@shipstatic/ship 2.0.0-beta.17 → 2.0.0-beta.19

package/dist/index.d.cts

@@ -79,97 +79,6 @@ interface DeploymentCreateResponse extends Deployment {
     /** Claim URL for public deployments. Present when deployed without credentials. */
     readonly claim?: string;
 }
-/**
- * Every path the public API answers on, declared once.
- *
- * The URL surface was written out in four places — the API's mounts, the
- * SDK's client, the dashboard's client, and the post-deploy smoke — so a
- * rename meant finding all four. The first three now read this table.
- *
- * The smoke (`cloudflare/api/smoke.mjs`) deliberately still spells its own:
- * five of its nine paths are `/admin/*`, which this table excludes by
- * design, and splitting one list between a registry and literals reads worse
- * than keeping it uniform.
- *
- * **What this guarantees, exactly.** Collection paths are mounted from here,
- * so producer and consumer cannot diverge. Item paths are declared here and
- * consumed by clients, but the API spells them relative to their mount
- * (`/:deployment/config`), so the table does not *generate* them — it is
- * held to them by `api/tests/architecture/api-paths.test.ts`, which fails if
- * any entry names a path no route answers. Some entries have no client yet
- * (`DEPLOYMENT_CONFIG`, `DOMAIN_PROPAGATION` — endpoints the SDK
- * deliberately does not reach); the fence is what keeps those honest rather
- * than merely asserted.
- *
- * **The operator surface is deliberately absent.** `/admin/*` paths belong
- * to `web/my`, for the same reason its row types do: this package is
- * published, and the operator surface is not public (see `CLAUDE.md`, "Admin
- * types"). A path here is a promise to every npm consumer; `/admin` is a
- * promise to one dashboard.
- *
- * Item paths are functions rather than templates so the key is interpolated
- * in one place, encoded the same way by every caller.
- */
-declare const API_PATHS: {
-    readonly DEPLOYMENTS: "/deployments";
-    readonly DEPLOYMENT: (deployment: string) => string;
-    readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
-    readonly DOMAINS: "/domains";
-    readonly DOMAIN: (domain: string) => string;
-    readonly DOMAIN_VERIFY: (domain: string) => string;
-    readonly DOMAIN_DNS: (domain: string) => string;
-    readonly DOMAIN_RECORDS: (domain: string) => string;
-    readonly DOMAIN_SHARE: (domain: string) => string;
-    readonly DOMAIN_PROPAGATION: (domain: string) => string;
-    readonly DOMAINS_VALIDATE: "/domains/validate";
-    readonly TOKENS: "/tokens";
-    readonly TOKEN: (token: string) => string;
-    readonly ACCOUNT: "/account";
-    readonly ACCOUNT_KEY: "/account/key";
-    readonly ACCOUNT_CLAIM: "/account/claim";
-    readonly ACTIVITIES: "/activities";
-    readonly LABELS: "/labels";
-    readonly LIMITS: "/limits";
-    readonly PING: "/ping";
-    readonly SETUP: "/setup";
-    readonly SPA_CHECK: "/spa-check";
-    readonly UPLOAD: "/upload";
-};
-/**
- * The deploy request's multipart field names — the other half of the wire
- * surface beside {@link API_PATHS}. `POST /deployments` (and the first-party
- * `/upload`) is multipart/form-data, and these are the names the API reads.
- *
- * Declared once because the body has three independent WRITERS — the SDK's
- * Node and browser body builders, and the n8n community node's hand-rolled
- * client (which cannot import this under n8n Cloud's zero-dependency rule,
- * and fences its restated copy instead) — and until this export every writer
- * restated the strings the API parses, with nothing comparing them.
- *
- * `FILES` carries one entry per file (the API reads it with `getAll`); every
- * other field is single. The `@internal` flags are serialized as the literal
- * string `'true'` and belong to first-party surfaces only.
- */
-declare const DEPLOY_FIELDS: {
-    /** One entry per file — read with `getAll`. */
-    readonly FILES: "files[]";
-    /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
-    readonly CHECKSUMS: "checksums";
-    /** JSON array of label strings. */
-    readonly LABELS: "labels";
-    /** The deploying surface's {@link DeploymentVia} member. */
-    readonly VIA: "via";
-    /** Plaintext password — the API hashes it server-side. */
-    readonly PASSWORD: "password";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly BUILD: "build";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly PRERENDER: "prerender";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly SPA: "spa";
-    /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
-    readonly CAPTCHA: "captcha";
-};
 /**
  * The half of a list response that is identical on every list.
  *
@@ -188,6 +97,28 @@ interface ListResponse {
     /** Opaque cursor from this page; `null` on the last page. */
     cursor: string | null;
 }
