@workos-inc/node 6.8.0 → 7.0.0

package/lib/common/exceptions/index.d.ts

@@ -1,4 +1,5 @@
 export * from './generic-server.exception';
+export * from './bad-request.exception';
 export * from './no-api-key-provided.exception';
 export * from './not-found.exception';
 export * from './oauth.exception';

package/lib/common/exceptions/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./generic-server.exception"), exports);
+__exportStar(require("./bad-request.exception"), exports);
 __exportStar(require("./no-api-key-provided.exception"), exports);
 __exportStar(require("./not-found.exception"), exports);
 __exportStar(require("./oauth.exception"), exports);

package/lib/common/interfaces/app-info.interface.d.ts

@@ -0,0 +1,4 @@
+export interface AppInfo {
+    name: string;
+    version: string;
+}

package/lib/common/interfaces/workos-options.interface.d.ts

@@ -1,6 +1,8 @@
+import { AppInfo } from './app-info.interface';
 export interface WorkOSOptions {
     apiHostname?: string;
     https?: boolean;
     port?: number;
     config?: RequestInit;
+    appInfo?: AppInfo;
 }

package/lib/directory-sync/directory-sync.spec.js

@@ -128,11 +128,9 @@ describe('DirectorySync', () => {
                 };
                 (0, test_utils_1.fetchOnce)(directoryListResponse);
                 const subject = yield workos.directorySync.listDirectories({
-                    domain: 'google.com',
                     organizationId: 'org_1234',
                 });
                 expect((0, test_utils_1.fetchSearchParams)()).toMatchObject({
-                    domain: 'google.com',
                     organization_id: 'org_1234',
                 });
                 expect(subject).toMatchObject({
@@ -143,9 +141,6 @@ describe('DirectorySync', () => {
                         listMetadata: {},
                     },
                     apiCall: expect.any(Function),
-                    options: {
-                        domain: 'google.com',
-                    },
                 });
             }));
         });

package/lib/directory-sync/interfaces/list-directories-options.interface.d.ts

@@ -1,11 +1,9 @@
 import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
 export interface ListDirectoriesOptions extends PaginationOptions {
-    domain?: string;
     organizationId?: string;
     search?: string;
 }
 export interface SerializedListDirectoriesOptions extends PaginationOptions {
-    domain?: string;
     organization_id?: string;
     search?: string;
 }

package/lib/directory-sync/serializers/list-directories-options.serializer.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeListDirectoriesOptions = void 0;
 const serializeListDirectoriesOptions = (options) => ({
-    domain: options.domain,
     organization_id: options.organizationId,
     search: options.search,
     limit: options.limit,

package/lib/events/events.spec.js

@@ -83,18 +83,6 @@ describe('Event', () => {
                 });
             }));
         });
