@workos-inc/node 7.25.1 → 7.27.0

package/lib/fga/fga.d.ts

@@ -1,5 +1,5 @@
 import { WorkOS } from '../workos';
-import { Resource, CheckBatchOptions, CheckOptions, CheckRequestOptions, CheckResult, CreateResourceOptions, DeleteResourceOptions, ListResourcesOptions, ListWarrantsRequestOptions, ListWarrantsOptions, QueryOptions, QueryRequestOptions, QueryResult, ResourceInterface, ResourceOptions, UpdateResourceOptions, WriteWarrantOptions, Warrant, WarrantToken } from './interfaces';
+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';
 export declare class FGA {
     private readonly workos;
@@ -11,6 +11,7 @@ export declare class FGA {
     listResources(options?: ListResourcesOptions): Promise<AutoPaginatable<Resource>>;
     updateResource(options: UpdateResourceOptions): Promise<Resource>;
     deleteResource(resource: DeleteResourceOptions): Promise<void>;
+    batchWriteResources(options: BatchWriteResourcesOptions): Promise<Resource[]>;
     writeWarrant(options: WriteWarrantOptions): Promise<WarrantToken>;
     batchWriteWarrants(options: WriteWarrantOptions[]): Promise<WarrantToken>;
     listWarrants(options?: ListWarrantsOptions, requestOptions?: ListWarrantsRequestOptions): Promise<AutoPaginatable<Warrant>>;

package/lib/fga/fga.js

@@ -79,6 +79,12 @@ class FGA {
             yield this.workos.delete(`/fga/v1/resources/${resourceType}/${resourceId}`);
         });
     }
+    batchWriteResources(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/fga/v1/resources/batch', options);
+            return (0, serializers_1.deserializeBatchWriteResourcesResponse)(data);
+        });
+    }
     writeWarrant(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.workos.post('/fga/v1/warrants', (0, serializers_1.serializeWriteWarrantOptions)(options));

package/lib/fga/fga.spec.js

@@ -178,6 +178,132 @@ describe('FGA', () => {
             expect(response).toBeUndefined();
         }));
     });
