@shipstatic/types 0.3.5 → 0.3.7

package/dist/index.d.ts

@@ -172,6 +172,20 @@ export interface Account {
     /** Unix timestamp (seconds) when account was activated (first deployment) */
     activated?: number;
 }
+/**
+ * Account-specific configuration overrides
+ * Allows per-account customization of limits without changing plan
+ */
+export interface AccountOverrides {
+    /** Override for maximum resources (deployments + domains) */
+    resources?: number;
+    /** Override for maximum individual file size in bytes */
+    fileSize?: number;
+    /** Override for maximum number of files per deployment */
+    filesCount?: number;
+    /** Override for maximum total deployment size in bytes */
+    totalSize?: number;
+}
 /**
  * All possible error types in the Shipstatic platform
  * Names are developer-friendly while wire format stays consistent
@@ -424,6 +438,59 @@ export interface TokenResource {
     list: () => Promise<TokenListResponse>;
     remove: (token: string) => Promise<void>;
 }
+/**
+ * Subscription status response from GET /subscriptions/status
+ */
+export interface SubscriptionStatus {
+    /** Whether the account has an active subscription */
+    hasSubscription: boolean;
+    /** Current account plan */
+    plan: AccountPlanType;
+    /** Creem subscription ID (if subscribed) */
+    subscriptionId?: string;
+    /** Number of subscription units (1 unit = 1 custom domain) */
+    units?: number;
+    /** Number of custom domains currently in use */
+    customDomains?: number;
+    /** Subscription status from Creem (active, trialing, canceled, etc.) */
+    status?: string;
+    /** Link to Creem customer portal for subscription management */
+    portalLink?: string | null;
+}
+/**
+ * Checkout session response from POST /subscriptions/checkout
+ */
+export interface CheckoutSession {
+    /** URL to redirect user to Creem checkout page */
+    checkoutUrl: string;
+    /** Creem checkout session ID */
+    checkoutId: string;
+}
+/**
+ * Subscription sync request body for POST /subscriptions/sync
+ */
+export interface SubscriptionSyncRequest {
+    /** Creem subscription ID received after checkout */
+    subscriptionId: string;
+}
+/**
+ * Subscription resource interface - the contract all implementations must follow
+ *
+ * IMPOSSIBLE SIMPLICITY: No sync() method needed!
+ * Webhooks are the single source of truth. Frontend just polls status().
+ */
+export interface SubscriptionResource {
+    /**
+     * Create a checkout session
+     * @returns Checkout session with URL to redirect user
+     */
+    checkout: () => Promise<CheckoutSession>;
+    /**
+     * Get current subscription status
+     * @returns Subscription status and usage information
+     */
+    status: () => Promise<SubscriptionStatus>;
+}
 /**
  * Keys resource interface - the contract all implementations must follow
  */

package/package.json

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

package/src/index.ts

@@ -205,6 +205,21 @@ export interface Account {
   activated?: number;
 }
 
+/**
+ * Account-specific configuration overrides
+ * Allows per-account customization of limits without changing plan
+ */
+export interface AccountOverrides {
+  /** Override for maximum resources (deployments + domains) */
+  resources?: number;
+  /** Override for maximum individual file size in bytes */
+  fileSize?: number;
+  /** Override for maximum number of files per deployment */
+  filesCount?: number;
+  /** Override for maximum total deployment size in bytes */
+  totalSize?: number;
+}
+
 // =============================================================================
 // ERROR SYSTEM
 // =============================================================================
@@ -669,6 +684,68 @@ export interface TokenResource {
   remove: (token: string) => Promise<void>;
 }
 
+// =============================================================================
+// SUBSCRIPTION TYPES
+// =============================================================================
+
+/**
+ * Subscription status response from GET /subscriptions/status
+ */
+export interface SubscriptionStatus {
+  /** Whether the account has an active subscription */
+  hasSubscription: boolean;
+  /** Current account plan */
+  plan: AccountPlanType;
+  /** Creem subscription ID (if subscribed) */
+  subscriptionId?: string;
+  /** Number of subscription units (1 unit = 1 custom domain) */
+  units?: number;
+  /** Number of custom domains currently in use */
+  customDomains?: number;
+  /** Subscription status from Creem (active, trialing, canceled, etc.) */
+  status?: string;
+  /** Link to Creem customer portal for subscription management */
+  portalLink?: string | null;
+}
+
+/**
+ * Checkout session response from POST /subscriptions/checkout
+ */
+export interface CheckoutSession {
+  /** URL to redirect user to Creem checkout page */
+  checkoutUrl: string;
+  /** Creem checkout session ID */
+  checkoutId: string;
+}
+
+/**
+ * Subscription sync request body for POST /subscriptions/sync
+ */
+export interface SubscriptionSyncRequest {
+  /** Creem subscription ID received after checkout */
+  subscriptionId: string;
+}
+
+/**
+ * Subscription resource interface - the contract all implementations must follow
+ *
+ * IMPOSSIBLE SIMPLICITY: No sync() method needed!
+ * Webhooks are the single source of truth. Frontend just polls status().
+ */
+export interface SubscriptionResource {
+  /**
+   * Create a checkout session
+   * @returns Checkout session with URL to redirect user
+   */
+  checkout: () => Promise<CheckoutSession>;
+
+  /**
+   * Get current subscription status
+   * @returns Subscription status and usage information
+   */
+  status: () => Promise<SubscriptionStatus>;
+}
+
 /**
  * Keys resource interface - the contract all implementations must follow
  */