@shipstatic/types 0.2.3 → 0.2.5

package/dist/index.d.ts

@@ -2,28 +2,40 @@
  * @file Shared TypeScript types, constants, and utilities for the Shipstatic platform.
  * This package is the single source of truth for all shared data structures.
  */
+/**
+ * Deployment status constants
+ */
+export declare const DeploymentStatus: {
+    readonly PENDING: "pending";
+    readonly SUCCESS: "success";
+    readonly FAILED: "failed";
+    readonly DELETING: "deleting";
+};
+export type DeploymentStatusType = typeof DeploymentStatus[keyof typeof DeploymentStatus];
 /**
  * Core deployment object - used in both API responses and SDK
  */
 export interface Deployment {
     /** The deployment ID */
-    deployment: string;
+    readonly deployment: string;
     /** Number of files in this deployment */
-    files: number;
+    readonly files: number;
     /** Total size of all files in bytes */
-    size: number;
-    /** Current deployment status - computed from verified field */
-    status: 'incomplete' | 'complete';
+    readonly size: number;
+    /** Current deployment status */
+    status: DeploymentStatusType;
     /** Whether deployment has configuration */
-    config?: boolean;
+    readonly config?: boolean;
     /** The deployment URL */
-    url: string;
+    readonly url: string;
     /** Unix timestamp (seconds) when deployment was created */
-    created: number;
+    readonly created: number;
     /** Unix timestamp (seconds) when deployment expires */
     expires?: number;
     /** Unix timestamp (seconds) when deployment was verified and ready */
     verified?: number;
+    /** Short-lived JWT token for claiming this deployment (only present for public deployments) */
+    claimToken?: string;
 }
 /**
  * Response for listing deployments
@@ -36,24 +48,33 @@ export interface DeploymentListResponse {
     /** Total number of deployments if available */
     total?: number;
 }
+/**
+ * Alias status constants
+ */
+export declare const AliasStatus: {
+    readonly PENDING: "pending";
+    readonly SUCCESS: "success";
+    readonly FAILED: "failed";
+};
+export type AliasStatusType = typeof AliasStatus[keyof typeof AliasStatus];
 /**
  * Core alias object - used in both API responses and SDK
  */
 export interface Alias {
     /** The alias name */
-    alias: string;
+    readonly alias: string;
     /** The deployment name this alias points to */
     deployment: string;
     /** Current alias status */
-    status: 'pending' | 'success' | 'failed';
+    status: AliasStatusType;
     /** The alias URL - internal (subdomain) or external (custom domain) */
-    url: string;
+    readonly url: string;
     /** Unix timestamp (seconds) when alias was created */
-    created: number;
+    readonly created: number;
+    /** Whether this was a create (201) or update (200) operation */
+    readonly isCreate?: boolean;
     /** Unix timestamp (seconds) when alias was confirmed */
     confirmed?: number;
-    /** Whether this was a create operation (true) or update operation (false). Optional - only present in set operations */
-    isCreate?: boolean;
 }
 /**
  * Response for listing aliases
@@ -77,6 +98,18 @@ export interface DeploymentRemoveResponse {
     /** Human-readable message */
     message?: string;
 }
+/**
+ * Account plan constants
+ */
+export declare const AccountPlan: {
+    readonly FREE: "free";
+    readonly PAID: "paid";
+    readonly PARTNER: "partner";
+    readonly SUSPENDED: "suspended";
+    readonly TERMINATING: "terminating";
+    readonly TERMINATED: "terminated";
+};
+export type AccountPlanType = typeof AccountPlan[keyof typeof AccountPlan];
 /**
  * Core account object - used in both API responses and SDK
  */
