@learnorama/mozaik-sdk 0.1.0

package/dist/api/tutoring-practitioner.js

@@ -0,0 +1,110 @@
+
+import { r as request } from "../client-D3kMOcIr.js";
+//#region src/api/tutoring-practitioner/tutoring-practitioner.ts
+const getAnswerRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/answer`;
+};
+/**
+* Deliver the answer.
+*
+* The body is stored as the answer and any named attachments are re-roled to
+* ``answer`` — they were uploaded against this request, so no id from another
+* request can be attached here.
+* @summary Answer Request
+*/
+const answerRequest = async (requestId, tutoringAnswerWrite, 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(getAnswerRequestUrl(requestId), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(tutoringAnswerWrite)
+	});
+};
+const getClaimRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/claim`;
+};
+/**
+* Take a dispatched request.
+*
+* ``409`` if somebody else already holds it. The check and the write are one
+* statement so that two practitioners hitting claim in the same instant cannot
+* both win — the legacy reads then writes, so both do.
+* @summary Claim Request
+*/
+const claimRequest = async (requestId, options) => {
+	return request(getClaimRequestUrl(requestId), {
+		...options,
+		method: "POST"
+	});
+};
+const getCloseRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/close`;
+};
+/**
+* Close a request that will not be answered, with a reason.
+*
+* A dispatcher's job rather than a practitioner's: giving up on a request is a
+* decision about the queue, and the person who could not answer it is not the
+* person who should decide nobody will.
+* @summary Close Request
+*/
+const closeRequest = async (requestId, tutoringCloseWrite, 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(getCloseRequestUrl(requestId), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(tutoringCloseWrite)
+	});
+};
+const getOpenRoomUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/room`;
+};
+/**
+* Open the room for a live request. The practitioner decides when.
+*
+* Deliberately an explicit action rather than a side effect of claiming, which
+* is what Prof Express does: the teacher presses a button in their own queue,
+* and ``createTeacherVedamoClasssroom`` refuses unless a teacher is assigned.
+* A room provisioned at dispatch is a room the pupil joins alone.
+*
+* Only the assigned practitioner may open it, and only once — a second call
+* returns the room that is already open rather than provisioning another. The
+* legacy has no such check, so pressing its button twice orphans a room the
+* pupil may already hold a link to.
+*
+* ``409`` for a channel with nothing to join, and for a request nobody has
+* claimed.
+* @summary Open Room
+*/
+const openRoom = async (requestId, options) => {
+	return request(getOpenRoomUrl(requestId), {
+		...options,
+		method: "POST"
+	});
+};
+//#endregion
+export { answerRequest, claimRequest, closeRequest, getAnswerRequestUrl, getClaimRequestUrl, getCloseRequestUrl, getOpenRoomUrl, openRoom };
+
+//# sourceMappingURL=tutoring-practitioner.js.map

