@workos-inc/node 7.17.1 → 7.19.0

package/lib/common/iron-session/edge-iron-session-provider.d.ts

@@ -0,0 +1,10 @@
+import { IronSessionProvider, SealDataOptions, UnsealedDataType } from './iron-session-provider';
+/**
+ * EdgeIronSessionProvider which uses the base iron-session seal/unseal methods.
+ */
+export declare class EdgeIronSessionProvider extends IronSessionProvider {
+    /** @override */
+    sealData(data: unknown, options: SealDataOptions): Promise<string>;
+    /** @override */
+    unsealData<T = UnsealedDataType>(seal: string, options: SealDataOptions): Promise<T>;
+}

package/lib/common/iron-session/edge-iron-session-provider.js

@@ -0,0 +1,32 @@
+"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.EdgeIronSessionProvider = void 0;
+const edge_1 = require("iron-session/edge");
+const iron_session_provider_1 = require("./iron-session-provider");
+/**
+ * EdgeIronSessionProvider which uses the base iron-session seal/unseal methods.
+ */
+class EdgeIronSessionProvider extends iron_session_provider_1.IronSessionProvider {
+    /** @override */
+    sealData(data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, edge_1.sealData)(data, options);
+        });
+    }
+    /** @override */
+    unsealData(seal, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, edge_1.unsealData)(seal, options);
+        });
+    }
+}
+exports.EdgeIronSessionProvider = EdgeIronSessionProvider;

package/lib/common/iron-session/iron-session-provider.d.ts

@@ -0,0 +1,19 @@
+export type SealDataOptions = {
+    password: string | {
+        [id: string]: string;
+    };
+    ttl?: number | undefined;
+};
+export type UnsealedDataType = Record<string, unknown>;
+/**
+ * Interface encapsulating the sealData/unsealData methods for separate iron-session implementations.
+ *
+ * This allows for different implementations of the iron-session library to be used in
+ * worker/edge vs. regular web environments, which is required because of the different crypto APIs available.
+ * Once we drop support for Node 16 and upgrade to iron-session 8+, we can remove this abstraction as iron-session 8+
+ * handles this on its own.
+ */
+export declare abstract class IronSessionProvider {
+    abstract sealData(data: unknown, options: SealDataOptions): Promise<string>;
+    abstract unsealData<T = UnsealedDataType>(seal: string, options: SealDataOptions): Promise<T>;
+}

package/lib/common/iron-session/iron-session-provider.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IronSessionProvider = void 0;
+/**
+ * Interface encapsulating the sealData/unsealData methods for separate iron-session implementations.
+ *
+ * This allows for different implementations of the iron-session library to be used in
+ * worker/edge vs. regular web environments, which is required because of the different crypto APIs available.
+ * Once we drop support for Node 16 and upgrade to iron-session 8+, we can remove this abstraction as iron-session 8+
+ * handles this on its own.
+ */
+class IronSessionProvider {
+}
+exports.IronSessionProvider = IronSessionProvider;

package/lib/common/iron-session/web-iron-session-provider.d.ts

@@ -0,0 +1,10 @@
+import { IronSessionProvider, SealDataOptions, UnsealedDataType } from './iron-session-provider';
+/**
+ * WebIronSessionProvider which uses the base iron-session seal/unseal methods.
+ */
+export declare class WebIronSessionProvider extends IronSessionProvider {
+    /** @override */
+    sealData(data: unknown, options: SealDataOptions): Promise<string>;
+    /** @override */
+    unsealData<T = UnsealedDataType>(seal: string, options: SealDataOptions): Promise<T>;
+}

package/lib/common/iron-session/web-iron-session-provider.js

@@ -0,0 +1,32 @@
+"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.WebIronSessionProvider = void 0;
+const iron_session_1 = require("iron-session");
+const iron_session_provider_1 = require("./iron-session-provider");
+/**
+ * WebIronSessionProvider which uses the base iron-session seal/unseal methods.
+ */
+class WebIronSessionProvider extends iron_session_provider_1.IronSessionProvider {
+    /** @override */
+    sealData(data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, iron_session_1.sealData)(data, options);
+        });
+    }
+    /** @override */
+    unsealData(seal, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, iron_session_1.unsealData)(seal, options);
+        });
+    }
+}
+exports.WebIronSessionProvider = WebIronSessionProvider;

package/lib/common/net/fetch-client.js

@@ -23,7 +23,7 @@ class FetchHttpClient extends http_client_1.HttpClient {
             }
             fetchFn = globalThis.fetch;
         }
