@shipstatic/types 2.4.1-beta.0 → 2.5.0-beta.0

package/dist/index.d.ts

@@ -784,11 +784,28 @@ export interface DeploymentUploadOptions {
     captcha?: string;
 }
 /**
- * Deployment resource interface - the contract all implementations must follow
- */
-export interface DeploymentResource {
-    upload: (input: DeployInput, options?: DeploymentUploadOptions) => Promise<DeploymentCreateResponse>;
-    list: () => Promise<DeploymentListResponse>;
+ * Pagination options for the paginated list endpoints (`GET /deployments`,
+ * `GET /domains`). The response's `cursor` feeds the next request; a `null`
+ * cursor on the response means the last page. Omitting both returns the
+ * server's default first page.
+ */
+export interface ListOptions {
+    /** Maximum number of items to return in one page. */
+    limit?: number;
+    /** Opaque cursor from the previous page's response. */
+    cursor?: string;
+}
+/**
+ * Deployment resource interface - the contract all implementations must follow.
+ *
+ * The interface defines the minimal wire contract; SDK implementations may
+ * extend the upload options with runtime concerns (timeout, signal, progress
+ * callbacks) by parameterizing: `DeploymentResource<MyUploadOptions>`. The
+ * default keeps plain `DeploymentResource` valid for wire-only consumers.
+ */
+export interface DeploymentResource<UploadOptions extends DeploymentUploadOptions = DeploymentUploadOptions> {
+    upload: (input: DeployInput, options?: UploadOptions) => Promise<DeploymentCreateResponse>;
+    list: (options?: ListOptions) => Promise<DeploymentListResponse>;
     get: (id: string) => Promise<Deployment>;
     set: (id: string, options: {
         labels: string[];
@@ -803,7 +820,7 @@ export interface DomainResource {
         deployment?: string;
         labels?: string[];
     }) => Promise<DomainSetResult>;
-    list: () => Promise<DomainListResponse>;
+    list: (options?: ListOptions) => Promise<DomainListResponse>;
     get: (name: string) => Promise<Domain>;
     remove: (name: string) => Promise<void>;
     verify: (name: string) => Promise<{
@@ -863,11 +880,11 @@ export interface CheckoutSession {
  * All activity event types logged in the system.
  * Uses dot notation consistently: {resource}.{action}
  */
-export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'deployment.flagged' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'admin.impersonate' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created' | 'billing.sync' | 'billing.stale' | 'billing.race';
+export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'deployment.flagged' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'token.delete' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'admin.impersonate' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created' | 'billing.sync' | 'billing.stale' | 'billing.race';
 /**
  * Activity events visible to users in the dashboard
  */
-export type UserVisibleActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.transition' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume';
+export type UserVisibleActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.transition' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'token.delete';
 /**
  * Activity record returned from the API
  */

package/dist/index.js

@@ -197,6 +197,23 @@ export class ShipError extends Error {
         catch {
             // Body unreadable; fall through to operationName-derived message.
         }
+        // Rate-limit (and 503) timing rides the `Retry-After` HEADER, which a
+        // body-only reader would drop. Lift it into `details` as seconds so
+        // consumers can back off from the typed error alone, without keeping the
+        // raw Response around. Body-carried fields are preserved and win.
+        const retryAfterHeader = response.headers.get('retry-after');
+        if (retryAfterHeader !== null) {
+            const value = retryAfterHeader.trim();
+            const seconds = /^\d+$/.test(value)
+                ? Number(value)
+                : Math.ceil((Date.parse(value) - Date.now()) / 1000);
+            if (Number.isFinite(seconds) && seconds >= 0) {
+                const existing = details && typeof details === 'object' ? details : {};
+                if (existing.retryAfter === undefined) {
+                    details = { ...existing, retryAfter: seconds };
+                }
+            }
+        }
         message = message || `${operationName || 'Request'} failed with status ${response.status}`;
         const type = bodyType ??
             (response.status === 401

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "2.4.1-beta.0",
+  "version": "2.5.0-beta.0",
   "description": "Shared types for ShipStatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -512,6 +512,25 @@ export class ShipError extends Error {
       // Body unreadable; fall through to operationName-derived message.
     }
 
+    // Rate-limit (and 503) timing rides the `Retry-After` HEADER, which a
+    // body-only reader would drop. Lift it into `details` as seconds so
+    // consumers can back off from the typed error alone, without keeping the
+    // raw Response around. Body-carried fields are preserved and win.
+    const retryAfterHeader = response.headers.get('retry-after');
+    if (retryAfterHeader !== null) {
+      const value = retryAfterHeader.trim();
+      const seconds = /^\d+$/.test(value)
+        ? Number(value)
+        : Math.ceil((Date.parse(value) - Date.now()) / 1000);
+      if (Number.isFinite(seconds) && seconds >= 0) {
+        const existing =
+          details && typeof details === 'object' ? (details as Record<string, unknown>) : {};
+        if (existing.retryAfter === undefined) {
+          details = { ...existing, retryAfter: seconds };
+        }
+      }
+    }
+
     message = message || `${operationName || 'Request'} failed with status ${response.status}`;
 
     const type =
@@ -1233,14 +1252,31 @@ export interface DeploymentUploadOptions {
 }
 
 /**
- * Deployment resource interface - the contract all implementations must follow
+ * Pagination options for the paginated list endpoints (`GET /deployments`,
+ * `GET /domains`). The response's `cursor` feeds the next request; a `null`
+ * cursor on the response means the last page. Omitting both returns the
+ * server's default first page.
  */
-export interface DeploymentResource {
-  upload: (
-    input: DeployInput,
-    options?: DeploymentUploadOptions,
-  ) => Promise<DeploymentCreateResponse>;
-  list: () => Promise<DeploymentListResponse>;
+export interface ListOptions {
+  /** Maximum number of items to return in one page. */
+  limit?: number;
+  /** Opaque cursor from the previous page's response. */
+  cursor?: string;
+}
+
+/**
+ * Deployment resource interface - the contract all implementations must follow.
+ *
+ * The interface defines the minimal wire contract; SDK implementations may
+ * extend the upload options with runtime concerns (timeout, signal, progress
+ * callbacks) by parameterizing: `DeploymentResource<MyUploadOptions>`. The
+ * default keeps plain `DeploymentResource` valid for wire-only consumers.
+ */
+export interface DeploymentResource<
+  UploadOptions extends DeploymentUploadOptions = DeploymentUploadOptions,
+> {
+  upload: (input: DeployInput, options?: UploadOptions) => Promise<DeploymentCreateResponse>;
+  list: (options?: ListOptions) => Promise<DeploymentListResponse>;
   get: (id: string) => Promise<Deployment>;
   set: (id: string, options: { labels: string[] }) => Promise<Deployment>;
   remove: (id: string) => Promise<void>;
@@ -1254,7 +1290,7 @@ export interface DomainResource {
     name: string,
     options?: { deployment?: string; labels?: string[] },
   ) => Promise<DomainSetResult>;
-  list: () => Promise<DomainListResponse>;
+  list: (options?: ListOptions) => Promise<DomainListResponse>;
   get: (name: string) => Promise<Domain>;
   remove: (name: string) => Promise<void>;
   verify: (name: string) => Promise<{ message: string }>;
@@ -1342,6 +1378,7 @@ export type ActivityEvent =
   // Token events
   | 'token.create'
   | 'token.consume'
+  | 'token.delete'
   // Admin events (not user-visible)
   | 'admin.account.plan.update'
   | 'admin.account.ref.update'
@@ -1388,7 +1425,8 @@ export type UserVisibleActivityEvent =
   | 'domain.delete'
   | 'domain.verify'
   | 'token.create'
-  | 'token.consume';
+  | 'token.consume'
+  | 'token.delete';
 
 /**
  * Activity record returned from the API