@workos-inc/node 2.20.0 → 3.0.0-alpha.2

package/lib/users/users.spec.js

@@ -0,0 +1,318 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const axios_mock_adapter_1 = __importDefault(require("axios-mock-adapter"));
+const workos_1 = require("../workos");
+const user_json_1 = __importDefault(require("./fixtures/user.json"));
+const list_users_json_1 = __importDefault(require("./fixtures/list-users.json"));
+const session_json_1 = __importDefault(require("./fixtures/session.json"));
+const mock = new axios_mock_adapter_1.default(axios_1.default);
+const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+const userId = 'user_01H5JQDV7R7ATEYZDEG0W5PRYS';
+describe('UserManagement', () => {
+    afterEach(() => mock.resetHistory());
+    describe('getUser', () => {
+        it('sends a Get User request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet(`/users/${userId}`).reply(200, user_json_1.default);
+            const user = yield workos.users.getUser(userId);
+            expect(mock.history.get[0].url).toEqual(`/users/${userId}`);
+            expect(user).toMatchObject({
+                object: 'user',
+                id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'test01@example.com',
+                firstName: 'Test 01',
+                lastName: 'User',
+                organizationMemberships: [],
+                userType: 'unmanaged',
+                emailVerifiedAt: '2023-07-17T20:07:20.055Z',
+            });
+        }));
+    });
+    describe('listUsers', () => {
+        it('lists users', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet('/users').reply(200, list_users_json_1.default);
+            const userList = yield workos.users.listUsers();
+            expect(mock.history.get[0].url).toEqual('/users');
+            expect(userList).toMatchObject({
+                object: 'list',
+                data: [
+                    {
+                        object: 'user',
+                        email: 'test01@example.com',
+                    },
+                ],
+                listMetadata: {
+                    before: null,
+                    after: null,
+                },
+            });
+        }));
+        it('sends the correct params when filtering', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onGet('/users').reply(200, list_users_json_1.default);
+            yield workos.users.listUsers({
+                email: 'foo@example.com',
+                organization: 'org_someorg',
+                type: 'managed',
+                after: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                limit: 10,
+            });
+            expect(mock.history.get[0].params).toEqual({
+                email: 'foo@example.com',
+                organization: 'org_someorg',
+                type: 'managed',
+                after: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                limit: 10,
+            });
+        }));
+    });
+    describe('createUser', () => {
+        it('sends a Create User request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost('/users').reply(200, user_json_1.default);
+            const user = yield workos.users.createUser({
+                email: 'test01@example.com',
+                password: 'extra-secure',
+                firstName: 'Test 01',
+                lastName: 'User',
+                emailVerified: true,
+            });
+            expect(mock.history.post[0].url).toEqual('/users');
+            expect(user).toMatchObject({
+                object: 'user',
+                email: 'test01@example.com',
+                firstName: 'Test 01',
+                lastName: 'User',
+                organizationMemberships: [],
+                userType: 'unmanaged',
+                emailVerifiedAt: '2023-07-17T20:07:20.055Z',
+                createdAt: '2023-07-18T02:07:19.911Z',
+                updatedAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
+    describe('authenticateUserWithPassword', () => {
+        it('sends an password 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.authenticateUserWithPassword({
+                clientId: 'proj_whatever',
+                email: 'test01@example.com',
+                password: 'extra-secure',
+            });
+            expect(mock.history.post[0].url).toEqual('/users/sessions/token');
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+                session: {
+                    id: 'session_01H5K05VP5CPCXJA5Z7G191GS4',
+                    token: 'really-long-token',
+                },
+            });
+        }));
+    });
+    describe('authenticateUserWithToken', () => {
+        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({
+                clientId: 'proj_whatever',
+                code: 'or this',
+                expiresIn: 15,
+            });
+            expect(mock.history.post[0].url).toEqual('/users/sessions/token');
+            expect(JSON.parse(mock.history.post[0].data)).toMatchObject({
+                client_secret: 'sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU',
+                grant_type: 'authorization_code',
+            });
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+                session: {
+                    id: 'session_01H5K05VP5CPCXJA5Z7G191GS4',
+                    token: 'really-long-token',
+                },
+            });
+        }));
+    });
+    describe('verifySession', () => {
+        it('sends a request to verify the session', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost('/users/sessions/verify').reply(200, {
+                user: user_json_1.default,
+                session: session_json_1.default,
+            });
+            const resp = yield workos.users.verifySession({
+                clientId: 'proj_something',
+                token: 'really-long-token',
+            });
+            expect(mock.history.post[0].url).toEqual('/users/sessions/verify');
+            expect(resp).toMatchObject({
+                user: {
+                    email: 'test01@example.com',
+                },
+                session: {
+                    id: 'session_01H5K05VP5CPCXJA5Z7G191GS4',
+                    token: 'really-long-token',
+                },
+            });
+        }));
+    });
+    describe('revokeSession', () => {
+        it('can revoke with the session_id', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost('/users/sessions/revocations').reply(200, true);
+            const revoked = yield workos.users.revokeSession({
+                sessionId: 'session_01H5K05VP5CPCXJA5Z7G191GS4',
+            });
+            expect(mock.history.post[0].url).toEqual('/users/sessions/revocations');
+            expect(revoked).toEqual(true);
+        }));
+        it('can revoke with the session_token', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost('/users/sessions/revocations').reply(200, true);
+            const revoked = yield workos.users.revokeSession({
+                sessionToken: 'really-long-token',
+            });
+            expect(mock.history.post[0].url).toEqual('/users/sessions/revocations');
+            expect(revoked).toEqual(true);
+        }));
+    });
+    describe('revokeAllSessionsForUser', () => {
+        it('sends a revokeAllSessionsForUser request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onDelete(`/users/${userId}/sessions`).reply(200, true);
+            const revoked = yield workos.users.revokeAllSessionsForUser(userId);
+            expect(mock.history.delete[0].url).toEqual(`/users/${userId}/sessions`);
+            expect(revoked).toEqual(true);
+        }));
+    });
+    describe('createEmailVerificationChallenge', () => {
+        it('sends a Create Email Verification Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost(`/users/${userId}/email_verification_challenge`).reply(200, {
+                token: 'email-verification-challenge',
+                user: user_json_1.default,
+            });
+            const resp = yield workos.users.createEmailVerificationChallenge({
+                userId,
+                verificationUrl: 'https://example.com/verify-email',
+            });
+            expect(mock.history.post[0].url).toEqual(`/users/${userId}/email_verification_challenge`);
+            expect(resp).toMatchObject({
+                token: 'email-verification-challenge',
+                user: {
+                    email: 'test01@example.com',
+                },
+            });
+        }));
+        describe('completeEmailVerification', () => {
+            it('sends a Complete Email Verification request', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock.onPost(`/users/email_verification`).reply(200, user_json_1.default);
+                const resp = yield workos.users.completeEmailVerification('email-verification-token');
+                expect(mock.history.post[0].url).toEqual(`/users/email_verification`);
+                expect(resp).toMatchObject({
+                    email: 'test01@example.com',
+                });
+            }));
+        });
+    });
+    describe('createPasswordResetChallenge', () => {
+        it('sends a Create Password Reset Challenge request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost(`/users/password_reset_challenge`).reply(200, {
+                token: 'password-reset-token',
+                user: user_json_1.default,
+            });
+            const resp = yield workos.users.createPasswordResetChallenge({
+                email: 'test01@example.com',
+                passwordResetUrl: 'https://example.com/forgot-password',
+            });
+            expect(mock.history.post[0].url).toEqual(`/users/password_reset_challenge`);
+            expect(resp).toMatchObject({
+                token: 'password-reset-token',
+                user: {
+                    email: 'test01@example.com',
+                },
+            });
+        }));
+    });
+    describe('completePasswordReset', () => {
+        it('sends a completePasswordReset request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost(`/users/password_reset`).reply(200, user_json_1.default);
+            const resp = yield workos.users.completePasswordReset({
+                token: '',
+                newPassword: 'correct horse battery staple',
+            });
+            expect(mock.history.post[0].url).toEqual(`/users/password_reset`);
+            expect(resp).toMatchObject({
+                email: 'test01@example.com',
+            });
+        }));
+    });
+    describe('addUserToOrganization', () => {
+        it('sends a addUserToOrganization request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPost(`/users/${userId}/organizations`).reply(200, user_json_1.default);
+            const resp = yield workos.users.addUserToOrganization({
+                userId,
+                organizationId: 'org_coolorg',
+            });
+            expect(mock.history.post[0].url).toEqual(`/users/${userId}/organizations`);
+            expect(resp).toMatchObject({
+                email: 'test01@example.com',
+            });
+        }));
+    });
+    describe('removeUserFromOrganization', () => {
+        it('sends a removeUserFromOrganization request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const orgId = 'org_coolorg';
+            mock
+                .onDelete(`/users/${userId}/organizations/${orgId}`)
+                .reply(200, user_json_1.default);
+            const resp = yield workos.users.removeUserFromOrganization({
+                userId,
+                organizationId: orgId,
+            });
+            expect(mock.history.delete[0].url).toEqual(`/users/${userId}/organizations/${orgId}`);
+            expect(resp).toMatchObject({
+                email: 'test01@example.com',
+            });
+        }));
+    });
+    describe('updateUser', () => {
+        it('sends a updateUser request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPut(`/users/${userId}`).reply(200, user_json_1.default);
+            const resp = yield workos.users.updateUser({
+                userId,
+                firstName: 'Dane',
+                lastName: 'Williams',
+            });
+            expect(mock.history.put[0].url).toEqual(`/users/${userId}`);
+            expect(resp).toMatchObject({
+                email: 'test01@example.com',
+            });
+        }));
+    });
+    describe('updateUserPassword', () => {
+        it('sends a updateUserPassword request', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock.onPut(`/users/${userId}/password`).reply(200, user_json_1.default);
+            const resp = yield workos.users.updateUserPassword({
+                userId,
+                password: 'secure',
+            });
+            expect(mock.history.put[0].url).toEqual(`/users/${userId}/password`);
+            expect(resp).toMatchObject({
+                email: 'test01@example.com',
+            });
+        }));
+    });
+});

