@shipstatic/ship 0.3.12 → 0.3.14

package/dist/browser.d.ts

@@ -1,7 +1,7 @@
 import * as _shipstatic_types from '@shipstatic/types';
-import { PingResponse, ConfigResponse, StaticFile, Deployment, DeploymentListResponse, Domain, DomainListResponse, Account, TokenCreateResponse, TokenListResponse, DeployInput, DeploymentResource, DomainResource, AccountResource, TokenResource, PlatformConfig, ValidatableFile, FileValidationResult } from '@shipstatic/types';
+import { ProgressInfo, PingResponse, ConfigResponse, StaticFile, Deployment, DeploymentListResponse, Domain, DomainListResponse, DomainDnsResponse, DomainRecordsResponse, Account, TokenCreateResponse, TokenListResponse, PlatformConfig, ResolvedConfig, DeployInput, DeploymentResource, DomainResource, AccountResource, TokenResource, ValidatableFile, FileValidationResult, ShipError } from '@shipstatic/types';
 export * from '@shipstatic/types';
-export { Account, AccountResource, DEFAULT_API, DeployInput, Deployment, DeploymentResource, Domain, DomainResource, FileValidationStatus as FILE_VALIDATION_STATUS, PingResponse, ShipError, ShipErrorType, StaticFile, TokenResource } from '@shipstatic/types';
+export { Account, AccountResource, DEFAULT_API, DeployInput, Deployment, DeploymentResource, Domain, DomainResource, ErrorType, FileValidationStatus as FILE_VALIDATION_STATUS, PingResponse, ResolvedConfig, ShipError, StaticFile, TokenResource } from '@shipstatic/types';
 
 /**
  * @file SDK-specific type definitions
@@ -43,20 +43,6 @@ interface DeploymentOptions {
  * Derived from DeploymentOptions but excludes client-side only options.
  */
 type ApiDeployOptions = Omit<DeploymentOptions, 'pathDetect'>;
-/**
- * Progress information for deploy operations.
- * Provides consistent percentage-based progress with byte-level details.
- */
-interface ProgressInfo {
-    /** Progress percentage (0-100). */
-    percent: number;
-    /** Number of bytes loaded so far. */
-    loaded: number;
-    /** Total number of bytes to be loaded. May be 0 if unknown initially. */
-    total: number;
-    /** Current file being processed (optional). */
-    file?: string;
-}
 /**
  * Options for configuring a `Ship` instance.
  * Sets default API host, authentication credentials, progress callbacks, concurrency, and timeouts for the client.
@@ -163,6 +149,7 @@ declare class SimpleEvents {
 declare class ApiHttp extends SimpleEvents {
     private readonly apiUrl;
     private readonly getAuthHeadersCallback;
+    private readonly timeout;
     constructor(options: ShipClientOptions & {
         getAuthHeaders: () => Record<string, string>;
     });
@@ -171,9 +158,18 @@ declare class ApiHttp extends SimpleEvents {
      */
     transferEventsTo(target: ApiHttp): void;
     /**
-     * Make authenticated HTTP request with events
+     * Make authenticated HTTP request with events and timeout
      */
     private request;
+    /**
+     * Combine multiple AbortSignals into one
+     */
+    private combineSignals;
+    /**
+     * Make request and return both data and HTTP status code
+     * Used when the caller needs to inspect the status (e.g., 201 vs 200)
+     */
+    private requestWithStatus;
     /**
      * Generate auth headers from Ship instance callback
      */
