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

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

@@ -12,7 +12,6 @@ export type UseApiFetchByIdsParams = {
     validationEntity?: string;
     urlTemplate?: string;
     urlParams?: UrlParams;
-    /** Anything axios takes except what this helper decides: the method, the url, the body and the signal. */
     options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
     isSearchApi?: boolean;
     field?: string;
@@ -25,8 +24,8 @@ export type FetchByIdsParams = {
     signal?: AbortSignal;
 };
 /**
- * Ids per request. A cache drains everything queued in one go, and a thousand ids in a query string is
- * past the 8 KB request line a proxy takes by default -- the request would come back 414.
+ * Ids per request. A cache drains all queued ids at once, and a thousand ids in
+ * a query string exceed the default 8 KB proxy request line limit, giving a 414.
  */
 export declare const FETCH_BY_IDS_BATCH_SIZE = 100;
 export declare const useApiFetchByIds: <T>(params: UseApiFetchByIdsParams) => UseApiFetchByIdsReturnType<T>;
@@ -34,24 +33,11 @@ export type UseApiFetchByIdsReturnType<T> = {
     execute: (ids: DocId[] | IntegerId[], params?: FetchByIdsParams) => Promise<T[]>;
     abort: () => void;
     /**
-     * True while this instance has a request in flight, false once the last one settles.
-     *
-     * It is here so a caller does not have to keep its own: the hand-rolled version is a ref cleared in
-     * a `finally`, and that `finally` belongs to whichever call ended -- including one that
-     * `cancelPrevious` just superseded, which turns the spinner off while the call the user is waiting
-     * for is still running. This one never dips between a superseded call and the one that replaced it.
-     *
-     * Two things to know before replacing a hand-rolled flag with it.
-     *
-     * It covers what this helper does and nothing the caller does afterwards. A flag that also spans a
-     * follow-up cached fetch, a mapping pass or a second endpoint is not the same flag, and swapping it
-     * for this one turns the spinner off too early. Keep your own where it means more than "this helper
-     * is working".
-     *
-     * It belongs to the instance, so it is only reachable if you hold the instance. A factory that
-     * builds one per call and hands back the promise alone -- `const { execute } = useX()` inside the
-     * function that calls it -- cannot expose `loading`, `abort` or `cancelPrevious` at all. Hoist the
-     * instance to where the caller lives first.
+     * 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/useApiFetchByIds.js

@@ -1,44 +1,44 @@
-import { isDefined as e, isUndefined as t } from "../../../shared/utils/common.js";
-import { AnzuFatalError as n } from "../../../shared/error/AnzuFatalError.js";
+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 { AnzuApiResponseCodeError as r } from "../../../shared/error/AnzuApiResponseCodeError.js";
-import { replaceUrlParameters as i } from "../utils/apiHelper.js";
-import { isValidHTTPStatus as a } from "../utils/response.js";
-import { mapApiError as o, report as s } from "../utils/apiErrors.js";
-import { createAbortable as c, hasBody as l, ownedByHelper as u, requestedUrl as d } from "./request.js";
-import { readListBody as f } from "../utils/listBody.js";
-import { useApiQueryBuilder as p } from "./useApiQueryBuilder.js";
+import { isDefined as i, isUndefined as a } from "../../../shared/utils/common.js";
+import { useApiQueryBuilder as o } from "./useApiQueryBuilder.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 { readListBody as p } from "../utils/listBody.js";
 var m = (e, t, n = "id") => {
-	let { querySetLimit: r, querySetOffset: i, querySetOrder: a, queryBuild: o, queryAddFilter: s, queryAdd: c } = p(), l = e.length;
-	return r(l), i(1, l), a(n, !1), t ? c(n, e.join(",")) : s("in", n, e.join(",")), o();
-}, h = (p) => {
-	let { client: h, system: g, entity: _, validationSystem: v, validationEntity: y, urlTemplate: b, urlParams: x, options: S = {}, isSearchApi: C = !1, field: w = "id", cancelPrevious: T = !1 } = p, E = c({ cancelPrevious: T }), D = async (c, p) => {
-		let { urlTemplate: T, urlParams: D, signal: O } = p, k, A;
+	let { querySetLimit: r, querySetOffset: i, querySetOrder: a, queryBuild: s, queryAddFilter: c, queryAdd: l } = o(), u = e.length;
+	return r(u), i(1, u), a(n, !1), t ? l(n, e.join(",")) : c("in", n, e.join(",")), s();
+}, h = (o) => {
+	let { client: h, system: g, entity: _, validationSystem: v, validationEntity: y, urlTemplate: b, urlParams: x, options: S = {}, isSearchApi: C = !1, field: w = "id", cancelPrevious: T = !1 } = o, E = l({ cancelPrevious: T }), D = async (o, l) => {
+		let { urlTemplate: T, urlParams: D, signal: O } = l, k, A;
 		try {
-			let o = await E.run((r) => {
-				let a = e(T) ? T : b;
-				if (t(a)) throw new n(void 0, "Url template is undefined");
-				let o = e(D) ? D : x, s = (t(o) ? a : i(a, o)) + m(c, C, w), l = h();
-				return k = s, l.get(s, {
-					...u(S),
-					signal: r
+			let s = await E.run((t) => {
+				let r = i(T) ? T : b;
+				if (a(r)) throw new e(void 0, "Url template is undefined");
+				let s = i(D) ? D : x, c = (a(s) ? r : n(r, s)) + m(o, C, w), l = h();
+				return k = c, l.get(c, {
+					...d(S),
+					signal: t
 				});
 			}, O);
-			A = o.config;
-			let s = () => d(h, k, S, void 0, A);
-			if (!a(o.status)) throw new r(o.status);
-			if (o.status === 204) return [];
-			if (!l(o)) throw new r(o.status, void 0, "Expected a response body, url: " + s());
-			return f(o.data, o.status, s()).items;
+			A = s.config;
+			let c = () => f(h, k, S, void 0, A);
+			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 p(s.data, s.status, c()).items;
 		} catch (e) {
 			let t = {
 				system: g,
 				entity: _,
 				validationSystem: v,
 				validationEntity: y,
-				url: d(h, k, S, e, A)
+				url: f(h, k, S, e, A)
 			};
-			throw s(o(e, t), t);
+			throw c(s(e, t), t);
 		}
 	};
 	return {
@@ -55,7 +55,6 @@ var m = (e, t, n = "id") => {
 		loading: E.loading
 	};
 };
-//#endregion
 export { h as useApiFetchByIds };
 
 //# sourceMappingURL=useApiFetchByIds.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useApiFetchByIds.js","names":["generateByIdsApiQuery","useApiQueryBuilder","limit","ids","querySetLimit","querySetOffset","querySetOrder","field","isSearchApi","queryAdd","queryAddFilter","queryBuild","useApiFetchByIds","params","abortable","createAbortable","executeBatch","urlTemplateOverride","urlParamsOverride","fetchParams","url","dispatched","res","template","isDefined","urlTemplate","isUndefined","AnzuFatalError","resolvedParams","urlParams","requestUrl","replaceUrlParameters","instance","client","ownedByHelper","options","abortSignal","signal","asSent","requestedUrl","isValidHTTPStatus","AnzuApiResponseCodeError","hasBody","readListBody","err","context","report","mapApiError","items","start","batch"],"sources":["../../../../src/domains/api/composables/useApiFetchByIds.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 type { DocId, IntegerId } from '@/shared/types/common'\nimport { isDefined, isUndefined } from '@/shared/utils/common'\nimport type { Ref } from 'vue'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { useApiQueryBuilder } from '@/domains/api/composables/useApiQueryBuilder'\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 UseApiFetchByIdsParams = {\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  /** Anything axios takes except what this helper decides: the method, the url, the body and the signal. */\n  options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>\n  isSearchApi?: boolean\n  field?: string\n  cancelPrevious?: boolean\n}\n\nexport type FetchByIdsParams = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n}\n\n/**\n * Ids per request. A cache drains everything queued in one go, and a thousand ids in a query string is\n * past the 8 KB request line a proxy takes by default -- the request would come back 414.\n */\nexport const FETCH_BY_IDS_BATCH_SIZE = 100\n\n/** The `filter_in` query that fetches exactly the ids asked for, in one request. */\nconst generateByIdsApiQuery = (ids: IntegerId[] | DocId[], isSearchApi: boolean, field = 'id'): string => {\n  const { querySetLimit, querySetOffset, querySetOrder, queryBuild, queryAddFilter, queryAdd } = useApiQueryBuilder()\n  const limit = ids.length\n  querySetLimit(limit)\n  querySetOffset(1, limit)\n  querySetOrder(field, false)\n  if (isSearchApi) queryAdd(field, ids.join(','))\n  else queryAddFilter('in', field, ids.join(','))\n\n  return queryBuild()\n}\n\nexport const useApiFetchByIds = <T>(params: UseApiFetchByIdsParams): UseApiFetchByIdsReturnType<T> => {\n  const {\n    client,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    isSearchApi = false,\n    field = 'id',\n    cancelPrevious = false,\n  } = params\n  const abortable = createAbortable({ cancelPrevious })\n\n  const executeBatch = async (ids: DocId[] | IntegerId[], fetchParams: FetchByIdsParams): Promise<T[]> => {\n    const { urlTemplate: urlTemplateOverride, urlParams: urlParamsOverride, signal } = fetchParams\n\n    // Assigned inside `run`, once, at the moment there is a url to ask for; undefined until then,\n    // which is what a failure before dispatch honestly reports.\n    let url: string | undefined\n    // The config axios used, kept for the failures this helper raises after reading the response:\n    // they carry no config of their own, and rebuilding one describes the request as the client\n    // would send it now rather than as it was sent.\n    let dispatched: AxiosRequestConfig | undefined\n\n    try {\n      const res = await abortable.run((abortSignal) => {\n        // Derived inside `run`, the way the list does it: `run` opens the generation and, with\n        // `cancelPrevious`, stops the call before this one, so work done ahead of it would let a\n        // call that never dispatches leave its predecessor running. Inside the try as well, so a\n        // caller that forgot the template gets the same error class as every other failure rather\n        // than a bare `Error`.\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 baseUrl = isUndefined(resolvedParams) ? template : replaceUrlParameters(template, resolvedParams)\n        const requestUrl = baseUrl + generateByIdsApiQuery(ids, isSearchApi, field)\n        const instance = client()\n\n        // Recorded last, when nothing between here and the call can throw any more: a client factory\n        // that fails is a request that never happened, and the report says so by naming no url.\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 will name, so a message and the context beside it cannot disagree about\n      // which request failed when an interceptor rewrote it on the way out.\n      const asSent = () => requestedUrl(client, url, options, undefined, dispatched)\n      if (!isValidHTTPStatus(res.status)) throw new AnzuApiResponseCodeError(res.status)\n\n      // Nothing matched the ids -- 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 readListBody<T>(res.data, res.status, asSent()).items\n    } catch (err: unknown) {\n      // Built once and handed to both, the way the batch does it: half the work on the failure path,\n      // and one place that could go wrong instead of two.\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  // One batch after another, not side by side: with `cancelPrevious` each batch would stop the one\n  // before it. A failed batch fails the call, as a single request would.\n  const execute = async (ids: DocId[] | IntegerId[], fetchParams: FetchByIdsParams = {}): Promise<T[]> => {\n    if (ids.length <= FETCH_BY_IDS_BATCH_SIZE) return executeBatch(ids, fetchParams)\n    const items: T[] = []\n    for (let start = 0; start < ids.length; start += FETCH_BY_IDS_BATCH_SIZE) {\n      const batch = ids.slice(start, start + FETCH_BY_IDS_BATCH_SIZE) as DocId[] | IntegerId[]\n      items.push(...(await executeBatch(batch, fetchParams)))\n    }\n    return items\n  }\n\n  return { execute, abort: abortable.abort, loading: abortable.loading }\n}\n\nexport type UseApiFetchByIdsReturnType<T> = {\n  execute: (ids: DocId[] | IntegerId[], params?: FetchByIdsParams) => Promise<T[]>\n  abort: () => void\n  /**\n   * True while this instance has a request in flight, false once the last one settles.\n   *\n   * It is here so a caller does not have to keep its own: the hand-rolled version is a ref cleared in\n   * a `finally`, and that `finally` belongs to whichever call ended -- including one that\n   * `cancelPrevious` just superseded, which turns the spinner off while the call the user is waiting\n   * for is still running. This one never dips between a superseded call and the one that replaced it.\n   *\n   * Two things to know before replacing a hand-rolled flag with it.\n   *\n   * It covers what this helper does and nothing the caller does afterwards. A flag that also spans a\n   * follow-up cached fetch, a mapping pass or a second endpoint is not the same flag, and swapping it\n   * for this one turns the spinner off too early. Keep your own where it means more than \"this helper\n   * is working\".\n   *\n   * It belongs to the instance, so it is only reachable if you hold the instance. A factory that\n   * builds one per call and hands back the promise alone -- `const { execute } = useX()` inside the\n   * function that calls it -- cannot expose `loading`, `abort` or `cancelPrevious` at all. Hoist the\n   * instance to where the caller lives first.\n   */\n  loading: Ref<boolean>\n}\n"],"mappings":";;;;;;;;;;AA6CA,IAAMA,KAAyB,GAA4B,GAAsB,IAAQ,SAAiB;CACxG,IAAM,EAAE,kBAAe,mBAAgB,kBAAe,eAAY,mBAAgB,gBAAaC,EAAmB,GAC5GC,IAAQC,EAAI;CAOlB,OANAC,EAAcF,CAAK,GACnBG,EAAe,GAAGH,CAAK,GACvBI,EAAcC,GAAO,EAAK,GACtBC,IAAaC,EAASF,GAAOJ,EAAI,KAAK,GAAG,CAAC,IACzCO,EAAe,MAAMH,GAAOJ,EAAI,KAAK,GAAG,CAAC,GAEvCQ,EAAW;AACpB,GAEaC,KAAuB,MAAkE;CACpG,IAAM,EACJ,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,iBAAc,IACd,WAAQ,MACR,oBAAiB,OACfC,GACEC,IAAYC,EAAgB,EAAE,kBAAe,CAAC,GAE9CC,IAAe,OAAO,GAA4B,MAAgD;EACtG,IAAM,EAAE,aAAaC,GAAqB,WAAWC,GAAmB,cAAWC,GAI/EC,GAIAC;EAEJ,IAAI;GACF,IAAMC,IAAM,MAAMR,EAAU,KAAK,MAAgB;IAM/C,IAAMS,IAAWC,EAAUP,CAAmB,IAAIA,IAAsBQ;IACxE,IAAIC,EAAYH,CAAQ,GAAG,MAAM,IAAII,EAAe,KAAA,GAAW,2BAA2B;IAE1F,IAAMC,IAAiBJ,EAAUN,CAAiB,IAAIA,IAAoBW,GAEpEC,KADUJ,EAAYE,CAAc,IAAIL,IAAWQ,EAAqBR,GAAUK,CAAc,KACzE5B,EAAsBG,GAAKK,GAAaD,CAAK,GACpEyB,IAAWC,EAAO;IAMxB,OAFA,IAAMH,GAECE,EAAS,IAAIF,GAAY;KAAE,GAAGI,EAAcC,CAAO;KAAG,QAAQC;IAAY,CAAC;GACpF,GAAGC,CAAM;GAET,IAAaf,EAAI;GAGjB,IAAMgB,UAAeC,EAAaN,GAAQb,GAAKe,GAAS,KAAA,GAAWd,CAAU;GAC7E,IAAI,CAACmB,EAAkBlB,EAAI,MAAM,GAAG,MAAM,IAAImB,EAAyBnB,EAAI,MAAM;GAGjF,IAAIA,EAAI,WAAA,KAAmC,OAAO,CAAC;GAEnD,IAAI,CAACoB,EAAQpB,CAAG,GACd,MAAM,IAAImB,EAAyBnB,EAAI,QAAQ,KAAA,GAAW,oCAAoCgB,EAAO,CAAC;GAGxG,OAAOK,EAAgBrB,EAAI,MAAMA,EAAI,QAAQgB,EAAO,CAAC,CAAC,CAAC;EACzD,SAASM,GAAc;GAGrB,IAAMC,IAAU;IACd;IACA;IACA;IACA;IACA,KAAKN,EAAaN,GAAQb,GAAKe,GAASS,GAAKvB,CAAU;GACzD;GAEA,MAAMyB,EAAOC,EAAYH,GAAKC,CAAO,GAAGA,CAAO;EACjD;CACF;CAcA,OAAO;EAAE,gBAVc,GAA4B,IAAgC,CAAC,MAAoB;GACtG,IAAI1C,EAAI,UAAA,KAAmC,OAAOa,EAAab,GAAKgB,CAAW;GAC/E,IAAM6B,IAAa,CAAC;GACpB,KAAK,IAAIC,IAAQ,GAAGA,IAAQ9C,EAAI,QAAQ,KAAA,KAAkC;IACxE,IAAM+C,IAAQ/C,EAAI,MAAM8C,GAAOA,IAAA,GAA+B;IAC9D,EAAM,KAAK,GAAI,MAAMjC,EAAakC,GAAO/B,CAAW,CAAE;GACxD;GACA,OAAO6B;EACT;EAEkB,OAAOlC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE"}
+{"version":3,"file":"useApiFetchByIds.js","names":["generateByIdsApiQuery","useApiQueryBuilder","limit","ids","querySetLimit","querySetOffset","querySetOrder","field","isSearchApi","queryAdd","queryAddFilter","queryBuild","useApiFetchByIds","params","abortable","createAbortable","executeBatch","urlTemplateOverride","urlParamsOverride","fetchParams","url","dispatched","res","template","isDefined","urlTemplate","isUndefined","AnzuFatalError","resolvedParams","urlParams","requestUrl","replaceUrlParameters","instance","client","ownedByHelper","options","abortSignal","signal","asSent","requestedUrl","isValidHTTPStatus","AnzuApiResponseCodeError","hasBody","readListBody","err","context","report","mapApiError","items","start","batch"],"sources":["../../../../src/domains/api/composables/useApiFetchByIds.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 type { DocId, IntegerId } from '@/shared/types/common'\nimport { isDefined, isUndefined } from '@/shared/utils/common'\nimport type { Ref } from 'vue'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { useApiQueryBuilder } from '@/domains/api/composables/useApiQueryBuilder'\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 UseApiFetchByIdsParams = {\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  isSearchApi?: boolean\n  field?: string\n  cancelPrevious?: boolean\n}\n\nexport type FetchByIdsParams = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n}\n\n/**\n * Ids per request. A cache drains all queued ids at once, and a thousand ids in\n * a query string exceed the default 8 KB proxy request line limit, giving a 414.\n */\nexport const FETCH_BY_IDS_BATCH_SIZE = 100\n\nconst generateByIdsApiQuery = (ids: IntegerId[] | DocId[], isSearchApi: boolean, field = 'id'): string => {\n  const { querySetLimit, querySetOffset, querySetOrder, queryBuild, queryAddFilter, queryAdd } = useApiQueryBuilder()\n  const limit = ids.length\n  querySetLimit(limit)\n  querySetOffset(1, limit)\n  querySetOrder(field, false)\n  if (isSearchApi) queryAdd(field, ids.join(','))\n  else queryAddFilter('in', field, ids.join(','))\n\n  return queryBuild()\n}\n\nexport const useApiFetchByIds = <T>(params: UseApiFetchByIdsParams): UseApiFetchByIdsReturnType<T> => {\n  const {\n    client,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    isSearchApi = false,\n    field = 'id',\n    cancelPrevious = false,\n  } = params\n  const abortable = createAbortable({ cancelPrevious })\n\n  const executeBatch = async (ids: DocId[] | IntegerId[], fetchParams: FetchByIdsParams): Promise<T[]> => {\n    const { urlTemplate: urlTemplateOverride, urlParams: urlParamsOverride, 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    // 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    try {\n      const res = await abortable.run((abortSignal) => {\n        // Derived inside `run` because `run` opens the generation and, with `cancelPrevious`, stops the\n        // previous call. Work done before it could leave the predecessor running if this call never dispatches.\n        // Inside the try so a missing template raises the same error class as other failures.\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 baseUrl = isUndefined(resolvedParams) ? template : replaceUrlParameters(template, resolvedParams)\n        const requestUrl = baseUrl + generateByIdsApiQuery(ids, isSearchApi, field)\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      // Nothing matched the ids -- 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 readListBody<T>(res.data, res.status, asSent()).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      throw report(mapApiError(err, context), context)\n    }\n  }\n\n  // Batches run sequentially. In parallel, `cancelPrevious` would make each\n  // batch stop the one before it. A failed batch fails the whole call.\n  const execute = async (ids: DocId[] | IntegerId[], fetchParams: FetchByIdsParams = {}): Promise<T[]> => {\n    if (ids.length <= FETCH_BY_IDS_BATCH_SIZE) return executeBatch(ids, fetchParams)\n    const items: T[] = []\n    for (let start = 0; start < ids.length; start += FETCH_BY_IDS_BATCH_SIZE) {\n      const batch = ids.slice(start, start + FETCH_BY_IDS_BATCH_SIZE) as DocId[] | IntegerId[]\n      items.push(...(await executeBatch(batch, fetchParams)))\n    }\n    return items\n  }\n\n  return { execute, abort: abortable.abort, loading: abortable.loading }\n}\n\nexport type UseApiFetchByIdsReturnType<T> = {\n  execute: (ids: DocId[] | IntegerId[], params?: FetchByIdsParams) => 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,IAAMA,KAAyB,GAA4B,GAAsB,IAAQ,SAAiB;CACxG,IAAM,EAAE,kBAAe,mBAAgB,kBAAe,eAAY,mBAAgB,gBAAaC,EAAmB,GAC5GC,IAAQC,EAAI;CAOlB,OANAC,EAAcF,CAAK,GACnBG,EAAe,GAAGH,CAAK,GACvBI,EAAcC,GAAO,EAAK,GACtBC,IAAaC,EAASF,GAAOJ,EAAI,KAAK,GAAG,CAAC,IACzCO,EAAe,MAAMH,GAAOJ,EAAI,KAAK,GAAG,CAAC,GAEvCQ,EAAW;AACpB,GAEaC,KAAuB,MAAkE;CACpG,IAAM,EACJ,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,iBAAc,IACd,WAAQ,MACR,oBAAiB,OACfC,GACEC,IAAYC,EAAgB,EAAE,kBAAe,CAAC,GAE9CC,IAAe,OAAO,GAA4B,MAAgD;EACtG,IAAM,EAAE,aAAaC,GAAqB,WAAWC,GAAmB,cAAWC,GAI/EC,GAGAC;EAEJ,IAAI;GACF,IAAMC,IAAM,MAAMR,EAAU,KAAK,MAAgB;IAI/C,IAAMS,IAAWC,EAAUP,CAAmB,IAAIA,IAAsBQ;IACxE,IAAIC,EAAYH,CAAQ,GAAG,MAAM,IAAII,EAAe,KAAA,GAAW,2BAA2B;IAE1F,IAAMC,IAAiBJ,EAAUN,CAAiB,IAAIA,IAAoBW,GAEpEC,KADUJ,EAAYE,CAAc,IAAIL,IAAWQ,EAAqBR,GAAUK,CAAc,KACzE5B,EAAsBG,GAAKK,GAAaD,CAAK,GACpEyB,IAAWC,EAAO;IAMxB,OAFA,IAAMH,GAECE,EAAS,IAAIF,GAAY;KAAE,GAAGI,EAAcC,CAAO;KAAG,QAAQC;IAAY,CAAC;GACpF,GAAGC,CAAM;GAET,IAAaf,EAAI;GAEjB,IAAMgB,UAAeC,EAAaN,GAAQb,GAAKe,GAAS,KAAA,GAAWd,CAAU;GAC7E,IAAI,CAACmB,EAAkBlB,EAAI,MAAM,GAAG,MAAM,IAAImB,EAAyBnB,EAAI,MAAM;GAGjF,IAAIA,EAAI,WAAA,KAAmC,OAAO,CAAC;GAEnD,IAAI,CAACoB,EAAQpB,CAAG,GACd,MAAM,IAAImB,EAAyBnB,EAAI,QAAQ,KAAA,GAAW,oCAAoCgB,EAAO,CAAC;GAGxG,OAAOK,EAAgBrB,EAAI,MAAMA,EAAI,QAAQgB,EAAO,CAAC,CAAC,CAAC;EACzD,SAASM,GAAc;GAErB,IAAMC,IAAU;IACd;IACA;IACA;IACA;IACA,KAAKN,EAAaN,GAAQb,GAAKe,GAASS,GAAKvB,CAAU;GACzD;GAEA,MAAMyB,EAAOC,EAAYH,GAAKC,CAAO,GAAGA,CAAO;EACjD;CACF;CAcA,OAAO;EAAE,gBAVc,GAA4B,IAAgC,CAAC,MAAoB;GACtG,IAAI1C,EAAI,UAAA,KAAmC,OAAOa,EAAab,GAAKgB,CAAW;GAC/E,IAAM6B,IAAa,CAAC;GACpB,KAAK,IAAIC,IAAQ,GAAGA,IAAQ9C,EAAI,QAAQ,KAAA,KAAkC;IACxE,IAAM+C,IAAQ/C,EAAI,MAAM8C,GAAOA,IAAA,GAA+B;IAC9D,EAAM,KAAK,GAAI,MAAMjC,EAAakC,GAAO/B,CAAW,CAAE;GACxD;GACA,OAAO6B;EACT;EAEkB,OAAOlC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE"}

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

@@ -12,31 +12,23 @@ export type UseApiFetchItemsParams = {
     validationSystem?: string;
     validationEntity?: string;
     /**
-     * The url, query and all: whatever built the query has already run by the time it gets here.
-     *
-     * `urlParams` are substituted into the PATH only -- `/article/:id/routes?locale=:locale` fills in
-     * `:id` and sends `:locale` as it stands. This is the helper written for hand-made queries, so it
-     * is the one place someone would reach for a placeholder in the query; put the value in the query
-     * when building it, or pass it through `options.params` and let axios serialise it.
+     * The full url including the query, already built by the caller.
+     * `urlParams` are substituted into the path only. A placeholder in the query
+     * is sent as is. Put the value in the query or pass it via `options.params`.
      */
     urlTemplate?: string;
     urlParams?: UrlParams;
-    /** Anything axios takes except what this helper decides: the method, the url, the body and the signal. */
     options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
     cancelPrevious?: boolean;
     /**
-     * Default `GET`, which is what 17 of the fleet's list reads and every existing caller here use.
-     *
-     * The others are here because a list is not only ever the answer to a read: a filter too big for a
-     * url goes out as a POST, and a mutation can answer with the list it just changed -- a swap, a
-     * shift, an upsert-all. What this helper is about is the answer, not the verb.
+     * Defaults to `GET`.
+     * Other verbs exist because a filter too big for a url goes out
+     * as a POST, and a mutation can answer with the changed list.
      */
     method?: 'GET' | 'POST' | 'PUT' | 'PATCH';
     /**
-     * Default `'envelope'`, because that is the fleet's norm and the exception is what gets declared.
-     *
-     * Leaving it out cannot go wrong quietly: the reader refuses the shape that was not declared, so a
-     * forgotten `'array'` fails on the first run rather than handing back something that is not a list.
+     * Defaults to `'envelope'`, the fleet norm.
+     * The reader refuses an undeclared shape, so a forgotten `'array'` fails on the first run.
      */
     shape?: ItemsShape;
 };
@@ -49,53 +41,22 @@ export type FetchItemsParams<B = never> = {
     signal?: AbortSignal;
 };
 /**
- * A list from an endpoint the caller has already written the query for, with no pagination.
- *
- * It exists because the fleet kept doing this through `useApiRequest<ApiResponseList<T[]>>`: build a
- * query by hand -- an order, a limit, a fixed filter -- bake it into the url, and read `.data` off
- * the envelope that comes back. That is a list fetch with the list part missing: nothing checks that
- * `data` is an array, so a malformed answer still hands back `undefined` typed as `T[]`, which is
- * the bug this whole family was built to end.
- *
- * `useApiFetchList` cannot serve them: it asks for a pagination ref, a `filterData` and a
- * `filterConfig`, and these calls have none -- their filters are decided at the call site and are
- * not the user's to change. So this is that helper with the pagination taken out: same core, same
- * error mapping, same list-body check, and it answers with the items rather than the envelope.
- *
- * Read is the usual case, not the only one: a filter too big for a url goes out as a POST, and a
- * mutation can answer with the list it just changed. The helper is about what comes back.
- *
- * Which shape it comes back in is declared, not guessed. `shape` picks the reader and the reader
- * refuses the other shape, the way `optionalBody` makes a caller declare a body instead of leaving
- * the helper to accept whatever turns up. A wrong declaration therefore fails loudly on the first
- * run, which is what makes having a default safe at all.
- *
- * It writes no metadata. An endpoint whose paging the user drives is `useApiFetchList`; a list read
- * page by page to the end is `useApiFetchListBatch`.
+ * Fetches a list from an endpoint whose query the caller already built, without pagination.
+ * Replaces `useApiRequest<ApiResponseList<T[]>>` reads, which never checked that `data`
+ * is an array. `useApiFetchList` needs pagination and filter config these calls lack.
+ * `shape` is declared, and the reader refuses the other shape, so a wrong declaration fails loudly.
+ * Writes no metadata. Use `useApiFetchList` for user-driven paging and `useApiFetchListBatch` to read all pages.
  */
 export declare const useApiFetchItems: <T, B = never>(params: UseApiFetchItemsParams) => UseApiFetchItemsReturnType<T, B>;
 export type UseApiFetchItemsReturnType<T, B = never> = {
     execute: (params?: FetchItemsParams<B>) => Promise<T[]>;
     abort: () => void;
     /**
-     * True while this instance has a request in flight, false once the last one settles.
-     *
-     * It is here so a caller does not have to keep its own: the hand-rolled version is a ref cleared in
-     * a `finally`, and that `finally` belongs to whichever call ended -- including one that
-     * `cancelPrevious` just superseded, which turns the spinner off while the call the user is waiting
-     * for is still running. This one never dips between a superseded call and the one that replaced it.
-     *
-     * Two things to know before replacing a hand-rolled flag with it.
-     *
-     * It covers what this helper does and nothing the caller does afterwards. A flag that also spans a
-     * follow-up cached fetch, a mapping pass or a second endpoint is not the same flag, and swapping it
-     * for this one turns the spinner off too early. Keep your own where it means more than "this helper
-     * is working".
-     *
-     * It belongs to the instance, so it is only reachable if you hold the instance. A factory that
-     * builds one per call and hands back the promise alone -- `const { execute } = useX()` inside the
-     * function that calls it -- cannot expose `loading`, `abort` or `cancelPrevious` at all. Hoist the
-     * instance to where the caller lives first.
+     * 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/useApiFetchItems.js

@@ -1,29 +1,29 @@
-import { isDefined as e, isNull as t, isUndefined as n } from "../../../shared/utils/common.js";
-import { AnzuFatalError as r } from "../../../shared/error/AnzuFatalError.js";
+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 { AnzuApiResponseCodeError as i } from "../../../shared/error/AnzuApiResponseCodeError.js";
-import { replaceUrlParameters as a } from "../utils/apiHelper.js";
-import { isValidHTTPStatus as o } from "../utils/response.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";
-//#region src/domains/api/composables/useApiFetchItems.ts
+// 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((i) => {
-					let o = e(h) ? h : x;
-					if (n(o)) throw new r(void 0, "Url template is undefined");
-					let s = !t(O) && !n(O);
-					if (T === "GET" && s) throw new r(void 0, "A GET request does not carry a body -- set method, or pass the value through options.params");
-					let c = e(w) ? w : S, l = n(c) ? o : a(o, c), u = {
+				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: i
+						signal: t
 					};
 					s && (u.data = JSON.stringify(O));
 					let f = g();
@@ -31,9 +31,9 @@ var h = (h) => {
 				}, k);
 				j = s.config;
 				let c = () => f(g, A, C, void 0, j);
-				if (!o(s.status)) throw new i(s.status);
+				if (!r(s.status)) throw new t(s.status);
 				if (s.status === 204) return [];
-				if (!u(s)) throw new i(s.status, void 0, "Expected a response body, url: " + c());
+				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 = {
@@ -50,7 +50,6 @@ var h = (h) => {
 		loading: D.loading
 	};
 };
-//#endregion
 export { h as useApiFetchItems };
 
 //# sourceMappingURL=useApiFetchItems.js.map

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

@@ -1 +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 url, query and all: whatever built the query has already run by the time it gets here.\n   *\n   * `urlParams` are substituted into the PATH only -- `/article/:id/routes?locale=:locale` fills in\n   * `:id` and sends `:locale` as it stands. This is the helper written for hand-made queries, so it\n   * is the one place someone would reach for a placeholder in the query; put the value in the query\n   * when building it, or pass it through `options.params` and let axios serialise it.\n   */\n  urlTemplate?: string\n  urlParams?: UrlParams\n  /** Anything axios takes except what this helper decides: the method, the url, the body and the signal. */\n  options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>\n  cancelPrevious?: boolean\n  /**\n   * Default `GET`, which is what 17 of the fleet's list reads and every existing caller here use.\n   *\n   * The others are here because a list is not only ever the answer to a read: a filter too big for a\n   * url goes out as a POST, and a mutation can answer with the list it just changed -- a swap, a\n   * shift, an upsert-all. What this helper is about is the answer, not the verb.\n   */\n  method?: 'GET' | 'POST' | 'PUT' | 'PATCH'\n  /**\n   * Default `'envelope'`, because that is the fleet's norm and the exception is what gets declared.\n   *\n   * Leaving it out cannot go wrong quietly: the reader refuses the shape that was not declared, so a\n   * forgotten `'array'` fails on the first run rather than handing back something that is not a list.\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 * A list from an endpoint the caller has already written the query for, with no pagination.\n *\n * It exists because the fleet kept doing this through `useApiRequest<ApiResponseList<T[]>>`: build a\n * query by hand -- an order, a limit, a fixed filter -- bake it into the url, and read `.data` off\n * the envelope that comes back. That is a list fetch with the list part missing: nothing checks that\n * `data` is an array, so a malformed answer still hands back `undefined` typed as `T[]`, which is\n * the bug this whole family was built to end.\n *\n * `useApiFetchList` cannot serve them: it asks for a pagination ref, a `filterData` and a\n * `filterConfig`, and these calls have none -- their filters are decided at the call site and are\n * not the user's to change. So this is that helper with the pagination taken out: same core, same\n * error mapping, same list-body check, and it answers with the items rather than the envelope.\n *\n * Read is the usual case, not the only one: a filter too big for a url goes out as a POST, and a\n * mutation can answer with the list it just changed. The helper is about what comes back.\n *\n * Which shape it comes back in is declared, not guessed. `shape` picks the reader and the reader\n * refuses the other shape, the way `optionalBody` makes a caller declare a body instead of leaving\n * the helper to accept whatever turns up. A wrong declaration therefore fails loudly on the first\n * run, which is what makes having a default safe at all.\n *\n * It writes no metadata. An endpoint whose paging the user drives is `useApiFetchList`; a list read\n * page by page to the end is `useApiFetchListBatch`.\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`, at the moment there is a url to ask for; undefined until then, which is\n    // what a failure before dispatch honestly reports.\n    let url: string | undefined\n    let dispatched: AxiosRequestConfig | undefined\n\n    try {\n      const res = await abortable.run((abortSignal) => {\n        // Derived inside `run`, the way the rest of the family does it: `run` opens the generation\n        // and, with `cancelPrevious`, stops the call before this one.\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, as it always has -- a caller that means to send JSON `null` wraps it.\n        const sendsBody = !isNull(body) && !isUndefined(body)\n\n        // Because `method` defaults to GET: a caller who wrote a body and forgot `method: 'POST'`\n        // would otherwise send a GET without its filter, and nothing downstream would notice.\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 what this helper owns: a caller cannot reach in and set the method,\n        // the url, the body or the signal through it.\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, when nothing between here and the call can throw any more. It used to sit\n        // safely above the dispatch because nothing here could fail; `JSON.stringify` can -- a\n        // circular body would otherwise be reported as a request to a url nobody ever called.\n        url = requestUrl\n\n        return instance.request(config)\n      }, signal)\n\n      dispatched = res.config\n      // The url the report will name, so a message and the context beside it cannot disagree about\n      // which request failed when an interceptor rewrote it on the way out.\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, false once the last one settles.\n   *\n   * It is here so a caller does not have to keep its own: the hand-rolled version is a ref cleared in\n   * a `finally`, and that `finally` belongs to whichever call ended -- including one that\n   * `cancelPrevious` just superseded, which turns the spinner off while the call the user is waiting\n   * for is still running. This one never dips between a superseded call and the one that replaced it.\n   *\n   * Two things to know before replacing a hand-rolled flag with it.\n   *\n   * It covers what this helper does and nothing the caller does afterwards. A flag that also spans a\n   * follow-up cached fetch, a mapping pass or a second endpoint is not the same flag, and swapping it\n   * for this one turns the spinner off too early. Keep your own where it means more than \"this helper\n   * is working\".\n   *\n   * It belongs to the instance, so it is only reachable if you hold the instance. A factory that\n   * builds one per call and hands back the promise alone -- `const { execute } = useX()` inside the\n   * function that calls it -- cannot expose `loading`, `abort` or `cancelPrevious` at all. Hoist the\n   * instance to where the caller lives first.\n   */\n  loading: Ref<boolean>\n}\n"],"mappings":";;;;;;;;;;AAuFA,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;CAiFpD,OAAO;EAAE,gBA/Ec,IAAmC,CAAC,MAAoB;GAC7E,IAAM,EAAE,aAAaC,GAAqB,WAAWC,GAAmB,SAAM,cAAWC,GAIrFC,GACAC;GAEJ,IAAI;IACF,IAAMC,IAAM,MAAMP,EAAU,KAAK,MAAgB;KAG/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;KAIpD,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,GAInGI,IAA6B;MACjC,GAAGC,EAAcC,CAAO;MACxB;MACA,KAAKJ;MACL,QAAQK;KACV;KACA,AAAIX,MAAW,EAAO,OAAO,KAAK,UAAUE,CAAI;KAEhD,IAAMU,IAAWC,EAAO;KAOxB,OAFA,IAAMP,GAECM,EAAS,QAAQJ,CAAM;IAChC,GAAGM,CAAM;IAET,IAAapB,EAAI;IAGjB,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"}
+{"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

@@ -13,7 +13,6 @@ export type UseApiFetchListParams = {
     validationEntity?: string;
     urlTemplate?: string;
     urlParams?: UrlParams;
-    /** Anything axios takes except what this helper decides: the method, the url, the body and the signal. */
     options?: Omit<AxiosRequestConfig, 'method' | 'url' | 'data' | 'signal'>;
     cancelPrevious?: boolean;
 };
@@ -24,10 +23,8 @@ export type FetchListParams = {
     /** Stops this one call, leaving the instance's other calls alone. */
     signal?: AbortSignal;
     /**
-     * `false`: a failure of this one call is thrown as ever, and not handed to the api error logger.
-     *
-     * As in `useApiRequest`: for a caller that reads a list again on a timer and has reported its first failure
-     * already. It is the caller's to say which call that is, call by call; an instance has no such switch.
+     * `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;
 };
@@ -37,24 +34,11 @@ 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, false once the last one settles.
-     *
-     * It is here so a caller does not have to keep its own: the hand-rolled version is a ref cleared in
-     * a `finally`, and that `finally` belongs to whichever call ended -- including one that
-     * `cancelPrevious` just superseded, which turns the spinner off while the call the user is waiting
-     * for is still running. This one never dips between a superseded call and the one that replaced it.
-     *
-     * Two things to know before replacing a hand-rolled flag with it.
-     *
-     * It covers what this helper does and nothing the caller does afterwards. A flag that also spans a
-     * follow-up cached fetch, a mapping pass or a second endpoint is not the same flag, and swapping it
-     * for this one turns the spinner off too early. Keep your own where it means more than "this helper
-     * is working".
-     *
-     * It belongs to the instance, so it is only reachable if you hold the instance. A factory that
-     * builds one per call and hands back the promise alone -- `const { execute } = useX()` inside the
-     * function that calls it -- cannot expose `loading`, `abort` or `cancelPrevious` at all. Hoist the
-     * instance to where the caller lives first.
+     * 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

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