fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

fix(nextjs,shared): Revert "Use use client directive to support sha… #1806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9626959
Revert "chore(shared): Add JSDoc to helpers moved to shared package"
nikosdouvlis Sep 29, 2023
0df7e2c
Revert "chore(backend): Moved shared module to util/shared and drop u…
nikosdouvlis Sep 29, 2023
01bb8ca
Revert "chore(backend): Replace shared module with @clerk/shared impo…
nikosdouvlis Sep 29, 2023
aae1150
fix(backend): Revert deprecation warnings
nikosdouvlis Sep 29, 2023
cecf74d
chore(repo): Changeset
nikosdouvlis Sep 29, 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
7 changes: 7 additions & 0 deletions .changeset/fair-cobras-explain.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors
25,075 changes: 14,202 additions & 10,873 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion packages/backend/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
"test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
},
"dependencies": {
"@clerk/shared": "^0.24.0",
"@clerk/types": "^3.53.0",
"@peculiar/webcrypto": "1.4.1",
"@types/node": "16.18.6",
Expand Down
7 changes: 1 addition & 6 deletions packages/backend/src/api/endpoints/InterstitialApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
* @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
*/
export class InterstitialAPI extends AbstractAPI {
public async getInterstitial() {
deprecated(
'getInterstitial()',
'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
);

return this.request<string>({
path: 'internal/interstitial',
method: 'GET',
Expand Down
3 changes: 0 additions & 3 deletions packages/backend/src/api/endpoints/OrganizationApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
* @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
*/
public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

const { organizationId, limit, offset } = params;
this.requireId(organizationId);

Expand Down
20 changes: 2 additions & 18 deletions packages/backend/src/api/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
(cb: any): LegacyRequestFunction =>
async (...args) => {
deprecated(
'',
'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
'resources-legacy-return',
);
// @ts-ignore
const { data, errors, status, statusText } = await cb<T>(...args);
if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
const {
apiKey,
secretKey,
httpOptions,
apiUrl = API_URL,
apiVersion = API_VERSION,
userAgent = USER_AGENT,
httpOptions = {},
} = options;
if (apiKey) {
deprecated('apiKey', 'Use `secretKey` instead.');
}
if (httpOptions) {
deprecated(
'httpOptions',
'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
);
}

const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

res = await runtime.fetch(
finalUrl.href,
deepmerge(httpOptions || {}, {
deepmerge(httpOptions, {
method,
headers,
...body,
Expand Down
3 changes: 0 additions & 3 deletions packages/backend/src/api/resources/ExternalAccount.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
);
}
}

deprecatedProperty(ExternalAccount, 'picture', 'Use `imageUrl` instead.');
3 changes: 0 additions & 3 deletions packages/backend/src/api/resources/Organization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
);
}
}

deprecatedProperty(Organization, 'logoUrl', 'Use `imageUrl` instead.');
3 changes: 0 additions & 3 deletions packages/backend/src/api/resources/OrganizationMembership.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
);
}
}

deprecatedProperty(OrganizationMembershipPublicUserData, 'profileImageUrl', 'Use `imageUrl` instead.');
3 changes: 0 additions & 3 deletions packages/backend/src/api/resources/User.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
);
}
}

deprecatedProperty(User, 'profileImageUrl', 'Use `imageUrl` instead.');
14 changes: 1 addition & 13 deletions packages/backend/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
const apiClient = createBackendApiClient(opts);
const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
...apiClient,
...requestState,
/**
* @deprecated This prop has been deprecated and will be removed in the next major release.
*/
__unstable_options: opts,
};

// The __unstable_options is not being used internally and
// it's only being set in packages/sdk-node/src/clerkClient.ts#L86
deprecatedObjectProperty(
clerkInstance,
'__unstable_options',
'Use `createClerkClient({...})` to create a new clerk instance instead.',
);

return clerkInstance;
}
4 changes: 2 additions & 2 deletions packages/backend/src/redirections.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
assert.raises(
() => redirectToSignIn({ returnBackUrl }),
new Error(
'@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
),
);
});
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
assert.raises(
() => redirectToSignUp({ returnBackUrl }),
new Error(
'@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
),
);
});
Expand Down
9 changes: 4 additions & 5 deletions packages/backend/src/redirections.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
if (!frontendApi) {
frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
} else {
deprecated('frontentApi', 'Use `publishableKey` instead.');
}

