stripe-experiment-sync 1.0.3 → 1.0.7

package/dist/cli/lib.d.cts

@@ -0,0 +1,70 @@
+interface Config {
+    stripeApiKey: string;
+    ngrokAuthToken: string;
+    databaseUrl: string;
+}
+interface CliOptions {
+    stripeKey?: string;
+    ngrokToken?: string;
+    databaseUrl?: string;
+}
+/**
+ * Load configuration from .env file, environment variables, and interactive prompts.
+ * Values are masked with *** when prompting for sensitive information.
+ */
+declare function loadConfig(options: CliOptions): Promise<Config>;
+
+interface DeployOptions {
+    supabaseAccessToken?: string;
+    supabaseProjectRef?: string;
+    stripeKey?: string;
+}
+
+/**
+ * Backfill command - backfills a specific entity type from Stripe.
+ */
+declare function backfillCommand(options: CliOptions, entityName: string): Promise<void>;
+/**
+ * Migration command - runs database migrations only.
+ */
+declare function migrateCommand(options: CliOptions): Promise<void>;
+/**
+ * Main sync command - syncs Stripe data to PostgreSQL using webhooks for real-time updates.
+ * 1. Runs database migrations
+ * 2. Creates StripeSync instance
+ * 3. Creates ngrok tunnel and Stripe webhook endpoint
+ * 4. Runs initial backfill of all Stripe data
+ * 5. Keeps running to process live webhook events (Ctrl+C to stop)
+ */
+declare function syncCommand(options: CliOptions): Promise<void>;
+/**
+ * Install command - installs Stripe sync Edge Functions to Supabase.
+ * 1. Validates Supabase project access
+ * 2. Deploys stripe-setup, stripe-webhook, and stripe-worker Edge Functions
+ * 3. Sets required secrets (STRIPE_SECRET_KEY)
+ * 4. Runs the setup function to create webhook and run migrations
+ */
+declare function installCommand(options: DeployOptions): Promise<void>;
+/**
+ * Uninstall command - removes Stripe sync Edge Functions and resources from Supabase.
+ * 1. Validates Supabase project access
+ * 2. Deletes Stripe webhooks
+ * 3. Deletes Edge Functions (stripe-setup, stripe-webhook, stripe-worker)
+ * 4. Deletes secrets and pg_cron jobs
+ * 5. Drops the stripe schema
+ */
+declare function uninstallCommand(options: DeployOptions): Promise<void>;
+
+interface NgrokTunnel {
+    url: string;
+    close: () => Promise<void>;
+}
+/**
+ * Create an ngrok tunnel to expose the local server to the internet.
+ * @param port - The local port to expose
+ * @param authToken - ngrok authentication token
+ * @returns The tunnel URL and a close function
+ */
+declare function createTunnel(port: number, authToken: string): Promise<NgrokTunnel>;
+
+export { type CliOptions, type Config, type DeployOptions, type NgrokTunnel, backfillCommand, createTunnel, installCommand, loadConfig, migrateCommand, syncCommand, uninstallCommand };

package/dist/cli/lib.d.ts

