autumn-js 0.0.84 → 0.0.92

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

@@ -1,5 +1,8 @@
 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;
@@ -47,6 +50,7 @@ interface CheckFeatureResult extends CoreCustomerFeature {
     entity_id?: string;
     required_balance: number;
     code: string;
+    usage_limit?: number;
     preview?: CheckFeaturePreview;
 }
 interface CheckFeaturePreview {
@@ -171,6 +175,7 @@ interface CoreCustomerFeature {
     included_usage?: number;
     next_reset_at?: number | null;
     overage_allowed?: boolean;
+    usage_limit?: number;
     breakdown?: {
         interval: ProductItemInterval;
         balance?: number;
@@ -233,6 +238,7 @@ interface CustomerInvoice {
     total: number;
     currency: string;
     created_at: number;
+    hosted_invoice_url: string;
 }
 
 interface Entity {
@@ -251,14 +257,29 @@ interface CancelResult {
     customer_id: string;
     product_id: string;
 }
-interface AttachResult {
-    checkout_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;
-    customer_data?: CustomerData;
-}
+    product_ids: string[];
+    customer_data?: any;
+    checkout_url?: string | undefined;
+}>;
+type AttachResult = z.infer<typeof AttachResultSchema>;
 interface TrackResult {
     id: string;
     code: string;
@@ -315,13 +336,12 @@ interface RedeemReferralCodeResult {
     applied: boolean;
 }
 
-declare const ReactAutumnProvider: ({ children, getBearerToken, backendUrl, customerData, includeCredentials, disableDialogs, authClient, }: {
+declare const ReactAutumnProvider: ({ children, getBearerToken, backendUrl, customerData, includeCredentials, authClient, }: {
     children: React.ReactNode;
     getBearerToken?: () => Promise<string | null | undefined>;
     backendUrl?: string;
     customerData?: CustomerData;
     includeCredentials?: boolean;
-    disableDialogs?: boolean;
     authClient?: any;
 }) => react_jsx_runtime.JSX.Element;
 
@@ -352,60 +372,149 @@ interface CreateEntityParams {
 interface GetEntityParams {
     expand?: string[];
 }
-interface EntityDataParams {
-    name?: string;
-    featureId: string;
-}
 
-interface CreateReferralCodeParams {
+declare const CreateReferralCodeParamsSchema: z.ZodObject<{
+    programId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     programId: string;
-}
-interface RedeemReferralCodeParams {
+}, {
+    programId: string;
+}>;
+type CreateReferralCodeParams = z.infer<typeof CreateReferralCodeParamsSchema>;
+declare const RedeemReferralCodeParamsSchema: z.ZodObject<{
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     code: string;
-}
+}, {
+    code: string;
+}>;
+type RedeemReferralCodeParams = z.infer<typeof RedeemReferralCodeParamsSchema>;
 
-interface AttachFeatureOptions {
-    featureId: string;
-    quantity: number;
-}
-interface AttachParams {
-    productId?: string;
-    entityId?: string;
-    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;
-    checkoutSessionParams?: Record<string, any>;
-}
-interface CancelParams {
+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>;
+    cancelImmediately: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
     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;
-}
+    entityId?: string | undefined;
+    cancelImmediately?: boolean | undefined;
+}, {
+    productId: string;
+    entityId?: string | undefined;
+    cancelImmediately?: boolean | undefined;
+}>;
+type CancelParams = z.infer<typeof CancelParamsSchema>;
+declare const CheckParamsSchema: z.ZodObject<{
+    featureId: z.ZodOptional<z.ZodString>;
+    productId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    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>]>>>;
+    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;
+    requiredBalance?: number | undefined;
+    sendEvent?: boolean | undefined;
+    withPreview?: boolean | undefined;
+}, {
+    featureId?: string | undefined;
+    productId?: string | undefined;
+    entityId?: string | undefined;
+    dialog?: ((args_0: any, ...args: unknown[]) => JSX.Element | React$1.ReactNode) | undefined;
+    entityData?: any;
+    requiredBalance?: number | undefined;
+    sendEvent?: boolean | undefined;
+    withPreview?: boolean | undefined;
+}>;
+type CheckParams = z.infer<typeof CheckParamsSchema>;
+declare const TrackParamsSchema: z.ZodObject<{
+    featureId: z.ZodOptional<z.ZodString>;
+    eventName: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodNumber>;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+    entityData: z.ZodOptional<z.ZodAny>;
+}, "strip", z.ZodTypeAny, {
+    value?: number | undefined;
+    featureId?: string | undefined;
+    entityId?: string | undefined;
+    entityData?: any;
+    eventName?: string | undefined;
+    idempotencyKey?: string | undefined;
+}, {
+    value?: number | undefined;
+    featureId?: string | undefined;
+    entityId?: string | undefined;
+    entityData?: any;
+    eventName?: string | undefined;
+    idempotencyKey?: string | undefined;
+}>;
+type TrackParams = z.infer<typeof TrackParamsSchema>;
 interface OpenBillingPortalParams {
     returnUrl?: string;
     openInNewTab?: boolean;
@@ -441,6 +550,8 @@ interface UseCustomerResult {
 interface UseCustomerParams {
     errorOnNotFound?: boolean;
     expand?: CustomerExpandOption[];
+    swrConfig?: SWRConfiguration;
+    authClient?: any;
 }
 
 declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
@@ -461,7 +572,7 @@ 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<Result<AttachResult | CheckResult, AutumnError>>;
+    attach: (params: AttachParams) => Promise<any>;
     cancel: (params: CancelParams) => AutumnPromise<CancelResult>;
     track: (params: TrackParams) => AutumnPromise<TrackResult>;
 };
@@ -470,7 +581,7 @@ 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<Result<AttachResult | CheckResult, AutumnError>>;
+    attach: (params: AttachParams) => Promise<any>;
     check: (params: CheckParams) => AutumnPromise<CheckResult>;
     track: (params: TrackParams) => AutumnPromise<TrackResult>;
     cancel: (params: CancelParams) => AutumnPromise<CancelResult>;