Skip to content

chore(clerk-js): Apply deprication warnings for Organization.getMemberships #1787

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

Closed
panteliselef wants to merge 1 commit into from
Closed

chore(clerk-js): Apply deprication warnings for Organization.getMemberships #1787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .changeset/forty-crews-fetch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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',
Expand Down