fix issue where cookieName isn't always used, fix types

Author: nicknisi

src/interfaces.ts

@@ -40,12 +40,19 @@ export interface GetAuthURLOptions {
   returnPathname?: string;
 }
 
-export interface AuthKitLoaderOptions {
+export type AuthKitLoaderOptions = {
   ensureSignedIn?: boolean;
   debug?: boolean;
-  storage?: SessionStorage;
-  cookie?: SessionIdStorageStrategy['cookie'];
-}
+} & (
+  | {
+      storage?: never;
+      cookie?: SessionIdStorageStrategy['cookie'];
+    }
+  | {
+      storage: SessionStorage;
+      cookie: SessionIdStorageStrategy['cookie'];
+    }
+);
 
 export interface AuthorizedData {
   user: User;

src/session.ts

@@ -1,6 +1,6 @@
 import type { LoaderFunctionArgs, SessionData, TypedResponse } from '@remix-run/node';
 import { json, redirect } from '@remix-run/node';
-import { WORKOS_CLIENT_ID, WORKOS_COOKIE_PASSWORD } from './env-variables.js';
+import { WORKOS_CLIENT_ID, WORKOS_COOKIE_NAME, WORKOS_COOKIE_PASSWORD } from './env-variables.js';
 import { getAuthorizationUrl } from './get-authorization-url.js';
 import type { AccessToken, AuthKitLoaderOptions, AuthorizedData, Session, UnauthorizedData } from './interfaces.js';
 import { workos } from './workos.js';
@@ -123,7 +123,8 @@ async function authkitLoader<Data = unknown>(
     cookie,
   } = typeof loaderOrOptions === 'object' ? loaderOrOptions : options;
 
-  const { getSession, destroySession } = await configureSessionStorage({ storage, cookieName: cookie?.name });
+  const cookieName = cookie?.name ?? WORKOS_COOKIE_NAME ?? 'wos-session';
+  const { getSession, destroySession } = await configureSessionStorage({ storage, cookieName });
 
   const { request } = loaderArgs;
   const session = await updateSession(request, debug);

src/sessionStorage.spec.ts

@@ -67,7 +67,7 @@ describe('SessionStorageManager', () => {
         storage: createMemorySessionStorage({ cookie }),
         cookieName: '_cookie',
       });
-      expect(cookieName).toBe('wos-session');
+      expect(cookieName).toBe('_cookie');
       expect(getSession).toBeDefined();
       expect(commitSession).toBeDefined();
       expect(destroySession).toBeDefined();

src/sessionStorage.ts

@@ -6,10 +6,9 @@ import {
   WORKOS_COOKIE_NAME,
 } from './env-variables.js';
 
-interface SessionStorageConfig {
-  storage?: SessionStorage;
-  cookieName?: string;
-}
+type SessionStorageConfig = { storage?: never; cookieName?: string } | { storage: SessionStorage; cookieName: string };
+
+const DEFAULT_COOKIE_NAME = WORKOS_COOKIE_NAME || 'wos-session';
 
 export const errors = {
   configureSessionStorage:
@@ -25,11 +24,10 @@ export class SessionStorageManager {
   /**
    * The default cookie name used for storing the session id.
    */
-  static readonly DEFAULT_COOKIE_NAME = 'wos-session';
 
   private storage: SessionStorage | null = null;
   private configPromise: Promise<void> | null = null;
-  private cookieName: string = SessionStorageManager.DEFAULT_COOKIE_NAME;
+  private cookieName: string = DEFAULT_COOKIE_NAME;
 
   async configure(config: SessionStorageConfig = {}) {
     if (!this.configPromise) {
@@ -58,15 +56,15 @@ export class SessionStorageManager {
     return { ...storage, cookieName };
   }
 
-  private createSessionStorage({ storage, cookieName }: SessionStorageConfig = {}): SessionStorage {
-    if (storage) {
-      return storage;
-    }
-
+  private createSessionStorage({ storage, cookieName }: SessionStorageConfig): SessionStorage {
     if (cookieName) {
       this.cookieName = cookieName;
     }
 
+    if (storage) {
+      return storage;
+    }
+
     const cookieOptions = {
       ...this.getDefaultCookieOptions(),
       ...(cookieName ? { name: cookieName } : {}),
@@ -81,7 +79,7 @@ export class SessionStorageManager {
     const redirectUrl = new URL(WORKOS_REDIRECT_URI);
     const isSecureProtocol = redirectUrl.protocol === 'https:';
     return {
-      name: WORKOS_COOKIE_NAME || SessionStorageManager.DEFAULT_COOKIE_NAME,
+      name: this.cookieName,
       path: '/',
       httpOnly: true,
       secure: isSecureProtocol,