@workos-inc/node 2.11.0 → 2.12.0

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

@@ -1,5 +1,7 @@
+import { AxiosRequestConfig } from 'axios';
 export interface WorkOSOptions {
     apiHostname?: string;
     https?: boolean;
     port?: number;
+    axios?: Omit<AxiosRequestConfig, 'baseURL'>;
 }

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

@@ -1,5 +1,8 @@
+import { PostOptions } from '../../common/interfaces';
 export interface CreateOrganizationOptions {
     name: string;
     allow_profiles_outside_organization?: boolean;
     domains?: string[];
 }
+export interface CreateOrganizationRequestOptions extends Pick<PostOptions, 'idempotencyKey'> {
+}

package/lib/organizations/organizations.d.ts

@@ -1,11 +1,11 @@
 import { List } from '../common/interfaces/list.interface';
 import { WorkOS } from '../workos';
-import { CreateOrganizationOptions, ListOrganizationsOptions, Organization, UpdateOrganizationOptions } from './interfaces';
+import { CreateOrganizationOptions, CreateOrganizationRequestOptions, ListOrganizationsOptions, Organization, UpdateOrganizationOptions } from './interfaces';
 export declare class Organizations {
     private readonly workos;
     constructor(workos: WorkOS);
     listOrganizations(options?: ListOrganizationsOptions): Promise<List<Organization>>;
-    createOrganization(payload: CreateOrganizationOptions): Promise<Organization>;
+    createOrganization(payload: CreateOrganizationOptions, requestOptions?: CreateOrganizationRequestOptions): Promise<Organization>;
     deleteOrganization(id: string): Promise<void>;
     getOrganization(id: string): Promise<Organization>;
     updateOrganization(options: UpdateOrganizationOptions): Promise<Organization>;

package/lib/organizations/organizations.js

@@ -33,9 +33,9 @@ class Organizations {
             return data;
         });
     }
-    createOrganization(payload) {
+    createOrganization(payload, requestOptions = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.workos.post('/organizations', payload);
+            const { data } = yield this.workos.post('/organizations', payload, requestOptions);
             return data;
         });
     }

package/lib/organizations/organizations.spec.js

@@ -108,6 +108,23 @@ describe('Organizations', () => {
         });
     });
     describe('createOrganization', () => {
+        describe('with an idempotency key', () => {
+            it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock
+                    .onPost('/organizations', {
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                })
+                    .replyOnce(201, create_organization_json_1.default);
+                yield workos.organizations.createOrganization({
+                    domains: ['example.com'],
+                    name: 'Test Organization',
+                }, {
+                    idempotencyKey: 'the-idempotency-key',
+                });
+                expect(mock.history.post[0].headers['Idempotency-Key']).toEqual('the-idempotency-key');
+            }));
+        });
         describe('with a valid payload', () => {
             it('creates an organization', () => __awaiter(void 0, void 0, void 0, function* () {
                 mock

package/lib/workos.js

@@ -25,10 +25,11 @@ const webhooks_1 = require("./webhooks/webhooks");
 const mfa_1 = require("./mfa/mfa");
 const audit_logs_1 = require("./audit-logs/audit-logs");
 const bad_request_exception_1 = require("./common/exceptions/bad-request.exception");
-const VERSION = '2.11.0';
+const VERSION = '2.12.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
+        var _a;
         this.key = key;
         this.options = options;
         this.auditLogs = new audit_logs_1.AuditLogs(this);
@@ -56,13 +57,7 @@ class WorkOS {
         if (port) {
             this.baseURL = this.baseURL + `:${port}`;
         }
-        this.client = axios_1.default.create({
-            baseURL: this.baseURL,
-            headers: {
-                Authorization: `Bearer ${this.key}`,
-                'User-Agent': `workos-node/${VERSION}`,
-            },
-        });
+        this.client = axios_1.default.create(Object.assign(Object.assign({}, options.axios), { baseURL: this.baseURL, headers: Object.assign(Object.assign({}, (_a = options.axios) === null || _a === void 0 ? void 0 : _a.headers), { Authorization: `Bearer ${this.key}`, 'User-Agent': `workos-node/${VERSION}` }) }));
     }
     post(path, entity, options = {}) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/workos.spec.js

@@ -65,6 +65,22 @@ describe('WorkOS', () => {
                 expect(workos.baseURL).toEqual('https://localhost:4000');
             });
         });
+        describe('when the `axios` option is provided', () => {
+            it('applies the configuration to the Axios client', () => __awaiter(void 0, void 0, void 0, function* () {
+                mock.onPost().reply(200, 'OK', { 'X-Request-ID': 'a-request-id' });
+                const workos = new workos_1.WorkOS('sk_test', {
+                    axios: {
+                        headers: {
+                            'X-My-Custom-Header': 'Hey there!',
+                        },
+                    },
+                });
+                yield workos.post('/somewhere', {});
+                expect(mock.history.post[0].headers).toMatchObject({
+                    'X-My-Custom-Header': 'Hey there!',
+                });
+            }));
+        });
     });
     describe('post', () => {
         describe('when the api responds with a 404', () => {

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.11.0",
+  "version": "2.12.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -40,9 +40,9 @@
   },
   "devDependencies": {
     "@types/jest": "27.5.2",
-    "@types/node": "14.18.22",
+    "@types/node": "14.18.24",
     "@types/pluralize": "0.0.29",
-    "axios-mock-adapter": "1.21.1",
+    "axios-mock-adapter": "1.21.2",
     "jest": "27.5.1",
     "prettier": "2.7.1",
     "supertest": "6.2.3",