Merge branch 'main' into dependabot/npm_and_yarn/typedoc-0.24.4

src/auth0-session/config.ts

@@ -208,7 +208,10 @@ export interface SessionConfig {
    *
    * **IMPORTANT** You must use a suitably unique value to prevent collisions.
    */
-  genId?: <Req = any>(req: Req) => string | Promise<string>;
+  genId?: <Req = any, SessionType extends { [key: string]: any } = { [key: string]: any }>(
+    req: Req,
+    session: SessionType
+  ) => string | Promise<string>;
 
   /**
    * If you want your session duration to be rolling, resetting everytime the

src/auth0-session/get-config.ts

@@ -31,7 +31,7 @@ const paramsSchema = Joi.object({
     autoSave: Joi.boolean().optional().default(true),
     name: Joi.string().token().optional().default('appSession'),
     store: Joi.object().optional(),
-    genId: Joi.function().maxArity(1).when(Joi.ref('store'), { then: Joi.required() }),
+    genId: Joi.function().maxArity(2).when(Joi.ref('store'), { then: Joi.required() }),
     storeIDToken: Joi.boolean().optional().default(true),
     cookie: Joi.object({
       domain: Joi.string().optional(),

src/auth0-session/session/stateful-session.ts

@@ -85,7 +85,7 @@ export class StatefulSession<
     }
 
     if (!sessionId) {
-      sessionId = await genId!(req);
+      sessionId = await genId!(req, session);
       debug('generated new session id %o', sessionId);
     }
     debug('set session %o', sessionId);

src/config.ts

@@ -218,7 +218,10 @@ export interface SessionConfig {
    * **IMPORTANT** If you override this, you must use a suitable value from your platform to
    * prevent collisions. For example, for Node: `require('crypto').randomBytes(16).toString('hex')`.
    */
-  genId?: <Req = any>(req: Req) => string | Promise<string>;
+  genId?: <Req = any, SessionType extends { [key: string]: any } = { [key: string]: any }>(
+    req: Req,
+    session: SessionType
+  ) => string | Promise<string>;
 
   /**
    * If you want your session duration to be rolling, resetting everytime the

tests/auth0-session/session/stateful-session.test.ts

@@ -148,6 +148,17 @@ describe('StatefulSession', () => {
     expect(cookieJar.getCookieStringSync(baseURL)).toMatch(/^appSession=foobar\..+/);
   });
 
+  it('should provide current user session to custom session id generator', async () => {
+    const genId = jest.fn().mockImplementation((_req, session) => session.state);
+    const baseURL = await setup({ ...config, session: { ...config.session, genId } });
+    const cookieJar = await login(baseURL);
+    const genIdParams = genId.mock.calls.at(0);
+    expect(genIdParams.length).toEqual(2);
+    expect('id_token' in genIdParams.at(1)).toBeTruthy();
+    const regex = `^appSession=${genIdParams.at(1).state}\..+`;
+    expect(cookieJar.getCookieStringSync(baseURL)).toMatch(new RegExp(regex));
+  });
+
   it('should regenerate the session when a new user is logging in over an existing user', async () => {
     await store.set('foo', await getPayload());
     const baseURL = await setup(config);

tests/stateful-session.test.ts

@@ -98,4 +98,15 @@ describe('next stateful session', () => {
     expect(Object.keys(store)).toHaveLength(1);
     expect(cookieJar.getCookieStringSync(baseUrl)).toMatch(/^appSession=foo\..+/);
   });
+
+  it('should provide current user session to custom session id generator', async () => {
+    const genId = jest.fn().mockImplementation((_req, session) => session.user.nickname);
+    const baseURL = await setup({ ...config, session: { ...config.session, genId } });
+    const cookieJar = await login(baseURL);
+    const genIdParams = genId.mock.calls.at(0);
+    expect(genIdParams.length).toEqual(2);
+    expect('idToken' in genIdParams.at(1)).toBeTruthy();
+    expect('user' in genIdParams.at(1)).toBeTruthy();
+    expect(cookieJar.getCookieStringSync(baseURL)).toMatch(/^appSession=__test_nickname__\..+/);
+  });
 });