@@ -0,0 +1,70 @@
+interface Config {
+    stripeApiKey: string;
+    ngrokAuthToken: string;
+    databaseUrl: string;
+}
+interface CliOptions {
+    stripeKey?: string;
+    ngrokToken?: string;
+    databaseUrl?: string;
+}
+/**
+ * Load configuration from .env file, environment variables, and interactive prompts.
+ * Values are masked with *** when prompting for sensitive information.
+ */
+declare function loadConfig(options: CliOptions): Promise<Config>;
+
+interface DeployOptions {
+    supabaseAccessToken?: string;
+    supabaseProjectRef?: string;
+    stripeKey?: string;
+}
+
+/**
+ * Backfill command - backfills a specific entity type from Stripe.
+ */
+declare function backfillCommand(options: CliOptions, entityName: string): Promise<void>;
+/**
+ * Migration command - runs database migrations only.
+ */
+declare function migrateCommand(options: CliOptions): Promise<void>;
+/**
+ * Main sync command - syncs Stripe data to PostgreSQL using webhooks for real-time updates.
+ * 1. Runs database migrations
+ * 2. Creates StripeSync instance
+ * 3. Creates ngrok tunnel and Stripe webhook endpoint
+ * 4. Runs initial backfill of all Stripe data
+ * 5. Keeps running to process live webhook events (Ctrl+C to stop)
+ */
+declare function syncCommand(options: CliOptions): Promise<void>;
+/**
+ * Install command - installs Stripe sync Edge Functions to Supabase.
+ * 1. Validates Supabase project access
+ * 2. Deploys stripe-setup, stripe-webhook, and stripe-worker Edge Functions
+ * 3. Sets required secrets (STRIPE_SECRET_KEY)
+ * 4. Runs the setup function to create webhook and run migrations
+ */
+declare function installCommand(options: DeployOptions): Promise<void>;
+/**
+ * Uninstall command - removes Stripe sync Edge Functions and resources from Supabase.
+ * 1. Validates Supabase project access
+ * 2. Deletes Stripe webhooks
+ * 3. Deletes Edge Functions (stripe-setup, stripe-webhook, stripe-worker)
+ * 4. Deletes secrets and pg_cron jobs
+ * 5. Drops the stripe schema
+ */
+declare function uninstallCommand(options: DeployOptions): Promise<void>;
+
+interface NgrokTunnel {
+    url: string;
+    close: () => Promise<void>;
+}
+/**
+ * Create an ngrok tunnel to expose the local server to the internet.
+ * @param port - The local port to expose
+ * @param authToken - ngrok authentication token
+ * @returns The tunnel URL and a close function
+ */
+declare function createTunnel(port: number, authToken: string): Promise<NgrokTunnel>;
+
+export { type CliOptions, type Config, type DeployOptions, type NgrokTunnel, backfillCommand, createTunnel, installCommand, loadConfig, migrateCommand, syncCommand, uninstallCommand };

package/dist/cli/lib.js

@@ -0,0 +1,21 @@
+import {
+  backfillCommand,
+  createTunnel,
+  installCommand,
+  loadConfig,
+  migrateCommand,
+  syncCommand,
+  uninstallCommand
+} from "../chunk-3P5TZKWU.js";
+import "../chunk-7JWRDXNB.js";
+import "../chunk-SX3HLE4H.js";
+import "../chunk-YXQZXR7S.js";
+export {
+  backfillCommand,
+  createTunnel,
+  installCommand,
+  loadConfig,
+  migrateCommand,
+  syncCommand,
+  uninstallCommand
+};

package/dist/index.cjs

