@stack-spot/portal-network 0.184.0 → 0.185.0-beta.1

package/src/network/AutoInfiniteQuery.ts

@@ -1,115 +1,115 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import {
-  InfiniteData, QueryFunctionContext, QueryKey,
-  UseInfiniteQueryResult,
-  useInfiniteQuery,
-  useSuspenseInfiniteQuery,
-} from '@tanstack/react-query'
-import { get, set } from 'lodash'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { AutoQuery } from './AutoQuery'
-import { queryClient } from './react-query-client'
-import { AutoQueryObjectParams, InfiniteQueryObject, InfiniteQueryOptions, UseInfiniteQueryObjectOptions } from './types'
-
-export class AutoInfiniteQuery<Variables, Result, PageParamName extends keyof Variables, Accumulator extends keyof Result | ''>
-  extends AutoQuery<Variables, Result>
-  implements InfiniteQueryObject<Variables, Result, Accumulator>
-{
-  private options: Required<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator | ''>>
-
-  constructor(
-    params: AutoQueryObjectParams<Variables, Result>,
-    options: InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
-  ) {
-    super(params)
-    this.options = {
-      ...options,
-      accumulator: options.accumulator ?? '',
-      defaultVariables: options.defaultVariables ?? {},
-    }
-  }
-
-  private createInfiniteQueryFn(
-    variables: Variables | undefined,
-  ): (context: QueryFunctionContext<QueryKey, Variables[PageParamName]>) => Promise<Result> {
-    return ({ pageParam, signal }) => {
-      const paginatedVariables = {
-        ...variables,
-      } 
-      set(paginatedVariables, this.options.pageParamName, pageParam ?? get(variables, this.options.pageParamName))
-      return this.callFn(paginatedVariables, signal)
-    }
-  }
-
-  private getListFromData(data: InfiniteData<Result> | undefined) {
-    return data?.pages.map(
-      page => this.options.accumulator ? page[this.options.accumulator as keyof Result] : page,
-    ).flat() as Accumulator extends keyof Result ? Result[Accumulator] : Result
-  }
-
-  private useInfiniteQueryResult(
-    suspense: boolean,
-    variables = {} as Variables,
-    options?: UseInfiniteQueryObjectOptions<Result>,
-  ) {
-    variables = { ...this.options.defaultVariables, ...variables }
-    const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
-    return use<any, any, any, any, any>({
-      ...options,
-      queryKey: this.getInfiniteKey(variables),
-      queryFn: this.createInfiniteQueryFn(variables),
-      initialPageParam: this.options.initialPageParam,
-      getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) =>
-        this.options.getNextPageParam({ variables, lastPage, allPages, lastPageParam, allPageParams }),
-    }, queryClient) as UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>
-  }
-
-  useInfiniteQuery(
-    variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions<Result>,
-  ): [
-    Accumulator extends keyof Result ? Result[Accumulator] : Result,
-    UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
-  ] {
-    const result = this.useInfiniteQueryResult(true, variables, options)
-    return [
-      this.getListFromData(result.data),
-      result,
-    ]
-  }
-
-  useStatefulInfiniteQuery(
-    variables?: Variables,
-    options?: UseInfiniteQueryObjectOptions<Result>,
-  ): [
-    Accumulator extends keyof Result ? Result[Accumulator] : Result,
-    boolean,
-    StackspotAPIError | undefined | null,
-    UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
-  ] {
-    const result = this.useInfiniteQueryResult(false, variables, options)
-    return [
-      this.getListFromData(result.data),
-      result.isPending,
-      result.error,
-      result,
-    ]
-  }
-
-  async invalidate(variables?: Partial<Variables> | undefined): Promise<void> {
-    await Promise.all([
-      super.invalidate(variables),
-      queryClient.invalidateQueries({ queryKey: this.getInfiniteKey(variables) }),
-    ])
-  }
-
-  private getInfiniteKey(variables?: Partial<Variables> | undefined) {
-    return ['infinite', ...this.getKey(variables)]
-  }
-
-  async cancel(variables?: Partial<Variables> | undefined) {
-    super.cancel(variables)
-    queryClient.cancelQueries({ queryKey: this.getInfiniteKey() })
-  }
-}
+/* eslint-disable react-hooks/rules-of-hooks */
+
+import {
+  InfiniteData, QueryFunctionContext, QueryKey,
+  UseInfiniteQueryResult,
+  useInfiniteQuery,
+  useSuspenseInfiniteQuery,
+} from '@tanstack/react-query'
+import { get, set } from 'lodash'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { AutoQuery } from './AutoQuery'
+import { queryClient } from './react-query-client'
+import { AutoQueryObjectParams, InfiniteQueryObject, InfiniteQueryOptions, UseInfiniteQueryObjectOptions } from './types'
+
+export class AutoInfiniteQuery<Variables, Result, PageParamName extends keyof Variables, Accumulator extends keyof Result | ''>
+  extends AutoQuery<Variables, Result>
+  implements InfiniteQueryObject<Variables, Result, Accumulator>
+{
+  private options: Required<InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator | ''>>
+
+  constructor(
+    params: AutoQueryObjectParams<Variables, Result>,
+    options: InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>,
+  ) {
+    super(params)
+    this.options = {
+      ...options,
+      accumulator: options.accumulator ?? '',
+      defaultVariables: options.defaultVariables ?? {},
+    }
+  }
+
+  private createInfiniteQueryFn(
+    variables: Variables | undefined,
+  ): (context: QueryFunctionContext<QueryKey, Variables[PageParamName]>) => Promise<Result> {
+    return ({ pageParam, signal }) => {
+      const paginatedVariables = {
+        ...variables,
+      } 
+      set(paginatedVariables, this.options.pageParamName, pageParam ?? get(variables, this.options.pageParamName))
+      return this.callFn(paginatedVariables, signal)
+    }
+  }
+
+  private getListFromData(data: InfiniteData<Result> | undefined) {
+    return data?.pages.map(
+      page => this.options.accumulator ? page[this.options.accumulator as keyof Result] : page,
+    ).flat() as Accumulator extends keyof Result ? Result[Accumulator] : Result
+  }
+
+  private useInfiniteQueryResult(
+    suspense: boolean,
+    variables = {} as Variables,
+    options?: UseInfiniteQueryObjectOptions<Result>,
+  ) {
+    variables = { ...this.options.defaultVariables, ...variables }
+    const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
+    return use<any, any, any, any, any>({
+      ...options,
+      queryKey: this.getInfiniteKey(variables),
+      queryFn: this.createInfiniteQueryFn(variables),
+      initialPageParam: this.options.initialPageParam,
+      getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) =>
+        this.options.getNextPageParam({ variables, lastPage, allPages, lastPageParam, allPageParams }),
+    }, queryClient) as UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>
+  }
+
+  useInfiniteQuery(
+    variables?: Variables,
+    options?: UseInfiniteQueryObjectOptions<Result>,
+  ): [
+    Accumulator extends keyof Result ? Result[Accumulator] : Result,
+    UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
+  ] {
+    const result = this.useInfiniteQueryResult(true, variables, options)
+    return [
+      this.getListFromData(result.data),
+      result,
+    ]
+  }
+
+  useStatefulInfiniteQuery(
+    variables?: Variables,
+    options?: UseInfiniteQueryObjectOptions<Result>,
+  ): [
+    Accumulator extends keyof Result ? Result[Accumulator] : Result,
+    boolean,
+    StackspotAPIError | undefined | null,
+    UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>,
+  ] {
+    const result = this.useInfiniteQueryResult(false, variables, options)
+    return [
+      this.getListFromData(result.data),
+      result.isPending,
+      result.error,
+      result,
+    ]
+  }
+
+  async invalidate(variables?: Partial<Variables> | undefined): Promise<void> {
+    await Promise.all([
+      super.invalidate(variables),
+      queryClient.invalidateQueries({ queryKey: this.getInfiniteKey(variables) }),
+    ])
+  }
+
+  private getInfiniteKey(variables?: Partial<Variables> | undefined) {
+    return ['infinite', ...this.getKey(variables)]
+  }
+
+  async cancel(variables?: Partial<Variables> | undefined) {
+    super.cancel(variables)
+    queryClient.cancelQueries({ queryKey: this.getInfiniteKey() })
+  }
+}