const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
}

const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
}

const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down
23 changes: 23 additions & 0 deletions packages/backend/src/shared/callWithRetry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
fn: (...args: unknown[]) => Promise<T>,
attempt = 1,
maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
try {
return await fn();
} catch (e) {
if (attempt >= maxAttempts) {
throw e;
}
await wait(2 ** attempt * 100);

return callWithRetry(fn, attempt + 1);
}
}
15 changes: 15 additions & 0 deletions packages/backend/src/shared/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
* This module will contain functionality that will be copied
* from @clerk/shared and will be replaced by imports when the
* bundling issue is fixed.
*/
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';
16 changes: 16 additions & 0 deletions packages/backend/src/shared/instance.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
return (
frontendApi.endsWith('.lclstage.dev') ||
frontendApi.endsWith('.stgstage.dev') ||
frontendApi.endsWith('.clerkstage.dev') ||
frontendApi.endsWith('.accountsstage.dev')
);
}
35 changes: 35 additions & 0 deletions packages/backend/src/shared/isDevOrStagingUrl.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
const DEV_OR_STAGING_SUFFIXES = [
'.lcl.dev',
'.stg.dev',
'.lclstage.dev',
'.stgstage.dev',
'.dev.lclclerk.com',
'.stg.lclclerk.com',
'.accounts.lclclerk.com',
'accountsstage.dev',
'accounts.dev',
];

const devOrStagingUrlCache = new Map<string, boolean>();

return {
isDevOrStagingUrl: (url: string | URL): boolean => {
if (!url) {
return false;
}

const hostname = typeof url === 'string' ? url : url.hostname;
let res = devOrStagingUrlCache.get(hostname);
if (res === undefined) {
res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
devOrStagingUrlCache.set(hostname, res);
}
return res;
},
};
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };
56 changes: 56 additions & 0 deletions packages/backend/src/shared/parsePublishableKey.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
? PUBLISHABLE_KEY_TEST_PREFIX
: PUBLISHABLE_KEY_LIVE_PREFIX;
return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
key = key || '';

if (!isPublishableKey(key)) {
return null;
}

const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

let frontendApi = isomorphicAtob(key.split('_')[2]);

if (!frontendApi.endsWith('$')) {
return null;
}

frontendApi = frontendApi.slice(0, -1);

return {
instanceType,
frontendApi,
};
}

export function isPublishableKey(key: string) {
key = key || '';

const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
if (typeof atob !== 'undefined' && typeof atob === 'function') {
return atob(data);
} else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
return new globalThis.Buffer(data, 'base64').toString();
}
return data;
};
Loading
, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading

, '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
fix(nextjs,shared): Revert "Use use client directive to support sha…#1806

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

nikosdouvlis
merged 5 commits into

from

Sep 29, 2023
 Merged


fix(nextjs,shared): Revert "Use use client directive to support sha…
#1806
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
9626959

Revert "chore(shared): Add JSDoc to helpers moved to shared package"


nikosdouvlis Sep 29, 2023
0df7e2c

Revert "chore(backend): Moved shared module to util/shared and drop u…


nikosdouvlis Sep 29, 2023
01bb8ca

Revert "chore(backend): Replace shared module with @clerk/shared impo…


nikosdouvlis Sep 29, 2023
aae1150

fix(backend): Revert deprecation warnings


nikosdouvlis Sep 29, 2023
cecf74d

chore(repo): Changeset


nikosdouvlis Sep 29, 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


7 changes: 7 additions & 0 deletions
.changeset/fair-cobras-explain.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
'@clerk/nextjs': patch
---

Temporarily revert internal change to resolve RSC-related errors

25,075 changes: 14,202 additions & 10,873 deletions
package-lock.json

View file


Open in desktop


Large diffs are not rendered by default.


