diff --git a/.changeset/forty-crews-fetch.md b/.changeset/forty-crews-fetch.md new file mode 100644 index 00000000000..92d886824c6 --- /dev/null +++ b/.changeset/forty-crews-fetch.md @@ -0,0 +1,5 @@ +--- +'@clerk/clerk-js': patch +--- + +Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships diff --git a/packages/clerk-js/src/core/resources/Organization.ts b/packages/clerk-js/src/core/resources/Organization.ts index c60077d46f9..df56934f152 100644 --- a/packages/clerk-js/src/core/resources/Organization.ts +++ b/packages/clerk-js/src/core/resources/Organization.ts @@ -24,6 +24,7 @@ import type { UpdateMembershipParams, UpdateOrganizationParams, } from '@clerk/types'; +import type { GetMembershipsParams } from '@clerk/types'; import { unixEpochToDate } from '../../utils/date'; import { convertPageToOffset } from '../../utils/pagesToOffset'; @@ -161,6 +162,18 @@ export class Organization extends BaseResource implements OrganizationResource { getMemberships: GetMemberships = async getMembershipsParams => { const isDeprecatedParams = typeof getMembershipsParams === 'undefined' || !getMembershipsParams?.paginated; + + if (!(getMembershipsParams as GetMembershipsParams)?.limit) { + deprecated( + 'limit', + 'Use `pageSize` instead in Organization.getMemberships.', + 'organization:getMemberships:limit', + ); + } + if (!(getMembershipsParams as GetMembershipsParams)?.offset) { + deprecated('offset', 'Use `initialPage` instead in Organization.limit.', 'organization:getMemberships:offset'); + } + return await BaseResource._fetch({ path: `/organizations/${this.id}/memberships`, method: 'GET',