@shipstatic/ship 0.2.8 → 0.3.1

package/README.md

@@ -99,13 +99,13 @@ ship list                    # List deployments
 ship get abc123              # Get deployment details
 ship remove abc123           # Remove deployment
 
-# Manage aliases
-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
+# Manage domains
+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 remove staging                         # Remove domain
 
 # Account
 ship account                 # Get account details
@@ -157,7 +157,7 @@ interface ShipOptions {
 
 - `ship.ping()` - Check API connectivity
 - `ship.deployments` - Access deployment resource
-- `ship.aliases` - Access alias resource  
+- `ship.domains` - Access domain resource
 - `ship.account` - Access account resource
 - `ship.on(event, handler)` - Add event listener for API observability
 - `ship.off(event, handler)` - Remove event listener
@@ -209,35 +209,35 @@ interface DeployOptions {
 }
 ```
 
-### Aliases Resource
+### Domains Resource
 
 ```typescript
-// Set or update an alias (with optional tags)
-await ship.aliases.set(aliasName, deploymentId, tags?)
+// Set or update a domain (with optional tags)
+await ship.domains.set(domainName, deploymentId, tags?)
 
-// Get alias details
-await ship.aliases.get(aliasName)
+// Get domain details
+await ship.domains.get(domainName)
 
-// List all aliases
-await ship.aliases.list()
+// List all domains
+await ship.domains.list()
 
-// Remove alias
-await ship.aliases.remove(aliasName)
+// Remove domain
+await ship.domains.remove(domainName)
 
-// Trigger DNS confirmation for external alias
-await ship.aliases.confirm(aliasName)
+// Trigger DNS confirmation for external domain
+await ship.domains.confirm(domainName)
 ```
 
 **Examples:**
 ```javascript
-// Set alias without tags
-await ship.aliases.set('staging', 'dep_abc123');
+// Set domain without tags
+await ship.domains.set('staging', 'dep_abc123');
 
-// Set alias with tags
-await ship.aliases.set('production', 'dep_xyz789', ['prod', 'v1.0.0']);
+// Set domain with tags
+await ship.domains.set('production', 'dep_xyz789', ['prod', 'v1.0.0']);
 
-// Confirm DNS for external alias
-await ship.aliases.confirm('www.example.com');
+// Confirm DNS for external domain
+await ship.domains.confirm('www.example.com');
 ```
 
 ### Environment-Specific Examples
@@ -586,11 +586,11 @@ ship get abc123         # Get deployment details
 ship remove abc123      # Remove deployment
 ```
 
-### Alias Commands
+### Domain Commands
 
 ```bash
-ship aliases            # List aliases
-ship alias staging abc123  # Set alias to deployment
+ship domains            # List domains
+ship domains set staging abc123  # Set domain to deployment
 ```
 
 ### Account Commands
@@ -705,7 +705,7 @@ File Objects → Path Extraction → Junk Filtering → Content Processing → S
 Ship SDK provides comprehensive deployment functionality:
 
 - **Deployment Resource**: Complete operations (create, list, get, remove)
-- **Alias Resource**: Complete operations (set, get, list, remove)  
+- **Domain Resource**: Complete operations (set, get, list, remove)
 - **Account Resource**: Account information retrieval
 - **Event System**: Comprehensive observability with request, response, error events
 - **Unified Error System**: Single `ShipError` class with factory methods

package/dist/browser.d.ts

@@ -1,7 +1,7 @@
 import * as _shipstatic_types from '@shipstatic/types';
-import { PingResponse, ConfigResponse, StaticFile, Deployment, DeploymentListResponse, Alias, AliasListResponse, Account, TokenCreateResponse, TokenListResponse, DeployInput, DeploymentResource, AliasResource, AccountResource, TokenResource, PlatformConfig } from '@shipstatic/types';
+import { PingResponse, ConfigResponse, StaticFile, Deployment, DeploymentListResponse, Domain, DomainListResponse, Account, TokenCreateResponse, TokenListResponse, DeployInput, DeploymentResource, DomainResource, AccountResource, TokenResource, PlatformConfig } from '@shipstatic/types';
 export * from '@shipstatic/types';
-export { Account, Alias, DEFAULT_API, DeployInput, Deployment, PingResponse, ShipError, ShipErrorType } from '@shipstatic/types';
+export { Account, DEFAULT_API, DeployInput, Deployment, Domain, PingResponse, ShipError, ShipErrorType } from '@shipstatic/types';
 
 /**
  * @file SDK-specific type definitions
@@ -201,23 +201,23 @@ declare class ApiHttp extends SimpleEvents {
     listDeployments(): Promise<DeploymentListResponse>;
     getDeployment(id: string): Promise<Deployment>;
     removeDeployment(id: string): Promise<void>;
-    setAlias(name: string, deployment: string, tags?: string[]): Promise<Alias>;
-    getAlias(name: string): Promise<Alias>;
-    listAliases(): Promise<AliasListResponse>;
-    removeAlias(name: string): Promise<void>;
-    confirmAlias(name: string): Promise<{
+    setDomain(name: string, deployment: string, tags?: string[]): Promise<Domain>;
+    getDomain(name: string): Promise<Domain>;
+    listDomains(): Promise<DomainListResponse>;
+    removeDomain(name: string): Promise<void>;
+    confirmDomain(name: string): Promise<{
         message: string;
     }>;
-    getAliasDns(name: string): Promise<{
-        alias: string;
+    getDomainDns(name: string): Promise<{
+        domain: string;
         dns: any;
     }>;
-    getAliasRecords(name: string): Promise<{
-        alias: string;
+    getDomainRecords(name: string): Promise<{
+        domain: string;
         records: any[];
     }>;
-    getAliasShare(name: string): Promise<{
-        alias: string;
+    getDomainShare(name: string): Promise<{
+        domain: string;
         hash: string;
     }>;
     getAccount(): Promise<Account>;
@@ -233,11 +233,11 @@ declare class ApiHttp extends SimpleEvents {
 }
 
 /**
- * @file Ship SDK resource implementations for deployments, aliases, and accounts.
+ * @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 createAliasResource(getApi: () => ApiHttp, ensureInit?: () => Promise<void>): AliasResource;
+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;
 
@@ -251,8 +251,9 @@ declare abstract class Ship$1 {
     protected http: ApiHttp;
     protected readonly clientOptions: ShipClientOptions;
     protected initPromise: Promise<void> | null;
+    protected _config: ConfigResponse | null;
     protected _deployments: DeploymentResource;
-    protected _aliases: AliasResource;
+    protected _domains: DomainResource;
     protected _account: AccountResource;
     protected _tokens: TokenResource;
     constructor(options?: ShipClientOptions);
@@ -280,9 +281,9 @@ declare abstract class Ship$1 {
      */
     get deployments(): DeploymentResource;
     /**
-     * Get aliases resource
+     * Get domains resource
      */
-    get aliases(): AliasResource;
+    get domains(): DomainResource;
     /**
      * Get account resource
      */
@@ -291,6 +292,11 @@ declare abstract class Ship$1 {
      * Get tokens resource
      */
     get tokens(): TokenResource;
+    /**
+     * Get API configuration (file upload limits, etc.)
+     * Reuses platform config fetched during initialization, then caches the result
+     */
+    getConfig(): Promise<ConfigResponse>;
     /**
      * Add event listener
      * @param event - Event name
@@ -506,4 +512,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, createTokenResource, Ship as default, filterJunk, getCurrentConfig, getENV, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig };
+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, createDeploymentResource, createDomainResource, createTokenResource, Ship as default, filterJunk, getCurrentConfig, getENV, loadConfig, mergeDeployOptions, optimizeDeployPaths, pluralize, processFilesForBrowser, resolveConfig, setConfig as setPlatformConfig };