@anzusystems/common-admin 1.49.0 → 2.0.0-rc.10

package/dist/domains/api/composables/useApiFetchItems.js

@@ -0,0 +1,55 @@
+import { AnzuFatalError as e } from "../../../shared/error/AnzuFatalError.js";
+import { AnzuApiResponseCodeError as t } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { replaceUrlParameters as n } from "../utils/apiHelper.js";
+import { isValidHTTPStatus as r } from "../utils/response.js";
+import "../../../shared/statusCodes.js";
+import { isDefined as i, isNull as a, isUndefined as o } from "../../../shared/utils/common.js";
+import { mapApiError as s, report as c } from "../utils/apiErrors.js";
+import { createAbortable as l, hasBody as u, ownedByHelper as d, requestedUrl as f } from "./request.js";
+import { readArrayBody as p, readListBody as m } from "../utils/listBody.js";
+// src/domains/api/composables/useApiFetchItems.ts
+var h = (h) => {
+	let { client: g, system: _, entity: v, validationSystem: y, validationEntity: b, urlTemplate: x, urlParams: S, options: C = {}, cancelPrevious: w = !1, method: T = "GET", shape: E = "envelope" } = h, D = l({ cancelPrevious: w });
+	return {
+		execute: async (l = {}) => {
+			let { urlTemplate: h, urlParams: w, body: O, signal: k } = l, A, j;
+			try {
+				let s = await D.run((t) => {
+					let r = i(h) ? h : x;
+					if (o(r)) throw new e(void 0, "Url template is undefined");
+					let s = !a(O) && !o(O);
+					if (T === "GET" && s) throw new e(void 0, "A GET request does not carry a body -- set method, or pass the value through options.params");
+					let c = i(w) ? w : S, l = o(c) ? r : n(r, c), u = {
+						...d(C),
+						method: T,
+						url: l,
+						signal: t
+					};
+					s && (u.data = JSON.stringify(O));
+					let f = g();
+					return A = l, f.request(u);
+				}, k);
+				j = s.config;
+				let c = () => f(g, A, C, void 0, j);
+				if (!r(s.status)) throw new t(s.status);
+				if (s.status === 204) return [];
+				if (!u(s)) throw new t(s.status, void 0, "Expected a response body, url: " + c());
+				return E === "array" ? p(s.data, s.status, c()) : m(s.data, s.status, c()).items;
+			} catch (e) {
+				let t = {
+					system: _,
+					entity: v,
+					validationSystem: y,
+					validationEntity: b,
+					url: f(g, A, C, e, j)
+				};
+				throw c(s(e, t), t);
+			}
+		},
+		abort: D.abort,
+		loading: D.loading
+	};
+};
+export { h as useApiFetchItems };
+
+//# sourceMappingURL=useApiFetchItems.js.map

package/dist/domains/api/composables/useApiFetchItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApiFetchItems.js","names":["useApiFetchItems","params","abortable","createAbortable","urlTemplateOverride","urlParamsOverride","fetchParams","url","dispatched","res","template","isDefined","urlTemplate","isUndefined","AnzuFatalError","sendsBody","isNull","body","method","resolvedParams","urlParams","requestUrl","replaceUrlParameters","config","ownedByHelper","options","abortSignal","instance","client","signal","asSent","requestedUrl","isValidHTTPStatus","AnzuApiResponseCodeError","hasBody","shape","readArrayBody","readListBody","err","context","report","mapApiError"],"sources":["../../../../src/domains/api/composables/useApiFetchItems.ts"],"sourcesContent":["import { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { replaceUrlParameters, type UrlParams } from '@/domains/api/utils/apiHelper'\nimport { isValidHTTPStatus } from '@/domains/api/utils/response'\nimport type { AxiosRequestConfig } from 'axios'\nimport { HTTP_STATUS_NO_CONTENT } from '@/shared/statusCodes'\nimport { isDefined, isNull, isUndefined } from '@/shared/utils/common'\nimport type { Ref } from 'vue'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { mapApiError, report } from '@/domains/api/utils/apiErrors'\nimport { createAbortable, hasBody, ownedByHelper, requestedUrl } from '@/domains/api/composables/request'\nimport { readArrayBody, readListBody } from '@/domains/api/utils/listBody'\n\n/** Which of the two shapes a list arrives in. */\nexport type ItemsShape = 'envelope' | 'array'\n\nexport type UseApiFetchItemsParams = {\n  client: AxiosClientFn\n  system: string\n  entity: string\n  /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */\n  validationSystem?: string\n  validationEntity?: string\n  /**\n   * The full url including the query, already built by the caller.\n   * `urlParams` are substituted into the path only. A placeholder in the query\n   * is sent as is. Put the value in the query or pass it via `options.params`.\n   */\n  urlTemplate?: string\n  urlParams?: UrlParams\n  options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>\n  cancelPrevious?: boolean\n  /**\n   * Defaults to `GET`.\n   * Other verbs exist because a filter too big for a url goes out\n   * as a POST, and a mutation can answer with the changed list.\n   */\n  method?: 'GET' | 'POST' | 'PUT' | 'PATCH'\n  /**\n   * Defaults to `'envelope'`, the fleet norm.\n   * The reader refuses an undeclared shape, so a forgotten `'array'` fails on the first run.\n   */\n  shape?: ItemsShape\n}\n\nexport type FetchItemsParams<B = never> = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  /** `null` omits the body, as everywhere in this family. */\n  body?: B\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n}\n\n/**\n * Fetches a list from an endpoint whose query the caller already built, without pagination.\n * Replaces `useApiRequest<ApiResponseList<T[]>>` reads, which never checked that `data`\n * is an array. `useApiFetchList` needs pagination and filter config these calls lack.\n * `shape` is declared, and the reader refuses the other shape, so a wrong declaration fails loudly.\n * Writes no metadata. Use `useApiFetchList` for user-driven paging and `useApiFetchListBatch` to read all pages.\n */\nexport const useApiFetchItems = <T, B = never>(params: UseApiFetchItemsParams): UseApiFetchItemsReturnType<T, B> => {\n  const {\n    client,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    cancelPrevious = false,\n    method = 'GET',\n    shape = 'envelope',\n  } = params\n  const abortable = createAbortable({ cancelPrevious })\n\n  const execute = async (fetchParams: FetchItemsParams<B> = {}): Promise<T[]> => {\n    const { urlTemplate: urlTemplateOverride, urlParams: urlParamsOverride, body, signal } = fetchParams\n\n    // Assigned inside `run` once a url exists. It stays undefined\n    // before that, so a failure before dispatch reports no url.\n    let url: string | undefined\n    let dispatched: AxiosRequestConfig | undefined\n\n    try {\n      const res = await abortable.run((abortSignal) => {\n        // Derived inside `run` because `run` opens the generation and, with `cancelPrevious`, stops the previous call.\n        const template = isDefined(urlTemplateOverride) ? urlTemplateOverride : urlTemplate\n        if (isUndefined(template)) throw new AnzuFatalError(undefined, 'Url template is undefined')\n\n        // `null` omits the body. To send JSON `null`, the caller wraps it.\n        const sendsBody = !isNull(body) && !isUndefined(body)\n\n        // `method` defaults to GET, so a body without `method: 'POST'` would silently send a GET without its filter.\n        if (method === 'GET' && sendsBody) {\n          throw new AnzuFatalError(\n            undefined,\n            'A GET request does not carry a body -- set method, or pass the value through options.params'\n          )\n        }\n\n        const resolvedParams = isDefined(urlParamsOverride) ? urlParamsOverride : urlParams\n        const requestUrl = isUndefined(resolvedParams) ? template : replaceUrlParameters(template, resolvedParams)\n\n        // `options` first, then the helper-owned keys, so a caller cannot override method, url, body or signal.\n        const config: AxiosRequestConfig = {\n          ...ownedByHelper(options),\n          method,\n          url: requestUrl,\n          signal: abortSignal,\n        }\n        if (sendsBody) config.data = JSON.stringify(body)\n\n        const instance = client()\n\n        // Recorded last, after anything that can throw. `JSON.stringify` fails on a circular\n        // body, which would otherwise be reported as a request to a url never called.\n        url = requestUrl\n\n        return instance.request(config)\n      }, signal)\n\n      dispatched = res.config\n      // The url the report names, so the message and context agree when an interceptor rewrote the request.\n      const asSent = () => requestedUrl(client, url, options, undefined, dispatched)\n      if (!isValidHTTPStatus(res.status)) throw new AnzuApiResponseCodeError(res.status)\n\n      // Nothing matched -- an empty answer, not a broken one.\n      if (res.status === HTTP_STATUS_NO_CONTENT) return []\n\n      if (!hasBody(res)) {\n        throw new AnzuApiResponseCodeError(res.status, undefined, 'Expected a response body, url: ' + asSent())\n      }\n\n      return shape === 'array'\n        ? readArrayBody<T>(res.data, res.status, asSent())\n        : readListBody<T>(res.data, res.status, asSent()).items\n    } catch (err: unknown) {\n      const context = {\n        system,\n        entity,\n        validationSystem,\n        validationEntity,\n        url: requestedUrl(client, url, options, err, dispatched),\n      }\n\n      throw report(mapApiError(err, context), context)\n    }\n  }\n\n  return { execute, abort: abortable.abort, loading: abortable.loading }\n}\n\nexport type UseApiFetchItemsReturnType<T, B = never> = {\n  execute: (params?: FetchItemsParams<B>) => Promise<T[]>\n  abort: () => void\n  /**\n   * True while this instance has a request in flight. Unlike a caller-cleared\n   * `finally` flag, it does not dip when `cancelPrevious` supersedes a call.\n   * It covers only this helper's work. Keep your own flag if it also spans follow-up fetches or mapping.\n   * It belongs to the instance. A factory that builds one per call cannot\n   * expose `loading`, `abort` or `cancelPrevious`, so hoist the instance first.\n   */\n  loading: Ref<boolean>\n}\n"],"mappings":";;;;;;;;;;AA6DA,IAAaA,KAAkC,MAAqE;CAClH,IAAM,EACJ,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,oBAAiB,IACjB,YAAS,OACT,WAAQ,eACNC,GACEC,IAAYC,EAAgB,EAAE,kBAAe,CAAC;CA4EpD,OAAO;EAAE,gBA1Ec,IAAmC,CAAC,MAAoB;GAC7E,IAAM,EAAE,aAAaC,GAAqB,WAAWC,GAAmB,SAAM,cAAWC,GAIrFC,GACAC;GAEJ,IAAI;IACF,IAAMC,IAAM,MAAMP,EAAU,KAAK,MAAgB;KAE/C,IAAMQ,IAAWC,EAAUP,CAAmB,IAAIA,IAAsBQ;KACxE,IAAIC,EAAYH,CAAQ,GAAG,MAAM,IAAII,EAAe,KAAA,GAAW,2BAA2B;KAG1F,IAAMC,IAAY,CAACC,EAAOC,CAAI,KAAK,CAACJ,EAAYI,CAAI;KAGpD,IAAIC,MAAW,SAASH,GACtB,MAAM,IAAID,EACR,KAAA,GACA,6FACF;KAGF,IAAMK,IAAiBR,EAAUN,CAAiB,IAAIA,IAAoBe,GACpEC,IAAaR,EAAYM,CAAc,IAAIT,IAAWY,EAAqBZ,GAAUS,CAAc,GAGnGI,IAA6B;MACjC,GAAGC,EAAcC,CAAO;MACxB;MACA,KAAKJ;MACL,QAAQK;KACV;KACA,AAAIX,MAAW,EAAO,OAAO,KAAK,UAAUE,CAAI;KAEhD,IAAMU,IAAWC,EAAO;KAMxB,OAFA,IAAMP,GAECM,EAAS,QAAQJ,CAAM;IAChC,GAAGM,CAAM;IAET,IAAapB,EAAI;IAEjB,IAAMqB,UAAeC,EAAaH,GAAQrB,GAAKkB,GAAS,KAAA,GAAWjB,CAAU;IAC7E,IAAI,CAACwB,EAAkBvB,EAAI,MAAM,GAAG,MAAM,IAAIwB,EAAyBxB,EAAI,MAAM;IAGjF,IAAIA,EAAI,WAAA,KAAmC,OAAO,CAAC;IAEnD,IAAI,CAACyB,EAAQzB,CAAG,GACd,MAAM,IAAIwB,EAAyBxB,EAAI,QAAQ,KAAA,GAAW,oCAAoCqB,EAAO,CAAC;IAGxG,OAAOK,MAAU,UACbC,EAAiB3B,EAAI,MAAMA,EAAI,QAAQqB,EAAO,CAAC,IAC/CO,EAAgB5B,EAAI,MAAMA,EAAI,QAAQqB,EAAO,CAAC,CAAC,CAAC;GACtD,SAASQ,GAAc;IACrB,IAAMC,IAAU;KACd;KACA;KACA;KACA;KACA,KAAKR,EAAaH,GAAQrB,GAAKkB,GAASa,GAAK9B,CAAU;IACzD;IAEA,MAAMgC,EAAOC,EAAYH,GAAKC,CAAO,GAAGA,CAAO;GACjD;EACF;EAEkB,OAAOrC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE"}

package/dist/domains/api/composables/useApiFetchList.d.ts

@@ -0,0 +1,44 @@
+import { UrlParams } from '../utils/apiHelper';
+import { AxiosRequestConfig } from 'axios';
+import { FilterConfig, FilterData } from '../../filters/composables/filterFactory';
+import { Ref } from 'vue';
+import { Pagination } from './pagination';
+import { AxiosClientFn } from '../utils/client';
+export type UseApiFetchListParams = {
+    client: AxiosClientFn;
+    system: string;
+    entity: string;
+    /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */
+    validationSystem?: string;
+    validationEntity?: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
+    cancelPrevious?: boolean;
+};
+export type FetchListParams = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    forceElastic?: boolean;
+    /** Stops this one call, leaving the instance's other calls alone. */
+    signal?: AbortSignal;
+    /**
+     * `false`: a failure of this call is still thrown but not sent to the api error logger.
+     * For a caller that polls a list and has already reported its first failure. It is set per call, not per instance.
+     */
+    report?: boolean;
+};
+export declare const generateListQuery: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>) => string;
+export declare const useApiFetchList: <T>(params: UseApiFetchListParams) => UseApiFetchListReturnType<T>;
+export type UseApiFetchListReturnType<T> = {
+    execute: (pagination: Ref<Pagination>, filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListParams) => Promise<T[]>;
+    abort: () => void;
+    /**
+     * True while this instance has a request in flight. Unlike a caller-cleared
+     * `finally` flag, it does not dip when `cancelPrevious` supersedes a call.
+     * It covers only this helper's work. Keep your own flag if it also spans follow-up fetches or mapping.
+     * It belongs to the instance. A factory that builds one per call cannot
+     * expose `loading`, `abort` or `cancelPrevious`, so hoist the instance first.
+     */
+    loading: Ref<boolean>;
+};

