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

package/src/network/ManualInfiniteQuery.ts

@@ -1,95 +1,95 @@
-/* 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 { ManualQuery } from './ManualQuery'
-import { queryClient } from './react-query-client'
-import { FullOperationConfig, InfiniteQueryConfig, InfiniteQueryObject, UseInfiniteQueryObjectOptions } from './types'
-
-export class ManualInfiniteQuery<
-  Variables extends Record<string, any>,
-  Result,
-  PageParamName extends keyof Variables,
-  Accumulator extends keyof Result | ''
-> extends ManualQuery<Variables, Result> implements InfiniteQueryObject<Variables, Result, Accumulator> {
-  constructor(
-    config: InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
-      & { apiName: string, transformError: (error: any) => StackspotAPIError },
-  ) {
-    super(config as FullOperationConfig<any, any>)
-  }
-
-  private getConfig() {
-    return this.config as unknown as InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
-  }
-
-  private createInfiniteQueryFn(
-    variables: Variables,
-  ): (context: QueryFunctionContext<QueryKey, Variables[PageParamName]>) => Promise<Result> {
-    return ({ pageParam, signal }) => {
-      const paginatedVariables = {
-        ...variables,
-      } 
-      set(paginatedVariables, this.getConfig().pageParamName, pageParam ?? get(variables, this.getConfig().pageParamName))
-      return this.makeRequest(paginatedVariables, signal)
-    }
-  }
-
-  private getListFromData(data: InfiniteData<Result> | undefined) {
-    return data?.pages.map(
-      page => this.getConfig().accumulator ? page[this.getConfig().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 = { ...variables, ...this.getConfig().defaultVariables }
-    const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
-    return use<any, any, any, any, any>({
-      ...options,
-      queryKey: ['infinite', ...this.getKey(variables)],
-      queryFn: this.createInfiniteQueryFn(variables),
-      initialPageParam: this.getConfig().initialPageParam,
-      getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => 
-        this.getConfig().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: ['infinite', ...this.getKey(variables)] }),
-    ])
-  }
-}
+/* 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 { ManualQuery } from './ManualQuery'
+import { queryClient } from './react-query-client'
+import { FullOperationConfig, InfiniteQueryConfig, InfiniteQueryObject, UseInfiniteQueryObjectOptions } from './types'
+
+export class ManualInfiniteQuery<
+  Variables extends Record<string, any>,
+  Result,
+  PageParamName extends keyof Variables,
+  Accumulator extends keyof Result | ''
+> extends ManualQuery<Variables, Result> implements InfiniteQueryObject<Variables, Result, Accumulator> {
+  constructor(
+    config: InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
+      & { apiName: string, transformError: (error: any) => StackspotAPIError },
+  ) {
+    super(config as FullOperationConfig<any, any>)
+  }
+
+  private getConfig() {
+    return this.config as unknown as InfiniteQueryConfig<Variables, Result, PageParamName, Accumulator>
+  }
+
+  private createInfiniteQueryFn(
+    variables: Variables,
+  ): (context: QueryFunctionContext<QueryKey, Variables[PageParamName]>) => Promise<Result> {
+    return ({ pageParam, signal }) => {
+      const paginatedVariables = {
+        ...variables,
+      } 
+      set(paginatedVariables, this.getConfig().pageParamName, pageParam ?? get(variables, this.getConfig().pageParamName))
+      return this.makeRequest(paginatedVariables, signal)
+    }
+  }
+
+  private getListFromData(data: InfiniteData<Result> | undefined) {
+    return data?.pages.map(
+      page => this.getConfig().accumulator ? page[this.getConfig().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 = { ...variables, ...this.getConfig().defaultVariables }
+    const use = suspense ? useSuspenseInfiniteQuery : useInfiniteQuery
+    return use<any, any, any, any, any>({
+      ...options,
+      queryKey: ['infinite', ...this.getKey(variables)],
+      queryFn: this.createInfiniteQueryFn(variables),
+      initialPageParam: this.getConfig().initialPageParam,
+      getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => 
+        this.getConfig().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: ['infinite', ...this.getKey(variables)] }),
+    ])
+  }
+}

package/src/network/ManualMutation.ts

@@ -1,40 +1,40 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { UseMutationOptions, useMutation } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { ManualOperation } from './ManualOperation'
-import { queryClient } from './react-query-client'
-import { FullOperationConfig, MutationObject } from './types'
-
-export class ManualMutation<
-  Variables extends Record<string, any> | void,
-  Result
-> extends ManualOperation<Variables> implements MutationObject<Variables, Result> {
-  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], Result>) {
-    super(config)
-  }
-
-  private async makeRequest(variables?: Record<string, any>, signal: AbortSignal = new AbortController().signal) {
-    try {
-      return await this.config.request(
-        ...[signal, variables] as Variables extends void ? [AbortSignal] : [AbortSignal, Variables],
-      )
-    } catch (error) {
-      throw this.config.transformError(error)
-    }
-  }
-
-  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.makeRequest(variables, signal)
-  }
-
-  useMutation(options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'> & { signal?: AbortSignal }) {
-    const result = useMutation<Result, StackspotAPIError, Variables>({
-      ...options,
-      mutationFn: (variables: any) => this.makeRequest(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 { ManualOperation } from './ManualOperation'
+import { queryClient } from './react-query-client'
+import { FullOperationConfig, MutationObject } from './types'
+
+export class ManualMutation<
+  Variables extends Record<string, any> | void,
+  Result
+> extends ManualOperation<Variables> implements MutationObject<Variables, Result> {
+  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], Result>) {
+    super(config)
+  }
+
+  private async makeRequest(variables?: Record<string, any>, signal: AbortSignal = new AbortController().signal) {
+    try {
+      return await this.config.request(
+        ...[signal, variables] as Variables extends void ? [AbortSignal] : [AbortSignal, Variables],
+      )
+    } catch (error) {
+      throw this.config.transformError(error)
+    }
+  }
+
+  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.makeRequest(variables, signal)
+  }
+
+  useMutation(options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'> & { signal?: AbortSignal }) {
+    const result = useMutation<Result, StackspotAPIError, Variables>({
+      ...options,
+      mutationFn: (variables: any) => this.makeRequest(variables, options?.signal),
+    }, queryClient)
+    return [result.mutateAsync as any, result.isPending, result.error as StackspotAPIError | undefined, result as any] as const
+  }
+}

package/src/network/ManualOperation.ts

@@ -1,52 +1,52 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { UseQueryOptions, UseQueryResult, useQuery } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { queryClient } from './react-query-client'
-import { FullOperationConfig, OperationObject } from './types'
-
-export abstract class ManualOperation<Variables extends Record<string, any> | void> implements OperationObject<Variables> {
-  protected config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], any>
-
-  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], any>) {
-    this.config = config
-  }
-
-  private async makePermissionRequest(variables: Partial<Record<string, any>> | undefined) {
-    try {
-      // @ts-ignore the following is correct. TS can't correctly infer the conditional type here =(
-      return await this.config.permission(variables)
-    } catch (error) {
-      throw this.config.transformError(error)
-    }
-  }
-
-  isAllowed(...[variables]: Variables extends void ? [] : [variables?: Partial<Variables>]) {
-    return queryClient.fetchQuery({
-      queryKey: this.getPermissionKey(variables as Variables),
-      queryFn: () => this.makePermissionRequest(variables),
-    })
-  }
-
-  useAllowed(
-    ...args: Variables extends void
-      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-      : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
-  ) {
-    /* `this.config.permission` is a function with arity 0 or 1. If it accepts variables, its arity is 1. If it doesn't accept variables,
-    its arity is zero. 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.config.permission.length === 1 ? args : [undefined, args[0]]
-    const result = useQuery({
-      ...options,
-      queryKey: this.getPermissionKey(variables as Variables),
-      queryFn: () => this.makePermissionRequest(variables),
-    }, queryClient) as UseQueryResult<boolean, StackspotAPIError>
-    return [result.data, result.isPending, result.error, result] as const
-  }
-
-  getPermissionKey(variables?: Partial<Variables>) {
-    return [this.config.apiName, `${this.config.name}.permission`, variables]
-  }
-}
+/* eslint-disable react-hooks/rules-of-hooks */
+
+import { UseQueryOptions, UseQueryResult, useQuery } from '@tanstack/react-query'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { queryClient } from './react-query-client'
+import { FullOperationConfig, OperationObject } from './types'
+
+export abstract class ManualOperation<Variables extends Record<string, any> | void> implements OperationObject<Variables> {
+  protected config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], any>
+
+  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], any>) {
+    this.config = config
+  }
+
+  private async makePermissionRequest(variables: Partial<Record<string, any>> | undefined) {
+    try {
+      // @ts-ignore the following is correct. TS can't correctly infer the conditional type here =(
+      return await this.config.permission(variables)
+    } catch (error) {
+      throw this.config.transformError(error)
+    }
+  }
+
+  isAllowed(...[variables]: Variables extends void ? [] : [variables?: Partial<Variables>]) {
+    return queryClient.fetchQuery({
+      queryKey: this.getPermissionKey(variables as Variables),
+      queryFn: () => this.makePermissionRequest(variables),
+    })
+  }
+
+  useAllowed(
+    ...args: Variables extends void
+      ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+      : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]
+  ) {
+    /* `this.config.permission` is a function with arity 0 or 1. If it accepts variables, its arity is 1. If it doesn't accept variables,
+    its arity is zero. 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.config.permission.length === 1 ? args : [undefined, args[0]]
+    const result = useQuery({
+      ...options,
+      queryKey: this.getPermissionKey(variables as Variables),
+      queryFn: () => this.makePermissionRequest(variables),
+    }, queryClient) as UseQueryResult<boolean, StackspotAPIError>
+    return [result.data, result.isPending, result.error, result] as const
+  }
+
+  getPermissionKey(variables?: Partial<Variables>) {
+    return [this.config.apiName, `${this.config.name}.permission`, variables]
+  }
+}

package/src/network/ManualQuery.ts

@@ -1,82 +1,82 @@
-/* eslint-disable react-hooks/rules-of-hooks */
-
-import { DefinedUseQueryResult, UseSuspenseQueryResult, useQuery, useSuspenseQuery } from '@tanstack/react-query'
-import { StackspotAPIError } from '../error/StackspotAPIError'
-import { ManualOperation } from './ManualOperation'
-import { queryClient } from './react-query-client'
-import { FullOperationConfig, QueryObject, UseQueryObjectOptions } from './types'
-
-export class ManualQuery<
-  Variables extends Record<string, any> | void,
-  Result
-> extends ManualOperation<Variables> implements QueryObject<Variables, Result> {
-  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], Result>) {
-    super(config)
-  }
-
-  protected async makeRequest(variables: Record<string, any> | undefined, signal: AbortSignal) {
-    try {
-      return await this.config.request(
-        ...[signal, variables] as Variables extends void ? [AbortSignal] : [AbortSignal, Variables],
-      )
-    } catch (error) {
-      throw this.config.transformError(error)
-    }
-  }
-
-  query(...[variables]: Variables extends void ? [] : [variables: Variables]) {
-    return queryClient.fetchQuery({
-      queryKey: this.getKey(variables as Variables),
-      queryFn: ({ signal }) => this.makeRequest(variables, signal),
-    })
-  }
-
-  #useQueryResult<T extends boolean>(
-    suspense: T,
-    ...args: Variables extends void
-      ? [options?: UseQueryObjectOptions<Result>]
-      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
-  ) {
-    /* `this.config.request` is a function with arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
-    AbortSignal and the 2nd is the variables. If it doesn't accept variables, its arity is one: it accepts only the AbortSignal.
-    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.config.request.length === 2 ? args : [undefined, args[0]]
-    const use = suspense ? useSuspenseQuery : useQuery
-    return use({
-      ...options,
-      queryKey: this.getKey(variables as Variables),
-      queryFn: ({ signal }) => this.makeRequest(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>) {
-    return [this.config.apiName, this.config.name, variables]
-  }
-
-  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 { ManualOperation } from './ManualOperation'
+import { queryClient } from './react-query-client'
+import { FullOperationConfig, QueryObject, UseQueryObjectOptions } from './types'
+
+export class ManualQuery<
+  Variables extends Record<string, any> | void,
+  Result
+> extends ManualOperation<Variables> implements QueryObject<Variables, Result> {
+  constructor(config: FullOperationConfig<Variables extends void ? [AbortSignal] : [AbortSignal, Variables], Result>) {
+    super(config)
+  }
+
+  protected async makeRequest(variables: Record<string, any> | undefined, signal: AbortSignal) {
+    try {
+      return await this.config.request(
+        ...[signal, variables] as Variables extends void ? [AbortSignal] : [AbortSignal, Variables],
+      )
+    } catch (error) {
+      throw this.config.transformError(error)
+    }
+  }
+
+  query(...[variables]: Variables extends void ? [] : [variables: Variables]) {
+    return queryClient.fetchQuery({
+      queryKey: this.getKey(variables as Variables),
+      queryFn: ({ signal }) => this.makeRequest(variables, signal),
+    })
+  }
+
+  #useQueryResult<T extends boolean>(
+    suspense: T,
+    ...args: Variables extends void
+      ? [options?: UseQueryObjectOptions<Result>]
+      : [variables: Variables, options?: UseQueryObjectOptions<Result>]
+  ) {
+    /* `this.config.request` is a function with arity 1 or 2. If it accepts variables, its arity is 2: the 1st parameter is the
+    AbortSignal and the 2nd is the variables. If it doesn't accept variables, its arity is one: it accepts only the AbortSignal.
+    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.config.request.length === 2 ? args : [undefined, args[0]]
+    const use = suspense ? useSuspenseQuery : useQuery
+    return use({
+      ...options,
+      queryKey: this.getKey(variables as Variables),
+      queryFn: ({ signal }) => this.makeRequest(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>) {
+    return [this.config.apiName, this.config.name, variables]
+  }
+
+  cancel(variables?: Partial<Variables>) {
+    queryClient.cancelQueries({ queryKey: this.getKey(variables) })
+  }
+}