@workos-inc/node 7.1.0 → 7.3.0

package/README.md

@@ -37,6 +37,19 @@ const workos = new WorkOS('sk_1234');
 
 For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
 
+## Beta Releases
+
+WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these
+and share feedback with us before these features reach general availability (GA). To install a Beta version,
+please follow the [installation steps](#installation) above using the Beta release version.
+
+> Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a
+> specific version. This way you can install the same version each time without breaking changes unless you are
+> intentionally looking for the latest Beta version.
+
+We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you
+can move to using the stable version.
+
 ## More Information
 
 - [Single Sign-On Guide](https://workos.com/docs/sso/guide)

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

@@ -1,8 +1,9 @@
 import { DirectoryUser, DirectoryUserResponse, DirectoryGroup, DirectoryGroupResponse, EventDirectory, EventDirectoryResponse } from '../../directory-sync/interfaces';
 import { Organization, OrganizationResponse } from '../../organizations/interfaces';
 import { Connection, ConnectionResponse } from '../../sso/interfaces';
-import { Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
+import { InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
 import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
+import { RoleEvent, RoleEventResponse } from '../../user-management/interfaces/role.interface';
 export interface EventBase {
     id: string;
     createdAt: string;
@@ -139,6 +140,22 @@ export interface DsyncUserUpdatedEventResponse extends EventResponseBase {
     event: 'dsync.user.updated';
     data: DirectoryUserResponse & Record<'previous_attributes', any>;
 }
+export interface InvitationCreatedEvent extends EventBase {
+    event: 'invitation.created';
+    data: InvitationEvent;
+}
+export interface InvitationCreatedEventResponse extends EventResponseBase {
+    event: 'invitation.created';
+    data: InvitationEventResponse;
+}
+export interface MagicAuthCreatedEvent extends EventBase {
+    event: 'magic_auth.created';
+    data: MagicAuthEvent;
+}
+export interface MagicAuthCreatedEventResponse extends EventResponseBase {
+    event: 'magic_auth.created';
+    data: MagicAuthEventResponse;
+}
 export interface UserCreatedEvent extends EventBase {
     event: 'user.created';
     data: User;
@@ -163,14 +180,36 @@ export interface UserDeletedEventResponse extends EventResponseBase {
     event: 'user.deleted';
     data: UserResponse;
 }
+/**
+ * @deprecated Use OrganizationMembershipCreated instead. Will be removed in a future major version.
+ */
 export interface OrganizationMembershipAdded extends EventBase {
     event: 'organization_membership.added';
     data: OrganizationMembership;
 }
+/**
+ * @deprecated Use OrganizationMembershipCreatedResponse instead. Will be removed in a future major version.
+ */
 export interface OrganizationMembershipAddedResponse extends EventResponseBase {
     event: 'organization_membership.added';
     data: OrganizationMembershipResponse;
 }
+export interface OrganizationMembershipCreated extends EventBase {
+    event: 'organization_membership.created';
+    data: OrganizationMembership;
+}
+export interface OrganizationMembershipCreatedResponse extends EventResponseBase {
+    event: 'organization_membership.created';
+    data: OrganizationMembershipResponse;
+}
+export interface OrganizationMembershipDeleted extends EventBase {
+    event: 'organization_membership.deleted';
+    data: OrganizationMembership;
+}
+export interface OrganizationMembershipDeletedResponse extends EventResponseBase {
+    event: 'organization_membership.deleted';
+    data: OrganizationMembershipResponse;
+}
 export interface OrganizationMembershipUpdated extends EventBase {
     event: 'organization_membership.updated';
     data: OrganizationMembership;
@@ -179,10 +218,16 @@ export interface OrganizationMembershipUpdatedResponse extends EventResponseBase
     event: 'organization_membership.updated';
     data: OrganizationMembershipResponse;
 }
+/**
+ * @deprecated Use OrganizationMembershipDeleted instead. Will be removed in a future major version.
+ */
 export interface OrganizationMembershipRemoved extends EventBase {
     event: 'organization_membership.removed';
     data: OrganizationMembership;
 }
+/**
+ * @deprecated Use OrganizationMembershipDeletedResponse instead. Will be removed in a future major version.
+ */
 export interface OrganizationMembershipRemovedResponse extends EventResponseBase {
     event: 'organization_membership.removed';
     data: OrganizationMembershipResponse;
@@ -211,6 +256,22 @@ export interface OrganizationDeletedResponse extends EventResponseBase {
     event: 'organization.deleted';
     data: OrganizationResponse;
 }
+export interface RoleCreatedEvent extends EventBase {
+    event: 'role.created';
+    data: RoleEvent;
+}
+export interface RoleCreatedEventResponse extends EventResponseBase {
+    event: 'role.created';
+    data: RoleEventResponse;
+}
+export interface RoleDeletedEvent extends EventBase {
+    event: 'role.deleted';
+    data: RoleEvent;
+}
+export interface RoleDeletedEventResponse extends EventResponseBase {
+    event: 'role.deleted';
+    data: RoleEventResponse;
+}
 export interface SessionCreatedEvent extends EventBase {
     event: 'session.created';
     data: Session;
@@ -219,7 +280,7 @@ export interface SessionCreatedEventResponse extends EventResponseBase {
     event: 'session.created';
     data: SessionResponse;
 }
-export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipUpdated | OrganizationMembershipRemoved | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
-export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
+export type Event = ConnectionActivatedEvent | ConnectionDeactivatedEvent | ConnectionDeletedEvent | DsyncActivatedEvent | DsyncDeactivatedEvent | DsyncDeletedEvent | DsyncGroupCreatedEvent | DsyncGroupUpdatedEvent | DsyncGroupDeletedEvent | DsyncGroupUserAddedEvent | DsyncGroupUserRemovedEvent | DsyncUserCreatedEvent | DsyncUserUpdatedEvent | DsyncUserDeletedEvent | InvitationCreatedEvent | MagicAuthCreatedEvent | UserCreatedEvent | UserUpdatedEvent | UserDeletedEvent | OrganizationMembershipAdded | OrganizationMembershipCreated | OrganizationMembershipDeleted | OrganizationMembershipUpdated | OrganizationMembershipRemoved | RoleCreatedEvent | RoleDeletedEvent | SessionCreatedEvent | OrganizationCreatedEvent | OrganizationUpdatedEvent | OrganizationDeletedEvent;
+export type EventResponse = ConnectionActivatedEventResponse | ConnectionDeactivatedEventResponse | ConnectionDeletedEventResponse | DsyncActivatedEventResponse | DsyncDeactivatedEventResponse | DsyncDeletedEventResponse | DsyncGroupCreatedEventResponse | DsyncGroupUpdatedEventResponse | DsyncGroupDeletedEventResponse | DsyncGroupUserAddedEventResponse | DsyncGroupUserRemovedEventResponse | DsyncUserCreatedEventResponse | DsyncUserUpdatedEventResponse | DsyncUserDeletedEventResponse | InvitationCreatedEventResponse | MagicAuthCreatedEventResponse | UserCreatedEventResponse | UserUpdatedEventResponse | UserDeletedEventResponse | OrganizationMembershipAddedResponse | OrganizationMembershipCreatedResponse | OrganizationMembershipDeletedResponse | OrganizationMembershipUpdatedResponse | OrganizationMembershipRemovedResponse | RoleCreatedEventResponse | RoleDeletedEventResponse | SessionCreatedEventResponse | OrganizationCreatedResponse | OrganizationUpdatedResponse | OrganizationDeletedResponse;
 export type EventName = Event['event'];
 export {};

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

@@ -6,6 +6,7 @@ const serializers_2 = require("../../organizations/serializers");
 const serializers_3 = require("../../sso/serializers");
 const serializers_4 = require("../../user-management/serializers");
 const organization_membership_serializer_1 = require("../../user-management/serializers/organization-membership.serializer");
+const role_serializer_1 = require("../../user-management/serializers/role.serializer");
 const session_serializer_1 = require("../../user-management/serializers/session.serializer");
 const deserializeEvent = (event) => {
     const eventBase = {
@@ -39,14 +40,23 @@ const deserializeEvent = (event) => {
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_1.deserializeDirectoryUser)(event.data) });
         case 'dsync.user.updated':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_1.deserializeUpdatedEventDirectoryUser)(event.data) });
+        case 'invitation.created':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeInvitationEvent)(event.data) });
+        case 'magic_auth.created':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeMagicAuthEvent)(event.data) });
         case 'user.created':
         case 'user.updated':
         case 'user.deleted':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, serializers_4.deserializeUser)(event.data) });
         case 'organization_membership.added':
