@shipstatic/types 0.4.9 → 0.4.11

package/README.md

@@ -55,7 +55,7 @@ import type { DeploymentResource, DomainResource, AccountResource } from '@ships
 ### Validation Utilities
 
 ```typescript
-import { validateApiKey, validateDeployToken, validateSubdomain } from '@shipstatic/types';
+import { validateApiKey, validateDeployToken, isDeployment } from '@shipstatic/types';
 ```
 
 ### Constants

package/dist/index.d.ts

@@ -364,9 +364,10 @@ export declare function validateDeployToken(deployToken: string): void;
  */
 export declare function validateApiUrl(apiUrl: string): void;
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export declare function validateSubdomain(input: string): boolean;
+export declare function isDeployment(input: string): boolean;
 /**
  * Request payload for SPA check endpoint
  */
@@ -578,13 +579,14 @@ export interface KeysResource {
     }>;
 }
 /**
- * All activity event types logged in the system
+ * 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_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_create' | 'dispute_create';
+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.tags.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';
 /**
  * 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_update' | 'deployment_delete' | 'deployment_claim' | 'domain_create' | 'domain_update' | 'domain_delete' | 'domain_verify' | 'token_create' | 'token_consume';
+export type UserVisibleActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.transition' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume';
 /**
  * Activity record returned from the API
  */

package/dist/index.js

@@ -253,10 +253,10 @@ export function validateApiUrl(apiUrl) {
     }
 }
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export function validateSubdomain(input) {
-    // Deployment subdomain format: word-word-7chars (e.g. "happy-cat-abc1234")
+export function isDeployment(input) {
     return /^[a-z]+-[a-z]+-[a-z0-9]{7}$/i.test(input);
 }
 // =============================================================================

package/package.json

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

package/src/index.ts

@@ -580,10 +580,10 @@ export function validateApiUrl(apiUrl: string): void {
 }
 
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export function validateSubdomain(input: string): boolean {
-  // Deployment subdomain format: word-word-7chars (e.g. "happy-cat-abc1234")
+export function isDeployment(input: string): boolean {
   return /^[a-z]+-[a-z]+-[a-z0-9]{7}$/i.test(input);
 }
 
@@ -835,73 +835,73 @@ export interface KeysResource {
 // =============================================================================
 
 /**
- * All activity event types logged in the system
+ * All activity event types logged in the system.
+ * Uses dot notation consistently: {resource}.{action}
  */
 export type ActivityEvent =
   // Account events
-  | 'account_create'
-  | 'account_update'
-  | 'account_delete'
-  | 'account_key_generate'
-  | 'account_plan_paid'
-  | 'account_plan_transition'
-  | 'account_suspended'
+  | 'account.create'
+  | 'account.update'
+  | 'account.delete'
+  | 'account.key.generate'
+  | 'account.plan.paid'
+  | 'account.plan.transition'
+  | 'account.suspended'
   // Deployment events
-  | 'deployment_create'
-  | 'deployment_update'
-  | 'deployment_delete'
-  | 'deployment_claim'
+  | 'deployment.create'
+  | 'deployment.update'
+  | 'deployment.delete'
+  | 'deployment.claim'
   // Domain events
-  | 'domain_create'
-  | 'domain_update'
-  | 'domain_delete'
-  | 'domain_verify'
+  | 'domain.create'
+  | 'domain.update'
+  | 'domain.delete'
+  | 'domain.verify'
   // 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_create'
-  | 'dispute_create';
+  | 'token.create'
+  | 'token.consume'
+  // Admin 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'
+  | 'admin.billing.sync'
+  | 'admin.billing.terminated'
+  // Webhook events (logged directly from payment provider)
+  | '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
  */
 export type UserVisibleActivityEvent =
-  | 'account_create'
-  | 'account_update'
-  | 'account_delete'
-  | 'account_key_generate'
-  | 'account_plan_transition'
-  | 'deployment_create'
-  | 'deployment_update'
-  | 'deployment_delete'
-  | 'deployment_claim'
-  | 'domain_create'
-  | 'domain_update'
-  | 'domain_delete'
-  | 'domain_verify'
-  | 'token_create'
-  | 'token_consume';
+  | 'account.create'
+  | 'account.update'
+  | 'account.delete'
+  | 'account.key.generate'
+  | 'account.plan.transition'
+  | 'deployment.create'
+  | 'deployment.update'
+  | 'deployment.delete'
+  | 'deployment.claim'
+  | 'domain.create'
+  | 'domain.update'
+  | 'domain.delete'
+  | 'domain.verify'
+  | 'token.create'
+  | 'token.consume';
 
 /**
  * Activity record returned from the API