@typeship-ax/cli 0.10.0 → 0.21.0

package/dist/resources/drafts.js

@@ -0,0 +1,230 @@
+// typeship — drafts resource.
+// Generated by typeship — https://typeship.dev
+import { paginate } from "../core/pagination.js";
+import { BadGatewayError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PreconditionFailedError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
+export class DraftsResource {
+    _core;
+    constructor(_core) {
+        this._core = _core;
+    }
+    /**
+     * List Drafts
+     *
+     * Lists open and merged Drafts, newest first. Each Target has one open Draft; each merge adds a
+     * merged Draft.
+     *
+     * Auto-paginates: `for await (const item of …)` walks every page.
+     * `GET /drafts`
+     */
+    list(params, options) {
+        return paginate(this._core, {
+            method: "GET",
+            path: "/drafts",
+            security: [{ "apiKey": [] }],
+            query: {
+                limit: params?.limit,
+                cursor: params?.cursor,
+                target_id: params?.targetId,
+                status: params?.status,
+            },
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "drafts.list",
+            options,
+        }, {
+            style: "cursor",
+            itemsField: "data",
+            cursorParam: "cursor",
+            nextCursorField: "next_cursor",
+            hasMoreField: "has_more",
+            limitParam: "limit",
+        });
+    }
+    /**
+     * Get a Draft
+     *
+     * Returns the Draft's status. An open Draft also reports its typed reason when action is
+     * required, next version and its source, readiness, checks, and conflict counts. The response
+     * carries an `ETag`; send it in `If-Match` when updating the Draft to avoid changing a newer
+     * version selection.
+     * `GET /drafts/{draft_id}`
+     */
+    async get(draftId, options) {
+        return this._core.requestData({
+            method: "GET",
+            path: `/drafts/${encodeURIComponent(String(draftId))}`,
+            security: [{ "apiKey": [] }],
+            errors: {
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "drafts.get",
+            options,
+        });
+    }
+    /**
+     * Select an exact Draft version or return to automatic versioning
+     *
+     * Checks your version choice against the required version bump, then regenerates the existing
+     * Draft pull request.
+     *
+     * Send the Draft's `ETag` in `If-Match` to reject an intervening change with 412
+     * precondition_failed before saving or regenerating. Omitting `If-Match` applies the selection to
+     * the current Draft. version_next is required; null restores automatic selection.
+     *
+     * A `502` response means the selected version was saved, but regeneration failed. Follow the
+     * error's retryable and suggested_action fields. Repeating an unfinished selection resumes
+     * generation; repeating a completed selection starts no new work. If using If-Match, retrieve the
+     * Draft and confirm the saved selection before retrying with its current ETag.
+     * A `409 draft_merged` means the Draft merged; retrieve the Target and select a version on its
+     * `draft_id`. A `409 target_busy` means the Target is publishing; wait and retry. A `409
+     * version_occupied` means the version is already released; retrieve the Draft and releases,
+     * choose a new version, and retry.
+     * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+     * and If-Match.
+     * `PATCH /drafts/{draft_id}`
+     */
+    async update(draftId, body, params, options) {
+        return this._core.requestData({
+            method: "PATCH",
+            path: `/drafts/${encodeURIComponent(String(draftId))}`,
+            security: [{ "apiKey": [] }],
+            headers: {
+                "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+            },
+            body,
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "409": ConflictError,
+                "412": PreconditionFailedError,
+                "422": UnprocessableEntityError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+                "502": BadGatewayError,
+            },
+            schemaKey: "drafts.update",
+            options,
+        });
+    }
+    /**
+     * List customized and conflicted files on a Draft
+     *
+     * Lists the Draft's files that differ from the last merged package or need a conflict decision,
+     * ordered by path, without file content. Each conflict names its kind, the saved decision, and
+     * the sides you can read with getFile. With `filter=history`, lists files affected by a
+     * default-branch history rewrite; the list is empty when none is pending.
+     *
+     * Returns `409 resource_changed` while Typeship is carrying the Draft's latest commit forward
+     * (status working), or when the Draft changes between pages.
+     *
+     * Auto-paginates: `for await (const item of …)` walks every page.
+     * `GET /drafts/{draft_id}/files`
+     */
+    listFiles(draftId, params, options) {
+        return paginate(this._core, {
+            method: "GET",
+            path: `/drafts/${encodeURIComponent(String(draftId))}/files`,
+            security: [{ "apiKey": [] }],
+            query: {
+                filter: params?.filter,
+                limit: params?.limit,
+                cursor: params?.cursor,
+            },
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "409": ConflictError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "drafts.listFiles",
+            options,
+        }, {
+            style: "cursor",
+            itemsField: "data",
+            cursorParam: "cursor",
+            nextCursorField: "next_cursor",
+            hasMoreField: "has_more",
+            limitParam: "limit",
+        });
+    }
+    /**
+     * Resolve selected Draft files
+     *
+     * Resolves conflicts on the Draft's head_sha: keep yours or generated, or supply final content as
+     * text or, for binary files, base64. Choosing generated for a customized path replaces it with
+     * the generated file, or deletes a Draft-only file.
+     *
+     * Conflict decisions are saved together and can be replaced until applied. Choosing generated for
+     * customized paths commits those changes together on the Draft branch. Returns the Draft. When
+     * every conflict has a decision, `conflicts.decided` equals `conflicts.total` and Typeship
+     * continues the Draft and runs checks. Paths that already match the Draft change nothing.
+     * `POST /drafts/{draft_id}/resolve`
+     */
+    async resolve(draftId, body, options) {
+        return this._core.requestData({
+            method: "POST",
+            path: `/drafts/${encodeURIComponent(String(draftId))}/resolve`,
+            security: [{ "apiKey": [] }],
+            body,
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "409": ConflictError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            schemaKey: "drafts.resolve",
+            options,
+        });
+    }
+    /**
+     * Approve recovery from rewritten default-branch history
+     *
+     * When the Draft has status `action_required` and reason `history_rewritten`, review affected
+     * files with `listDraftFiles` and `filter=history`, then approve with the Draft's
+     * `history_recovery` revisions. Approval saves the recovery without changing Git and returns the
+     * Draft; the next generation rebuilds it from the rewritten default branch. The previous Draft
+     * branch stays available, and overlapping code comes back as conflicts to resolve. A rewritten
+     * Draft branch alone needs no approval.
+     * `POST /drafts/{draft_id}/recover`
+     */
+    async recover(draftId, body, options) {
+        return this._core.requestData({
+            method: "POST",
+            path: `/drafts/${encodeURIComponent(String(draftId))}/recover`,
+            security: [{ "apiKey": [] }],
+            body,
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "409": ConflictError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            schemaKey: "drafts.recover",
+            options,
+        });
+    }
+}

package/dist/resources/files.d.ts

@@ -0,0 +1,23 @@
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, InternalServerError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
+import type { FileId, FileResponseRead } from "../types.js";
+export declare class FilesResource {
+    private readonly _core;
+    constructor(_core: HttpCore);
+    /**
+     * Get a file
+     *
+     * Returns one bounded chunk of an immutable file: at most 24 KiB, as UTF-8 text or, for binary
+     * bytes, base64. When next_cursor is not null, repeat the request with cursor and concatenate the
+     * chunks in order. A file ID always returns the same bytes.
+     * `GET /files/{file_id}`
+     */
+    get(fileId: FileId, params?: FilesGetParams, options?: RequestOptions): Promise<FileResponseRead>;
+}
+export interface FilesGetParams {
+    /** next_cursor from the preceding chunk of this file. */
+    cursor?: string;
+}
+/** Typed errors `get` can throw. */
+export type FilesGetError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+//# sourceMappingURL=files.d.ts.map

package/dist/resources/files.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/resources/files.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,MAAM,EAAgB,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE1E,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;OAOG;IACG,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAqBxG;AAED,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,oCAAoC;AACpC,MAAM,MAAM,aAAa,GACrB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}

package/dist/resources/files.js

@@ -0,0 +1,38 @@
+// typeship — files resource.
+// Generated by typeship — https://typeship.dev
+import { BadRequestError, ForbiddenError, InternalServerError, NotFoundError, RateLimitedError, UnauthorizedError, } from "../errors.js";
+export class FilesResource {
+    _core;
+    constructor(_core) {
+        this._core = _core;
+    }
+    /**
+     * Get a file
+     *
+     * Returns one bounded chunk of an immutable file: at most 24 KiB, as UTF-8 text or, for binary
+     * bytes, base64. When next_cursor is not null, repeat the request with cursor and concatenate the
+     * chunks in order. A file ID always returns the same bytes.
+     * `GET /files/{file_id}`
+     */
+    async get(fileId, params, options) {
+        return this._core.requestData({
+            method: "GET",
+            path: `/files/${encodeURIComponent(String(fileId))}`,
+            security: [{ "apiKey": [] }],
+            query: {
+                cursor: params?.cursor,
+            },
+            errors: {
+                "400": BadRequestError,
+                "401": UnauthorizedError,
+                "403": ForbiddenError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "files.get",
+            options,
+        });
+    }
+}

package/dist/resources/generate.d.ts

@@ -1,36 +1,65 @@
-import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, ApiResponseError, BadRequestError, ConflictError, ForbiddenError, PayloadTooLargeError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, ApiResponseError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PayloadTooLargeError, RateLimitedError, UnauthorizedError, UnprocessableEntityError } from "../errors.js";
 import type { GenerateRequest, GenerationResultRead } from "../types.js";
 export declare class GenerateResource {
     private readonly _core;
     constructor(_core: HttpCore);
     /**
-     * Generate one Target from a Definition
-     *
-     * Stateless generation: nothing is stored. Returns the full generated
-     * package as files. Works without an API key: anonymous calls generate
-     * the first 25 operations, rate limited per IP address, and the
-     * response's `limits` object says what was held back and where to lift
-     * it; anonymous calls from a Definition URL also carry `claim.url`, a link
-     * that turns the run into a project once a person signs in. With a key, the free plan generates
-     * the first 25 operations and
-     * paid plans generate the complete Definition. A present but invalid key is a
-     * 401, not a downgrade to anonymous.
+     * Generate one package from a Spec
+     *
+     * Returns one generated package without creating a Project.
+     *
+     * Supports [idempotent retries](https://typeship.dev/docs/typeship-api/idempotency); keyed
+     * responses include generated files in the replay cache.
+     *
+     * Use `download.url` to save the complete ZIP, verify `download.sha256`, and extract it into an
+     * empty directory. The link expires at `download.expires_at` and grants access to anyone who has
+     * it. CLI, MCP, and SDK calls supply an idempotency key automatically. Agents should request
+     * `fields=["download","coverage","warnings","claim"]` to keep the MCP result compact; files can
+     * exceed the response limit. Download the ZIP instead of repeating generation to retrieve omitted
+     * files.
+     *
+     * Anonymous and Free requests include the first 25 operations. Paid plans include all operations.
+     * Anonymous requests are rate limited by IP address. Check `coverage` for omitted operations; an
+     * invalid API key returns `401`.
+     *
+     * An anonymous URL request without source headers may return `claim.url`. Sign in through that
+     * link within seven days to save the recipe as a Project.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /generate`
      */
-    run(body: GenerateRequest, params?: GenerateRunParams, options?: RequestOptions): Promise<ApiResult<GenerationResultRead, GenerateRunError>>;
+    run(body: GenerateRequest, params?: GenerateRunParams, options?: RequestOptions): Promise<GenerationResultRead>;
+    /**
+     * Download a generated package
+     *
+     * Download the complete ZIP referenced by `generate_run`'s `download.url`. Pass the token from
+     * that URL. No API key is needed; the token grants access only to that exact package until its
+     * replay window expires. Keep the token private.
+     *
+     * The local MCP server saves this binary response to disk. On a hosted MCP connection, download
+     * the original URL directly to your workspace. Verify the ZIP against `download.sha256` before
+     * extracting it into an empty directory. Expired or invalid tokens return `404`; a new generation
+     * creates a new download.
+     * `GET /generate/download`
+     */
+    downloadPackage(params: GenerateDownloadPackageParams, options?: RequestOptions): Promise<Blob>;
 }
 export interface GenerateRunParams {
     /**
-     * Identifies one logical write for 24 hours. The key is scoped to the authenticated account and
-     * operation; account-less generation uses a hashed network identity. Retrying the same method,
-     * path, query, and JSON body replays the original response. Reusing the key with changed intent
-     * returns 409. After expiry the key starts a new write.
+     * Identifies one logical write for 24 hours. The key is scoped to the authenticated organization
+     * and operation; generation without an organization uses a hashed network identity. Retrying the
+     * same method, path, query, If-Match header, and JSON body replays the original response. Reusing
+     * the key with changed intent returns 409. After expiry the key starts a new write.
      */
     idempotencyKey?: string;
 }
-/** Every error `run` can produce, as a discriminated union. */
-export type GenerateRunError = BadRequestError | UnauthorizedError | ForbiddenError | ConflictError | PayloadTooLargeError | UnprocessableEntityError | RateLimitedError | ApiResponseError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+/** Typed errors `run` can throw. */
+export type GenerateRunError = BadRequestError | UnauthorizedError | ForbiddenError | ConflictError | PayloadTooLargeError | UnprocessableEntityError | RateLimitedError | InternalServerError | ApiResponseError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export interface GenerateDownloadPackageParams {
+    /** Private download token from download.url in the generation result. */
+    token: string;
+}
+/** Typed errors `downloadPackage` can throw. */
+export type GenerateDownloadPackageError = BadRequestError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=generate.d.ts.map

package/dist/resources/generate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/resources/generate.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAoB,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE3F,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;;;;;;;;OAeG;IACG,GAAG,CACP,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC;CAwB9D;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,wBAAwB,GACxB,gBAAgB,GAChB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/resources/generate.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAoB,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAE3F,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,GAAG,CACP,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IA0BhC;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,MAAM,EAAE,6BAA6B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBtG;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,oCAAoC;AACpC,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,wBAAwB,GACxB,gBAAgB,GAChB,mBAAmB,GACnB,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,6BAA6B;IAC5C,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,eAAe,GACf,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}

