@workos-inc/node 7.30.1 → 7.31.0-beta.actions1

package/lib/index.js

@@ -19,6 +19,7 @@ const node_crypto_provider_1 = require("./common/crypto/node-crypto-provider");
 const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider");
 const fetch_client_1 = require("./common/net/fetch-client");
 const node_client_1 = require("./common/net/node-client");
+const actions_1 = require("./actions/actions");
 const webhooks_1 = require("./webhooks/webhooks");
 const workos_1 = require("./workos");
 const web_iron_session_provider_1 = require("./common/iron-session/web-iron-session-provider");
@@ -61,6 +62,17 @@ class WorkOSNode extends workos_1.WorkOS {
         return new webhooks_1.Webhooks(cryptoProvider);
     }
     /** @override */
+    createActionsClient() {
+        let cryptoProvider;
+        if (typeof crypto !== 'undefined' && typeof crypto.subtle !== 'undefined') {
+            cryptoProvider = new subtle_crypto_provider_1.SubtleCryptoProvider();
+        }
+        else {
+            cryptoProvider = new node_crypto_provider_1.NodeCryptoProvider();
+        }
+        return new actions_1.Actions(cryptoProvider);
+    }
+    /** @override */
     createIronSessionProvider() {
         return new web_iron_session_provider_1.WebIronSessionProvider();
     }

package/lib/index.worker.d.ts

@@ -1,3 +1,4 @@
+import { Actions } from './actions/actions';
 import { IronSessionProvider } from './common/iron-session/iron-session-provider';
 import { HttpClient } from './common/net/http-client';
 import { WorkOSOptions } from './index.worker';
@@ -21,6 +22,8 @@ declare class WorkOSWorker extends WorkOS {
     /** @override */
     createWebhookClient(): Webhooks;
     /** @override */
+    createActionsClient(): Actions;
+    /** @override */
     createIronSessionProvider(): IronSessionProvider;
     /** @override */
     emitWarning(warning: string): void;

package/lib/index.worker.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkOS = void 0;
+const actions_1 = require("./actions/actions");
 const subtle_crypto_provider_1 = require("./common/crypto/subtle-crypto-provider");
 const edge_iron_session_provider_1 = require("./common/iron-session/edge-iron-session-provider");
 const fetch_client_1 = require("./common/net/fetch-client");
@@ -44,6 +45,11 @@ class WorkOSWorker extends workos_1.WorkOS {
         return new webhooks_1.Webhooks(cryptoProvider);
     }
     /** @override */
+    createActionsClient() {
+        const cryptoProvider = new subtle_crypto_provider_1.SubtleCryptoProvider();
+        return new actions_1.Actions(cryptoProvider);
+    }
+    /** @override */
     createIronSessionProvider() {
         return new edge_iron_session_provider_1.EdgeIronSessionProvider();
     }

package/lib/organizations/organizations.d.ts

@@ -1,7 +1,6 @@
 import { AutoPaginatable } from '../common/utils/pagination';
 import { WorkOS } from '../workos';
 import { CreateOrganizationOptions, CreateOrganizationRequestOptions, ListOrganizationsOptions, Organization, UpdateOrganizationOptions } from './interfaces';
-import { SetStripeCustomerIdOptions } from './interfaces/set-stripe-customer-id-options.interface';
 export declare class Organizations {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -10,6 +9,4 @@ export declare class Organizations {
     deleteOrganization(id: string): Promise<void>;
     getOrganization(id: string): Promise<Organization>;
     updateOrganization(options: UpdateOrganizationOptions): Promise<Organization>;
-    setStripeCustomerId(options: SetStripeCustomerIdOptions): Promise<string | undefined>;
-    getStripeCustomerId(id: string): Promise<string | undefined>;
 }

package/lib/organizations/organizations.js

@@ -57,17 +57,5 @@ class Organizations {
             return (0, serializers_1.deserializeOrganization)(data);
         });
     }
-    setStripeCustomerId(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const updatedOrganization = yield this.updateOrganization(options);
-            return updatedOrganization.stripeCustomerId;
-        });
-    }
-    getStripeCustomerId(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const organization = yield this.getOrganization(id);
-            return organization.stripeCustomerId;
-        });
-    }
 }
 exports.Organizations = Organizations;

package/lib/organizations/organizations.spec.js

