@typeship-ax/mcp 0.10.0 → 0.20.0

package/src/resources/drafts.ts

@@ -0,0 +1,422 @@
+// typeship — drafts resource.
+// Generated by typeship — https://typeship.dev
+
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  BadGatewayError,
+  BadRequestError,
+  ConflictError,
+  ForbiddenError,
+  InternalServerError,
+  NotFoundError,
+  PreconditionFailedError,
+  RateLimitedError,
+  UnauthorizedError,
+  UnprocessableEntityError,
+} from "../errors.js";
+import type {
+  Draft,
+  DraftFile,
+  DraftFileList,
+  DraftFileListRead,
+  DraftFileRead,
+  DraftId,
+  DraftList,
+  DraftListRead,
+  DraftRead,
+  DraftRecoverRequest,
+  DraftResolveRequest,
+  DraftResponse,
+  DraftResponseRead,
+  DraftStatus,
+  DraftUpdateRequest,
+  TargetId,
+} from "../types.js";
+
+export class DraftsResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * 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?: DraftsListParams, options?: RequestOptions): PagePromise<DraftRead, DraftsListError> {
+    return paginate<DraftRead, DraftsListError>(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: DraftId, options?: RequestOptions): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsGetError>({
+      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: DraftId,
+    body: DraftUpdateRequest,
+    params?: DraftsUpdateParams,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsUpdateError>({
+      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: DraftId,
+    params?: DraftsListFilesParams,
+    options?: RequestOptions,
+  ): PagePromise<DraftFileRead, DraftsListFilesError> {
+    return paginate<DraftFileRead, DraftsListFilesError>(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: DraftId,
+    body: DraftResolveRequest,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsResolveError>({
+      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: DraftId,
+    body: DraftRecoverRequest,
+    options?: RequestOptions,
+  ): Promise<DraftResponseRead> {
+    return this._core.requestData<DraftResponseRead, DraftsRecoverError>({
+      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,
+    });
+  }
+}
+
+export interface DraftsListParams {
+  /**
+   * 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 Drafts of this Target. */
+  targetId?: TargetId;
+  /** Only Drafts with this status. */
+  status?: DraftStatus;
+}
+
+/** Typed errors `list` can throw. */
+export type DraftsListError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `get` can throw. */
+export type DraftsGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface DraftsUpdateParams {
+  /**
+   * ETag from a preceding response. The write applies only if the resource still has that version;
+   * otherwise it returns 412 precondition_failed without changes. Omit to write the current
+   * version. See https://typeship.dev/docs/typeship-api#conditional-writes.
+   */
+  ifMatch?: string;
+}
+
+/** Typed errors `update` can throw. */
+export type DraftsUpdateError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | PreconditionFailedError
+  | UnprocessableEntityError
+  | RateLimitedError
+  | InternalServerError
+  | BadGatewayError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+export interface DraftsListFilesParams {
+  /**
+   * conflicted: conflicts only. customized: files that differ from the last merged package.
+   * history: files affected by a default-branch history rewrite. Omit for conflicted and customized
+   * files.
+   */
+  filter?: "conflicted" | "customized" | "history";
+  /**
+   * 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;
+}
+
+/** Typed errors `listFiles` can throw. */
+export type DraftsListFilesError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `resolve` can throw. */
+export type DraftsResolveError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Typed errors `recover` can throw. */
+export type DraftsRecoverError =
+  | BadRequestError
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | ConflictError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;

package/src/resources/files.ts

@@ -0,0 +1,68 @@
+// typeship — files resource.
+// Generated by typeship — https://typeship.dev
+
+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, FileResponse, FileResponseRead } from "../types.js";
+
+export class FilesResource {
+  constructor(private readonly _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}`
+   */
+  async get(fileId: FileId, params?: FilesGetParams, options?: RequestOptions): Promise<FileResponseRead> {
+    return this._core.requestData<FileResponseRead, FilesGetError>({
+      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,
+    });
+  }
+}
+
+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;

package/src/resources/generate.ts

@@ -1,7 +1,7 @@
 // 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 { HttpCore, type RequestOptions } from "../core/http.js";
 import {
   ResponseParseError,
   TransportError,
@@ -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 Spec
    *
-   * 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","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`
@@ -40,8 +51,8 @@ export class GenerateResource {
     body: GenerateRequest,
     params?: GenerateRunParams,
     options?: RequestOptions,
-  ): Promise<ApiResult<GenerationResultRead, GenerateRunError>> {
-    return this._core.request<GenerationResultRead, GenerateRunError>({
+  ): Promise<GenerationResultRead> {
+    return this._core.requestData<GenerationResultRead, GenerateRunError>({
       method: "POST",
       path: "/generate",
       security: [{},{"apiKey":[]}],
@@ -57,6 +68,7 @@ export class GenerateResource {
         "413": PayloadTooLargeError,
         "422": UnprocessableEntityError,
         "429": RateLimitedError,
+        "500": InternalServerError,
         default: ApiResponseError,
       },
       idempotencyKey: "Idempotency-Key",
@@ -64,19 +76,52 @@ 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<Blob> {
+    return this._core.requestData<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.
+   * 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. */
+/** Typed errors `run` can throw. */
 export type GenerateRunError =
   | BadRequestError
   | UnauthorizedError
@@ -85,8 +130,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;
+}
+
+/** Typed errors `downloadPackage` can throw. */
+export type GenerateDownloadPackageError =
+  | BadRequestError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;