@workos-inc/node 7.34.0 → 7.35.1

package/lib/actions/actions.d.ts

@@ -1,5 +1,6 @@
 import { CryptoProvider } from '../common/crypto/crypto-provider';
-import { AuthenticationActionResponseData, ResponsePayload, UserRegistrationActionResponseData } from './interfaces/response-payload';
+import { ActionContext } from './interfaces/action.interface';
+import { AuthenticationActionResponseData, ResponsePayload, UserRegistrationActionResponseData } from './interfaces/response-payload.interface';
 export declare class Actions {
     private signatureProvider;
     constructor(cryptoProvider: CryptoProvider);
@@ -16,4 +17,10 @@ export declare class Actions {
         payload: ResponsePayload;
         signature: string;
     }>;
+    constructAction({ payload, sigHeader, secret, tolerance, }: {
+        payload: unknown;
+        sigHeader: string;
+        secret: string;
+        tolerance?: number;
+    }): Promise<ActionContext>;
 }

package/lib/actions/actions.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Actions = void 0;
 const crypto_1 = require("../common/crypto");
 const unreachable_1 = require("../common/utils/unreachable");
+const action_serializer_1 = require("./serializers/action.serializer");
 class Actions {
     constructor(cryptoProvider) {
         this.signatureProvider = new crypto_1.SignatureProvider(cryptoProvider);
@@ -49,5 +50,12 @@ class Actions {
             return response;
         });
     }
+    constructAction({ payload, sigHeader, secret, tolerance = 300, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = { payload, sigHeader, secret, tolerance };
+            yield this.verifyHeader(options);
+            return (0, action_serializer_1.deserializeAction)(payload);
+        });
+    }
 }
 exports.Actions = Actions;

package/lib/actions/actions.spec.js

@@ -14,7 +14,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const crypto_1 = __importDefault(require("crypto"));
 const workos_1 = require("../workos");