@@ -88,9 +121,11 @@ export interface Account {
     /** User profile picture URL */
     picture?: string;
     /** Account plan status */
-    plan: 'free' | 'active' | 'suspended';
+    plan: AccountPlanType;
     /** Unix timestamp (seconds) when account was created */
     created: number;
+    /** Unix timestamp (seconds) when account was activated (first deployment) */
+    activated?: number;
 }
 /**
  * All possible error types in the Shipstatic platform
@@ -167,22 +202,6 @@ export declare class ShipError extends Error {
     isConfigError(): boolean;
     isType(errorType: ErrorType): boolean;
 }
-/**
- * Server-side platform configuration - enforced limits on the platform
- */
-export declare const serverConfig: {
-    /** Maximum individual file size in bytes (10MB) */
-    readonly maxFileSize: number;
-    /** Maximum number of files per deployment */
-    readonly maxFilesCount: 1000;
-    /** Maximum total deployment size in bytes (100MB) */
-    readonly maxTotalSize: number;
-    /** Deployment expiry in hours */
-    readonly deploymentExpiryHours: 120;
-    /** Pagination limits */
-    readonly defaultLimit: 50;
-    readonly maxLimit: 100;
-};
 /**
  * Platform configuration response from API
  */
@@ -218,6 +237,12 @@ export declare const API_KEY_TOTAL_LENGTH: number;
 export declare const DEPLOY_TOKEN_PREFIX = "token-";
 export declare const DEPLOY_TOKEN_HEX_LENGTH = 64;
 export declare const DEPLOY_TOKEN_TOTAL_LENGTH: number;
+export declare const AuthMethod: {
+    readonly JWT: "jwt";
+    readonly API_KEY: "apiKey";
+    readonly TOKEN: "token";
+};
+export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
 export declare const DEPLOYMENT_CONFIG_FILENAME = "ship.json";
 /**
  * Validate API key format
@@ -347,15 +372,6 @@ export interface UploadedFile {
     size: number;
     validated?: boolean;
 }
-/**
- * Deployment status enumeration
- */
-export declare enum DeploymentStatus {
-    PENDING = "pending",
-    SUCCESS = "success",
-    FAILED = "failed",
-    DELETING = "deleting"
-}
 /**
  * Rate limiting data structure
  */

package/dist/index.js

@@ -3,6 +3,43 @@
  * This package is the single source of truth for all shared data structures.
  */
 // =============================================================================
+// I. CORE ENTITIES
+// =============================================================================
+/**
+ * Deployment status constants
+ */
+export const DeploymentStatus = {
+    PENDING: 'pending',
+    SUCCESS: 'success',
+    FAILED: 'failed',
+    DELETING: 'deleting'
+};
+// =============================================================================
+// ALIAS TYPES
+// =============================================================================
+/**
+ * Alias status constants
+ */
+export const AliasStatus = {
+    PENDING: 'pending',
+    SUCCESS: 'success',
+    FAILED: 'failed'
+};
+// =============================================================================
+// ACCOUNT TYPES
+// =============================================================================
+/**
+ * Account plan constants
+ */
+export const AccountPlan = {
+    FREE: 'free',
+    PAID: 'paid',
+    PARTNER: 'partner',
+    SUSPENDED: 'suspended',
+    TERMINATING: 'terminating',
+    TERMINATED: 'terminated'
+};
+// =============================================================================
 // ERROR SYSTEM
 // =============================================================================
 /**
@@ -142,25 +179,6 @@ export class ShipError extends Error {
         return this.type === errorType;
     }
 }
-// =============================================================================
-// CONFIGURATION CONSTANTS
-// =============================================================================
-/**
- * Server-side platform configuration - enforced limits on the platform
- */
-export const serverConfig = {
-    /** Maximum individual file size in bytes (10MB) */
-    maxFileSize: 10 * 1024 * 1024,
-    /** Maximum number of files per deployment */
-    maxFilesCount: 1000,
-    /** Maximum total deployment size in bytes (100MB) */
-    maxTotalSize: 100 * 1024 * 1024,
-    /** Deployment expiry in hours */
-    deploymentExpiryHours: 120, // 5 days
-    /** Pagination limits */
-    defaultLimit: 50,
-    maxLimit: 100,
-};
 // API Key Configuration
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
@@ -169,6 +187,12 @@ export const API_KEY_TOTAL_LENGTH = API_KEY_PREFIX.length + API_KEY_HEX_LENGTH;
 export const DEPLOY_TOKEN_PREFIX = 'token-';
 export const DEPLOY_TOKEN_HEX_LENGTH = 64;
 export const DEPLOY_TOKEN_TOTAL_LENGTH = DEPLOY_TOKEN_PREFIX.length + DEPLOY_TOKEN_HEX_LENGTH; // 70
