@workos-inc/node 7.42.0 → 7.43.0

package/lib/actions/actions.spec.js

@@ -104,6 +104,7 @@ describe('Actions', () => {
                     createdAt: '2024-10-22T17:12:50.746Z',
                     updatedAt: '2024-10-22T17:12:50.746Z',
                     externalId: null,
+                    metadata: {},
                 },
                 ipAddress: '50.141.123.10',
                 userAgent: 'Mozilla/5.0',
@@ -119,6 +120,7 @@ describe('Actions', () => {
                     createdAt: '2024-10-22T17:12:50.746Z',
                     updatedAt: '2024-10-22T17:12:50.746Z',
                     externalId: null,
+                    metadata: {},
                 },
                 organizationMembership: {
                     object: 'organization_membership',

package/lib/organizations/fixtures/get-organization.json

@@ -12,5 +12,6 @@
             "verification_strategy": "dns",
             "verification_token": "xB8SeACdKJQP9DP4CahU4YuQZ"
         }
-    ]
+    ],
+    "metadata": {}
 }

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

@@ -4,6 +4,7 @@ export interface CreateOrganizationOptions {
     name: string;
     domainData?: DomainData[];
     externalId?: string | null;
+    metadata?: Record<string, string>;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */
@@ -17,6 +18,7 @@ export interface SerializedCreateOrganizationOptions {
     name: string;
     domain_data?: DomainData[];
     external_id?: string | null;
+    metadata?: Record<string, string>;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */

package/lib/organizations/interfaces/organization.interface.d.ts

@@ -9,6 +9,7 @@ export interface Organization {
     createdAt: string;
     updatedAt: string;
     externalId: string | null;
+    metadata: Record<string, string>;
 }
 export interface OrganizationResponse {
     object: 'organization';
@@ -20,4 +21,5 @@ export interface OrganizationResponse {
     created_at: string;
     updated_at: string;
     external_id?: string | null;
+    metadata?: Record<string, string>;
 }

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

@@ -5,6 +5,7 @@ export interface UpdateOrganizationOptions {
     domainData?: DomainData[];
     stripeCustomerId?: string | null;
     externalId?: string | null;
+    metadata?: Record<string, string>;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */
@@ -19,6 +20,7 @@ export interface SerializedUpdateOrganizationOptions {
     domain_data?: DomainData[];
     stripe_customer_id?: string | null;
     external_id?: string | null;
+    metadata?: Record<string, string>;
     /**
      * @deprecated If you need to allow sign-ins from any email domain, contact support@workos.com.
      */

package/lib/organizations/organizations.spec.js

@@ -155,6 +155,16 @@ describe('Organizations', () => {
                     expect(subject.domains).toHaveLength(1);
                 }));
             });
+            it('adds metadata to the request', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)(create_organization_json_1.default, { status: 201 });
+                yield workos.organizations.createOrganization({
+                    name: 'My organization',
+                    metadata: { key: 'value' },
+                });
+                expect((0, test_utils_1.fetchBody)()).toMatchObject({
+                    metadata: { key: 'value' },
+                });
+            }));
         });
         describe('with an invalid payload', () => {
             it('returns an error', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -251,6 +261,16 @@ describe('Organizations', () => {
                     expect(subject.domains).toHaveLength(1);
                 }));
             });
+            it('adds metadata to the request', () => __awaiter(void 0, void 0, void 0, function* () {
+                (0, test_utils_1.fetchOnce)(update_organization_json_1.default, { status: 201 });
+                yield workos.organizations.updateOrganization({
+                    organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+                    metadata: { key: 'value' },
+                });
+                expect((0, test_utils_1.fetchBody)()).toEqual({
+                    metadata: { key: 'value' },
+                });
+            }));
         });
         describe('when given `stripeCustomerId`', () => {
             it('updates the organization’s Stripe customer ID', () => __awaiter(void 0, void 0, void 0, function* () {

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

@@ -7,5 +7,6 @@ const serializeCreateOrganizationOptions = (options) => ({
     domain_data: options.domainData,
     domains: options.domains,
     external_id: options.externalId,
+    metadata: options.metadata,
 });
 exports.serializeCreateOrganizationOptions = serializeCreateOrganizationOptions;

package/lib/organizations/serializers/organization.serializer.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeOrganization = void 0;
 const organization_domain_serializer_1 = require("../../organization-domains/serializers/organization-domain.serializer");
 const deserializeOrganization = (organization) => {
-    var _a;
+    var _a, _b;
     return (Object.assign(Object.assign({ object: organization.object, id: organization.id, name: organization.name, allowProfilesOutsideOrganization: organization.allow_profiles_outside_organization, domains: organization.domains.map(organization_domain_serializer_1.deserializeOrganizationDomain) }, (typeof organization.stripe_customer_id === 'undefined'
         ? undefined
-        : { stripeCustomerId: organization.stripe_customer_id })), { createdAt: organization.created_at, updatedAt: organization.updated_at, externalId: (_a = organization.external_id) !== null && _a !== void 0 ? _a : null }));
+        : { stripeCustomerId: organization.stripe_customer_id })), { createdAt: organization.created_at, updatedAt: organization.updated_at, externalId: (_a = organization.external_id) !== null && _a !== void 0 ? _a : null, metadata: (_b = organization.metadata) !== null && _b !== void 0 ? _b : {} }));
 };
 exports.deserializeOrganization = deserializeOrganization;

package/lib/organizations/serializers/organization.serializer.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/organizations/serializers/organization.serializer.spec.js

@@ -0,0 +1,33 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const organization_serializer_1 = require("./organization.serializer");
+const get_organization_json_1 = __importDefault(require("../fixtures/get-organization.json"));
+const organizationResponse = Object.assign(Object.assign({}, get_organization_json_1.default), { object: 'organization', created_at: new Date().toISOString(), updated_at: new Date().toISOString(), domains: [] });
+describe('deserializeOrganization', () => {
+    it('includes metadata if present', () => {
+        const metadata = { key: 'value' };
+        expect((0, organization_serializer_1.deserializeOrganization)(Object.assign(Object.assign({}, organizationResponse), { metadata }))).toMatchObject({
+            metadata,
+        });
+    });
+    it('coerces missing metadata to empty object', () => {
+        const { metadata } = organizationResponse, organizationResponseWithoutMetadata = __rest(organizationResponse, ["metadata"]);
+        expect((0, organization_serializer_1.deserializeOrganization)(organizationResponseWithoutMetadata)).toMatchObject({
+            metadata: {},
+        });
+    });
+});

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

@@ -8,5 +8,6 @@ const serializeUpdateOrganizationOptions = (options) => ({
     domains: options.domains,
     stripe_customer_id: options.stripeCustomerId,
     external_id: options.externalId,
+    metadata: options.metadata,
 });
 exports.serializeUpdateOrganizationOptions = serializeUpdateOrganizationOptions;

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

@@ -8,5 +8,6 @@
     "updated_at": "2023-07-18T02:07:19.911Z",
     "email_verified": true,
     "profile_picture_url": "https://example.com/profile_picture.jpg",
-    "last_sign_in_at": "2023-07-18T02:07:19.911Z"
+    "last_sign_in_at": "2023-07-18T02:07:19.911Z",
+    "metadata": { "key": "value" }
 }

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

