@shipstatic/types 0.3.4 → 0.3.6

package/dist/index.d.ts

@@ -172,6 +172,18 @@ 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 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
@@ -288,6 +300,7 @@ export declare const AuthMethod: {
     readonly JWT: "jwt";
     readonly API_KEY: "apiKey";
     readonly TOKEN: "token";
+    readonly WEBHOOK: "webhook";
 };
 export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
 export declare const DEPLOYMENT_CONFIG_FILENAME = "ship.json";
@@ -423,6 +436,71 @@ 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 sync response from POST /subscriptions/sync
+ */
+export interface SubscriptionSyncResponse {
+    /** Whether sync was successful */
+    success: boolean;
+    /** The synced subscription ID */
+    subscriptionId: string;
+}
+/**
+ * Subscription resource interface - the contract all implementations must follow
+ */
+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>;
+    /**
+     * Sync subscription ID after checkout redirect
+     * @param subscriptionId - Subscription ID from Creem redirect
+     * @returns Sync confirmation
+     */
+    sync: (subscriptionId: string) => Promise<SubscriptionSyncResponse>;
+}
 /**
  * Keys resource interface - the contract all implementations must follow
  */

package/dist/index.js

@@ -193,7 +193,8 @@ export const DEPLOY_TOKEN_TOTAL_LENGTH = DEPLOY_TOKEN_PREFIX.length + DEPLOY_TOK
 export const AuthMethod = {
     JWT: 'jwt',
     API_KEY: 'apiKey',
-    TOKEN: 'token'
+    TOKEN: 'token',
+    WEBHOOK: 'webhook'
 };
 // Deployment Configuration
 export const DEPLOYMENT_CONFIG_FILENAME = 'ship.json';

package/package.json

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

package/src/index.ts

@@ -205,6 +205,19 @@ export interface Account {
   activated?: number;
 }
 
+/**
+ * Account-specific configuration overrides
+ * Allows per-account customization of limits without changing plan
+ */
+export interface AccountOverrides {
+  /** 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
 // =============================================================================
@@ -451,7 +464,8 @@ export const DEPLOY_TOKEN_TOTAL_LENGTH = DEPLOY_TOKEN_PREFIX.length + DEPLOY_TOK
 export const AuthMethod = {
   JWT: 'jwt',
   API_KEY: 'apiKey',
-  TOKEN: 'token'
+  TOKEN: 'token',
+  WEBHOOK: 'webhook'
 } as const;
 
 export type AuthMethodType = typeof AuthMethod[keyof typeof AuthMethod];
@@ -668,6 +682,82 @@ 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 sync response from POST /subscriptions/sync
+ */
+export interface SubscriptionSyncResponse {
+  /** Whether sync was successful */
+  success: boolean;
+  /** The synced subscription ID */
+  subscriptionId: string;
+}
+
+/**
+ * Subscription resource interface - the contract all implementations must follow
+ */
+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>;
+
+  /**
+   * Sync subscription ID after checkout redirect
+   * @param subscriptionId - Subscription ID from Creem redirect
+   * @returns Sync confirmation
+   */
+  sync: (subscriptionId: string) => Promise<SubscriptionSyncResponse>;
+}
+
 /**
  * Keys resource interface - the contract all implementations must follow
  */