@learnorama/mozaik-sdk 0.1.0-staging.13.1 → 0.3.2-staging.19.1

package/dist/api/cvs-documents.d.ts

@@ -1,5 +1,5 @@
 
-import { Cr as DocumentRead, Er as DocumentPage, G as ReviewUpdateWrite, K as ReviewRead, M as SupplierGrantRead, Sr as DocumentSearchWrite, Xn as LastPositionWrite, ft as RatingUpdateWrite } from "../chunks/index.js";
+import { Jr as DocumentRead, P as SupplierGrantRead, X as ReviewRead, Y as ReviewUpdateWrite, Zr as DocumentPage, _t as RatingUpdateWrite, in as OpenAtSupplierParams, qr as DocumentSearchWrite, rr as LastPositionWrite } from "../chunks/index.js";
 import { c as request } from "../chunks/client.js";
 //#region src/api/cvs-documents/cvs-documents.d.ts
 export declare const getSearchDocumentsUrl: () => string;
@@ -26,7 +26,7 @@ export declare const getReadDocumentUrl: (docId: number) => string;
  * @summary Read Document
  */
 export declare const readDocument: (docId: number, options?: Parameters<typeof request>[1]) => Promise<DocumentRead>;
-export declare const getOpenAtSupplierUrl: (docId: number) => string;
+export declare const getOpenAtSupplierUrl: (docId: number, params?: OpenAtSupplierParams) => string;
 /**
  * Authorise this patron to open one title at the supplier hosting it.
  *
@@ -48,11 +48,23 @@ export declare const getOpenAtSupplierUrl: (docId: number) => string;
  * them either, so the honest answer is that this title is not openable rather
  * than a 500 from a missing branch.
  *
+ * ``mode`` is the legacy's ``$upload``: ``stream`` to consult in place,
+ * ``download`` to take a copy away. It does two things, and both matter —
+ *
+ * * **The library is billed for the right act.** ``exemp`` records streaming
+ *   and download separately, and ``pret_download`` is the only column where a
+ *   loan duration ever appears. Granting a download as a view bills the wrong
+ *   quota.
+ * * **Three platforms sign it.** Jeux CVS, CVS Livres and Komics Initiative
+ *   append the flag *after* the second key, so a stream and a download of the
+ *   same title by the same patron at the same second carry different
+ *   signatures. For the other platforms it is inert.
+ *
  * The returned token is for the *supplier*, not for us. See
  * :class:`~app.datamodels.cvs.downloads.SupplierGrantRead`.
  * @summary Open At Supplier
  */
-export declare const openAtSupplier: (docId: number, options?: Parameters<typeof request>[1]) => Promise<SupplierGrantRead>;
+export declare const openAtSupplier: (docId: number, params?: OpenAtSupplierParams, options?: Parameters<typeof request>[1]) => Promise<SupplierGrantRead>;
 export declare const getReadLastPositionUrl: (docId: number) => string;
 /**
  * Where this patron got to, or ``0`` if they have not started.

package/dist/api/cvs-documents.js

@@ -52,8 +52,13 @@ const readDocument = async (docId, options) => {
 		method: "GET"
 	});
 };
-const getOpenAtSupplierUrl = (docId) => {
-	return `/cvs/documents/${docId}/grant`;
+const getOpenAtSupplierUrl = (docId, params) => {
+	const normalizedParams = new URLSearchParams();
+	Object.entries(params || {}).forEach(([key, value]) => {
+		if (value !== void 0) normalizedParams.append(key, value === null ? "null" : String(value));
+	});
+	const stringifiedParams = normalizedParams.toString();
+	return stringifiedParams.length > 0 ? `/cvs/documents/${docId}/grant?${stringifiedParams}` : `/cvs/documents/${docId}/grant`;
 };
 /**
 * Authorise this patron to open one title at the supplier hosting it.
@@ -76,12 +81,24 @@ const getOpenAtSupplierUrl = (docId) => {
 * them either, so the honest answer is that this title is not openable rather
 * than a 500 from a missing branch.
 *
+* ``mode`` is the legacy's ``$upload``: ``stream`` to consult in place,
+* ``download`` to take a copy away. It does two things, and both matter —
+*
+* * **The library is billed for the right act.** ``exemp`` records streaming
+*   and download separately, and ``pret_download`` is the only column where a
+*   loan duration ever appears. Granting a download as a view bills the wrong
+*   quota.
+* * **Three platforms sign it.** Jeux CVS, CVS Livres and Komics Initiative
+*   append the flag *after* the second key, so a stream and a download of the
+*   same title by the same patron at the same second carry different
+*   signatures. For the other platforms it is inert.
+*
 * The returned token is for the *supplier*, not for us. See
 * :class:`~app.datamodels.cvs.downloads.SupplierGrantRead`.
 * @summary Open At Supplier
 */