@@ -38,19 +38,19 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// ../../node_modules/.pnpm/tsup@8.5.0_postcss@8.5.6_tsx@4.20.6_typescript@5.9.3_yaml@2.8.1/node_modules/tsup/assets/cjs_shims.js
+// ../../node_modules/.pnpm/tsup@8.5.0_postcss@8.5.6_tsx@4.21.0_typescript@5.9.3_yaml@2.8.1/node_modules/tsup/assets/cjs_shims.js
 var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 
 // package.json
 var package_default = {
   name: "stripe-experiment-sync",
-  version: "1.0.3",
+  version: "1.0.7",
   private: false,
   description: "Stripe Sync Engine to sync Stripe data to Postgres",
   type: "module",
   main: "./dist/index.cjs",
-  bin: "./dist/cli/index.cjs",
+  bin: "./dist/cli/index.js",
   exports: {
     ".": {
       types: "./dist/index.d.ts",
@@ -61,12 +61,17 @@ var package_default = {
       types: "./dist/supabase/index.d.ts",
       import: "./dist/supabase/index.js",
       require: "./dist/supabase/index.cjs"
+    },
+    "./cli": {
+      types: "./dist/cli/lib.d.ts",
+      import: "./dist/cli/lib.js",
+      require: "./dist/cli/lib.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",
+    build: "tsup src/index.ts src/supabase/index.ts src/cli/index.ts src/cli/lib.ts --format esm,cjs --dts --shims && cp -r src/database/migrations dist/migrations",
     lint: "eslint src --ext .ts",
     test: "vitest"
   },
@@ -74,21 +79,28 @@ var package_default = {
     "dist"
   ],
   dependencies: {
+    "@ngrok/ngrok": "^1.4.1",
+    chalk: "^5.3.0",
+    commander: "^12.1.0",
+    dotenv: "^16.4.7",
+    express: "^4.18.2",
+    inquirer: "^12.3.0",
     pg: "^8.16.3",
     "pg-node-migrations": "0.0.8",
+    stripe: "^17.7.0",
     "supabase-management-js": "^0.1.6",
     ws: "^8.18.0",
     yesql: "^7.0.0"
   },
-  peerDependencies: {
-    stripe: "> 11"
-  },
   devDependencies: {
+    "@types/express": "^4.17.21",
+    "@types/inquirer": "^9.0.7",
     "@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",
+    tsx: "^4.19.2",
     vitest: "^3.2.4"
   },
   repository: {
@@ -143,9 +155,9 @@ var ORDERED_STRIPE_TABLES = [
   "reviews",
   "_managed_webhooks",
   "customers",
-  "_sync_obj_run",
-  // Must be deleted before _sync_run (foreign key)
-  "_sync_run"
+  "_sync_obj_runs",
+  // Must be deleted before _sync_runs (foreign key)
+  "_sync_runs"
 ];
 var TABLES_WITH_ACCOUNT_ID = /* @__PURE__ */ new Set(["_managed_webhooks"]);
 var PostgresClient = class {
@@ -436,7 +448,7 @@ var PostgresClient = class {
   // Observable Sync System Methods
   // =============================================================================
   // These methods support long-running syncs with full observability.
-  // Uses two tables: _sync_run (parent) and _sync_obj_run (children)
+  // Uses two tables: _sync_runs (parent) and _sync_obj_runs (children)
   // RunKey = (accountId, runStartedAt) - natural composite key
   /**
    * Cancel stale runs (running but no object updated in 5 minutes).
@@ -446,7 +458,7 @@ var PostgresClient = class {
    */
   async cancelStaleRuns(accountId) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_obj_run" o
+      `UPDATE "${this.config.schema}"."_sync_obj_runs" o
        SET status = 'error',
            error_message = 'Auto-cancelled: stale (no update in 5 min)',
            completed_at = now()
@@ -456,17 +468,17 @@ var PostgresClient = class {
       [accountId]
     );
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_run" r
+      `UPDATE "${this.config.schema}"."_sync_runs" r
        SET closed_at = now()
        WHERE r."_account_id" = $1
          AND r.closed_at IS NULL
          AND EXISTS (
-           SELECT 1 FROM "${this.config.schema}"."_sync_obj_run" o
+           SELECT 1 FROM "${this.config.schema}"."_sync_obj_runs" o
            WHERE o."_account_id" = r."_account_id"
              AND o.run_started_at = r.started_at
          )
          AND NOT EXISTS (
-           SELECT 1 FROM "${this.config.schema}"."_sync_obj_run" o
+           SELECT 1 FROM "${this.config.schema}"."_sync_obj_runs" o
            WHERE o."_account_id" = r."_account_id"
              AND o.run_started_at = r.started_at
              AND o.status IN ('pending', 'running')
@@ -484,7 +496,7 @@ var PostgresClient = class {
   async getOrCreateSyncRun(accountId, triggeredBy) {
     await this.cancelStaleRuns(accountId);
     const existing = await this.query(
-      `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_run"
+      `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_runs"
        WHERE "_account_id" = $1 AND closed_at IS NULL`,
       [accountId]
     );
@@ -494,7 +506,7 @@ var PostgresClient = class {
     }
     try {
       const result = await this.query(
-        `INSERT INTO "${this.config.schema}"."_sync_run" ("_account_id", triggered_by, started_at)
+        `INSERT INTO "${this.config.schema}"."_sync_runs" ("_account_id", triggered_by, started_at)
          VALUES ($1, $2, date_trunc('milliseconds', now()))
          RETURNING "_account_id", started_at`,
         [accountId, triggeredBy ?? null]
@@ -513,7 +525,7 @@ var PostgresClient = class {
    */
   async getActiveSyncRun(accountId) {
     const result = await this.query(
-      `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_run"
+      `SELECT "_account_id", started_at FROM "${this.config.schema}"."_sync_runs"
        WHERE "_account_id" = $1 AND closed_at IS NULL`,
       [accountId]
     );
@@ -523,12 +535,12 @@ var PostgresClient = class {
   }
   /**
    * Get sync run config (for concurrency control).
-   * Status is derived from sync_dashboard view.
+   * Status is derived from sync_runs view.
    */
   async getSyncRun(accountId, runStartedAt) {
     const result = await this.query(
       `SELECT "_account_id", started_at, max_concurrent, closed_at
-       FROM "${this.config.schema}"."_sync_run"
+       FROM "${this.config.schema}"."_sync_runs"
        WHERE "_account_id" = $1 AND started_at = $2`,
       [accountId, runStartedAt]
     );
@@ -547,7 +559,7 @@ var PostgresClient = class {
    */
   async closeSyncRun(accountId, runStartedAt) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_run"
+      `UPDATE "${this.config.schema}"."_sync_runs"
        SET closed_at = now()
        WHERE "_account_id" = $1 AND started_at = $2 AND closed_at IS NULL`,
       [accountId, runStartedAt]
@@ -561,7 +573,7 @@ var PostgresClient = class {
     if (objects.length === 0) return;
     const values = objects.map((_, i) => `($1, $2, $${i + 3})`).join(", ");
     await this.query(
-      `INSERT INTO "${this.config.schema}"."_sync_obj_run" ("_account_id", run_started_at, object)
+      `INSERT INTO "${this.config.schema}"."_sync_obj_runs" ("_account_id", run_started_at, object)
        VALUES ${values}
        ON CONFLICT ("_account_id", run_started_at, object) DO NOTHING`,
       [accountId, runStartedAt, ...objects]
@@ -580,7 +592,7 @@ var PostgresClient = class {
     const runningCount = await this.countRunningObjects(accountId, runStartedAt);
     if (runningCount >= run.maxConcurrent) return false;
     const result = await this.query(
-      `UPDATE "${this.config.schema}"."_sync_obj_run"
+      `UPDATE "${this.config.schema}"."_sync_obj_runs"
        SET status = 'running', started_at = now(), updated_at = now()
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3 AND status = 'pending'
        RETURNING *`,
@@ -594,7 +606,7 @@ var PostgresClient = class {
   async getObjectRun(accountId, runStartedAt, object) {
     const result = await this.query(
       `SELECT object, status, processed_count, cursor
-       FROM "${this.config.schema}"."_sync_obj_run"
+       FROM "${this.config.schema}"."_sync_obj_runs"
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object]
     );
@@ -613,7 +625,7 @@ var PostgresClient = class {
    */
   async incrementObjectProgress(accountId, runStartedAt, object, count) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_obj_run"
+      `UPDATE "${this.config.schema}"."_sync_obj_runs"
        SET processed_count = processed_count + $4, updated_at = now()
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object, count]
@@ -629,7 +641,7 @@ var PostgresClient = class {
     const isNumeric = cursor !== null && /^\d+$/.test(cursor);
     if (isNumeric) {
       await this.query(
-        `UPDATE "${this.config.schema}"."_sync_obj_run"
+        `UPDATE "${this.config.schema}"."_sync_obj_runs"
          SET cursor = GREATEST(COALESCE(cursor::bigint, 0), $4::bigint)::text,
              updated_at = now()
          WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
@@ -637,7 +649,7 @@ var PostgresClient = class {
       );
     } else {
       await this.query(
-        `UPDATE "${this.config.schema}"."_sync_obj_run"
+        `UPDATE "${this.config.schema}"."_sync_obj_runs"
          SET cursor = $4, updated_at = now()
          WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
         [accountId, runStartedAt, object, cursor]
@@ -653,7 +665,7 @@ var PostgresClient = class {
   async getLastCompletedCursor(accountId, object) {
     const result = await this.query(
       `SELECT MAX(o.cursor::bigint)::text as cursor
-       FROM "${this.config.schema}"."_sync_obj_run" o
+       FROM "${this.config.schema}"."_sync_obj_runs" o
        WHERE o."_account_id" = $1
          AND o.object = $2
          AND o.cursor IS NOT NULL`,
@@ -667,10 +679,10 @@ var PostgresClient = class {
    */
   async deleteSyncRuns(accountId) {
     await this.query(
-      `DELETE FROM "${this.config.schema}"."_sync_obj_run" WHERE "_account_id" = $1`,
+      `DELETE FROM "${this.config.schema}"."_sync_obj_runs" WHERE "_account_id" = $1`,
       [accountId]
     );
-    await this.query(`DELETE FROM "${this.config.schema}"."_sync_run" WHERE "_account_id" = $1`, [
+    await this.query(`DELETE FROM "${this.config.schema}"."_sync_runs" WHERE "_account_id" = $1`, [
       accountId
     ]);
   }
@@ -680,7 +692,7 @@ var PostgresClient = class {
    */
   async completeObjectSync(accountId, runStartedAt, object) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_obj_run"
+      `UPDATE "${this.config.schema}"."_sync_obj_runs"
        SET status = 'complete', completed_at = now()
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object]
@@ -696,7 +708,7 @@ var PostgresClient = class {
    */
   async failObjectSync(accountId, runStartedAt, object, errorMessage) {
     await this.query(
-      `UPDATE "${this.config.schema}"."_sync_obj_run"
+      `UPDATE "${this.config.schema}"."_sync_obj_runs"
        SET status = 'error', error_message = $4, completed_at = now()
        WHERE "_account_id" = $1 AND run_started_at = $2 AND object = $3`,
       [accountId, runStartedAt, object, errorMessage]
@@ -711,7 +723,7 @@ var PostgresClient = class {
    */
   async hasAnyObjectErrors(accountId, runStartedAt) {
     const result = await this.query(
-      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_run"
+      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_runs"
        WHERE "_account_id" = $1 AND run_started_at = $2 AND status = 'error'`,
       [accountId, runStartedAt]
     );
@@ -722,7 +734,7 @@ var PostgresClient = class {
    */
   async countRunningObjects(accountId, runStartedAt) {
     const result = await this.query(
-      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_run"
+      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_runs"
        WHERE "_account_id" = $1 AND run_started_at = $2 AND status = 'running'`,
       [accountId, runStartedAt]
     );
@@ -738,7 +750,7 @@ var PostgresClient = class {
     const runningCount = await this.countRunningObjects(accountId, runStartedAt);
     if (runningCount >= run.maxConcurrent) return null;
     const result = await this.query(
-      `SELECT object FROM "${this.config.schema}"."_sync_obj_run"
+      `SELECT object FROM "${this.config.schema}"."_sync_obj_runs"
        WHERE "_account_id" = $1 AND run_started_at = $2 AND status = 'pending'
        ORDER BY object
        LIMIT 1`,
@@ -751,7 +763,7 @@ var PostgresClient = class {
    */
   async areAllObjectsComplete(accountId, runStartedAt) {
     const result = await this.query(
-      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_run"
+      `SELECT COUNT(*) as count FROM "${this.config.schema}"."_sync_obj_runs"
        WHERE "_account_id" = $1 AND run_started_at = $2 AND status IN ('pending', 'running')`,
       [accountId, runStartedAt]
     );

package/dist/index.d.cts

@@ -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;

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;