+// Authentication Method Constants
+export const AuthMethod = {
+    JWT: 'jwt',
+    API_KEY: 'apiKey',
+    TOKEN: 'token'
+};
 // Deployment Configuration
 export const DEPLOYMENT_CONFIG_FILENAME = 'ship.json';
 // =============================================================================
@@ -239,16 +263,6 @@ export function validateSubdomain(input) {
 // =============================================================================
 /** Default API URL if not otherwise configured. */
 export const DEFAULT_API = 'https://api.shipstatic.com';
-/**
- * Deployment status enumeration
- */
-export var DeploymentStatus;
-(function (DeploymentStatus) {
-    DeploymentStatus["PENDING"] = "pending";
-    DeploymentStatus["SUCCESS"] = "success";
-    DeploymentStatus["FAILED"] = "failed";
-    DeploymentStatus["DELETING"] = "deleting";
-})(DeploymentStatus || (DeploymentStatus = {}));
 // =============================================================================
 // URL GENERATION UTILITIES
 // =============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",
@@ -34,7 +34,7 @@
   },
   "devDependencies": {
     "@types/node": "^24.3.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "scripts": {
     "build": "tsc",

package/src/index.ts

@@ -7,28 +7,42 @@
 // I. CORE ENTITIES
 // =============================================================================
 
+/**
+ * Deployment status constants
+ */
+export const DeploymentStatus = {
+  PENDING: 'pending',
+  SUCCESS: 'success',
+  FAILED: 'failed',
+  DELETING: 'deleting'
+} as const;
+
+export type DeploymentStatusType = typeof DeploymentStatus[keyof typeof DeploymentStatus];
+
 /**
  * Core deployment object - used in both API responses and SDK
  */
 export interface Deployment {
   /** The deployment ID */
-  deployment: string;
+  readonly deployment: string;
   /** Number of files in this deployment */
-  files: number;
+  readonly files: number;
   /** Total size of all files in bytes */
-  size: number;
-  /** Current deployment status - computed from verified field */
-  status: 'incomplete' | 'complete';
+  readonly size: number;
+  /** Current deployment status */
+  status: DeploymentStatusType; // Mutable - can be updated
   /** Whether deployment has configuration */
-  config?: boolean;
+  readonly config?: boolean;
   /** The deployment URL */
-  url: string;
+  readonly url: string;
   /** Unix timestamp (seconds) when deployment was created */
-  created: number;
+  readonly created: number;
   /** Unix timestamp (seconds) when deployment expires */
-  expires?: number;
+  expires?: number; // Mutable - can be updated
   /** Unix timestamp (seconds) when deployment was verified and ready */
-  verified?: number;
+  verified?: number; // Mutable - can be updated  
+  /** Short-lived JWT token for claiming this deployment (only present for public deployments) */
+  claimToken?: string; // Mutable - can be updated
 }
 
 
@@ -48,24 +62,35 @@ export interface DeploymentListResponse {
 // ALIAS TYPES
 // =============================================================================
 
+/**
+ * Alias status constants
+ */
+export const AliasStatus = {
+  PENDING: 'pending',
+  SUCCESS: 'success',
+  FAILED: 'failed'
+} as const;
+
+export type AliasStatusType = typeof AliasStatus[keyof typeof AliasStatus];
+
 /**
  * Core alias object - used in both API responses and SDK
  */
 export interface Alias {
   /** The alias name */
-  alias: string;
+  readonly alias: string;
   /** The deployment name this alias points to */
-  deployment: string;
+  deployment: string; // Mutable - can be updated to point to different deployment
   /** Current alias status */
-  status: 'pending' | 'success' | 'failed';
+  status: AliasStatusType; // Mutable - can be updated
   /** The alias URL - internal (subdomain) or external (custom domain) */
-  url: string;
+  readonly url: string;
   /** Unix timestamp (seconds) when alias was created */
-  created: number;
+  readonly created: number;
+  /** Whether this was a create (201) or update (200) operation */
+  readonly isCreate?: boolean;
   /** Unix timestamp (seconds) when alias was confirmed */
-  confirmed?: number;
-  /** Whether this was a create operation (true) or update operation (false). Optional - only present in set operations */
-  isCreate?: boolean;
+  confirmed?: number; // Mutable - can be updated
 }
 
 /**
@@ -96,6 +121,20 @@ export interface DeploymentRemoveResponse {
 // ACCOUNT TYPES
 // =============================================================================
 
+/**
+ * Account plan constants
+ */
+export const AccountPlan = {
+  FREE: 'free',
+  PAID: 'paid',
+  PARTNER: 'partner',
+  SUSPENDED: 'suspended',
+  TERMINATING: 'terminating',
+  TERMINATED: 'terminated'
+} as const;
+
+export type AccountPlanType = typeof AccountPlan[keyof typeof AccountPlan];
+
 /**
  * Core account object - used in both API responses and SDK
  */
@@ -107,9 +146,11 @@ export interface Account {
   /** User profile picture URL */
   picture?: string;
   /** Account plan status */
-  plan: 'free' | 'active' | 'suspended';
+  plan: AccountPlanType;
   /** Unix timestamp (seconds) when account was created */
   created: number;
+  /** Unix timestamp (seconds) when account was activated (first deployment) */
+  activated?: number;
 }
 
 // =============================================================================
@@ -298,22 +339,6 @@ export class ShipError extends Error {
 // CONFIGURATION CONSTANTS
 // =============================================================================
 
-/**
- * Server-side platform configuration - enforced limits on the platform
- */
-export const serverConfig = {
-  /** Maximum individual file size in bytes (10MB) */
-  maxFileSize: 10 * 1024 * 1024,
-  /** Maximum number of files per deployment */
-  maxFilesCount: 1000,
-  /** Maximum total deployment size in bytes (100MB) */
-  maxTotalSize: 100 * 1024 * 1024,
-  /** Deployment expiry in hours */
-  deploymentExpiryHours: 120, // 5 days
-  /** Pagination limits */
-  defaultLimit: 50,
-  maxLimit: 100,
-} as const;
 
 
 
@@ -368,6 +393,15 @@ export const DEPLOY_TOKEN_PREFIX = 'token-';
 export const DEPLOY_TOKEN_HEX_LENGTH = 64;
 export const DEPLOY_TOKEN_TOTAL_LENGTH = DEPLOY_TOKEN_PREFIX.length + DEPLOY_TOKEN_HEX_LENGTH; // 70
 
+// Authentication Method Constants
+export const AuthMethod = {
+  JWT: 'jwt',
+  API_KEY: 'apiKey', 
+  TOKEN: 'token'
+} as const;
+
+export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
+
 // Deployment Configuration
 export const DEPLOYMENT_CONFIG_FILENAME = 'ship.json';
 
@@ -588,16 +622,6 @@ export interface UploadedFile {
   validated?: boolean;
 }
 
-/**
- * Deployment status enumeration
- */
-export enum DeploymentStatus {
-  PENDING = 'pending',
-  SUCCESS = 'success',
-  FAILED = 'failed',
-  DELETING = 'deleting'
-}
-
 /**
  * Rate limiting data structure
  */