@typeship-ax/cli 0.9.1 → 0.20.0

package/src/polling-login.ts

@@ -149,7 +149,16 @@ export async function customBrowserApproval(config: { authUrl: string; name: str
       await pause(Math.min(intervalMs, Math.max(0, deadline - Date.now())), flow.signal);
       flow.check();
       if (Date.now() >= deadline) throw new LoginPollingError("expired");
-      const result = await oauthJsonRequest(url + "/status", post({ session: start.session, code_verifier: verifier }), Math.min(15_000, deadline - Date.now()));
+      let result: Awaited<ReturnType<typeof oauthJsonRequest>>;
+      try {
+        result = await oauthJsonRequest(url + "/status", post({ session: start.session, code_verifier: verifier }), Math.min(15_000, deadline - Date.now()));
+      } catch (error) {
+        flow.check();
+        if (error instanceof OAuthResponseError && error.code === "timed_out" && Date.now() >= deadline) {
+          throw new LoginPollingError("expired");
+        }
+        throw error;
+      }
       flow.check();
       if (Date.now() >= deadline) throw new LoginPollingError("expired");
       if (result.status !== 200) throw new LoginPollingError("request_failed");

package/src/resources/account.ts

@@ -1,5 +1,5 @@
 // typeship — account 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 {
@@ -8,6 +8,7 @@ import {
   UnexpectedApiError,
   ValidationError,
   ForbiddenError,
+  InternalServerError,
   RateLimitedError,
   UnauthorizedError,
 } from "../errors.js";
@@ -18,8 +19,8 @@ export class AccountResource {
   /**
    * The account behind the presented credentials
    *
-   * Returns the account that owns the presented API key. This is also the
-   * identity endpoint the generated typeship CLI's `whoami` calls.
+   * Returns the account associated with your credential. The Typeship CLI uses this endpoint for
+   * `whoami`.
    * `GET /me`
    */
   async retrieve(options?: RequestOptions): Promise<ApiResult<AccountRead, AccountRetrieveError>> {
@@ -27,7 +28,12 @@ export class AccountResource {
       method: "GET",
       path: "/me",
       security: [{"apiKey":[]}],
-      errors: { "401": UnauthorizedError, "403": ForbiddenError, "429": RateLimitedError },
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
       idempotent: true,
       schemaKey: "account.retrieve",
       options,
@@ -40,6 +46,7 @@ export type AccountRetrieveError =
   | UnauthorizedError
   | ForbiddenError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError

package/src/resources/api-keys.ts

@@ -1,5 +1,5 @@
 // typeship — apiKeys 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 { paginate, PagePromise } from "../core/pagination.js";
@@ -10,7 +10,9 @@ import {
   ValidationError,
   BadRequestError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
+  PreconditionFailedError,
   RateLimitedError,
   UnauthorizedError,
 } from "../errors.js";
@@ -28,16 +30,16 @@ export class ApiKeysResource {
   /**
    * List API keys
    *
-   * Keys are never returned in full — only their identity and last four. Creation stays in the
-   * console deliberately: a leaked key that can mint more keys is a leaked account.
+   * Lists key metadata and the last four characters of each key. Full keys are not returned. Create
+   * keys in the Console.
    *
    * Auto-paginates: `for await (const item of …)` walks every page.
-   * `GET /api_keys`
+   * `GET /api-keys`
    */
   list(params?: ApiKeysListParams, options?: RequestOptions): PagePromise<ApiKeyRead, ApiKeysListError> {
     return paginate<ApiKeyRead, ApiKeysListError>(this._core, {
       method: "GET",
-      path: "/api_keys",
+      path: "/api-keys",
       security: [{"apiKey":[]}],
       query: {
         limit: params?.limit,
@@ -48,6 +50,7 @@ export class ApiKeysResource {
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "apiKeys.list",
@@ -62,28 +65,64 @@ export class ApiKeysResource {
     });
   }
 
+  /**
+   * Retrieve an API key
+   *
+   * Returns the key summary and its ETag for conditional revocation.
+   * `GET /api-keys/{api_key_id}`
+   */
+  async retrieve(
+    apiKeyId: string,
+    options?: RequestOptions,
+  ): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRetrieveError>> {
+    return this._core.request<ApiKeyResponseRead, ApiKeysRetrieveError>({
+      method: "GET",
+      path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "apiKeys.retrieve",
+      options,
+    });
+  }
+
   /**
    * Revoke an API key
    *
-   * Idempotent: revoking an already-revoked key returns the same body, so a rotation script that
-   * re-runs does not have to special-case having already succeeded. An OAuth member may revoke a
-   * key they created; an organization admin may revoke any key. Organization API keys retain
-   * account-wide authority.
-   * `DELETE /api_keys/{api_key_id}`
+   * Revokes a key. Repeating the request returns the same result.
+   *
+   * With OAuth, members can revoke their own keys; organization admins can revoke any key.
+   * Organization API keys can revoke any key in their account.
+   * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+   * and If-Match.
+   * `DELETE /api-keys/{api_key_id}`
    */
   async revoke(
     apiKeyId: string,
+    params?: ApiKeysRevokeParams,
     options?: RequestOptions,
   ): Promise<ApiResult<ApiKeyResponseRead, ApiKeysRevokeError>> {
     return this._core.request<ApiKeyResponseRead, ApiKeysRevokeError>({
       method: "DELETE",
-      path: `/api_keys/${encodeURIComponent(String(apiKeyId))}`,
+      path: `/api-keys/${encodeURIComponent(String(apiKeyId))}`,
       security: [{"apiKey":[]}],
+      headers: {
+        "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
+      },
       errors: {
+        "400": BadRequestError,
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "404": NotFoundError,
+        "412": PreconditionFailedError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "apiKeys.revoke",
@@ -93,11 +132,18 @@ export class ApiKeysResource {
 }
 
 export interface ApiKeysListParams {
-  /** Maximum number of resources to return. */
+  /**
+   * 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 account,
-   * operation, filters, and ordering that issued it.
+   * 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;
 }
@@ -108,17 +154,42 @@ export type ApiKeysListError =
   | UnauthorizedError
   | ForbiddenError
   | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieve` can produce, as a discriminated union. */
+export type ApiKeysRetrieveError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
+export interface ApiKeysRevokeParams {
+  /**
+   * 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;
+}
+
 /** Every error `revoke` can produce, as a discriminated union. */
 export type ApiKeysRevokeError =
+  | BadRequestError
   | UnauthorizedError
   | ForbiddenError
   | NotFoundError
+  | PreconditionFailedError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError

package/src/resources/definition-revisions.ts

@@ -1,5 +1,5 @@
 // typeship — definitionRevisions 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 { paginate, PagePromise } from "../core/pagination.js";
@@ -10,12 +10,15 @@ import {
   ValidationError,
   BadRequestError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
   RateLimitedError,
   UnauthorizedError,
 } from "../errors.js";
 import type {
   DefinitionDocumentId,
+  DefinitionDocumentResponse,
+  DefinitionDocumentResponseRead,
   DefinitionId,
   DefinitionRevision,
   DefinitionRevisionId,
@@ -31,9 +34,8 @@ export class DefinitionRevisionsResource {
   /**
    * List Definition Revisions
    *
-   * Immutable snapshots of the complete resolved document graph this Definition observed, newest
-   * first. Content is available from the revision and document endpoints and is never embedded in a
-   * list response.
+   * Lists the Definition's revisions, newest first. Source content is not included; retrieve the
+   * revision content or individual documents separately.
    *
    * Auto-paginates: `for await (const item of …)` walks every page.
    * `GET /definitions/{definition_id}/revisions`
@@ -57,6 +59,7 @@ export class DefinitionRevisionsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "definitionRevisions.list",
@@ -74,9 +77,9 @@ export class DefinitionRevisionsResource {
   /**
    * Retrieve a Definition Revision
    *
-   * Metadata for one immutable resolved document graph. Fetch its canonical content or individual
-   * source documents from the content endpoints.
-   * `GET /definition_revisions/{definition_revision_id}`
+   * Returns metadata for a saved Definition Revision. Retrieve its resolved content or individual
+   * source documents separately.
+   * `GET /definition-revisions/{definition_revision_id}`
    */
   async retrieve(
     definitionRevisionId: DefinitionRevisionId,
@@ -84,13 +87,14 @@ export class DefinitionRevisionsResource {
   ): Promise<ApiResult<DefinitionRevisionResponseRead, DefinitionRevisionsRetrieveError>> {
     return this._core.request<DefinitionRevisionResponseRead, DefinitionRevisionsRetrieveError>({
       method: "GET",
-      path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}`,
+      path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}`,
       security: [{"apiKey":[]}],
       errors: {
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "definitionRevisions.retrieve",
@@ -101,9 +105,9 @@ export class DefinitionRevisionsResource {
   /**
    * Retrieve a Definition Revision's canonical content
    *
-   * Returns the exact canonical resolved content identified by the revision's graph digest,
-   * suitable for saving or piping into a diff.
-   * `GET /definition_revisions/{definition_revision_id}/content`
+   * Returns the saved, resolved content for this revision. Save it locally or compare it with
+   * another revision.
+   * `GET /definition-revisions/{definition_revision_id}/content`
    */
   async retrieveContent(
     definitionRevisionId: DefinitionRevisionId,
@@ -111,13 +115,14 @@ export class DefinitionRevisionsResource {
   ): Promise<ApiResult<string, DefinitionRevisionsRetrieveContentError>> {
     return this._core.request<string, DefinitionRevisionsRetrieveContentError>({
       method: "GET",
-      path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}/content`,
+      path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}/content`,
       security: [{"apiKey":[]}],
       errors: {
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "definitionRevisions.retrieveContent",
@@ -127,7 +132,7 @@ export class DefinitionRevisionsResource {
 
   /**
    * Retrieve one source document from a Definition Revision
-   * `GET /definition_revisions/{definition_revision_id}/documents/{document_id}/content`
+   * `GET /definition-revisions/{definition_revision_id}/documents/{document_id}/content`
    */
   async retrieveDocumentContent(
     definitionRevisionId: DefinitionRevisionId,
@@ -136,27 +141,64 @@ export class DefinitionRevisionsResource {
   ): Promise<ApiResult<string, DefinitionRevisionsRetrieveDocumentContentError>> {
     return this._core.request<string, DefinitionRevisionsRetrieveDocumentContentError>({
       method: "GET",
-      path: `/definition_revisions/${encodeURIComponent(String(definitionRevisionId))}/documents/${encodeURIComponent(String(documentId))}/content`,
+      path: `/definition-revisions/${encodeURIComponent(String(definitionRevisionId))}/documents/${encodeURIComponent(String(documentId))}/content`,
       security: [{"apiKey":[]}],
       errors: {
         "401": UnauthorizedError,
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "definitionRevisions.retrieveDocumentContent",
       options,
     });
   }
+
+  /**
+   * Retrieve a Definition Document
+   *
+   * Returns metadata for one source document captured in a Definition Revision. Retrieve its
+   * content through the revision's document content endpoint. A document in another organization
+   * returns 404 not_found.
+   * `GET /definition-documents/{definition_document_id}`
+   */
+  async retrieveDocument(
+    definitionDocumentId: DefinitionDocumentId,
+    options?: RequestOptions,
+  ): Promise<ApiResult<DefinitionDocumentResponseRead, DefinitionRevisionsRetrieveDocumentError>> {
+    return this._core.request<DefinitionDocumentResponseRead, DefinitionRevisionsRetrieveDocumentError>({
+      method: "GET",
+      path: `/definition-documents/${encodeURIComponent(String(definitionDocumentId))}`,
+      security: [{"apiKey":[]}],
+      errors: {
+        "401": UnauthorizedError,
+        "403": ForbiddenError,
+        "404": NotFoundError,
+        "429": RateLimitedError,
+        "500": InternalServerError,
+      },
+      idempotent: true,
+      schemaKey: "definitionRevisions.retrieveDocument",
+      options,
+    });
+  }
 }
 
 export interface DefinitionRevisionsListParams {
-  /** Maximum number of resources to return. */
+  /**
+   * 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 account,
-   * operation, filters, and ordering that issued it.
+   * 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;
 }
@@ -168,6 +210,7 @@ export type DefinitionRevisionsListError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -179,6 +222,7 @@ export type DefinitionRevisionsRetrieveError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -190,6 +234,7 @@ export type DefinitionRevisionsRetrieveContentError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
@@ -201,6 +246,19 @@ export type DefinitionRevisionsRetrieveDocumentContentError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
+  | UnexpectedApiError
+  | ResponseParseError
+  | TransportError
+  | ValidationError;
+
+/** Every error `retrieveDocument` can produce, as a discriminated union. */
+export type DefinitionRevisionsRetrieveDocumentError =
+  | UnauthorizedError
+  | ForbiddenError
+  | NotFoundError
+  | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError

package/src/resources/definitions.ts

@@ -1,5 +1,5 @@
 // typeship — definitions 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 {
@@ -10,7 +10,9 @@ import {
   BadRequestError,
   ConflictError,
   ForbiddenError,
+  InternalServerError,
   NotFoundError,
+  PreconditionFailedError,
   RateLimitedError,
   UnauthorizedError,
   UnprocessableEntityError,
@@ -41,6 +43,7 @@ export class DefinitionsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotent: true,
       schemaKey: "definitions.retrieve",
@@ -51,7 +54,16 @@ export class DefinitionsResource {
   /**
    * Update and resolve a Definition
    *
-   * Resolves the complete document graph and records a new immutable revision before saving.
+   * Resolves the source documents before saving the update and records a new Definition Revision
+   * when the source changes.
+   * Omitted fields remain unchanged; supplied objects and arrays replace the whole field.
+   * If the Definition or its Project configuration changes during validation, returns 409
+   * definition_changed without saving the rejected update. Retrieve the current Definition and
+   * Project, reconcile your changes,
+   * and submit a new request with a new Idempotency-Key if using one.
+   *
+   * See [conditional writes](https://typeship.dev/docs/typeship-api#conditional-writes) for ETag
+   * and If-Match.
    *
    * A `Idempotency-Key` UUID is generated per call (stable across retries) unless you pass one.
    * `PATCH /definitions/{definition_id}`
@@ -67,6 +79,7 @@ export class DefinitionsResource {
       path: `/definitions/${encodeURIComponent(String(definitionId))}`,
       security: [{"apiKey":[]}],
       headers: {
+        "If-Match": params?.ifMatch === undefined ? undefined : String(params?.ifMatch),
         "Idempotency-Key": params?.idempotencyKey === undefined ? undefined : String(params?.idempotencyKey),
       },
       body,
@@ -76,8 +89,10 @@ export class DefinitionsResource {
         "403": ForbiddenError,
         "404": NotFoundError,
         "409": ConflictError,
+        "412": PreconditionFailedError,
         "422": UnprocessableEntityError,
         "429": RateLimitedError,
+        "500": InternalServerError,
       },
       idempotencyKey: "Idempotency-Key",
       schemaKey: "definitions.update",
@@ -92,17 +107,24 @@ export type DefinitionsRetrieveError =
   | ForbiddenError
   | NotFoundError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError
   | ValidationError;
 
 export interface DefinitionsUpdateParams {
+  /**
+   * 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;
   /**
    * 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;
 }
@@ -114,8 +136,10 @@ export type DefinitionsUpdateError =
   | ForbiddenError
   | NotFoundError
   | ConflictError
+  | PreconditionFailedError
   | UnprocessableEntityError
   | RateLimitedError
+  | InternalServerError
   | UnexpectedApiError
   | ResponseParseError
   | TransportError