@shipstatic/types 0.3.17 → 0.3.19

package/dist/index.d.ts

@@ -28,6 +28,8 @@ export interface Deployment {
     readonly config?: boolean;
     /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
     tags?: string[];
+    /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli') */
+    readonly via?: string;
     /** The deployment URL */
     readonly url: string;
     /** Unix timestamp (seconds) when deployment was created */
@@ -77,8 +79,8 @@ export interface Domain {
     readonly created: number;
     /** Whether this was a create (201) or update (200) operation */
     readonly isCreate?: boolean;
-    /** Unix timestamp (seconds) when domain was confirmed */
-    confirmed?: number;
+    /** Unix timestamp (seconds) when domain was verified */
+    verified?: number;
 }
 /**
  * Response for listing domains
@@ -91,6 +93,48 @@ export interface DomainListResponse {
     /** Total number of domains if available */
     total?: number;
 }
+/**
+ * DNS record types supported for domain configuration
+ */
+export type DnsRecordType = 'A' | 'CNAME';
+/**
+ * DNS record required for domain configuration
+ */
+export interface DnsRecord {
+    /** Record type (A for apex, CNAME for subdomains) */
+    type: DnsRecordType;
+    /** The DNS name to configure */
+    name: string;
+    /** The value to set (IP for A, hostname for CNAME) */
+    value: string;
+}
+/**
+ * DNS provider information for a domain
+ */
+export interface DnsProvider {
+    /** Provider name (e.g., "Cloudflare", "GoDaddy") */
+    name?: string;
+}
+/**
+ * Response for domain DNS provider lookup
+ */
+export interface DomainDnsResponse {
+    /** The domain name */
+    domain: string;
+    /** DNS provider information, null if not yet looked up */
+    dns: {
+        provider?: DnsProvider;
+    } | null;
+}
+/**
+ * Response for domain DNS records
+ */
+export interface DomainRecordsResponse {
+    /** The domain name */
+    domain: string;
+    /** Required DNS records for configuration */
+    records: DnsRecord[];
+}
 /**
  * Response for deployment removal
  */
@@ -214,8 +258,6 @@ export declare enum ErrorType {
     /** Configuration error */
     Config = "config_error"
 }
-/** @deprecated Use ErrorType instead. Kept for backward compatibility. */
-export declare const ShipErrorType: typeof ErrorType;
 /**
  * Standard error response format used everywhere
  */
@@ -385,6 +427,32 @@ export interface PlatformConfig {
     deployToken?: string;
     apiKey?: string;
 }
+/**
+ * Resolved configuration with required apiUrl.
+ * This is the normalized config after merging options, env, and config files.
+ */
+export interface ResolvedConfig {
+    /** API URL (always present after resolution, defaults to DEFAULT_API) */
+    apiUrl: string;
+    /** API key for authenticated deployments */
+    apiKey?: string;
+    /** Deploy token for single-use deployments */
+    deployToken?: string;
+}
+/**
+ * Progress information for deploy/upload operations.
+ * Provides consistent percentage-based progress with byte-level details.
+ */
+export interface ProgressInfo {
+    /** Progress percentage (0-100) */
+    percent: number;
+    /** Number of bytes loaded so far */
+    loaded: number;
+    /** Total number of bytes to load. May be 0 if unknown initially */
+    total: number;
+    /** Current file being processed (optional) */
+    file?: string;
+}
 /** Default API URL if not otherwise configured. */
 export declare const DEFAULT_API = "https://api.shipstatic.com";
 /**
@@ -411,17 +479,11 @@ export interface DomainResource {
     get: (domainName: string) => Promise<Domain>;
     list: () => Promise<DomainListResponse>;
     remove: (domainName: string) => Promise<void>;
-    confirm: (domainName: string) => Promise<{
+    verify: (domainName: string) => Promise<{
         message: string;
     }>;
-    dns: (domainName: string) => Promise<{
-        domain: string;
-        dns: any;
-    }>;
-    records: (domainName: string) => Promise<{
-        domain: string;
-        records: any[];
-    }>;
+    dns: (domainName: string) => Promise<DomainDnsResponse>;
+    records: (domainName: string) => Promise<DomainRecordsResponse>;
     share: (domainName: string) => Promise<{
         domain: string;
         hash: string;
@@ -497,11 +559,11 @@ export interface KeysResource {
 /**
  * All activity event types logged in the system
  */
