@thomasfosterau/effect-rdf 0.0.0 → 0.1.0

package/dist/Protocol-DlSoiIKB.d.mts

@@ -0,0 +1,108 @@
+import { n as DatasetSpec } from "./Store-D0jmVfb3.mjs";
+import { t as ProtocolError } from "./ProtocolErrors-Ckfejnl6.mjs";
+import * as Effect from "effect/Effect";
+import * as HttpServerRequest from "effect/http/HttpServerRequest";
+declare namespace Protocol_d_exports {
+  export { ContentType, EndpointKind, FORM, Operation, SPARQL_QUERY, SPARQL_UPDATE, datasetFromParams, decode, isNonUtf8, parseContentType, searchParams };
+}
+/**
+ * The media type of a direct `POST` query body.
+ *
+ * @since 0.1.0
+ * @category media types
+ */
+declare const SPARQL_QUERY = "application/sparql-query";
+/**
+ * The media type of a direct `POST` update body.
+ *
+ * @since 0.1.0
+ * @category media types
+ */
+declare const SPARQL_UPDATE = "application/sparql-update";
+/**
+ * The media type of form-encoded requests.
+ *
+ * @since 0.1.0
+ * @category media types
+ */
+declare const FORM = "application/x-www-form-urlencoded";
+/**
+ * A decoded protocol operation.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+type Operation = {
+  readonly _tag: 'Query';
+  readonly query: string;
+  /** The protocol dataset (`default-graph-uri` / `named-graph-uri`), if any. */
+  readonly dataset: DatasetSpec | undefined;
+} | {
+  readonly _tag: 'Update';
+  readonly update: string;
+  /** The protocol dataset (`using-graph-uri` / `using-named-graph-uri`), if any. */
+  readonly using: DatasetSpec | undefined;
+} | {
+  readonly _tag: 'ServiceDescription';
+};
+/**
+ * A parsed `Content-Type` header.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface ContentType {
+  readonly mediaType: string;
+  readonly parameters: Readonly<Record<string, string>>;
+}
+/**
+ * Parses a `Content-Type` header (media type lower-cased, parameter names
+ * lower-cased, quotes removed).
+ *
+ * @since 0.1.0
+ * @category parsing
+ */
+declare const parseContentType: (header: string | undefined) => ContentType | undefined;
+/**
+ * Whether a content type declares a charset other than UTF-8.
+ *
+ * @since 0.1.0
+ * @category parsing
+ */
+declare const isNonUtf8: (contentType: ContentType) => boolean;
+/**
+ * The query string parameters of a request URL.
+ *
+ * @since 0.1.0
+ * @category parsing
+ */
+declare const searchParams: (url: string) => URLSearchParams;
+/**
+ * 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
+ */
+declare const datasetFromParams: (params: URLSearchParams, defaultName: string, namedName: string, baseIri: string) => Effect.Effect<DatasetSpec | undefined, ProtocolError>;
+/**
+ * What a SPARQL endpoint accepts.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface EndpointKind {
+  readonly query: boolean;
+  readonly update: boolean;
+}
+/**
+ * Decodes a request to the SPARQL endpoint. `baseIri` resolves relative
+ * graph IRIs in the dataset parameters.
+ *
+ * @since 0.1.0
+ * @category decoding
+ */
+declare const decode: (request: HttpServerRequest.HttpServerRequest, kind: EndpointKind, baseIri: string) => Effect.Effect<Operation, ProtocolError>;
+export { Protocol_d_exports as a, datasetFromParams as c, parseContentType as d, searchParams as f, Operation as i, decode as l, EndpointKind as n, SPARQL_QUERY as o, FORM as r, SPARQL_UPDATE as s, ContentType as t, isNonUtf8 as u };
+//# sourceMappingURL=Protocol-DlSoiIKB.d.mts.map

package/dist/ProtocolErrors-Ckfejnl6.d.mts

