autumn-js 0.1.10 → 0.1.12

package/dist/sdk/index.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var zod = require('zod');
+var v4 = require('zod/v4');
 
 var __defProp = Object.defineProperty;
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
@@ -433,48 +433,216 @@ var Autumn = class {
     });
     return toContainerResult({ response, logger: this.logger });
   }
+  /**
+   * 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
     });
   }
+  /**
+   * 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
     });
   }
+  /**
+   * 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,
       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,
       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,
       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,
       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,
@@ -488,8 +656,8 @@ __publicField(Autumn, "entities", entityMethods());
 __publicField(Autumn, "referrals", referralMethods());
 __publicField(Autumn, "features", featureMethods());
 __publicField(Autumn, "checkout", (params) => staticWrapper(handleCheckout, void 0, { params }));
-__publicField(Autumn, "attach", (params) => staticWrapper(handleAttach, void 0, { params }));
 __publicField(Autumn, "usage", (params) => staticWrapper(handleUsage, void 0, { params }));
+__publicField(Autumn, "attach", (params) => staticWrapper(handleAttach, void 0, { params }));
 __publicField(Autumn, "setupPayment", (params) => staticWrapper(handleSetupPayment, void 0, { params }));
 __publicField(Autumn, "cancel", (params) => staticWrapper(handleCancel, void 0, { params }));
 __publicField(Autumn, "check", (params) => staticWrapper(handleCheck, void 0, { params }));
@@ -519,15 +687,15 @@ var ProductItemInterval = /* @__PURE__ */ ((ProductItemInterval2) => {
   ProductItemInterval2["Multiple"] = "multiple";
   return ProductItemInterval2;
 })(ProductItemInterval || {});