package/dist/domains/api/composables/useApiFetchList.js

@@ -0,0 +1,68 @@
+import { AnzuFatalError as e } from "../../../shared/error/AnzuFatalError.js";
+import { AnzuApiResponseCodeError as t } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { replaceUrlParameters as n } from "../utils/apiHelper.js";
+import { isValidHTTPStatus as r } from "../utils/response.js";
+import { useApiQueryBuilder as i } from "./useApiQueryBuilder.js";
+import "../../../shared/statusCodes.js";
+import { isDefined as a, isNull as o, isUndefined as s } from "../../../shared/utils/common.js";
+import { SortOrder as c } from "../types/SortOrder.js";
+import { mapApiError as l, report as u } from "../utils/apiErrors.js";
+import { createAbortable as d, hasBody as f, ownedByHelper as p, requestedUrl as m } from "./request.js";
+import { readListBody as h } from "../utils/listBody.js";
+// src/domains/api/composables/useApiFetchList.ts
+var g = (e, t, n) => {
+	let { querySetLimit: r, querySetOffset: a, querySetOrder: o, queryBuild: s, querySetFilters: l } = i();
+	return r(e.value.rowsPerPage), a(e.value.page, e.value.rowsPerPage), e.value.sortBy && o(e.value.sortBy.key, e.value.sortBy.order === c.Desc), l(t, n), s();
+}, _ = (i) => {
+	let { client: c, system: _, entity: v, validationSystem: y, validationEntity: b, urlTemplate: x, urlParams: S, options: C = {}, cancelPrevious: w = !1 } = i, T = d({ cancelPrevious: w });
+	return {
+		execute: async (i, d, w, E = {}) => {
+			let { urlTemplate: D, urlParams: O, forceElastic: k = !1, signal: A, report: j = !0 } = E, M, N, P = 0, F, I = (e) => {
+				T.generation() === P && F?.aborted !== !0 && A?.aborted !== !0 && (i.value = {
+					...i.value,
+					...e
+				});
+			};
+			try {
+				let l = await T.run((t, r) => {
+					P = r, F = t;
+					let o = a(D) ? D : x;
+					if (s(o)) throw new e(void 0, "Url template is undefined");
+					let l = a(O) ? O : S, u = w.general.elastic || k ? "/search" : "", f = (s(l) ? o : n(o, l)) + u + g(i, d, w), m = c();
+					return M = f, m.get(f, {
+						...p(C),
+						signal: t
+					});
+				}, A);
+				N = l.config;
+				let u = () => m(c, M, C, void 0, N);
+				if (!r(l.status)) throw new t(l.status);
+				if (l.status === 204) return I({
+					totalCount: 0,
+					hasNextPage: o(i.value.hasNextPage) ? null : !1,
+					currentViewCount: 0
+				}), [];
+				if (!f(l)) throw new t(l.status, void 0, "Expected a response body, url: " + u());
+				let _ = h(l.data, l.status, u());
+				return _.mode !== "unknown" && I({
+					..._.pagination,
+					currentViewCount: _.items.length
+				}), _.items;
+			} catch (e) {
+				let t = {
+					system: _,
+					entity: v,
+					validationSystem: y,
+					validationEntity: b,
+					url: m(c, M, C, e, N)
+				}, n = l(e, t);
+				throw j ? u(n, t) : n;
+			}
+		},
+		abort: T.abort,
+		loading: T.loading
+	};
+};
+export { g as generateListQuery, _ as useApiFetchList };
+
+//# sourceMappingURL=useApiFetchList.js.map

