@workos-inc/node 6.2.0 → 6.4.0

package/lib/common/interfaces/event.interface.d.ts

@@ -1,6 +1,6 @@
 import { DirectoryUser, DirectoryUserResponse, DirectoryGroup, DirectoryGroupResponse, EventDirectory, EventDirectoryResponse } from '../../directory-sync/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
-import { User, UserResponse } from '../../user-management/interfaces';
+import { Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
 import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
 export interface EventBase {
     id: string;
@@ -162,6 +162,14 @@ export interface UserDeletedEventResponse extends EventResponseBase {
     event: 'user.deleted';
     data: UserResponse;
 }
+export interface UserImpersonatedEvent extends EventBase {
+    event: 'user.impersonated';
+    data: Session;
+}
+export interface UserImpersonatedEventResponse extends EventResponseBase {
+    event: 'user.impersonated';
+    data: SessionResponse;
+}
 export interface OrganizationMembershipAdded extends EventBase {
     event: 'organization_membership.added';
     data: OrganizationMembership;
@@ -186,7 +194,7 @@ export interface OrganizationMembershipRemovedResponse extends EventResponseBase
     event: 'organization_membership.removed';
     data: OrganizationMembershipResponse;
 }
-export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipUpdated | OrganizationMembershipRemoved;
-export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse;
-export type EventName = 'connection.activated' | 'connection.deactivated' | 'connection.deleted' | 'dsync.activated' | 'dsync.deactivated' | 'dsync.deleted' | 'dsync.group.created' | 'dsync.group.deleted' | 'dsync.group.updated' | 'dsync.group.user_added' | 'dsync.group.user_removed' | 'dsync.user.created' | 'dsync.user.deleted' | 'dsync.user.updated' | 'user.created' | 'user.updated' | 'user.deleted' | 'organization_membership.added' | 'organization_membership.updated' | 'organization_membership.removed';
+export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | UserImpersonatedEvent | OrganizationMembershipAdded | OrganizationMembershipUpdated | OrganizationMembershipRemoved;
+export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | UserImpersonatedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse;
+export type EventName = Event['event'];
 export {};

package/lib/common/serializers/event.serializer.js

@@ -5,6 +5,7 @@ const serializers_1 = require("../../directory-sync/serializers");
 const serializers_2 = require("../../sso/serializers");
 const serializers_3 = require("../../user-management/serializers");
 const organization_membership_serializer_1 = require("../../user-management/serializers/organization-membership.serializer");
+const session_serializer_1 = require("../../user-management/serializers/session.serializer");
 const deserializeEvent = (event) => {
     const eventBase = {
         id: event.id,
@@ -41,6 +42,8 @@ const deserializeEvent = (event) => {
         case 'user.updated':
         case 'user.deleted':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_3.deserializeUser)(event.data) });
+        case 'user.impersonated':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, session_serializer_1.deserializeSession)(event.data) });
         case 'organization_membership.added':
         case 'organization_membership.updated':
         case 'organization_membership.removed':

package/lib/common/utils/test-utils.d.ts

@@ -1,5 +1,5 @@
 import { MockParams } from 'jest-fetch-mock';
-export declare function fetchOnce(response?: any, { status, headers, ...rest }?: MockParams): import("jest-fetch-mock").FetchMock;
+export declare function fetchOnce(response?: {}, { status, headers, ...rest }?: MockParams): import("jest-fetch-mock").FetchMock;
 export declare function fetchURL(): string | Request | undefined;
 export declare function fetchSearchParams(): {
     [k: string]: string;

package/lib/user-management/fixtures/organization-membership.json

@@ -4,6 +4,9 @@
     "user_id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
     "organization_id": "organization_01H5JQDV7R7ATEYZDEG0W5PRYS",
     "status": "active",
+    "role": {
+        "slug": "member"
+    },
     "created_at": "2023-07-18T02:07:19.911Z",
     "updated_at": "2023-07-18T02:07:19.911Z"
 }

package/lib/user-management/interfaces/authentication-response.interface.d.ts

