@typeship-ax/cli 0.9.1 → 0.20.0

package/src/resources/generate.ts

@@ -1,5 +1,5 @@
 // typeship — generate resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
+// Generated by typeship — https://typeship.dev
 
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import {
@@ -11,6 +11,8 @@ import {
   BadRequestError,
   ConflictError,
   ForbiddenError,
+  InternalServerError,
+  NotFoundError,
   PayloadTooLargeError,
   RateLimitedError,
   UnauthorizedError,
@@ -21,17 +23,26 @@ import type { GenerateRequest, GenerationResult, GenerationResultRead } from "..
 export class GenerateResource {
   constructor(private readonly _core: HttpCore) {}
   /**
-   * Generate one Target from a Definition
+   * Generate one package 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.
+   * 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","meta","warnings","limits","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 `limits` 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`
@@ -57,6 +68,7 @@ export class GenerateResource {
         "413": PayloadTooLargeError,
         "422": UnprocessableEntityError,
         "429": RateLimitedError,
+        "500": InternalServerError,
         default: ApiResponseError,
       },
       idempotencyKey: "Idempotency-Key",
@@ -64,14 +76,50 @@ 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: GenerateDownloadPackageParams,
+    options?: RequestOptions,
+  ): Promise<ApiResult<Blob, GenerateDownloadPackageError>> {
+    return this._core.request<Blob, GenerateDownloadPackageError>({
+      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,
+    });
+  }
 }
 
 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.
+   * 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;
 }
@@ -85,8 +133,25 @@ export type GenerateRunError =
   | PayloadTooLargeError
   | UnprocessableEntityError
   | RateLimitedError
+  | InternalServerError
   | ApiResponseError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
+
+export interface GenerateDownloadPackageParams {
+  /** Private download token from download.url in the generation result. */
+  token: string;
+}
+
+/** Every error `downloadPackage` can produce, as a discriminated union. */
+export type GenerateDownloadPackageError =
+  | BadRequestError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;

package/src/resources/generations.ts

@@ -1,5 +1,5 @@
 // typeship — generations resource.
-// Generated by typeship — https://typeship.dev — do not edit by hand.
+// Generated by typeship — https://typeship.dev
 
 import { HttpCore, type ApiResult, type RequestOptions } from "../core/http.js";
 import {
@@ -9,6 +9,7 @@ import {
   ValidationError,
   BadRequestError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
   RateLimitedError,
   UnauthorizedError,
@@ -20,7 +21,10 @@ export class GenerationsResource {
   /**
    * Retrieve a generation
    *
-   * Includes the generated files when the generation succeeded.
+   * Returns the current Generation status. `queued` and `running` mean generation is still in
+   * progress. `succeeded` means generated files are saved, not that repository delivery or a Draft
+   * is complete. Successful results include files, or a file index when the package is too large to
+   * inline.
    * `GET /generations/{generation_id}`
    */
   async retrieve(
@@ -36,6 +40,7 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "generations.retrieve",
@@ -46,8 +51,8 @@ export class GenerationsResource {
   /**
    * Fetch one file from a generation
    *
-   * Raw file content, for generations whose target was too large to inline (files_omitted true).
-   * The generation's files_index lists valid paths.
+   * Returns one file's raw content. Use a path from `files_index` when the Generation reports
+   * `files_omitted: true`.
    * `GET /generations/{generation_id}/file`
    */
   async retrieveFile(
@@ -68,12 +73,32 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "generations.retrieveFile",
       options,
     });
   }
+
+/** Poll until files are generated or the Generation fails. */
+  async wait(
+    generationId: GenerationId,
+    options: RequestOptions & { intervalMs?: number; waitTimeoutMs?: number } = {},
+  ): Promise<ApiResult<GenerationResponseRead, GenerationsRetrieveError>> {
+    const { intervalMs = 1_000, waitTimeoutMs = 600_000, ...requestOptions } = options;
+    const deadline = Date.now() + waitTimeoutMs;
+    while (true) {
+      if (requestOptions.signal?.aborted) {
+        throw requestOptions.signal.reason ?? new Error("Generation wait aborted.");
+      }
+      const result = await this.retrieve(generationId, requestOptions);
+      if (!result.ok || (result.data.status !== "queued" && result.data.status !== "running")) return result;
+      if (Date.now() >= deadline) throw new Error("Timed out waiting for Generation " + generationId + ".");
+      await new Promise<void>((resolve) =>
+        setTimeout(resolve, Math.min(intervalMs, deadline - Date.now())));
+    }
+  }
 }
 
 /** Every error `retrieve` can produce, as a discriminated union. */
@@ -82,6 +107,7 @@ export type GenerationsRetrieveError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -99,6 +125,7 @@ export type GenerationsRetrieveFileError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError