@stack-spot/portal-network 0.2.0 → 0.3.1

package/dist/network/ReactQueryNetworkClient.js

@@ -0,0 +1,144 @@
+/* eslint-disable react-hooks/rules-of-hooks */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ReactQueryNetworkClient_instances, _ReactQueryNetworkClient_parseErrorData, _ReactQueryNetworkClient_transformError, _ReactQueryNetworkClient_withErrorTreatment, _ReactQueryNetworkClient_onFetchPermission;
+import { HttpError } from '@oazapfts/runtime';
+import { StackspotAPIError } from '../error/StackspotAPIError.js';
+import { AutoInfiniteQuery } from './AutoInfiniteQuery.js';
+import { AutoMutation } from './AutoMutation.js';
+import { AutoQuery } from './AutoQuery.js';
+import { ManualInfiniteQuery } from './ManualInfiniteQuery.js';
+import { ManualMutation } from './ManualMutation.js';
+import { ManualQuery } from './ManualQuery.js';
+import { NetworkClient } from './NetworkClient.js';
+const DUMMY_ULID = '01HSTZ5471CBG4AW9BFJ0VTVG9';
+const PERMISSION_ERROR = 'permission-error';
+export const DEFAULT_PAGE_SIZE = 20;
+/**
+ * A Network Client that uses oazapfts for making requests and React Query for managing responses.
+ */
+export class ReactQueryNetworkClient extends NetworkClient {
+    /**
+     * @param baseURL An object with the keys "dev", "stg" and "prd". The values must be the url for each of these environments.
+     * @param defaults the `default` object of the API this client is for (provided by the code generated by oazapfts).
+     */
+    constructor(baseURL, defaults) {
+        super(baseURL);
+        _ReactQueryNetworkClient_instances.add(this);
+        _ReactQueryNetworkClient_withErrorTreatment.set(this, (block) => (async (...args) => {
+            try {
+                return await block(...args);
+            }
+            catch (error) {
+                throw __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_transformError).call(this, error);
+            }
+        })
+        /**
+         * Receives an HttpError and returns a StackspotAPIError.
+         * @param error the original HttpError created by oazapfts.
+         */
+        );
+        defaults.baseUrl = '';
+        defaults.fetch = (...args) => this.fetch(...args);
+    }
+    query(fnOrConfig) {
+        return typeof fnOrConfig === 'function'
+            ? new AutoQuery({
+                apiName: this.constructor.name,
+                fn: fnOrConfig,
+                onFetchPermission: (...args) => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_onFetchPermission).call(this, ...args),
+                transformError: error => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_transformError).call(this, error),
+            })
+            : new ManualQuery({
+                ...fnOrConfig,
+                apiName: this.constructor.name,
+                request: __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.request),
+                permission: fnOrConfig.permission ? __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.permission) : undefined,
+            });
+    }
+    infiniteQuery(fnOrConfig, options) {
+        return typeof fnOrConfig === 'function'
+            ? new AutoInfiniteQuery({
+                apiName: this.constructor.name,
+                fn: fnOrConfig,
+                onFetchPermission: (...args) => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_onFetchPermission).call(this, ...args),
+                transformError: error => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_transformError).call(this, error),
+            }, {
+                accumulator: options?.accumulator ?? '',
+                pageParamName: options?.pageParamName ?? 'page',
+                initialPageParam: options?.initialPageParam ?? 1,
+                defaultVariables: options?.defaultVariables ?? { size: DEFAULT_PAGE_SIZE },
+                getNextPageParam: options?.getNextPageParam ?? (({ variables, lastPage, lastPageParam }) => {
+                    const size = variables.size ?? 1;
+                    const isLastPageTheLast = lastPage && ((Array.isArray(lastPage) && lastPage.length < size)
+                        || (options?.accumulator !== undefined && options?.accumulator !== '' && lastPage[options?.accumulator]?.length < size));
+                    return isLastPageTheLast ? undefined : lastPageParam + 1;
+                }),
+            })
+            : new ManualInfiniteQuery({
+                ...fnOrConfig,
+                apiName: this.constructor.name,
+                request: __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.request),
+                permission: fnOrConfig.permission ? __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.permission) : undefined,
+            });
+    }
+    mutation(fnOrConfig) {
+        if (typeof fnOrConfig === 'function') {
+            return new AutoMutation({
+                apiName: this.constructor.name,
+                fn: fnOrConfig,
+                onFetchPermission: (...args) => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_onFetchPermission).call(this, ...args),
+                transformError: error => __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_transformError).call(this, error),
+            });
+        }
+        return new ManualMutation({
+            ...fnOrConfig,
+            apiName: this.constructor.name,
+            request: __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.request),
+            permission: fnOrConfig.permission ? __classPrivateFieldGet(this, _ReactQueryNetworkClient_withErrorTreatment, "f").call(this, fnOrConfig.permission) : undefined,
+        });
+    }
+}
+_ReactQueryNetworkClient_withErrorTreatment = new WeakMap(), _ReactQueryNetworkClient_instances = new WeakSet(), _ReactQueryNetworkClient_parseErrorData = function _ReactQueryNetworkClient_parseErrorData(error) {
+    if (typeof error.data === 'string') {
+        try {
+            return JSON.parse(error.data);
+        }
+        catch { /* empty */ }
+    }
+    return error.data;
+}, _ReactQueryNetworkClient_transformError = function _ReactQueryNetworkClient_transformError(error) {
+    if (!(error instanceof HttpError))
+        throw new StackspotAPIError({ status: 0, message: error?.message || `${error}`, stack: error.stack });
+    const data = __classPrivateFieldGet(this, _ReactQueryNetworkClient_instances, "m", _ReactQueryNetworkClient_parseErrorData).call(this, error);
+    if (data.type === PERMISSION_ERROR) {
+        // eslint-disable-next-line no-console
+        console.error('Error while validating permissions:', data.message);
+        return new StackspotAPIError({
+            status: 500,
+            stack: error.stack,
+            message: language => language === 'pt'
+                ? 'Ocorreu um erro ao validar as permissões.'
+                : 'There was an error while validating permissions.',
+        });
+    }
+    return this.buildStackSpotError(error);
+}, _ReactQueryNetworkClient_onFetchPermission = async function _ReactQueryNetworkClient_onFetchPermission(input, init) {
+    const [path, method, body] = input instanceof Request
+        ? [input.url, input.method, input.body]
+        : [`${input}`, (init?.method?.toLowerCase() || 'get'), init?.body];
+    try {
+        /* We allow the dev not to pass any variable when validating a permission. For this reason, oazapfts might generate a path with
+        "undefined". If this happens, we must replace the undefined text with a dummy ULID. */
+        const fixedPath = path.replace(/\/undefined(\/|$)/g, `/${DUMMY_ULID}$1`);
+        const isAllowed = await this.requestPermission(method, fixedPath, body);
+        return new Response(`${isAllowed}`, { headers: { 'Content-Type': 'application/json' } });
+    }
+    catch (error) {
+        return new Response(JSON.stringify({ type: PERMISSION_ERROR, message: error.message || `${error}` }), { status: 500 });
+    }
+};
+//# sourceMappingURL=ReactQueryNetworkClient.js.map

