workos 0.13.3 → 0.14.0

package/dist/commands/api/catalog.d.ts

@@ -0,0 +1,23 @@
+export interface Param {
+    name: string;
+    description: string;
+    required: boolean;
+}
+export interface EndpointInfo {
+    method: string;
+    path: string;
+    summary: string;
+    tag: string;
+    operationId: string;
+    pathParams: Param[];
+    queryParams: Param[];
+    hasRequestBody: boolean;
+    requestBodyRequired: boolean;
+}
+export interface Catalog {
+    endpoints: EndpointInfo[];
+    tags: string[];
+}
+export declare function parseSpec(yamlText: string): Catalog;
+export declare function loadCatalog(): Promise<Catalog>;
+export declare function endpointsByTag(endpoints: EndpointInfo[]): Map<string, EndpointInfo[]>;

package/dist/commands/api/catalog.js

@@ -0,0 +1,97 @@
+import { parse as parseYaml } from 'yaml';
+import { createRequire } from 'node:module';
+import { readFile } from 'node:fs/promises';
+const HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete'];
+/**
+ * Resolve an OpenAPI 3.x parameter object that may itself be a $ref pointing
+ * into components.parameters. Returns undefined if the ref can't be resolved
+ * (so the parameter is skipped instead of producing a {param} placeholder
+ * that leaks into request URLs).
+ */
+function resolveParam(param, componentParams) {
+    if (!param || typeof param !== 'object')
+        return undefined;
+    if (typeof param.$ref === 'string') {
+        const match = /^#\/components\/parameters\/(.+)$/.exec(param.$ref);
+        if (!match)
+            return undefined;
+        const target = componentParams[match[1]];
+        if (!target)
+            return undefined;
+        // Recurse so a chain of $refs still resolves to a concrete definition.
+        return resolveParam(target, componentParams);
+    }
+    return param;
+}
+export function parseSpec(yamlText) {
+    const spec = parseYaml(yamlText);
+    const endpoints = [];
+    const componentParams = spec.components?.parameters ?? {};
+    for (const [path, pathItem] of Object.entries(spec.paths ?? {})) {
+        const pathObj = pathItem;
+        for (const method of HTTP_METHODS) {
+            const operation = pathObj[method];
+            if (!operation || typeof operation !== 'object')
+                continue;
+            const op = operation;
+            const tag = (op.tags ?? ['other'])[0] ?? 'other';
+            // Resolve $ref and merge path-level + operation-level params.
+            // Operation-level params override path-level ones with the same (name, in)
+            // pair, per the OpenAPI 3.x spec.
+            const rawPathLevel = pathObj.parameters ?? [];
+            const rawOpLevel = op.parameters ?? [];
+            const merged = new Map();
+            for (const raw of [...rawPathLevel, ...rawOpLevel]) {
+                const resolved = resolveParam(raw, componentParams);
+                if (!resolved || !resolved.name || !resolved.in)
+                    continue;
+                merged.set(`${resolved.in}:${resolved.name}`, resolved);
+            }
+            const allParams = [...merged.values()];
+            const pathParams = allParams
+                .filter((p) => p.in === 'path')
+                .map((p) => ({ name: p.name, description: p.description ?? '', required: p.required ?? true }));
+            const queryParams = allParams
+                .filter((p) => p.in === 'query')
+                .map((p) => ({ name: p.name, description: p.description ?? '', required: p.required ?? false }));
+            const reqBody = op.requestBody;
+            endpoints.push({
+                method: method.toUpperCase(),
+                path,
+                summary: op.summary ?? '',
+                tag,
+                operationId: op.operationId ?? '',
+                pathParams,
+                queryParams,
+                hasRequestBody: !!reqBody,
+                requestBodyRequired: !!reqBody?.required,
+            });
+        }
+    }
+    const tags = [...new Set(endpoints.map((e) => e.tag))].sort();
+    return { endpoints, tags };
+}
+let cachedCatalog;
+export function loadCatalog() {
+    // Cache the in-flight Promise (not just the resolved value) so concurrent
+    // callers reuse the same readFile/parse pass — see request.ts callers.
+    if (cachedCatalog)
+        return cachedCatalog;
+    cachedCatalog = (async () => {
+        const require = createRequire(import.meta.url);
+        const specPath = require.resolve('@workos/openapi-spec/spec');
+        const yamlText = await readFile(specPath, 'utf-8');
+        return parseSpec(yamlText);
+    })();
+    return cachedCatalog;
+}
+export function endpointsByTag(endpoints) {
+    const grouped = new Map();
+    for (const ep of endpoints) {
+        const list = grouped.get(ep.tag) ?? [];
+        list.push(ep);
+        grouped.set(ep.tag, list);
+    }
+    return grouped;
+}
+//# sourceMappingURL=catalog.js.map