@@ -8,6 +8,7 @@ export interface CreateUserOptions {
     lastName?: string;
     emailVerified?: boolean;
     externalId?: string;
+    metadata?: Record<string, string>;
 }
 export interface SerializedCreateUserOptions {
     email: string;
@@ -18,4 +19,5 @@ export interface SerializedCreateUserOptions {
     last_name?: string;
     email_verified?: boolean;
     external_id?: string;
+    metadata?: Record<string, string>;
 }

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

@@ -8,6 +8,7 @@ export interface UpdateUserOptions {
     passwordHash?: string;
     passwordHashType?: PasswordHashType;
     externalId?: string;
+    metadata?: Record<string, string>;
 }
 export interface SerializedUpdateUserOptions {
     first_name?: string;
@@ -17,4 +18,5 @@ export interface SerializedUpdateUserOptions {
     password_hash?: string;
     password_hash_type?: PasswordHashType;
     external_id?: string;
+    metadata?: Record<string, string>;
 }

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

@@ -10,6 +10,7 @@ export interface User {
     createdAt: string;
     updatedAt: string;
     externalId: string | null;
+    metadata: Record<string, string>;
 }
 export interface UserResponse {
     object: 'user';
@@ -23,4 +24,5 @@ export interface UserResponse {
     created_at: string;
     updated_at: string;
     external_id?: string;
+    metadata?: Record<string, string>;
 }

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

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

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

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

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

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeUser = void 0;
 const deserializeUser = (user) => {
-    var _a;
+    var _a, _b;
     return ({
         object: user.object,
         id: user.id,
@@ -15,6 +15,7 @@ const deserializeUser = (user) => {
         createdAt: user.created_at,
         updatedAt: user.updated_at,
         externalId: (_a = user.external_id) !== null && _a !== void 0 ? _a : null,
+        metadata: (_b = user.metadata) !== null && _b !== void 0 ? _b : {},
     });
 };
 exports.deserializeUser = deserializeUser;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,32 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const user_serializer_1 = require("./user.serializer");
+const user_json_1 = __importDefault(require("../fixtures/user.json"));
+describe('deserializeUser', () => {
+    it('includes metadata if present', () => {
+        const metadata = { key: 'value' };
+        expect((0, user_serializer_1.deserializeUser)(Object.assign(Object.assign({}, user_json_1.default), { object: 'user', metadata }))).toMatchObject({
+            metadata,
+        });
+    });
+    it('coerces missing metadata to empty object', () => {
+        const { metadata } = user_json_1.default, userResponseWithoutMetadata = __rest(user_json_1.default, ["metadata"]);
+        expect((0, user_serializer_1.deserializeUser)(Object.assign(Object.assign({}, userResponseWithoutMetadata), { object: 'user' }))).toMatchObject({
+            metadata: {},
+        });
+    });
+});

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

@@ -162,6 +162,16 @@ describe('UserManagement', () => {
                 updatedAt: '2023-07-18T02:07:19.911Z',
             });
         }));
+        it('adds metadata to the request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(user_json_1.default);
+            yield workos.userManagement.createUser({
+                email: 'test01@example.com',
+                metadata: { key: 'value' },
+            });
+            expect((0, test_utils_1.fetchBody)()).toMatchObject({
+                metadata: { key: 'value' },
+            });
+        }));
     });
     describe('authenticateUserWithMagicAuth', () => {
         it('sends a magic auth authentication request', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -1092,6 +1102,16 @@ describe('UserManagement', () => {
                 });
             }));
         });
+        it('adds metadata to the request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(user_json_1.default);
+            yield workos.userManagement.updateUser({
+                userId,
+                metadata: { key: 'value' },
+            });
+            expect((0, test_utils_1.fetchBody)()).toMatchObject({
+                metadata: { key: 'value' },
+            });
+        }));
     });
     describe('enrollAuthFactor', () => {
         it('sends an enrollAuthFactor request', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/workos.js

@@ -31,7 +31,7 @@ const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
-const VERSION = '7.42.0';
+const VERSION = '7.43.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.42.0",
+  "version": "7.43.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",