@typeship-ax/cli 0.10.0 → 0.21.0

package/src/resources/generations.ts

@@ -1,7 +1,8 @@
 // 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 { HttpCore, type RequestOptions } from "../core/http.js";
+import { paginate, PagePromise } from "../core/pagination.js";
 import {
   ResponseParseError,
   TransportError,
@@ -9,25 +10,82 @@ import {
   ValidationError,
   BadRequestError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
   RateLimitedError,
   UnauthorizedError,
 } from "../errors.js";
-import type { GenerationId, GenerationResponse, GenerationResponseRead } from "../types.js";
+import type {
+  FileList,
+  FileListRead,
+  FileModel,
+  FileModelRead,
+  GenerationId,
+  GenerationList,
+  GenerationListRead,
+  GenerationResponse,
+  GenerationResponseRead,
+  GenerationStatus,
+  GenerationSummary,
+  GenerationSummaryRead,
+  ProjectId,
+  TargetId,
+} from "../types.js";
 
 export class GenerationsResource {
   constructor(private readonly _core: HttpCore) {}
   /**
-   * Retrieve a generation
+   * List generations
    *
-   * Includes the generated files when the generation succeeded.
-   * `GET /generations/{generation_id}`
+   * Auto-paginates: `for await (const item of …)` walks every page.
+   * `GET /generations`
    */
-  async retrieve(
-    generationId: GenerationId,
+  list(
+    params?: GenerationsListParams,
     options?: RequestOptions,
-  ): Promise<ApiResult<GenerationResponseRead, GenerationsRetrieveError>> {
-    return this._core.request<GenerationResponseRead, GenerationsRetrieveError>({
+  ): PagePromise<GenerationSummaryRead, GenerationsListError> {
+    return paginate<GenerationSummaryRead, GenerationsListError>(this._core, {
+      method: "GET",
+      path: "/generations",
+      security: [{"apiKey":[]}],
+      query: {
+        limit: params?.limit,
+        cursor: params?.cursor,
+        project_id: params?.projectId,
+        target_id: params?.targetId,
+        status: params?.status,
+      },
+      errors: {
+        "400": BadRequestError,
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "generations.list",
+      options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
+    });
+  }
+
+  /**
+   * 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}`
+   */
+  async get(generationId: GenerationId, options?: RequestOptions): Promise<GenerationResponseRead> {
+    return this._core.requestData<GenerationResponseRead, GenerationsGetError>({
       method: "GET",
       path: `/generations/${encodeURIComponent(String(generationId))}`,
       security: [{"apiKey":[]}],
@@ -36,31 +94,34 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
-      schemaKey: "generations.retrieve",
+      schemaKey: "generations.get",
       options,
     });
   }
 
   /**
-   * 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`
    */
-  async retrieveFile(
+  listFiles(
     generationId: GenerationId,
-    params: GenerationsRetrieveFileParams,
+    params?: GenerationsListFilesParams,
     options?: RequestOptions,
-  ): Promise<ApiResult<string, GenerationsRetrieveFileError>> {
-    return this._core.request<string, GenerationsRetrieveFileError>({
+  ): PagePromise<FileModelRead, GenerationsListFilesError> {
+    return paginate<FileModelRead, GenerationsListFilesError>(this._core, {
       method: "GET",
-      path: `/generations/${encodeURIComponent(String(generationId))}/file`,
+      path: `/generations/${encodeURIComponent(String(generationId))}/files`,
       security: [{"apiKey":[]}],
       query: {
-        path: params.path,
+        limit: params?.limit,
+        cursor: params?.cursor,
       },
       errors: {
         "400": BadRequestError,
@@ -68,37 +129,114 @@ export class GenerationsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
-      schemaKey: "generations.retrieveFile",
+      schemaKey: "generations.listFiles",
       options,
+    }, {
+      style: "cursor",
+      itemsField: "data",
+      cursorParam: "cursor",
+      nextCursorField: "next_cursor",
+      hasMoreField: "has_more",
+      limitParam: "limit",
     });
   }
+
+/** Poll until files are generated or the Generation fails. */
+  async wait(
+    generationId: GenerationId,
+    options: RequestOptions & { intervalMs?: number; waitTimeoutMs?: number } = {},
+  ): Promise<GenerationResponseRead> {
+    const { intervalMs = 3_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.get(generationId, requestOptions);
+      if (result.status !== "queued" && result.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())));
+    }
+  }
+}
+
+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;
 }
 
-/** Every error `retrieve` can produce, as a discriminated union. */
-export type GenerationsRetrieveError =
+/** Typed errors `list` can throw. */
+export type GenerationsListError =
+  | BadRequestError
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
-export interface GenerationsRetrieveFileParams {
-  /** Repo-relative path inside the generated package. */
-  path: string;
+/** 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 =
+/** Typed errors `listFiles` can throw. */
+export type GenerationsListFilesError =
   | BadRequestError
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError

package/src/resources/organization.ts

@@ -0,0 +1,53 @@
+// typeship — organization resource.
+// Generated by typeship — https://typeship.dev
+
+import { HttpCore, type RequestOptions } from "../core/http.js";
+import {
+  ResponseParseError,
+  TransportError,
+  UnexpectedApiError,
+  ValidationError,
+  ForbiddenError,
+  InternalServerError,
+  RateLimitedError,
+  UnauthorizedError,
+} from "../errors.js";
+import type { Organization, OrganizationRead } from "../types.js";
+
+export class OrganizationResource {
+  constructor(private readonly _core: HttpCore) {}
+  /**
+   * The organization behind the presented credentials
+   *
+   * Returns the organization associated with your credential. The Typeship CLI uses this endpoint
+   * for `whoami`.
+   * `GET /organization`
+   */
+  async get(options?: RequestOptions): Promise<OrganizationRead> {
+    return this._core.requestData<OrganizationRead, OrganizationGetError>({
+      method: "GET",
+      path: "/organization",
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "organization.get",
+      options,
+    });
+  }
+}
+
+/** Typed errors `get` can throw. */
+export type OrganizationGetError =
+  | UnauthorizedError
+  | ForbiddenError
+  | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;