autumn-js 0.1.10 → 0.1.12

package/dist/libraries/react/index.mjs

@@ -512,22 +512,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,
@@ -535,6 +605,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,
@@ -542,6 +630,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,
@@ -549,12 +660,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,
@@ -562,6 +711,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,
@@ -585,7 +753,7 @@ var ProductItemInterval = /* @__PURE__ */ ((ProductItemInterval2) => {
 })(ProductItemInterval || {});
 
 // src/sdk/customers/cusEnums.ts
-import { z } from "zod";
+import { z } from "zod/v4";
 var CustomerExpandEnum = z.enum([
   "invoices",
   "rewards",
@@ -596,10 +764,10 @@ var CustomerExpandEnum = z.enum([
 ]);
 
 // src/sdk/customers/cusTypes.ts
-import { z as z2 } from "zod";
+import { z as z2 } from "zod/v4";
 var CoreCusFeatureSchema = z2.object({
   unlimited: z2.boolean().optional(),
-  interval: z2.nativeEnum(ProductItemInterval).optional(),
+  interval: z2.enum(ProductItemInterval).optional(),
   balance: z2.number().nullish(),
   usage: z2.number().optional(),
   included_usage: z2.number().optional(),
@@ -612,7 +780,7 @@ var CoreCusFeatureSchema = z2.object({
   }).optional(),
   breakdown: z2.array(
     z2.object({
-      interval: z2.nativeEnum(ProductItemInterval),
+      interval: z2.enum(ProductItemInterval),
       balance: z2.number().optional(),
       usage: z2.number().optional(),
       included_usage: z2.number().optional(),
@@ -636,7 +804,7 @@ var CreateCustomerParamsSchema = z2.object({
   email: z2.string().nullish(),
   name: z2.string().nullish(),
   fingerprint: z2.string().nullish(),
-  metadata: z2.record(z2.any()).optional(),
+  metadata: z2.record(z2.string(), z2.any()).optional(),
   expand: z2.array(CustomerExpandEnum).optional()
 });
 var BillingPortalParamsSchema = z2.object({
@@ -655,7 +823,7 @@ var UpdateBalancesParamsSchema = z2.object({
 );
 
 // src/sdk/general/checkTypes.ts
-import { z as z3 } from "zod";
+import { z as z3 } from "zod/v4";
 var CheckFeatureResultSchema = z3.object({
   allowed: z3.boolean(),
   feature_id: z3.string(),
@@ -665,7 +833,7 @@ var CheckFeatureResultSchema = z3.object({
 }).extend(CoreCusFeatureSchema.shape);
 
 // src/sdk/customers/entities/entTypes.ts
-import { z as z4 } from "zod";
+import { z as z4 } from "zod/v4";
 var EntityDataSchema = z4.object({
   name: z4.string().optional(),
   feature_id: z4.string()
@@ -677,7 +845,7 @@ var TransferProductParamsSchema = z4.object({
 });
 
 // src/sdk/general/genTypes.ts
-import { z as z5 } from "zod";
+import { z as z5 } from "zod/v4";
 var CancelParamsSchema = z5.object({
   customer_id: z5.string(),
   product_id: z5.string(),
@@ -725,7 +893,7 @@ var QueryParamsSchema = z5.object({
 });
 
 // src/sdk/referrals/referralTypes.ts
-import { z as z6 } from "zod";
+import { z as z6 } from "zod/v4";
 var CreateReferralCodeParamsSchema = z6.object({
   customer_id: z6.string(),
   program_id: z6.string()
@@ -736,7 +904,7 @@ var RedeemReferralCodeParamsSchema = z6.object({
 });
 
 // src/sdk/general/attachTypes.ts
-import { z as z7 } from "zod";
+import { z as z7 } from "zod/v4";
 var AttachFeatureOptionsSchema = z7.object({
   feature_id: z7.string(),
   quantity: z7.number()
@@ -749,11 +917,11 @@ var AttachParamsSchema = z7.object({
   product_ids: z7.array(z7.string()).optional(),
   free_trial: z7.boolean().optional(),
   success_url: z7.string().optional(),
-  metadata: z7.record(z7.string()).optional(),
+  metadata: z7.record(z7.string(), z7.string()).optional(),
   force_checkout: z7.boolean().optional(),
   customer_data: CustomerDataSchema.optional(),
   entity_data: z7.any().optional(),
-  checkout_session_params: z7.record(z7.any()).optional(),
+  checkout_session_params: z7.record(z7.string(), z7.any()).optional(),
   reward: z7.string().optional(),
   invoice: z7.boolean().optional()
 });
@@ -777,10 +945,12 @@ 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(),
-  checkout_session_params: z7.record(z7.any()).optional(),
+  checkout_session_params: z7.record(z7.string(), z7.any()).optional(),
   reward: z7.string().optional()
 });
 
@@ -1476,7 +1646,6 @@ var useAutumnBase = ({
   };
   return {
     attach,
-    // check,
     track,
     cancel,
     openBillingPortal,
@@ -1696,16 +1865,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/{prodTypes-Bmoibf-M.d.ts → prodTypes-C8xRoBP7.d.mts}

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from 'zod/v4';
 
 declare const Infinite = "inf";
 declare enum FreeTrialDuration {
@@ -29,9 +29,8 @@ declare const CheckFeatureResultSchema: z.ZodObject<{
     customer_id: z.ZodString;
     entity_id: z.ZodOptional<z.ZodString>;
     required_balance: z.ZodNumber;
-} & {
     unlimited: z.ZodOptional<z.ZodBoolean>;
-    interval: z.ZodOptional<z.ZodNativeEnum<typeof ProductItemInterval>>;
+    interval: z.ZodOptional<z.ZodEnum<typeof ProductItemInterval>>;
     balance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     usage: z.ZodOptional<z.ZodNumber>;
     included_usage: z.ZodOptional<z.ZodNumber>;
@@ -41,101 +40,19 @@ declare const CheckFeatureResultSchema: z.ZodObject<{
     rollovers: z.ZodOptional<z.ZodObject<{
         balance: z.ZodNumber;
         expires_at: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        balance: number;
-        expires_at: number;
-    }, {
-        balance: number;
-        expires_at: number;
-    }>>;
+    }, z.core.$strip>>;
     breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        interval: z.ZodNativeEnum<typeof ProductItemInterval>;
+        interval: z.ZodEnum<typeof ProductItemInterval>;
         balance: z.ZodOptional<z.ZodNumber>;
         usage: z.ZodOptional<z.ZodNumber>;
         included_usage: z.ZodOptional<z.ZodNumber>;
         next_reset_at: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }, {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
         feature_id: z.ZodString;
         credit_amount: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        feature_id: string;
-        credit_amount: number;
-    }, {
-        feature_id: string;
-        credit_amount: number;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    customer_id: string;
-    allowed: boolean;
-    feature_id: string;
-    required_balance: number;
-    entity_id?: string | undefined;
-    unlimited?: boolean | undefined;
-    interval?: ProductItemInterval | undefined;
-    balance?: number | null | undefined;
-    usage?: number | undefined;
-    included_usage?: number | undefined;
-    next_reset_at?: number | null | undefined;
-    overage_allowed?: boolean | undefined;
-    usage_limit?: number | undefined;
-    rollovers?: {
-        balance: number;
-        expires_at: number;
-    } | undefined;
-    breakdown?: {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }[] | undefined;
-    credit_schema?: {
-        feature_id: string;
-        credit_amount: number;
-    }[] | undefined;
-}, {
-    customer_id: string;
-    allowed: boolean;
-    feature_id: string;
-    required_balance: number;
-    entity_id?: string | undefined;
-    unlimited?: boolean | undefined;
-    interval?: ProductItemInterval | undefined;
-    balance?: number | null | undefined;
-    usage?: number | undefined;
-    included_usage?: number | undefined;
-    next_reset_at?: number | null | undefined;
-    overage_allowed?: boolean | undefined;
-    usage_limit?: number | undefined;
-    rollovers?: {
-        balance: number;
-        expires_at: number;
-    } | undefined;
-    breakdown?: {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }[] | undefined;
-    credit_schema?: {
-        feature_id: string;
-        credit_amount: number;
-    }[] | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 type CheckFeatureResult = z.infer<typeof CheckFeatureResultSchema>;
 interface CheckFeaturePreview {
     scenario: CheckFeatureScenario;

package/dist/libraries/react/{prodTypes-Bmoibf-M.d.mts → prodTypes-C8xRoBP7.d.ts}

@@ -1,4 +1,4 @@
-import { z } from 'zod';
+import { z } from 'zod/v4';
 
 declare const Infinite = "inf";
 declare enum FreeTrialDuration {
@@ -29,9 +29,8 @@ declare const CheckFeatureResultSchema: z.ZodObject<{
     customer_id: z.ZodString;
     entity_id: z.ZodOptional<z.ZodString>;
     required_balance: z.ZodNumber;
-} & {
     unlimited: z.ZodOptional<z.ZodBoolean>;
-    interval: z.ZodOptional<z.ZodNativeEnum<typeof ProductItemInterval>>;
+    interval: z.ZodOptional<z.ZodEnum<typeof ProductItemInterval>>;
     balance: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     usage: z.ZodOptional<z.ZodNumber>;
     included_usage: z.ZodOptional<z.ZodNumber>;
@@ -41,101 +40,19 @@ declare const CheckFeatureResultSchema: z.ZodObject<{
     rollovers: z.ZodOptional<z.ZodObject<{
         balance: z.ZodNumber;
         expires_at: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        balance: number;
-        expires_at: number;
-    }, {
-        balance: number;
-        expires_at: number;
-    }>>;
+    }, z.core.$strip>>;
     breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        interval: z.ZodNativeEnum<typeof ProductItemInterval>;
+        interval: z.ZodEnum<typeof ProductItemInterval>;
         balance: z.ZodOptional<z.ZodNumber>;
         usage: z.ZodOptional<z.ZodNumber>;
         included_usage: z.ZodOptional<z.ZodNumber>;
         next_reset_at: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }, {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }>, "many">>;
+    }, z.core.$strip>>>;
     credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
         feature_id: z.ZodString;
         credit_amount: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        feature_id: string;
-        credit_amount: number;
-    }, {
-        feature_id: string;
-        credit_amount: number;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    customer_id: string;
-    allowed: boolean;
-    feature_id: string;
-    required_balance: number;
-    entity_id?: string | undefined;
-    unlimited?: boolean | undefined;
-    interval?: ProductItemInterval | undefined;
-    balance?: number | null | undefined;
-    usage?: number | undefined;
-    included_usage?: number | undefined;
-    next_reset_at?: number | null | undefined;
-    overage_allowed?: boolean | undefined;
-    usage_limit?: number | undefined;
-    rollovers?: {
-        balance: number;
-        expires_at: number;
-    } | undefined;
-    breakdown?: {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }[] | undefined;
-    credit_schema?: {
-        feature_id: string;
-        credit_amount: number;
-    }[] | undefined;
-}, {
-    customer_id: string;
-    allowed: boolean;
-    feature_id: string;
-    required_balance: number;
-    entity_id?: string | undefined;
-    unlimited?: boolean | undefined;
-    interval?: ProductItemInterval | undefined;
-    balance?: number | null | undefined;
-    usage?: number | undefined;
-    included_usage?: number | undefined;
-    next_reset_at?: number | null | undefined;
-    overage_allowed?: boolean | undefined;
-    usage_limit?: number | undefined;
-    rollovers?: {
-        balance: number;
-        expires_at: number;
-    } | undefined;
-    breakdown?: {
-        interval: ProductItemInterval;
-        balance?: number | undefined;
-        usage?: number | undefined;
-        included_usage?: number | undefined;
-        next_reset_at?: number | undefined;
-    }[] | undefined;
-    credit_schema?: {
-        feature_id: string;
-        credit_amount: number;
-    }[] | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 type CheckFeatureResult = z.infer<typeof CheckFeatureResultSchema>;
 interface CheckFeaturePreview {
     scenario: CheckFeatureScenario;

package/dist/next/AutumnProvider.d.mts

@@ -1,19 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { z } from 'zod';
+import { z } from 'zod/v4';
 
 declare const CustomerDataSchema: z.ZodObject<{
     name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | null | undefined;
-    email?: string | null | undefined;
-    fingerprint?: string | null | undefined;
-}, {
-    name?: string | null | undefined;
-    email?: string | null | undefined;
-    fingerprint?: string | null | undefined;
-}>;
+}, z.core.$strip>;
 type CustomerData = z.infer<typeof CustomerDataSchema>;
 
 interface AuthPluginOptions {

package/dist/next/AutumnProvider.d.ts

@@ -1,19 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { z } from 'zod';
+import { z } from 'zod/v4';
 
 declare const CustomerDataSchema: z.ZodObject<{
     name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string | null | undefined;
-    email?: string | null | undefined;
-    fingerprint?: string | null | undefined;
-}, {
-    name?: string | null | undefined;
-    email?: string | null | undefined;
-    fingerprint?: string | null | undefined;
-}>;
+}, z.core.$strip>;
 type CustomerData = z.infer<typeof CustomerDataSchema>;
 
 interface AuthPluginOptions {