refactor(clerk-js,nextjs,shared): Move account portal utils to shared…

… package
clerk · Oct 31, 2023 · 1318b2f · 1318b2f
1 parent 86133f1
commit 1318b2f
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 65 deletions.
diff --git a/packages/clerk-js/src/utils/url.ts b/packages/clerk-js/src/utils/url.ts
@@ -1,4 +1,9 @@
-import { camelToSnake, createDevOrStagingUrlCache } from '@clerk/shared';
+import {
+  camelToSnake,
+  createDevOrStagingUrlCache,
+  isCurrentDevAccountPortalOrigin,
+  isLegacyDevAccountPortalOrigin,
+} from '@clerk/shared';
 import { globs } from '@clerk/shared/globs';
 import type { SignUpResource } from '@clerk/types';
 
@@ -28,9 +33,6 @@ export const DEV_OR_STAGING_SUFFIXES = [
   'accounts.dev',
 ];
 
-export const LEGACY_DEV_SUFFIXES = ['.lcl.dev', '.lclstage.dev', '.lclclerk.com'];
-export const CURRENT_DEV_SUFFIXES = ['.accounts.dev', '.accountsstage.dev', '.accounts.lclclerk.com'];
-
 const BANNED_URI_PROTOCOLS = ['javascript:'] as const;
 
 const { isDevOrStagingUrl } = createDevOrStagingUrlCache();
@@ -52,28 +54,6 @@ export function isDevAccountPortalOrigin(hostname: string = window.location.host
   return res;
 }
 
-// Returns true for hosts such as:
-// * accounts.foo.bar-13.lcl.dev
-// * accounts.foo.bar-13.lclstage.dev
-// * accounts.foo.bar-13.dev.lclclerk.com
-function isLegacyDevAccountPortalOrigin(host: string): boolean {
-  return LEGACY_DEV_SUFFIXES.some(legacyDevSuffix => {
-    return host.startsWith('accounts.') && host.endsWith(legacyDevSuffix);
-  });
-}
-
-// Returns true for hosts such as:
-// * foo-bar-13.accounts.dev
-// * foo-bar-13.accountsstage.dev
-// * foo-bar-13.accounts.lclclerk.com
-// But false for:
-// * foo-bar-13.clerk.accounts.lclclerk.com
-function isCurrentDevAccountPortalOrigin(host: string): boolean {
-  return CURRENT_DEV_SUFFIXES.some(currentDevSuffix => {
-    return host.endsWith(currentDevSuffix) && !host.endsWith('.clerk' + currentDevSuffix);
-  });
-}
-
 export function getETLDPlusOneFromFrontendApi(frontendApi: string): string {
   return frontendApi.replace('clerk.', '');
 }

diff --git a/packages/nextjs/src/server/url.ts b/packages/nextjs/src/server/url.ts
@@ -1,8 +1,4 @@
-// TODO: This is a partial duplicate of part of packages/clerk-js/src/utils/url.ts
-// TODO: To be removed when we can extract this utility to @clerk/shared
-
-export const LEGACY_DEV_SUFFIXES = ['.lcl.dev', '.lclstage.dev', '.lclclerk.com'];
-export const CURRENT_DEV_SUFFIXES = ['.accounts.dev', '.accountsstage.dev', '.accounts.lclclerk.com'];
+import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared';
 
 const accountPortalCache = new Map<string, boolean>();
 
@@ -20,25 +16,3 @@ export function isDevAccountPortalOrigin(hostname: string): boolean {
 
   return res;
 }
