autumn-js 0.1.52 → 0.1.54

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

@@ -1,23 +1,7 @@
 import { z } from 'zod/v4';
-import React, { JSX } from 'react';
 import * as swr from 'swr';
 import { SWRConfiguration } from 'swr';
-
-interface ErrorResponse {
-    message: string;
-    code: string;
-}
-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;
-    };
-}
+import React, { JSX } from 'react';
 
 declare const Infinite = "inf";
 declare enum FreeTrialDuration {
@@ -41,6 +25,70 @@ declare enum ProductItemInterval {
 }
 type ProductItemIntervalType = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "semi_annual" | "year" | "multiple";
 
+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;
+    };
+}
+
 type CheckFeatureScenario = "usage_limit" | "feature_flag";
 declare const CheckFeatureResultSchema: z.ZodObject<{
     allowed: z.ZodBoolean;
@@ -123,70 +171,95 @@ interface CheckProductPreview {
     };
 }
 
-declare enum AppEnv {
-    Sandbox = "sandbox",
-    Live = "live"
-}
-
-interface Feature {
+interface PricingTableProduct {
     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;
+    description?: string;
+    button_text?: string;
+    recommend_text?: string;
+    everything_from?: string;
+    price: {
+        primary_text: string;
         secondary_text?: string;
-    };
-}
-interface FreeTrial {
-    duration: FreeTrialDuration;
-    length: number;
-    unique_fingerprint: boolean;
-    trial_available?: boolean;
+    } & ProductItem;
+    items: ({
+        primary_text: string;
+        secondary_text?: string;
+    } & ProductItem)[];
+    scenario: ProductScenario;
 }