-        this._fetchFn = fetchFn;
+        this._fetchFn = fetchFn.bind(globalThis);
     }
     /** @override */
     getClientName() {

package/lib/index.d.ts

@@ -2,6 +2,7 @@ import { HttpClient } from './common/net/http-client';
 import { Webhooks } from './webhooks/webhooks';
 import { WorkOS } from './workos';
 import { WorkOSOptions } from './common/interfaces';
+import { IronSessionProvider } from './common/iron-session/iron-session-provider';
 export * from './audit-logs/interfaces';
 export * from './common/exceptions';
 export * from './common/interfaces';
@@ -19,5 +20,7 @@ declare class WorkOSNode extends WorkOS {
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;
     /** @override */
     createWebhookClient(): Webhooks;
+    /** @override */
+    createIronSessionProvider(): IronSessionProvider;
 }
 export { WorkOSNode as WorkOS };

package/lib/index.js

@@ -21,6 +21,7 @@ const fetch_client_1 = require("./common/net/fetch-client");
 const node_client_1 = require("./common/net/node-client");
 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");
 __exportStar(require("./audit-logs/interfaces"), exports);
 __exportStar(require("./common/exceptions"), exports);
 __exportStar(require("./common/interfaces"), exports);
@@ -57,5 +58,9 @@ class WorkOSNode extends workos_1.WorkOS {
         }
         return new webhooks_1.Webhooks(cryptoProvider);
     }
+    /** @override */
+    createIronSessionProvider() {
+        return new web_iron_session_provider_1.WebIronSessionProvider();
+    }
 }
 exports.WorkOS = WorkOSNode;

package/lib/index.worker.d.ts

@@ -1,3 +1,4 @@
+import { IronSessionProvider } from './common/iron-session/iron-session-provider';
 import { HttpClient } from './common/net/http-client';
 import { WorkOSOptions } from './index.worker';
 import { Webhooks } from './webhooks/webhooks';
@@ -19,5 +20,7 @@ declare class WorkOSWorker extends WorkOS {
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;
     /** @override */
     createWebhookClient(): Webhooks;
+    /** @override */
+    createIronSessionProvider(): IronSessionProvider;
 }
 export { WorkOSWorker as WorkOS };

package/lib/index.worker.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkOS = void 0;
 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");
 const webhooks_1 = require("./webhooks/webhooks");
 const workos_1 = require("./workos");
@@ -42,5 +43,9 @@ class WorkOSWorker extends workos_1.WorkOS {
         const cryptoProvider = new subtle_crypto_provider_1.SubtleCryptoProvider();
         return new webhooks_1.Webhooks(cryptoProvider);
     }
+    /** @override */
+    createIronSessionProvider() {
+        return new edge_iron_session_provider_1.EdgeIronSessionProvider();
+    }
 }
 exports.WorkOS = WorkOSWorker;

package/lib/user-management/interfaces/authenticate-with-refresh-token-options.interface.d.ts

