@shipstatic/ship 0.3.13 → 0.3.15

package/README.md

@@ -105,7 +105,7 @@ ship domains list                                   # List domains
 ship domains set staging abc123                     # Set domain to deployment
 ship domains set prod abc123 --tag production       # Set domain with tag
 ship domains set prod abc123 --tag prod --tag v1    # Set domain with multiple tags
-ship domains confirm www.example.com                # Trigger DNS confirmation
+ship domains verify www.example.com                # Trigger DNS verification
 ship domains remove staging                         # Remove domain
 
 # Account
@@ -202,6 +202,7 @@ interface ShipOptions {
   deployToken?: string;   // Deploy token: token- prefix + 64-char hex (70 chars total)
   timeout?: number;       // Request timeout (ms)
   useCredentials?: boolean; // Use HTTP-only cookies for auth (skips token check)
+  caller?: string;        // Identifier for multi-tenant deployments (e.g., CI system name)
 }
 ```
 
@@ -264,6 +265,8 @@ interface DeployOptions {
   maxConcurrency?: number;
   timeout?: number;
   stripCommonPrefix?: boolean;      // Remove common path prefix
+  via?: string;                     // Client identifier (auto-set: 'sdk' for SDK, 'cli' for CLI)
+  caller?: string;                  // Multi-tenant identifier (e.g., 'github-actions', 'jenkins')
 }
 ```
 
@@ -282,8 +285,8 @@ await ship.domains.list()
 // Remove domain
 await ship.domains.remove(domainName)
 
-// Trigger DNS confirmation for external domain
-await ship.domains.confirm(domainName)
+// Trigger DNS verification for external domain
+await ship.domains.verify(domainName)
 ```
 
 **Examples:**
@@ -294,8 +297,8 @@ await ship.domains.set('staging', 'dep_abc123');
 // Set domain with tags
 await ship.domains.set('production', 'dep_xyz789', ['prod', 'v1.0.0']);
 
-// Confirm DNS for external domain
-await ship.domains.confirm('www.example.com');
+// Verify DNS for external domain
+await ship.domains.verify('www.example.com');
 ```
 
 ### Environment-Specific Examples
@@ -798,7 +801,7 @@ pnpm build && pnpm test --run
 - **Node.js tests**: Filesystem and path manipulation
 - **Error tests**: Unified error handling patterns
 
-**Current Status:** 614 tests passing (614 total) ✅
+**Current Status:** 1006 tests passing (1006 total) ✅
 
 ## Contributing
 

package/dist/browser.d.ts

@@ -1,5 +1,5 @@
 import * as _shipstatic_types 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 } from '@shipstatic/types';
+import { ProgressInfo, StaticFile, PingResponse, ConfigResponse, 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, ErrorType, FileValidationStatus as FILE_VALIDATION_STATUS, PingResponse, ResolvedConfig, ShipError, StaticFile, TokenResource } from '@shipstatic/types';
 
@@ -37,12 +37,25 @@ interface DeploymentOptions {
     tags?: string[];
     /** Callback for deploy progress with detailed statistics. */
     onProgress?: (info: ProgressInfo) => void;
+    /** Client/tool identifier for this deployment (e.g., 'sdk', 'cli', 'web'). Alphanumeric only. */
+    via?: string;
+    /** Caller identifier for multi-tenant deployments (alphanumeric, dot, underscore, hyphen). */
+    caller?: string;
 }
+type ApiDeployOptions = Omit<DeploymentOptions, 'pathDetect'>;
 /**
- * Options for configuring an deploy operation via `apiClient.deployFiles`.
- * Derived from DeploymentOptions but excludes client-side only options.
+ * Prepared request body for deployment.
+ * Created by platform-specific code, consumed by HTTP client.
  */
-type ApiDeployOptions = Omit<DeploymentOptions, 'pathDetect'>;
+interface DeployBody {
+    body: FormData | ArrayBuffer;
+    headers: Record<string, string>;
+}
+/**
+ * Function that creates a deploy request body from files.
+ * Implemented differently for Node.js and Browser.
+ */
+type DeployBodyCreator = (files: StaticFile[], tags?: string[], via?: string) => Promise<DeployBody>;
 /**
  * Options for configuring a `Ship` instance.
  * Sets default API host, authentication credentials, progress callbacks, concurrency, and timeouts for the client.
@@ -81,6 +94,11 @@ interface ShipClientOptions {
      * to proceed with cookie-based credentials.
      */
     useCredentials?: boolean | undefined;
+    /**
+     * Default caller identifier for multi-tenant deployments.
+     * Alphanumeric characters, dots, underscores, and hyphens allowed (max 128 chars).
+     */
+    caller?: string | undefined;
 }
 /**
  * Event map for Ship SDK events
@@ -136,23 +154,19 @@ declare class SimpleEvents {
 }
 
 /**
- * @file HTTP client with integrated event system
- * Clean, direct implementation with reliable error handling
+ * @file HTTP client for Ship API.
  */
 
