@workos-inc/node 7.50.1 → 7.51.0

package/lib/common/utils/pagination.d.ts

@@ -1,6 +1,6 @@
 import { List, PaginationOptions } from '../interfaces';
 export declare class AutoPaginatable<T> {
-    private list;
+    protected list: List<T>;
     private apiCall;
     readonly object: 'list';
     readonly options: PaginationOptions;

package/lib/fga/fga.d.ts

@@ -1,6 +1,7 @@
 import { WorkOS } from '../workos';
 import { Resource, CheckBatchOptions, CheckOptions, CheckRequestOptions, CheckResult, CreateResourceOptions, DeleteResourceOptions, ListResourcesOptions, ListWarrantsRequestOptions, ListWarrantsOptions, QueryOptions, QueryRequestOptions, QueryResult, ResourceInterface, ResourceOptions, UpdateResourceOptions, WriteWarrantOptions, Warrant, WarrantToken, BatchWriteResourcesOptions } from './interfaces';
 import { AutoPaginatable } from '../common/utils/pagination';
+import { FgaPaginatable } from './utils/fga-paginatable';
 export declare class FGA {
     private readonly workos;
     constructor(workos: WorkOS);
@@ -15,5 +16,5 @@ export declare class FGA {
     writeWarrant(options: WriteWarrantOptions): Promise<WarrantToken>;
     batchWriteWarrants(options: WriteWarrantOptions[]): Promise<WarrantToken>;
     listWarrants(options?: ListWarrantsOptions, requestOptions?: ListWarrantsRequestOptions): Promise<AutoPaginatable<Warrant>>;
-    query(options: QueryOptions, requestOptions?: QueryRequestOptions): Promise<AutoPaginatable<QueryResult>>;
+    query(options: QueryOptions, requestOptions?: QueryRequestOptions): Promise<FgaPaginatable<QueryResult>>;
 }

package/lib/fga/fga.js

@@ -15,6 +15,8 @@ const serializers_1 = require("./serializers");
 const interface_check_1 = require("./utils/interface-check");
 const pagination_1 = require("../common/utils/pagination");
 const fetch_and_deserialize_1 = require("../common/utils/fetch-and-deserialize");
+const fga_paginatable_1 = require("./utils/fga-paginatable");
+const fetch_and_deserialize_list_1 = require("./utils/fetch-and-deserialize-list");
 class FGA {
     constructor(workos) {
         this.workos = workos;
@@ -104,7 +106,7 @@ class FGA {
     }
     query(options, requestOptions = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            return new pagination_1.AutoPaginatable(yield (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/fga/v1/query', serializers_1.deserializeQueryResult, (0, serializers_1.serializeQueryOptions)(options), requestOptions), (params) => (0, fetch_and_deserialize_1.fetchAndDeserialize)(this.workos, '/fga/v1/query', serializers_1.deserializeQueryResult, params, requestOptions), (0, serializers_1.serializeQueryOptions)(options));
+            return new fga_paginatable_1.FgaPaginatable(yield (0, fetch_and_deserialize_list_1.fetchAndDeserializeFGAList)(this.workos, '/fga/v1/query', serializers_1.deserializeQueryResult, (0, serializers_1.serializeQueryOptions)(options), requestOptions), (params) => (0, fetch_and_deserialize_list_1.fetchAndDeserializeFGAList)(this.workos, '/fga/v1/query', serializers_1.deserializeQueryResult, params, requestOptions), (0, serializers_1.serializeQueryOptions)(options));
         });
     }
 }

package/lib/fga/fga.spec.js

@@ -48,6 +48,56 @@ describe('FGA', () => {
                 warrantToken: 'abc',
             });
         }));
+        it('deserializes warnings in check response', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({
+                result: 'authorized',
+                is_implicit: false,
+                warrant_token: 'abc',
+                warnings: [
+                    {
+                        code: 'missing_context_keys',
+                        message: 'Missing required context keys',
+                        keys: ['tenant_id', 'region'],
+                    },
+                    {
+                        code: 'some_other_warning',
+                        message: 'Some other warning message',
+                    },
+                ],
+            });
+            const checkResult = yield workos.fga.check({
+                checks: [
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'admin',
+                        },
+                        relation: 'member',
+                        subject: {
+                            resourceType: 'user',
+                            resourceId: 'user_123',
+                        },
+                    },
+                ],
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/fga/v1/check');
+            expect(checkResult).toMatchObject({
+                result: 'authorized',
+                isImplicit: false,
+                warrantToken: 'abc',
+                warnings: [
+                    {
+                        code: 'missing_context_keys',
+                        message: 'Missing required context keys',
+                        keys: ['tenant_id', 'region'],
+                    },
+                    {
+                        code: 'some_other_warning',
+                        message: 'Some other warning message',
+                    },
+                ],
+            });
+        }));
     });
     describe('createResource', () => {
         it('creates resource', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -606,6 +656,100 @@ describe('FGA', () => {
                 },
             ]);
         }));
