feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
panteliselef merged 4 commits into from
Aug 17, 2023
Merged

feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList #1606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c78d028
feat(clerk-js): Support Paginated response in OrganizationMembership.…
panteliselef Aug 16, 2023
723ec14
feat(shared): Introduce userMemberships in useOrganizationList
panteliselef Aug 16, 2023
e173310
chore(clerk-js): Mark limit and offset as deprecated
panteliselef Aug 16, 2023
5e4f7d2
chore(clerk-js): Add changeset
panteliselef Aug 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/gold-jeans-turn.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
return Organization.create({ name, slug });
};

/**
* @deprecated use User.getOrganizationMemberships
*/
public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
return await OrganizationMembership.retrieve();
};
Expand Down
55 changes: 49 additions & 6 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
ClerkPaginatedResponse,
ClerkResourceReloadParams,
GetUserOrganizationMembershipParams,
MembershipRole,
OrganizationMembershipJSON,
OrganizationMembershipResource,
PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
this.fromJSON(data);
}

static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
const isDeprecatedParams =
typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
return await BaseResource._fetch({
path: '/me/organization_memberships',
method: 'GET',
search: retrieveMembershipsParams as any,
search: isDeprecatedParams
? retrieveMembershipsParams
: (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
})
.then(res => {
const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
if (isDeprecatedParams) {
const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
}

const { data: suggestions, total_count } =
res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

return {
total_count,
data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
} as any;
})
.catch(() => []);
}
.catch(() => {
if (isDeprecatedParams) {
return [];
}
return {
total_count: 0,
data: [],
};
});
};

destroy = async (): Promise<OrganizationMembership> => {
// TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
role: MembershipRole;
};

/**
* @deprecated
*/
export type RetrieveMembershipsParams = {
/**
* @deprecated Use pageSize instead
*/
limit?: number;
/**
* @deprecated Use initialPage instead
*/
offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
params?: T,
) => T['paginated'] extends true
? Promise<ClerkPaginatedResponse<OrganizationMembership>>
: Promise<OrganizationMembership[]>;
9 changes: 3 additions & 6 deletions packages/clerk-js/src/core/resources/User.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
EmailAddressResource,
ExternalAccountJSON,
ExternalAccountResource,
GetOrganizationMemberships,
GetUserOrganizationInvitationsParams,
GetUserOrganizationSuggestionsParams,
ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
BaseResource,
DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
return OrganizationSuggestion.retrieve(params);
};

getOrganizationMemberships = async (
retrieveMembership: RetrieveMembershipsParams,
): Promise<OrganizationMembership[]> => {
return await OrganizationMembership.retrieve(retrieveMembership);
};
getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
OrganizationMembership.retrieve(retrieveMembership);

get verifiedExternalAccounts() {
return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
userMemberships: {
infinite: true,
},
userInvitations: {
infinite: true,
},
Expand Down
68 changes: 67 additions & 1 deletion packages/shared/src/hooks/useOrganizationList.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
ClerkPaginatedResponse,
CreateOrganizationParams,
GetUserOrganizationInvitationsParams,
GetUserOrganizationMembershipParams,
GetUserOrganizationSuggestionsParams,
OrganizationMembershipResource,
OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
userMemberships?:
| true
| (GetUserOrganizationMembershipParams & {
infinite?: boolean;
keepPreviousData?: boolean;
});
userInvitations?:
| true
| (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
| {
isLoaded: false;
/**
* @deprecated Use userMemberships instead
*/
organizationList: undefined;
createOrganization: undefined;
setActive: undefined;
userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
}
| {
isLoaded: boolean;
/**
* @deprecated Use userMemberships instead
*/
organizationList: OrganizationList;
createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
setActive: SetActive;
userMemberships: PaginatedResources<OrganizationMembershipResource>;
userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
};

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
const { userInvitations, userSuggestions } = params || {};
const { userMemberships, userInvitations, userSuggestions } = params || {};

const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
initialPage: 1,
pageSize: 10,
keepPreviousData: false,
infinite: false,
});

const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
const clerk = useClerkInstanceContext();
const user = useUserContext();