+        case 'organization_membership.created':
+        case 'organization_membership.deleted':
         case 'organization_membership.updated':
         case 'organization_membership.removed':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, organization_membership_serializer_1.deserializeOrganizationMembership)(event.data) });
+        case 'role.created':
+        case 'role.deleted':
+            return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, role_serializer_1.deserializeRole)(event.data) });
         case 'session.created':
             return Object.assign(Object.assign({}, eventBase), { event: event.event, data: (0, session_serializer_1.deserializeSession)(event.data) });
         case 'organization.created':

package/lib/events/events.spec.js

@@ -94,5 +94,17 @@ describe('Event', () => {
                 listMetadata: {},
             });
         }));
+        it(`requests Events with a valid organization id`, () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(eventsListResponse);
+            const list = yield workos.events.listEvents({
+                events: ['connection.activated'],
+                organizationId: 'org_1234',
+            });
+            expect(list).toEqual({
+                object: 'list',
+                data: [event],
+                listMetadata: {},
+            });
+        }));
     });
 });

package/lib/events/interfaces/list-events-options.interface.d.ts

@@ -5,6 +5,7 @@ export interface ListEventOptions {
     rangeEnd?: string;
     limit?: number;
     after?: string;
+    organizationId?: string;
 }
 export interface SerializedListEventOptions {
     events: EventName[];
@@ -12,4 +13,5 @@ export interface SerializedListEventOptions {
     range_end?: string;
     limit?: number;
     after?: string;
+    organization_id?: string;
 }

package/lib/events/serializers/list-event-options.serializer.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeListEventOptions = void 0;
 const serializeListEventOptions = (options) => ({
     events: options.events,
+    organization_id: options.organizationId,
     range_start: options.rangeStart,
     range_end: options.rangeEnd,
     limit: options.limit,

package/lib/organizations/interfaces/create-organization-options.interface.d.ts

@@ -1,12 +1,21 @@
 import { PostOptions } from '../../common/interfaces';
+import { DomainData } from './domain-data.interface';
 export interface CreateOrganizationOptions {
     name: string;
     allowProfilesOutsideOrganization?: boolean;
+    domainData?: DomainData[];
+    /**
+     * @deprecated Use `domain_data` instead.
+     */
     domains?: string[];
 }
 export interface SerializedCreateOrganizationOptions {
     name: string;
     allow_profiles_outside_organization?: boolean;
+    domain_data?: DomainData[];
+    /**
+     * @deprecated Use `domain_data` instead.
+     */
     domains?: string[];
 }
 export interface CreateOrganizationRequestOptions extends Pick<PostOptions, 'idempotencyKey'> {

package/lib/organizations/interfaces/domain-data.interface.d.ts

@@ -0,0 +1,8 @@
+export declare enum DomainDataState {
+    Verified = "verified",
+    Pending = "pending"
+}
+export interface DomainData {
+    domain: string;
+    state: DomainDataState;
+}

package/lib/organizations/interfaces/domain-data.interface.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DomainDataState = void 0;
+// These are the only possible states to create an organization domain with
+var DomainDataState;
+(function (DomainDataState) {
+    DomainDataState["Verified"] = "verified";
+    DomainDataState["Pending"] = "pending";
+})(DomainDataState || (exports.DomainDataState = DomainDataState = {}));

package/lib/organizations/interfaces/index.d.ts

@@ -1,4 +1,5 @@
 export * from './create-organization-options.interface';
+export * from './domain-data.interface';
 export * from './list-organizations-options.interface';
 export * from './organization-domain.interface';
 export * from './organization.interface';

package/lib/organizations/interfaces/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./create-organization-options.interface"), exports);
+__exportStar(require("./domain-data.interface"), exports);
 __exportStar(require("./list-organizations-options.interface"), exports);
 __exportStar(require("./organization-domain.interface"), exports);
 __exportStar(require("./organization.interface"), exports);

package/lib/organizations/interfaces/update-organization-options.interface.d.ts

@@ -1,11 +1,20 @@
+import { DomainData } from './domain-data.interface';
 export interface UpdateOrganizationOptions {
     organization: string;
     name: string;
     allowProfilesOutsideOrganization?: boolean;
+    domainData?: DomainData[];
+    /**
+     * @deprecated Use `domain_data` instead.
+     */
     domains?: string[];
 }
 export interface SerializedUpdateOrganizationOptions {
     name: string;
     allow_profiles_outside_organization?: boolean;
+    domain_data?: DomainData[];
+    /**
+     * @deprecated Use `domain_data` instead.
+     */
     domains?: string[];
 }

package/lib/organizations/organizations.spec.js

@@ -20,6 +20,7 @@ const create_organization_json_1 = __importDefault(require("./fixtures/create-or
 const get_organization_json_1 = __importDefault(require("./fixtures/get-organization.json"));
 const list_organizations_json_1 = __importDefault(require("./fixtures/list-organizations.json"));
 const update_organization_json_1 = __importDefault(require("./fixtures/update-organization.json"));
+const interfaces_1 = require("./interfaces");
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 describe('Organizations', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
@@ -116,20 +117,40 @@ describe('Organizations', () => {
             }));
         });
         describe('with a valid payload', () => {
-            it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
-                (0, test_utils_1.fetchOnce)(create_organization_json_1.default, { status: 201 });
-                const subject = yield workos.organizations.createOrganization({
-                    domains: ['example.com'],
-                    name: 'Test Organization',
-                });
-                expect((0, test_utils_1.fetchBody)()).toEqual({
-                    domains: ['example.com'],
-                    name: 'Test Organization',
-                });
-                expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
-                expect(subject.name).toEqual('Test Organization');
-                expect(subject.domains).toHaveLength(1);
-            }));
+            describe('with `domains`', () => {
+                it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(create_organization_json_1.default, { status: 201 });
+                    const subject = yield workos.organizations.createOrganization({
+                        domains: ['example.com'],
+                        name: 'Test Organization',
+                    });
+                    expect((0, test_utils_1.fetchBody)()).toEqual({
+                        domains: ['example.com'],
+                        name: 'Test Organization',
+                    });
+                    expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
+                    expect(subject.name).toEqual('Test Organization');
+                    expect(subject.domains).toHaveLength(1);
+                }));
+            });
+            describe('with `domain_data`', () => {
+                it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(create_organization_json_1.default, { status: 201 });
+                    const subject = yield workos.organizations.createOrganization({
+                        domainData: [
+                            { domain: 'example.com', state: interfaces_1.DomainDataState.Verified },
+                        ],
+                        name: 'Test Organization',
+                    });
+                    expect((0, test_utils_1.fetchBody)()).toEqual({
+                        domain_data: [{ domain: 'example.com', state: 'verified' }],
+                        name: 'Test Organization',
+                    });
+                    expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
+                    expect(subject.name).toEqual('Test Organization');
+                    expect(subject.domains).toHaveLength(1);
+                }));
+            });
         });
         describe('with an invalid payload', () => {
             it('returns an error', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -170,21 +191,42 @@ describe('Organizations', () => {
     });
     describe('updateOrganization', () => {
         describe('with a valid payload', () => {
-            it('updates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
-                (0, test_utils_1.fetchOnce)(update_organization_json_1.default, { status: 201 });
-                const subject = yield workos.organizations.updateOrganization({
-                    organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
-                    domains: ['example.com'],
-                    name: 'Test Organization 2',
-                });
-                expect((0, test_utils_1.fetchBody)()).toEqual({
-                    domains: ['example.com'],
-                    name: 'Test Organization 2',
-                });
-                expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
-                expect(subject.name).toEqual('Test Organization 2');
-                expect(subject.domains).toHaveLength(1);
-            }));
+            describe('with `domains', () => {
+                it('updates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(update_organization_json_1.default, { status: 201 });
+                    const subject = yield workos.organizations.updateOrganization({
+                        organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+                        domains: ['example.com'],
+                        name: 'Test Organization 2',
+                    });
+                    expect((0, test_utils_1.fetchBody)()).toEqual({
+                        domains: ['example.com'],
+                        name: 'Test Organization 2',
+                    });
+                    expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
+                    expect(subject.name).toEqual('Test Organization 2');
+                    expect(subject.domains).toHaveLength(1);
+                }));
+            });
+            describe('with `domain_data`', () => {
+                it('updates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(update_organization_json_1.default, { status: 201 });
+                    const subject = yield workos.organizations.updateOrganization({
+                        organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+                        domainData: [
+                            { domain: 'example.com', state: interfaces_1.DomainDataState.Verified },
+                        ],
+                        name: 'Test Organization 2',
+                    });
+                    expect((0, test_utils_1.fetchBody)()).toEqual({
+                        domain_data: [{ domain: 'example.com', state: 'verified' }],
+                        name: 'Test Organization 2',
+                    });
+                    expect(subject.id).toEqual('org_01EHT88Z8J8795GZNQ4ZP1J81T');
+                    expect(subject.name).toEqual('Test Organization 2');
+                    expect(subject.domains).toHaveLength(1);
+                }));
+            });
         });
     });
 });