package/dist/commands/api/catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../../src/commands/api/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAyB5C,MAAM,YAAY,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAU,CAAC;AAUxE;;;;;GAKG;AACH,SAAS,YAAY,CAAC,KAAe,EAAE,eAAyC;IAC9E,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC1D,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnC,MAAM,KAAK,GAAG,mCAAmC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACnE,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QAC9B,uEAAuE;QACvE,OAAO,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,QAAgB;IACxC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAG9B,CAAC;IACF,MAAM,SAAS,GAAmB,EAAE,CAAC;IACrC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,EAAE,UAAU,IAAI,EAAE,CAAC;IAE1D,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QAChE,MAAM,OAAO,GAAG,QAAmC,CAAC;QAEpD,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE,CAAC;YAClC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAClC,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ;gBAAE,SAAS;YAE1D,MAAM,EAAE,GAAG,SAAoC,CAAC;YAChD,MAAM,GAAG,GAAG,CAAE,EAAE,CAAC,IAAiB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC;YAE/D,8DAA8D;YAC9D,2EAA2E;YAC3E,kCAAkC;YAClC,MAAM,YAAY,GAAI,OAAO,CAAC,UAAqC,IAAI,EAAE,CAAC;YAC1E,MAAM,UAAU,GAAI,EAAE,CAAC,UAAqC,IAAI,EAAE,CAAC;YACnE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAC;YAC3C,KAAK,MAAM,GAAG,IAAI,CAAC,GAAG,YAAY,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC;gBACnD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;gBACpD,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;oBAAE,SAAS;gBAC1D,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,SAAS,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;YAEvC,MAAM,UAAU,GAAY,SAAS;iBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC;iBAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAK,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;YAEnG,MAAM,WAAW,GAAY,SAAS;iBACnC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC;iBAC/B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAK,EAAE,WAAW,EAAE,CAAC,CAAC,WAAW,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;YAEpG,MAAM,OAAO,GAAG,EAAE,CAAC,WAAkD,CAAC;YACtE,SAAS,CAAC,IAAI,CAAC;gBACb,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;gBAC5B,IAAI;gBACJ,OAAO,EAAG,EAAE,CAAC,OAAkB,IAAI,EAAE;gBACrC,GAAG;gBACH,WAAW,EAAG,EAAE,CAAC,WAAsB,IAAI,EAAE;gBAC7C,UAAU;gBACV,WAAW;gBACX,cAAc,EAAE,CAAC,CAAC,OAAO;gBACzB,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,QAAQ;aACzC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,IAAI,aAA2C,CAAC;AAEhD,MAAM,UAAU,WAAW;IACzB,0EAA0E;IAC1E,uEAAuE;IACvE,IAAI,aAAa;QAAE,OAAO,aAAa,CAAC;IAExC,aAAa,GAAG,CAAC,KAAK,IAAI,EAAE;QAC1B,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC,CAAC,EAAE,CAAC;IAEL,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,SAAyB;IACtD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;IAClD,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACd,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC","sourcesContent":["import { parse as parseYaml } from 'yaml';\nimport { createRequire } from 'node:module';\nimport { readFile } from 'node:fs/promises';\n\nexport interface Param {\n  name: string;\n  description: string;\n  required: boolean;\n}\n\nexport interface EndpointInfo {\n  method: string;\n  path: string;\n  summary: string;\n  tag: string;\n  operationId: string;\n  pathParams: Param[];\n  queryParams: Param[];\n  hasRequestBody: boolean;\n  requestBodyRequired: boolean;\n}\n\nexport interface Catalog {\n  endpoints: EndpointInfo[];\n  tags: string[];\n}\n\nconst HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete'] as const;\n\ninterface RawParam {\n  name?: string;\n  in?: string;\n  description?: string;\n  required?: boolean;\n  $ref?: string;\n}\n\n/**\n * Resolve an OpenAPI 3.x parameter object that may itself be a $ref pointing\n * into components.parameters. Returns undefined if the ref can't be resolved\n * (so the parameter is skipped instead of producing a {param} placeholder\n * that leaks into request URLs).\n */\nfunction resolveParam(param: RawParam, componentParams: Record<string, RawParam>): RawParam | undefined {\n  if (!param || typeof param !== 'object') return undefined;\n  if (typeof param.$ref === 'string') {\n    const match = /^#\\/components\\/parameters\\/(.+)$/.exec(param.$ref);\n    if (!match) return undefined;\n    const target = componentParams[match[1]!];\n    if (!target) return undefined;\n    // Recurse so a chain of $refs still resolves to a concrete definition.\n    return resolveParam(target, componentParams);\n  }\n  return param;\n}\n\nexport function parseSpec(yamlText: string): Catalog {\n  const spec = parseYaml(yamlText) as {\n    paths?: Record<string, unknown>;\n    components?: { parameters?: Record<string, RawParam> };\n  };\n  const endpoints: EndpointInfo[] = [];\n  const componentParams = spec.components?.parameters ?? {};\n\n  for (const [path, pathItem] of Object.entries(spec.paths ?? {})) {\n    const pathObj = pathItem as Record<string, unknown>;\n\n    for (const method of HTTP_METHODS) {\n      const operation = pathObj[method];\n      if (!operation || typeof operation !== 'object') continue;\n\n      const op = operation as Record<string, unknown>;\n      const tag = ((op.tags as string[]) ?? ['other'])[0] ?? 'other';\n\n      // Resolve $ref and merge path-level + operation-level params.\n      // Operation-level params override path-level ones with the same (name, in)\n      // pair, per the OpenAPI 3.x spec.\n      const rawPathLevel = (pathObj.parameters as RawParam[] | undefined) ?? [];\n      const rawOpLevel = (op.parameters as RawParam[] | undefined) ?? [];\n      const merged = new Map<string, RawParam>();\n      for (const raw of [...rawPathLevel, ...rawOpLevel]) {\n        const resolved = resolveParam(raw, componentParams);\n        if (!resolved || !resolved.name || !resolved.in) continue;\n        merged.set(`${resolved.in}:${resolved.name}`, resolved);\n      }\n      const allParams = [...merged.values()];\n\n      const pathParams: Param[] = allParams\n        .filter((p) => p.in === 'path')\n        .map((p) => ({ name: p.name!, description: p.description ?? '', required: p.required ?? true }));\n\n      const queryParams: Param[] = allParams\n        .filter((p) => p.in === 'query')\n        .map((p) => ({ name: p.name!, description: p.description ?? '', required: p.required ?? false }));\n\n      const reqBody = op.requestBody as Record<string, unknown> | undefined;\n      endpoints.push({\n        method: method.toUpperCase(),\n        path,\n        summary: (op.summary as string) ?? '',\n        tag,\n        operationId: (op.operationId as string) ?? '',\n        pathParams,\n        queryParams,\n        hasRequestBody: !!reqBody,\n        requestBodyRequired: !!reqBody?.required,\n      });\n    }\n  }\n\n  const tags = [...new Set(endpoints.map((e) => e.tag))].sort();\n  return { endpoints, tags };\n}\n\nlet cachedCatalog: Promise<Catalog> | undefined;\n\nexport function loadCatalog(): Promise<Catalog> {\n  // Cache the in-flight Promise (not just the resolved value) so concurrent\n  // callers reuse the same readFile/parse pass — see request.ts callers.\n  if (cachedCatalog) return cachedCatalog;\n\n  cachedCatalog = (async () => {\n    const require = createRequire(import.meta.url);\n    const specPath = require.resolve('@workos/openapi-spec/spec');\n    const yamlText = await readFile(specPath, 'utf-8');\n    return parseSpec(yamlText);\n  })();\n\n  return cachedCatalog;\n}\n\nexport function endpointsByTag(endpoints: EndpointInfo[]): Map<string, EndpointInfo[]> {\n  const grouped = new Map<string, EndpointInfo[]>();\n  for (const ep of endpoints) {\n    const list = grouped.get(ep.tag) ?? [];\n    list.push(ep);\n    grouped.set(ep.tag, list);\n  }\n  return grouped;\n}\n"]}

package/dist/commands/api/format.d.ts

@@ -0,0 +1,5 @@
+import type { ApiResponse } from './request.js';
+export declare function colorMethod(method: string): string;
+export declare function printResponse(response: ApiResponse, { includeStatus }?: {
+    includeStatus?: boolean;
+}): void;

package/dist/commands/api/format.js

@@ -0,0 +1,46 @@
+import chalk from 'chalk';
+import { isJsonMode, outputJson } from '../../utils/output.js';
+export function colorMethod(method) {
+    switch (method) {
+        case 'GET':
+            return chalk.green(method);
+        case 'POST':
+            return chalk.blue(method);
+        case 'PUT':
+        case 'PATCH':
+            return chalk.yellow(method);
+        case 'DELETE':
+            return chalk.red(method);
+        default:
+            return method;
+    }
+}
+export function printResponse(response, { includeStatus = false } = {}) {
+    if (isJsonMode()) {
+        if (includeStatus) {
+            const headers = {};
+            response.headers.forEach((value, key) => {
+                headers[key] = value;
+            });
+            outputJson({ status: response.status, headers, body: response.body });
+        }
+        else {
+            outputJson(response.body);
+        }
+        return;
+    }
+    if (includeStatus) {
+        console.log(chalk.dim(`HTTP ${response.status}`));
+        response.headers.forEach((value, key) => {
+            console.log(chalk.dim(`${key}: ${value}`));
+        });
+        console.log();
+    }
+    if (typeof response.body === 'object' && response.body !== null) {
+        console.log(JSON.stringify(response.body, null, 2));
+    }
+    else {
+        console.log(response.rawBody);
+    }
+}
+//# sourceMappingURL=format.js.map

package/dist/commands/api/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/commands/api/format.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAG/D,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,KAAK;YACR,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,KAAK,MAAM;YACT,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,KAAK,KAAK,CAAC;QACX,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC9B,KAAK,QAAQ;YACX,OAAO,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3B;YACE,OAAO,MAAM,CAAC;IAClB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,QAAqB,EACrB,EAAE,aAAa,GAAG,KAAK,KAAkC,EAAE;IAE3D,IAAI,UAAU,EAAE,EAAE,CAAC;QACjB,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBACtC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACvB,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QACxE,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACtC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAChE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;AACH,CAAC","sourcesContent":["import chalk from 'chalk';\nimport { isJsonMode, outputJson } from '../../utils/output.js';\nimport type { ApiResponse } from './request.js';\n\nexport function colorMethod(method: string): string {\n  switch (method) {\n    case 'GET':\n      return chalk.green(method);\n    case 'POST':\n      return chalk.blue(method);\n    case 'PUT':\n    case 'PATCH':\n      return chalk.yellow(method);\n    case 'DELETE':\n      return chalk.red(method);\n    default:\n      return method;\n  }\n}\n\nexport function printResponse(\n  response: ApiResponse,\n  { includeStatus = false }: { includeStatus?: boolean } = {},\n): void {\n  if (isJsonMode()) {\n    if (includeStatus) {\n      const headers: Record<string, string> = {};\n      response.headers.forEach((value, key) => {\n        headers[key] = value;\n      });\n      outputJson({ status: response.status, headers, body: response.body });\n    } else {\n      outputJson(response.body);\n    }\n    return;\n  }\n\n  if (includeStatus) {\n    console.log(chalk.dim(`HTTP ${response.status}`));\n    response.headers.forEach((value, key) => {\n      console.log(chalk.dim(`${key}: ${value}`));\n    });\n    console.log();\n  }\n\n  if (typeof response.body === 'object' && response.body !== null) {\n    console.log(JSON.stringify(response.body, null, 2));\n  } else {\n    console.log(response.rawBody);\n  }\n}\n"]}

package/dist/commands/api/index.d.ts

@@ -0,0 +1,15 @@
+export { colorMethod } from './format.js';
+export interface ApiCommandOptions {
+    method?: string;
+    data?: string;
+    file?: string;
+    include?: boolean;
+    apiKey?: string;
+    dryRun?: boolean;
+    yes?: boolean;
+}
+export declare function runApiInteractive(options?: {
+    apiKey?: string;
+}): Promise<void>;
+export declare function runApiLs(filter?: string): Promise<void>;
+export declare function runApiRequest(endpoint: string, options: ApiCommandOptions): Promise<void>;

package/dist/commands/api/index.js

@@ -0,0 +1,200 @@
+import chalk from 'chalk';
+import { readFile } from 'node:fs/promises';
+import { loadCatalog, endpointsByTag } from './catalog.js';
+import { apiRequest } from './request.js';
+import { resolveApiBaseUrl } from '../../lib/api-key.js';
+import { exitWithError, isJsonMode, outputJson } from '../../utils/output.js';
+import { isCiMode, isPromptAllowed } from '../../utils/interaction-mode.js';
+import { confirmationRecovery } from '../../utils/recovery-hints.js';
+import { formatWorkOSCommandArgs } from '../../utils/command-invocation.js';
+import { colorMethod, printResponse } from './format.js';
+export { colorMethod } from './format.js';
+const MUTATING_METHODS = new Set(['POST', 'PUT', 'PATCH', 'DELETE']);
+export async function runApiInteractive(options) {
+    // Interactive mode is inherently human-oriented (clack prompts, preview text,
+    // etc.). Refuse to enter it whenever JSON output was requested, regardless of
+    // TTY status, so stdout stays machine-readable.
+    if (isJsonMode()) {
+        exitWithError({
+            code: 'tty_required',
+            message: 'Interactive mode is not available with --json. Provide an endpoint or use `workos api ls`.',
+            details: {
+                usage: ['workos api <endpoint>', 'workos api ls [filter]'],
+            },
+        });
+    }
+    if (!isPromptAllowed()) {
+        exitWithError({
+            code: 'tty_required',
+            message: 'Interactive API mode requires human mode. Usage: workos api <endpoint> or workos api ls [filter]. Example: workos api /user_management/users',
+        });
+    }
+    const { apiInteractive } = await import('./interactive.js');
+    await apiInteractive({ apiKey: options?.apiKey });
+}
+export async function runApiLs(filter) {
+    const catalog = await loadCatalog();
+    let endpoints = catalog.endpoints;
+    if (filter) {
+        const lower = filter.toLowerCase();
+        endpoints = endpoints.filter((e) => e.path.toLowerCase().includes(lower) ||
+            e.tag.toLowerCase().includes(lower) ||
+            e.summary.toLowerCase().includes(lower) ||
+            e.operationId.toLowerCase().includes(lower));
+    }
+    if (isJsonMode()) {
+        outputJson({
+            data: endpoints.map((e) => ({
+                method: e.method,
+                path: e.path,
+                summary: e.summary,
+                tag: e.tag,
+            })),
+        });
+        return;
+    }
+    if (endpoints.length === 0) {
+        console.log(filter ? `No endpoints matching "${filter}".` : 'No endpoints found.');
+        return;
+    }
+    const grouped = endpointsByTag(endpoints);
+    for (const [tag, eps] of grouped) {
+        console.log(`\n${chalk.bold(tag)}`);
+        for (const ep of eps) {
+            const method = colorMethod(ep.method).padEnd(18);
+            console.log(`  ${method} ${ep.path}  ${chalk.dim(ep.summary)}`);
+        }
+    }
+    console.log();
+}
+export async function runApiRequest(endpoint, options) {
+    const body = await resolveBody(options);
+    const hasBody = body !== undefined;
+    const method = (options.method ?? (hasBody ? 'POST' : 'GET')).toUpperCase();
+    const baseUrl = resolveApiBaseUrl();
+    if (options.dryRun) {
+        if (isJsonMode()) {
+            let parsedBody;
+            if (hasBody) {
+                try {
+                    parsedBody = JSON.parse(body);
+                }
+                catch {
+                    exitWithError({ code: 'invalid_json_body', message: 'Request body is not valid JSON.' });
+                }
+            }
+            outputJson({
+                dryRun: true,
+                method,
+                url: `${baseUrl}${normalizePath(endpoint)}`,
+                body: parsedBody,
+            });
+        }
+        else {
+            console.log(`${chalk.dim('[dry-run]')} ${method} ${baseUrl}${normalizePath(endpoint)}`);
+            if (hasBody)
+                prettyPrint(body);
+        }
+        return;
+    }
+    if (MUTATING_METHODS.has(method) && !options.yes) {
+        const confirmCommand = buildConfirmationCommand(endpoint, method, options);
+        if (!isPromptAllowed()) {
+            exitWithError({
+                code: 'confirmation_required',
+                message: isCiMode()
+                    ? `Mutating requests in CI mode require --yes. Refusing to ${method} ${endpoint}.`
+                    : `Mutating requests in agent mode require --yes. Refusing to ${method} ${endpoint}.`,
+                recovery: confirmationRecovery(confirmCommand),
+            });
+        }
+        if (isJsonMode()) {
+            exitWithError({
+                code: 'confirmation_required',
+                message: 'Mutating requests in JSON mode require --yes to keep stdout machine-readable.',
+                recovery: confirmationRecovery(confirmCommand),
+            });
+        }
+        const clack = (await import('../../utils/clack.js')).default;
+        console.log(`\n${chalk.yellow('About to')} ${method} ${endpoint}`);
+        if (hasBody)
+            prettyPrint(body);
+        const ok = await clack.confirm({ message: 'Proceed?' });
+        if (!ok || clack.isCancel(ok)) {
+            process.exit(0);
+        }
+    }
+    const response = await apiRequest({
+        method,
+        path: normalizePath(endpoint),
+        apiKey: options.apiKey,
+        body,
+        baseUrl,
+    });
+    printResponse(response, { includeStatus: options.include });
+    if (response.status >= 400) {
+        process.exit(1);
+    }
+}
+function normalizePath(path) {
+    if (!path.startsWith('/'))
+        return `/${path}`;
+    return path;
+}
+function buildConfirmationCommand(endpoint, method, options) {
+    if (options.apiKey || options.file === '-') {
+        return undefined;
+    }
+    const args = ['api', endpoint, '--method', method];
+    if (options.data !== undefined) {
+        args.push(`--data=${options.data}`);
+    }
+    if (options.file) {
+        args.push(`--file=${options.file}`);
+    }
+    if (options.include) {
+        args.push('--include');
+    }
+    args.push('--yes');
+    return formatWorkOSCommandArgs(args);
+}
+async function resolveBody(options) {
+    if (options.data !== undefined)
+        return options.data;
+    if (options.file) {
+        if (options.file === '-') {
+            const chunks = [];
+            for await (const chunk of process.stdin) {
+                chunks.push(chunk);
+            }
+            const stdinBody = Buffer.concat(chunks).toString('utf-8');
+            if (stdinBody.length === 0) {
+                exitWithError({
+                    code: 'empty_stdin_body',
+                    message: 'Reading request body from stdin (--file -) yielded no data. Pipe data into the command or pass --data instead.',
+                });
+            }
+            return stdinBody;
+        }
+        try {
+            return await readFile(options.file, 'utf-8');
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : String(err);
+            exitWithError({
+                code: 'file_read_error',
+                message: `Could not read request body file "${options.file}": ${message}`,
+            });
+        }
+    }
+    return undefined;
+}
+function prettyPrint(jsonString) {
+    try {
+        console.log(JSON.stringify(JSON.parse(jsonString), null, 2));
+    }
+    catch {
+        console.log(jsonString);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/commands/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAY1C,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;AAErE,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAA6B;IACnE,8EAA8E;IAC9E,8EAA8E;IAC9E,gDAAgD;IAChD,IAAI,UAAU,EAAE,EAAE,CAAC;QACjB,aAAa,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,OAAO,EAAE,4FAA4F;YACrG,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC,uBAAuB,EAAE,wBAAwB,CAAC;aAC3D;SACF,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;QACvB,aAAa,CAAC;YACZ,IAAI,EAAE,cAAc;YACpB,OAAO,EACL,8IAA8I;SACjJ,CAAC,CAAC;IACL,CAAC;IAED,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC5D,MAAM,cAAc,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,MAAe;IAC5C,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;IACpC,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACnC,SAAS,GAAG,SAAS,CAAC,MAAM,CAC1B,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;YACpC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;YACnC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;YACvC,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAC9C,CAAC;IACJ,CAAC;IAED,IAAI,UAAU,EAAE,EAAE,CAAC;QACjB,UAAU,CAAC;YACT,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,OAAO,EAAE,CAAC,CAAC,OAAO;gBAClB,GAAG,EAAE,CAAC,CAAC,GAAG;aACX,CAAC,CAAC;SACJ,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,0BAA0B,MAAM,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;QACnF,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,EAAE,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACpC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,MAAM,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACjD,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IACD,OAAO,CAAC,GAAG,EAAE,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,QAAgB,EAAE,OAA0B;IAC9E,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC;IACnC,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5E,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;IAEpC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,IAAI,UAAU,EAAE,EAAE,CAAC;YACjB,IAAI,UAAmB,CAAC;YACxB,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC;oBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAChC,CAAC;gBAAC,MAAM,CAAC;oBACP,aAAa,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,iCAAiC,EAAE,CAAC,CAAC;gBAC3F,CAAC;YACH,CAAC;YACD,UAAU,CAAC;gBACT,MAAM,EAAE,IAAI;gBACZ,MAAM;gBACN,GAAG,EAAE,GAAG,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,EAAE;gBAC3C,IAAI,EAAE,UAAU;aACjB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,MAAM,IAAI,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACxF,IAAI,OAAO;gBAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QACjD,MAAM,cAAc,GAAG,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAC3E,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YACvB,aAAa,CAAC;gBACZ,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EAAE,QAAQ,EAAE;oBACjB,CAAC,CAAC,2DAA2D,MAAM,IAAI,QAAQ,GAAG;oBAClF,CAAC,CAAC,8DAA8D,MAAM,IAAI,QAAQ,GAAG;gBACvF,QAAQ,EAAE,oBAAoB,CAAC,cAAc,CAAC;aAC/C,CAAC,CAAC;QACL,CAAC;QACD,IAAI,UAAU,EAAE,EAAE,CAAC;YACjB,aAAa,CAAC;gBACZ,IAAI,EAAE,uBAAuB;gBAC7B,OAAO,EAAE,+EAA+E;gBACxF,QAAQ,EAAE,oBAAoB,CAAC,cAAc,CAAC;aAC/C,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAAC,OAAO,CAAC;QAC7D,OAAO,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;QACnE,IAAI,OAAO;YAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,EAAE,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;YAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC;QAChC,MAAM;QACN,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC;QAC7B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,IAAI;QACJ,OAAO;KACR,CAAC,CAAC;IAEH,aAAa,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAE5D,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,IAAI,EAAE,CAAC;IAC7C,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAgB,EAAE,MAAc,EAAE,OAA0B;IAC5F,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;IACnD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,IAAI,CAAC,IAAI,CAAC,UAAU,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnB,OAAO,uBAAuB,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,OAA0B;IACnD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,OAAO,CAAC,IAAI,CAAC;IACpD,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,IAAI,OAAO,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YACzB,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBACxC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;YACD,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC1D,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3B,aAAa,CAAC;oBACZ,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EACL,gHAAgH;iBACnH,CAAC,CAAC;YACL,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,GAAY,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACjE,aAAa,CAAC;gBACZ,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,qCAAqC,OAAO,CAAC,IAAI,MAAM,OAAO,EAAE;aAC1E,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,WAAW,CAAC,UAAkB;IACrC,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC","sourcesContent":["import chalk from 'chalk';\nimport { readFile } from 'node:fs/promises';\nimport { loadCatalog, endpointsByTag } from './catalog.js';\nimport { apiRequest } from './request.js';\nimport { resolveApiBaseUrl } from '../../lib/api-key.js';\nimport { exitWithError, isJsonMode, outputJson } from '../../utils/output.js';\nimport { isCiMode, isPromptAllowed } from '../../utils/interaction-mode.js';\nimport { confirmationRecovery } from '../../utils/recovery-hints.js';\nimport { formatWorkOSCommandArgs } from '../../utils/command-invocation.js';\nimport { colorMethod, printResponse } from './format.js';\n\nexport { colorMethod } from './format.js';\n\nexport interface ApiCommandOptions {\n  method?: string;\n  data?: string;\n  file?: string;\n  include?: boolean;\n  apiKey?: string;\n  dryRun?: boolean;\n  yes?: boolean;\n}\n\nconst MUTATING_METHODS = new Set(['POST', 'PUT', 'PATCH', 'DELETE']);\n\nexport async function runApiInteractive(options?: { apiKey?: string }): Promise<void> {\n  // Interactive mode is inherently human-oriented (clack prompts, preview text,\n  // etc.). Refuse to enter it whenever JSON output was requested, regardless of\n  // TTY status, so stdout stays machine-readable.\n  if (isJsonMode()) {\n    exitWithError({\n      code: 'tty_required',\n      message: 'Interactive mode is not available with --json. Provide an endpoint or use `workos api ls`.',\n      details: {\n        usage: ['workos api <endpoint>', 'workos api ls [filter]'],\n      },\n    });\n  }\n\n  if (!isPromptAllowed()) {\n    exitWithError({\n      code: 'tty_required',\n      message:\n        'Interactive API mode requires human mode. Usage: workos api <endpoint> or workos api ls [filter]. Example: workos api /user_management/users',\n    });\n  }\n\n  const { apiInteractive } = await import('./interactive.js');\n  await apiInteractive({ apiKey: options?.apiKey });\n}\n\nexport async function runApiLs(filter?: string): Promise<void> {\n  const catalog = await loadCatalog();\n  let endpoints = catalog.endpoints;\n\n  if (filter) {\n    const lower = filter.toLowerCase();\n    endpoints = endpoints.filter(\n      (e) =>\n        e.path.toLowerCase().includes(lower) ||\n        e.tag.toLowerCase().includes(lower) ||\n        e.summary.toLowerCase().includes(lower) ||\n        e.operationId.toLowerCase().includes(lower),\n    );\n  }\n\n  if (isJsonMode()) {\n    outputJson({\n      data: endpoints.map((e) => ({\n        method: e.method,\n        path: e.path,\n        summary: e.summary,\n        tag: e.tag,\n      })),\n    });\n    return;\n  }\n\n  if (endpoints.length === 0) {\n    console.log(filter ? `No endpoints matching \"${filter}\".` : 'No endpoints found.');\n    return;\n  }\n\n  const grouped = endpointsByTag(endpoints);\n\n  for (const [tag, eps] of grouped) {\n    console.log(`\\n${chalk.bold(tag)}`);\n    for (const ep of eps) {\n      const method = colorMethod(ep.method).padEnd(18);\n      console.log(`  ${method} ${ep.path}  ${chalk.dim(ep.summary)}`);\n    }\n  }\n  console.log();\n}\n\nexport async function runApiRequest(endpoint: string, options: ApiCommandOptions): Promise<void> {\n  const body = await resolveBody(options);\n  const hasBody = body !== undefined;\n  const method = (options.method ?? (hasBody ? 'POST' : 'GET')).toUpperCase();\n  const baseUrl = resolveApiBaseUrl();\n\n  if (options.dryRun) {\n    if (isJsonMode()) {\n      let parsedBody: unknown;\n      if (hasBody) {\n        try {\n          parsedBody = JSON.parse(body);\n        } catch {\n          exitWithError({ code: 'invalid_json_body', message: 'Request body is not valid JSON.' });\n        }\n      }\n      outputJson({\n        dryRun: true,\n        method,\n        url: `${baseUrl}${normalizePath(endpoint)}`,\n        body: parsedBody,\n      });\n    } else {\n      console.log(`${chalk.dim('[dry-run]')} ${method} ${baseUrl}${normalizePath(endpoint)}`);\n      if (hasBody) prettyPrint(body);\n    }\n    return;\n  }\n\n  if (MUTATING_METHODS.has(method) && !options.yes) {\n    const confirmCommand = buildConfirmationCommand(endpoint, method, options);\n    if (!isPromptAllowed()) {\n      exitWithError({\n        code: 'confirmation_required',\n        message: isCiMode()\n          ? `Mutating requests in CI mode require --yes. Refusing to ${method} ${endpoint}.`\n          : `Mutating requests in agent mode require --yes. Refusing to ${method} ${endpoint}.`,\n        recovery: confirmationRecovery(confirmCommand),\n      });\n    }\n    if (isJsonMode()) {\n      exitWithError({\n        code: 'confirmation_required',\n        message: 'Mutating requests in JSON mode require --yes to keep stdout machine-readable.',\n        recovery: confirmationRecovery(confirmCommand),\n      });\n    }\n    const clack = (await import('../../utils/clack.js')).default;\n    console.log(`\\n${chalk.yellow('About to')} ${method} ${endpoint}`);\n    if (hasBody) prettyPrint(body);\n    const ok = await clack.confirm({ message: 'Proceed?' });\n    if (!ok || clack.isCancel(ok)) {\n      process.exit(0);\n    }\n  }\n\n  const response = await apiRequest({\n    method,\n    path: normalizePath(endpoint),\n    apiKey: options.apiKey,\n    body,\n    baseUrl,\n  });\n\n  printResponse(response, { includeStatus: options.include });\n\n  if (response.status >= 400) {\n    process.exit(1);\n  }\n}\n\nfunction normalizePath(path: string): string {\n  if (!path.startsWith('/')) return `/${path}`;\n  return path;\n}\n\nfunction buildConfirmationCommand(endpoint: string, method: string, options: ApiCommandOptions): string | undefined {\n  if (options.apiKey || options.file === '-') {\n    return undefined;\n  }\n\n  const args = ['api', endpoint, '--method', method];\n  if (options.data !== undefined) {\n    args.push(`--data=${options.data}`);\n  }\n  if (options.file) {\n    args.push(`--file=${options.file}`);\n  }\n  if (options.include) {\n    args.push('--include');\n  }\n  args.push('--yes');\n  return formatWorkOSCommandArgs(args);\n}\n\nasync function resolveBody(options: ApiCommandOptions): Promise<string | undefined> {\n  if (options.data !== undefined) return options.data;\n  if (options.file) {\n    if (options.file === '-') {\n      const chunks: Buffer[] = [];\n      for await (const chunk of process.stdin) {\n        chunks.push(chunk);\n      }\n      const stdinBody = Buffer.concat(chunks).toString('utf-8');\n      if (stdinBody.length === 0) {\n        exitWithError({\n          code: 'empty_stdin_body',\n          message:\n            'Reading request body from stdin (--file -) yielded no data. Pipe data into the command or pass --data instead.',\n        });\n      }\n      return stdinBody;\n    }\n    try {\n      return await readFile(options.file, 'utf-8');\n    } catch (err: unknown) {\n      const message = err instanceof Error ? err.message : String(err);\n      exitWithError({\n        code: 'file_read_error',\n        message: `Could not read request body file \"${options.file}\": ${message}`,\n      });\n    }\n  }\n  return undefined;\n}\n\nfunction prettyPrint(jsonString: string): void {\n  try {\n    console.log(JSON.stringify(JSON.parse(jsonString), null, 2));\n  } catch {\n    console.log(jsonString);\n  }\n}\n"]}

package/dist/commands/api/interactive.d.ts

@@ -0,0 +1,3 @@
+export declare function apiInteractive(options?: {
+    apiKey?: string;
+}): Promise<void>;

package/dist/commands/api/interactive.js

@@ -0,0 +1,127 @@
+import clack from '../../utils/clack.js';
+import { loadCatalog, endpointsByTag } from './catalog.js';
+import { apiRequest } from './request.js';
+import { colorMethod, printResponse } from './format.js';
+import { resolveApiKey, resolveApiBaseUrl } from '../../lib/api-key.js';
+function assertNotCancelled(value) {
+    if (clack.isCancel(value))
+        process.exit(0);
+    return value;
+}
+export async function apiInteractive(options) {
+    const catalog = await loadCatalog();
+    const grouped = endpointsByTag(catalog.endpoints);
+    const tag = assertNotCancelled(await clack.select({
+        message: 'Select a category:',
+        options: catalog.tags.map((t) => {
+            const count = grouped.get(t)?.length ?? 0;
+            return { value: t, label: `${t} (${count})` };
+        }),
+    }));
+    const endpoints = grouped.get(tag);
+    const ep = assertNotCancelled(await clack.select({
+        message: 'Select an endpoint:',
+        options: endpoints.map((e) => ({
+            value: e,
+            label: `${colorMethod(e.method).padEnd(18)} ${e.path}`,
+            hint: e.summary,
+        })),
+    }));
+    let resolvedPath = ep.path;
+    for (const param of ep.pathParams) {
+        const value = assertNotCancelled(await clack.text({
+            message: `${param.name}:`,
+            placeholder: param.description || undefined,
+            validate: (v) => {
+                if (!v?.trim())
+                    return `${param.name} is required`;
+            },
+        }));
+        resolvedPath = resolvedPath.replaceAll(`{${param.name}}`, encodeURIComponent(value.trim()));
+    }
+    let queryString = '';
+    if (ep.queryParams.length > 0) {
+        const requiredParams = ep.queryParams.filter((qp) => qp.required);
+        const optionalParams = ep.queryParams.filter((qp) => !qp.required);
+        const params = [];
+        for (const qp of requiredParams) {
+            const value = assertNotCancelled(await clack.text({
+                message: `${qp.name} (required):`,
+                placeholder: qp.description || undefined,
+                validate: (v) => {
+                    if (!v?.trim())
+                        return `${qp.name} is required`;
+                },
+            }));
+            params.push(`${encodeURIComponent(qp.name)}=${encodeURIComponent(value.trim())}`);
+        }
+        if (optionalParams.length > 0) {
+            const wantsOptional = assertNotCancelled(await clack.confirm({
+                message: `Add optional query parameters? (${optionalParams.length} available)`,
+                initialValue: false,
+            }));
+            if (wantsOptional) {
+                for (const qp of optionalParams) {
+                    const value = assertNotCancelled(await clack.text({
+                        message: `${qp.name}:`,
+                        placeholder: qp.description || undefined,
+                    }));
+                    const trimmed = value.trim();
+                    if (trimmed) {
+                        params.push(`${encodeURIComponent(qp.name)}=${encodeURIComponent(trimmed)}`);
+                    }
+                }
+            }
+        }
+        if (params.length > 0) {
+            queryString = `?${params.join('&')}`;
+        }
+    }
+    let body;
+    if (ep.hasRequestBody) {
+        let collectBody = ep.requestBodyRequired;
+        if (!collectBody) {
+            collectBody = assertNotCancelled(await clack.confirm({
+                message: 'Provide a request body?',
+                initialValue: ep.method === 'POST' || ep.method === 'PUT',
+            }));
+        }
+        if (collectBody) {
+            body = assertNotCancelled(await clack.text({
+                message: 'Request body (JSON):',
+                placeholder: '{"key": "value"}',
+                validate: (v) => {
+                    if (!v?.trim())
+                        return 'Body cannot be empty';
+                    try {
+                        JSON.parse(v);
+                    }
+                    catch {
+                        return 'Invalid JSON';
+                    }
+                },
+            })).trim();
+        }
+    }
+    const fullPath = `${resolvedPath}${queryString}`;
+    console.log(`\n  ${colorMethod(ep.method)}  ${fullPath}`);
+    if (body) {
+        console.log(JSON.stringify(JSON.parse(body), null, 2));
+    }
+    console.log();
+    const ok = assertNotCancelled(await clack.confirm({ message: 'Execute this request?' }));
+    if (!ok)
+        process.exit(0);
+    const response = await apiRequest({
+        method: ep.method,
+        path: fullPath,
+        apiKey: options?.apiKey ?? resolveApiKey(),
+        baseUrl: resolveApiBaseUrl(),
+        body,
+    });
+    printResponse(response, { includeStatus: true });
+    if (response.status >= 400) {
+        process.exit(1);
+    }
+}
+//# sourceMappingURL=interactive.js.map

package/dist/commands/api/interactive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interactive.js","sourceRoot":"","sources":["../../../src/commands/api/interactive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAqB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAExE,SAAS,kBAAkB,CAAI,KAAiB;IAC9C,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,OAAO,KAAU,CAAC;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAA6B;IAChE,MAAM,OAAO,GAAG,MAAM,WAAW,EAAE,CAAC;IACpC,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAElD,MAAM,GAAG,GAAG,kBAAkB,CAC5B,MAAM,KAAK,CAAC,MAAM,CAAC;QACjB,OAAO,EAAE,oBAAoB;QAC7B,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC;YAC1C,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC;QAChD,CAAC,CAAC;KACH,CAAC,CACH,CAAC;IAEF,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;IACpC,MAAM,EAAE,GAAG,kBAAkB,CAC3B,MAAM,KAAK,CAAC,MAAM,CAAe;QAC/B,OAAO,EAAE,qBAAqB;QAC9B,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAC7B,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE;YACtD,IAAI,EAAE,CAAC,CAAC,OAAO;SAChB,CAAC,CAAC;KACJ,CAAC,CACH,CAAC;IAEF,IAAI,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,kBAAkB,CAC9B,MAAM,KAAK,CAAC,IAAI,CAAC;YACf,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,GAAG;YACzB,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,SAAS;YAC3C,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;gBACd,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE;oBAAE,OAAO,GAAG,KAAK,CAAC,IAAI,cAAc,CAAC;YACrD,CAAC;SACF,CAAC,CACH,CAAC;QACF,YAAY,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,IAAI,GAAG,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,cAAc,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QAClE,MAAM,cAAc,GAAG,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;QACnE,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,kBAAkB,CAC9B,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,cAAc;gBACjC,WAAW,EAAE,EAAE,CAAC,WAAW,IAAI,SAAS;gBACxC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE;wBAAE,OAAO,GAAG,EAAE,CAAC,IAAI,cAAc,CAAC;gBAClD,CAAC;aACF,CAAC,CACH,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QACpF,CAAC;QAED,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,aAAa,GAAG,kBAAkB,CACtC,MAAM,KAAK,CAAC,OAAO,CAAC;gBAClB,OAAO,EAAE,mCAAmC,cAAc,CAAC,MAAM,aAAa;gBAC9E,YAAY,EAAE,KAAK;aACpB,CAAC,CACH,CAAC;YAEF,IAAI,aAAa,EAAE,CAAC;gBAClB,KAAK,MAAM,EAAE,IAAI,cAAc,EAAE,CAAC;oBAChC,MAAM,KAAK,GAAG,kBAAkB,CAC9B,MAAM,KAAK,CAAC,IAAI,CAAC;wBACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG;wBACtB,WAAW,EAAE,EAAE,CAAC,WAAW,IAAI,SAAS;qBACzC,CAAC,CACH,CAAC;oBACF,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;oBAC7B,IAAI,OAAO,EAAE,CAAC;wBACZ,MAAM,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBAC/E,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,WAAW,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACvC,CAAC;IACH,CAAC;IAED,IAAI,IAAwB,CAAC;IAC7B,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC;QACtB,IAAI,WAAW,GAAG,EAAE,CAAC,mBAAmB,CAAC;QACzC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,kBAAkB,CAC9B,MAAM,KAAK,CAAC,OAAO,CAAC;gBAClB,OAAO,EAAE,yBAAyB;gBAClC,YAAY,EAAE,EAAE,CAAC,MAAM,KAAK,MAAM,IAAI,EAAE,CAAC,MAAM,KAAK,KAAK;aAC1D,CAAC,CACH,CAAC;QACJ,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,GAAG,kBAAkB,CACvB,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,OAAO,EAAE,sBAAsB;gBAC/B,WAAW,EAAE,kBAAkB;gBAC/B,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE;oBACd,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE;wBAAE,OAAO,sBAAsB,CAAC;oBAC9C,IAAI,CAAC;wBACH,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAChB,CAAC;oBAAC,MAAM,CAAC;wBACP,OAAO,cAAc,CAAC;oBACxB,CAAC;gBACH,CAAC;aACF,CAAC,CACH,CAAC,IAAI,EAAE,CAAC;QACX,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,GAAG,YAAY,GAAG,WAAW,EAAE,CAAC;IAEjD,OAAO,CAAC,GAAG,CAAC,OAAO,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC;IAC1D,IAAI,IAAI,EAAE,CAAC;QACT,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,CAAC,GAAG,EAAE,CAAC;IAEd,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC;IACzF,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAEzB,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC;QAChC,MAAM,EAAE,EAAE,CAAC,MAAM;QACjB,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE;QAC1C,OAAO,EAAE,iBAAiB,EAAE;QAC5B,IAAI;KACL,CAAC,CAAC;IAEH,aAAa,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC","sourcesContent":["import clack from '../../utils/clack.js';\nimport { loadCatalog, endpointsByTag, type EndpointInfo } from './catalog.js';\nimport { apiRequest } from './request.js';\nimport { colorMethod, printResponse } from './format.js';\nimport { resolveApiKey, resolveApiBaseUrl } from '../../lib/api-key.js';\n\nfunction assertNotCancelled<T>(value: T | symbol): T {\n  if (clack.isCancel(value)) process.exit(0);\n  return value as T;\n}\n\nexport async function apiInteractive(options?: { apiKey?: string }): Promise<void> {\n  const catalog = await loadCatalog();\n  const grouped = endpointsByTag(catalog.endpoints);\n\n  const tag = assertNotCancelled(\n    await clack.select({\n      message: 'Select a category:',\n      options: catalog.tags.map((t) => {\n        const count = grouped.get(t)?.length ?? 0;\n        return { value: t, label: `${t} (${count})` };\n      }),\n    }),\n  );\n\n  const endpoints = grouped.get(tag)!;\n  const ep = assertNotCancelled(\n    await clack.select<EndpointInfo>({\n      message: 'Select an endpoint:',\n      options: endpoints.map((e) => ({\n        value: e,\n        label: `${colorMethod(e.method).padEnd(18)} ${e.path}`,\n        hint: e.summary,\n      })),\n    }),\n  );\n\n  let resolvedPath = ep.path;\n  for (const param of ep.pathParams) {\n    const value = assertNotCancelled(\n      await clack.text({\n        message: `${param.name}:`,\n        placeholder: param.description || undefined,\n        validate: (v) => {\n          if (!v?.trim()) return `${param.name} is required`;\n        },\n      }),\n    );\n    resolvedPath = resolvedPath.replaceAll(`{${param.name}}`, encodeURIComponent(value.trim()));\n  }\n\n  let queryString = '';\n  if (ep.queryParams.length > 0) {\n    const requiredParams = ep.queryParams.filter((qp) => qp.required);\n    const optionalParams = ep.queryParams.filter((qp) => !qp.required);\n    const params: string[] = [];\n\n    for (const qp of requiredParams) {\n      const value = assertNotCancelled(\n        await clack.text({\n          message: `${qp.name} (required):`,\n          placeholder: qp.description || undefined,\n          validate: (v) => {\n            if (!v?.trim()) return `${qp.name} is required`;\n          },\n        }),\n      );\n      params.push(`${encodeURIComponent(qp.name)}=${encodeURIComponent(value.trim())}`);\n    }\n\n    if (optionalParams.length > 0) {\n      const wantsOptional = assertNotCancelled(\n        await clack.confirm({\n          message: `Add optional query parameters? (${optionalParams.length} available)`,\n          initialValue: false,\n        }),\n      );\n\n      if (wantsOptional) {\n        for (const qp of optionalParams) {\n          const value = assertNotCancelled(\n            await clack.text({\n              message: `${qp.name}:`,\n              placeholder: qp.description || undefined,\n            }),\n          );\n          const trimmed = value.trim();\n          if (trimmed) {\n            params.push(`${encodeURIComponent(qp.name)}=${encodeURIComponent(trimmed)}`);\n          }\n        }\n      }\n    }\n\n    if (params.length > 0) {\n      queryString = `?${params.join('&')}`;\n    }\n  }\n\n  let body: string | undefined;\n  if (ep.hasRequestBody) {\n    let collectBody = ep.requestBodyRequired;\n    if (!collectBody) {\n      collectBody = assertNotCancelled(\n        await clack.confirm({\n          message: 'Provide a request body?',\n          initialValue: ep.method === 'POST' || ep.method === 'PUT',\n        }),\n      );\n    }\n\n    if (collectBody) {\n      body = assertNotCancelled(\n        await clack.text({\n          message: 'Request body (JSON):',\n          placeholder: '{\"key\": \"value\"}',\n          validate: (v) => {\n            if (!v?.trim()) return 'Body cannot be empty';\n            try {\n              JSON.parse(v);\n            } catch {\n              return 'Invalid JSON';\n            }\n          },\n        }),\n      ).trim();\n    }\n  }\n\n  const fullPath = `${resolvedPath}${queryString}`;\n\n  console.log(`\\n  ${colorMethod(ep.method)}  ${fullPath}`);\n  if (body) {\n    console.log(JSON.stringify(JSON.parse(body), null, 2));\n  }\n  console.log();\n\n  const ok = assertNotCancelled(await clack.confirm({ message: 'Execute this request?' }));\n  if (!ok) process.exit(0);\n\n  const response = await apiRequest({\n    method: ep.method,\n    path: fullPath,\n    apiKey: options?.apiKey ?? resolveApiKey(),\n    baseUrl: resolveApiBaseUrl(),\n    body,\n  });\n\n  printResponse(response, { includeStatus: true });\n\n  if (response.status >= 400) {\n    process.exit(1);\n  }\n}\n"]}

package/dist/commands/api/request.d.ts

@@ -0,0 +1,14 @@
+export interface ApiRequestOptions {
+    method: string;
+    path: string;
+    apiKey?: string;
+    body?: string;
+    baseUrl?: string;
+}
+export interface ApiResponse {
+    status: number;
+    headers: Headers;
+    body: unknown;
+    rawBody: string;
+}
+export declare function apiRequest(options: ApiRequestOptions): Promise<ApiResponse>;