@fragno-dev/backoffice-api 0.0.0-stage → 0.0.0

package/dist/v0/client.js

@@ -0,0 +1,61 @@
+import { backofficeApiErrorSchema } from "../errors.js";
+import { backofficeScopePathSegment } from "./shared/scope.js";
+import { backofficeApiV0 } from "./api.js";
+//#region src/v0/client.ts
+/**
+* Backoffice answered with an error. `code` is null when the response was not an API error, e.g.
+* a server failure or an intermediary's response, so the operation's outcome is unknown.
+*/
+var BackofficeApiRequestError = class extends Error {
+	status;
+	code;
+	constructor(status, code, message) {
+		super(message);
+		this.name = "BackofficeApiRequestError";
+		this.status = status;
+		this.code = code;
+	}
+};
+/** The request never got a response, e.g. a network failure, so the operation's outcome is unknown. */
+var BackofficeApiUnreachableError = class extends Error {
+	constructor(cause) {
+		super("Backoffice could not be reached.", { cause });
+		this.name = "BackofficeApiUnreachableError";
+	}
+};
+async function requestErrorFromResponse(response) {
+	const body = backofficeApiErrorSchema.safeParse(await response.json().catch(() => null));
+	return body.success ? new BackofficeApiRequestError(response.status, body.data.error.code, body.data.error.message) : new BackofficeApiRequestError(response.status, null, `Backoffice responded with HTTP ${response.status}.`);
+}
+/**
+* Calls the v0 API at `origin` with one bearer credential. Network failures reject with
+* `BackofficeApiUnreachableError`, and error responses with `BackofficeApiRequestError`. Anything
+* else, such as a success body that does not match this contract, is a bug and rejects as is.
+*/
+function createBackofficeApiClient({ origin, accessToken, fetch }) {
+	return { async call(scope, operationId, ...input) {
+		const url = new URL(`/api/${backofficeApiV0.version}/scopes/${backofficeScopePathSegment(scope)}/${operationId}`, origin);
+		let response;
+		try {
+			response = await fetch(url, input.length === 0 ? {
+				method: "POST",
+				headers: { authorization: `Bearer ${accessToken}` }
+			} : {
+				method: "POST",
+				headers: {
+					authorization: `Bearer ${accessToken}`,
+					"content-type": "application/json"
+				},
+				body: JSON.stringify(input[0])
+			});
+		} catch (error) {
+			throw new BackofficeApiUnreachableError(error);
+		}
+		if (!response.ok) throw await requestErrorFromResponse(response);
+		return backofficeApiV0.operations[operationId].output.parse(response.status === 204 ? void 0 : await response.json());
+	} };
+}
+//#endregion
+export { BackofficeApiRequestError, BackofficeApiUnreachableError, createBackofficeApiClient };
+
+//# sourceMappingURL=client.js.map