package/lib/organizations/serializers/create-organization-options.serializer.js

@@ -4,6 +4,7 @@ exports.serializeCreateOrganizationOptions = void 0;
 const serializeCreateOrganizationOptions = (options) => ({
     name: options.name,
     allow_profiles_outside_organization: options.allowProfilesOutsideOrganization,
+    domain_data: options.domainData,
     domains: options.domains,
 });
 exports.serializeCreateOrganizationOptions = serializeCreateOrganizationOptions;

package/lib/organizations/serializers/update-organization-options.serializer.js

@@ -4,6 +4,7 @@ exports.serializeUpdateOrganizationOptions = void 0;
 const serializeUpdateOrganizationOptions = (options) => ({
     name: options.name,
     allow_profiles_outside_organization: options.allowProfilesOutsideOrganization,
+    domain_data: options.domainData,
     domains: options.domains,
 });
 exports.serializeUpdateOrganizationOptions = serializeUpdateOrganizationOptions;

package/lib/user-management/fixtures/invitation.json

@@ -8,6 +8,7 @@
     "expires_at": "2023-07-18T02:07:19.911Z",
     "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
     "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+    "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
     "created_at": "2023-07-18T02:07:19.911Z",
     "updated_at": "2023-07-18T02:07:19.911Z"
 }

