@workos-inc/node 3.1.1 → 3.2.0

package/lib/users/interfaces/authenticate-user-with-token-options.interface.d.ts

@@ -1,12 +1,12 @@
-export interface AuthenticateUserWithTokenOptions {
+export interface AuthenticateUserWithCodeOptions {
     clientId: string;
     code: string;
     expiresIn?: number;
 }
-export interface AuthenticateUserWithTokenCredentials {
+export interface AuthenticateUserWithCodeCredentials {
     clientSecret: string | undefined;
 }
-export interface SerializedAuthenticateUserWithTokenOptions {
+export interface SerializedAuthenticateUserWithCodeOptions {
     grant_type: 'authorization_code';
     client_id: string;
     client_secret: string | undefined;

package/lib/users/interfaces/enroll-user-in-mfa-factor.interface.d.ts

@@ -0,0 +1,11 @@
+export interface EnrollUserInMfaFactorOptions {
+    userId: string;
+    type: 'totp';
+    totpIssuer: string;
+    totpUser: string;
+}
+export interface SerializedEnrollUserInMfaFactorOptions {
+    type: 'totp';
+    totp_issuer: string;
+    totp_user: string;
+}

package/lib/users/interfaces/enroll-user-in-mfa-factor.interface.js

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

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

@@ -7,6 +7,7 @@ export * from './complete-password-reset-options.interface';
 export * from './create-email-verification-challenge-options.interface';
 export * from './create-password-reset-challenge-options.interface';
 export * from './create-user-options.interface';
+export * from './enroll-user-in-mfa-factor.interface';
 export * from './list-users-options.interface';
 export * from './magic-auth-challenge.interface';
 export * from './remove-user-from-organization-options.interface';

package/lib/users/interfaces/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./complete-password-reset-options.interface"), exports);
 __exportStar(require("./create-email-verification-challenge-options.interface"), exports);
 __exportStar(require("./create-password-reset-challenge-options.interface"), exports);
 __exportStar(require("./create-user-options.interface"), exports);
+__exportStar(require("./enroll-user-in-mfa-factor.interface"), exports);
 __exportStar(require("./list-users-options.interface"), exports);
 __exportStar(require("./magic-auth-challenge.interface"), exports);
 __exportStar(require("./remove-user-from-organization-options.interface"), exports);

package/lib/users/serializers/authenticate-user-with-code-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticateUserWithCodeCredentials, AuthenticateUserWithCodeOptions, SerializedAuthenticateUserWithCodeOptions } from '../interfaces';
+export declare const serializeAuthenticateUserWithCodeOptions: (options: AuthenticateUserWithCodeOptions & AuthenticateUserWithCodeCredentials) => SerializedAuthenticateUserWithCodeOptions;

package/lib/users/serializers/{authenticate-user-with-token-options.serializer.js → authenticate-user-with-code-options.serializer.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeAuthenticateUserWithTokenOptions = void 0;
-const serializeAuthenticateUserWithTokenOptions = (options) => ({
+exports.serializeAuthenticateUserWithCodeOptions = void 0;
+const serializeAuthenticateUserWithCodeOptions = (options) => ({
     grant_type: 'authorization_code',
     client_id: options.clientId,
     client_secret: options.clientSecret,
     code: options.code,
     expires_in: options.expiresIn,
 });
-exports.serializeAuthenticateUserWithTokenOptions = serializeAuthenticateUserWithTokenOptions;
+exports.serializeAuthenticateUserWithCodeOptions = serializeAuthenticateUserWithCodeOptions;

package/lib/users/serializers/enroll-user-in-mfa-factor-options.serializer.d.ts

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

package/lib/users/serializers/enroll-user-in-mfa-factor-options.serializer.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeEnrollUserInMfaFactorOptions = void 0;
+const serializeEnrollUserInMfaFactorOptions = (options) => ({
+    type: options.type,
+    totp_issuer: options.totpIssuer,
+    totp_user: options.totpUser,
+});
+exports.serializeEnrollUserInMfaFactorOptions = serializeEnrollUserInMfaFactorOptions;

package/lib/users/serializers/index.d.ts

@@ -1,6 +1,6 @@
+export * from './authenticate-user-with-code-options.serializer';
 export * from './authenticate-user-with-magic-auth-options.serializer';
 export * from './authenticate-user-with-password-options.serializer';
-export * from './authenticate-user-with-token-options.serializer';
 export * from './authentication-response.serializer';
 export * from './complete-password-reset-options.serializer';
 export * from './create-email-verification-challenge.serializer';
@@ -9,7 +9,7 @@ export * from './create-user-options.serializer';
 export * from './revoke-session-options.serializer';
 export * from './send-magic-auth-code-options.serializer';
 export * from './session.serializer';
-export * from './update-user-password-options.serializer';
 export * from './update-user-options.serializer';
+export * from './update-user-password-options.serializer';
 export * from './user.serializer';
 export * from './verify-session.serializer';

package/lib/users/serializers/index.js

@@ -14,9 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./authenticate-user-with-code-options.serializer"), exports);
 __exportStar(require("./authenticate-user-with-magic-auth-options.serializer"), exports);
 __exportStar(require("./authenticate-user-with-password-options.serializer"), exports);
-__exportStar(require("./authenticate-user-with-token-options.serializer"), exports);
 __exportStar(require("./authentication-response.serializer"), exports);
 __exportStar(require("./complete-password-reset-options.serializer"), exports);
 __exportStar(require("./create-email-verification-challenge.serializer"), exports);
@@ -25,7 +25,7 @@ __exportStar(require("./create-user-options.serializer"), exports);
 __exportStar(require("./revoke-session-options.serializer"), exports);
 __exportStar(require("./send-magic-auth-code-options.serializer"), exports);
 __exportStar(require("./session.serializer"), exports);
-__exportStar(require("./update-user-password-options.serializer"), exports);
 __exportStar(require("./update-user-options.serializer"), exports);
+__exportStar(require("./update-user-password-options.serializer"), exports);
 __exportStar(require("./user.serializer"), exports);
 __exportStar(require("./verify-session.serializer"), exports);

package/lib/users/users.d.ts

@@ -1,6 +1,7 @@
 import { WorkOS } from '../workos';
 import { AutoPaginatable } from '../common/utils/pagination';
-import { AddUserToOrganizationOptions, AuthenticateUserWithMagicAuthOptions, AuthenticateUserWithPasswordOptions, AuthenticateUserWithTokenOptions, AuthenticationResponse, CompletePasswordResetOptions, CreateEmailVerificationChallengeOptions, CreateEmailVerificationChallengeResponse, CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreateUserOptions, ListUsersOptions, MagicAuthChallenge, RemoveUserFromOrganizationOptions, RevokeAllSessionsForUserOptions, RevokeSessionOptions, SendMagicAuthCodeOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifySessionOptions, VerifySessionResponse } from './interfaces';
+import { AddUserToOrganizationOptions, AuthenticateUserWithMagicAuthOptions, AuthenticateUserWithPasswordOptions, AuthenticateUserWithCodeOptions, AuthenticationResponse, CompletePasswordResetOptions, CreateEmailVerificationChallengeOptions, CreateEmailVerificationChallengeResponse, CreatePasswordResetChallengeOptions, CreatePasswordResetChallengeResponse, CreateUserOptions, ListUsersOptions, MagicAuthChallenge, RemoveUserFromOrganizationOptions, RevokeAllSessionsForUserOptions, RevokeSessionOptions, SendMagicAuthCodeOptions, UpdateUserOptions, UpdateUserPasswordOptions, User, VerifySessionOptions, VerifySessionResponse, EnrollUserInMfaFactorOptions } from './interfaces';
+import { Challenge, Factor } from '../mfa/interfaces';
 export declare class Users {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -9,7 +10,7 @@ export declare class Users {
     createUser(payload: CreateUserOptions): Promise<User>;
     authenticateUserWithMagicAuth(payload: AuthenticateUserWithMagicAuthOptions): Promise<AuthenticationResponse>;
     authenticateUserWithPassword(payload: AuthenticateUserWithPasswordOptions): Promise<AuthenticationResponse>;
-    authenticateUserWithToken(payload: AuthenticateUserWithTokenOptions): Promise<AuthenticationResponse>;
+    authenticateUserWithCode(payload: AuthenticateUserWithCodeOptions): Promise<AuthenticationResponse>;
     verifySession(payload: VerifySessionOptions): Promise<VerifySessionResponse>;
     revokeSession(payload: RevokeSessionOptions): Promise<boolean>;
     revokeAllSessionsForUser({ userId, }: RevokeAllSessionsForUserOptions): Promise<boolean>;
@@ -22,4 +23,8 @@ export declare class Users {
     removeUserFromOrganization({ userId, organizationId, }: RemoveUserFromOrganizationOptions): Promise<User>;
     updateUser(payload: UpdateUserOptions): Promise<User>;
     updateUserPassword(payload: UpdateUserPasswordOptions): Promise<User>;
+    enrollUserInMfaFactor(payload: EnrollUserInMfaFactorOptions): Promise<{
+        authenticationFactor: Factor;
+        authenticationChallenge: Challenge;
+    }>;
 }

package/lib/users/users.js

@@ -13,6 +13,8 @@ exports.Users = void 0;
 const pagination_1 = require("../common/utils/pagination");
 const serializers_1 = require("./serializers");
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
+const serializers_2 = require("../mfa/serializers");
+const enroll_user_in_mfa_factor_options_serializer_1 = require("./serializers/enroll-user-in-mfa-factor-options.serializer");
 class Users {
     constructor(workos) {
         this.workos = workos;
@@ -46,9 +48,9 @@ class Users {
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
-    authenticateUserWithToken(payload) {
+    authenticateUserWithCode(payload) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/users/sessions/token', (0, serializers_1.serializeAuthenticateUserWithTokenOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
+            const { data } = yield this.workos.post('/users/sessions/token', (0, serializers_1.serializeAuthenticateUserWithCodeOptions)(Object.assign(Object.assign({}, payload), { clientSecret: this.workos.key })));
             return (0, serializers_1.deserializeAuthenticationResponse)(data);
         });
     }
@@ -130,5 +132,14 @@ class Users {
             return (0, serializers_1.deserializeUser)(data);
         });
     }
+    enrollUserInMfaFactor(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/users/${payload.userId}/auth/factors`, (0, enroll_user_in_mfa_factor_options_serializer_1.serializeEnrollUserInMfaFactorOptions)(payload));
+            return {
+                authenticationFactor: (0, serializers_2.deserializeFactor)(data.authentication_factor),
+                authenticationChallenge: (0, serializers_2.deserializeChallenge)(data.authentication_challenge),
+            };
+        });
+    }
 }
 exports.Users = Users;

package/lib/users/users.spec.js

@@ -146,12 +146,12 @@ describe('UserManagement', () => {
             });
         }));
     });
-    describe('authenticateUserWithToken', () => {
+    describe('authenticateUserWithCode', () => {
         it('sends a token authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
             mock
                 .onPost('/users/sessions/token')
                 .reply(200, { user: user_json_1.default, session: session_json_1.default });
-            const resp = yield workos.users.authenticateUserWithToken({
+            const resp = yield workos.users.authenticateUserWithCode({
                 clientId: 'proj_whatever',
                 code: 'or this',
                 expiresIn: 15,
@@ -375,4 +375,65 @@ describe('UserManagement', () => {
             });
         }));
     });
+    describe('enrollUserInMfaFactor', () => {
+        it('sends an enrollUserInMfaFactor request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost(`/users/${userId}/auth/factors`).reply(200, {
+                authentication_factor: {
+                    object: 'authentication_factor',
+                    id: 'auth_factor_1234',
+                    created_at: '2022-03-15T20:39:19.892Z',
+                    updated_at: '2022-03-15T20:39:19.892Z',
+                    type: 'totp',
+                    totp: {
+                        issuer: 'WorkOS',
+                        qr_code: 'qr-code-test',
+                        secret: 'secret-test',
+                        uri: 'uri-test',
+                        user: 'some_user',
+                    },
+                },
+                authentication_challenge: {
+                    object: 'authentication_challenge',
+                    id: 'auth_challenge_1234',
+                    created_at: '2022-03-15T20:39:19.892Z',
+                    updated_at: '2022-03-15T20:39:19.892Z',
+                    expires_at: '2022-03-15T21:39:19.892Z',
+                    code: '12345',
+                    authentication_factor_id: 'auth_factor_1234',
+                },
+            });
+            const resp = yield workos.users.enrollUserInMfaFactor({
+                userId,
+                type: 'totp',
+                totpIssuer: 'WorkOS',
+                totpUser: 'some_user',
+            });
+            expect(mock.history.post[0].url).toEqual(`/users/${userId}/auth/factors`);
+            expect(resp).toMatchObject({
+                authenticationFactor: {
+                    object: 'authentication_factor',
+                    id: 'auth_factor_1234',
+                    createdAt: '2022-03-15T20:39:19.892Z',
+                    updatedAt: '2022-03-15T20:39:19.892Z',
+                    type: 'totp',
+                    totp: {
+                        issuer: 'WorkOS',
+                        qrCode: 'qr-code-test',
+                        secret: 'secret-test',
+                        uri: 'uri-test',
+                        user: 'some_user',
+                    },
+                },
+                authenticationChallenge: {
+                    object: 'authentication_challenge',
+                    id: 'auth_challenge_1234',
+                    createdAt: '2022-03-15T20:39:19.892Z',
+                    updatedAt: '2022-03-15T20:39:19.892Z',
+                    expiresAt: '2022-03-15T21:39:19.892Z',
+                    code: '12345',
+                    authenticationFactorId: 'auth_factor_1234',
+                },
+            });
+        }));
+    });
 });

package/lib/workos.js

@@ -27,7 +27,7 @@ const mfa_1 = require("./mfa/mfa");
 const audit_logs_1 = require("./audit-logs/audit-logs");
 const users_1 = require("./users/users");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
-const VERSION = '3.1.1';
+const VERSION = '3.2.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {

package/package.json

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

package/lib/users/serializers/authenticate-user-with-token-options.serializer.d.ts

@@ -1,2 +0,0 @@
-import { AuthenticateUserWithTokenCredentials, AuthenticateUserWithTokenOptions, SerializedAuthenticateUserWithTokenOptions } from '../interfaces';
-export declare const serializeAuthenticateUserWithTokenOptions: (options: AuthenticateUserWithTokenOptions & AuthenticateUserWithTokenCredentials) => SerializedAuthenticateUserWithTokenOptions;