package/dist/v0/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":[],"sources":["../../src/v0/client.ts"],"sourcesContent":["import type { z } from \"zod\";\n\nimport { backofficeApiErrorSchema, type BackofficeApiErrorCode } from \"../errors\";\nimport { backofficeApiV0 } from \"./api\";\nimport { backofficeScopePathSegment, type BackofficeContextScope } from \"./shared/scope\";\n\ntype Operations = typeof backofficeApiV0.operations;\ntype OperationId = keyof Operations;\n\n/** Operations whose input is `z.void()` are called without an input argument. */\ntype OperationInputArgs<TId extends OperationId> = Operations[TId][\"input\"] extends z.ZodVoid\n  ? []\n  : [input: z.input<Operations[TId][\"input\"]>];\n\nexport type BackofficeApiClient = {\n  /** Runs one operation in `scope`, returning its output parsed by the operation's schema. */\n  call<TId extends OperationId>(\n    scope: BackofficeContextScope,\n    operationId: TId,\n    ...input: OperationInputArgs<TId>\n  ): Promise<z.output<Operations[TId][\"output\"]>>;\n};\n\n/**\n * Backoffice answered with an error. `code` is null when the response was not an API error, e.g.\n * a server failure or an intermediary's response, so the operation's outcome is unknown.\n */\nexport class BackofficeApiRequestError extends Error {\n  readonly status: number;\n  readonly code: BackofficeApiErrorCode | null;\n\n  constructor(status: number, code: BackofficeApiErrorCode | null, message: string) {\n    super(message);\n    this.name = \"BackofficeApiRequestError\";\n    this.status = status;\n    this.code = code;\n  }\n}\n\n/** The request never got a response, e.g. a network failure, so the operation's outcome is unknown. */\nexport class BackofficeApiUnreachableError extends Error {\n  constructor(cause: unknown) {\n    super(\"Backoffice could not be reached.\", { cause });\n    this.name = \"BackofficeApiUnreachableError\";\n  }\n}\n\nasync function requestErrorFromResponse(response: Response): Promise<BackofficeApiRequestError> {\n  const body = backofficeApiErrorSchema.safeParse(await response.json().catch(() => null));\n  return body.success\n    ? new BackofficeApiRequestError(response.status, body.data.error.code, body.data.error.message)\n    : new BackofficeApiRequestError(\n        response.status,\n        null,\n        `Backoffice responded with HTTP ${response.status}.`,\n      );\n}\n\n/**\n * Calls the v0 API at `origin` with one bearer credential. Network failures reject with\n * `BackofficeApiUnreachableError`, and error responses with `BackofficeApiRequestError`. Anything\n * else, such as a success body that does not match this contract, is a bug and rejects as is.\n */\nexport function createBackofficeApiClient({\n  origin,\n  accessToken,\n  fetch,\n}: {\n  origin: string;\n  accessToken: string;\n  fetch: typeof globalThis.fetch;\n}): BackofficeApiClient {\n  return {\n    async call(scope, operationId, ...input) {\n      const url = new URL(\n        `/api/${backofficeApiV0.version}/scopes/${backofficeScopePathSegment(scope)}/${operationId}`,\n        origin,\n      );\n      let response: Response;\n      try {\n        response = await fetch(\n          url,\n          input.length === 0\n            ? { method: \"POST\", headers: { authorization: `Bearer ${accessToken}` } }\n            : {\n                method: \"POST\",\n                headers: {\n                  authorization: `Bearer ${accessToken}`,\n                  \"content-type\": \"application/json\",\n                },\n                body: JSON.stringify(input[0]),\n              },\n        );\n      } catch (error) {\n        throw new BackofficeApiUnreachableError(error);\n      }\n      if (!response.ok) {\n        throw await requestErrorFromResponse(response);\n      }\n      // TypeScript cannot relate an indexed schema's result to `TId`; it is that operation's output.\n      return backofficeApiV0.operations[operationId].output.parse(\n        response.status === 204 ? undefined : await response.json(),\n      ) as z.output<Operations[typeof operationId][\"output\"]>;\n    },\n  };\n}\n"],"mappings":";;;;;;;;AA2BA,IAAa,4BAAb,cAA+C,MAAM;CACnD;CACA;CAEA,YAAY,QAAgB,MAAqC,SAAiB;EAChF,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,KAAK,OAAO;CACd;AACF;;AAGA,IAAa,gCAAb,cAAmD,MAAM;CACvD,YAAY,OAAgB;EAC1B,MAAM,oCAAoC,EAAE,MAAM,CAAC;EACnD,KAAK,OAAO;CACd;AACF;AAEA,eAAe,yBAAyB,UAAwD;CAC9F,MAAM,OAAO,yBAAyB,UAAU,MAAM,SAAS,KAAK,CAAC,CAAC,YAAY,IAAI,CAAC;CACvF,OAAO,KAAK,UACR,IAAI,0BAA0B,SAAS,QAAQ,KAAK,KAAK,MAAM,MAAM,KAAK,KAAK,MAAM,OAAO,IAC5F,IAAI,0BACF,SAAS,QACT,MACA,kCAAkC,SAAS,OAAO,EACpD;AACN;;;;;;AAOA,SAAgB,0BAA0B,EACxC,QACA,aACA,SAKsB;CACtB,OAAO,EACL,MAAM,KAAK,OAAO,aAAa,GAAG,OAAO;EACvC,MAAM,MAAM,IAAI,IACd,QAAQ,gBAAgB,QAAQ,UAAU,2BAA2B,KAAK,EAAE,GAAG,eAC/E,MACF;EACA,IAAI;EACJ,IAAI;GACF,WAAW,MAAM,MACf,KACA,MAAM,WAAW,IACb;IAAE,QAAQ;IAAQ,SAAS,EAAE,eAAe,UAAU,cAAc;GAAE,IACtE;IACE,QAAQ;IACR,SAAS;KACP,eAAe,UAAU;KACzB,gBAAgB;IAClB;IACA,MAAM,KAAK,UAAU,MAAM,EAAE;GAC/B,CACN;EACF,SAAS,OAAO;GACd,MAAM,IAAI,8BAA8B,KAAK;EAC/C;EACA,IAAI,CAAC,SAAS,IACZ,MAAM,MAAM,yBAAyB,QAAQ;EAG/C,OAAO,gBAAgB,WAAW,YAAY,CAAC,OAAO,MACpD,SAAS,WAAW,MAAM,KAAA,IAAY,MAAM,SAAS,KAAK,CAC5D;CACF,EACF;AACF"}