feat(remix,backend): Repo level config for remix (#1470)

* feat(remix,backend): Repo level config for remix * fix(remix): Remove unused utility * fix(remix): Add ClerkState missing types * test(backend,remix): Update tests * chore(repo): Changeset
clerk · Aug 4, 2023 · 30fcdd5 · 30fcdd5
1 parent bc07de9
commit 30fcdd5
Show file tree

Hide file tree

Showing 11 changed files with 107 additions and 4 deletions.
diff --git a/.changeset/nine-peas-care.md b/.changeset/nine-peas-care.md
@@ -0,0 +1,5 @@
+---
+'@clerk/remix': minor
+---
+
+Configure sign in/up and afterSignIn/Up paths for remix via env variables.
diff --git a/.changeset/wicked-schools-tell.md b/.changeset/wicked-schools-tell.md
@@ -0,0 +1,5 @@
+---
+'@clerk/backend': minor
+---
+
+Include `signUpUrl`, `afterSignInUrl` and `afterSignUpUrl` to `authenticateRequest` options.
diff --git a/packages/backend/src/tokens/authStatus.ts b/packages/backend/src/tokens/authStatus.ts
@@ -22,6 +22,9 @@ export type SignedInState = {
   isSatellite: boolean;
   domain: string;
   signInUrl: string;
+  signUpUrl: string;
+  afterSignInUrl: string;
+  afterSignUpUrl: string;
   isSignedIn: true;
   isInterstitial: false;
   isUnknown: false;
@@ -38,6 +41,9 @@ export type SignedOutState = {
   isSatellite: boolean;
   domain: string;
   signInUrl: string;
+  signUpUrl: string;
+  afterSignInUrl: string;
+  afterSignUpUrl: string;
   isSignedIn: false;
   isInterstitial: false;
   isUnknown: false;
@@ -94,6 +100,9 @@ export async function signedIn<T>(options: T, sessionClaims: JwtPayload): Promis
     loadUser,
     loadOrganization,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
   } = options as any;
 
   const { sid: sessionId, org_id: orgId, sub: userId } = sessionClaims;
@@ -143,6 +152,9 @@ export async function signedIn<T>(options: T, sessionClaims: JwtPayload): Promis
     domain,
     isSatellite,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
     isSignedIn: true,
     isInterstitial: false,
     isUnknown: false,
@@ -151,7 +163,17 @@ export async function signedIn<T>(options: T, sessionClaims: JwtPayload): Promis
 }
 
 export function signedOut<T>(options: T, reason: AuthReason, message = ''): SignedOutState {
-  const { frontendApi, publishableKey, proxyUrl, isSatellite, domain, signInUrl } = options as any;
+  const {
+    frontendApi,
+    publishableKey,
+    proxyUrl,
+    isSatellite,
+    domain,
+    signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
+  } = options as any;
 
   return {
     status: AuthStatus.SignedOut,
@@ -163,6 +185,9 @@ export function signedOut<T>(options: T, reason: AuthReason, message = ''): Sign
     isSatellite,
     domain,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
     isSignedIn: false,
     isInterstitial: false,
     isUnknown: false,
@@ -171,7 +196,17 @@ export function signedOut<T>(options: T, reason: AuthReason, message = ''): Sign
 }
 
 export function interstitial<T>(options: T, reason: AuthReason, message = ''): InterstitialState {
-  const { frontendApi, publishableKey, proxyUrl, isSatellite, domain, signInUrl } = options as any;
+  const {
+    frontendApi,
+    publishableKey,
+    proxyUrl,
+    isSatellite,
+    domain,
+    signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
+  } = options as any;
   return {
     status: AuthStatus.Interstitial,
     reason,
@@ -182,6 +217,9 @@ export function interstitial<T>(options: T, reason: AuthReason, message = ''): I
     domain,
     proxyUrl,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
     isSignedIn: false,
     isInterstitial: true,
     isUnknown: false,
@@ -190,7 +228,8 @@ export function interstitial<T>(options: T, reason: AuthReason, message = ''): I
 }
 
 export function unknownState<T>(options: T, reason: AuthReason, message = ''): UnknownState {
-  const { frontendApi, publishableKey, isSatellite, domain, signInUrl } = options as any;
+  const { frontendApi, publishableKey, isSatellite, domain, signInUrl, signUpUrl, afterSignInUrl, afterSignUpUrl } =
+    options as any;
   return {
     status: AuthStatus.Unknown,
     reason,
@@ -200,6 +239,9 @@ export function unknownState<T>(options: T, reason: AuthReason, message = ''): U
     isSatellite,
     domain,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
     isSignedIn: false,
     isInterstitial: false,
     isUnknown: true,

diff --git a/packages/backend/src/tokens/request.test.ts b/packages/backend/src/tokens/request.test.ts
@@ -30,6 +30,9 @@ function assertSignedOut(
     isUnknown: false,
     isSatellite: false,
     signInUrl: '',
+    signUpUrl: '',
+    afterSignInUrl: '',
+    afterSignUpUrl: '',
     domain: '',
     message: '',
     toAuth: {},
@@ -72,6 +75,9 @@ function assertInterstitial(
     isUnknown: false,
     isSatellite: false,
     signInUrl: '',
+    signUpUrl: '',
+    afterSignInUrl: '',
+    afterSignUpUrl: '',
     domain: '',
     toAuth: {},
     ...expectedState,
@@ -88,6 +94,9 @@ function assertUnknown(assert, requestState: RequestState, reason: AuthReason) {
     isUnknown: true,
     isSatellite: false,
     signInUrl: '',
+    signUpUrl: '',
+    afterSignInUrl: '',
+    afterSignUpUrl: '',
     domain: '',
     reason,
     toAuth: {},
@@ -128,6 +137,9 @@ function assertSignedIn(
     isUnknown: false,
     isSatellite: false,
     signInUrl: '',
+    signUpUrl: '',
+    afterSignInUrl: '',
+    afterSignUpUrl: '',
     domain: '',
     ...expectedState,
   });
@@ -150,6 +162,9 @@ export default (QUnit: QUnit) => {
     skipJwksCache: true,
     isSatellite: false,
     signInUrl: '',
+    signUpUrl: '',
+    afterSignInUrl: '',
+    afterSignUpUrl: '',
     domain: '',
     searchParams: new URLSearchParams(),
   } satisfies AuthenticateRequestOptions;

diff --git a/packages/backend/src/tokens/request.ts b/packages/backend/src/tokens/request.ts
@@ -101,6 +101,9 @@ export type AuthenticateRequestOptions = OptionalVerifyTokenOptions &
      * @experimental
      */
     signInUrl?: string;
+    signUpUrl?: string;
+    afterSignInUrl?: string;
+    afterSignUpUrl?: string;
     request?: Request;
   };
 

diff --git a/packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts b/packages/nextjs/src/utils/mergeNextClerkPropsWithEnv.ts
@@ -14,5 +14,5 @@ export const mergeNextClerkPropsWithEnv = (props: Omit<NextClerkProviderProps, '
     signUpUrl: props.signUpUrl || process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL || '',
     afterSignInUrl: props.afterSignInUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL || '',
     afterSignUpUrl: props.afterSignUpUrl || process.env.NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL || '',
-  } as any as NextClerkProviderProps;
+  } as unknown as NextClerkProviderProps;
 };
diff --git a/packages/remix/src/client/RemixClerkProvider.tsx b/packages/remix/src/client/RemixClerkProvider.tsx
@@ -46,6 +46,9 @@ export function ClerkProvider({ children, ...rest }: RemixClerkProviderProps): J
     __isSatellite,
     __clerk_debug,
     __signInUrl,
+    __signUpUrl,
+    __afterSignInUrl,
+    __afterSignUpUrl,
     __clerkJSUrl,
     __clerkJSVersion,
   } = clerkState?.__internal_clerk_state || {};
@@ -68,6 +71,9 @@ export function ClerkProvider({ children, ...rest }: RemixClerkProviderProps): J
       domain={__domain as any}
       isSatellite={__isSatellite}
       signInUrl={__signInUrl}
+      signUpUrl={__signUpUrl}
+      afterSignInUrl={__afterSignInUrl}
+      afterSignUpUrl={__afterSignUpUrl}
       clerkJSUrl={__clerkJSUrl}
       clerkJSVersion={__clerkJSVersion}
       {...restProps}

diff --git a/packages/remix/src/client/types.ts b/packages/remix/src/client/types.ts
@@ -11,6 +11,9 @@ export type ClerkState = {
     __domain: string | undefined;
     __isSatellite: boolean;
     __signInUrl: string | undefined;
+    __signUpUrl: string | undefined;
+    __afterSignInUrl: string | undefined;
+    __afterSignUpUrl: string | undefined;
     __clerk_debug: any;
     __clerkJSUrl: string | undefined;
     __clerkJSVersion: string | undefined;

diff --git a/packages/remix/src/ssr/authenticateRequest.ts b/packages/remix/src/ssr/authenticateRequest.ts
@@ -73,6 +73,21 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
   const signInUrl =
     opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 
+  const signUpUrl =
+    opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
+
+  const afterSignInUrl =
+    opts.afterSignInUrl ||
+    getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
+    (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
+    '';
+
+  const afterSignUpUrl =
+    opts.afterSignUpUrl ||
+    getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
+    (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
+    '';
+
   if (isSatellite && !proxyUrl && !domain) {
     throw new Error(satelliteAndMissingProxyUrlAndDomain);
   }
@@ -96,6 +111,9 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
     isSatellite,
     domain,
     signInUrl,
+    signUpUrl,
+    afterSignInUrl,
+    afterSignUpUrl,
     request,
   });
 }
diff --git a/packages/remix/src/ssr/types.ts b/packages/remix/src/ssr/types.ts
@@ -21,6 +21,9 @@ export type RootAuthLoaderOptions = {
   loadOrganization?: boolean;
   authorizedParties?: [];
   signInUrl?: string;
+  signUpUrl?: string;
+  afterSignInUrl?: string;
+  afterSignUpUrl?: string;
 } & Pick<VerifyTokenOptions, 'audience'> &
   MultiDomainAndOrProxy;
 

diff --git a/packages/remix/src/ssr/utils.ts b/packages/remix/src/ssr/utils.ts
@@ -110,6 +110,9 @@ export const injectRequestStateIntoResponse = async (response: Response, request
     __domain: requestState.domain,
     __isSatellite: requestState.isSatellite,
     __signInUrl: requestState.signInUrl,
+    __signUpUrl: requestState.signUpUrl,
+    __afterSignInUrl: requestState.afterSignInUrl,
+    __afterSignUpUrl: requestState.afterSignUpUrl,
     __clerk_debug: debugRequestState(requestState),
     __clerkJSUrl: getEnvVariable('CLERK_JS'),
     __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),