+/**
+ * Pagination options for every list endpoint. The response's `cursor` feeds
+ * the next request; a `null` cursor means the last page. Omitting both
+ * returns the server's default first page.
+ *
+ * A list answers `{ <collection>, cursor }` and nothing else — `cursor`
+ * carries the entire has-more signal, so no redundant boolean, and no
+ * `total`. **A count is an aggregate over a collection, not a property of a
+ * page:** including one makes every read pay for a full scan it did not ask
+ * for, which is precisely the cost keyset pagination exists to avoid.
+ *
+ * Counts therefore live on the summary resource that owns them —
+ * `GET /account` (`usage`) for a caller's own totals, `GET /admin/stats` for
+ * platform-wide ones. Ask for a count when you want a count; ask for a page
+ * when you want a page.
+ */
+interface ListOptions {
+    /** Maximum number of items to return in one page. */
+    limit?: number;
+    /** Opaque cursor from the previous page's response. */
+    cursor?: string;
+}
 /**
  * Response for listing deployments
  */
@@ -658,6 +589,97 @@ interface AccountOverrides {
     /** Override for maximum total deployment size in bytes */
     totalSize?: number;
 }
+/**
+ * Every path the public API answers on, declared once.
+ *
+ * The URL surface was written out in four places — the API's mounts, the
+ * SDK's client, the dashboard's client, and the post-deploy smoke — so a
+ * rename meant finding all four. The first three now read this table.
+ *
+ * The smoke (`cloudflare/api/smoke.mjs`) deliberately still spells its own:
+ * five of its nine paths are `/admin/*`, which this table excludes by
+ * design, and splitting one list between a registry and literals reads worse
+ * than keeping it uniform.
+ *
+ * **What this guarantees, exactly.** Collection paths are mounted from here,
+ * so producer and consumer cannot diverge. Item paths are declared here and
+ * consumed by clients, but the API spells them relative to their mount
+ * (`/:deployment/config`), so the table does not *generate* them — it is
+ * held to them by `api/tests/architecture/api-paths.test.ts`, which fails if
+ * any entry names a path no route answers. Some entries have no client yet
+ * (`DEPLOYMENT_CONFIG`, `DOMAIN_PROPAGATION` — endpoints the SDK
+ * deliberately does not reach); the fence is what keeps those honest rather
+ * than merely asserted.
+ *
+ * **The operator surface is deliberately absent.** `/admin/*` paths belong
+ * to `web/my`, for the same reason its row types do: this package is
+ * published, and the operator surface is not public (see `CLAUDE.md`, "Admin
+ * types"). A path here is a promise to every npm consumer; `/admin` is a
+ * promise to one dashboard.
+ *
+ * Item paths are functions rather than templates so the key is interpolated
+ * in one place, encoded the same way by every caller.
+ */
+declare const API_PATHS: {
+    readonly DEPLOYMENTS: "/deployments";
+    readonly DEPLOYMENT: (deployment: string) => string;
+    readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
+    readonly DOMAINS: "/domains";
+    readonly DOMAIN: (domain: string) => string;
+    readonly DOMAIN_VERIFY: (domain: string) => string;
+    readonly DOMAIN_DNS: (domain: string) => string;
+    readonly DOMAIN_RECORDS: (domain: string) => string;
+    readonly DOMAIN_SHARE: (domain: string) => string;
+    readonly DOMAIN_PROPAGATION: (domain: string) => string;
+    readonly DOMAINS_VALIDATE: "/domains/validate";
+    readonly TOKENS: "/tokens";
+    readonly TOKEN: (token: string) => string;
+    readonly ACCOUNT: "/account";
+    readonly ACCOUNT_KEY: "/account/key";
+    readonly ACCOUNT_CLAIM: "/account/claim";
+    readonly ACTIVITIES: "/activities";
+    readonly LABELS: "/labels";
+    readonly LIMITS: "/limits";
+    readonly PING: "/ping";
+    readonly SETUP: "/setup";
+    readonly SPA_CHECK: "/spa-check";
+    readonly UPLOAD: "/upload";
+};
+/**
+ * The deploy request's multipart field names — the other half of the wire
+ * surface beside {@link API_PATHS}. `POST /deployments` (and the first-party
+ * `/upload`) is multipart/form-data, and these are the names the API reads.
+ *
+ * Declared once because the body has three independent WRITERS — the SDK's
+ * Node and browser body builders, and the n8n community node's hand-rolled
+ * client (which cannot import this under n8n Cloud's zero-dependency rule,
+ * and fences its restated copy instead) — and until this export every writer
+ * restated the strings the API parses, with nothing comparing them.
+ *
+ * `FILES` carries one entry per file (the API reads it with `getAll`); every
+ * other field is single. The `@internal` flags are serialized as the literal
+ * string `'true'` and belong to first-party surfaces only.
+ */
+declare const DEPLOY_FIELDS: {
+    /** One entry per file — read with `getAll`. */
+    readonly FILES: "files[]";
+    /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
+    readonly CHECKSUMS: "checksums";
+    /** JSON array of label strings. */
+    readonly LABELS: "labels";
+    /** The deploying surface's {@link DeploymentVia} member. */
+    readonly VIA: "via";
+    /** Plaintext password — the API hashes it server-side. */
+    readonly PASSWORD: "password";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly BUILD: "build";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly PRERENDER: "prerender";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly SPA: "spa";
+    /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
+    readonly CAPTCHA: "captcha";
+};
 /**
  * All possible error types in the ShipStatic platform.
  *
@@ -1309,28 +1331,6 @@ interface DeploymentUploadOptions {
      */
     idempotencyKey?: string;
 }
