@typeship-ax/cli 0.10.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/AGENTS.md +10 -5
  2. package/README.md +5 -5
  3. package/api.json +9773 -4501
  4. package/api.md +501 -271
  5. package/dist/api-identity.d.ts.map +1 -1
  6. package/dist/api-identity.js +6 -1
  7. package/dist/cli-agent.d.ts +5 -5
  8. package/dist/cli-agent.d.ts.map +1 -1
  9. package/dist/cli-agent.js +14 -10
  10. package/dist/cli.js +158 -82
  11. package/dist/core/http.d.ts +29 -16
  12. package/dist/core/http.d.ts.map +1 -1
  13. package/dist/core/http.js +108 -25
  14. package/dist/core/pagination.d.ts +8 -8
  15. package/dist/core/pagination.d.ts.map +1 -1
  16. package/dist/core/pagination.js +7 -16
  17. package/dist/errors.d.ts +20 -13
  18. package/dist/errors.d.ts.map +1 -1
  19. package/dist/errors.js +29 -20
  20. package/dist/index.d.ts +37 -19
  21. package/dist/index.d.ts.map +1 -1
  22. package/dist/index.js +42 -18
  23. package/dist/ops.d.ts +5 -1
  24. package/dist/ops.d.ts.map +1 -1
  25. package/dist/ops.js +42 -35
  26. package/dist/polling-login.d.ts.map +1 -1
  27. package/dist/polling-login.js +11 -1
  28. package/dist/resources/api-keys.d.ts +44 -18
  29. package/dist/resources/api-keys.d.ts.map +1 -1
  30. package/dist/resources/api-keys.js +46 -14
  31. package/dist/resources/deliveries.d.ts +46 -0
  32. package/dist/resources/deliveries.d.ts.map +1 -0
  33. package/dist/resources/deliveries.js +70 -0
  34. package/dist/resources/drafts.d.ts +155 -0
  35. package/dist/resources/drafts.d.ts.map +1 -0
  36. package/dist/resources/drafts.js +230 -0
  37. package/dist/resources/files.d.ts +23 -0
  38. package/dist/resources/files.d.ts.map +1 -0
  39. package/dist/resources/files.js +38 -0
  40. package/dist/resources/generate.d.ts +49 -20
  41. package/dist/resources/generate.d.ts.map +1 -1
  42. package/dist/resources/generate.js +56 -14
  43. package/dist/resources/generations.d.ts +70 -18
  44. package/dist/resources/generations.d.ts.map +1 -1
  45. package/dist/resources/generations.js +84 -16
  46. package/dist/resources/organization.d.ts +18 -0
  47. package/dist/resources/organization.d.ts.map +1 -0
  48. package/dist/resources/organization.js +32 -0
  49. package/dist/resources/projects.d.ts +87 -124
  50. package/dist/resources/projects.d.ts.map +1 -1
  51. package/dist/resources/projects.js +70 -173
  52. package/dist/resources/publications.d.ts +46 -0
  53. package/dist/resources/publications.d.ts.map +1 -0
  54. package/dist/resources/publications.js +70 -0
  55. package/dist/resources/releases.d.ts +66 -0
  56. package/dist/resources/releases.d.ts.map +1 -0
  57. package/dist/resources/releases.js +101 -0
  58. package/dist/resources/spec-revisions.d.ts +85 -0
  59. package/dist/resources/spec-revisions.d.ts.map +1 -0
  60. package/dist/resources/spec-revisions.js +116 -0
  61. package/dist/resources/specs.d.ts +72 -0
  62. package/dist/resources/specs.d.ts.map +1 -0
  63. package/dist/resources/specs.js +107 -0
  64. package/dist/resources/targets.d.ts +85 -105
  65. package/dist/resources/targets.d.ts.map +1 -1
  66. package/dist/resources/targets.js +70 -163
  67. package/dist/schemas.d.ts +1 -0
  68. package/dist/schemas.d.ts.map +1 -1
  69. package/dist/schemas.js +194 -139
  70. package/dist/types.d.ts +2626 -1141
  71. package/dist/types.d.ts.map +1 -1
  72. package/dist/types.js +90 -11
  73. package/package.json +3 -3
  74. package/src/api-identity.ts +6 -2
  75. package/src/cli-agent.ts +17 -13
  76. package/src/cli.ts +145 -77
  77. package/src/core/http.ts +106 -30
  78. package/src/core/pagination.ts +13 -23
  79. package/src/errors.ts +30 -20
  80. package/src/index.ts +46 -24
  81. package/src/ops.ts +47 -36
  82. package/src/polling-login.ts +10 -1
  83. package/src/resources/api-keys.ts +87 -19
  84. package/src/resources/deliveries.ts +139 -0
  85. package/src/resources/drafts.ts +422 -0
  86. package/src/resources/files.ts +68 -0
  87. package/src/resources/generate.ts +81 -19
  88. package/src/resources/generations.ts +167 -29
  89. package/src/resources/organization.ts +53 -0
  90. package/src/resources/projects.ts +129 -322
  91. package/src/resources/publications.ts +139 -0
  92. package/src/resources/releases.ts +199 -0
  93. package/src/resources/spec-revisions.ts +237 -0
  94. package/src/resources/specs.ts +200 -0
  95. package/src/resources/targets.ts +135 -304
  96. package/src/schemas.ts +195 -140
  97. package/src/types.ts +2793 -1177
  98. package/dist/resources/account.d.ts +0 -18
  99. package/dist/resources/account.d.ts.map +0 -1
  100. package/dist/resources/account.js +0 -27
  101. package/dist/resources/definition-revisions.d.ts +0 -58
  102. package/dist/resources/definition-revisions.d.ts.map +0 -1
  103. package/dist/resources/definition-revisions.js +0 -114
  104. package/dist/resources/definitions.d.ts +0 -35
  105. package/dist/resources/definitions.d.ts.map +0 -1
  106. package/dist/resources/definitions.js +0 -60
  107. package/src/resources/account.ts +0 -46
  108. package/src/resources/definition-revisions.ts +0 -207
  109. package/src/resources/definitions.ts +0 -122
