autumn-js 0.1.42 → 0.1.43

package/dist/next/client/hooks/useCustomer.d.mts

@@ -0,0 +1,87 @@
+import { A as AutumnError } from '../error-DHbclCVh.mjs';
+import { A as AttachParams, a as AutumnPromise, g as CheckResult, T as TrackParams, b as TrackResult, C as CancelParams, c as CancelResult, S as SetupPaymentParams, d as SetupPaymentResult, O as OpenBillingPortalParams, e as CheckoutParams, f as CheckParams, h as Success } from '../clientAttachTypes-yOuJqDWt.mjs';
+import { A as AttachResult, C as CheckoutResult, b as CreateEntityParams, a as CreateReferralCodeResult, R as RedeemReferralCodeResult } from '../clientEntTypes-aLfa3lyP.mjs';
+import { f as CustomerExpandOption, a as Customer, B as BillingPortalResult } from '../cusTypes-CXjHwB-c.mjs';
+import { E as Entity } from '../entTypes-BkN-Puru.mjs';
+import { SWRConfiguration } from 'swr';
+import { z } from 'zod/v4';
+import '../prodTypes-B_VMILpU.mjs';
+
+declare const CreateReferralCodeParamsSchema: z.ZodObject<{
+    programId: z.ZodString;
+}, z.core.$strip>;
+type CreateReferralCodeParams = z.infer<typeof CreateReferralCodeParamsSchema>;
+declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
+    code: z.ZodString;
+}, z.core.$strip>;
+type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;
+
+interface UseCustomerResult {
+    /** The current customer data including subscription and feature information */
+    customer: Customer | null;
+    /** Whether customer data is currently being loaded */
+    isLoading: boolean;
+    /** Any error that occurred while fetching customer data */
+    error: AutumnError | null;
+    /**
+     * Attaches a product to the current customer, enabling access and handling billing.
+     * Activates a product and applies all product items with automatic payment handling.
+     */
+    attach: (params: AttachParams) => AutumnPromise<AttachResult | CheckResult>;
+    /**
+     * Tracks usage events for metered features.
+     * Records feature usage and updates customer balances server-side.
+     */
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    /**
+     * Cancels a customer's subscription or product attachment.
+     * Can cancel immediately or at the end of the billing cycle.
+     */
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    /**
+     * Sets up a payment method for the customer.
+     * Collects payment information without immediately charging.
+     */
+    setupPayment: (params: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    /**
+     * Opens the Stripe billing portal for the customer.
+     * Allows customers to manage their subscription and payment methods.
+     */
+    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    /**
+     * Initiates a checkout flow for product purchase.
+     * Handles payment collection and redirects to Stripe checkout when needed.
+     */
+    checkout: (params: CheckoutParams) => AutumnPromise<CheckoutResult>;
+    /** Refetches the customer data from the server */
+    refetch: () => Promise<Customer | null>;
+    /**
+     * Creates new entities for granular feature tracking.
+     * Entities allow per-user or per-workspace feature limits.
+     */
+    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
+    /**
+     * Creates a referral code for the customer.
+     * Generates codes that can be shared for referral programs.
+     */
+    createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
+    /**
+     * Redeems a referral code for the customer.
+     * Applies referral benefits when a valid code is provided.
+     */
+    redeemReferralCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
+    /**
+     * Checks if a customer has access to a feature and shows paywalls if needed.
+     * Client-side feature gating with optional dialog display for upgrades.
+     */
+    check: (params: CheckParams) => Success<CheckResult>;
+}
+interface UseCustomerParams {
+    errorOnNotFound?: boolean;
+    expand?: CustomerExpandOption[];
+    swrConfig?: SWRConfiguration;
+}
+
+declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
+
+export { useCustomer };

package/dist/next/client/hooks/useCustomer.d.ts

@@ -0,0 +1,87 @@
+import { A as AutumnError } from '../error-DHbclCVh.js';
+import { A as AttachParams, a as AutumnPromise, g as CheckResult, T as TrackParams, b as TrackResult, C as CancelParams, c as CancelResult, S as SetupPaymentParams, d as SetupPaymentResult, O as OpenBillingPortalParams, e as CheckoutParams, f as CheckParams, h as Success } from '../clientAttachTypes-BtZh00uu.js';
+import { A as AttachResult, C as CheckoutResult, b as CreateEntityParams, a as CreateReferralCodeResult, R as RedeemReferralCodeResult } from '../clientEntTypes-Bsi7ciUF.js';
+import { f as CustomerExpandOption, a as Customer, B as BillingPortalResult } from '../cusTypes-B-rJwpui.js';
+import { E as Entity } from '../entTypes-DjKFS-Zk.js';
+import { SWRConfiguration } from 'swr';
+import { z } from 'zod/v4';
+import '../prodTypes-B_VMILpU.js';
+
+declare const CreateReferralCodeParamsSchema: z.ZodObject<{
+    programId: z.ZodString;
+}, z.core.$strip>;
+type CreateReferralCodeParams = z.infer<typeof CreateReferralCodeParamsSchema>;
+declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
+    code: z.ZodString;
+}, z.core.$strip>;
+type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;
+
+interface UseCustomerResult {
+    /** The current customer data including subscription and feature information */
+    customer: Customer | null;
+    /** Whether customer data is currently being loaded */
+    isLoading: boolean;
+    /** Any error that occurred while fetching customer data */
+    error: AutumnError | null;
+    /**
+     * Attaches a product to the current customer, enabling access and handling billing.
+     * Activates a product and applies all product items with automatic payment handling.
+     */
+    attach: (params: AttachParams) => AutumnPromise<AttachResult | CheckResult>;
+    /**
+     * Tracks usage events for metered features.
+     * Records feature usage and updates customer balances server-side.
+     */
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    /**
+     * Cancels a customer's subscription or product attachment.
+     * Can cancel immediately or at the end of the billing cycle.
+     */
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    /**
+     * Sets up a payment method for the customer.
+     * Collects payment information without immediately charging.
+     */
+    setupPayment: (params: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    /**
+     * Opens the Stripe billing portal for the customer.
+     * Allows customers to manage their subscription and payment methods.
+     */
+    openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    /**
+     * Initiates a checkout flow for product purchase.
+     * Handles payment collection and redirects to Stripe checkout when needed.
+     */
+    checkout: (params: CheckoutParams) => AutumnPromise<CheckoutResult>;
+    /** Refetches the customer data from the server */
+    refetch: () => Promise<Customer | null>;
+    /**
+     * Creates new entities for granular feature tracking.
+     * Entities allow per-user or per-workspace feature limits.
+     */
+    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
+    /**
+     * Creates a referral code for the customer.
+     * Generates codes that can be shared for referral programs.
+     */
+    createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
+    /**
+     * Redeems a referral code for the customer.
+     * Applies referral benefits when a valid code is provided.
+     */
+    redeemReferralCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
+    /**
+     * Checks if a customer has access to a feature and shows paywalls if needed.
+     * Client-side feature gating with optional dialog display for upgrades.
+     */
+    check: (params: CheckParams) => Success<CheckResult>;
+}
+interface UseCustomerParams {
+    errorOnNotFound?: boolean;
+    expand?: CustomerExpandOption[];
+    swrConfig?: SWRConfiguration;
+}
+
+declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
+
+export { useCustomer };

package/dist/next/client/hooks/useEntity.d.mts

@@ -0,0 +1,33 @@
+import { f as CheckParams, g as CheckResult, A as AttachParams, C as CancelParams, a as AutumnPromise, T as TrackParams } from '../clientAttachTypes-yOuJqDWt.mjs';
+import { G as GetEntityParams, E as Entity } from '../entTypes-BkN-Puru.mjs';
+import * as swr from 'swr';
+import '../prodTypes-B_VMILpU.mjs';
+import 'zod/v4';
+import '../error-DHbclCVh.mjs';
+import '../cusTypes-CXjHwB-c.mjs';
+
+declare const useEntity: (entityId: string | null, params?: GetEntityParams) => {
+    entity: Entity | null;
+    isLoading: boolean;
+    error: any;
+    refetch: swr.KeyedMutator<Entity | null>;
+    check: (params: CheckParams) => {
+        data: CheckResult;
+        error: null;
+    };
+    attach: (params: AttachParams) => Promise<any>;
+    cancel: (params: CancelParams) => AutumnPromise<{
+        success: boolean;
+        customer_id: string;
+        product_id: string;
+    }>;
+    track: (params: TrackParams) => AutumnPromise<{
+        id: string;
+        code: string;
+        customer_id: string;
+        feature_id?: string | undefined;
+        event_name?: string | undefined;
+    }>;
+};
+
+export { useEntity };

package/dist/next/client/hooks/useEntity.d.ts

@@ -0,0 +1,33 @@
+import { f as CheckParams, g as CheckResult, A as AttachParams, C as CancelParams, a as AutumnPromise, T as TrackParams } from '../clientAttachTypes-BtZh00uu.js';
+import { G as GetEntityParams, E as Entity } from '../entTypes-DjKFS-Zk.js';
+import * as swr from 'swr';
+import '../prodTypes-B_VMILpU.js';
+import 'zod/v4';
+import '../error-DHbclCVh.js';
+import '../cusTypes-B-rJwpui.js';
+
+declare const useEntity: (entityId: string | null, params?: GetEntityParams) => {
+    entity: Entity | null;
+    isLoading: boolean;
+    error: any;
+    refetch: swr.KeyedMutator<Entity | null>;
+    check: (params: CheckParams) => {
+        data: CheckResult;
+        error: null;
+    };
+    attach: (params: AttachParams) => Promise<any>;
+    cancel: (params: CancelParams) => AutumnPromise<{
+        success: boolean;
+        customer_id: string;
+        product_id: string;
+    }>;
+    track: (params: TrackParams) => AutumnPromise<{
+        id: string;
+        code: string;
+        customer_id: string;
+        feature_id?: string | undefined;
+        event_name?: string | undefined;
+    }>;
+};
+
+export { useEntity };

package/dist/next/client/hooks/usePricingTable.d.mts

@@ -0,0 +1,34 @@
+import * as swr from 'swr';
+import { A as AutumnError } from '../error-DHbclCVh.mjs';
+import { P as Product } from '../prodTypes-B_VMILpU.mjs';
+import 'zod/v4';
+
+interface ProductDetails {
+    id?: string;
+    name?: string;
+    description?: string;
+    buttonText?: string;
+    buttonUrl?: string;
+    recommendText?: string;
+    everythingFrom?: string;
+    price?: {
+        primaryText: string;
+        secondaryText?: string;
+    };
+    items?: {
+        featureId?: string;
+        primaryText?: string;
+        secondaryText?: string;
+    }[];
+}
+
+declare const usePricingTable: (params?: {
+    productDetails?: ProductDetails[];
+}) => {
+    products: Product[] | null;
+    isLoading: boolean;
+    error: AutumnError | undefined;
+    refetch: swr.KeyedMutator<Product[]>;
+};
+
+export { usePricingTable };

package/dist/next/client/hooks/usePricingTable.d.ts

@@ -0,0 +1,34 @@
+import * as swr from 'swr';
+import { A as AutumnError } from '../error-DHbclCVh.js';
+import { P as Product } from '../prodTypes-B_VMILpU.js';
+import 'zod/v4';
+
+interface ProductDetails {
+    id?: string;
+    name?: string;
+    description?: string;
+    buttonText?: string;
+    buttonUrl?: string;
+    recommendText?: string;
+    everythingFrom?: string;
+    price?: {
+        primaryText: string;
+        secondaryText?: string;
+    };
+    items?: {
+        featureId?: string;
+        primaryText?: string;
+        secondaryText?: string;
+    }[];
+}
+
+declare const usePricingTable: (params?: {
+    productDetails?: ProductDetails[];
+}) => {
+    products: Product[] | null;
+    isLoading: boolean;
+    error: AutumnError | undefined;
+    refetch: swr.KeyedMutator<Product[]>;
+};
+
+export { usePricingTable };

package/dist/next/client/prodTypes-B_VMILpU.d.mts

@@ -0,0 +1,162 @@
+import { z } from 'zod/v4';
+
+declare const Infinite = "inf";
+declare enum FreeTrialDuration {
+    Day = "day"
+}
+declare enum UsageModel {
+    Prepaid = "prepaid",
+    PayPerUse = "pay_per_use"
+}
+type UsageModelType = "prepaid" | "pay_per_use";
+declare enum ProductItemInterval {
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    Quarter = "quarter",
+    SemiAnnual = "semi_annual",
+    Year = "year",
+    Multiple = "multiple"
+}
+type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
+
+declare const CheckFeatureResultSchema: z.ZodObject<{
+    allowed: z.ZodBoolean;
+    feature_id: z.ZodString;
+    customer_id: z.ZodString;
+    entity_id: z.ZodOptional<z.ZodString>;
+    required_balance: z.ZodNumber;
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    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>;
+    next_reset_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    rollovers: z.ZodOptional<z.ZodObject<{
+        balance: z.ZodNumber;
+        expires_at: z.ZodNumber;
+    }, z.core.$strip>>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        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>;
+    }, z.core.$strip>>>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CheckFeatureResult = z.infer<typeof CheckFeatureResultSchema>;
+type ProductScenario = "scheduled" | "active" | "new" | "renew" | "upgrade" | "downgrade" | "cancel";
+interface CheckProductResult {
+    allowed: boolean;
+    customer_id: string;
+    product_id: string;
+    entity_id?: string;
+    status?: string;
+    preview?: CheckProductPreview;
+}
+interface CheckProductPreview {
+    scenario: ProductScenario;
+    product_id: string;
+    product_name: string;
+    recurring: boolean;
+    error_on_attach?: boolean;
+    next_cycle_at?: number;
+    current_product_name?: string;
+    items?: {
+        price: string;
+        description: string;
+        usage_model?: UsageModelType;
+    }[];
+    options?: {
+        feature_id: string;
+        feature_name: string;
+        billing_units: number;
+        price?: number;
+        tiers?: {
+            to: number | string;
+            amount: number;
+        }[];
+    }[];
+    due_today?: {
+        price: number;
+        currency: string;
+    };
+    due_next_cycle?: {
+        price: number;
+        currency: string;
+    };
+}
+
+declare enum AppEnv {
+    Sandbox = "sandbox",
+    Live = "live"
+}
+
+interface Feature {
+    id: string;
+    name: string;
+    type: "boolean" | "continuous_use" | "single_use" | "credit_system";
+}
+interface ProductItem {
+    type?: "feature" | "priced_feature" | "price";
+    feature_id?: string;
+    included_usage?: number | typeof Infinite;
+    interval?: ProductItemIntervalType;
+    feature?: Feature;
+    usage_model?: UsageModel;
+    price?: number;
+    billing_units?: number;
+    entity_feature_id?: string;
+    reset_usage_when_enabled?: boolean;
+    quantity?: number;
+    next_cycle_quantity?: number;
+    display?: {
+        primary_text?: string;
+        secondary_text?: string;
+    };
+}
+interface FreeTrial {
+    duration: FreeTrialDuration;
+    length: number;
+    unique_fingerprint: boolean;
+    trial_available?: boolean;
+}
+interface Product {
+    id: string;
+    created_at: number;
+    name: string;
+    env: AppEnv;
+    is_add_on: boolean;
+    is_default: boolean;
+    group: string;
+    version: number;
+    items: ProductItem[];
+    free_trial: FreeTrial | null;
+    scenario?: ProductScenario;
+    base_variant_id: string | null;
+    properties: {
+        is_free: boolean;
+        is_one_off: boolean;
+        interval_group: string;
+        has_trial: boolean;
+        updateable: boolean;
+    };
+    display?: {
+        name?: string;
+        description?: string;
+        button_text?: string;
+        recommend_text?: string;
+        everything_from?: string;
+        button_url?: string;
+    };
+}
+
+export { AppEnv as A, type CheckFeatureResult as C, type Product as P, type ProductItem as a, ProductItemInterval as b, type CheckProductResult as c };

package/dist/next/client/prodTypes-B_VMILpU.d.ts

@@ -0,0 +1,162 @@
+import { z } from 'zod/v4';
+
+declare const Infinite = "inf";
+declare enum FreeTrialDuration {
+    Day = "day"
+}
+declare enum UsageModel {
+    Prepaid = "prepaid",
+    PayPerUse = "pay_per_use"
+}
+type UsageModelType = "prepaid" | "pay_per_use";
+declare enum ProductItemInterval {
+    Minute = "minute",
+    Hour = "hour",
+    Day = "day",
+    Week = "week",
+    Month = "month",
+    Quarter = "quarter",
+    SemiAnnual = "semi_annual",
+    Year = "year",
+    Multiple = "multiple"
+}
+type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
+
+declare const CheckFeatureResultSchema: z.ZodObject<{
+    allowed: z.ZodBoolean;
+    feature_id: z.ZodString;
+    customer_id: z.ZodString;
+    entity_id: z.ZodOptional<z.ZodString>;
+    required_balance: z.ZodNumber;
+    unlimited: z.ZodOptional<z.ZodBoolean>;
+    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>;
+    next_reset_at: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    overage_allowed: z.ZodOptional<z.ZodBoolean>;
+    usage_limit: z.ZodOptional<z.ZodNumber>;
+    rollovers: z.ZodOptional<z.ZodObject<{
+        balance: z.ZodNumber;
+        expires_at: z.ZodNumber;
+    }, z.core.$strip>>;
+    breakdown: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        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>;
+    }, z.core.$strip>>>;
+    credit_schema: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        feature_id: z.ZodString;
+        credit_amount: z.ZodNumber;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+type CheckFeatureResult = z.infer<typeof CheckFeatureResultSchema>;
+type ProductScenario = "scheduled" | "active" | "new" | "renew" | "upgrade" | "downgrade" | "cancel";
+interface CheckProductResult {
+    allowed: boolean;
+    customer_id: string;
+    product_id: string;
+    entity_id?: string;
+    status?: string;
+    preview?: CheckProductPreview;
+}
+interface CheckProductPreview {
+    scenario: ProductScenario;
+    product_id: string;
+    product_name: string;
+    recurring: boolean;
+    error_on_attach?: boolean;
+    next_cycle_at?: number;
+    current_product_name?: string;
+    items?: {
+        price: string;
+        description: string;
+        usage_model?: UsageModelType;
+    }[];
+    options?: {
+        feature_id: string;
+        feature_name: string;
+        billing_units: number;
+        price?: number;
+        tiers?: {
+            to: number | string;
+            amount: number;
+        }[];
+    }[];
+    due_today?: {
+        price: number;
+        currency: string;
+    };
+    due_next_cycle?: {
+        price: number;
+        currency: string;
+    };
+}
+
+declare enum AppEnv {
+    Sandbox = "sandbox",
+    Live = "live"
+}
+
+interface Feature {
+    id: string;
+    name: string;
+    type: "boolean" | "continuous_use" | "single_use" | "credit_system";
+}
+interface ProductItem {
+    type?: "feature" | "priced_feature" | "price";
+    feature_id?: string;
+    included_usage?: number | typeof Infinite;
+    interval?: ProductItemIntervalType;
+    feature?: Feature;
+    usage_model?: UsageModel;
+    price?: number;
+    billing_units?: number;
+    entity_feature_id?: string;
+    reset_usage_when_enabled?: boolean;
+    quantity?: number;
+    next_cycle_quantity?: number;
+    display?: {
+        primary_text?: string;
+        secondary_text?: string;
+    };
+}
+interface FreeTrial {
+    duration: FreeTrialDuration;
+    length: number;
+    unique_fingerprint: boolean;
+    trial_available?: boolean;
+}
+interface Product {
+    id: string;
+    created_at: number;
+    name: string;
+    env: AppEnv;
+    is_add_on: boolean;
+    is_default: boolean;
+    group: string;
+    version: number;
+    items: ProductItem[];
+    free_trial: FreeTrial | null;
+    scenario?: ProductScenario;
+    base_variant_id: string | null;
+    properties: {
+        is_free: boolean;
+        is_one_off: boolean;
+        interval_group: string;
+        has_trial: boolean;
+        updateable: boolean;
+    };
+    display?: {
+        name?: string;
+        description?: string;
+        button_text?: string;
+        recommend_text?: string;
+        everything_from?: string;
+        button_url?: string;
+    };
+}
+
+export { AppEnv as A, type CheckFeatureResult as C, type Product as P, type ProductItem as a, ProductItemInterval as b, type CheckProductResult as c };