@shipstatic/ship 0.4.25 → 0.5.1

package/README.md

@@ -18,26 +18,26 @@ npm install @shipstatic/ship
 # Deploy a directory
 ship ./dist
 
-# Deploy with tags
-ship ./dist --tag production --tag v1.0.0
+# Deploy with labels
+ship ./dist --label production --label v1.0.0
 
 # Deployments
 ship deployments list
 ship deployments get <id>
-ship deployments set <id> --tag production      # Update tags
+ship deployments set <id> --label production      # Update labels
 ship deployments remove <id>
 
 # Domains
 ship domains list
-ship domains set staging <deployment-id>        # Point domain to deployment
-ship domains set staging --tag production       # Update domain tags
+ship domains set staging <deployment-id>          # Link domain to deployment
+ship domains set staging --label production       # Update domain labels
 ship domains get staging
 ship domains verify www.example.com
 ship domains remove staging
 
 # Tokens
 ship tokens list
-ship tokens create --ttl 3600 --tag ci
+ship tokens create --ttl 3600 --label ci
 ship tokens remove <token>
 
 # Account
@@ -64,9 +64,9 @@ console.log(`Deployed: ${result.url}`);
 await ship.domains.set('staging', { deployment: result.deployment });
 await ship.domains.list();
 
-// Update tags
-await ship.deployments.set(result.deployment, { tags: ['production', 'v1.0'] });
-await ship.domains.set('staging', { tags: ['live'] });
+// Update labels
+await ship.deployments.set(result.deployment, { labels: ['production', 'v1.0'] });
+await ship.domains.set('staging', { labels: ['live'] });
 ```
 
 ## Browser Usage
@@ -123,18 +123,18 @@ SHIP_API_KEY=ship-your-api-key
 ship.deployments.create(input, options?)    // Create new deployment
 ship.deployments.list()                      // List all deployments
 ship.deployments.get(id)                     // Get deployment details
-ship.deployments.set(id, { tags })           // Update deployment tags
+ship.deployments.set(id, { labels })         // Update deployment labels
 ship.deployments.remove(id)                  // Delete deployment
 
 // Domains
-ship.domains.set(name, { deployment?, tags? })  // Create/update domain (see below)
+ship.domains.set(name, { deployment?, labels? })  // Create/update domain (see below)
 ship.domains.get(name)                          // Get domain details
 ship.domains.list()                             // List all domains
 ship.domains.remove(name)                       // Delete domain
 ship.domains.verify(name)                       // Trigger DNS verification
 
 // Tokens
-ship.tokens.create({ ttl?, tags? })          // Create deploy token
+ship.tokens.create({ ttl?, labels? })        // Create deploy token
 ship.tokens.list()                           // List all tokens
 ship.tokens.remove(token)                    // Revoke token
 
@@ -148,17 +148,14 @@ ship.ping()                                  // Check API connectivity
 ### domains.set() Behavior
 
 ```typescript
-// Point domain to deployment
+// Link domain to deployment
 ship.domains.set('staging', { deployment: 'abc123' });
 
-// Point domain to deployment with tags
-ship.domains.set('staging', { deployment: 'abc123', tags: ['prod'] });
+// Link domain to deployment with labels
+ship.domains.set('staging', { deployment: 'abc123', labels: ['prod'] });
 
-// Update tags only (domain must exist)
-ship.domains.set('staging', { tags: ['prod', 'v2'] });
-
-// Error: must provide deployment or tags
-ship.domains.set('staging', {});  // throws validation error
+// Update labels only (domain must exist)
+ship.domains.set('staging', { labels: ['prod', 'v2'] });
 ```
 
 **Domain format:** Domain names are FQDNs (Fully Qualified Domain Names). The SDK accepts any format (case-insensitive, Unicode) - the API handles normalization.

package/dist/browser.d.ts

@@ -33,8 +33,8 @@ interface DeploymentOptions {
     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[];
+    /** Optional array of labels for categorization and filtering (lowercase, alphanumeric with separators). */
+    labels?: 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. */
@@ -55,7 +55,7 @@ interface DeployBody {
  * 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>;
+type DeployBodyCreator = (files: StaticFile[], labels?: 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.
@@ -192,12 +192,12 @@ declare class ApiHttp extends SimpleEvents {
     deploy(files: StaticFile[], options?: ApiDeployOptions): Promise<Deployment>;
     listDeployments(): Promise<DeploymentListResponse>;
     getDeployment(id: string): Promise<Deployment>;
-    updateDeploymentTags(id: string, tags: string[]): Promise<Deployment>;
+    updateDeploymentLabels(id: string, labels: string[]): Promise<Deployment>;
     removeDeployment(id: string): Promise<void>;
-    setDomain(name: string, deployment?: string, tags?: string[]): Promise<Domain>;
+    setDomain(name: string, deployment?: string, labels?: string[]): Promise<Domain>;
     listDomains(): Promise<DomainListResponse>;
     getDomain(name: string): Promise<Domain>;
-    updateDomainTags(name: string, tags: string[]): Promise<Domain>;
+    updateDomainLabels(name: string, labels: string[]): Promise<Domain>;
     removeDomain(name: string): Promise<void>;
     verifyDomain(name: string): Promise<{
         message: string;
@@ -209,7 +209,7 @@ declare class ApiHttp extends SimpleEvents {
         hash: string;
     }>;
     validateDomain(name: string): Promise<DomainValidateResponse>;
-    createToken(ttl?: number, tags?: string[]): Promise<TokenCreateResponse>;
+    createToken(ttl?: number, labels?: string[]): Promise<TokenCreateResponse>;
     listTokens(): Promise<TokenListResponse>;
     removeToken(token: string): Promise<void>;
     getAccount(): Promise<Account>;