package/dist/api/tutoring-practitioner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tutoring-practitioner.js","names":[],"sources":["../../src/api/tutoring-practitioner/tutoring-practitioner.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  TutoringAnswerWrite,\n  TutoringCloseWrite,\n  TutoringRoomRead\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getAnswerRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/answer`\n}\n\n/**\n * Deliver the answer.\n *\n * The body is stored as the answer and any named attachments are re-roled to\n * ``answer`` — they were uploaded against this request, so no id from another\n * request can be attached here.\n * @summary Answer Request\n */\nexport const answerRequest = async (requestId: number,\n    tutoringAnswerWrite: TutoringAnswerWrite, 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>(getAnswerRequestUrl(requestId),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(tutoringAnswerWrite)\n  }\n);}\n\n\nexport const getClaimRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/claim`\n}\n\n/**\n * Take a dispatched request.\n *\n * ``409`` if somebody else already holds it. The check and the write are one\n * statement so that two practitioners hitting claim in the same instant cannot\n * both win — the legacy reads then writes, so both do.\n * @summary Claim Request\n */\nexport const claimRequest = async (requestId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getClaimRequestUrl(requestId),\n  {\n    ...options,\n    method: 'POST'\n\n\n  }\n);}\n\n\nexport const getCloseRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/close`\n}\n\n/**\n * Close a request that will not be answered, with a reason.\n *\n * A dispatcher's job rather than a practitioner's: giving up on a request is a\n * decision about the queue, and the person who could not answer it is not the\n * person who should decide nobody will.\n * @summary Close Request\n */\nexport const closeRequest = async (requestId: number,\n    tutoringCloseWrite: TutoringCloseWrite, 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>(getCloseRequestUrl(requestId),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(tutoringCloseWrite)\n  }\n);}\n\n\nexport const getOpenRoomUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/room`\n}\n\n/**\n * Open the room for a live request. The practitioner decides when.\n *\n * Deliberately an explicit action rather than a side effect of claiming, which\n * is what Prof Express does: the teacher presses a button in their own queue,\n * and ``createTeacherVedamoClasssroom`` refuses unless a teacher is assigned.\n * A room provisioned at dispatch is a room the pupil joins alone.\n *\n * Only the assigned practitioner may open it, and only once — a second call\n * returns the room that is already open rather than provisioning another. The\n * legacy has no such check, so pressing its button twice orphans a room the\n * pupil may already hold a link to.\n *\n * ``409`` for a channel with nothing to join, and for a request nobody has\n * claimed.\n * @summary Open Room\n */\nexport const openRoom = async (requestId: number, options?: Parameters<typeof request>[1]): Promise<TutoringRoomRead> => {\n\n  return request<TutoringRoomRead>(getOpenRoomUrl(requestId),\n  {\n    ...options,\n    method: 'POST'\n\n\n  }\n);}\n\n\n"],"mappings":";;;AAeA,MAAa,uBAAuB,cAAuB;CAKzD,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;AAUA,MAAa,gBAAgB,OAAO,WAChC,qBAA0C,YAA2D;CAErG,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,oBAAoB,SAAS,GAChD;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,cAAuB;CAKxD,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;AAUA,MAAa,eAAe,OAAO,WAAmB,YAA2D;CAE/G,OAAO,QAAc,mBAAmB,SAAS,GACjD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,sBAAsB,cAAuB;CAKxD,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;AAUA,MAAa,eAAe,OAAO,WAC/B,oBAAwC,YAA2D;CAEnG,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,SAAS,GAC/C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,kBAAkB;CACzC,CACF;AAAE;AAGF,MAAa,kBAAkB,cAAuB;CAKpD,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;;;;;;;;;;AAmBA,MAAa,WAAW,OAAO,WAAmB,YAAuE;CAEvH,OAAO,QAA0B,eAAe,SAAS,GACzD;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE"}

package/dist/api/tutoring-requests.d.ts

