stripe-experiment-sync 1.0.6 → 1.0.8

package/README.md

@@ -120,11 +120,32 @@ The library will create and manage a `stripe` schema in your PostgreSQL database
 
 > **Important:** The library uses a fixed schema name of `stripe`. This cannot be configured as the SQL migrations hardcode this schema name.
 
-> **Note:** Fields and tables prefixed with an underscore (`_`) are reserved for internal metadata managed by the sync engine and should not be modified directly. These include fields like `_account`, `_cursor`, `_synced_at`, and tables like `_migrations`, `_accounts`, `_sync_run`, and `_sync_obj_run`.
+> **Note:** Fields and tables prefixed with an underscore (`_`) are reserved for internal metadata managed by the sync engine and should not be modified directly. These include fields like `_account_id`, `_last_synced_at`, `_updated_at`, and tables like `_migrations`, `_managed_webhooks`, `_sync_runs`, and `_sync_obj_runs`.
+
+### Observability
+
+The sync engine tracks sync operations in the `sync_runs` view, which provides aggregated metrics for each sync session:
+
+```sql
+SELECT
+  account_id,
+  started_at,
+  closed_at,
+  status,              -- 'running', 'complete', or 'error'
+  total_processed,     -- Total records synced across all objects
+  complete_count,      -- Number of object types completed
+  error_count,         -- Number of object types with errors
+  running_count,       -- Number of object types currently syncing
+  pending_count        -- Number of object types not yet started
+FROM stripe.sync_runs
+ORDER BY started_at DESC;
+```
+
+For detailed per-object status, you can query the internal `_sync_obj_runs` table (though this is not recommended for production use).
 
 ### Migrations
 
-Migrations are included in the `db/migrations` directory. You can run them using the provided `runMigrations` function:
+Migrations are automatically included with the package and bundled in the `dist/migrations` directory when built. You can run them using the provided `runMigrations` function:
 
 ```ts
 import { runMigrations } from 'stripe-experiment-sync'
@@ -205,10 +226,10 @@ await sync.processUntilDone({
 })
 ```
 
-- `object` can be one of: `all`, `charge`, `customer`, `dispute`, `invoice`, `payment_method`, `payment_intent`, `plan`, `price`, `product`, `setup_intent`, `subscription`.
+- `object` can be one of: `all`, `charge`, `checkout_sessions`, `credit_note`, `customer`, `customer_with_entitlements`, `dispute`, `early_fraud_warning`, `invoice`, `payment_intent`, `payment_method`, `plan`, `price`, `product`, `refund`, `setup_intent`, `subscription`, `subscription_schedules`, `tax_id`.
 - `created` is a Stripe RangeQueryParam and supports `gt`, `gte`, `lt`, `lte`.
 
-The sync engine automatically tracks per-account cursors in the `_sync_run` and `_sync_obj_run` tables. When you call sync methods without an explicit `created` filter, they will automatically resume from the last synced position for that account and resource. This enables incremental syncing that can resume after interruptions.
+The sync engine automatically tracks per-account cursors in the `_sync_runs` and `_sync_obj_runs` tables. When you call sync methods without an explicit `created` filter, they will automatically resume from the last synced position for that account and resource. This enables incremental syncing that can resume after interruptions.
 
 > **Note:**
 > For large Stripe accounts (more than 10,000 objects), it is recommended to write a script that loops through each day and sets the `created` date filters to the start and end of day. This avoids timeouts and memory issues when syncing large datasets.

package/dist/{chunk-3UERGK2O.js → chunk-CKWVW2JK.js}

@@ -1,12 +1,12 @@
 // package.json
 var package_default = {
   name: "stripe-experiment-sync",
-  version: "1.0.6",
+  version: "1.0.8-beta.1765856228",
   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",
@@ -17,12 +17,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"
   },
@@ -30,21 +35,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: {