package/dist/network/ReactQueryNetworkClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReactQueryNetworkClient.js","sourceRoot":"","sources":["../../src/network/ReactQueryNetworkClient.ts"],"names":[],"mappings":"AAAA,+CAA+C;;;;;;;AAE/C,OAAO,EAAY,SAAS,EAAe,MAAM,mBAAmB,CAAA;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAG/C,MAAM,UAAU,GAAG,4BAA4B,CAAA;AAC/C,MAAM,gBAAgB,GAAG,kBAAkB,CAAA;AAC3C,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAEnC;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,aAAa;IACjE;;;OAGG;IACH,YAAY,OAA4B,EAAE,QAAuB;QAC/D,KAAK,CAAC,OAAO,CAAC,CAAA;;QA+BhB,sDAAsB,CAA6B,KAAyC,EAAwC,EAAE,CAAC,CACrI,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;YAChB,IAAI,CAAC;gBACH,OAAO,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;YAC7B,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,MAAM,uBAAA,IAAI,mFAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,CAAA;YACnC,CAAC;QACH,CAAC,CACF;QAED;;;WAGG;UALF;QAtCC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAA;QACrB,QAAQ,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;IACnD,CAAC;IAgFS,KAAK,CAAC,UAAe;QAC7B,OAAO,OAAO,UAAU,KAAK,UAAU;YACrC,CAAC,CAAC,IAAI,SAAS,CACb;gBACE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC9B,EAAE,EAAE,UAAU;gBACd,iBAAiB,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,uBAAA,IAAI,sFAAmB,MAAvB,IAAI,EAAoB,GAAG,IAAI,CAAC;gBAChE,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAA,IAAI,mFAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC;aACrD,CACF;YACD,CAAC,CAAC,IAAI,WAAW,CAAC;gBAChB,GAAG,UAAU;gBACb,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC9B,OAAO,EAAE,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,OAAO,CAAC;gBACrD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;aAChG,CAAC,CAAA;IACN,CAAC;IAqDS,aAAa,CACrB,UAAe,EAAE,OAA2D;QAE5E,OAAO,OAAO,UAAU,KAAK,UAAU;YACrC,CAAC,CAAC,IAAI,iBAAiB,CACrB;gBACE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC9B,EAAE,EAAE,UAAU;gBACd,iBAAiB,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,uBAAA,IAAI,sFAAmB,MAAvB,IAAI,EAAoB,GAAG,IAAI,CAAC;gBAChE,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAA,IAAI,mFAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC;aACrD,EACD;gBACE,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,EAAE;gBACvC,aAAa,EAAE,OAAO,EAAE,aAAa,IAAI,MAAM;gBAC/C,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,CAAC;gBAChD,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,EAAE,IAAI,EAAE,iBAAiB,EAAE;gBAC1E,gBAAgB,EAAE,OAAO,EAAE,gBAAgB,IAAI,CAAC,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE;oBACzF,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,IAAI,CAAC,CAAA;oBAChC,MAAM,iBAAiB,GAAG,QAAQ,IAAI,CACpC,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;2BAChD,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,IAAI,OAAO,EAAE,WAAW,KAAK,EAAE,IAAI,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,CACxH,CAAA;oBACD,OAAO,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAA;gBAC1D,CAAC,CAAC;aACH,CACF;YACD,CAAC,CAAC,IAAI,mBAAmB,CAAC;gBACxB,GAAG,UAAU;gBACb,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC9B,OAAO,EAAE,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,OAAO,CAAC;gBACrD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;aAChG,CAAC,CAAA;IACN,CAAC;IAuBS,QAAQ,CAAC,UAAe;QAChC,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;YACrC,OAAO,IAAI,YAAY,CACrB;gBACE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;gBAC9B,EAAE,EAAE,UAAU;gBACd,iBAAiB,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,uBAAA,IAAI,sFAAmB,MAAvB,IAAI,EAAoB,GAAG,IAAI,CAAC;gBAChE,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAA,IAAI,mFAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC;aACrD,CACF,CAAA;QACH,CAAC;QACD,OAAO,IAAI,cAAc,CAAC;YACxB,GAAG,UAAU;YACb,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YAC9B,OAAO,EAAE,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,OAAO,CAAC;YACrD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,uBAAA,IAAI,mDAAoB,MAAxB,IAAI,EAAqB,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAChG,CAAC,CAAA;IACJ,CAAC;CACF;4MA5NiB,KAAgB;IAC9B,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/B,CAAC;QAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAA;AACnB,CAAC,6FAEe,KAAU;IACxB,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC;QAAE,MAAM,IAAI,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,IAAI,GAAG,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAA;IACxI,MAAM,IAAI,GAAG,uBAAA,IAAI,mFAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,CAAA;IACxC,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACnC,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAClE,OAAO,IAAI,iBAAiB,CAAC;YAC3B,MAAM,EAAE,GAAG;YACX,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC,QAAQ,KAAK,IAAI;gBACpC,CAAC,CAAC,2CAA2C;gBAC7C,CAAC,CAAC,kDAAkD;SACvD,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;AACxC,CAAC,+CAkBD,KAAK,qDAAoB,KAA6B,EAAE,IAA8B;IACpF,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,KAAK,YAAY,OAAO;QACnD,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAoB,EAAE,KAAK,CAAC,IAAI,CAAC;QACrD,CAAC,CAAC,CAAC,GAAG,KAAK,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,KAAK,CAAe,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;IAClF,IAAI,CAAC;QACH;8FACsF;QACtF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,IAAI,UAAU,IAAI,CAAC,CAAA;QACxE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,IAAW,CAAC,CAAA;QAC9E,OAAO,IAAI,QAAQ,CAAC,GAAG,SAAS,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,CAAC,CAAA;IAC1F,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,GAAG,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAA;IACxH,CAAC;AACH,CAAC"}