-export type ActivityEvent = 'account_create' | 'account_update' | 'account_delete' | 'account_key_generate' | 'account_plan_paid' | 'account_plan_transition' | 'account_suspended' | 'deployment_create' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_confirm' | 'token_create' | 'token_consume' | 'admin_account_plan_update' | 'admin_account_ref_update' | 'admin_account_billing_update' | 'admin_account_tags_update' | 'admin_deployment_delete' | 'admin_domain_delete' | 'billing_suspended' | 'billing_active' | 'billing_canceled' | 'billing_paused' | 'billing_expired' | 'billing_paid' | 'billing_trialing' | 'billing_scheduled_cancel' | 'billing_unpaid' | 'billing_update' | 'billing_past_due' | 'billing_terminated' | 'billing_manual_sync' | 'refund_created' | 'dispute_created';
+export type ActivityEvent = 'account_create' | 'account_update' | 'account_delete' | 'account_key_generate' | 'account_plan_paid' | 'account_plan_transition' | 'account_suspended' | 'deployment_create' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_verify' | 'token_create' | 'token_consume' | 'admin_account_plan_update' | 'admin_account_ref_update' | 'admin_account_billing_update' | 'admin_account_tags_update' | 'admin_deployment_delete' | 'admin_domain_delete' | 'billing_suspended' | 'billing_active' | 'billing_canceled' | 'billing_paused' | 'billing_expired' | 'billing_paid' | 'billing_trialing' | 'billing_scheduled_cancel' | 'billing_unpaid' | 'billing_update' | 'billing_past_due' | 'billing_terminated' | 'billing_manual_sync' | 'refund_created' | 'dispute_created';
 /**
  * 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_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_confirm' | 'token_create' | 'token_consume';
+export type UserVisibleActivityEvent = 'account_create' | 'account_update' | 'account_delete' | 'account_key_generate' | 'account_plan_transition' | 'deployment_create' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_verify' | 'token_create' | 'token_consume';
 /**
  * Activity record returned from the API
  */

package/dist/index.js

@@ -70,8 +70,6 @@ export var ErrorType;
     /** Configuration error */
     ErrorType["Config"] = "config_error";
 })(ErrorType || (ErrorType = {}));
-/** @deprecated Use ErrorType instead. Kept for backward compatibility. */
-export const ShipErrorType = ErrorType;
 /**
  * Categorizes error types for better type checking
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.3.17",
+  "version": "0.3.19",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -35,6 +35,8 @@ export interface Deployment {
   readonly config?: boolean;
   /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
   tags?: string[];
+  /** The client/tool used to create this deployment (e.g., 'web', 'sdk', 'cli') */
+  readonly via?: string;
   /** The deployment URL */
   readonly url: string;
   /** Unix timestamp (seconds) when deployment was created */
@@ -93,8 +95,8 @@ export interface Domain {
   readonly created: number;
   /** Whether this was a create (201) or update (200) operation */
   readonly isCreate?: boolean;
-  /** Unix timestamp (seconds) when domain was confirmed */
-  confirmed?: number; // Mutable - can be updated
+  /** Unix timestamp (seconds) when domain was verified */
+  verified?: number; // Mutable - can be updated
 }
 
 /**
@@ -109,6 +111,51 @@ export interface DomainListResponse {
   total?: number;
 }
 
+/**
+ * DNS record types supported for domain configuration
+ */
+export type DnsRecordType = 'A' | 'CNAME';
+
+/**
+ * DNS record required for domain configuration
+ */
+export interface DnsRecord {
+  /** Record type (A for apex, CNAME for subdomains) */
+  type: DnsRecordType;
+  /** The DNS name to configure */
+  name: string;
+  /** The value to set (IP for A, hostname for CNAME) */
+  value: string;
+}
+
+/**
+ * DNS provider information for a domain
+ */
+export interface DnsProvider {
+  /** Provider name (e.g., "Cloudflare", "GoDaddy") */
+  name?: string;
+}
+
+/**
+ * Response for domain DNS provider lookup
+ */
+export interface DomainDnsResponse {
+  /** The domain name */
+  domain: string;
+  /** DNS provider information, null if not yet looked up */
+  dns: { provider?: DnsProvider } | null;
+}
+
+/**
+ * Response for domain DNS records
+ */
+export interface DomainRecordsResponse {
+  /** The domain name */
+  domain: string;
+  /** Required DNS records for configuration */
+  records: DnsRecord[];
+}
+
 /**
  * Response for deployment removal
  */
