@shipstatic/types 0.3.17 → 0.3.18

package/dist/index.d.ts

@@ -91,6 +91,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 +256,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 +425,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";
 /**
@@ -414,14 +480,8 @@ export interface DomainResource {
     confirm: (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;

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.18",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -109,6 +109,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 +298,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 +373,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 +445,6 @@ export class ShipError extends Error {
   }
 }
 
-// =============================================================================
-// CONFIGURATION CONSTANTS
-// =============================================================================
-
-
-
-
 // =============================================================================
 // CONFIG TYPES
 // =============================================================================
@@ -453,7 +487,6 @@ export interface PingResponse {
   timestamp?: number;
 }
 
-
 // API Key Configuration
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
@@ -628,6 +661,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
 // =============================================================================
@@ -666,8 +731,8 @@ export interface DomainResource {
   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[] }>;
+  dns: (domainName: string) => Promise<DomainDnsResponse>;
+  records: (domainName: string) => Promise<DomainRecordsResponse>;
   share: (domainName: string) => Promise<{ domain: string; hash: string }>;
 }