package/dist/network/react-query-client.d.ts

@@ -0,0 +1,6 @@
+import { QueryClient } from '@tanstack/react-query';
+/**
+ * The global, unique, Query Client for React Query.
+ */
+export declare const queryClient: QueryClient;
+//# sourceMappingURL=react-query-client.d.ts.map

package/dist/network/react-query-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-query-client.d.ts","sourceRoot":"","sources":["../../src/network/react-query-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD;;GAEG;AACH,eAAO,MAAM,WAAW,aAA8F,CAAA"}

package/dist/network/react-query-client.js

@@ -0,0 +1,6 @@
+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 } } });
+//# sourceMappingURL=react-query-client.js.map

package/dist/network/react-query-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-query-client.js","sourceRoot":"","sources":["../../src/network/react-query-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,EAAE,oBAAoB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA"}

package/dist/network/types.d.ts

@@ -0,0 +1,234 @@
+import type { RequestOpts } from '@oazapfts/runtime';
+import { Session } from '@stack-spot/auth';
+import { InfiniteData, MutateOptions, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+import { StackspotAPIError } from '../error/StackspotAPIError.js';
+export interface SessionManager {
+    hasSession(): boolean;
+    endSession(): void;
+    getSession(): Session;
+}
+export type Env = 'dev' | 'stg' | 'prd';
+export type HTTPMethod = 'post' | 'patch' | 'delete' | 'put' | 'get';
+export interface OperationConfig<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result> {
+    /**
+     * The operation name. To be used as key in React Query.
+     */
+    name: string;
+    /**
+     * The function to run once the operation is called.
+     * @param abortSignal the AbortSignal to pass to any request made.
+     * @param variables if this operation accepts variables, the second parameter is the variables object.
+     * @returns the operation result (this should not be a Response object, but it could be its body).
+     */
+    request: (...args: Args) => Promise<Result>;
+    /**
+     * The function to run once one asks if the operation is allowed.
+     * @param variables if this operation accepts variables, the single parameter is the variables object.
+     * @returns a promise that resolves to true if the operation is allowed and false otherwise.
+     */
+    permission: (...args: Args extends [AbortSignal] ? [] : [Args[1]]) => Promise<boolean>;
+}
+export interface InfiniteQueryOptions<Variables, Result, PageParamName extends keyof Variables, Accumulator extends keyof Result | ''> {
+    /**
+     * The name of the variable that controls the current page.
+     */
+    pageParamName: PageParamName;
+    /**
+     * The name of the property in the Result that contains the items of a page. If the result itself is the array of items, use an empty
+     * string ('').
+     */
+    accumulator?: Accumulator;
+    /**
+     * The initial value for page variable.
+     */
+    initialPageParam: Variables[PageParamName];
+    /**
+     * Some defaults to be used when a variable is not specified.
+     */
+    defaultVariables?: Partial<Variables>;
+    /**
+     * A function that determines the value of the page variable in order to get the next page.
+     * @parar context the current context with the variables and page details.
+     * @returns undefined or null if there are no more pages. The next value for the page variable otherwise.
+     */
+    getNextPageParam: (context: {
+        /**
+         * the original set of variables passed to the hook `useInfiniteQuery`.
+         */
+        variables: Variables;
+        /**
+         * the last page Result.
+         */
+        lastPage: Result;
+        /**
+         * the Results of each page.
+         */
+        allPages: Result[];
+        /**
+         * the value of the page variable used to retrieve the last page.
+         */
+        lastPageParam: Variables[PageParamName];
+        /**
+         * the values of the page variable for requesting each of the pages.
+         */
+        allPageParams: Variables[PageParamName][];
+    }) => Variables[PageParamName] | undefined | null;
+}
+export interface FullOperationConfig<Args extends [AbortSignal, Record<string, any>] | [AbortSignal], Result> extends OperationConfig<Args, Result> {
+    /**
+     * The name of the API where this operation is called: used for composing a query key.
+     */
+    apiName: string;
+}
+export type InfiniteQueryConfig<Variables extends Record<string, any>, Result, PageParamName extends keyof Variables, Accumulator extends keyof Result | ''> = OperationConfig<[AbortSignal, Variables], Result> & InfiniteQueryOptions<Variables, Result, PageParamName, Accumulator>;
+export interface OperationObject<Variables> {
+    /**
+     * Checks if this operation is allowed for the user currently logged in.
+     * @param variables the variables for the operation, if a required url parameter is not provided, it's replaced by a default string.
+     * @returns a promise that resolves to true if the operation is allowed or false otherwise.
+     * @throws `StackspotAPIError`
+     */
+    isAllowed: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => Promise<boolean>;
+    /**
+     * Same as `isAllowed`, but a React Hook instead.
+     * @param args if this operation accepts variables, the first argument should be the variables and the second the query options
+     * (optional). If it doesn't accept variables, the single optional argument must be the query options. Moreover, if a required url
+     * parameter is not provided, it's replaced by a default string.
+     * @returns an array with 4 items:
+     * - [0]: true if allowed, false if not allowed, undefined if not fetched.
+     * - [1]: true if pending, false otherwise.
+     * - [2]: a StackspotAPIError if an error happens, null or undefined otherwise.
+     * - [3]: the original UseQueryResult object, from ReactQuery.
+     */
+    useAllowed: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables?: Partial<Variables>, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Readonly<[boolean | undefined, boolean, StackspotAPIError | null | undefined, UseQueryResult<boolean, StackspotAPIError>]>;
+    /**
+     * Gets the key for the query used to verify if this operation is allowed.
+     *
+     * Attention: invalidating this key won't clear the cache, since the `@stack-spot/opa` library doesn't support individual cache
+     * invalidation.
+     * @param args if this operation accepts variables, the first argument should be the variables and the second the query options
+     * (optional). If it doesn't accept variables, the single optional argument must be the query options. Moreover, if a required url
+     * parameter is not provided, it's replaced by a default string.
+     * @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 interface QueryObject<Variables, Result> extends OperationObject<Variables> {
+    /**
+     * Runs the query operation.
+     * @param variables the request variables if this query accepts variables.
+     * @returns a Promise with the response data
+     * @throws `StackspotAPIError`
+     */
+    query: (...args: Variables extends void ? [] : [variables: Variables]) => Promise<Result>;
+    /**
+     * Same as `query`, but, instead of an async function, this is a React Hook that expects a React Suspense environment.
+     *
+     * If you want a hook that performs a stateful query instead of relying in Suspense, call `useStatefulQuery` instead.
+     *
+     * @param args if this query accepts variables, the first argument should be the variables and the second the query options
+     * (optional). If it doesn't accept variables, the single optional argument must be the query options.
+     * @returns the response data or undefined if not fetched.
+     * @throws `StackspotAPIError`
+     * @throws `Promise<Result>`
+     */
+    useQuery: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Result | undefined;
+    /**
+     * Same as `query`, but a React Hook instead.
+     * @param args if this query accepts variables, the first argument should be the variables and the second the query options
+     * (optional). If it doesn't accept variables, the single optional argument must be the query options.
+     * @returns an array with 4 items:
+     * - [0]: the response data or undefined if not fetched.
+     * - [1]: true if pending, false otherwise.
+     * - [2]: a StackspotAPIError if an error happens, null or undefined otherwise.
+     * - [3]: the original UseQueryResult object, from ReactQuery.
+     */
+    useStatefulQuery: (...args: Variables extends void ? [options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>] : [variables: Variables, options?: Omit<UseQueryOptions, 'queryFn' | 'queryKey'>]) => Readonly<[Result | undefined, boolean, StackspotAPIError | null | undefined, UseQueryResult<Result, StackspotAPIError>]>;
+    /**
+     * Invalidates the cache for this query. A specific query can be invalidated by passing an argument (variables).
+     * @param variables if this query accepts variables, a query with specific variables can be invalidated.
+     * @returns a promise that resolves once the cache is invalidated.
+     */
+    invalidate: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => Promise<void>;
+    /**
+     * Gets the key for this query.
+     * @param variables the variables for the query.
+     * @returns the query key.
+     */
+    getKey: (...args: Variables extends void ? [] : [variables?: Partial<Variables>]) => any[];
+}
+export type UseInfiniteQueryObjectOptions = Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>;
+export interface InfiniteQueryObject<Variables, Result, Accumulator extends keyof Result | ''> extends QueryObject<Variables, Result> {
+    /**
+     * Builds up a list with the result of multiple pages. This relies on React Suspense for error and first-loading feedbacks.
+     *
+     * Equivalent to React Query's `useSuspenseInfiniteQuery`.
+     * @param variables the variables for the query.
+     * @param options the options for the query.
+     * @returns an array with 2 items:
+     * - [0]: the list of items.
+     * - [1]: the original UseInfiniteQueryResult object, from ReactQuery.
+     */
+    useInfiniteQuery: (...args: Partial<Variables> extends Variables ? [variables?: Variables, options?: UseInfiniteQueryObjectOptions] : [variables: Variables, options?: UseInfiniteQueryObjectOptions]) => Readonly<[
+        (Accumulator extends keyof Result ? Result[Accumulator] : Result) | undefined,
+        UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>
+    ]>;
+    /**
+     * Builds up a list with the result of multiple pages.
+     *
+     * Equivalent to React Query's `useInfiniteQuery`.
+     * @param variables the variables for the query.
+     * @param options the options for the query.
+     * @returns an array with 4 items:
+     * - [0]: the list of items.
+     * - [1]: true if fetching the first page, false otherwise.
+     * - [2]: a StackspotAPIError if an error happens, null or undefined otherwise.
+     * - [3]: the original UseInfiniteQueryResult object, from ReactQuery.
+     */
+    useStatefulInfiniteQuery: (...args: Partial<Variables> extends Variables ? [variables?: Variables, options?: Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>] : [variables: Variables, options?: Omit<UseInfiniteQueryOptions, 'queryFn' | 'queryKey' | 'getNextPageParam' | 'initialPageParam'>]) => Readonly<[
+        (Accumulator extends keyof Result ? Result[Accumulator] : Result) | undefined,
+        boolean,
+        StackspotAPIError | undefined | null,
+        UseInfiniteQueryResult<InfiniteData<Result>, StackspotAPIError>
+    ]>;
+}
+export interface AutoQueryObjectParams<Variables, Result> {
+    apiName: string;
+    fn: ((variables: Variables, opts?: RequestOpts) => Promise<Result>) | ((opts?: RequestOpts) => Promise<Result>);
+    onFetchPermission: typeof fetch;
+    transformError?: (error: any) => StackspotAPIError;
+}
+export interface MutationObject<Variables, Result> extends OperationObject<Variables> {
+    /**
+     * Runs the mutation and returns a promise.
+     * @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>;
+    /**
+     * A React hook equivalent to React Query's `useMutation`. It creates a mutation function and the mutation states.
+     * @param options the options for `useMutation`
+     * @returns an array with 4 items:
+     * - [0]: the mutation function (equivalent to `mutateAsync` from the result of a `useMutation`).
+     * - [1]: true if pending, false otherwise.
+     * - [2]: a StackspotAPIError if an error happens, undefined otherwise.
+     * - [3]: the original UseMutationResult object, from ReactQuery.
+     *
+     */
+    useMutation: (options?: Omit<UseMutationOptions<Result, StackspotAPIError, Variables>, 'mutationFn'>) => Readonly<[
+        (...args: Variables extends void ? [options?: MutateOptions<Result, StackspotAPIError>] : [variables: Variables, options?: MutateOptions<Result, StackspotAPIError, Variables>]) => Promise<Result>,
+        boolean,
+        StackspotAPIError | undefined,
+        UseMutationResult<Result, StackspotAPIError, Variables>
+    ]>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/network/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/network/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC5L,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC7B,UAAU,IAAI,OAAO,CAAC;IACtB,UAAU,IAAI,IAAI,CAAC;IACnB,UAAU,IAAI,OAAO,CAAC;CACvB;AAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAEvC,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,KAAK,CAAA;AAEpE,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,MAAM;IACtG;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C;;;;OAIG;IACH,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACxF;AAGD,MAAM,WAAW,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,SAAS,MAAM,SAAS,EAAE,WAAW,SAAS,MAAM,MAAM,GAAG,EAAE;IACnI;;OAEG;IACH,aAAa,EAAE,aAAa,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,gBAAgB,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAC3C;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACtC;;;;OAIG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAC1B;;WAEG;QACH,SAAS,EAAE,SAAS,CAAC;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB;;WAEG;QACH,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC;;WAEG;QACH,aAAa,EAAG,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;KAC5C,KAAK,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,mBAAmB,CAClC,IAAI,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,MAAM,CACvE,SAAQ,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,mBAAmB,CAC7B,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrC,MAAM,EACN,aAAa,SAAS,MAAM,SAAS,EACrC,WAAW,SAAS,MAAM,MAAM,GAAG,EAAE,IACnC,eAAe,CAAC,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,GAAG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;AAE3H,MAAM,WAAW,eAAe,CAAC,SAAS;IACxC;;;;;OAKG;IACH,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACzG;;;;;;;;;;OAUG;IACH,UAAU,EAAE,CACV,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAC1F,QAAQ,CAAC,CAAC,OAAO,GAAG,SAAS,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,EAAE,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAChI;;;;;;;;;OASG;IACH,gBAAgB,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;IACrG;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC;CACrD;AAED,MAAM,WAAW,WAAW,CAAC,SAAS,EAAE,MAAM,CAAE,SAAQ,eAAe,CAAC,SAAS,CAAC;IAChF;;;;;OAKG;IACH,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1F;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CACR,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAChF,MAAM,GAAG,SAAS,CAAC;IACxB;;;;;;;;;OASG;IACH,gBAAgB,EAAE,CAChB,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC3B,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,GACzD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC,KAChF,QAAQ,CAAC,CAAC,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,EAAE,cAAc,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC9H;;;;OAIG;IACH,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvG;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;CAC5F;AAED,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,uBAAuB,EAAE,SAAS,GAAG,UAAU,GAAG,kBAAkB,GAAG,kBAAkB,CAAC,CAAA;AAE3I,MAAM,WAAW,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,SAAS,MAAM,MAAM,GAAG,EAAE,CAAE,SAAQ,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC;IACnI;;;;;;;;;OASG;IACH,gBAAgB,EAAE,CAChB,GAAG,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,SAAS,GACzC,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,6BAA6B,CAAC,GAChE,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,6BAA6B,CAAC,KAChE,QAAQ,CAAC;QACZ,CAAC,WAAW,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,GAAG,SAAS;QAC7E,sBAAsB,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;KAChE,CAAC,CAAC;IACH;;;;;;;;;;;OAWG;IACH,wBAAwB,EAAE,CACxB,GAAG,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC,SAAS,SAAS,GACzC,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,SAAS,GAAG,UAAU,GAAG,kBAAkB,GAAG,kBAAkB,CAAC,CAAC,GAClI,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,SAAS,GAAG,UAAU,GAAG,kBAAkB,GAAG,kBAAkB,CAAC,CAAC,KAClI,QAAQ,CAAC;QACZ,CAAC,WAAW,SAAS,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,GAAG,SAAS;QAC7E,OAAO;QACP,iBAAiB,GAAG,SAAS,GAAG,IAAI;QACpC,sBAAsB,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;KAChE,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,qBAAqB,CAAC,SAAS,EAAE,MAAM;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAChH,iBAAiB,EAAE,OAAO,KAAK,CAAC;IAChC,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,iBAAiB,CAAC;CACpD;AAED,MAAM,WAAW,cAAc,CAAC,SAAS,EAAE,MAAM,CAAE,SAAQ,eAAe,CAAC,SAAS,CAAC;IACnF;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAAG,EAAE,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3F;;;;;;;;;OASG;IACH,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC,EAAE,YAAY,CAAC,KAClG,QAAQ,CAAC;QACP,CAAC,GAAG,IAAI,EAAE,SAAS,SAAS,IAAI,GAC5B,CAAC,OAAO,CAAC,EAAG,aAAa,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,GACrD,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC,KACpF,OAAO,CAAC,MAAM,CAAC;QACpB,OAAO;QACP,iBAAiB,GAAG,SAAS;QAC7B,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,CAAC;KACxD,CAAC,CAAC;CACN"}

package/dist/network/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/network/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/network/types.ts"],"names":[],"mappings":""}

package/dist/utils/use-extended-list.d.ts

@@ -0,0 +1,39 @@
+type ExtensionMap<T> = Record<string, (item: T) => any>;
+type Unpromisify<T> = T extends Promise<infer R> ? R : T;
+type Extension<E extends ExtensionMap<any>> = {
+    [K in keyof E]?: Unpromisify<ReturnType<E[K]>>;
+};
+type ItemWithExtensions<T, E extends ExtensionMap<T>> = T & Extension<E>;
+/**
+ * Computes the given extensions for the items in the list passed as parameter. An extension will, most of the times, return a promise,
+ * but it can return whatever you'd like.
+ *
+ * If the extensions are promises and are still loading, the items won't have the corresponding keys.
+ *
+ * Attention: once an extension is calculated for an item, it's never calculated again. An item is identified by the parameter "idProp"
+ * (3rd), which is "id" by default.
+ *
+ * @example
+ * ```
+ * const [groups] = accountClient.memberGroups.useInfiniteQuery({ memberId: 'someId' })
+ * const extendedGroups = useExtendedList(groups, {
+ *   canRemoveMemberFromGroup: group => accountClient.removeMemberFromGroup.isAllowed({ groupId: group.id, memberId: 'someId' }),
+ *   title: group => `${group.name} (${group.totalUsers})`,
+ * })
+ * ```
+ * Above, each item in `extendedGroups` will have the properties `canRemoveMemberFromGroup` and `title`, once all permission have been
+ * fetched.
+ *
+ * @param list the items to compute extensions for.
+ * @param extensions an object where the keys are the extension names and the values are functions that return the value of the extension.
+ * @param idProp the name of the property that can be used as an id. 'id' by default.
+ * @returns an array with 2 items:
+ * - [0]: the list with the permission properties.
+ * - [1]: true if waiting for a promise, false otherwise.
+ */
+export declare function useExtendedList<T, E extends ExtensionMap<T>>(list: T[], extensions: E, idProp: keyof T): [ItemWithExtensions<T, E>[], boolean];
+export declare function useExtendedList<T extends {
+    id: string;
+}, E extends ExtensionMap<T>>(list: T[], extensions: E, idProp?: keyof T): [ItemWithExtensions<T, E>[], boolean];
+export {};
+//# sourceMappingURL=use-extended-list.d.ts.map

package/dist/utils/use-extended-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-extended-list.d.ts","sourceRoot":"","sources":["../../src/utils/use-extended-list.ts"],"names":[],"mappings":"AAEA,KAAK,YAAY,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,GAAG,CAAC,CAAA;AAEvD,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAExD,KAAK,SAAS,CAAC,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAEhG,KAAK,kBAAkB,CAAC,CAAC,EAAE,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EAC1D,IAAI,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GACxC,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;AACxC,wBAAgB,eAAe,CAAC,CAAC,SAAS;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACjF,IAAI,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,GACzC,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA"}

package/dist/utils/use-extended-list.js

@@ -0,0 +1,36 @@
+import { useEffect, useRef, useState } from 'react';
+export function useExtendedList(list, extensions, idProp = 'id') {
+    const [listWithExtensions, setListWithExtensions] = useState(list);
+    const [isLoading, setLoading] = useState(true);
+    const extensionMap = useRef(new Map());
+    const listId = list.map(i => i[idProp]).join(';');
+    useEffect(() => {
+        async function update() {
+            setLoading(true);
+            const newList = await Promise.all(list.map(async (item) => {
+                const itemExtensions = extensionMap.current.get(item[idProp]) ?? {};
+                if (Object.keys(itemExtensions).length === 0) {
+                    await Promise.all(Object.keys(extensions).map(async (key) => {
+                        try {
+                            // "await" because it might be a promise
+                            itemExtensions[key] = await extensions[key](item);
+                        }
+                        catch (error) {
+                            // eslint-disable-next-line no-console
+                            console.error(`Failed to compute extension "${String(key)}" for item with id "${item[idProp]}". It will have undefined as its value, which may cause errors ahead. Caused by the error below:`);
+                            // eslint-disable-next-line no-console
+                            console.error(error);
+                        }
+                    }));
+                    extensionMap.current.set(item[idProp], itemExtensions);
+                }
+                return { ...item, ...itemExtensions };
+            }));
+            setLoading(false);
+            setListWithExtensions(newList);
+        }
+        update();
+    }, [listId]);
+    return [listWithExtensions.length ? listWithExtensions : list, isLoading];
+}
+//# sourceMappingURL=use-extended-list.js.map

package/dist/utils/use-extended-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-extended-list.js","sourceRoot":"","sources":["../../src/utils/use-extended-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AA2CnD,MAAM,UAAU,eAAe,CAC7B,IAAS,EAAE,UAAa,EAAE,SAAS,IAAe;IAElD,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,CAAC,GAAG,QAAQ,CAAC,IAAkC,CAAC,CAAA;IAChG,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC9C,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,GAAG,EAAqB,CAAC,CAAA;IACzD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAEjD,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,UAAU,MAAM;YACnB,UAAU,CAAC,IAAI,CAAC,CAAA;YAChB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;gBACxD,MAAM,cAAc,GAAiB,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAA;gBACjF,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC7C,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,GAAY,EAAE,EAAE;wBACnE,IAAI,CAAC;4BACH,wCAAwC;4BACxC,cAAc,CAAC,GAAG,CAAC,GAAG,MAAM,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;wBACnD,CAAC;wBAAC,OAAO,KAAK,EAAE,CAAC;4BACf,sCAAsC;4BACtC,OAAO,CAAC,KAAK,CAAC,gCAAgC,MAAM,CAAC,GAAG,CAAC,uBAAuB,IAAI,CAAC,MAAM,CAAC,kGAAkG,CAAC,CAAA;4BAC/L,sCAAsC;4BACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;wBACtB,CAAC;oBACH,CAAC,CAAC,CAAC,CAAA;oBACH,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,CAAA;gBACxD,CAAC;gBACD,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,cAAc,EAAE,CAAA;YACvC,CAAC,CAAC,CAAC,CAAA;YACH,UAAU,CAAC,KAAK,CAAC,CAAA;YACjB,qBAAqB,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC;QACD,MAAM,EAAE,CAAA;IACV,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;IAEZ,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAkC,EAAE,SAAS,CAAC,CAAA;AACzG,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stack-spot/portal-network",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",