autumn-js 0.1.11 → 0.1.13

package/dist/libraries/backend/better-auth.d.mts

@@ -98,6 +98,7 @@ declare const autumn: (options?: {
                         quantity: number;
                     }[] | undefined;
                     success_url?: string | undefined;
+                    force_checkout?: boolean | undefined;
                     customer_data?: {
                         name?: string | null | undefined;
                         email?: string | null | undefined;
@@ -106,6 +107,7 @@ declare const autumn: (options?: {
                     entity_data?: any;
                     checkout_session_params?: Record<string, any> | undefined;
                     reward?: string | undefined;
+                    invoice?: boolean | undefined;
                 };
             } & {
                 method?: "POST" | undefined;
@@ -139,6 +141,7 @@ declare const autumn: (options?: {
                         quantity: z.ZodNumber;
                     }, z.core.$strip>>>;
                     success_url: z.ZodOptional<z.ZodString>;
+                    force_checkout: z.ZodOptional<z.ZodBoolean>;
                     customer_data: z.ZodOptional<z.ZodObject<{
                         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                         email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -147,6 +150,7 @@ declare const autumn: (options?: {
                     entity_data: z.ZodOptional<z.ZodAny>;
                     checkout_session_params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
                     reward: z.ZodOptional<z.ZodString>;
+                    invoice: z.ZodOptional<z.ZodBoolean>;
                 }, z.core.$strip>;
                 use: ((inputContext: better_auth.MiddlewareInputContext<better_auth.MiddlewareOptions>) => Promise<{
                     session: {

package/dist/libraries/backend/better-auth.d.ts

@@ -98,6 +98,7 @@ declare const autumn: (options?: {
                         quantity: number;
                     }[] | undefined;
                     success_url?: string | undefined;
+                    force_checkout?: boolean | undefined;
                     customer_data?: {
                         name?: string | null | undefined;
                         email?: string | null | undefined;
@@ -106,6 +107,7 @@ declare const autumn: (options?: {
                     entity_data?: any;
                     checkout_session_params?: Record<string, any> | undefined;
                     reward?: string | undefined;
+                    invoice?: boolean | undefined;
                 };
             } & {
                 method?: "POST" | undefined;
@@ -139,6 +141,7 @@ declare const autumn: (options?: {
                         quantity: z.ZodNumber;
                     }, z.core.$strip>>>;
                     success_url: z.ZodOptional<z.ZodString>;
+                    force_checkout: z.ZodOptional<z.ZodBoolean>;
                     customer_data: z.ZodOptional<z.ZodObject<{
                         name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                         email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -147,6 +150,7 @@ declare const autumn: (options?: {
                     entity_data: z.ZodOptional<z.ZodAny>;
                     checkout_session_params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
                     reward: z.ZodOptional<z.ZodString>;
+                    invoice: z.ZodOptional<z.ZodBoolean>;
                 }, z.core.$strip>;
                 use: ((inputContext: better_auth.MiddlewareInputContext<better_auth.MiddlewareOptions>) => Promise<{
                     session: {

package/dist/libraries/backend/better-auth.js

@@ -476,22 +476,92 @@ var Autumn = class {
   entities = entityMethods(this);
   referrals = referralMethods(this);
   features = featureMethods(this);
-  static checkout = (params) => staticWrapper(handleCheckout, void 0, { params });
+  /**
+   * Initiates a checkout flow for a product purchase.
+   * 
+   * The checkout function handles the purchase process for products with pricing.
+   * It determines whether to show a dialog for user input or redirect directly
+   * to Stripe based on the customer's state and product requirements.
+   * 
+   * @param params - Checkout parameters including product ID, customer data, and options
+   * @returns Promise resolving to checkout details including pricing, prorations, and URLs
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.checkout({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   success_url: "https://myapp.com/success"
+   * });
+   * 
+   * if (result.url) {
+   *   // Redirect to Stripe checkout
+   *   window.location.href = result.url;
+   * }
+   * ```
+   */
   async checkout(params) {
     return handleCheckout({
       instance: this,
       params
     });
   }
-  static attach = (params) => staticWrapper(handleAttach, void 0, { params });
+  static checkout = (params) => staticWrapper(handleCheckout, void 0, { params });
   static usage = (params) => staticWrapper(handleUsage, void 0, { params });
+  /**
+   * Attaches a product to a customer, enabling access and handling billing.
+   * 
+   * The attach function activates a product for a customer and applies all product items.
+   * When you attach a product:
+   * - The customer gains access to all features in the product
+   * - If the product has prices, the customer will be billed accordingly  
+   * - If there's no existing payment method, a checkout URL will be generated
+   * 
+   * @param params - Attach parameters including customer ID, product ID, and options
+   * @returns Promise resolving to attachment result with checkout URL if needed
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.attach({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   success_url: "https://myapp.com/success"
+   * });
+   * 
+   * if (result.checkout_url) {
+   *   // Payment required - redirect to checkout
+   *   window.location.href = result.checkout_url;
+   * } else {
+   *   // Product successfully attached
+   *   console.log("Access granted:", result.message);
+   * }
+   * ```
+   */
   async attach(params) {
     return handleAttach({
       instance: this,
       params
     });
   }
+  static attach = (params) => staticWrapper(handleAttach, void 0, { params });
   static setupPayment = (params) => staticWrapper(handleSetupPayment, void 0, { params });
+  /**
+   * Sets up a payment method for a customer.
+   * 
+   * This method allows you to set up payment methods for customers without 
+   * immediately charging them. Useful for collecting payment information
+   * before product attachment or for updating existing payment methods.
+   * 
+   * @param params - Setup payment parameters including customer information
+   * @returns Promise resolving to setup payment result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.setupPayment({
+   *   customer_id: "user_123"
+   * });
+   * ```
+   */
   async setupPayment(params) {
     return handleSetupPayment({
       instance: this,
@@ -499,6 +569,24 @@ var Autumn = class {
     });
   }
   static cancel = (params) => staticWrapper(handleCancel, void 0, { params });
+  /**
+   * Cancels a customer's subscription or product attachment.
+   * 
+   * This method allows you to cancel a customer's subscription to a specific product.
+   * You can choose to cancel immediately or at the end of the billing cycle.
+   * 
+   * @param params - Cancel parameters including customer ID and product ID
+   * @returns Promise resolving to cancellation result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.cancel({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   cancel_immediately: false // Cancel at end of billing cycle
+   * });
+   * ```
+   */
   async cancel(params) {
     return handleCancel({
       instance: this,
@@ -506,6 +594,29 @@ var Autumn = class {
     });
   }
   static check = (params) => staticWrapper(handleCheck, void 0, { params });
+  /**
+   * Checks if a customer has access to a specific feature.
+   * 
+   * This method verifies whether a customer has permission to use a feature
+   * and checks their remaining balance/usage limits. It can be used to gate
+   * features and determine when to show upgrade prompts.
+   * 
+   * @param params - Check parameters including customer ID and feature ID
+   * @returns Promise resolving to access check result with allowed status and balance info
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.check({
+   *   customer_id: "user_123",
+   *   feature_id: "messages",
+   *   required_balance: 1
+   * });
+   * 
+   * if (!result.allowed) {
+   *   console.log("Feature access denied - upgrade required");
+   * }
+   * ```
+   */
   async check(params) {
     return handleCheck({
       instance: this,
@@ -513,12 +624,50 @@ var Autumn = class {
     });
   }
   static track = (params) => staticWrapper(handleTrack, void 0, { params });
+  /**
+   * Tracks usage events for features or analytics.
+   * 
+   * This method records usage events for metered features, updating the customer's
+   * balance and usage statistics. It's typically used server-side to ensure
+   * accurate tracking that cannot be manipulated by users.
+   * 
+   * @param params - Track parameters including customer ID, feature ID, and usage value
+   * @returns Promise resolving to tracking result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.track({
+   *   customer_id: "user_123",
+   *   feature_id: "messages",
+   *   value: 1 // Track 1 message sent
+   * });
+   * ```
+   */
   async track(params) {
     return handleTrack({
       instance: this,
       params
     });
   }
+  /**
+   * Retrieves usage statistics and analytics for a customer.
+   * 
+   * This method fetches detailed usage information for a customer's features,
+   * including current balances, usage history, and analytics data. Useful
+   * for displaying usage dashboards or generating reports.
+   * 
+   * @param params - Usage parameters including customer ID and optional filters
+   * @returns Promise resolving to usage statistics and analytics data
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.usage({
+   *   customer_id: "user_123",
+   *   feature_id: "messages" 
+   *   value: 20 // Usage value
+   * });
+   * ```
+   */
   async usage(params) {
     return handleUsage({
       instance: this,
@@ -526,6 +675,25 @@ var Autumn = class {
     });
   }
   static query = (params) => staticWrapper(handleQuery, void 0, { params });
+  /**
+   * Performs advanced queries on customer data and analytics.
+   * 
+   * This method allows you to run complex queries against customer data,
+   * usage patterns, and billing information. Useful for generating reports,
+   * analytics, and custom data insights.
+   * 
+   * @param params - Query parameters including customer ID and query specifications
+   * @returns Promise resolving to query results with requested data
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.query({
+   *   customer_id: "user_123",
+   *   feature_id: "messages" // feature id to fetch for query, can also be an array
+   * });
+   * 
+   * ```
+   */
   async query(params) {
     return handleQuery({
       instance: this,
@@ -765,6 +933,8 @@ var CheckoutParamsSchema = import_v47.z.object({
   product_id: import_v47.z.string(),
   entity_id: import_v47.z.string().optional(),
   options: import_v47.z.array(AttachFeatureOptionsSchema).optional(),
+  force_checkout: import_v47.z.boolean().optional(),
+  invoice: import_v47.z.boolean().optional(),
   success_url: import_v47.z.string().optional(),
   customer_data: CustomerDataSchema.optional(),
   entity_data: import_v47.z.any().optional(),

package/dist/libraries/backend/better-auth.mjs

@@ -3,12 +3,12 @@ import {
 } from "./chunk-UNZHJTEY.mjs";
 import {
   createRouterWithOptions
-} from "./chunk-RAHKKJED.mjs";
-import "./chunk-VNJ3MFJE.mjs";
-import "./chunk-7K3RATTK.mjs";
-import "./chunk-EW2R7722.mjs";
-import "./chunk-P3ARLB2M.mjs";
-import "./chunk-5DDCZMDB.mjs";
+} from "./chunk-NWPFUFXX.mjs";
+import "./chunk-56RGUNOT.mjs";
+import "./chunk-SDL7BFTH.mjs";
+import "./chunk-2DWGCQCF.mjs";
+import "./chunk-6JI6MF4S.mjs";
+import "./chunk-FA5Z2MOT.mjs";
 import {
   AttachParamsSchema,
   Autumn,
@@ -20,7 +20,7 @@ import {
   CustomerExpandEnum,
   RedeemReferralCodeParamsSchema,
   TrackParamsSchema
-} from "./chunk-NAP2URIW.mjs";
+} from "./chunk-Q7SD535L.mjs";
 import "./chunk-2TEL6LR5.mjs";
 import "./chunk-KSG3E4Q2.mjs";
 

package/dist/libraries/backend/{chunk-EW2R7722.mjs → chunk-2DWGCQCF.mjs}

@@ -1,6 +1,6 @@
 import {
   withAuth
-} from "./chunk-5DDCZMDB.mjs";
+} from "./chunk-FA5Z2MOT.mjs";
 import {
   BASE_PATH
 } from "./chunk-KSG3E4Q2.mjs";

package/dist/libraries/backend/{chunk-VNJ3MFJE.mjs → chunk-56RGUNOT.mjs}

@@ -1,6 +1,6 @@
 import {
   withAuth
-} from "./chunk-5DDCZMDB.mjs";
+} from "./chunk-FA5Z2MOT.mjs";
 import {
   BASE_PATH
 } from "./chunk-KSG3E4Q2.mjs";

package/dist/libraries/backend/{chunk-P3ARLB2M.mjs → chunk-6JI6MF4S.mjs}

@@ -1,6 +1,6 @@
 import {
   withAuth
-} from "./chunk-5DDCZMDB.mjs";
+} from "./chunk-FA5Z2MOT.mjs";
 
 // src/libraries/backend/routes/entityRoutes.ts
 import { addRoute } from "rou3";

package/dist/libraries/backend/{chunk-5DDCZMDB.mjs → chunk-FA5Z2MOT.mjs}

@@ -1,7 +1,7 @@
 import {
   toBackendError,
   toBackendRes
-} from "./chunk-NAP2URIW.mjs";
+} from "./chunk-Q7SD535L.mjs";
 import {
   logger
 } from "./chunk-2TEL6LR5.mjs";

package/dist/libraries/backend/{chunk-RAHKKJED.mjs → chunk-NWPFUFXX.mjs}

@@ -1,21 +1,21 @@
 import {
   addGenRoutes
-} from "./chunk-VNJ3MFJE.mjs";
+} from "./chunk-56RGUNOT.mjs";
 import {
   addProductRoutes
-} from "./chunk-7K3RATTK.mjs";
+} from "./chunk-SDL7BFTH.mjs";
 import {
   addReferralRoutes
-} from "./chunk-EW2R7722.mjs";
+} from "./chunk-2DWGCQCF.mjs";
 import {
   addEntityRoutes
-} from "./chunk-P3ARLB2M.mjs";
+} from "./chunk-6JI6MF4S.mjs";
 import {
   withAuth
-} from "./chunk-5DDCZMDB.mjs";
+} from "./chunk-FA5Z2MOT.mjs";
 import {
   fetchPricingTable
-} from "./chunk-NAP2URIW.mjs";
+} from "./chunk-Q7SD535L.mjs";
 import {
   BASE_PATH
 } from "./chunk-KSG3E4Q2.mjs";

package/dist/libraries/backend/{chunk-NAP2URIW.mjs → chunk-Q7SD535L.mjs}

@@ -413,22 +413,92 @@ var Autumn = class {
   entities = entityMethods(this);
   referrals = referralMethods(this);
   features = featureMethods(this);
-  static checkout = (params) => staticWrapper(handleCheckout, void 0, { params });
+  /**
+   * Initiates a checkout flow for a product purchase.
+   * 
+   * The checkout function handles the purchase process for products with pricing.
+   * It determines whether to show a dialog for user input or redirect directly
+   * to Stripe based on the customer's state and product requirements.
+   * 
+   * @param params - Checkout parameters including product ID, customer data, and options
+   * @returns Promise resolving to checkout details including pricing, prorations, and URLs
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.checkout({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   success_url: "https://myapp.com/success"
+   * });
+   * 
+   * if (result.url) {
+   *   // Redirect to Stripe checkout
+   *   window.location.href = result.url;
+   * }
+   * ```
+   */
   async checkout(params) {
     return handleCheckout({
       instance: this,
       params
     });
   }
-  static attach = (params) => staticWrapper(handleAttach, void 0, { params });
+  static checkout = (params) => staticWrapper(handleCheckout, void 0, { params });
   static usage = (params) => staticWrapper(handleUsage, void 0, { params });
+  /**
+   * Attaches a product to a customer, enabling access and handling billing.
+   * 
+   * The attach function activates a product for a customer and applies all product items.
+   * When you attach a product:
+   * - The customer gains access to all features in the product
+   * - If the product has prices, the customer will be billed accordingly  
+   * - If there's no existing payment method, a checkout URL will be generated
+   * 
+   * @param params - Attach parameters including customer ID, product ID, and options
+   * @returns Promise resolving to attachment result with checkout URL if needed
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.attach({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   success_url: "https://myapp.com/success"
+   * });
+   * 
+   * if (result.checkout_url) {
+   *   // Payment required - redirect to checkout
+   *   window.location.href = result.checkout_url;
+   * } else {
+   *   // Product successfully attached
+   *   console.log("Access granted:", result.message);
+   * }
+   * ```
+   */
   async attach(params) {
     return handleAttach({
       instance: this,
       params
     });
   }
+  static attach = (params) => staticWrapper(handleAttach, void 0, { params });
   static setupPayment = (params) => staticWrapper(handleSetupPayment, void 0, { params });
+  /**
+   * Sets up a payment method for a customer.
+   * 
+   * This method allows you to set up payment methods for customers without 
+   * immediately charging them. Useful for collecting payment information
+   * before product attachment or for updating existing payment methods.
+   * 
+   * @param params - Setup payment parameters including customer information
+   * @returns Promise resolving to setup payment result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.setupPayment({
+   *   customer_id: "user_123"
+   * });
+   * ```
+   */
   async setupPayment(params) {
     return handleSetupPayment({
       instance: this,
@@ -436,6 +506,24 @@ var Autumn = class {
     });
   }
   static cancel = (params) => staticWrapper(handleCancel, void 0, { params });
+  /**
+   * Cancels a customer's subscription or product attachment.
+   * 
+   * This method allows you to cancel a customer's subscription to a specific product.
+   * You can choose to cancel immediately or at the end of the billing cycle.
+   * 
+   * @param params - Cancel parameters including customer ID and product ID
+   * @returns Promise resolving to cancellation result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.cancel({
+   *   customer_id: "user_123",
+   *   product_id: "pro",
+   *   cancel_immediately: false // Cancel at end of billing cycle
+   * });
+   * ```
+   */
   async cancel(params) {
     return handleCancel({
       instance: this,
@@ -443,6 +531,29 @@ var Autumn = class {
     });
   }
   static check = (params) => staticWrapper(handleCheck, void 0, { params });
+  /**
+   * Checks if a customer has access to a specific feature.
+   * 
+   * This method verifies whether a customer has permission to use a feature
+   * and checks their remaining balance/usage limits. It can be used to gate
+   * features and determine when to show upgrade prompts.
+   * 
+   * @param params - Check parameters including customer ID and feature ID
+   * @returns Promise resolving to access check result with allowed status and balance info
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.check({
+   *   customer_id: "user_123",
+   *   feature_id: "messages",
+   *   required_balance: 1
+   * });
+   * 
+   * if (!result.allowed) {
+   *   console.log("Feature access denied - upgrade required");
+   * }
+   * ```
+   */
   async check(params) {
     return handleCheck({
       instance: this,
@@ -450,12 +561,50 @@ var Autumn = class {
     });
   }
   static track = (params) => staticWrapper(handleTrack, void 0, { params });
+  /**
+   * Tracks usage events for features or analytics.
+   * 
+   * This method records usage events for metered features, updating the customer's
+   * balance and usage statistics. It's typically used server-side to ensure
+   * accurate tracking that cannot be manipulated by users.
+   * 
+   * @param params - Track parameters including customer ID, feature ID, and usage value
+   * @returns Promise resolving to tracking result
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.track({
+   *   customer_id: "user_123",
+   *   feature_id: "messages",
+   *   value: 1 // Track 1 message sent
+   * });
+   * ```
+   */
   async track(params) {
     return handleTrack({
       instance: this,
       params
     });
   }
+  /**
+   * Retrieves usage statistics and analytics for a customer.
+   * 
+   * This method fetches detailed usage information for a customer's features,
+   * including current balances, usage history, and analytics data. Useful
+   * for displaying usage dashboards or generating reports.
+   * 
+   * @param params - Usage parameters including customer ID and optional filters
+   * @returns Promise resolving to usage statistics and analytics data
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.usage({
+   *   customer_id: "user_123",
+   *   feature_id: "messages" 
+   *   value: 20 // Usage value
+   * });
+   * ```
+   */
   async usage(params) {
     return handleUsage({
       instance: this,
@@ -463,6 +612,25 @@ var Autumn = class {
     });
   }
   static query = (params) => staticWrapper(handleQuery, void 0, { params });
+  /**
+   * Performs advanced queries on customer data and analytics.
+   * 
+   * This method allows you to run complex queries against customer data,
+   * usage patterns, and billing information. Useful for generating reports,
+   * analytics, and custom data insights.
+   * 
+   * @param params - Query parameters including customer ID and query specifications
+   * @returns Promise resolving to query results with requested data
+   * 
+   * @example
+   * ```typescript
+   * const result = await autumn.query({
+   *   customer_id: "user_123",
+   *   feature_id: "messages" // feature id to fetch for query, can also be an array
+   * });
+   * 
+   * ```
+   */
   async query(params) {
     return handleQuery({
       instance: this,
@@ -702,6 +870,8 @@ var CheckoutParamsSchema = z7.object({
   product_id: z7.string(),
   entity_id: z7.string().optional(),
   options: z7.array(AttachFeatureOptionsSchema).optional(),
+  force_checkout: z7.boolean().optional(),
+  invoice: z7.boolean().optional(),
   success_url: z7.string().optional(),
   customer_data: CustomerDataSchema.optional(),
   entity_data: z7.any().optional(),

package/dist/libraries/backend/{chunk-7K3RATTK.mjs → chunk-SDL7BFTH.mjs}

@@ -1,6 +1,6 @@
 import {
   withAuth
-} from "./chunk-5DDCZMDB.mjs";
+} from "./chunk-FA5Z2MOT.mjs";
 import {
   BASE_PATH
 } from "./chunk-KSG3E4Q2.mjs";