autumn-js 0.1.11 → 0.1.12

package/dist/libraries/react/client/types/clientGenTypes.js

@@ -477,22 +477,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,
@@ -500,6 +570,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,
@@ -507,6 +595,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,
@@ -514,12 +625,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,
@@ -527,6 +676,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,
@@ -742,6 +910,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/react/client/types/clientGenTypes.mjs

@@ -2,7 +2,7 @@
 
 import {
   QueryRangeEnum
-} from "../../chunk-WYQMHQUE.mjs";
+} from "../../chunk-5O3IHYFF.mjs";
 
 // src/libraries/react/client/types/clientGenTypes.ts
 import { z } from "zod/v4";

package/dist/libraries/react/components/checkout-dialog/checkout-dialog-synced.d.mts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React__default from 'react';
-import { C as CheckoutResult } from '../../attachTypes-C5gcbNrS.mjs';
-import '../../prodTypes-B8NdKyKo.mjs';
+import { C as CheckoutResult } from '../../attachTypes-Cuxn1ThG.mjs';
+import '../../prodTypes-C8xRoBP7.mjs';
 import 'zod/v4';
 
 interface CheckoutDialogProps {

package/dist/libraries/react/components/checkout-dialog/checkout-dialog-synced.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React__default from 'react';
-import { C as CheckoutResult } from '../../attachTypes-CLK4jfuj.js';
-import '../../prodTypes-B8NdKyKo.js';
+import { C as CheckoutResult } from '../../attachTypes-BQaZHr5e.js';
+import '../../prodTypes-C8xRoBP7.js';
 import 'zod/v4';
 
 interface CheckoutDialogProps {

package/dist/libraries/react/components/checkout-dialog/checkout-dialog-synced.js

@@ -6088,22 +6088,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,
@@ -6111,6 +6181,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,
@@ -6118,6 +6206,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,
@@ -6125,12 +6236,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,
@@ -6138,6 +6287,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,
@@ -6353,6 +6521,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(),
@@ -7052,7 +7222,6 @@ var useAutumnBase = ({
   };
   return {
     attach,
-    // check,
     track,
     cancel,
     openBillingPortal,
@@ -7272,16 +7441,6 @@ var useCustomerBase = ({
         context
       });
       return res;
-    },
-    /** @deprecated Use check() instead */
-    allowed: (params2) => {
-      const result = handleCheck2({
-        customer,
-        params: params2,
-        isEntity: false,
-        context
-      });
-      return result.data.allowed;
     }
   };
 };

package/dist/libraries/react/components/checkout-dialog/checkout-dialog-synced.mjs

@@ -5,44 +5,44 @@ import {
   CheckoutDialog,
   PriceItem,
   PricingDialogButton
-} from "../../chunk-JHFJKAXG.mjs";
+} from "../../chunk-7A2PZDUO.mjs";
 import "../../chunk-URQMBRFZ.mjs";
+import "../../chunk-GUM4HIGI.mjs";
+import "../../chunk-OTZ65PCT.mjs";
+import "../../chunk-YWQTQ72B.mjs";
+import "../../chunk-KUS3X33V.mjs";
+import "../../chunk-BLM4DAAR.mjs";
+import "../../chunk-I5ZGIAIX.mjs";
 import "../../chunk-JGDTNJTR.mjs";
 import "../../chunk-EV5RNY5U.mjs";
-import "../../chunk-7JNU5ABT.mjs";
-import "../../chunk-QJPZFEVW.mjs";
-import "../../chunk-GUM4HIGI.mjs";
-import "../../chunk-LCWL3TIT.mjs";
+import "../../chunk-FJWZPMWU.mjs";
 import "../../chunk-FEISQQNM.mjs";
+import "../../chunk-QJPZFEVW.mjs";
 import "../../chunk-I2A7PK2L.mjs";
-import "../../chunk-YWQTQ72B.mjs";
-import "../../chunk-KUS3X33V.mjs";
 import "../../chunk-7TYAAD2T.mjs";
 import "../../chunk-RPEGNKJH.mjs";
