@workos-inc/node 7.38.0 → 7.40.0

package/lib/actions/actions.spec.js

@@ -103,6 +103,7 @@ describe('Actions', () => {
                     profilePictureUrl: 'https://example.com/jane.jpg',
                     createdAt: '2024-10-22T17:12:50.746Z',
                     updatedAt: '2024-10-22T17:12:50.746Z',
+                    externalId: null,
                 },
                 ipAddress: '50.141.123.10',
                 userAgent: 'Mozilla/5.0',

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

@@ -9,7 +9,9 @@
             "last_name": "User",
             "created_at": "2023-07-18T02:07:19.911Z",
             "updated_at": "2023-07-18T02:07:19.911Z",
-            "email_verified_at": "2023-07-17T20:07:20.055Z"
+            "email_verified": true,
+            "profile_picture_url": "https://example.com/profile_picture.jpg",
+            "last_sign_in_at": "2023-07-18T02:07:19.911Z"
         }
     ],
     "list_metadata": {

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

@@ -7,5 +7,6 @@
     "created_at": "2023-07-18T02:07:19.911Z",
     "updated_at": "2023-07-18T02:07:19.911Z",
     "email_verified": true,
-    "profile_picture_url": "https://example.com/profile_picture.jpg"
+    "profile_picture_url": "https://example.com/profile_picture.jpg",
+    "last_sign_in_at": "2023-07-18T02:07:19.911Z"
 }

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

@@ -7,6 +7,7 @@ export interface CreateUserOptions {
     firstName?: string;
     lastName?: string;
     emailVerified?: boolean;
+    externalId?: string;
 }
 export interface SerializedCreateUserOptions {
     email: string;
@@ -16,4 +17,5 @@ export interface SerializedCreateUserOptions {
     first_name?: string;
     last_name?: string;
     email_verified?: boolean;
+    external_id?: string;
 }

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

@@ -7,6 +7,7 @@ export interface UpdateUserOptions {
     password?: string;
     passwordHash?: string;
     passwordHashType?: PasswordHashType;
+    externalId?: string;
 }
 export interface SerializedUpdateUserOptions {
     first_name?: string;
@@ -15,4 +16,5 @@ export interface SerializedUpdateUserOptions {
     password?: string;
     password_hash?: string;
     password_hash_type?: PasswordHashType;
+    external_id?: string;
 }

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

@@ -6,8 +6,10 @@ export interface User {
     profilePictureUrl: string | null;
     firstName: string | null;
     lastName: string | null;
+    lastSignInAt: string | null;
     createdAt: string;
     updatedAt: string;
+    externalId: string | null;
 }
 export interface UserResponse {
     object: 'user';
@@ -17,6 +19,8 @@ export interface UserResponse {
     profile_picture_url: string | null;
     first_name: string | null;
     last_name: string | null;
+    last_sign_in_at: string | null;
     created_at: string;
     updated_at: string;
+    external_id?: string;
 }

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

@@ -9,5 +9,6 @@ const serializeCreateUserOptions = (options) => ({
     first_name: options.firstName,
     last_name: options.lastName,
     email_verified: options.emailVerified,
+    external_id: options.externalId,
 });
 exports.serializeCreateUserOptions = serializeCreateUserOptions;

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

@@ -8,5 +8,6 @@ const serializeUpdateUserOptions = (options) => ({
     password: options.password,
     password_hash: options.passwordHash,
     password_hash_type: options.passwordHashType,
+    external_id: options.externalId,
 });
 exports.serializeUpdateUserOptions = serializeUpdateUserOptions;

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

@@ -1,15 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeUser = void 0;
-const deserializeUser = (user) => ({
-    object: user.object,
-    id: user.id,
-    email: user.email,
-    emailVerified: user.email_verified,
-    firstName: user.first_name,
-    profilePictureUrl: user.profile_picture_url,
-    lastName: user.last_name,
-    createdAt: user.created_at,
-    updatedAt: user.updated_at,
-});
+const deserializeUser = (user) => {
+    var _a;
+    return ({
+        object: user.object,
+        id: user.id,
+        email: user.email,
+        emailVerified: user.email_verified,
+        firstName: user.first_name,
+        profilePictureUrl: user.profile_picture_url,
+        lastName: user.last_name,
+        lastSignInAt: user.last_sign_in_at,
+        createdAt: user.created_at,
+        updatedAt: user.updated_at,
+        externalId: (_a = user.external_id) !== null && _a !== void 0 ? _a : null,
+    });
+};
 exports.deserializeUser = deserializeUser;

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

@@ -39,6 +39,7 @@ export declare class UserManagement {
         cookiePassword: string;
     }): Session;
     getUser(userId: string): Promise<User>;
+    getUserByExternalId(externalId: string): Promise<User>;
     listUsers(options?: ListUsersOptions): Promise<AutoPaginatable<User>>;
     createUser(payload: CreateUserOptions): Promise<User>;
     authenticateWithMagicAuth(payload: AuthenticateWithMagicAuthOptions): Promise<AuthenticationResponse>;

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

@@ -84,6 +84,12 @@ class UserManagement {
             return (0, serializers_2.deserializeUser)(data);
         });
     }
+    getUserByExternalId(externalId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/user_management/users/external_id/${externalId}`);
+            return (0, serializers_2.deserializeUser)(data);
+        });
+    }
     listUsers(options) {
         return __awaiter(this, void 0, void 0, function* () {
             return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/users', serializers_2.deserializeUser, options ? (0, list_users_options_serializer_1.serializeListUsersOptions)(options) : undefined), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/user_management/users', serializers_2.deserializeUser, params), options ? (0, list_users_options_serializer_1.serializeListUsersOptions)(options) : undefined);

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

@@ -81,6 +81,26 @@ describe('UserManagement', () => {
                 firstName: 'Test 01',
                 lastName: 'User',
                 emailVerified: true,
+                lastSignInAt: '2023-07-18T02:07:19.911Z',
+            });
+        }));
+    });
+    describe('getUserByExternalId', () => {
+        it('sends a Get User request', () => __awaiter(void 0, void 0, void 0, function* () {
+            const externalId = 'user_external_id';
+            (0, test_utils_1.fetchOnce)(Object.assign(Object.assign({}, user_json_1.default), { external_id: externalId }));
+            const user = yield workos.userManagement.getUserByExternalId(externalId);
+            expect((0, test_utils_1.fetchURL)()).toContain(`/user_management/users/external_id/${externalId}`);
+            expect(user).toMatchObject({
+                object: 'user',
+                id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                email: 'test01@example.com',
+                profilePictureUrl: 'https://example.com/profile_picture.jpg',
+                firstName: 'Test 01',
+                lastName: 'User',
+                emailVerified: true,
+                lastSignInAt: '2023-07-18T02:07:19.911Z',
+                externalId,
             });
         }));
     });

package/lib/workos.js

@@ -29,7 +29,7 @@ const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider
 const fetch_client_1 = require("./common/net/fetch-client");
 const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
-const VERSION = '7.38.0';
+const VERSION = '7.40.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.38.0",
+  "version": "7.40.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -72,4 +72,5 @@
       "default": "./lib/index.js"
     }
   }
-}
+}
+