@@ -208,14 +204,8 @@ declare class ApiHttp extends SimpleEvents {
     confirmDomain(name: string): Promise<{
         message: string;
     }>;
-    getDomainDns(name: string): Promise<{
-        domain: string;
-        dns: any;
-    }>;
-    getDomainRecords(name: string): Promise<{
-        domain: string;
-        records: any[];
-    }>;
+    getDomainDns(name: string): Promise<DomainDnsResponse>;
+    getDomainRecords(name: string): Promise<DomainRecordsResponse>;
     getDomainShare(name: string): Promise<{
         domain: string;
         hash: string;
@@ -232,6 +222,31 @@ declare class ApiHttp extends SimpleEvents {
     private getBrowserContentType;
 }
 
+/**
+ * @file Shared configuration logic for both environments.
+ *
+ * CONFIGURATION PRECEDENCE (highest to lowest):
+ * 1. Constructor options / CLI flags (passed directly to Ship())
+ * 2. Environment variables (SHIP_API_KEY, SHIP_DEPLOY_TOKEN, SHIP_API_URL)
+ * 3. Config file (.shiprc or package.json "ship" key)
+ * 4. Default values (DEFAULT_API)
+ *
+ * This means CLI flags always win, followed by env vars, then config files.
+ */
+
+type Config = PlatformConfig;
+
+/**
+ * Universal configuration resolver for all environments.
+ * This is the single source of truth for config resolution.
+ */
+declare function resolveConfig(userOptions?: ShipClientOptions, loadedConfig?: Partial<ShipClientOptions>): ResolvedConfig;
+/**
+ * Merge deployment options with client defaults.
+ * This is shared logic used by both environments.
+ */
+declare function mergeDeployOptions(options: DeploymentOptions, clientDefaults: ShipClientOptions): DeploymentOptions;
+
 /**
  * @file Ship SDK resource implementations for deployments, domains, and accounts.
  */
@@ -253,13 +268,13 @@ declare abstract class Ship$1 {
     protected initPromise: Promise<void> | null;
     protected _config: ConfigResponse | null;
     private auth;
-    private readonly authHeadersCallback;
+    protected readonly authHeadersCallback: () => Record<string, string>;
     protected _deployments: DeploymentResource;
     protected _domains: DomainResource;
     protected _account: AccountResource;
     protected _tokens: TokenResource;
     constructor(options?: ShipClientOptions);
-    protected abstract resolveInitialConfig(options: ShipClientOptions): any;
+    protected abstract resolveInitialConfig(options: ShipClientOptions): ResolvedConfig;
     protected abstract loadFullConfig(): Promise<void>;
     protected abstract processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
     /**
@@ -343,26 +358,6 @@ declare abstract class Ship$1 {
     private hasAuth;
 }
 
-/**
- * @file Shared configuration logic for both environments.
- */
-
-type Config = PlatformConfig;
-/**
- * Universal configuration resolver for all environments.
- * This is the single source of truth for config resolution.
- */
-declare function resolveConfig(userOptions?: ShipClientOptions, loadedConfig?: Partial<ShipClientOptions>): {
-    apiUrl: string;
-    apiKey?: string;
-    deployToken?: string;
-};
-/**
- * Merge deployment options with client defaults.
- * This is shared logic used by both environments.
- */
-declare function mergeDeployOptions(options: DeploymentOptions, clientDefaults: ShipClientOptions): DeploymentOptions;
-
 interface MD5Result {
     md5: string;
 }
@@ -540,6 +535,26 @@ declare function getValidFiles<T extends ValidatableFile>(files: T[]): T[];
  */
 declare function allValidFilesReady<T extends ValidatableFile>(files: T[]): boolean;
 
+/**
+ * @file Error utilities for consistent error handling across SDK consumers.
+ */
+
+/**
+ * Ensure any error is wrapped as a ShipError.
+ * Useful for catch blocks where the error type is unknown.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await someOperation();
+ * } catch (err) {
+ *   const shipError = ensureShipError(err);
+ *   // Now you can safely use shipError.message, shipError.type, etc.
+ * }
+ * ```
+ */
+declare function ensureShipError(err: unknown): ShipError;
+
 /**
  * @file Browser configuration implementation - no file system access.
  * Browser environment receives all config through constructor options.
@@ -608,9 +623,9 @@ declare function processFilesForBrowser(browserFiles: File[], options?: Deployme
 declare class Ship extends Ship$1 {
     #private;
     constructor(options?: ShipClientOptions);
-    protected resolveInitialConfig(options: ShipClientOptions): any;
+    protected resolveInitialConfig(options: ShipClientOptions): ResolvedConfig;
     protected loadFullConfig(): Promise<void>;
     protected processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
 }
 
-export { type ApiDeployOptions, ApiHttp, type Config, type DeployFile, type DeploymentOptions, type ExecutionEnvironment, JUNK_DIRECTORIES, type MD5Result, type ProgressInfo, Ship, type ShipClientOptions, type ShipEvents, __setTestEnvironment, allValidFilesReady, calculateMD5, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, filterJunk, formatFileSize, getCurrentConfig, getENV, getValidFiles, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig, validateFiles };
+export { type ApiDeployOptions, ApiHttp, type Config, type DeployFile, type DeploymentOptions, type ExecutionEnvironment, JUNK_DIRECTORIES, type MD5Result, Ship, type ShipClientOptions, type ShipEvents, __setTestEnvironment, allValidFilesReady, calculateMD5, createAccountResource, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, ensureShipError, filterJunk, formatFileSize, getCurrentConfig, getENV, getValidFiles, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig, validateFiles };