-import "../../chunk-BLM4DAAR.mjs";
-import "../../chunk-I5ZGIAIX.mjs";
-import "../../chunk-VZY225C6.mjs";
-import "../../chunk-4NZ7ML7V.mjs";
-import "../../chunk-KP2Q65Y3.mjs";
-import "../../chunk-2ENHPIYQ.mjs";
-import "../../chunk-3MF54MDU.mjs";
-import "../../chunk-67RWFVWN.mjs";
-import "../../chunk-4J6OC4ZQ.mjs";
 import "../../chunk-WVKYZYFT.mjs";
-import "../../chunk-TTLL63A4.mjs";
-import "../../chunk-OMJJLT2Q.mjs";
+import "../../chunk-CMUWZZWV.mjs";
+import "../../chunk-RK4NRHHQ.mjs";
+import "../../chunk-5RTUQSYZ.mjs";
+import "../../chunk-HNIU2WNT.mjs";
+import "../../chunk-4J6OC4ZQ.mjs";
+import "../../chunk-ROKCGZ77.mjs";
+import "../../chunk-26K62U62.mjs";
+import "../../chunk-QNMB7QR6.mjs";
+import "../../chunk-VGNA76RG.mjs";
 import "../../chunk-RFSQBGLO.mjs";
-import "../../chunk-XK3AXQED.mjs";
-import "../../chunk-KMYL54B4.mjs";
-import "../../chunk-6D6TYTTO.mjs";
-import "../../chunk-YHT2JUXO.mjs";
-import "../../chunk-FDNQ6GRK.mjs";
-import "../../chunk-U3OQJXCW.mjs";
-import "../../chunk-WYQMHQUE.mjs";
-import "../../chunk-CIBQ4BJU.mjs";
+import "../../chunk-6X76WFOV.mjs";
+import "../../chunk-DKOF357C.mjs";
+import "../../chunk-P6CAHZVT.mjs";
+import "../../chunk-7HRCOEUW.mjs";
+import "../../chunk-TE2MOBO7.mjs";
+import "../../chunk-JTYEHM27.mjs";
+import "../../chunk-5O3IHYFF.mjs";
 import "../../chunk-V575SGOW.mjs";
 import "../../chunk-ZV4RPZTM.mjs";
 import "../../chunk-JVCOY7ZL.mjs";
+import "../../chunk-CIBQ4BJU.mjs";
 import "../../chunk-VTGR7VVK.mjs";
 import "../../chunk-WFFVOEUG.mjs";
 import "../../chunk-ZF2HUCN6.mjs";

package/dist/libraries/react/components/checkout-dialog/lib/checkout-content.d.mts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as CheckoutResult } from '../../../attachTypes-C5gcbNrS.mjs';
-import '../../../prodTypes-B8NdKyKo.mjs';
+import { C as CheckoutResult } from '../../../attachTypes-Cuxn1ThG.mjs';
+import '../../../prodTypes-C8xRoBP7.mjs';
 import 'zod/v4';
 
 declare const getCheckoutContent: (checkoutResult: CheckoutResult) => {

package/dist/libraries/react/components/checkout-dialog/lib/checkout-content.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { C as CheckoutResult } from '../../../attachTypes-CLK4jfuj.js';
-import '../../../prodTypes-B8NdKyKo.js';
+import { C as CheckoutResult } from '../../../attachTypes-BQaZHr5e.js';
+import '../../../prodTypes-C8xRoBP7.js';
 import 'zod/v4';
 
 declare const getCheckoutContent: (checkoutResult: CheckoutResult) => {

package/dist/libraries/react/components/paywall-dialog/lib/paywall-content.d.mts

@@ -1,4 +1,4 @@
-import { C as CheckFeaturePreview } from '../../../prodTypes-B8NdKyKo.mjs';
+import { C as CheckFeaturePreview } from '../../../prodTypes-C8xRoBP7.mjs';
 import 'zod/v4';
 
 declare const getPaywallContent: (preview?: CheckFeaturePreview) => {

package/dist/libraries/react/components/paywall-dialog/lib/paywall-content.d.ts

@@ -1,4 +1,4 @@
-import { C as CheckFeaturePreview } from '../../../prodTypes-B8NdKyKo.js';
+import { C as CheckFeaturePreview } from '../../../prodTypes-C8xRoBP7.js';
 import 'zod/v4';
 
 declare const getPaywallContent: (preview?: CheckFeaturePreview) => {