@thomasfosterau/effect-rdf 0.0.0 → 0.1.0

package/dist/Processor-FJPvO0CB.d.mts

@@ -0,0 +1,435 @@
+import { r as Report } from "./Report-hcXsc_19.mjs";
+import { i as Dialect, l as MetadataError, m as TableGroup } from "./Metadata-CEt3yc1-.mjs";
+import { c as Source, d as TableGroup$1, o as Options$1 } from "./Table-C3reiVrb.mjs";
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import * as Effect from "effect/Effect";
+import * as Context from "effect/Context";
+import * as Layer from "effect/Layer";
+declare namespace Processor_d_exports {
+  export { LoadError, Loader, Options, Processed, defaultLocations, fromMetadata, fromTabular, layerSources, makeLoader, processGroup };
+}
+declare const LoadError_base: Schema.Class<LoadError, Schema.TaggedStruct<"LoadError", {
+  readonly message: Schema.String;
+  readonly url: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * A table or metadata document that could not be read.
+ *
+ * @since 0.1.0
+ * @category errors
+ */
+declare class LoadError extends LoadError_base {}
+declare const Loader_base: Context.ServiceClass<Loader, "@thomasfosterau/effect-rdf/csvw/Loader", {
+  readonly table: (url: string, dialect: Dialect) => Effect.Effect<ReadonlyArray<ReadonlyArray<string>>, LoadError>;
+  readonly document: (url: string) => Effect.Effect<Option.Option<string>, LoadError>;
+}>;
+/**
+ * Reads the resources CSVW processing needs: a table's rows, parsed with its
+ * dialect, and a metadata document's text (`None` when there is none at that
+ * URL, as when probing default locations).
+ *
+ * @since 0.1.0
+ * @category services
+ */
+declare class Loader extends Loader_base {}
+/**
+ * A `Loader` over already-parsed tables and metadata documents held in
+ * memory, keyed by URL (a table's dialect is not used: its rows are already
+ * split).
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const makeLoader: (sources: ReadonlyArray<Source>, documents?: Readonly<Record<string, string>>) => Loader["Service"];
+/**
+ * `makeLoader` as a layer.
+ *
+ * @since 0.1.0
+ * @category layers
+ */
+declare const layerSources: (sources: ReadonlyArray<Source>, documents?: Readonly<Record<string, string>>) => Layer.Layer<Loader>;
+/**
+ * Options for processing.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Options extends Options$1 {
+  /** User-supplied (overriding) metadata: its URL and text. */
+  readonly metadata?: {
+    readonly url: string;
+    readonly text: string;
+  } | undefined;
+  /** Look for metadata at the default locations (default `true`). */
+  readonly locate?: boolean | undefined;
+}
+/**
+ * The result of processing: the annotated group, the metadata it was
+ * annotated with and the validation report.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Processed {
+  readonly group: TableGroup$1;
+  readonly metadata: TableGroup;
+  readonly report: Report;
+}
+/**
+ * The default metadata locations for a tabular data file
+ * (`{+url}-metadata.json`, then `csv-metadata.json`), resolved against it.
+ *
+ * @since 0.1.0
+ * @category locating
+ */
+declare const defaultLocations: (url: string) => ReadonlyArray<string>;
+/**
+ * Annotates every table of a normalized table group, reading each through
+ * the `Loader`, and checks its keys.
+ *
+ * @since 0.1.0
+ * @category processing
+ */
+declare const processGroup: (metadata: {
+  readonly tables: readonly {
+    readonly url: string;
+    readonly notes: readonly Schema.Json[];
+    readonly common: {
+      readonly [x: string]: Schema.Json;
+    };
+    readonly isSuppressed: boolean;
+    readonly inherited: {
+      readonly required?: boolean | undefined;
+      readonly aboutUrl?: string | undefined;
+      readonly datatype?: {
+        readonly common: {
+          readonly [x: string]: Schema.Json;
+        };
+        readonly base: string;
+        readonly length?: number | undefined;
+        readonly format?: string | {
+          readonly decimalChar?: string | undefined;
+          readonly groupChar?: string | undefined;
+          readonly pattern?: string | undefined;
+        } | undefined;
+        readonly id?: string | undefined;
+        readonly minLength?: number | undefined;
+        readonly maxLength?: number | undefined;
+        readonly minInclusive?: string | number | undefined;
+        readonly maxInclusive?: string | number | undefined;
+        readonly minExclusive?: string | number | undefined;
+        readonly maxExclusive?: string | number | undefined;
+      } | undefined;
+      readonly default?: string | undefined;
+      readonly lang?: string | undefined;
+      readonly null?: readonly string[] | undefined;
+      readonly ordered?: boolean | undefined;
+      readonly propertyUrl?: string | undefined;
+      readonly separator?: string | null | undefined;
+      readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+      readonly valueUrl?: string | undefined;
+    };
+    readonly transformations: readonly {
+      readonly url: string;
+      readonly common: {
+        readonly [x: string]: Schema.Json;
+      };
+      readonly titles: {
+        readonly [x: string]: readonly string[];
+      };
+      readonly scriptFormat: string;
+      readonly targetFormat: string;
+      readonly id?: string | undefined;
+      readonly source?: string | undefined;
+    }[];
+    readonly dialect?: {
+      readonly lineTerminators: readonly string[];
+      readonly quoteChar: string | null;
+      readonly delimiter: string;
+      readonly isDoubleQuoted: boolean;
+      readonly encoding: string;
+      readonly headerRowCount: number;
+      readonly shouldSkipBlankRows: boolean;
+      readonly skipColumns: number;
+      readonly skipRows: number;
+      readonly trim: "true" | "false" | "start" | "end";
+      readonly id?: string | undefined;
+      readonly commentPrefix?: string | undefined;
+    } | undefined;
+    readonly id?: string | undefined;
+    readonly tableDirection?: "ltr" | "rtl" | "auto" | undefined;
+    readonly tableSchema?: {
+      readonly columns: readonly {
+        readonly common: {
+          readonly [x: string]: Schema.Json;
+        };
+        readonly titles: {
+          readonly [x: string]: readonly string[];
+        };
+        readonly isVirtual: boolean;
+        readonly isSuppressed: boolean;
+        readonly inherited: {
+          readonly required?: boolean | undefined;
+          readonly aboutUrl?: string | undefined;
+          readonly datatype?: {
+            readonly common: {
+              readonly [x: string]: Schema.Json;
+            };
+            readonly base: string;
+            readonly length?: number | undefined;
+            readonly format?: string | {
+              readonly decimalChar?: string | undefined;
+              readonly groupChar?: string | undefined;
+              readonly pattern?: string | undefined;
+            } | undefined;
+            readonly id?: string | undefined;
+            readonly minLength?: number | undefined;
+            readonly maxLength?: number | undefined;
+            readonly minInclusive?: string | number | undefined;
+            readonly maxInclusive?: string | number | undefined;
+            readonly minExclusive?: string | number | undefined;
+            readonly maxExclusive?: string | number | undefined;
+          } | undefined;
+          readonly default?: string | undefined;
+          readonly lang?: string | undefined;
+          readonly null?: readonly string[] | undefined;
+          readonly ordered?: boolean | undefined;
+          readonly propertyUrl?: string | undefined;
+          readonly separator?: string | null | undefined;
+          readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+          readonly valueUrl?: string | undefined;
+        };
+        readonly name?: string | undefined;
+        readonly id?: string | undefined;
+        readonly titleName?: string | undefined;
+      }[];
+      readonly common: {
+        readonly [x: string]: Schema.Json;
+      };
+      readonly inherited: {
+        readonly required?: boolean | undefined;
+        readonly aboutUrl?: string | undefined;
+        readonly datatype?: {
+          readonly common: {
+            readonly [x: string]: Schema.Json;
+          };
+          readonly base: string;
+          readonly length?: number | undefined;
+          readonly format?: string | {
+            readonly decimalChar?: string | undefined;
+            readonly groupChar?: string | undefined;
+            readonly pattern?: string | undefined;
+          } | undefined;
+          readonly id?: string | undefined;
+          readonly minLength?: number | undefined;
+          readonly maxLength?: number | undefined;
+          readonly minInclusive?: string | number | undefined;
+          readonly maxInclusive?: string | number | undefined;
+          readonly minExclusive?: string | number | undefined;
+          readonly maxExclusive?: string | number | undefined;
+        } | undefined;
+        readonly default?: string | undefined;
+        readonly lang?: string | undefined;
+        readonly null?: readonly string[] | undefined;
+        readonly ordered?: boolean | undefined;
+        readonly propertyUrl?: string | undefined;
+        readonly separator?: string | null | undefined;
+        readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+        readonly valueUrl?: string | undefined;
+      };
+      readonly foreignKeys: readonly {
+        readonly columnReference: readonly string[];
+        readonly reference: {
+          readonly columnReference: readonly string[];
+          readonly resource?: string | undefined;
+          readonly schemaReference?: string | undefined;
+        };
+      }[];
+      readonly id?: string | undefined;
+      readonly primaryKey?: readonly string[] | undefined;
+      readonly rowTitles?: readonly string[] | undefined;
+    } | undefined;
+  }[];
+  readonly notes: readonly Schema.Json[];
+  readonly common: {
+    readonly [x: string]: Schema.Json;
+  };
+  readonly inherited: {
+    readonly required?: boolean | undefined;
+    readonly aboutUrl?: string | undefined;
+    readonly datatype?: {
+      readonly common: {
+        readonly [x: string]: Schema.Json;
+      };
+      readonly base: string;
+      readonly length?: number | undefined;
+      readonly format?: string | {
+        readonly decimalChar?: string | undefined;
+        readonly groupChar?: string | undefined;
+        readonly pattern?: string | undefined;
+      } | undefined;
+      readonly id?: string | undefined;
+      readonly minLength?: number | undefined;
+      readonly maxLength?: number | undefined;
+      readonly minInclusive?: string | number | undefined;
+      readonly maxInclusive?: string | number | undefined;
+      readonly minExclusive?: string | number | undefined;
+      readonly maxExclusive?: string | number | undefined;
+    } | undefined;
+    readonly default?: string | undefined;
+    readonly lang?: string | undefined;
+    readonly null?: readonly string[] | undefined;
+    readonly ordered?: boolean | undefined;
+    readonly propertyUrl?: string | undefined;
+    readonly separator?: string | null | undefined;
+    readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+    readonly valueUrl?: string | undefined;
+  };
+  readonly transformations: readonly {
+    readonly url: string;
+    readonly common: {
+      readonly [x: string]: Schema.Json;
+    };
+    readonly titles: {
+      readonly [x: string]: readonly string[];
+    };
+    readonly scriptFormat: string;
+    readonly targetFormat: string;
+    readonly id?: string | undefined;
+    readonly source?: string | undefined;
+  }[];
+  readonly dialect?: {
+    readonly lineTerminators: readonly string[];
+    readonly quoteChar: string | null;
+    readonly delimiter: string;
+    readonly isDoubleQuoted: boolean;
+    readonly encoding: string;
+    readonly headerRowCount: number;
+    readonly shouldSkipBlankRows: boolean;
+    readonly skipColumns: number;
+    readonly skipRows: number;
+    readonly trim: "true" | "false" | "start" | "end";
+    readonly id?: string | undefined;
+    readonly commentPrefix?: string | undefined;
+  } | undefined;
+  readonly id?: string | undefined;
+  readonly tableDirection?: "ltr" | "rtl" | "auto" | undefined;
+  readonly tableSchema?: {
+    readonly columns: readonly {
+      readonly common: {
+        readonly [x: string]: Schema.Json;
+      };
+      readonly titles: {
+        readonly [x: string]: readonly string[];
+      };
+      readonly isVirtual: boolean;
+      readonly isSuppressed: boolean;
+      readonly inherited: {
+        readonly required?: boolean | undefined;
+        readonly aboutUrl?: string | undefined;
+        readonly datatype?: {
+          readonly common: {
+            readonly [x: string]: Schema.Json;
+          };
+          readonly base: string;
+          readonly length?: number | undefined;
+          readonly format?: string | {
+            readonly decimalChar?: string | undefined;
+            readonly groupChar?: string | undefined;
+            readonly pattern?: string | undefined;
+          } | undefined;
+          readonly id?: string | undefined;
+          readonly minLength?: number | undefined;
+          readonly maxLength?: number | undefined;
+          readonly minInclusive?: string | number | undefined;
+          readonly maxInclusive?: string | number | undefined;
+          readonly minExclusive?: string | number | undefined;
+          readonly maxExclusive?: string | number | undefined;
+        } | undefined;
+        readonly default?: string | undefined;
+        readonly lang?: string | undefined;
+        readonly null?: readonly string[] | undefined;
+        readonly ordered?: boolean | undefined;
+        readonly propertyUrl?: string | undefined;
+        readonly separator?: string | null | undefined;
+        readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+        readonly valueUrl?: string | undefined;
+      };
+      readonly name?: string | undefined;
+      readonly id?: string | undefined;
+      readonly titleName?: string | undefined;
+    }[];
+    readonly common: {
+      readonly [x: string]: Schema.Json;
+    };
+    readonly inherited: {
+      readonly required?: boolean | undefined;
+      readonly aboutUrl?: string | undefined;
+      readonly datatype?: {
+        readonly common: {
+          readonly [x: string]: Schema.Json;
+        };
+        readonly base: string;
+        readonly length?: number | undefined;
+        readonly format?: string | {
+          readonly decimalChar?: string | undefined;
+          readonly groupChar?: string | undefined;
+          readonly pattern?: string | undefined;
+        } | undefined;
+        readonly id?: string | undefined;
+        readonly minLength?: number | undefined;
+        readonly maxLength?: number | undefined;
+        readonly minInclusive?: string | number | undefined;
+        readonly maxInclusive?: string | number | undefined;
+        readonly minExclusive?: string | number | undefined;
+        readonly maxExclusive?: string | number | undefined;
+      } | undefined;
+      readonly default?: string | undefined;
+      readonly lang?: string | undefined;
+      readonly null?: readonly string[] | undefined;
+      readonly ordered?: boolean | undefined;
+      readonly propertyUrl?: string | undefined;
+      readonly separator?: string | null | undefined;
+      readonly textDirection?: "ltr" | "rtl" | "auto" | "inherit" | undefined;
+      readonly valueUrl?: string | undefined;
+    };
+    readonly foreignKeys: readonly {
+      readonly columnReference: readonly string[];
+      readonly reference: {
+        readonly columnReference: readonly string[];
+        readonly resource?: string | undefined;
+        readonly schemaReference?: string | undefined;
+      };
+    }[];
+    readonly id?: string | undefined;
+    readonly primaryKey?: readonly string[] | undefined;
+    readonly rowTitles?: readonly string[] | undefined;
+  } | undefined;
+}, warnings: readonly {
+  readonly message: string;
+  readonly level: "error" | "warning";
+  readonly column?: number | undefined;
+  readonly table?: string | undefined;
+  readonly row?: number | undefined;
+}[], options?: Options$1 | undefined) => Effect.Effect<Processed, LoadError | MetadataError, Loader>;
+/**
+ * Processes starting from a metadata document: decodes it (fetching any
+ * referenced schemas and dialects through the `Loader`) and annotates every
+ * table it describes.
+ *
+ * @since 0.1.0
+ * @category processing
+ */
+declare const fromMetadata: (url: string, text: string, options?: Options$1 | undefined) => Effect.Effect<Processed, LoadError | MetadataError, Loader>;
+/**
+ * Processes starting from a tabular data file: uses the user's metadata if
+ * given, else the first metadata document at a default location that
+ * describes the file, else the file's embedded metadata.
+ *
+ * @since 0.1.0
+ * @category processing
+ */
+declare const fromTabular: (url: string, options?: Options | undefined) => Effect.Effect<Processed, LoadError | MetadataError, Loader>;
+export { Processor_d_exports as a, fromTabular as c, processGroup as d, Processed as i, layerSources as l, Loader as n, defaultLocations as o, Options as r, fromMetadata as s, LoadError as t, makeLoader as u };
+//# sourceMappingURL=Processor-FJPvO0CB.d.mts.map

