@workos-inc/node 3.7.0 → 3.8.0

package/README.md

@@ -43,3 +43,4 @@ For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)
 - [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
 - [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
 - [Magic Link Guide](https://workos.com/docs/magic-link/guide)
+- [Domain Verification Guide](https://workos.com/docs/domain-verification/guide)

package/lib/common/utils/pagination.js

@@ -52,6 +52,8 @@ class AutoPaginatable {
             const result = yield __await(this.apiCall(Object.assign(Object.assign({}, this.options), { after: params.after })));
             yield yield __await(result.data);
             if (result.listMetadata.after) {
+                // Delay of 4rps to respect list users rate limits
+                yield __await(new Promise((resolve) => setTimeout(resolve, 250)));
                 yield __await(yield* __asyncDelegator(__asyncValues(this.generatePages({ after: result.listMetadata.after }))));
             }
         });

package/lib/events/events.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Events = void 0;
 const serializers_1 = require("../common/serializers");
+const serializers_2 = require("./serializers");
 class Events {
     constructor(workos) {
         this.workos = workos;
@@ -18,7 +19,7 @@ class Events {
     listEvents(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.get(`/events`, {
-                query: options,
+                query: options ? (0, serializers_2.serializeListEventOptions)(options) : undefined,
             });
             return (0, serializers_1.deserializeList)(data, serializers_1.deserializeEvent);
         });

package/lib/events/interfaces/list-events-options.interface.d.ts

@@ -6,3 +6,10 @@ export interface ListEventOptions {
     limit?: number;
     after?: string;
 }
+export interface SerializedListEventOptions {
+    events?: EventName[];
+    range_start?: string;
+    range_end?: string;
+    limit?: number;
+    after?: string;
+}

package/lib/events/serializers/index.d.ts

@@ -0,0 +1 @@
+export * from './list-event-options.serializer';

package/lib/events/serializers/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./list-event-options.serializer"), exports);

package/lib/events/serializers/list-event-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ListEventOptions, SerializedListEventOptions } from '../interfaces';
+export declare const serializeListEventOptions: (options: ListEventOptions) => SerializedListEventOptions;

package/lib/events/serializers/list-event-options.serializer.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeListEventOptions = void 0;
+const serializeListEventOptions = (options) => ({
+    events: options.events,
+    range_start: options.rangeStart,
+    range_end: options.rangeEnd,
+    limit: options.limit,
+    after: options.after,
+});
+exports.serializeListEventOptions = serializeListEventOptions;

package/lib/organization-domains/fixtures/get-organization-domain-pending.json

@@ -0,0 +1,7 @@
+{
+    "object": "organization_domain",
+    "id": "org_domain_01HD50K7EPWCMNPGMKXKKE14XT",
+    "domain": "workos.com",
+    "state": "pending",
+    "verification_token": "F06PGMsZIO0shrveGWuGxgCj7"
+}

package/lib/organization-domains/fixtures/get-organization-domain-unverified.json

@@ -0,0 +1,6 @@
+{
+    "object": "organization_domain",
+    "id": "org_domain_01HCZRAP3TPQ0X0DKJHR32TATG",
+    "domain": "workos.com",
+    "state": "pending"
+}

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

@@ -0,0 +1,8 @@
+export interface CreateOrganizationDomainOptions {
+    domain: string;
+    organizationId: string;
+}
+export interface SerializedCreateOrganizationDomainOptions {
+    domain: string;
+    organization_id: string;
+}

package/lib/organization-domains/interfaces/create-organization-domain-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/organization-domains/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './create-organization-domain-options.interface';
+export * from './organization-domain.interface';

package/lib/organization-domains/interfaces/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-organization-domain-options.interface"), exports);
+__exportStar(require("./organization-domain.interface"), exports);

package/lib/organization-domains/interfaces/organization-domain.interface.d.ts

@@ -0,0 +1,29 @@
+export declare enum OrganizationDomainState {
+    /**
+     * @deprecated
+     */
+    LegacyVerified = "legacy_verified",
+    Verified = "verified",
+    Pending = "pending",
+    Failed = "failed"
+}
+export declare enum OrganizationDomainVerificationStrategy {
+    Dns = "dns",
+    Developer = "developer"
+}
+export interface OrganizationDomain {
+    object: 'organization_domain';
+    id: string;
+    domain: string;
+    state: OrganizationDomainState;
+    verificationToken: string;
+    verificationStrategy: OrganizationDomainVerificationStrategy;
+}
+export interface OrganizationDomainResponse {
+    object: 'organization_domain';
+    id: string;
+    domain: string;
+    state: OrganizationDomainState;
+    verification_token: string;
+    verification_strategy: OrganizationDomainVerificationStrategy;
+}

package/lib/organization-domains/interfaces/organization-domain.interface.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationDomainVerificationStrategy = exports.OrganizationDomainState = void 0;
+var OrganizationDomainState;
+(function (OrganizationDomainState) {
+    /**
+     * @deprecated
+     */
+    OrganizationDomainState["LegacyVerified"] = "legacy_verified";
+    OrganizationDomainState["Verified"] = "verified";
+    OrganizationDomainState["Pending"] = "pending";
+    OrganizationDomainState["Failed"] = "failed";
+})(OrganizationDomainState || (exports.OrganizationDomainState = OrganizationDomainState = {}));
+var OrganizationDomainVerificationStrategy;
+(function (OrganizationDomainVerificationStrategy) {
+    OrganizationDomainVerificationStrategy["Dns"] = "dns";
+    OrganizationDomainVerificationStrategy["Developer"] = "developer";
+})(OrganizationDomainVerificationStrategy || (exports.OrganizationDomainVerificationStrategy = OrganizationDomainVerificationStrategy = {}));

package/lib/organization-domains/organization-domains.d.ts

@@ -0,0 +1,9 @@
+import { WorkOS } from '../workos';
+import { CreateOrganizationDomainOptions, OrganizationDomain } from './interfaces';
+export declare class OrganizationDomains {
+    private readonly workos;
+    constructor(workos: WorkOS);
+    get(id: string): Promise<OrganizationDomain>;
+    verify(id: string): Promise<OrganizationDomain>;
+    create(payload: CreateOrganizationDomainOptions): Promise<OrganizationDomain>;
+}

package/lib/organization-domains/organization-domains.js

@@ -0,0 +1,38 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationDomains = void 0;
+const create_organization_domain_options_serializer_1 = require("./serializers/create-organization-domain-options.serializer");
+const organization_domain_serializer_1 = require("./serializers/organization-domain.serializer");
+class OrganizationDomains {
+    constructor(workos) {
+        this.workos = workos;
+    }
+    get(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.get(`/organization_domains/${id}`);
+            return (0, organization_domain_serializer_1.deserializeOrganizationDomain)(data);
+        });
+    }
+    verify(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/organization_domains/${id}/verify`, {});
+            return (0, organization_domain_serializer_1.deserializeOrganizationDomain)(data);
+        });
+    }
+    create(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/organization_domains`, (0, create_organization_domain_options_serializer_1.serializeCreateOrganizationDomainOptions)(payload));
+            return (0, organization_domain_serializer_1.deserializeOrganizationDomain)(data);
+        });
+    }
+}
+exports.OrganizationDomains = OrganizationDomains;

