Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions package/src/libraries/react/hooks/useAggregateEvents.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ import type {
EventAggregationResponse,
} from "@/client/types/clientAnalyticsTypes";

export const useAggregateEvents = (
params: EventAggregationParams & { swrConfig?: SWRConfiguration },
) => {
export const useAggregateEvents = ({
swrConfig,
extraQueryKeys,
...params
}: EventAggregationParams & {
swrConfig?: SWRConfiguration;
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}) => {
const context = useAutumnContext({
AutumnContext,
name: "useAggregateEvents",
Expand Down Expand Up @@ -37,7 +43,10 @@ export const useAggregateEvents = (
? new Date(params.customRange.end).toISOString().slice(0, 13)
: undefined;

const { data, error, mutate } = useSWR<EventAggregationResponse, AutumnError>(
const { data, error, mutate } = useSWR<
EventAggregationResponse,
AutumnError
>(
[
"eventAggregate",
params.featureId,
Expand All @@ -46,6 +55,7 @@ export const useAggregateEvents = (
startDate,
endDate,
params.binSize,
...(extraQueryKeys ?? []),
],
fetcher,
{
Expand All @@ -56,7 +66,7 @@ export const useAggregateEvents = (
(error as AutumnErrorWithStatus).statusCode === 429,
errorRetryCount: 3,
refreshInterval: 0,
...params.swrConfig,
...swrConfig,
},
);

Expand Down
15 changes: 13 additions & 2 deletions package/src/libraries/react/hooks/useAnalytics.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ import type { QueryParams } from "@/client/types/clientGenTypes";
/**
* @deprecated Use useAggregateEvents or useListEvents instead
*/
export const useAnalytics = (params: QueryParams) => {
export const useAnalytics = ({
extraQueryKeys,
...params
}: QueryParams & {
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}) => {
const context = useAutumnContext({
AutumnContext,
name: "useAnalytics",
Expand All @@ -32,7 +38,12 @@ export const useAnalytics = (params: QueryParams) => {
};

const { data, error, mutate } = useSWR<QueryResult, AutumnError>(
["analytics", params.featureId, params.range],
[
"analytics",
params.featureId,
params.range,
...(extraQueryKeys ?? []),
],
fetcher,
{
refreshInterval: 0,
Expand Down
28 changes: 21 additions & 7 deletions package/src/libraries/react/hooks/useListEvents.tsx
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
import { AutumnContext, useAutumnContext } from "@/AutumnContext";
import type { EventsListParams } from "@/client/types/clientAnalyticsTypes";
import {
AutumnError,
type AutumnErrorWithStatus,
type EventsListResponse,
} from "@sdk";
import { useCallback, useState } from "react";
import useSWR, { type SWRConfiguration } from "swr";
import { AutumnContext, useAutumnContext } from "@/AutumnContext";
import type { EventsListParams } from "@/client/types/clientAnalyticsTypes";

export const useListEvents = (
params: EventsListParams & { swrConfig?: SWRConfiguration },
) => {
export const useListEvents = ({
swrConfig,
extraQueryKeys,
...params
}: EventsListParams & {
swrConfig?: SWRConfiguration;
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}) => {
const context = useAutumnContext({
AutumnContext,
name: "useListEvents",
Expand Down Expand Up @@ -52,7 +58,15 @@ export const useListEvents = (
EventsListResponse,
AutumnError
>(
["eventList", params.featureId, startDate, endDate, offset, limit],
[
"eventList",
params.featureId,
startDate,
endDate,
offset,
limit,
...(extraQueryKeys ?? []),
],
fetcher,
{
dedupingInterval: 2000,
Expand All @@ -62,7 +76,7 @@ export const useListEvents = (
(error as AutumnErrorWithStatus).statusCode === 429,
errorRetryCount: 3,
refreshInterval: 0,
...params.swrConfig,
...swrConfig,
},
);

Expand Down
6 changes: 4 additions & 2 deletions package/src/libraries/react/hooks/usePaywall.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
import { AutumnContext, useAutumnContext } from "@/AutumnContext";
import { AutumnClient } from "@/client/ReactAutumnClient";
import { CheckFeaturePreview } from "@sdk";
import useSWR from "swr";

export const usePaywall = ({
featureId,
entityId,
extraQueryKeys,
}: {
featureId?: string;
entityId?: string;
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}) => {
const context = useAutumnContext({
AutumnContext,
Expand All @@ -30,7 +32,7 @@ export const usePaywall = ({
return data;
};

const queryKey = [`check`, featureId, entityId];
const queryKey = [`check`, featureId, entityId, ...(extraQueryKeys ?? [])];

const { data, error, isLoading } = useSWR(queryKey, fetcher, {
refreshInterval: 0,
Expand Down
10 changes: 5 additions & 5 deletions package/src/libraries/react/hooks/usePricingTable.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { usePricingTableBase } from "./usePricingTableBase";
import { ProductDetails } from "../client/types/clientPricingTableTypes";
import {
type UsePricingTableParams,
usePricingTableBase,
} from "./usePricingTableBase";
import { AutumnContext, useAutumnContext } from "@/AutumnContext";

export const usePricingTable = (params?: {
productDetails?: ProductDetails[];
}) => {
export const usePricingTable = (params?: UsePricingTableParams) => {
const context = useAutumnContext({
AutumnContext,
name: "usePricingTable",
Expand Down
12 changes: 8 additions & 4 deletions package/src/libraries/react/hooks/usePricingTableBase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,18 @@ const defaultSWRConfig: SWRConfiguration = {
refreshInterval: 0,
};

export interface UsePricingTableParams {
productDetails?: ProductDetails[];
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}

export const usePricingTableBase = ({
client,
params,
}: {
client: AutumnClient | ConvexAutumnClient;
params?: {
productDetails?: ProductDetails[];
};
params?: UsePricingTableParams;
}): { products: Product[] | null; isLoading: boolean; error: AutumnError | undefined; refetch: () => void } => {
const fetcher = async () => {
try {
Expand All @@ -212,7 +216,7 @@ export const usePricingTableBase = ({
};

const { data, error, mutate } = useSWR<Product[], AutumnError>(
["pricing-table", client.backendUrl],
["pricing-table", client.backendUrl, ...(params?.extraQueryKeys ?? [])],
fetcher,
{ ...defaultSWRConfig }
);
Expand Down
12 changes: 9 additions & 3 deletions package/src/libraries/react/hooks/useProductsBase.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
import { AutumnClient } from "@/client/ReactAutumnClient";
import { AutumnContext, useAutumnContext } from "../AutumnContext";
import useSWR from "swr";

export const useProductsBase = ({ client }: { client: AutumnClient }) => {
export const useProductsBase = ({
client,
extraQueryKeys,
}: {
client: AutumnClient;
/** Extra key(s) appended to the SWR query key that trigger a refetch when any value changes. */
extraQueryKeys?: (string | null | undefined)[];
}) => {
const fetcher = async () => {
const { data, error } = await client.products.list();
if (error) throw error;
return data?.list || [];
};

const queryKey = [`products`];
const queryKey = [`products`, ...(extraQueryKeys ?? [])];

const { data, error, isLoading } = useSWR(queryKey, fetcher, {
refreshInterval: 0,
Expand Down
11 changes: 5 additions & 6 deletions package/src/next/client/hooks/usePricingTable.tsx
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
import { usePricingTableBase } from "../../../libraries/react/hooks/usePricingTableBase";
import {
type UsePricingTableParams,
usePricingTableBase,
} from "../../../libraries/react/hooks/usePricingTableBase";
import { AutumnContext, useAutumnContext } from "../../../libraries/react/AutumnContext";
import { ProductDetails } from "../../../libraries/react/client/types/clientPricingTableTypes";

export const usePricingTable = (params?: {
productDetails?: ProductDetails[];
}) => {
export const usePricingTable = (params?: UsePricingTableParams) => {
const context = useAutumnContext({
AutumnContext,
name: "usePricingTable",
});

return usePricingTableBase({ client: context.client, params });
};

Loading