stripe-experiment-sync 1.0.1 → 1.0.3

package/dist/chunk-SNGEJHKN.js

@@ -0,0 +1,73 @@
+// package.json
+var package_default = {
+  name: "stripe-experiment-sync",
+  version: "1.0.3",
+  private: false,
+  description: "Stripe Sync Engine to sync Stripe data to Postgres",
+  type: "module",
+  main: "./dist/index.cjs",
+  bin: "./dist/cli/index.cjs",
+  exports: {
+    ".": {
+      types: "./dist/index.d.ts",
+      import: "./dist/index.js",
+      require: "./dist/index.cjs"
+    },
+    "./supabase": {
+      types: "./dist/supabase/index.d.ts",
+      import: "./dist/supabase/index.js",
+      require: "./dist/supabase/index.cjs"
+    }
+  },
+  scripts: {
+    clean: "rimraf dist",
+    prebuild: "npm run clean",
+    build: "tsup src/index.ts src/supabase/index.ts --format esm,cjs --dts --shims && cp -r src/database/migrations dist/migrations",
+    lint: "eslint src --ext .ts",
+    test: "vitest"
+  },
+  files: [
+    "dist"
+  ],
+  dependencies: {
+    pg: "^8.16.3",
+    "pg-node-migrations": "0.0.8",
+    "supabase-management-js": "^0.1.6",
+    ws: "^8.18.0",
+    yesql: "^7.0.0"
+  },
+  peerDependencies: {
+    stripe: "> 11"
+  },
+  devDependencies: {
+    "@types/node": "^24.10.1",
+    "@types/pg": "^8.15.5",
+    "@types/ws": "^8.5.13",
+    "@types/yesql": "^4.1.4",
+    "@vitest/ui": "^4.0.9",
+    vitest: "^3.2.4"
+  },
+  repository: {
+    type: "git",
+    url: "https://github.com/tx-stripe/stripe-sync-engine.git"
+  },
+  homepage: "https://github.com/tx-stripe/stripe-sync-engine#readme",
+  bugs: {
+    url: "https://github.com/tx-stripe/stripe-sync-engine/issues"
+  },
+  keywords: [
+    "stripe",
+    "postgres",
+    "sync",
+    "webhooks",
+    "supabase",
+    "billing",
+    "database",
+    "typescript"
+  ],
+  author: "Supabase <https://supabase.com/>"
+};
+
+export {
+  package_default
+};

package/dist/index.cjs

