@shipstatic/ship 0.3.4 → 0.3.6

package/README.md

@@ -76,7 +76,7 @@ const ship = new Ship({
 
 // Deploy project - SDK automatically fetches platform configuration
 const result = await ship.deployments.create(['./dist'], {
-  onProgress: (progress) => console.log(`${progress}%`)
+  onProgress: ({ percent }) => console.log(`${percent}%`)
 });
 
 console.log(`Deployed: ${result.deployment}`);
@@ -201,6 +201,7 @@ interface ShipOptions {
   apiKey?: string;        // API key: ship- prefix + 64-char hex (69 chars total)
   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)
 }
 ```
 
@@ -259,8 +260,7 @@ interface DeployOptions {
   signal?: AbortSignal;             // Cancellation
   subdomain?: string;               // Custom subdomain
   onCancel?: () => void;
-  onProgress?: (progress: number) => void;
-  progress?: (stats: ProgressStats) => void;
+  onProgress?: (info: ProgressInfo) => void;  // Progress with percent (0-100), loaded, total bytes
   maxConcurrency?: number;
   timeout?: number;
   stripCommonPrefix?: boolean;      // Remove common path prefix
@@ -321,8 +321,8 @@ const result = await ship.deployments.create([
   './public'
 ], {
   stripCommonPrefix: true,
-  onProgress: (progress) => {
-    console.log(`Deployment: ${progress}% complete`);
+  onProgress: ({ percent }) => {
+    console.log(`Deployment: ${percent}% complete`);
   }
 });
 
@@ -346,8 +346,8 @@ const ship = new Ship({
 const fileInput = document.getElementById('fileInput') as HTMLInputElement;
 const files: File[] = Array.from(fileInput.files || []);
 const result = await ship.deployments.create(files, {
-  onProgress: (progress) => {
-    document.getElementById('progress').textContent = `${progress}%`;
+  onProgress: ({ percent }) => {
+    document.getElementById('progress').textContent = `${percent}%`;
   }
 });
 ```
@@ -691,7 +691,7 @@ import type {
   BrowserDeployInput, 
   DeployOptions,
   DeploySuccessResponse,
-  ProgressStats,
+  ProgressInfo,
   StaticFile,
   ShipError,
   ErrorType

package/dist/browser.d.ts

@@ -35,10 +35,8 @@ interface DeploymentOptions {
     spaDetect?: boolean;
     /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators). */
     tags?: string[];
-    /** Callback for overall deploy progress (0-100). */
-    onProgress?: (progress: number) => void;
-    /** Callback for detailed progress statistics. */
-    onProgressStats?: (progressStats: ProgressStats) => void;
+    /** Callback for deploy progress with detailed statistics. */
+    onProgress?: (info: ProgressInfo) => void;
 }
 /**
  * Options for configuring an deploy operation via `apiClient.deployFiles`.
@@ -46,16 +44,17 @@ interface DeploymentOptions {
  */
 type ApiDeployOptions = Omit<DeploymentOptions, 'pathDetect'>;
 /**
- * Detailed statistics about the progress of an deploy operation.
+ * Progress information for deploy operations.
+ * Provides consistent percentage-based progress with byte-level details.
  */
-interface ProgressStats {
-    /** The number of bytes loaded so far. */
+interface ProgressInfo {
+    /** Progress percentage (0-100). */
+    percent: number;
+    /** Number of bytes loaded so far. */
     loaded: number;
-    /** The total number of bytes to be loaded. May be 0 if unknown initially. */
+    /** Total number of bytes to be loaded. May be 0 if unknown initially. */
     total: number;
-    /** The progress as a fraction (loaded/total). Value is between 0 and 1. */
-    progress: number;
-    /** Optional identifier for the file this progress pertains to, if applicable. */
+    /** Current file being processed (optional). */
     file?: string;
 }
 /**
@@ -72,15 +71,10 @@ interface ShipClientOptions {
     /** Path to custom config file. */
     configFile?: string | undefined;
     /**
-     * Default callback for overall deploy progress for deploys made with this client.
-     * @param progress - A number between 0 and 100.
+     * Default callback for deploy progress for deploys made with this client.
+     * @param info - Progress information including percentage and byte counts.
      */
-    onProgress?: ((progress: number) => void) | undefined;
-    /**
-     * Default callback for detailed progress statistics for deploys made with this client.
-     * @param progressStats - Progress statistics object.
-     */
-    onProgressStats?: ((progressStats: ProgressStats) => void) | undefined;
+    onProgress?: ((info: ProgressInfo) => void) | undefined;
     /**
      * Default for maximum concurrent deploys.
      * Used if an deploy operation doesn't specify its own `maxConcurrency`.
@@ -92,6 +86,15 @@ interface ShipClientOptions {
      * Used if an deploy operation doesn't specify its own timeout.
      */
     timeout?: number | undefined;
+    /**
+     * When true, indicates the client should use HTTP-only cookies for authentication
+     * instead of explicit tokens. This is useful for internal browser applications
+     * where authentication is handled via secure cookies set by the API.
+     *
+     * When set, the pre-request authentication check is skipped, allowing requests
+     * to proceed with cookie-based credentials.
+     */
+    useCredentials?: boolean | undefined;
 }
 /**
  * Event map for Ship SDK events
@@ -159,9 +162,10 @@ declare class SimpleEvents {
  */
 declare class ApiHttp extends SimpleEvents {
     private readonly apiUrl;
-    private readonly apiKey;
-    private readonly deployToken;
-    constructor(options: ShipClientOptions);
+    private readonly getAuthHeadersCallback;
+    constructor(options: ShipClientOptions & {
+        getAuthHeaders: () => Record<string, string>;
+    });
     /**
      * Transfer events to another client (clean intentional API)
      */
@@ -171,13 +175,9 @@ declare class ApiHttp extends SimpleEvents {
      */
     private request;
     /**
-     * Generate auth headers
+     * Generate auth headers from Ship instance callback
      */
     private getAuthHeaders;
-    /**
-     * Check if credentials are needed
-     */
-    private needsCredentials;
     /**
      * Safely clone response for events
      */
@@ -236,7 +236,7 @@ declare class ApiHttp extends SimpleEvents {
  * @file Ship SDK resource implementations for deployments, domains, and accounts.
  */
 
-declare function createDeploymentResource(getApi: () => ApiHttp, clientDefaults?: ShipClientOptions, ensureInit?: () => Promise<void>, processInput?: (input: DeployInput, options: DeploymentOptions) => Promise<StaticFile[]>): DeploymentResource;
+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;
@@ -252,6 +252,8 @@ declare abstract class Ship$1 {
     protected readonly clientOptions: ShipClientOptions;
     protected initPromise: Promise<void> | null;
     protected _config: ConfigResponse | null;
+    private auth;
+    private readonly authHeadersCallback;
     protected _deployments: DeploymentResource;
     protected _domains: DomainResource;
     protected _account: AccountResource;
@@ -315,6 +317,30 @@ declare abstract class Ship$1 {
      * @protected
      */
     protected replaceHttpClient(newClient: ApiHttp): void;
+    /**
+     * Sets the deploy token for authentication.
+     * This will override any previously set API key or deploy token.
+     * @param token The deploy token (format: token-<64-char-hex>)
+     */
+    setDeployToken(token: string): void;
+    /**
+     * Sets the API key for authentication.
+     * This will override any previously set API key or deploy token.
+     * @param key The API key (format: ship-<64-char-hex>)
+     */
+    setApiKey(key: string): void;
+    /**
+     * Generate authorization headers based on current auth state
+     * Called dynamically on each request to ensure latest credentials are used
+     * @private
+     */
+    private getAuthHeaders;
+    /**
+     * Check if authentication credentials are configured
+     * Used by resources to fail fast if auth is required
+     * @private
+     */
+    private hasAuth;
 }
 
 /**
@@ -378,6 +404,35 @@ declare const JUNK_DIRECTORIES: readonly ["__MACOSX", ".Trashes", ".fseventsd",
  *
  * @param filePaths - An array of file path strings to filter
  * @returns A new array containing only non-junk file paths
+ *
+ * @example
+ * ```typescript
+ * import { filterJunk } from '@shipstatic/ship';
+ *
+ * // Filter an array of file paths
+ * const paths = ['index.html', '.DS_Store', '__MACOSX/file.txt', 'app.js'];
+ * const clean = filterJunk(paths);
+ * // Result: ['index.html', 'app.js']
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Use with browser File objects
+ * import { filterJunk } from '@shipstatic/ship';
+ *
+ * const files: File[] = [...]; // From input or drag-drop
+ *
+ * // Extract paths from File objects
+ * const filePaths = files.map(f => f.webkitRelativePath || f.name);
+ *
+ * // Filter out junk paths
+ * const validPaths = new Set(filterJunk(filePaths));
+ *
+ * // Filter the original File array
+ * const validFiles = files.filter(f =>
+ *   validPaths.has(f.webkitRelativePath || f.name)
+ * );
+ * ```
  */
 declare function filterJunk(filePaths: string[]): string[];
 
@@ -602,4 +657,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, FILE_VALIDATION_STATUS, type FileValidationResult, type FileValidationStatus, JUNK_DIRECTORIES, type MD5Result, type ProgressStats, Ship, type ShipClientOptions, type ShipEvents, type ValidatableFile, type ValidationError, __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, FILE_VALIDATION_STATUS, type FileValidationResult, type FileValidationStatus, JUNK_DIRECTORIES, type MD5Result, type ProgressInfo, Ship, type ShipClientOptions, type ShipEvents, type ValidatableFile, type ValidationError, __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 };