package/lib/organization-domains/organization-domains.spec.d.ts

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

package/lib/organization-domains/organization-domains.spec.js

@@ -0,0 +1,85 @@
+"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 get_organization_domain_pending_json_1 = __importDefault(require("./fixtures/get-organization-domain-pending.json"));
+const get_organization_domain_unverified_json_1 = __importDefault(require("./fixtures/get-organization-domain-unverified.json"));
+const interfaces_1 = require("./interfaces");
+const mock = new axios_mock_adapter_1.default(axios_1.default);
+const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+describe('OrganizationDomains', () => {
+    afterEach(() => mock.resetHistory());
+    describe('get', () => {
+        it('requests an Organization Domain', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock
+                .onGet('/organization_domains/org_domain_01HCZRAP3TPQ0X0DKJHR32TATG')
+                .replyOnce(200, get_organization_domain_unverified_json_1.default);
+            const subject = yield workos.organizationDomains.get('org_domain_01HCZRAP3TPQ0X0DKJHR32TATG');
+            expect(mock.history.get[0].url).toEqual('/organization_domains/org_domain_01HCZRAP3TPQ0X0DKJHR32TATG');
+            expect(subject.id).toEqual('org_domain_01HCZRAP3TPQ0X0DKJHR32TATG');
+            expect(subject.domain).toEqual('workos.com');
+            expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
+            expect(subject.verificationToken).toBeUndefined();
+        }));
+        it('requests an Organization Domain', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock
+                .onGet('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT')
+                .replyOnce(200, get_organization_domain_pending_json_1.default);
+            const subject = yield workos.organizationDomains.get('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(mock.history.get[0].url).toEqual('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(subject.domain).toEqual('workos.com');
+            expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
+            expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
+        }));
+    });
+    describe('verify', () => {
+        it('start Organization Domain verification flow', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock
+                .onPost('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT/verify')
+                .replyOnce(200, get_organization_domain_pending_json_1.default);
+            const subject = yield workos.organizationDomains.verify('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(mock.history.post[0].url).toEqual('/organization_domains/org_domain_01HD50K7EPWCMNPGMKXKKE14XT/verify');
+            expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(subject.domain).toEqual('workos.com');
+            expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
+            expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
+        }));
+    });
+    describe('create', () => {
+        it('creates an Organization Domain', () => __awaiter(void 0, void 0, void 0, function* () {
+            mock
+                .onPost('/organization_domains', {
+                domain: 'workos.com',
+                organization_id: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+            })
+                .replyOnce(200, get_organization_domain_pending_json_1.default);
+            const subject = yield workos.organizationDomains.create({
+                organizationId: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+                domain: 'workos.com',
+            });
+            expect(mock.history.post[0].url).toEqual('/organization_domains');
+            expect(JSON.parse(mock.history.post[0].data)).toMatchObject({
+                domain: 'workos.com',
+                organization_id: 'org_01EHT88Z8J8795GZNQ4ZP1J81T',
+            });
+            expect(subject.id).toEqual('org_domain_01HD50K7EPWCMNPGMKXKKE14XT');
+            expect(subject.domain).toEqual('workos.com');
+            expect(subject.state).toEqual(interfaces_1.OrganizationDomainState.Pending);
+            expect(subject.verificationToken).toEqual('F06PGMsZIO0shrveGWuGxgCj7');
+        }));
+    });
+});