@@ -1,15 +1,18 @@
+import { Impersonator, ImpersonatorResponse } from './impersonator.interface';
 import { User, UserResponse } from './user.interface';
 export interface AuthenticationResponse {
     user: User;
     organizationId?: string;
     accessToken?: string;
     refreshToken?: string;
+    impersonator?: Impersonator;
 }
 export interface AuthenticationResponseResponse {
     user: UserResponse;
     organization_id?: string;
     access_token?: string;
     refresh_token?: string;
+    impersonator?: ImpersonatorResponse;
 }
 export interface RefreshAuthenticationResponse {
     accessToken: string;

package/lib/user-management/interfaces/create-organization-membership-options.interface.d.ts

@@ -1,8 +1,10 @@
 export interface CreateOrganizationMembershipOptions {
     organizationId: string;
     userId: string;
+    roleSlug?: string;
 }
 export interface SerializedCreateOrganizationMembershipOptions {
     organization_id: string;
     user_id: string;
+    role_slug?: string;
 }

package/lib/user-management/interfaces/impersonator.interface.d.ts

@@ -0,0 +1,8 @@
+export interface Impersonator {
+    email: string;
+    reason: string | null;
+}
+export interface ImpersonatorResponse {
+    email: string;
+    reason: string | null;
+}

package/lib/user-management/interfaces/impersonator.interface.js

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

package/lib/user-management/interfaces/index.d.ts

@@ -15,4 +15,5 @@ export * from './send-verification-email-options';
 export * from './update-user-options.interface';
 export * from './update-user-password-options.interface';
 export * from './user.interface';
+export * from './session.interface';
 export * from './verify-email-options.interface';

package/lib/user-management/interfaces/index.js

@@ -31,4 +31,5 @@ __exportStar(require("./send-verification-email-options"), exports);
 __exportStar(require("./update-user-options.interface"), exports);
 __exportStar(require("./update-user-password-options.interface"), exports);
 __exportStar(require("./user.interface"), exports);
+__exportStar(require("./session.interface"), exports);
 __exportStar(require("./verify-email-options.interface"), exports);

package/lib/user-management/interfaces/organization-membership.interface.d.ts

@@ -1,3 +1,4 @@
+import { RoleResponse } from './role.interface';
 export interface OrganizationMembership {
     object: 'organization_membership';
     id: string;
@@ -6,6 +7,7 @@ export interface OrganizationMembership {
     userId: string;
     createdAt: string;
     updatedAt: string;
+    role: RoleResponse;
 }
 export interface OrganizationMembershipResponse {
     object: 'organization_membership';
@@ -15,4 +17,5 @@ export interface OrganizationMembershipResponse {
     user_id: string;
     created_at: string;
     updated_at: string;
+    role: RoleResponse;
 }

package/lib/user-management/interfaces/role.interface.d.ts

@@ -0,0 +1,3 @@
+export interface RoleResponse {
+    slug: string;
+}

package/lib/user-management/interfaces/role.interface.js

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

package/lib/user-management/interfaces/session.interface.d.ts

@@ -0,0 +1,19 @@
+import { Impersonator } from './impersonator.interface';
+export interface Session {
+    object: 'session';
+    id: string;
+    userId: string;
+    ipAddress: string | null;
+    userAgent: string | null;
+    organizationId?: string;
+    impersonator?: Impersonator;
+}
+export interface SessionResponse {
+    object: 'session';
+    id: string;
+    user_id: string;
+    ip_address: string | null;
+    user_agent: string | null;
+    organization_id?: string;
+    impersonator?: Impersonator;
+}

package/lib/user-management/interfaces/session.interface.js

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

package/lib/user-management/interfaces/update-organization-membership-options.interface.d.ts

@@ -0,0 +1,6 @@
+export interface UpdateOrganizationMembershipOptions {
+    roleSlug?: string;
+}
+export interface SerializedUpdateOrganizationMembershipOptions {
+    role_slug?: string;
+}

package/lib/user-management/interfaces/update-organization-membership-options.interface.js

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

package/lib/user-management/serializers/authentication-response.serializer.js

@@ -14,8 +14,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeRefreshAuthenticationResponse = exports.deserializeAuthenticationResponse = void 0;
 const user_serializer_1 = require("./user.serializer");
 const deserializeAuthenticationResponse = (authenticationResponse) => {
-    const { user, organization_id, access_token, refresh_token } = authenticationResponse, rest = __rest(authenticationResponse, ["user", "organization_id", "access_token", "refresh_token"]);
-    return Object.assign({ user: (0, user_serializer_1.deserializeUser)(user), organizationId: organization_id, accessToken: access_token, refreshToken: refresh_token }, rest);
+    const { user, organization_id, access_token, refresh_token, impersonator } = authenticationResponse, rest = __rest(authenticationResponse, ["user", "organization_id", "access_token", "refresh_token", "impersonator"]);
+    return Object.assign({ user: (0, user_serializer_1.deserializeUser)(user), organizationId: organization_id, accessToken: access_token, refreshToken: refresh_token, impersonator }, rest);
 };
 exports.deserializeAuthenticationResponse = deserializeAuthenticationResponse;
 const deserializeRefreshAuthenticationResponse = (refreshAuthenticationResponse) => {

package/lib/user-management/serializers/create-organization-membership-options.serializer.js

@@ -4,5 +4,6 @@ exports.serializeCreateOrganizationMembershipOptions = void 0;
 const serializeCreateOrganizationMembershipOptions = (options) => ({
     organization_id: options.organizationId,
     user_id: options.userId,
+    role_slug: options.roleSlug,
 });
 exports.serializeCreateOrganizationMembershipOptions = serializeCreateOrganizationMembershipOptions;

package/lib/user-management/serializers/organization-membership.serializer.js

@@ -9,5 +9,6 @@ const deserializeOrganizationMembership = (organizationMembership) => ({
     status: organizationMembership.status,
     createdAt: organizationMembership.created_at,
     updatedAt: organizationMembership.updated_at,
+    role: organizationMembership.role,
 });
 exports.deserializeOrganizationMembership = deserializeOrganizationMembership;

package/lib/user-management/serializers/session.serializer.d.ts

@@ -0,0 +1,2 @@
+import { Session, SessionResponse } from '../interfaces';
+export declare const deserializeSession: (session: SessionResponse) => Session;

package/lib/user-management/serializers/session.serializer.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeSession = void 0;
+const deserializeSession = (session) => ({
+    object: 'session',
+    id: session.id,
+    userId: session.user_id,
+    ipAddress: session.ip_address,
+    userAgent: session.user_agent,
+    organizationId: session.organization_id,
+    impersonator: session.impersonator,
+});
+exports.deserializeSession = deserializeSession;

package/lib/user-management/serializers/update-organization-membership-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { UpdateOrganizationMembershipOptions, SerializedUpdateOrganizationMembershipOptions } from '../interfaces/update-organization-membership-options.interface';
+export declare const serializeUpdateOrganizationMembershipOptions: (options: UpdateOrganizationMembershipOptions) => SerializedUpdateOrganizationMembershipOptions;

package/lib/user-management/serializers/update-organization-membership-options.serializer.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeUpdateOrganizationMembershipOptions = void 0;
+const serializeUpdateOrganizationMembershipOptions = (options) => ({
+    role_slug: options.roleSlug,
+});
+exports.serializeUpdateOrganizationMembershipOptions = serializeUpdateOrganizationMembershipOptions;

package/lib/user-management/user-management.d.ts

@@ -13,6 +13,7 @@ import { AuthenticateWithEmailVerificationOptions } from './interfaces/authentic
 import { AuthenticateWithOrganizationSelectionOptions } from './interfaces/authenticate-with-organization-selection.interface';
 import { Factor, FactorWithSecrets } from './interfaces/factor.interface';
 import { RevokeSessionOptions } from './interfaces/revoke-session-options.interface';
+import { UpdateOrganizationMembershipOptions } from './interfaces/update-organization-membership-options.interface';
 export declare class UserManagement {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -47,6 +48,7 @@ export declare class UserManagement {
     getOrganizationMembership(organizationMembershipId: string): Promise<OrganizationMembership>;
     listOrganizationMemberships(options: ListOrganizationMembershipsOptions): Promise<AutoPaginatable<OrganizationMembership>>;
     createOrganizationMembership(options: CreateOrganizationMembershipOptions): Promise<OrganizationMembership>;
+    updateOrganizationMembership(organizationMembershipId: string, options: UpdateOrganizationMembershipOptions): Promise<OrganizationMembership>;
     deleteOrganizationMembership(organizationMembershipId: string): Promise<void>;
     getInvitation(invitationId: string): Promise<Invitation>;
     listInvitations(options: ListInvitationsOptions): Promise<AutoPaginatable<Invitation>>;

package/lib/user-management/user-management.js

@@ -25,6 +25,7 @@ const authenticate_with_email_verification_serializer_1 = require("./serializers
 const authenticate_with_organization_selection_options_serializer_1 = require("./serializers/authenticate-with-organization-selection-options.serializer");
 const factor_serializer_1 = require("./serializers/factor.serializer");
 const revoke_session_options_interface_1 = require("./interfaces/revoke-session-options.interface");
+const update_organization_membership_options_serializer_1 = require("./serializers/update-organization-membership-options.serializer");
 const toQueryString = (options) => {
     const searchParams = new URLSearchParams();
     const keys = Object.keys(options).sort();
@@ -175,6 +176,12 @@ class UserManagement {
             return (0, organization_membership_serializer_1.deserializeOrganizationMembership)(data);
         });
     }
+    updateOrganizationMembership(organizationMembershipId, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.put(`/user_management/organization_memberships/${organizationMembershipId}`, (0, update_organization_membership_options_serializer_1.serializeUpdateOrganizationMembershipOptions)(options));
+            return (0, organization_membership_serializer_1.deserializeOrganizationMembership)(data);
+        });
+    }
     deleteOrganizationMembership(organizationMembershipId) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.delete(`/user_management/organization_memberships/${organizationMembershipId}`);

package/lib/user-management/user-management.spec.js

@@ -155,6 +155,30 @@ describe('UserManagement', () => {
                 },
             });
         }));
