@learnorama/mozaik-sdk 0.1.0

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

@@ -0,0 +1,106 @@
+
+import { G as ReviewUpdateWrite, K as ReviewRead, M as SupplierGrantRead, Un as LastPositionWrite, ft as RatingUpdateWrite, hr as DocumentRead, mr as DocumentSearchWrite, vr as DocumentPage } from "../index-wL_20vR8.js";
+import { c as request } from "../client-BDwBZYB0.js";
+//#region src/api/cvs-documents/cvs-documents.d.ts
+export declare const getSearchDocumentsUrl: () => string;
+/**
+ * Search the CVS catalogue.
+ *
+ * ``POST`` because the legacy put the query in the body and the mobile clients
+ * send it that way. It is a read, so it stays safe: nothing here writes.
+ *
+ * Same division as ``/search``: the index ranks, PostgreSQL authorises. An
+ * index outage degrades to no results rather than to an unfiltered catalogue.
+ * @summary Search Documents
+ */
+export declare const searchDocuments: (documentSearchWrite: DocumentSearchWrite, options?: Parameters<typeof request>[1]) => Promise<DocumentPage>;
+export declare const getReadDocumentUrl: (docId: number) => string;
+/**
+ * One work, if this caller's contract reaches it.
+ *
+ * Missing until now, which was an oversight rather than a decision: search,
+ * rating, review and position all existed and there was no way to fetch the
+ * thing they act on. The legacy has no equivalent either — the app assembles a
+ * document sheet from whatever the menu endpoint already returned, which is why
+ * a deep link into a title has never worked properly.
+ * @summary Read Document
+ */
+export declare const readDocument: (docId: number, options?: Parameters<typeof request>[1]) => Promise<DocumentRead>;
+export declare const getOpenAtSupplierUrl: (docId: number) => string;
+/**
+ * Authorise this patron to open one title at the supplier hosting it.
+ *
+ * Replaces the legacy ``wstoken``: 4,878 lines dispatching on
+ * ``frn.plate_forme`` through 57 near-identical arms. The signing schemes
+ * reduce to eight (:class:`~app.models.enums.TokenFormula`) and the platform
+ * map to a table, so what is left here is the order of operations.
+ *
+ * **Entitle, seat, then sign** — the same order the streaming route uses, and
+ * for the same reason. A signature is cheap to produce and impossible to
+ * recall once it has left; a seat can be released. Signing first would mean a
+ * refused request had already handed a patron something that works.
+ *
+ * ``404`` when the caller is not entitled or the title does not exist — the
+ * two are deliberately indistinguishable, as everywhere else in this API.
+ * ``409`` when every seat is taken: the caller *is* entitled and should be
+ * offered "try later", not "buy a subscription". ``409`` too when the supplier
+ * sits on a platform nobody implemented — four do, and the legacy cannot serve
+ * them either, so the honest answer is that this title is not openable rather
+ * than a 500 from a missing branch.
+ *
+ * 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 getReadLastPositionUrl: (docId: number) => string;
+/**
+ * Where this patron got to, or ``0`` if they have not started.
+ *
+ * New: the legacy has no way to read the position back, so a client that lost
+ * its local state could never resume. Absent means not started, which is why
+ * the row is not created on read.
+ * @summary Read Last Position
+ */
+export declare const readLastPosition: (docId: number, options?: Parameters<typeof request>[1]) => Promise<LastPositionWrite>;
+export declare const getSetLastPositionUrl: (docId: number) => string;
+/**
+ * Record where this patron got to.
+ *
+ * A write, and the legacy declares it ``GET`` with the position in the query
+ * string — which makes resuming a book a cacheable idempotent read that mutates
+ * state, and puts it outside the CSRF layer for free.
+ *
+ * Stored in :class:`~app.models.activity.ReadingPosition`, which the products
+ * share — CVS and the partner reader today — so a member who reads across them
+ * keeps their place in one shape.
+ * @summary Set Last Position
+ */
+export declare const setLastPosition: (docId: number, lastPositionWrite: LastPositionWrite, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getRateDocumentUrl: (docId: number) => string;
+/**
+ * Rate a document. Idempotent — rating again replaces the earlier score.
+ *
+ * ``PUT`` on the rating sub-resource rather than the legacy
+ * ``POST /document/rating/update`` with the id in the body: the identifier
+ * belongs in the path, and "update" in a path names an operation in a position
+ * reserved for a resource.
+ * @summary Rate Document
+ */
+export declare const rateDocument: (docId: number, ratingUpdateWrite: RatingUpdateWrite, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getWriteReviewUrl: (docId: number) => string;
+/**
+ * Write or replace this patron's review of a document.
+ *
+ * One review per person per document, so this is a ``PUT`` on a singular
+ * sub-resource rather than a ``POST`` to a collection. The legacy had two routes
+ * — with and without an ``avisId`` — for what is one row.
+ *
+ * Every write resets the review to unpublished. An edit after moderation is a
+ * new thing to moderate, and carrying the old approval forward is how an
+ * approved review becomes a different text.
+ * @summary Write Review
+ */
+export declare const writeReview: (docId: number, reviewUpdateWrite: ReviewUpdateWrite, options?: Parameters<typeof request>[1]) => Promise<ReviewRead>;
+//#endregion
+//# sourceMappingURL=cvs-documents.d.ts.map

package/dist/api/cvs-documents.js

@@ -0,0 +1,208 @@
+
+import { r as request } from "../client-D3kMOcIr.js";
+//#region src/api/cvs-documents/cvs-documents.ts
+const getSearchDocumentsUrl = () => {
+	return `/cvs/documents/search`;
+};
+/**
+* Search the CVS catalogue.
+*
+* ``POST`` because the legacy put the query in the body and the mobile clients
+* send it that way. It is a read, so it stays safe: nothing here writes.
+*
+* Same division as ``/search``: the index ranks, PostgreSQL authorises. An
+* index outage degrades to no results rather than to an unfiltered catalogue.
+* @summary Search Documents
+*/
+const searchDocuments = async (documentSearchWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getSearchDocumentsUrl(), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(documentSearchWrite)
+	});
+};
+const getReadDocumentUrl = (docId) => {
+	return `/cvs/documents/${docId}`;
+};
+/**
+* One work, if this caller's contract reaches it.
+*
+* Missing until now, which was an oversight rather than a decision: search,
+* rating, review and position all existed and there was no way to fetch the
+* thing they act on. The legacy has no equivalent either — the app assembles a
+* document sheet from whatever the menu endpoint already returned, which is why
+* a deep link into a title has never worked properly.
+* @summary Read Document
+*/
+const readDocument = async (docId, options) => {
+	return request(getReadDocumentUrl(docId), {
+		...options,
+		method: "GET"
+	});
+};
+const getOpenAtSupplierUrl = (docId) => {
+	return `/cvs/documents/${docId}/grant`;
+};
+/**
+* Authorise this patron to open one title at the supplier hosting it.
+*
+* Replaces the legacy ``wstoken``: 4,878 lines dispatching on
+* ``frn.plate_forme`` through 57 near-identical arms. The signing schemes
+* reduce to eight (:class:`~app.models.enums.TokenFormula`) and the platform
+* map to a table, so what is left here is the order of operations.
+*
+* **Entitle, seat, then sign** — the same order the streaming route uses, and
+* for the same reason. A signature is cheap to produce and impossible to
+* recall once it has left; a seat can be released. Signing first would mean a
+* refused request had already handed a patron something that works.
+*
+* ``404`` when the caller is not entitled or the title does not exist — the
+* two are deliberately indistinguishable, as everywhere else in this API.
+* ``409`` when every seat is taken: the caller *is* entitled and should be
+* offered "try later", not "buy a subscription". ``409`` too when the supplier
+* sits on a platform nobody implemented — four do, and the legacy cannot serve
+* them either, so the honest answer is that this title is not openable rather
+* than a 500 from a missing branch.
+*
+* 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), {
+		...options,
+		method: "POST"
+	});
+};
+const getReadLastPositionUrl = (docId) => {
+	return `/cvs/documents/${docId}/position`;
+};
+/**
+* Where this patron got to, or ``0`` if they have not started.
+*
+* New: the legacy has no way to read the position back, so a client that lost
+* its local state could never resume. Absent means not started, which is why
+* the row is not created on read.
+* @summary Read Last Position
+*/
+const readLastPosition = async (docId, options) => {
+	return request(getReadLastPositionUrl(docId), {
+		...options,
+		method: "GET"
+	});
+};
+const getSetLastPositionUrl = (docId) => {
+	return `/cvs/documents/${docId}/position`;
+};
+/**
+* Record where this patron got to.
+*
+* A write, and the legacy declares it ``GET`` with the position in the query
+* string — which makes resuming a book a cacheable idempotent read that mutates
+* state, and puts it outside the CSRF layer for free.
+*
+* Stored in :class:`~app.models.activity.ReadingPosition`, which the products
+* share — CVS and the partner reader today — so a member who reads across them
+* keeps their place in one shape.
+* @summary Set Last Position
+*/
+const setLastPosition = async (docId, lastPositionWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getSetLastPositionUrl(docId), {
+		...options,
+		method: "PUT",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(lastPositionWrite)
+	});
+};
+const getRateDocumentUrl = (docId) => {
+	return `/cvs/documents/${docId}/rating`;
+};
+/**
+* Rate a document. Idempotent — rating again replaces the earlier score.
+*
+* ``PUT`` on the rating sub-resource rather than the legacy
+* ``POST /document/rating/update`` with the id in the body: the identifier
+* belongs in the path, and "update" in a path names an operation in a position
+* reserved for a resource.
+* @summary Rate Document
+*/
+const rateDocument = async (docId, ratingUpdateWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getRateDocumentUrl(docId), {
+		...options,
+		method: "PUT",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(ratingUpdateWrite)
+	});
+};
+const getWriteReviewUrl = (docId) => {
+	return `/cvs/documents/${docId}/review`;
+};
+/**
+* Write or replace this patron's review of a document.
+*
+* One review per person per document, so this is a ``PUT`` on a singular
+* sub-resource rather than a ``POST`` to a collection. The legacy had two routes
+* — with and without an ``avisId`` — for what is one row.
+*
+* Every write resets the review to unpublished. An edit after moderation is a
+* new thing to moderate, and carrying the old approval forward is how an
+* approved review becomes a different text.
+* @summary Write Review
+*/
+const writeReview = async (docId, reviewUpdateWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getWriteReviewUrl(docId), {
+		...options,
+		method: "PUT",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(reviewUpdateWrite)
+	});
+};
+//#endregion
+export { getOpenAtSupplierUrl, getRateDocumentUrl, getReadDocumentUrl, getReadLastPositionUrl, getSearchDocumentsUrl, getSetLastPositionUrl, getWriteReviewUrl, openAtSupplier, rateDocument, readDocument, readLastPosition, searchDocuments, setLastPosition, writeReview };
+
+//# sourceMappingURL=cvs-documents.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,53 @@
+
+import { rr as SelectionRead, tr as FavoriteListRead } from "../index-wL_20vR8.js";
+import { c as request } from "../client-BDwBZYB0.js";
+//#region src/api/cvs-favorites/cvs-favorites.d.ts
+export declare const getListCvsFavoritesUrl: () => string;
+/**
+ * The caller's favourites.
+ *
+ * Entitlement-filtered. A title the library has stopped licensing stays in the
+ * list — removing it silently would lose the patron's own curation over a
+ * contract change they had nothing to do with — but it is not returned here,
+ * because a client cannot open it. When the licence comes back, so does the
+ * entry.
+ * @summary List Cvs Favorites
+ */
+export declare const listCvsFavorites: (options?: Parameters<typeof request>[1]) => Promise<FavoriteListRead>;
+export declare const getRemoveCvsFavoriteUrl: (docId: number) => string;
+/**
+ * Remove a work from the caller's list. Idempotent.
+ *
+ * Scoped to ``kind = 8`` through the list lookup, so this can never delete a
+ * line out of the patron's loans or reservations — which live in the same two
+ * tables and would look identical to a query that only matched on
+ * ``(user_id, doc_id)``.
+ * @summary Remove Cvs Favorite
+ */
+export declare const removeCvsFavorite: (docId: number, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getAddCvsFavoriteUrl: (docId: number) => string;
+/**
+ * Add a work to the caller's list. Idempotent.
+ *
+ * ``PUT`` and ``DELETE`` on the item, rather than the legacy's single route
+ * answering both ``POST`` and ``DELETE`` on a path with a required
+ * ``{selectionId}`` its own handler declares optional.
+ *
+ * Not entitlement-gated. A patron may bookmark something their library has not
+ * licensed yet — that is a signal worth having, and it is what an acquisitions
+ * request is made of. Reaching the work is gated, at the point of reaching it.
+ * @summary Add Cvs Favorite
+ */
+export declare const addCvsFavorite: (docId: number, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getListSelectionsUrl: () => string;
+/**
+ * Every list this patron holds, of every kind.
+ *
+ * Read-only and deliberately unfiltered: a client showing "my loans" and "my
+ * list" side by side needs to know which is which, and hiding the ILS-mirrored
+ * kinds would only make it guess.
+ * @summary List Selections
+ */
+export declare const listSelections: (options?: Parameters<typeof request>[1]) => Promise<SelectionRead[]>;
+//#endregion
+//# sourceMappingURL=cvs-favorites.d.ts.map

package/dist/api/cvs-favorites.js

@@ -0,0 +1,82 @@
+
+import { r as request } from "../client-D3kMOcIr.js";
+//#region src/api/cvs-favorites/cvs-favorites.ts
+const getListCvsFavoritesUrl = () => {
+	return `/cvs/favorites`;
+};
+/**
+* The caller's favourites.
+*
+* Entitlement-filtered. A title the library has stopped licensing stays in the
+* list — removing it silently would lose the patron's own curation over a
+* contract change they had nothing to do with — but it is not returned here,
+* because a client cannot open it. When the licence comes back, so does the
+* entry.
+* @summary List Cvs Favorites
+*/
+const listCvsFavorites = async (options) => {
+	return request(getListCvsFavoritesUrl(), {
+		...options,
+		method: "GET"
+	});
+};
+const getRemoveCvsFavoriteUrl = (docId) => {
+	return `/cvs/favorites/${docId}`;
+};
+/**
+* Remove a work from the caller's list. Idempotent.
+*
+* Scoped to ``kind = 8`` through the list lookup, so this can never delete a
+* line out of the patron's loans or reservations — which live in the same two
+* tables and would look identical to a query that only matched on
+* ``(user_id, doc_id)``.
+* @summary Remove Cvs Favorite
+*/
+const removeCvsFavorite = async (docId, options) => {
+	return request(getRemoveCvsFavoriteUrl(docId), {
+		...options,
+		method: "DELETE"
+	});
+};
+const getAddCvsFavoriteUrl = (docId) => {
+	return `/cvs/favorites/${docId}`;
+};
+/**
+* Add a work to the caller's list. Idempotent.
+*
+* ``PUT`` and ``DELETE`` on the item, rather than the legacy's single route
+* answering both ``POST`` and ``DELETE`` on a path with a required
+* ``{selectionId}`` its own handler declares optional.
+*
+* Not entitlement-gated. A patron may bookmark something their library has not
+* licensed yet — that is a signal worth having, and it is what an acquisitions
+* request is made of. Reaching the work is gated, at the point of reaching it.
+* @summary Add Cvs Favorite
+*/
+const addCvsFavorite = async (docId, options) => {
+	return request(getAddCvsFavoriteUrl(docId), {
+		...options,
+		method: "PUT"
+	});
+};
+const getListSelectionsUrl = () => {
+	return `/cvs/lists`;
+};
+/**
+* Every list this patron holds, of every kind.
+*
+* Read-only and deliberately unfiltered: a client showing "my loans" and "my
+* list" side by side needs to know which is which, and hiding the ILS-mirrored
+* kinds would only make it guess.
+* @summary List Selections
+*/
+const listSelections = async (options) => {
+	return request(getListSelectionsUrl(), {
+		...options,
+		method: "GET"
+	});
+};
+//#endregion
+export { addCvsFavorite, getAddCvsFavoriteUrl, getListCvsFavoritesUrl, getListSelectionsUrl, getRemoveCvsFavoriteUrl, listCvsFavorites, listSelections, removeCvsFavorite };
+
+//# sourceMappingURL=cvs-favorites.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,59 @@
+
+import { Ur as BorrowWrite, nn as LoanPage, rn as LoanRead, yn as ListLoansParams } from "../index-wL_20vR8.js";
+import { c as request } from "../client-BDwBZYB0.js";
+//#region src/api/cvs-loans/cvs-loans.d.ts
+export declare const getListLoansUrl: (params?: ListLoansParams) => string;
+/**
+ * What this caller currently holds (and optionally what they have returned).
+ *
+ * Replaces ``/download/details``, which took a ``downloadid`` and answered about
+ * one loan at a time — so a client rebuilding its shelf after reinstalling made
+ * one request per title, and had no way to discover the ids in the first place.
+ * @summary List Loans
+ */
+export declare const listLoans: (params?: ListLoansParams, options?: Parameters<typeof request>[1]) => Promise<LoanPage>;
+export declare const getBorrowUrl: () => string;
+/**
+ * Borrow a work.
+ *
+ * The order matters and is the whole point of the entitlement model:
+ *
+ * 1. **Entitled?** — is this act permitted on this work under a live contract.
+ * 2. **A seat free?** — ``max_concurrent`` counted from unreturned loans.
+ * 3. **Units left?** — reserved in Redis *before* the row is written, so a
+ *    refusal costs no database work.
+ * 4. **Append.** The ledger row is the loan.
+ *
+ * Idempotent on ``request_key``: a retried borrow returns the loan the first
+ * attempt created rather than taking a second copy of the same title.
+ * @summary Borrow
+ */
+export declare const borrow: (borrowWrite: BorrowWrite, options?: Parameters<typeof request>[1]) => Promise<LoanRead>;
+export declare const getReturnLoanUrl: (loanId: number) => string;
+/**
+ * Give a loan back early, freeing its seat. Idempotent.
+ *
+ * Returning something already returned is ``204``: the caller wanted it back on
+ * the shelf and it is on the shelf. The legacy answered an error, which meant a
+ * retried return looked like a failure and clients stopped retrying.
+ *
+ * The unit stays spent — see the module docstring. Only the seat comes back.
+ * @summary Return Loan
+ */
+export declare const returnLoan: (loanId: number, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getExtendLoanUrl: (loanId: number) => string;
+/**
+ * Prolong a loan.
+ *
+ * Bounded by the grant's ``max_extensions`` — the legacy's ``nb_extend`` — and
+ * refused once the loan has been returned or has lapsed. Extending something
+ * that already expired is not an extension, it is a new loan, and it should
+ * spend a new unit rather than quietly avoid one.
+ *
+ * Not idempotent, deliberately: two extension requests mean two extensions, and
+ * a client that wants exactly one should not send two.
+ * @summary Extend Loan
+ */
+export declare const extendLoan: (loanId: number, options?: Parameters<typeof request>[1]) => Promise<LoanRead>;
+//#endregion
+//# sourceMappingURL=cvs-loans.d.ts.map

package/dist/api/cvs-loans.js

@@ -0,0 +1,106 @@
+
+import { r as request } from "../client-D3kMOcIr.js";
+//#region src/api/cvs-loans/cvs-loans.ts
+const getListLoansUrl = (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/loans?${stringifiedParams}` : `/cvs/loans`;
+};
+/**
+* What this caller currently holds (and optionally what they have returned).
+*
+* Replaces ``/download/details``, which took a ``downloadid`` and answered about
+* one loan at a time — so a client rebuilding its shelf after reinstalling made
+* one request per title, and had no way to discover the ids in the first place.
+* @summary List Loans
+*/
+const listLoans = async (params, options) => {
+	return request(getListLoansUrl(params), {
+		...options,
+		method: "GET"
+	});
+};
+const getBorrowUrl = () => {
+	return `/cvs/loans`;
+};
+/**
+* Borrow a work.
+*
+* The order matters and is the whole point of the entitlement model:
+*
+* 1. **Entitled?** — is this act permitted on this work under a live contract.
+* 2. **A seat free?** — ``max_concurrent`` counted from unreturned loans.
+* 3. **Units left?** — reserved in Redis *before* the row is written, so a
+*    refusal costs no database work.
+* 4. **Append.** The ledger row is the loan.
+*
+* Idempotent on ``request_key``: a retried borrow returns the loan the first
+* attempt created rather than taking a second copy of the same title.
+* @summary Borrow
+*/
+const borrow = async (borrowWrite, options) => {
+	const getHeaders = (h) => {
+		if (!h) return {};
+		if (h instanceof Headers) return Object.fromEntries(h.entries());
+		if (Symbol.iterator in h) return Object.fromEntries(Array.from(h, (entry) => Array.from(entry)));
+		const headers = {};
+		for (const [name, value] of Object.entries(h)) if (value !== void 0) headers[name] = value;
+		return headers;
+	};
+	return request(getBorrowUrl(), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(borrowWrite)
+	});
+};
+const getReturnLoanUrl = (loanId) => {
+	return `/cvs/loans/${loanId}`;
+};
+/**
+* Give a loan back early, freeing its seat. Idempotent.
+*
+* Returning something already returned is ``204``: the caller wanted it back on
+* the shelf and it is on the shelf. The legacy answered an error, which meant a
+* retried return looked like a failure and clients stopped retrying.
+*
+* The unit stays spent — see the module docstring. Only the seat comes back.
+* @summary Return Loan
+*/
+const returnLoan = async (loanId, options) => {
+	return request(getReturnLoanUrl(loanId), {
+		...options,
+		method: "DELETE"
+	});
+};
+const getExtendLoanUrl = (loanId) => {
+	return `/cvs/loans/${loanId}/extensions`;
+};
+/**
+* Prolong a loan.
+*
+* Bounded by the grant's ``max_extensions`` — the legacy's ``nb_extend`` — and
+* refused once the loan has been returned or has lapsed. Extending something
+* that already expired is not an extension, it is a new loan, and it should
+* spend a new unit rather than quietly avoid one.
+*
+* Not idempotent, deliberately: two extension requests mean two extensions, and
+* a client that wants exactly one should not send two.
+* @summary Extend Loan
+*/
+const extendLoan = async (loanId, options) => {
+	return request(getExtendLoanUrl(loanId), {
+		...options,
+		method: "POST"
+	});
+};
+//#endregion
+export { borrow, extendLoan, getBorrowUrl, getExtendLoanUrl, getListLoansUrl, getReturnLoanUrl, listLoans, returnLoan };
+
+//# sourceMappingURL=cvs-loans.js.map