-const action_context_json_1 = __importDefault(require("./fixtures/action-context.json"));
+const authentication_action_context_json_1 = __importDefault(require("./fixtures/authentication-action-context.json"));
+const user_registration_action_context_json_1 = __importDefault(require("./fixtures/user-registration-action-context.json"));
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const crypto_2 = require("../common/crypto");
 describe('Actions', () => {
@@ -22,6 +23,16 @@ describe('Actions', () => {
     beforeEach(() => {
         secret = 'secret';
     });
+    const makeSigHeader = (payload, secret) => {
+        const timestamp = Date.now() * 1000;
+        const unhashedString = `${timestamp}.${JSON.stringify(payload)}`;
+        const signatureHash = crypto_1.default
+            .createHmac('sha256', secret)
+            .update(unhashedString)
+            .digest()
+            .toString('hex');
+        return `t=${timestamp}, v1=${signatureHash}`;
+    };
     describe('signResponse', () => {
         describe('type: authentication', () => {
             it('returns a signed response', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -56,23 +67,99 @@ describe('Actions', () => {
         });
     });
     describe('verifyHeader', () => {
-        it('aliases to the signature provider', () => __awaiter(void 0, void 0, void 0, function* () {
-            const spy = jest.spyOn(
-            // tslint:disable-next-line
-            workos.actions['signatureProvider'], 'verifyHeader');
-            const timestamp = Date.now() * 1000;
-            const unhashedString = `${timestamp}.${JSON.stringify(action_context_json_1.default)}`;
-            const signatureHash = crypto_1.default
-                .createHmac('sha256', secret)
-                .update(unhashedString)
-                .digest()
-                .toString('hex');
-            yield workos.actions.verifyHeader({
-                payload: action_context_json_1.default,
-                sigHeader: `t=${timestamp}, v1=${signatureHash}`,
+        it('verifies the header', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield expect(workos.actions.verifyHeader({
+                payload: authentication_action_context_json_1.default,
+                sigHeader: makeSigHeader(authentication_action_context_json_1.default, secret),
                 secret,
+            })).resolves.not.toThrow();
+        }));
+        it('throws when the header is invalid', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield expect(workos.actions.verifyHeader({
+                payload: authentication_action_context_json_1.default,
+                sigHeader: 't=123, v1=123',
+                secret,
+            })).rejects.toThrow();
+        }));
+    });
+    describe('constructAction', () => {
+        it('returns an authentication action', () => __awaiter(void 0, void 0, void 0, function* () {
+            const payload = authentication_action_context_json_1.default;
+            const sigHeader = makeSigHeader(payload, secret);
+            const action = yield workos.actions.constructAction({
+                payload,
+                sigHeader,
+                secret,
+            });
+            expect(action).toEqual({
+                id: '01JATCMZJY26PQ59XT9BNT0FNN',
+                user: {
+                    object: 'user',
+                    id: '01JATCHZVEC5EPANDPEZVM68Y9',
+                    email: 'jane@foocorp.com',
+                    firstName: 'Jane',
+                    lastName: 'Doe',
+                    emailVerified: true,
+                    profilePictureUrl: 'https://example.com/jane.jpg',
+                    createdAt: '2024-10-22T17:12:50.746Z',
+                    updatedAt: '2024-10-22T17:12:50.746Z',
+                },
+                ipAddress: '50.141.123.10',
+                userAgent: 'Mozilla/5.0',
+                issuer: 'test',
+                object: 'authentication_action_context',
+                organization: {
+                    object: 'organization',
+                    id: '01JATCMZJY26PQ59XT9BNT0FNN',
+                    name: 'Foo Corp',
+                    allowProfilesOutsideOrganization: false,
+                    domains: [],
+                    createdAt: '2024-10-22T17:12:50.746Z',
+                    updatedAt: '2024-10-22T17:12:50.746Z',
+                },
+                organizationMembership: {
+                    object: 'organization_membership',
+                    id: '01JATCNVYCHT1SZGENR4QTXKRK',
+                    userId: '01JATCHZVEC5EPANDPEZVM68Y9',
+                    organizationId: '01JATCMZJY26PQ59XT9BNT0FNN',
+                    role: {
+                        slug: 'member',
+                    },
+                    status: 'active',
+                    createdAt: '2024-10-22T17:12:50.746Z',
+                    updatedAt: '2024-10-22T17:12:50.746Z',
+                },
+            });
+        }));
+        it('returns a user registration action', () => __awaiter(void 0, void 0, void 0, function* () {
+            const payload = user_registration_action_context_json_1.default;
+            const sigHeader = makeSigHeader(payload, secret);
+            const action = yield workos.actions.constructAction({
+                payload,
+                sigHeader,
+                secret,
+            });
+            expect(action).toEqual({
+                id: '01JATCMZJY26PQ59XT9BNT0FNN',
+                object: 'user_registration_action_context',
+                userData: {
+                    object: 'user_data',
+                    email: 'jane@foocorp.com',
+                    firstName: 'Jane',
+                    lastName: 'Doe',
+                },
+                ipAddress: '50.141.123.10',
+                userAgent: 'Mozilla/5.0',
+                invitation: expect.objectContaining({
+                    object: 'invitation',
+                    id: '01JBVZWH8HJ855YZ5BWHG1WNZN',
+                    email: 'jane@foocorp.com',
+                    expiresAt: '2024-10-22T17:12:50.746Z',
+                    createdAt: '2024-10-21T17:12:50.746Z',
+                    updatedAt: '2024-10-21T17:12:50.746Z',
+                    acceptedAt: '2024-10-22T17:13:50.746Z',
+                }),
             });
-            expect(spy).toHaveBeenCalled();
         }));
     });
 });

package/lib/actions/fixtures/{action-context.json → authentication-action-context.json}

@@ -1,4 +1,5 @@
 {
+    "id": "01JATCMZJY26PQ59XT9BNT0FNN",
     "user": {
         "object": "user",
         "id": "01JATCHZVEC5EPANDPEZVM68Y9",

package/lib/actions/fixtures/user-registration-action-context.json

@@ -0,0 +1,24 @@
+{
+    "id": "01JATCMZJY26PQ59XT9BNT0FNN",
+    "user_data": {
+        "object": "user_data",
+        "email": "jane@foocorp.com",
+        "first_name": "Jane",
+        "last_name": "Doe"
+    },
+    "ip_address": "50.141.123.10",
+    "user_agent": "Mozilla/5.0",
+    "object": "user_registration_action_context",
+    "invitation": {
+        "object": "invitation",
+        "id": "01JBVZWH8HJ855YZ5BWHG1WNZN",
+        "email": "jane@foocorp.com",
+        "expires_at": "2024-10-22T17:12:50.746Z",
+        "created_at": "2024-10-21T17:12:50.746Z",
+        "updated_at": "2024-10-21T17:12:50.746Z",
+        "accepted_at": "2024-10-22T17:13:50.746Z",
+        "revoked_at": null,
+        "organization_id": "01JBW46BTKAA98WZN8826XQ2YP",
+        "inviter_user_id": "01JBVZWAEPWAE3YYKBVT0AF81F"
+    }
+}

package/lib/actions/interfaces/action.interface.d.ts

@@ -0,0 +1,53 @@
+import { Organization, OrganizationResponse } from '../../organizations/interfaces';
+import { Invitation, InvitationResponse, OrganizationMembership, OrganizationMembershipResponse, User, UserResponse } from '../../user-management/interfaces';
+interface AuthenticationActionContext {
+    id: string;
+    object: 'authentication_action_context';
+    user: User;
+    organization?: Organization;
+    organizationMembership?: OrganizationMembership;
+    ipAddress?: string;
+    userAgent?: string;
+    issuer?: string;
+}
+export interface UserData {
+    object: 'user_data';
+    email: string;
+    firstName: string;
+    lastName: string;
+}
+interface UserRegistrationActionContext {
+    id: string;
+    object: 'user_registration_action_context';
+    userData: UserData;
+    invitation?: Invitation;
+    ipAddress?: string;
+    userAgent?: string;
+}
+export type ActionContext = AuthenticationActionContext | UserRegistrationActionContext;
+interface AuthenticationActionPayload {
+    id: string;
+    object: 'authentication_action_context';
+    user: UserResponse;
+    organization?: OrganizationResponse;
+    organization_membership?: OrganizationMembershipResponse;
+    ip_address?: string;
+    user_agent?: string;
+    issuer?: string;
+}
+export interface UserDataPayload {
+    object: 'user_data';
+    email: string;
+    first_name: string;
+    last_name: string;
+}
+export interface UserRegistrationActionPayload {
+    id: string;
+    object: 'user_registration_action_context';
+    user_data: UserDataPayload;
+    invitation?: InvitationResponse;
+    ip_address?: string;
+    user_agent?: string;
+}
+export type ActionPayload = AuthenticationActionPayload | UserRegistrationActionPayload;
+export {};

package/lib/actions/interfaces/response-payload.interface.js

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

package/lib/actions/serializers/action.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ActionContext, ActionPayload } from '../interfaces/action.interface';
+export declare const deserializeAction: (actionPayload: ActionPayload) => ActionContext;

package/lib/actions/serializers/action.serializer.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeAction = void 0;
+const organization_serializer_1 = require("../../organizations/serializers/organization.serializer");
+const serializers_1 = require("../../user-management/serializers");
+const organization_membership_serializer_1 = require("../../user-management/serializers/organization-membership.serializer");
+const deserializeUserData = (userData) => {
+    return {
+        object: userData.object,
+        email: userData.email,
+        firstName: userData.first_name,
+        lastName: userData.last_name,
+    };
+};
+const deserializeAction = (actionPayload) => {
+    switch (actionPayload.object) {
+        case 'user_registration_action_context':
+            return {
+                id: actionPayload.id,
+                object: actionPayload.object,
+                userData: deserializeUserData(actionPayload.user_data),
+                invitation: actionPayload.invitation
+                    ? (0, serializers_1.deserializeInvitation)(actionPayload.invitation)
+                    : undefined,
+                ipAddress: actionPayload.ip_address,
+                userAgent: actionPayload.user_agent,
+            };
+        case 'authentication_action_context':
+            return {
+                id: actionPayload.id,
+                object: actionPayload.object,
+                user: (0, serializers_1.deserializeUser)(actionPayload.user),
+                organization: actionPayload.organization
+                    ? (0, organization_serializer_1.deserializeOrganization)(actionPayload.organization)
+                    : undefined,
+                organizationMembership: actionPayload.organization_membership
+                    ? (0, organization_membership_serializer_1.deserializeOrganizationMembership)(actionPayload.organization_membership)
+                    : undefined,
+                ipAddress: actionPayload.ip_address,
+                userAgent: actionPayload.user_agent,
+                issuer: actionPayload.issuer,
+            };
+    }
+};
+exports.deserializeAction = deserializeAction;

package/lib/common/iron-session/edge-iron-session-provider.js

@@ -19,7 +19,10 @@ class EdgeIronSessionProvider extends iron_session_provider_1.IronSessionProvide
     /** @override */
     sealData(data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, edge_1.sealData)(data, options);
+            // The iron-session default ttl is 14 days, which can be problematic if the WorkOS session is configured to be > 14 days.
+            // In that case the session expires and can't be refreshed, so we set the ttl to 0 to set it to the max possible value.
+            const sealOptions = Object.assign(Object.assign({}, options), { ttl: 0 });
+            return (0, edge_1.sealData)(data, sealOptions);
         });
     }
     /** @override */

package/lib/common/iron-session/web-iron-session-provider.js

@@ -19,7 +19,10 @@ class WebIronSessionProvider extends iron_session_provider_1.IronSessionProvider
     /** @override */
     sealData(data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, iron_session_1.sealData)(data, options);
+            // The iron-session default ttl is 14 days, which can be problematic if the WorkOS session is configured to be > 14 days.
+            // In that case the session expires and can't be refreshed, so we set the ttl to 0 to set it to the max possible value.
+            const sealOptions = Object.assign(Object.assign({}, options), { ttl: 0 });
+            return (0, iron_session_1.sealData)(data, sealOptions);
         });
     }
     /** @override */

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

@@ -8,6 +8,7 @@ export interface Invitation {
     expiresAt: string;
     organizationId: string | null;
     inviterUserId: string | null;
+    acceptedUserId: string | null;
     token: string;
     acceptInvitationUrl: string;
     createdAt: string;
@@ -23,6 +24,7 @@ export interface InvitationEvent {
     expiresAt: string;
     organizationId: string | null;
     inviterUserId: string | null;
+    acceptedUserId: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -36,6 +38,7 @@ export interface InvitationResponse {
     expires_at: string;
     organization_id: string | null;
     inviter_user_id: string | null;
+    accepted_user_id: string | null;
     token: string;
     accept_invitation_url: string;
     created_at: string;
@@ -51,6 +54,7 @@ export interface InvitationEventResponse {
     expires_at: string;
     organization_id: string | null;
     inviter_user_id: string | null;
+    accepted_user_id: string | null;
     created_at: string;
     updated_at: string;
 }

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

@@ -11,6 +11,7 @@ const deserializeInvitation = (invitation) => ({
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
     inviterUserId: invitation.inviter_user_id,
+    acceptedUserId: invitation.accepted_user_id,
     token: invitation.token,
     acceptInvitationUrl: invitation.accept_invitation_url,
     createdAt: invitation.created_at,
@@ -27,6 +28,7 @@ const deserializeInvitationEvent = (invitation) => ({
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
     inviterUserId: invitation.inviter_user_id,
+    acceptedUserId: invitation.accepted_user_id,
     createdAt: invitation.created_at,
     updatedAt: invitation.updated_at,
 });

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

@@ -100,6 +100,7 @@ export declare class UserManagement {
     findInvitationByToken(invitationToken: string): Promise<Invitation>;
     listInvitations(options: ListInvitationsOptions): Promise<AutoPaginatable<Invitation>>;
     sendInvitation(payload: SendInvitationOptions): Promise<Invitation>;
+    acceptInvitation(invitationId: string): Promise<Invitation>;
     revokeInvitation(invitationId: string): Promise<Invitation>;
     revokeSession(payload: RevokeSessionOptions): Promise<void>;
     getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }: AuthorizationURLOptions): string;

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

@@ -489,6 +489,12 @@ class UserManagement {
             return (0, invitation_serializer_1.deserializeInvitation)(data);
         });
     }
+    acceptInvitation(invitationId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/user_management/invitations/${invitationId}/accept`, null);
+            return (0, invitation_serializer_1.deserializeInvitation)(data);
+        });
+    }
     revokeInvitation(invitationId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.post(`/user_management/invitations/${invitationId}/revoke`, null);

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

@@ -1425,6 +1425,20 @@ describe('UserManagement', () => {
             });
         }));
     });
+    describe('acceptInvitation', () => {
+        it('sends an Accept Invitation request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const invitationId = 'invitation_01H5JQDV7R7ATEYZDEG0W5PRYS';
+            (0, test_utils_1.fetchOnce)(Object.assign(Object.assign({}, invitation_json_1.default), { state: 'accepted', accepted_user_id: 'user_01HGK4K4PXNSG85RNNV0GXYP5W' }));
+            const response = yield workos.userManagement.acceptInvitation(invitationId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/invitations/${invitationId}/accept`);
+            expect(response).toMatchObject({
+                object: 'invitation',
+                email: 'dane@workos.com',
+                state: 'accepted',
+                acceptedUserId: 'user_01HGK4K4PXNSG85RNNV0GXYP5W',
+            });
+        }));
+    });
     describe('revokeInvitation', () => {
         it('send a Revoke Invitation request', () => __awaiter(void 0, void 0, void 0, function* () {
             const invitationId = 'invitation_01H5JQDV7R7ATEYZDEG0W5PRYS';

package/lib/workos.js

@@ -29,7 +29,7 @@ const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider
 const fetch_client_1 = require("./common/net/fetch-client");
 const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
-const VERSION = '7.34.0';
+const VERSION = '7.35.1';
 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.34.0",
+  "version": "7.35.1",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",