@workos-inc/node 7.46.0 → 7.48.0

package/lib/common/interfaces/unknown-record.interface.d.ts

@@ -0,0 +1 @@
+export type UnknownRecord = Record<string, unknown>;

package/lib/common/interfaces/unknown-record.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/organization-domains/fixtures/get-organization-domain-pending.json

@@ -1,6 +1,7 @@
 {
     "object": "organization_domain",
     "id": "org_domain_01HD50K7EPWCMNPGMKXKKE14XT",
+    "organization_id": "org_01JR8C1EHCRPV4B4XP4W2B9X1M",
     "domain": "workos.com",
     "state": "pending",
     "verification_token": "F06PGMsZIO0shrveGWuGxgCj7",

package/lib/organization-domains/fixtures/get-organization-domain-verified.json

@@ -1,6 +1,7 @@
 {
     "object": "organization_domain",
     "id": "org_domain_01HCZRAP3TPQ0X0DKJHR32TATG",
+    "organization_id": "org_01JR8C1EHCRPV4B4XP4W2B9X1M",
     "domain": "workos.com",
     "state": "verified",
     "verification_token": null,

package/lib/organization-domains/interfaces/organization-domain.interface.d.ts

@@ -15,6 +15,7 @@ export interface OrganizationDomain {
     object: 'organization_domain';
     id: string;
     domain: string;
+    organizationId: string;
     state: OrganizationDomainState;
     verificationToken?: string;
     verificationStrategy: OrganizationDomainVerificationStrategy;
@@ -23,6 +24,7 @@ export interface OrganizationDomainResponse {
     object: 'organization_domain';
     id: string;
     domain: string;
+    organization_id: string;
     state: OrganizationDomainState;
     verification_token?: string;
     verification_strategy: OrganizationDomainVerificationStrategy;

package/lib/organization-domains/organization-domains.spec.js

@@ -28,6 +28,7 @@ describe('OrganizationDomains', () => {
             expect((0, test_utils_1.fetchURL)()).toContain('/organization_domains/org_domain_01HCZRAP3TPQ0X0DKJHR32TATG');
             expect(subject.id).toEqual('org_domain_01HCZRAP3TPQ0X0DKJHR32TATG');
             expect(subject.domain).toEqual('workos.com');
+            expect(subject.organizationId).toEqual('org_01JR8C1EHCRPV4B4XP4W2B9X1M');
             expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Verified);
             expect(subject.verificationToken).toBeNull();
             expect(subject.verificationStrategy).toEqual('manual');
@@ -38,6 +39,7 @@ describe('OrganizationDomains', () => {
             expect((0, test_utils_1.fetchURL)()).toContain('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
             expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
             expect(subject.domain).toEqual('workos.com');
+            expect(subject.organizationId).toEqual('org_01JR8C1EHCRPV4B4XP4W2B9X1M');
             expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
             expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
             expect(subject.verificationStrategy).toEqual('dns');
@@ -50,6 +52,7 @@ describe('OrganizationDomains', () => {
             expect((0, test_utils_1.fetchURL)()).toContain('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT/verify');
             expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
             expect(subject.domain).toEqual('workos.com');
+            expect(subject.organizationId).toEqual('org_01JR8C1EHCRPV4B4XP4W2B9X1M');
             expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
             expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
             expect(subject.verificationStrategy).toEqual('dns');
@@ -69,6 +72,7 @@ describe('OrganizationDomains', () => {
             });
             expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
             expect(subject.domain).toEqual('workos.com');
+            expect(subject.organizationId).toEqual('org_01JR8C1EHCRPV4B4XP4W2B9X1M');
             expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
             expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
             expect(subject.verificationStrategy).toEqual('dns');

package/lib/organization-domains/serializers/organization-domain.serializer.js

@@ -5,6 +5,7 @@ const deserializeOrganizationDomain = (organizationDomain) => ({
     object: organizationDomain.object,
     id: organizationDomain.id,
     domain: organizationDomain.domain,
+    organizationId: organizationDomain.organization_id,
     state: organizationDomain.state,
     verificationToken: organizationDomain.verification_token,
     verificationStrategy: organizationDomain.verification_strategy,

package/lib/sso/interfaces/profile-and-token.interface.d.ts

@@ -1,9 +1,10 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from './profile.interface';
-export interface ProfileAndToken {
+export interface ProfileAndToken<CustomAttributesType extends UnknownRecord> {
     accessToken: string;
-    profile: Profile;
+    profile: Profile<CustomAttributesType>;
 }
-export interface ProfileAndTokenResponse {
+export interface ProfileAndTokenResponse<CustomAttributesType extends UnknownRecord> {
     access_token: string;
-    profile: ProfileResponse;
+    profile: ProfileResponse<CustomAttributesType>;
 }

package/lib/sso/interfaces/profile.interface.d.ts

@@ -1,6 +1,7 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { RoleResponse } from '../../roles/interfaces';
 import { ConnectionType } from './connection-type.enum';
-export interface Profile {
+export interface Profile<CustomAttributesType extends UnknownRecord> {
     id: string;
     idpId: string;
     organizationId?: string;
@@ -11,11 +12,12 @@ export interface Profile {
     lastName?: string;
     role?: RoleResponse;
     groups?: string[];
+    customAttributes?: CustomAttributesType;
     rawAttributes?: {
         [key: string]: any;
     };
 }
-export interface ProfileResponse {
+export interface ProfileResponse<CustomAttributesType extends UnknownRecord> {
     id: string;
     idp_id: string;
     organization_id?: string;
@@ -26,6 +28,7 @@ export interface ProfileResponse {
     last_name?: string;
     role?: RoleResponse;
     groups?: string[];
+    custom_attributes?: CustomAttributesType;
     raw_attributes?: {
         [key: string]: any;
     };

package/lib/sso/serializers/profile-and-token.serializer.d.ts

@@ -1,2 +1,3 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { ProfileAndToken, ProfileAndTokenResponse } from '../interfaces';
-export declare const deserializeProfileAndToken: (profileAndToken: ProfileAndTokenResponse) => ProfileAndToken;
+export declare const deserializeProfileAndToken: <CustomAttributesType extends UnknownRecord>(profileAndToken: ProfileAndTokenResponse<CustomAttributesType>) => ProfileAndToken<CustomAttributesType>;

package/lib/sso/serializers/profile.serializer.d.ts

@@ -1,2 +1,3 @@
+import { UnknownRecord } from '../../common/interfaces/unknown-record.interface';
 import { Profile, ProfileResponse } from '../interfaces';
-export declare const deserializeProfile: (profile: ProfileResponse) => Profile;
+export declare const deserializeProfile: <CustomAttributesType extends UnknownRecord>(profile: ProfileResponse<CustomAttributesType>) => Profile<CustomAttributesType>;

package/lib/sso/serializers/profile.serializer.js

@@ -12,6 +12,7 @@ const deserializeProfile = (profile) => ({
     lastName: profile.last_name,
     role: profile.role,
     groups: profile.groups,
+    customAttributes: profile.custom_attributes,
     rawAttributes: profile.raw_attributes,
 });
 exports.deserializeProfile = deserializeProfile;

package/lib/sso/sso.d.ts

@@ -1,6 +1,7 @@
 import { AutoPaginatable } from '../common/utils/pagination';
 import { WorkOS } from '../workos';
 import { AuthorizationURLOptions, Connection, GetProfileAndTokenOptions, GetProfileOptions, ListConnectionsOptions, Profile, ProfileAndToken } from './interfaces';
+import { UnknownRecord } from '../common/interfaces/unknown-record.interface';
 export declare class SSO {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -8,6 +9,6 @@ export declare class SSO {
     deleteConnection(id: string): Promise<void>;
     getAuthorizationUrl({ connection, clientId, domain, domainHint, loginHint, organization, provider, redirectUri, state, }: AuthorizationURLOptions): string;
     getConnection(id: string): Promise<Connection>;
-    getProfileAndToken({ code, clientId, }: GetProfileAndTokenOptions): Promise<ProfileAndToken>;
-    getProfile({ accessToken }: GetProfileOptions): Promise<Profile>;
+    getProfileAndToken<CustomAttributesType extends UnknownRecord = UnknownRecord>({ code, clientId, }: GetProfileAndTokenOptions): Promise<ProfileAndToken<CustomAttributesType>>;
+    getProfile<CustomAttributesType extends UnknownRecord = UnknownRecord>({ accessToken, }: GetProfileOptions): Promise<Profile<CustomAttributesType>>;
 }

package/lib/sso/sso.js

@@ -77,7 +77,7 @@ class SSO {
             return (0, serializers_1.deserializeProfileAndToken)(data);
         });
     }
-    getProfile({ accessToken }) {
+    getProfile({ accessToken, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.get('/sso/profile', {
                 accessToken,

package/lib/sso/sso.spec.js

@@ -185,6 +185,10 @@ describe('SSO', () => {
                                 first_name: 'foo',
                                 last_name: 'bar',
                                 groups: ['Admins', 'Developers'],
+                                license: 'professional',
+                            },
+                            custom_attributes: {
+                                license: 'professional',
                             },
                         },
                     });
@@ -221,6 +225,7 @@ describe('SSO', () => {
                                 first_name: 'foo',
                                 last_name: 'bar',
                             },
+                            custom_attributes: {},
                         },
                     });
                     const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
@@ -257,6 +262,7 @@ describe('SSO', () => {
                         last_name: 'bar',
                         groups: ['Admins', 'Developers'],
                     },
+                    custom_attributes: {},
                 });
                 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
                 const profile = yield workos.sso.getProfile({

package/lib/workos.js

@@ -31,7 +31,7 @@ const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
-const VERSION = '7.46.0';
+const VERSION = '7.48.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.46.0",
+  "version": "7.48.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",