package/dist/domains/api/composables/useApiFetchList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApiFetchList.js","names":["generateListQuery","useApiQueryBuilder","querySetLimit","pagination","querySetOffset","querySetOrder","SortOrder","querySetFilters","filterData","filterConfig","queryBuild","useApiFetchList","params","abortable","createAbortable","urlTemplateOverride","urlParamsOverride","reported","fetchParams","url","dispatched","generation","ownSignal","writePagination","signal","next","res","currentGeneration","abortSignal","template","isDefined","urlTemplate","isUndefined","AnzuFatalError","resolvedParams","urlParams","searchApi","forceElastic","requestUrl","replaceUrlParameters","instance","client","ownedByHelper","options","asSent","requestedUrl","isValidHTTPStatus","AnzuApiResponseCodeError","isNull","hasBody","list","readListBody","err","context","error","mapApiError","report"],"sources":["../../../../src/domains/api/composables/useApiFetchList.ts"],"sourcesContent":["import { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { replaceUrlParameters, type UrlParams } from '@/domains/api/utils/apiHelper'\nimport { isValidHTTPStatus } from '@/domains/api/utils/response'\nimport type { AxiosRequestConfig } from 'axios'\nimport { useApiQueryBuilder } from '@/domains/api/composables/useApiQueryBuilder'\nimport { HTTP_STATUS_NO_CONTENT } from '@/shared/statusCodes'\nimport type { FilterConfig, FilterData } from '@/domains/filters/composables/filterFactory'\nimport type { Ref } from 'vue'\nimport { isDefined, isNull, isUndefined } from '@/shared/utils/common'\nimport type { Pagination } from '@/domains/api/composables/pagination'\nimport { SortOrder } from '@/domains/api/types/SortOrder'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { mapApiError, report } from '@/domains/api/utils/apiErrors'\nimport { createAbortable, hasBody, ownedByHelper, requestedUrl } from '@/domains/api/composables/request'\nimport { readListBody } from '@/domains/api/utils/listBody'\n\nexport type UseApiFetchListParams = {\n  client: AxiosClientFn\n  system: string\n  entity: string\n  /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */\n  validationSystem?: string\n  validationEntity?: string\n  urlTemplate?: string\n  urlParams?: UrlParams\n  options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>\n  cancelPrevious?: boolean\n}\n\nexport type FetchListParams = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  forceElastic?: boolean\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n  /**\n   * `false`: a failure of this call is still thrown but not sent to the api error logger.\n   * For a caller that polls a list and has already reported its first failure. It is set per call, not per instance.\n   */\n  report?: boolean\n}\n\nexport const generateListQuery = (\n  pagination: Ref<Pagination>,\n  filterData: FilterData<any>,\n  filterConfig: FilterConfig<any>\n): string => {\n  const { querySetLimit, querySetOffset, querySetOrder, queryBuild, querySetFilters } = useApiQueryBuilder()\n  querySetLimit(pagination.value.rowsPerPage)\n  querySetOffset(pagination.value.page, pagination.value.rowsPerPage)\n  if (pagination.value.sortBy) {\n    querySetOrder(pagination.value.sortBy.key, pagination.value.sortBy.order === SortOrder.Desc)\n  }\n  querySetFilters(filterData, filterConfig)\n  return queryBuild()\n}\n\nexport const useApiFetchList = <T>(params: UseApiFetchListParams): UseApiFetchListReturnType<T> => {\n  const {\n    client,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    cancelPrevious = false,\n  } = params\n  const abortable = createAbortable({ cancelPrevious })\n\n  const execute = async (\n    pagination: Ref<Pagination>,\n    filterData: FilterData<any>,\n    filterConfig: FilterConfig<any>,\n    fetchParams: FetchListParams = {}\n  ): Promise<T[]> => {\n    const {\n      urlTemplate: urlTemplateOverride,\n      urlParams: urlParamsOverride,\n      forceElastic = false,\n      signal,\n      report: reported = true,\n    } = fetchParams\n\n    // Assigned inside `run` once a url exists. It stays undefined before\n    // that, because a call that never reached the wire requested no url.\n    let url: string | undefined\n    // The config axios used, kept for failures raised after reading the response. Those carry\n    // no config, and a rebuild would describe the request as the client would send it now.\n    let dispatched: AxiosRequestConfig | undefined\n\n    // Set by `run`, not read before it. `run` opens the new\n    // generation, so an earlier value belongs to the previous call.\n    let generation = 0\n    let ownSignal: AbortSignal | undefined\n    const writePagination = (next: Partial<Pagination>) => {\n      // Check both a newer generation and this call's own abort. Aborting does not stop a response already arriving.\n      // The generation belongs to the instance, so one instance must serve one list.\n      // Concurrent calls writing to different refs would leave the older ref unwritten.\n      if (abortable.generation() !== generation) return\n      if (ownSignal?.aborted === true) return\n      // Read the caller's signal directly, not the relay. `run` drops the relay once the response arrives\n      // and this write happens after, so an abort in between would otherwise still write pagination.\n      if (signal?.aborted === true) return\n      pagination.value = { ...pagination.value, ...next }\n    }\n\n    try {\n      const res = await abortable.run((abortSignal, currentGeneration) => {\n        generation = currentGeneration\n        ownSignal = abortSignal\n\n        // The url is derived inside `run`, which opens the generation and, with\n        // `cancelPrevious`, stops the previous call. If building it threw before `run`,\n        // the previous call would stay current and write pagination for a replaced query.\n        // Inside the try so these failures raise the same error class as others.\n        const template = isDefined(urlTemplateOverride) ? urlTemplateOverride : urlTemplate\n        if (isUndefined(template)) throw new AnzuFatalError(undefined, 'Url template is undefined')\n\n        const resolvedParams = isDefined(urlParamsOverride) ? urlParamsOverride : urlParams\n        const searchApi = filterConfig.general.elastic || forceElastic ? '/search' : ''\n        const baseUrl =\n          (isUndefined(resolvedParams) ? template : replaceUrlParameters(template, resolvedParams)) + searchApi\n        const requestUrl = baseUrl + generateListQuery(pagination, filterData, filterConfig)\n        const instance = client()\n\n        // Recorded last, when nothing before the call can throw. A failing\n        // client factory means no request happened, so no url is reported.\n        url = requestUrl\n\n        return instance.get(requestUrl, { ...ownedByHelper(options), signal: abortSignal })\n      }, signal)\n\n      dispatched = res.config\n      // The url the report names, so the message and context agree when an interceptor rewrote the request.\n      const asSent = () => requestedUrl(client, url, options, undefined, dispatched)\n      if (!isValidHTTPStatus(res.status)) throw new AnzuApiResponseCodeError(res.status)\n\n      // 204 is an empty list. The metadata must be reset, or it keeps describing the previous query.\n      if (res.status === HTTP_STATUS_NO_CONTENT) {\n        // The current pagination mode decides what to clear. A counted list\n        // keeps `hasNextPage` as `null`, an infinite one gets `false`.\n        // Writing `null` for both switched infinite lists to counted mode. `ASubjectSelect` then autoloaded\n        // the same 204 again, and `ADatatablePagination` offered Next and Last on an empty page.\n        const stillCounted = isNull(pagination.value.hasNextPage)\n        writePagination({ totalCount: 0, hasNextPage: stillCounted ? null : false, currentViewCount: 0 })\n        return []\n      }\n\n      if (!hasBody(res)) {\n        throw new AnzuApiResponseCodeError(res.status, undefined, 'Expected a response body, url: ' + asSent())\n      }\n\n      const list = readListBody<T>(res.data, res.status, asSent())\n      // Only write when the response named a paging mode. Otherwise a lone\n      // `currentViewCount` would be stale metadata for an earlier query.\n      if (list.mode !== 'unknown') writePagination({ ...list.pagination, currentViewCount: list.items.length })\n\n      return list.items\n    } catch (err: unknown) {\n      // Built once and shared by both, as in the batch.\n      const context = {\n        system,\n        entity,\n        validationSystem,\n        validationEntity,\n        url: requestedUrl(client, url, options, err, dispatched),\n      }\n\n      const error = mapApiError(err, context)\n\n      throw reported ? report(error, context) : error\n    }\n  }\n\n  return { execute, abort: abortable.abort, loading: abortable.loading }\n}\n\nexport type UseApiFetchListReturnType<T> = {\n  execute: (\n    pagination: Ref<Pagination>,\n    filterData: FilterData<any>,\n    filterConfig: FilterConfig<any>,\n    params?: FetchListParams\n  ) => Promise<T[]>\n  abort: () => void\n  /**\n   * True while this instance has a request in flight. Unlike a caller-cleared\n   * `finally` flag, it does not dip when `cancelPrevious` supersedes a call.\n   * It covers only this helper's work. Keep your own flag if it also spans follow-up fetches or mapping.\n   * It belongs to the instance. A factory that builds one per call cannot\n   * expose `loading`, `abort` or `cancelPrevious`, so hoist the instance first.\n   */\n  loading: Ref<boolean>\n}\n"],"mappings":";;;;;;;;;;;;AA2CA,IAAaA,KACX,GACA,GACA,MACW;CACX,IAAM,EAAE,kBAAe,mBAAgB,kBAAe,eAAY,uBAAoBC,EAAmB;CAOzG,OANAC,EAAcC,EAAW,MAAM,WAAW,GAC1CC,EAAeD,EAAW,MAAM,MAAMA,EAAW,MAAM,WAAW,GAC9DA,EAAW,MAAM,UACnBE,EAAcF,EAAW,MAAM,OAAO,KAAKA,EAAW,MAAM,OAAO,UAAUG,EAAU,IAAI,GAE7FC,EAAgBC,GAAYC,CAAY,GACjCC,EAAW;AACpB,GAEaC,KAAsB,MAAgE;CACjG,IAAM,EACJ,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,oBAAiB,OACfC,GACEC,IAAYC,EAAgB,EAAE,kBAAe,CAAC;CA2GpD,OAAO;EAAE,gBAxGP,GACA,GACA,GACA,IAA+B,CAAC,MACf;GACjB,IAAM,EACJ,aAAaC,GACb,WAAWC,GACX,kBAAe,IACf,WACA,QAAQC,IAAW,OACjBC,GAIAC,GAGAC,GAIAC,IAAa,GACbC,GACEC,KAAmB,MAA8B;IAIrD,AAAIV,EAAU,WAAW,MAAMQ,KAC3BC,GAAW,YAAY,MAGvBE,GAAQ,YAAY,OACxB,EAAW,QAAQ;KAAE,GAAGrB,EAAW;KAAO,GAAGsB;IAAK;GACpD;GAEA,IAAI;IACF,IAAMC,IAAM,MAAMb,EAAU,KAAK,GAAa,MAAsB;KAElE,AADA,IAAac,GACb,IAAYC;KAMZ,IAAMC,IAAWC,EAAUf,CAAmB,IAAIA,IAAsBgB;KACxE,IAAIC,EAAYH,CAAQ,GAAG,MAAM,IAAII,EAAe,KAAA,GAAW,2BAA2B;KAE1F,IAAMC,IAAiBJ,EAAUd,CAAiB,IAAIA,IAAoBmB,GACpEC,IAAY3B,EAAa,QAAQ,WAAW4B,IAAe,YAAY,IAGvEC,KADHN,EAAYE,CAAc,IAAIL,IAAWU,EAAqBV,GAAUK,CAAc,KAAKE,IACjEpC,EAAkBG,GAAYK,GAAYC,CAAY,GAC7E+B,IAAWC,EAAO;KAMxB,OAFA,IAAMH,GAECE,EAAS,IAAIF,GAAY;MAAE,GAAGI,EAAcC,CAAO;MAAG,QAAQf;KAAY,CAAC;IACpF,GAAGJ,CAAM;IAET,IAAaE,EAAI;IAEjB,IAAMkB,UAAeC,EAAaJ,GAAQtB,GAAKwB,GAAS,KAAA,GAAWvB,CAAU;IAC7E,IAAI,CAAC0B,EAAkBpB,EAAI,MAAM,GAAG,MAAM,IAAIqB,EAAyBrB,EAAI,MAAM;IAGjF,IAAIA,EAAI,WAAA,KAON,OADAH,EAAgB;KAAE,YAAY;KAAG,aADZyB,EAAO7C,EAAW,MAAM,WACC,IAAe,OAAO;KAAO,kBAAkB;IAAE,CAAC,GACzF,CAAC;IAGV,IAAI,CAAC8C,EAAQvB,CAAG,GACd,MAAM,IAAIqB,EAAyBrB,EAAI,QAAQ,KAAA,GAAW,oCAAoCkB,EAAO,CAAC;IAGxG,IAAMM,IAAOC,EAAgBzB,EAAI,MAAMA,EAAI,QAAQkB,EAAO,CAAC;IAK3D,OAFIM,EAAK,SAAS,aAAW3B,EAAgB;KAAE,GAAG2B,EAAK;KAAY,kBAAkBA,EAAK,MAAM;IAAO,CAAC,GAEjGA,EAAK;GACd,SAASE,GAAc;IAErB,IAAMC,IAAU;KACd;KACA;KACA;KACA;KACA,KAAKR,EAAaJ,GAAQtB,GAAKwB,GAASS,GAAKhC,CAAU;IACzD,GAEMkC,IAAQC,EAAYH,GAAKC,CAAO;IAEtC,MAAMpC,IAAWuC,EAAOF,GAAOD,CAAO,IAAIC;GAC5C;EACF;EAEkB,OAAOzC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE"}

package/dist/domains/api/composables/useApiFetchListBatch.d.ts

@@ -0,0 +1,40 @@
+import { UrlParams } from '../utils/apiHelper';
+import { AxiosRequestConfig } from 'axios';
+import { FilterConfig, FilterData } from '../../filters/composables/filterFactory';
+import { Ref } from 'vue';
+import { AxiosClientFn } from '../utils/client';
+export type UseApiFetchListBatchParams = {
+    client: AxiosClientFn;
+    system: string;
+    entity: string;
+    /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */
+    validationSystem?: string;
+    validationEntity?: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
+    cancelPrevious?: boolean;
+};
+export type FetchListBatchParams = {
+    /** Stops this one call, leaving the instance's other calls alone. */
+    signal?: AbortSignal;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    sortBy?: string;
+    sortDesc?: boolean;
+    batchSize?: number;
+    forceElastic?: boolean;
+};
+export declare const useApiFetchListBatch: <T>(params: UseApiFetchListBatchParams) => UseApiFetchListBatchReturnType<T>;
+export type UseApiFetchListBatchReturnType<T> = {
+    execute: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListBatchParams) => Promise<T[]>;
+    abort: () => void;
+    /**
+     * True while this instance is working. For a batch it covers the whole walk, including gaps between pages.
+     * Unlike a hand-rolled ref cleared in `finally`, it does not drop when `cancelPrevious` supersedes a call.
+     * It covers only this helper. Keep your own flag if it also spans follow-up work such as a cached fetch or mapping.
+     * It is only reachable if you hold the instance. A factory that creates
+     * one per call cannot expose `loading`, `abort` or `cancelPrevious`.
+     */
+    loading: Ref<boolean>;
+};

package/dist/domains/api/composables/useApiFetchListBatch.js

@@ -0,0 +1,115 @@
+import { AnzuFatalError as e } from "../../../shared/error/AnzuFatalError.js";
+import { AnzuApiResponseCodeError as t } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { replaceUrlParameters as n } from "../utils/apiHelper.js";
+import { isValidHTTPStatus as r } from "../utils/response.js";
+import "../../../shared/statusCodes.js";
+import { isDefined as i, isUndefined as a } from "../../../shared/utils/common.js";
+import { usePagination as o } from "./pagination.js";
+import { SortOrder as s } from "../types/SortOrder.js";
+import { generateListQuery as c } from "./useApiFetchList.js";
+import { mapApiError as l, report as u } from "../utils/apiErrors.js";
+import { createAbortable as d, hasBody as f, ownedByHelper as p, requestedUrl as m } from "./request.js";
+import { readListBody as h } from "../utils/listBody.js";
+import { ref as g } from "vue";
+// src/domains/api/composables/useApiFetchListBatch.ts
+var _ = class extends Error {
+	pageUrl;
+	failure;
+	dispatched;
+	constructor(e, t, n) {
+		super("Batch page failed"), this.name = "PageFailure", this.pageUrl = e, this.failure = t, this.dispatched = n;
+	}
+}, v = (v) => {
+	let { client: y, system: b, entity: x, validationSystem: S, validationEntity: C, urlTemplate: w, urlParams: T, options: E = {}, cancelPrevious: D = !1 } = v, O = d({ cancelPrevious: D });
+	return {
+		execute: async (d, v, D = {}) => {
+			let { urlTemplate: k, urlParams: A, sortBy: j = "id", sortDesc: M = !0, batchSize: N = 100, forceElastic: P = !1, signal: F } = D;
+			try {
+				return await O.run(async (l) => {
+					let u = i(k) ? k : w;
+					if (a(u)) throw new e(void 0, "Url template is undefined");
+					if (N < 1) throw new e(void 0, "batchSize must be at least 1, got " + N);
+					let b = i(A) ? A : T, x = v.general.elastic || P ? "/search" : "", S = (a(b) ? u : n(u, b)) + x, C = y(), { pagination: D } = o(j, M ? s.Desc : s.Asc, { rowsPerPage: N }), O = async (e) => {
+						let t = S + c(e, d, v);
+						try {
+							return {
+								res: await C.get(t, {
+									...p(E),
+									signal: l
+								}),
+								pageUrl: t
+							};
+						} catch (e) {
+							throw new _(t, e);
+						}
+					}, F = (e, t) => m(y, t, E, void 0, e.config), I = (e, n) => {
+						if (!r(e.status)) throw new _(n, new t(e.status), e.config);
+						if (e.status === 204) return {
+							items: [],
+							mode: "unknown",
+							totalCount: 0,
+							hasNextPage: !1,
+							countIsBound: !1,
+							empty: !0
+						};
+						if (!f(e)) throw new _(n, new t(e.status, void 0, "Expected a response body, url: " + F(e, n)), e.config);
+						let i;
+						try {
+							i = h(e.data, e.status, F(e, n));
+						} catch (t) {
+							throw new _(n, t, e.config);
+						}
+						return {
+							items: i.items,
+							mode: i.mode,
+							totalCount: i.pagination.totalCount ?? 0,
+							hasNextPage: i.pagination.hasNextPage === !0,
+							countIsBound: i.countIsBound,
+							empty: !1
+						};
+					}, L = await O(D), R = I(L.res, L.pageUrl), z = [...R.items];
+					if (R.empty) return z;
+					let B = R.items.length > 0 && R.items.length < D.value.rowsPerPage;
+					if (B && (D.value.rowsPerPage = R.items.length), R.mode === "infinite") {
+						let e = R.hasNextPage;
+						for (; e;) {
+							D.value.page++;
+							let t = await O(D), n = I(t.res, t.pageUrl);
+							if (z.push(...n.items), n.empty) break;
+							e = n.hasNextPage;
+						}
+						return z;
+					}
+					if (R.mode !== "counted" || z.length >= R.totalCount) return z;
+					if (B || R.countIsBound) {
+						for (;;) {
+							D.value.page++;
+							let e = await O(D), t = I(e.res, e.pageUrl);
+							if (z.push(...t.items), t.items.length < D.value.rowsPerPage) break;
+						}
+						return z;
+					}
+					let V = Math.ceil(R.totalCount / D.value.rowsPerPage);
+					return V <= 1 || (await Promise.all(Array.from({ length: V - 1 }, (e, t) => O(g({
+						...D.value,
+						page: t + 2
+					})).then((e) => I(e.res, e.pageUrl))))).forEach((e) => z.push(...e.items)), z;
+				}, F);
+			} catch (e) {
+				let t = e instanceof _ ? e : null, n = {
+					system: b,
+					entity: x,
+					validationSystem: S,
+					validationEntity: C,
+					url: m(y, t?.pageUrl, E, t?.failure ?? e, t?.dispatched)
+				};
+				throw u(l(t?.failure ?? e, n), n);
+			}
+		},
+		abort: O.abort,
+		loading: O.loading
+	};
+};
+export { v as useApiFetchListBatch };
+
+//# sourceMappingURL=useApiFetchListBatch.js.map

package/dist/domains/api/composables/useApiFetchListBatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApiFetchListBatch.js","names":["PageFailure","pageUrl","failure","dispatched","useApiFetchListBatch","params","abortable","createAbortable","urlTemplateOverride","urlParamsOverride","fetchParams","template","isDefined","urlTemplate","isUndefined","AnzuFatalError","batchSize","resolvedParams","urlParams","searchApi","filterConfig","forceElastic","baseUrl","replaceUrlParameters","instance","client","usePagination","sortBy","sortDesc","SortOrder","get","generateListQuery","page","filterData","ownedByHelper","options","abortSignal","err","asSent","requestedUrl","res","readPage","isValidHTTPStatus","AnzuApiResponseCodeError","hasBody","body","readListBody","firstPage","pagination","first","results","capped","hasNextPage","nextPage","next","pageCount","ref","index","signal","failed","context","report","mapApiError"],"sources":["../../../../src/domains/api/composables/useApiFetchListBatch.ts"],"sourcesContent":["import { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { replaceUrlParameters, type UrlParams } from '@/domains/api/utils/apiHelper'\nimport { isValidHTTPStatus } from '@/domains/api/utils/response'\nimport type { AxiosRequestConfig, AxiosResponse } from 'axios'\nimport { HTTP_STATUS_NO_CONTENT } from '@/shared/statusCodes'\nimport type { FilterConfig, FilterData } from '@/domains/filters/composables/filterFactory'\nimport { type Ref, ref } from 'vue'\nimport { isDefined, isUndefined } from '@/shared/utils/common'\nimport { type Pagination, usePagination } from '@/domains/api/composables/pagination'\nimport { SortOrder } from '@/domains/api/types/SortOrder'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { generateListQuery } from '@/domains/api/composables/useApiFetchList'\nimport { mapApiError, report } from '@/domains/api/utils/apiErrors'\nimport { createAbortable, hasBody, ownedByHelper, requestedUrl } from '@/domains/api/composables/request'\nimport { readListBody } from '@/domains/api/utils/listBody'\n\nexport type UseApiFetchListBatchParams = {\n  client: AxiosClientFn\n  system: string\n  entity: string\n  /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */\n  validationSystem?: string\n  validationEntity?: string\n  urlTemplate?: string\n  urlParams?: UrlParams\n  options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>\n  cancelPrevious?: boolean\n}\n\nexport type FetchListBatchParams = {\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n  urlTemplate?: string\n  urlParams?: UrlParams\n  sortBy?: string\n  sortDesc?: boolean\n  batchSize?: number\n  forceElastic?: boolean\n}\n\n/**\n * Carries the url of the failing page to the catch that reports it.\n * The catch unwraps it before mapping, so callers see the same error classes as from other helpers.\n */\nclass PageFailure extends Error {\n  readonly pageUrl: string\n  readonly failure: unknown\n  /**\n   * The config axios used, set when the page answered but this helper refused\n   * the response. Transport failures do not need it, axios keeps its own.\n   */\n  readonly dispatched?: AxiosRequestConfig\n\n  constructor(pageUrl: string, failure: unknown, dispatched?: AxiosRequestConfig) {\n    super('Batch page failed')\n    this.name = 'PageFailure'\n    this.pageUrl = pageUrl\n    this.failure = failure\n    this.dispatched = dispatched\n  }\n}\n\nexport const useApiFetchListBatch = <T>(params: UseApiFetchListBatchParams): UseApiFetchListBatchReturnType<T> => {\n  const {\n    client,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    cancelPrevious = false,\n  } = params\n  const abortable = createAbortable({ cancelPrevious })\n\n  const execute = async (\n    filterData: FilterData<any>,\n    filterConfig: FilterConfig<any>,\n    fetchParams: FetchListBatchParams = {}\n  ): Promise<T[]> => {\n    const {\n      urlTemplate: urlTemplateOverride,\n      urlParams: urlParamsOverride,\n      sortBy = 'id',\n      sortDesc = true,\n      batchSize = 100,\n      forceElastic = false,\n      signal,\n    } = fetchParams\n\n    try {\n      return await abortable.run(async (abortSignal) => {\n        // Derived inside `run` because `run` opens the generation and, with `cancelPrevious`,\n        // stops the previous call. A throw before it would leave the predecessor running.\n        // Inside the try so the failure raises the same error class as others.\n        const template = isDefined(urlTemplateOverride) ? urlTemplateOverride : urlTemplate\n        if (isUndefined(template)) throw new AnzuFatalError(undefined, 'Url template is undefined')\n\n        // A page size below one never ends the walk and causes unbounded requests. Fail it as a caller error.\n        if (batchSize < 1) throw new AnzuFatalError(undefined, 'batchSize must be at least 1, got ' + batchSize)\n\n        const resolvedParams = isDefined(urlParamsOverride) ? urlParamsOverride : urlParams\n        const searchApi = filterConfig.general.elastic || forceElastic ? '/search' : ''\n        const baseUrl =\n          (isUndefined(resolvedParams) ? template : replaceUrlParameters(template, resolvedParams)) + searchApi\n        // One instance for the whole batch, so a factory that answers\n        // differently per call cannot split pages across backends.\n        const instance = client()\n\n        const { pagination } = usePagination(sortBy, sortDesc ? SortOrder.Desc : SortOrder.Asc, {\n          rowsPerPage: batchSize,\n        })\n\n        // Each page carries its own url so a failure can name the page. The base url cannot.\n        const get = async (page: Ref<Pagination>) => {\n          const pageUrl = baseUrl + generateListQuery(page, filterData, filterConfig)\n\n          try {\n            return { res: await instance.get(pageUrl, { ...ownedByHelper(options), signal: abortSignal }), pageUrl }\n          } catch (err: unknown) {\n            // Tagged here while the page is known. The counted branch dispatches all\n            // pages before any answers, so a shared variable would name the wrong page.\n            throw new PageFailure(pageUrl, err)\n          }\n        }\n\n        // The url the report names for this page, so the message and\n        // context agree when an interceptor rewrote the request.\n        const asSent = (res: AxiosResponse, pageUrl: string) =>\n          requestedUrl(client, pageUrl, options, undefined, res.config)\n\n        // Every page is checked the same way. A 2xx with no body breaks the contract on any page.\n        // The 204 branch is defensive. These backends return empty lists as 200 with a body.\n\n        const readPage = (res: AxiosResponse, pageUrl: string) => {\n          if (!isValidHTTPStatus(res.status)) {\n            throw new PageFailure(pageUrl, new AnzuApiResponseCodeError(res.status), res.config)\n          }\n          if (res.status === HTTP_STATUS_NO_CONTENT) {\n            return {\n              items: [] as T[],\n              mode: 'unknown' as const,\n              totalCount: 0,\n              hasNextPage: false,\n              countIsBound: false,\n              empty: true,\n            }\n          }\n          if (!hasBody(res)) {\n            throw new PageFailure(\n              pageUrl,\n              new AnzuApiResponseCodeError(\n                res.status,\n                undefined,\n                'Expected a response body, url: ' + asSent(res, pageUrl)\n              ),\n              res.config\n            )\n          }\n\n          let body\n          try {\n            body = readListBody<T>(res.data, res.status, asSent(res, pageUrl))\n          } catch (err: unknown) {\n            throw new PageFailure(pageUrl, err, res.config)\n          }\n\n          return {\n            items: body.items,\n            mode: body.mode,\n            totalCount: body.pagination.totalCount ?? 0,\n            hasNextPage: body.pagination.hasNextPage === true,\n            countIsBound: body.countIsBound,\n            empty: false,\n          }\n        }\n\n        const firstPage = await get(pagination)\n        const first = readPage(firstPage.res, firstPage.pageUrl)\n        const results: T[] = [...first.items]\n        if (first.empty) return results\n\n        // A short first page is read as the server's real page size (a capped `limit`), so later\n        // offsets use it. Done before the branch so both counted and infinite walks use it.\n        // If the server instead dropped rows after applying `limit`, this would repeat rows at boundaries.\n        // No such dropping was found, and repeated rows are visible while missing ones are not.\n        // When capped, pages are walked one at a time, so a wrong guess\n        // costs single requests and stops at the first empty page.\n        const capped = first.items.length > 0 && first.items.length < pagination.value.rowsPerPage\n        if (capped) pagination.value.rowsPerPage = first.items.length\n\n        // Infinite lists walk page by page, because only the answer says whether another exists.\n        if (first.mode === 'infinite') {\n          let hasNextPage = first.hasNextPage\n          while (hasNextPage) {\n            pagination.value.page++\n            const nextPage = await get(pagination)\n            const next = readPage(nextPage.res, nextPage.pageUrl)\n            results.push(...next.items)\n            if (next.empty) break\n            hasNextPage = next.hasNextPage\n          }\n\n          return results\n        }\n\n        // A list that named neither mode said nothing about further pages, so the first page is all there is.\n        if (first.mode !== 'counted') return results\n\n        // Two cases where `totalCount` cannot be divided into a page count. `bigTable` (on by default) makes\n        // `totalCount` a look-ahead of `offset + limit + 1`, not a total. Dividing it gives 2 pages, so a\n        // 5000-row batch would stop at 200. Or the page size was guessed and the server already contradicted it.\n        // In both cases walk pages sequentially until a page is shorter than requested. That is the end-of-data signal.\n        // Stop early when the rows already reach `totalCount`. The repository corrects\n        // `totalCount` to the real total only when a page comes back shorter than its\n        // limit. A capped server reports the look-ahead instead and does not match.\n        if (results.length >= first.totalCount) return results\n\n        if (capped || first.countIsBound) {\n          for (;;) {\n            pagination.value.page++\n            const nextPage = await get(pagination)\n            const next = readPage(nextPage.res, nextPage.pageUrl)\n            results.push(...next.items)\n            if (next.items.length < pagination.value.rowsPerPage) break\n          }\n\n          return results\n        }\n\n        // The count is known, so the remaining pages are requested in parallel.\n        const pageCount = Math.ceil(first.totalCount / pagination.value.rowsPerPage)\n        if (pageCount <= 1) return results\n\n        // Read each page as it arrives, not after all settle. Otherwise a broken\n        // body goes unnoticed while a sibling hangs, and the call never ends.\n        // Rejecting here reaches `run`, which aborts the siblings.\n        const rest = await Promise.all(\n          Array.from({ length: pageCount - 1 }, (_unused, index) =>\n            get(ref({ ...pagination.value, page: index + 2 })).then((page) => readPage(page.res, page.pageUrl))\n          )\n        )\n        // A 204 page adds nothing. The other pages are kept, since all were sent at once.\n        rest.forEach((page) => results.push(...page.items))\n\n        return results\n      }, signal)\n    } catch (err: unknown) {\n      const failed = err instanceof PageFailure ? err : null\n      // Only a page reports a url, and it reports its own. The base url is never\n      // requested. A failure before dispatch (missing template, unrenderable filter\n      // config) belongs to no page. Every failure after dispatch is a `PageFailure`.\n      const context = {\n        system,\n        entity,\n        validationSystem,\n        validationEntity,\n        url: requestedUrl(client, failed?.pageUrl, options, failed?.failure ?? err, failed?.dispatched),\n      }\n\n      throw report(mapApiError(failed?.failure ?? err, context), context)\n    }\n  }\n\n  return { execute, abort: abortable.abort, loading: abortable.loading }\n}\n\nexport type UseApiFetchListBatchReturnType<T> = {\n  execute: (filterData: FilterData<any>, filterConfig: FilterConfig<any>, params?: FetchListBatchParams) => Promise<T[]>\n  abort: () => void\n  /**\n   * True while this instance is working. For a batch it covers the whole walk, including gaps between pages.\n   * Unlike a hand-rolled ref cleared in `finally`, it does not drop when `cancelPrevious` supersedes a call.\n   * It covers only this helper. Keep your own flag if it also spans follow-up work such as a cached fetch or mapping.\n   * It is only reachable if you hold the instance. A factory that creates\n   * one per call cannot expose `loading`, `abort` or `cancelPrevious`.\n   */\n  loading: Ref<boolean>\n}\n"],"mappings":";;;;;;;;;;;;;;AA6CA,IAAMA,IAAN,cAA0B,MAAM;CAC9B;CACA;CAKA;CAEA,YAAY,GAAiB,GAAkB,GAAiC;EAK9E,AAJA,MAAM,mBAAmB,GACzB,KAAK,OAAO,eACZ,KAAK,UAAUC,GACf,KAAK,UAAUC,GACf,KAAK,aAAaC;CACpB;AACF,GAEaC,KAA2B,MAA0E;CAChH,IAAM,EACJ,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,oBAAiB,OACfC,GACEC,IAAYC,EAAgB,EAAE,kBAAe,CAAC;CA+LpD,OAAO;EAAE,gBA5LP,GACA,GACA,IAAoC,CAAC,MACpB;GACjB,IAAM,EACJ,aAAaC,GACb,WAAWC,GACX,YAAS,MACT,cAAW,IACX,eAAY,KACZ,kBAAe,IACf,cACEC;GAEJ,IAAI;IACF,OAAO,MAAMJ,EAAU,IAAI,OAAO,MAAgB;KAIhD,IAAMK,IAAWC,EAAUJ,CAAmB,IAAIA,IAAsBK;KACxE,IAAIC,EAAYH,CAAQ,GAAG,MAAM,IAAII,EAAe,KAAA,GAAW,2BAA2B;KAG1F,IAAIC,IAAY,GAAG,MAAM,IAAID,EAAe,KAAA,GAAW,uCAAuCC,CAAS;KAEvG,IAAMC,IAAiBL,EAAUH,CAAiB,IAAIA,IAAoBS,GACpEC,IAAYC,EAAa,QAAQ,WAAWC,IAAe,YAAY,IACvEC,KACHR,EAAYG,CAAc,IAAIN,IAAWY,EAAqBZ,GAAUM,CAAc,KAAKE,GAGxFK,IAAWC,EAAO,GAElB,EAAE,kBAAeC,EAAcC,GAAQC,IAAWC,EAAU,OAAOA,EAAU,KAAK,EACtF,aAAab,EACf,CAAC,GAGKc,IAAM,OAAO,MAA0B;MAC3C,IAAM7B,IAAUqB,IAAUS,EAAkBC,GAAMC,GAAYb,CAAY;MAE1E,IAAI;OACF,OAAO;QAAE,KAAK,MAAMI,EAAS,IAAIvB,GAAS;SAAE,GAAGiC,EAAcC,CAAO;SAAG,QAAQC;QAAY,CAAC;QAAG;OAAQ;MACzG,SAASC,GAAc;OAGrB,MAAM,IAAIrC,EAAYC,GAASoC,CAAG;MACpC;KACF,GAIMC,KAAU,GAAoB,MAClCC,EAAad,GAAQxB,GAASkC,GAAS,KAAA,GAAWK,EAAI,MAAM,GAKxDC,KAAY,GAAoB,MAAoB;MACxD,IAAI,CAACC,EAAkBF,EAAI,MAAM,GAC/B,MAAM,IAAIxC,EAAYC,GAAS,IAAI0C,EAAyBH,EAAI,MAAM,GAAGA,EAAI,MAAM;MAErF,IAAIA,EAAI,WAAA,KACN,OAAO;OACL,OAAO,CAAC;OACR,MAAM;OACN,YAAY;OACZ,aAAa;OACb,cAAc;OACd,OAAO;MACT;MAEF,IAAI,CAACI,EAAQJ,CAAG,GACd,MAAM,IAAIxC,EACRC,GACA,IAAI0C,EACFH,EAAI,QACJ,KAAA,GACA,oCAAoCF,EAAOE,GAAKvC,CAAO,CACzD,GACAuC,EAAI,MACN;MAGF,IAAIK;MACJ,IAAI;OACF,IAAOC,EAAgBN,EAAI,MAAMA,EAAI,QAAQF,EAAOE,GAAKvC,CAAO,CAAC;MACnE,SAASoC,GAAc;OACrB,MAAM,IAAIrC,EAAYC,GAASoC,GAAKG,EAAI,MAAM;MAChD;MAEA,OAAO;OACL,OAAOK,EAAK;OACZ,MAAMA,EAAK;OACX,YAAYA,EAAK,WAAW,cAAc;OAC1C,aAAaA,EAAK,WAAW,gBAAgB;OAC7C,cAAcA,EAAK;OACnB,OAAO;MACT;KACF,GAEME,IAAY,MAAMjB,EAAIkB,CAAU,GAChCC,IAAQR,EAASM,EAAU,KAAKA,EAAU,OAAO,GACjDG,IAAe,CAAC,GAAGD,EAAM,KAAK;KACpC,IAAIA,EAAM,OAAO,OAAOC;KAQxB,IAAMC,IAASF,EAAM,MAAM,SAAS,KAAKA,EAAM,MAAM,SAASD,EAAW,MAAM;KAI/E,IAHIG,MAAQ,EAAW,MAAM,cAAcF,EAAM,MAAM,SAGnDA,EAAM,SAAS,YAAY;MAC7B,IAAIG,IAAcH,EAAM;MACxB,OAAOG,IAAa;OAClB,EAAW,MAAM;OACjB,IAAMC,IAAW,MAAMvB,EAAIkB,CAAU,GAC/BM,IAAOb,EAASY,EAAS,KAAKA,EAAS,OAAO;OAEpD,IADAH,EAAQ,KAAK,GAAGI,EAAK,KAAK,GACtBA,EAAK,OAAO;OAChB,IAAcA,EAAK;MACrB;MAEA,OAAOJ;KACT;KAYA,IATID,EAAM,SAAS,aASfC,EAAQ,UAAUD,EAAM,YAAY,OAAOC;KAE/C,IAAIC,KAAUF,EAAM,cAAc;MAChC,SAAS;OACP,EAAW,MAAM;OACjB,IAAMI,IAAW,MAAMvB,EAAIkB,CAAU,GAC/BM,IAAOb,EAASY,EAAS,KAAKA,EAAS,OAAO;OAEpD,IADAH,EAAQ,KAAK,GAAGI,EAAK,KAAK,GACtBA,EAAK,MAAM,SAASN,EAAW,MAAM,aAAa;MACxD;MAEA,OAAOE;KACT;KAGA,IAAMK,IAAY,KAAK,KAAKN,EAAM,aAAaD,EAAW,MAAM,WAAW;KAc3E,OAbIO,KAAa,MAWjB,MANmB,QAAQ,IACzB,MAAM,KAAK,EAAE,QAAQA,IAAY,EAAE,IAAI,GAAS,MAC9CzB,EAAI0B,EAAI;MAAE,GAAGR,EAAW;MAAO,MAAMS,IAAQ;KAAE,CAAC,CAAC,CAAC,CAAC,MAAM,MAAShB,EAAST,EAAK,KAAKA,EAAK,OAAO,CAAC,CACpG,CACF,EAAA,CAEK,SAAS,MAASkB,EAAQ,KAAK,GAAGlB,EAAK,KAAK,CAAC,GAE3CkB;IACT,GAAGQ,CAAM;GACX,SAASrB,GAAc;IACrB,IAAMsB,IAAStB,aAAerC,IAAcqC,IAAM,MAI5CuB,IAAU;KACd;KACA;KACA;KACA;KACA,KAAKrB,EAAad,GAAQkC,GAAQ,SAASxB,GAASwB,GAAQ,WAAWtB,GAAKsB,GAAQ,UAAU;IAChG;IAEA,MAAME,EAAOC,EAAYH,GAAQ,WAAWtB,GAAKuB,CAAO,GAAGA,CAAO;GACpE;EACF;EAEkB,OAAOtD,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE"}

package/dist/domains/api/composables/useApiQueryBuilder.d.ts

@@ -0,0 +1,19 @@
+import { FilterConfig, FilterData, FilterVariant } from '../../filters/composables/filterFactory';
+import { DatetimeUTCNullable } from '../../../shared/types/common';
+/**
+ * Docs: /doc/Admin-Cms-Doc/Filters.md
+ */
+export declare function useApiQueryBuilder(): {
+    resolveTimeIntervalFilter: (fromName: string, untilName: string, filterData: FilterData<any>, filterConfig: FilterConfig<any>, mandatory: boolean, exclude: boolean) => null | {
+        from: DatetimeUTCNullable;
+        until: DatetimeUTCNullable;
+    };
+    querySetLimit: (value: number) => void;
+    querySetOffset: (page: number, limit: number) => void;
+    querySetOrder: (field: string | null, desc: boolean) => void;
+    queryAddFilter: (filterVariant: FilterVariant, field: string, value: string | number | boolean) => void;
+    querySetFilters: (filterData: FilterData<any>, filterConfig: FilterConfig<any>) => void;
+    queryAdd: (key: string, value: any) => void;
+    queryBuild: () => string;
+    q: import('vue').Ref<string[], string[]>;
+};

package/dist/domains/api/composables/useApiQueryBuilder.js

@@ -0,0 +1,74 @@
+import { isArray as e, isBoolean as t, isNull as n, isNumber as r, isString as i, isUndefined as a } from "../../../shared/utils/common.js";
+import { TimeIntervalSpecialOptions as o } from "../../filters/composables/filterTimeIntervalTools.js";
+import { dateModifyMinutes as s, dateTimeNow as c, dateTimeToDate as l, dateToUtc as u, getMonthInterval as d } from "../../../shared/utils/datetime.js";
+import { SortOrder as f } from "../types/SortOrder.js";
+import { ref as p } from "vue";
+// src/domains/api/composables/useApiQueryBuilder.ts
+function m() {
+	let m = p([]), h = (e) => {
+		C("limit", e);
+	}, g = (e, t) => {
+		C("offset", Math.max(0, (e - 1) * t));
+	}, _ = (e, t) => {
+		!n(e) && e.length > 0 && C("order[" + e + "]", t ? f.Desc : f.Asc);
+	}, v = (e) => t(e) ? e ? "1" : "0" : e, y = (e, t, n) => {
+		i(n) && n.length === 0 || m.value.push("filter_" + e + "[" + t + "]=" + v(n));
+	}, b = (e, t) => {
+		let n = e.fields[t];
+		if (a(n)) throw Error(`useApiQueryBuilder: filter field "${t}" is not configured`);
+		return n;
+	}, x = (e, t, a, f, p, m) => {
+		let h = a[e], g = a[t];
+		if (n(h) && p && !m && (h = b(f, e).default), n(g) && p && !m && (g = b(f, t).default), i(h) && i(g)) return {
+			from: h,
+			until: g
+		};
+		let _ = c(), v = l(_);
+		switch (h) {
+			case o.CurrentMonth: return d(v, "utc", 0, !1);
+			case o.LastMonth: return d(v, "utc", -1, !1);
+			case o.Last3Months: return d(v, "utc", -2, !0);
+			default: if (r(h)) return {
+				from: u(s(h * -1, v)),
+				until: _
+			};
+		}
+		return null;
+	}, S = (o, s) => n(o) ? s.mandatory && !s.exclude && !a(s.default) ? e(s.default) ? s.default.join(",") : s.default : null : i(o) ? o.length === 0 ? s.mandatory && !s.exclude && !a(s.default) && !n(s.default) ? encodeURIComponent(e(s.default) ? s.default.join(",") : s.default) : null : encodeURIComponent(o) : e(o) ? o.length === 0 ? s.mandatory && !s.exclude && e(s.default) ? s.default.map((e) => i(e) ? encodeURIComponent(e) : e).join(",") : null : o.map((e) => i(e) ? encodeURIComponent(e) : e).join(",") : r(o) || t(o) ? o : null, C = (e, t) => {
+		m.value.push(e + "=" + t);
+	};
+	return {
+		resolveTimeIntervalFilter: x,
+		querySetLimit: h,
+		querySetOffset: g,
+		querySetOrder: _,
+		queryAddFilter: y,
+		querySetFilters: (e, t) => {
+			let r = t.general.simpleFilters;
+			for (let i in e) {
+				let o = e[i], s = t.fields[i];
+				if (a(s) || s.exclude) continue;
+				let c = s.apiName || i;
+				if (s.type === "timeInterval" && !a(s.related)) {
+					let a = x(i, s.related, e, t, s.mandatory, s.exclude);
+					if (n(a)) continue;
+					let o = b(t, s.related).apiName || s.related;
+					if (r) {
+						C(c, a.from), C(o, a.until);
+						continue;
+					}
+					a.from && y("gte", c, a.from), a.until && y("lte", o, a.until);
+					continue;
+				}
+				let l = S(o, s);
+				n(l) || (r ? C(c, l) : y(s.variant, c, l));
+			}
+		},
+		queryAdd: C,
+		queryBuild: () => "?" + m.value.join("&"),
+		q: m
+	};
+}
+export { m as useApiQueryBuilder };
+
+//# sourceMappingURL=useApiQueryBuilder.js.map

package/dist/domains/api/composables/useApiQueryBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApiQueryBuilder.js","names":["useApiQueryBuilder","q","ref","querySetLimit","value","querySetOffset","page","limit","querySetOrder","isNull","field","queryAdd","desc","SortOrder","formatValue","isBoolean","queryAddFilter","isString","filterVariant","fieldConfig","filterConfig","name","isUndefined","resolveTimeIntervalFilter","fromValue","filterData","fromName","untilValue","untilName","mandatory","exclude","now","dateTimeNow","nowDate","dateTimeToDate","TimeIntervalSpecialOptions","getMonthInterval","isNumber","dateToUtc","dateModifyMinutes","getValue","config","isArray","item","key","isSimpleFilters","filterName","filterFieldValue","filterFieldConfig","data","nameRelated"],"sources":["../../../../src/domains/api/composables/useApiQueryBuilder.ts"],"sourcesContent":["import { ref } from 'vue'\nimport { isArray, isBoolean, isNull, isNumber, isString, isUndefined } from '@/shared/utils/common'\nimport type {\n  AllowedFilterValues,\n  FilterConfig,\n  FilterData,\n  FilterField,\n  FilterVariant,\n} from '@/domains/filters/composables/filterFactory'\nimport type { DatetimeUTCNullable } from '@/shared/types/common'\nimport {\n  TimeIntervalSpecialOptions,\n  type TimeIntervalToolsValue,\n} from '@/domains/filters/composables/filterTimeIntervalTools'\nimport { dateModifyMinutes, dateTimeNow, dateTimeToDate, dateToUtc, getMonthInterval } from '@/shared/utils/datetime'\nimport { SortOrder } from '@/domains/api/types/SortOrder'\n\n/**\n * Docs: /doc/Admin-Cms-Doc/Filters.md\n */\nexport function useApiQueryBuilder() {\n  const q = ref<string[]>([])\n\n  const querySetLimit = (value: number): void => {\n    queryAdd('limit', value)\n  }\n\n  const querySetOffset = (page: number, limit: number): void => {\n    queryAdd('offset', Math.max(0, (page - 1) * limit))\n  }\n\n  const querySetOrder = (field: string | null, desc: boolean): void => {\n    if (!isNull(field) && field.length > 0) queryAdd('order[' + field + ']', desc ? SortOrder.Desc : SortOrder.Asc)\n  }\n\n  const formatValue = (value: string | number | boolean): string | number => {\n    if (isBoolean(value)) {\n      return value ? '1' : '0'\n    }\n    return value\n  }\n\n  const queryAddFilter = (filterVariant: FilterVariant, field: string, value: string | number | boolean): void => {\n    if (isString(value) && value.length === 0) return\n    q.value.push('filter_' + filterVariant + '[' + field + ']=' + formatValue(value))\n  }\n\n  // `resolveTimeIntervalFilter` is public, so callers can pass any field names. A missing one fails with its name.\n  const fieldConfig = (filterConfig: FilterConfig<any>, name: string) => {\n    const field = filterConfig.fields[name]\n    if (isUndefined(field)) throw new Error(`useApiQueryBuilder: filter field \"${name}\" is not configured`)\n    return field\n  }\n\n  const resolveTimeIntervalFilter = (\n    fromName: string,\n    untilName: string,\n    filterData: FilterData<any>,\n    filterConfig: FilterConfig<any>,\n    mandatory: boolean,\n    exclude: boolean\n  ): null | {\n    from: DatetimeUTCNullable\n    until: DatetimeUTCNullable\n  } => {\n    let fromValue = filterData[fromName] as TimeIntervalToolsValue\n    let untilValue = filterData[untilName] as DatetimeUTCNullable\n    if (isNull(fromValue) && mandatory && !exclude) {\n      fromValue = fieldConfig(filterConfig, fromName).default as TimeIntervalToolsValue\n    }\n    if (isNull(untilValue) && mandatory && !exclude) {\n      untilValue = fieldConfig(filterConfig, untilName).default as DatetimeUTCNullable\n    }\n    if (isString(fromValue) && isString(untilValue)) {\n      return {\n        from: fromValue,\n        until: untilValue,\n      }\n    }\n    const now = dateTimeNow()\n    const nowDate = dateTimeToDate(now)\n    switch (fromValue) {\n      case TimeIntervalSpecialOptions.CurrentMonth: {\n        return getMonthInterval(nowDate, 'utc', 0, false)\n      }\n      case TimeIntervalSpecialOptions.LastMonth: {\n        return getMonthInterval(nowDate, 'utc', -1, false)\n      }\n      case TimeIntervalSpecialOptions.Last3Months: {\n        return getMonthInterval(nowDate, 'utc', -2, true)\n      }\n      default: {\n        if (isNumber(fromValue)) {\n          return {\n            from: dateToUtc(dateModifyMinutes(fromValue * -1, nowDate)),\n            until: now,\n          }\n        }\n      }\n    }\n    return null\n  }\n\n  const getValue = (value: AllowedFilterValues, config: FilterField): string | number | boolean | null => {\n    if (isNull(value)) {\n      if (config.mandatory && !config.exclude && !isUndefined(config.default)) {\n        return isArray(config.default) ? config.default.join(',') : config.default\n      }\n      return null\n    }\n    if (isString(value)) {\n      if (value.length === 0) {\n        if (config.mandatory && !config.exclude && !isUndefined(config.default) && !isNull(config.default)) {\n          return encodeURIComponent(isArray(config.default) ? config.default.join(',') : config.default)\n        }\n        return null\n      }\n      return encodeURIComponent(value)\n    }\n    if (isArray(value)) {\n      if (value.length === 0) {\n        if (config.mandatory && !config.exclude && isArray(config.default)) {\n          return config.default.map((item) => (isString(item) ? encodeURIComponent(item) : item)).join(',')\n        }\n        return null\n      }\n      return value.map((item) => (isString(item) ? encodeURIComponent(item) : item)).join(',')\n    }\n    if (isNumber(value) || isBoolean(value)) {\n      return value\n    }\n\n    return null\n  }\n\n  const queryAdd = (key: string, value: any): void => {\n    q.value.push(key + '=' + value)\n  }\n\n  const queryBuild = (): string => {\n    return '?' + q.value.join('&')\n  }\n\n  const querySetFilters = (filterData: FilterData<any>, filterConfig: FilterConfig<any>): void => {\n    const isSimpleFilters = filterConfig.general.simpleFilters\n    for (const filterName in filterData) {\n      const filterFieldValue = filterData[filterName] as AllowedFilterValues\n      const filterFieldConfig = filterConfig.fields[filterName]\n      if (isUndefined(filterFieldConfig) || filterFieldConfig.exclude) {\n        continue\n      }\n      const name = filterFieldConfig.apiName || filterName\n      if (filterFieldConfig.type === 'timeInterval' && !isUndefined(filterFieldConfig.related)) {\n        const data = resolveTimeIntervalFilter(\n          filterName,\n          filterFieldConfig.related,\n          filterData,\n          filterConfig,\n          filterFieldConfig.mandatory,\n          filterFieldConfig.exclude\n        )\n        if (isNull(data)) {\n          continue\n        }\n        const filterFieldConfigRelated = fieldConfig(filterConfig, filterFieldConfig.related)\n        const nameRelated = filterFieldConfigRelated.apiName || filterFieldConfig.related\n        if (isSimpleFilters) {\n          queryAdd(name, data.from)\n          queryAdd(nameRelated, data.until)\n          continue\n        }\n        if (data.from) queryAddFilter('gte', name, data.from)\n        if (data.until) {\n          queryAddFilter('lte', nameRelated, data.until)\n        }\n        continue\n      }\n      const value = getValue(filterFieldValue, filterFieldConfig)\n      if (isNull(value)) {\n        continue\n      }\n      if (isSimpleFilters) {\n        queryAdd(name, value)\n        continue\n      }\n      queryAddFilter(filterFieldConfig.variant, name, value)\n    }\n  }\n\n  return {\n    resolveTimeIntervalFilter,\n    querySetLimit,\n    querySetOffset,\n    querySetOrder,\n    queryAddFilter,\n    querySetFilters,\n    queryAdd,\n    queryBuild,\n    q,\n  }\n}\n"],"mappings":";;;;;;AAoBA,SAAgBA,IAAqB;CACnC,IAAMC,IAAIC,EAAc,CAAC,CAAC,GAEpBC,KAAiB,MAAwB;EAC7C,EAAS,SAASC,CAAK;CACzB,GAEMC,KAAkB,GAAc,MAAwB;EAC5D,EAAS,UAAU,KAAK,IAAI,IAAIC,IAAO,KAAKC,CAAK,CAAC;CACpD,GAEMC,KAAiB,GAAsB,MAAwB;EACnE,AAAI,CAACC,EAAOC,CAAK,KAAKA,EAAM,SAAS,KAAGC,EAAS,WAAWD,IAAQ,KAAKE,IAAOC,EAAU,OAAOA,EAAU,GAAG;CAChH,GAEMC,KAAe,MACfC,EAAUX,CAAK,IACVA,IAAQ,MAAM,MAEhBA,GAGHY,KAAkB,GAA8B,GAAe,MAA2C;EAC9G,AAAIC,EAASb,CAAK,KAAKA,EAAM,WAAW,KACxCH,EAAE,MAAM,KAAK,YAAYiB,IAAgB,MAAMR,IAAQ,OAAOI,EAAYV,CAAK,CAAC;CAClF,GAGMe,KAAe,GAAiC,MAAiB;EACrE,IAAMT,IAAQU,EAAa,OAAOC;EAClC,IAAIC,EAAYZ,CAAK,GAAG,MAAU,MAAM,qCAAqCW,EAAK,oBAAoB;EACtG,OAAOX;CACT,GAEMa,KACJ,GACA,GACA,GACA,GACA,GACA,MAIG;EACH,IAAIC,IAAYC,EAAWC,IACvBC,IAAaF,EAAWG;EAO5B,IANInB,EAAOe,CAAS,KAAKK,KAAa,CAACC,MACrC,IAAYX,EAAYC,GAAcM,CAAQ,CAAC,CAAC,UAE9CjB,EAAOkB,CAAU,KAAKE,KAAa,CAACC,MACtC,IAAaX,EAAYC,GAAcQ,CAAS,CAAC,CAAC,UAEhDX,EAASO,CAAS,KAAKP,EAASU,CAAU,GAC5C,OAAO;GACL,MAAMH;GACN,OAAOG;EACT;EAEF,IAAMI,IAAMC,EAAY,GAClBC,IAAUC,EAAeH,CAAG;EAClC,QAAQP,GAAR;GACE,KAAKW,EAA2B,cAC9B,OAAOC,EAAiBH,GAAS,OAAO,GAAG,EAAK;GAElD,KAAKE,EAA2B,WAC9B,OAAOC,EAAiBH,GAAS,OAAO,IAAI,EAAK;GAEnD,KAAKE,EAA2B,aAC9B,OAAOC,EAAiBH,GAAS,OAAO,IAAI,EAAI;GAElD,SACE,IAAII,EAASb,CAAS,GACpB,OAAO;IACL,MAAMc,EAAUC,EAAkBf,IAAY,IAAIS,CAAO,CAAC;IAC1D,OAAOF;GACT;EAGN;EACA,OAAO;CACT,GAEMS,KAAY,GAA4B,MACxC/B,EAAOL,CAAK,IACVqC,EAAO,aAAa,CAACA,EAAO,WAAW,CAACnB,EAAYmB,EAAO,OAAO,IAC7DC,EAAQD,EAAO,OAAO,IAAIA,EAAO,QAAQ,KAAK,GAAG,IAAIA,EAAO,UAE9D,OAELxB,EAASb,CAAK,IACZA,EAAM,WAAW,IACfqC,EAAO,aAAa,CAACA,EAAO,WAAW,CAACnB,EAAYmB,EAAO,OAAO,KAAK,CAAChC,EAAOgC,EAAO,OAAO,IACxF,mBAAmBC,EAAQD,EAAO,OAAO,IAAIA,EAAO,QAAQ,KAAK,GAAG,IAAIA,EAAO,OAAO,IAExF,OAEF,mBAAmBrC,CAAK,IAE7BsC,EAAQtC,CAAK,IACXA,EAAM,WAAW,IACfqC,EAAO,aAAa,CAACA,EAAO,WAAWC,EAAQD,EAAO,OAAO,IACxDA,EAAO,QAAQ,KAAK,MAAUxB,EAAS0B,CAAI,IAAI,mBAAmBA,CAAI,IAAIA,CAAK,CAAC,CAAC,KAAK,GAAG,IAE3F,OAEFvC,EAAM,KAAK,MAAUa,EAAS0B,CAAI,IAAI,mBAAmBA,CAAI,IAAIA,CAAK,CAAC,CAAC,KAAK,GAAG,IAErFN,EAASjC,CAAK,KAAKW,EAAUX,CAAK,IAC7BA,IAGF,MAGHO,KAAY,GAAa,MAAqB;EAClD,EAAE,MAAM,KAAKiC,IAAM,MAAMxC,CAAK;CAChC;CAoDA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA,kBApDuB,GAA6B,MAA0C;GAC9F,IAAMyC,IAAkBzB,EAAa,QAAQ;GAC7C,KAAK,IAAM0B,KAAcrB,GAAY;IACnC,IAAMsB,IAAmBtB,EAAWqB,IAC9BE,IAAoB5B,EAAa,OAAO0B;IAC9C,IAAIxB,EAAY0B,CAAiB,KAAKA,EAAkB,SACtD;IAEF,IAAM3B,IAAO2B,EAAkB,WAAWF;IAC1C,IAAIE,EAAkB,SAAS,kBAAkB,CAAC1B,EAAY0B,EAAkB,OAAO,GAAG;KACxF,IAAMC,IAAO1B,EACXuB,GACAE,EAAkB,SAClBvB,GACAL,GACA4B,EAAkB,WAClBA,EAAkB,OACpB;KACA,IAAIvC,EAAOwC,CAAI,GACb;KAGF,IAAMC,IAD2B/B,EAAYC,GAAc4B,EAAkB,OACzD,CAAA,CAAyB,WAAWA,EAAkB;KAC1E,IAAIH,GAAiB;MAEnB,AADAlC,EAASU,GAAM4B,EAAK,IAAI,GACxBtC,EAASuC,GAAaD,EAAK,KAAK;MAChC;KACF;KAEA,AADIA,EAAK,QAAMjC,EAAe,OAAOK,GAAM4B,EAAK,IAAI,GAChDA,EAAK,SACPjC,EAAe,OAAOkC,GAAaD,EAAK,KAAK;KAE/C;IACF;IACA,IAAM7C,IAAQoC,EAASO,GAAkBC,CAAiB;IAC1D,AAAIvC,EAAOL,CAAK,MAGZyC,IACFlC,EAASU,GAAMjB,CAAK,IAGtBY,EAAegC,EAAkB,SAAS3B,GAAMjB,CAAK;GACvD;EACF;EASE;EACA,kBAzDO,MAAMH,EAAE,MAAM,KAAK,GAAG;EA0D7B;CACF;AACF"}

package/dist/domains/api/composables/useApiRequest.d.ts

@@ -0,0 +1,64 @@
+import { UrlParams } from '../utils/apiHelper';
+import { AxiosRequestConfig, Method } from 'axios';
+import { Ref } from 'vue';
+import { AxiosClientFn } from '../utils/client';
+export type ExecuteRequestParams<B> = {
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    body?: B;
+    /** Stops this one call, leaving the instance's other calls alone. */
+    signal?: AbortSignal;
+    /**
+     * `false`: a failure of this call is still thrown but not sent to the api error logger.
+     * For pollers that already reported the first failure, so an outage
+     * is not logged on every tick. It is set per call, not per instance.
+     */
+    report?: boolean;
+};
+export type UseApiRequestParams = {
+    client: AxiosClientFn;
+    method: Method;
+    system: string;
+    entity: string;
+    /** i18n scope for field-level validation failures; defaults to `system` / `entity`. */
+    validationSystem?: string;
+    validationEntity?: string;
+    urlTemplate?: string;
+    urlParams?: UrlParams;
+    options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
+    /** Each call cancels the previous one, as for autocomplete. */
+    cancelPrevious?: boolean;
+};
+export type UseApiRequestReturnType<R, B> = {
+    execute: (params?: ExecuteRequestParams<B>) => Promise<R>;
+    abort: () => void;
+    /**
+     * True while this instance has a request in flight. Unlike a caller-cleared
+     * `finally` flag, it does not dip when `cancelPrevious` supersedes a call.
+     * It covers only this helper's work. Keep your own flag if it also spans follow-up fetches or mapping.
+     * It belongs to the instance. A factory that builds one per call cannot
+     * expose `loading`, `abort` or `cancelPrevious`, so hoist the instance first.
+     */
+    loading: Ref<boolean>;
+};
+/**
+ * A request to an endpoint that always answers with a body.
+ * A response without a body breaks the contract and fails like any other error.
+ * Use `useApiCommand` for endpoints that answer nothing, and `optionalBody` for endpoints that may answer either.
+ * `R` excludes `null`, `undefined` and `void` on purpose, so `useApiRequest<void, …>` does not compile.
+ */
+export declare function useApiRequest<R extends NonNullable<unknown>, B = never>(params: UseApiRequestParams & {
+    optionalBody?: false;
+}): UseApiRequestReturnType<R, B>;
+/**
+ * Same as above, for an endpoint where a missing body is a legitimate answer. The caller must narrow.
+ * Use it only where the endpoint is documented that way.
+ */
+export declare function useApiRequest<R extends NonNullable<unknown>, B = never>(params: UseApiRequestParams & {
+    optionalBody: true;
+}): UseApiRequestReturnType<R | undefined, B>;
+/**
+ * A request that reads nothing back, such as a delete or a call that starts work and answers 202.
+ * Any successful status resolves. A body, if one arrives, is ignored.
+ */
+export declare const useApiCommand: <B = never>(params: UseApiRequestParams) => UseApiRequestReturnType<void, B>;