@@ -1,6 +1,7 @@
 import { AuthenticateWithOptionsBase, SerializedAuthenticateWithOptionsBase } from './authenticate-with-options-base.interface';
 export interface AuthenticateWithRefreshTokenOptions extends AuthenticateWithOptionsBase {
     refreshToken: string;
+    organizationId?: string;
 }
 export interface AuthenticateUserWithRefreshTokenCredentials {
     clientSecret: string | undefined;
@@ -8,4 +9,5 @@ export interface AuthenticateUserWithRefreshTokenCredentials {
 export interface SerializedAuthenticateWithRefreshTokenOptions extends SerializedAuthenticateWithOptionsBase {
     grant_type: 'refresh_token';
     refresh_token: string;
+    organization_id: string | undefined;
 }

package/lib/user-management/serializers/authenticate-with-refresh-token.options.serializer.js

@@ -6,6 +6,7 @@ const serializeAuthenticateWithRefreshTokenOptions = (options) => ({
     client_id: options.clientId,
     client_secret: options.clientSecret,
     refresh_token: options.refreshToken,
+    organization_id: options.organizationId,
     ip_address: options.ipAddress,
     user_agent: options.userAgent,
 });

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

@@ -18,10 +18,12 @@ import { RevokeSessionOptions } from './interfaces/revoke-session-options.interf
 import { SendInvitationOptions } from './interfaces/send-invitation-options.interface';
 import { SessionHandlerOptions } from './interfaces/session-handler-options.interface';
 import { UpdateOrganizationMembershipOptions } from './interfaces/update-organization-membership-options.interface';
+import { IronSessionProvider } from '../common/iron-session/iron-session-provider';
 export declare class UserManagement {
     private readonly workos;
+    private readonly ironSessionProvider;
     private jwks;
-    constructor(workos: WorkOS);
+    constructor(workos: WorkOS, ironSessionProvider: IronSessionProvider);
     getUser(userId: string): Promise<User>;
     listUsers(options?: ListUsersOptions): Promise<AutoPaginatable<User>>;
     createUser(payload: CreateUserOptions): Promise<User>;

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

@@ -21,7 +21,6 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserManagement = void 0;
-const iron_session_1 = require("iron-session");
 const jose_1 = require("jose");
 const oauth_exception_1 = require("../common/exceptions/oauth.exception");
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
@@ -55,8 +54,9 @@ const toQueryString = (options) => {
     return searchParams.toString();
 };
 class UserManagement {
-    constructor(workos) {
+    constructor(workos, ironSessionProvider) {
         this.workos = workos;
+        this.ironSessionProvider = ironSessionProvider;
         const { clientId } = workos.options;
         // Set the JWKS URL. This is used to verify if the JWT is still valid
         this.jwks = clientId
@@ -164,7 +164,7 @@ class UserManagement {
                     reason: authenticate_with_session_cookie_interface_1.AuthenticateWithSessionCookieFailureReason.NO_SESSION_COOKIE_PROVIDED,
                 };
             }
-            const session = yield (0, iron_session_1.unsealData)(sessionData, {
+            const session = yield this.ironSessionProvider.unsealData(sessionData, {
                 password: cookiePassword,
             });
             if (!session.accessToken) {
@@ -214,7 +214,7 @@ class UserManagement {
                     reason: refresh_and_seal_session_data_interface_1.RefreshAndSealSessionDataFailureReason.NO_SESSION_COOKIE_PROVIDED,
                 };
             }
-            const session = yield (0, iron_session_1.unsealData)(sessionData, {
+            const session = yield this.ironSessionProvider.unsealData(sessionData, {
                 password: cookiePassword,
             });
             if (!session.refreshToken || !session.user) {
@@ -274,7 +274,9 @@ class UserManagement {
                 refreshToken: authenticationResponse.refreshToken,
                 impersonator: authenticationResponse.impersonator,
             };
-            return (0, iron_session_1.sealData)(sessionData, { password: cookiePassword });
+            return this.ironSessionProvider.sealData(sessionData, {
+                password: cookiePassword,
+            });
         });
     }
     getSessionFromCookie({ sessionData, cookiePassword = process.env.WORKOS_COOKIE_PASSWORD, }) {
@@ -283,7 +285,7 @@ class UserManagement {
                 throw new Error('Cookie password is required');
             }
             if (sessionData) {
-                return (0, iron_session_1.unsealData)(sessionData, {
+                return this.ironSessionProvider.unsealData(sessionData, {
                     password: cookiePassword,
                 });
             }

package/lib/worker.spec.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @jest-environment miniflare
+ */
+export {};

package/lib/worker.spec.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * @jest-environment miniflare
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_worker_1 = require("./index.worker");
+test('WorkOS is initialized without errors', () => {
+    expect(() => new index_worker_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU')).not.toThrow();
+});

package/lib/workos.d.ts

@@ -12,6 +12,7 @@ import { AuditLogs } from './audit-logs/audit-logs';
 import { UserManagement } from './user-management/user-management';
 import { FGA } from './fga/fga';
 import { HttpClient } from './common/net/http-client';
+import { IronSessionProvider } from './common/iron-session/iron-session-provider';
 export declare class WorkOS {
     readonly key?: string | undefined;
     readonly options: WorkOSOptions;
@@ -33,6 +34,7 @@ export declare class WorkOS {
     constructor(key?: string | undefined, options?: WorkOSOptions);
     createWebhookClient(): Webhooks;
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;
+    createIronSessionProvider(): IronSessionProvider;
     get version(): string;
     post<Result = any, Entity = any>(path: string, entity: Entity, options?: PostOptions): Promise<{
         data: Result;

package/lib/workos.js

@@ -27,7 +27,7 @@ const bad_request_exception_1 = require("./common/exceptions/bad-request.excepti
 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 VERSION = '7.17.1';
+const VERSION = '7.19.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
@@ -72,7 +72,7 @@ class WorkOS {
         }
         this.webhooks = this.createWebhookClient();
         // Must initialize UserManagement after baseURL is configured
-        this.userManagement = new user_management_1.UserManagement(this);
+        this.userManagement = new user_management_1.UserManagement(this, this.createIronSessionProvider());
         this.client = this.createHttpClient(options, userAgent);
     }
     createWebhookClient() {
@@ -82,6 +82,9 @@ class WorkOS {
         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 }) }));
     }
+    createIronSessionProvider() {
+        throw new Error('IronSessionProvider not implemented. Use WorkOSNode or WorkOSWorker instead.');
+    }
     get version() {
         return VERSION;
     }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.17.1",
+  "version": "7.19.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -32,6 +32,7 @@
     "lint": "tslint -p tsconfig.json -c tslint.json",
     "test": "jest",
     "test:watch": "jest --watch",
+    "test:worker": "jest src/worker.spec.ts",
     "prettier": "prettier \"src/**/*.{js,ts,tsx}\" --check",
     "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
     "prepublishOnly": "yarn run build"
@@ -47,6 +48,7 @@
     "@types/node": "14.18.54",
     "@types/pluralize": "0.0.30",
     "jest": "29.6.2",
+    "jest-environment-miniflare": "^2.14.2",
     "jest-fetch-mock": "^3.0.3",
     "prettier": "2.8.8",
     "supertest": "6.3.3",