@workos-inc/node 7.28.0 → 7.29.0

package/lib/audit-logs/audit-logs.d.ts

@@ -2,10 +2,12 @@ import { WorkOS } from '../workos';
 import { CreateAuditLogEventOptions, CreateAuditLogEventRequestOptions } from './interfaces';
 import { AuditLogExportOptions } from './interfaces/audit-log-export-options.interface';
 import { AuditLogExport } from './interfaces/audit-log-export.interface';
+import { AuditLogSchema, CreateAuditLogSchemaOptions, CreateAuditLogSchemaRequestOptions } from './interfaces/create-audit-log-schema-options.interface';
 export declare class AuditLogs {
     private readonly workos;
     constructor(workos: WorkOS);
     createEvent(organization: string, event: CreateAuditLogEventOptions, options?: CreateAuditLogEventRequestOptions): Promise<void>;
     createExport(options: AuditLogExportOptions): Promise<AuditLogExport>;
     getExport(auditLogExportId: string): Promise<AuditLogExport>;
+    createSchema(schema: CreateAuditLogSchemaOptions, options?: CreateAuditLogSchemaRequestOptions): Promise<AuditLogSchema>;
 }

package/lib/audit-logs/audit-logs.js

@@ -35,5 +35,11 @@ class AuditLogs {
             return (0, serializers_1.deserializeAuditLogExport)(data);
         });
     }
+    createSchema(schema, options = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post(`/audit_logs/actions/${schema.action}/schemas`, (0, serializers_1.serializeCreateAuditLogSchemaOptions)(schema), options);
+            return (0, serializers_1.deserializeAuditLogSchema)(data);
+        });
+    }
 }
 exports.AuditLogs = AuditLogs;

package/lib/audit-logs/audit-logs.spec.js

@@ -41,6 +41,26 @@ const event = {
         successful: true,
     },
 };
+const schema = {
+    action: 'user.logged_in',
+    actor: {
+        metadata: {
+            actor_id: 'string',
+        },
+    },
+    targets: [
+        {
+            type: 'user',
+            metadata: {
+                user_id: 'string',
+            },
+        },
+    ],
+    metadata: {
+        foo: 'number',
+        baz: 'boolean',
+    },
+};
 describe('AuditLogs', () => {
     beforeEach(() => jest_fetch_mock_1.default.resetMocks());
     describe('createEvent', () => {
@@ -234,4 +254,172 @@ describe('AuditLogs', () => {
             }));
         });
     });