-
-// Returns true for hosts such as:
-// * accounts.foo.bar-13.lcl.dev
-// * accounts.foo.bar-13.lclstage.dev
-// * accounts.foo.bar-13.dev.lclclerk.com
-function isLegacyDevAccountPortalOrigin(host: string): boolean {
-  return LEGACY_DEV_SUFFIXES.some(legacyDevSuffix => {
-    return host.startsWith('accounts.') && host.endsWith(legacyDevSuffix);
-  });
-}
-
-// Returns true for hosts such as:
-// * foo-bar-13.accounts.dev
-// * foo-bar-13.accountsstage.dev
-// * foo-bar-13.accounts.lclclerk.com
-// But false for:
-// * foo-bar-13.clerk.accounts.lclclerk.com
-function isCurrentDevAccountPortalOrigin(host: string): boolean {
-  return CURRENT_DEV_SUFFIXES.some(currentDevSuffix => {
-    return host.endsWith(currentDevSuffix) && !host.endsWith('.clerk' + currentDevSuffix);
-  });
-}
diff --git a/packages/shared/src/constants.ts b/packages/shared/src/constants.ts
@@ -1,11 +1,2 @@
-export const DEV_SUFFIXES = [
-  '.lcl.dev',
-  '.lclstage.dev',
-  '.dev.lclclerk.com',
-  '.accounts.lclclerk.com',
-  '.stg.lclclerk.com',
-];
-
-export const STAGING_SUFFIXES = ['.stg.dev', '.stgstage.dev', 'accountsstage.dev'];
-
-export const DEV_OR_STAGING_SUFFIXES = [...DEV_SUFFIXES, ...STAGING_SUFFIXES];
+export const LEGACY_DEV_SUFFIXES = ['.lcl.dev', '.lclstage.dev', '.lclclerk.com'];
+export const CURRENT_DEV_SUFFIXES = ['.accounts.dev', '.accountsstage.dev', '.accounts.lclclerk.com'];
diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts
@@ -13,6 +13,7 @@ export * from './utils';
 export * from './browser';
 export { callWithRetry } from './callWithRetry';
 export * from './color';
+export * from './constants';
 export * from './date';
 export * from './deprecated';
 export * from './error';

diff --git a/packages/shared/src/keys.ts b/packages/shared/src/keys.ts
@@ -1,6 +1,5 @@
 import type { PublishableKey } from '@clerk/types';
 
-import { DEV_OR_STAGING_SUFFIXES } from './constants';
 import { isomorphicAtob } from './isomorphicAtob';
 
 const PUBLISHABLE_KEY_LIVE_PREFIX = 'pk_live_';
@@ -57,6 +56,18 @@ export function isLegacyFrontendApiKey(key: string) {
 
 export function createDevOrStagingUrlCache() {
   // TODO: Check if we can merge it with `./instance.ts#isStaging()`
+  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 {

diff --git a/packages/shared/src/url.ts b/packages/shared/src/url.ts
@@ -1,3 +1,4 @@
+import { CURRENT_DEV_SUFFIXES, LEGACY_DEV_SUFFIXES } from './constants';
 import { isStaging } from './utils/instance';
 
 export function parseSearchParams(queryString = ''): URLSearchParams {
@@ -64,3 +65,25 @@ export const getScriptUrl = (
   const major = getClerkJsMajorVersionOrTag(frontendApi, pkgVersion);
   return `https://${noSchemeFrontendApi}/npm/@clerk/clerk-js@${clerkJSVersion || major}/dist/clerk.browser.js`;
 };
+
+// Returns true for hosts such as:
+// * accounts.foo.bar-13.lcl.dev
+// * accounts.foo.bar-13.lclstage.dev
+// * accounts.foo.bar-13.dev.lclclerk.com
+export function isLegacyDevAccountPortalOrigin(host: string): boolean {
+  return LEGACY_DEV_SUFFIXES.some(legacyDevSuffix => {
+    return host.startsWith('accounts.') && host.endsWith(legacyDevSuffix);
+  });
+}
+
+// Returns true for hosts such as:
+// * foo-bar-13.accounts.dev
+// * foo-bar-13.accountsstage.dev
+// * foo-bar-13.accounts.lclclerk.com
+// But false for:
+// * foo-bar-13.clerk.accounts.lclclerk.com
+export function isCurrentDevAccountPortalOrigin(host: string): boolean {
+  return CURRENT_DEV_SUFFIXES.some(currentDevSuffix => {
+    return host.endsWith(currentDevSuffix) && !host.endsWith('.clerk' + currentDevSuffix);
+  });
+}