Files
supabase/apps/studio/data/usage/org-usage-query.ts
2024-03-04 20:48:22 +08:00

48 lines
1.5 KiB
TypeScript

import { useQuery, UseQueryOptions } from '@tanstack/react-query'
import { get } from 'data/fetchers'
import { usageKeys } from './keys'
import type { ResponseError } from 'types'
import type { components } from 'data/api'
export type OrgUsageVariables = {
orgSlug?: string
projectRef?: string
start?: Date
end?: Date
}
export type OrgUsageResponse = components['schemas']['OrgUsageResponse']
export type OrgMetricsUsage = components['schemas']['OrgMetricUsage']
export async function getOrgUsage(
{ orgSlug, projectRef, start, end }: OrgUsageVariables,
signal?: AbortSignal
): Promise<OrgUsageResponse> {
if (!orgSlug) throw new Error('orgSlug is required')
const { data, error } = await get(`/platform/organizations/{slug}/usage`, {
params: {
path: { slug: orgSlug },
query: { project_ref: projectRef, start: start?.toISOString(), end: end?.toISOString() },
},
signal,
})
if (error) throw error
return data
}
export type OrgUsageData = Awaited<ReturnType<typeof getOrgUsage>>
export type OrgUsageError = ResponseError
export const useOrgUsageQuery = <TData = OrgUsageData>(
{ orgSlug, projectRef, start, end }: OrgUsageVariables,
{ enabled = true, ...options }: UseQueryOptions<OrgUsageData, OrgUsageError, TData> = {}
) =>
useQuery<OrgUsageData, OrgUsageError, TData>(
usageKeys.orgUsage(orgSlug, projectRef, start?.toISOString(), end?.toISOString()),
({ signal }) => getOrgUsage({ orgSlug, projectRef, start, end }, signal),
{
enabled: enabled && typeof orgSlug !== 'undefined',
...options,
}
)