@shipstatic/ship 0.2.5 → 0.2.7-alpha.1

package/README.md

@@ -90,6 +90,9 @@ ship ./dist
 # Or deploy current directory
 ship
 
+# Deploy with tags
+ship deployments create ./dist --tag production --tag v1.0.0
+
 # Explicit commands
 ship deploy ./build          # Deploy project from path
 ship list                    # List deployments
@@ -97,8 +100,12 @@ ship get abc123              # Get deployment details
 ship remove abc123           # Remove deployment
 
 # Manage aliases
-ship aliases                 # List aliases
-ship alias staging abc123    # Set alias to deployment
+ship aliases list                                   # List aliases
+ship aliases set staging abc123                     # Set alias to deployment
+ship aliases set prod abc123 --tag production       # Set alias with tag
+ship aliases set prod abc123 --tag prod --tag v1    # Set alias with multiple tags
+ship aliases confirm www.example.com                # Trigger DNS confirmation
+ship aliases remove staging                         # Remove alias
 
 # Account
 ship account                 # Get account details
@@ -190,17 +197,49 @@ interface DeployOptions {
   apiUrl?: string;
   apiKey?: string;                  // API key: ship- prefix + 64-char hex (69 chars total)
   deployToken?: string;             // Deploy token: token- prefix + 64-char hex (70 chars total)
-  signal?: AbortSignal;           // Cancellation
-  subdomain?: string;             // Custom subdomain
+  tags?: string[];                  // Optional array of tags for categorization
+  signal?: AbortSignal;             // Cancellation
+  subdomain?: string;               // Custom subdomain
   onCancel?: () => void;
   onProgress?: (progress: number) => void;
   progress?: (stats: ProgressStats) => void;
   maxConcurrency?: number;
   timeout?: number;
-  stripCommonPrefix?: boolean;    // Remove common path prefix
+  stripCommonPrefix?: boolean;      // Remove common path prefix
 }
 ```
 
+### Aliases Resource
+
+```typescript
+// Set or update an alias (with optional tags)
+await ship.aliases.set(aliasName, deploymentId, tags?)
+
+// Get alias details
+await ship.aliases.get(aliasName)
+
+// List all aliases
+await ship.aliases.list()
+
+// Remove alias
+await ship.aliases.remove(aliasName)
+
+// Trigger DNS confirmation for external alias
+await ship.aliases.confirm(aliasName)
+```
+
+**Examples:**
+```javascript
+// Set alias without tags
+await ship.aliases.set('staging', 'dep_abc123');
+
+// Set alias with tags
+await ship.aliases.set('production', 'dep_xyz789', ['prod', 'v1.0.0']);
+
+// Confirm DNS for external alias
+await ship.aliases.confirm('www.example.com');
+```
+
 ### Environment-Specific Examples
 
 #### Node.js File Deployment

package/dist/browser.d.ts

@@ -25,14 +25,16 @@ interface DeploymentOptions {
     maxConcurrency?: number;
     /** Timeout in milliseconds for the deploy request. */
     timeout?: number;
-    /** API key for this specific deploy. Overrides client's default. */
+    /** API key for this specific deploy. Overrides client's default (format: ship-<64-char-hex>, total 69 chars). */
     apiKey?: string;
-    /** Deploy token for this specific deploy. Overrides client's default. */
+    /** Deploy token for this specific deploy. Overrides client's default (format: token-<64-char-hex>, total 70 chars). */
     deployToken?: string;
     /** Whether to auto-detect and optimize file paths by flattening common directories. Defaults to true. */
     pathDetect?: boolean;
     /** Whether to auto-detect SPAs and generate ship.json configuration. Defaults to true. */
     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. */
@@ -63,9 +65,9 @@ interface ProgressStats {
 interface ShipClientOptions {
     /** Default API URL for the client instance. */
     apiUrl?: string | undefined;
-    /** API key for authenticated deployments. */
+    /** API key for authenticated deployments (format: ship-<64-char-hex>, total 69 chars). */
     apiKey?: string | undefined;
-    /** Deploy token for single-use deployments. */
+    /** Deploy token for single-use deployments (format: token-<64-char-hex>, total 70 chars). */
     deployToken?: string | undefined;
     /** Path to custom config file. */
     configFile?: string | undefined;
@@ -199,13 +201,25 @@ declare class ApiHttp extends SimpleEvents {
     listDeployments(): Promise<DeploymentListResponse>;
     getDeployment(id: string): Promise<Deployment>;
     removeDeployment(id: string): Promise<void>;
-    setAlias(name: string, deployment: string): Promise<Alias>;
+    setAlias(name: string, deployment: string, tags?: string[]): Promise<Alias>;
     getAlias(name: string): Promise<Alias>;
     listAliases(): Promise<AliasListResponse>;
     removeAlias(name: string): Promise<void>;
-    checkAlias(name: string): Promise<{
+    confirmAlias(name: string): Promise<{
         message: string;
     }>;
+    getAliasDns(name: string): Promise<{
+        alias: string;
+        dns: any;
+    }>;
+    getAliasRecords(name: string): Promise<{
+        alias: string;
+        records: any[];
+    }>;
+    getAliasShare(name: string): Promise<{
+        alias: string;
+        hash: string;
+    }>;
     getAccount(): Promise<Account>;
     checkSPA(files: StaticFile[]): Promise<boolean>;
     private validateFiles;
@@ -412,16 +426,29 @@ declare function getENV(): ExecutionEnvironment;
 
 /**
  * @file Browser configuration implementation - no file system access.
+ * Browser environment receives all config through constructor options.
  */
 
 /**
- * Browser config loading - only uses provided options.
+ * Browser config loading - always returns empty (no file system access).
+ * All configuration must be provided through Ship constructor options.
  */
 declare function loadConfig(configFile?: string): Promise<Config>;
+
+/**
+ * @file Platform configuration management for the Ship SDK.
+ * Implements fail-fast dynamic configuration with mandatory API fetch.
+ */
+
+/**
+ * Set the current config (called after fetching from API)
+ */
+declare function setConfig(config: ConfigResponse): void;
 /**
- * Set platform config in browser.
+ * Get current config - throws if not initialized (fail-fast approach)
+ * @throws {ShipError.config} If configuration hasn't been fetched from API
  */
-declare function setConfig(config: any): void;
+declare function getCurrentConfig(): ConfigResponse;
 
 /**
  * @file Browser-specific file utilities for the Ship SDK.
@@ -470,4 +497,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, type ProgressStats, Ship, type ShipClientOptions, type ShipEvents, __setTestEnvironment, calculateMD5, createAccountResource, createAliasResource, createDeploymentResource, Ship as default, filterJunk, getENV, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig };
+export { type ApiDeployOptions, ApiHttp, type Config, type DeployFile, type DeploymentOptions, type ExecutionEnvironment, JUNK_DIRECTORIES, type MD5Result, type ProgressStats, Ship, type ShipClientOptions, type ShipEvents, __setTestEnvironment, calculateMD5, createAccountResource, createAliasResource, createDeploymentResource, Ship as default, filterJunk, getCurrentConfig, getENV, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig };