@typeship-ax/cli 0.6.0

package/dist/index.js

@@ -0,0 +1,86 @@
+// typeship — client entry point.
+// Generated by typeship — https://typeship.dev — do not edit by hand.
+import { HttpCore, formatDebugEvent, bearerAuth, } from "./core/http.js";
+import { DEFS, SCHEMAS } from "./schemas.js";
+import { GenerateResource } from "./resources/generate.js";
+import { ProjectsResource } from "./resources/projects.js";
+import { GenerationsResource } from "./resources/generations.js";
+import { SpecRevisionsResource } from "./resources/spec-revisions.js";
+import { AccountResource } from "./resources/account.js";
+import { ApiKeysResource } from "./resources/api-keys.js";
+/** This package's version, also sent as the `User-Agent`. */
+export const VERSION = "0.6.0";
+const USER_AGENT = "@typeship-ax/cli/0.6.0 (typeship)";
+/**
+ * typeship — v0.6.0
+ *
+ * Generate production SDKs, CLIs, and MCP servers from an OpenAPI or
+ * GraphQL spec, and keep every selected output current.
+ *
+ * Every operation but one requires an API key, created in the console and
+ * sent as `Authorization: Bearer ak_...`. A browser session is not a
+ * credential for this API. The exception is POST /generate, which works
+ * anonymously with the free plan's limits.
+ */
+export class TypeshipClient {
+    generate;
+    projects;
+    generations;
+    specRevisions;
+    account;
+    apiKeys;
+    constructor(options = {}) {
+        // Identifies this package to the API (ignored by browsers, which
+        // control their own User-Agent); override via defaultHeaders.
+        const headers = { "User-Agent": USER_AGENT, ...options.defaultHeaders };
+        const debugOption = options.debug
+            ?? (typeof process !== "undefined" && process.env?.["TYPESHIP_DEBUG"] === "1");
+        const debug = typeof debugOption === "function"
+            ? debugOption
+            : debugOption === true
+                ? (event) => console.error(formatDebugEvent("typeship", event))
+                : undefined;
+        const query = {};
+        if (options.bearerToken !== undefined)
+            headers["Authorization"] = bearerAuth(options.bearerToken);
+        const v = options.validate;
+        const validate = v
+            ? {
+                requests: typeof v === "object" ? v.requests !== false : true,
+                responses: typeof v === "object" ? v.responses !== false : true,
+                mode: (typeof v === "object" && v.mode) || "throw",
+            }
+            : undefined;
+        const core = new HttpCore({
+            baseUrl: options.baseUrl ?? "https://typeship.dev/api/v1",
+            headers,
+            query,
+            fetch: options.fetch ?? fetch,
+            timeoutMs: options.timeoutMs ?? 30_000,
+            maxRetries: options.maxRetries ?? 2,
+            onRequest: options.onRequest,
+            onResponse: options.onResponse,
+            onError: options.onError,
+            debug,
+            validate,
+            schemas: validate ? SCHEMAS : undefined,
+            schemaDefs: validate ? DEFS : undefined,
+        });
+        this.generate = new GenerateResource(core);
+        this.projects = new ProjectsResource(core);
+        this.generations = new GenerationsResource(core);
+        this.specRevisions = new SpecRevisionsResource(core);
+        this.account = new AccountResource(core);
+        this.apiKeys = new ApiKeysResource(core);
+    }
+}
+export * from "./types.js";
+export * from "./errors.js";
+export { formatDebugEvent, } from "./core/http.js";
+export { Page, PagePromise } from "./core/pagination.js";
+export * from "./resources/generate.js";
+export * from "./resources/projects.js";
+export * from "./resources/generations.js";
+export * from "./resources/spec-revisions.js";
+export * from "./resources/account.js";
+export * from "./resources/api-keys.js";

package/dist/ops.d.ts

