@shipstatic/types 0.6.2 → 0.7.1

package/README.md

@@ -19,28 +19,54 @@ npm install @shipstatic/types
 ### Core Entities
 
 ```typescript
-import type { Deployment, Domain, Account, Token, StaticFile } from '@shipstatic/types';
+import type {
+  Deployment, DeploymentListResponse,
+  Domain, DomainListResponse, DnsRecord, DomainDnsResponse, DomainRecordsResponse, DomainValidateResponse,
+  Token, TokenListItem, TokenListResponse, TokenCreateResponse,
+  Account, AccountUsage, AccountOverrides,
+  StaticFile
+} from '@shipstatic/types';
 ```
 
 ### Error System
 
 ```typescript
-import { ShipError, ErrorType } from '@shipstatic/types';
+import { ShipError, ErrorType, isShipError } from '@shipstatic/types';
 
 throw ShipError.validation('File too large');
 throw ShipError.notFound('Deployment', id);
+throw ShipError.authentication();
+throw ShipError.business('Plan limit reached');
+
+if (isShipError(error)) {
+  console.log(error.status, error.type, error.message);
+}
 
-if (error.isClientError()) { /* handle */ }
+if (error.isClientError()) { /* Business | Config | File | Validation */ }
+if (error.isAuthError()) { /* handle auth */ }
+```
+
+### Status Constants
+
+```typescript
+import {
+  DeploymentStatus,   // pending | success | failed | deleting
+  DomainStatus,       // pending | partial | success | paused
+  AccountPlan,        // free | standard | sponsored | enterprise | suspended | terminating | terminated
+  FileValidationStatus, // pending | processing_error | excluded | validation_failed | ready
+  AuthMethod,         // jwt | apiKey | token | webhook | system
+} from '@shipstatic/types';
 ```
 
 ### API Response Types
 
 ```typescript
 import type {
-  DeploymentListResponse,
-  DomainListResponse,
   ConfigResponse,
-  BillingStatus
+  BillingStatus,
+  CheckoutSession,
+  ActivityListResponse,
+  PingResponse,
 } from '@shipstatic/types';
 ```
 
@@ -49,13 +75,62 @@ import type {
 SDK interface definitions:
 
 ```typescript
-import type { DeploymentResource, DomainResource, AccountResource } from '@shipstatic/types';
+import type {
+  DeploymentResource,
+  DomainResource,
+  AccountResource,
+  TokenResource,
+  BillingResource,
+  KeysResource,
+} from '@shipstatic/types';
 ```
 
 ### Validation Utilities
 
 ```typescript
-import { validateApiKey, validateDeployToken, isDeployment } from '@shipstatic/types';
+import {
+  validateApiKey,
+  validateDeployToken,
+  validateApiUrl,
+  isDeployment,
+  isBlockedExtension,
+  BLOCKED_EXTENSIONS,
+} from '@shipstatic/types';
+```
+
+### File Upload Types
+
+```typescript
+import type {
+  ValidatableFile,
+  FileValidationResult,
+  ValidationIssue,
+  UploadedFile,
+  ProgressInfo,
+} from '@shipstatic/types';
+```
+
+### Domain Utilities
+
+```typescript
+import {
+  isPlatformDomain,
+  isCustomDomain,
+  extractSubdomain,
+  generateDeploymentUrl,
+  generateDomainUrl,
+} from '@shipstatic/types';
+```
+
+### Label Utilities
+
+```typescript
+import {
+  LABEL_CONSTRAINTS,
+  LABEL_PATTERN,
+  serializeLabels,
+  deserializeLabels,
+} from '@shipstatic/types';
 ```
 
 ### Constants
@@ -64,16 +139,15 @@ import { validateApiKey, validateDeployToken, isDeployment } from '@shipstatic/t
 import {
   DEFAULT_API,
   API_KEY_PREFIX,
-  DeploymentStatus,
-  DomainStatus,
-  AccountPlan
+  DEPLOY_TOKEN_PREFIX,
+  DEPLOYMENT_CONFIG_FILENAME,
 } from '@shipstatic/types';
 ```
 
 ## Usage
 
 ```typescript
-import { ShipError, type Deployment, DeploymentStatus } from '@shipstatic/types';
+import { ShipError, isShipError, type Deployment, DeploymentStatus } from '@shipstatic/types';
 
 function processDeployment(deployment: Deployment) {
   if (deployment.status === DeploymentStatus.FAILED) {

package/dist/index.d.ts

@@ -529,7 +529,7 @@ export type DeployInput = File[] | string | string[];
  * Options for deployment creation at the API contract level.
  * SDK implementations may extend with additional options (timeout, signal, callbacks, etc.).
  */
-export interface DeploymentCreateOptions {
+export interface DeploymentUploadOptions {
     /** Optional labels for categorization and filtering */
     labels?: string[];
     /** Optional subdomain suggestion for the deployment */
@@ -541,7 +541,7 @@ export interface DeploymentCreateOptions {
  * Deployment resource interface - the contract all implementations must follow
  */
 export interface DeploymentResource {
-    create: (input: DeployInput, options?: DeploymentCreateOptions) => Promise<Deployment>;
+    upload: (input: DeployInput, options?: DeploymentUploadOptions) => Promise<Deployment>;
     list: () => Promise<DeploymentListResponse>;
     get: (id: string) => Promise<Deployment>;
     set: (id: string, options: {
@@ -643,7 +643,7 @@ export interface KeysResource {
  * All activity event types logged in the system.
  * Uses dot notation consistently: {resource}.{action}
  */
-export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created';
+export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.paid' | 'account.plan.transition' | 'account.suspended' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'admin.account.plan.update' | 'admin.account.ref.update' | 'admin.account.billing.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.billing.sync' | 'admin.billing.terminated' | 'admin.impersonate' | 'billing.active' | 'billing.canceled' | 'billing.paused' | 'billing.expired' | 'billing.paid' | 'billing.trialing' | 'billing.scheduled_cancel' | 'billing.unpaid' | 'billing.update' | 'billing.past_due' | 'refund.created' | 'dispute.created';
 /**
  * Activity events visible to users in the dashboard
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.6.2",
+  "version": "0.7.1",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -815,7 +815,7 @@ export type DeployInput = File[] | string | string[];
  * Options for deployment creation at the API contract level.
  * SDK implementations may extend with additional options (timeout, signal, callbacks, etc.).
  */
-export interface DeploymentCreateOptions {
+export interface DeploymentUploadOptions {
   /** Optional labels for categorization and filtering */
   labels?: string[];
   /** Optional subdomain suggestion for the deployment */
@@ -828,7 +828,7 @@ export interface DeploymentCreateOptions {
  * Deployment resource interface - the contract all implementations must follow
  */
 export interface DeploymentResource {
-  create: (input: DeployInput, options?: DeploymentCreateOptions) => Promise<Deployment>;
+  upload: (input: DeployInput, options?: DeploymentUploadOptions) => Promise<Deployment>;
   list: () => Promise<DeploymentListResponse>;
   get: (id: string) => Promise<Deployment>;
   set: (id: string, options: { labels: string[] }) => Promise<Deployment>;
@@ -965,6 +965,7 @@ export type ActivityEvent =
   | 'admin.domain.delete'
   | 'admin.billing.sync'
   | 'admin.billing.terminated'
+  | 'admin.impersonate'
   // Webhook events (logged directly from payment provider)
   | 'billing.active'
   | 'billing.canceled'