+    describe('batchWriteResources', () => {
+        it('batch create resources', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({
+                data: [
+                    {
+                        resource_type: 'role',
+                        resource_id: 'admin',
+                        meta: {
+                            description: 'The admin role',
+                        },
+                    },
+                    {
+                        resource_type: 'role',
+                        resource_id: 'manager',
+                    },
+                    {
+                        resource_type: 'role',
+                        resource_id: 'employee',
+                    },
+                ],
+            });
+            const createdResources = yield workos.fga.batchWriteResources({
+                op: interfaces_1.ResourceOp.Create,
+                resources: [
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'admin',
+                        },
+                        meta: {
+                            description: 'The admin role',
+                        },
+                    },
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'manager',
+                        },
+                    },
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'employee',
+                        },
+                    },
+                ],
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/fga/v1/resources/batch');
+            expect(createdResources).toMatchObject([
+                {
+                    resourceType: 'role',
+                    resourceId: 'admin',
+                    meta: {
+                        description: 'The admin role',
+                    },
+                },
+                {
+                    resourceType: 'role',
+                    resourceId: 'manager',
+                },
+                {
+                    resourceType: 'role',
+                    resourceId: 'employee',
+                },
+            ]);
+        }));
+        it('batch delete resources', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({
+                data: [
+                    {
+                        resource_type: 'role',
+                        resource_id: 'admin',
+                    },
+                    {
+                        resource_type: 'role',
+                        resource_id: 'manager',
+                    },
+                    {
+                        resource_type: 'role',
+                        resource_id: 'employee',
+                    },
+                ],
+            });
+            const deletedResources = yield workos.fga.batchWriteResources({
+                op: interfaces_1.ResourceOp.Delete,
+                resources: [
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'admin',
+                        },
+                        meta: {
+                            description: 'The admin role',
+                        },
+                    },
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'manager',
+                        },
+                    },
+                    {
+                        resource: {
+                            resourceType: 'role',
+                            resourceId: 'employee',
+                        },
+                    },
+                ],
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/fga/v1/resources/batch');
+            expect(deletedResources).toMatchObject([
+                {
+                    resourceType: 'role',
+                    resourceId: 'admin',
+                },
+                {
+                    resourceType: 'role',
+                    resourceId: 'manager',
+                },
+                {
+                    resourceType: 'role',
+                    resourceId: 'employee',
+                },
+            ]);
+        }));
+    });
     describe('writeWarrant', () => {
         it('should create warrant with no op', () => __awaiter(void 0, void 0, void 0, function* () {
             (0, test_utils_1.fetchOnce)({

package/lib/fga/interfaces/check-op.enum.d.ts

@@ -1,5 +1,4 @@
 export declare enum CheckOp {
     AllOf = "all_of",
-    AnyOf = "any_of",
-    Batch = "batch"
+    AnyOf = "any_of"
 }

package/lib/fga/interfaces/check-op.enum.js

@@ -5,5 +5,4 @@ var CheckOp;
 (function (CheckOp) {
     CheckOp["AllOf"] = "all_of";
     CheckOp["AnyOf"] = "any_of";
-    CheckOp["Batch"] = "batch";
 })(CheckOp || (exports.CheckOp = CheckOp = {}));

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

@@ -29,6 +29,11 @@ export interface SerializedCheckOptions {
     checks: SerializedCheckWarrantOptions[];
     debug?: boolean;
 }
+export interface SerializedCheckBatchOptions {
+    op: 'batch';
+    checks: SerializedCheckWarrantOptions[];
+    debug?: boolean;
+}
 export interface CheckResultResponse {
     result: string;
     is_implicit: boolean;

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

@@ -1,6 +1,7 @@
 export * from './check-op.enum';
 export * from './check.interface';
 export * from './query.interface';
+export * from './resource-op.enum';
 export * from './resource.interface';
 export * from './warrant-op.enum';
 export * from './warrant-token.interface';

package/lib/fga/interfaces/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./check-op.enum"), exports);
 __exportStar(require("./check.interface"), exports);
 __exportStar(require("./query.interface"), exports);
+__exportStar(require("./resource-op.enum"), exports);
 __exportStar(require("./resource.interface"), exports);
 __exportStar(require("./warrant-op.enum"), exports);
 __exportStar(require("./warrant-token.interface"), exports);

package/lib/fga/interfaces/resource-op.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum ResourceOp {
+    Create = "create",
+    Delete = "delete"
+}

package/lib/fga/interfaces/resource-op.enum.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceOp = void 0;
+var ResourceOp;
+(function (ResourceOp) {
+    ResourceOp["Create"] = "create";
+    ResourceOp["Delete"] = "delete";
+})(ResourceOp || (exports.ResourceOp = ResourceOp = {}));

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

@@ -1,4 +1,5 @@
 import { PaginationOptions } from '../../common/interfaces/pagination-options.interface';
+import { ResourceOp } from './resource-op.enum';
 export interface ResourceInterface {
     getResourceType(): string;
     getResourceId(): string;
@@ -58,3 +59,10 @@ export interface ResourceResponse {
         [key: string]: any;
     };
 }
+export interface BatchWriteResourcesOptions {
+    op: ResourceOp;
+    resources: CreateResourceOptions[] | DeleteResourceOptions[];
+}
+export interface BatchWriteResourcesResponse {
+    data: ResourceResponse[];
+}

package/lib/fga/serializers/check-options.serializer.d.ts

@@ -1,4 +1,4 @@
-import { CheckBatchOptions, CheckOptions, DecisionTreeNode, DecisionTreeNodeResponse, SerializedCheckOptions } from '../interfaces';
+import { CheckBatchOptions, CheckOptions, DecisionTreeNode, DecisionTreeNodeResponse, SerializedCheckBatchOptions, SerializedCheckOptions } from '../interfaces';
 export declare const serializeCheckOptions: (options: CheckOptions) => SerializedCheckOptions;
-export declare const serializeCheckBatchOptions: (options: CheckBatchOptions) => SerializedCheckOptions;
+export declare const serializeCheckBatchOptions: (options: CheckBatchOptions) => SerializedCheckBatchOptions;
 export declare const deserializeDecisionTreeNode: (response: DecisionTreeNodeResponse) => DecisionTreeNode;

package/lib/fga/serializers/check-options.serializer.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeDecisionTreeNode = exports.serializeCheckBatchOptions = exports.serializeCheckOptions = void 0;
-const interfaces_1 = require("../interfaces");
 const interface_check_1 = require("../utils/interface-check");
 const serializeCheckOptions = (options) => ({
     op: options.op,
@@ -10,7 +9,7 @@ const serializeCheckOptions = (options) => ({
 });
 exports.serializeCheckOptions = serializeCheckOptions;
 const serializeCheckBatchOptions = (options) => ({
-    op: interfaces_1.CheckOp.Batch,
+    op: 'batch',
     checks: options.checks.map(serializeCheckWarrantOptions),
     debug: options.debug,
 });

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

@@ -1,2 +1,3 @@
-import { Resource, ResourceResponse } from '../interfaces';
+import { BatchWriteResourcesResponse, Resource, ResourceResponse } from '../interfaces';
 export declare const deserializeResource: (response: ResourceResponse) => Resource;
+export declare const deserializeBatchWriteResourcesResponse: (response: BatchWriteResourcesResponse) => Resource[];

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

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deserializeResource = void 0;
+exports.deserializeBatchWriteResourcesResponse = exports.deserializeResource = void 0;
 const deserializeResource = (response) => ({
     resourceType: response.resource_type,
     resourceId: response.resource_id,
     meta: response.meta,
 });
 exports.deserializeResource = deserializeResource;
+const deserializeBatchWriteResourcesResponse = (response) => {
+    return response.data.map((resource) => (0, exports.deserializeResource)(resource));
+};
+exports.deserializeBatchWriteResourcesResponse = deserializeBatchWriteResourcesResponse;

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

@@ -3,6 +3,7 @@ export interface AuthorizationURLOptions {
     codeChallenge?: string;
     codeChallengeMethod?: 'S256';
     connectionId?: string;
+    context?: string;
     organizationId?: string;
     domainHint?: string;
     loginHint?: string;

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

@@ -102,7 +102,7 @@ export declare class UserManagement {
     sendInvitation(payload: SendInvitationOptions): Promise<Invitation>;
     revokeInvitation(invitationId: string): Promise<Invitation>;
     revokeSession(payload: RevokeSessionOptions): Promise<void>;
-    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }: AuthorizationURLOptions): string;
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }: AuthorizationURLOptions): string;
     getLogoutUrl({ sessionId }: {
         sessionId: string;
     }): string;

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

@@ -498,7 +498,7 @@ class UserManagement {
             yield this.workos.post('/user_management/sessions/revoke', (0, revoke_session_options_interface_1.serializeRevokeSessionOptions)(payload));
         });
     }
-    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }) {
+    getAuthorizationUrl({ connectionId, codeChallenge, codeChallengeMethod, context, clientId, domainHint, loginHint, organizationId, provider, redirectUri, state, screenHint, }) {
         if (!provider && !connectionId && !organizationId) {
             throw new TypeError(`Incomplete arguments. Need to specify either a 'connectionId', 'organizationId', or 'provider'.`);
         }
@@ -509,6 +509,7 @@ class UserManagement {
             connection_id: connectionId,
             code_challenge: codeChallenge,
             code_challenge_method: codeChallengeMethod,
+            context,
             organization_id: organizationId,
             domain_hint: domainHint,
             login_hint: loginHint,

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.25.1';
+const VERSION = '7.27.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.25.1",
+  "version": "7.27.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",