@sendmux/cli 1.0.0 → 1.0.1

package/dist/operation-flags.d.ts

@@ -12,9 +12,9 @@ export interface OperationFlags extends AuthFlags {
 }
 export interface ParsedOperationOptions {
     body?: unknown;
-    headers?: Record<string, string>;
-    path?: Record<string, string>;
-    query?: Record<string, string>;
+    headers?: Record<string, unknown>;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
 }
 export declare const operationFlags: {
     body: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;

package/dist/operation-flags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation-flags.d.ts","sourceRoot":"","sources":["../src/operation-flags.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;CA6B1B,CAAC;AAEF,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,mBAAmB,EAC9B,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,sBAAsB,CAAC,CAgCjC"}
+{"version":3,"file":"operation-flags.d.ts","sourceRoot":"","sources":["../src/operation-flags.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,mBAAmB,EAGpB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;CA6B1B,CAAC;AAEF,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,mBAAmB,EAC9B,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,sBAAsB,CAAC,CAwBjC"}

package/dist/operation-flags.js

@@ -4,10 +4,10 @@ import { authFlags, } from "./base-command.js";
 export const operationFlags = {
     ...authFlags,
     body: Flags.string({
-        description: "JSON request body for POST, PUT, and PATCH operations.",
+        description: "JSON request body, or UTF-8 bytes for binary operations.",
     }),
     "body-file": Flags.string({
-        description: "Path to a JSON request body file.",
+        description: "Path to a JSON request body file, or a binary file for binary operations.",
     }),
     header: Flags.string({
         description: "Header as name=value. Repeat for multiple headers.",
@@ -32,24 +32,17 @@ export const operationFlags = {
     }),
 };
 export async function parseOperationOptions(command, operation, flags) {
-    const path = parsePairs(flags.path ?? [], "--path");
-    for (const parameter of operation.pathParams) {
-        if (parameter.required && !path[parameter.name]) {
-            command.error(`Missing path parameter "${parameter.name}". Pass --path ${parameter.name}=<value>.`, {
-                exit: 2,
-            });
-        }
-    }
-    const query = parsePairs(flags.query ?? [], "--query");
-    const headers = parsePairs(flags.header ?? [], "--header");
+    const path = parseParameterPairs(command, operation.pathParams, flags.path ?? [], "--path");
+    const query = parseParameterPairs(command, operation.queryParams, flags.query ?? [], "--query");
+    const headers = parseParameterPairs(command, operation.headerParams, flags.header ?? [], "--header");
     if (flags["idempotency-key"]) {
-        headers["Idempotency-Key"] = flags["idempotency-key"];
+        addHeaderFlag(command, operation, headers, "Idempotency-Key", flags["idempotency-key"]);
     }
     if (flags["if-match"]) {
-        headers["If-Match"] = flags["if-match"];
+        addHeaderFlag(command, operation, headers, "If-Match", flags["if-match"]);
     }
     if (flags["if-none-match"]) {
-        headers["If-None-Match"] = flags["if-none-match"];
+        addHeaderFlag(command, operation, headers, "If-None-Match", flags["if-none-match"]);
     }
     const body = await parseBody(command, operation, flags);
     return dropEmpty({
@@ -59,14 +52,51 @@ export async function parseOperationOptions(command, operation, flags) {
         query,
     });
 }
-function parsePairs(values, flagName) {
+function parseParameterPairs(command, parameters, values, flagName) {
+    const parameterMap = new Map(parameters.map((parameter) => [keyForParameter(flagName, parameter.name), parameter]));
     const pairs = {};
     for (const value of values) {
         const separator = value.indexOf("=");
         if (separator <= 0) {
-            throw new Error(`${flagName} values must use name=value syntax`);
+            command.error(`${flagName} values must use name=value syntax`, { exit: 2 });
+        }
+        const name = value.slice(0, separator);
+        const parameter = parameterMap.get(keyForParameter(flagName, name));
+        if (!parameter) {
+            const allowed = parameters.map((item) => item.name).join(", ") || "none";
+            command.error(`Unknown ${labelForFlag(flagName)} parameter "${name}". Supported parameters: ${allowed}.`, {
+                exit: 2,
+            });
+        }
+        const parsedValue = parseParameterValue(command, parameter, value.slice(separator + 1), flagName);
+        if (parameter.schema.type === "array") {
+            const existing = pairs[parameter.name];
+            const nextValue = Array.isArray(existing) ? [...existing, parsedValue] : [parsedValue];
+            if (parameter.schema.maxItems !== undefined && nextValue.length > parameter.schema.maxItems) {
+                command.error(`${labelForFlag(flagName)} parameter "${parameter.name}" accepts at most ${parameter.schema.maxItems} values.`, {
+                    exit: 2,
+                });
+            }
+            pairs[parameter.name] = nextValue;
+            continue;
+        }
+        pairs[parameter.name] = parsedValue;
+    }
+    for (const parameter of parameters) {
+        if (parameter.required && pairs[parameter.name] === undefined) {
+            command.error(`Missing ${labelForFlag(flagName)} parameter "${parameter.name}". Pass ${flagName} ${parameter.name}=<value>.`, {
+                exit: 2,
+            });
+        }
+        const parsed = pairs[parameter.name];
+        if (parameter.schema.type === "array" &&
+            parameter.schema.minItems !== undefined &&
+            Array.isArray(parsed) &&
+            parsed.length < parameter.schema.minItems) {
+            command.error(`${labelForFlag(flagName)} parameter "${parameter.name}" requires at least ${parameter.schema.minItems} values.`, {
+                exit: 2,
+            });
         }
-        pairs[value.slice(0, separator)] = value.slice(separator + 1);
     }
     return pairs;
 }
@@ -74,11 +104,30 @@ async function parseBody(command, operation, flags) {
     if (flags.body && flags["body-file"]) {
         command.error("Pass only one of --body or --body-file.", { exit: 2 });
     }
-    const raw = flags["body-file"] ? await readFile(flags["body-file"], "utf8") : flags.body;
-    if (!raw) {
+    if (operation.bodyKind === "none") {
+        if (flags.body || flags["body-file"]) {
+            command.error("This command does not accept a request body.", { exit: 2 });
+        }
+        return undefined;
+    }
+    const hasBodyInput = flags.body !== undefined || flags["body-file"] !== undefined;
+    if (!hasBodyInput) {
         if (operation.requestBodyRequired) {
-            command.error("This command requires a JSON body. Pass --body or --body-file.", { exit: 2 });
+            const label = operation.bodyKind === "binary" ? "request body file" : "JSON body";
+            command.error(`This command requires a ${label}. Pass --body${operation.bodyKind === "binary" ? "-file" : " or --body-file"}.`, {
+                exit: 2,
+            });
+        }
+        return undefined;
+    }
+    if (operation.bodyKind === "binary") {
+        if (flags.body !== undefined) {
+            return Buffer.from(flags.body, "utf8");
         }
+        return readFile(flags["body-file"]);
+    }
+    const raw = flags["body-file"] ? await readFile(flags["body-file"], "utf8") : flags.body;
+    if (raw === undefined) {
         return undefined;
     }
     try {
@@ -88,6 +137,68 @@ async function parseBody(command, operation, flags) {
         command.error("Request body must be valid JSON.", { exit: 2 });
     }
 }
+function addHeaderFlag(command, operation, headers, name, value) {
+    const parameter = operation.headerParams.find((item) => item.name.toLowerCase() === name.toLowerCase());
+    if (!parameter) {
+        command.error(`This command does not support the ${name} header.`, { exit: 2 });
+    }
+    headers[parameter.name] = parseParameterValue(command, parameter, value, "--header");
+}
+function parseParameterValue(command, parameter, raw, flagName) {
+    const label = `${labelForFlag(flagName)} parameter "${parameter.name}"`;
+    const schema = scalarSchemaForParameter(parameter);
+    let value = raw;
+    if (schema.type === "integer" || schema.type === "number") {
+        const parsed = Number(raw);
+        if (!Number.isFinite(parsed) || (schema.type === "integer" && !Number.isInteger(parsed))) {
+            command.error(`${label} must be ${articleForType(schema.type)}.`, { exit: 2 });
+        }
+        value = parsed;
+    }
+    if (schema.type === "boolean") {
+        if (raw !== "true" && raw !== "false") {
+            command.error(`${label} must be true or false.`, { exit: 2 });
+        }
+        value = raw === "true";
+    }
+    if (typeof value === "number") {
+        if (schema.minimum !== undefined && value < schema.minimum) {
+            command.error(`${label} must be at least ${schema.minimum}.`, { exit: 2 });
+        }
+        if (schema.maximum !== undefined && value > schema.maximum) {
+            command.error(`${label} must be at most ${schema.maximum}.`, { exit: 2 });
+        }
+    }
+    if (typeof value === "string") {
+        if (schema.minLength !== undefined && value.length < schema.minLength) {
+            command.error(`${label} must be at least ${schema.minLength} characters.`, { exit: 2 });
+        }
+        if (schema.maxLength !== undefined && value.length > schema.maxLength) {
+            command.error(`${label} must be at most ${schema.maxLength} characters.`, { exit: 2 });
+        }
+        if (schema.pattern && !new RegExp(schema.pattern).test(value)) {
+            command.error(`${label} does not match the required format.`, { exit: 2 });
+        }
+    }
+    if (schema.enum &&
+        (typeof value === "string" || typeof value === "number") &&
+        !schema.enum.includes(value)) {
+        command.error(`${label} must be one of: ${schema.enum.join(", ")}.`, { exit: 2 });
+    }
+    return value;
+}
+function scalarSchemaForParameter(parameter) {
+    return parameter.schema.type === "array" ? parameter.schema.items : parameter.schema;
+}
+function keyForParameter(flagName, name) {
+    return flagName === "--header" ? name.toLowerCase() : name;
+}
+function labelForFlag(flagName) {
+    return flagName.replace(/^--/, "");
+}
+function articleForType(type) {
+    return type === "integer" ? "an integer" : "a number";
+}
 function dropEmpty(options) {
     const next = {};
     for (const [key, value] of Object.entries(options)) {

package/dist/operation-runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation-runner.d.ts","sourceRoot":"","sources":["../src/operation-runner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAoBhE,wBAAsB,eAAe,CACnC,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,mBAAmB,EAC9B,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,OAAO,CAAC,CAelB"}
+{"version":3,"file":"operation-runner.d.ts","sourceRoot":"","sources":["../src/operation-runner.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAoBhE,wBAAsB,eAAe,CACnC,OAAO,EAAE,cAAc,EACvB,SAAS,EAAE,mBAAmB,EAC9B,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,OAAO,CAAC,CA4ClB"}

package/dist/operation-runner.js

@@ -19,11 +19,73 @@ export async function runSdkOperation(command, operation, flags) {
     const client = clientFactories[operation.surface](clientConfig);
     const operationOptions = await parseOperationOptions(command, operation, flags);
     const sdkOperation = operationFor(operation);
+    if (operation.operationId === "mailboxStreamEvents") {
+        const controller = new AbortController();
+        const response = await sdkOperation({
+            client,
+            ...operationOptions,
+            signal: controller.signal,
+        });
+        return command.renderResult(await firstStreamEvent(response, controller));
+    }
+    if (operation.operationId === "mailboxGetMessageAttachment") {
+        const response = await sdkOperation({
+            client,
+            ...operationOptions,
+            parseAs: "arrayBuffer",
+        });
+        const data = rawResponseData(response);
+        if (typeof data === "string" || data instanceof ArrayBuffer || ArrayBuffer.isView(data)) {
+            return command.renderBinaryResult(data);
+        }
+        throw new Error("SDK operation mailboxGetMessageAttachment did not return binary content");
+    }
     const response = await sdkOperation({
         client,
         ...operationOptions,
     });
-    return command.renderResult(rawEnvelope(response));
+    const data = rawResponseData(response);
+    if (operation.responseKind === "text" && typeof data === "string") {
+        return command.renderTextResult(data);
+    }
+    return command.renderResult(data);
+}
+async function firstStreamEvent(value, controller) {
+    const stream = value?.stream;
+    if (!stream || typeof stream[Symbol.asyncIterator] !== "function") {
+        throw new Error("SDK operation mailboxStreamEvents did not return an async stream");
+    }
+    const iterator = stream[Symbol.asyncIterator]();
+    let timer;
+    const timeout = new Promise((_, reject) => {
+        timer = setTimeout(() => reject(new Error("Timed out waiting for mailbox stream event")), 20_000);
+    });
+    try {
+        const next = await Promise.race([iterator.next(), timeout]);
+        if (next.done) {
+            throw new Error("Mailbox stream ended before yielding an event");
+        }
+        return next.value;
+    }
+    finally {
+        if (timer) {
+            clearTimeout(timer);
+        }
+        controller.abort();
+        await closeAsyncIterator(iterator);
+    }
+}
+async function closeAsyncIterator(iterator) {
+    if (typeof iterator.return !== "function") {
+        return;
+    }
+    await Promise.race([iterator.return(), sleep(1_000)]).catch(() => undefined);
+}
+function sleep(ms) {
+    return new Promise((resolve) => {
+        const timeout = setTimeout(resolve, ms);
+        timeout.unref?.();
+    });
 }
 function operationFor(operation) {
     const module = surfaceModules[operation.surface];
@@ -33,13 +95,9 @@ function operationFor(operation) {
     }
     return sdkOperation;
 }
-function rawEnvelope(value) {
+function rawResponseData(value) {
     if (!value || typeof value !== "object" || !("data" in value)) {
         return value;
     }
-    const data = value.data;
-    if (!data || typeof data !== "object" || !("ok" in data)) {
-        return value;
-    }
-    return data;
+    return value.data;
 }

package/dist/operation-types.d.ts

@@ -2,8 +2,26 @@ import type { ApiKeyKind } from "./key-kind.js";
 export interface OperationParameter {
     name: string;
     required: boolean;
+    schema: OperationParameterSchema;
+}
+export type OperationParameterSchema = OperationParameterArraySchema | OperationParameterScalarSchema;
+export interface OperationParameterArraySchema {
+    items: OperationParameterScalarSchema;
+    maxItems?: number;
+    minItems?: number;
+    type: "array";
+}
+export interface OperationParameterScalarSchema {
+    enum?: readonly (number | string)[];
+    maximum?: number;
+    maxLength?: number;
+    minimum?: number;
+    minLength?: number;
+    pattern?: string;
+    type: "boolean" | "integer" | "number" | "string";
 }
 export interface OperationDefinition {
+    bodyKind: "binary" | "json" | "none";
     command: string;
     description: string;
     headerParams: readonly OperationParameter[];
@@ -12,6 +30,7 @@ export interface OperationDefinition {
     path: string;
     pathParams: readonly OperationParameter[];
     queryParams: readonly OperationParameter[];
+    responseKind: "binary" | "json" | "text";
     requestBodyRequired: boolean;
     requiredKeyKind: ApiKeyKind;
     surface: "mailbox" | "management" | "sending";

package/dist/operation-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operation-types.d.ts","sourceRoot":"","sources":["../src/operation-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC1C,WAAW,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC3C,mBAAmB,EAAE,OAAO,CAAC;IAC7B,eAAe,EAAE,UAAU,CAAC;IAC5B,OAAO,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,CAAC;CAC/C"}
+{"version":3,"file":"operation-types.d.ts","sourceRoot":"","sources":["../src/operation-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,wBAAwB,CAAC;CAClC;AAED,MAAM,MAAM,wBAAwB,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAEtG,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,8BAA8B,CAAC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;CACnD;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC1C,WAAW,EAAE,SAAS,kBAAkB,EAAE,CAAC;IAC3C,YAAY,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IACzC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,eAAe,EAAE,UAAU,CAAC;IAC5B,OAAO,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,CAAC;CAC/C"}