@primitivedotdev/sdk 0.9.0 → 0.11.0

package/dist/oclif/api-command.js

@@ -7,80 +7,126 @@ function flagName(parameterName) {
 function flagDescription(parameter) {
     return parameter.description ?? parameter.name;
 }
-/**
- * Render a one-shot description of a JSON Schema's top-level
- * properties so an agent reading `<command> --help` can build a
- * valid `--body` payload without probing the server. Pulled from
- * the resolved request schema embedded on the manifest.
- *
- * Format prioritizes scanability over completeness: required
- * fields first, each line is `<name> <type> [- description]`
- * truncated to a reasonable width. Callers who need the full
- * schema can run `primitive list-operations | jq` and read
- * `requestSchema` directly.
- */
-function renderRequestSchemaSummary(schema) {
+function extractBodyFields(schema) {
     if (!schema || typeof schema !== "object")
-        return null;
+        return [];
     const properties = schema.properties;
     if (!properties || typeof properties !== "object")
-        return null;
+        return [];
     const requiredArr = Array.isArray(schema.required)
         ? schema.required.filter((k) => typeof k === "string")
         : [];
     const required = new Set(requiredArr);
-    const entries = Object.entries(properties)
-        .map(([name, raw]) => {
+    const fields = [];
+    for (const [name, raw] of Object.entries(properties)) {
         const propSchema = raw && typeof raw === "object" ? raw : {};
-        let type = "any";
         const t = propSchema.type;
+        let displayType = "any";
+        let kind = "complex";
         if (typeof t === "string") {
-            type = t;
-            if (type === "array") {
+            displayType = t;
+            if (t === "string")
+                kind = "string";
+            else if (t === "integer" || t === "number")
+                kind = "integer";
+            else if (t === "boolean")
+                kind = "boolean";
+            else if (t === "array") {
                 const items = propSchema.items;
                 if (items && typeof items === "object") {
                     const itemType = items.type;
                     if (typeof itemType === "string") {
-                        type = `array<${itemType}>`;
+                        displayType = `array<${itemType}>`;
                     }
                 }
+                kind = "complex";
+            }
+            else {
+                kind = "complex";
             }
         }
         else if (Array.isArray(t)) {
-            // Nullable shorthand the codegen normalizes to e.g. ["string","null"].
+            // Nullable shorthand the codegen normalizes to e.g.
+            // ["string","null"]. If exactly one non-null member, surface
+            // it as that scalar with a trailing `?`.
             const nonNull = t.filter((s) => s !== "null");
-            type = nonNull.length === 1 ? `${nonNull[0]}?` : nonNull.join("|");
+            if (nonNull.length === 1) {
+                const single = nonNull[0];
+                displayType = `${single}?`;
+                if (single === "string")
+                    kind = "string";
+                else if (single === "integer" || single === "number")
+                    kind = "integer";
+                else if (single === "boolean")
+                    kind = "boolean";
+                else
+                    kind = "complex";
+            }
+            else {
+                displayType = nonNull.join("|");
+                kind = "complex";
+            }
         }
         const description = typeof propSchema.description === "string"
             ? propSchema.description.split("\n")[0].trim()
             : "";
-        return {
+        const enumRaw = propSchema.enum;
+        const enumValues = kind === "string" && Array.isArray(enumRaw)
+            ? enumRaw.filter((e) => typeof e === "string")
+            : undefined;
+        fields.push({
             name,
-            type,
             description,
             required: required.has(name),
-        };
-    })
-        .sort((a, b) => {
+            displayType,
+            kind,
+            ...(enumValues && enumValues.length > 0 ? { enumValues } : {}),
+        });
+    }
+    return fields.sort((a, b) => {
         if (a.required !== b.required)
             return a.required ? -1 : 1;
         return a.name.localeCompare(b.name);
     });
-    if (entries.length === 0)
+}
+/**
+ * Render a "Body fields" summary for the per-command help.
+ *
+ * Most scalar fields are exposed as individual `--flag` flags,
+ * which oclif auto-renders in the FLAGS section above. To avoid
+ * duplicating that, the summary here only documents fields that
+ * MUST go through `--body` (complex types: arrays, objects,
+ * mixed-non-nullable). When an operation has only scalars, the
+ * summary is omitted entirely and oclif's FLAGS section is the
+ * full story.
+ *
+ * For operations with mixed scalar and complex fields, we also
+ * include a short header pointing the agent at the flag form so
+ * the natural reading is "use the flags above; --body for the
+ * leftovers below."
+ */
+function renderRequestSchemaSummary(schema) {
+    const fields = extractBodyFields(schema);
+    if (fields.length === 0)
         return null;
-    const nameWidth = Math.min(24, Math.max(...entries.map((e) => e.name.length)));
-    const lines = ["Body fields (JSON --body):"];
+    const complex = fields.filter((f) => f.kind === "complex");
+    if (complex.length === 0)
+        return null;
+    const nameWidth = Math.min(24, Math.max(...complex.map((f) => f.name.length)));
     const descMax = 78;
-    for (const e of entries) {
-        const flag = e.required ? " *" : "  ";
-        const padName = e.name.padEnd(nameWidth);
-        const trimmedDesc = e.description.length > descMax
-            ? `${e.description.slice(0, descMax - 3)}...`
-            : e.description;
+    const lines = [
+        "Body fields requiring --body JSON (these are not exposed as flags):",
+    ];
+    for (const f of complex) {
+        const marker = f.required ? " *" : "  ";
+        const padName = f.name.padEnd(nameWidth);
+        const trimmedDesc = f.description.length > descMax
+            ? `${f.description.slice(0, descMax - 3)}...`
+            : f.description;
         const desc = trimmedDesc ? `  ${trimmedDesc}` : "";
-        lines.push(`${flag} ${padName}  ${e.type}${desc}`);
+        lines.push(`${marker} ${padName}  ${f.displayType}${desc}`);
     }
-    lines.push("(* = required)");
+    lines.push("(* = required. Scalar body fields are exposed as individual --flag-name flags; see FLAGS above.)");
     return lines.join("\n");
 }
 export function flagForParameter(parameter) {
@@ -196,6 +242,44 @@ export function formatErrorPayload(payload) {
     }
     return JSON.stringify(payload, null, 2);
 }
+// Reserved flag names the body-field expander must never overwrite.
+// `--body` and `--body-file` are the JSON escape hatches.
+// `--api-key`, `--base-url`, `--output` are infra. Path and query
+// params get added before body fields and take precedence.
+const RESERVED_FLAG_NAMES = new Set([
+    "api-key",
+    "base-url",
+    "body",
+    "body-file",
+    "output",
+]);
+function bodyFieldFlag(field) {
+    // Flag descriptions cap at 80 chars so oclif's --help output
+    // stays readable; the schema's full description is also visible
+    // via `primitive list-operations | jq`.
+    const descMax = 80;
+    const trimmedDesc = field.description.length > descMax
+        ? `${field.description.slice(0, descMax - 3)}...`
+        : field.description;
+    // Field-flag UX choice: do NOT mark scalar body fields as
+    // required at the oclif level even when the JSON Schema marks
+    // them required. Reason: a caller can satisfy the requirement
+    // either via the individual flag OR via --body / --body-file.
+    // Marking the flag required would force the individual-flag
+    // form. The runtime body merger validates the final assembled
+    // body against the same server-side schema either way.
+    const common = {
+        description: trimmedDesc || field.name,
+    };
+    if (field.kind === "boolean")
+        return Flags.boolean(common);
+    if (field.kind === "integer")
+        return Flags.integer(common);
+    if (field.enumValues) {
+        return Flags.string({ ...common, options: field.enumValues });
+    }
+    return Flags.string(common);
+}
 function buildFlags(operation) {
     const flags = {
         "api-key": Flags.string({
@@ -210,18 +294,67 @@ function buildFlags(operation) {
     for (const parameter of [...operation.pathParams, ...operation.queryParams]) {
         flags[flagName(parameter.name)] = flagForParameter(parameter);
     }
+    const bodyFieldFlagToProperty = new Map();
     if (operation.hasJsonBody) {
-        flags.body = Flags.string({ description: "JSON request body" });
+        flags.body = Flags.string({
+            description: "Full request body as JSON. Prefer per-field flags (e.g. --to, --from, --body-text) when available; --body is the escape hatch for nested or complex fields.",
+        });
         flags["body-file"] = Flags.string({
-            description: "Path to a JSON file used as the request body",
+            description: "Path to a JSON file used as the request body. Same role as --body for callers passing a saved payload.",
         });
+        // Expand top-level scalar body fields into individual flags so
+        // `primitive sending:send-email --to alice@x --from support@x
+        // --body-text "hi"` works without constructing JSON. Driven by
+        // the requestSchema embedded on the manifest. Skip flags that
+        // collide with reserved names or with path/query params already
+        // added above; those collisions fall back to --body.
+        //
+        // Collisions are tracked in the returned map so the run()
+        // handler doesn't misread a path/query param's value as a
+        // body-field override. (A naive "look up parsedFlags[name]"
+        // pass would happily pick up the path param's value and
+        // silently write it into the body.)
+        const bodyFields = extractBodyFields(operation.requestSchema);
+        for (const field of bodyFields) {
+            if (field.kind === "complex")
+                continue;
+            const name = flagName(field.name);
+            if (RESERVED_FLAG_NAMES.has(name))
+                continue;
+            if (flags[name] !== undefined)
+                continue;
+            flags[name] = bodyFieldFlag(field);
+            bodyFieldFlagToProperty.set(name, field.name);
+        }
     }
     if (operation.binaryResponse) {
         flags.output = Flags.string({
             description: "Write binary response bytes to a file",
         });
     }
-    return flags;
+    return { flags, bodyFieldFlagToProperty };
+}
+// Pull body field values out of the parsed CLI flags. Returns
+// only fields the user actually supplied (omits undefined). Used
+// to override / extend the JSON --body when both forms are
+// present (per-field flags take precedence on key conflicts).
+//
+// The `bodyFieldFlagToProperty` allowlist comes from buildFlags and
+// records ONLY the flags actually registered as body-field flags.
+// Without it, this function would naively read parsedFlags by
+// kebab-cased field name and pick up values from a colliding path
+// or query param flag, silently writing them into the body under
+// the body-field key. The allowlist keeps the merge honest: only
+// flags this CLI generator owns end up in the body.
+function collectBodyFieldFlags(parsedFlags, bodyFieldFlagToProperty) {
+    const result = {};
+    for (const [flag, property] of bodyFieldFlagToProperty) {
+        const value = parsedFlags[flag];
+        if (value === undefined)
+            continue;
+        result[property] = value;
+    }
+    return result;
 }
 function collectValues(parameters, flags) {
     const values = {};
@@ -234,7 +367,7 @@ function collectValues(parameters, flags) {
     return values;
 }
 export function createOperationCommand(operation) {
-    const flags = buildFlags(operation);
+    const { flags, bodyFieldFlagToProperty } = buildFlags(operation);
     // Append a "Body fields" summary to the description so agents
     // running `<command> --help` learn the JSON shape immediately.
     // Without this, `--help` only said "JSON request body" and agents
@@ -262,11 +395,48 @@ export function createOperationCommand(operation) {
                     ? parsedFlags["base-url"]
                     : undefined,
             });
-            const body = operation.hasJsonBody
-                ? readJsonBody(parsedFlags)
-                : undefined;
+            // Two body sources, merged: explicit JSON via --body /
+            // --body-file (the base) plus per-field flags (the
+            // overrides). Per-field flag values take precedence on key
+            // conflicts so a caller can pass a base payload via --body
+            // and override one field on the command line.
+            let body;
+            if (operation.hasJsonBody) {
+                const explicit = readJsonBody(parsedFlags);
+                const overrides = collectBodyFieldFlags(parsedFlags, bodyFieldFlagToProperty);
+                if (Object.keys(overrides).length > 0) {
+                    if (explicit === undefined) {
+                        body = overrides;
+                    }
+                    else if (explicit !== null &&
+                        typeof explicit === "object" &&
+                        !Array.isArray(explicit)) {
+                        body = { ...explicit, ...overrides };
+                    }
+                    else {
+                        // Caller passed --body as null, an array, or a
+                        // primitive AND also passed per-field flags. We can't
+                        // merge per-field overrides into a non-object body
+                        // shape, and silently dropping either source would
+                        // leave the caller's actual intent unclear. Refuse
+                        // loudly so the next attempt is unambiguous.
+                        const explicitKind = explicit === null
+                            ? "null"
+                            : Array.isArray(explicit)
+                                ? "array"
+                                : typeof explicit;
+                        const overrideFlags = Object.keys(overrides)
+                            .map((p) => `--${flagName(p)}`)
+                            .join(", ");
+                        throw new Errors.CLIError(`--body must be a JSON object when also passing per-field flags (got ${explicitKind}); supplied per-field flags: ${overrideFlags}. Either drop --body and rely on the per-field flags, or move every field into the JSON --body and drop the flags.`);
+                    }
+                }
+                else {
+                    body = explicit;
+                }
+            }
             if (operation.bodyRequired && body === undefined) {
-                throw new Errors.CLIError(`Operation ${operation.operationId} requires --body or --body-file`);
+                throw new Errors.CLIError(`Operation ${operation.operationId} requires a body. Pass each field as a --flag (see --help) or supply JSON via --body / --body-file.`);
             }
             const operationFn = operations[operation.sdkName];
             const result = await operationFn({

package/dist/oclif/commands/send.js

@@ -0,0 +1,159 @@
+import { Command, Errors, Flags } from "@oclif/core";
+import { listDomains, sendEmail } from "../../api/generated/sdk.gen.js";
+import { PrimitiveApiClient } from "../../api/index.js";
+import { extractErrorPayload, formatErrorPayload } from "../api-command.js";
+// `primitive send` is the agent-grade shortcut for the most common
+// case: send a fresh outbound email. It wraps `sending:send-email`
+// with two ergonomic defaults that the underlying operation can't
+// express through manifest-driven flag generation alone:
+//
+//   1. `--from` defaults to `agent@<first-verified-domain>` when
+//      omitted. Most agents don't know which domains their org has
+//      verified for outbound; making them list-domains first to
+//      derive a from-address is exactly the kind of email-ops cruft
+//      this command exists to hide. Customers with multiple
+//      domains, or who want a different local-part, pass --from
+//      explicitly.
+//   2. `--subject` defaults to the first non-empty line of the body
+//      (capped). Empty subjects get spam-scored, so we always emit
+//      something. Callers who want full control pass --subject.
+//
+// `--body` here is the message body (text). The full `send-email`
+// operation distinguishes `body_text` and `body_html`; this
+// shortcut keeps it simple by exposing `--body` for text and
+// `--html` for the HTML alternative. Users who need both can pass
+// both flags or fall back to `sending:send-email` for the full
+// flag list.
+//
+// Compared to `swaks` (which agents likely have in their training
+// data): this is `swaks`-shaped on purpose so an agent
+// pattern-matching from there lands in the happy path. We just
+// don't need swaks's `--server` / `--auth-*` flags because the
+// HTTPS API key is the auth and the server is implicit.
+const SUBJECT_MAX_LENGTH = 70;
+function deriveSubject(body) {
+    for (const line of body.split("\n")) {
+        const trimmed = line.trim();
+        if (!trimmed)
+            continue;
+        return trimmed.length > SUBJECT_MAX_LENGTH
+            ? `${trimmed.slice(0, SUBJECT_MAX_LENGTH - 3)}...`
+            : trimmed;
+    }
+    return "Message";
+}
+function isVerifiedDomain(domain) {
+    return domain.is_active === true;
+}
+async function pickDefaultFromAddress(apiClient) {
+    const result = await listDomains({
+        client: apiClient.client,
+        responseStyle: "fields",
+    });
+    if (result.error) {
+        const errorPayload = extractErrorPayload(result.error);
+        throw new Errors.CLIError(`Could not look up your verified domains to default --from. Pass --from explicitly. Underlying error: ${formatErrorPayload(errorPayload)}`);
+    }
+    const envelope = result.data;
+    const first = envelope?.data?.find(isVerifiedDomain);
+    if (!first) {
+        throw new Errors.CLIError("No active verified outbound domain found on this account; pass --from explicitly. To set up outbound, claim a domain via `primitive domains:add-domain` and verify it.");
+    }
+    // Local-part: "agent". Any local-part is accepted on managed
+    // *.primitive.email subdomains, so this works out of the box for
+    // the auto-issued domain pool. For customers with BYO domains
+    // and their own MX, "agent@" may or may not be a routable
+    // mailbox; if you have a specific address you want to use, pass
+    // --from explicitly.
+    return `agent@${first.domain}`;
+}
+class SendCommand extends Command {
+    static description = `Send an outbound email. Agent-grade shortcut for sending:send-email with sensible defaults.
+
+  --from defaults to agent@<your-first-verified-outbound-domain> when omitted.
+  --subject defaults to the first line of the body when omitted.
+
+  For the full flag set (custom message-id threading on the wire,
+  references arrays, etc.), use \`primitive sending:send-email\`.`;
+    static summary = "Send an email (simplified, agent-friendly)";
+    static examples = [
+        "<%= config.bin %> send --to alice@example.com --body 'Hi Alice!'",
+        "<%= config.bin %> send --to alice@example.com --from support@yourcompany.com --subject 'Quick question' --body 'Are you free Thursday?'",
+        "<%= config.bin %> send --to alice@example.com --html '<p>Hello!</p>'",
+        "<%= config.bin %> send --to alice@example.com --body 'Confirmed' --wait",
+    ];
+    static flags = {
+        "api-key": Flags.string({
+            description: "Primitive API key (defaults to PRIMITIVE_API_KEY)",
+            env: "PRIMITIVE_API_KEY",
+        }),
+        "base-url": Flags.string({
+            description: "API base URL (defaults to PRIMITIVE_API_URL or production)",
+            env: "PRIMITIVE_API_URL",
+        }),
+        to: Flags.string({
+            description: "Recipient address (e.g. alice@example.com).",
+            required: true,
+        }),
+        from: Flags.string({
+            description: "Sender address. Defaults to agent@<your-first-verified-outbound-domain>.",
+        }),
+        subject: Flags.string({
+            description: "Subject line. Defaults to the first line of --body / --html when omitted.",
+        }),
+        body: Flags.string({
+            description: "Plain-text message body. Either --body or --html (or both) is required.",
+        }),
+        html: Flags.string({
+            description: "HTML message body. Either --body or --html (or both) is required.",
+        }),
+        "in-reply-to": Flags.string({
+            description: "Message-Id of the parent email when threading a reply on the wire. For replying to an inbound message you received, prefer `primitive sending:reply-to-email --id <inbound-id>`.",
+        }),
+        wait: Flags.boolean({
+            description: "Block until the receiving MTA returns an outcome. Without --wait, the call returns once Primitive has accepted the message for delivery.",
+        }),
+        "wait-timeout-ms": Flags.integer({
+            description: "Maximum time to wait when --wait is set. Defaults to 30000ms.",
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(SendCommand);
+        if (!flags.body && !flags.html) {
+            throw new Errors.CLIError("Either --body or --html (or both) is required.");
+        }
+        const apiClient = new PrimitiveApiClient({
+            apiKey: flags["api-key"],
+            baseUrl: flags["base-url"],
+        });
+        const from = flags.from ?? (await pickDefaultFromAddress(apiClient));
+        const subject = flags.subject ?? (flags.body ? deriveSubject(flags.body) : "Message");
+        const result = await sendEmail({
+            body: {
+                from,
+                to: flags.to,
+                subject,
+                ...(flags.body !== undefined ? { body_text: flags.body } : {}),
+                ...(flags.html !== undefined ? { body_html: flags.html } : {}),
+                ...(flags["in-reply-to"] !== undefined
+                    ? { in_reply_to: flags["in-reply-to"] }
+                    : {}),
+                ...(flags.wait !== undefined ? { wait: flags.wait } : {}),
+                ...(flags["wait-timeout-ms"] !== undefined
+                    ? { wait_timeout_ms: flags["wait-timeout-ms"] }
+                    : {}),
+            },
+            client: apiClient.client,
+            responseStyle: "fields",
+        });
+        if (result.error) {
+            const errorPayload = extractErrorPayload(result.error);
+            process.stderr.write(`${formatErrorPayload(errorPayload)}\n`);
+            process.exitCode = 1;
+            return;
+        }
+        const envelope = result.data;
+        this.log(JSON.stringify(envelope?.data ?? null, null, 2));
+    }
+}
+export default SendCommand;

package/dist/oclif/index.js

@@ -1,6 +1,7 @@
 import { Args, Command } from "@oclif/core";
 import { operationManifest, } from "../openapi/index.js";
 import { createOperationCommand } from "./api-command.js";
+import SendCommand from "./commands/send.js";
 import { renderFishCompletion } from "./fish-completion.js";
 class ListOperationsCommand extends Command {
     static description = "List all generated API operations";
@@ -38,5 +39,10 @@ const generatedCommands = Object.fromEntries(operationManifest.map((operation) =
 export const COMMANDS = {
     completion: CompletionCommand,
     "list-operations": ListOperationsCommand,
+    // `send` is the agent-grade shortcut for sending:send-email with
+    // sensible defaults (auto from-address, auto subject). The full
+    // operation stays available under sending:send-email for callers
+    // who want every flag.
+    send: SendCommand,
     ...generatedCommands,
 };