-/**
- * Pagination options for every list endpoint. The response's `cursor` feeds
- * the next request; a `null` cursor means the last page. Omitting both
- * returns the server's default first page.
- *
- * A list answers `{ <collection>, cursor }` and nothing else — `cursor`
- * carries the entire has-more signal, so no redundant boolean, and no
- * `total`. **A count is an aggregate over a collection, not a property of a
- * page:** including one makes every read pay for a full scan it did not ask
- * for, which is precisely the cost keyset pagination exists to avoid.
- *
- * Counts therefore live on the summary resource that owns them —
- * `GET /account` (`usage`) for a caller's own totals, `GET /admin/stats` for
- * platform-wide ones. Ask for a count when you want a count; ask for a page
- * when you want a page.
- */
-interface ListOptions {
-    /** Maximum number of items to return in one page. */
-    limit?: number;
-    /** Opaque cursor from the previous page's response. */
-    cursor?: string;
-}
 /**
  * What a caller may change on an existing deployment.
  *

package/dist/index.d.ts

@@ -79,97 +79,6 @@ interface DeploymentCreateResponse extends Deployment {
     /** Claim URL for public deployments. Present when deployed without credentials. */
     readonly claim?: string;
 }
-/**
- * Every path the public API answers on, declared once.
- *
- * The URL surface was written out in four places — the API's mounts, the
- * SDK's client, the dashboard's client, and the post-deploy smoke — so a
- * rename meant finding all four. The first three now read this table.
- *
- * The smoke (`cloudflare/api/smoke.mjs`) deliberately still spells its own:
- * five of its nine paths are `/admin/*`, which this table excludes by
- * design, and splitting one list between a registry and literals reads worse
- * than keeping it uniform.
- *
- * **What this guarantees, exactly.** Collection paths are mounted from here,
- * so producer and consumer cannot diverge. Item paths are declared here and
- * consumed by clients, but the API spells them relative to their mount
- * (`/:deployment/config`), so the table does not *generate* them — it is
- * held to them by `api/tests/architecture/api-paths.test.ts`, which fails if
- * any entry names a path no route answers. Some entries have no client yet
- * (`DEPLOYMENT_CONFIG`, `DOMAIN_PROPAGATION` — endpoints the SDK
- * deliberately does not reach); the fence is what keeps those honest rather
- * than merely asserted.
- *
- * **The operator surface is deliberately absent.** `/admin/*` paths belong
- * to `web/my`, for the same reason its row types do: this package is
- * published, and the operator surface is not public (see `CLAUDE.md`, "Admin
- * types"). A path here is a promise to every npm consumer; `/admin` is a
- * promise to one dashboard.
- *
- * Item paths are functions rather than templates so the key is interpolated
- * in one place, encoded the same way by every caller.
- */
-declare const API_PATHS: {
-    readonly DEPLOYMENTS: "/deployments";
-    readonly DEPLOYMENT: (deployment: string) => string;
-    readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
-    readonly DOMAINS: "/domains";
-    readonly DOMAIN: (domain: string) => string;
-    readonly DOMAIN_VERIFY: (domain: string) => string;
-    readonly DOMAIN_DNS: (domain: string) => string;
-    readonly DOMAIN_RECORDS: (domain: string) => string;
-    readonly DOMAIN_SHARE: (domain: string) => string;
-    readonly DOMAIN_PROPAGATION: (domain: string) => string;
-    readonly DOMAINS_VALIDATE: "/domains/validate";
-    readonly TOKENS: "/tokens";
-    readonly TOKEN: (token: string) => string;
-    readonly ACCOUNT: "/account";
-    readonly ACCOUNT_KEY: "/account/key";
-    readonly ACCOUNT_CLAIM: "/account/claim";
-    readonly ACTIVITIES: "/activities";
-    readonly LABELS: "/labels";
-    readonly LIMITS: "/limits";
-    readonly PING: "/ping";
-    readonly SETUP: "/setup";
-    readonly SPA_CHECK: "/spa-check";
-    readonly UPLOAD: "/upload";
-};
-/**
- * The deploy request's multipart field names — the other half of the wire
- * surface beside {@link API_PATHS}. `POST /deployments` (and the first-party
- * `/upload`) is multipart/form-data, and these are the names the API reads.
- *
- * Declared once because the body has three independent WRITERS — the SDK's
- * Node and browser body builders, and the n8n community node's hand-rolled
- * client (which cannot import this under n8n Cloud's zero-dependency rule,
- * and fences its restated copy instead) — and until this export every writer
- * restated the strings the API parses, with nothing comparing them.
- *
- * `FILES` carries one entry per file (the API reads it with `getAll`); every
- * other field is single. The `@internal` flags are serialized as the literal
- * string `'true'` and belong to first-party surfaces only.
- */
-declare const DEPLOY_FIELDS: {
-    /** One entry per file — read with `getAll`. */
-    readonly FILES: "files[]";
-    /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
-    readonly CHECKSUMS: "checksums";
-    /** JSON array of label strings. */
-    readonly LABELS: "labels";
-    /** The deploying surface's {@link DeploymentVia} member. */
-    readonly VIA: "via";
-    /** Plaintext password — the API hashes it server-side. */
-    readonly PASSWORD: "password";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly BUILD: "build";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly PRERENDER: "prerender";
-    /** @internal Server-processing flag — first-party `/upload` only. */
-    readonly SPA: "spa";
-    /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
-    readonly CAPTCHA: "captcha";
-};
 /**
  * The half of a list response that is identical on every list.
  *
@@ -188,6 +97,28 @@ interface ListResponse {
     /** Opaque cursor from this page; `null` on the last page. */
     cursor: string | null;
 }
