feat(backend,nextjs,utils): Remove interstitial

clerk · Nov 29, 2023 · c5a06aa · c5a06aa
1 parent 89bc8ab
commit c5a06aa
Show file tree

Hide file tree

Showing 12 changed files with 292 additions and 463 deletions.
diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
@@ -28,7 +28,7 @@ export type ClerkOptions = CreateBackendApiOptions &
 export function Clerk(options: ClerkOptions) {
   const opts = { ...options };
   const apiClient = createBackendApiClient(opts);
-  const requestState = createAuthenticateRequest({ options: opts, apiClient });
+  const requestState = createAuthenticateRequest({ options: opts });
   const telemetry = new TelemetryCollector({
     ...options.telemetry,
     publishableKey: opts.publishableKey,

diff --git a/packages/backend/src/tokens/authStatus.ts b/packages/backend/src/tokens/authStatus.ts
@@ -8,8 +8,8 @@ import type { TokenVerificationErrorReason } from './errors';
 export enum AuthStatus {
   SignedIn = 'signed-in',
   SignedOut = 'signed-out',
-  Interstitial = 'interstitial',
-  Unknown = 'unknown',
+  // will not be used
+  Handshake = 'handshake',
 }
 
 export type SignedInState = {
@@ -24,9 +24,6 @@ export type SignedInState = {
   signUpUrl: string;
   afterSignInUrl: string;
   afterSignUpUrl: string;
-  isSignedIn: true;
-  isInterstitial: false;
-  isUnknown: false;
   toAuth: () => SignedInAuthObject;
 };
 
@@ -42,24 +39,14 @@ export type SignedOutState = {
   signUpUrl: string;
   afterSignInUrl: string;
   afterSignUpUrl: string;
-  isSignedIn: false;
-  isInterstitial: false;
-  isUnknown: false;
   toAuth: () => SignedOutAuthObject;
 };
 
-export type InterstitialState = Omit<SignedOutState, 'isInterstitial' | 'status' | 'toAuth'> & {
-  status: AuthStatus.Interstitial;
-  isInterstitial: true;
+export type HandshakeState = Omit<SignedOutState, 'status' | 'toAuth'> & {
+  status: AuthStatus.Handshake;
   toAuth: () => null;
 };
 
-export type UnknownState = Omit<InterstitialState, 'status' | 'isInterstitial' | 'isUnknown'> & {
-  status: AuthStatus.Unknown;
-  isInterstitial: false;
-  isUnknown: true;
-};
-
 export enum AuthErrorReason {
   CookieAndUATMissing = 'cookie-and-uat-missing',
   CookieMissing = 'cookie-missing',
@@ -79,7 +66,7 @@ export enum AuthErrorReason {
 
 export type AuthReason = AuthErrorReason | TokenVerificationErrorReason;
 
-export type RequestState = SignedInState | SignedOutState | InterstitialState | UnknownState;
+export type RequestState = SignedInState | SignedOutState | HandshakeState;
 
 type LoadResourcesOptions = {
   loadSession?: boolean;
@@ -179,12 +166,10 @@ export async function signedIn<T extends AuthStatusOptionsType>(
     signUpUrl,
     afterSignInUrl,
     afterSignUpUrl,
-    isSignedIn: true,
-    isInterstitial: false,
-    isUnknown: false,
     toAuth: () => authObject,
   };
 }
+
 export function signedOut<T extends AuthStatusOptionsType>(
   options: T,
   reason: AuthReason,
@@ -213,49 +198,15 @@ export function signedOut<T extends AuthStatusOptionsType>(
     signUpUrl,
     afterSignInUrl,
     afterSignUpUrl,
-    isSignedIn: false,
-    isInterstitial: false,
-    isUnknown: false,
     toAuth: () => signedOutAuthObject({ ...options, status: AuthStatus.SignedOut, reason, message }),
   };
 }
 
-export function interstitial<T extends AuthStatusOptionsType>(
+export function handshake<T extends AuthStatusOptionsType>(
   options: T,
   reason: AuthReason,
   message = '',
-): InterstitialState {
-  const {
-    publishableKey = '',
-    proxyUrl = '',
-    isSatellite = false,
-    domain = '',
-    signInUrl = '',
-    signUpUrl = '',
-    afterSignInUrl = '',
-    afterSignUpUrl = '',
-  } = options;
-
-  return {
-    status: AuthStatus.Interstitial,
-    reason,
-    message,
-    publishableKey,
-    isSatellite,
-    domain,
-    proxyUrl,
-    signInUrl,
-    signUpUrl,
-    afterSignInUrl,
-    afterSignUpUrl,
-    isSignedIn: false,
-    isInterstitial: true,
-    isUnknown: false,
-    toAuth: () => null,
-  };
-}
-
-export function unknownState(options: AuthStatusOptionsType, reason: AuthReason, message = ''): UnknownState {
+): HandshakeState {
   const {
     publishableKey = '',
     proxyUrl = '',
@@ -268,7 +219,7 @@ export function unknownState(options: AuthStatusOptionsType, reason: AuthReason,
   } = options;
 
   return {
-    status: AuthStatus.Unknown,
+    status: AuthStatus.Handshake,
     reason,
     message,
     publishableKey,
@@ -279,9 +230,6 @@ export function unknownState(options: AuthStatusOptionsType, reason: AuthReason,
     signUpUrl,
     afterSignInUrl,
     afterSignUpUrl,
-    isSignedIn: false,
-    isInterstitial: false,
-    isUnknown: true,
     toAuth: () => null,
   };
 }
diff --git a/packages/backend/src/tokens/errors.ts b/packages/backend/src/tokens/errors.ts
@@ -22,8 +22,6 @@ export enum TokenVerificationErrorReason {
   RemoteJWKMissing = 'jwk-remote-missing',
 
   JWKFailedToResolve = 'jwk-failed-to-resolve',
-
-  RemoteInterstitialFailedToLoad = 'interstitial-remote-failed-to-load',
 }
 
 export enum TokenVerificationErrorAction {

diff --git a/packages/backend/src/tokens/factory.ts b/packages/backend/src/tokens/factory.ts
@@ -1,7 +1,4 @@
-import type { ApiClient } from '../api';
 import { mergePreDefinedOptions } from '../util/mergePreDefinedOptions';
-import type { LoadInterstitialOptions } from './interstitial';
-import { loadInterstitialFromLocal } from './interstitial';
 import type { AuthenticateRequestOptions } from './request';
 import { authenticateRequest as authenticateRequestOriginal, debugRequestState } from './request';
 
@@ -36,11 +33,9 @@ const defaultOptions = {
 
 export type CreateAuthenticateRequestOptions = {
   options: BuildTimeOptions;
-  apiClient: ApiClient;
 };
 
 export function createAuthenticateRequest(params: CreateAuthenticateRequestOptions) {
-  const { apiClient } = params;
   const buildTimeOptions = mergePreDefinedOptions(defaultOptions, params.options);
 
   const authenticateRequest = (options: RunTimeOptions) => {
@@ -56,18 +51,8 @@ export function createAuthenticateRequest(params: CreateAuthenticateRequestOptio
     });
   };
 
-  const localInterstitial = (options: Omit<LoadInterstitialOptions, 'apiUrl'>) => {
-    const runTimeOptions = mergePreDefinedOptions(buildTimeOptions, options);
-    return loadInterstitialFromLocal({ ...options, ...runTimeOptions });
-  };
-
-  // TODO: Replace this function with remotePublicInterstitial
-  const remotePrivateInterstitial = () => apiClient.interstitial.getInterstitial();
-
   return {
     authenticateRequest,
-    localInterstitial,
-    remotePrivateInterstitial,
     debugRequestState,
   };
 }