-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;
+
+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 EventsListParamsSchema: z.ZodObject<{
+    offset: z.ZodOptional<z.ZodDefault<z.ZodCoercedNumber<unknown>>>;
+    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+    featureId: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>;
+    customRange: z.ZodOptional<z.ZodObject<{
+        start: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+        end: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type EventsListParams = z.infer<typeof EventsListParamsSchema>;
+declare const EventAggregationParamsSchema: z.ZodObject<{
+    featureId: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>;
+    groupBy: z.ZodOptional<z.ZodString>;
+    range: z.ZodOptional<z.ZodEnum<{
+        "24h": "24h";
+        "7d": "7d";
+        "30d": "30d";
+        "90d": "90d";
+        last_cycle: "last_cycle";
+        "1bc": "1bc";
+        "3bc": "3bc";
+    }>>;
+    binSize: z.ZodDefault<z.ZodEnum<{
+        day: "day";
+        hour: "hour";
+    }>>;
+    customRange: z.ZodOptional<z.ZodObject<{
+        start: z.ZodNumber;
+        end: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type EventAggregationParams = z.infer<typeof EventAggregationParamsSchema>;
+type FlatAggregatedRow = {
+    period: number;
+    [featureName: string]: number;
+};
+type GroupedAggregatedRow = {
+    period: number;
+} & {
+    [featureName: string]: Record<string, number>;
+};
+type AggregatedEventRow = FlatAggregatedRow | GroupedAggregatedRow;
+declare const EventAggregationTotalSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
+    count: z.ZodNumber;
+    sum: z.ZodNumber;
+}, z.core.$strip>>;
+type EventAggregationTotal = z.infer<typeof EventAggregationTotalSchema>;
+type EventAggregationResponse = {
+    list: AggregatedEventRow[];
+    total: EventAggregationTotal;
+};
+
 declare enum ProductStatus {
     Active = "active",
     Expired = "expired",
@@ -382,6 +455,22 @@ type QueryResult = {
     }>;
 };
 
+interface ErrorResponse {
+    message: string;
+    code: string;
+}
+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;
+    };
+}
+
 type Success<T> = {
     data: T;
     error: null;
@@ -395,24 +484,6 @@ type Failure<E> = {
 type Result<T, E> = Success<T> | Failure<E>;
 type AutumnPromise<T> = Promise<Result<T, AutumnError>>;
 
-interface PricingTableProduct {
-    id: string;
-    name: string;
-    description?: string;
-    button_text?: string;
-    recommend_text?: string;
-    everything_from?: string;
-    price: {
-        primary_text: string;
-        secondary_text?: string;
-    } & ProductItem;
-    items: ({
-        primary_text: string;
-        secondary_text?: string;
-    } & ProductItem)[];
-    scenario: ProductScenario;
-}
-
 interface Entity {
     id: string;
     name: string;
@@ -440,77 +511,16 @@ interface RedeemReferralCodeResult {
     };
 }
 
-declare const ReactAutumnProvider: ({ children, getBearerToken, convex, backendUrl, customerData, includeCredentials, betterAuthUrl, headers, convexApi, pathPrefix, }: {
-    children: React.ReactNode;
-    getBearerToken?: () => Promise<string | null>;
-    convex?: any;
-    backendUrl?: string;
-    customerData?: CustomerData;
-    includeCredentials?: boolean;
-    betterAuthUrl?: string;
-    headers?: Record<string, string>;
-    convexApi?: any;
-    pathPrefix?: string;
-}) => React.JSX.Element;
-
-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 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;
-    }, z.core.$strip>>>;
-    productIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    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.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>>;
-    newBillingSubscription: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-type AttachParams = z.infer<typeof AttachParamsSchema>;
-declare const CheckoutParamsSchema: z.ZodObject<{
-    productId: z.ZodOptional<z.ZodString>;
-    productIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    entityId: z.ZodOptional<z.ZodString>;
-    entityData: z.ZodOptional<z.ZodAny>;
-    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        featureId: z.ZodString;
-        quantity: z.ZodNumber;
-    }, z.core.$strip>>>;
-    successUrl: z.ZodOptional<z.ZodString>;
-    openInNewTab: z.ZodOptional<z.ZodBoolean>;
-    dialog: z.ZodOptional<z.ZodAny>;
-    forceCheckout: z.ZodOptional<z.ZodBoolean>;
-    freeTrial: z.ZodOptional<z.ZodBoolean>;
-    checkoutSessionParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    reward: z.ZodOptional<z.ZodString>;
-    newBillingSubscription: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
-type CheckoutParams = z.infer<typeof CheckoutParamsSchema>;
+declare const useAggregateEvents: (params: EventAggregationParams) => {
+    list: AggregatedEventRow[] | undefined;
+    total: Record<string, {
+        count: number;
+        sum: number;
+    }> | undefined;
+    isLoading: boolean;
+    error: AutumnError | undefined;
+    refetch: swr.KeyedMutator<EventAggregationResponse>;
+};
 
 declare const CancelParamsSchema: z.ZodObject<{
     productId: z.ZodString;
@@ -564,59 +574,59 @@ declare const QueryParamsSchema: z.ZodObject<{
 }, z.core.$strip>;
 type QueryParams = z.infer<typeof QueryParamsSchema>;
 
-declare const EventListParamsSchema: z.ZodObject<{
-    starting_after: z.ZodOptional<z.ZodString>;
-    limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-    customer_id: z.ZodString;
-    feature_id: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>;
-    time_range: z.ZodOptional<z.ZodObject<{
-        start: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-        end: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
-    }, z.core.$strip>>;
+/**
+ * @deprecated Use useAggregateEvents or useListEvents instead
+ */
+declare const useAnalytics: (params: QueryParams) => {
+    data: ({
+        period: number;
+    } & {
+        [key: string]: number | Record<string, number>;
+    })[] | undefined;
+    isLoading: boolean;
+    error: AutumnError | undefined;
+    refetch: swr.KeyedMutator<QueryResult>;
+};
+
+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;
+    }, z.core.$strip>>>;
+    productIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    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.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>>;
+    newBillingSubscription: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-type EventListParams = z.infer<typeof EventListParamsSchema>;
-declare const EventAggregationParamsSchema: z.ZodObject<{
-    customer_id: z.ZodString;
-    feature_id: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString>]>;
-    group_by: z.ZodOptional<z.ZodString>;
-    range: z.ZodOptional<z.ZodEnum<{
-        "24h": "24h";
-        "7d": "7d";
-        "30d": "30d";
-        "90d": "90d";
-        last_cycle: "last_cycle";
-        "1bc": "1bc";
-        "3bc": "3bc";
-    }>>;
-    bin_size: z.ZodDefault<z.ZodEnum<{
-        day: "day";
-        hour: "hour";
-    }>>;
-    custom_range: z.ZodOptional<z.ZodObject<{
-        start: z.ZodNumber;
-        end: z.ZodNumber;
-    }, z.core.$strip>>;
+type AttachParams = z.infer<typeof AttachParamsSchema>;
+declare const CheckoutParamsSchema: z.ZodObject<{
+    productId: z.ZodOptional<z.ZodString>;
+    productIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    entityId: z.ZodOptional<z.ZodString>;
+    entityData: z.ZodOptional<z.ZodAny>;
+    options: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        featureId: z.ZodString;
+        quantity: z.ZodNumber;
+    }, z.core.$strip>>>;
+    successUrl: z.ZodOptional<z.ZodString>;
+    openInNewTab: z.ZodOptional<z.ZodBoolean>;
+    dialog: z.ZodOptional<z.ZodAny>;
+    forceCheckout: z.ZodOptional<z.ZodBoolean>;
+    freeTrial: z.ZodOptional<z.ZodBoolean>;
+    checkoutSessionParams: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    reward: z.ZodOptional<z.ZodString>;
+    newBillingSubscription: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
-type EventAggregationParams = z.infer<typeof EventAggregationParamsSchema>;
-type FlatAggregatedRow = {
-    period: number;
-    [featureName: string]: number;
-};
-type GroupedAggregatedRow = {
-    period: number;
-} & {
-    [featureName: string]: Record<string, number>;
-};
-type AggregatedEventRow = FlatAggregatedRow | GroupedAggregatedRow;
-declare const EventAggregationTotalSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
-    count: z.ZodNumber;
-    sum: z.ZodNumber;
-}, z.core.$strip>>;
-type EventAggregationTotal = z.infer<typeof EventAggregationTotalSchema>;
-type EventAggregationResponse = {
-    list: AggregatedEventRow[];
-    total: EventAggregationTotal;
-};
+type CheckoutParams = z.infer<typeof CheckoutParamsSchema>;
 
 declare const CreateEntityParamsSchema: z.ZodObject<{
     id: z.ZodString;
@@ -766,15 +776,6 @@ interface UseCustomerParams {
  */
 declare const useCustomer: (params?: UseCustomerParams) => UseCustomerResult;
 
-declare const usePricingTable: (params?: {
-    productDetails?: ProductDetails[];
-}) => {
-    products: Product[] | null;
-    isLoading: boolean;
-    error: AutumnError | undefined;
-    refetch: () => void;
-};
-
 declare const useEntity: (entityId: string | null, params?: GetEntityParams) => {
     entity: Entity | null;
     isLoading: boolean;
@@ -792,27 +793,7 @@ declare const useEntity: (entityId: string | null, params?: GetEntityParams) =>
     track: (params: TrackParams) => void;
 };
 
-declare const useAnalytics: (params: QueryParams) => {
-    data: ({
-        period: number;
-    } & {
-        [key: string]: number | Record<string, number>;
-    })[] | undefined;
-    isLoading: boolean;
-    error: AutumnError | undefined;
-    refetch: swr.KeyedMutator<QueryResult>;
-};
-
-declare const usePaywall: ({ featureId, entityId, }: {
-    featureId?: string;
-    entityId?: string;
-}) => {
-    data: CheckFeaturePreview | undefined;
-    error: any;
-    isLoading: boolean;
-};
-
-declare const useListEvents: (params: EventListParams) => {
+declare const useListEvents: (params: EventsListParams) => {
     list: {
         id: string;
         timestamp: number;
@@ -821,8 +802,9 @@ declare const useListEvents: (params: EventListParams) => {
         value: number;
         properties: Record<string, never>;
     }[] | undefined;
-    hasMore: boolean | undefined;
-    nextCursor: string | null | undefined;
+    hasMore: boolean;
+    hasPrevious: boolean;
+    page: number;
     isLoading: boolean;
     error: AutumnError | undefined;
     refetch: swr.KeyedMutator<{
@@ -835,21 +817,47 @@ declare const useListEvents: (params: EventListParams) => {
             properties: Record<string, never>;
         }[];
         has_more: boolean;
-        next_cursor: string | null;
+        offset: number;
+        limit: number;
+        total: number;
     }>;
+    nextPage: () => void;
+    prevPage: () => void;
+    goToPage: (pageNum: number) => void;
+    resetPagination: () => void;
 };
 
-declare const useAggregateEvents: (params: EventAggregationParams) => {
-    list: AggregatedEventRow[] | undefined;
-    total: Record<string, {
-        count: number;
-        sum: number;
-    }> | undefined;
+declare const usePaywall: ({ featureId, entityId, }: {
+    featureId?: string;
+    entityId?: string;
+}) => {
+    data: CheckFeaturePreview | undefined;
+    error: any;
+    isLoading: boolean;
+};
+
+declare const usePricingTable: (params?: {
+    productDetails?: ProductDetails[];
+}) => {
+    products: Product[] | null;
     isLoading: boolean;
     error: AutumnError | undefined;
-    refetch: swr.KeyedMutator<EventAggregationResponse>;
+    refetch: () => void;
 };
 
+declare const ReactAutumnProvider: ({ children, getBearerToken, convex, backendUrl, customerData, includeCredentials, betterAuthUrl, headers, convexApi, pathPrefix, }: {
+    children: React.ReactNode;
+    getBearerToken?: () => Promise<string | null>;
+    convex?: any;
+    backendUrl?: string;
+    customerData?: CustomerData;
+    includeCredentials?: boolean;
+    betterAuthUrl?: string;
+    headers?: Record<string, string>;
+    convexApi?: any;
+    pathPrefix?: string;
+}) => React.JSX.Element;
+
 interface CheckoutDialogProps {
     open: boolean;
     setOpen: (open: boolean) => void;