package/lib/organization-domains/serializers/create-organization-domain-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { CreateOrganizationDomainOptions, SerializedCreateOrganizationDomainOptions } from '../interfaces';
+export declare const serializeCreateOrganizationDomainOptions: (options: CreateOrganizationDomainOptions) => SerializedCreateOrganizationDomainOptions;

package/lib/organization-domains/serializers/create-organization-domain-options.serializer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCreateOrganizationDomainOptions = void 0;
+const serializeCreateOrganizationDomainOptions = (options) => ({
+    domain: options.domain,
+    organization_id: options.organizationId,
+});
+exports.serializeCreateOrganizationDomainOptions = serializeCreateOrganizationDomainOptions;

package/lib/organization-domains/serializers/organization-domain.serializer.d.ts

@@ -0,0 +1,2 @@
+import { OrganizationDomain, OrganizationDomainResponse } from '../interfaces';
+export declare const deserializeOrganizationDomain: (organizationDomain: OrganizationDomainResponse) => OrganizationDomain;

package/lib/organization-domains/serializers/organization-domain.serializer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeOrganizationDomain = void 0;
+const deserializeOrganizationDomain = (organizationDomain) => ({
+    object: organizationDomain.object,
+    id: organizationDomain.id,
+    domain: organizationDomain.domain,
+    state: organizationDomain.state,
+    verificationToken: organizationDomain.verification_token,
+    verificationStrategy: organizationDomain.verification_strategy,
+});
+exports.deserializeOrganizationDomain = deserializeOrganizationDomain;

package/lib/portal/interfaces/generate-portal-link-intent.interface.d.ts