-        it(`requests Events`, () => __awaiter(void 0, void 0, void 0, function* () {
-            (0, test_utils_1.fetchOnce)(eventsListResponse);
-            const subject = yield workos.events.listEvents({
-                rangeStart: '2020-05-05',
-                rangeEnd: '2020-05-07',
-            });
-            expect(subject).toEqual({
-                object: 'list',
-                data: [event],
-                listMetadata: {},
-            });
-        }));
         it(`requests Events with a valid event name`, () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)(eventsListResponse);
             const list = yield workos.events.listEvents({

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

@@ -1,13 +1,13 @@
 import { EventName } from '../../common/interfaces';
 export interface ListEventOptions {
-    events?: EventName[];
+    events: EventName[];
     rangeStart?: string;
     rangeEnd?: string;
     limit?: number;
     after?: string;
 }
 export interface SerializedListEventOptions {
-    events?: EventName[];
+    events: EventName[];
     range_start?: string;
     range_end?: string;
     limit?: number;

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

@@ -1,6 +1,8 @@
 export interface CreateUserOptions {
     email: string;
     password?: string;
+    passwordHash?: string;
+    passwordHashType?: 'bcrypt' | 'firebase-scrypt' | 'ssha';
     firstName?: string;
     lastName?: string;
     emailVerified?: boolean;
@@ -8,6 +10,8 @@ export interface CreateUserOptions {
 export interface SerializedCreateUserOptions {
     email: string;
     password?: string;
+    password_hash?: string;
+    password_hash_type?: 'bcrypt' | 'firebase-scrypt' | 'ssha';
     first_name?: string;
     last_name?: string;
     email_verified?: boolean;

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

@@ -1,19 +1,35 @@
 export * from './authenticate-with-magic-auth-options.interface';
 export * from './authenticate-with-password-options.interface';
 export * from './authenticate-with-code-options.interface';
+export * from './authenticate-with-email-verification-options.interface';
+export * from './authenticate-with-magic-auth-options.interface';
+export * from './authenticate-with-options-base.interface';
+export * from './authenticate-with-organization-selection.interface';
+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 './reset-password-options.interface';
-export * from './send-password-reset-email-options.interface';
+export * from './create-organization-membership-options.interface';
 export * from './create-user-options.interface';
 export * from './enroll-auth-factor.interface';
-export * from './list-users-options.interface';
+export * from './factor.interface';
+export * from './impersonator.interface';
+export * from './invitation.interface';
 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 './organization-membership.interface';
+export * from './reset-password-options.interface';
+export * from './revoke-session-options.interface';
+export * from './role.interface';
+export * from './send-invitation-options.interface';
 export * from './send-magic-auth-code-options.interface';
-export * from './send-verification-email-options';
+export * from './send-password-reset-email-options.interface';
+export * from './send-verification-email-options.interface';
+export * from './session.interface';
+export * from './update-organization-membership-options.interface';
 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

@@ -17,19 +17,35 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authenticate-with-magic-auth-options.interface"), exports);
 __exportStar(require("./authenticate-with-password-options.interface"), exports);
 __exportStar(require("./authenticate-with-code-options.interface"), exports);
+__exportStar(require("./authenticate-with-email-verification-options.interface"), exports);
+__exportStar(require("./authenticate-with-magic-auth-options.interface"), exports);
+__exportStar(require("./authenticate-with-options-base.interface"), exports);
+__exportStar(require("./authenticate-with-organization-selection.interface"), exports);
+__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("./reset-password-options.interface"), exports);
-__exportStar(require("./send-password-reset-email-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);
-__exportStar(require("./list-users-options.interface"), exports);
+__exportStar(require("./factor.interface"), exports);
+__exportStar(require("./impersonator.interface"), exports);
+__exportStar(require("./invitation.interface"), exports);
 __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("./organization-membership.interface"), exports);
+__exportStar(require("./reset-password-options.interface"), exports);
+__exportStar(require("./revoke-session-options.interface"), exports);
+__exportStar(require("./role.interface"), exports);
+__exportStar(require("./send-invitation-options.interface"), exports);
 __exportStar(require("./send-magic-auth-code-options.interface"), exports);
-__exportStar(require("./send-verification-email-options"), exports);
+__exportStar(require("./send-password-reset-email-options.interface"), exports);
+__exportStar(require("./send-verification-email-options.interface"), exports);
+__exportStar(require("./session.interface"), exports);
+__exportStar(require("./update-organization-membership-options.interface"), 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/send-invitation-options.interface.d.ts

@@ -3,10 +3,12 @@ export interface SendInvitationOptions {
     organizationId?: string;
     expiresInDays?: number;
     inviterUserId?: string;
+    roleSlug?: string;
 }
 export interface SerializedSendInvitationOptions {
     email: string;
     organization_id?: string;
     expires_in_days?: number;
     inviter_user_id?: string;
+    role_slug?: string;
 }

package/lib/user-management/interfaces/send-verification-email-options.interface.js

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

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

@@ -4,6 +4,8 @@ exports.serializeCreateUserOptions = void 0;
 const serializeCreateUserOptions = (options) => ({
     email: options.email,
     password: options.password,
+    password_hash: options.passwordHash,
+    password_hash_type: options.passwordHashType,
     first_name: options.firstName,
     last_name: options.lastName,
     email_verified: options.emailVerified,

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

@@ -6,5 +6,6 @@ const serializeSendInvitationOptions = (options) => ({
     organization_id: options.organizationId,
     expires_in_days: options.expiresInDays,
     inviter_user_id: options.inviterUserId,
+    role_slug: options.roleSlug,
 });
 exports.serializeSendInvitationOptions = serializeSendInvitationOptions;

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.8.0';
+const VERSION = '7.0.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -59,7 +59,12 @@ class WorkOS {
         if (port) {
             this.baseURL = this.baseURL + `:${port}`;
         }
-        this.client = new fetch_client_1.FetchClient(this.baseURL, Object.assign(Object.assign({}, options.config), { headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': `workos-node/${VERSION}` }) }));
+        let userAgent = `workos-node/${VERSION}`;
+        if (options.appInfo) {
+            const { name, version } = options.appInfo;
+            userAgent += ` ${name}: ${version}`;
+        }
+        this.client = new fetch_client_1.FetchClient(this.baseURL, Object.assign(Object.assign({}, options.config), { headers: Object.assign(Object.assign({}, (_a = options.config) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': userAgent }) }));
     }
     get version() {
         return VERSION;

package/lib/workos.spec.js

@@ -82,6 +82,22 @@ describe('WorkOS', () => {
                 });
             }));
         });
+        describe('when the `appInfo` option is provided', () => {
+            it('applies the configuration to the fetch client user-agent', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)('{}');
+                const packageJson = JSON.parse(yield promises_1.default.readFile('package.json', 'utf8'));
+                const workos = new workos_1.WorkOS('sk_test', {
+                    appInfo: {
+                        name: 'fooApp',
+                        version: '1.0.0',
+                    },
+                });
+                yield workos.post('/somewhere', {});
+                expect((0, test_utils_1.fetchHeaders)()).toMatchObject({
+                    'User-Agent': `workos-node/${packageJson.version} fooApp: 1.0.0`,
+                });
+            }));
+        });
     });
     describe('version', () => {
         it('matches the version in `package.json`', () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "6.8.0",
+  "version": "7.0.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -12,6 +12,10 @@
     "node": "14.21.3",
     "yarn": "1.22.19"
   },
+  "engines": {
+    "node": ">=19"
+  },
+  "engineStrict": true,
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -45,7 +49,7 @@
     "jest-fetch-mock": "^3.0.3",
     "prettier": "2.8.8",
     "supertest": "6.3.3",
-    "ts-jest": "29.1.1",
+    "ts-jest": "29.1.2",
     "tslint": "6.1.3",
     "typescript": "5.1.6"
   }