autumn-js 0.0.103 → 0.0.105

package/dist/libraries/react/index.d.mts

@@ -2,7 +2,6 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import { z } from 'zod';
 import * as swr from 'swr';
 import { SWRConfiguration } from 'swr';
-import * as React$1 from 'react';
 
 interface ErrorResponse {
     message: string;
@@ -108,10 +107,17 @@ declare enum AppEnv {
     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;
@@ -143,10 +149,12 @@ interface Product {
     free_trial: FreeTrial | null;
     scenario?: ProductScenario;
     base_variant_id: string | null;
-    properties?: {
-        is_free?: boolean;
-        is_one_off?: boolean;
-        interval_group?: string;
+    properties: {
+        is_free: boolean;
+        is_one_off: boolean;
+        interval_group: string;
+        has_trial: boolean;
+        has_prepaid: boolean;
     };
     display?: {
         name?: string;
@@ -223,11 +231,20 @@ interface Customer {
     features: Record<string, CustomerFeature>;
     invoices?: CustomerInvoice[];
 }
-interface CustomerData {
-    name?: string;
-    email?: string;
-    fingerprint?: string;
-}
+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;
+}>;
+type CustomerData = z.infer<typeof CustomerDataSchema>;
 interface BillingPortalResult {
     customer_id: string;
     url: string;
@@ -242,29 +259,6 @@ interface CustomerInvoice {
     hosted_invoice_url: string;
 }
 
-declare const AttachResultSchema: z.ZodObject<{
-    checkout_url: z.ZodOptional<z.ZodString>;
-    customer_id: z.ZodString;
-    product_ids: z.ZodArray<z.ZodString, "many">;
-    code: z.ZodString;
-    message: z.ZodString;
-    customer_data: z.ZodOptional<z.ZodAny>;
-}, "strip", z.ZodTypeAny, {
-    customer_id: string;
-    code: string;
-    message: string;
-    product_ids: string[];
-    customer_data?: any;
-    checkout_url?: string | undefined;
-}, {
-    customer_id: string;
-    code: string;
-    message: string;
-    product_ids: string[];
-    customer_data?: any;
-    checkout_url?: string | undefined;
-}>;
-type AttachResult = z.infer<typeof AttachResultSchema>;
 declare const CancelResultSchema: z.ZodObject<{
     success: z.ZodBoolean;
     customer_id: z.ZodString;
@@ -305,6 +299,60 @@ interface SetupPaymentResult {
     url: string;
 }
 
+declare const AttachFeatureOptionsSchema: z.ZodObject<{
+    feature_id: z.ZodString;
+    quantity: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    feature_id: string;
+    quantity: number;
+}, {
+    feature_id: string;
+    quantity: number;
+}>;
+type AttachFeatureOptions = z.infer<typeof AttachFeatureOptionsSchema>;
+declare const AttachResultSchema: z.ZodObject<{
+    checkout_url: z.ZodOptional<z.ZodString>;
+    customer_id: z.ZodString;
+    product_ids: z.ZodArray<z.ZodString, "many">;
+    code: z.ZodString;
+    message: z.ZodString;
+    customer_data: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    customer_id: string;
+    code: string;
+    message: string;
+    product_ids: string[];
+    customer_data?: any;
+    checkout_url?: string | undefined;
+}, {
+    customer_id: string;
+    code: string;
+    message: string;
+    product_ids: string[];
+    customer_data?: any;
+    checkout_url?: string | undefined;
+}>;
+type AttachResult = z.infer<typeof AttachResultSchema>;
+type CheckoutResult = {
+    url?: string;
+    customer_id: string;
+    has_prorations: boolean;
+    lines: {
+        description: string;
+        amount: number;
+        item: ProductItem;
+    }[];
+    total: number;
+    currency: string;
+    options: AttachFeatureOptions[];
+    product: Product;
+    current_product: Product;
+    next_cycle?: {
+        starts_at: number;
+        total: number;
+    };
+};
+
 type Success<T> = {
     data: T;
     error: null;
@@ -413,65 +461,6 @@ declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
 }>;
 type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;
 
-declare const AttachParamsSchema: z.ZodObject<{
-    productId: z.ZodOptional<z.ZodString>;
-    entityId: z.ZodOptional<z.ZodString>;
-    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        featureId: z.ZodString;
-        quantity: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        quantity: number;
-        featureId: string;
-    }, {
-        quantity: number;
-        featureId: string;
-    }>, "many">>;
-    productIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    freeTrial: z.ZodOptional<z.ZodBoolean>;
-    successUrl: z.ZodOptional<z.ZodString>;
-    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-    forceCheckout: z.ZodOptional<z.ZodBoolean>;
-    dialog: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodUnion<[z.ZodType<JSX.Element, z.ZodTypeDef, JSX.Element>, z.ZodType<React$1.ReactNode, z.ZodTypeDef, React$1.ReactNode>]>>>;
-    entityData: z.ZodOptional<z.ZodAny>;
-    openInNewTab: z.ZodOptional<z.ZodBoolean>;
-    reward: z.ZodOptional<z.ZodString>;
-    checkoutSessionParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    options?: {
-        quantity: number;
-        featureId: string;
-    }[] | undefined;
-    metadata?: Record<string, string> | undefined;
-    reward?: string | undefined;
-    productId?: string | undefined;
-    entityId?: string | undefined;
-    productIds?: string[] | undefined;
-    freeTrial?: boolean | undefined;
-    successUrl?: string | undefined;
-    forceCheckout?: boolean | undefined;
-    dialog?: ((args_0: any, ...args: unknown[]) => JSX.Element | React$1.ReactNode) | undefined;
-    entityData?: any;
-    openInNewTab?: boolean | undefined;
-    checkoutSessionParams?: Record<string, any> | undefined;
-}, {
-    options?: {
-        quantity: number;
-        featureId: string;
-    }[] | undefined;
-    metadata?: Record<string, string> | undefined;
-    reward?: string | undefined;
-    productId?: string | undefined;
-    entityId?: string | undefined;
-    productIds?: string[] | undefined;
-    freeTrial?: boolean | undefined;
-    successUrl?: string | undefined;
-    forceCheckout?: boolean | undefined;
-    dialog?: ((args_0: any, ...args: unknown[]) => JSX.Element | React$1.ReactNode) | undefined;
-    entityData?: any;
-    openInNewTab?: boolean | undefined;
-    checkoutSessionParams?: Record<string, any> | undefined;
-}>;
-type AttachParams = z.infer<typeof AttachParamsSchema>;
 declare const CancelParamsSchema: z.ZodObject<{
     productId: z.ZodString;
     entityId: z.ZodOptional<z.ZodString>;
@@ -493,26 +482,26 @@ declare const CheckParamsSchema: z.ZodObject<{
     requiredBalance: z.ZodOptional<z.ZodNumber>;
     sendEvent: z.ZodOptional<z.ZodBoolean>;
     withPreview: z.ZodOptional<z.ZodBoolean>;
-    dialog: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodAny], z.ZodUnknown>, z.ZodUnion<[z.ZodType<JSX.Element, z.ZodTypeDef, JSX.Element>, z.ZodType<React$1.ReactNode, z.ZodTypeDef, React$1.ReactNode>]>>>;
+    dialog: z.ZodOptional<z.ZodAny>;
     entityData: z.ZodOptional<z.ZodAny>;
 }, "strip", z.ZodTypeAny, {
-    featureId?: string | undefined;
     productId?: string | undefined;
     entityId?: string | undefined;
-    dialog?: ((args_0: any, ...args: unknown[]) => JSX.Element | React$1.ReactNode) | undefined;
-    entityData?: any;
+    featureId?: string | undefined;
     requiredBalance?: number | undefined;
     sendEvent?: boolean | undefined;
     withPreview?: boolean | undefined;
+    dialog?: any;
+    entityData?: any;
 }, {
-    featureId?: string | undefined;
     productId?: string | undefined;
     entityId?: string | undefined;
-    dialog?: ((args_0: any, ...args: unknown[]) => JSX.Element | React$1.ReactNode) | undefined;
-    entityData?: any;
+    featureId?: string | undefined;
     requiredBalance?: number | undefined;
     sendEvent?: boolean | undefined;
     withPreview?: boolean | undefined;
+    dialog?: any;
+    entityData?: any;
 }>;
 type CheckParams = z.infer<typeof CheckParamsSchema>;
 declare const TrackParamsSchema: z.ZodObject<{
@@ -524,15 +513,15 @@ declare const TrackParamsSchema: z.ZodObject<{
     entityData: z.ZodOptional<z.ZodAny>;
 }, "strip", z.ZodTypeAny, {
     value?: number | undefined;
-    featureId?: string | undefined;
     entityId?: string | undefined;
+    featureId?: string | undefined;
     entityData?: any;
     eventName?: string | undefined;
     idempotencyKey?: string | undefined;
 }, {
     value?: number | undefined;
-    featureId?: string | undefined;
     entityId?: string | undefined;
+    featureId?: string | undefined;
     entityData?: any;
     eventName?: string | undefined;
     idempotencyKey?: string | undefined;
@@ -554,6 +543,107 @@ interface AllowedParams {
     requiredBalance?: number;
 }
 
+declare const AttachParamsSchema: z.ZodObject<{
+    productId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        featureId: z.ZodString;
+        quantity: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        quantity: number;
+        featureId: string;
+    }, {
+        quantity: number;
+        featureId: string;
+    }>, "many">>;
+    productIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    freeTrial: z.ZodOptional<z.ZodBoolean>;
+    successUrl: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    forceCheckout: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * @deprecated This field is deprecated and will be removed in a future version.
+     */
+    dialog: z.ZodOptional<z.ZodAny>;
+    entityData: z.ZodOptional<z.ZodAny>;
+    openInNewTab: z.ZodOptional<z.ZodBoolean>;
+    reward: z.ZodOptional<z.ZodString>;
+    checkoutSessionParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    options?: {
+        quantity: number;
+        featureId: string;
+    }[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    reward?: string | undefined;
+    productId?: string | undefined;
+    entityId?: string | undefined;
+    dialog?: any;
+    entityData?: any;
+    productIds?: string[] | undefined;
+    freeTrial?: boolean | undefined;
+    successUrl?: string | undefined;
+    forceCheckout?: boolean | undefined;
+    openInNewTab?: boolean | undefined;
+    checkoutSessionParams?: Record<string, any> | undefined;
+}, {
+    options?: {
+        quantity: number;
+        featureId: string;
+    }[] | undefined;
+    metadata?: Record<string, string> | undefined;
+    reward?: string | undefined;
+    productId?: string | undefined;
+    entityId?: string | undefined;
+    dialog?: any;
+    entityData?: any;
+    productIds?: string[] | undefined;
+    freeTrial?: boolean | undefined;
+    successUrl?: string | undefined;
+    forceCheckout?: boolean | undefined;
+    openInNewTab?: boolean | undefined;
+    checkoutSessionParams?: Record<string, any> | undefined;
+}>;
+type AttachParams = z.infer<typeof AttachParamsSchema>;
+declare const CheckoutParamsSchema: z.ZodObject<{
+    productId: z.ZodString;
+    entityId: z.ZodOptional<z.ZodString>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        featureId: z.ZodString;
+        quantity: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        quantity: number;
+        featureId: string;
+    }, {
+        quantity: number;
+        featureId: string;
+    }>, "many">>;
+    successUrl: z.ZodOptional<z.ZodString>;
+    openInNewTab: z.ZodOptional<z.ZodBoolean>;
+    dialog: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    productId: string;
+    options?: {
+        quantity: number;
+        featureId: string;
+    }[] | undefined;
+    entityId?: string | undefined;
+    dialog?: any;
+    successUrl?: string | undefined;
+    openInNewTab?: boolean | undefined;
+}, {
+    productId: string;
+    options?: {
+        quantity: number;
+        featureId: string;
+    }[] | undefined;
+    entityId?: string | undefined;
+    dialog?: any;
+    successUrl?: string | undefined;
+    openInNewTab?: boolean | undefined;
+}>;
+type CheckoutParams = z.infer<typeof CheckoutParamsSchema>;
+
 interface UseCustomerResult {
     customer: Customer | null;
     isLoading: boolean;
@@ -564,6 +654,7 @@ interface UseCustomerResult {
     cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
     setupPayment: (params: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
     openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
+    checkout: (params: CheckoutParams) => AutumnPromise<CheckoutResult>;
     refetch: () => Promise<Customer | null>;
     createEntity: (params: CreateEntityParams | CreateEntityParams[]) => AutumnPromise<Entity | Entity[]>;
     createReferralCode: (params: CreateReferralCodeParams) => AutumnPromise<CreateReferralCodeResult>;
@@ -594,7 +685,14 @@ declare const useEntity: (entityId: string | null, params?: GetEntityParams) =>
     refetch: swr.KeyedMutator<Entity | null>;
     allowed: (params: AllowedParams) => boolean;
     check: (params: CheckParams) => AutumnPromise<CheckResult>;
-    attach: (params: AttachParams) => Promise<any>;
+    attach: (params: AttachParams) => Promise<Result<{
+        customer_id: string;
+        code: string;
+        message: string;
+        product_ids: string[];
+        customer_data?: any;
+        checkout_url?: string | undefined;
+    } | CheckResult, AutumnError>>;
     cancel: (params: CancelParams) => AutumnPromise<{
         customer_id: string;
         product_id: string;
@@ -613,21 +711,34 @@ declare const useEntity: (entityId: string | null, params?: GetEntityParams) =>
  * @deprecated The functions exported from this hook can now be found in useCustomer
  */
 declare const useAutumn: () => {
-    attach: (params: AttachParams) => Promise<any>;
+    attach: (params: AttachParams) => Promise<Result<{
+        customer_id: string;
+        code: string;
+        message: string;
+        product_ids: string[];
+        customer_data?: any;
+        checkout_url?: string | undefined;
+    } | CheckResult, AutumnError>>;
     check: (params: CheckParams) => AutumnPromise<CheckResult>;
     track: (params: TrackParams) => AutumnPromise<TrackResult>;
     cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
     openBillingPortal: (params?: OpenBillingPortalParams) => AutumnPromise<BillingPortalResult>;
     setupPayment: (params?: SetupPaymentParams) => AutumnPromise<SetupPaymentResult>;
+    checkout: (params: CheckoutParams) => Promise<{
+        data: null;
+        error: AutumnError;
+    } | {
+        data: CheckoutResult;
+        error: null;
+    }>;
 };
 
 interface AttachDialogProps {
     open: boolean;
     setOpen: (open: boolean) => void;
-    preview: CheckProductPreview;
-    onClick: (options?: any) => Promise<void>;
+    checkoutResult: CheckoutResult;
 }
-declare function AttachDialog(params?: AttachDialogProps): react_jsx_runtime.JSX.Element;
+declare function AttachDialog(params: AttachDialogProps): react_jsx_runtime.JSX.Element;
 
 interface CheckDialogProps {
     open: boolean;