package/lib/user-management/fixtures/list-invitations.json

@@ -11,6 +11,7 @@
             "expires_at": "2023-07-18T02:07:19.911Z",
             "organization_id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS",
             "token": "Z1uX3RbwcIl5fIGJJJCXXisdI",
+            "accept_invitation_url": "https://myauthkit.com/invite?invitation_token=Z1uX3RbwcIl5fIGJJJCXXisdI",
             "created_at": "2023-07-18T02:07:19.911Z",
             "updated_at": "2023-07-18T02:07:19.911Z"
         }

package/lib/user-management/fixtures/magic_auth.json

@@ -0,0 +1,10 @@
+{
+    "object": "magic_auth",
+    "id": "magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "user_id": "user_01H5JQDV7R7ATEYZDEG0W5PRYS",
+    "email": "dane@workos.com",
+    "expires_at": "2023-07-18T02:07:19.911Z",
+    "code": "123456",
+    "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,11 +1,13 @@
 import { Impersonator, ImpersonatorResponse } from './impersonator.interface';
 import { User, UserResponse } from './user.interface';
+type AuthenticationMethod = 'SSO' | 'Password' | 'GitHubOAuth' | 'GoogleOAuth' | 'MicrosoftOAuth' | 'MagicAuth' | 'Impersonation';
 export interface AuthenticationResponse {
     user: User;
     organizationId?: string;
     accessToken: string;
     refreshToken: string;
     impersonator?: Impersonator;
+    authenticationMethod?: AuthenticationMethod;
 }
 export interface AuthenticationResponseResponse {
     user: UserResponse;
@@ -13,6 +15,7 @@ export interface AuthenticationResponseResponse {
     access_token: string;
     refresh_token: string;
     impersonator?: ImpersonatorResponse;
+    authentication_method?: AuthenticationMethod;
 }
 export interface RefreshAuthenticationResponse {
     accessToken: string;
@@ -22,3 +25,4 @@ export interface RefreshAuthenticationResponseResponse {
     access_token: string;
     refresh_token: string;
 }
+export {};

package/lib/user-management/interfaces/create-magic-auth-options.interface.d.ts

@@ -0,0 +1,8 @@
+export interface CreateMagicAuthOptions {
+    email: string;
+    invitationToken?: string;
+}
+export interface SerializedCreateMagicAuthOptions {
+    email: string;
+    invitation_token?: string;
+}

package/lib/user-management/interfaces/create-magic-auth-options.interface.js

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

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

@@ -9,6 +9,7 @@ export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-refresh-token-options.interface';
 export * from './authenticate-with-totp-options.interface';
 export * from './authentication-response.interface';
+export * from './create-magic-auth-options.interface';
 export * from './create-organization-membership-options.interface';
 export * from './create-user-options.interface';
 export * from './enroll-auth-factor.interface';
@@ -19,6 +20,7 @@ export * from './list-auth-factors-options.interface';
 export * from './list-invitations-options.interface';
 export * from './list-organization-memberships-options.interface';
 export * from './list-users-options.interface';
+export * from './magic-auth.interface';
 export * from './organization-membership.interface';
 export * from './reset-password-options.interface';
 export * from './revoke-session-options.interface';
@@ -33,3 +35,4 @@ export * from './update-user-options.interface';
 export * from './update-user-password-options.interface';
 export * from './user.interface';
 export * from './verify-email-options.interface';
+export * from './role.interface';

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

@@ -25,6 +25,7 @@ __exportStar(require("./authenticate-with-password-options.interface"), exports)
 __exportStar(require("./authenticate-with-refresh-token-options.interface"), exports);
 __exportStar(require("./authenticate-with-totp-options.interface"), exports);
 __exportStar(require("./authentication-response.interface"), exports);
+__exportStar(require("./create-magic-auth-options.interface"), exports);
 __exportStar(require("./create-organization-membership-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
 __exportStar(require("./enroll-auth-factor.interface"), exports);
@@ -35,6 +36,7 @@ __exportStar(require("./list-auth-factors-options.interface"), exports);
 __exportStar(require("./list-invitations-options.interface"), exports);
 __exportStar(require("./list-organization-memberships-options.interface"), exports);
 __exportStar(require("./list-users-options.interface"), exports);
+__exportStar(require("./magic-auth.interface"), exports);
 __exportStar(require("./organization-membership.interface"), exports);
 __exportStar(require("./reset-password-options.interface"), exports);
 __exportStar(require("./revoke-session-options.interface"), exports);
@@ -49,3 +51,4 @@ __exportStar(require("./update-user-options.interface"), exports);
 __exportStar(require("./update-user-password-options.interface"), exports);
 __exportStar(require("./user.interface"), exports);
 __exportStar(require("./verify-email-options.interface"), exports);
+__exportStar(require("./role.interface"), exports);

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

@@ -8,6 +8,19 @@ export interface Invitation {
     expiresAt: string;
     organizationId: string | null;
     token: string;
+    acceptInvitationUrl: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface InvitationEvent {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    acceptedAt: string | null;
+    revokedAt: string | null;
+    expiresAt: string;
+    organizationId: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -21,6 +34,19 @@ export interface InvitationResponse {
     expires_at: string;
     organization_id: string | null;
     token: string;
+    accept_invitation_url: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface InvitationEventResponse {
+    object: 'invitation';
+    id: string;
+    email: string;
+    state: 'pending' | 'accepted' | 'expired' | 'revoked';
+    accepted_at: string | null;
+    revoked_at: string | null;
+    expires_at: string;
+    organization_id: string | null;
     created_at: string;
     updated_at: string;
 }

package/lib/user-management/interfaces/magic-auth.interface.d.ts

@@ -0,0 +1,38 @@
+export interface MagicAuth {
+    object: 'magic_auth';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    code: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MagicAuthEvent {
+    object: 'magic_auth';
+    id: string;
+    userId: string;
+    email: string;
+    expiresAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface MagicAuthResponse {
+    object: 'magic_auth';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    code: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface MagicAuthEventResponse {
+    object: 'magic_auth';
+    id: string;
+    user_id: string;
+    email: string;
+    expires_at: string;
+    created_at: string;
+    updated_at: string;
+}

package/lib/user-management/interfaces/magic-auth.interface.js

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

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

@@ -1,3 +1,11 @@
 export interface RoleResponse {
     slug: string;
 }
+export interface RoleEvent {
+    object: 'role';
+    slug: string;
+}
+export interface RoleEventResponse {
+    object: 'role';
+    slug: string;
+}

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, 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);
+    const { user, organization_id, access_token, refresh_token, authentication_method, impersonator } = authenticationResponse, rest = __rest(authenticationResponse, ["user", "organization_id", "access_token", "refresh_token", "authentication_method", "impersonator"]);
+    return Object.assign({ user: (0, user_serializer_1.deserializeUser)(user), organizationId: organization_id, accessToken: access_token, refreshToken: refresh_token, impersonator, authenticationMethod: authentication_method }, rest);
 };
 exports.deserializeAuthenticationResponse = deserializeAuthenticationResponse;
 const deserializeRefreshAuthenticationResponse = (refreshAuthenticationResponse) => {

package/lib/user-management/serializers/create-magic-auth-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { CreateMagicAuthOptions, SerializedCreateMagicAuthOptions } from '../interfaces';
+export declare const serializeCreateMagicAuthOptions: (options: CreateMagicAuthOptions) => SerializedCreateMagicAuthOptions;

package/lib/user-management/serializers/create-magic-auth-options.serializer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCreateMagicAuthOptions = void 0;
+const serializeCreateMagicAuthOptions = (options) => ({
+    email: options.email,
+    invitation_token: options.invitationToken,
+});
+exports.serializeCreateMagicAuthOptions = serializeCreateMagicAuthOptions;

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

@@ -4,8 +4,11 @@ export * from './authenticate-with-password-options.serializer';
 export * from './authenticate-with-refresh-token.options.serializer';
 export * from './authenticate-with-totp-options.serializer';
 export * from './authentication-response.serializer';
+export * from './create-magic-auth-options.serializer';
 export * from './enroll-auth-factor-options.serializer';
 export * from './factor.serializer';
+export * from './invitation.serializer';
+export * from './magic-auth.serializer';
 export * from './reset-password-options.serializer';
 export * from './send-password-reset-email.serializer';
 export * from './create-user-options.serializer';

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

@@ -20,8 +20,11 @@ __exportStar(require("./authenticate-with-password-options.serializer"), exports
 __exportStar(require("./authenticate-with-refresh-token.options.serializer"), exports);
 __exportStar(require("./authenticate-with-totp-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
+__exportStar(require("./create-magic-auth-options.serializer"), exports);
 __exportStar(require("./enroll-auth-factor-options.serializer"), exports);
 __exportStar(require("./factor.serializer"), exports);
+__exportStar(require("./invitation.serializer"), exports);
+__exportStar(require("./magic-auth.serializer"), exports);
 __exportStar(require("./reset-password-options.serializer"), exports);
 __exportStar(require("./send-password-reset-email.serializer"), exports);
 __exportStar(require("./create-user-options.serializer"), exports);

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

@@ -1,2 +1,3 @@
-import { Invitation, InvitationResponse } from '../interfaces/invitation.interface';
+import { Invitation, InvitationEvent, InvitationEventResponse, InvitationResponse } from '../interfaces/invitation.interface';
 export declare const deserializeInvitation: (invitation: InvitationResponse) => Invitation;
+export declare const deserializeInvitationEvent: (invitation: InvitationEventResponse) => InvitationEvent;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeInvitation = void 0;
+exports.deserializeInvitationEvent = exports.deserializeInvitation = void 0;
 const deserializeInvitation = (invitation) => ({
     object: invitation.object,
     id: invitation.id,
@@ -11,7 +11,21 @@ const deserializeInvitation = (invitation) => ({
     expiresAt: invitation.expires_at,
     organizationId: invitation.organization_id,
     token: invitation.token,
+    acceptInvitationUrl: invitation.accept_invitation_url,
     createdAt: invitation.created_at,
     updatedAt: invitation.updated_at,
 });
 exports.deserializeInvitation = deserializeInvitation;
+const deserializeInvitationEvent = (invitation) => ({
+    object: invitation.object,
+    id: invitation.id,
+    email: invitation.email,
+    state: invitation.state,
+    acceptedAt: invitation.accepted_at,
+    revokedAt: invitation.revoked_at,
+    expiresAt: invitation.expires_at,
+    organizationId: invitation.organization_id,
+    createdAt: invitation.created_at,
+    updatedAt: invitation.updated_at,
+});
+exports.deserializeInvitationEvent = deserializeInvitationEvent;

package/lib/user-management/serializers/magic-auth.serializer.d.ts

@@ -0,0 +1,3 @@
+import { MagicAuth, MagicAuthEvent, MagicAuthEventResponse, MagicAuthResponse } from '../interfaces/magic-auth.interface';
+export declare const deserializeMagicAuth: (magicAuth: MagicAuthResponse) => MagicAuth;
+export declare const deserializeMagicAuthEvent: (magicAuth: MagicAuthEventResponse) => MagicAuthEvent;

package/lib/user-management/serializers/magic-auth.serializer.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeMagicAuthEvent = exports.deserializeMagicAuth = void 0;
+const deserializeMagicAuth = (magicAuth) => ({
+    object: magicAuth.object,
+    id: magicAuth.id,
+    userId: magicAuth.user_id,
+    email: magicAuth.email,
+    expiresAt: magicAuth.expires_at,
+    code: magicAuth.code,
+    createdAt: magicAuth.created_at,
+    updatedAt: magicAuth.updated_at,
+});
+exports.deserializeMagicAuth = deserializeMagicAuth;
+const deserializeMagicAuthEvent = (magicAuth) => ({
+    object: magicAuth.object,
+    id: magicAuth.id,
+    userId: magicAuth.user_id,
+    email: magicAuth.email,
+    expiresAt: magicAuth.expires_at,
+    createdAt: magicAuth.created_at,
+    updatedAt: magicAuth.updated_at,
+});
+exports.deserializeMagicAuthEvent = deserializeMagicAuthEvent;

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

@@ -0,0 +1,2 @@
+import { RoleEvent, RoleEventResponse } from '../interfaces';
+export declare const deserializeRole: (role: RoleEventResponse) => RoleEvent;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeRole = void 0;
+const deserializeRole = (role) => ({
+    object: 'role',
+    slug: role.slug,
+});
+exports.deserializeRole = deserializeRole;

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

@@ -1,6 +1,6 @@
 import { WorkOS } from '../workos';
 import { AutoPaginatable } from '../common/utils/pagination';
-import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions, AuthenticateWithRefreshTokenOptions, RefreshAuthenticationResponse } from './interfaces';
+import { AuthenticateWithCodeOptions, AuthenticateWithMagicAuthOptions, AuthenticateWithPasswordOptions, AuthenticateWithTotpOptions, AuthenticationResponse, ResetPasswordOptions, SendPasswordResetEmailOptions, CreateUserOptions, EnrollAuthFactorOptions, ListAuthFactorsOptions, ListUsersOptions, SendMagicAuthCodeOptions, SendVerificationEmailOptions, UpdateUserOptions, User, VerifyEmailOptions, AuthenticateWithRefreshTokenOptions, RefreshAuthenticationResponse, MagicAuth, CreateMagicAuthOptions } from './interfaces';
 import { Challenge } from '../mfa/interfaces';
 import { OrganizationMembership } from './interfaces/organization-membership.interface';
 import { ListOrganizationMembershipsOptions } from './interfaces/list-organization-memberships-options.interface';
@@ -30,6 +30,11 @@ export declare class UserManagement {
     sendVerificationEmail({ userId, }: SendVerificationEmailOptions): Promise<{
         user: User;
     }>;
+    getMagicAuth(magicAuthId: string): Promise<MagicAuth>;
+    createMagicAuth(options: CreateMagicAuthOptions): Promise<MagicAuth>;
+    /**
+     * @deprecated Please use `createMagicAuth` instead. This method will be removed in a future major version.
+     */
     sendMagicAuthCode(options: SendMagicAuthCodeOptions): Promise<void>;
     verifyEmail({ code, userId, }: VerifyEmailOptions): Promise<{
         user: User;

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

@@ -106,6 +106,21 @@ class UserManagement {
             return { user: (0, serializers_1.deserializeUser)(data.user) };
         });
     }
+    getMagicAuth(magicAuthId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/magic_auth/${magicAuthId}`);
+            return (0, serializers_1.deserializeMagicAuth)(data);
+        });
+    }
+    createMagicAuth(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/user_management/magic_auth', (0, serializers_1.serializeCreateMagicAuthOptions)(Object.assign({}, options)));
+            return (0, serializers_1.deserializeMagicAuth)(data);
+        });
+    }
+    /**
+     * @deprecated Please use `createMagicAuth` instead. This method will be removed in a future major version.
+     */
     sendMagicAuthCode(options) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.workos.post('/user_management/magic_auth/send', (0, serializers_1.serializeSendMagicAuthCodeOptions)(options));

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

@@ -22,10 +22,12 @@ const organization_membership_json_1 = __importDefault(require("./fixtures/organ
 const list_organization_memberships_json_1 = __importDefault(require("./fixtures/list-organization-memberships.json"));
 const invitation_json_1 = __importDefault(require("./fixtures/invitation.json"));
 const list_invitations_json_1 = __importDefault(require("./fixtures/list-invitations.json"));
+const magic_auth_json_1 = __importDefault(require("./fixtures/magic_auth.json"));
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const userId = 'user_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const organizationMembershipId = 'om_01H5JQDV7R7ATEYZDEG0W5PRYS';
 const invitationId = 'invitation_01H5JQDV7R7ATEYZDEG0W5PRYS';
+const magicAuthId = 'magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS';
 describe('UserManagement', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('getUser', () => {
@@ -155,6 +157,22 @@ describe('UserManagement', () => {
                 },
             });
         }));
+        it('deserializes authentication_method', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({
+                user: user_json_1.default,
+                authentication_method: 'Password',
+            });
+            const resp = yield workos.userManagement.authenticateWithCode({
+                clientId: 'proj_whatever',
+                code: 'or this',
+            });
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+                authenticationMethod: 'Password',
+            });
+        }));
         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)({
@@ -308,6 +326,43 @@ describe('UserManagement', () => {
             }));
         });
     });
+    describe('getMagicAuth', () => {
+        it('sends a Get Magic Auth request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(magic_auth_json_1.default);
+            const magicAuth = yield workos.userManagement.getMagicAuth(magicAuthId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/magic_auth/${magicAuthId}`);
+            expect(magicAuth).toMatchObject({
+                id: 'magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'dane@workos.com',
+                expiresAt: '2023-07-18T02:07:19.911Z',
+                code: '123456',
+                createdAt: '2023-07-18T02:07:19.911Z',
+                updatedAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
+    describe('createMagicAuth', () => {
+        it('sends a Create Magic Auth request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(magic_auth_json_1.default);
+            const response = yield workos.userManagement.createMagicAuth({
+                email: 'bob.loblaw@example.com',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/user_management/magic_auth');
+            expect((0, test_utils_1.fetchBody)()).toEqual({
+                email: 'bob.loblaw@example.com',
+            });
+            expect(response).toMatchObject({
+                id: 'magic_auth_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                userId: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'dane@workos.com',
+                expiresAt: '2023-07-18T02:07:19.911Z',
+                code: '123456',
+                createdAt: '2023-07-18T02:07:19.911Z',
+                updatedAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
     describe('sendMagicAuthCode', () => {
         it('sends a Send Magic Auth Code request', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)();

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 = '7.1.0';
+const VERSION = '7.3.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.1.0",
+  "version": "7.3.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -9,7 +9,7 @@
     "workos"
   ],
   "volta": {
-    "node": "14.21.3",
+    "node": "19.9.0",
     "yarn": "1.22.19"
   },
   "engines": {