@@ -19,7 +19,6 @@ const clear_stripe_customer_id_json_1 = __importDefault(require("./fixtures/clea
 const create_organization_invalid_json_1 = __importDefault(require("./fixtures/create-organization-invalid.json"));
 const create_organization_json_1 = __importDefault(require("./fixtures/create-organization.json"));
 const get_organization_json_1 = __importDefault(require("./fixtures/get-organization.json"));
-const get_stripe_customer_id_json_1 = __importDefault(require("./fixtures/get-stripe-customer-id.json"));
 const list_organizations_json_1 = __importDefault(require("./fixtures/list-organizations.json"));
 const update_organization_json_1 = __importDefault(require("./fixtures/update-organization.json"));
 const set_stripe_customer_id_json_1 = __importDefault(require("./fixtures/set-stripe-customer-id.json"));
@@ -239,33 +238,7 @@ describe('Organizations', () => {
                 }));
             });
         });
-    });
-    describe('setStripeCustomerId', () => {
-        describe('with a valid payload', () => {
-            it('updates the organization’s Stripe customer ID', () => __awaiter(void 0, void 0, void 0, function* () {
-                (0, test_utils_1.fetchOnce)(set_stripe_customer_id_json_1.default);
-                const subject = yield workos.organizations.setStripeCustomerId({
-                    organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
-                    stripeCustomerId: 'cus_MX8J9nfK4lP2Yw',
-                });
-                expect((0, test_utils_1.fetchBody)()).toEqual({
-                    stripe_customer_id: 'cus_MX8J9nfK4lP2Yw',
-                });
-                expect(subject).toBe('cus_MX8J9nfK4lP2Yw');
-            }));
-            it('clears the organization’s Stripe customer ID with a `null` value', () => __awaiter(void 0, void 0, void 0, function* () {
-                (0, test_utils_1.fetchOnce)(clear_stripe_customer_id_json_1.default);
-                const subject = yield workos.organizations.setStripeCustomerId({
-                    organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
-                    stripeCustomerId: null,
-                });
-                expect((0, test_utils_1.fetchBody)()).toEqual({
-                    stripe_customer_id: null,
-                });
-                expect(subject).toBeUndefined();
-            }));
-        });
-        describe('when set via `updateOrganization`', () => {
+        describe('when given `stripeCustomerId`', () => {
             it('updates the organization’s Stripe customer ID', () => __awaiter(void 0, void 0, void 0, function* () {
                 (0, test_utils_1.fetchOnce)(set_stripe_customer_id_json_1.default);
                 const subject = yield workos.organizations.updateOrganization({
@@ -288,29 +261,18 @@ describe('Organizations', () => {
                 });
                 expect(subject.stripeCustomerId).toBeUndefined();
             }));
-        });
-        describe('when the feature is not enabled', () => {
-            it('returns an error', () => __awaiter(void 0, void 0, void 0, function* () {
-                (0, test_utils_1.fetchOnce)(set_stripe_customer_id_disabled_json_1.default, { status: 422 });
-                yield expect(workos.organizations.setStripeCustomerId({
-                    organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
-                    stripeCustomerId: 'cus_MX8J9nfK4lP2Yw',
-                })).rejects.toThrowError('stripe_customer_id is not enabled for this environment');
-                expect((0, test_utils_1.fetchBody)()).toEqual({
-                    stripe_customer_id: 'cus_MX8J9nfK4lP2Yw',
-                });
-            }));
-        });
-    });
-    describe('getStripeCustomerId', () => {
-        it('returns the organization’s Stripe customer ID', () => __awaiter(void 0, void 0, void 0, function* () {
-            (0, test_utils_1.fetchOnce)(get_stripe_customer_id_json_1.default);
-            const subject = yield workos.organizations.setStripeCustomerId({
-                organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
-                stripeCustomerId: null,
+            describe('when the feature is not enabled', () => {
+                it('returns an error', () => __awaiter(void 0, void 0, void 0, function* () {
+                    (0, test_utils_1.fetchOnce)(set_stripe_customer_id_disabled_json_1.default, { status: 422 });
+                    yield expect(workos.organizations.updateOrganization({
+                        organization: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+                        stripeCustomerId: 'cus_MX8J9nfK4lP2Yw',
+                    })).rejects.toThrowError('stripe_customer_id is not enabled for this environment');
+                    expect((0, test_utils_1.fetchBody)()).toEqual({
+                        stripe_customer_id: 'cus_MX8J9nfK4lP2Yw',
+                    });
+                }));
             });
-            expect((0, test_utils_1.fetchURL)()).toContain('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T');
-            expect(subject).toEqual('cus_MX8J9nfK4lP2Yw');
-        }));
+        });
     });
 });

package/lib/webhooks/webhooks.d.ts

@@ -1,20 +1,20 @@
 import { Event } from '../common/interfaces';
 import { CryptoProvider } from '../common/crypto/crypto-provider';
 export declare class Webhooks {
-    private cryptoProvider;
+    private signatureProvider;
     constructor(cryptoProvider: CryptoProvider);
+    get verifyHeader(): ({ payload, sigHeader, secret, tolerance, }: {
+        payload: any;
+        sigHeader: string;
+        secret: string;
+        tolerance?: number | undefined;
+    }) => Promise<boolean>;
+    get computeSignature(): (timestamp: any, payload: any, secret: string) => Promise<string>;
+    get getTimestampAndSignatureHash(): (sigHeader: string) => [string, string];
     constructEvent({ payload, sigHeader, secret, tolerance, }: {
         payload: unknown;
         sigHeader: string;
         secret: string;
         tolerance?: number;
     }): Promise<Event>;
-    verifyHeader({ payload, sigHeader, secret, tolerance, }: {
-        payload: any;
-        sigHeader: string;
-        secret: string;
-        tolerance?: number;
-    }): Promise<boolean>;
-    getTimestampAndSignatureHash(sigHeader: string): [string, string];
-    computeSignature(timestamp: any, payload: any, secret: string): Promise<string>;
 }

package/lib/webhooks/webhooks.js

@@ -10,11 +10,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Webhooks = void 0;
-const exceptions_1 = require("../common/exceptions");
 const serializers_1 = require("../common/serializers");
+const SignatureProvider_1 = require("../common/crypto/SignatureProvider");
 class Webhooks {
     constructor(cryptoProvider) {
-        this.cryptoProvider = cryptoProvider;
+        this.signatureProvider = new SignatureProvider_1.SignatureProvider(cryptoProvider);
+    }
+    get verifyHeader() {
+        return this.signatureProvider.verifyHeader.bind(this.signatureProvider);
+    }
+    get computeSignature() {
+        return this.signatureProvider.computeSignature.bind(this.signatureProvider);
+    }
+    get getTimestampAndSignatureHash() {
+        return this.signatureProvider.getTimestampAndSignatureHash.bind(this.signatureProvider);
     }
     constructEvent({ payload, sigHeader, secret, tolerance = 180000, }) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -24,39 +33,5 @@ class Webhooks {
             return (0, serializers_1.deserializeEvent)(webhookPayload);
         });
     }
-    verifyHeader({ payload, sigHeader, secret, tolerance = 180000, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const [timestamp, signatureHash] = this.getTimestampAndSignatureHash(sigHeader);
-            if (!signatureHash || Object.keys(signatureHash).length === 0) {
-                throw new exceptions_1.SignatureVerificationException('No signature hash found with expected scheme v1');
-            }
-            if (parseInt(timestamp, 10) < Date.now() - tolerance) {
-                throw new exceptions_1.SignatureVerificationException('Timestamp outside the tolerance zone');
-            }
-            const expectedSig = yield this.computeSignature(timestamp, payload, secret);
-            if ((yield this.cryptoProvider.secureCompare(expectedSig, signatureHash)) ===
-                false) {
-                throw new exceptions_1.SignatureVerificationException('Signature hash does not match the expected signature hash for payload');
-            }
-            return true;
-        });
-    }
-    getTimestampAndSignatureHash(sigHeader) {
-        const signature = sigHeader;
-        const [t, v1] = signature.split(',');
-        if (typeof t === 'undefined' || typeof v1 === 'undefined') {
-            throw new exceptions_1.SignatureVerificationException('Signature or timestamp missing');
-        }
-        const { 1: timestamp } = t.split('=');
-        const { 1: signatureHash } = v1.split('=');
-        return [timestamp, signatureHash];
-    }
-    computeSignature(timestamp, payload, secret) {
-        return __awaiter(this, void 0, void 0, function* () {
-            payload = JSON.stringify(payload);
-            const signedPayload = `${timestamp}.${payload}`;
-            return yield this.cryptoProvider.computeHMACSignatureAsync(signedPayload, secret);
-        });
-    }
 }
 exports.Webhooks = Webhooks;