@@ -253,9 +300,6 @@ export enum ErrorType {
   Config = "config_error"
 }
 
-/** @deprecated Use ErrorType instead. Kept for backward compatibility. */
-export const ShipErrorType = ErrorType;
-
 /**
  * Categorizes error types for better type checking
  */
@@ -331,7 +375,6 @@ export class ShipError extends Error {
     return new ShipError(ErrorType.Authentication, message, 401, details);
   }
 
-
   static business(message: string, status: number = 400): ShipError {
     return new ShipError(ErrorType.Business, message, status);
   }
@@ -404,13 +447,6 @@ export class ShipError extends Error {
   }
 }
 
-// =============================================================================
-// CONFIGURATION CONSTANTS
-// =============================================================================
-
-
-
-
 // =============================================================================
 // CONFIG TYPES
 // =============================================================================
@@ -453,7 +489,6 @@ export interface PingResponse {
   timestamp?: number;
 }
 
-
 // API Key Configuration
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
@@ -628,6 +663,38 @@ export interface PlatformConfig {
   apiKey?: string;
 }
 
+/**
+ * Resolved configuration with required apiUrl.
+ * This is the normalized config after merging options, env, and config files.
+ */
+export interface ResolvedConfig {
+  /** API URL (always present after resolution, defaults to DEFAULT_API) */
+  apiUrl: string;
+  /** API key for authenticated deployments */
+  apiKey?: string;
+  /** Deploy token for single-use deployments */
+  deployToken?: string;
+}
+
+// =============================================================================
+// PROGRESS TRACKING
+// =============================================================================
+
+/**
+ * Progress information for deploy/upload operations.
+ * Provides consistent percentage-based progress with byte-level details.
+ */
+export interface ProgressInfo {
+  /** Progress percentage (0-100) */
+  percent: number;
+  /** Number of bytes loaded so far */
+  loaded: number;
+  /** Total number of bytes to load. May be 0 if unknown initially */
+  total: number;
+  /** Current file being processed (optional) */
+  file?: string;
+}
+
 // =============================================================================
 // PLATFORM CONSTANTS
 // =============================================================================
@@ -665,9 +732,9 @@ export interface DomainResource {
   get: (domainName: string) => Promise<Domain>;
   list: () => Promise<DomainListResponse>;
   remove: (domainName: string) => Promise<void>;
-  confirm: (domainName: string) => Promise<{ message: string }>;
-  dns: (domainName: string) => Promise<{ domain: string; dns: any }>;
-  records: (domainName: string) => Promise<{ domain: string; records: any[] }>;
+  verify: (domainName: string) => Promise<{ message: string }>;
+  dns: (domainName: string) => Promise<DomainDnsResponse>;
+  records: (domainName: string) => Promise<DomainRecordsResponse>;
   share: (domainName: string) => Promise<{ domain: string; hash: string }>;
 }
 
@@ -774,7 +841,7 @@ export type ActivityEvent =
   | 'domain_update'
   | 'domain_delete'
   | 'domain_set'
-  | 'domain_confirm'
+  | 'domain_verify'
   // Token events
   | 'token_create'
   | 'token_consume'
@@ -818,7 +885,7 @@ export type UserVisibleActivityEvent =
   | 'domain_update'
   | 'domain_delete'
   | 'domain_set'
-  | 'domain_confirm'
+  | 'domain_verify'
   | 'token_create'
   | 'token_consume';