@@ -0,0 +1,86 @@
+
+import { Gr as BodyUploadAttachment, a as TutoringRequestWrite, c as TutoringRequestRead, hn as ListMyRequestsParams, p as TutoringFeedbackWrite, s as TutoringRequestPage, x as TutoringAttachmentRead } from "../index-wL_20vR8.js";
+import { c as request } from "../client-BDwBZYB0.js";
+//#region src/api/tutoring-requests/tutoring-requests.d.ts
+export declare const getListMyRequestsUrl: (params?: ListMyRequestsParams) => string;
+/**
+ * The caller's own requests, newest first.
+ *
+ * Includes requests they submitted for a child profile, which is what the
+ * ``requested_by_id`` half of the predicate is for — a parent's list should not
+ * go empty the moment they ask on somebody else's behalf.
+ * @summary List My Requests
+ */
+export declare const listMyRequests: (params?: ListMyRequestsParams, options?: Parameters<typeof request>[1]) => Promise<TutoringRequestPage>;
+export declare const getSubmitRequestUrl: () => string;
+/**
+ * Ask for help.
+ *
+ * Debits the tenant's tutoring entitlement, which is what makes this a ``409``
+ * when the allowance is spent rather than a queued request nobody may answer.
+ * ``403`` from the entitlement layer is reported as ``404`` for the subject, per
+ * the convention the loan routes already follow.
+ *
+ * ``onBehalfOfId`` must name a profile of the caller. Anything else is ``403``:
+ * the legacy accepts a ``user_id`` in the body and trusts it, which is an
+ * authorization decision made by whoever wrote the client.
+ * @summary Submit Request
+ */
+export declare const submitRequest: (tutoringRequestWrite: TutoringRequestWrite, options?: Parameters<typeof request>[1]) => Promise<TutoringRequestRead>;
+export declare const getGetRequestUrl: (requestId: number) => string;
+/**
+ * One of the caller's own requests, with signed links to its files.
+ * @summary Get Request
+ */
+export declare const getRequest: (requestId: number, options?: Parameters<typeof request>[1]) => Promise<TutoringRequestRead>;
+export declare const getUploadAttachmentUrl: (requestId: number) => string;
+/**
+ * Attach a file to a request. One per call.
+ *
+ * One per call rather than an array, deliberately. A pupil photographing four
+ * pages on a phone connection wants three of them to survive the fourth
+ * timing out, and the legacy's ``documents[]`` array is all-or-nothing — with
+ * no cap on how many, so a single request can be arbitrarily large.
+ *
+ * The role follows from who is asking: the pupil is attaching to a question,
+ * the assigned practitioner to an answer. Nobody declares it, so nobody can
+ * claim the wrong one.
+ *
+ * ``415`` for a format we do not accept, ``413`` for a file over the ceiling,
+ * ``409`` once the per-request cap is reached, and ``404`` for a request that
+ * is not the caller's.
+ * @summary Upload Attachment
+ */
+export declare const uploadAttachment: (requestId: number, bodyUploadAttachment: BodyUploadAttachment, options?: Parameters<typeof request>[1]) => Promise<TutoringAttachmentRead>;
+export declare const getDeleteAttachmentUrl: (requestId: number, attachmentId: number) => string;
+/**
+ * Remove a file the caller uploaded.
+ *
+ * Only the uploader, and only while the request is still open — a file that
+ * formed part of a delivered answer is part of the record.
+ *
+ * The object goes and the row goes with it: this is a mistaken upload being
+ * withdrawn, not a retention event. Retention is the bucket's lifecycle rule,
+ * which removes objects and leaves rows behind.
+ * @summary Delete Attachment
+ */
+export declare const deleteAttachment: (requestId: number, attachmentId: number, options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getCancelRequestUrl: (requestId: number) => string;
+/**
+ * Withdraw a request the caller asked.
+ *
+ * The debit is **not** reversed. A pupil who asks and withdraws has occupied a
+ * dispatcher's attention, and refunding it would make cancel-and-resubmit a way
+ * around the allowance. If a tenant should get the unit back, that is a credit
+ * somebody grants, which is a different act with a different audit trail.
+ * @summary Cancel Request
+ */
+export declare const cancelRequest: (requestId: number, options?: Parameters<typeof request>[1]) => Promise<TutoringRequestRead>;
+export declare const getRateRequestUrl: (requestId: number) => string;
+/**
+ * Rate the answer. One rating per request, enforced by the table.
+ * @summary Rate Request
+ */
+export declare const rateRequest: (requestId: number, tutoringFeedbackWrite: TutoringFeedbackWrite, options?: Parameters<typeof request>[1]) => Promise<void>;
+//#endregion
+//# sourceMappingURL=tutoring-requests.d.ts.map

package/dist/api/tutoring-requests.js

@@ -0,0 +1,176 @@
+
+import { r as request } from "../client-D3kMOcIr.js";
+//#region src/api/tutoring-requests/tutoring-requests.ts
+const getListMyRequestsUrl = (params) => {
+	const normalizedParams = new URLSearchParams();
+	Object.entries(params || {}).forEach(([key, value]) => {
+		if (Array.isArray(value) && ["status"].includes(key)) {
+			value.forEach((v) => {
+				normalizedParams.append(key, v === null ? "null" : String(v));
+			});
+			return;
+		}
+		if (value !== void 0) normalizedParams.append(key, value === null ? "null" : String(value));
+	});
+	const stringifiedParams = normalizedParams.toString();
+	return stringifiedParams.length > 0 ? `/tutoring/requests?${stringifiedParams}` : `/tutoring/requests`;
+};
+/**
+* The caller's own requests, newest first.
+*
+* Includes requests they submitted for a child profile, which is what the
+* ``requested_by_id`` half of the predicate is for — a parent's list should not
+* go empty the moment they ask on somebody else's behalf.
+* @summary List My Requests
+*/
+const listMyRequests = async (params, options) => {
+	return request(getListMyRequestsUrl(params), {
+		...options,
+		method: "GET"
+	});
+};
+const getSubmitRequestUrl = () => {
+	return `/tutoring/requests`;
+};
+/**
+* Ask for help.
+*
+* Debits the tenant's tutoring entitlement, which is what makes this a ``409``
+* when the allowance is spent rather than a queued request nobody may answer.
+* ``403`` from the entitlement layer is reported as ``404`` for the subject, per
+* the convention the loan routes already follow.
+*
+* ``onBehalfOfId`` must name a profile of the caller. Anything else is ``403``:
+* the legacy accepts a ``user_id`` in the body and trusts it, which is an
+* authorization decision made by whoever wrote the client.
+* @summary Submit Request
+*/
+const submitRequest = async (tutoringRequestWrite, 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(getSubmitRequestUrl(), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(tutoringRequestWrite)
+	});
+};
+const getGetRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}`;
+};
+/**
+* One of the caller's own requests, with signed links to its files.
+* @summary Get Request
+*/
+const getRequest = async (requestId, options) => {
+	return request(getGetRequestUrl(requestId), {
+		...options,
+		method: "GET"
+	});
+};
+const getUploadAttachmentUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/attachments`;
+};
+/**
+* Attach a file to a request. One per call.
+*
+* One per call rather than an array, deliberately. A pupil photographing four
+* pages on a phone connection wants three of them to survive the fourth
+* timing out, and the legacy's ``documents[]`` array is all-or-nothing — with
+* no cap on how many, so a single request can be arbitrarily large.
+*
+* The role follows from who is asking: the pupil is attaching to a question,
+* the assigned practitioner to an answer. Nobody declares it, so nobody can
+* claim the wrong one.
+*
+* ``415`` for a format we do not accept, ``413`` for a file over the ceiling,
+* ``409`` once the per-request cap is reached, and ``404`` for a request that
+* is not the caller's.
+* @summary Upload Attachment
+*/
+const uploadAttachment = async (requestId, bodyUploadAttachment, options) => {
+	const formData = new FormData();
+	formData.append(`file`, bodyUploadAttachment.file);
+	return request(getUploadAttachmentUrl(requestId), {
+		...options,
+		method: "POST",
+		body: formData
+	});
+};
+const getDeleteAttachmentUrl = (requestId, attachmentId) => {
+	return `/tutoring/requests/${requestId}/attachments/${attachmentId}`;
+};
+/**
+* Remove a file the caller uploaded.
+*
+* Only the uploader, and only while the request is still open — a file that
+* formed part of a delivered answer is part of the record.
+*
+* The object goes and the row goes with it: this is a mistaken upload being
+* withdrawn, not a retention event. Retention is the bucket's lifecycle rule,
+* which removes objects and leaves rows behind.
+* @summary Delete Attachment
+*/
+const deleteAttachment = async (requestId, attachmentId, options) => {
+	return request(getDeleteAttachmentUrl(requestId, attachmentId), {
+		...options,
+		method: "DELETE"
+	});
+};
+const getCancelRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/cancel`;
+};
+/**
+* Withdraw a request the caller asked.
+*
+* The debit is **not** reversed. A pupil who asks and withdraws has occupied a
+* dispatcher's attention, and refunding it would make cancel-and-resubmit a way
+* around the allowance. If a tenant should get the unit back, that is a credit
+* somebody grants, which is a different act with a different audit trail.
+* @summary Cancel Request
+*/
+const cancelRequest = async (requestId, options) => {
+	return request(getCancelRequestUrl(requestId), {
+		...options,
+		method: "POST"
+	});
+};
+const getRateRequestUrl = (requestId) => {
+	return `/tutoring/requests/${requestId}/feedback`;
+};
+/**
+* Rate the answer. One rating per request, enforced by the table.
+* @summary Rate Request
+*/
+const rateRequest = async (requestId, tutoringFeedbackWrite, 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(getRateRequestUrl(requestId), {
+		...options,
+		method: "POST",
+		headers: {
+			"Content-Type": "application/json",
+			...getHeaders(options?.headers)
+		},
+		body: JSON.stringify(tutoringFeedbackWrite)
+	});
+};
+//#endregion
+export { cancelRequest, deleteAttachment, getCancelRequestUrl, getDeleteAttachmentUrl, getGetRequestUrl, getListMyRequestsUrl, getRateRequestUrl, getRequest, getSubmitRequestUrl, getUploadAttachmentUrl, listMyRequests, rateRequest, submitRequest, uploadAttachment };
+
+//# sourceMappingURL=tutoring-requests.js.map

package/dist/api/tutoring-requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tutoring-requests.js","names":[],"sources":["../../src/api/tutoring-requests/tutoring-requests.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  BodyUploadAttachment,\n  ListMyRequestsParams,\n  TutoringAttachmentRead,\n  TutoringFeedbackWrite,\n  TutoringRequestPage,\n  TutoringRequestRead,\n  TutoringRequestWrite\n} from '../../models';\n\nimport { request } from '../../client';\n\nexport const getListMyRequestsUrl = (params?: ListMyRequestsParams,) => {\n  const normalizedParams = new URLSearchParams();\n\n  Object.entries(params || {}).forEach(([key, value]) => {\n    const explodeParameters = [\"status\"];\n\n    if (Array.isArray(value) && explodeParameters.includes(key)) {\n      value.forEach((v) => {\n        normalizedParams.append(key, v === null ? 'null' : String(v));\n      });\n      return;\n    }\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 ? `/tutoring/requests?${stringifiedParams}` : `/tutoring/requests`\n}\n\n/**\n * The caller's own requests, newest first.\n *\n * Includes requests they submitted for a child profile, which is what the\n * ``requested_by_id`` half of the predicate is for — a parent's list should not\n * go empty the moment they ask on somebody else's behalf.\n * @summary List My Requests\n */\nexport const listMyRequests = async (params?: ListMyRequestsParams, options?: Parameters<typeof request>[1]): Promise<TutoringRequestPage> => {\n\n  return request<TutoringRequestPage>(getListMyRequestsUrl(params),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getSubmitRequestUrl = () => {\n\n\n\n\n  return `/tutoring/requests`\n}\n\n/**\n * Ask for help.\n *\n * Debits the tenant's tutoring entitlement, which is what makes this a ``409``\n * when the allowance is spent rather than a queued request nobody may answer.\n * ``403`` from the entitlement layer is reported as ``404`` for the subject, per\n * the convention the loan routes already follow.\n *\n * ``onBehalfOfId`` must name a profile of the caller. Anything else is ``403``:\n * the legacy accepts a ``user_id`` in the body and trusts it, which is an\n * authorization decision made by whoever wrote the client.\n * @summary Submit Request\n */\nexport const submitRequest = async (tutoringRequestWrite: TutoringRequestWrite, options?: Parameters<typeof request>[1]): Promise<TutoringRequestRead> => {\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<TutoringRequestRead>(getSubmitRequestUrl(),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(tutoringRequestWrite)\n  }\n);}\n\n\nexport const getGetRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}`\n}\n\n/**\n * One of the caller's own requests, with signed links to its files.\n * @summary Get Request\n */\nexport const getRequest = async (requestId: number, options?: Parameters<typeof request>[1]): Promise<TutoringRequestRead> => {\n\n  return request<TutoringRequestRead>(getGetRequestUrl(requestId),\n  {\n    ...options,\n    method: 'GET'\n\n\n  }\n);}\n\n\nexport const getUploadAttachmentUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/attachments`\n}\n\n/**\n * Attach a file to a request. One per call.\n *\n * One per call rather than an array, deliberately. A pupil photographing four\n * pages on a phone connection wants three of them to survive the fourth\n * timing out, and the legacy's ``documents[]`` array is all-or-nothing — with\n * no cap on how many, so a single request can be arbitrarily large.\n *\n * The role follows from who is asking: the pupil is attaching to a question,\n * the assigned practitioner to an answer. Nobody declares it, so nobody can\n * claim the wrong one.\n *\n * ``415`` for a format we do not accept, ``413`` for a file over the ceiling,\n * ``409`` once the per-request cap is reached, and ``404`` for a request that\n * is not the caller's.\n * @summary Upload Attachment\n */\nexport const uploadAttachment = async (requestId: number,\n    bodyUploadAttachment: BodyUploadAttachment, options?: Parameters<typeof request>[1]): Promise<TutoringAttachmentRead> => {\n    const formData = new FormData();\nformData.append(`file`, bodyUploadAttachment.file);\n\n  return request<TutoringAttachmentRead>(getUploadAttachmentUrl(requestId),\n  {\n    ...options,\n    method: 'POST'\n    ,\n    body: formData\n  }\n);}\n\n\nexport const getDeleteAttachmentUrl = (requestId: number,\n    attachmentId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/attachments/${attachmentId}`\n}\n\n/**\n * Remove a file the caller uploaded.\n *\n * Only the uploader, and only while the request is still open — a file that\n * formed part of a delivered answer is part of the record.\n *\n * The object goes and the row goes with it: this is a mistaken upload being\n * withdrawn, not a retention event. Retention is the bucket's lifecycle rule,\n * which removes objects and leaves rows behind.\n * @summary Delete Attachment\n */\nexport const deleteAttachment = async (requestId: number,\n    attachmentId: number, options?: Parameters<typeof request>[1]): Promise<void> => {\n\n  return request<void>(getDeleteAttachmentUrl(requestId,attachmentId),\n  {\n    ...options,\n    method: 'DELETE'\n\n\n  }\n);}\n\n\nexport const getCancelRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/cancel`\n}\n\n/**\n * Withdraw a request the caller asked.\n *\n * The debit is **not** reversed. A pupil who asks and withdraws has occupied a\n * dispatcher's attention, and refunding it would make cancel-and-resubmit a way\n * around the allowance. If a tenant should get the unit back, that is a credit\n * somebody grants, which is a different act with a different audit trail.\n * @summary Cancel Request\n */\nexport const cancelRequest = async (requestId: number, options?: Parameters<typeof request>[1]): Promise<TutoringRequestRead> => {\n\n  return request<TutoringRequestRead>(getCancelRequestUrl(requestId),\n  {\n    ...options,\n    method: 'POST'\n\n\n  }\n);}\n\n\nexport const getRateRequestUrl = (requestId: number,) => {\n\n\n\n\n  return `/tutoring/requests/${requestId}/feedback`\n}\n\n/**\n * Rate the answer. One rating per request, enforced by the table.\n * @summary Rate Request\n */\nexport const rateRequest = async (requestId: number,\n    tutoringFeedbackWrite: TutoringFeedbackWrite, 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>(getRateRequestUrl(requestId),\n  {\n    ...options,\n    method: 'POST',\n    headers: { 'Content-Type': 'application/json', ...getHeaders(options?.headers) },\n    body: JSON.stringify(tutoringFeedbackWrite)\n  }\n);}\n\n\n"],"mappings":";;;AAmBA,MAAa,wBAAwB,WAAmC;CACtE,MAAM,mBAAmB,IAAI,gBAAgB;CAE7C,OAAO,QAAQ,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,WAAW;EAGrD,IAAI,MAAM,QAAQ,KAAK,KAAK,CAFD,QAEiB,CAAC,CAAC,SAAS,GAAG,GAAG;GAC3D,MAAM,SAAS,MAAM;IACnB,iBAAiB,OAAO,KAAK,MAAM,OAAO,SAAS,OAAO,CAAC,CAAC;GAC9D,CAAC;GACD;EACF;EAEA,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,sBAAsB,sBAAsB;AACpF;;;;;;;;;AAUA,MAAa,iBAAiB,OAAO,QAA+B,YAA0E;CAE5I,OAAO,QAA6B,qBAAqB,MAAM,GAC/D;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,4BAA4B;CAKvC,OAAO;AACT;;;;;;;;;;;;;;AAeA,MAAa,gBAAgB,OAAO,sBAA4C,YAA0E;CAEtJ,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,QAA6B,oBAAoB,GACtD;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,oBAAoB;CAC3C,CACF;AAAE;AAGF,MAAa,oBAAoB,cAAuB;CAKtD,OAAO,sBAAsB;AAC/B;;;;;AAMA,MAAa,aAAa,OAAO,WAAmB,YAA0E;CAE5H,OAAO,QAA6B,iBAAiB,SAAS,GAC9D;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,0BAA0B,cAAuB;CAK5D,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;;;;;;;;;;AAmBA,MAAa,mBAAmB,OAAO,WACnC,sBAA4C,YAA6E;CACzH,MAAM,WAAW,IAAI,SAAS;CAClC,SAAS,OAAO,QAAQ,qBAAqB,IAAI;CAE/C,OAAO,QAAgC,uBAAuB,SAAS,GACvE;EACE,GAAG;EACH,QAAQ;EAER,MAAM;CACR,CACF;AAAE;AAGF,MAAa,0BAA0B,WACnC,iBAA0B;CAK5B,OAAO,sBAAsB,UAAU,eAAe;AACxD;;;;;;;;;;;;AAaA,MAAa,mBAAmB,OAAO,WACnC,cAAsB,YAA2D;CAEnF,OAAO,QAAc,uBAAuB,WAAU,YAAY,GAClE;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,uBAAuB,cAAuB;CAKzD,OAAO,sBAAsB,UAAU;AACzC;;;;;;;;;;AAWA,MAAa,gBAAgB,OAAO,WAAmB,YAA0E;CAE/H,OAAO,QAA6B,oBAAoB,SAAS,GACjE;EACE,GAAG;EACH,QAAQ;CAGV,CACF;AAAE;AAGF,MAAa,qBAAqB,cAAuB;CAKvD,OAAO,sBAAsB,UAAU;AACzC;;;;;AAMA,MAAa,cAAc,OAAO,WAC9B,uBAA8C,YAA2D;CAEzG,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,kBAAkB,SAAS,GAC9C;EACE,GAAG;EACH,QAAQ;EACR,SAAS;GAAE,gBAAgB;GAAoB,GAAG,WAAW,SAAS,OAAO;EAAE;EAC/E,MAAM,KAAK,UAAU,qBAAqB;CAC5C,CACF;AAAE"}

package/dist/client-BDwBZYB0.d.ts

@@ -0,0 +1,28 @@
+
+//#region src/client.d.ts
+/** Configuration belongs to a client instance, never to global authentication state. */
+interface ClientOptions {
+  baseUrl: string;
+  getAccessToken?: () => string | null | undefined | Promise<string | null | undefined>;
+  headers?: HeadersInit;
+  fetch?: typeof globalThis.fetch;
+}
+interface Client extends Readonly<ClientOptions> {}
+interface RequestOptions extends RequestInit {
+  client?: Client;
+}
+declare class ApiError<T = unknown> extends Error {
+  readonly status: number;
+  readonly data: T;
+  readonly headers: Headers;
+  constructor(response: Response, data: T);
+}
+declare function createClient(options: ClientOptions): Client;
+/** Orval transport: typed successful data, rejected HTTP errors, native cancellation. */
+declare function request<T>(path: string, options?: RequestOptions): Promise<T>;
+/** Used by generated React Query hooks for HTTP failures. */
+type ErrorType<T> = ApiError<T>;
+type BodyType<T> = T;
+//#endregion
+export { ErrorType as a, request as c, ClientOptions as i, BodyType as n, RequestOptions as o, Client as r, createClient as s, ApiError as t };
+//# sourceMappingURL=client-BDwBZYB0.d.ts.map

package/dist/client-D3kMOcIr.js

@@ -0,0 +1,61 @@
+
+//#region src/client.ts
+var ApiError = class extends Error {
+	status;
+	data;
+	headers;
+	constructor(response, data) {
+		super(`Mozaik API returned HTTP ${response.status}`);
+		this.name = "ApiError";
+		this.status = response.status;
+		this.data = data;
+		this.headers = response.headers;
+	}
+};
+function createClient(options) {
+	const url = new URL(options.baseUrl);
+	if (!["https:", "http:"].includes(url.protocol) || url.username || url.password || url.search || url.hash || url.pathname !== "/") throw new TypeError("baseUrl must be an HTTP(S) origin without credentials, path, query or fragment");
+	return Object.freeze({
+		...options,
+		baseUrl: url.origin,
+		headers: new Headers(options.headers)
+	});
+}
+/** Orval transport: typed successful data, rejected HTTP errors, native cancellation. */
+async function request(path, options = {}) {
+	const { client, headers: requestHeaders, ...init } = options;
+	const headers = new Headers(client?.headers);
+	new Headers(requestHeaders).forEach((value, key) => headers.set(key, value));
+	const url = client ? new URL(path, client.baseUrl) : void 0;
+	if (client && url?.origin !== client.baseUrl) throw new TypeError("Refusing to send client credentials to another origin");
+	if (!headers.has("Authorization")) {
+		const token = await client?.getAccessToken?.();
+		if (token) headers.set("Authorization", `Bearer ${token}`);
+	}
+	if (init.body instanceof FormData) headers.delete("Content-Type");
+	if (!headers.has("Accept")) headers.set("Accept", "application/json");
+	const response = await (client?.fetch ?? globalThis.fetch)(url?.href ?? path, {
+		credentials: "omit",
+		...init,
+		headers
+	});
+	let data;
+	if (response.status !== 204 && response.status !== 205 && init.method !== "HEAD") {
+		const text = await response.text();
+		if (text) {
+			if (response.headers.get("Content-Type")?.includes("json")) try {
+				data = JSON.parse(text);
+			} catch (error) {
+				if (response.ok) throw error;
+				data = text;
+			}
+			else data = text;
+		}
+	}
+	if (!response.ok) throw new ApiError(response, data);
+	return data;
+}
+//#endregion
+export { createClient as n, request as r, ApiError as t };
+
+//# sourceMappingURL=client-D3kMOcIr.js.map

package/dist/client-D3kMOcIr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-D3kMOcIr.js","names":[],"sources":["../src/client.ts"],"sourcesContent":["/** Configuration belongs to a client instance, never to global authentication state. */\nexport interface ClientOptions {\n  baseUrl: string;\n  getAccessToken?: () => string | null | undefined | Promise<string | null | undefined>;\n  headers?: HeadersInit;\n  fetch?: typeof globalThis.fetch;\n}\n\nexport interface Client extends Readonly<ClientOptions> {}\n\nexport interface RequestOptions extends RequestInit {\n  client?: Client;\n}\n\nexport class ApiError<T = unknown> extends Error {\n  readonly status: number;\n  readonly data: T;\n  readonly headers: Headers;\n\n  constructor(response: Response, data: T) {\n    super(`Mozaik API returned HTTP ${response.status}`);\n    this.name = 'ApiError';\n    this.status = response.status;\n    this.data = data;\n    this.headers = response.headers;\n  }\n}\n\nexport function createClient(options: ClientOptions): Client {\n  const url = new URL(options.baseUrl);\n  if (!['https:', 'http:'].includes(url.protocol) || url.username || url.password || url.search || url.hash || url.pathname !== '/') {\n    throw new TypeError('baseUrl must be an HTTP(S) origin without credentials, path, query or fragment');\n  }\n  return Object.freeze({ ...options, baseUrl: url.origin, headers: new Headers(options.headers) });\n}\n\n/** Orval transport: typed successful data, rejected HTTP errors, native cancellation. */\nexport async function request<T>(path: string, options: RequestOptions = {}): Promise<T> {\n  const { client, headers: requestHeaders, ...init } = options;\n  const headers = new Headers(client?.headers);\n  new Headers(requestHeaders).forEach((value, key) => headers.set(key, value));\n  const url = client ? new URL(path, client.baseUrl) : undefined;\n  if (client && url?.origin !== client.baseUrl) {\n    throw new TypeError('Refusing to send client credentials to another origin');\n  }\n  if (!headers.has('Authorization')) {\n    const token = await client?.getAccessToken?.();\n    if (token) headers.set('Authorization', `Bearer ${token}`);\n  }\n  if (init.body instanceof FormData) headers.delete('Content-Type');\n  if (!headers.has('Accept')) headers.set('Accept', 'application/json');\n  const response = await (client?.fetch ?? globalThis.fetch)(url?.href ?? path, {\n    credentials: 'omit', ...init, headers,\n  });\n  let data: unknown;\n  if (response.status !== 204 && response.status !== 205 && init.method !== 'HEAD') {\n    const text = await response.text();\n    if (text) {\n      if (response.headers.get('Content-Type')?.includes('json')) {\n        try { data = JSON.parse(text); }\n        catch (error) { if (response.ok) throw error; data = text; }\n      } else data = text;\n    }\n  }\n  if (!response.ok) throw new ApiError(response, data);\n  return data as T;\n}\n\n/** Used by generated React Query hooks for HTTP failures. */\nexport type ErrorType<T> = ApiError<T>;\nexport type BodyType<T> = T;\n"],"mappings":";;AAcA,IAAa,WAAb,cAA2C,MAAM;CAC/C;CACA;CACA;CAEA,YAAY,UAAoB,MAAS;EACvC,MAAM,4BAA4B,SAAS,QAAQ;EACnD,KAAK,OAAO;EACZ,KAAK,SAAS,SAAS;EACvB,KAAK,OAAO;EACZ,KAAK,UAAU,SAAS;CAC1B;AACF;AAEA,SAAgB,aAAa,SAAgC;CAC3D,MAAM,MAAM,IAAI,IAAI,QAAQ,OAAO;CACnC,IAAI,CAAC,CAAC,UAAU,OAAO,CAAC,CAAC,SAAS,IAAI,QAAQ,KAAK,IAAI,YAAY,IAAI,YAAY,IAAI,UAAU,IAAI,QAAQ,IAAI,aAAa,KAC5H,MAAM,IAAI,UAAU,gFAAgF;CAEtG,OAAO,OAAO,OAAO;EAAE,GAAG;EAAS,SAAS,IAAI;EAAQ,SAAS,IAAI,QAAQ,QAAQ,OAAO;CAAE,CAAC;AACjG;;AAGA,eAAsB,QAAW,MAAc,UAA0B,CAAC,GAAe;CACvF,MAAM,EAAE,QAAQ,SAAS,gBAAgB,GAAG,SAAS;CACrD,MAAM,UAAU,IAAI,QAAQ,QAAQ,OAAO;CAC3C,IAAI,QAAQ,cAAc,CAAC,CAAC,SAAS,OAAO,QAAQ,QAAQ,IAAI,KAAK,KAAK,CAAC;CAC3E,MAAM,MAAM,SAAS,IAAI,IAAI,MAAM,OAAO,OAAO,IAAI,KAAA;CACrD,IAAI,UAAU,KAAK,WAAW,OAAO,SACnC,MAAM,IAAI,UAAU,uDAAuD;CAE7E,IAAI,CAAC,QAAQ,IAAI,eAAe,GAAG;EACjC,MAAM,QAAQ,MAAM,QAAQ,iBAAiB;EAC7C,IAAI,OAAO,QAAQ,IAAI,iBAAiB,UAAU,OAAO;CAC3D;CACA,IAAI,KAAK,gBAAgB,UAAU,QAAQ,OAAO,cAAc;CAChE,IAAI,CAAC,QAAQ,IAAI,QAAQ,GAAG,QAAQ,IAAI,UAAU,kBAAkB;CACpE,MAAM,WAAW,OAAO,QAAQ,SAAS,WAAW,MAAA,CAAO,KAAK,QAAQ,MAAM;EAC5E,aAAa;EAAQ,GAAG;EAAM;CAChC,CAAC;CACD,IAAI;CACJ,IAAI,SAAS,WAAW,OAAO,SAAS,WAAW,OAAO,KAAK,WAAW,QAAQ;EAChF,MAAM,OAAO,MAAM,SAAS,KAAK;EACjC,IAAI,MAAM;GACR,IAAI,SAAS,QAAQ,IAAI,cAAc,CAAC,EAAE,SAAS,MAAM,GACvD,IAAI;IAAE,OAAO,KAAK,MAAM,IAAI;GAAG,SACxB,OAAO;IAAE,IAAI,SAAS,IAAI,MAAM;IAAO,OAAO;GAAM;QACtD,OAAO;EAChB;CACF;CACA,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,SAAS,UAAU,IAAI;CACnD,OAAO;AACT"}