@raideno/convex-stripe 0.2.2 → 0.2.3

package/README.md

@@ -45,13 +45,16 @@ export default defineSchema({
 ```ts
 // convex/stripe.ts
 
-import { internalConvexStripe } from "@raideno/convex-stripe/server";
+import { internalConvexStripe, syncAllTables } from "@raideno/convex-stripe/server";
 
 export const { stripe, store, sync } = internalConvexStripe({
   stripe: {
     secret_key: process.env.STRIPE_SECRET_KEY!,
     account_webhook_secret: process.env.STRIPE_ACCOUNT_WEBHOOK_SECRET!,
   },
+  sync: {
+    tables: syncAllTables(),
+  },
 });
 
 export const createCustomer = internalAction({
@@ -165,6 +168,9 @@ Now you can use the provided functions to:
 
 If you wish to also add stripe connect, below is a guide on how to do it. You can find a full example in [`examples/marketplaces/README.md`](examples/marketplace/README.md).
 
+### 0. Enable connect on your stripe dashboard.
+...
+
 ### 1. Create a connect webhook using `sync` method.
 ...
 
@@ -243,8 +249,8 @@ This action is typically manually called or setup to be automatically called in
 }
 ```
 
-- `data` (optional, default: `true`): Syncs all existing Stripe resources to Convex tables.
-- `data.withConnect` (option, default: `false`): Syncs all existing Stripe resources from linked accounts to Convex tables.
+- `tables` (optional, default: `true`): Syncs all existing Stripe resources to Convex tables.
+- `tables.withConnect` (option, default: `false`): Syncs all existing Stripe resources from linked accounts to Convex tables.
 - `webhook.account` (optional, default: `false`): Creates/updates the account webhook endpoint. Returns the webhook secret if a new endpoint is created. You must set it in your convex environment variables as `STRIPE_ACCOUNT_WEBHOOK_SECRET`.
 - `webhook.connect` (optional, default: `false`): Creates/updates the connect webhook endpoint. Returns the webhook secret if a new endpoint is created. You must set it in your convex environment variables as `STRIPE_CONNECT_WEBHOOK_SECRET`.
 - `portal` (optional, default: `false`): Creates the default billing portal configuration if it doesn't exist.

package/dist/index.d.ts

@@ -149,39 +149,49 @@ declare const CreateCustomerImplementation: {
     }>;
 };
 
-export declare type InputConfiguration = WithOptional<InternalConfiguration, "portal" | "sync" | "redirectTtlMs" | "webhook" | "detached" | "catalog">;
-
-export declare type InputOptions = WithOptional<InternalOptions, "store" | "debug" | "logger" | "base">;
-
-export declare interface InternalConfiguration {
+export declare interface InputConfiguration {
     stripe: {
+        version?: default_2.StripeConfig["apiVersion"];
         secret_key: string;
         account_webhook_secret: string;
         connect_webhook_secret?: string;
     };
-    catalog: {
-        products: default_2.ProductCreateParams[];
-        prices: default_2.PriceCreateParams[];
-        behavior: {
-            onExisting: "update" | "archive_and_recreate" | "skip" | "error";
-            onMissingKey: "create" | "error";
+    sync: {
+        catalog?: {
+            products?: default_2.ProductCreateParams[];
+            prices?: default_2.PriceCreateParams[];
+            behavior?: {
+                onExisting?: "update" | "archive_and_recreate" | "skip" | "error";
+                onMissingKey?: "create" | "error";
+            };
+            metadataKey?: string;
         };
-        metadataKey: string;
-    };
-    webhook: {
-        metadata: Record<string, string>;
-        description: string;
-        path: string;
+        webhooks?: {
+            account: {
+                metadata?: Record<string, string>;
+                description?: string;
+                path?: string;
+            };
+            connect: {
+                metadata?: Record<string, string>;
+                description?: string;
+                path?: string;
+            };
+        };
+        portal?: default_2.BillingPortal.ConfigurationCreateParams;
+        tables: Record<keyof typeof stripeTables, boolean>;
     };
-    portal: default_2.BillingPortal.ConfigurationCreateParams;
-    callback?: {
-        unstable__afterChange?: CallbackAfterChange;
+    callbacks?: {
+        afterChange?: CallbackAfterChange;
     };
-    detached: boolean;
-    sync: Partial<Record<keyof typeof stripeTables, boolean>>;
-    redirectTtlMs: number;
+    detached?: boolean;
+    redirectTtlMs?: number;
 }
 
+export declare type InputOptions = Partial<InternalOptions>;
+
+export declare type InternalConfiguration = RecursiveDeepRequired<InputConfiguration>;
+
 export declare const internalConvexStripe: (configuration_: InputConfiguration, options_?: InputOptions) => {
     stripe: {
         http: {
@@ -1435,13 +1445,13 @@ export declare const internalConvexStripe: (configuration_: InputConfiguration,
     doc?: undefined;
     } | undefined>>;
     sync: RegisteredAction<"internal", {
-    portal?: boolean | undefined;
     webhooks?: {
     account?: boolean | undefined;
     connect?: boolean | undefined;
     } | undefined;
+    portal?: boolean | undefined;
     unstable_catalog?: boolean | undefined;
-    data: boolean | {
+    tables: boolean | {
     withConnect?: boolean | undefined;
     };
     }, Promise<void>>;
@@ -1486,6 +1496,10 @@ declare const PortalImplementation: {
     } & Omit<default_2.BillingPortal.SessionCreateParams, "customer" | "return_url">, stripeOptions: default_2.RequestOptions, configuration: InternalConfiguration, options: InternalOptions) => Promise<default_2.Response<default_2.BillingPortal.Session>>;
 };
 
+declare type RecursiveDeepRequired<T> = T extends (...args: any[]) => any ? T : T extends object ? {
+    [K in keyof T]-?: RecursiveDeepRequired<T[K]>;
+} : T;
+
 declare type StripeDataModel = DataModelFromSchemaDefinition<typeof stripeSchema>;
 
 declare const stripeSchema: SchemaDefinition<    {
@@ -8857,6 +8871,10 @@ declare const SubscribeImplementation: {
     } & Omit<default_2.Checkout.SessionCreateParams, "mode" | "customer" | "client_reference_id" | "line_items" | "success_url" | "ui_mode" | "cancel_url">, stripeOptions: default_2.RequestOptions, configuration: InternalConfiguration, options: InternalOptions) => Promise<default_2.Response<default_2.Checkout.Session>>;
 };
 
-declare type WithOptional<T, K extends keyof T = never> = Omit<T, K> & Partial<Pick<T, K>>;
+export declare const syncAllTables: () => Record<keyof typeof stripeTables, boolean>;
+
+export declare const syncAllTablesExcept: (tables: Array<keyof typeof stripeTables>) => Record<keyof typeof stripeTables, boolean>;
+
+export declare const syncOnlyTables: (tables: Array<keyof typeof stripeTables>) => Record<keyof typeof stripeTables, boolean>;
 
 export { }