@raideno/convex-stripe 0.3.3 → 0.3.5

package/README.md

@@ -17,9 +17,9 @@ Stripe [syncing](./documentation/references/tables.md), subscriptions, [checkout
     - [7. Run the `sync` Action](#7-run-the-sync-action)
     - [8. Start Building](#8-start-building)
   - [Configuration](#configuration)
+    - [Schema Configuration](#schema-configuration)
     - [Stripe Configuration](#stripe-configuration)
     - [Sync Configuration](#sync-configuration)
-      - [Table Selection](#table-selection)
       - [Catalog (Unstable)](#catalog-unstable)
       - [Webhook Configuration](#webhook-configuration)
       - [Portal Configuration](#portal-configuration)
@@ -99,6 +99,22 @@ export default defineSchema({
 });
 ```
 
+If you only want to sync specific tables and avoid creating empty tables in your database, you can use the `allStripeTablesExcept` or `onlyStripeTables` helpers instead of `stripeTables`:
+
+```ts
+// convex/schema.ts
+
+import { defineSchema } from "convex/server";
+import { onlyStripeTables } from "@raideno/convex-stripe/server";
+
+export default defineSchema({
+  ...onlyStripeTables(["stripeCustomers", "stripeSubscriptions", "stripeProducts", "stripePrices"]),
+  // your other tables...
+});
+```
+
+The package will only sync the tables you defined.
+
 See [Tables Reference](./documentation/references/tables.md) for the full list of tables and their schemas.
 
 ### 4. Initialize the Library
@@ -108,16 +124,16 @@ Call `internalConvexStripe` with your Stripe credentials and sync configuration.
 ```ts
 // convex/stripe.ts
 
-import { internalConvexStripe, syncAllTables } from "@raideno/convex-stripe/server";
+import { internalConvexStripe } from "@raideno/convex-stripe/server";
+
+import schema from "./schema";
 
 export const { stripe, store, sync } = internalConvexStripe({
+  schema: schema,
   stripe: {
     secret_key: process.env.STRIPE_SECRET_KEY!,
     account_webhook_secret: process.env.STRIPE_ACCOUNT_WEBHOOK_SECRET!,
   },
-  sync: {
-    tables: syncAllTables(),
-  },
 });
 ```
 
@@ -243,6 +259,9 @@ The `internalConvexStripe` function accepts a configuration object and an option
 ```ts
 const { stripe, store, sync } = internalConvexStripe(configuration, options);
 ```
+### Schema Configuration
+
+The `schema` key holds your convex app schema, from it the package will infer which stripe tables should be synced or not depending on what stripeTables where defined.
 
 ### Stripe Configuration
 
@@ -259,29 +278,6 @@ The `stripe` key in the configuration object holds your Stripe credentials and A
 
 The `sync` key controls which tables are synced and allows you to define catalog items, webhook endpoints, and billing portal configuration.
 
-#### Table Selection
-
-Three helper functions are provided to control which Stripe tables are synced into Convex:
-
-```ts
-import {
-  syncAllTables,
-  syncAllTablesExcept,
-  syncOnlyTables,
-} from "@raideno/convex-stripe/server";
-
-// Sync all 24 tables (default)
-{ tables: syncAllTables() }
-
-// Sync all tables except specific ones
-{ tables: syncAllTablesExcept(["stripeReviews", "stripePlans"]) }
-
-// Sync only specific tables
-{ tables: syncOnlyTables(["stripeCustomers", "stripeSubscriptions", "stripeProducts", "stripePrices"]) }
-```
-
-All 24 available tables are listed in the [Synced Tables](#synced-tables) section.
-
 #### Catalog (Unstable)
 
 The `sync.catalog` key lets you pre-define products and prices that should exist in Stripe. When the `sync` action is called with `{ catalog: true }`, the library ensures these objects exist in your Stripe account.
@@ -290,7 +286,6 @@ The `sync.catalog` key lets you pre-define products and prices that should exist
 internalConvexStripe({
   // ...
   sync: {
-    tables: syncAllTables(),
     catalog: {
       products: [
         { name: "Pro Plan", metadata: { convex_stripe_key: "pro" } },
@@ -485,15 +480,17 @@ Then update your configuration to include it:
 ```ts
 // convex/stripe.ts
 
+import { internalConvexStripe } from "@raideno/convex-stripe/server";
+
+import schema from "./schema";
+
 export const { stripe, store, sync } = internalConvexStripe({
+  schema: schema,
   stripe: {
     secret_key: process.env.STRIPE_SECRET_KEY!,
     account_webhook_secret: process.env.STRIPE_ACCOUNT_WEBHOOK_SECRET!,
     connect_webhook_secret: process.env.STRIPE_CONNECT_WEBHOOK_SECRET!,
-  },
-  sync: {
-    tables: syncAllTables(),
-  },
+  }
 });
 ```