@@ -0,0 +1,115 @@
+export interface ParamSpec {
+    /** wire name (JSON key, query name, or path placeholder) */
+    name: string;
+    /** CLI flag, without the leading dashes */
+    flag: string;
+    /** property name the SDK params object uses */
+    ts: string;
+    kind: "path" | "query" | "header" | "body";
+    /** "file": a binary multipart field; the CLI takes a path and uploads it.
+     * "array"/"object": the schema says so (a lone scalar flag value becomes a
+     * one-item array; an object must be JSON). "json": a union or untyped
+     * value — JSON if it parses, else the raw text. */
+    type: "string" | "number" | "boolean" | "array" | "object" | "json" | "file";
+    required: boolean;
+    enum?: string[];
+    /** Element type of an "array" param: what each repeated/comma value coerces to. */
+    items?: {
+        type: "string" | "number" | "boolean" | "object" | "json";
+        enum?: string[];
+    };
+    /** A date-shaped string: the CLI and MCP server resolve relative forms (-P7D, today). */
+    format?: "date" | "date-time";
+    description?: string;
+    /** Settable once on the client (globals option); optional per call. */
+    global?: boolean;
+}
+export interface OpSpec {
+    resource: string;
+    method: string;
+    command: [string, string];
+    /** Full kebab method name, still routable, when command[1] was shortened. */
+    commandAlias?: string;
+    tool: string;
+    httpMethod: string;
+    path: string;
+    summary?: string;
+    /** Full operation description, for the docs command (help stays terse). */
+    description?: string;
+    /** What agents see in tools/list: summary, the description's first
+     * sentence, method + path. Computed once so package and hosted agree. */
+    toolDescription: string;
+    paginated: boolean;
+    hasBody: boolean;
+    bodyStyle: "none" | "fields" | "data";
+    /** wire encoding of the body, for generic executors */
+    bodyKind: "json" | "form" | "multipart" | "binary" | "text" | null;
+    /** Success body is a text/event-stream: the CLI streams events as NDJSON;
+     * not an MCP tool. */
+    sse: boolean;
+    hasParams: boolean;
+    /** GraphQL ops whose field returns an object accept a selection-set
+     * override (a leaf-returning field has nothing to select). */
+    select: boolean;
+    /** present for GraphQL ops: enough to build the request document */
+    graphql?: {
+        field: string;
+        kind: "query" | "mutation";
+        docPrefix: string;
+        defaultSelection: string;
+    };
+    /** Retried by default (idempotent verb), like the SDK method. */
+    idempotent: boolean;
+    /** Header the SDK fills with one UUID per call (Idempotency-Key). */
+    idempotencyHeader?: string;
+    /** Operation-level retry policy (x-typeship-retries). */
+    retry?: {
+        maxRetries?: number;
+        statuses?: number[];
+        initialDelayMs?: number;
+        maxDelayMs?: number;
+        retryNonIdempotent?: boolean;
+    };
+    /** Page-walking config for generic executors, same shape as the SDK's PageConfig. */
+    pagination?: {
+        style: "cursor" | "cursorFromLastId" | "page" | "offset";
+        itemsField: string;
+        cursorParam?: string;
+        nextCursorField?: string;
+        hasMoreField?: string;
+        idField?: string;
+        pageParam?: string;
+        offsetParam?: string;
+        limitParam?: string;
+    };
+    /** The spec's security requirement: "required" fails fast without a
+     * credential; "none" works anonymously; "optional" is either. */
+    auth: "required" | "optional" | "none";
+    /** Whether calling this operation only reads, writes, or destroys state. */
+    safety: "read" | "write" | "destructive";
+    params: ParamSpec[];
+    inputSchema: Record<string, unknown>;
+    /** Deterministic arguments derived from inputSchema for runnable examples. */
+    exampleArguments: Record<string, unknown>;
+    /** What the tool returns (JSON Schema 2020-12), when the spec documents
+     * a success body; paginated tools describe { items, hasMore, nextPage }. */
+    outputSchema?: Record<string, unknown>;
+}
+export declare const OPS: OpSpec[];
+/** Parameters settable once on the client (globals option): CLI/MCP fill
+ * them from flags or environment; the SDK falls back per request. */
+export declare const GLOBALS: {
+    name: string;
+    option: string;
+    flag: string;
+    envSuffix: string;
+}[];
+export declare function findOp(resource: string, method: string): OpSpec | undefined;
+export declare function missingRequired(op: OpSpec, values: Record<string, unknown>): string[];
+/**
+ * Assemble the SDK method's positional arguments from a flat map of values
+ * keyed by wire name (plus an optional raw body for bodyStyle "data" or a
+ * --data base object).
+ */
+export declare function buildArgs(op: OpSpec, values: Record<string, unknown>, dataBody?: unknown, select?: string): unknown[];
+//# sourceMappingURL=ops.d.ts.map

package/dist/ops.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ops.d.ts","sourceRoot":"","sources":["../src/ops.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,SAAS;IACxB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC3C;;;uDAGmD;IACnD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7E,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,mFAAmF;IACnF,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IACvF,yFAAyF;IACzF,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uEAAuE;IACvE,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;6EACyE;IACzE,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;IACtC,uDAAuD;IACvD,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IACnE;0BACsB;IACtB,GAAG,EAAE,OAAO,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB;kEAC8D;IAC9D,MAAM,EAAE,OAAO,CAAC;IAChB,oEAAoE;IACpE,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAC;IACrG,iEAAiE;IACjE,UAAU,EAAE,OAAO,CAAC;IACpB,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yDAAyD;IACzD,KAAK,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IACjI,qFAAqF;IACrF,UAAU,CAAC,EAAE;QACX,KAAK,EAAE,QAAQ,GAAG,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;QACzD,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;IACF;qEACiE;IACjE,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;IACvC,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,aAAa,CAAC;IACzC,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,8EAA8E;IAC9E,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C;gFAC4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC;AAED,eAAO,MAAM,GAAG,EAAE,MAAM,EAkBvB,CAAC;AAEF;qEACqE;AACrE,eAAO,MAAM,OAAO,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,EAEtF,CAAC;AAEF,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE3E;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAIrF;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,QAAQ,CAAC,EAAE,OAAO,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,EAAE,CAuCX"}