@@ -45,25 +45,28 @@ var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 // package.json
 var package_default = {
   name: "stripe-experiment-sync",
-  version: "1.0.1",
+  version: "1.0.3",
   private: false,
   description: "Stripe Sync Engine to sync Stripe data to Postgres",
   type: "module",
   main: "./dist/index.cjs",
+  bin: "./dist/cli/index.cjs",
   exports: {
-    import: {
+    ".": {
       types: "./dist/index.d.ts",
-      import: "./dist/index.js"
-    },
-    require: {
-      types: "./dist/index.d.cts",
+      import: "./dist/index.js",
       require: "./dist/index.cjs"
+    },
+    "./supabase": {
+      types: "./dist/supabase/index.d.ts",
+      import: "./dist/supabase/index.js",
+      require: "./dist/supabase/index.cjs"
     }
   },
   scripts: {
     clean: "rimraf dist",
     prebuild: "npm run clean",
-    build: "tsup src/index.ts --format esm,cjs --dts --shims && cp -r src/database/migrations dist/migrations",
+    build: "tsup src/index.ts src/supabase/index.ts --format esm,cjs --dts --shims && cp -r src/database/migrations dist/migrations",
     lint: "eslint src --ext .ts",
     test: "vitest"
   },
@@ -73,6 +76,7 @@ var package_default = {
   dependencies: {
     pg: "^8.16.3",
     "pg-node-migrations": "0.0.8",
+    "supabase-management-js": "^0.1.6",
     ws: "^8.18.0",
     yesql: "^7.0.0"
   },
@@ -442,12 +446,20 @@ var PostgresClient = class {
    */
   async cancelStaleRuns(accountId) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_run" r
+      `UPDATE "${this.config.schema}"."_sync_obj_run" o
        SET status = 'error',
            error_message = 'Auto-cancelled: stale (no update in 5 min)',
            completed_at = now()
+       WHERE o."_account_id" = $1
+         AND o.status = 'running'
+         AND o.updated_at < now() - interval '5 minutes'`,
+      [accountId]
+    );
+    await this.query(
+      `UPDATE "${this.config.schema}"."_sync_run" r
+       SET closed_at = now()
        WHERE r."_account_id" = $1
-         AND r.status = 'running'
+         AND r.closed_at IS NULL
          AND EXISTS (
            SELECT 1 FROM "${this.config.schema}"."_sync_obj_run" o
            WHERE o."_account_id" = r."_account_id"
@@ -457,7 +469,7 @@ var PostgresClient = class {
            SELECT 1 FROM "${this.config.schema}"."_sync_obj_run" o
            WHERE o."_account_id" = r."_account_id"
              AND o.run_started_at = r.started_at
-             AND o.updated_at >= now() - interval '5 minutes'
+             AND o.status IN ('pending', 'running')
          )`,
       [accountId]
     );
@@ -473,7 +485,7 @@ var PostgresClient = class {
     await this.cancelStaleRuns(accountId);
     const existing = await this.query(
       `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_run"
-       WHERE "_account_id" = $1 AND status = 'running'`,
+       WHERE "_account_id" = $1 AND closed_at IS NULL`,
       [accountId]
     );
     if (existing.rows.length > 0) {
@@ -502,7 +514,7 @@ var PostgresClient = class {
   async getActiveSyncRun(accountId) {
     const result = await this.query(
       `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_run"
-       WHERE "_account_id" = $1 AND status = 'running'`,
+       WHERE "_account_id" = $1 AND closed_at IS NULL`,
       [accountId]
     );
     if (result.rows.length === 0) return null;
@@ -510,11 +522,12 @@ var PostgresClient = class {
     return { accountId: row._account_id, runStartedAt: row.started_at };
   }
   /**
-   * Get full sync run details.
+   * Get sync run config (for concurrency control).
+   * Status is derived from sync_dashboard view.
    */
   async getSyncRun(accountId, runStartedAt) {
     const result = await this.query(
-      `SELECT "_account_id", started_at, status, max_concurrent
+      `SELECT "_account_id", started_at, max_concurrent, closed_at
        FROM "${this.config.schema}"."_sync_run"
        WHERE "_account_id" = $1 AND started_at = $2`,
       [accountId, runStartedAt]
@@ -524,32 +537,22 @@ var PostgresClient = class {
     return {
       accountId: row._account_id,
       runStartedAt: row.started_at,
-      status: row.status,
-      maxConcurrent: row.max_concurrent
+      maxConcurrent: row.max_concurrent,
+      closedAt: row.closed_at
     };
   }
   /**
-   * Mark a sync run as complete.
+   * Close a sync run (mark as done).
+   * Status (complete/error) is derived from object run states.
    */
-  async completeSyncRun(accountId, runStartedAt) {
+  async closeSyncRun(accountId, runStartedAt) {
     await this.query(
       `UPDATE "${this.config.schema}"."_sync_run"
-       SET status = 'complete', completed_at = now()
-       WHERE "_account_id" = $1 AND started_at = $2`,
+       SET closed_at = now()
+       WHERE "_account_id" = $1 AND started_at = $2 AND closed_at IS NULL`,
       [accountId, runStartedAt]
     );
   }
-  /**
-   * Mark a sync run as failed.
-   */
-  async failSyncRun(accountId, runStartedAt, errorMessage) {
-    await this.query(
-      `UPDATE "${this.config.schema}"."_sync_run"
-       SET status = 'error', error_message = $3, completed_at = now()
-       WHERE "_account_id" = $1 AND started_at = $2`,
-      [accountId, runStartedAt, errorMessage]
-    );
-  }
   /**
    * Create object run entries for a sync run.
    * All objects start as 'pending'.
@@ -673,6 +676,7 @@ var PostgresClient = class {
   }
   /**
    * Mark an object sync as complete.
+   * Auto-closes the run when all objects are done.
    */
   async completeObjectSync(accountId, runStartedAt, object) {
     await this.query(
@@ -681,9 +685,14 @@ var PostgresClient = class {
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object]
     );
+    const allDone = await this.areAllObjectsComplete(accountId, runStartedAt);
+    if (allDone) {
+      await this.closeSyncRun(accountId, runStartedAt);
+    }
   }
   /**
    * Mark an object sync as failed.
+   * Auto-closes the run when all objects are done.
    */
   async failObjectSync(accountId, runStartedAt, object, errorMessage) {
     await this.query(
@@ -692,6 +701,21 @@ var PostgresClient = class {
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object, errorMessage]
     );
+    const allDone = await this.areAllObjectsComplete(accountId, runStartedAt);
+    if (allDone) {
+      await this.closeSyncRun(accountId, runStartedAt);
+    }
+  }
+  /**
+   * Check if any object in a run has errored.
+   */
+  async hasAnyObjectErrors(accountId, runStartedAt) {
+    const result = await this.query(
+      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_run"
+       WHERE "_account_id" = $1 AND run_started_at = $2 AND status = 'error'`,
+      [accountId, runStartedAt]
+    );
+    return parseInt(result.rows[0].count) > 0;
   }
   /**
    * Count running objects in a run.
@@ -733,6 +757,13 @@ var PostgresClient = class {
     );
     return parseInt(result.rows[0].count) === 0;
   }
+  /**
+   * Closes the database connection pool and cleans up resources.
+   * Call this when you're done using the PostgresClient instance.
+   */
+  async close() {
+    await this.pool.end();
+  }
 };
 
 // src/schemas/managed_webhook.ts
@@ -1287,8 +1318,8 @@ var StripeSync = class {
       // Depends on invoice
       listFn: (p) => this.stripe.creditNotes.list(p),
       upsertFn: (items, id, bf) => this.upsertCreditNotes(items, id, bf),
-      supportsCreatedFilter: false
-      // credit_notes don't support created filter
+      supportsCreatedFilter: true
+      // credit_notes support created filter
     },
     dispute: {
       order: 14,
@@ -1941,14 +1972,10 @@ var StripeSync = class {
           }
         }
       }
-      await this.postgresClient.completeSyncRun(accountId, runStartedAt);
+      await this.postgresClient.closeSyncRun(accountId, runStartedAt);
       return results;
     } catch (error) {
-      await this.postgresClient.failSyncRun(
-        accountId,
-        runStartedAt,
-        error instanceof Error ? error.message : "Unknown error"
-      );
+      await this.postgresClient.closeSyncRun(accountId, runStartedAt);
       throw error;
     }
   }
@@ -2479,12 +2506,13 @@ var StripeSync = class {
     await this.postgresClient.tryStartObjectSync(accountId, runStartedAt, resourceName);
     try {
       const result = await fn(cursor, runStartedAt);
-      await this.postgresClient.completeSyncRun(accountId, runStartedAt);
+      await this.postgresClient.completeObjectSync(accountId, runStartedAt, resourceName);
       return result;
     } catch (error) {
-      await this.postgresClient.failSyncRun(
+      await this.postgresClient.failObjectSync(
         accountId,
         runStartedAt,
+        resourceName,
         error instanceof Error ? error.message : "Unknown error"
       );
       throw error;
@@ -3232,6 +3260,13 @@ var StripeSync = class {
     }
     return entities;
   }
+  /**
+   * Closes the database connection pool and cleans up resources.
+   * Call this when you're done using the StripeSync instance.
+   */
+  async close() {
+    await this.postgresClient.pool.end();
+  }
 };
 function chunkArray(array, chunkSize) {
   const result = [];

package/dist/index.d.cts

@@ -104,22 +104,20 @@ declare class PostgresClient {
         runStartedAt: Date;
     } | null>;
     /**
-     * Get full sync run details.
+     * Get sync run config (for concurrency control).
+     * Status is derived from sync_dashboard view.
      */
     getSyncRun(accountId: string, runStartedAt: Date): Promise<{
         accountId: string;
         runStartedAt: Date;
-        status: string;
         maxConcurrent: number;
+        closedAt: Date | null;
     } | null>;
     /**
-     * Mark a sync run as complete.
-     */
-    completeSyncRun(accountId: string, runStartedAt: Date): Promise<void>;
-    /**
-     * Mark a sync run as failed.
+     * Close a sync run (mark as done).
+     * Status (complete/error) is derived from object run states.
      */
-    failSyncRun(accountId: string, runStartedAt: Date, errorMessage: string): Promise<void>;
+    closeSyncRun(accountId: string, runStartedAt: Date): Promise<void>;
     /**
      * Create object run entries for a sync run.
      * All objects start as 'pending'.
@@ -168,12 +166,18 @@ declare class PostgresClient {
     deleteSyncRuns(accountId: string): Promise<void>;
     /**
      * Mark an object sync as complete.
+     * Auto-closes the run when all objects are done.
      */
     completeObjectSync(accountId: string, runStartedAt: Date, object: string): Promise<void>;
     /**
      * Mark an object sync as failed.
+     * Auto-closes the run when all objects are done.
      */
     failObjectSync(accountId: string, runStartedAt: Date, object: string, errorMessage: string): Promise<void>;
+    /**
+     * Check if any object in a run has errored.
+     */
+    hasAnyObjectErrors(accountId: string, runStartedAt: Date): Promise<boolean>;
     /**
      * Count running objects in a run.
      */
@@ -187,6 +191,11 @@ declare class PostgresClient {
      * Check if all objects in a run are complete (or error).
      */
     areAllObjectsComplete(accountId: string, runStartedAt: Date): Promise<boolean>;
+    /**
+     * Closes the database connection pool and cleans up resources.
+     * Call this when you're done using the PostgresClient instance.
+     */
+    close(): Promise<void>;
 }
 
 /**
@@ -567,6 +576,11 @@ declare class StripeSync {
      */
     private expandEntity;
     private fetchMissingEntities;
+    /**
+     * Closes the database connection pool and cleans up resources.
+     * Call this when you're done using the StripeSync instance.
+     */
+    close(): Promise<void>;
 }
 
 type MigrationConfig = {

package/dist/index.d.ts

@@ -104,22 +104,20 @@ declare class PostgresClient {
         runStartedAt: Date;
     } | null>;
     /**
-     * Get full sync run details.
+     * Get sync run config (for concurrency control).
+     * Status is derived from sync_dashboard view.
      */
     getSyncRun(accountId: string, runStartedAt: Date): Promise<{
         accountId: string;
         runStartedAt: Date;
-        status: string;
         maxConcurrent: number;
+        closedAt: Date | null;
     } | null>;
     /**
-     * Mark a sync run as complete.
-     */
-    completeSyncRun(accountId: string, runStartedAt: Date): Promise<void>;
-    /**
-     * Mark a sync run as failed.
+     * Close a sync run (mark as done).
+     * Status (complete/error) is derived from object run states.
      */
-    failSyncRun(accountId: string, runStartedAt: Date, errorMessage: string): Promise<void>;
+    closeSyncRun(accountId: string, runStartedAt: Date): Promise<void>;
     /**
      * Create object run entries for a sync run.
      * All objects start as 'pending'.
@@ -168,12 +166,18 @@ declare class PostgresClient {
     deleteSyncRuns(accountId: string): Promise<void>;
     /**
      * Mark an object sync as complete.
+     * Auto-closes the run when all objects are done.
      */
     completeObjectSync(accountId: string, runStartedAt: Date, object: string): Promise<void>;
     /**
      * Mark an object sync as failed.
+     * Auto-closes the run when all objects are done.
      */
     failObjectSync(accountId: string, runStartedAt: Date, object: string, errorMessage: string): Promise<void>;
+    /**
+     * Check if any object in a run has errored.
+     */
+    hasAnyObjectErrors(accountId: string, runStartedAt: Date): Promise<boolean>;
     /**
      * Count running objects in a run.
      */
@@ -187,6 +191,11 @@ declare class PostgresClient {
      * Check if all objects in a run are complete (or error).
      */
     areAllObjectsComplete(accountId: string, runStartedAt: Date): Promise<boolean>;
+    /**
+     * Closes the database connection pool and cleans up resources.
+     * Call this when you're done using the PostgresClient instance.
+     */
+    close(): Promise<void>;
 }
 
 /**
@@ -567,6 +576,11 @@ declare class StripeSync {
      */
     private expandEntity;
     private fetchMissingEntities;
+    /**
+     * Closes the database connection pool and cleans up resources.
+     * Call this when you're done using the StripeSync instance.
+     */
+    close(): Promise<void>;
 }
 
 type MigrationConfig = {