package/src/network/AutoMutation.ts

@@ -1,27 +1,27 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { UseMutationOptions, useMutation } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { AutoOperation } from './AutoOperation'
-import { queryClient } from './react-query-client'
-import { AutoQueryObjectParams, MutationObject } from './types'
-
-export class AutoMutation<Variables, Result> extends AutoOperation<Variables> implements MutationObject<Variables, Result> {
-  constructor(params: AutoQueryObjectParams<Variables, Result>) {
-    super(params)
-  }
-
-  mutate(...args: Variables extends void ? [signal?: AbortSignal] : [variables: Variables, signal?: AbortSignal]) {
-    const variables = args[0] instanceof AbortSignal ? undefined : args[0]
-    const signal = args[0] instanceof AbortSignal ? args[0] : args[1]
-    return this.callFn(variables, signal)
-  }
-
-  useMutation(options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'> & { signal?: AbortSignal }) {
-    const result = useMutation<Result, StackspotAPIError, Variables>({
-      ...options,
-      mutationFn: (variables) => this.callFn(variables, options?.signal),
-    }, queryClient)
-    return [result.mutateAsync as any, result.isPending, result.error as StackspotAPIError | undefined, result as any] as const
-  }
-}
+/* eslint-disable react-hooks/rules-of-hooks */
+
+import { UseMutationOptions, useMutation } from '@tanstack/react-query'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { AutoOperation } from './AutoOperation'
+import { queryClient } from './react-query-client'
+import { AutoQueryObjectParams, MutationObject } from './types'
+
+export class AutoMutation<Variables, Result> extends AutoOperation<Variables> implements MutationObject<Variables, Result> {
+  constructor(params: AutoQueryObjectParams<Variables, Result>) {
+    super(params)
+  }
+
+  mutate(...args: Variables extends void ? [signal?: AbortSignal] : [variables: Variables, signal?: AbortSignal]) {
+    const variables = args[0] instanceof AbortSignal ? undefined : args[0]
+    const signal = args[0] instanceof AbortSignal ? args[0] : args[1]
+    return this.callFn(variables, signal)
+  }
+
+  useMutation(options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'> & { signal?: AbortSignal }) {
+    const result = useMutation<Result, StackspotAPIError, Variables>({
+      ...options,
+      mutationFn: (variables) => this.callFn(variables, options?.signal),
+    }, queryClient)
+    return [result.mutateAsync as any, result.isPending, result.error as StackspotAPIError | undefined, result as any] as const
+  }
+}