+/**
+ * Pagination options for every list endpoint. The response's `cursor` feeds
+ * the next request; a `null` cursor means the last page. Omitting both
+ * returns the server's default first page.
+ *
+ * A list answers `{ <collection>, cursor }` and nothing else — `cursor`
+ * carries the entire has-more signal, so no redundant boolean, and no
+ * `total`. **A count is an aggregate over a collection, not a property of a
+ * page:** including one makes every read pay for a full scan it did not ask
+ * for, which is precisely the cost keyset pagination exists to avoid.
+ *
+ * Counts therefore live on the summary resource that owns them —
+ * `GET /account` (`usage`) for a caller's own totals, `GET /admin/stats` for
+ * platform-wide ones. Ask for a count when you want a count; ask for a page
+ * when you want a page.
+ */
+interface ListOptions {
+    /** Maximum number of items to return in one page. */
+    limit?: number;
+    /** Opaque cursor from the previous page's response. */
+    cursor?: string;
+}
 /**
  * Response for listing deployments
  */
@@ -658,6 +589,97 @@ interface AccountOverrides {
     /** Override for maximum total deployment size in bytes */
     totalSize?: number;
 }
+/**
+ * Every path the public API answers on, declared once.
+ *
+ * The URL surface was written out in four places — the API's mounts, the
+ * SDK's client, the dashboard's client, and the post-deploy smoke — so a
+ * rename meant finding all four. The first three now read this table.
+ *
+ * The smoke (`cloudflare/api/smoke.mjs`) deliberately still spells its own:
+ * five of its nine paths are `/admin/*`, which this table excludes by
+ * design, and splitting one list between a registry and literals reads worse
+ * than keeping it uniform.
+ *
+ * **What this guarantees, exactly.** Collection paths are mounted from here,
+ * so producer and consumer cannot diverge. Item paths are declared here and
+ * consumed by clients, but the API spells them relative to their mount
+ * (`/:deployment/config`), so the table does not *generate* them — it is
+ * held to them by `api/tests/architecture/api-paths.test.ts`, which fails if
+ * any entry names a path no route answers. Some entries have no client yet
+ * (`DEPLOYMENT_CONFIG`, `DOMAIN_PROPAGATION` — endpoints the SDK
+ * deliberately does not reach); the fence is what keeps those honest rather
+ * than merely asserted.
+ *
+ * **The operator surface is deliberately absent.** `/admin/*` paths belong
+ * to `web/my`, for the same reason its row types do: this package is
+ * published, and the operator surface is not public (see `CLAUDE.md`, "Admin
+ * types"). A path here is a promise to every npm consumer; `/admin` is a
+ * promise to one dashboard.
+ *
+ * Item paths are functions rather than templates so the key is interpolated
+ * in one place, encoded the same way by every caller.
+ */
+declare const API_PATHS: {
+    readonly DEPLOYMENTS: "/deployments";
+    readonly DEPLOYMENT: (deployment: string) => string;
+    readonly DEPLOYMENT_CONFIG: (deployment: string) => string;
+    readonly DOMAINS: "/domains";
+    readonly DOMAIN: (domain: string) => string;
+    readonly DOMAIN_VERIFY: (domain: string) => string;
+    readonly DOMAIN_DNS: (domain: string) => string;
+    readonly DOMAIN_RECORDS: (domain: string) => string;
+    readonly DOMAIN_SHARE: (domain: string) => string;
+    readonly DOMAIN_PROPAGATION: (domain: string) => string;
+    readonly DOMAINS_VALIDATE: "/domains/validate";
+    readonly TOKENS: "/tokens";
+    readonly TOKEN: (token: string) => string;
+    readonly ACCOUNT: "/account";
+    readonly ACCOUNT_KEY: "/account/key";
+    readonly ACCOUNT_CLAIM: "/account/claim";
+    readonly ACTIVITIES: "/activities";
+    readonly LABELS: "/labels";
+    readonly LIMITS: "/limits";
+    readonly PING: "/ping";
+    readonly SETUP: "/setup";
+    readonly SPA_CHECK: "/spa-check";
+    readonly UPLOAD: "/upload";
+};
+/**
+ * The deploy request's multipart field names — the other half of the wire
+ * surface beside {@link API_PATHS}. `POST /deployments` (and the first-party
+ * `/upload`) is multipart/form-data, and these are the names the API reads.
+ *
+ * Declared once because the body has three independent WRITERS — the SDK's
+ * Node and browser body builders, and the n8n community node's hand-rolled
+ * client (which cannot import this under n8n Cloud's zero-dependency rule,
+ * and fences its restated copy instead) — and until this export every writer
+ * restated the strings the API parses, with nothing comparing them.
+ *
+ * `FILES` carries one entry per file (the API reads it with `getAll`); every
+ * other field is single. The `@internal` flags are serialized as the literal
+ * string `'true'` and belong to first-party surfaces only.
+ */
+declare const DEPLOY_FIELDS: {
+    /** One entry per file — read with `getAll`. */
+    readonly FILES: "files[]";
+    /** JSON array of MD5 hex digests, index-aligned with `FILES`. */
+    readonly CHECKSUMS: "checksums";
+    /** JSON array of label strings. */
+    readonly LABELS: "labels";
+    /** The deploying surface's {@link DeploymentVia} member. */
+    readonly VIA: "via";
+    /** Plaintext password — the API hashes it server-side. */
+    readonly PASSWORD: "password";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly BUILD: "build";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly PRERENDER: "prerender";
+    /** @internal Server-processing flag — first-party `/upload` only. */
+    readonly SPA: "spa";
+    /** @internal reCAPTCHA proof — `web/www`'s public uploader only. */
+    readonly CAPTCHA: "captcha";
+};
 /**
  * All possible error types in the ShipStatic platform.
  *
@@ -1309,28 +1331,6 @@ interface DeploymentUploadOptions {
      */
     idempotencyKey?: string;
 }
-/**
- * Pagination options for every list endpoint. The response's `cursor` feeds
- * the next request; a `null` cursor means the last page. Omitting both
- * returns the server's default first page.
- *
- * A list answers `{ <collection>, cursor }` and nothing else — `cursor`
- * carries the entire has-more signal, so no redundant boolean, and no
- * `total`. **A count is an aggregate over a collection, not a property of a
- * page:** including one makes every read pay for a full scan it did not ask
- * for, which is precisely the cost keyset pagination exists to avoid.
- *
- * Counts therefore live on the summary resource that owns them —
- * `GET /account` (`usage`) for a caller's own totals, `GET /admin/stats` for
- * platform-wide ones. Ask for a count when you want a count; ask for a page
- * when you want a page.
- */
-interface ListOptions {
-    /** Maximum number of items to return in one page. */
-    limit?: number;
-    /** Opaque cursor from the previous page's response. */
-    cursor?: string;
-}
 /**
  * What a caller may change on an existing deployment.
  *