+    describe('createSchema', () => {
+        describe('with an idempotency key', () => {
+            it('includes an idempotency key with request', () => __awaiter(void 0, void 0, void 0, function* () {
+                const workosSpy = jest.spyOn(workos_1.WorkOS.prototype, 'post');
+                const time = new Date().toISOString();
+                const createSchemaResult = {
+                    object: 'audit_log_schema',
+                    version: 1,
+                    targets: [
+                        {
+                            type: 'user',
+                            metadata: {
+                                user_id: 'string',
+                            },
+                        },
+                    ],
+                    actor: {
+                        metadata: {
+                            actor_id: 'string',
+                        },
+                    },
+                    metadata: {
+                        foo: 'number',
+                        baz: 'boolean',
+                    },
+                    createdAt: time,
+                };
+                const createSchemaResponse = {
+                    object: 'audit_log_schema',
+                    version: 1,
+                    targets: [
+                        {
+                            type: 'user',
+                            metadata: {
+                                type: 'object',
+                                properties: {
+                                    user_id: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    actor: {
+                        metadata: {
+                            type: 'object',
+                            properties: {
+                                actor_id: {
+                                    type: 'string',
+                                },
+                            },
+                        },
+                    },
+                    metadata: {
+                        type: 'object',
+                        properties: {
+                            foo: {
+                                type: 'number',
+                            },
+                            baz: {
+                                type: 'boolean',
+                            },
+                        },
+                    },
+                    created_at: time,
+                };
+                workosSpy.mockResolvedValueOnce((0, workos_mock_response_1.mockWorkOsResponse)(201, createSchemaResponse));
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createSchema(schema, {
+                    idempotencyKey: 'the-idempotency-key',
+                })).resolves.toEqual(createSchemaResult);
+                expect(workosSpy).toHaveBeenCalledWith('/audit_logs/actions/user.logged_in/schemas', (0, serializers_1.serializeCreateAuditLogSchemaOptions)(schema), { idempotencyKey: 'the-idempotency-key' });
+            }));
+        });
+        describe('when the api responds with a 201', () => {
+            it('returns `audit_log_schema`', () => __awaiter(void 0, void 0, void 0, function* () {
+                const workosSpy = jest.spyOn(workos_1.WorkOS.prototype, 'post');
+                const time = new Date().toISOString();
+                const createSchemaResult = {
+                    object: 'audit_log_schema',
+                    version: 1,
+                    targets: [
+                        {
+                            type: 'user',
+                            metadata: {
+                                user_id: 'string',
+                            },
+                        },
+                    ],
+                    actor: {
+                        metadata: {
+                            actor_id: 'string',
+                        },
+                    },
+                    metadata: {
+                        foo: 'number',
+                        baz: 'boolean',
+                    },
+                    createdAt: time,
+                };
+                const createSchemaResponse = {
+                    object: 'audit_log_schema',
+                    version: 1,
+                    targets: [
+                        {
+                            type: 'user',
+                            metadata: {
+                                type: 'object',
+                                properties: {
+                                    user_id: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    ],
+                    actor: {
+                        metadata: {
+                            type: 'object',
+                            properties: {
+                                actor_id: {
+                                    type: 'string',
+                                },
+                            },
+                        },
+                    },
+                    metadata: {
+                        type: 'object',
+                        properties: {
+                            foo: {
+                                type: 'number',
+                            },
+                            baz: {
+                                type: 'boolean',
+                            },
+                        },
+                    },
+                    created_at: time,
+                };
+                workosSpy.mockResolvedValueOnce((0, workos_mock_response_1.mockWorkOsResponse)(201, createSchemaResponse));
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createSchema(schema, {
+                    idempotencyKey: 'the-idempotency-key',
+                })).resolves.toEqual(createSchemaResult);
+            }));
+        });
+        describe('when the api responds with a 400', () => {
+            it('throws a BadRequestException', () => __awaiter(void 0, void 0, void 0, function* () {
+                const workosSpy = jest.spyOn(workos_1.WorkOS.prototype, 'post');
+                const errors = [
+                    {
+                        field: 'actor.metadata',
+                        code: 'actor.metadata must be an object',
+                    },
+                ];
+                workosSpy.mockImplementationOnce(() => {
+                    throw new bad_request_exception_1.BadRequestException({
+                        code: '400',
+                        errors,
+                        message: 'Audit Log Schema could not be processed due to missing or incorrect data.',
+                        requestID: 'a-request-id',
+                    });
+                });
+                const workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU');
+                yield expect(workos.auditLogs.createSchema(schema)).rejects.toThrow(bad_request_exception_1.BadRequestException);
+            }));
+        });
+    });
 });

package/lib/audit-logs/interfaces/create-audit-log-schema-options.interface.d.ts

@@ -0,0 +1,63 @@
+import { PostOptions } from '../../common/interfaces';
+export type AuditLogSchemaMetadata = Record<string, {
+    type: 'string' | 'boolean' | 'number';
+}> | undefined;
+export interface AuditLogSchema {
+    object: 'audit_log_schema';
+    version: number;
+    targets: AuditLogTargetSchema[];
+    actor: AuditLogActorSchema;
+    metadata: Record<string, string | boolean | number> | undefined;
+    createdAt: string;
+}
+export interface AuditLogActorSchema {
+    metadata: Record<string, string | boolean | number>;
+}
+export interface AuditLogTargetSchema {
+    type: string;
+    metadata?: Record<string, string | boolean | number> | undefined;
+}
+export interface CreateAuditLogSchemaOptions {
+    action: string;
+    targets: AuditLogTargetSchema[];
+    actor?: AuditLogActorSchema;
+    metadata?: Record<string, string | boolean | number>;
+}
+interface SerializedAuditLogTargetSchema {
+    type: string;
+    metadata?: {
+        type: 'object';
+        properties: AuditLogSchemaMetadata;
+    };
+}
+export interface SerializedCreateAuditLogSchemaOptions {
+    targets: SerializedAuditLogTargetSchema[];
+    actor?: {
+        metadata: {
+            type: 'object';
+            properties: AuditLogSchemaMetadata;
+        };
+    };
+    metadata?: {
+        type: 'object';
+        properties: AuditLogSchemaMetadata;
+    };
+}
+export interface CreateAuditLogSchemaResponse {
+    object: 'audit_log_schema';
+    version: number;
+    targets: SerializedAuditLogTargetSchema[];
+    actor: {
+        metadata: {
+            type: 'object';
+            properties: AuditLogSchemaMetadata;
+        };
+    };
+    metadata: {
+        type: 'object';
+        properties: AuditLogSchemaMetadata;
+    };
+    created_at: string;
+}
+export type CreateAuditLogSchemaRequestOptions = Pick<PostOptions, 'idempotencyKey'>;
+export {};

package/lib/audit-logs/interfaces/create-audit-log-schema-options.interface.js

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

package/lib/audit-logs/interfaces/index.d.ts

@@ -1,3 +1,4 @@
 export * from './audit-log-export-options.interface';
 export * from './audit-log-export.interface';
 export * from './create-audit-log-event-options.interface';
+export * from './create-audit-log-schema-options.interface';

package/lib/audit-logs/interfaces/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./audit-log-export-options.interface"), exports);
 __exportStar(require("./audit-log-export.interface"), exports);
 __exportStar(require("./create-audit-log-event-options.interface"), exports);
+__exportStar(require("./create-audit-log-schema-options.interface"), exports);

package/lib/audit-logs/serializers/create-audit-log-schema-options.serializer.d.ts

@@ -0,0 +1,2 @@
+import { CreateAuditLogSchemaOptions, SerializedCreateAuditLogSchemaOptions } from '../interfaces';
+export declare const serializeCreateAuditLogSchemaOptions: (schema: CreateAuditLogSchemaOptions) => SerializedCreateAuditLogSchemaOptions;

package/lib/audit-logs/serializers/create-audit-log-schema-options.serializer.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeCreateAuditLogSchemaOptions = void 0;
+function serializeMetadata(metadata) {
+    if (!metadata) {
+        return {};
+    }
+    const serializedMetadata = {};
+    Object.keys(metadata).forEach((key) => {
+        serializedMetadata[key] = {
+            type: metadata[key],
+        };
+    });
+    return serializedMetadata;
+}
+const serializeCreateAuditLogSchemaOptions = (schema) => {
+    var _a;
+    return ({
+        actor: {
+            metadata: {
+                type: 'object',
+                properties: serializeMetadata((_a = schema.actor) === null || _a === void 0 ? void 0 : _a.metadata),
+            },
+        },
+        targets: schema.targets.map((target) => {
+            return {
+                type: target.type,
+                metadata: target.metadata
+                    ? {
+                        type: 'object',
+                        properties: serializeMetadata(target.metadata),
+                    }
+                    : undefined,
+            };
+        }),
+        metadata: {
+            type: 'object',
+            properties: serializeMetadata(schema.metadata),
+        },
+    });
+};
+exports.serializeCreateAuditLogSchemaOptions = serializeCreateAuditLogSchemaOptions;

package/lib/audit-logs/serializers/create-audit-log-schema.serializer.d.ts

@@ -0,0 +1,2 @@
+import { AuditLogSchema, CreateAuditLogSchemaResponse } from '../interfaces';
+export declare const deserializeAuditLogSchema: (auditLogSchema: CreateAuditLogSchemaResponse) => AuditLogSchema;

package/lib/audit-logs/serializers/create-audit-log-schema.serializer.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeAuditLogSchema = void 0;
+function deserializeMetadata(metadata) {
+    if (!metadata || !metadata.properties) {
+        return {};
+    }
+    const deserializedMetadata = {};
+    Object.keys(metadata.properties).forEach((key) => {
+        if (metadata.properties) {
+            deserializedMetadata[key] = metadata.properties[key].type;
+        }
+    });
+    return deserializedMetadata;
+}
+const deserializeAuditLogSchema = (auditLogSchema) => {
+    var _a;
+    return ({
+        object: auditLogSchema.object,
+        version: auditLogSchema.version,
+        targets: auditLogSchema.targets.map((target) => {
+            return {
+                type: target.type,
+                metadata: target.metadata
+                    ? deserializeMetadata(target.metadata)
+                    : undefined,
+            };
+        }),
+        actor: {
+            metadata: deserializeMetadata((_a = auditLogSchema.actor) === null || _a === void 0 ? void 0 : _a.metadata),
+        },
+        metadata: deserializeMetadata(auditLogSchema.metadata),
+        createdAt: auditLogSchema.created_at,
+    });
+};
+exports.deserializeAuditLogSchema = deserializeAuditLogSchema;

package/lib/audit-logs/serializers/index.d.ts

@@ -1,3 +1,5 @@
 export * from './audit-log-export.serializer';
 export * from './audit-log-export-options.serializer';
 export * from './create-audit-log-event-options.serializer';
+export * from './create-audit-log-schema-options.serializer';
+export * from './create-audit-log-schema.serializer';

package/lib/audit-logs/serializers/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./audit-log-export.serializer"), exports);
 __exportStar(require("./audit-log-export-options.serializer"), exports);
 __exportStar(require("./create-audit-log-event-options.serializer"), exports);
+__exportStar(require("./create-audit-log-schema-options.serializer"), exports);
+__exportStar(require("./create-audit-log-schema.serializer"), exports);

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