const userMembershipsParams =
typeof userMemberships === 'undefined'
? undefined
: {
initialPage: userMembershipsSafeValues.initialPage,
pageSize: userMembershipsSafeValues.pageSize,
};

const userInvitationsParams =
typeof userInvitations === 'undefined'
? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

const isClerkLoaded = !!(clerk.loaded && user);

const memberships = usePagesOrInfinite<
GetUserOrganizationMembershipParams,
ClerkPaginatedResponse<OrganizationMembershipResource>
>(
{
...userMembershipsParams,
paginated: true,
} as any,
user?.getOrganizationMemberships as unknown as any,
{
keepPreviousData: userMembershipsSafeValues.keepPreviousData,
infinite: userMembershipsSafeValues.infinite,
enabled: !!userMembershipsParams,
},
{
type: 'userMemberships',
userId: user?.id,
},
);

const invitations = usePagesOrInfinite<
GetUserOrganizationInvitationsParams,
ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
organizationList: undefined,
createOrganization: undefined,
setActive: undefined,
userMemberships: {
data: undefined,
count: undefined,
isLoading: false,
isFetching: false,
isError: false,
page: undefined,
pageCount: undefined,
fetchPage: undefined,
fetchNext: undefined,
fetchPrevious: undefined,
hasNextPage: false,
hasPreviousPage: false,
unstable__mutate: undefined,
},
userInvitations: {
data: undefined,
count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
organizationList: createOrganizationList(user.organizationMemberships),
setActive: clerk.setActive,
createOrganization: clerk.createOrganization,
userMemberships: memberships,
userInvitations: invitations,
userSuggestions: suggestions,
};
Expand Down
27 changes: 27 additions & 0 deletions packages/types/src/user.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
getSessions: () => Promise<SessionWithActivitiesResource[]>;
setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
getOrganizationMemberships: GetOrganizationMemberships;
getOrganizationInvitations: (
params?: GetUserOrganizationInvitationsParams,
) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
limit?: number;
offset?: number;
};

export type GetUserOrganizationMembershipParams = {
/**
* This the starting point for your fetched results. The initial value persists between re-renders
*/
initialPage?: number;
/**
* Maximum number of items returned per request. The initial value persists between re-renders
*/
pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
params?: T,
) => T['paginated'] extends true
? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
: Promise<OrganizationMembershipResource[]>;
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList#1606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

panteliselef
merged 4 commits into

from

Aug 17, 2023
 Merged


feat(clerk-js): Support Paginated response in OrganizationMembership.retrieve & userMemberships in useOrganizationList
#1606
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c78d028

feat(clerk-js): Support Paginated response in OrganizationMembership.…


panteliselef Aug 16, 2023
723ec14

feat(shared): Introduce userMemberships in useOrganizationList


panteliselef Aug 16, 2023
e173310

chore(clerk-js): Mark limit and offset as deprecated


panteliselef Aug 16, 2023
5e4f7d2

chore(clerk-js): Add changeset


panteliselef Aug 16, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


9 changes: 9 additions & 0 deletions
.changeset/gold-jeans-turn.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/types': patch
---

Updates signature of OrganizationMembership.retrieve to support backwards compatibility while allowing using the new paginated responses.

+ userMemberships is now also part of the returned values of useOrganizationList

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1009,6 +1009,9 @@ export default class Clerk implements ClerkInterface {
 return Organization.create({ name, slug });
 };

 /**
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve();
 };
Expand Down

55 changes: 49 additions & 6 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
 GetUserOrganizationMembershipParams,
 MembershipRole,
 OrganizationMembershipJSON,
 OrganizationMembershipResource,
 PublicUserData,
} from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, Organization } from './internal';

export class OrganizationMembership extends BaseResource implements OrganizationMembershipResource {
Expand All@@ -23,18 +26,40 @@ export class OrganizationMembership extends BaseResource implements Organization
 this.fromJSON(data);
 }

 static async retrieve(retrieveMembershipsParams?: RetrieveMembershipsParams): Promise<OrganizationMembership[]> {
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;
 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
 search: retrieveMembershipsParams as any,
 search: isDeprecatedParams
 ? retrieveMembershipsParams
 : (convertPageToOffset(retrieveMembershipsParams as unknown as any) as any),
 })
 .then(res => {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem));
 if (isDeprecatedParams) {
 const organizationMembershipsJSON = res?.response as unknown as OrganizationMembershipJSON[];
 return organizationMembershipsJSON.map(orgMem => new OrganizationMembership(orgMem)) as any;
 }

 const { data: suggestions, total_count } =
 res?.response as unknown as ClerkPaginatedResponse<OrganizationMembershipJSON>;

 return {
 total_count,
 data: suggestions.map(suggestion => new OrganizationMembership(suggestion)),
 } as any;
 })
 .catch(() => []);
 }
 .catch(() => {
 if (isDeprecatedParams) {
 return [];
 }
 return {
 total_count: 0,
 data: [],
 };
 });
 };

 destroy = async (): Promise<OrganizationMembership> => {
 // TODO: Revise the return type of _baseDelete
Expand DownExpand Up@@ -100,7 +125,25 @@ export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};

/**
 * @deprecated
 */