1 change: 0 additions & 1 deletion
packages/backend/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,6 @@
 "test:cloudflare-workerd": "tests/cloudflare-workerd/run.sh"
 },
 "dependencies": {
 "@clerk/shared": "^0.24.0",
 "@clerk/types": "^3.53.0",
 "@peculiar/webcrypto": "1.4.1",
 "@types/node": "16.18.6",
Expand Down

7 changes: 1 addition & 6 deletions
packages/backend/src/api/endpoints/InterstitialApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
import { deprecated } from '../../util/shared';
import { AbstractAPI } from './AbstractApi';

/**
 * @deprecated Switch to the public interstitial endpoint from Clerk Backend API.
 */
export class InterstitialAPI extends AbstractAPI {
 public async getInterstitial() {
 deprecated(
 'getInterstitial()',
 'Switch to `Clerk(...).localInterstitial(...)` from `import { Clerk } from "@clerk/backend"`.',
 );

 return this.request<string>({
 path: 'internal/interstitial',
 method: 'GET',
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/endpoints/OrganizationApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import type {
} from '../resources';
import type { OrganizationMembershipRole } from '../resources/Enums';
import { AbstractAPI } from './AbstractApi';
import { deprecated } from '@clerk/shared';

const basePath = '/organizations';

Expand DownExpand Up@@ -256,8 +255,6 @@ export class OrganizationAPI extends AbstractAPI {
 * @deprecated Use `getOrganizationInvitationList` instead along with the status parameter.
 */
 public async getPendingOrganizationInvitationList(params: GetPendingOrganizationInvitationListParams) {
 deprecated('getPendingOrganizationInvitationList', 'Use `getOrganizationInvitationList` instead.');

 const { organizationId, limit, offset } = params;
 this.requireId(organizationId);

Expand Down

20 changes: 2 additions & 18 deletions
packages/backend/src/api/request.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,6 @@ import { API_URL, API_VERSION, constants, USER_AGENT } from '../constants';
import runtime from '../runtime';
import { assertValidSecretKey } from '../util/assertValidSecretKey';
import { joinPaths } from '../util/path';
import { deprecated } from '../util/shared';
import type { CreateBackendApiOptions } from './factory';
import { deserialize } from './resources/Deserializer';

Expand DownExpand Up@@ -51,11 +50,6 @@ type LegacyRequestFunction = <T>(requestOptions: ClerkBackendApiRequestOptions)
const withLegacyReturn =
 (cb: any): LegacyRequestFunction =>
 async (...args) => {
 deprecated(
 '',
 'Resources return format will switch to `{ data: any, errors: ClerkAPIError[] }` from `data | never` the next major version.',
 'resources-legacy-return',
 );
 // @ts-ignore
 const { data, errors, status, statusText } = await cb<T>(...args);
 if (errors === null) {
Expand All@@ -73,21 +67,11 @@ export function buildRequest(options: CreateBackendApiOptions) {
 const {
 apiKey,
 secretKey,
 httpOptions,
 apiUrl = API_URL,
 apiVersion = API_VERSION,
 userAgent = USER_AGENT,
 httpOptions = {},
 } = options;
 if (apiKey) {
 deprecated('apiKey', 'Use `secretKey` instead.');
 }
 if (httpOptions) {
 deprecated(
 'httpOptions',
 'This option has been deprecated and will be removed with the next major release.\nA RequestInit init object used by the `request` method.',
 );
 }

 const { path, method, queryParams, headerParams, bodyParams, formData } = requestOptions;
 const key = secretKey || apiKey;

Expand DownExpand Up@@ -135,7 +119,7 @@ export function buildRequest(options: CreateBackendApiOptions) {

 res = await runtime.fetch(
 finalUrl.href,
 deepmerge(httpOptions || {}, {
 deepmerge(httpOptions, {
 method,
 headers,
 ...body,
Expand Down

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/ExternalAccount.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { ExternalAccountJSON } from './JSON';
import { Verification } from './Verification';

Expand DownExpand Up@@ -42,5 +41,3 @@ export class ExternalAccount {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/Organization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import type { OrganizationJSON } from './JSON';

export class Organization {
Expand DownExpand Up@@ -41,5 +40,3 @@ export class Organization {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/OrganizationMembership.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { Organization } from '../resources';
import type { OrganizationMembershipRole } from './Enums';
import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON';
Expand DownExpand Up@@ -55,5 +54,3 @@ export class OrganizationMembershipPublicUserData {
 );
 }
}

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

3 changes: 0 additions & 3 deletions
packages/backend/src/api/resources/User.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
import { deprecatedProperty } from '../../util/shared';
import { EmailAddress } from './EmailAddress';
import { ExternalAccount } from './ExternalAccount';
import type { ExternalAccountJSON, UserJSON } from './JSON';
Expand DownExpand Up@@ -73,5 +72,3 @@ export class User {
 );
 }
}

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

14 changes: 1 addition & 13 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
import { deprecatedObjectProperty } from '@clerk/shared';

import type { CreateBackendApiOptions } from './api';
import { createBackendApiClient } from './api';
import type { CreateAuthenticateRequestOptions } from './tokens';
Expand DownExpand Up@@ -28,22 +26,12 @@ export function Clerk(options: ClerkOptions) {
 const apiClient = createBackendApiClient(opts);
 const requestState = createAuthenticateRequest({ options: opts, apiClient });

const clerkInstance = {
return {
 ...apiClient,
 ...requestState,
 /**
 * @deprecated This prop has been deprecated and will be removed in the next major release.
 */
 __unstable_options: opts,
 };

 // The __unstable_options is not being used internally and
 // it's only being set in packages/sdk-node/src/clerkClient.ts#L86
 deprecatedObjectProperty(
 clerkInstance,
 '__unstable_options',
 'Use `createClerkClient({...})` to create a new clerk instance instead.',
 );

 return clerkInstance;
}

4 changes: 2 additions & 2 deletions
packages/backend/src/redirections.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignIn({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand DownExpand Up@@ -221,7 +221,7 @@ export default (QUnit: QUnit) => {
 assert.raises(
 () => redirectToSignUp({ returnBackUrl }),
 new Error(
 '@clerk/backend: Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 'Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.',
 ),
 );
 });
Expand Down

9 changes: 4 additions & 5 deletions
packages/backend/src/redirections.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { deprecated, errorThrower, parsePublishableKey } from './util/shared';
import { missingPublishableKeyErrorMessage } from './shared';
import { parsePublishableKey } from './shared';

type RedirectAdapter = (url: string) => any;

Expand DownExpand Up@@ -39,15 +40,13 @@ type RedirectParams = {
export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, publishableKey }: RedirectParams) {
 if (!frontendApi) {
 frontendApi = parsePublishableKey(publishableKey)?.frontendApi;
 } else {
 deprecated('frontentApi', 'Use `publishableKey` instead.');
 }

 const accountsBaseUrl = buildAccountsBaseUrl(frontendApi);

 const redirectToSignUp = ({ returnBackUrl }: SignUpParams = {}) => {
 if (!signUpUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignUpUrl = `${accountsBaseUrl}/sign-up`;
Expand All@@ -56,7 +55,7 @@ export function redirect({ redirectAdapter, signUpUrl, signInUrl, frontendApi, p

 const redirectToSignIn = ({ returnBackUrl }: SignInParams = {}) => {
 if (!signInUrl && !accountsBaseUrl) {
errorThrower.throwMissingPublishableKeyError();
throw new Error(missingPublishableKeyErrorMessage);
 }

 const accountsSignInUrl = `${accountsBaseUrl}/sign-in`;
Expand Down

23 changes: 23 additions & 0 deletions
packages/backend/src/shared/callWithRetry.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
function wait(ms: number) {
 return new Promise(res => setTimeout(res, ms));
}

const MAX_NUMBER_OF_RETRIES = 5;

// TODO: Move this to @clerk/shared and reuse it with @clerk/clerk-js
export async function callWithRetry<T>(
 fn: (...args: unknown[]) => Promise<T>,
 attempt = 1,
 maxAttempts = MAX_NUMBER_OF_RETRIES,
): Promise<T> {
 try {
 return await fn();
 } catch (e) {
 if (attempt >= maxAttempts) {
 throw e;
 }
 await wait(2 ** attempt * 100);

 return callWithRetry(fn, attempt + 1);
 }
}

15 changes: 15 additions & 0 deletions
packages/backend/src/shared/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
/*
 * This module will contain functionality that will be copied
 * from @clerk/shared and will be replaced by imports when the
 * bundling issue is fixed.
 */
export { isDevelopmentFromApiKey, isProductionFromApiKey, isStaging } from './instance';

export { addClerkPrefix, getScriptUrl, getClerkJsMajorVersionOrTag } from './url';
export { callWithRetry } from './callWithRetry';

// TODO: replace it with @clerk/shared errorThrower.throwMissingPublishableKeyError()
export const missingPublishableKeyErrorMessage = `Missing publishableKey. You can get your key at https://dashboard.clerk.com/last-active?path=api-keys.`;

export { isDevOrStagingUrl } from './isDevOrStagingUrl';
export { buildPublishableKey, isPublishableKey, parsePublishableKey } from './parsePublishableKey';

16 changes: 16 additions & 0 deletions
packages/backend/src/shared/instance.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
export function isDevelopmentFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('test_') || apiKey.startsWith('sk_test_');
}

export function isProductionFromApiKey(apiKey: string): boolean {
 return apiKey.startsWith('live_') || apiKey.startsWith('sk_live_');
}

export function isStaging(frontendApi: string): boolean {
 return (
 frontendApi.endsWith('.lclstage.dev') ||
 frontendApi.endsWith('.stgstage.dev') ||
 frontendApi.endsWith('.clerkstage.dev') ||
 frontendApi.endsWith('.accountsstage.dev')
 );
}

35 changes: 35 additions & 0 deletions
packages/backend/src/shared/isDevOrStagingUrl.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
// TODO: use the same function from @clerk/shared once treeshakable
function createDevOrStagingUrlCache() {
 const DEV_OR_STAGING_SUFFIXES = [
 '.lcl.dev',
 '.stg.dev',
 '.lclstage.dev',
 '.stgstage.dev',
 '.dev.lclclerk.com',
 '.stg.lclclerk.com',
 '.accounts.lclclerk.com',
 'accountsstage.dev',
 'accounts.dev',
 ];

 const devOrStagingUrlCache = new Map<string, boolean>();

 return {
 isDevOrStagingUrl: (url: string | URL): boolean => {
 if (!url) {
 return false;
 }

 const hostname = typeof url === 'string' ? url : url.hostname;
 let res = devOrStagingUrlCache.get(hostname);
 if (res === undefined) {
 res = DEV_OR_STAGING_SUFFIXES.some(s => hostname.endsWith(s));
 devOrStagingUrlCache.set(hostname, res);
 }
 return res;
 },
 };
}

const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
export { isDevOrStagingUrl };

56 changes: 56 additions & 0 deletions
packages/backend/src/shared/parsePublishableKey.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
import type { PublishableKey } from '@clerk/types';

const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
const PUBLISHABLE_KEY_TEST_PREFIX = 'pk_test_';

// This regex matches the publishable like frontend API keys (e.g. foo-bar-13.clerk.accounts.dev)
const PUBLISHABLE_FRONTEND_API_DEV_REGEX = /^(([a-z]+)-){2}([0-9]{1,2})\.clerk\.accounts([a-z.]*)(dev|com)$/i;

export function buildPublishableKey(frontendApi: string): string {
 const keyPrefix = PUBLISHABLE_FRONTEND_API_DEV_REGEX.test(frontendApi)
 ? PUBLISHABLE_KEY_TEST_PREFIX
 : PUBLISHABLE_KEY_LIVE_PREFIX;
 return `${keyPrefix}${btoa(`${frontendApi}$`)}`;
}

export function parsePublishableKey(key: string | undefined): PublishableKey | null {
 key = key || '';

 if (!isPublishableKey(key)) {
 return null;
 }

 const instanceType = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) ? 'production' : 'development';

 let frontendApi = isomorphicAtob(key.split('_')[2]);

 if (!frontendApi.endsWith('$')) {
 return null;
 }

 frontendApi = frontendApi.slice(0, -1);

 return {
 instanceType,
 frontendApi,
 };
}

export function isPublishableKey(key: string) {
 key = key || '';

 const hasValidPrefix = key.startsWith(PUBLISHABLE_KEY_LIVE_PREFIX) || key.startsWith(PUBLISHABLE_KEY_TEST_PREFIX);

 const hasValidFrontendApiPostfix = isomorphicAtob(key.split('_')[2] || '').endsWith('$');

 return hasValidPrefix && hasValidFrontendApiPostfix;
}

const isomorphicAtob = (data: string) => {
 if (typeof atob !== 'undefined' && typeof atob === 'function') {
 return atob(data);
 } else if (typeof globalThis !== 'undefined' && globalThis.Buffer) {
 return new globalThis.Buffer(data, 'base64').toString();
 }
 return data;
};
Loading