stripe-experiment-sync 1.0.6 → 1.0.8

package/dist/index.d.ts

@@ -105,7 +105,7 @@ declare class PostgresClient {
     } | null>;
     /**
      * Get sync run config (for concurrency control).
-     * Status is derived from sync_dashboard view.
+     * Status is derived from sync_runs view.
      */
     getSyncRun(accountId: string, runStartedAt: Date): Promise<{
         accountId: string;
@@ -335,6 +335,13 @@ interface ProcessNextParams extends SyncParams {
     triggeredBy?: string;
 }
 
+/**
+ * Identifies a specific sync run.
+ */
+type RunKey = {
+    accountId: string;
+    runStartedAt: Date;
+};
 declare class StripeSync {
     private config;
     stripe: Stripe;
@@ -470,6 +477,20 @@ declare class StripeSync {
      * @returns Sync result with count of synced items
      */
     private processObjectUntilDone;
+    /**
+     * Join existing sync run or create a new one.
+     * Returns sync run key and list of supported objects to sync.
+     *
+     * Cooperative behavior: If a sync run already exists, joins it instead of failing.
+     * This is used by workers and background processes that should cooperate.
+     *
+     * @param triggeredBy - What triggered this sync (for observability)
+     * @returns Run key and list of objects to sync
+     */
+    joinOrCreateSyncRun(triggeredBy?: string): Promise<{
+        runKey: RunKey;
+        objects: Exclude<SyncObject, 'all' | 'customer_with_entitlements'>[];
+    }>;
     processUntilDone(params?: SyncParams): Promise<SyncBackfill>;
     /**
      * Internal implementation of processUntilDone with an existing run.
@@ -600,6 +621,37 @@ declare function runMigrations(config: MigrationConfig): Promise<void>;
  */
 declare function hashApiKey(apiKey: string): string;
 
+interface WebhookProcessingResult {
+    status: number;
+    databaseUrl: string;
+    event_type?: string;
+    event_id?: string;
+    error?: string;
+}
+interface StripeWebSocketOptions {
+    stripeApiKey: string;
+    onEvent: (event: StripeWebhookEvent) => Promise<WebhookProcessingResult | void> | WebhookProcessingResult | void;
+    onReady?: (secret: string) => void;
+    onError?: (error: Error) => void;
+    onClose?: (code: number, reason: string) => void;
+}
+interface StripeWebSocketClient {
+    close: () => void;
+    isConnected: () => boolean;
+}
+interface StripeWebhookEvent {
+    type: string;
+    webhook_id: string;
+    webhook_conversation_id: string;
+    event_payload: string;
+    http_headers: Record<string, string>;
+    endpoint: {
+        url: string;
+        status: string;
+    };
+}
+declare function createStripeWebSocketClient(options: StripeWebSocketOptions): Promise<StripeWebSocketClient>;
+
 declare const VERSION: string;
 
-export { type Logger, PostgresClient, type ProcessNextParams, type ProcessNextResult, type RevalidateEntity, StripeSync, type StripeSyncConfig, type Sync, type SyncBackfill, type SyncEntitlementsParams, type SyncFeaturesParams, type SyncObject, type SyncParams, VERSION, hashApiKey, runMigrations };
+export { type Logger, PostgresClient, type ProcessNextParams, type ProcessNextResult, type RevalidateEntity, StripeSync, type StripeSyncConfig, type StripeWebSocketClient, type StripeWebSocketOptions, type StripeWebhookEvent, type Sync, type SyncBackfill, type SyncEntitlementsParams, type SyncFeaturesParams, type SyncObject, type SyncParams, VERSION, type WebhookProcessingResult, createStripeWebSocketClient, hashApiKey, runMigrations };