-const openAtSupplier = async (docId, options) => {
-	return request(getOpenAtSupplierUrl(docId), {
+const openAtSupplier = async (docId, params, options) => {
+	return request(getOpenAtSupplierUrl(docId, params), {
 		...options,
 		method: "POST"
 	});

package/dist/api/cvs-documents.js.map

@@ -1 +1 @@
-{"version":3,"file":"cvs-documents.js","names":[],"sources":["../../src/api/cvs-documents/cvs-documents.ts"],"sourcesContent":["/**\n * Generated by orval 🍺\n * Do not edit manually.\n * Mozaik backend\n * Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.\n * OpenAPI spec version: 0.1.0\n */\nimport type {\n  DocumentPage,\n  DocumentRead,\n  DocumentSearchWrite,\n  LastPositionWrite,\n  RatingUpdateWrite,\n  ReviewRead,\n  ReviewUpdateWrite,\n  SupplierGrantRead\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getSearchDocumentsUrl = () => {\n\n\n\n\n  return `/cvs/documents/search`\n}\n\n/**\n * Search the CVS catalogue.\n *\n * ``POST`` because the legacy put the query in the body and the mobile clients\n * send it that way. It is a read, so it stays safe: nothing here writes.\n *\n * Same division as ``/search``: the index ranks, PostgreSQL authorises. An\n * index outage degrades to no results rather than to an unfiltered catalogue.\n * @summary Search Documents\n */\nexport const searchDocuments = async (documentSearchWrite: DocumentSearchWrite, options?: Parameters<typeof request>[1]): Promise<DocumentPage> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<DocumentPage>(getSearchDocumentsUrl(),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(documentSearchWrite)\n  }\n);}\n\n\nexport const getReadDocumentUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}`\n}\n\n/**\n * One work, if this caller's contract reaches it.\n *\n * Missing until now, which was an oversight rather than a decision: search,\n * rating, review and position all existed and there was no way to fetch the\n * thing they act on. The legacy has no equivalent either — the app assembles a\n * document sheet from whatever the menu endpoint already returned, which is why\n * a deep link into a title has never worked properly.\n * @summary Read Document\n */\nexport const readDocument = async (docId: number, options?: Parameters<typeof request>[1]): Promise<DocumentRead> => {\n\n  return request<DocumentRead>(getReadDocumentUrl(docId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getOpenAtSupplierUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/grant`\n}\n\n/**\n * Authorise this patron to open one title at the supplier hosting it.\n *\n * Replaces the legacy ``wstoken``: 4,878 lines dispatching on\n * ``frn.plate_forme`` through 57 near-identical arms. The signing schemes\n * reduce to eight (:class:`~app.models.enums.TokenFormula`) and the platform\n * map to a table, so what is left here is the order of operations.\n *\n * **Entitle, seat, then sign** — the same order the streaming route uses, and\n * for the same reason. A signature is cheap to produce and impossible to\n * recall once it has left; a seat can be released. Signing first would mean a\n * refused request had already handed a patron something that works.\n *\n * ``404`` when the caller is not entitled or the title does not exist — the\n * two are deliberately indistinguishable, as everywhere else in this API.\n * ``409`` when every seat is taken: the caller *is* entitled and should be\n * offered \"try later\", not \"buy a subscription\". ``409`` too when the supplier\n * sits on a platform nobody implemented — four do, and the legacy cannot serve\n * them either, so the honest answer is that this title is not openable rather\n * than a 500 from a missing branch.\n *\n * The returned token is for the *supplier*, not for us. See\n * :class:`~app.datamodels.cvs.downloads.SupplierGrantRead`.\n * @summary Open At Supplier\n */\nexport const openAtSupplier = async (docId: number, options?: Parameters<typeof request>[1]): Promise<SupplierGrantRead> => {\n\n  return request<SupplierGrantRead>(getOpenAtSupplierUrl(docId),\n  {\n    ...options,\n    method: 'POST'\n\n\n  }\n);}\n\n\nexport const getReadLastPositionUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/position`\n}\n\n/**\n * Where this patron got to, or ``0`` if they have not started.\n *\n * New: the legacy has no way to read the position back, so a client that lost\n * its local state could never resume. Absent means not started, which is why\n * the row is not created on read.\n * @summary Read Last Position\n */\nexport const readLastPosition = async (docId: number, options?: Parameters<typeof request>[1]): Promise<LastPositionWrite> => {\n\n  return request<LastPositionWrite>(getReadLastPositionUrl(docId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getSetLastPositionUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/position`\n}\n\n/**\n * Record where this patron got to.\n *\n * A write, and the legacy declares it ``GET`` with the position in the query\n * string — which makes resuming a book a cacheable idempotent read that mutates\n * state, and puts it outside the CSRF layer for free.\n *\n * Stored in :class:`~app.models.activity.ReadingPosition`, which the products\n * share — CVS and the partner reader today — so a member who reads across them\n * keeps their place in one shape.\n * @summary Set Last Position\n */\nexport const setLastPosition = async (docId: number,\n    lastPositionWrite: LastPositionWrite, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<void>(getSetLastPositionUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(lastPositionWrite)\n  }\n);}\n\n\nexport const getRateDocumentUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/rating`\n}\n\n/**\n * Rate a document. Idempotent — rating again replaces the earlier score.\n *\n * ``PUT`` on the rating sub-resource rather than the legacy\n * ``POST /document/rating/update`` with the id in the body: the identifier\n * belongs in the path, and \"update\" in a path names an operation in a position\n * reserved for a resource.\n * @summary Rate Document\n */\nexport const rateDocument = async (docId: number,\n    ratingUpdateWrite: RatingUpdateWrite, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<void>(getRateDocumentUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(ratingUpdateWrite)\n  }\n);}\n\n\nexport const getWriteReviewUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/review`\n}\n\n/**\n * Write or replace this patron's review of a document.\n *\n * One review per person per document, so this is a ``PUT`` on a singular\n * sub-resource rather than a ``POST`` to a collection. The legacy had two routes\n * — with and without an ``avisId`` — for what is one row.\n *\n * Every write resets the review to unpublished. An edit after moderation is a\n * new thing to moderate, and carrying the old approval forward is how an\n * approved review becomes a different text.\n * @summary Write Review\n */\nexport const writeReview = async (docId: number,\n    reviewUpdateWrite: ReviewUpdateWrite, options?: Parameters<typeof request>[1]): Promise<ReviewRead> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<ReviewRead>(getWriteReviewUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(reviewUpdateWrite)\n  }\n);}\n\n\n"],"mappings":";;;AAoBA,MAAa,8BAA8B;CAKzC,OAAO;AACT;;;;;;;;;;;AAYA,MAAa,kBAAkB,OAAO,qBAA0C,YAAmE;CAE/I,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAsB,sBAAsB,GACjD;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,mBAAmB;CAC1C,CACF;AAAE;AAGF,MAAa,sBAAsB,UAAmB;CAKpD,OAAO,kBAAkB;AAC3B;;;;;;;;;;;AAYA,MAAa,eAAe,OAAO,OAAe,YAAmE;CAEnH,OAAO,QAAsB,mBAAmB,KAAK,GACrD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,wBAAwB,UAAmB;CAKtD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,MAAa,iBAAiB,OAAO,OAAe,YAAwE;CAE1H,OAAO,QAA2B,qBAAqB,KAAK,GAC5D;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,0BAA0B,UAAmB;CAKxD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;AAUA,MAAa,mBAAmB,OAAO,OAAe,YAAwE;CAE5H,OAAO,QAA2B,uBAAuB,KAAK,GAC9D;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,yBAAyB,UAAmB;CAKvD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;;;;AAcA,MAAa,kBAAkB,OAAO,OAClC,mBAAsC,YAA2D;CAEjG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAc,sBAAsB,KAAK,GAC9C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE;AAGF,MAAa,sBAAsB,UAAmB;CAKpD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;AAWA,MAAa,eAAe,OAAO,OAC/B,mBAAsC,YAA2D;CAEjG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAc,mBAAmB,KAAK,GAC3C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE;AAGF,MAAa,qBAAqB,UAAmB;CAKnD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;;;;AAcA,MAAa,cAAc,OAAO,OAC9B,mBAAsC,YAAiE;CAEvG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAoB,kBAAkB,KAAK,GAChD;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE"}
+{"version":3,"file":"cvs-documents.js","names":[],"sources":["../../src/api/cvs-documents/cvs-documents.ts"],"sourcesContent":["/**\n * Generated by orval 🍺\n * Do not edit manually.\n * Mozaik backend\n * Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.\n * OpenAPI spec version: 0.3.2\n */\nimport type {\n  DocumentPage,\n  DocumentRead,\n  DocumentSearchWrite,\n  LastPositionWrite,\n  OpenAtSupplierParams,\n  RatingUpdateWrite,\n  ReviewRead,\n  ReviewUpdateWrite,\n  SupplierGrantRead\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getSearchDocumentsUrl = () => {\n\n\n\n\n  return `/cvs/documents/search`\n}\n\n/**\n * Search the CVS catalogue.\n *\n * ``POST`` because the legacy put the query in the body and the mobile clients\n * send it that way. It is a read, so it stays safe: nothing here writes.\n *\n * Same division as ``/search``: the index ranks, PostgreSQL authorises. An\n * index outage degrades to no results rather than to an unfiltered catalogue.\n * @summary Search Documents\n */\nexport const searchDocuments = async (documentSearchWrite: DocumentSearchWrite, options?: Parameters<typeof request>[1]): Promise<DocumentPage> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<DocumentPage>(getSearchDocumentsUrl(),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(documentSearchWrite)\n  }\n);}\n\n\nexport const getReadDocumentUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}`\n}\n\n/**\n * One work, if this caller's contract reaches it.\n *\n * Missing until now, which was an oversight rather than a decision: search,\n * rating, review and position all existed and there was no way to fetch the\n * thing they act on. The legacy has no equivalent either — the app assembles a\n * document sheet from whatever the menu endpoint already returned, which is why\n * a deep link into a title has never worked properly.\n * @summary Read Document\n */\nexport const readDocument = async (docId: number, options?: Parameters<typeof request>[1]): Promise<DocumentRead> => {\n\n  return request<DocumentRead>(getReadDocumentUrl(docId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getOpenAtSupplierUrl = (docId: number,\n    params?: OpenAtSupplierParams,) => {\n  const normalizedParams = new URLSearchParams();\n\n  Object.entries(params || {}).forEach(([key, value]) => {\n\n    if (value !== undefined) {\n      normalizedParams.append(key, value === null ? 'null' : String(value))\n    }\n  });\n\n  const stringifiedParams = normalizedParams.toString();\n\n  return stringifiedParams.length > 0 ? `/cvs/documents/${docId}/grant?${stringifiedParams}` : `/cvs/documents/${docId}/grant`\n}\n\n/**\n * Authorise this patron to open one title at the supplier hosting it.\n *\n * Replaces the legacy ``wstoken``: 4,878 lines dispatching on\n * ``frn.plate_forme`` through 57 near-identical arms. The signing schemes\n * reduce to eight (:class:`~app.models.enums.TokenFormula`) and the platform\n * map to a table, so what is left here is the order of operations.\n *\n * **Entitle, seat, then sign** — the same order the streaming route uses, and\n * for the same reason. A signature is cheap to produce and impossible to\n * recall once it has left; a seat can be released. Signing first would mean a\n * refused request had already handed a patron something that works.\n *\n * ``404`` when the caller is not entitled or the title does not exist — the\n * two are deliberately indistinguishable, as everywhere else in this API.\n * ``409`` when every seat is taken: the caller *is* entitled and should be\n * offered \"try later\", not \"buy a subscription\". ``409`` too when the supplier\n * sits on a platform nobody implemented — four do, and the legacy cannot serve\n * them either, so the honest answer is that this title is not openable rather\n * than a 500 from a missing branch.\n *\n * ``mode`` is the legacy's ``$upload``: ``stream`` to consult in place,\n * ``download`` to take a copy away. It does two things, and both matter —\n *\n * * **The library is billed for the right act.** ``exemp`` records streaming\n *   and download separately, and ``pret_download`` is the only column where a\n *   loan duration ever appears. Granting a download as a view bills the wrong\n *   quota.\n * * **Three platforms sign it.** Jeux CVS, CVS Livres and Komics Initiative\n *   append the flag *after* the second key, so a stream and a download of the\n *   same title by the same patron at the same second carry different\n *   signatures. For the other platforms it is inert.\n *\n * The returned token is for the *supplier*, not for us. See\n * :class:`~app.datamodels.cvs.downloads.SupplierGrantRead`.\n * @summary Open At Supplier\n */\nexport const openAtSupplier = async (docId: number,\n    params?: OpenAtSupplierParams, options?: Parameters<typeof request>[1]): Promise<SupplierGrantRead> => {\n\n  return request<SupplierGrantRead>(getOpenAtSupplierUrl(docId,params),\n  {\n    ...options,\n    method: 'POST'\n\n\n  }\n);}\n\n\nexport const getReadLastPositionUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/position`\n}\n\n/**\n * Where this patron got to, or ``0`` if they have not started.\n *\n * New: the legacy has no way to read the position back, so a client that lost\n * its local state could never resume. Absent means not started, which is why\n * the row is not created on read.\n * @summary Read Last Position\n */\nexport const readLastPosition = async (docId: number, options?: Parameters<typeof request>[1]): Promise<LastPositionWrite> => {\n\n  return request<LastPositionWrite>(getReadLastPositionUrl(docId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getSetLastPositionUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/position`\n}\n\n/**\n * Record where this patron got to.\n *\n * A write, and the legacy declares it ``GET`` with the position in the query\n * string — which makes resuming a book a cacheable idempotent read that mutates\n * state, and puts it outside the CSRF layer for free.\n *\n * Stored in :class:`~app.models.activity.ReadingPosition`, which the products\n * share — CVS and the partner reader today — so a member who reads across them\n * keeps their place in one shape.\n * @summary Set Last Position\n */\nexport const setLastPosition = async (docId: number,\n    lastPositionWrite: LastPositionWrite, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<void>(getSetLastPositionUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(lastPositionWrite)\n  }\n);}\n\n\nexport const getRateDocumentUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/rating`\n}\n\n/**\n * Rate a document. Idempotent — rating again replaces the earlier score.\n *\n * ``PUT`` on the rating sub-resource rather than the legacy\n * ``POST /document/rating/update`` with the id in the body: the identifier\n * belongs in the path, and \"update\" in a path names an operation in a position\n * reserved for a resource.\n * @summary Rate Document\n */\nexport const rateDocument = async (docId: number,\n    ratingUpdateWrite: RatingUpdateWrite, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<void>(getRateDocumentUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(ratingUpdateWrite)\n  }\n);}\n\n\nexport const getWriteReviewUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/documents/${docId}/review`\n}\n\n/**\n * Write or replace this patron's review of a document.\n *\n * One review per person per document, so this is a ``PUT`` on a singular\n * sub-resource rather than a ``POST`` to a collection. The legacy had two routes\n * — with and without an ``avisId`` — for what is one row.\n *\n * Every write resets the review to unpublished. An edit after moderation is a\n * new thing to moderate, and carrying the old approval forward is how an\n * approved review becomes a different text.\n * @summary Write Review\n */\nexport const writeReview = async (docId: number,\n    reviewUpdateWrite: ReviewUpdateWrite, options?: Parameters<typeof request>[1]): Promise<ReviewRead> => {\n\n    const getHeaders = (h?: NonNullable<RequestInit['headers']>): Record<string, string | readonly string[]> => {\n    if (!h) return {};\n    if (h instanceof Headers) return Object.fromEntries(h.entries());\n    if (Symbol.iterator in h) {\n      return Object.fromEntries(\n        Array.from(h as Iterable<Iterable<string>>, (entry) => Array.from(entry) as [string, string]),\n      );\n    }\n    const headers: Record<string, string | readonly string[]> = {};\n    for (const [name, value] of Object.entries<string | readonly string[] | undefined>(h)) {\n      if (value !== undefined) headers[name] = value;\n    }\n    return headers;\n  };\nreturn request<ReviewRead>(getWriteReviewUrl(docId),\n  {\n    ...options,\n    method: 'PUT',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(reviewUpdateWrite)\n  }\n);}\n\n\n"],"mappings":";;;AAqBA,MAAa,8BAA8B;CAKzC,OAAO;AACT;;;;;;;;;;;AAYA,MAAa,kBAAkB,OAAO,qBAA0C,YAAmE;CAE/I,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAsB,sBAAsB,GACjD;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,mBAAmB;CAC1C,CACF;AAAE;AAGF,MAAa,sBAAsB,UAAmB;CAKpD,OAAO,kBAAkB;AAC3B;;;;;;;;;;;AAYA,MAAa,eAAe,OAAO,OAAe,YAAmE;CAEnH,OAAO,QAAsB,mBAAmB,KAAK,GACrD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,wBAAwB,OACjC,WAAmC;CACrC,MAAM,mBAAmB,IAAI,gBAAgB;CAE7C,OAAO,QAAQ,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EAErD,IAAI,UAAU,KAAA,GACZ,iBAAiB,OAAO,KAAK,UAAU,OAAO,SAAS,OAAO,KAAK,CAAC;CAExE,CAAC;CAED,MAAM,oBAAoB,iBAAiB,SAAS;CAEpD,OAAO,kBAAkB,SAAS,IAAI,kBAAkB,MAAM,SAAS,sBAAsB,kBAAkB,MAAM;AACvH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,MAAa,iBAAiB,OAAO,OACjC,QAA+B,YAAwE;CAEzG,OAAO,QAA2B,qBAAqB,OAAM,MAAM,GACnE;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,0BAA0B,UAAmB;CAKxD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;AAUA,MAAa,mBAAmB,OAAO,OAAe,YAAwE;CAE5H,OAAO,QAA2B,uBAAuB,KAAK,GAC9D;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,yBAAyB,UAAmB;CAKvD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;;;;AAcA,MAAa,kBAAkB,OAAO,OAClC,mBAAsC,YAA2D;CAEjG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAc,sBAAsB,KAAK,GAC9C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE;AAGF,MAAa,sBAAsB,UAAmB;CAKpD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;AAWA,MAAa,eAAe,OAAO,OAC/B,mBAAsC,YAA2D;CAEjG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAc,mBAAmB,KAAK,GAC3C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE;AAGF,MAAa,qBAAqB,UAAmB;CAKnD,OAAO,kBAAkB,MAAM;AACjC;;;;;;;;;;;;;AAcA,MAAa,cAAc,OAAO,OAC9B,mBAAsC,YAAiE;CAEvG,MAAM,cAAc,MAAwF;EAC5G,IAAI,CAAC,GAAG,OAAO,CAAC;EAChB,IAAI,aAAa,SAAS,OAAO,OAAO,YAAY,EAAE,QAAQ,CAAC;EAC/D,IAAI,OAAO,YAAY,GACrB,OAAO,OAAO,YACZ,MAAM,KAAK,IAAkC,UAAU,MAAM,KAAK,KAAK,CAAqB,CAC9F;EAEF,MAAM,UAAsD,CAAC;EAC7D,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAgD,CAAC,GAClF,IAAI,UAAU,KAAA,GAAW,QAAQ,QAAQ;EAE3C,OAAO;CACT;CACF,OAAO,QAAoB,kBAAkB,KAAK,GAChD;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,iBAAiB;CACxC,CACF;AAAE"}

package/dist/api/cvs-favorites.d.ts

@@ -1,5 +1,5 @@
 
-import { dr as SelectionRead, lr as FavoriteListRead } from "../chunks/index.js";
+import { Ir as SelectionRead, Pr as FavoriteListRead } from "../chunks/index.js";
 import { c as request } from "../chunks/client.js";
 //#region src/api/cvs-favorites/cvs-favorites.d.ts
 export declare const getListCvsFavoritesUrl: () => string;

package/dist/api/cvs-favorites.js.map

@@ -1 +1 @@
-{"version":3,"file":"cvs-favorites.js","names":[],"sources":["../../src/api/cvs-favorites/cvs-favorites.ts"],"sourcesContent":["/**\n * Generated by orval 🍺\n * Do not edit manually.\n * Mozaik backend\n * Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.\n * OpenAPI spec version: 0.1.0\n */\nimport type {\n  FavoriteListRead,\n  SelectionRead\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getListCvsFavoritesUrl = () => {\n\n\n\n\n  return `/cvs/favorites`\n}\n\n/**\n * The caller's favourites.\n *\n * Entitlement-filtered. A title the library has stopped licensing stays in the\n * list — removing it silently would lose the patron's own curation over a\n * contract change they had nothing to do with — but it is not returned here,\n * because a client cannot open it. When the licence comes back, so does the\n * entry.\n * @summary List Cvs Favorites\n */\nexport const listCvsFavorites = async ( options?: Parameters<typeof request>[1]): Promise<FavoriteListRead> => {\n\n  return request<FavoriteListRead>(getListCvsFavoritesUrl(),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getRemoveCvsFavoriteUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/favorites/${docId}`\n}\n\n/**\n * Remove a work from the caller's list. Idempotent.\n *\n * Scoped to ``kind = 8`` through the list lookup, so this can never delete a\n * line out of the patron's loans or reservations — which live in the same two\n * tables and would look identical to a query that only matched on\n * ``(user_id, doc_id)``.\n * @summary Remove Cvs Favorite\n */\nexport const removeCvsFavorite = async (docId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getRemoveCvsFavoriteUrl(docId),\n  {\n    ...options,\n    method: 'DELETE'\n\n\n  }\n);}\n\n\nexport const getAddCvsFavoriteUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/favorites/${docId}`\n}\n\n/**\n * Add a work to the caller's list. Idempotent.\n *\n * ``PUT`` and ``DELETE`` on the item, rather than the legacy's single route\n * answering both ``POST`` and ``DELETE`` on a path with a required\n * ``{selectionId}`` its own handler declares optional.\n *\n * Not entitlement-gated. A patron may bookmark something their library has not\n * licensed yet — that is a signal worth having, and it is what an acquisitions\n * request is made of. Reaching the work is gated, at the point of reaching it.\n * @summary Add Cvs Favorite\n */\nexport const addCvsFavorite = async (docId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getAddCvsFavoriteUrl(docId),\n  {\n    ...options,\n    method: 'PUT'\n\n\n  }\n);}\n\n\nexport const getListSelectionsUrl = () => {\n\n\n\n\n  return `/cvs/lists`\n}\n\n/**\n * Every list this patron holds, of every kind.\n *\n * Read-only and deliberately unfiltered: a client showing \"my loans\" and \"my\n * list\" side by side needs to know which is which, and hiding the ILS-mirrored\n * kinds would only make it guess.\n * @summary List Selections\n */\nexport const listSelections = async ( options?: Parameters<typeof request>[1]): Promise<SelectionRead[]> => {\n\n  return request<SelectionRead[]>(getListSelectionsUrl(),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\n"],"mappings":";;;AAcA,MAAa,+BAA+B;CAK1C,OAAO;AACT;;;;;;;;;;;AAYA,MAAa,mBAAmB,OAAQ,YAAuE;CAE7G,OAAO,QAA0B,uBAAuB,GACxD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,2BAA2B,UAAmB;CAKzD,OAAO,kBAAkB;AAC3B;;;;;;;;;;AAWA,MAAa,oBAAoB,OAAO,OAAe,YAA2D;CAEhH,OAAO,QAAc,wBAAwB,KAAK,GAClD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,wBAAwB,UAAmB;CAKtD,OAAO,kBAAkB;AAC3B;;;;;;;;;;;;;AAcA,MAAa,iBAAiB,OAAO,OAAe,YAA2D;CAE7G,OAAO,QAAc,qBAAqB,KAAK,GAC/C;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,6BAA6B;CAKxC,OAAO;AACT;;;;;;;;;AAUA,MAAa,iBAAiB,OAAQ,YAAsE;CAE1G,OAAO,QAAyB,qBAAqB,GACrD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE"}
+{"version":3,"file":"cvs-favorites.js","names":[],"sources":["../../src/api/cvs-favorites/cvs-favorites.ts"],"sourcesContent":["/**\n * Generated by orval 🍺\n * Do not edit manually.\n * Mozaik backend\n * Four products behind one API — Biblio, Médiathèques, the partner catalogues (Nextory and YouScribe) and Prof Express. Authentication is Keycloak SSO only, once, for all of them: see the **auth** section below for the browser flow and the three failure modes.\n * OpenAPI spec version: 0.3.2\n */\nimport type {\n  FavoriteListRead,\n  SelectionRead\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getListCvsFavoritesUrl = () => {\n\n\n\n\n  return `/cvs/favorites`\n}\n\n/**\n * The caller's favourites.\n *\n * Entitlement-filtered. A title the library has stopped licensing stays in the\n * list — removing it silently would lose the patron's own curation over a\n * contract change they had nothing to do with — but it is not returned here,\n * because a client cannot open it. When the licence comes back, so does the\n * entry.\n * @summary List Cvs Favorites\n */\nexport const listCvsFavorites = async ( options?: Parameters<typeof request>[1]): Promise<FavoriteListRead> => {\n\n  return request<FavoriteListRead>(getListCvsFavoritesUrl(),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getRemoveCvsFavoriteUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/favorites/${docId}`\n}\n\n/**\n * Remove a work from the caller's list. Idempotent.\n *\n * Scoped to ``kind = 8`` through the list lookup, so this can never delete a\n * line out of the patron's loans or reservations — which live in the same two\n * tables and would look identical to a query that only matched on\n * ``(user_id, doc_id)``.\n * @summary Remove Cvs Favorite\n */\nexport const removeCvsFavorite = async (docId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getRemoveCvsFavoriteUrl(docId),\n  {\n    ...options,\n    method: 'DELETE'\n\n\n  }\n);}\n\n\nexport const getAddCvsFavoriteUrl = (docId: number,) => {\n\n\n\n\n  return `/cvs/favorites/${docId}`\n}\n\n/**\n * Add a work to the caller's list. Idempotent.\n *\n * ``PUT`` and ``DELETE`` on the item, rather than the legacy's single route\n * answering both ``POST`` and ``DELETE`` on a path with a required\n * ``{selectionId}`` its own handler declares optional.\n *\n * Not entitlement-gated. A patron may bookmark something their library has not\n * licensed yet — that is a signal worth having, and it is what an acquisitions\n * request is made of. Reaching the work is gated, at the point of reaching it.\n * @summary Add Cvs Favorite\n */\nexport const addCvsFavorite = async (docId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getAddCvsFavoriteUrl(docId),\n  {\n    ...options,\n    method: 'PUT'\n\n\n  }\n);}\n\n\nexport const getListSelectionsUrl = () => {\n\n\n\n\n  return `/cvs/lists`\n}\n\n/**\n * Every list this patron holds, of every kind.\n *\n * Read-only and deliberately unfiltered: a client showing \"my loans\" and \"my\n * list\" side by side needs to know which is which, and hiding the ILS-mirrored\n * kinds would only make it guess.\n * @summary List Selections\n */\nexport const listSelections = async ( options?: Parameters<typeof request>[1]): Promise<SelectionRead[]> => {\n\n  return request<SelectionRead[]>(getListSelectionsUrl(),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\n"],"mappings":";;;AAcA,MAAa,+BAA+B;CAK1C,OAAO;AACT;;;;;;;;;;;AAYA,MAAa,mBAAmB,OAAQ,YAAuE;CAE7G,OAAO,QAA0B,uBAAuB,GACxD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,2BAA2B,UAAmB;CAKzD,OAAO,kBAAkB;AAC3B;;;;;;;;;;AAWA,MAAa,oBAAoB,OAAO,OAAe,YAA2D;CAEhH,OAAO,QAAc,wBAAwB,KAAK,GAClD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,wBAAwB,UAAmB;CAKtD,OAAO,kBAAkB;AAC3B;;;;;;;;;;;;;AAcA,MAAa,iBAAiB,OAAO,OAAe,YAA2D;CAE7G,OAAO,QAAc,qBAAqB,KAAK,GAC/C;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,6BAA6B;CAKxC,OAAO;AACT;;;;;;;;;AAUA,MAAa,iBAAiB,OAAQ,YAAsE;CAE1G,OAAO,QAAyB,qBAAqB,GACrD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE"}

package/dist/api/cvs-ils.d.ts

@@ -0,0 +1,167 @@
+
+import { Nn as ListIlsLoansParams, _r as IlsHoldListRead, ar as IlsTagWrite, br as IlsActionRead, cr as IlsStatusRead, dr as IlsPasswordWrite, dt as ReadIlsHoldableParams, fr as IlsLocationListRead, gr as IlsHoldWrite, lr as IlsSignInWrite, mr as IlsLoanListRead, or as IlsSuggestionOptionListRead, ur as IlsReviewWrite, xr as IlsAccountRead, yr as IlsHoldableRead } from "../chunks/index.js";
+import { c as request } from "../chunks/client.js";
+//#region src/api/cvs-ils/cvs-ils.d.ts
+export declare const getReadIlsAccountUrl: () => string;
+/**
+ * The borrower record held by the library.
+ *
+ * Passed through unmodelled — PMB documents no shape for this call and the
+ * four libraries run different versions, so a fixed schema would drop exactly
+ * the fine and expiry fields a patron most needs.
+ * @summary Read Ils Account
+ */
+export declare const readIlsAccount: (options?: Parameters<typeof request>[1]) => Promise<IlsAccountRead>;
+export declare const getListIlsHoldLocationsUrl: () => string;
+/**
+ * Branches a reservation may be collected from.
+ *
+ * A separate call from ``/ils/locations`` because it is a different list —
+ * not every branch accepts collections, and offering one that does not
+ * produces a hold the patron can never pick up.
+ * @summary List Ils Hold Locations
+ */
+export declare const listIlsHoldLocations: (options?: Parameters<typeof request>[1]) => Promise<IlsLocationListRead>;
+export declare const getListIlsHoldsUrl: () => string;
+/**
+ * This patron's reservations, with their place in each queue.
+ * @summary List Ils Holds
+ */
+export declare const listIlsHolds: (options?: Parameters<typeof request>[1]) => Promise<IlsHoldListRead>;
+export declare const getPlaceIlsHoldUrl: () => string;
+/**
+ * Reserve a record, for collection at a branch.
+ *
+ * Check ``GET /ils/records/{record_id}/holdable`` first if you want to show
+ * the patron why not before they try — this returns the library's refusal
+ * either way.
+ * @summary Place Ils Hold
+ */
+export declare const placeIlsHold: (ilsHoldWrite: IlsHoldWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getCancelIlsHoldUrl: (holdId: number) => string;
+/**
+ * Cancel a reservation. The library decides whether it may still be.
+ * @summary Cancel Ils Hold
+ */
+export declare const cancelIlsHold: (holdId: number, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getListIlsLoansUrl: (params?: ListIlsLoansParams) => string;
+/**
+ * What this patron has out from their library.
+ *
+ * ``state`` replaces PMB's integer ``loan_type``. The wire values were 0, 1
+ * and 2 with the meanings in the vendor's documentation and nowhere in the
+ * URL; a client should not have to know that 2 means overdue.
+ * @summary List Ils Loans
+ */
+export declare const listIlsLoans: (params?: ListIlsLoansParams, options?: Parameters<typeof request>[1]) => Promise<IlsLoanListRead>;
+export declare const getRenewIlsLoanUrl: (barcode: string) => string;
+/**
+ * Extend one loan.
+ *
+ * Keyed on the **item barcode**, not a loan id, because that is what PMB
+ * renews — a physical copy — and it is the number printed on the book. It is
+ * also what ``GET /ils/loans`` returns as ``barcode``.
+ *
+ * A refusal is a ``200`` with ``ok: false``, not an error: "this cannot be
+ * renewed again" is the library's answer to a valid question, and the reason
+ * it gives is worth showing the patron.
+ * @summary Renew Ils Loan
+ */
+export declare const renewIlsLoan: (barcode: string, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getListIlsLocationsUrl: () => string;
+/**
+ * Every branch in the library's catalogue.
+ * @summary List Ils Locations
+ */
+export declare const listIlsLocations: (options?: Parameters<typeof request>[1]) => Promise<IlsLocationListRead>;
+export declare const getChangeIlsPasswordUrl: () => string;
+/**
+ * Change the password on the **library's** system.
+ *
+ * Not the Mozaik one. A patron who changes it here still signs in to this
+ * platform with their Mozaik credentials, and saying so in the UI avoids the
+ * support ticket.
+ * @summary Change Ils Password
+ */
+export declare const changeIlsPassword: (ilsPasswordWrite: IlsPasswordWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getReadIlsHoldableUrl: (recordId: number, params?: ReadIlsHoldableParams) => string;
+/**
+ * Whether this patron may reserve this record, and the library's reason.
+ * @summary Read Ils Holdable
+ */
+export declare const readIlsHoldable: (recordId: number, params?: ReadIlsHoldableParams, options?: Parameters<typeof request>[1]) => Promise<IlsHoldableRead>;
+export declare const getAddIlsReviewUrl: (recordId: number) => string;
+/**
+ * Post a review to the library's OPAC, where its other borrowers see it.
+ *
+ * Distinct from a Mozaik review: this one lives on the library's system and
+ * is not moderated here.
+ * @summary Add Ils Review
+ */
+export declare const addIlsReview: (recordId: number, ilsReviewWrite: IlsReviewWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getAddIlsTagUrl: (recordId: number) => string;
+/**
+ * Tag a record in the library's catalogue.
+ * @summary Add Ils Tag
+ */
+export declare const addIlsTag: (recordId: number, ilsTagWrite: IlsTagWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getSignOutOfIlsUrl: () => string;
+/**
+ * Drop the link. Idempotent, and never fails on the library's account.
+ *
+ * Our copy of the session goes first. Telling PMB is best-effort: if the
+ * library is down, the patron is still signed out here, which is the part
+ * they asked for and the part that matters for a shared device.
+ * @summary Sign Out Of Ils
+ */
+export declare const signOutOfIls: (options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getSignInToIlsUrl: () => string;
+/**
+ * Link this patron to their library account with their card credentials.
+ *
+ * Replaces ``login``, ``login-md5`` and ``login-aes``: those are three ways to
+ * carry one password to a server of unknown vintage, and the connector
+ * negotiates between them — AES first, because it is the only one that does
+ * not hand the library a password it can replay.
+ *
+ * **The credentials are not stored.** They open an upstream session and are
+ * discarded; the session is what persists, and it expires. That is why there
+ * is no silent re-login anywhere below — a patron whose session lapses is
+ * asked again, because we deliberately cannot do it for them.
+ *
+ * ``401`` for a wrong card number or password — the patron's, at their
+ * library, not their Mozaik credentials.
+ * @summary Sign In To Ils
+ */
+export declare const signInToIls: (ilsSignInWrite: IlsSignInWrite, options?: Parameters<typeof request>[1]) => Promise<IlsStatusRead>;
+export declare const getReadIlsStatusUrl: () => string;
+/**
+ * Whether this library has a catalogue system, and whether we speak it.
+ *
+ * **Read this first.** Most libraries have no ILS, and a client that assumes
+ * otherwise renders a "my loans" tab that can only ever answer ``409``.
+ *
+ * Never 409s itself — "there is no integration" is the answer, not an error.
+ * @summary Read Ils Status
+ */
+export declare const readIlsStatus: (options?: Parameters<typeof request>[1]) => Promise<IlsStatusRead>;
+export declare const getListIlsSuggestionCategoriesUrl: () => string;
+/**
+ * Categories a purchase suggestion may name.
+ *
+ * The suggestion itself is not submitted here: PMB's OPAC borrower services
+ * expose the two vocabularies and no ``add_suggestion``, so the legacy could
+ * not submit one either. Carried because a client building a suggestion form
+ * needs them, and their absence would look like an oversight rather than the
+ * vendor's.
+ * @summary List Ils Suggestion Categories
+ */
+export declare const listIlsSuggestionCategories: (options?: Parameters<typeof request>[1]) => Promise<IlsSuggestionOptionListRead>;
+export declare const getListIlsSuggestionSourcesUrl: () => string;
+/**
+ * Sources a purchase suggestion may cite. See the note on categories.
+ * @summary List Ils Suggestion Sources
+ */
+export declare const listIlsSuggestionSources: (options?: Parameters<typeof request>[1]) => Promise<IlsSuggestionOptionListRead>;
+//#endregion
+//# sourceMappingURL=cvs-ils.d.ts.map