@shipstatic/ship 0.4.6 → 0.4.7

package/README.md

@@ -161,6 +161,13 @@ ship.domains.set('staging', { tags: ['prod', 'v2'] });
 ship.domains.set('staging', {});  // throws validation error
 ```
 
+**Domain format:** Domain names are FQDNs (Fully Qualified Domain Names). The SDK accepts any format (case-insensitive, Unicode) - the API handles normalization.
+
+```typescript
+ship.domains.set('Example.COM', { deployment: 'abc' });  // → normalized to 'example.com'
+ship.domains.set('münchen.de', { deployment: 'abc' });   // → Unicode supported
+```
+
 ### Events
 
 ```javascript

package/dist/browser.d.ts

@@ -264,9 +264,25 @@ interface DeploymentResourceContext extends ResourceContext {
     clientDefaults?: ShipClientOptions;
     hasAuth?: () => boolean;
 }
+/**
+ * Create deployment resource with all CRUD operations.
+ */
 declare function createDeploymentResource(ctx: DeploymentResourceContext): DeploymentResource;
+/**
+ * Create domain resource with all CRUD operations.
+ *
+ * @remarks
+ * The `name` parameter in all methods is an FQDN (Fully Qualified Domain Name).
+ * The SDK does not validate or normalize domain names - the API handles all domain semantics.
+ */
 declare function createDomainResource(ctx: ResourceContext): DomainResource;
+/**
+ * Create account resource (whoami functionality).
+ */
 declare function createAccountResource(ctx: ResourceContext): AccountResource;
+/**
+ * Create token resource for managing deploy tokens.
+ */
 declare function createTokenResource(ctx: ResourceContext): TokenResource;
 
 /**