package/dist/Protocol-BA7OkNgp.mjs

@@ -0,0 +1,202 @@
+import { t as __exportAll } from "./rolldown-runtime-D8jQpDG7.mjs";
+import { Z as namedNode } from "./Term-CFLG1qu4.mjs";
+import { i as isAbsolute, l as resolve } from "./Iri-Cr92gsQV.mjs";
+import { d as unsupportedMediaType, o as methodNotAllowed, r as badRequest } from "./ProtocolErrors-czDPVcX5.mjs";
+import * as Arr from "effect/Array";
+import * as Option from "effect/Option";
+import * as Effect from "effect/Effect";
+import * as Match from "effect/Match";
+// src/sparql/Protocol.ts
+/**
+* Decoding of SPARQL 1.1 Protocol requests.
+*
+* A request to the SPARQL endpoint is one of
+*
+* - a query: `GET` with a `query` parameter, `POST` with an
+*   `application/x-www-form-urlencoded` body holding `query`, or `POST` with
+*   an `application/sparql-query` body;
+* - an update: `POST` with an `application/x-www-form-urlencoded` body
+*   holding `update`, or `POST` with an `application/sparql-update` body;
+* - a service description request: `GET` without `query`.
+*
+* The dataset parameters (`default-graph-uri` / `named-graph-uri` for
+* queries, `using-graph-uri` / `using-named-graph-uri` for updates) come from
+* the URL query string, and also from the body of a form request.
+*
+* @since 0.1.0
+*/
+var Protocol_exports = /* @__PURE__ */ __exportAll({
+	FORM: () => FORM,
+	SPARQL_QUERY: () => SPARQL_QUERY,
+	SPARQL_UPDATE: () => SPARQL_UPDATE,
+	datasetFromParams: () => datasetFromParams,
+	decode: () => decode,
+	isNonUtf8: () => isNonUtf8,
+	parseContentType: () => parseContentType,
+	searchParams: () => searchParams
+});
+/**
+* The media type of a direct `POST` query body.
+*
+* @since 0.1.0
+* @category media types
+*/
+const SPARQL_QUERY = "application/sparql-query";
+/**
+* The media type of a direct `POST` update body.
+*
+* @since 0.1.0
+* @category media types
+*/
+const SPARQL_UPDATE = "application/sparql-update";
+/**
+* The media type of form-encoded requests.
+*
+* @since 0.1.0
+* @category media types
+*/
+const FORM = "application/x-www-form-urlencoded";
+/**
+* Parses a `Content-Type` header (media type lower-cased, parameter names
+* lower-cased, quotes removed).
+*
+* @since 0.1.0
+* @category parsing
+*/
+const parseContentType = (header) => {
+	if (header === void 0 || header.trim() === "") return void 0;
+	const [type, ...params] = header.split(";");
+	const parameters = {};
+	params.forEach((p) => {
+		const eq = p.indexOf("=");
+		if (eq < 0) return;
+		const key = p.slice(0, eq).trim().toLowerCase();
+		const raw = p.slice(eq + 1).trim();
+		parameters[key] = raw.startsWith("\"") && raw.endsWith("\"") && raw.length >= 2 ? raw.slice(1, -1) : raw;
+	});
+	return {
+		mediaType: (type ?? "").trim().toLowerCase(),
+		parameters
+	};
+};
+/**
+* Whether a content type declares a charset other than UTF-8.
+*
+* @since 0.1.0
+* @category parsing
+*/
+const isNonUtf8 = (contentType) => {
+	const charset = contentType.parameters["charset"];
+	return charset !== void 0 && !/^utf-?8$/i.test(charset);
+};
+/**
+* The query string parameters of a request URL.
+*
+* @since 0.1.0
+* @category parsing
+*/
+const searchParams = (url) => {
+	const q = url.indexOf("?");
+	if (q < 0) return new URLSearchParams();
+	const hash = url.indexOf("#", q);
+	return new URLSearchParams(url.slice(q + 1, hash < 0 ? void 0 : hash));
+};
+const graphList = (values, baseIri) => Effect.forEach(values, (value) => {
+	const iri = resolve(value, baseIri);
+	return isAbsolute(iri) && !/[\s<>"{}|^`\\]/.test(iri) ? Effect.succeed(namedNode(iri)) : Effect.fail(badRequest(`Invalid graph IRI: ${value}`));
+}, { concurrency: 1 });
+/**
+* Builds the dataset described by protocol parameters (`undefined` when no
+* parameter is present). When only named graphs are given the default graph
+* is empty, as for `FROM NAMED` in a query.
+*
+* @since 0.1.0
+* @category parsing
+*/
+const datasetFromParams = (params, defaultName, namedName, baseIri) => Effect.gen(function* () {
+	const defaults = params.getAll(defaultName);
+	const named = params.getAll(namedName);
+	if (Arr.isReadonlyArrayEmpty(defaults) && Arr.isReadonlyArrayEmpty(named)) return void 0;
+	return {
+		defaultGraph: yield* graphList(defaults, baseIri),
+		namedGraphs: yield* graphList(named, baseIri)
+	};
+});
+const merge = (a, b) => {
+	const out = new URLSearchParams(a);
+	b.forEach((v, k) => out.append(k, v));
+	return out;
+};
+const single = (params, name) => {
+	const values = params.getAll(name);
+	if (values.length > 1) return Effect.fail(badRequest(`Exactly one '${name}' parameter is allowed`));
+	return Effect.succeed(Arr.head(values));
+};
+const readBody = (request) => Effect.mapError(request.text, (e) => badRequest(`Could not read the request body: ${e.message}`));
+const fromParams = (params, kind, method, baseIri) => Effect.gen(function* () {
+	const query = yield* single(params, "query");
+	const update = yield* single(params, "update");
+	if (Option.isSome(query) && Option.isSome(update)) return yield* badRequest("A request cannot have both 'query' and 'update'");
+	if (Option.isSome(update)) {
+		if (method !== "POST") return yield* badRequest("Updates must be sent with POST");
+		if (!kind.update) return yield* badRequest("This endpoint does not accept updates");
+		const using = yield* datasetFromParams(params, "using-graph-uri", "using-named-graph-uri", baseIri);
+		return {
+			_tag: "Update",
+			update: update.value,
+			using
+		};
+	}
+	if (Option.isSome(query)) {
+		if (!kind.query) return yield* badRequest("This endpoint does not accept queries");
+		const dataset = yield* datasetFromParams(params, "default-graph-uri", "named-graph-uri", baseIri);
+		return {
+			_tag: "Query",
+			query: query.value,
+			dataset
+		};
+	}
+	if (method === "GET" || method === "HEAD") return { _tag: "ServiceDescription" };
+	return yield* badRequest("Missing 'query' or 'update' parameter");
+});
+/**
+* Decodes a request to the SPARQL endpoint. `baseIri` resolves relative
+* graph IRIs in the dataset parameters.
+*
+* @since 0.1.0
+* @category decoding
+*/
+const decode = (request, kind, baseIri) => Effect.gen(function* () {
+	const method = request.method;
+	const urlParams = searchParams(request.url);
+	if (method === "GET" || method === "HEAD") return yield* fromParams(urlParams, kind, method, baseIri);
+	if (method !== "POST") return yield* methodNotAllowed(method, ["GET", "POST"]);
+	const contentType = parseContentType(request.headers["content-type"]);
+	if (contentType === void 0) return yield* unsupportedMediaType(`A POST request needs a Content-Type of ${FORM}, ${SPARQL_QUERY} or ${SPARQL_UPDATE}`);
+	if (isNonUtf8(contentType)) return yield* unsupportedMediaType(`Unsupported charset '${contentType.parameters["charset"]}' (only UTF-8 is accepted)`);
+	return yield* Match.value(contentType).pipe(Match.when({ mediaType: FORM }, () => Effect.gen(function* () {
+		const body = yield* readBody(request);
+		return yield* fromParams(merge(urlParams, new URLSearchParams(body)), kind, method, baseIri);
+	})), Match.when({ mediaType: SPARQL_QUERY }, () => Effect.gen(function* () {
+		if (!kind.query) return yield* unsupportedMediaType("This endpoint does not accept queries");
+		if (urlParams.has("query") || urlParams.has("update")) return yield* badRequest(`A ${SPARQL_QUERY} request cannot also have a 'query' or 'update' parameter`);
+		return {
+			_tag: "Query",
+			query: yield* readBody(request),
+			dataset: yield* datasetFromParams(urlParams, "default-graph-uri", "named-graph-uri", baseIri)
+		};
+	})), Match.when({ mediaType: SPARQL_UPDATE }, () => Effect.gen(function* () {
+		if (!kind.update) return yield* unsupportedMediaType("This endpoint does not accept updates");
+		if (urlParams.has("query") || urlParams.has("update")) return yield* badRequest(`A ${SPARQL_UPDATE} request cannot also have a 'query' or 'update' parameter`);
+		return {
+			_tag: "Update",
+			update: yield* readBody(request),
+			using: yield* datasetFromParams(urlParams, "using-graph-uri", "using-named-graph-uri", baseIri)
+		};
+	})), Match.orElse((other) => Effect.gen(function* () {
+		return yield* unsupportedMediaType(`Unsupported Content-Type '${other.mediaType}'; expected ${FORM}, ${SPARQL_QUERY} or ${SPARQL_UPDATE}`);
+	})));
+});
+export { datasetFromParams as a, parseContentType as c, SPARQL_UPDATE as i, searchParams as l, Protocol_exports as n, decode as o, SPARQL_QUERY as r, isNonUtf8 as s, FORM as t };
+
+//# sourceMappingURL=Protocol-BA7OkNgp.mjs.map

package/dist/Protocol-BA7OkNgp.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Protocol-BA7OkNgp.mjs","names":["Iri.resolve","Iri.isAbsolute","Term.namedNode","ProtocolErrors.badRequest","ProtocolErrors.methodNotAllowed","ProtocolErrors.unsupportedMediaType"],"sources":["../src/sparql/Protocol.ts"],"sourcesContent":["/**\n * Decoding of SPARQL 1.1 Protocol requests.\n *\n * A request to the SPARQL endpoint is one of\n *\n * - a query: `GET` with a `query` parameter, `POST` with an\n *   `application/x-www-form-urlencoded` body holding `query`, or `POST` with\n *   an `application/sparql-query` body;\n * - an update: `POST` with an `application/x-www-form-urlencoded` body\n *   holding `update`, or `POST` with an `application/sparql-update` body;\n * - a service description request: `GET` without `query`.\n *\n * The dataset parameters (`default-graph-uri` / `named-graph-uri` for\n * queries, `using-graph-uri` / `using-named-graph-uri` for updates) come from\n * the URL query string, and also from the body of a form request.\n *\n * @since 0.1.0\n */\nimport * as Match from 'effect/Match';\nimport * as Arr from 'effect/Array';\nimport * as Effect from 'effect/Effect';\nimport * as Option from 'effect/Option';\nimport type * as HttpServerRequest from 'effect/http/HttpServerRequest';\nimport * as Iri from '../Iri.ts';\nimport * as Term from '../Term.ts';\nimport type * as Store from './Store.ts';\nimport * as ProtocolErrors from './ProtocolErrors.ts';\n\n/**\n * The media type of a direct `POST` query body.\n *\n * @since 0.1.0\n * @category media types\n */\nexport const SPARQL_QUERY = 'application/sparql-query';\n\n/**\n * The media type of a direct `POST` update body.\n *\n * @since 0.1.0\n * @category media types\n */\nexport const SPARQL_UPDATE = 'application/sparql-update';\n\n/**\n * The media type of form-encoded requests.\n *\n * @since 0.1.0\n * @category media types\n */\nexport const FORM = 'application/x-www-form-urlencoded';\n\n/**\n * A decoded protocol operation.\n *\n * @since 0.1.0\n * @category models\n */\nexport type Operation =\n  | {\n      readonly _tag: 'Query';\n      readonly query: string;\n      /** The protocol dataset (`default-graph-uri` / `named-graph-uri`), if any. */\n      readonly dataset: Store.DatasetSpec | undefined;\n    }\n  | {\n      readonly _tag: 'Update';\n      readonly update: string;\n      /** The protocol dataset (`using-graph-uri` / `using-named-graph-uri`), if any. */\n      readonly using: Store.DatasetSpec | undefined;\n    }\n  | { readonly _tag: 'ServiceDescription' };\n\n/**\n * A parsed `Content-Type` header.\n *\n * @since 0.1.0\n * @category models\n */\nexport interface ContentType {\n  readonly mediaType: string;\n  readonly parameters: Readonly<Record<string, string>>;\n}\n\n/**\n * Parses a `Content-Type` header (media type lower-cased, parameter names\n * lower-cased, quotes removed).\n *\n * @since 0.1.0\n * @category parsing\n */\nexport const parseContentType = (header: string | undefined): ContentType | undefined => {\n  if (header === undefined || header.trim() === '') return undefined;\n  const [type, ...params] = header.split(';');\n  const parameters: Record<string, string> = {};\n  params.forEach((p) => {\n    const eq = p.indexOf('=');\n    if (eq < 0) return;\n    const key = p.slice(0, eq).trim().toLowerCase();\n    const raw = p.slice(eq + 1).trim();\n    parameters[key] =\n      raw.startsWith('\"') && raw.endsWith('\"') && raw.length >= 2 ? raw.slice(1, -1) : raw;\n  });\n  return { mediaType: (type ?? '').trim().toLowerCase(), parameters };\n};\n\n/**\n * Whether a content type declares a charset other than UTF-8.\n *\n * @since 0.1.0\n * @category parsing\n */\nexport const isNonUtf8 = (contentType: ContentType): boolean => {\n  const charset = contentType.parameters['charset'];\n  return charset !== undefined && !/^utf-?8$/i.test(charset);\n};\n\n/**\n * The query string parameters of a request URL.\n *\n * @since 0.1.0\n * @category parsing\n */\nexport const searchParams = (url: string): URLSearchParams => {\n  const q = url.indexOf('?');\n  if (q < 0) return new URLSearchParams();\n  const hash = url.indexOf('#', q);\n  return new URLSearchParams(url.slice(q + 1, hash < 0 ? undefined : hash));\n};\n\nconst graphList = (\n  values: ReadonlyArray<string>,\n  baseIri: string,\n): Effect.Effect<Array<Term.NamedNode>, ProtocolErrors.ProtocolError> =>\n  Effect.forEach(\n    values,\n    (value) => {\n      const iri = Iri.resolve(value, baseIri);\n      return Iri.isAbsolute(iri) && !/[\\s<>\"{}|^`\\\\]/.test(iri)\n        ? Effect.succeed(Term.namedNode(iri))\n        : Effect.fail(ProtocolErrors.badRequest(`Invalid graph IRI: ${value}`));\n    },\n    { concurrency: 1 },\n  );\n\n/**\n * Builds the dataset described by protocol parameters (`undefined` when no\n * parameter is present). When only named graphs are given the default graph\n * is empty, as for `FROM NAMED` in a query.\n *\n * @since 0.1.0\n * @category parsing\n */\nexport const datasetFromParams = (\n  params: URLSearchParams,\n  defaultName: string,\n  namedName: string,\n  baseIri: string,\n): Effect.Effect<Store.DatasetSpec | undefined, ProtocolErrors.ProtocolError> =>\n  Effect.gen(function* () {\n    const defaults = params.getAll(defaultName);\n    const named = params.getAll(namedName);\n    if (Arr.isReadonlyArrayEmpty(defaults) && Arr.isReadonlyArrayEmpty(named)) return undefined;\n    return {\n      defaultGraph: yield* graphList(defaults, baseIri),\n      namedGraphs: yield* graphList(named, baseIri),\n    };\n  });\n\nconst merge = (a: URLSearchParams, b: URLSearchParams): URLSearchParams => {\n  const out = new URLSearchParams(a);\n  b.forEach((v, k) => out.append(k, v));\n  return out;\n};\n\nconst single = (\n  params: URLSearchParams,\n  name: string,\n): Effect.Effect<Option.Option<string>, ProtocolErrors.ProtocolError> => {\n  const values = params.getAll(name);\n  if (values.length > 1) {\n    return Effect.fail(ProtocolErrors.badRequest(`Exactly one '${name}' parameter is allowed`));\n  }\n  return Effect.succeed(Arr.head(values));\n};\n\nconst readBody = (\n  request: HttpServerRequest.HttpServerRequest,\n): Effect.Effect<string, ProtocolErrors.ProtocolError> =>\n  Effect.mapError(request.text, (e) =>\n    ProtocolErrors.badRequest(`Could not read the request body: ${e.message}`),\n  );\n\n/**\n * What a SPARQL endpoint accepts.\n *\n * @since 0.1.0\n * @category models\n */\nexport interface EndpointKind {\n  readonly query: boolean;\n  readonly update: boolean;\n}\n\nconst fromParams = (\n  params: URLSearchParams,\n  kind: EndpointKind,\n  method: string,\n  baseIri: string,\n): Effect.Effect<Operation, ProtocolErrors.ProtocolError> =>\n  Effect.gen(function* () {\n    const query = yield* single(params, 'query');\n    const update = yield* single(params, 'update');\n    if (Option.isSome(query) && Option.isSome(update)) {\n      return yield* ProtocolErrors.badRequest(\"A request cannot have both 'query' and 'update'\");\n    }\n    if (Option.isSome(update)) {\n      if (method !== 'POST') {\n        return yield* ProtocolErrors.badRequest('Updates must be sent with POST');\n      }\n      if (!kind.update)\n        return yield* ProtocolErrors.badRequest('This endpoint does not accept updates');\n      const using = yield* datasetFromParams(\n        params,\n        'using-graph-uri',\n        'using-named-graph-uri',\n        baseIri,\n      );\n      return { _tag: 'Update', update: update.value, using } as const;\n    }\n    if (Option.isSome(query)) {\n      if (!kind.query)\n        return yield* ProtocolErrors.badRequest('This endpoint does not accept queries');\n      const dataset = yield* datasetFromParams(\n        params,\n        'default-graph-uri',\n        'named-graph-uri',\n        baseIri,\n      );\n      return { _tag: 'Query', query: query.value, dataset } as const;\n    }\n    if (method === 'GET' || method === 'HEAD') return { _tag: 'ServiceDescription' } as const;\n    return yield* ProtocolErrors.badRequest(\"Missing 'query' or 'update' parameter\");\n  });\n\n/**\n * Decodes a request to the SPARQL endpoint. `baseIri` resolves relative\n * graph IRIs in the dataset parameters.\n *\n * @since 0.1.0\n * @category decoding\n */\nexport const decode = (\n  request: HttpServerRequest.HttpServerRequest,\n  kind: EndpointKind,\n  baseIri: string,\n): Effect.Effect<Operation, ProtocolErrors.ProtocolError> =>\n  Effect.gen(function* () {\n    const method = request.method;\n    const urlParams = searchParams(request.url);\n    if (method === 'GET' || method === 'HEAD') {\n      return yield* fromParams(urlParams, kind, method, baseIri);\n    }\n    if (method !== 'POST') {\n      return yield* ProtocolErrors.methodNotAllowed(method, ['GET', 'POST']);\n    }\n    const contentType = parseContentType(request.headers['content-type']);\n    if (contentType === undefined) {\n      return yield* ProtocolErrors.unsupportedMediaType(\n        `A POST request needs a Content-Type of ${FORM}, ${SPARQL_QUERY} or ${SPARQL_UPDATE}`,\n      );\n    }\n    if (isNonUtf8(contentType)) {\n      return yield* ProtocolErrors.unsupportedMediaType(\n        `Unsupported charset '${contentType.parameters['charset']}' (only UTF-8 is accepted)`,\n      );\n    }\n    return yield* Match.value(contentType).pipe(\n      Match.when({ mediaType: FORM }, () =>\n        Effect.gen(function* () {\n          const body = yield* readBody(request);\n          return yield* fromParams(\n            merge(urlParams, new URLSearchParams(body)),\n            kind,\n            method,\n            baseIri,\n          );\n        }),\n      ),\n      Match.when({ mediaType: SPARQL_QUERY }, () =>\n        Effect.gen(function* () {\n          if (!kind.query) {\n            return yield* ProtocolErrors.unsupportedMediaType(\n              'This endpoint does not accept queries',\n            );\n          }\n          if (urlParams.has('query') || urlParams.has('update')) {\n            return yield* ProtocolErrors.badRequest(\n              `A ${SPARQL_QUERY} request cannot also have a 'query' or 'update' parameter`,\n            );\n          }\n          const query = yield* readBody(request);\n          const dataset = yield* datasetFromParams(\n            urlParams,\n            'default-graph-uri',\n            'named-graph-uri',\n            baseIri,\n          );\n          return { _tag: 'Query', query, dataset } as const;\n        }),\n      ),\n      Match.when({ mediaType: SPARQL_UPDATE }, () =>\n        Effect.gen(function* () {\n          if (!kind.update) {\n            return yield* ProtocolErrors.unsupportedMediaType(\n              'This endpoint does not accept updates',\n            );\n          }\n          if (urlParams.has('query') || urlParams.has('update')) {\n            return yield* ProtocolErrors.badRequest(\n              `A ${SPARQL_UPDATE} request cannot also have a 'query' or 'update' parameter`,\n            );\n          }\n          const update = yield* readBody(request);\n          const using = yield* datasetFromParams(\n            urlParams,\n            'using-graph-uri',\n            'using-named-graph-uri',\n            baseIri,\n          );\n          return { _tag: 'Update', update, using } as const;\n        }),\n      ),\n      Match.orElse((other) =>\n        Effect.gen(function* () {\n          return yield* ProtocolErrors.unsupportedMediaType(\n            `Unsupported Content-Type '${other.mediaType}'; expected ${FORM}, ${SPARQL_QUERY} or ${SPARQL_UPDATE}`,\n          );\n        }),\n      ),\n    );\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,MAAa,eAAe;;;;;;;AAQ5B,MAAa,gBAAgB;;;;;;;AAQ7B,MAAa,OAAO;;;;;;;;AAyCpB,MAAa,oBAAoB,WAAwD;CACvF,IAAI,WAAW,KAAA,KAAa,OAAO,KAAK,MAAM,IAAI,OAAO,KAAA;CACzD,MAAM,CAAC,MAAM,GAAG,UAAU,OAAO,MAAM,GAAG;CAC1C,MAAM,aAAqC,CAAC;CAC5C,OAAO,SAAS,MAAM;EACpB,MAAM,KAAK,EAAE,QAAQ,GAAG;EACxB,IAAI,KAAK,GAAG;EACZ,MAAM,MAAM,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY;EAC9C,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,KAAK;EACjC,WAAW,OACT,IAAI,WAAW,IAAG,KAAK,IAAI,SAAS,IAAG,KAAK,IAAI,UAAU,IAAI,IAAI,MAAM,GAAG,EAAE,IAAI;CACrF,CAAC;CACD,OAAO;EAAE,YAAY,QAAQ,GAAA,CAAI,KAAK,CAAC,CAAC,YAAY;EAAG;CAAW;AACpE;;;;;;;AAQA,MAAa,aAAa,gBAAsC;CAC9D,MAAM,UAAU,YAAY,WAAW;CACvC,OAAO,YAAY,KAAA,KAAa,CAAC,YAAY,KAAK,OAAO;AAC3D;;;;;;;AAQA,MAAa,gBAAgB,QAAiC;CAC5D,MAAM,IAAI,IAAI,QAAQ,GAAG;CACzB,IAAI,IAAI,GAAG,OAAO,IAAI,gBAAgB;CACtC,MAAM,OAAO,IAAI,QAAQ,KAAK,CAAC;CAC/B,OAAO,IAAI,gBAAgB,IAAI,MAAM,IAAI,GAAG,OAAO,IAAI,KAAA,IAAY,IAAI,CAAC;AAC1E;AAEA,MAAM,aACJ,QACA,YAEA,OAAO,QACL,SACC,UAAU;CACT,MAAM,MAAMA,QAAY,OAAO,OAAO;CACtC,OAAOC,WAAe,GAAG,KAAK,CAAC,iBAAiB,KAAK,GAAG,IACpD,OAAO,QAAQC,UAAe,GAAG,CAAC,IAClC,OAAO,KAAKC,WAA0B,sBAAsB,OAAO,CAAC;AAC1E,GACA,EAAE,aAAa,EAAE,CACnB;;;;;;;;;AAUF,MAAa,qBACX,QACA,aACA,WACA,YAEA,OAAO,IAAI,aAAa;CACtB,MAAM,WAAW,OAAO,OAAO,WAAW;CAC1C,MAAM,QAAQ,OAAO,OAAO,SAAS;CACrC,IAAI,IAAI,qBAAqB,QAAQ,KAAK,IAAI,qBAAqB,KAAK,GAAG,OAAO,KAAA;CAClF,OAAO;EACL,cAAc,OAAO,UAAU,UAAU,OAAO;EAChD,aAAa,OAAO,UAAU,OAAO,OAAO;CAC9C;AACF,CAAC;AAEH,MAAM,SAAS,GAAoB,MAAwC;CACzE,MAAM,MAAM,IAAI,gBAAgB,CAAC;CACjC,EAAE,SAAS,GAAG,MAAM,IAAI,OAAO,GAAG,CAAC,CAAC;CACpC,OAAO;AACT;AAEA,MAAM,UACJ,QACA,SACuE;CACvE,MAAM,SAAS,OAAO,OAAO,IAAI;CACjC,IAAI,OAAO,SAAS,GAClB,OAAO,OAAO,KAAKA,WAA0B,gBAAgB,KAAK,uBAAuB,CAAC;CAE5F,OAAO,OAAO,QAAQ,IAAI,KAAK,MAAM,CAAC;AACxC;AAEA,MAAM,YACJ,YAEA,OAAO,SAAS,QAAQ,OAAO,MAC7BA,WAA0B,oCAAoC,EAAE,SAAS,CAC3E;AAaF,MAAM,cACJ,QACA,MACA,QACA,YAEA,OAAO,IAAI,aAAa;CACtB,MAAM,QAAQ,OAAO,OAAO,QAAQ,OAAO;CAC3C,MAAM,SAAS,OAAO,OAAO,QAAQ,QAAQ;CAC7C,IAAI,OAAO,OAAO,KAAK,KAAK,OAAO,OAAO,MAAM,GAC9C,OAAO,OAAOA,WAA0B,iDAAiD;CAE3F,IAAI,OAAO,OAAO,MAAM,GAAG;EACzB,IAAI,WAAW,QACb,OAAO,OAAOA,WAA0B,gCAAgC;EAE1E,IAAI,CAAC,KAAK,QACR,OAAO,OAAOA,WAA0B,uCAAuC;EACjF,MAAM,QAAQ,OAAO,kBACnB,QACA,mBACA,yBACA,OACF;EACA,OAAO;GAAE,MAAM;GAAU,QAAQ,OAAO;GAAO;EAAM;CACvD;CACA,IAAI,OAAO,OAAO,KAAK,GAAG;EACxB,IAAI,CAAC,KAAK,OACR,OAAO,OAAOA,WAA0B,uCAAuC;EACjF,MAAM,UAAU,OAAO,kBACrB,QACA,qBACA,mBACA,OACF;EACA,OAAO;GAAE,MAAM;GAAS,OAAO,MAAM;GAAO;EAAQ;CACtD;CACA,IAAI,WAAW,SAAS,WAAW,QAAQ,OAAO,EAAE,MAAM,qBAAqB;CAC/E,OAAO,OAAOA,WAA0B,uCAAuC;AACjF,CAAC;;;;;;;;AASH,MAAa,UACX,SACA,MACA,YAEA,OAAO,IAAI,aAAa;CACtB,MAAM,SAAS,QAAQ;CACvB,MAAM,YAAY,aAAa,QAAQ,GAAG;CAC1C,IAAI,WAAW,SAAS,WAAW,QACjC,OAAO,OAAO,WAAW,WAAW,MAAM,QAAQ,OAAO;CAE3D,IAAI,WAAW,QACb,OAAO,OAAOC,iBAAgC,QAAQ,CAAC,OAAO,MAAM,CAAC;CAEvE,MAAM,cAAc,iBAAiB,QAAQ,QAAQ,eAAe;CACpE,IAAI,gBAAgB,KAAA,GAClB,OAAO,OAAOC,qBACZ,0CAA0C,KAAK,IAAI,aAAa,MAAM,eACxE;CAEF,IAAI,UAAU,WAAW,GACvB,OAAO,OAAOA,qBACZ,wBAAwB,YAAY,WAAW,WAAW,2BAC5D;CAEF,OAAO,OAAO,MAAM,MAAM,WAAW,CAAC,CAAC,KACrC,MAAM,KAAK,EAAE,WAAW,KAAK,SAC3B,OAAO,IAAI,aAAa;EACtB,MAAM,OAAO,OAAO,SAAS,OAAO;EACpC,OAAO,OAAO,WACZ,MAAM,WAAW,IAAI,gBAAgB,IAAI,CAAC,GAC1C,MACA,QACA,OACF;CACF,CAAC,CACH,GACA,MAAM,KAAK,EAAE,WAAW,aAAa,SACnC,OAAO,IAAI,aAAa;EACtB,IAAI,CAAC,KAAK,OACR,OAAO,OAAOA,qBACZ,uCACF;EAEF,IAAI,UAAU,IAAI,OAAO,KAAK,UAAU,IAAI,QAAQ,GAClD,OAAO,OAAOF,WACZ,KAAK,aAAa,0DACpB;EASF,OAAO;GAAE,MAAM;GAAS,OAAA,OAPH,SAAS,OAAO;GAON,SAAA,OANR,kBACrB,WACA,qBACA,mBACA,OACF;EACuC;CACzC,CAAC,CACH,GACA,MAAM,KAAK,EAAE,WAAW,cAAc,SACpC,OAAO,IAAI,aAAa;EACtB,IAAI,CAAC,KAAK,QACR,OAAO,OAAOE,qBACZ,uCACF;EAEF,IAAI,UAAU,IAAI,OAAO,KAAK,UAAU,IAAI,QAAQ,GAClD,OAAO,OAAOF,WACZ,KAAK,cAAc,0DACrB;EASF,OAAO;GAAE,MAAM;GAAU,QAAA,OAPH,SAAS,OAAO;GAOL,OAAA,OANZ,kBACnB,WACA,mBACA,yBACA,OACF;EACuC;CACzC,CAAC,CACH,GACA,MAAM,QAAQ,UACZ,OAAO,IAAI,aAAa;EACtB,OAAO,OAAOE,qBACZ,6BAA6B,MAAM,UAAU,cAAc,KAAK,IAAI,aAAa,MAAM,eACzF;CACF,CAAC,CACH,CACF;AACF,CAAC"}