@shipstatic/types 0.3.14 → 0.3.16

package/dist/index.d.ts

@@ -66,8 +66,8 @@ export type DomainStatusType = typeof DomainStatus[keyof typeof DomainStatus];
 export interface Domain {
     /** The domain name */
     readonly domain: string;
-    /** The deployment name this domain points to */
-    deployment: string;
+    /** The deployment name this domain points to (null = domain added but not yet linked) */
+    deployment: string | null;
     /** Current domain status */
     status: DomainStatusType;
     /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
@@ -408,7 +408,7 @@ export interface DeploymentResource {
  * Domain resource interface - the contract all implementations must follow
  */
 export interface DomainResource {
-    set: (domainName: string, deployment: string, tags?: string[]) => Promise<Domain>;
+    set: (domainName: string, deployment?: string, tags?: string[]) => Promise<Domain>;
     get: (domainName: string) => Promise<Domain>;
     list: () => Promise<DomainListResponse>;
     remove: (domainName: string) => Promise<void>;
@@ -495,6 +495,36 @@ export interface KeysResource {
         apiKey: string;
     }>;
 }
+/**
+ * All activity event types logged in the system
+ */
+export type ActivityEvent = 'account_create' | 'account_update' | 'account_delete' | 'account_key_generate' | 'account_plan_paid' | 'account_plan_transition' | 'account_suspended' | 'deployment_create' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_confirm' | 'token_create' | 'token_consume' | 'admin_account_plan_update' | 'admin_account_ref_update' | 'admin_account_billing_update' | 'admin_account_tags_update' | 'admin_deployment_delete' | 'admin_domain_delete' | 'billing_suspended' | 'billing_active' | 'billing_canceled' | 'billing_paused' | 'billing_expired' | 'billing_paid' | 'billing_trialing' | 'billing_scheduled_cancel' | 'billing_unpaid' | 'billing_update' | 'billing_past_due' | 'billing_terminated' | 'billing_manual_sync' | 'refund_created' | 'dispute_created';
+/**
+ * Activity events visible to users in the dashboard
+ */
+export type UserVisibleActivityEvent = 'account_create' | 'account_update' | 'account_delete' | 'account_key_generate' | 'account_plan_transition' | 'deployment_create' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_set' | 'domain_confirm' | 'token_create' | 'token_consume';
+/**
+ * Activity record returned from the API
+ */
+export interface Activity {
+    /** The event type */
+    event: ActivityEvent;
+    /** Unix timestamp (seconds) when the activity occurred */
+    created: number;
+    /** Associated deployment ID (if applicable) */
+    deployment?: string;
+    /** Associated domain name (if applicable) */
+    domain?: string;
+    /** JSON-encoded metadata (parse with JSON.parse) */
+    meta?: string;
+}
+/**
+ * Response from GET /activities endpoint
+ */
+export interface ActivityListResponse {
+    /** Array of activities */
+    activities: Activity[];
+}
 /**
  * File status constants for validation state tracking
  */

package/package.json

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

package/src/index.ts

@@ -82,8 +82,8 @@ export type DomainStatusType = typeof DomainStatus[keyof typeof DomainStatus];
 export interface Domain {
   /** The domain name */
   readonly domain: string;
-  /** The deployment name this domain points to */
-  deployment: string; // Mutable - can be updated to point to different deployment
+  /** The deployment name this domain points to (null = domain added but not yet linked) */
+  deployment: string | null; // Mutable - can be updated to point to different deployment
   /** Current domain status */
   status: DomainStatusType; // Mutable - can be updated
   /** Optional array of tags for categorization and filtering (lowercase, alphanumeric with separators) */
@@ -662,7 +662,7 @@ export interface DeploymentResource {
  * Domain resource interface - the contract all implementations must follow
  */
 export interface DomainResource {
-  set: (domainName: string, deployment: string, tags?: string[]) => Promise<Domain>;
+  set: (domainName: string, deployment?: string, tags?: string[]) => Promise<Domain>;
   get: (domainName: string) => Promise<Domain>;
   list: () => Promise<DomainListResponse>;
   remove: (domainName: string) => Promise<void>;
@@ -750,6 +750,103 @@ export interface KeysResource {
   create: () => Promise<{ apiKey: string }>;
 }
 
+// =============================================================================
+// ACTIVITY TYPES
+// =============================================================================
+
+/**
+ * All activity event types logged in the system
+ */
+export type ActivityEvent =
+  // Account events
+  | 'account_create'
+  | 'account_update'
+  | 'account_delete'
+  | 'account_key_generate'
+  | 'account_plan_paid'
+  | 'account_plan_transition'
+  | 'account_suspended'
+  // Deployment events
+  | 'deployment_create'
+  | 'deployment_delete'
+  | 'deployment_claim'
+  // Domain events
+  | 'domain_create'
+  | 'domain_update'
+  | 'domain_delete'
+  | 'domain_set'
+  | 'domain_confirm'
+  // Token events
+  | 'token_create'
+  | 'token_consume'
+  // System events (not user-visible)
+  | 'admin_account_plan_update'
+  | 'admin_account_ref_update'
+  | 'admin_account_billing_update'
+  | 'admin_account_tags_update'
+  | 'admin_deployment_delete'
+  | 'admin_domain_delete'
+  // Billing events (internal, not shown to users except account_plan_transition)
+  | 'billing_suspended'
+  | 'billing_active'
+  | 'billing_canceled'
+  | 'billing_paused'
+  | 'billing_expired'
+  | 'billing_paid'
+  | 'billing_trialing'
+  | 'billing_scheduled_cancel'
+  | 'billing_unpaid'
+  | 'billing_update'
+  | 'billing_past_due'
+  | 'billing_terminated'
+  | 'billing_manual_sync'
+  | 'refund_created'
+  | 'dispute_created';
+
+/**
+ * Activity events visible to users in the dashboard
+ */
+export type UserVisibleActivityEvent =
+  | 'account_create'
+  | 'account_update'
+  | 'account_delete'
+  | 'account_key_generate'
+  | 'account_plan_transition'
+  | 'deployment_create'
+  | 'deployment_delete'
+  | 'deployment_claim'
+  | 'domain_create'
+  | 'domain_update'
+  | 'domain_delete'
+  | 'domain_set'
+  | 'domain_confirm'
+  | 'token_create'
+  | 'token_consume';
+
+/**
+ * Activity record returned from the API
+ */
+export interface Activity {
+  /** The event type */
+  event: ActivityEvent;
+  /** Unix timestamp (seconds) when the activity occurred */
+  created: number;
+  /** Associated deployment ID (if applicable) */
+  deployment?: string;
+  /** Associated domain name (if applicable) */
+  domain?: string;
+  /** JSON-encoded metadata (parse with JSON.parse) */
+  meta?: string;
+}
+
+/**
+ * Response from GET /activities endpoint
+ */
+export interface ActivityListResponse {
+  /** Array of activities */
+  activities: Activity[];
+}
+
 // =============================================================================
 // FILE UPLOAD TYPES
 // =============================================================================