@@ -1,5 +1,6 @@
 export declare enum GeneratePortalLinkIntent {
     AuditLogs = "audit_logs",
+    DomainVerification = "domain_verification",
     DSync = "dsync",
     LogStreams = "log_streams",
     SSO = "sso"

package/lib/portal/interfaces/generate-portal-link-intent.interface.js

@@ -4,6 +4,7 @@ exports.GeneratePortalLinkIntent = void 0;
 var GeneratePortalLinkIntent;
 (function (GeneratePortalLinkIntent) {
     GeneratePortalLinkIntent["AuditLogs"] = "audit_logs";
+    GeneratePortalLinkIntent["DomainVerification"] = "domain_verification";
     GeneratePortalLinkIntent["DSync"] = "dsync";
     GeneratePortalLinkIntent["LogStreams"] = "log_streams";
     GeneratePortalLinkIntent["SSO"] = "sso";

package/lib/portal/portal.spec.js

@@ -41,6 +41,23 @@ describe('Portal', () => {
                     expect(link).toEqual('https://id.workos.com/portal/launch?secret=secret');
                 }));
             });
+            describe('with the domain_verification intent', () => {
+                it('returns an Admin Portal link', () => __awaiter(void 0, void 0, void 0, function* () {
+                    mock
+                        .onPost('/portal/generate_link', {
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.DomainVerification,
+                        organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
+                        return_url: 'https://www.example.com',
+                    })
+                        .replyOnce(201, generate_link_json_1.default);
+                    const { link } = yield workos.portal.generateLink({
+                        intent: generate_portal_link_intent_interface_1.GeneratePortalLinkIntent.DomainVerification,
+                        organization: 'org_01EHQMYV6MBK39QC5PZXHY59C3',
+                        returnUrl: 'https://www.example.com',
+                    });
+                    expect(link).toEqual('https://id.workos.com/portal/launch?secret=secret');
+                }));
+            });
             describe('with the dsync intent', () => {
                 it('returns an Admin Portal link', () => __awaiter(void 0, void 0, void 0, function* () {
                     mock

package/lib/workos.d.ts

@@ -4,6 +4,7 @@ import { GetOptions, PostOptions, PutOptions, WorkOSOptions } from './common/int
 import { DirectorySync } from './directory-sync/directory-sync';
 import { Events } from './events/events';
 import { Organizations } from './organizations/organizations';
+import { OrganizationDomains } from './organization-domains/organization-domains';
 import { Passwordless } from './passwordless/passwordless';
 import { Portal } from './portal/portal';
 import { SSO } from './sso/sso';
@@ -20,6 +21,7 @@ export declare class WorkOS {
     readonly auditTrail: AuditTrail;
     readonly directorySync: DirectorySync;
     readonly organizations: Organizations;
+    readonly organizationDomains: OrganizationDomains;
     readonly passwordless: Passwordless;
     readonly portal: Portal;
     readonly sso: SSO;

package/lib/workos.js

@@ -19,6 +19,7 @@ const exceptions_1 = require("./common/exceptions");
 const directory_sync_1 = require("./directory-sync/directory-sync");
 const events_1 = require("./events/events");
 const organizations_1 = require("./organizations/organizations");
+const organization_domains_1 = require("./organization-domains/organization-domains");
 const passwordless_1 = require("./passwordless/passwordless");
 const portal_1 = require("./portal/portal");
 const sso_1 = require("./sso/sso");
@@ -27,7 +28,7 @@ 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 = '3.7.0';
+const VERSION = '3.8.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 class WorkOS {
     constructor(key, options = {}) {
@@ -38,6 +39,7 @@ class WorkOS {
         this.auditTrail = new audit_trail_1.AuditTrail(this);
         this.directorySync = new directory_sync_1.DirectorySync(this);
         this.organizations = new organizations_1.Organizations(this);
+        this.organizationDomains = new organization_domains_1.OrganizationDomains(this);
         this.passwordless = new passwordless_1.Passwordless(this);
         this.portal = new portal_1.Portal(this);
         this.sso = new sso_1.SSO(this);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.7.0",
+  "version": "3.8.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",