chore(clerk-js): Apply deprecation warnings#1779

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
dimkl merged 8 commits into from
Sep 29, 2023
Merged

chore(clerk-js): Apply deprecation warnings #1779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3b47713
chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…
dimkl Sep 25, 2023
435583c
chore(clerk-js): Warn about Organization.create(a: string) deprecation
dimkl Sep 25, 2023
c866c0e
chore(clerk-js): Warn about Organization.retrieve limit & offset depr…
dimkl Sep 25, 2023
a1a0fc3
chore(clerk-js): Warn about svgUrl deprecation
dimkl Sep 25, 2023
04c7e25
chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…
dimkl Sep 25, 2023
ede23a2
chore(clerk-js): Add changeset for clerk-js deprecation warnings
dimkl Sep 25, 2023
e5dbd31
chore(clerk-js): Update snapshots to omit the deprecated class proper…
dimkl Sep 28, 2023
af4b7ba
chore(clerk-js): Use deprecate util for Organization.getMemberships p…
panteliselef Sep 27, 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
5 changes: 5 additions & 0 deletions .changeset/forty-crews-fetch.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships
10 changes: 10 additions & 0 deletions .changeset/four-chairs-lay.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
---
'@clerk/clerk-js': patch
---

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`
2 changes: 2 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
addClerkPrefix,
deprecated,
handleValueOrFn,
inClientSide,
is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
* @deprecated use User.getOrganizationMemberships
*/
public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
return await OrganizationMembership.retrieve();
};

Expand Down
14 changes: 10 additions & 4 deletions packages/clerk-js/src/core/resources/DisplayConfig.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
instanceEnvironmentType!: string;
faviconImageUrl!: string;
logoImageUrl!: string;
// TODO: Remove
/**
* @deprecated Use `logoImageUrl` instead.
*/
logoUrl!: string;
// TODO: Remove
/**
* @deprecated Use `faviconImageUrl` instead.
*/
faviconUrl!: string;
preferredSignInStrategy!: PreferredSignInStrategy;
signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
this.preferredSignInStrategy = data.preferred_sign_in_strategy;
this.logoImageUrl = data.logo_image_url;
this.faviconImageUrl = data.favicon_image_url;
// TODO: Remove
this.logoUrl = data.logo_url;
// TODO: Remove
this.faviconUrl = data.favicon_url;
this.homeUrl = data.home_url;
this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
return this;
}
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');
4 changes: 3 additions & 1 deletion packages/clerk-js/src/core/resources/ExternalAccount.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
ExternalAccountJSON,
ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
return this.username || this.emailAddress || this.label;
}
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');
22 changes: 21 additions & 1 deletion packages/clerk-js/src/core/resources/Organization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
AddMemberParams,
ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
if (typeof paramsOrName === 'string') {
// DX: Deprecated v3.5.2
name = paramsOrName;
deprecated(
'create',
'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
'organization:create',
);
} else {
name = paramsOrName.name;
slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
}
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');
20 changes: 20 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembership.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
ClerkPaginatedResponse,
ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
const isDeprecatedParams =
typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
deprecated(
'limit',
'Use `pageSize` instead in OrganizationMembership.retrieve.',
'organization-membership:limit',
);
}
if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
deprecated(
'offset',
'Use `initialPage` instead in OrganizationMembership.retrieve.',
'organization-membership:offset',
);
}

return await BaseResource._fetch({
path: '/me/organization_memberships',
method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
}
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
role: MembershipRole;
};
Expand Down
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/OrganizationMembershipRequest.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
return this;
}
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');
3 changes: 3 additions & 0 deletions packages/clerk-js/src/core/resources/User.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
BackupCodeJSON,
BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
return this;
}
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');
1 change: 0 additions & 1 deletion packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
"imageUrl": "https://clerk.com",
"inviteMember": [Function],
"inviteMembers": [Function],
"logoUrl": "https://url-for-logo.png",
"maxAllowedMemberships": 3,
"membersCount": 1,
"name": "test_name",
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
"imageUrl": "https://clerk.com",
"inviteMember": [Function],
"inviteMembers": [Function],
"logoUrl": "https://path-to-logo.png",
"maxAllowedMemberships": 3,
"membersCount": 1,
"name": "test_name",
Expand Down
2 changes: 2 additions & 0 deletions packages/clerk-js/src/ui/common/constants.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
* @deprecated In favor of iconImageUrl
*/
export function svgUrl(id: string): string {
deprecated('svgUrl', 'Use `iconImageUrl` instead');
return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down
, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down

, '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
chore(clerk-js): Apply deprecation warnings#1779

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

dimkl
merged 8 commits into

from

Sep 29, 2023
 Merged


chore(clerk-js): Apply deprecation warnings
#1779
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
3b47713

chore(clerk-js): Warn about Clerk.getOrganizationMemberships() deprec…


dimkl Sep 25, 2023
435583c

chore(clerk-js): Warn about Organization.create(a: string) deprecation


dimkl Sep 25, 2023
c866c0e

chore(clerk-js): Warn about Organization.retrieve limit & offset depr…


dimkl Sep 25, 2023
a1a0fc3

chore(clerk-js): Warn about svgUrl deprecation


dimkl Sep 25, 2023
04c7e25

chore(clerk-js): Warn about avatarUrl/logoUrl/faviconUrl/profileImage…


dimkl Sep 25, 2023
ede23a2

chore(clerk-js): Add changeset for clerk-js deprecation warnings


dimkl Sep 25, 2023
e5dbd31

chore(clerk-js): Update snapshots to omit the deprecated class proper…


dimkl Sep 28, 2023
af4b7ba

chore(clerk-js): Use deprecate util for Organization.getMemberships p…


panteliselef Sep 27, 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


5 changes: 5 additions & 0 deletions
.changeset/forty-crews-fetch.md

View file


Open in desktop

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

Use our deprecate utility to log warnings about deprecated usage of Organization.getMemberships

10 changes: 10 additions & 0 deletions
.changeset/four-chairs-lay.md

View file


Open in desktop

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

Apply deprecation warnings clerk-js package for:
- Organization.create() using string parameter
- Organization.retrieve() `limit` & `offset`
- Clerk.getOrganizationMemberships()
- `svgUrl`
- `avatarUrl`/`logoUrl`/`faviconUrl`/`profileImageUrl`

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { LocalStorageBroadcastChannel } from '@clerk/shared';
import {
 addClerkPrefix,
 deprecated,
 handleValueOrFn,
 inClientSide,
 is4xxError,
Expand DownExpand Up@@ -1080,6 +1081,7 @@ export default class Clerk implements ClerkInterface {
 * @deprecated use User.getOrganizationMemberships
 */
 public getOrganizationMemberships = async (): Promise<OrganizationMembership[]> => {
 deprecated('getOrganizationMemberships', 'Use User.getOrganizationMemberships');
 return await OrganizationMembership.retrieve();
 };

Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/core/resources/DisplayConfig.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type { DisplayConfigJSON, DisplayConfigResource, DisplayThemeJSON, PreferredSignInStrategy } from '@clerk/types';

import { BaseResource } from './internal';
Expand All@@ -18,9 +19,13 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 instanceEnvironmentType!: string;
 faviconImageUrl!: string;
 logoImageUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `logoImageUrl` instead.
 */
 logoUrl!: string;
 // TODO: Remove
 /**
 * @deprecated Use `faviconImageUrl` instead.
 */
 faviconUrl!: string;
 preferredSignInStrategy!: PreferredSignInStrategy;
 signInUrl!: string;
Expand DownExpand Up@@ -52,9 +57,7 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 this.preferredSignInStrategy = data.preferred_sign_in_strategy;
 this.logoImageUrl = data.logo_image_url;
 this.faviconImageUrl = data.favicon_image_url;
 // TODO: Remove
 this.logoUrl = data.logo_url;
 // TODO: Remove
 this.faviconUrl = data.favicon_url;
 this.homeUrl = data.home_url;
 this.signInUrl = data.sign_in_url;
Expand All@@ -77,3 +80,6 @@ export class DisplayConfig extends BaseResource implements DisplayConfigResource
 return this;
 }
}

deprecatedProperty(DisplayConfig, 'logoUrl', 'Use `logoImageUrl` instead.');
deprecatedProperty(DisplayConfig, 'faviconUrl', 'Use `faviconImageUrl` instead.');

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/core/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { titleize } from '@clerk/shared';
import { deprecatedProperty, titleize } from '@clerk/shared';
import type {
 ExternalAccountJSON,
 ExternalAccountResource,
Expand DownExpand Up@@ -84,3 +84,5 @@ export class ExternalAccount extends BaseResource implements ExternalAccountReso
 return this.username || this.emailAddress || this.label;
 }
}

deprecatedProperty(ExternalAccount, 'avatarUrl', 'Use `imageUrl` instead.');

22 changes: 21 additions & 1 deletion
packages/clerk-js/src/core/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { deprecated } from '@clerk/shared';
import { deprecated, deprecatedProperty } from '@clerk/shared';
import type {
 AddMemberParams,
 ClerkPaginatedResponse,
Expand All@@ -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 DownExpand Up@@ -67,6 +68,11 @@ export class Organization extends BaseResource implements OrganizationResource {
 if (typeof paramsOrName === 'string') {
 // DX: Deprecated v3.5.2
 name = paramsOrName;
 deprecated(
 'create',
 'Calling `create` with a string is deprecated. Use an object of type CreateOrganizationParams instead.',
 'organization:create',
 );
 } else {
 name = paramsOrName.name;
 slug = paramsOrName.slug;
Expand DownExpand Up@@ -161,6 +167,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 DownExpand Up@@ -338,3 +356,5 @@ export class Organization extends BaseResource implements OrganizationResource {
 return this.fromJSON(currentOrganization?.organization as OrganizationJSON);
 }
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');

20 changes: 20 additions & 0 deletions
packages/clerk-js/src/core/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type {
 ClerkPaginatedResponse,
 ClerkResourceReloadParams,
Expand DownExpand Up@@ -29,6 +30,22 @@ export class OrganizationMembership extends BaseResource implements Organization
 static retrieve: GetOrganizationMembershipsClass = async retrieveMembershipsParams => {
 const isDeprecatedParams =
 typeof retrieveMembershipsParams === 'undefined' || !retrieveMembershipsParams?.paginated;

 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.limit) {
 deprecated(
 'limit',
 'Use `pageSize` instead in OrganizationMembership.retrieve.',
 'organization-membership:limit',
 );
 }
 if (!(retrieveMembershipsParams as RetrieveMembershipsParams)?.offset) {
 deprecated(
 'offset',
 'Use `initialPage` instead in OrganizationMembership.retrieve.',
 'organization-membership:offset',
 );
 }

 return await BaseResource._fetch({
 path: '/me/organization_memberships',
 method: 'GET',
Expand DownExpand Up@@ -121,6 +138,9 @@ export class OrganizationMembership extends BaseResource implements Organization
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembership, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

export type UpdateOrganizationMembershipParams = {
 role: MembershipRole;
};
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,6 @@ export class OrganizationMembershipRequest extends BaseResource implements Organ
 return this;
 }
}

// TODO(@dimkl): deprecate nested property
// deprecatedProperty(OrganizationMembershipRequest, 'publicUserData.profileImageUrl', 'Use `imageUrl` instead.');

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecatedProperty } from '@clerk/shared';
import type {
 BackupCodeJSON,
 BackupCodeResource,
Expand DownExpand Up@@ -347,3 +348,5 @@ export class User extends BaseResource implements UserResource {
 return this;
 }
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,6 @@ Organization {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://url-for-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,6 @@ OrganizationMembership {
 "imageUrl": "https://clerk.com",
 "inviteMember": [Function],
 "inviteMembers": [Function],
 "logoUrl": "https://path-to-logo.png",
 "maxAllowedMemberships": 3,
 "membersCount": 1,
 "name": "test_name",
Expand Down

2 changes: 2 additions & 0 deletions
packages/clerk-js/src/ui/common/constants.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { deprecated } from '@clerk/shared';
import type { Attribute, Web3Provider } from '@clerk/types';

import type { LocalizationKey } from '../localization/localizationKeys';
Expand DownExpand Up@@ -102,6 +103,7 @@ export function getWeb3ProviderData(name: Web3Provider): Web3ProviderData | unde
 * @deprecated In favor of iconImageUrl
 */
export function svgUrl(id: string): string {
 deprecated('svgUrl', 'Use `iconImageUrl` instead');
 return `https://images.clerk.com/static/${id}.svg`;
}

Expand Down