@workos-inc/node 7.71.0 → 7.72.0

package/lib/api-keys/api-keys.d.ts

@@ -0,0 +1,7 @@
+import { WorkOS } from '../workos';
+import { ValidateApiKeyOptions, ValidateApiKeyResponse } from './interfaces/validate-api-key.interface';
+export declare class ApiKeys {
+    private readonly workos;
+    constructor(workos: WorkOS);
+    validateApiKey(payload: ValidateApiKeyOptions): Promise<ValidateApiKeyResponse>;
+}

package/lib/api-keys/api-keys.js

@@ -0,0 +1,25 @@
+"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.ApiKeys = void 0;
+const validate_api_key_serializer_1 = require("./serializers/validate-api-key.serializer");
+class ApiKeys {
+    constructor(workos) {
+        this.workos = workos;
+    }
+    validateApiKey(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.workos.post('/api_keys/validations', payload);
+            return (0, validate_api_key_serializer_1.deserializeValidateApiKeyResponse)(data);
+        });
+    }
+}
+exports.ApiKeys = ApiKeys;

package/lib/api-keys/api-keys.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/api-keys/api-keys.spec.js

@@ -0,0 +1,61 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jest_fetch_mock_1 = __importDefault(require("jest-fetch-mock"));
+const test_utils_1 = require("../common/utils/test-utils");
+const workos_1 = require("../workos");
+const validate_api_key_json_1 = __importDefault(require("./fixtures/validate-api-key.json"));
+describe('ApiKeys', () => {
+    let workos;
+    beforeAll(() => {
+        workos = new workos_1.WorkOS('sk_test_Sz3IQjepeSWaI4cMS4ms4sMuU', {
+            apiHostname: 'api.workos.test',
+            clientId: 'proj_123',
+        });
+    });
+    beforeEach(() => jest_fetch_mock_1.default.resetMocks());
+    describe('validateApiKey', () => {
+        it('sends a validate API key request', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)(validate_api_key_json_1.default);
+            const response = yield workos.apiKeys.validateApiKey({
+                value: 'sk_123',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/api_keys/validations');
+            expect(response).toEqual({
+                apiKey: {
+                    object: 'api_key',
+                    id: 'api_key_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                    owner: {
+                        type: 'organization',
+                        id: 'org_01H5JQDV7R7ATEYZDEG0W5PRYS',
+                    },
+                    name: 'Test Api Key',
+                    obfuscatedValue: 'sk_…PRYS',
+                    lastUsedAt: null,
+                    permissions: ['read', 'write'],
+                    createdAt: '2023-07-18T02:07:19.911Z',
+                    updatedAt: '2023-07-18T02:07:19.911Z',
+                },
+            });
+        }));
+        it('returns null if key is invalid', () => __awaiter(void 0, void 0, void 0, function* () {
+            (0, test_utils_1.fetchOnce)({ api_key: null });
+            const response = yield workos.apiKeys.validateApiKey({
+                value: 'invalid',
+            });
+            expect((0, test_utils_1.fetchURL)()).toContain('/api_keys/validations');
+            expect(response).toEqual({ apiKey: null });
+        }));
+    });
+});

package/lib/api-keys/fixtures/validate-api-key.json

@@ -0,0 +1,16 @@
+{
+    "api_key": {
+        "object": "api_key",
+        "id": "api_key_01H5JQDV7R7ATEYZDEG0W5PRYS",
+        "owner": {
+            "type": "organization",
+            "id": "org_01H5JQDV7R7ATEYZDEG0W5PRYS"
+        },
+        "name": "Test Api Key",
+        "obfuscated_value": "sk_…PRYS",
+        "last_used_at": null,
+        "permissions": ["read", "write"],
+        "created_at": "2023-07-18T02:07:19.911Z",
+        "updated_at": "2023-07-18T02:07:19.911Z"
+    }
+}

package/lib/api-keys/interfaces/api-key.interface.d.ts