package/dist/core/http.js CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Runtime core. Generated by typeship — https://typeship.dev
3
- * Zero dependencies: built on the platform fetch API (Node 18+, browsers, edge).
3
+ * Zero dependencies: built on the platform fetch API (Node 20+, browsers, edge).
4
4
  */
5
5
  /** Collapse a result into its data, throwing the typed error when !ok. */
6
6
  export function unwrap(result) {
@@ -10,14 +10,83 @@ export function unwrap(result) {
10
10
  throw result.error;
11
11
  throw new Error(String(result.error));
12
12
  }
13
+ /** Adapter for generated CLI and MCP entry points that consume result objects. */
14
+ export async function asApiResult(call) {
15
+ try {
16
+ const data = await call;
17
+ const pageResponse = data && typeof data === "object" && "response" in data
18
+ ? data.response : undefined;
19
+ const response = pageResponse ?? {
20
+ status: 0,
21
+ headers: new Headers(),
22
+ rawBody: data,
23
+ requestId: requestIdFromBody(data),
24
+ };
25
+ return { ok: true, data, response };
26
+ }
27
+ catch (error) {
28
+ const response = error && typeof error === "object" && "response" in error
29
+ ? error.response : undefined;
30
+ return { ok: false, error, response };
31
+ }
32
+ }
33
+ /** Common fields on every failure. A missing response has status null. */
34
+ export class SdkError extends Error {
35
+ code;
36
+ status;
37
+ requestId;
38
+ body;
39
+ constructor(message, code, status = null, body, requestId) {
40
+ super(message);
41
+ this.name = new.target.name;
42
+ this.code = code;
43
+ this.status = status;
44
+ this.body = body;
45
+ this.requestId = requestId;
46
+ }
47
+ }
48
+ function errorCode(body, fallback) {
49
+ if (body && typeof body === "object" && !Array.isArray(body)) {
50
+ const value = body;
51
+ const first = Array.isArray(value.errors) ? value.errors[0] : undefined;
52
+ const code = value.code ?? first?.code;
53
+ if (typeof code === "string" && code.trim())
54
+ return code;
55
+ }
56
+ return fallback;
57
+ }
58
+ function errorDetail(body) {
59
+ if (!body || typeof body !== "object" || Array.isArray(body))
60
+ return "";
61
+ const value = body;
62
+ const first = Array.isArray(value.errors) ? value.errors[0] : undefined;
63
+ const detail = value.message ?? value.error ?? value.detail ?? first?.message;
64
+ return typeof detail === "string" && detail.trim() ? ": " + detail : "";
65
+ }
66
+ function nextStep(status) {
67
+ if (status === 401)
68
+ return "Check the credential and retry.";
69
+ if (status === 403)
70
+ return "Check the credential's permissions and retry.";
71
+ if (status === 404)
72
+ return "Check the requested identifier or path.";
73
+ if (status === 409)
74
+ return "Refresh the resource and retry the change.";
75
+ if (status === 422 || status === 400)
76
+ return "Correct the request and retry.";
77
+ if (status === 429)
78
+ return "Wait before retrying the request.";
79
+ if (status >= 500)
80
+ return "Retry later; contact the API provider if this continues.";
81
+ return "Inspect the error body and correct the request before retrying.";
82
+ }
13
83
  /** Base class for every HTTP error response. */
14
- export class ApiError extends Error {
84
+ export class ApiError extends SdkError {
15
85
  status;
16
86
  body;
17
87
  response;
18
88
  constructor(message, status, body, response) {
19
- super(message);
20
- this.name = new.target.name;
89
+ super(message + errorDetail(body) + ". " + nextStep(status), errorCode(body, "http_" + status), status, body, response.requestId);
21
90
  this.status = status;
22
91
  this.body = body;
23
92
  this.response = response;
@@ -30,32 +99,31 @@ export class UnexpectedApiError extends ApiError {
30
99
  }
31
100
  }
32
101
  /** A successful response declared JSON but carried a body that could not be parsed. */
33
- export class ResponseParseError extends Error {
102
+ export class ResponseParseError extends SdkError {
34
103
  status;
35
104
  body;
36
105
  response;
37
106
  cause;
38
107
  constructor(body, response, cause) {
39
- super("HTTP " + response.status + " response body was not valid JSON");
40
- this.name = "ResponseParseError";
108
+ super("HTTP " + response.status + " response body was not valid JSON. Check the API response or contact its provider.", "response_parse_error", response.status, body, response.requestId);
41
109
  this.status = response.status;
42
110
  this.body = body;
43
111
  this.response = response;
44
112
  this.cause = cause;
45
113
  }
46
114
  }
47
- /** Request or response data did not match the spec's schema (opt-in via the
48
- * client's validate option). Never thrown: returned as the error side of
49
- * ApiResult, like every other failure. */
50
- export class ValidationError extends Error {
115
+ /** Request or response data did not match the spec's schema. */
116
+ export class ValidationError extends SdkError {
51
117
  direction;
118
+ target;
52
119
  violations;
53
- constructor(direction, violations) {
120
+ constructor(direction, violations, target = "body") {
54
121
  const shown = violations.slice(0, 3).map((v) => v.path + " " + v.message).join("; ");
55
- super(direction + " body failed schema validation: " + shown
56
- + (violations.length > 3 ? " (+" + (violations.length - 3) + " more)" : ""));
57
- this.name = "ValidationError";
122
+ super(direction + " " + target + " failed schema validation: " + shown
123
+ + (violations.length > 3 ? " (+" + (violations.length - 3) + " more)" : "")
124
+ + ". Correct the " + (direction === "request" ? "request" : "API response or update the spec") + ".", "validation_error");
58
125
  this.direction = direction;
126
+ this.target = target;
59
127
  this.violations = violations;
60
128
  }
61
129
  }
@@ -93,7 +161,17 @@ export function validateAgainstSchema(value, schema, path, out, defs) {
93
161
  for (const sub of s.allOf)
94
162
  validateAgainstSchema(value, sub, path, out, defs);
95
163
  const variants = s.anyOf ?? s.oneOf;
96
- if (Array.isArray(variants) && variants.length > 0) {
164
+ const discriminator = s.responseDiscriminator;
165
+ const tag = typeof discriminator?.propertyName === "string" && value && typeof value === "object" && !Array.isArray(value)
166
+ ? value[discriminator.propertyName] : undefined;
167
+ if (typeof tag === "string") {
168
+ if (Object.hasOwn(discriminator.mapping, tag)) {
169
+ validateAgainstSchema(value, discriminator.mapping[tag], path, out, defs);
170
+ }
171
+ // Unknown variants remain raw data. Callers must handle their tag before
172
+ // interpreting fields or taking an action based on workflow state.
173
+ }
174
+ else if (Array.isArray(variants) && variants.length > 0) {
97
175
  const matched = variants.some((sub) => {
98
176
  const scratch = [];
99
177
  validateAgainstSchema(value, sub, path, scratch, defs);
@@ -190,12 +268,13 @@ function transportFailureMessage(method, url, cause) {
190
268
  return method + " " + url + " failed: " + detail;
191
269
  }
192
270
  /** The request failed before a complete HTTP response arrived (network failure, timeout, abort, or truncated body). */
193
- export class TransportError extends Error {
271
+ export class TransportError extends SdkError {
194
272
  cause;
195
- constructor(message, cause) {
196
- super(message);
197
- this.name = "TransportError";
273
+ response;
274
+ constructor(message, cause, response) {
275
+ super(message + ". Check the connection and retry.", "transport_error", response?.status ?? null, undefined, response?.requestId);
198
276
  this.cause = cause;
277
+ this.response = response;
199
278
  }
200
279
  }
201
280
  /** Resolve one complete alternative in spec order. Missing or incompatible
@@ -348,7 +427,7 @@ export class HttpCore {
348
427
  catch (cause) {
349
428
  const parseError = cause instanceof ResponseParseError ? cause : undefined;
350
429
  emitResponseDebug(response, parseError?.body);
351
- const error = (parseError ?? new TransportError("The response body read failed before completing", cause));
430
+ const error = (parseError ?? new TransportError("The response body read failed before completing", cause, meta(response)));
352
431
  await this.config.onError?.(error, { method: req.method, path: req.path });
353
432
  return { ok: false, error, response: parseError?.response ?? meta(response) };
354
433
  }
@@ -394,8 +473,8 @@ export class HttpCore {
394
473
  try {
395
474
  body = await parseBody(response, req.method);
396
475
  }
397
- catch {
398
- body = undefined; // error responses keep their status even if the body read aborts
476
+ catch (cause) {
477
+ body = cause instanceof ResponseParseError ? cause.body : undefined;
399
478
  }
400
479
  emitResponseDebug(response, body);
401
480
  const responseMeta = meta(response, body);
@@ -413,6 +492,10 @@ export class HttpCore {
413
492
  await this.config.onError?.(error, { method: req.method, path: req.path });
414
493
  return { ok: false, error };
415
494
  }
495
+ /** SDK-facing call: resolve to the payload or throw its typed error. */
496
+ async requestData(req) {
497
+ return unwrap(await this.request(req));
498
+ }
416
499
  async send(req, timeoutMs, attempt, autoIdempotencyKey) {
417
500
  const selected = req.security && this.config.credentials ? selectSecurity(req.security, this.config.credentials) : {};
418
501
  const headers = {};
@@ -637,8 +720,8 @@ function meta(response, body) {
637
720
  undefined,
638
721
  };
639
722
  }
640
- /** AbortSignal.any reached Node in 18.17. Keep the package's Node 18 floor
641
- * honest for earlier 18.x releases and for web runtimes without it. */
723
+ /** AbortSignal.any is missing from some web and edge runtimes; compose the
724
+ * signals by hand there. */
642
725
  function composeSignals(signals) {
643
726
  const nativeAny = AbortSignal.any;
644
727
  if (nativeAny)
@@ -1,10 +1,10 @@
1
1
  /**
2
2
  * Auto-pagination. Generated by typeship — https://typeship.dev
3
3
  *
4
- * List operations return a PagePromise: `await` it for one page (a typed
5
- * ApiResult), or `for await` it to stream every item across every page.
4
+ * List operations return a PagePromise: `await` it for one page, or
5
+ * `for await` it to stream every item across every page.
6
6
  */
7
- import { HttpCore, type ApiResult, type CoreRequest, type ResponseMeta } from "./http.js";
7
+ import { HttpCore, type CoreRequest, type ResponseMeta } from "./http.js";
8
8
  export interface PageConfig {
9
9
  style: "cursor" | "cursorFromLastId" | "page" | "offset";
10
10
  /** Response field holding the item array ("data", "items", …). */
@@ -19,7 +19,7 @@ export interface PageConfig {
19
19
  offsetParam?: string;
20
20
  limitParam?: string;
21
21
  }
22
- type FetchPage<Item, E> = (query: Record<string, unknown>) => Promise<ApiResult<Page<Item, E>, E>>;
22
+ type FetchPage<Item, E> = (query: Record<string, unknown>) => Promise<Page<Item, E>>;
23
23
  export declare class Page<Item, E = unknown> {
24
24
  private readonly fetchPage;
25
25
  private readonly config;
@@ -37,13 +37,13 @@ export declare class Page<Item, E = unknown> {
37
37
  private looksLikeMore;
38
38
  }
39
39
  /**
40
- * Awaitable (one page, as a typed ApiResult) and async-iterable (all items,
40
+ * Awaitable (one page) and async-iterable (all items,
41
41
  * all pages). Iteration throws the operation's typed error union on failure.
42
42
  */
43
- export declare class PagePromise<Item, E> implements PromiseLike<ApiResult<Page<Item, E>, E>>, AsyncIterable<Item> {
43
+ export declare class PagePromise<Item, E> implements PromiseLike<Page<Item, E>>, AsyncIterable<Item> {
44
44
  private readonly first;
45
- constructor(first: Promise<ApiResult<Page<Item, E>, E>>);
46
- then<R1 = ApiResult<Page<Item, E>, E>, R2 = never>(onfulfilled?: ((value: ApiResult<Page<Item, E>, E>) => R1 | PromiseLike<R1>) | null, onrejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null): Promise<R1 | R2>;
45
+ constructor(first: Promise<Page<Item, E>>);
46
+ then<R1 = Page<Item, E>, R2 = never>(onfulfilled?: ((value: Page<Item, E>) => R1 | PromiseLike<R1>) | null, onrejected?: ((reason: unknown) => R2 | PromiseLike<R2>) | null): Promise<R1 | R2>;
47
47
  [Symbol.asyncIterator](): AsyncIterator<Item, void, undefined>;
48
48
  }
49
49
  export declare function paginate<Item, E>(core: HttpCore, req: CoreRequest, config: PageConfig): PagePromise<Item, E>;
@@ -1 +1 @@
1
- {"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/core/pagination.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,QAAQ,EACR,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,QAAQ,GAAG,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;IACzD,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC,IAAI,CACxB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAE1C,qBAAa,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;IACjD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;gBAG9B,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,EAC7B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,YAAY;IASxB,IAAI,KAAK,IAAI,IAAI,EAAE,CAGlB;IAED,WAAW,IAAI,OAAO;IAItB,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAoBhD,iGAAiG;IAC3F,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAUlD,+DAA+D;IACxD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC;IAQrE,OAAO,CAAC,aAAa;CAUtB;AAED;;;GAGG;AACH,qBAAa,WAAW,CAAC,IAAI,EAAE,CAAC,CAAE,YAAW,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC;IACxG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuC;gBACjD,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAIvD,IAAI,CAAC,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EAC/C,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EACnF,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,GAC9D,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;IAIZ,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC;CAOtE;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,CAAC,EAC9B,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,UAAU,GACjB,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAgBtB"}
1
+ {"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../../src/core/pagination.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,QAAQ,EACR,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,WAAW,CAAC;AAEnB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,QAAQ,GAAG,kBAAkB,GAAG,MAAM,GAAG,QAAQ,CAAC;IACzD,kEAAkE;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC,IAAI,CACxB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC3B,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAE5B,qBAAa,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAC/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;IACjD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC;gBAG9B,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,EAC7B,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAI,EAAE,OAAO,EACb,QAAQ,EAAE,YAAY;IASxB,IAAI,KAAK,IAAI,IAAI,EAAE,CAGlB;IAED,WAAW,IAAI,OAAO;IAItB,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAoBhD,iGAAiG;IAC3F,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAMlD,+DAA+D;IACxD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC;IAQrE,OAAO,CAAC,aAAa;CAUtB;AAED;;;GAGG;AACH,qBAAa,WAAW,CAAC,IAAI,EAAE,CAAC,CAAE,YAAW,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC;IAC1F,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;gBACnC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAIzC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,GAAG,KAAK,EACjC,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EACrE,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,GAC9D,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;IAIZ,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC;CAGtE;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,CAAC,EAC9B,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,WAAW,EAChB,MAAM,EAAE,UAAU,GACjB,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAetB"}
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Auto-pagination. Generated by typeship — https://typeship.dev
3
3
  *
4
- * List operations return a PagePromise: `await` it for one page (a typed
5
- * ApiResult), or `for await` it to stream every item across every page.
4
+ * List operations return a PagePromise: `await` it for one page, or
5
+ * `for await` it to stream every item across every page.
6
6
  */
7
7
  export class Page {
8
8
  fetchPage;
@@ -49,11 +49,7 @@ export class Page {
49
49
  const next = this.nextPageParams();
50
50
  if (next === null)
51
51
  return null;
52
- const result = await this.fetchPage(next);
53
- if (!result.ok) {
54
- throw result.error instanceof Error ? result.error : new Error(String(result.error));
55
- }
56
- return result.data;
52
+ return this.fetchPage(next);
57
53
  }
58
54
  /** Iterate every item on this page and all following pages. */
59
55
  async *[Symbol.asyncIterator]() {
@@ -78,7 +74,7 @@ export class Page {
78
74
  }
79
75
  }
80
76
  /**
81
- * Awaitable (one page, as a typed ApiResult) and async-iterable (all items,
77
+ * Awaitable (one page) and async-iterable (all items,
82
78
  * all pages). Iteration throws the operation's typed error union on failure.
83
79
  */
84
80
  export class PagePromise {
@@ -90,11 +86,7 @@ export class PagePromise {
90
86
  return this.first.then(onfulfilled, onrejected);
91
87
  }
92
88
  async *[Symbol.asyncIterator]() {
93
- const result = await this.first;
94
- if (!result.ok) {
95
- throw result.error instanceof Error ? result.error : new Error(String(result.error));
96
- }
97
- yield* result.data;
89
+ yield* await this.first;
98
90
  }
99
91
  }
100
92
  export function paginate(core, req, config) {
@@ -103,9 +95,8 @@ export function paginate(core, req, config) {
103
95
  let nextReq = { ...req, query: params };
104
96
  const result = await core.request(nextReq);
105
97
  if (!result.ok)
106
- return result;
107
- const page = new Page(fetchPage, config, params, result.data, result.response);
108
- return { ok: true, data: page, response: result.response };
98
+ throw result.error instanceof Error ? result.error : new Error(String(result.error));
99
+ return new Page(fetchPage, config, params, result.data, result.response);
109
100
  };
110
101
  const initial = {};
111
102
  let seed = req.query ?? {};
package/dist/errors.d.ts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { ApiError, type ResponseMeta } from "./core/http.js";
2
2
  import type { ErrorModelRead } from "./types.js";
3
- export { ApiError, ResponseParseError, TransportError, UnexpectedApiError, ValidationError, type Violation, unwrap } from "./core/http.js";
3
+ export { ApiError, SdkError, ResponseParseError, TransportError, UnexpectedApiError, ValidationError, type Violation } from "./core/http.js";
4
4
  /**
5
- * The request body, Definition source, target selection, or package name is invalid.
5
+ * The request body, Spec source, target selection, or package name is invalid.
6
6
  * Raised for HTTP 400 responses.
7
7
  */
8
8
  export declare class BadRequestError extends ApiError<400, ErrorModelRead> {
@@ -37,7 +37,7 @@ export declare class PayloadTooLargeError extends ApiError<413, ErrorModelRead>
37
37
  constructor(body: ErrorModelRead, response: ResponseMeta);
38
38
  }
39
39
  /**
40
- * The Definition could not be resolved or understood.
40
+ * The Spec could not be resolved or understood.
41
41
  * Raised for HTTP 422 responses.
42
42
  */
43
43
  export declare class UnprocessableEntityError extends ApiError<422, ErrorModelRead> {
@@ -51,6 +51,13 @@ export declare class UnprocessableEntityError extends ApiError<422, ErrorModelRe
51
51
  export declare class RateLimitedError extends ApiError<429, ErrorModelRead> {
52
52
  constructor(body: ErrorModelRead, response: ResponseMeta);
53
53
  }
54
+ /**
55
+ * An unexpected error prevented the request from completing.
56
+ * Raised for HTTP 500 responses.
57
+ */
58
+ export declare class InternalServerError extends ApiError<500, ErrorModelRead> {
59
+ constructor(body: ErrorModelRead, response: ResponseMeta);
60
+ }
54
61
  /**
55
62
  * Unexpected error.
56
63
  * Raised for "default" responses.
@@ -59,28 +66,28 @@ export declare class ApiResponseError extends ApiError<number, ErrorModelRead> {
59
66
  constructor(body: ErrorModelRead, response: ResponseMeta);
60
67
  }
61
68
  /**
62
- * The plan does not include another project or the requested target configuration.
63
- * Raised for HTTP 402 responses.
69
+ * No such resource in this organization.
70
+ * Raised for HTTP 404 responses.
64
71
  */
65
- export declare class PaymentRequiredError extends ApiError<402, ErrorModelRead> {
72
+ export declare class NotFoundError extends ApiError<404, ErrorModelRead> {
66
73
  constructor(body: ErrorModelRead, response: ResponseMeta);
67
74
  }
68
75
  /**
69
- * Project setup failed unexpectedly; the key reservation is released.
70
- * Raised for HTTP 500 responses.
76
+ * The plan does not include another project or the requested target configuration.
77
+ * Raised for HTTP 402 responses.
71
78
  */
72
- export declare class InternalServerError extends ApiError<500, ErrorModelRead> {
79
+ export declare class PaymentRequiredError extends ApiError<402, ErrorModelRead> {
73
80
  constructor(body: ErrorModelRead, response: ResponseMeta);
74
81
  }
75
82
  /**
76
- * No such resource in this account.
77
- * Raised for HTTP 404 responses.
83
+ * The resource changed since the ETag supplied in If-Match. No write was applied.
84
+ * Raised for HTTP 412 responses.
78
85
  */
79
- export declare class NotFoundError extends ApiError<404, ErrorModelRead> {
86
+ export declare class PreconditionFailedError extends ApiError<412, ErrorModelRead> {
80
87
  constructor(body: ErrorModelRead, response: ResponseMeta);
81
88
  }
82
89
  /**
83
- * The Project was saved, but an obsolete release pull request could not be retired.
90
+ * Dependent work failed while completing the request.
84
91
  * Raised for HTTP 502 responses.
85
92
  */
86
93
  export declare class BadGatewayError extends ApiError<502, ErrorModelRead> {
@@ -1 +1 @@
1
- {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,KAAK,EAAc,cAAc,EAAE,MAAM,YAAY,CAAC;AAE7D,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE,eAAe,EAAE,KAAK,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE3I;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACpD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACtD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACnD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAClD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACzD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAC7D,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACrD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;gBACxD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACzD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACxD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAClD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACpD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD"}
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,KAAK,EAAc,cAAc,EAAE,MAAM,YAAY,CAAC;AAE7D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,kBAAkB,EAAE,eAAe,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE7I;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACpD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACtD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACnD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAClD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACzD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAC7D,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACrD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACxD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;gBACxD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,aAAc,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAClD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACzD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBAC5D,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ,CAAC,GAAG,EAAE,cAAc,CAAC;gBACpD,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,YAAY;CAGzD"}
package/dist/errors.js CHANGED
@@ -1,14 +1,14 @@
1
1
  // typeship — typed error classes.
2
- // Generated by typeship — https://typeship.dev — do not edit by hand.
2
+ // Generated by typeship — https://typeship.dev
3
3
  import { ApiError } from "./core/http.js";
4
- export { ApiError, ResponseParseError, TransportError, UnexpectedApiError, ValidationError, unwrap } from "./core/http.js";
4
+ export { ApiError, SdkError, ResponseParseError, TransportError, UnexpectedApiError, ValidationError } from "./core/http.js";
5
5
  /**
6
- * The request body, Definition source, target selection, or package name is invalid.
6
+ * The request body, Spec source, target selection, or package name is invalid.
7
7
  * Raised for HTTP 400 responses.
8
8
  */
9
9
  export class BadRequestError extends ApiError {
10
10
  constructor(body, response) {
11
- super("The request body, Definition source, target selection, or package name is invalid.", 400, body, response);
11
+ super("The request body, Spec source, target selection, or package name is invalid.", 400, body, response);
12
12
  }
13
13
  }
14
14
  /**
@@ -48,12 +48,12 @@ export class PayloadTooLargeError extends ApiError {
48
48
  }
49
49
  }
50
50
  /**
51
- * The Definition could not be resolved or understood.
51
+ * The Spec could not be resolved or understood.
52
52
  * Raised for HTTP 422 responses.
53
53
  */
54
54
  export class UnprocessableEntityError extends ApiError {
55
55
  constructor(body, response) {
56
- super("The Definition could not be resolved or understood.", 422, body, response);
56
+ super("The Spec could not be resolved or understood.", 422, body, response);
57
57
  }
58
58
  }
59
59
  /**
@@ -66,6 +66,15 @@ export class RateLimitedError extends ApiError {
66
66
  super("Too many requests, or an identical write is still in progress. Wait for Retry-After before retrying.", 429, body, response);
67
67
  }
68
68
  }
69
+ /**
70
+ * An unexpected error prevented the request from completing.
71
+ * Raised for HTTP 500 responses.
72
+ */
73
+ export class InternalServerError extends ApiError {
74
+ constructor(body, response) {
75
+ super("An unexpected error prevented the request from completing.", 500, body, response);
76
+ }
77
+ }
69
78
  /**
70
79
  * Unexpected error.
71
80
  * Raised for "default" responses.
@@ -76,38 +85,38 @@ export class ApiResponseError extends ApiError {
76
85
  }
77
86
  }
78
87
  /**
79
- * The plan does not include another project or the requested target configuration.
80
- * Raised for HTTP 402 responses.
88
+ * No such resource in this organization.
89
+ * Raised for HTTP 404 responses.
81
90
  */
82
- export class PaymentRequiredError extends ApiError {
91
+ export class NotFoundError extends ApiError {
83
92
  constructor(body, response) {
84
- super("The plan does not include another project or the requested target configuration.", 402, body, response);
93
+ super("No such resource in this organization.", 404, body, response);
85
94
  }
86
95
  }
87
96
  /**
88
- * Project setup failed unexpectedly; the key reservation is released.
89
- * Raised for HTTP 500 responses.
97
+ * The plan does not include another project or the requested target configuration.
98
+ * Raised for HTTP 402 responses.
90
99
  */
91
- export class InternalServerError extends ApiError {
100
+ export class PaymentRequiredError extends ApiError {
92
101
  constructor(body, response) {
93
- super("Project setup failed unexpectedly; the key reservation is released.", 500, body, response);
102
+ super("The plan does not include another project or the requested target configuration.", 402, body, response);
94
103
  }
95
104
  }
96
105
  /**
97
- * No such resource in this account.
98
- * Raised for HTTP 404 responses.
106
+ * The resource changed since the ETag supplied in If-Match. No write was applied.
107
+ * Raised for HTTP 412 responses.
99
108
  */
100
- export class NotFoundError extends ApiError {
109
+ export class PreconditionFailedError extends ApiError {
101
110
  constructor(body, response) {
102
- super("No such resource in this account.", 404, body, response);
111
+ super("The resource changed since the ETag supplied in If-Match. No write was applied.", 412, body, response);
103
112
  }
104
113
  }
105
114
  /**
106
- * The Project was saved, but an obsolete release pull request could not be retired.
115
+ * Dependent work failed while completing the request.
107
116
  * Raised for HTTP 502 responses.
108
117
  */
109
118
  export class BadGatewayError extends ApiError {
110
119
  constructor(body, response) {
111
- super("The Project was saved, but an obsolete release pull request could not be retired.", 502, body, response);
120
+ super("Dependent work failed while completing the request.", 502, body, response);
112
121
  }
113
122
  }
package/dist/index.d.ts CHANGED
@@ -1,14 +1,19 @@
1
1
  import { type AuthValue, type DebugEvent, type RequestContext } from "./core/http.js";
2
2
  import { GenerateResource } from "./resources/generate.js";
3
3
  import { ProjectsResource } from "./resources/projects.js";
4
- import { DefinitionsResource } from "./resources/definitions.js";
4
+ import { SpecsResource } from "./resources/specs.js";
5
+ import { SpecRevisionsResource } from "./resources/spec-revisions.js";
5
6
  import { TargetsResource } from "./resources/targets.js";
7
+ import { DraftsResource } from "./resources/drafts.js";
8
+ import { ReleasesResource } from "./resources/releases.js";
9
+ import { DeliveriesResource } from "./resources/deliveries.js";
10
+ import { PublicationsResource } from "./resources/publications.js";
6
11
  import { GenerationsResource } from "./resources/generations.js";
7
- import { DefinitionRevisionsResource } from "./resources/definition-revisions.js";
8
- import { AccountResource } from "./resources/account.js";
12
+ import { FilesResource } from "./resources/files.js";
13
+ import { OrganizationResource } from "./resources/organization.js";
9
14
  import { ApiKeysResource } from "./resources/api-keys.js";
10
15
  /** This package's version, also sent as the `User-Agent`. */
11
- export declare const VERSION = "0.10.0";
16
+ export declare const VERSION = "0.21.0";
12
17
  export interface ClientOptions {
13
18
  /** Override the server URL. Default: `https://typeship.dev/api/v1` */
14
19
  baseUrl?: string;
@@ -18,8 +23,8 @@ export interface ClientOptions {
18
23
  */
19
24
  bearerToken?: string | (() => string | Promise<string>);
20
25
  /**
21
- * Credentials keyed by the Definition's security scheme names. Only one complete alternative is
22
- * sent for each operation. Named values take precedence over convenience options.
26
+ * Credentials keyed by the Spec's security scheme names. Only one complete alternative is sent
27
+ * for each operation. Named values take precedence over convenience options.
23
28
  */
24
29
  credentials?: {
25
30
  "apiKey"?: AuthValue;
@@ -58,9 +63,8 @@ export interface ClientOptions {
58
63
  debug?: boolean | ((event: DebugEvent) => void);
59
64
  /**
60
65
  * Opt-in zero-dependency runtime validation of JSON bodies against the spec's schemas: true
61
- * checks requests and responses and returns a ValidationError on mismatch (as the ApiResult
62
- * error, never thrown); mode "warn" logs via console.warn and lets the call proceed. Catches spec
63
- * drift the type system can't see.
66
+ * checks requests and responses and throws ValidationError on mismatch; mode "warn" logs via
67
+ * console.warn and lets the call proceed. Catches spec drift the type system can't see.
64
68
  */
65
69
  validate?: boolean | {
66
70
  requests?: boolean;
@@ -69,10 +73,10 @@ export interface ClientOptions {
69
73
  };
70
74
  }
71
75
  /**
72
- * typeship — v0.10.0
76
+ * typeship — v0.21.0
73
77
  *
74
- * Resolve an OpenAPI or GraphQL Definition, diagnose it, and keep every
75
- * selected SDK, CLI, and MCP Target current.
78
+ * Resolve an OpenAPI or GraphQL Spec, diagnose it, and keep every
79
+ * selected CLI, MCP, and SDK Target current.
76
80
  *
77
81
  * Every operation but one requires a bearer credential: an organization
78
82
  * API key from the console, or an OAuth access token carrying the operation's
@@ -80,28 +84,42 @@ export interface ClientOptions {
80
84
  * consent. OAuth grants cannot switch organizations after consent. A browser
81
85
  * session is not a credential for this API. The exception is POST /generate,
82
86
  * which works anonymously with the free plan's limits.
87
+ *
88
+ * Examples use Parcel, a fictional delivery service. Replace its domains,
89
+ * repository names, and resource identifiers with your own. The hosted
90
+ * petstore Spec is a runnable sample.
83
91
  */
84
92
  export declare class TypeshipClient {
85
93
  readonly generate: GenerateResource;
86
94
  readonly projects: ProjectsResource;
87
- readonly definitions: DefinitionsResource;
95
+ readonly specs: SpecsResource;
96
+ readonly specRevisions: SpecRevisionsResource;
88
97
  readonly targets: TargetsResource;
98
+ readonly drafts: DraftsResource;
99
+ readonly releases: ReleasesResource;
100
+ readonly deliveries: DeliveriesResource;
101
+ readonly publications: PublicationsResource;
89
102
  readonly generations: GenerationsResource;
90
- readonly definitionRevisions: DefinitionRevisionsResource;
91
- readonly account: AccountResource;
103
+ readonly files: FilesResource;
104
+ readonly organization: OrganizationResource;
92
105
  readonly apiKeys: ApiKeysResource;
93
106
  constructor(options?: ClientOptions);
94
107
  }
95
108
  export * from "./types.js";
96
109
  export * from "./errors.js";
97
- export { formatDebugEvent, type ApiResult, type AuthValue, type DebugEvent, type RequestContext, type RequestOptions, type ResponseMeta, } from "./core/http.js";
110
+ export { formatDebugEvent, type AuthValue, type DebugEvent, type RequestContext, type RequestOptions, type ResponseMeta, } from "./core/http.js";
98
111
  export { Page, PagePromise } from "./core/pagination.js";
99
112
  export * from "./resources/generate.js";
100
113
  export * from "./resources/projects.js";
101
- export * from "./resources/definitions.js";
114
+ export * from "./resources/specs.js";
115
+ export * from "./resources/spec-revisions.js";
102
116
  export * from "./resources/targets.js";
117
+ export * from "./resources/drafts.js";
118
+ export * from "./resources/releases.js";
119
+ export * from "./resources/deliveries.js";
120
+ export * from "./resources/publications.js";
103
121
  export * from "./resources/generations.js";
104
- export * from "./resources/definition-revisions.js";
105
- export * from "./resources/account.js";
122
+ export * from "./resources/files.js";
123
+ export * from "./resources/organization.js";
106
124
  export * from "./resources/api-keys.js";
107
125
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAGL,KAAK,SAAS,EAEd,KAAK,UAAU,EACf,KAAK,cAAc,EAEpB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,6DAA6D;AAC7D,eAAO,MAAM,OAAO,WAAW,CAAC;AAGhC,MAAM,WAAW,aAAa;IAC5B,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD;;;OAGG;IACH,WAAW,CAAC,EAAE;QACZ,QAAQ,CAAC,EAAE,SAAS,CAAC;KACtB,CAAC;IACF,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnF;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC;IAChD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3F;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,mBAAmB,EAAE,2BAA2B,CAAC;IAC1D,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;gBAEtB,OAAO,GAAE,aAAkB;CA8DxC;AAED,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,gBAAgB,EAChB,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEzD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAGL,KAAK,SAAS,EAEd,KAAK,UAAU,EACf,KAAK,cAAc,EAEpB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,6DAA6D;AAC7D,eAAO,MAAM,OAAO,WAAW,CAAC;AAGhC,MAAM,WAAW,aAAa;IAC5B,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACxD;;;OAGG;IACH,WAAW,CAAC,EAAE;QACZ,QAAQ,CAAC,EAAE,SAAS,CAAC;KACtB,CAAC;IACF,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,uCAAuC;IACvC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnF;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;KAAE,CAAC;CAC3F;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,cAAc;IACzB,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC;IAC9C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAC5C,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,oBAAoB,CAAC;IAC5C,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;gBAEtB,OAAO,GAAE,aAAkB;CAmExC;AAED,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,gBAAgB,EAChB,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEzD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC"}