@shipstatic/ship 0.3.13 → 0.3.14

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, 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, ErrorType, FileValidationStatus as FILE_VALIDATION_STATUS, PingResponse, ResolvedConfig, ShipError, StaticFile, TokenResource } from '@shipstatic/types';
 
@@ -535,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,4 +628,4 @@ declare class Ship extends Ship$1 {
     protected processInput(input: DeployInput, options: DeploymentOptions): Promise<StaticFile[]>;
 }
 
-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 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 };