autumn-js 0.0.65 → 0.0.67

package/dist/next/index.d.mts

@@ -1,74 +1,38 @@
-import * as React$1 from 'react';
-import React__default from 'react';
-import * as swr from 'swr';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as swr from 'swr';
+import * as React$1 from 'react';
 import { NextRequest, NextResponse } from 'next/server';
 
-interface EntityDataParams {
-    name?: string;
-    featureId: string;
-}
-
-interface AttachParams {
-    productId: string;
-    entityId?: string;
-    options?: {
-        featureId: string;
-        quantity: number;
-    }[];
-    successUrl?: string;
-    forceCheckout?: boolean;
-    metadata?: Record<string, string>;
-    dialog?: () => JSX.Element | React__default.ReactNode;
-    callback?: () => Promise<void>;
-    withPreview?: "formatted" | "raw";
-    entityData?: EntityDataParams;
-    openInNewTab?: boolean;
-}
-interface CreateEntityParams {
-    id: string;
-    name: string;
-    featureId: string;
-}
-
-interface CancelParams {
-    productId: string;
-    entityId?: string;
-    cancelImmediately?: boolean;
+interface ErrorResponse {
+    message: string;
+    code: string;
 }
-interface TrackParams {
-    featureId?: string;
-    eventName?: string;
-    entityId?: string;
-    value?: number;
-    idempotencyKey?: string;
-    entityData?: EntityDataParams;
+declare class AutumnError extends Error {
+    readonly message: string;
+    readonly code: string;
+    constructor(response: ErrorResponse);
+    static fromError(error: any): AutumnError;
+    toString(): string;
+    toJSON(): {
+        message: string;
+        code: string;
+    };
 }
 
-declare const useAutumn: () => {
-    attach: ({ productId, entityId, options, successUrl, forceCheckout, metadata, dialog, callback, entityData, openInNewTab, }: AttachParams) => Promise<any>;
-    check: ({ featureId, productId, entityId, requiredBalance, sendEvent, withPreview, dialog, entityData, }: {
-        featureId?: string;
-        productId?: string;
-        entityId?: string;
-        requiredBalance?: number;
-        sendEvent?: boolean;
-        withPreview?: "formatted" | "raw";
-        dialog?: (data: any) => JSX.Element | React.ReactNode;
-        entityData?: EntityDataParams;
-    }) => Promise<any>;
-    track: (params: TrackParams) => Promise<any>;
-    cancel: (params: CancelParams) => Promise<any>;
-    openBillingPortal: (options?: {
-        returnUrl?: string;
-    }) => Promise<any>;
-};
-
 declare enum AppEnv {
     Sandbox = "sandbox",
     Live = "live"
 }
 
+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",
@@ -80,6 +44,7 @@ declare enum ProductItemInterval {
     Year = "year",
     Multiple = "multiple"
 }
+type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
 
 declare enum ProductStatus {
     Active = "active",
@@ -140,6 +105,18 @@ interface CustomerData {
     email?: string;
     fingerprint?: string;
 }
+interface CreateCustomerParams {
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+    fingerprint?: string | null;
+    metadata?: Record<string, any>;
+    expand?: CustomerExpandOption[];
+}
+interface BillingPortalResponse {
+    customer_id: string;
+    url: string;
+}
 interface CustomerInvoice {
     product_ids: string[];
     stripe_id: string;
@@ -151,7 +128,10 @@ interface CustomerInvoice {
 
 type EntityExpandOption = "invoices";
 
-interface GetEntityParams {
+interface DeleteEntityResult {
+    success: boolean;
+}
+interface GetEntityParams$1 {
     expand?: EntityExpandOption[];
 }
 interface Entity {
@@ -165,6 +145,125 @@ interface Entity {
     invoices?: CustomerInvoice[];
 }
 
+interface ProductItem {
+    feature_id?: string;
+    included_usage?: number | typeof Infinite;
+    interval?: ProductItemIntervalType;
+    usage_model?: UsageModel;
+    price?: number;
+    billing_units?: number;
+    entity_feature_id?: string;
+    reset_usage_on_billing?: boolean;
+    reset_usage_when_enabled?: boolean;
+}
+interface FreeTrial {
+    duration: FreeTrialDuration;
+    length: number;
+    unique_fingerprint: boolean;
+}
+interface Product {
+    autumn_id: string;
+    created_at: number;
+    id: string;
+    name: string;
+    env: AppEnv;
+    is_add_on: boolean;
+    is_default: boolean;
+    group: string;
+    version: number;
+    items: ProductItem[];
+    free_trial: FreeTrial | null;
+}
+
+type CheckFeatureScenario = "usage_limit" | "feature_flag";
+interface CheckFeaturePreview {
+    scenario: CheckFeatureScenario;
+    title: string;
+    message: string;
+    feature_id: string;
+    feature_name: string;
+    products: Product[];
+}
+type CheckProductScenario = "scheduled" | "active" | "new" | "renew" | "upgrade" | "downgrade" | "cancel";
+interface CheckProductPreview {
+    scenario: CheckProductScenario;
+    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;
+    };
+}
+
+interface CancelResult {
+    success: boolean;
+    customer_id: string;
+    product_id: string;
+}
+interface AttachResult {
+    checkout_url?: string;
+    customer_id: string;
+    product_ids: string[];
+    code: string;
+    message: string;
+    customer_data?: CustomerData;
+}
+interface TrackResult {
+    id: string;
+    code: string;
+    customer_id: string;
+    feature_id?: string;
+    event_name?: string;
+}
+interface CheckResult {
+    customer_id: string;
+    allowed: boolean;
+    code: string;
+    feature_id?: string;
+    required_balance?: number;
+    unlimited?: boolean;
+    balance?: number | null;
+    product_id?: string;
+    status?: string;
+    preview?: CheckProductPreview | CheckFeaturePreview;
+}
+
+type Success<T> = {
+    data: T;
+    error: null;
+    statusCode?: number;
+};
+type Failure<E> = {
+    data: null;
+    error: E;
+    statusCode?: number;
+};
+type Result<T, E> = Success<T> | Failure<E>;
+type AutumnPromise<T> = Promise<Result<T, AutumnError>>;
+
 interface PricingTableProduct {
     id: string;
     name: string;
@@ -178,95 +277,213 @@ interface PricingTableProduct {
         secondaryText?: string;
     }[];
 }
-declare class AutumnClientError extends Error {
+
+interface CreateReferralCodeResult {
     code: string;
-    constructor({ message, code }: {
-        message: string;
-        code: string;
-    });
-    toString(): string;
-    toJSON(): {
-        message: string;
-        code: string;
-    };
+    customer_id: string;
+    created_at: number;
 }
-interface AutumnContextParams {
+interface RedeemReferralCodeResult {
+    id: string;
+    customer_id: string;
+    reward_id: string;
+    applied: boolean;
+}
+
+declare const NextAutumnProvider: ({ encryptedCustomerId, customerData, children, }: {
     encryptedCustomerId?: string;
     customerData?: CustomerData;
-    authProvider?: "clerk" | "better-auth";
-    customer: Customer | null;
-    setCustomer: (customer: Customer | null) => void;
-    entity: Entity | null;
-    setEntity: (entity: Entity | null) => void;
+    children: React.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+interface CreateEntityParams {
+    id: string;
+    name: string;
+    featureId: string;
+}
+interface GetEntityParams {
+    expand?: string[];
+}
+interface EntityDataParams {
+    name?: string;
+    featureId: string;
+}
+
+interface CreateReferralCodeParams {
+    programId: string;
+}
+interface RedeemReferralCodeParams {
+    code: string;
+}
+
+interface AttachFeatureOptions {
+    featureId: string;
+    quantity: number;
+}
+interface AttachParams {
+    productId?: string;
     entityId?: string;
-    prodChangeDialog: {
-        found: boolean;
-        setProps: (props: any) => void;
-        setOpen: (open: boolean) => void;
-        setComponent: (component: any) => void;
-    };
-    paywallDialog: {
-        found: boolean;
-        setProps: (props: any) => void;
-        setOpen: (open: boolean) => void;
-        setComponent: (component: any) => void;
-    };
-    pricingTableProducts: PricingTableProduct[] | null;
-    setPricingTableProducts: (products: PricingTableProduct[]) => void;
+    options?: AttachFeatureOptions[];
+    productIds?: string[];
+    freeTrial?: boolean;
+    successUrl?: string;
+    metadata?: Record<string, string>;
+    forceCheckout?: boolean;
+    dialog?: (data: any) => JSX.Element | React.ReactNode;
+    entityData?: EntityDataParams;
+    openInNewTab?: boolean;
+    reward?: string;
+}
+interface CancelParams {
+    productId: string;
+    entityId?: string;
+    cancelImmediately?: boolean;
+}
+interface CheckParams {
+    featureId?: string;
+    productId?: string;
+    entityId?: string;
+    requiredBalance?: number;
+    sendEvent?: boolean;
+    withPreview?: boolean;
+    dialog?: (data: any) => JSX.Element | React.ReactNode;
+    entityData?: EntityDataParams;
+}
+interface TrackParams {
+    featureId?: string;
+    eventName?: string;
+    entityId?: string;
+    value?: number;
+    idempotencyKey?: string;
+    entityData?: EntityDataParams;
+}
+interface OpenBillingPortalParams {
+    returnUrl?: string;
+    openInNewTab?: boolean;
 }
 
-interface UseCustomerProps {
-    expand?: CustomerExpandOption[];
-    autoCreate?: boolean;
-    encryptedCustomerId?: string;
+interface AutumnClientConfig {
+    backendUrl?: string;
+    getBearerToken?: () => Promise<string | null | undefined>;
     customerData?: CustomerData;
-    errorOnNotFound?: boolean;
+    includeCredentials?: boolean;
 }
-declare const useCustomer: (options?: UseCustomerProps) => {
+declare class AutumnClient {
+    protected readonly backendUrl?: string;
+    protected readonly getBearerToken?: () => Promise<string | null | undefined>;
+    protected readonly customerData?: CustomerData;
+    protected readonly includeCredentials?: boolean;
+    constructor({ backendUrl, getBearerToken, customerData, includeCredentials, }: AutumnClientConfig);
+    getHeaders(): Promise<any>;
+    handleFetch({ path, method, body, }: {
+        path: string;
+        method: string;
+        body?: any;
+    }): Promise<Result<any, AutumnError>>;
+    post(path: string, body: any): Promise<Result<any, AutumnError>>;
+    get(path: string): Promise<Result<any, AutumnError>>;
+    delete(path: string): Promise<Result<any, AutumnError>>;
+    createCustomer(params: Omit<CreateCustomerParams, "id" | "data"> & {
+        errorOnNotFound?: boolean;
+    }): Promise<Result<Customer, AutumnError>>;
+    getPricingTable(): Promise<Result<{
+        list: PricingTableProduct[];
+    }, AutumnError>>;
+    attach: (params: AttachParams) => AutumnPromise<AttachResult>;
+    cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
+    check: (params: CheckParams) => AutumnPromise<CheckResult>;
+    track: (params: TrackParams) => AutumnPromise<TrackResult>;
+    openBillingPortal: (params?: OpenBillingPortalParams | undefined) => AutumnPromise<BillingPortalResponse>;
+    entities: {
+        create: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
+        get: (entityId: string, params?: GetEntityParams | undefined) => AutumnPromise<Entity>;
+        delete: (entityId: string) => AutumnPromise<DeleteEntityResult>;
+    };
+    referrals: {
+        createCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
+        redeemCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
+    };
+}
+
+interface UseCustomerResult {
     customer: Customer | null;
     isLoading: boolean;
-    error: AutumnClientError | null;
-    refetch: () => Promise<void>;
-    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => Promise<any>;
-    deleteEntity: (entityId: string) => Promise<any>;
-};
+    error: AutumnError | null;
+    refetch: () => Promise<Customer | null>;
+    createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
+    createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
+    redeemReferralCode: (params: RedeemReferralCodeParams) => AutumnPromise<RedeemReferralCodeResult>;
+}
+interface UseCustomerParams {
+    errorOnNotFound?: boolean;
+    expand?: CustomerExpandOption[];
+}
 
-declare const usePricingTable: (options?: {
-    productDetails: {
-        id: string;
-        description?: string;
-        buttonText?: string;
-        buttonUrl?: string;
-        recommendText?: string;
-    }[];
+declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
+
+interface ProductDetails {
+    id: string;
+    description?: string;
+    buttonText?: string;
+    buttonUrl?: string;
+    recommendText?: string;
+}
+
+declare const usePricingTable: (params?: {
+    productDetails?: ProductDetails[];
 }) => {
-    products: any[] | null;
+    products: PricingTableProduct[] | null;
     isLoading: boolean;
-    error: any;
-    refetch: () => Promise<PricingTableProduct[] | null>;
+    error: AutumnError | undefined;
+    refetch: swr.KeyedMutator<PricingTableProduct[]>;
 };
 
-declare const useEntity: (entityId?: string, params?: GetEntityParams) => {
-    entity: any;
+declare const useEntity: (entityId: string | null, params?: GetEntityParams$1) => {
+    entity: Entity | null;
     isLoading: boolean;
     error: any;
-    refetch: swr.KeyedMutator<any>;
+    refetch: swr.KeyedMutator<Entity | null>;
 };
 
-declare const AutumnContext: React$1.Context<AutumnContextParams>;
-declare const useAutumnContext: () => AutumnContextParams;
-
-declare const withAuth: <T extends {
-    customerId?: string;
-    customerData?: CustomerData;
-    authProvider?: string;
-}>({ fn, withCustomerData, requireCustomer, }: {
-    fn: (args: T) => Promise<any>;
-    withCustomerData?: boolean;
-    requireCustomer?: boolean;
-}) => (args: Omit<T, "customerId"> & {
-    encryptedCustomerId?: string;
-}, request?: Request) => Promise<any>;
+declare const useAutumn: () => {
+    attach: (params: AttachParams) => Promise<Result<AttachResult | CheckResult, AutumnError>>;
+    check: (params: CheckParams) => Promise<{
+        data: null;
+        error: AutumnError;
+        statusCode?: number;
+    } | {
+        data: CheckResult;
+        error: null;
+        statusCode?: number;
+    }>;
+    track: (params: TrackParams) => Promise<{
+        data: null;
+        error: AutumnError;
+        statusCode?: number;
+    } | {
+        data: TrackResult;
+        error: null;
+        statusCode?: number;
+    }>;
+    cancel: (params: CancelParams) => Promise<{
+        data: null;
+        error: AutumnError;
+        statusCode?: number;
+    } | {
+        data: CancelResult;
+        error: null;
+        statusCode?: number;
+    }>;
+    openBillingPortal: (params?: OpenBillingPortalParams) => Promise<{
+        data: null;
+        error: AutumnError;
+        statusCode?: number;
+    } | {
+        data: BillingPortalResponse;
+        error: null;
+        statusCode?: number;
+    }>;
+};
 
 interface AuthPluginOptions {
     provider: "better-auth" | "supabase" | "clerk";
@@ -286,6 +503,21 @@ interface AutumnProviderProps {
 }
 declare const AutumnProvider: ({ customerId, customerData, authPlugin, children, }: AutumnProviderProps) => react_jsx_runtime.JSX.Element;
 
+interface AutumnDialogContext {
+    props: any;
+    setProps: (props: any) => void;
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    setComponent: (component: any) => void;
+}
+interface AutumnContextParams {
+    initialized: boolean;
+    client: AutumnClient;
+    paywallDialog: AutumnDialogContext;
+    prodChangeDialog: AutumnDialogContext;
+}
+declare const AutumnContext: React$1.Context<AutumnContextParams>;
+
 type AuthResult = Promise<{
     customerId?: string;
     customerData?: {
@@ -303,4 +535,4 @@ declare function autumnHandler(options: {
     POST: (request: NextRequest) => Promise<NextResponse<any>>;
 };
 
-export { AutumnContext, AutumnProvider, type UseCustomerProps, autumnHandler, useAutumn, useAutumnContext, useCustomer, useEntity, usePricingTable, withAuth };
+export { AutumnContext, AutumnProvider, NextAutumnProvider, autumnHandler, useAutumn, useCustomer, useEntity, usePricingTable };