@better-auth/stripe 1.2.0-beta.18

package/src/types.ts

@@ -0,0 +1,323 @@
+import type { Session, User } from "better-auth";
+import type Stripe from "stripe";
+
+export type Plan = {
+	/**
+	 * Monthly price id
+	 */
+	priceId?: string;
+	/**
+	 * To use lookup key instead of price id
+	 *
+	 * https://docs.stripe.com/products-prices/
+	 * manage-prices#lookup-keys
+	 */
+	lookupKey?: string;
+	/**
+	 * A yearly discount price id
+	 *
+	 * useful when you want to offer a discount for
+	 * yearly subscription
+	 */
+	annualDiscountPriceId?: string;
+	/**
+	 * Plan name
+	 */
+	name: string;
+	/**
+	 * Limits for the plan
+	 */
+	limits?: Record<string, number>;
+	/**
+	 * Plan group name
+	 *
+	 * useful when you want to group plans or
+	 * when a user can subscribe to multiple plans.
+	 */
+	group?: string;
+	/**
+	 * Free trial days
+	 */
+	freeTrial?: {
+		/**
+		 * Number of days
+		 */
+		days: number;
+		/**
+		 * Only available for new users or users without existing subscription
+		 *
+		 * @default true
+		 */
+		forNewUsersOnly?: boolean;
+		/**
+		 * A function that will be called when the trial
+		 * starts.
+		 *
+		 * @param subscription
+		 * @returns
+		 */
+		onTrialStart?: (subscription: Subscription) => Promise<void>;
+		/**
+		 * A function that will be called when the trial
+		 * ends
+		 *
+		 * @param subscription - Subscription
+		 * @returns
+		 */
+		onTrialEnd?: (
+			data: {
+				subscription: Subscription;
+				user: User & Record<string, any>;
+			},
+			request?: Request,
+		) => Promise<void>;
+		/**
+		 * A function that will be called when the trial
+		 * expired.
+		 * @param subscription - Subscription
+		 * @returns
+		 */
+		onTrialExpired?: (subscription: Subscription) => Promise<void>;
+	};
+};
+
+export interface Subscription {
+	/**
+	 * Database identifier
+	 */
+	id: string;
+	/**
+	 * The plan name
+	 */
+	plan: string;
+	/**
+	 * Stripe customer id
+	 */
+	stripeCustomerId?: string;
+	/**
+	 * Stripe subscription id
+	 */
+	stripeSubscriptionId?: string;
+	/**
+	 * Trial start date
+	 */
+	trialStart?: Date;
+	/**
+	 * Trial end date
+	 */
+	trialEnd?: Date;
+	/**
+	 * Price Id for the subscription
+	 */
+	priceId?: string;
+	/**
+	 * To what reference id the subscription belongs to
+	 * @example
+	 * - userId for a user
+	 * - workspace id for a saas platform
+	 * - website id for a hosting platform
+	 *
+	 * @default - userId
+	 */
+	referenceId: string;
+	/**
+	 * Subscription status
+	 */
+	status:
+		| "active"
+		| "canceled"
+		| "incomplete"
+		| "incomplete_expired"
+		| "past_due"
+		| "paused"
+		| "trialing"
+		| "unpaid";
+	/**
+	 * The billing cycle start date
+	 */
+	periodStart?: Date;
+	/**
+	 * The billing cycle end date
+	 */
+	periodEnd?: Date;
+	/**
+	 * Cancel at period end
+	 */
+	cancelAtPeriodEnd?: boolean;
+	/**
+	 * A field to group subscriptions so you can have multiple subscriptions
+	 * for one reference id
+	 */
+	groupId?: string;
+	/**
+	 * Number of seats for the subscription (useful for team plans)
+	 */
+	seats?: number;
+}
+
+export interface StripeOptions {
+	/**
+	 * Stripe Client
+	 */
+	stripeClient: Stripe;
+	/**
+	 * Stripe Webhook Secret
+	 *
+	 * @description Stripe webhook secret key
+	 */
+	stripeWebhookSecret: string;
+	/**
+	 * Enable customer creation when a user signs up
+	 */
+	createCustomerOnSignUp?: boolean;
+	/**
+	 * A callback to run after a customer has been created
+	 * @param customer - Customer Data
+	 * @param stripeCustomer - Stripe Customer Data
+	 * @returns
+	 */
+	onCustomerCreate?: (
+		data: {
+			customer: Customer;
+			stripeCustomer: Stripe.Customer;
+			user: User;
+		},
+		request?: Request,
+	) => Promise<void>;
+	/**
+	 * A custom function to get the customer create
+	 * params
+	 * @param data - data containing user and session
+	 * @returns
+	 */
+	getCustomerCreateParams?: (
+		data: {
+			user: User;
+			session: Session;
+		},
+		request?: Request,
+	) => Promise<{}>;
+	/**
+	 * Subscriptions
+	 */
+	subscription?: {
+		enabled: boolean;
+		/**
+		 * Subscription Configuration
+		 */
+		/**
+		 * List of plan
+		 */
+		plans: Plan[] | (() => Promise<Plan[]>);
+		/**
+		 * Require email verification before a user is allowed to upgrade
+		 * their subscriptions
+		 *
+		 * @default false
+		 */
+		requireEmailVerification?: boolean;
+		/**
+		 * A callback to run after a user has subscribed to a package
+		 * @param event - Stripe Event
+		 * @param subscription - Subscription Data
+		 * @returns
+		 */
+		onSubscriptionComplete?: (
+			data: {
+				event: Stripe.Event;
+				stripeSubscription: Stripe.Subscription;
+				subscription: Subscription;
+				plan: Plan;
+			},
+			request?: Request,
+		) => Promise<void>;
+		/**
+		 * A callback to run after a user is about to cancel their subscription
+		 * @returns
+		 */
+		onSubscriptionUpdate?: (data: {
+			event: Stripe.Event;
+			subscription: Subscription;
+		}) => Promise<void>;
+		/**
+		 * A callback to run after a user is about to cancel their subscription
+		 * @returns
+		 */
+		onSubscriptionCancel?: (data: {
+			event: Stripe.Event;
+			subscription: Subscription;
+			stripeSubscription: Stripe.Subscription;
+			cancellationDetails?: Stripe.Subscription.CancellationDetails;
+		}) => Promise<void>;
+		/**
+		 * A function to check if the reference id is valid
+		 * and belongs to the user
+		 *
+		 * @param data - data containing user, session and referenceId
+		 * @param request - Request Object
+		 * @returns
+		 */
+		authorizeReference?: (
+			data: {
+				user: User & Record<string, any>;
+				session: Session & Record<string, any>;
+				referenceId: string;
+				action:
+					| "upgrade-subscription"
+					| "list-subscription"
+					| "cancel-subscription";
+			},
+			request?: Request,
+		) => Promise<boolean>;
+		/**
+		 * A callback to run after a user has deleted their subscription
+		 * @returns
+		 */
+		onSubscriptionDeleted?: (data: {
+			event: Stripe.Event;
+			stripeSubscription: Stripe.Subscription;
+			subscription: Subscription;
+		}) => Promise<void>;
+		/**
+		 * parameters for session create params
+		 *
+		 * @param data - data containing user, session and plan
+		 * @param request - Request Object
+		 */
+		getCheckoutSessionParams?: (
+			data: {
+				user: User & Record<string, any>;
+				session: Session & Record<string, any>;
+				plan: Plan;
+				subscription: Subscription;
+			},
+			request?: Request,
+		) =>
+			| Promise<{
+					params?: Stripe.Checkout.SessionCreateParams;
+					options?: Stripe.RequestOptions;
+			  }>
+			| {
+					params?: Stripe.Checkout.SessionCreateParams;
+					options?: Stripe.RequestOptions;
+			  };
+		/**
+		 * Enable organization subscription
+		 */
+		organization?: {
+			enabled: boolean;
+		};
+	};
+	onEvent?: (event: Stripe.Event) => Promise<void>;
+}
+
+export interface Customer {
+	id: string;
+	stripeCustomerId?: string;
+	userId: string;
+	createdAt: Date;
+	updatedAt: Date;
+}
+
+export interface InputSubscription extends Omit<Subscription, "id"> {}
+export interface InputCustomer extends Omit<Customer, "id"> {}