-/**
- * HTTP client with integrated event system
- * - Direct event integration
- * - Clean inheritance from SimpleEvents
- * - Reliable error handling
- */
+interface ApiHttpOptions extends ShipClientOptions {
+    getAuthHeaders: () => Record<string, string>;
+    createDeployBody: DeployBodyCreator;
+}
 declare class ApiHttp extends SimpleEvents {
     private readonly apiUrl;
     private readonly getAuthHeadersCallback;
     private readonly timeout;
-    constructor(options: ShipClientOptions & {
-        getAuthHeaders: () => Record<string, string>;
-    });
+    private readonly createDeployBody;
+    constructor(options: ApiHttpOptions);
     /**
      * Transfer events to another client (clean intentional API)
      */
@@ -201,7 +215,7 @@ declare class ApiHttp extends SimpleEvents {
     getDomain(name: string): Promise<Domain>;
     listDomains(): Promise<DomainListResponse>;
     removeDomain(name: string): Promise<void>;
-    confirmDomain(name: string): Promise<{
+    verifyDomain(name: string): Promise<{
         message: string;
     }>;
     getDomainDns(name: string): Promise<DomainDnsResponse>;
@@ -215,11 +229,6 @@ declare class ApiHttp extends SimpleEvents {
     listTokens(): Promise<TokenListResponse>;
     removeToken(token: string): Promise<void>;
     checkSPA(files: StaticFile[]): Promise<boolean>;
-    private validateFiles;
-    private prepareRequestPayload;
-    private createBrowserBody;
-    private createNodeBody;
-    private getBrowserContentType;
 }
 
 /**
@@ -234,8 +243,10 @@ declare class ApiHttp extends SimpleEvents {
  * This means CLI flags always win, followed by env vars, then config files.
  */
 
-type Config = PlatformConfig;
-
+/**
+ * Cross-environment config loader that dispatches to appropriate implementation.
+ */
+declare function loadConfig(configFile?: string): Promise<PlatformConfig>;
 /**
  * Universal configuration resolver for all environments.
  * This is the single source of truth for config resolution.
@@ -248,13 +259,28 @@ declare function resolveConfig(userOptions?: ShipClientOptions, loadedConfig?: P
 declare function mergeDeployOptions(options: DeploymentOptions, clientDefaults: ShipClientOptions): DeploymentOptions;
 
 /**
- * @file Ship SDK resource implementations for deployments, domains, and accounts.
+ * Ship SDK resource factory functions.
  */
 
-declare function createDeploymentResource(getApi: () => ApiHttp, clientDefaults?: ShipClientOptions, ensureInit?: () => Promise<void>, processInput?: (input: DeployInput, options: DeploymentOptions) => Promise<StaticFile[]>, hasAuth?: () => boolean): DeploymentResource;
-declare function createDomainResource(getApi: () => ApiHttp, ensureInit?: () => Promise<void>): DomainResource;
-declare function createAccountResource(getApi: () => ApiHttp, ensureInit?: () => Promise<void>): AccountResource;
-declare function createTokenResource(getApi: () => ApiHttp, ensureInit?: () => Promise<void>): TokenResource;
+/**
+ * Shared context for all resource factories.
+ */
+interface ResourceContext {
+    getApi: () => ApiHttp;
+    ensureInit: () => Promise<void>;
+}
+/**
+ * Extended context for deployment resource.
+ */
+interface DeploymentResourceContext extends ResourceContext {
+    processInput: (input: DeployInput, options: DeploymentOptions) => Promise<StaticFile[]>;
+    clientDefaults?: ShipClientOptions;
+    hasAuth?: () => boolean;
+}
+declare function createDeploymentResource(ctx: DeploymentResourceContext): DeploymentResource;
+declare function createDomainResource(ctx: ResourceContext): DomainResource;
+declare function createAccountResource(ctx: ResourceContext): AccountResource;
+declare function createTokenResource(ctx: ResourceContext): TokenResource;
 
 /**
  * Abstract base class for Ship SDK implementations.
@@ -277,6 +303,7 @@ declare abstract class Ship$1 {
     protected abstract resolveInitialConfig(options: ShipClientOptions): ResolvedConfig;
     protected abstract loadFullConfig(): Promise<void>;
     protected abstract processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
+    protected abstract getDeployBodyCreator(): DeployBodyCreator;
     /**
      * Ensure full initialization is complete - called lazily by resources
      */
@@ -536,15 +563,24 @@ declare function getValidFiles<T extends ValidatableFile>(files: T[]): T[];
 declare function allValidFilesReady<T extends ValidatableFile>(files: T[]): boolean;
 
 /**
- * @file Browser configuration implementation - no file system access.
- * Browser environment receives all config through constructor options.
+ * @file Error utilities for consistent error handling across SDK consumers.
  */
 
 /**
- * Browser config loading - always returns empty (no file system access).
- * All configuration must be provided through Ship constructor options.
+ * 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 loadConfig(configFile?: string): Promise<Config>;
+declare function ensureShipError(err: unknown): ShipError;
 
 /**
  * @file Platform configuration management for the Ship SDK.
@@ -601,11 +637,11 @@ declare function processFilesForBrowser(browserFiles: File[], options?: Deployme
  * ```
  */
 declare class Ship extends Ship$1 {
-    #private;
     constructor(options?: ShipClientOptions);
     protected resolveInitialConfig(options: ShipClientOptions): ResolvedConfig;
     protected loadFullConfig(): Promise<void>;
     protected processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
+    protected getDeployBodyCreator(): DeployBodyCreator;
 }
 
-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, filterJunk, formatFileSize, getCurrentConfig, getENV, getValidFiles, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig, validateFiles };
+export { type ApiDeployOptions, ApiHttp, type ApiHttpOptions, type DeployBody, type DeployBodyCreator, type DeployFile, type DeploymentOptions, type DeploymentResourceContext, type ExecutionEnvironment, JUNK_DIRECTORIES, type MD5Result, type ResourceContext, 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 };