package/dist/resources/generate.js

@@ -1,29 +1,38 @@
 // typeship — generate resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
-import { ApiResponseError, BadRequestError, ConflictError, ForbiddenError, PayloadTooLargeError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
+// Generated by typeship — https://typeship.dev
+import { ApiResponseError, BadRequestError, ConflictError, ForbiddenError, InternalServerError, NotFoundError, PayloadTooLargeError, RateLimitedError, UnauthorizedError, UnprocessableEntityError, } from "../errors.js";
 export class GenerateResource {
     _core;
     constructor(_core) {
         this._core = _core;
     }
     /**
-     * Generate one Target from a Definition
-     *
-     * Stateless generation: nothing is stored. Returns the full generated
-     * package as files. Works without an API key: anonymous calls generate
-     * the first 25 operations, rate limited per IP address, and the
-     * response's `limits` object says what was held back and where to lift
-     * it; anonymous calls from a Definition URL also carry `claim.url`, a link
-     * that turns the run into a project once a person signs in. With a key, the free plan generates
-     * the first 25 operations and
-     * paid plans generate the complete Definition. A present but invalid key is a
-     * 401, not a downgrade to anonymous.
+     * Generate one package from a Spec
+     *
+     * Returns one generated package without creating a Project.
+     *
+     * Supports [idempotent retries](https://typeship.dev/docs/typeship-api/idempotency); keyed
+     * responses include generated files in the replay cache.
+     *
+     * Use `download.url` to save the complete ZIP, verify `download.sha256`, and extract it into an
+     * empty directory. The link expires at `download.expires_at` and grants access to anyone who has
+     * it. CLI, MCP, and SDK calls supply an idempotency key automatically. Agents should request
+     * `fields=["download","coverage","warnings","claim"]` to keep the MCP result compact; files can
+     * exceed the response limit. Download the ZIP instead of repeating generation to retrieve omitted
+     * files.
+     *
+     * Anonymous and Free requests include the first 25 operations. Paid plans include all operations.
+     * Anonymous requests are rate limited by IP address. Check `coverage` for omitted operations; an
+     * invalid API key returns `401`.
+     *
+     * An anonymous URL request without source headers may return `claim.url`. Sign in through that
+     * link within seven days to save the recipe as a Project.
      *
      * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
      * `POST /generate`
      */
     async run(body, params, options) {
-        return this._core.request({
+        return this._core.requestData({
             method: "POST",
             path: "/generate",
             security: [{}, { "apiKey": [] }],
@@ -39,6 +48,7 @@ export class GenerateResource {
                 "413": PayloadTooLargeError,
                 "422": UnprocessableEntityError,
                 "429": RateLimitedError,
+                "500": InternalServerError,
                 default: ApiResponseError,
             },
             idempotencyKey: "Idempotency-Key",
@@ -46,4 +56,36 @@ export class GenerateResource {
             options,
         });
     }
+    /**
+     * Download a generated package
+     *
+     * Download the complete ZIP referenced by `generate_run`'s `download.url`. Pass the token from
+     * that URL. No API key is needed; the token grants access only to that exact package until its
+     * replay window expires. Keep the token private.
+     *
+     * The local MCP server saves this binary response to disk. On a hosted MCP connection, download
+     * the original URL directly to your workspace. Verify the ZIP against `download.sha256` before
+     * extracting it into an empty directory. Expired or invalid tokens return `404`; a new generation
+     * creates a new download.
+     * `GET /generate/download`
+     */
+    async downloadPackage(params, options) {
+        return this._core.requestData({
+            method: "GET",
+            path: "/generate/download",
+            security: [{}],
+            query: {
+                token: params.token,
+            },
+            errors: {
+                "400": BadRequestError,
+                "404": NotFoundError,
+                "429": RateLimitedError,
+                "500": InternalServerError,
+            },
+            idempotent: true,
+            schemaKey: "generate.downloadPackage",
+            options,
+        });
+    }
 }

package/dist/resources/generations.d.ts

@@ -1,31 +1,83 @@
-import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
-import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
-import type { GenerationId, GenerationResponseRead } from "../types.js";
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { PagePromise } from "../core/pagination.js";
+import { ResponseParseError, TransportError, UnexpectedApiError, ValidationError, BadRequestError, ForbiddenError, InternalServerError, NotFoundError, RateLimitedError, UnauthorizedError } from "../errors.js";
+import type { FileModelRead, GenerationId, GenerationResponseRead, GenerationStatus, GenerationSummaryRead, ProjectId, TargetId } from "../types.js";
 export declare class GenerationsResource {
     private readonly _core;
     constructor(_core: HttpCore);
     /**
-     * Retrieve a generation
+     * List generations
      *
-     * Includes the generated files when the generation succeeded.
+     * Auto-paginates: `for await (const item of …)` walks every page.
+     * `GET /generations`
+     */
+    list(params?: GenerationsListParams, options?: RequestOptions): PagePromise<GenerationSummaryRead, GenerationsListError>;
+    /**
+     * Get a generation
+     *
+     * Returns the status of that Generation. `queued` and `running` mean generation is still in
+     * progress. `completed` means generated files are saved, not that repository delivery or a Draft
+     * is complete. List its files with listGenerationFiles and read each with getFile.
      * `GET /generations/{generation_id}`
      */
-    retrieve(generationId: GenerationId, options?: RequestOptions): Promise<ApiResult<GenerationResponseRead, GenerationsRetrieveError>>;
+    get(generationId: GenerationId, options?: RequestOptions): Promise<GenerationResponseRead>;
     /**
-     * Fetch one file from a generation
+     * List a Generation's files
+     *
+     * Lists the generated package's files, ordered by path. Read content with getFile.
      *
-     * Raw file content, for generations whose target was too large to inline (files_omitted true).
-     * The generation's files_index lists valid paths.
-     * `GET /generations/{generation_id}/file`
+     * Auto-paginates: `for await (const item of …)` walks every page.
+     * `GET /generations/{generation_id}/files`
      */
-    retrieveFile(generationId: GenerationId, params: GenerationsRetrieveFileParams, options?: RequestOptions): Promise<ApiResult<string, GenerationsRetrieveFileError>>;
+    listFiles(generationId: GenerationId, params?: GenerationsListFilesParams, options?: RequestOptions): PagePromise<FileModelRead, GenerationsListFilesError>;
+    /** Poll until files are generated or the Generation fails. */
+    wait(generationId: GenerationId, options?: RequestOptions & {
+        intervalMs?: number;
+        waitTimeoutMs?: number;
+    }): Promise<GenerationResponseRead>;
 }
-/** Every error `retrieve` can produce, as a discriminated union. */
-export type GenerationsRetrieveError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
-export interface GenerationsRetrieveFileParams {
-    /** Repo-relative path inside the generated package. */
-    path: string;
+export interface GenerationsListParams {
+    /**
+     * Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
+     * representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
+     * invalid_request. List query parameters must appear only once; unrecognized parameters also
+     * return 400.
+     */
+    limit?: number;
+    /**
+     * Opaque cursor from the preceding page's next_cursor. Valid only for the same organization,
+     * operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
+     * malformed, or repeated cursors return 400 invalid_request. The page limit may change between
+     * requests.
+     */
+    cursor?: string;
+    /** Only Generations in this Project. */
+    projectId?: ProjectId;
+    /** Only Generations of this Target. */
+    targetId?: TargetId;
+    /** Only Generations with this status. */
+    status?: GenerationStatus;
+}
+/** Typed errors `list` can throw. */
+export type GenerationsListError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+/** Typed errors `get` can throw. */
+export type GenerationsGetError = UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+export interface GenerationsListFilesParams {
+    /**
+     * Maximum number of resources to return. Omit for 20; otherwise supply base-10 digits
+     * representing an integer from 1 to 100. Empty, malformed, or out-of-range values return 400
+     * invalid_request. List query parameters must appear only once; unrecognized parameters also
+     * return 400.
+     */
+    limit?: number;
+    /**
+     * Opaque cursor from the preceding page's next_cursor. Valid only for the same organization,
+     * operation, filters, and ordering that issued it. Omit to start at the first page. Empty,
+     * malformed, or repeated cursors return 400 invalid_request. The page limit may change between
+     * requests.
+     */
+    cursor?: string;
 }
-/** Every error `retrieveFile` can produce, as a discriminated union. */
-export type GenerationsRetrieveFileError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
+/** Typed errors `listFiles` can throw. */
+export type GenerationsListFilesError = BadRequestError | UnauthorizedError | ForbiddenError | NotFoundError | RateLimitedError | InternalServerError | UnexpectedApiError | ResponseParseError | TransportError | ValidationError;
 //# sourceMappingURL=generations.d.ts.map

package/dist/resources/generations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generations.d.ts","sourceRoot":"","sources":["../../src/resources/generations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,YAAY,EAAsB,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE5F,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;OAKG;IACG,QAAQ,CACZ,YAAY,EAAE,YAAY,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,sBAAsB,EAAE,wBAAwB,CAAC,CAAC;IAiBvE;;;;;;OAMG;IACG,YAAY,CAChB,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,6BAA6B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;CAoB5D;AAED,oEAAoE;AACpE,MAAM,MAAM,wBAAwB,GAChC,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,6BAA6B;IAC5C,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wEAAwE;AACxE,MAAM,MAAM,4BAA4B,GACpC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}
+{"version":3,"file":"generations.d.ts","sourceRoot":"","sources":["../../src/resources/generations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EAAY,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAIV,aAAa,EACb,YAAY,EAIZ,sBAAsB,EACtB,gBAAgB,EAEhB,qBAAqB,EACrB,SAAS,EACT,QAAQ,EACT,MAAM,aAAa,CAAC;AAErB,qBAAa,mBAAmB;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAC5C;;;;;OAKG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qBAAqB,EAAE,oBAAoB,CAAC;IAiC3D;;;;;;;OAOG;IACG,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAkBhG;;;;;;;OAOG;IACH,SAAS,CACP,YAAY,EAAE,YAAY,EAC1B,MAAM,CAAC,EAAE,0BAA0B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,aAAa,EAAE,yBAAyB,CAAC;IA8B1D,8DAA8D;IACtD,IAAI,CACR,YAAY,EAAE,YAAY,EAC1B,OAAO,GAAE,cAAc,GAAG;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAO,GAC7E,OAAO,CAAC,sBAAsB,CAAC;CAcnC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,yCAAyC;IACzC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,qCAAqC;AACrC,MAAM,MAAM,oBAAoB,GAC5B,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,oCAAoC;AACpC,MAAM,MAAM,mBAAmB,GAC3B,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC;AAEpB,MAAM,WAAW,0BAA0B;IACzC;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,0CAA0C;AAC1C,MAAM,MAAM,yBAAyB,GACjC,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,aAAa,GACb,gBAAgB,GAChB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,eAAe,CAAC"}