package/src/network/AutoOperation.ts

@@ -1,73 +1,73 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { type RequestOpts } from '@oazapfts/runtime'
-import { UseQueryOptions, UseQueryResult, useQuery } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { queryClient } from './react-query-client'
-import { AutoQueryObjectParams, OperationObject } from './types'
-
-export abstract class AutoOperation<Variables> implements OperationObject<Variables> {
-  protected fn: ((variables: Variables, opts?: RequestOpts) => Promise<any>) | ((opts?: RequestOpts) => Promise<any>)
-  protected apiName: string
-  protected onFetchPermission: typeof fetch
-  private transformError?: (error: any) => StackspotAPIError
-
-  constructor({ apiName, onFetchPermission, fn, transformError }: AutoQueryObjectParams<Variables, any>) {
-    this.fn = fn
-    this.onFetchPermission = onFetchPermission
-    this.apiName = apiName
-    this.transformError = transformError
-    if (typeof fn === 'function' && !fn.name) {
-      throw new Error("Anonymous functions can't be automatically converted into React queries or mutations.")
-    }
-  }
-
-  protected async callFn(variables: Partial<Variables> | undefined, signal: AbortSignal | undefined, fetchFn?: typeof fetch) {
-    const fn = this.fn as (...args: any[]) => Promise<any>
-    try {
-      const result = await (
-        fn.length === 2
-          ? fn(variables ?? {}, fetchFn ? { fetch: fetchFn, signal } : { signal })
-          : fn(fetchFn ? { fetch: fetchFn, signal } : { signal })
-      )
-      return result
-    } catch (error) {
-      throw this.transformError ? this.transformError(error) : error
-    }
-  }
-
-  private createPermissionQueryFn(variables: Partial<Variables> | undefined) {
-    return () => this.callFn(variables, undefined, this.onFetchPermission)
-  }
-
-  isAllowed(...[variables]: Variables extends void ? [] : [variables?: Partial<Variables>]) {
-    return queryClient.fetchQuery({
-      queryKey: this.getPermissionKey(variables as Variables),
-      queryFn: this.createPermissionQueryFn(variables),
-    })
-  }
-
-  useAllowed(
-    ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-  ) {
-    /* `this.fn` is a oazapfts function, i.e. it has arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
-    variables and the 2nd is the RequestOpts. If it doesn't accept variables, its arity is one: it accepts only the RequestOpts.
-    We can use this information to determine what the type of `args` actually is at runtime. If variables are accepted, than the 1st
-    argument is the variables and the 2nd is the query options, otherwise, it has a single argument, which is the query options. */
-    const [variables, options] = this.fn.length > 1
-      ? args as [Variables, Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
-      : [undefined, args[0] as Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
-    const result = useQuery({
-      ...options,
-      queryKey: this.getPermissionKey(variables as Variables),
-      queryFn: this.createPermissionQueryFn(variables),
-    }, queryClient) as UseQueryResult<boolean, StackspotAPIError>
-    return [result.data, result.isPending, result.error, result] as const
-  }
-
-  getPermissionKey(variables?: Partial<Variables>) {
-    return [this.apiName, `${this.fn.name}.permission`, variables]
-  }
-}
+/* eslint-disable react-hooks/rules-of-hooks */
+
+import { type RequestOpts } from '@oazapfts/runtime'
+import { UseQueryOptions, UseQueryResult, useQuery } from '@tanstack/react-query'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { queryClient } from './react-query-client'
+import { AutoQueryObjectParams, OperationObject } from './types'
+
+export abstract class AutoOperation<Variables> implements OperationObject<Variables> {
+  protected fn: ((variables: Variables, opts?: RequestOpts) => Promise<any>) | ((opts?: RequestOpts) => Promise<any>)
+  protected apiName: string
+  protected onFetchPermission: typeof fetch
+  private transformError?: (error: any) => StackspotAPIError
+
+  constructor({ apiName, onFetchPermission, fn, transformError }: AutoQueryObjectParams<Variables, any>) {
+    this.fn = fn
+    this.onFetchPermission = onFetchPermission
+    this.apiName = apiName
+    this.transformError = transformError
+    if (typeof fn === 'function' && !fn.name) {
+      throw new Error("Anonymous functions can't be automatically converted into React queries or mutations.")
+    }
+  }
+
+  protected async callFn(variables: Partial<Variables> | undefined, signal: AbortSignal | undefined, fetchFn?: typeof fetch) {
+    const fn = this.fn as (...args: any[]) => Promise<any>
+    try {
+      const result = await (
+        fn.length === 2
+          ? fn(variables ?? {}, fetchFn ? { fetch: fetchFn, signal } : { signal })
+          : fn(fetchFn ? { fetch: fetchFn, signal } : { signal })
+      )
+      return result
+    } catch (error) {
+      throw this.transformError ? this.transformError(error) : error
+    }
+  }
+
+  private createPermissionQueryFn(variables: Partial<Variables> | undefined) {
+    return () => this.callFn(variables, undefined, this.onFetchPermission)
+  }
+
+  isAllowed(...[variables]: Variables extends void ? [] : [variables?: Partial<Variables>]) {
+    return queryClient.fetchQuery({
+      queryKey: this.getPermissionKey(variables as Variables),
+      queryFn: this.createPermissionQueryFn(variables),
+    })
+  }
+
+  useAllowed(
+    ...args: Variables extends void
+      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+  ) {
+    /* `this.fn` is a oazapfts function, i.e. it has arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
+    variables and the 2nd is the RequestOpts. If it doesn't accept variables, its arity is one: it accepts only the RequestOpts.
+    We can use this information to determine what the type of `args` actually is at runtime. If variables are accepted, than the 1st
+    argument is the variables and the 2nd is the query options, otherwise, it has a single argument, which is the query options. */
+    const [variables, options] = this.fn.length > 1
+      ? args as [Variables, Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
+      : [undefined, args[0] as Omit<UseQueryOptions, 'queryFn' | 'queryKey'> | undefined]
+    const result = useQuery({
+      ...options,
+      queryKey: this.getPermissionKey(variables as Variables),
+      queryFn: this.createPermissionQueryFn(variables),
+    }, queryClient) as UseQueryResult<boolean, StackspotAPIError>
+    return [result.data, result.isPending, result.error, result] as const
+  }
+
+  getPermissionKey(variables?: Partial<Variables>) {
+    return [this.apiName, `${this.fn.name}.permission`, variables]
+  }
+}

package/src/network/AutoQuery.ts

@@ -1,75 +1,75 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { DefinedUseQueryResult, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { AutoOperation } from './AutoOperation'
-import { queryClient } from './react-query-client'
-import { AutoQueryObjectParams, QueryObject, UseQueryObjectOptions } from './types'
-
-export class AutoQuery<Variables, Result> extends AutoOperation<Variables> implements QueryObject<Variables, Result> {
-  constructor(params: AutoQueryObjectParams<Variables, Result>) {
-    super(params)
-  }
-
-  query(...[variables]: Variables extends void ? [] : [variables: Variables]) {
-    return queryClient.fetchQuery({
-      queryKey: this.getKey(variables),
-      queryFn: ({ signal }) => this.callFn(variables, signal),
-    })
-  }
-
-  #useQueryResult<T extends boolean>(
-    suspense: T,
-    ...args: Variables extends void
-      ? [options?: UseQueryObjectOptions<Result>]
-      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
-  ) {
-    /* `this.fn` is a oazapfts function, i.e. it has arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
-    variables and the 2nd is the RequestOpts. If it doesn't accept variables, its arity is one: it accepts only the RequestOpts.
-    We can use this information to determine what the type of `args` actually is at runtime. If variables are accepted, than the 1st
-    argument is the variables and the 2nd is the query options, otherwise, it has a single argument, which is the query options. */
-    const [variables, options] = this.fn.length > 1
-      ? args as [Variables, UseQueryObjectOptions<Result> | undefined]
-      : [undefined, args[0] as UseQueryObjectOptions<Result> | undefined]
-    const use = suspense ? useSuspenseQuery : useQuery
-    return use({
-      ...options,
-      // without this, this lib won't work in React's strict mode, since every request will be immediately aborted (component unmounted).
-      gcTime: 60000,
-      queryKey: this.getKey(variables),
-      queryFn: ({ signal }) => this.callFn(variables, signal),
-    }, queryClient) as T extends true ? UseSuspenseQueryResult<Result, StackspotAPIError> : DefinedUseQueryResult<Result, StackspotAPIError>
-  }
-
-  useQuery(
-    ...args: Variables extends void
-      ? [options?: UseQueryObjectOptions<Result>]
-      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
-  ) {
-    const result = this.#useQueryResult(true, ...args)
-    return result.data
-  }
-
-  useStatefulQuery(
-    ...args: Variables extends void
-      ? [options?: UseQueryObjectOptions<Result>]
-      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
-  ) {
-    const result = this.#useQueryResult(false, ...args)
-    return [result.data, result.isPending, result.error as StackspotAPIError | undefined, result] as const
-  }
-
-  invalidate(variables?: Partial<Variables>) {
-    return queryClient.invalidateQueries({ queryKey: this.getKey(variables) })
-  }
-
-  getKey(variables?: Partial<Variables>)  {
-    const key: any[] = [this.apiName, this.fn.name]
-    if (variables) key.push(variables)
-    return key
-  }
-
-  cancel(variables?: Partial<Variables>) {
-    queryClient.cancelQueries({ queryKey: this.getKey(variables) })
-  }
-}
+/* eslint-disable react-hooks/rules-of-hooks */
+
+import { DefinedUseQueryResult, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { AutoOperation } from './AutoOperation'
+import { queryClient } from './react-query-client'
+import { AutoQueryObjectParams, QueryObject, UseQueryObjectOptions } from './types'
+
+export class AutoQuery<Variables, Result> extends AutoOperation<Variables> implements QueryObject<Variables, Result> {
+  constructor(params: AutoQueryObjectParams<Variables, Result>) {
+    super(params)
+  }
+
+  query(...[variables]: Variables extends void ? [] : [variables: Variables]) {
+    return queryClient.fetchQuery({
+      queryKey: this.getKey(variables),
+      queryFn: ({ signal }) => this.callFn(variables, signal),
+    })
+  }
+
+  #useQueryResult<T extends boolean>(
+    suspense: T,
+    ...args: Variables extends void
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
+  ) {
+    /* `this.fn` is a oazapfts function, i.e. it has arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
+    variables and the 2nd is the RequestOpts. If it doesn't accept variables, its arity is one: it accepts only the RequestOpts.
+    We can use this information to determine what the type of `args` actually is at runtime. If variables are accepted, than the 1st
+    argument is the variables and the 2nd is the query options, otherwise, it has a single argument, which is the query options. */
+    const [variables, options] = this.fn.length > 1
+      ? args as [Variables, UseQueryObjectOptions<Result> | undefined]
+      : [undefined, args[0] as UseQueryObjectOptions<Result> | undefined]
+    const use = suspense ? useSuspenseQuery : useQuery
+    return use({
+      ...options,
+      // without this, this lib won't work in React's strict mode, since every request will be immediately aborted (component unmounted).
+      gcTime: 60000,
+      queryKey: this.getKey(variables),
+      queryFn: ({ signal }) => this.callFn(variables, signal),
+    }, queryClient) as T extends true ? UseSuspenseQueryResult<Result, StackspotAPIError> : DefinedUseQueryResult<Result, StackspotAPIError>
+  }
+
+  useQuery(
+    ...args: Variables extends void
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
+  ) {
+    const result = this.#useQueryResult(true, ...args)
+    return result.data
+  }
+
+  useStatefulQuery(
+    ...args: Variables extends void
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
+  ) {
+    const result = this.#useQueryResult(false, ...args)
+    return [result.data, result.isPending, result.error as StackspotAPIError | undefined, result] as const
+  }
+
+  invalidate(variables?: Partial<Variables>) {
+    return queryClient.invalidateQueries({ queryKey: this.getKey(variables) })
+  }
+
+  getKey(variables?: Partial<Variables>)  {
+    const key: any[] = [this.apiName, this.fn.name]
+    if (variables) key.push(variables)
+    return key
+  }
+
+  cancel(variables?: Partial<Variables>) {
+    queryClient.cancelQueries({ queryKey: this.getKey(variables) })
+  }
+}