export type RetrieveMembershipsParams = {
 /**
 * @deprecated Use pageSize instead
 */
 limit?: number;
 /**
 * @deprecated Use initialPage instead
 */
 offset?: number;
};

type MembershipParams = (RetrieveMembershipsParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};
export type GetOrganizationMembershipsClass = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembership>>
 : Promise<OrganizationMembership[]>;

9 changes: 3 additions & 6 deletions
packages/clerk-js/src/core/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import type {
 EmailAddressResource,
 ExternalAccountJSON,
 ExternalAccountResource,
 GetOrganizationMemberships,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationSuggestionsParams,
 ImageResource,
Expand All@@ -32,7 +33,6 @@ import { unixEpochToDate } from '../../utils/date';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { getFullName } from '../../utils/user';
import { BackupCode } from './BackupCode';
import type { RetrieveMembershipsParams } from './internal';
import {
 BaseResource,
 DeletedObject,
Expand DownExpand Up@@ -266,11 +266,8 @@ export class User extends BaseResource implements UserResource {
 return OrganizationSuggestion.retrieve(params);
 };

 getOrganizationMemberships = async (
 retrieveMembership: RetrieveMembershipsParams,
 ): Promise<OrganizationMembership[]> => {
 return await OrganizationMembership.retrieve(retrieveMembership);
 };
 getOrganizationMemberships: GetOrganizationMemberships = retrieveMembership =>
 OrganizationMembership.retrieve(retrieveMembership);

 get verifiedExternalAccounts() {
 return this.externalAccounts.filter(externalAccount => externalAccount.verification?.status == 'verified');
Expand Down

3 changes: 3 additions & 0 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import type { useCoreOrganizationList } from '../../contexts';

export const organizationListParams = {
 userMemberships: {
 infinite: true,
 },
 userInvitations: {
 infinite: true,
 },
Expand Down

68 changes: 67 additions & 1 deletion
packages/shared/src/hooks/useOrganizationList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import type {
 ClerkPaginatedResponse,
 CreateOrganizationParams,
 GetUserOrganizationInvitationsParams,
 GetUserOrganizationMembershipParams,
 GetUserOrganizationSuggestionsParams,
 OrganizationMembershipResource,
 OrganizationResource,
Expand All@@ -15,6 +16,12 @@ import type { PaginatedResources, PaginatedResourcesWithDefault } from './types'
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

type UseOrganizationListParams = {
 userMemberships?:
 | true
 | (GetUserOrganizationMembershipParams & {
 infinite?: boolean;
 keepPreviousData?: boolean;
 });
 userInvitations?:
 | true
 | (GetUserOrganizationInvitationsParams & {
Expand All@@ -34,25 +41,40 @@ type OrganizationList = ReturnType<typeof createOrganizationList>;
type UseOrganizationListReturn =
 | {
 isLoaded: false;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: undefined;
 createOrganization: undefined;
 setActive: undefined;
 userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
 userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 }
 | {
 isLoaded: boolean;
 /**
 * @deprecated Use userMemberships instead
 */
 organizationList: OrganizationList;
 createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
 setActive: SetActive;
 userMemberships: PaginatedResources<OrganizationMembershipResource>;
 userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
 userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };

type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

export const useOrganizationList: UseOrganizationList = params => {
 const { userInvitations, userSuggestions } = params || {};
 const { userMemberships, userInvitations, userSuggestions } = params || {};

 const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
 initialPage: 1,
 pageSize: 10,
 keepPreviousData: false,
 infinite: false,
 });

 const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
 initialPage: 1,
Expand All@@ -73,6 +95,14 @@ export const useOrganizationList: UseOrganizationList = params => {
 const clerk = useClerkInstanceContext();
 const user = useUserContext();

 const userMembershipsParams =
 typeof userMemberships === 'undefined'
 ? undefined
 : {
 initialPage: userMembershipsSafeValues.initialPage,
 pageSize: userMembershipsSafeValues.pageSize,
 };

 const userInvitationsParams =
 typeof userInvitations === 'undefined'
 ? undefined
Expand All@@ -93,6 +123,26 @@ export const useOrganizationList: UseOrganizationList = params => {

 const isClerkLoaded = !!(clerk.loaded && user);

 const memberships = usePagesOrInfinite<
 GetUserOrganizationMembershipParams,
 ClerkPaginatedResponse<OrganizationMembershipResource>
 >(
 {
 ...userMembershipsParams,
 paginated: true,
 } as any,
 user?.getOrganizationMemberships as unknown as any,
 {
 keepPreviousData: userMembershipsSafeValues.keepPreviousData,
 infinite: userMembershipsSafeValues.infinite,
 enabled: !!userMembershipsParams,
 },
 {
 type: 'userMemberships',
 userId: user?.id,
 },
 );

 const invitations = usePagesOrInfinite<
 GetUserOrganizationInvitationsParams,
 ClerkPaginatedResponse<UserOrganizationInvitationResource>
Expand DownExpand Up@@ -138,6 +188,21 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: undefined,
 createOrganization: undefined,
 setActive: undefined,
 userMemberships: {
 data: undefined,
 count: undefined,
 isLoading: false,
 isFetching: false,
 isError: false,
 page: undefined,
 pageCount: undefined,
 fetchPage: undefined,
 fetchNext: undefined,
 fetchPrevious: undefined,
 hasNextPage: false,
 hasPreviousPage: false,
 unstable__mutate: undefined,
 },
 userInvitations: {
 data: undefined,
 count: undefined,
Expand DownExpand Up@@ -176,6 +241,7 @@ export const useOrganizationList: UseOrganizationList = params => {
 organizationList: createOrganizationList(user.organizationMemberships),
 setActive: clerk.setActive,
 createOrganization: clerk.createOrganization,
 userMemberships: memberships,
 userInvitations: invitations,
 userSuggestions: suggestions,
 };
Expand Down

27 changes: 27 additions & 0 deletions
packages/types/src/user.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -101,6 +101,7 @@ export interface UserResource extends ClerkResource {
 getSessions: () => Promise<SessionWithActivitiesResource[]>;
 setProfileImage: (params: SetProfileImageParams) => Promise<ImageResource>;
 createExternalAccount: (params: CreateExternalAccountParams) => Promise<ExternalAccountResource>;
 getOrganizationMemberships: GetOrganizationMemberships;
 getOrganizationInvitations: (
 params?: GetUserOrganizationInvitationsParams,
 ) => Promise<ClerkPaginatedResponse<UserOrganizationInvitationResource>>;
Expand DownExpand Up@@ -190,3 +191,29 @@ export type GetUserOrganizationSuggestionsParams = {

 status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[];
};

type GetUserOrganizationMembershipOldParams = {
 limit?: number;
 offset?: number;
};

export type GetUserOrganizationMembershipParams = {
 /**
 * This the starting point for your fetched results. The initial value persists between re-renders
 */
 initialPage?: number;
 /**
 * Maximum number of items returned per request. The initial value persists between re-renders
 */
 pageSize?: number;
};

type MembershipParams = (GetUserOrganizationMembershipOldParams | GetUserOrganizationMembershipParams) & {
 paginated?: boolean;
};

export type GetOrganizationMemberships = <T extends MembershipParams>(
 params?: T,
) => T['paginated'] extends true
 ? Promise<ClerkPaginatedResponse<OrganizationMembershipResource>>
 : Promise<OrganizationMembershipResource[]>;