-var ProductStatus = /* @__PURE__ */ ((ProductStatus3) => {
-  ProductStatus3["Active"] = "active";
-  ProductStatus3["Expired"] = "expired";
-  ProductStatus3["Trialing"] = "trialing";
-  ProductStatus3["Scheduled"] = "scheduled";
-  ProductStatus3["PastDue"] = "past_due";
-  return ProductStatus3;
+var ProductStatus = /* @__PURE__ */ ((ProductStatus2) => {
+  ProductStatus2["Active"] = "active";
+  ProductStatus2["Expired"] = "expired";
+  ProductStatus2["Trialing"] = "trialing";
+  ProductStatus2["Scheduled"] = "scheduled";
+  ProductStatus2["PastDue"] = "past_due";
+  return ProductStatus2;
 })(ProductStatus || {});
-var CustomerExpandEnum = zod.z.enum([
+var CustomerExpandEnum = v4.z.enum([
   "invoices",
   "rewards",
   "trials_used",
@@ -535,121 +703,121 @@ var CustomerExpandEnum = zod.z.enum([
   "referrals",
   "payment_method"
 ]);
-var CoreCusFeatureSchema = zod.z.object({
-  unlimited: zod.z.boolean().optional(),
-  interval: zod.z.nativeEnum(ProductItemInterval).optional(),
-  balance: zod.z.number().nullish(),
-  usage: zod.z.number().optional(),
-  included_usage: zod.z.number().optional(),
-  next_reset_at: zod.z.number().nullish(),
-  overage_allowed: zod.z.boolean().optional(),
-  usage_limit: zod.z.number().optional(),
-  rollovers: zod.z.object({
-    balance: zod.z.number(),
-    expires_at: zod.z.number()
+var CoreCusFeatureSchema = v4.z.object({
+  unlimited: v4.z.boolean().optional(),
+  interval: v4.z.enum(ProductItemInterval).optional(),
+  balance: v4.z.number().nullish(),
+  usage: v4.z.number().optional(),
+  included_usage: v4.z.number().optional(),
+  next_reset_at: v4.z.number().nullish(),
+  overage_allowed: v4.z.boolean().optional(),
+  usage_limit: v4.z.number().optional(),
+  rollovers: v4.z.object({
+    balance: v4.z.number(),
+    expires_at: v4.z.number()
   }).optional(),
-  breakdown: zod.z.array(
-    zod.z.object({
-      interval: zod.z.nativeEnum(ProductItemInterval),
-      balance: zod.z.number().optional(),
-      usage: zod.z.number().optional(),
-      included_usage: zod.z.number().optional(),
-      next_reset_at: zod.z.number().optional()
+  breakdown: v4.z.array(
+    v4.z.object({
+      interval: v4.z.enum(ProductItemInterval),
+      balance: v4.z.number().optional(),
+      usage: v4.z.number().optional(),
+      included_usage: v4.z.number().optional(),
+      next_reset_at: v4.z.number().optional()
     })
   ).optional(),
-  credit_schema: zod.z.array(
-    zod.z.object({
-      feature_id: zod.z.string(),
-      credit_amount: zod.z.number()
+  credit_schema: v4.z.array(
+    v4.z.object({
+      feature_id: v4.z.string(),
+      credit_amount: v4.z.number()
     })
   ).optional()
 });
-var CustomerDataSchema = zod.z.object({
-  name: zod.z.string().nullish(),
-  email: zod.z.string().nullish(),
-  fingerprint: zod.z.string().nullish()
+var CustomerDataSchema = v4.z.object({
+  name: v4.z.string().nullish(),
+  email: v4.z.string().nullish(),
+  fingerprint: v4.z.string().nullish()
 });
-var CreateCustomerParamsSchema = zod.z.object({
-  id: zod.z.string().nullish(),
-  email: zod.z.string().nullish(),
-  name: zod.z.string().nullish(),
-  fingerprint: zod.z.string().nullish(),
-  metadata: zod.z.record(zod.z.any()).optional(),
-  expand: zod.z.array(CustomerExpandEnum).optional()
+var CreateCustomerParamsSchema = v4.z.object({
+  id: v4.z.string().nullish(),
+  email: v4.z.string().nullish(),
+  name: v4.z.string().nullish(),
+  fingerprint: v4.z.string().nullish(),
+  metadata: v4.z.record(v4.z.string(), v4.z.any()).optional(),
+  expand: v4.z.array(CustomerExpandEnum).optional()
 });
-var BillingPortalParamsSchema = zod.z.object({
-  return_url: zod.z.string().optional()
+var BillingPortalParamsSchema = v4.z.object({
+  return_url: v4.z.string().optional()
 });
-var UpdateBalancesParamsSchema = zod.z.object({
-  feature_id: zod.z.string(),
-  balance: zod.z.number()
+var UpdateBalancesParamsSchema = v4.z.object({
+  feature_id: v4.z.string(),
+  balance: v4.z.number()
 }).or(
-  zod.z.array(
-    zod.z.object({
-      feature_id: zod.z.string(),
-      balance: zod.z.number()
+  v4.z.array(
+    v4.z.object({
+      feature_id: v4.z.string(),
+      balance: v4.z.number()
     })
   )
 );
-var CheckFeatureResultSchema = zod.z.object({
-  allowed: zod.z.boolean(),
-  feature_id: zod.z.string(),
-  customer_id: zod.z.string(),
-  entity_id: zod.z.string().optional(),
-  required_balance: zod.z.number()
+var CheckFeatureResultSchema = v4.z.object({
+  allowed: v4.z.boolean(),
+  feature_id: v4.z.string(),
+  customer_id: v4.z.string(),
+  entity_id: v4.z.string().optional(),
+  required_balance: v4.z.number()
 }).extend(CoreCusFeatureSchema.shape);
-var EntityDataSchema = zod.z.object({
-  name: zod.z.string().optional(),
-  feature_id: zod.z.string()
+var EntityDataSchema = v4.z.object({
+  name: v4.z.string().optional(),
+  feature_id: v4.z.string()
 });
-var TransferProductParamsSchema = zod.z.object({
-  from_entity_id: zod.z.string(),
-  to_entity_id: zod.z.string(),
-  product_id: zod.z.string()
+var TransferProductParamsSchema = v4.z.object({
+  from_entity_id: v4.z.string(),
+  to_entity_id: v4.z.string(),
+  product_id: v4.z.string()
 });
-var CancelParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  product_id: zod.z.string(),
-  entity_id: zod.z.string().optional(),
-  cancel_immediately: zod.z.boolean().optional()
+var CancelParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  product_id: v4.z.string(),
+  entity_id: v4.z.string().optional(),
+  cancel_immediately: v4.z.boolean().optional()
 });
-var CancelResultSchema = zod.z.object({
-  success: zod.z.boolean(),
-  customer_id: zod.z.string(),
-  product_id: zod.z.string()
+var CancelResultSchema = v4.z.object({
+  success: v4.z.boolean(),
+  customer_id: v4.z.string(),
+  product_id: v4.z.string()
 });
-var TrackParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  value: zod.z.number().optional(),
-  feature_id: zod.z.string().optional(),
-  event_name: zod.z.string().optional(),
-  entity_id: zod.z.string().optional(),
-  customer_data: zod.z.any().optional(),
-  idempotency_key: zod.z.string().optional(),
-  entity_data: zod.z.any().optional()
+var TrackParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  value: v4.z.number().optional(),
+  feature_id: v4.z.string().optional(),
+  event_name: v4.z.string().optional(),
+  entity_id: v4.z.string().optional(),
+  customer_data: v4.z.any().optional(),
+  idempotency_key: v4.z.string().optional(),
+  entity_data: v4.z.any().optional()
 });
-var TrackResultSchema = zod.z.object({
-  id: zod.z.string(),
-  code: zod.z.string(),
-  customer_id: zod.z.string(),
-  feature_id: zod.z.string().optional(),
-  event_name: zod.z.string().optional()
+var TrackResultSchema = v4.z.object({
+  id: v4.z.string(),
+  code: v4.z.string(),
+  customer_id: v4.z.string(),
+  feature_id: v4.z.string().optional(),
+  event_name: v4.z.string().optional()
 });
-var CheckParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  feature_id: zod.z.string().optional(),
-  product_id: zod.z.string().optional(),
-  entity_id: zod.z.string().optional(),
-  customer_data: zod.z.any().optional(),
-  required_balance: zod.z.number().optional(),
-  send_event: zod.z.boolean().optional(),
-  with_preview: zod.z.boolean().optional(),
+var CheckParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  feature_id: v4.z.string().optional(),
+  product_id: v4.z.string().optional(),
+  entity_id: v4.z.string().optional(),
+  customer_data: v4.z.any().optional(),
+  required_balance: v4.z.number().optional(),
+  send_event: v4.z.boolean().optional(),
+  with_preview: v4.z.boolean().optional(),
   entity_data: EntityDataSchema.optional()
 });
-var QueryRangeEnum = zod.z.enum(["24h", "7d", "30d", "90d", "last_cycle"]);
-var QueryParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  feature_id: zod.z.string().or(zod.z.array(zod.z.string())),
+var QueryRangeEnum = v4.z.enum(["24h", "7d", "30d", "90d", "last_cycle"]);
+var QueryParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  feature_id: v4.z.string().or(v4.z.array(v4.z.string())),
   range: QueryRangeEnum.optional()
 });
 
@@ -683,59 +851,61 @@ var fetchPricingTable = async ({
   }
   return await instance.get(path);
 };
-var CreateReferralCodeParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  program_id: zod.z.string()
+var CreateReferralCodeParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  program_id: v4.z.string()
 });
-var RedeemReferralCodeParamsSchema = zod.z.object({
-  code: zod.z.string(),
-  customer_id: zod.z.string()
+var RedeemReferralCodeParamsSchema = v4.z.object({
+  code: v4.z.string(),
+  customer_id: v4.z.string()
 });
-var AttachFeatureOptionsSchema = zod.z.object({
-  feature_id: zod.z.string(),
-  quantity: zod.z.number()
+var AttachFeatureOptionsSchema = v4.z.object({
+  feature_id: v4.z.string(),
+  quantity: v4.z.number()
 });
-var AttachParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  product_id: zod.z.string().optional(),
-  entity_id: zod.z.string().optional(),
-  options: zod.z.array(AttachFeatureOptionsSchema).optional(),
-  product_ids: zod.z.array(zod.z.string()).optional(),
-  free_trial: zod.z.boolean().optional(),
-  success_url: zod.z.string().optional(),
-  metadata: zod.z.record(zod.z.string()).optional(),
-  force_checkout: zod.z.boolean().optional(),
+var AttachParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  product_id: v4.z.string().optional(),
+  entity_id: v4.z.string().optional(),
+  options: v4.z.array(AttachFeatureOptionsSchema).optional(),
+  product_ids: v4.z.array(v4.z.string()).optional(),
+  free_trial: v4.z.boolean().optional(),
+  success_url: v4.z.string().optional(),
+  metadata: v4.z.record(v4.z.string(), v4.z.string()).optional(),
+  force_checkout: v4.z.boolean().optional(),
   customer_data: CustomerDataSchema.optional(),
-  entity_data: zod.z.any().optional(),
-  checkout_session_params: zod.z.record(zod.z.any()).optional(),
-  reward: zod.z.string().optional(),
-  invoice: zod.z.boolean().optional()
+  entity_data: v4.z.any().optional(),
+  checkout_session_params: v4.z.record(v4.z.string(), v4.z.any()).optional(),
+  reward: v4.z.string().optional(),
+  invoice: v4.z.boolean().optional()
 });
-var AttachResultSchema = zod.z.object({
-  checkout_url: zod.z.string().optional(),
-  customer_id: zod.z.string(),
-  product_ids: zod.z.array(zod.z.string()),
-  code: zod.z.string(),
-  message: zod.z.string(),
-  customer_data: zod.z.any().optional(),
-  invoice: zod.z.object({
-    status: zod.z.string(),
-    stripe_id: zod.z.string(),
-    hosted_invoice_url: zod.z.string().nullable(),
-    total: zod.z.number(),
-    currency: zod.z.string()
+var AttachResultSchema = v4.z.object({
+  checkout_url: v4.z.string().optional(),
+  customer_id: v4.z.string(),
+  product_ids: v4.z.array(v4.z.string()),
+  code: v4.z.string(),
+  message: v4.z.string(),
+  customer_data: v4.z.any().optional(),
+  invoice: v4.z.object({
+    status: v4.z.string(),
+    stripe_id: v4.z.string(),
+    hosted_invoice_url: v4.z.string().nullable(),
+    total: v4.z.number(),
+    currency: v4.z.string()
   }).optional()
 });
-var CheckoutParamsSchema = zod.z.object({
-  customer_id: zod.z.string(),
-  product_id: zod.z.string(),
-  entity_id: zod.z.string().optional(),
-  options: zod.z.array(AttachFeatureOptionsSchema).optional(),
-  success_url: zod.z.string().optional(),
+var CheckoutParamsSchema = v4.z.object({
+  customer_id: v4.z.string(),
+  product_id: v4.z.string(),
+  entity_id: v4.z.string().optional(),
+  options: v4.z.array(AttachFeatureOptionsSchema).optional(),
+  force_checkout: v4.z.boolean().optional(),
+  invoice: v4.z.boolean().optional(),
+  success_url: v4.z.string().optional(),
   customer_data: CustomerDataSchema.optional(),
-  entity_data: zod.z.any().optional(),
-  checkout_session_params: zod.z.record(zod.z.any()).optional(),
-  reward: zod.z.string().optional()
+  entity_data: v4.z.any().optional(),
+  checkout_session_params: v4.z.record(v4.z.string(), v4.z.any()).optional(),
+  reward: v4.z.string().optional()
 });
 
 exports.AppEnv = AppEnv;