package/lib/webhooks/fixtures/webhook.json

@@ -1 +1 @@
-{ "id": "wh_123", "data": { "id": "directory_user_01FAEAJCR3ZBZ30D8BD1924TVG", "state": "active", "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "idp_id": "00u1e8mutl6wlH3lL4x7", "object": "directory_user", "username": "blair@foo-corp.com", "last_name": "Lunchford", "first_name": "Blair", "job_title": "Software Engineer", "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7", "raw_attributes": { "name": { "givenName": "Blair", "familyName": "Lunchford", "middleName": "Elizabeth", "honorificPrefix": "Ms." }, "title": "Software Engineer", "active": true, "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "groups": [], "locale": "en-US", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"], "userName": "blair@foo-corp.com", "addresses": [{ "region": "CA", "primary": true, "locality": "San Francisco", "postalCode": "94016" }], "externalId": "00u1e8mutl6wlH3lL4x7", "displayName": "Blair Lunchford", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "manager": { "value": "2", "displayName": "Kate Chapman" }, "division": "Engineering", "department": "Customer Success" } } }, "event": "dsync.user.created" }
+{ "id": "wh_123", "data": { "id": "directory_user_01FAEAJCR3ZBZ30D8BD1924TVG", "state": "active", "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "idp_id": "00u1e8mutl6wlH3lL4x7", "object": "directory_user", "username": "blair@foo-corp.com", "last_name": "Lunchford", "first_name": "Blair", "job_title": "Software Engineer", "directory_id": "directory_01F9M7F68PZP8QXP8G7X5QRHS7", "raw_attributes": { "name": { "givenName": "Blair", "familyName": "Lunchford", "middleName": "Elizabeth", "honorificPrefix": "Ms." }, "title": "Software Engineer", "active": true, "emails": [{ "type": "work", "value": "blair@foo-corp.com", "primary": true }], "groups": [], "locale": "en-US", "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"], "userName": "blair@foo-corp.com", "addresses": [{ "region": "CA", "primary": true, "locality": "San Francisco", "postalCode": "94016" }], "externalId": "00u1e8mutl6wlH3lL4x7", "displayName": "Blair Lunchford", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": { "manager": { "value": "2", "displayName": "Kate Chapman" }, "division": "Engineering", "department": "Customer Success" } } }, "event": "dsync.user.created", "created_at": "2021-06-25T19:07:33.155Z" }

package/lib/webhooks/interfaces/webhook-directory-user.interface.d.ts

@@ -1,5 +1,5 @@
-import { User } from '../../directory-sync/interfaces';
-export interface WebhookDirectoryUser extends User {
+import { DirectoryUser } from '../../directory-sync/interfaces';
+export interface WebhookDirectoryUser extends DirectoryUser {
     created_at: string;
     updated_at: string;
 }

package/lib/webhooks/interfaces/webhook.interface.d.ts

@@ -4,6 +4,7 @@ import { WebhookDirectoryUser as User } from './webhook-directory-user.interface
 import { WebhookDirectory as Directory } from './webhook-directory.interface';
 interface WebhookBase {
     id: string;
+    created_at: string;
 }
 export interface ConnectionActivatedWebhook extends WebhookBase {
     event: 'connection.activated';

package/lib/workos.d.ts

@@ -10,6 +10,7 @@ import { SSO } from './sso/sso';
 import { Webhooks } from './webhooks/webhooks';
 import { Mfa } from './mfa/mfa';
 import { AuditLogs } from './audit-logs/audit-logs';
+import { Users } from './users/users';
 export declare class WorkOS {
     readonly key?: string | undefined;
     readonly options: WorkOSOptions;
@@ -25,11 +26,12 @@ export declare class WorkOS {
     readonly webhooks: Webhooks;
     readonly mfa: Mfa;
     readonly events: Events;
+    readonly users: Users;
     constructor(key?: string | undefined, options?: WorkOSOptions);
-    post(path: string, entity: any, options?: PostOptions): Promise<AxiosResponse>;
-    get(path: string, options?: GetOptions): Promise<AxiosResponse>;
-    put(path: string, entity: any, options?: PutOptions): Promise<AxiosResponse>;
-    delete(path: string, query?: any): Promise<AxiosResponse>;
+    post<T = any, D = any, P = any>(path: string, entity: P, options?: PostOptions): Promise<AxiosResponse<T, D>>;
+    get<T = any, D = any>(path: string, options?: GetOptions): Promise<AxiosResponse<T, D>>;
+    put<T = any, D = any>(path: string, entity: any, options?: PutOptions): Promise<AxiosResponse<T, D>>;
+    delete<T = any, D = any>(path: string, query?: any): Promise<AxiosResponse<T, D>>;
     emitWarning(warning: string): void;
     private handleAxiosError;
 }

package/lib/workos.js

@@ -25,8 +25,9 @@ const sso_1 = require("./sso/sso");
 const webhooks_1 = require("./webhooks/webhooks");
 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 = '2.20.0';
+const VERSION = '3.0.0-alpha.2';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -43,6 +44,7 @@ class WorkOS {
         this.webhooks = new webhooks_1.Webhooks();
         this.mfa = new mfa_1.Mfa(this);
         this.events = new events_1.Events(this);
+        this.users = new users_1.Users(this);
         if (!key) {
             this.key = process.env.WORKOS_API_KEY;
             if (!this.key) {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.20.0",
+  "version": "3.0.0-alpha.2",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -9,7 +9,7 @@
     "workos"
   ],
   "volta": {
-    "node": "14.21.2",
+    "node": "14.21.3",
     "yarn": "1.22.19"
   },
   "main": "lib/index.js",
@@ -34,20 +34,19 @@
     "prepublishOnly": "yarn run build"
   },
   "dependencies": {
-    "axios": "0.21.4",
-    "pluralize": "8.0.0",
-    "query-string": "7.1.3"
+    "axios": "1.4.0",
+    "pluralize": "8.0.0"
   },
   "devDependencies": {
-    "@types/jest": "27.5.2",
-    "@types/node": "14.18.36",
-    "@types/pluralize": "0.0.29",
-    "axios-mock-adapter": "1.21.2",
-    "jest": "27.5.1",
-    "prettier": "2.8.3",
-    "supertest": "6.2.3",
-    "ts-jest": "27.1.5",
+    "@types/jest": "29.5.3",
+    "@types/node": "14.18.54",
+    "@types/pluralize": "0.0.30",
+    "axios-mock-adapter": "1.21.5",
+    "jest": "29.6.2",
+    "prettier": "2.8.8",
+    "supertest": "6.3.3",
+    "ts-jest": "29.1.1",
     "tslint": "6.1.3",
-    "typescript": "4.9.5"
+    "typescript": "5.1.6"
   }
 }

package/lib/directory-sync/interfaces/group.interface.d.ts

@@ -1,10 +0,0 @@
-export interface Group {
-    id: string;
-    idp_id: string;
-    directory_id: string;
-    organization_id: string | null;
-    name: string;
-    created_at: string;
-    updated_at: string;
-    raw_attributes: any;
-}

package/lib/directory-sync/interfaces/user.interface.d.ts

@@ -1,23 +0,0 @@
-import { Group } from './group.interface';
-export type DefaultCustomAttributes = Record<string, unknown>;
-export interface User<TCustomAttributes extends object = DefaultCustomAttributes, TRawAttributes = any> {
-    id: string;
-    directory_id: string;
-    organization_id: string | null;
-    raw_attributes: TRawAttributes;
-    custom_attributes: TCustomAttributes;
-    idp_id: string;
-    first_name: string;
-    emails: {
-        type: string;
-        value: string;
-        primary: boolean;
-    }[];
-    username: string;
-    last_name: string;
-    job_title: string | null;
-    state: 'active' | 'inactive' | 'suspended';
-}
-export interface UserWithGroups<TCustomAttributes extends object = DefaultCustomAttributes> extends User<TCustomAttributes> {
-    groups: Group[];
-}