@paymentsdb/sync-engine 0.0.1

package/dist/supabase/index.d.ts

@@ -0,0 +1,121 @@
+declare const STRIPE_SCHEMA_COMMENT_PREFIX = "stripe-sync";
+declare const INSTALLATION_STARTED_SUFFIX = "installation:started";
+declare const INSTALLATION_ERROR_SUFFIX = "installation:error";
+declare const INSTALLATION_INSTALLED_SUFFIX = "installed";
+interface DeployClientOptions {
+    accessToken: string;
+    projectRef: string;
+    projectBaseUrl?: string;
+    supabaseManagementUrl?: string;
+}
+interface ProjectInfo {
+    id: string;
+    name: string;
+    region: string;
+}
+declare class SupabaseSetupClient {
+    private api;
+    private projectRef;
+    private projectBaseUrl;
+    private supabaseManagementUrl?;
+    private accessToken;
+    constructor(options: DeployClientOptions);
+    /**
+     * Validate that the project exists and we have access
+     */
+    validateProject(): Promise<ProjectInfo>;
+    /**
+     * Deploy an Edge Function
+     */
+    deployFunction(name: string, code: string, verifyJwt?: boolean): Promise<void>;
+    /**
+     * Set secrets for Edge Functions
+     */
+    setSecrets(secrets: {
+        name: string;
+        value: string;
+    }[]): Promise<void>;
+    /**
+     * Run SQL against the database
+     */
+    runSQL(sql: string): Promise<unknown>;
+    /**
+     * Setup pg_cron job to invoke worker function
+     * @param intervalSeconds - How often to run the worker (default: 60 seconds)
+     */
+    setupPgCronJob(intervalSeconds?: number): Promise<void>;
+    /**
+     * Get the webhook URL for this project
+     */
+    getWebhookUrl(): string;
+    /**
+     * Get the anon key for this project (needed for Realtime subscriptions)
+     */
+    getAnonKey(): Promise<string>;
+    /**
+     * Get the project URL
+     */
+    getProjectUrl(): string;
+    /**
+     * Invoke an Edge Function
+     */
+    invokeFunction(name: string, bearerToken: string): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Check if stripe-sync is installed in the database.
+     *
+     * Uses the Supabase Management API to run SQL queries.
+     * Uses duck typing (schema + migrations table) combined with comment validation.
+     * Throws error for legacy installations to prevent accidental corruption.
+     *
+     * @param schema The schema name to check (defaults to 'stripe')
+     * @returns true if properly installed with comment marker, false if not installed
+     * @throws Error if legacy installation detected (schema exists without comment)
+     */
+    isInstalled(schema?: string): Promise<boolean>;
+    /**
+     * Update installation progress comment on the stripe schema
+     */
+    updateInstallationComment(message: string): Promise<void>;
+    /**
+     * Delete an Edge Function
+     */
+    deleteFunction(name: string): Promise<void>;
+    /**
+     * Delete a secret
+     */
+    deleteSecret(name: string): Promise<void>;
+    /**
+     * Uninstall stripe-sync from a Supabase project
+     * Invokes the stripe-setup edge function's DELETE endpoint which handles cleanup
+     */
+    uninstall(): Promise<void>;
+    /**
+     * Inject package version into Edge Function code
+     */
+    private injectPackageVersion;
+    install(stripeKey: string, packageVersion?: string, workerIntervalSeconds?: number): Promise<void>;
+}
+declare function install(params: {
+    supabaseAccessToken: string;
+    supabaseProjectRef: string;
+    stripeKey: string;
+    packageVersion?: string;
+    workerIntervalSeconds?: number;
+    baseProjectUrl?: string;
+    supabaseManagementUrl?: string;
+}): Promise<void>;
+declare function uninstall(params: {
+    supabaseAccessToken: string;
+    supabaseProjectRef: string;
+    baseProjectUrl?: string;
+    supabaseManagementUrl?: string;
+}): Promise<void>;
+
+declare const setupFunctionCode: string;
+declare const webhookFunctionCode: string;
+declare const workerFunctionCode: string;
+
+export { type DeployClientOptions, INSTALLATION_ERROR_SUFFIX, INSTALLATION_INSTALLED_SUFFIX, INSTALLATION_STARTED_SUFFIX, type ProjectInfo, STRIPE_SCHEMA_COMMENT_PREFIX, SupabaseSetupClient as SupabaseDeployClient, SupabaseSetupClient, install, setupFunctionCode, uninstall, webhookFunctionCode, workerFunctionCode };

package/dist/supabase/index.js

@@ -0,0 +1,26 @@
+import {
+  INSTALLATION_ERROR_SUFFIX,
+  INSTALLATION_INSTALLED_SUFFIX,
+  INSTALLATION_STARTED_SUFFIX,
+  STRIPE_SCHEMA_COMMENT_PREFIX,
+  SupabaseSetupClient,
+  install,
+  setupFunctionCode,
+  uninstall,
+  webhookFunctionCode,
+  workerFunctionCode
+} from "../chunk-TYAHH7EW.js";
+import "../chunk-CMGFQCD7.js";
+export {
+  INSTALLATION_ERROR_SUFFIX,
+  INSTALLATION_INSTALLED_SUFFIX,
+  INSTALLATION_STARTED_SUFFIX,
+  STRIPE_SCHEMA_COMMENT_PREFIX,
+  SupabaseSetupClient as SupabaseDeployClient,
+  SupabaseSetupClient,
+  install,
+  setupFunctionCode,
+  uninstall,
+  webhookFunctionCode,
+  workerFunctionCode
+};

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@paymentsdb/sync-engine",
+  "version": "0.0.1",
+  "private": false,
+  "description": "Stripe Sync Engine to sync Stripe data to Postgres",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "bin": "./dist/cli/index.js",
+  "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"
+    },
+    "./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 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"
+  },
+  "files": [
+    "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",
+    "papaparse": "5.4.1",
+    "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"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/inquirer": "^9.0.7",
+    "@types/node": "^24.10.1",
+    "@types/papaparse": "5.3.16",
+    "@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": {
+    "type": "git",
+    "url": "https://github.com/stripe-experiments/sync-engine.git"
+  },
+  "homepage": "https://github.com/stripe-experiments/sync-engine#readme",
+  "bugs": {
+    "url": "https://github.com/stripe-experiments/sync-engine/issues"
+  },
+  "keywords": [
+    "stripe",
+    "postgres",
+    "sync",
+    "webhooks",
+    "supabase",
+    "billing",
+    "database",
+    "typescript"
+  ],
+  "author": "PaymentsDB <https://paymentsdb.com/>",
+  "license": "Apache-2.0"
+}