@moneymq/better-auth 0.2.1

package/dist/index.d.ts

@@ -0,0 +1,421 @@
+import * as _moneymq_sdk from '@moneymq/sdk';
+import { MoneyMQ } from '@moneymq/sdk';
+import * as better_auth from 'better-auth';
+import { z } from 'zod';
+
+/**
+ * Usage record for billing
+ */
+interface UsageRecord {
+    id: string;
+    userId: string;
+    customerId: string;
+    metric: string;
+    quantity: number;
+    timestamp: Date;
+    metadata?: Record<string, string>;
+    billed: boolean;
+    billedAt?: Date;
+    paymentId?: string;
+}
+/**
+ * Usage metric configuration
+ */
+interface UsageMetric {
+    /**
+     * Unique identifier for this metric (e.g., "api_calls", "storage_gb")
+     */
+    name: string;
+    /**
+     * MoneyMQ price ID for this metric
+     */
+    priceId: string;
+    /**
+     * Human-readable display name
+     */
+    displayName?: string;
+    /**
+     * Unit of measurement (e.g., "requests", "GB", "minutes")
+     */
+    unit?: string;
+    /**
+     * Aggregation method for billing period
+     * - 'sum': Total of all records (default)
+     * - 'max': Maximum value in period
+     * - 'last': Last recorded value
+     */
+    aggregation?: 'sum' | 'max' | 'last';
+}
+/**
+ * Usage billing configuration
+ */
+interface UsageBillingConfig {
+    /**
+     * Enable usage-based billing
+     */
+    enabled: boolean;
+    /**
+     * Available usage metrics
+     */
+    metrics: UsageMetric[];
+    /**
+     * Callback after usage is recorded
+     */
+    onUsageRecorded?: (record: UsageRecord) => void | Promise<void>;
+    /**
+     * Callback after usage is billed
+     */
+    onUsageBilled?: (params: {
+        records: UsageRecord[];
+        paymentId: string;
+        amount: number;
+    }) => void | Promise<void>;
+}
+/**
+ * MoneyMQ Better Auth plugin options
+ */
+interface MoneyMQPluginOptions {
+    /**
+     * MoneyMQ SDK client instance
+     */
+    client: MoneyMQ;
+    /**
+     * Webhook secret for signature verification
+     */
+    webhookSecret?: string;
+    /**
+     * Automatically create MoneyMQ customer on user signup
+     * @default true
+     */
+    createCustomerOnSignUp?: boolean;
+    /**
+     * Callback after customer is created
+     */
+    onCustomerCreate?: (params: {
+        customer: {
+            id: string;
+            email: string;
+        };
+        user: {
+            id: string;
+            email: string;
+        };
+    }) => void | Promise<void>;
+    /**
+     * Customize customer creation parameters
+     */
+    getCustomerCreateParams?: (user: {
+        id: string;
+        email: string;
+        name?: string;
+    }) => {
+        email: string;
+        name?: string;
+        metadata?: Record<string, string>;
+    };
+    /**
+     * Handle custom webhook events
+     */
+    onEvent?: (event: WebhookEvent) => void | Promise<void>;
+    /**
+     * Usage-based billing configuration
+     */
+    usage?: UsageBillingConfig;
+    /**
+     * Schema customization
+     */
+    schema?: {
+        usage?: {
+            modelName?: string;
+            fields?: Partial<Record<keyof UsageRecord, string>>;
+        };
+    };
+}
+/**
+ * Webhook event from MoneyMQ
+ */
+interface WebhookEvent {
+    id: string;
+    type: WebhookEventType;
+    data: Record<string, unknown>;
+    created: number;
+}
+/**
+ * Supported webhook event types
+ */
+type WebhookEventType = 'payment.completed' | 'payment.failed' | 'checkout.completed' | 'checkout.expired' | 'customer.created' | 'customer.updated' | 'payout.completed' | 'payout.failed';
+/**
+ * Client plugin options
+ */
+interface MoneyMQClientPluginOptions {
+    /**
+     * Enable usage tracking on client
+     */
+    usage?: boolean;
+}
+/**
+ * Record usage parameters
+ */
+interface RecordUsageParams {
+    /**
+     * Metric name to record usage for
+     */
+    metric: string;
+    /**
+     * Quantity to record
+     */
+    quantity: number;
+    /**
+     * Optional metadata
+     */
+    metadata?: Record<string, string>;
+}
+/**
+ * Get usage parameters
+ */
+interface GetUsageParams {
+    /**
+     * Metric name to get usage for (optional, returns all if not specified)
+     */
+    metric?: string;
+    /**
+     * Start date for usage period
+     */
+    startDate?: Date;
+    /**
+     * End date for usage period
+     */
+    endDate?: Date;
+    /**
+     * Include billed usage records
+     * @default false
+     */
+    includeBilled?: boolean;
+}
+/**
+ * Usage summary response
+ */
+interface UsageSummary {
+    metric: string;
+    displayName?: string;
+    unit?: string;
+    total: number;
+    unbilledTotal: number;
+    records: UsageRecord[];
+}
+/**
+ * Create checkout parameters
+ */
+interface CreateCheckoutParams {
+    /**
+     * Line items for the checkout
+     */
+    lineItems: Array<{
+        price: string;
+        quantity: number;
+    }>;
+    /**
+     * URL to redirect to on success
+     */
+    successUrl: string;
+    /**
+     * URL to redirect to on cancel
+     */
+    cancelUrl: string;
+    /**
+     * Optional metadata
+     */
+    metadata?: Record<string, string>;
+}
+
+/**
+ * MoneyMQ plugin for Better Auth
+ *
+ * Integrates MoneyMQ stablecoin payments with Better Auth for
+ * customer creation and usage-based billing.
+ *
+ * @example
+ * ```typescript
+ * import { betterAuth } from 'better-auth';
+ * import { moneymq } from '@moneymq/better-auth';
+ * import { MoneyMQ } from '@moneymq/sdk';
+ *
+ * const moneymqClient = new MoneyMQ({
+ *   endpoint: process.env.MONEYMQ_ENDPOINT!,
+ *   secret: process.env.MONEYMQ_SECRET,
+ * });
+ *
+ * export const auth = betterAuth({
+ *   plugins: [
+ *     moneymq({
+ *       client: moneymqClient,
+ *       webhookSecret: process.env.MONEYMQ_WEBHOOK_SECRET,
+ *       createCustomerOnSignUp: true,
+ *       usage: {
+ *         enabled: true,
+ *         metrics: [
+ *           { name: 'api_calls', priceId: 'price_xxx', unit: 'requests' },
+ *           { name: 'storage', priceId: 'price_yyy', unit: 'GB' },
+ *         ],
+ *       },
+ *     }),
+ *   ],
+ * });
+ * ```
+ */
+declare const moneymq: (options: MoneyMQPluginOptions) => {
+    id: "moneymq";
+    endpoints: {
+        moneymqWebhook: better_auth.StrictEndpoint<"/moneymq/webhook", {
+            method: "POST";
+            metadata: {
+                isAction: false;
+            };
+        }, {
+            received: boolean;
+        }>;
+        recordUsage: better_auth.StrictEndpoint<"/moneymq/usage/record", {
+            method: "POST";
+            body: z.ZodObject<{
+                metric: z.ZodString;
+                quantity: z.ZodNumber;
+                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, "strip", z.ZodTypeAny, {
+                metric: string;
+                quantity: number;
+                metadata?: Record<string, string> | undefined;
+            }, {
+                metric: string;
+                quantity: number;
+                metadata?: Record<string, string> | undefined;
+            }>;
+        }, {
+            success: boolean;
+            record: UsageRecord;
+        }>;
+        getUsage: better_auth.StrictEndpoint<"/moneymq/usage", {
+            method: "GET";
+            query: z.ZodObject<{
+                metric: z.ZodOptional<z.ZodString>;
+                startDate: z.ZodOptional<z.ZodString>;
+                endDate: z.ZodOptional<z.ZodString>;
+                includeBilled: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                metric?: string | undefined;
+                startDate?: string | undefined;
+                endDate?: string | undefined;
+                includeBilled?: string | undefined;
+            }, {
+                metric?: string | undefined;
+                startDate?: string | undefined;
+                endDate?: string | undefined;
+                includeBilled?: string | undefined;
+            }>;
+        }, {
+            usage: {
+                metric: string;
+                displayName: string | undefined;
+                unit: string | undefined;
+                total: number;
+                unbilledTotal: number;
+                records: UsageRecord[];
+            }[];
+        }>;
+        createUsageCheckout: better_auth.StrictEndpoint<"/moneymq/usage/checkout", {
+            method: "POST";
+            body: z.ZodObject<{
+                metrics: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                successUrl: z.ZodString;
+                cancelUrl: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                successUrl: string;
+                cancelUrl: string;
+                metrics?: string[] | undefined;
+            }, {
+                successUrl: string;
+                cancelUrl: string;
+                metrics?: string[] | undefined;
+            }>;
+        }, {
+            url: string;
+            sessionId: string;
+            lineItems: {
+                price: string;
+                quantity: number;
+            }[];
+            totalRecords: number;
+        }>;
+        createCheckout: better_auth.StrictEndpoint<"/moneymq/checkout", {
+            method: "POST";
+            body: z.ZodObject<{
+                lineItems: z.ZodArray<z.ZodObject<{
+                    price: z.ZodString;
+                    quantity: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    quantity: number;
+                    price: string;
+                }, {
+                    quantity: number;
+                    price: string;
+                }>, "many">;
+                successUrl: z.ZodString;
+                cancelUrl: z.ZodString;
+                metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            }, "strip", z.ZodTypeAny, {
+                successUrl: string;
+                cancelUrl: string;
+                lineItems: {
+                    quantity: number;
+                    price: string;
+                }[];
+                metadata?: Record<string, string> | undefined;
+            }, {
+                successUrl: string;
+                cancelUrl: string;
+                lineItems: {
+                    quantity: number;
+                    price: string;
+                }[];
+                metadata?: Record<string, string> | undefined;
+            }>;
+        }, {
+            url: string;
+            sessionId: string;
+        }>;
+        getCustomer: better_auth.StrictEndpoint<"/moneymq/customer", {
+            method: "GET";
+        }, {
+            customer: null;
+        } | {
+            customer: _moneymq_sdk.Customer;
+        }>;
+        getMetrics: better_auth.StrictEndpoint<"/moneymq/metrics", {
+            method: "GET";
+        }, {
+            metrics: {
+                name: string;
+                displayName: string | undefined;
+                unit: string | undefined;
+                aggregation: "sum" | "max" | "last";
+            }[];
+        }>;
+    };
+    schema: {
+        user: {
+            fields: {
+                moneymqCustomerId: {
+                    type: "string";
+                    required: false;
+                };
+            };
+        };
+    };
+    hooks: {
+        after: {
+            matcher: (context: better_auth.HookEndpointContext) => boolean;
+            handler: (ctx: better_auth.MiddlewareInputContext<better_auth.MiddlewareOptions>) => Promise<void>;
+        }[];
+    };
+};
+
+export { type CreateCheckoutParams, type GetUsageParams, type MoneyMQClientPluginOptions, type MoneyMQPluginOptions, type RecordUsageParams, type UsageBillingConfig, type UsageMetric, type UsageRecord, type UsageSummary, type WebhookEvent, type WebhookEventType, moneymq as default, moneymq };