@@ -0,0 +1,84 @@
+import * as Schema from "effect/Schema";
+import * as HttpServerResponse from "effect/http/HttpServerResponse";
+declare namespace ProtocolErrors_d_exports {
+  export { ProtocolError, badRequest, forbidden, internal, methodNotAllowed, notAcceptable, notFound, timeout, toResponse, unsupportedMediaType };
+}
+declare const ProtocolError_base: Schema.Class<ProtocolError, Schema.TaggedStruct<"ProtocolError", {
+  readonly status: Schema.Number;
+  readonly message: Schema.String;
+  readonly headers: Schema.optional<Schema.$Record<Schema.String, Schema.String>>;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * A protocol-level failure: the HTTP status, a human-readable message (sent
+ * as a `text/plain` body) and extra response headers (e.g. `Allow`).
+ *
+ * @since 0.1.0
+ * @category errors
+ */
+declare class ProtocolError extends ProtocolError_base {}
+/**
+ * `400 Bad Request`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const badRequest: (message: string) => ProtocolError;
+/**
+ * `403 Forbidden`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const forbidden: (message: string) => ProtocolError;
+/**
+ * `404 Not Found`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const notFound: (message: string) => ProtocolError;
+/**
+ * `405 Method Not Allowed` with an `Allow` header.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const methodNotAllowed: (method: string, allow: ReadonlyArray<string>) => ProtocolError;
+/**
+ * `406 Not Acceptable`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const notAcceptable: (accept: string, available: ReadonlyArray<string>) => ProtocolError;
+/**
+ * `415 Unsupported Media Type`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const unsupportedMediaType: (message: string) => ProtocolError;
+/**
+ * `500 Internal Server Error`.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const internal: (message: string) => ProtocolError;
+/**
+ * `503 Service Unavailable`, used when a query exceeds the configured
+ * timeout.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const timeout: (message: string) => ProtocolError;
+/**
+ * Renders a protocol error as a `text/plain` response.
+ *
+ * @since 0.1.0
+ * @category conversions
+ */
+declare const toResponse: (error: ProtocolError) => HttpServerResponse.HttpServerResponse;
+export { internal as a, notFound as c, unsupportedMediaType as d, forbidden as i, timeout as l, ProtocolErrors_d_exports as n, methodNotAllowed as o, badRequest as r, notAcceptable as s, ProtocolError as t, toResponse as u };
+//# sourceMappingURL=ProtocolErrors-Ckfejnl6.d.mts.map

package/dist/ProtocolErrors-czDPVcX5.mjs

@@ -0,0 +1,129 @@
+import { t as __exportAll } from "./rolldown-runtime-D8jQpDG7.mjs";
+import * as Schema from "effect/Schema";
+import * as HttpServerResponse from "effect/http/HttpServerResponse";
+// src/sparql/ProtocolErrors.ts
+/**
+* Errors of the protocol layer. Every failure of a protocol request is
+* mapped to a `ProtocolError` carrying the HTTP status to answer with.
+*
+* @since 0.1.0
+*/
+var ProtocolErrors_exports = /* @__PURE__ */ __exportAll({
+	ProtocolError: () => ProtocolError,
+	badRequest: () => badRequest,
+	forbidden: () => forbidden,
+	internal: () => internal,
+	methodNotAllowed: () => methodNotAllowed,
+	notAcceptable: () => notAcceptable,
+	notFound: () => notFound,
+	timeout: () => timeout,
+	toResponse: () => toResponse,
+	unsupportedMediaType: () => unsupportedMediaType
+});
+/**
+* A protocol-level failure: the HTTP status, a human-readable message (sent
+* as a `text/plain` body) and extra response headers (e.g. `Allow`).
+*
+* @since 0.1.0
+* @category errors
+*/
+var ProtocolError = class extends Schema.TaggedError()("ProtocolError", {
+	status: Schema.Number,
+	message: Schema.String,
+	headers: Schema.optional(Schema.Record(Schema.String, Schema.String))
+}) {};
+/**
+* `400 Bad Request`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const badRequest = (message) => new ProtocolError({
+	status: 400,
+	message
+});
+/**
+* `403 Forbidden`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const forbidden = (message) => new ProtocolError({
+	status: 403,
+	message
+});
+/**
+* `404 Not Found`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const notFound = (message) => new ProtocolError({
+	status: 404,
+	message
+});
+/**
+* `405 Method Not Allowed` with an `Allow` header.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const methodNotAllowed = (method, allow) => new ProtocolError({
+	status: 405,
+	message: `Method ${method} is not allowed here (allowed: ${allow.join(", ")})`,
+	headers: { allow: allow.join(", ") }
+});
+/**
+* `406 Not Acceptable`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const notAcceptable = (accept, available) => new ProtocolError({
+	status: 406,
+	message: `None of the requested media types (${accept}) is available; available: ${available.join(", ")}`
+});
+/**
+* `415 Unsupported Media Type`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const unsupportedMediaType = (message) => new ProtocolError({
+	status: 415,
+	message
+});
+/**
+* `500 Internal Server Error`.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const internal = (message) => new ProtocolError({
+	status: 500,
+	message
+});
+/**
+* `503 Service Unavailable`, used when a query exceeds the configured
+* timeout.
+*
+* @since 0.1.0
+* @category constructors
+*/
+const timeout = (message) => new ProtocolError({
+	status: 503,
+	message
+});
+/**
+* Renders a protocol error as a `text/plain` response.
+*
+* @since 0.1.0
+* @category conversions
+*/
+const toResponse = (error) => HttpServerResponse.text(`${error.message}\n`, {
+	status: error.status,
+	headers: error.headers ?? {}
+});
+export { internal as a, notFound as c, unsupportedMediaType as d, forbidden as i, timeout as l, ProtocolErrors_exports as n, methodNotAllowed as o, badRequest as r, notAcceptable as s, ProtocolError as t, toResponse as u };
+
+//# sourceMappingURL=ProtocolErrors-czDPVcX5.mjs.map

package/dist/ProtocolErrors-czDPVcX5.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProtocolErrors-czDPVcX5.mjs","names":[],"sources":["../src/sparql/ProtocolErrors.ts"],"sourcesContent":["/**\n * Errors of the protocol layer. Every failure of a protocol request is\n * mapped to a `ProtocolError` carrying the HTTP status to answer with.\n *\n * @since 0.1.0\n */\nimport * as Schema from 'effect/Schema';\nimport * as HttpServerResponse from 'effect/http/HttpServerResponse';\n\n/**\n * A protocol-level failure: the HTTP status, a human-readable message (sent\n * as a `text/plain` body) and extra response headers (e.g. `Allow`).\n *\n * @since 0.1.0\n * @category errors\n */\nexport class ProtocolError extends Schema.TaggedError<ProtocolError>()('ProtocolError', {\n  status: Schema.Number,\n  message: Schema.String,\n  headers: Schema.optional(Schema.Record(Schema.String, Schema.String)),\n}) {}\n\n/**\n * `400 Bad Request`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const badRequest = (message: string): ProtocolError =>\n  new ProtocolError({ status: 400, message });\n\n/**\n * `403 Forbidden`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const forbidden = (message: string): ProtocolError =>\n  new ProtocolError({ status: 403, message });\n\n/**\n * `404 Not Found`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const notFound = (message: string): ProtocolError =>\n  new ProtocolError({ status: 404, message });\n\n/**\n * `405 Method Not Allowed` with an `Allow` header.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const methodNotAllowed = (method: string, allow: ReadonlyArray<string>): ProtocolError =>\n  new ProtocolError({\n    status: 405,\n    message: `Method ${method} is not allowed here (allowed: ${allow.join(', ')})`,\n    headers: { allow: allow.join(', ') },\n  });\n\n/**\n * `406 Not Acceptable`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const notAcceptable = (accept: string, available: ReadonlyArray<string>): ProtocolError =>\n  new ProtocolError({\n    status: 406,\n    message: `None of the requested media types (${accept}) is available; available: ${available.join(', ')}`,\n  });\n\n/**\n * `415 Unsupported Media Type`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const unsupportedMediaType = (message: string): ProtocolError =>\n  new ProtocolError({ status: 415, message });\n\n/**\n * `500 Internal Server Error`.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const internal = (message: string): ProtocolError =>\n  new ProtocolError({ status: 500, message });\n\n/**\n * `503 Service Unavailable`, used when a query exceeds the configured\n * timeout.\n *\n * @since 0.1.0\n * @category constructors\n */\nexport const timeout = (message: string): ProtocolError =>\n  new ProtocolError({ status: 503, message });\n\n/**\n * Renders a protocol error as a `text/plain` response.\n *\n * @since 0.1.0\n * @category conversions\n */\nexport const toResponse = (error: ProtocolError): HttpServerResponse.HttpServerResponse =>\n  HttpServerResponse.text(`${error.message}\\n`, {\n    status: error.status,\n    headers: error.headers ?? {},\n  });\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgBA,IAAa,gBAAb,cAAmC,OAAO,YAA2B,CAAC,CAAC,iBAAiB;CACtF,QAAQ,OAAO;CACf,SAAS,OAAO;CAChB,SAAS,OAAO,SAAS,OAAO,OAAO,OAAO,QAAQ,OAAO,MAAM,CAAC;AACtE,CAAC,CAAC,CAAC,CAAC;;;;;;;AAQJ,MAAa,cAAc,YACzB,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;AAQ5C,MAAa,aAAa,YACxB,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;AAQ5C,MAAa,YAAY,YACvB,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;AAQ5C,MAAa,oBAAoB,QAAgB,UAC/C,IAAI,cAAc;CAChB,QAAQ;CACR,SAAS,UAAU,OAAO,iCAAiC,MAAM,KAAK,IAAI,EAAE;CAC5E,SAAS,EAAE,OAAO,MAAM,KAAK,IAAI,EAAE;AACrC,CAAC;;;;;;;AAQH,MAAa,iBAAiB,QAAgB,cAC5C,IAAI,cAAc;CAChB,QAAQ;CACR,SAAS,sCAAsC,OAAO,6BAA6B,UAAU,KAAK,IAAI;AACxG,CAAC;;;;;;;AAQH,MAAa,wBAAwB,YACnC,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;AAQ5C,MAAa,YAAY,YACvB,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;;AAS5C,MAAa,WAAW,YACtB,IAAI,cAAc;CAAE,QAAQ;CAAK;AAAQ,CAAC;;;;;;;AAQ5C,MAAa,cAAc,UACzB,mBAAmB,KAAK,GAAG,MAAM,QAAQ,KAAK;CAC5C,QAAQ,MAAM;CACd,SAAS,MAAM,WAAW,CAAC;AAC7B,CAAC"}