@stack-spot/portal-network 0.45.0 → 0.46.0

package/src/network/react-query-client.ts

@@ -3,4 +3,12 @@ import { QueryClient } from '@tanstack/react-query'
 /**
  * The global, unique, Query Client for React Query.
  */
-export const queryClient = new QueryClient({ defaultOptions: { queries: { refetchOnWindowFocus: false, retry: 3, staleTime: Infinity } } })
+export const queryClient = new QueryClient({
+  defaultOptions: {
+    queries: {
+      refetchOnWindowFocus: false,
+      retry: false,
+      staleTime: Infinity,
+    },
+  },
+})

package/src/network/types.ts

@@ -136,15 +136,6 @@ export interface OperationObject<Variables> {
    * @returns the query key.
    */
   getPermissionKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[],
-  /**
-   * Cancels the request if it hasn't finished yet.
-   * 
-   * A canceled request will fail by throwing a `CanceledError`.
-   * 
-   * @param variables the variables for the operation. If not provided, this will cancel all requests in progress for this operation.
-   * @returns true if any request has been canceled, false otherwise.
-   */
-  cancel: (variables?: Partial<Variables>) => boolean,
 }
 
 export type UseQueryObjectOptions<Result> = Omit<UseQueryOptions<Result, StackspotAPIError>, 'queryFn' | 'queryKey'>
@@ -200,6 +191,12 @@ export interface QueryObject<Variables, Result> extends OperationObject<Variable
    * @returns the query key.
    */
   getKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[],
+  /**
+   * Cancels the query if it hasn't finished yet.
+   * 
+   * @param variables the variables for the operation. If not provided, this will cancel all requests in progress for this query.
+   */
+  cancel: (variables?: Partial<Variables>) => void,
 }
 
 export type UseInfiniteQueryObjectOptions<Result> = Omit<
@@ -263,7 +260,7 @@ export interface MutationObject<Variables, Result> extends OperationObject<Varia
    * @param args the variables for the mutation.
    * @returns a promise that resolves to the response's data.
    */
-  mutate: (...args: Variables extends void ? [] : [variables: Variables]) => Promise<Result>,
+  mutate: (...args: Variables extends void ? [signal?: AbortSignal] : [variables: Variables, signal?: AbortSignal]) => Promise<Result>,
   /**
    * A React hook equivalent to React Query's `useMutation`. It creates a mutation function and the mutation states.
    * @param options the options for `useMutation`
@@ -274,7 +271,7 @@ export interface MutationObject<Variables, Result> extends OperationObject<Varia
    * - [3]: the original UseMutationResult object, from ReactQuery.
    * 
    */
-  useMutation: (options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'>) =>
+  useMutation: (options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'> & { signal?: AbortSignal }) =>
     Readonly<[
       (...args: Variables extends void
         ? [options?:  MutateOptions<Result, StackspotAPIError>]
@@ -286,7 +283,7 @@ export interface MutationObject<Variables, Result> extends OperationObject<Varia
     ]>,
 }
 
-export type OperationVariables<T extends Pick<OperationObject<any>, 'cancel'>> = T extends Pick<OperationObject<infer R>, 'cancel'>
+export type OperationVariables<T extends Pick<OperationObject<any>, 'isAllowed'>> = T extends Pick<OperationObject<infer R>, 'isAllowed'>
   ? R
   : never
 export type OperationResult<T extends { query: (variables?: any) => Promise<any> } | { mutate: (variables?: any) => Promise<any> }> = 

package/dist/error/CanceledError.d.ts

@@ -1,8 +0,0 @@
-import { StackspotAPIError } from './StackspotAPIError.js';
-/**
- * This error is thrown when a request is canceled by the user before it completes.
- */
-export declare class CanceledError extends StackspotAPIError {
-    constructor();
-}
-//# sourceMappingURL=CanceledError.d.ts.map

package/dist/error/CanceledError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CanceledError.d.ts","sourceRoot":"","sources":["../../src/error/CanceledError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD;;GAEG;AACH,qBAAa,aAAc,SAAQ,iBAAiB;;CAInD"}

package/dist/error/CanceledError.js

@@ -1,10 +0,0 @@
-import { StackspotAPIError } from './StackspotAPIError.js';
-/**
- * This error is thrown when a request is canceled by the user before it completes.
- */
-export class CanceledError extends StackspotAPIError {
-    constructor() {
-        super({ status: 0, message: lang => lang === 'en' ? 'Canceled by the user' : 'Cancelado pelo usuário' });
-    }
-}
-//# sourceMappingURL=CanceledError.js.map

package/dist/error/CanceledError.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CanceledError.js","sourceRoot":"","sources":["../../src/error/CanceledError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,iBAAiB;IAClD;QACE,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,wBAAwB,EAAE,CAAC,CAAA;IAC1G,CAAC;CACF"}

package/src/error/CanceledError.ts

@@ -1,10 +0,0 @@
-import { StackspotAPIError } from './StackspotAPIError'
-
-/**
- * This error is thrown when a request is canceled by the user before it completes.
- */
-export class CanceledError extends StackspotAPIError {
-  constructor() {
-    super({ status: 0, message: lang => lang === 'en' ? 'Canceled by the user' : 'Cancelado pelo usuário' })
-  }
-}