@workos-inc/node 7.37.1 → 7.38.0

package/lib/actions/interfaces/index.d.ts

@@ -0,0 +1,2 @@
+export * from './action.interface';
+export * from './response-payload.interface';

package/lib/actions/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("./action.interface"), exports);
+__exportStar(require("./response-payload.interface"), exports);

package/lib/fga/fga.spec.js

@@ -24,6 +24,7 @@ describe('FGA', () => {
             (0, test_utils_1.fetchOnce)({
                 result: 'authorized',
                 is_implicit: false,
+                warrant_token: 'abc',
             });
             const checkResult = yield workos.fga.check({
                 checks: [
@@ -44,6 +45,7 @@ describe('FGA', () => {
             expect(checkResult).toMatchObject({
                 result: 'authorized',
                 isImplicit: false,
+                warrantToken: 'abc',
             });
         }));
     });

package/lib/fga/interfaces/check.interface.d.ts

@@ -37,6 +37,7 @@ export interface SerializedCheckBatchOptions {
 export interface CheckResultResponse {
     result: string;
     is_implicit: boolean;
+    warrant_token: string;
     debug_info?: DebugInfoResponse;
 }
 export interface DebugInfo {
@@ -64,11 +65,13 @@ export interface DecisionTreeNodeResponse {
 export interface CheckResultInterface {
     result: string;
     isImplicit: boolean;
+    warrantToken: string;
     debugInfo?: DebugInfo;
 }
 export declare class CheckResult implements CheckResultInterface {
     result: string;
     isImplicit: boolean;
+    warrantToken: string;
     debugInfo?: DebugInfo;
     constructor(json: CheckResultResponse);
     isAuthorized(): boolean;

package/lib/fga/interfaces/check.interface.js

@@ -7,6 +7,7 @@ class CheckResult {
     constructor(json) {
         this.result = json.result;
         this.isImplicit = json.is_implicit;
+        this.warrantToken = json.warrant_token;
         this.debugInfo = json.debug_info
             ? {
                 processingTime: json.debug_info.processing_time,

package/lib/index.d.ts

@@ -4,6 +4,7 @@ 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 './actions/interfaces';
 export * from './audit-logs/interfaces';
 export * from './common/exceptions';
 export * from './common/interfaces';
@@ -18,6 +19,7 @@ export * from './passwordless/interfaces';
 export * from './portal/interfaces';
 export * from './sso/interfaces';
 export * from './user-management/interfaces';
+export * from './roles/interfaces';
 declare class WorkOSNode extends WorkOS {
     /** @override */
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;

package/lib/index.js

@@ -23,6 +23,7 @@ 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");
+__exportStar(require("./actions/interfaces"), exports);
 __exportStar(require("./audit-logs/interfaces"), exports);
 __exportStar(require("./common/exceptions"), exports);
 __exportStar(require("./common/interfaces"), exports);
@@ -37,6 +38,7 @@ __exportStar(require("./passwordless/interfaces"), exports);
 __exportStar(require("./portal/interfaces"), exports);
 __exportStar(require("./sso/interfaces"), exports);
 __exportStar(require("./user-management/interfaces"), exports);
+__exportStar(require("./roles/interfaces"), exports);
 class WorkOSNode extends workos_1.WorkOS {
     /** @override */
     createHttpClient(options, userAgent) {

package/lib/index.worker.d.ts

@@ -4,6 +4,7 @@ import { HttpClient } from './common/net/http-client';
 import { WorkOSOptions } from './index.worker';
 import { Webhooks } from './webhooks/webhooks';
 import { WorkOS } from './workos';
+export * from './actions/interfaces';
 export * from './audit-logs/interfaces';
 export * from './common/exceptions';
 export * from './common/interfaces';
@@ -11,11 +12,14 @@ export * from './common/utils/pagination';
 export * from './directory-sync/interfaces';
 export * from './directory-sync/utils/get-primary-email';
 export * from './events/interfaces';
+export * from './fga/interfaces';
 export * from './organizations/interfaces';
+export * from './organization-domains/interfaces';
 export * from './passwordless/interfaces';
 export * from './portal/interfaces';
 export * from './sso/interfaces';
 export * from './user-management/interfaces';
+export * from './roles/interfaces';
 declare class WorkOSWorker extends WorkOS {
     /** @override */
     createHttpClient(options: WorkOSOptions, userAgent: string): HttpClient;

package/lib/index.worker.js

@@ -21,6 +21,7 @@ const edge_iron_session_provider_1 = require("./common/iron-session/edge-iron-se
 const fetch_client_1 = require("./common/net/fetch-client");
 const webhooks_1 = require("./webhooks/webhooks");
 const workos_1 = require("./workos");
+__exportStar(require("./actions/interfaces"), exports);
 __exportStar(require("./audit-logs/interfaces"), exports);
 __exportStar(require("./common/exceptions"), exports);
 __exportStar(require("./common/interfaces"), exports);
@@ -28,11 +29,14 @@ __exportStar(require("./common/utils/pagination"), exports);
 __exportStar(require("./directory-sync/interfaces"), exports);
 __exportStar(require("./directory-sync/utils/get-primary-email"), exports);
 __exportStar(require("./events/interfaces"), exports);
+__exportStar(require("./fga/interfaces"), exports);
 __exportStar(require("./organizations/interfaces"), exports);
+__exportStar(require("./organization-domains/interfaces"), exports);
 __exportStar(require("./passwordless/interfaces"), exports);
 __exportStar(require("./portal/interfaces"), exports);
 __exportStar(require("./sso/interfaces"), exports);
 __exportStar(require("./user-management/interfaces"), exports);
+__exportStar(require("./roles/interfaces"), exports);
 class WorkOSWorker extends workos_1.WorkOS {
     /** @override */
     createHttpClient(options, userAgent) {

package/lib/organizations/fixtures/list-organization-roles.json

@@ -7,6 +7,10 @@
             "name": "Admin",
             "slug": "admin",
             "description": null,
+            "permissions": [
+                "posts:create",
+                "posts:delete"
+            ],
             "type": "EnvironmentRole",
             "created_at": "2024-01-01T00:00:00.000Z",
             "updated_at": "2024-01-01T00:00:00.000Z"
@@ -17,6 +21,7 @@
             "name": "Member",
             "slug": "member",
             "description": null,
+            "permissions": [],
             "type": "EnvironmentRole",
             "created_at": "2024-01-01T00:00:00.000Z",
             "updated_at": "2024-01-01T00:00:00.000Z"
@@ -27,6 +32,9 @@
             "name": "OrganizationMember",
             "slug": "org-member",
             "description": null,
+            "permissions": [
+                "posts:read"
+            ],
             "type": "OrganizationRole",
             "created_at": "2024-01-01T00:00:00.000Z",
             "updated_at": "2024-01-01T00:00:00.000Z"

package/lib/organizations/organizations.spec.js

@@ -285,6 +285,41 @@ describe('Organizations', () => {
             expect((0, test_utils_1.fetchURL)()).toContain('/organizations/org_01EHT88Z8J8795GZNQ4ZP1J81T/roles');
             expect(object).toEqual('list');
             expect(data).toHaveLength(3);
+            expect(data).toEqual([
+                {
+                    object: 'role',
+                    id: 'role_01EHQMYV6MBK39QC5PZXHY59C5',
+                    name: 'Admin',
+                    slug: 'admin',
+                    description: null,
+                    permissions: ['posts:create', 'posts:delete'],
+                    type: 'EnvironmentRole',
+                    createdAt: '2024-01-01T00:00:00.000Z',
+                    updatedAt: '2024-01-01T00:00:00.000Z',
+                },
+                {
+                    object: 'role',
+                    id: 'role_01EHQMYV6MBK39QC5PZXHY59C3',
+                    name: 'Member',
+                    slug: 'member',
+                    description: null,
+                    permissions: [],
+                    type: 'EnvironmentRole',
+                    createdAt: '2024-01-01T00:00:00.000Z',
+                    updatedAt: '2024-01-01T00:00:00.000Z',
+                },
+                {
+                    object: 'role',
+                    id: 'role_01EHQMYV6MBK39QC5PZXHY59C3',
+                    name: 'OrganizationMember',
+                    slug: 'org-member',
+                    description: null,
+                    permissions: ['posts:read'],
+                    type: 'OrganizationRole',
+                    createdAt: '2024-01-01T00:00:00.000Z',
+                    updatedAt: '2024-01-01T00:00:00.000Z',
+                },
+            ]);
         }));
     });
 });

package/lib/roles/interfaces/role.interface.d.ts

@@ -4,10 +4,16 @@ export interface RoleResponse {
 export interface RoleEvent {
     object: 'role';
     slug: string;
+    permissions: string[];
+    createdAt: string;
+    updatedAt: string;
 }
 export interface RoleEventResponse {
     object: 'role';
     slug: string;
+    permissions: string[];
+    created_at: string;
+    updated_at: string;
 }
 export interface ListOrganizationRolesResponse {
     object: 'list';
@@ -19,6 +25,7 @@ export interface OrganizationRoleResponse {
     name: string;
     slug: string;
     description: string | null;
+    permissions: string[];
     type: 'EnvironmentRole' | 'OrganizationRole';
     created_at: string;
     updated_at: string;
@@ -29,6 +36,7 @@ export interface Role {
     name: string;
     slug: string;
     description: string | null;
+    permissions: string[];
     type: 'EnvironmentRole' | 'OrganizationRole';
     createdAt: string;
     updatedAt: string;

package/lib/roles/serializers/role.serializer.js

@@ -7,6 +7,7 @@ const deserializeRole = (role) => ({
     name: role.name,
     slug: role.slug,
     description: role.description,
+    permissions: role.permissions,
     type: role.type,
     createdAt: role.created_at,
     updatedAt: role.updated_at,

package/lib/user-management/interfaces/refresh-and-seal-session-data.interface.d.ts

@@ -1,3 +1,4 @@
+import { AuthenticateWithSessionCookieSuccessResponse } from './authenticate-with-session-cookie.interface';
 import { AuthenticationResponse } from './authentication-response.interface';
 export declare enum RefreshAndSealSessionDataFailureReason {
     /**
@@ -14,14 +15,23 @@ export declare enum RefreshAndSealSessionDataFailureReason {
      */
     ORGANIZATION_NOT_AUTHORIZED = "organization_not_authorized"
 }
-type RefreshAndSealSessionDataFailedResponse = {
+type RefreshSessionFailedResponse = {
     authenticated: false;
     reason: RefreshAndSealSessionDataFailureReason;
 };
+/**
+ * @deprecated To be removed in a future major version along with `refreshAndSealSessionData`.
+ */
 type RefreshAndSealSessionDataSuccessResponse = {
     authenticated: true;
     session?: AuthenticationResponse;
     sealedSession?: string;
 };
-export type RefreshAndSealSessionDataResponse = RefreshAndSealSessionDataFailedResponse | RefreshAndSealSessionDataSuccessResponse;
+export type RefreshAndSealSessionDataResponse = RefreshSessionFailedResponse | RefreshAndSealSessionDataSuccessResponse;
+type RefreshSessionSuccessResponse = Omit<AuthenticateWithSessionCookieSuccessResponse, 'accessToken'> & {
+    authenticated: true;
+    session?: AuthenticationResponse;
+    sealedSession?: string;
+};
+export type RefreshSessionResponse = RefreshSessionFailedResponse | RefreshSessionSuccessResponse;
 export {};

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

@@ -4,5 +4,8 @@ exports.deserializeRoleEvent = void 0;
 const deserializeRoleEvent = (role) => ({
     object: 'role',
     slug: role.slug,
+    permissions: role.permissions,
+    createdAt: role.created_at,
+    updatedAt: role.updated_at,
 });
 exports.deserializeRoleEvent = deserializeRoleEvent;

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

@@ -1,5 +1,5 @@
+import { AuthenticateWithSessionCookieFailedResponse, AuthenticateWithSessionCookieSuccessResponse, RefreshSessionResponse } from './interfaces';
 import { UserManagement } from './user-management';
-import { AuthenticateWithSessionCookieFailedResponse, AuthenticateWithSessionCookieSuccessResponse, RefreshAndSealSessionDataResponse } from './interfaces';
 type RefreshOptions = {
     cookiePassword?: string;
     organizationId?: string;
@@ -25,7 +25,7 @@ export declare class Session {
      * @param options.organizationId - The organization ID to use for the new session cookie.
      * @returns An object indicating whether the refresh was successful or not. If successful, it will include the new sealed session data.
      */
-    refresh(options?: RefreshOptions): Promise<RefreshAndSealSessionDataResponse>;
+    refresh(options?: RefreshOptions): Promise<RefreshSessionResponse>;
     /**
      * Gets the URL to redirect the user to for logging out.
      *

package/lib/user-management/session.js

@@ -116,10 +116,20 @@ class Session {
                     this.cookiePassword = options.cookiePassword;
                 }
                 this.sessionData = authenticationResponse.sealedSession;
+                const { sid: sessionId, org_id: organizationId, role, permissions, entitlements, } = (0, jose_1.decodeJwt)(authenticationResponse.accessToken);
+                // TODO: Returning `session` here means there's some duplicated data.
+                // Slim down the return type in a future major version.
                 return {
                     authenticated: true,
                     sealedSession: authenticationResponse.sealedSession,
                     session: authenticationResponse,
+                    sessionId,
+                    organizationId,
+                    role,
+                    permissions,
+                    entitlements,
+                    user: session.user,
+                    impersonator: session.impersonator,
                 };
             }
             catch (error) {

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

@@ -200,11 +200,11 @@ describe('Session', () => {
                 const response = yield session.refresh();
                 expect(response).toEqual({
                     authenticated: true,
-                    accessToken: undefined,
-                    authenticationMethod: undefined,
-                    impersonator: undefined,
-                    organizationId: undefined,
-                    refreshToken: undefined,
+                    impersonator: {
+                        email: 'admin@example.com',
+                        reason: 'test',
+                    },
+                    organizationId: 'org_123',
                     sealedSession: expect.any(String),
                     session: expect.objectContaining({
                         sealedSession: expect.any(String),
@@ -212,6 +212,15 @@ describe('Session', () => {
                             email: 'test01@example.com',
                         }),
                     }),
+                    entitlements: undefined,
+                    permissions: ['posts:create', 'posts:delete'],
+                    role: 'member',
+                    sessionId: 'session_123',
+                    user: expect.objectContaining({
+                        email: 'test01@example.com',
+                        id: 'user_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                        object: 'user',
+                    }),
                 });
             }));
             it('overwrites the cookie password if a new one is provided', () => __awaiter(void 0, void 0, void 0, function* () {

package/lib/workos.js

@@ -29,7 +29,7 @@ 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.37.1';
+const VERSION = '7.38.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.37.1",
+  "version": "7.38.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -72,4 +72,4 @@
       "default": "./lib/index.js"
     }
   }
-}
+}