@@ -0,0 +1,28 @@
+export interface ApiKey {
+    object: 'api_key';
+    id: string;
+    owner: {
+        type: 'organization';
+        id: string;
+    };
+    name: string;
+    obfuscatedValue: string;
+    lastUsedAt: string | null;
+    permissions: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SerializedApiKey {
+    object: 'api_key';
+    id: string;
+    owner: {
+        type: 'organization';
+        id: string;
+    };
+    name: string;
+    obfuscated_value: string;
+    last_used_at: string | null;
+    permissions: string[];
+    created_at: string;
+    updated_at: string;
+}

package/lib/api-keys/interfaces/api-key.interface.js

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

package/lib/api-keys/interfaces/validate-api-key.interface.d.ts

@@ -0,0 +1,10 @@
+import { ApiKey, SerializedApiKey } from './api-key.interface';
+export interface ValidateApiKeyOptions {
+    value: string;
+}
+export interface ValidateApiKeyResponse {
+    apiKey: ApiKey | null;
+}
+export interface SerializedValidateApiKeyResponse {
+    api_key: SerializedApiKey | null;
+}

package/lib/api-keys/interfaces/validate-api-key.interface.js

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

package/lib/api-keys/serializers/api-key.serializer.d.ts

@@ -0,0 +1,2 @@
+import { ApiKey, SerializedApiKey } from '../interfaces/api-key.interface';
+export declare function deserializeApiKey(apiKey: SerializedApiKey): ApiKey;

package/lib/api-keys/serializers/api-key.serializer.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeApiKey = void 0;
+function deserializeApiKey(apiKey) {
+    return {
+        object: apiKey.object,
+        id: apiKey.id,
+        owner: apiKey.owner,
+        name: apiKey.name,
+        obfuscatedValue: apiKey.obfuscated_value,
+        lastUsedAt: apiKey.last_used_at,
+        permissions: apiKey.permissions,
+        createdAt: apiKey.created_at,
+        updatedAt: apiKey.updated_at,
+    };
+}
+exports.deserializeApiKey = deserializeApiKey;

package/lib/api-keys/serializers/validate-api-key.serializer.d.ts

@@ -0,0 +1,2 @@
+import { SerializedValidateApiKeyResponse, ValidateApiKeyResponse } from '../interfaces/validate-api-key.interface';
+export declare function deserializeValidateApiKeyResponse(response: SerializedValidateApiKeyResponse): ValidateApiKeyResponse;

package/lib/api-keys/serializers/validate-api-key.serializer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeValidateApiKeyResponse = void 0;
+const api_key_serializer_1 = require("./api-key.serializer");
+function deserializeValidateApiKeyResponse(response) {
+    return {
+        apiKey: response.api_key ? (0, api_key_serializer_1.deserializeApiKey)(response.api_key) : null,
+    };
+}
+exports.deserializeValidateApiKeyResponse = deserializeValidateApiKeyResponse;

package/lib/workos.d.ts

@@ -1,4 +1,5 @@
 import { GetOptions, PostOptions, PutOptions, WorkOSOptions } from './common/interfaces';
+import { ApiKeys } from './api-keys/api-keys';
 import { DirectorySync } from './directory-sync/directory-sync';
 import { Events } from './events/events';
 import { Organizations } from './organizations/organizations';
@@ -24,6 +25,7 @@ export declare class WorkOS {
     readonly client: HttpClient;
     readonly clientId?: string;
     readonly actions: Actions;
+    readonly apiKeys: ApiKeys;
     readonly auditLogs: AuditLogs;
     readonly directorySync: DirectorySync;
     readonly organizations: Organizations;

package/lib/workos.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkOS = void 0;
 const exceptions_1 = require("./common/exceptions");
+const api_keys_1 = require("./api-keys/api-keys");
 const directory_sync_1 = require("./directory-sync/directory-sync");
 const events_1 = require("./events/events");
 const organizations_1 = require("./organizations/organizations");
@@ -32,7 +33,7 @@ const actions_1 = require("./actions/actions");
 const vault_1 = require("./vault/vault");
 const conflict_exception_1 = require("./common/exceptions/conflict.exception");
 const parse_error_1 = require("./common/exceptions/parse-error");
-const VERSION = '7.71.0';
+const VERSION = '7.72.0';
 const DEFAULT_HOSTNAME = 'api.workos.com';
 const HEADER_AUTHORIZATION = 'Authorization';
 const HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
@@ -41,6 +42,7 @@ class WorkOS {
     constructor(key, options = {}) {
         this.key = key;
         this.options = options;
+        this.apiKeys = new api_keys_1.ApiKeys(this);
         this.auditLogs = new audit_logs_1.AuditLogs(this);
         this.directorySync = new directory_sync_1.DirectorySync(this);
         this.organizations = new organizations_1.Organizations(this);

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "7.71.0",
+  "version": "7.72.0",
   "name": "@workos-inc/node",
   "author": "WorkOS",
   "description": "A Node wrapper for the WorkOS API",
@@ -65,6 +65,10 @@
       "import": "./lib/index.worker.js",
       "default": "./lib/index.worker.js"
     },
+    "convex": {
+      "import": "./lib/index.worker.js",
+      "default": "./lib/index.worker.js"
+    },
     "default": {
       "import": "./lib/index.js",
       "default": "./lib/index.js"