package/lib/webhooks/webhooks.spec.js

@@ -17,8 +17,6 @@ const workos_1 = require("../workos");
 const webhook_json_1 = __importDefault(require("./fixtures/webhook.json"));
 const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
 const exceptions_1 = require("../common/exceptions");
-const node_crypto_provider_1 = require("../common/crypto/node-crypto-provider");
-const subtle_crypto_provider_1 = require("../common/crypto/subtle-crypto-provider");
 describe('Webhooks', () => {
     let payload;
     let secret;
@@ -166,55 +164,34 @@ describe('Webhooks', () => {
         });
     });
     describe('verifyHeader', () => {
-        it('returns true when the signature is valid', () => __awaiter(void 0, void 0, void 0, function* () {
-            const sigHeader = `t=${timestamp}, v1=${signatureHash}`;
-            const options = { payload, sigHeader, secret };
-            const result = yield workos.webhooks.verifyHeader(options);
-            expect(result).toBeTruthy();
+        it('aliases to the signature provider', () => __awaiter(void 0, void 0, void 0, function* () {
+            const spy = jest.spyOn(
+            // tslint:disable-next-line
+            workos.webhooks['signatureProvider'], 'verifyHeader');
+            yield workos.webhooks.verifyHeader({
+                payload,
+                sigHeader: `t=${timestamp}, v1=${signatureHash}`,
+                secret,
+            });
+            expect(spy).toHaveBeenCalled();
         }));
     });
-    describe('getTimestampAndSignatureHash', () => {
-        it('returns the timestamp and signature when the signature is valid', () => {
-            const sigHeader = `t=${timestamp}, v1=${signatureHash}`;
-            const timestampAndSignature = workos.webhooks.getTimestampAndSignatureHash(sigHeader);
-            expect(timestampAndSignature).toEqual([
-                timestamp.toString(),
-                signatureHash,
-            ]);
-        });
-    });
     describe('computeSignature', () => {
-        it('returns the computed signature', () => __awaiter(void 0, void 0, void 0, function* () {
-            const signature = yield workos.webhooks.computeSignature(timestamp, payload, secret);
-            expect(signature).toEqual(signatureHash);
+        it('aliases to the signature provider', () => __awaiter(void 0, void 0, void 0, function* () {
+            const spy = jest.spyOn(
+            // tslint:disable-next-line
+            workos.webhooks['signatureProvider'], 'computeSignature');
+            yield workos.webhooks.computeSignature(timestamp, payload, secret);
+            expect(spy).toHaveBeenCalled();
         }));
     });
-    describe('when in an environment that supports SubtleCrypto', () => {
-        it('automatically uses the subtle crypto library', () => {
+    describe('getTimestampAndSignatureHash', () => {
+        it('aliases to the signature provider', () => __awaiter(void 0, void 0, void 0, function* () {
+            const spy = jest.spyOn(
             // tslint:disable-next-line
-            expect(workos.webhooks['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
-        });
-    });
-    describe('CryptoProvider', () => {
-        describe('when computing HMAC signature', () => {
-            it('returns the same for the Node crypto and Web Crypto versions', () => __awaiter(void 0, void 0, void 0, function* () {
-                const nodeCryptoProvider = new node_crypto_provider_1.NodeCryptoProvider();
-                const subtleCryptoProvider = new subtle_crypto_provider_1.SubtleCryptoProvider();
-                const stringifiedPayload = JSON.stringify(payload);
-                const payloadHMAC = `${timestamp}.${stringifiedPayload}`;
-                const nodeCompare = yield nodeCryptoProvider.computeHMACSignatureAsync(payloadHMAC, secret);
-                const subtleCompare = yield subtleCryptoProvider.computeHMACSignatureAsync(payloadHMAC, secret);
-                expect(nodeCompare).toEqual(subtleCompare);
-            }));
-        });
-        describe('when securely comparing', () => {
-            it('returns the same for the Node crypto and Web Crypto versions', () => __awaiter(void 0, void 0, void 0, function* () {
-                const nodeCryptoProvider = new node_crypto_provider_1.NodeCryptoProvider();
-                const subtleCryptoProvider = new subtle_crypto_provider_1.SubtleCryptoProvider();
-                const signature = yield workos.webhooks.computeSignature(timestamp, payload, secret);
-                expect(nodeCryptoProvider.secureCompare(signature, signatureHash)).toEqual(subtleCryptoProvider.secureCompare(signature, signatureHash));
-                expect(nodeCryptoProvider.secureCompare(signature, 'foo')).toEqual(subtleCryptoProvider.secureCompare(signature, 'foo'));
-            }));
-        });
+            workos.webhooks['signatureProvider'], 'getTimestampAndSignatureHash');
+            workos.webhooks.getTimestampAndSignatureHash(`t=${timestamp}, v1=${signatureHash}`);
+            expect(spy).toHaveBeenCalled();
+        }));
     });
 });

package/lib/workos.d.ts

@@ -14,12 +14,14 @@ import { FGA } from './fga/fga';
 import { HttpClient } from './common/net/http-client';
 import { IronSessionProvider } from './common/iron-session/iron-session-provider';
 import { Widgets } from './widgets/widgets';
+import { Actions } from './actions/actions';
 export declare class WorkOS {
     readonly key?: string | undefined;
     readonly options: WorkOSOptions;
     readonly baseURL: string;
     readonly client: HttpClient;
     readonly clientId?: string;
+    readonly actions: Actions;
     readonly auditLogs: AuditLogs;
     readonly directorySync: DirectorySync;
     readonly organizations: Organizations;
@@ -35,6 +37,7 @@ export declare class WorkOS {
     readonly widgets: Widgets;
     constructor(key?: string | undefined, options?: WorkOSOptions);
     createWebhookClient(): Webhooks;
+    createActionsClient(): Actions;
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;
     createIronSessionProvider(): IronSessionProvider;
     get version(): string;

package/lib/workos.js

@@ -28,6 +28,7 @@ const http_client_1 = require("./common/net/http-client");
 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.30.1';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
@@ -78,6 +79,7 @@ class WorkOS {
             userAgent += ` ${name}: ${version}`;
         }
         this.webhooks = this.createWebhookClient();
+        this.actions = this.createActionsClient();
         // Must initialize UserManagement after baseURL is configured
         this.userManagement = new user_management_1.UserManagement(this, this.createIronSessionProvider());
         this.client = this.createHttpClient(options, userAgent);
@@ -85,6 +87,9 @@ class WorkOS {
     createWebhookClient() {
         return new webhooks_1.Webhooks(new subtle_crypto_provider_1.SubtleCryptoProvider());
     }
+    createActionsClient() {
+        return new actions_1.Actions(new subtle_crypto_provider_1.SubtleCryptoProvider());
+    }
     createHttpClient(options, userAgent) {
         var _a;
         return new fetch_client_1.FetchHttpClient(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 }) }));

package/lib/workos.spec.js

@@ -246,8 +246,12 @@ describe('WorkOS', () => {
             const workos = new index_worker_1.WorkOS('sk_test_key');
             // tslint:disable-next-line
             expect(workos['client']).toBeInstanceOf(fetch_client_1.FetchHttpClient);
+            expect(
             // tslint:disable-next-line
-            expect(workos.webhooks['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
+            workos.webhooks['signatureProvider']['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
+            expect(
+            // tslint:disable-next-line
+            workos.actions['signatureProvider']['cryptoProvider']).toBeInstanceOf(subtle_crypto_provider_1.SubtleCryptoProvider);
         });
         it('uses console.warn to emit warnings', () => {
             const workos = new index_worker_1.WorkOS('sk_test_key');

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.30.1",
+  "version": "7.31.0-beta.actions1",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -50,6 +50,7 @@
     "jest": "29.6.2",
     "jest-environment-miniflare": "^2.14.2",
     "jest-fetch-mock": "^3.0.3",
+    "nock": "^13.5.5",
     "prettier": "2.8.8",
     "supertest": "6.3.3",
     "ts-jest": "29.1.3",

package/lib/organizations/fixtures/get-stripe-customer-id.json

@@ -1,17 +0,0 @@
-{
-    "name": "Test Organization 3",
-    "object": "organization",
-    "id": "org_01EHT88Z8J8795GZNQ4ZP1J81T",
-    "allow_profiles_outside_organization": false,
-    "domains": [
-        {
-            "domain": "example.com",
-            "object": "organization_domain",
-            "id": "org_domain_01EHT88Z8WZEFWYPM6EC9BX2R8",
-            "state": "verified",
-            "verification_strategy": "dns",
-            "verification_token": "xB8SeACdKJQP9DP4CahU4YuQZ"
-        }
-    ],
-    "stripe_customer_id": "cus_MX8J9nfK4lP2Yw"
-}

package/lib/organizations/interfaces/set-stripe-customer-id-options.interface.d.ts

@@ -1,4 +0,0 @@
-export interface SetStripeCustomerIdOptions {
-    organization: string;
-    stripeCustomerId: string | null;
-}