chore(shared,types): Move SharedSignedInAuthObjectProperties to @clerk/types

Author: octoper

packages/shared/src/__tests__/jwtPayloadParser.test.ts

@@ -11,16 +11,18 @@ const baseClaims = {
   __raw: '',
 };
 
-describe('resolveSignedInAuthStateFromJWTClaims', () => {
-  test.skip('produced auth object is the same for v1 and v2', () => {
+describe('JWTPayloadToAuthObjectProperties', () => {
+  test('produced auth object is the same for v1 and v2', () => {
     const { sessionClaims: v2Claims, ...signedInAuthObjectV2 } = JWTPayloadToAuthObjectProperties({
       ...baseClaims,
       v: 2,
+      fea: 'o:impersonation',
       o: {
         id: 'org_id',
         rol: 'admin',
         slg: 'org_slug',
-        per: 'permission1,permission2',
+        per: 'read,manage',
+        fpm: '3',
       },
     });
 
@@ -29,7 +31,7 @@ describe('resolveSignedInAuthStateFromJWTClaims', () => {
       org_id: 'org_id',
       org_role: 'admin',
       org_slug: 'org_slug',
-      org_permissions: ['org:permission1', 'permission2'],
+      org_permissions: ['org:impersonation:read', 'org:impersonation:manage'],
     });
     expect(signedInAuthObjectV1).toEqual(signedInAuthObjectV2);
   });

packages/shared/src/jwtPayloadParser.ts

@@ -1,32 +1,10 @@
 import type {
-  ActClaim,
   JwtPayload,
   OrganizationCustomPermissionKey,
   OrganizationCustomRoleKey,
-  SessionStatusClaim,
+  SharedSignedInAuthObjectProperties,
 } from '@clerk/types';
 
-/**
- * @internal
- */
-type SignedInAuthObjectProperties = {
-  sessionClaims: JwtPayload;
-  sessionId: string;
-  sessionStatus: SessionStatusClaim | null;
-  actor: ActClaim | undefined;
-  userId: string;
-  orgId: string | undefined;
-  orgRole: OrganizationCustomRoleKey | undefined;
-  orgSlug: string | undefined;
-  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
-  /**
-   * Factor Verification Age
-   * Each item represents the minutes that have passed since the last time a first or second factor were verified.
-   * [fistFactorAge, secondFactorAge]
-   */
-  factorVerificationAge: [firstFactorAge: number, secondFactorAge: number] | null;
-};
-
 const parseFeatures = (fea: string | undefined) => {
   const features = fea ? fea.split(',').map(f => f.trim()) : [];
 
@@ -100,7 +78,7 @@ function buildOrgPermissions({
  *
  * Resolves the signed-in auth state from JWT claims.
  */
-const __experimental_JWTPayloadToAuthObjectProperties = (claims: JwtPayload): SignedInAuthObjectProperties => {
+const __experimental_JWTPayloadToAuthObjectProperties = (claims: JwtPayload): SharedSignedInAuthObjectProperties => {
   let orgId: string | undefined;
   let orgRole: OrganizationCustomRoleKey | undefined;
   let orgSlug: string | undefined;

packages/types/src/authObject.ts

@@ -0,0 +1,23 @@
+import type { ActClaim, JwtPayload, SessionStatusClaim } from './jwtv2';
+import type { OrganizationCustomPermissionKey, OrganizationCustomRoleKey } from './organizationMembership';
+
+/**
+ * @internal
+ */
+export type SharedSignedInAuthObjectProperties = {
+  sessionClaims: JwtPayload;
+  sessionId: string;
+  sessionStatus: SessionStatusClaim | null;
+  actor: ActClaim | undefined;
+  userId: string;
+  orgId: string | undefined;
+  orgRole: OrganizationCustomRoleKey | undefined;
+  orgSlug: string | undefined;
+  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
+  /**
+   * Factor Verification Age
+   * Each item represents the minutes that have passed since the last time a first or second factor were verified.
+   * [fistFactorAge, secondFactorAge]
+   */
+  factorVerificationAge: [firstFactorAge: number, secondFactorAge: number] | null;
+};

packages/types/src/index.ts

@@ -67,3 +67,4 @@ export * from './customMenuItems';
 export * from './samlConnection';
 export * from './waitlist';
 export * from './snapshots';
+export * from './authObject';