+        it('deserializes warnings in query response', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({
+                data: [
+                    {
+                        resource_type: 'role',
+                        resource_id: 'admin',
+                        warrant: {
+                            resource_type: 'role',
+                            resource_id: 'admin',
+                            relation: 'member',
+                            subject: {
+                                resource_type: 'user',
+                                resource_id: 'user_123',
+                            },
+                        },
+                        is_implicit: false,
+                    },
+                    {
+                        resource_type: 'role',
+                        resource_id: 'manager',
+                        warrant: {
+                            resource_type: 'role',
+                            resource_id: 'manager',
+                            relation: 'member',
+                            subject: {
+                                resource_type: 'user',
+                                resource_id: 'user_123',
+                            },
+                        },
+                        is_implicit: true,
+                    },
+                ],
+                list_metadata: {
+                    before: null,
+                    after: null,
+                },
+                warnings: [
+                    {
+                        code: 'missing_context_keys',
+                        message: 'Missing required context keys',
+                        keys: ['tenant_id'],
+                    },
+                    {
+                        code: 'some_other_warning',
+                        message: 'Some other warning message',
+                    },
+                ],
+            });
+            const result = yield workos.fga.query({
+                q: 'select role where user:user_123 is member',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/fga/v1/query');
+            expect(result.data).toMatchObject([
+                {
+                    resourceType: 'role',
+                    resourceId: 'admin',
+                    warrant: {
+                        resourceType: 'role',
+                        resourceId: 'admin',
+                        relation: 'member',
+                        subject: {
+                            resourceType: 'user',
+                            resourceId: 'user_123',
+                        },
+                    },
+                    isImplicit: false,
+                },
+                {
+                    resourceType: 'role',
+                    resourceId: 'manager',
+                    warrant: {
+                        resourceType: 'role',
+                        resourceId: 'manager',
+                        relation: 'member',
+                        subject: {
+                            resourceType: 'user',
+                            resourceId: 'user_123',
+                        },
+                    },
+                    isImplicit: true,
+                },
+            ]);
+            expect(result.warnings).toMatchObject([
+                {
+                    code: 'missing_context_keys',
+                    message: 'Missing required context keys',
+                    keys: ['tenant_id'],
+                },
+                {
+                    code: 'some_other_warning',
+                    message: 'Some other warning message',
+                },
+            ]);
+        }));
         it('sends correct params and options', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)({
                 data: [

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

@@ -2,6 +2,7 @@ import { ResourceInterface, ResourceOptions } from './resource.interface';
 import { PolicyContext, SerializedSubject, Subject } from './warrant.interface';
 import { CheckOp } from './check-op.enum';
 import { PostOptions } from '../../common/interfaces';
+import { Warning } from './warning.interface';
 export interface CheckWarrantOptions {
     resource: ResourceInterface | ResourceOptions;
     relation: string;
@@ -39,6 +40,7 @@ export interface CheckResultResponse {
     is_implicit: boolean;
     warrant_token: string;
     debug_info?: DebugInfoResponse;
+    warnings?: Warning[];
 }
 export interface DebugInfo {
     processingTime: number;
@@ -67,12 +69,14 @@ export interface CheckResultInterface {
     isImplicit: boolean;
     warrantToken: string;
     debugInfo?: DebugInfo;
+    warnings?: Warning[];
 }
 export declare class CheckResult implements CheckResultInterface {
     result: string;
     isImplicit: boolean;
     warrantToken: string;
     debugInfo?: DebugInfo;
+    warnings?: Warning[];
     constructor(json: CheckResultResponse);
     isAuthorized(): boolean;
 }

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

@@ -14,6 +14,7 @@ class CheckResult {
                 decisionTree: (0, check_options_serializer_1.deserializeDecisionTreeNode)(json.debug_info.decision_tree),
             }
             : undefined;
+        this.warnings = json.warnings;
     }
     isAuthorized() {
         return this.result === CHECK_RESULT_AUTHORIZED;

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

@@ -0,0 +1,8 @@
+import { List, ListResponse } from '../../common/interfaces';
+import { Warning } from './warning.interface';
+export interface FGAListResponse<T> extends ListResponse<T> {
+    warnings?: Warning[];
+}
+export interface FGAList<T> extends List<T> {
+    warnings?: Warning[];
+}

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

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

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

@@ -0,0 +1,9 @@
+export interface BaseWarning {
+    code: string;
+    message: string;
+}
+export interface MissingContextKeysWarning extends BaseWarning {
+    code: 'missing_context_keys';
+    keys: string[];
+}
+export type Warning = BaseWarning | MissingContextKeysWarning;

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

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

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

@@ -10,3 +10,4 @@ export * from './resource.serializer';
 export * from './warrant-token.serializer';
 export * from './warrant.serializer';
 export * from './write-warrant-options.serializer';
+export * from './list.serializer';

package/lib/fga/serializers/index.js

@@ -26,3 +26,4 @@ __exportStar(require("./resource.serializer"), exports);
 __exportStar(require("./warrant-token.serializer"), exports);
 __exportStar(require("./warrant.serializer"), exports);
 __exportStar(require("./write-warrant-options.serializer"), exports);
+__exportStar(require("./list.serializer"), exports);

package/lib/fga/serializers/list.serializer.d.ts

@@ -0,0 +1,5 @@
+import { FGAList } from '../interfaces/list.interface';
+import { ListResponse } from '../../common/interfaces';
+export declare const deserializeFGAList: <T, U>(response: ListResponse<T> & {
+    warnings?: any[] | undefined;
+}, deserializeFn: (data: T) => U) => FGAList<U>;

package/lib/fga/serializers/list.serializer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeFGAList = void 0;
+const deserializeFGAList = (response, deserializeFn) => ({
+    object: 'list',
+    data: response.data.map(deserializeFn),
+    listMetadata: response.list_metadata,
+    warnings: response.warnings,
+});
+exports.deserializeFGAList = deserializeFGAList;

package/lib/fga/serializers/query-result.serializer.d.ts

@@ -1,2 +1,7 @@
 import { QueryResult, QueryResultResponse } from '../interfaces';
+import { Warning } from '../interfaces/warning.interface';
+import { ListResponse } from '../../common/interfaces';
+export interface QueryResultListResponse extends ListResponse<QueryResultResponse> {
+    warnings?: Warning[];
+}
 export declare const deserializeQueryResult: (queryResult: QueryResultResponse) => QueryResult;

package/lib/fga/utils/fetch-and-deserialize-list.d.ts

@@ -0,0 +1,5 @@
+import { WorkOS } from '../../workos';
+import { FGAList } from '../interfaces/list.interface';
+import { QueryRequestOptions } from '../interfaces';
+import { PaginationOptions } from '../../common/interfaces';
+export declare const fetchAndDeserializeFGAList: <T, U>(workos: WorkOS, endpoint: string, deserializeFn: (data: T) => U, options?: PaginationOptions, requestOptions?: QueryRequestOptions) => Promise<FGAList<U>>;

package/lib/fga/utils/fetch-and-deserialize-list.js

@@ -0,0 +1,18 @@
+"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.fetchAndDeserializeFGAList = void 0;
+const list_serializer_1 = require("../serializers/list.serializer");
+const fetchAndDeserializeFGAList = (workos, endpoint, deserializeFn, options, requestOptions) => __awaiter(void 0, void 0, void 0, function* () {
+    const { data: response } = yield workos.get(endpoint, Object.assign({ query: options }, requestOptions));
+    return (0, list_serializer_1.deserializeFGAList)(response, deserializeFn);
+});
+exports.fetchAndDeserializeFGAList = fetchAndDeserializeFGAList;

package/lib/fga/utils/fga-paginatable.d.ts

@@ -0,0 +1,9 @@
+import { AutoPaginatable } from '../../common/utils/pagination';
+import { FGAList } from '../interfaces/list.interface';
+import { Warning } from '../interfaces/warning.interface';
+import { PaginationOptions } from '../../common/interfaces';
+export declare class FgaPaginatable<T> extends AutoPaginatable<T> {
+    protected list: FGAList<T>;
+    constructor(list: FGAList<T>, apiCall: (params: PaginationOptions) => Promise<FGAList<T>>, options?: PaginationOptions);
+    get warnings(): Warning[] | undefined;
+}

package/lib/fga/utils/fga-paginatable.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FgaPaginatable = void 0;
+const pagination_1 = require("../../common/utils/pagination");
+class FgaPaginatable extends pagination_1.AutoPaginatable {
+    constructor(list, apiCall, options) {
+        super(list, apiCall, options);
+    }
+    get warnings() {
+        return this.list.warnings;
+    }
+}
+exports.FgaPaginatable = FgaPaginatable;

package/lib/user-management/interfaces/update-user-options.interface.d.ts

@@ -1,6 +1,7 @@
 import { PasswordHashType } from './password-hash-type.interface';
 export interface UpdateUserOptions {
     userId: string;
+    email?: string;
     firstName?: string;
     lastName?: string;
     emailVerified?: boolean;
@@ -11,6 +12,7 @@ export interface UpdateUserOptions {
     metadata?: Record<string, string | null>;
 }
 export interface SerializedUpdateUserOptions {
+    email?: string;
     first_name?: string;
     last_name?: string;
     email_verified?: boolean;

package/lib/user-management/serializers/update-user-options.serializer.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serializeUpdateUserOptions = void 0;
 const serializeUpdateUserOptions = (options) => ({
+    email: options.email,
+    email_verified: options.emailVerified,
     first_name: options.firstName,
     last_name: options.lastName,
-    email_verified: options.emailVerified,
     password: options.password,
     password_hash: options.passwordHash,
     password_hash_type: options.passwordHashType,

package/lib/workos.js

@@ -31,7 +31,7 @@ const widgets_1 = require("./widgets/widgets");
 const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
-const VERSION = '7.50.1';
+const VERSION = '7.51.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.50.1",
+  "version": "7.51.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",