package/src/utils.ts

@@ -0,0 +1,22 @@
+import type { StripeOptions } from "./types";
+
+export async function getPlans(options: StripeOptions) {
+	return typeof options?.subscription?.plans === "function"
+		? await options.subscription?.plans()
+		: options.subscription?.plans;
+}
+
+export async function getPlanByPriceId(
+	options: StripeOptions,
+	priceId: string,
+) {
+	return await getPlans(options).then((res) =>
+		res?.find((plan) => plan.priceId === priceId),
+	);
+}
+
+export async function getPlanByName(options: StripeOptions, name: string) {
+	return await getPlans(options).then((res) =>
+		res?.find((plan) => plan.name.toLowerCase() === name.toLowerCase()),
+	);
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+	"compilerOptions": {
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"target": "es2022",
+		"allowJs": true,
+		"resolveJsonModule": true,
+		"module": "ESNext",
+		"noEmit": true,
+		"moduleResolution": "Bundler",
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"verbatimModuleSyntax": true,
+		"strict": true,
+		"noImplicitOverride": true,
+		"noFallthroughCasesInSwitch": true
+	},
+	"exclude": ["node_modules", "dist"],
+	"include": ["src"]
+}

package/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+	root: ".",
+	test: {
+		clearMocks: true,
+		globals: true,
+		setupFiles: ["dotenv/config"],
+	},
+});