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

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

@@ -1,33 +1,33 @@
-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 "../../../shared/statusCodes.js";
-import { AnzuApiResponseCodeError as i } from "../../../shared/error/AnzuApiResponseCodeError.js";
-import { replaceUrlParameters as a } from "../utils/apiHelper.js";
+import { AnzuApiResponseCodeError as e } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { AnzuFatalError as t } from "../../../shared/error/AnzuFatalError.js";
+import { replaceUrlParameters as n } from "../utils/apiHelper.js";
+import { isDefined as r, isNull as i, isUndefined as a } from "../../../shared/utils/common.js";
 import { isValidHTTPStatus as o } from "../utils/response.js";
+import "../../../shared/statusCodes.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";
-//#region src/domains/api/composables/useApiRequest.ts
+// src/domains/api/composables/useApiRequest.ts
 var p = (u, p) => {
 	let { client: m, method: h, system: g, entity: _, validationSystem: v, validationEntity: y, urlTemplate: b, urlParams: x, options: S = {}, cancelPrevious: C = !1 } = u, w = l({ cancelPrevious: C });
 	return {
 		execute: async (l = {}) => {
-			let { urlTemplate: u, urlParams: C, body: T, signal: E, report: D = !0 } = l, O = e(u) ? u : b, k = e(C) ? C : x, A, j;
+			let { urlTemplate: u, urlParams: C, body: T, signal: E, report: D = !0 } = l, O = r(u) ? u : b, k = r(C) ? C : x, A, j;
 			try {
-				let s = await w.run((i) => {
-					if (n(O)) throw new r(void 0, "Url template is undefined");
-					let o = O !== "" && e(k) ? a(O, k) : O, s = {
+				let s = await w.run((e) => {
+					if (a(O)) throw new t(void 0, "Url template is undefined");
+					let o = O !== "" && r(k) ? n(O, k) : O, s = {
 						method: h,
 						url: o
 					};
-					!t(T) && !n(T) && (s.data = JSON.stringify(T));
+					!i(T) && !a(T) && (s.data = JSON.stringify(T));
 					let c = {
 						...d(S),
 						...s,
-						signal: i
+						signal: e
 					}, l = m();
 					return A = o, l.request(c);
 				}, E);
-				if (j = s.config, !o(s.status)) throw new i(s.status);
+				if (j = s.config, !o(s.status)) throw new e(s.status);
 				return p(s, () => f(m, A, S, void 0, j));
 			} catch (e) {
 				let t = {
@@ -44,19 +44,18 @@ var p = (u, p) => {
 		loading: w.loading
 	};
 };
-function m(e) {
-	let t = e.optionalBody === !0;
-	return p(e, (e, n) => {
-		if (e.status === 204) {
-			if (t) return;
-			throw new i(e.status);
+function m(t) {
+	let n = t.optionalBody === !0;
+	return p(t, (t, r) => {
+		if (t.status === 204) {
+			if (n) return;
+			throw new e(t.status);
 		}
-		if (u(e)) return e.data;
-		if (!t) throw new i(e.status, void 0, "Expected a response body, url: " + n());
+		if (u(t)) return t.data;
+		if (!n) throw new e(t.status, void 0, "Expected a response body, url: " + r());
 	});
 }
 var h = (e) => p(e, () => void 0);
-//#endregion
 export { h as useApiCommand, m as useApiRequest };
 
 //# sourceMappingURL=useApiRequest.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useApiRequest.js","names":["createRequest","params","abortable","createAbortable","templateOverride","paramsOverride","reported","executeParams","template","isDefined","urlTemplate","resolvedParams","urlParams","url","dispatched","res","isUndefined","AnzuFatalError","requestUrl","replaceUrlParameters","axiosConfig","isNull","body","config","ownedByHelper","options","abortSignal","instance","client","signal","isValidHTTPStatus","AnzuApiResponseCodeError","interpret","requestedUrl","err","context","error","mapApiError","report","useApiRequest","optionalBody","hasBody","useApiCommand"],"sources":["../../../../src/domains/api/composables/useApiRequest.ts"],"sourcesContent":["import { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { replaceUrlParameters, type UrlParams } from '@/domains/api/utils/apiHelper'\nimport { isDefined, isNull, isUndefined } from '@/shared/utils/common'\nimport { isValidHTTPStatus } from '@/domains/api/utils/response'\nimport type { AxiosRequestConfig, Method } from 'axios'\nimport { HTTP_STATUS_NO_CONTENT } from '@/shared/statusCodes'\nimport type { Ref } from 'vue'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { mapApiError, report } from '@/domains/api/utils/apiErrors'\nimport {\n  type Abortable,\n  createAbortable,\n  hasBody,\n  ownedByHelper,\n  requestedUrl,\n} from '@/domains/api/composables/request'\n\nexport type ExecuteRequestParams<B> = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  body?: B\n  /** Stops this one call, leaving the instance's other calls alone. */\n  signal?: AbortSignal\n  /**\n   * `false`: a failure of this one call is thrown as ever, and not handed to the api error logger.\n   *\n   * For a caller that repeats a request on a timer and has reported its first failure already: a poll that\n   * asks every few seconds through an outage would otherwise write the same failure down each time. It is the\n   * caller's to say which call that is, call by call; it is not a way to make a kind of request quiet, and an\n   * instance has no such switch.\n   */\n  report?: boolean\n}\n\nexport type UseApiRequestParams = {\n  client: AxiosClientFn\n  method: Method\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  /** Each call supersedes the one before it -- the autocomplete shape. */\n  cancelPrevious?: boolean\n}\n\nexport type UseApiRequestReturnType<R, B> = {\n  execute: (params?: ExecuteRequestParams<B>) => Promise<R>\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\n// The url is only ever used to say which request the message is about, and a helper that failed\n// before it had one still has to be able to say something. Handed over as a function because\n// building it costs a render and the successful reading of a response does not need it.\ntype Interpret<R> = (res: { status: number; data: unknown }, url: () => string | undefined) => R\n\nconst createRequest = <R, B>(params: UseApiRequestParams, interpret: Interpret<R>): UseApiRequestReturnType<R, B> => {\n  const {\n    client,\n    method,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    cancelPrevious = false,\n  } = params\n  const abortable: Abortable = createAbortable({ cancelPrevious })\n\n  const execute = async (executeParams: ExecuteRequestParams<B> = {}): Promise<R> => {\n    const {\n      urlTemplate: templateOverride,\n      urlParams: paramsOverride,\n      body,\n      signal,\n      report: reported = true,\n    } = executeParams\n\n    const template = isDefined(templateOverride) ? templateOverride : urlTemplate\n    const resolvedParams = isDefined(paramsOverride) ? paramsOverride : urlParams\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. An empty string is a different answer: that\n    // is a call whose url really is the client root, and it gets rendered as one.\n    let url: string | undefined\n    // The config axios used, kept for the failures this helper raises after reading the response:\n    // they are not axios errors and carry no config of their own, and rebuilding one describes the\n    // request as the client 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        // Inside `run`, and inside the try with it: `run` opens the generation and, with\n        // `cancelPrevious`, stops the call before this one, so a call that throws on its way to the\n        // wire still supersedes its predecessor instead of leaving it current. And a caller that\n        // forgot the template gets the same error class as every other failure rather than a bare\n        // `Error` nothing in the fleet is written to catch.\n        if (isUndefined(template)) throw new AnzuFatalError(undefined, 'Url template is undefined')\n        const requestUrl =\n          template !== '' && isDefined(resolvedParams) ? replaceUrlParameters(template, resolvedParams) : template\n\n        const axiosConfig: AxiosRequestConfig = { method, url: requestUrl }\n        // `null` omits the body, as it always has -- a caller that means to send JSON `null` wraps it.\n        if (!isNull(body) && !isUndefined(body)) axiosConfig.data = JSON.stringify(body)\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. The type says so too; this is for javascript\n        // callers and for anything typed loosely enough to slip past it.\n        const config = { ...ownedByHelper(options), ...axiosConfig, signal: abortSignal }\n        const instance = client()\n\n        // Recorded last, when nothing between here and the call can throw any more. A body that will\n        // not serialise, or a client factory that fails, is a request that never happened, and the\n        // report has to be able to say so rather than name a url nobody asked for.\n        url = requestUrl\n\n        return instance.request(config)\n      }, signal)\n\n      dispatched = res.config\n      if (!isValidHTTPStatus(res.status)) throw new AnzuApiResponseCodeError(res.status)\n\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      return interpret(res, () => requestedUrl(client, url, options, undefined, dispatched))\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      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\n/**\n * A request to an endpoint that always answers with a body.\n *\n * A response without one is the endpoint breaking its own contract, not an empty answer, so it fails\n * like any other error rather than handing back a value the declared type does not admit. An\n * endpoint that answers nothing is `useApiCommand`; one that may answer either is `optionalBody`.\n *\n * `R` excludes `null`, `undefined` and `void` on purpose: those are ways of saying \"no body\", and a\n * caller saying that has chosen the wrong helper. It is also what makes the migration visible --\n * every `useApiRequest<void, …>` in the fleet stops compiling and names itself.\n */\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody?: false }\n): UseApiRequestReturnType<R, B>\n/**\n * The same, for an endpoint where a body is optional and its absence is a legitimate answer. The\n * caller narrows, which is the point -- use it only where the endpoint really is documented that way.\n */\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody: true }\n): UseApiRequestReturnType<R | undefined, B>\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody?: boolean }\n): UseApiRequestReturnType<R | undefined, B> {\n  const optionalBody = params.optionalBody === true\n\n  return createRequest<R | undefined, B>(params, (res, url) => {\n    // 204 is decided by status alone, before the body is looked at: it carries none by definition,\n    // so anything that arrived with one is not something to hand on. A 202 may legitimately carry a\n    // body, which is why it is not in here and falls through to `hasBody` like any other success.\n    if (res.status === HTTP_STATUS_NO_CONTENT) {\n      if (optionalBody) return undefined\n\n      throw new AnzuApiResponseCodeError(res.status)\n    }\n\n    if (hasBody(res)) return res.data as R\n    if (optionalBody) return undefined\n\n    throw new AnzuApiResponseCodeError(res.status, undefined, 'Expected a response body, url: ' + url())\n  })\n}\n\n/**\n * A request that asks the backend to do something and reads nothing back -- a delete, or a call that\n * only starts work and answers 202. Any successful status resolves; a body, if one arrives, is\n * ignored rather than typed.\n */\nexport const useApiCommand = <B = never>(params: UseApiRequestParams): UseApiRequestReturnType<void, B> =>\n  createRequest<void, B>(params, () => undefined)\n"],"mappings":";;;;;;;;;AAkFA,IAAMA,KAAuB,GAA6B,MAA2D;CACnH,IAAM,EACJ,WACA,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,oBAAiB,OACfC,GACEC,IAAuBC,EAAgB,EAAE,kBAAe,CAAC;CA0E/D,OAAO;EAAE,gBAxEc,IAAyC,CAAC,MAAkB;GACjF,IAAM,EACJ,aAAaC,GACb,WAAWC,GACX,SACA,WACA,QAAQC,IAAW,OACjBC,GAEEC,IAAWC,EAAUL,CAAgB,IAAIA,IAAmBM,GAC5DC,IAAiBF,EAAUJ,CAAc,IAAIA,IAAiBO,GAIhEC,GAIAC;GAEJ,IAAI;IACF,IAAMC,IAAM,MAAMb,EAAU,KAAK,MAAgB;KAM/C,IAAIc,EAAYR,CAAQ,GAAG,MAAM,IAAIS,EAAe,KAAA,GAAW,2BAA2B;KAC1F,IAAMC,IACJV,MAAa,MAAMC,EAAUE,CAAc,IAAIQ,EAAqBX,GAAUG,CAAc,IAAIH,GAE5FY,IAAkC;MAAE;MAAQ,KAAKF;KAAW;KAElE,AAAI,CAACG,EAAOC,CAAI,KAAK,CAACN,EAAYM,CAAI,MAAG,EAAY,OAAO,KAAK,UAAUA,CAAI;KAK/E,IAAMC,IAAS;MAAE,GAAGC,EAAcC,CAAO;MAAG,GAAGL;MAAa,QAAQM;KAAY,GAC1EC,IAAWC,EAAO;KAOxB,OAFA,IAAMV,GAECS,EAAS,QAAQJ,CAAM;IAChC,GAAGM,CAAM;IAGT,IADA,IAAad,EAAI,QACb,CAACe,EAAkBf,EAAI,MAAM,GAAG,MAAM,IAAIgB,EAAyBhB,EAAI,MAAM;IAIjF,OAAOiB,EAAUjB,SAAWkB,EAAaL,GAAQf,GAAKY,GAAS,KAAA,GAAWX,CAAU,CAAC;GACvF,SAASoB,GAAc;IAGrB,IAAMC,IAAU;KACd;KACA;KACA;KACA;KACA,KAAKF,EAAaL,GAAQf,GAAKY,GAASS,GAAKpB,CAAU;IACzD,GAEMsB,IAAQC,EAAYH,GAAKC,CAAO;IAEtC,MAAM7B,IAAWgC,EAAOF,GAAOD,CAAO,IAAIC;GAC5C;EACF;EAEkB,OAAOlC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE;AAuBA,SAAgBqC,EACd,GAC2C;CAC3C,IAAMC,IAAevC,EAAO,iBAAiB;CAE7C,OAAOD,EAAgCC,IAAS,GAAK,MAAQ;EAI3D,IAAIc,EAAI,WAAA,KAAmC;GACzC,IAAIyB,GAAc;GAElB,MAAM,IAAIT,EAAyBhB,EAAI,MAAM;EAC/C;EAEA,IAAI0B,EAAQ1B,CAAG,GAAG,OAAOA,EAAI;EAC7B,IAAI,IAEJ,MAAM,IAAIgB,EAAyBhB,EAAI,QAAQ,KAAA,GAAW,oCAAoCF,EAAI,CAAC;CACrG,CAAC;AACH;AAOA,IAAa6B,KAA4B,MACvC1C,EAAuBC,SAAc,KAAA,CAAS"}
+{"version":3,"file":"useApiRequest.js","names":["createRequest","params","abortable","createAbortable","templateOverride","paramsOverride","reported","executeParams","template","isDefined","urlTemplate","resolvedParams","urlParams","url","dispatched","res","isUndefined","AnzuFatalError","requestUrl","replaceUrlParameters","axiosConfig","isNull","body","config","ownedByHelper","options","abortSignal","instance","client","signal","isValidHTTPStatus","AnzuApiResponseCodeError","interpret","requestedUrl","err","context","error","mapApiError","report","useApiRequest","optionalBody","hasBody","useApiCommand"],"sources":["../../../../src/domains/api/composables/useApiRequest.ts"],"sourcesContent":["import { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { replaceUrlParameters, type UrlParams } from '@/domains/api/utils/apiHelper'\nimport { isDefined, isNull, isUndefined } from '@/shared/utils/common'\nimport { isValidHTTPStatus } from '@/domains/api/utils/response'\nimport type { AxiosRequestConfig, Method } from 'axios'\nimport { HTTP_STATUS_NO_CONTENT } from '@/shared/statusCodes'\nimport type { Ref } from 'vue'\nimport type { AxiosClientFn } from '@/domains/api/utils/client'\nimport { mapApiError, report } from '@/domains/api/utils/apiErrors'\nimport {\n  type Abortable,\n  createAbortable,\n  hasBody,\n  ownedByHelper,\n  requestedUrl,\n} from '@/domains/api/composables/request'\n\nexport type ExecuteRequestParams<B> = {\n  urlTemplate?: string\n  urlParams?: UrlParams\n  body?: B\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 pollers that already reported the first failure, so an outage\n   * is not logged on every tick. It is set per call, not per instance.\n   */\n  report?: boolean\n}\n\nexport type UseApiRequestParams = {\n  client: AxiosClientFn\n  method: Method\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  /** Each call cancels the previous one, as for autocomplete. */\n  cancelPrevious?: boolean\n}\n\nexport type UseApiRequestReturnType<R, B> = {\n  execute: (params?: ExecuteRequestParams<B>) => Promise<R>\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\n// The url only identifies the request in error messages, and may be missing if the helper failed before\n// building it. It is a function because building it costs a render that successful reads do not need.\ntype Interpret<R> = (res: { status: number; data: unknown }, url: () => string | undefined) => R\n\nconst createRequest = <R, B>(params: UseApiRequestParams, interpret: Interpret<R>): UseApiRequestReturnType<R, B> => {\n  const {\n    client,\n    method,\n    system,\n    entity,\n    validationSystem,\n    validationEntity,\n    urlTemplate,\n    urlParams,\n    options = {},\n    cancelPrevious = false,\n  } = params\n  const abortable: Abortable = createAbortable({ cancelPrevious })\n\n  const execute = async (executeParams: ExecuteRequestParams<B> = {}): Promise<R> => {\n    const {\n      urlTemplate: templateOverride,\n      urlParams: paramsOverride,\n      body,\n      signal,\n      report: reported = true,\n    } = executeParams\n\n    const template = isDefined(templateOverride) ? templateOverride : urlTemplate\n    const resolvedParams = isDefined(paramsOverride) ? paramsOverride : urlParams\n    // Set in `run` once there is a url. `undefined` means the failure happened before\n    // dispatch. An empty string is a real url (the client root) and is rendered as such.\n    let url: string | undefined\n    // The config axios actually sent. Errors raised after reading the response are not axios errors and have\n    // no config. Rebuilding one would describe the request as it would be sent now, not as it was sent.\n    let dispatched: AxiosRequestConfig | undefined\n\n    try {\n      const res = await abortable.run((abortSignal) => {\n        // Throw inside `run` and its try. `run` opens the generation and, with `cancelPrevious`,\n        // stops the previous call, so a call that throws before sending still supersedes it.\n        // It also gives a missing template the same error class as other failures, not a bare `Error`.\n        if (isUndefined(template)) throw new AnzuFatalError(undefined, 'Url template is undefined')\n        const requestUrl =\n          template !== '' && isDefined(resolvedParams) ? replaceUrlParameters(template, resolvedParams) : template\n\n        const axiosConfig: AxiosRequestConfig = { method, url: requestUrl }\n        // `null` omits the body. To send JSON `null`, the caller wraps it.\n        if (!isNull(body) && !isUndefined(body)) axiosConfig.data = JSON.stringify(body)\n\n        // `options` goes first so a caller cannot override the method, url, body or signal.\n        // The type already forbids this. The spread order protects JavaScript and loosely typed callers.\n        const config = { ...ownedByHelper(options), ...axiosConfig, signal: abortSignal }\n        const instance = client()\n\n        // Set `url` last, when nothing before the call can throw.\n        // If serialising the body or the client factory fails, no request happened and the report must not name a url.\n        url = requestUrl\n\n        return instance.request(config)\n      }, signal)\n\n      dispatched = res.config\n      if (!isValidHTTPStatus(res.status)) throw new AnzuApiResponseCodeError(res.status)\n\n      // The url the report names, so the message and context agree when an interceptor rewrote the request.\n      return interpret(res, () => requestedUrl(client, url, options, undefined, dispatched))\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\n/**\n * A request to an endpoint that always answers with a body.\n * A response without a body breaks the contract and fails like any other error.\n * Use `useApiCommand` for endpoints that answer nothing, and `optionalBody` for endpoints that may answer either.\n * `R` excludes `null`, `undefined` and `void` on purpose, so `useApiRequest<void, …>` does not compile.\n */\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody?: false }\n): UseApiRequestReturnType<R, B>\n/**\n * Same as above, for an endpoint where a missing body is a legitimate answer. The caller must narrow.\n * Use it only where the endpoint is documented that way.\n */\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody: true }\n): UseApiRequestReturnType<R | undefined, B>\nexport function useApiRequest<R extends NonNullable<unknown>, B = never>(\n  params: UseApiRequestParams & { optionalBody?: boolean }\n): UseApiRequestReturnType<R | undefined, B> {\n  const optionalBody = params.optionalBody === true\n\n  return createRequest<R | undefined, B>(params, (res, url) => {\n    // 204 is decided by status alone, because it carries no body by definition.\n    // 202 may carry a body, so it falls through to `hasBody` like any other success.\n    if (res.status === HTTP_STATUS_NO_CONTENT) {\n      if (optionalBody) return undefined\n\n      throw new AnzuApiResponseCodeError(res.status)\n    }\n\n    if (hasBody(res)) return res.data as R\n    if (optionalBody) return undefined\n\n    throw new AnzuApiResponseCodeError(res.status, undefined, 'Expected a response body, url: ' + url())\n  })\n}\n\n/**\n * A request that reads nothing back, such as a delete or a call that starts work and answers 202.\n * Any successful status resolves. A body, if one arrives, is ignored.\n */\nexport const useApiCommand = <B = never>(params: UseApiRequestParams): UseApiRequestReturnType<void, B> =>\n  createRequest<void, B>(params, () => undefined)\n"],"mappings":";;;;;;;;;AAgEA,IAAMA,KAAuB,GAA6B,MAA2D;CACnH,IAAM,EACJ,WACA,WACA,WACA,WACA,qBACA,qBACA,gBACA,cACA,aAAU,CAAC,GACX,oBAAiB,OACfC,GACEC,IAAuBC,EAAgB,EAAE,kBAAe,CAAC;CAkE/D,OAAO;EAAE,gBAhEc,IAAyC,CAAC,MAAkB;GACjF,IAAM,EACJ,aAAaC,GACb,WAAWC,GACX,SACA,WACA,QAAQC,IAAW,OACjBC,GAEEC,IAAWC,EAAUL,CAAgB,IAAIA,IAAmBM,GAC5DC,IAAiBF,EAAUJ,CAAc,IAAIA,IAAiBO,GAGhEC,GAGAC;GAEJ,IAAI;IACF,IAAMC,IAAM,MAAMb,EAAU,KAAK,MAAgB;KAI/C,IAAIc,EAAYR,CAAQ,GAAG,MAAM,IAAIS,EAAe,KAAA,GAAW,2BAA2B;KAC1F,IAAMC,IACJV,MAAa,MAAMC,EAAUE,CAAc,IAAIQ,EAAqBX,GAAUG,CAAc,IAAIH,GAE5FY,IAAkC;MAAE;MAAQ,KAAKF;KAAW;KAElE,AAAI,CAACG,EAAOC,CAAI,KAAK,CAACN,EAAYM,CAAI,MAAG,EAAY,OAAO,KAAK,UAAUA,CAAI;KAI/E,IAAMC,IAAS;MAAE,GAAGC,EAAcC,CAAO;MAAG,GAAGL;MAAa,QAAQM;KAAY,GAC1EC,IAAWC,EAAO;KAMxB,OAFA,IAAMV,GAECS,EAAS,QAAQJ,CAAM;IAChC,GAAGM,CAAM;IAGT,IADA,IAAad,EAAI,QACb,CAACe,EAAkBf,EAAI,MAAM,GAAG,MAAM,IAAIgB,EAAyBhB,EAAI,MAAM;IAGjF,OAAOiB,EAAUjB,SAAWkB,EAAaL,GAAQf,GAAKY,GAAS,KAAA,GAAWX,CAAU,CAAC;GACvF,SAASoB,GAAc;IAErB,IAAMC,IAAU;KACd;KACA;KACA;KACA;KACA,KAAKF,EAAaL,GAAQf,GAAKY,GAASS,GAAKpB,CAAU;IACzD,GAEMsB,IAAQC,EAAYH,GAAKC,CAAO;IAEtC,MAAM7B,IAAWgC,EAAOF,GAAOD,CAAO,IAAIC;GAC5C;EACF;EAEkB,OAAOlC,EAAU;EAAO,SAASA,EAAU;CAAQ;AACvE;AAkBA,SAAgBqC,EACd,GAC2C;CAC3C,IAAMC,IAAevC,EAAO,iBAAiB;CAE7C,OAAOD,EAAgCC,IAAS,GAAK,MAAQ;EAG3D,IAAIc,EAAI,WAAA,KAAmC;GACzC,IAAIyB,GAAc;GAElB,MAAM,IAAIT,EAAyBhB,EAAI,MAAM;EAC/C;EAEA,IAAI0B,EAAQ1B,CAAG,GAAG,OAAOA,EAAI;EAC7B,IAAI,IAEJ,MAAM,IAAIgB,EAAyBhB,EAAI,QAAQ,KAAA,GAAW,oCAAoCF,EAAI,CAAC;CACrG,CAAC;AACH;AAMA,IAAa6B,KAA4B,MACvC1C,EAAuBC,SAAc,KAAA,CAAS"}

package/dist/domains/api/types/SortOrder.js

@@ -1,9 +1,8 @@
-//#region src/domains/api/types/SortOrder.ts
+// src/domains/api/types/SortOrder.ts
 var e = {
 	Asc: "asc",
 	Desc: "desc"
 };
-//#endregion
 export { e as SortOrder };
 
 //# sourceMappingURL=SortOrder.js.map

package/dist/domains/api/utils/apiErrors.d.ts

@@ -2,87 +2,60 @@ import { AnzuError } from '../../../shared/error/AnzuError';
 export type ApiErrorContext = {
     system: string;
     entity: string;
-    /** The url actually requested, parameters substituted and query included -- not the template. */
+    /** The url actually requested, with parameters substituted and query included. Not the template. */
     url?: string;
     /**
-     * The status the backend answered with, when it answered at all. Absent for a transport failure,
-     * where there is no response.
-     *
-     * It is here so an application can decide what is worth writing down without the call sites having
-     * to: a 404 that a caller probes for, for instance. Those used to be silenced per call, which made
-     * whether a failure was recorded depend on which call made it. The switch is the application's now,
-     * and this is what it needs to use it.
-     *
-     * Two statuses are not the application's to decide, and the library keeps them: 401 and 403. They
-     * are not an endpoint failing its contract, they are the session -- nobody is logged in, or this
-     * user may not -- and every admin in the fleet already branches on them and acts. Everything else
-     * reaches the logger and is filtered here, on this field.
+     * The status the backend answered with. Absent for a transport failure.
+     * The application's logger uses it to decide what to record, for example a 404 that a caller probes for.
+     * The library itself handles 401 and 403, because they concern the
+     * session and not the endpoint. Every other status reaches the logger.
      */
     status?: number;
     /**
-     * The i18n scope a field-level validation failure is reported under, when it is not the same as
-     * the backend above.
-     *
-     * `AnzuApiValidationError` turns the server's field names into `<system>.<entity>.model.<field>`
-     * translation keys. For a component shared by nine backends those two are different questions:
-     * *which* backend failed -- which is what the report needs -- and *whose labels* name its fields,
-     * which for a shared form is always the library's own `common.*`. Left unset, the two stay one
-     * value, exactly as before.
+     * The i18n scope for field-level validation errors, when it differs from the backend above.
+     * `AnzuApiValidationError` builds `<system>.<entity>.model.<field>` translation keys. A component
+     * shared by several backends reports which backend failed but uses the library's `common.*` labels.
+     * If unset, the backend value is used.
      */
     validationSystem?: string;
     validationEntity?: string;
 };
 export type ApiErrorLogger = (error: Error, context: ApiErrorContext) => void;
 /**
- * What the user probe calls itself in the error context.
- *
- * A 404 here is an answer, not a failure -- it is how a system says "no account of yours". The
- * default logger skips it; an app's own logger still receives it, so it filters on this together
- * with the status rather than on the url, which would also silence a real detail read of the same
- * path. The validation scope stays the user's, so a field error would still name a real label.
- * Defined here, not beside the probe, so the default logger can know it without an import cycle.
+ * Entity name of the user probe in the error context.
+ * A 404 from the probe means the user has no account, so the default logger skips it. App loggers
+ * should filter on this and the status, not the url, which would also silence a real detail read.
+ * The validation scope stays the user's, so field errors still resolve real labels.
+ * Defined here to avoid an import cycle with the default logger.
  */
 export declare const USER_PROBE_ENTITY = "anzuUserProbe";
-/** What reporting does until an application says otherwise; exported so a test can put it back. */
+/** Default error reporting. Exported so tests can restore it. */
 export declare const defaultApiErrorLogger: ApiErrorLogger;
 /**
- * Replaces the logger the api helpers report unexpected failures through, or turns reporting off
- * with `null`.
- *
- * It is one switch for the whole family rather than a flag on each instance, which is what it
- * replaces: whether a failure was written down used to depend on which helper made the call and how
- * that instance happened to be constructed.
- *
- * An application that wants these where it can see them passes its own:
- * `setApiErrorLogger((e, ctx) => Sentry.captureException(e, { extra: ctx }))`.
+ * Replaces the logger the api helpers report unexpected failures through. `null` turns reporting off.
+ * One global switch for all helpers, so reporting does not depend on which helper made the call.
+ * @example setApiErrorLogger((e, ctx) => Sentry.captureException(e, { extra: ctx }))
  */
 export declare const setApiErrorLogger: (fn: ApiErrorLogger | null) => void;
 /**
- * The HTTP status the backend answered with, read off whichever class carries it: the axios response
- * of an `AnzuApiAxiosError`, or the `code` of an `AnzuApiResponseCodeError` (a response axios let
- * through). `undefined` when nothing answered -- a timeout, a network failure, a cancel.
+ * HTTP status from the axios response of `AnzuApiAxiosError` or the `code` of `AnzuApiResponseCodeError`.
+ * `undefined` when nothing answered: timeout, network failure, cancel.
  */
 export declare const apiErrorStatus: (error: unknown) => number | undefined;
 /**
- * Whether `report` hands this error, once mapped, to the logger: not a timeout, a 401 or a 403, nor
- * anything while reporting is off. For a caller that reports only the first failure of a series: a
- * failure dropped here has told nobody, and the series begins with the first one that was written.
- * What the application's own logger does with it is the application's.
+ * Whether `report` passes this error to the logger. False for a timeout, 401, 403, or while reporting is off.
+ * Lets a caller that reports only the first failure of a series start the series at the first logged one.
  */
 export declare const apiErrorIsReported: (error: unknown) => boolean;
 /**
- * Reports an error once, after it has been mapped, and hands it back so the caller can throw it.
- *
- * After, not during: an error the helper raised itself -- a body that never arrived, a status it
- * refuses -- is already an `Anzu*` class by the time it reaches the mapping, so a logger placed
- * inside the mapping would never see the two cases it exists for.
+ * Reports a mapped error once and returns it so the caller can throw it.
+ * Runs after mapping because errors the helper raises itself are
+ * already `Anzu*` classes and would bypass a logger inside the mapping.
  */
 export declare const report: <E>(error: E, context: ApiErrorContext) => E;
 /**
- * Turns whatever axios rejected with into one of the Anzu error classes.
- *
- * There used to be a copy of this inside each helper. The order of the checks is what decides which
- * class a failure becomes, so four copies were four chances for the same failure to arrive under
- * different names depending on which helper made the call.
+ * Turns whatever axios rejected with into an Anzu error class.
+ * Shared by all helpers. The order of checks decides the class,
+ * so separate copies would map the same failure differently.
  */
 export declare const mapApiError: (err: unknown, context: ApiErrorContext) => AnzuError;

package/dist/domains/api/utils/apiErrors.js

@@ -1,29 +1,29 @@
-import { isAnzuError as e } from "../../../shared/error/AnzuError.js";
-import { AnzuFatalError as t } from "../../../shared/error/AnzuFatalError.js";
-import "../../../shared/statusCodes.js";
-import { AnzuApiForbiddenError as n, axiosErrorResponseIsForbidden as r } from "../../../shared/error/AnzuApiForbiddenError.js";
-import { AnzuApiValidationError as i, axiosErrorResponseHasValidationData as a } from "../../../shared/error/AnzuApiValidationError.js";
-import { AnzuApiResponseCodeError as o } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { AnzuApiAxiosError as e } from "../../../shared/error/AnzuApiAxiosError.js";
+import { AnzuApiCancelledError as t, axiosErrorIsCancelled as n } from "../../../shared/error/AnzuApiCancelledError.js";
+import { AnzuApiDependencyExistsError as r, axiosErrorResponseHasDependencyExistsData as i } from "../../../shared/error/AnzuApiDependencyExistsError.js";
+import { AnzuApiForbiddenError as a, axiosErrorResponseIsForbidden as o } from "../../../shared/error/AnzuApiForbiddenError.js";
 import { AnzuApiForbiddenOperationError as s, axiosErrorResponseHasForbiddenOperationData as c } from "../../../shared/error/AnzuApiForbiddenOperationError.js";
-import { AnzuApiDependencyExistsError as l, axiosErrorResponseHasDependencyExistsData as u } from "../../../shared/error/AnzuApiDependencyExistsError.js";
-import { AnzuApiTimeoutError as d, axiosErrorIsTimeout as f } from "../../../shared/error/AnzuApiTimeoutError.js";
-import { AnzuApiAxiosError as p } from "../../../shared/error/AnzuApiAxiosError.js";
-import { AnzuApiCancelledError as m, axiosErrorIsCancelled as h } from "../../../shared/error/AnzuApiCancelledError.js";
+import { AnzuApiResponseCodeError as l } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { AnzuApiTimeoutError as u, axiosErrorIsTimeout as d } from "../../../shared/error/AnzuApiTimeoutError.js";
+import { AnzuApiValidationError as f, axiosErrorResponseHasValidationData as p } from "../../../shared/error/AnzuApiValidationError.js";
+import { isAnzuError as m } from "../../../shared/error/AnzuError.js";
+import { AnzuFatalError as h } from "../../../shared/error/AnzuFatalError.js";
+import "../../../shared/statusCodes.js";
 import { SessionExpiredError as g } from "../../../shared/error/SessionExpiredError.js";
 import { isInCauseChain as _ } from "../../../shared/error/isInCauseChain.js";
 import v from "axios";
-//#region src/domains/api/utils/apiErrors.ts
+// src/domains/api/utils/apiErrors.ts
 var y = "anzuUserProbe", b = (e, t) => {
 	(t.status !== 404 || t.entity !== "anzuUserProbe") && console.error("Api error: " + (t.url ?? ""), e);
 }, x = b, S = (e) => {
 	x = e;
 }, C = [
-	p,
-	t,
-	o
-], w = (e) => {
-	if (e instanceof o) return e.code;
-	if (e instanceof p) return e.cause.response?.status;
+	e,
+	h,
+	l
+], w = (t) => {
+	if (t instanceof l) return t.code;
+	if (t instanceof e) return t.cause.response?.status;
 }, T = (e) => {
 	let t = w(e);
 	return t === 401 || t === 403 || _(e, (e) => e instanceof g) ? !1 : x !== null && C.some((t) => e instanceof t);
@@ -35,11 +35,10 @@ var y = "anzuUserProbe", b = (e, t) => {
 		});
 	} catch {}
 	return e;
-}, D = (o, g) => {
-	let { system: _, entity: y } = g, b = g.validationSystem ?? _, x = g.validationEntity ?? y, S = o, C = o;
-	return e(o) ? o : h(o) ? new m(S) : r(C) ? new n(C, g.url) : a(C) ? new i(C, b, x, S) : u(C) ? new l(C, b, x, S) : c(C) ? new s(C, S) : f(S) ? new d(S) : v.isAxiosError(o) ? new p(C) : new t(S);
+}, D = (l, g) => {
+	let { system: _, entity: y } = g, b = g.validationSystem ?? _, x = g.validationEntity ?? y, S = l, C = l;
+	return m(l) ? l : n(l) ? new t(S) : o(C) ? new a(C, g.url) : p(C) ? new f(C, b, x, S) : i(C) ? new r(C, b, x, S) : c(C) ? new s(C, S) : d(S) ? new u(S) : v.isAxiosError(l) ? new e(C) : new h(S);
 };
-//#endregion
 export { y as USER_PROBE_ENTITY, T as apiErrorIsReported, w as apiErrorStatus, b as defaultApiErrorLogger, D as mapApiError, E as report, S as setApiErrorLogger };
 
 //# sourceMappingURL=apiErrors.js.map

package/dist/domains/api/utils/apiErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"apiErrors.js","names":["axios","USER_PROBE_ENTITY","defaultApiErrorLogger","context","error","logger","setApiErrorLogger","fn","LOGGED","AnzuApiAxiosError","AnzuFatalError","AnzuApiResponseCodeError","apiErrorStatus","apiErrorIsReported","status","isInCauseChain","cause","SessionExpiredError","cls","report","mapApiError","labelSystem","system","labelEntity","entity","err","axiosError","isAnzuError","axiosErrorIsCancelled","AnzuApiCancelledError","axiosErrorResponseIsForbidden","AnzuApiForbiddenError","axiosErrorResponseHasValidationData","AnzuApiValidationError","axiosErrorResponseHasDependencyExistsData","AnzuApiDependencyExistsError","axiosErrorResponseHasForbiddenOperationData","AnzuApiForbiddenOperationError","axiosErrorIsTimeout","AnzuApiTimeoutError"],"sources":["../../../../src/domains/api/utils/apiErrors.ts"],"sourcesContent":["import axios, { type AxiosError } from 'axios'\nimport { AnzuApiAxiosError } from '@/shared/error/AnzuApiAxiosError'\nimport { AnzuApiCancelledError, axiosErrorIsCancelled } from '@/shared/error/AnzuApiCancelledError'\nimport {\n  AnzuApiDependencyExistsError,\n  axiosErrorResponseHasDependencyExistsData,\n} from '@/shared/error/AnzuApiDependencyExistsError'\nimport { AnzuApiForbiddenError, axiosErrorResponseIsForbidden } from '@/shared/error/AnzuApiForbiddenError'\nimport {\n  AnzuApiForbiddenOperationError,\n  axiosErrorResponseHasForbiddenOperationData,\n} from '@/shared/error/AnzuApiForbiddenOperationError'\nimport { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { AnzuApiTimeoutError, axiosErrorIsTimeout } from '@/shared/error/AnzuApiTimeoutError'\nimport { AnzuApiValidationError, axiosErrorResponseHasValidationData } from '@/shared/error/AnzuApiValidationError'\nimport { AnzuError, isAnzuError } from '@/shared/error/AnzuError'\nimport { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { HTTP_STATUS_FORBIDDEN, HTTP_STATUS_UNAUTHORIZED } from '@/shared/statusCodes'\nimport { SessionExpiredError } from '@/shared/error/SessionExpiredError'\nimport { isInCauseChain } from '@/shared/error/isInCauseChain'\n\nexport type ApiErrorContext = {\n  system: string\n  entity: string\n  /** The url actually requested, parameters substituted and query included -- not the template. */\n  url?: string\n  /**\n   * The status the backend answered with, when it answered at all. Absent for a transport failure,\n   * where there is no response.\n   *\n   * It is here so an application can decide what is worth writing down without the call sites having\n   * to: a 404 that a caller probes for, for instance. Those used to be silenced per call, which made\n   * whether a failure was recorded depend on which call made it. The switch is the application's now,\n   * and this is what it needs to use it.\n   *\n   * Two statuses are not the application's to decide, and the library keeps them: 401 and 403. They\n   * are not an endpoint failing its contract, they are the session -- nobody is logged in, or this\n   * user may not -- and every admin in the fleet already branches on them and acts. Everything else\n   * reaches the logger and is filtered here, on this field.\n   */\n  status?: number\n  /**\n   * The i18n scope a field-level validation failure is reported under, when it is not the same as\n   * the backend above.\n   *\n   * `AnzuApiValidationError` turns the server's field names into `<system>.<entity>.model.<field>`\n   * translation keys. For a component shared by nine backends those two are different questions:\n   * *which* backend failed -- which is what the report needs -- and *whose labels* name its fields,\n   * which for a shared form is always the library's own `common.*`. Left unset, the two stay one\n   * value, exactly as before.\n   */\n  validationSystem?: string\n  validationEntity?: string\n}\n\nexport type ApiErrorLogger = (error: Error, context: ApiErrorContext) => void\n\n/**\n * What the user probe calls itself in the error context.\n *\n * A 404 here is an answer, not a failure -- it is how a system says \"no account of yours\". The\n * default logger skips it; an app's own logger still receives it, so it filters on this together\n * with the status rather than on the url, which would also silence a real detail read of the same\n * path. The validation scope stays the user's, so a field error would still name a real label.\n * Defined here, not beside the probe, so the default logger can know it without an import cycle.\n */\nexport const USER_PROBE_ENTITY = 'anzuUserProbe'\n\n/** What reporting does until an application says otherwise; exported so a test can put it back. */\nexport const defaultApiErrorLogger: ApiErrorLogger = (error, context) => {\n  if (context.status === 404 && context.entity === USER_PROBE_ENTITY) return\n  console.error('Api error: ' + (context.url ?? ''), error)\n}\n\nlet logger: ApiErrorLogger | null = defaultApiErrorLogger\n\n/**\n * Replaces the logger the api helpers report unexpected failures through, or turns reporting off\n * with `null`.\n *\n * It is one switch for the whole family rather than a flag on each instance, which is what it\n * replaces: whether a failure was written down used to depend on which helper made the call and how\n * that instance happened to be constructed.\n *\n * An application that wants these where it can see them passes its own:\n * `setApiErrorLogger((e, ctx) => Sentry.captureException(e, { extra: ctx }))`.\n */\nexport const setApiErrorLogger = (fn: ApiErrorLogger | null): void => {\n  logger = fn\n}\n\n// Only the failures nobody planned for. A validation or forbidden answer is the backend saying\n// something the caller asked about and will show; writing those down as well would be noise that\n// teaches people to ignore the log.\nconst LOGGED = [AnzuApiAxiosError, AnzuFatalError, AnzuApiResponseCodeError]\n\n/**\n * The HTTP status the backend answered with, read off whichever class carries it: the axios response\n * of an `AnzuApiAxiosError`, or the `code` of an `AnzuApiResponseCodeError` (a response axios let\n * through). `undefined` when nothing answered -- a timeout, a network failure, a cancel.\n */\nexport const apiErrorStatus = (error: unknown): number | undefined => {\n  if (error instanceof AnzuApiResponseCodeError) return error.code\n  if (error instanceof AnzuApiAxiosError) return error.cause.response?.status\n\n  return undefined\n}\n\n/**\n * Whether `report` hands this error, once mapped, to the logger: not a timeout, a 401 or a 403, nor\n * anything while reporting is off. For a caller that reports only the first failure of a series: a\n * failure dropped here has told nobody, and the series begins with the first one that was written.\n * What the application's own logger does with it is the application's.\n */\nexport const apiErrorIsReported = (error: unknown): boolean => {\n  const status = apiErrorStatus(error)\n  // Neither of these is an unplanned failure. A 401 is \"nobody is logged in\", which every admin\n  // branches on before sending the user to the login page -- writing it down would mean an \"Api\n  // error\" for every unauthenticated start of the app. A 403 is \"this user may not\", which the\n  // caller shows. Both are the session rather than an endpoint breaking its contract.\n  //\n  // By status rather than by class, because the class only keeps it quiet on one of the two paths: a\n  // rejected 403 becomes `AnzuApiForbiddenError`, which is outside `LOGGED`, while one that arrives\n  // fulfilled -- as `options.validateStatus` allows -- becomes an `AnzuApiResponseCodeError`, which\n  // is inside it. Left to the class, the policy would hold or not depending on how the caller\n  // configured axios.\n  //\n  // It is the one thing the `status` field above does not leave to the application, and deliberately:\n  // an app that wanted its own unauthenticated starts in the log would be asking for noise it cannot\n  // act on, while an app that wants 404 or 409 filtered has the field to do it with.\n  if (status === HTTP_STATUS_UNAUTHORIZED || status === HTTP_STATUS_FORBIDDEN) return false\n  // The same as a 401, stopped before it went out: the refresh found the session gone.\n  if (isInCauseChain(error, (cause) => cause instanceof SessionExpiredError)) return false\n\n  return logger !== null && LOGGED.some((cls) => error instanceof cls)\n}\n\n/**\n * Reports an error once, after it has been mapped, and hands it back so the caller can throw it.\n *\n * After, not during: an error the helper raised itself -- a body that never arrived, a status it\n * refuses -- is already an `Anzu*` class by the time it reaches the mapping, so a logger placed\n * inside the mapping would never see the two cases it exists for.\n */\nexport const report = <E>(error: E, context: ApiErrorContext): E => {\n  if (logger !== null && apiErrorIsReported(error)) {\n    try {\n      // Filled in here rather than by the caller: the status belongs to the failure, and only the\n      // mapped error knows it -- the helper that built the context has not looked at the error yet.\n      logger(error as unknown as Error, { ...context, status: apiErrorStatus(error) })\n    } catch {\n      // A logger that throws must not replace the failure the caller is waiting for.\n    }\n  }\n\n  return error\n}\n\n/**\n * Turns whatever axios rejected with into one of the Anzu error classes.\n *\n * There used to be a copy of this inside each helper. The order of the checks is what decides which\n * class a failure becomes, so four copies were four chances for the same failure to arrive under\n * different names depending on which helper made the call.\n */\nexport const mapApiError = (err: unknown, context: ApiErrorContext): AnzuError => {\n  const { system, entity } = context\n  const labelSystem = context.validationSystem ?? system\n  const labelEntity = context.validationEntity ?? entity\n  // The predicates below are typed against `Error` / `AxiosError` and each begins by checking what\n  // it was handed, so narrowing here only satisfies their signatures.\n  const error = err as Error\n  const axiosError = err as AxiosError\n\n  // Already mapped -- including the errors a helper raised about its own contract. Wrapping it again\n  // would bury the class the caller branches on.\n  if (isAnzuError(err)) return err\n\n  // Before everything else, because it is not a failure: the caller stopped this request.\n  if (axiosErrorIsCancelled(err)) return new AnzuApiCancelledError(error)\n\n  // The rendered url, not `config.url`: that one is relative, carries no params, and would become\n  // this error's `message` -- the only url in the family that never went through `requestedUrl`.\n  if (axiosErrorResponseIsForbidden(axiosError)) return new AnzuApiForbiddenError(axiosError, context.url)\n\n  if (axiosErrorResponseHasValidationData(axiosError)) {\n    return new AnzuApiValidationError(axiosError, labelSystem, labelEntity, error)\n  }\n\n  if (axiosErrorResponseHasDependencyExistsData(axiosError)) {\n    return new AnzuApiDependencyExistsError(axiosError, labelSystem, labelEntity, error)\n  }\n\n  if (axiosErrorResponseHasForbiddenOperationData(axiosError)) {\n    return new AnzuApiForbiddenOperationError(axiosError, error)\n  }\n\n  if (axiosErrorIsTimeout(error)) return new AnzuApiTimeoutError(error)\n\n  if (axios.isAxiosError(err)) return new AnzuApiAxiosError(axiosError)\n\n  return new AnzuFatalError(error)\n}\n"],"mappings":";;;;;;;;;;;;;;;AAkEA,IAAaC,IAAoB,iBAGpBC,KAAyC,GAAO,MAAY;CACvE,CAAIC,EAAQ,WAAW,OAAOA,EAAQ,WAAA,oBACtC,QAAQ,MAAM,iBAAiBA,EAAQ,OAAO,KAAKC,CAAK;AAC1D,GAEIC,IAAgCH,GAavBI,KAAqB,MAAoC;CACpE,IAASC;AACX,GAKMC,IAAS;CAACC;CAAmBC;CAAgBC;AAAwB,GAO9DC,KAAkB,MAAuC;CACpE,IAAIR,aAAiBO,GAA0B,OAAOP,EAAM;CAC5D,IAAIA,aAAiBK,GAAmB,OAAOL,EAAM,MAAM,UAAU;AAGvE,GAQaS,KAAsB,MAA4B;CAC7D,IAAMC,IAASF,EAAeR,CAAK;CAmBnC,OAJIU,MAAA,OAAuCA,MAAA,OAEvCC,EAAeX,IAAQ,MAAUY,aAAiBC,CAAmB,IAAU,KAE5EZ,MAAW,QAAQG,EAAO,MAAM,MAAQJ,aAAiBc,CAAG;AACrE,GASaC,KAAa,GAAU,MAAgC;CAClE,IAAId,MAAW,QAAQQ,EAAmBT,CAAK,GAC7C,IAAI;EAGF,EAAOA,GAA2B;GAAE,GAAGD;GAAS,QAAQS,EAAeR,CAAK;EAAE,CAAC;CACjF,QAAQ,CAER;CAGF,OAAOA;AACT,GASagB,KAAe,GAAc,MAAwC;CAChF,IAAM,EAAE,WAAQ,cAAWjB,GACrBkB,IAAclB,EAAQ,oBAAoBmB,GAC1CC,IAAcpB,EAAQ,oBAAoBqB,GAG1CpB,IAAQqB,GACRC,IAAaD;CA6BnB,OAzBIE,EAAYF,CAAG,IAAUA,IAGzBG,EAAsBH,CAAG,IAAU,IAAII,EAAsBzB,CAAK,IAIlE0B,EAA8BJ,CAAU,IAAU,IAAIK,EAAsBL,GAAYvB,EAAQ,GAAG,IAEnG6B,EAAoCN,CAAU,IACzC,IAAIO,EAAuBP,GAAYL,GAAaE,GAAanB,CAAK,IAG3E8B,EAA0CR,CAAU,IAC/C,IAAIS,EAA6BT,GAAYL,GAAaE,GAAanB,CAAK,IAGjFgC,EAA4CV,CAAU,IACjD,IAAIW,EAA+BX,GAAYtB,CAAK,IAGzDkC,EAAoBlC,CAAK,IAAU,IAAImC,EAAoBnC,CAAK,IAEhEJ,EAAM,aAAayB,CAAG,IAAU,IAAIhB,EAAkBiB,CAAU,IAE7D,IAAIhB,EAAeN,CAAK;AACjC"}
+{"version":3,"file":"apiErrors.js","names":["axios","USER_PROBE_ENTITY","defaultApiErrorLogger","context","error","logger","setApiErrorLogger","fn","LOGGED","AnzuApiAxiosError","AnzuFatalError","AnzuApiResponseCodeError","apiErrorStatus","apiErrorIsReported","status","isInCauseChain","cause","SessionExpiredError","cls","report","mapApiError","labelSystem","system","labelEntity","entity","err","axiosError","isAnzuError","axiosErrorIsCancelled","AnzuApiCancelledError","axiosErrorResponseIsForbidden","AnzuApiForbiddenError","axiosErrorResponseHasValidationData","AnzuApiValidationError","axiosErrorResponseHasDependencyExistsData","AnzuApiDependencyExistsError","axiosErrorResponseHasForbiddenOperationData","AnzuApiForbiddenOperationError","axiosErrorIsTimeout","AnzuApiTimeoutError"],"sources":["../../../../src/domains/api/utils/apiErrors.ts"],"sourcesContent":["import axios, { type AxiosError } from 'axios'\nimport { AnzuApiAxiosError } from '@/shared/error/AnzuApiAxiosError'\nimport { AnzuApiCancelledError, axiosErrorIsCancelled } from '@/shared/error/AnzuApiCancelledError'\nimport {\n  AnzuApiDependencyExistsError,\n  axiosErrorResponseHasDependencyExistsData,\n} from '@/shared/error/AnzuApiDependencyExistsError'\nimport { AnzuApiForbiddenError, axiosErrorResponseIsForbidden } from '@/shared/error/AnzuApiForbiddenError'\nimport {\n  AnzuApiForbiddenOperationError,\n  axiosErrorResponseHasForbiddenOperationData,\n} from '@/shared/error/AnzuApiForbiddenOperationError'\nimport { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { AnzuApiTimeoutError, axiosErrorIsTimeout } from '@/shared/error/AnzuApiTimeoutError'\nimport { AnzuApiValidationError, axiosErrorResponseHasValidationData } from '@/shared/error/AnzuApiValidationError'\nimport { AnzuError, isAnzuError } from '@/shared/error/AnzuError'\nimport { AnzuFatalError } from '@/shared/error/AnzuFatalError'\nimport { HTTP_STATUS_FORBIDDEN, HTTP_STATUS_UNAUTHORIZED } from '@/shared/statusCodes'\nimport { SessionExpiredError } from '@/shared/error/SessionExpiredError'\nimport { isInCauseChain } from '@/shared/error/isInCauseChain'\n\nexport type ApiErrorContext = {\n  system: string\n  entity: string\n  /** The url actually requested, with parameters substituted and query included. Not the template. */\n  url?: string\n  /**\n   * The status the backend answered with. Absent for a transport failure.\n   * The application's logger uses it to decide what to record, for example a 404 that a caller probes for.\n   * The library itself handles 401 and 403, because they concern the\n   * session and not the endpoint. Every other status reaches the logger.\n   */\n  status?: number\n  /**\n   * The i18n scope for field-level validation errors, when it differs from the backend above.\n   * `AnzuApiValidationError` builds `<system>.<entity>.model.<field>` translation keys. A component\n   * shared by several backends reports which backend failed but uses the library's `common.*` labels.\n   * If unset, the backend value is used.\n   */\n  validationSystem?: string\n  validationEntity?: string\n}\n\nexport type ApiErrorLogger = (error: Error, context: ApiErrorContext) => void\n\n/**\n * Entity name of the user probe in the error context.\n * A 404 from the probe means the user has no account, so the default logger skips it. App loggers\n * should filter on this and the status, not the url, which would also silence a real detail read.\n * The validation scope stays the user's, so field errors still resolve real labels.\n * Defined here to avoid an import cycle with the default logger.\n */\nexport const USER_PROBE_ENTITY = 'anzuUserProbe'\n\n/** Default error reporting. Exported so tests can restore it. */\nexport const defaultApiErrorLogger: ApiErrorLogger = (error, context) => {\n  if (context.status === 404 && context.entity === USER_PROBE_ENTITY) return\n  console.error('Api error: ' + (context.url ?? ''), error)\n}\n\nlet logger: ApiErrorLogger | null = defaultApiErrorLogger\n\n/**\n * Replaces the logger the api helpers report unexpected failures through. `null` turns reporting off.\n * One global switch for all helpers, so reporting does not depend on which helper made the call.\n * @example setApiErrorLogger((e, ctx) => Sentry.captureException(e, { extra: ctx }))\n */\nexport const setApiErrorLogger = (fn: ApiErrorLogger | null): void => {\n  logger = fn\n}\n\n// Only unplanned failures. Validation and forbidden errors are shown to the user by the caller.\n// Logging them too would be noise.\nconst LOGGED = [AnzuApiAxiosError, AnzuFatalError, AnzuApiResponseCodeError]\n\n/**\n * HTTP status from the axios response of `AnzuApiAxiosError` or the `code` of `AnzuApiResponseCodeError`.\n * `undefined` when nothing answered: timeout, network failure, cancel.\n */\nexport const apiErrorStatus = (error: unknown): number | undefined => {\n  if (error instanceof AnzuApiResponseCodeError) return error.code\n  if (error instanceof AnzuApiAxiosError) return error.cause.response?.status\n\n  return undefined\n}\n\n/**\n * Whether `report` passes this error to the logger. False for a timeout, 401, 403, or while reporting is off.\n * Lets a caller that reports only the first failure of a series start the series at the first logged one.\n */\nexport const apiErrorIsReported = (error: unknown): boolean => {\n  const status = apiErrorStatus(error)\n  // 401 and 403 are session states, not endpoint failures. Every\n  // admin checks for 401 on startup, so logging it adds noise.\n  // Checked by status, not by class. A rejected 403 becomes `AnzuApiForbiddenError` (not in `LOGGED`).\n  // A fulfilled 403 allowed by `options.validateStatus` becomes `AnzuApiResponseCodeError` (in `LOGGED`).\n  // This is not configurable on purpose. Apps can filter other statuses like 404 or 409 via the `status` field.\n  if (status === HTTP_STATUS_UNAUTHORIZED || status === HTTP_STATUS_FORBIDDEN) return false\n  // Same as a 401, caught before the request: the refresh found the session gone.\n  if (isInCauseChain(error, (cause) => cause instanceof SessionExpiredError)) return false\n\n  return logger !== null && LOGGED.some((cls) => error instanceof cls)\n}\n\n/**\n * Reports a mapped error once and returns it so the caller can throw it.\n * Runs after mapping because errors the helper raises itself are\n * already `Anzu*` classes and would bypass a logger inside the mapping.\n */\nexport const report = <E>(error: E, context: ApiErrorContext): E => {\n  if (logger !== null && apiErrorIsReported(error)) {\n    try {\n      // Status is added here because only the mapped error knows it.\n      // The caller built the context before looking at the error.\n      logger(error as unknown as Error, { ...context, status: apiErrorStatus(error) })\n    } catch {\n      // A logger that throws must not replace the failure the caller is waiting for.\n    }\n  }\n\n  return error\n}\n\n/**\n * Turns whatever axios rejected with into an Anzu error class.\n * Shared by all helpers. The order of checks decides the class,\n * so separate copies would map the same failure differently.\n */\nexport const mapApiError = (err: unknown, context: ApiErrorContext): AnzuError => {\n  const { system, entity } = context\n  const labelSystem = context.validationSystem ?? system\n  const labelEntity = context.validationEntity ?? entity\n  // Casts only satisfy the predicate signatures. Each predicate checks its input itself.\n  const error = err as Error\n  const axiosError = err as AxiosError\n\n  // Already mapped, including contract errors raised by a helper.\n  // Wrapping again would hide the class the caller branches on.\n  if (isAnzuError(err)) return err\n\n  // Checked first because a cancelled request is not a failure. The caller stopped it.\n  if (axiosErrorIsCancelled(err)) return new AnzuApiCancelledError(error)\n\n  // Use the rendered url, not `config.url`. `config.url` is relative and has no params.\n  // It would become this error's `message`, unlike every other error that uses `requestedUrl`.\n  if (axiosErrorResponseIsForbidden(axiosError)) return new AnzuApiForbiddenError(axiosError, context.url)\n\n  if (axiosErrorResponseHasValidationData(axiosError)) {\n    return new AnzuApiValidationError(axiosError, labelSystem, labelEntity, error)\n  }\n\n  if (axiosErrorResponseHasDependencyExistsData(axiosError)) {\n    return new AnzuApiDependencyExistsError(axiosError, labelSystem, labelEntity, error)\n  }\n\n  if (axiosErrorResponseHasForbiddenOperationData(axiosError)) {\n    return new AnzuApiForbiddenOperationError(axiosError, error)\n  }\n\n  if (axiosErrorIsTimeout(error)) return new AnzuApiTimeoutError(error)\n\n  if (axios.isAxiosError(err)) return new AnzuApiAxiosError(axiosError)\n\n  return new AnzuFatalError(error)\n}\n"],"mappings":";;;;;;;;;;;;;;;AAoDA,IAAaC,IAAoB,iBAGpBC,KAAyC,GAAO,MAAY;CACvE,CAAIC,EAAQ,WAAW,OAAOA,EAAQ,WAAA,oBACtC,QAAQ,MAAM,iBAAiBA,EAAQ,OAAO,KAAKC,CAAK;AAC1D,GAEIC,IAAgCH,GAOvBI,KAAqB,MAAoC;CACpE,IAASC;AACX,GAIMC,IAAS;CAACC;CAAmBC;CAAgBC;AAAwB,GAM9DC,KAAkB,MAAuC;CACpE,IAAIR,aAAiBO,GAA0B,OAAOP,EAAM;CAC5D,IAAIA,aAAiBK,GAAmB,OAAOL,EAAM,MAAM,UAAU;AAGvE,GAMaS,KAAsB,MAA4B;CAC7D,IAAMC,IAASF,EAAeR,CAAK;CAUnC,OAJIU,MAAA,OAAuCA,MAAA,OAEvCC,EAAeX,IAAQ,MAAUY,aAAiBC,CAAmB,IAAU,KAE5EZ,MAAW,QAAQG,EAAO,MAAM,MAAQJ,aAAiBc,CAAG;AACrE,GAOaC,KAAa,GAAU,MAAgC;CAClE,IAAId,MAAW,QAAQQ,EAAmBT,CAAK,GAC7C,IAAI;EAGF,EAAOA,GAA2B;GAAE,GAAGD;GAAS,QAAQS,EAAeR,CAAK;EAAE,CAAC;CACjF,QAAQ,CAER;CAGF,OAAOA;AACT,GAOagB,KAAe,GAAc,MAAwC;CAChF,IAAM,EAAE,WAAQ,cAAWjB,GACrBkB,IAAclB,EAAQ,oBAAoBmB,GAC1CC,IAAcpB,EAAQ,oBAAoBqB,GAE1CpB,IAAQqB,GACRC,IAAaD;CA6BnB,OAzBIE,EAAYF,CAAG,IAAUA,IAGzBG,EAAsBH,CAAG,IAAU,IAAII,EAAsBzB,CAAK,IAIlE0B,EAA8BJ,CAAU,IAAU,IAAIK,EAAsBL,GAAYvB,EAAQ,GAAG,IAEnG6B,EAAoCN,CAAU,IACzC,IAAIO,EAAuBP,GAAYL,GAAaE,GAAanB,CAAK,IAG3E8B,EAA0CR,CAAU,IAC/C,IAAIS,EAA6BT,GAAYL,GAAaE,GAAanB,CAAK,IAGjFgC,EAA4CV,CAAU,IACjD,IAAIW,EAA+BX,GAAYtB,CAAK,IAGzDkC,EAAoBlC,CAAK,IAAU,IAAImC,EAAoBnC,CAAK,IAEhEJ,EAAM,aAAayB,CAAG,IAAU,IAAIhB,EAAkBiB,CAAU,IAE7D,IAAIhB,EAAeN,CAAK;AACjC"}

package/dist/domains/api/utils/apiHelper.js

@@ -1,8 +1,7 @@
-import { isEmptyObject as e } from "../../../shared/utils/common.js";
-import { stringUrlTemplateReplace as t } from "../../../shared/utils/string.js";
-//#region src/domains/api/utils/apiHelper.ts
-var n = (n, r, i = "") => e(r) ? n : t(i === "" ? n : i, r);
-//#endregion
+import { stringUrlTemplateReplace as e } from "../../../shared/utils/string.js";
+import { isEmptyObject as t } from "../../../shared/utils/common.js";
+// src/domains/api/utils/apiHelper.ts
+var n = (n, r, i = "") => t(r) ? n : e(i === "" ? n : i, r);
 export { n as replaceUrlParameters };
 
 //# sourceMappingURL=apiHelper.js.map

package/dist/domains/api/utils/listBody.d.ts

@@ -2,64 +2,43 @@ import { Pagination } from '../composables/pagination';
 export type ListBody<T> = {
     items: T[];
     /**
-     * Which kind of list answered, read from the response rather than inferred from `pagination`.
-     *
-     * They are two different things and conflating them cost a bug: `pagination` is what to write, and
-     * for an infinite list that includes `totalCount: 0` to clear the counted mode's leftovers -- so a
-     * reader using `totalCount` to recognise the mode sees a counted list of zero items.
+     * Which kind of list answered, read from the response, not inferred from `pagination`.
+     * `pagination` is what to write. For an infinite list it includes `totalCount: 0` to clear counted-mode leftovers.
+     * So reading the mode from `totalCount` sees a counted list of zero items. This caused a bug.
      */
     mode: 'counted' | 'infinite' | 'unknown';
     /**
-     * What the response said about the mode it is in, plus the other mode's field cleared: a counted
-     * body carries `hasNextPage: null` and an infinite one `totalCount: 0`, so a value left over from
-     * the previous query cannot go on describing this one. A missing or malformed field of the mode's
-     * own kind is not written at all.
+     * The fields the response gave for its mode, plus the other mode's field cleared.
+     * A counted body gets `hasNextPage: null`, an infinite one
+     * `totalCount: 0`, so values from the previous query do not linger.
+     * A missing or malformed field of the mode's own kind is not written.
      */
     pagination: Partial<Pagination>;
     /**
      * Whether `totalCount` is a bound rather than a count.
-     *
-     * The backend's counted envelope carries `bigTable`, and with it on -- which is the default -- the
-     * count it sends is `offset + limit + 1`: a look-ahead that says "there is at least one more page",
-     * not how many rows exist. It is corrected to the real total only when the page came back short,
-     * which is to say only when there was nothing more to look ahead to.
-     *
-     * Page-by-page navigation does not care: the sentinel is exactly what it needs to enable Next.
-     * Anything that treats the number as a total does -- dividing by a page size to learn how many
-     * pages exist yields 2, whatever the real answer is.
+     * With the backend's `bigTable` on (the default), the count is `offset
+     * + limit + 1`, a look-ahead meaning "at least one more page".
+     * It is the real total only when the page came back short.
+     * Fine for Next/Previous navigation. Wrong for anything that computes a page count from it.
      */
     countIsBound: boolean;
 };
 /**
  * Reads a list response.
- *
- * The array is the only thing that decides whether this is a list at all. The existing shape guards
- * test for a metadata key and nothing else, so `{ totalCount: 1 }` passed as a list and the caller
- * got `undefined` typed as an array.
- *
- * Metadata only picks the mode, and is optional: a well-formed array is not worth discarding because
- * the count beside it is missing or of the wrong type.
- *
- * `hasNextPage` decides, and only its absence falls through to `totalCount`. It has to be that way
- * round, because the backend's infinite envelope carries BOTH: `ApiInfiniteResponseList` serialises
- * `hasNextPage`, `data` and `totalCount` (the last marked `@deprecated`, which is a docblock and
- * suppresses nothing), while the counted one carries `totalCount`, `data` and `bigTable` and never
- * `hasNextPage`. So the presence of `hasNextPage` is the only unambiguous signal, and reading
- * `totalCount` first would turn every infinite list in the fleet into a counted one -- with a total
- * that is not a total: with `bigTable` on, which is the default, the counted number is a look-ahead
- * sentinel, `offset + limit + 1`, and the infinite envelope reports that same sentinel unconditionally.
+ * Only the `data` array decides whether this is a list. Older guards checked a metadata
+ * key only, so `{ totalCount: 1 }` passed and callers got `undefined` as an array.
+ * Metadata only picks the mode and is optional. A valid array is kept even if the count is missing or malformed.
+ * `hasNextPage` decides the mode. The infinite envelope also carries a
+ * deprecated `totalCount`, and the counted one never has `hasNextPage`.
+ * Reading `totalCount` first would make every infinite list counted,
+ * with a look-ahead sentinel `offset + limit + 1` as its total.
  */
 export declare const readListBody: <T>(body: unknown, status: number, url: string | undefined) => ListBody<T>;
 /**
  * Reads a list that arrived as a bare array.
- *
- * The second of the two shapes a list comes in, and a separate reader rather than one that takes
- * either: the caller declares which one this endpoint answers with and the reader refuses the
- * other, the way `optionalBody` makes the caller declare a body. One reader accepting both shapes
- * is a permissive reader, and a permissive reader is what let a malformed answer through in the
- * first place.
- *
- * Returns `T[]` rather than `ListBody<T>`: `mode: 'unknown'` means the envelope named no mode, and
- * here there was no envelope to name one.
+ * Separate from `readListBody` on purpose. The caller declares the shape
+ * its endpoint returns and the other shape is refused, like `optionalBody`.
+ * A reader accepting both shapes would let malformed answers through.
+ * Returns `T[]`, not `ListBody<T>`, because there is no envelope to name a mode.
  */
 export declare const readArrayBody: <T>(body: unknown, status: number, url: string | undefined) => T[];

package/dist/domains/api/utils/listBody.js

@@ -1,10 +1,10 @@
-import { isBoolean as e, isNumber as t, isObject as n } from "../../../shared/utils/common.js";
-import { AnzuApiResponseCodeError as r } from "../../../shared/error/AnzuApiResponseCodeError.js";
-//#region src/domains/api/utils/listBody.ts
+import { AnzuApiResponseCodeError as e } from "../../../shared/error/AnzuApiResponseCodeError.js";
+import { isBoolean as t, isNumber as n, isObject as r } from "../../../shared/utils/common.js";
+// src/domains/api/utils/listBody.ts
 var i = (i, a, o) => {
-	if (!n(i) || !Array.isArray(i.data)) throw new r(a, void 0, "Expected a list body, url: " + o);
+	if (!r(i) || !Array.isArray(i.data)) throw new e(a, void 0, "Expected a list body, url: " + o);
 	let { data: s, totalCount: c, hasNextPage: l, bigTable: u } = i;
-	return e(l) ? {
+	return t(l) ? {
 		items: s,
 		mode: "infinite",
 		pagination: {
@@ -12,7 +12,7 @@ var i = (i, a, o) => {
 			totalCount: 0
 		},
 		countIsBound: !1
-	} : t(c) ? {
+	} : n(c) ? {
 		items: s,
 		mode: "counted",
 		pagination: {
@@ -26,11 +26,10 @@ var i = (i, a, o) => {
 		pagination: {},
 		countIsBound: !1
 	};
-}, a = (e, t, n) => {
-	if (!Array.isArray(e)) throw new r(t, void 0, "Expected an array body, url: " + n);
-	return e;
+}, a = (t, n, r) => {
+	if (!Array.isArray(t)) throw new e(n, void 0, "Expected an array body, url: " + r);
+	return t;
 };
-//#endregion
 export { a as readArrayBody, i as readListBody };
 
 //# sourceMappingURL=listBody.js.map

package/dist/domains/api/utils/listBody.js.map

@@ -1 +1 @@
-{"version":3,"file":"listBody.js","names":["readListBody","isObject","body","AnzuApiResponseCodeError","status","url","isBoolean","hasNextPage","data","isNumber","totalCount","bigTable","readArrayBody"],"sources":["../../../../src/domains/api/utils/listBody.ts"],"sourcesContent":["import { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { isBoolean, isNumber, isObject } from '@/shared/utils/common'\nimport type { Pagination } from '@/domains/api/composables/pagination'\n\nexport type ListBody<T> = {\n  items: T[]\n  /**\n   * Which kind of list answered, read from the response rather than inferred from `pagination`.\n   *\n   * They are two different things and conflating them cost a bug: `pagination` is what to write, and\n   * for an infinite list that includes `totalCount: 0` to clear the counted mode's leftovers -- so a\n   * reader using `totalCount` to recognise the mode sees a counted list of zero items.\n   */\n  mode: 'counted' | 'infinite' | 'unknown'\n  /**\n   * What the response said about the mode it is in, plus the other mode's field cleared: a counted\n   * body carries `hasNextPage: null` and an infinite one `totalCount: 0`, so a value left over from\n   * the previous query cannot go on describing this one. A missing or malformed field of the mode's\n   * own kind is not written at all.\n   */\n  pagination: Partial<Pagination>\n  /**\n   * Whether `totalCount` is a bound rather than a count.\n   *\n   * The backend's counted envelope carries `bigTable`, and with it on -- which is the default -- the\n   * count it sends is `offset + limit + 1`: a look-ahead that says \"there is at least one more page\",\n   * not how many rows exist. It is corrected to the real total only when the page came back short,\n   * which is to say only when there was nothing more to look ahead to.\n   *\n   * Page-by-page navigation does not care: the sentinel is exactly what it needs to enable Next.\n   * Anything that treats the number as a total does -- dividing by a page size to learn how many\n   * pages exist yields 2, whatever the real answer is.\n   */\n  countIsBound: boolean\n}\n\n/**\n * Reads a list response.\n *\n * The array is the only thing that decides whether this is a list at all. The existing shape guards\n * test for a metadata key and nothing else, so `{ totalCount: 1 }` passed as a list and the caller\n * got `undefined` typed as an array.\n *\n * Metadata only picks the mode, and is optional: a well-formed array is not worth discarding because\n * the count beside it is missing or of the wrong type.\n *\n * `hasNextPage` decides, and only its absence falls through to `totalCount`. It has to be that way\n * round, because the backend's infinite envelope carries BOTH: `ApiInfiniteResponseList` serialises\n * `hasNextPage`, `data` and `totalCount` (the last marked `@deprecated`, which is a docblock and\n * suppresses nothing), while the counted one carries `totalCount`, `data` and `bigTable` and never\n * `hasNextPage`. So the presence of `hasNextPage` is the only unambiguous signal, and reading\n * `totalCount` first would turn every infinite list in the fleet into a counted one -- with a total\n * that is not a total: with `bigTable` on, which is the default, the counted number is a look-ahead\n * sentinel, `offset + limit + 1`, and the infinite envelope reports that same sentinel unconditionally.\n */\nexport const readListBody = <T>(body: unknown, status: number, url: string | undefined): ListBody<T> => {\n  if (!isObject(body) || !Array.isArray((body as { data?: unknown }).data)) {\n    throw new AnzuApiResponseCodeError(status, undefined, 'Expected a list body, url: ' + url)\n  }\n\n  const { data, totalCount, hasNextPage, bigTable } = body as {\n    data: T[]\n    totalCount?: unknown\n    hasNextPage?: unknown\n    bigTable?: unknown\n  }\n\n  if (isBoolean(hasNextPage)) {\n    return { items: data, mode: 'infinite', pagination: { hasNextPage, totalCount: 0 }, countIsBound: false }\n  }\n\n  if (isNumber(totalCount)) {\n    // `null`, not `false`: the field is three-valued and the paginators read it that way. `isNull`\n    // is what picks the mode -- `ADatatablePagination.vue:62,67,73` and both `ASubjectSelect.vue`\n    // take a non-null value to mean an infinite list, so `false` here says \"infinite, and there is\n    // no next page\": Next and Last go dead on every page and the total renders as the number of\n    // rows on screen. `null` is the counted list saying the infinite mode's field does not apply.\n    return {\n      items: data,\n      mode: 'counted',\n      pagination: { totalCount, hasNextPage: null },\n      countIsBound: bigTable === true,\n    }\n  }\n\n  return { items: data, mode: 'unknown', pagination: {}, countIsBound: false }\n}\n\n/**\n * Reads a list that arrived as a bare array.\n *\n * The second of the two shapes a list comes in, and a separate reader rather than one that takes\n * either: the caller declares which one this endpoint answers with and the reader refuses the\n * other, the way `optionalBody` makes the caller declare a body. One reader accepting both shapes\n * is a permissive reader, and a permissive reader is what let a malformed answer through in the\n * first place.\n *\n * Returns `T[]` rather than `ListBody<T>`: `mode: 'unknown'` means the envelope named no mode, and\n * here there was no envelope to name one.\n */\nexport const readArrayBody = <T>(body: unknown, status: number, url: string | undefined): T[] => {\n  if (!Array.isArray(body)) {\n    throw new AnzuApiResponseCodeError(status, undefined, 'Expected an array body, url: ' + url)\n  }\n\n  return body as T[]\n}\n"],"mappings":";;;AAuDA,IAAaA,KAAmB,GAAe,GAAgB,MAAyC;CACtG,IAAI,CAACC,EAASC,CAAI,KAAK,CAAC,MAAM,QAASA,EAA4B,IAAI,GACrE,MAAM,IAAIC,EAAyBC,GAAQ,KAAA,GAAW,gCAAgCC,CAAG;CAG3F,IAAM,EAAE,SAAM,eAAY,gBAAa,gBAAaH;CAyBpD,OAlBII,EAAUC,CAAW,IAChB;EAAE,OAAOC;EAAM,MAAM;EAAY,YAAY;GAAE;GAAa,YAAY;EAAE;EAAG,cAAc;CAAM,IAGtGC,EAASC,CAAU,IAMd;EACL,OAAOF;EACP,MAAM;EACN,YAAY;GAAE;GAAY,aAAa;EAAK;EAC5C,cAAcG,MAAa;CAC7B,IAGK;EAAE,OAAOH;EAAM,MAAM;EAAW,YAAY,CAAC;EAAG,cAAc;CAAM;AAC7E,GAcaI,KAAoB,GAAe,GAAgB,MAAiC;CAC/F,IAAI,CAAC,MAAM,QAAQV,CAAI,GACrB,MAAM,IAAIC,EAAyBC,GAAQ,KAAA,GAAW,kCAAkCC,CAAG;CAG7F,OAAOH;AACT"}
+{"version":3,"file":"listBody.js","names":["readListBody","isObject","body","AnzuApiResponseCodeError","status","url","isBoolean","hasNextPage","data","isNumber","totalCount","bigTable","readArrayBody"],"sources":["../../../../src/domains/api/utils/listBody.ts"],"sourcesContent":["import { AnzuApiResponseCodeError } from '@/shared/error/AnzuApiResponseCodeError'\nimport { isBoolean, isNumber, isObject } from '@/shared/utils/common'\nimport type { Pagination } from '@/domains/api/composables/pagination'\n\nexport type ListBody<T> = {\n  items: T[]\n  /**\n   * Which kind of list answered, read from the response, not inferred from `pagination`.\n   * `pagination` is what to write. For an infinite list it includes `totalCount: 0` to clear counted-mode leftovers.\n   * So reading the mode from `totalCount` sees a counted list of zero items. This caused a bug.\n   */\n  mode: 'counted' | 'infinite' | 'unknown'\n  /**\n   * The fields the response gave for its mode, plus the other mode's field cleared.\n   * A counted body gets `hasNextPage: null`, an infinite one\n   * `totalCount: 0`, so values from the previous query do not linger.\n   * A missing or malformed field of the mode's own kind is not written.\n   */\n  pagination: Partial<Pagination>\n  /**\n   * Whether `totalCount` is a bound rather than a count.\n   * With the backend's `bigTable` on (the default), the count is `offset\n   * + limit + 1`, a look-ahead meaning \"at least one more page\".\n   * It is the real total only when the page came back short.\n   * Fine for Next/Previous navigation. Wrong for anything that computes a page count from it.\n   */\n  countIsBound: boolean\n}\n\n/**\n * Reads a list response.\n * Only the `data` array decides whether this is a list. Older guards checked a metadata\n * key only, so `{ totalCount: 1 }` passed and callers got `undefined` as an array.\n * Metadata only picks the mode and is optional. A valid array is kept even if the count is missing or malformed.\n * `hasNextPage` decides the mode. The infinite envelope also carries a\n * deprecated `totalCount`, and the counted one never has `hasNextPage`.\n * Reading `totalCount` first would make every infinite list counted,\n * with a look-ahead sentinel `offset + limit + 1` as its total.\n */\nexport const readListBody = <T>(body: unknown, status: number, url: string | undefined): ListBody<T> => {\n  if (!isObject(body) || !Array.isArray((body as { data?: unknown }).data)) {\n    throw new AnzuApiResponseCodeError(status, undefined, 'Expected a list body, url: ' + url)\n  }\n\n  const { data, totalCount, hasNextPage, bigTable } = body as {\n    data: T[]\n    totalCount?: unknown\n    hasNextPage?: unknown\n    bigTable?: unknown\n  }\n\n  if (isBoolean(hasNextPage)) {\n    return { items: data, mode: 'infinite', pagination: { hasNextPage, totalCount: 0 }, countIsBound: false }\n  }\n\n  if (isNumber(totalCount)) {\n    // `null`, not `false`. Paginators (`ADatatablePagination.vue`,\n    // `ASubjectSelect.vue`) treat any non-null value as an infinite list.\n    // `false` would mean \"infinite, no next page\": Next and Last go dead and the total shows the rows on screen.\n    // `null` means the counted list has no `hasNextPage`.\n    return {\n      items: data,\n      mode: 'counted',\n      pagination: { totalCount, hasNextPage: null },\n      countIsBound: bigTable === true,\n    }\n  }\n\n  return { items: data, mode: 'unknown', pagination: {}, countIsBound: false }\n}\n\n/**\n * Reads a list that arrived as a bare array.\n * Separate from `readListBody` on purpose. The caller declares the shape\n * its endpoint returns and the other shape is refused, like `optionalBody`.\n * A reader accepting both shapes would let malformed answers through.\n * Returns `T[]`, not `ListBody<T>`, because there is no envelope to name a mode.\n */\nexport const readArrayBody = <T>(body: unknown, status: number, url: string | undefined): T[] => {\n  if (!Array.isArray(body)) {\n    throw new AnzuApiResponseCodeError(status, undefined, 'Expected an array body, url: ' + url)\n  }\n\n  return body as T[]\n}\n"],"mappings":";;;AAuCA,IAAaA,KAAmB,GAAe,GAAgB,MAAyC;CACtG,IAAI,CAACC,EAASC,CAAI,KAAK,CAAC,MAAM,QAASA,EAA4B,IAAI,GACrE,MAAM,IAAIC,EAAyBC,GAAQ,KAAA,GAAW,gCAAgCC,CAAG;CAG3F,IAAM,EAAE,SAAM,eAAY,gBAAa,gBAAaH;CAwBpD,OAjBII,EAAUC,CAAW,IAChB;EAAE,OAAOC;EAAM,MAAM;EAAY,YAAY;GAAE;GAAa,YAAY;EAAE;EAAG,cAAc;CAAM,IAGtGC,EAASC,CAAU,IAKd;EACL,OAAOF;EACP,MAAM;EACN,YAAY;GAAE;GAAY,aAAa;EAAK;EAC5C,cAAcG,MAAa;CAC7B,IAGK;EAAE,OAAOH;EAAM,MAAM;EAAW,YAAY,CAAC;EAAG,cAAc;CAAM;AAC7E,GASaI,KAAoB,GAAe,GAAgB,MAAiC;CAC/F,IAAI,CAAC,MAAM,QAAQV,CAAI,GACrB,MAAM,IAAIC,EAAyBC,GAAQ,KAAA,GAAW,kCAAkCC,CAAG;CAG7F,OAAOH;AACT"}

package/dist/domains/api/utils/response.js

@@ -1,7 +1,6 @@
 import { HTTP_STATUS_VALID_ALL as e } from "../../../shared/statusCodes.js";
-//#region src/domains/api/utils/response.ts
+// src/domains/api/utils/response.ts
 var t = (t) => e.includes(t);
-//#endregion
 export { t as isValidHTTPStatus };
 
 //# sourceMappingURL=response.js.map

package/dist/domains/auth/components/Acl.js

@@ -1,7 +1,6 @@
 import e from "./Acl.vue_vue_type_script_setup_true_lang.js";
-//#region src/domains/auth/components/Acl.vue
+// src/domains/auth/components/Acl.vue
 var t = e;
-//#endregion
 export { t as default };
 
 //# sourceMappingURL=Acl.js.map