autumn-js 0.1.11 → 0.1.12

package/dist/libraries/react/hooks/useAnalytics.d.mts

@@ -1,9 +1,9 @@
 import * as swr from 'swr';
 import { QueryParams } from '../client/types/clientGenTypes.mjs';
 import { A as AutumnError } from '../error-DHbclCVh.mjs';
-import { Q as QueryResult } from '../genTypes-C_ilxndU.mjs';
+import { Q as QueryResult } from '../genTypes-DdYlVEah.mjs';
 import 'zod/v4';
-import '../prodTypes-B8NdKyKo.mjs';
+import '../prodTypes-C8xRoBP7.mjs';
 
 declare const useAnalytics: (params: QueryParams) => {
     data: ({

package/dist/libraries/react/hooks/useAnalytics.d.ts

@@ -1,9 +1,9 @@
 import * as swr from 'swr';
 import { QueryParams } from '../client/types/clientGenTypes.js';
 import { A as AutumnError } from '../error-DHbclCVh.js';
-import { Q as QueryResult } from '../genTypes-DjcQWIOM.js';
+import { Q as QueryResult } from '../genTypes-aPPwPimh.js';
 import 'zod/v4';
-import '../prodTypes-B8NdKyKo.js';
+import '../prodTypes-C8xRoBP7.js';
 
 declare const useAnalytics: (params: QueryParams) => {
     data: ({

package/dist/libraries/react/hooks/useAnalytics.js

@@ -500,22 +500,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,
@@ -523,6 +593,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,
@@ -530,6 +618,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,
@@ -537,12 +648,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,
@@ -550,6 +699,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/react/hooks/useAnalytics.mjs

@@ -2,14 +2,14 @@
 
 import {
   useAnalytics
-} from "../chunk-VZY225C6.mjs";
-import "../chunk-FDNQ6GRK.mjs";
-import "../chunk-U3OQJXCW.mjs";
-import "../chunk-WYQMHQUE.mjs";
-import "../chunk-CIBQ4BJU.mjs";
+} from "../chunk-ROKCGZ77.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/hooks/useCustomer.d.mts

@@ -1,21 +1,79 @@
 import { UseCustomerParams, UseCustomerResult } from './useCustomerBase.mjs';
 import '../error-DHbclCVh.mjs';
-import '../genTypes-C_ilxndU.mjs';
-import '../prodTypes-B8NdKyKo.mjs';
+import '../genTypes-DdYlVEah.mjs';
+import '../prodTypes-C8xRoBP7.mjs';
 import 'zod/v4';
-import '../attachTypes-C5gcbNrS.mjs';
-import '../entTypes-C1bM1Zpv.mjs';
-import '../cusTypes-CBapqjzm.mjs';
-import '../ReactAutumnClient-IFdMWiu5.mjs';
+import '../attachTypes-Cuxn1ThG.mjs';
+import '../entTypes-D-gn1jj2.mjs';
+import '../cusTypes-B2m4-oz4.mjs';
+import '../ReactAutumnClient-zBxnpPLM.mjs';
 import '../client/types/clientEntTypes.mjs';
 import '../client/types/clientGenTypes.mjs';
 import '../client/types/clientReferralTypes.mjs';
 import 'swr';
 import 'react';
-import './helpers/handleCheck.mjs';
-import '../AutumnContext.mjs';
 import '../client/types/clientAttachTypes.mjs';
 
+/**
+ * React hook for managing customer billing, subscriptions, and feature access.
+ *
+ * Provides access to all Autumn billing functions including product attachment,
+ * subscription management, usage tracking, and feature gating. Automatically
+ * handles customer data fetching and caching.
+ *
+ * @param params - Optional configuration for the hook
+ * @returns Object containing customer data and billing functions
+ *
+ * @example
+ * ```tsx
+ * import { useCustomer } from "autumn-js/react";
+ *
+ * function MyComponent() {
+ *   const {
+ *     customer,
+ *     isLoading,
+ *     attach,
+ *     cancel,
+ *     check,
+ *     track,
+ *     checkout,
+ *     openBillingPortal,
+ *     setupPayment,
+ *     createReferralCode,
+ *     redeemReferralCode,
+ *     createEntity,
+ *     refetch
+ *   } = useCustomer();
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => attach({ productId: "pro" })}>
+ *         Upgrade to Pro
+ *       </button>
+ *       <button onClick={() => cancel({ productId: "pro" })}>
+ *         Cancel Subscription
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @returns {Object} Hook result object
+ * @returns {Customer | null} returns.customer - Current customer data with subscription info
+ * @returns {boolean} returns.isLoading - Whether customer data is loading
+ * @returns {AutumnError | null} returns.error - Any error from customer data fetching
+ * @returns {Function} returns.attach - Attach product to customer with billing
+ * @returns {Function} returns.cancel - Cancel customer subscription/product
+ * @returns {Function} returns.check - Check feature access and show paywalls
+ * @returns {Function} returns.track - Track feature usage events
+ * @returns {Function} returns.checkout - Initiate product checkout flow
+ * @returns {Function} returns.openBillingPortal - Open Stripe billing portal
+ * @returns {Function} returns.setupPayment - Setup payment method
+ * @returns {Function} returns.createReferralCode - Create referral codes
+ * @returns {Function} returns.redeemReferralCode - Redeem referral codes
+ * @returns {Function} returns.createEntity - Create entities for granular tracking
+ * @returns {Function} returns.refetch - Manually refetch customer data
+ */
 declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
 
 export { useCustomer };

package/dist/libraries/react/hooks/useCustomer.d.ts

@@ -1,21 +1,79 @@
 import { UseCustomerParams, UseCustomerResult } from './useCustomerBase.js';
 import '../error-DHbclCVh.js';
-import '../genTypes-DjcQWIOM.js';
-import '../prodTypes-B8NdKyKo.js';
+import '../genTypes-aPPwPimh.js';
+import '../prodTypes-C8xRoBP7.js';
 import 'zod/v4';
-import '../attachTypes-CLK4jfuj.js';
-import '../entTypes-DbIrfEpl.js';
-import '../cusTypes-D13MXEN7.js';
-import '../ReactAutumnClient-CfDtucnL.js';
+import '../attachTypes-BQaZHr5e.js';
+import '../entTypes-WMQRyYAv.js';
+import '../cusTypes-lMnznWYJ.js';
+import '../ReactAutumnClient-CIAkiqwV.js';
 import '../client/types/clientEntTypes.js';
 import '../client/types/clientGenTypes.js';
 import '../client/types/clientReferralTypes.js';
 import 'swr';
 import 'react';
-import './helpers/handleCheck.js';
-import '../AutumnContext.js';
 import '../client/types/clientAttachTypes.js';
 
+/**
+ * React hook for managing customer billing, subscriptions, and feature access.
+ *
+ * Provides access to all Autumn billing functions including product attachment,
+ * subscription management, usage tracking, and feature gating. Automatically
+ * handles customer data fetching and caching.
+ *
+ * @param params - Optional configuration for the hook
+ * @returns Object containing customer data and billing functions
+ *
+ * @example
+ * ```tsx
+ * import { useCustomer } from "autumn-js/react";
+ *
+ * function MyComponent() {
+ *   const {
+ *     customer,
+ *     isLoading,
+ *     attach,
+ *     cancel,
+ *     check,
+ *     track,
+ *     checkout,
+ *     openBillingPortal,
+ *     setupPayment,
+ *     createReferralCode,
+ *     redeemReferralCode,
+ *     createEntity,
+ *     refetch
+ *   } = useCustomer();
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => attach({ productId: "pro" })}>
+ *         Upgrade to Pro
+ *       </button>
+ *       <button onClick={() => cancel({ productId: "pro" })}>
+ *         Cancel Subscription
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
+ * @returns {Object} Hook result object
+ * @returns {Customer | null} returns.customer - Current customer data with subscription info
+ * @returns {boolean} returns.isLoading - Whether customer data is loading
+ * @returns {AutumnError | null} returns.error - Any error from customer data fetching
+ * @returns {Function} returns.attach - Attach product to customer with billing
+ * @returns {Function} returns.cancel - Cancel customer subscription/product
+ * @returns {Function} returns.check - Check feature access and show paywalls
+ * @returns {Function} returns.track - Track feature usage events
+ * @returns {Function} returns.checkout - Initiate product checkout flow
+ * @returns {Function} returns.openBillingPortal - Open Stripe billing portal
+ * @returns {Function} returns.setupPayment - Setup payment method
+ * @returns {Function} returns.createReferralCode - Create referral codes
+ * @returns {Function} returns.redeemReferralCode - Redeem referral codes
+ * @returns {Function} returns.createEntity - Create entities for granular tracking
+ * @returns {Function} returns.refetch - Manually refetch customer data
+ */
 declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
 
 export { useCustomer };