+        describe('when the code is for an impersonator', () => {
+            it('deserializes the impersonator metadata', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)({
+                    user: user_json_1.default,
+                    impersonator: {
+                        email: 'admin@example.com',
+                        reason: 'A good reason.',
+                    },
+                });
+                const resp = yield workos.userManagement.authenticateWithCode({
+                    clientId: 'proj_whatever',
+                    code: 'or this',
+                });
+                expect(resp).toMatchObject({
+                    user: {
+                        email: 'test01@example.com',
+                    },
+                    impersonator: {
+                        email: 'admin@example.com',
+                        reason: 'A good reason.',
+                    },
+                });
+            }));
+        });
     });
     describe('authenticateWithRefreshToken', () => {
         it('sends a refresh_token authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -531,6 +555,29 @@ describe('UserManagement', () => {
                 organizationId: 'organization_01H5JQDV7R7ATEYZDEG0W5PRYS',
                 userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
                 status: 'active',
+                role: {
+                    slug: 'member',
+                },
+            });
+        }));
+    });
+    describe('updateOrganizationMembership', () => {
+        it('sends an update organization membership request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(organization_membership_json_1.default, {
+                status: 200,
+            });
+            const organizationMembership = yield workos.userManagement.updateOrganizationMembership(organizationMembershipId, {
+                roleSlug: 'member',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/organization_memberships/${organizationMembershipId}`);
+            expect(organizationMembership).toMatchObject({
+                object: 'organization_membership',
+                organizationId: 'organization_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                status: 'active',
+                role: {
+                    slug: 'member',
+                },
             });
         }));
     });

package/lib/workos.js

@@ -24,7 +24,7 @@ const audit_logs_1 = require("./audit-logs/audit-logs");
 const user_management_1 = require("./user-management/user-management");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
 const fetch_client_1 = require("./common/utils/fetch-client");
-const VERSION = '6.2.0';
+const VERSION = '6.4.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

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