chore(*): Enforce publishableKey to IsomorphicClerkOptions

clerk · Nov 16, 2023 · acafd5b · acafd5b
1 parent cc7cfba
commit acafd5b
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 16 deletions.
diff --git a/integration/tests/next-build.test.ts b/integration/tests/next-build.test.ts
@@ -6,7 +6,6 @@ import { appConfigs } from '../presets';
 test.describe('next build @nextjs', () => {
   test.describe.configure({ mode: 'parallel' });
   let app: Application;
-  const output = [];
 
   test.beforeAll(async () => {
     app = await appConfigs.next.appRouter

diff --git a/packages/expo/src/ClerkProvider.tsx b/packages/expo/src/ClerkProvider.tsx
@@ -13,7 +13,10 @@ __internal__setErrorThrowerOptions({
   packageName: '@clerk/expo',
 });
 
-export type ClerkProviderProps = ClerkReactProviderProps & {
+type ClerkReactProviderOptionalPK = Exclude<ClerkReactProviderProps, 'publishableKey'> &
+  Partial<Pick<ClerkReactProviderProps, 'publishableKey'>>;
+
+export type ClerkProviderProps = ClerkReactProviderOptionalPK & {
   tokenCache?: TokenCache;
 };
 
@@ -27,6 +30,7 @@ export function ClerkProvider(props: ClerkProviderProps): JSX.Element {
       // See JS-598 for additional context.
       key={key}
       {...rest}
+      publishableKey={key}
       Clerk={buildClerk({ key, tokenCache })}
       standardBrowser={!isReactNative()}
     >

diff --git a/packages/nextjs/src/pages/ClerkProvider.tsx b/packages/nextjs/src/pages/ClerkProvider.tsx
@@ -39,7 +39,6 @@ export function ClerkProvider({ children, ...props }: NextClerkProviderProps): J
 
   return (
     <ClerkNextOptionsProvider options={mergedProps}>
-      {/*@ts-expect-error*/}
       <ReactClerkProvider
         {...mergedProps}
         initialState={initialState}

diff --git a/packages/nextjs/src/types.ts b/packages/nextjs/src/types.ts
@@ -1,4 +1,5 @@
-import type { IsomorphicClerkOptions } from '@clerk/clerk-react';
+import type { ClerkProviderProps } from '@clerk/clerk-react';
+import type { MultiDomainAndOrProxy } from '@clerk/types';
 import type React from 'react';
 
 export type NextClerkProviderProps = {
@@ -12,4 +13,5 @@ export type NextClerkProviderProps = {
    * @default true
    */
   __unstable_invokeMiddlewareOnAuthStateChange?: boolean;
-} & IsomorphicClerkOptions;
+} & Partial<ClerkProviderProps> &
+  MultiDomainAndOrProxy;
diff --git a/packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts b/packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
@@ -8,9 +8,9 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
     publishableKey: props.publishableKey || process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY || '',
     clerkJSUrl: props.clerkJSUrl || process.env.NEXT_PUBLIC_CLERK_JS,
     clerkJSVersion: props.clerkJSVersion || process.env.NEXT_PUBLIC_CLERK_JS_VERSION,
-    proxyUrl: props.proxyUrl || process.env.NEXT_PUBLIC_CLERK_PROXY_URL || '',
-    domain: props.domain || process.env.NEXT_PUBLIC_CLERK_DOMAIN || '',
-    isSatellite: props.isSatellite || isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE),
+    proxyUrl: props.proxyUrl || (process.env.NEXT_PUBLIC_CLERK_PROXY_URL as any), // added as any to cater issue with type resolution
+    domain: props.domain || (process.env.NEXT_PUBLIC_CLERK_DOMAIN as any), // added as any to cater issue with type resolution
+    isSatellite: props.isSatellite || (isTruthy(process.env.NEXT_PUBLIC_CLERK_IS_SATELLITE) as any), // added as any to cater issue with type resolution
     signInUrl: props.signInUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL || '',
     signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
     afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',

diff --git a/packages/react/src/types.ts b/packages/react/src/types.ts
@@ -28,7 +28,7 @@ export type IsomorphicClerkOptions = Omit<ClerkOptions, 'isSatellite'> & {
   clerkJSVariant?: 'headless' | '';
   clerkJSVersion?: string;
   sdkMetadata?: SDKMetadata;
-  publishableKey?: string;
+  publishableKey: string;
 } & MultiDomainAndOrProxy;
 
 export interface BrowserClerkConstructor {

diff --git a/packages/types/src/clerk.ts b/packages/types/src/clerk.ts
@@ -13,6 +13,7 @@ import type { ClientResource } from './client';
 import type { CustomPage } from './customPages';
 import type { DisplayThemeJSON } from './json';
 import type { LocalizationResource } from './localization';
+import type { MultiDomainAndOrProxy } from './multiDomain';
 import type { OAuthProvider, OAuthScope } from './oauth';
 import type { OrganizationResource } from './organization';
 import type { MembershipRole } from './organizationMembership';
@@ -524,7 +525,7 @@ export interface ClerkOptions {
    * Defaults to false
    */
   isInterstitial?: boolean;
-  isSatellite?: boolean | ((url: URL) => boolean);
+  isSatellite?: MultiDomainAndOrProxy['isSatellite'];
 }
 
 export interface Resources {

diff --git a/packages/types/src/multiDomain.ts b/packages/types/src/multiDomain.ts
@@ -1,9 +1,7 @@
-import type { ClerkOptions } from './clerk';
-
 type StringOrURLFnToString = string | ((url: URL) => string);
 
 /**
- * DomainOrProxyUrl supports the following cases
+ * MultiDomainAndOrProxy supports the following cases
  * 1) none of them are set
  * 2) only proxyUrl is set
  * 3) isSatellite and proxy is set
@@ -12,16 +10,16 @@ type StringOrURLFnToString = string | ((url: URL) => string);
 export type MultiDomainAndOrProxy =
   | {
       isSatellite?: never;
-      proxyUrl?: never | StringOrURLFnToString;
+      proxyUrl?: StringOrURLFnToString;
       domain?: never;
     }
   | {
-      isSatellite: Exclude<ClerkOptions['isSatellite'], undefined>;
+      isSatellite: boolean | ((url: URL) => boolean);
       proxyUrl?: never;
       domain: StringOrURLFnToString;
     }
   | {
-      isSatellite: Exclude<ClerkOptions['isSatellite'], undefined>;
+      isSatellite: boolean | ((url: URL) => boolean);
       proxyUrl: StringOrURLFnToString;
       domain?: never;
     };