ldkit 2.3.0 → 2.4.0

package/script/cli.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_process_1 = require("node:process");
+const node_util_1 = require("node:util");
+const node_fs_1 = require("node:fs");
+const commander_1 = require("commander");
+const context_to_schema_js_1 = require("./scripts/context_to_schema.js");
+const shex_to_schema_js_1 = require("./scripts/shex_to_schema.js");
+const schema_to_script_js_1 = require("./scripts/schema_to_script.js");
+const asciiArt = String.raw `
+  _     ____  _    _ _   
+ | |   |  _ \| | _(_) |_ 
+ | |   | | | | |/ / | __|
+ | |___| |_| |   <| | |_ 
+ |_____|____/|_|\_\_|\__|
+                                                              
+`;
+const program = new commander_1.Command();
+program
+    .name("ldkit")
+    .description("LDkit CLI utilities for Linked Data")
+    .helpOption(false)
+    .showHelpAfterError()
+    .configureHelp({
+    styleCommandDescription: (str) => (0, node_util_1.styleText)("gray", str),
+    styleDescriptionText: (str) => (0, node_util_1.styleText)("gray", str),
+    styleCommandText: (str) => (0, node_util_1.styleText)("cyan", str),
+    styleArgumentText: (str) => (0, node_util_1.styleText)("yellow", str),
+    styleSubcommandText: (str) => (0, node_util_1.styleText)("cyan", str),
+})
+    .configureOutput({
+    outputError: (str, write) => write((0, node_util_1.styleText)("red", str)),
+    stripColor: (str) => str,
+});
+program.command("context-to-schema")
+    .description("Convert a JSON-LD context from a file or URL to a LDkit schema")
+    .addArgument(new commander_1.Argument("<method>", "type of input").choices([
+    "url",
+    "file",
+    "arg",
+]))
+    .argument("<input>", "input JSON-LD context - file, URL, or string")
+    .action(async (method, input) => {
+    try {
+        const resolvedInput = await resolve(method, input);
+        const schema = await (0, context_to_schema_js_1.contextToSchema)(JSON.parse(resolvedInput));
+        console.log((0, schema_to_script_js_1.schemaToScript)(schema));
+    }
+    catch (error) {
+        console.error((0, node_util_1.styleText)("red", `${error.message}`));
+    }
+});
+program.command("shexc-to-schema")
+    .description("Convert a ShExC schema from a file or URL to a LDkit schema")
+    .addArgument(new commander_1.Argument("<method>", "type of input").choices([
+    "url",
+    "file",
+    "arg",
+]))
+    .argument("<input>", "input ShExC schema - file, URL, or string")
+    .action(async (method, input) => {
+    try {
+        const resolvedInput = await resolve(method, input);
+        const schema = (0, shex_to_schema_js_1.shexcToSchema)(resolvedInput);
+        console.log((0, schema_to_script_js_1.schemaToScript)(schema));
+    }
+    catch (error) {
+        console.error((0, node_util_1.styleText)("red", `${error.message}`));
+    }
+});
+program.command("shexj-to-schema")
+    .description("Convert a ShExJ schema from a file or URL to a LDkit schema")
+    .addArgument(new commander_1.Argument("<method>", "type of input").choices([
+    "url",
+    "file",
+    "arg",
+]))
+    .argument("<input>", "input ShExJ schema - file, URL, or string")
+    .action(async (method, input) => {
+    try {
+        const resolvedInput = await resolve(method, input);
+        const schema = (0, shex_to_schema_js_1.shexjToSchema)(JSON.parse(resolvedInput));
+        console.log((0, schema_to_script_js_1.schemaToScript)(schema));
+    }
+    catch (error) {
+        console.error((0, node_util_1.styleText)("red", `${error.message}`));
+    }
+});
+// Check if no arguments were provided
+if (node_process_1.argv.length <= 2) {
+    console.log((0, node_util_1.styleText)("red", asciiArt));
+    program.help(); // Automatically exits after printing help
+}
+else {
+    program.parse(node_process_1.argv);
+}
+async function resolve(method, input) {
+    if (method === "url") {
+        try {
+            return await fetch(input).then((res) => res.text());
+        }
+        catch (error) {
+            throw new Error(`Failed to fetch URL: ${input}.\n${error}`);
+        }
+    }
+    else if (method === "file") {
+        try {
+            return (0, node_fs_1.readFileSync)(input, "utf-8");
+        }
+        catch (error) {
+            throw new Error(`Failed to read file: ${input}.\n${error}`);
+        }
+    }
+    else if (method === "arg") {
+        return input;
+    }
+    throw new Error(`Unknown resolution method: ${method}`);
+}

package/script/library/asynciterator.d.ts

@@ -0,0 +1,30 @@
+import { AsyncIterator } from "asynciterator";
+export { ArrayIterator, type AsyncIterator, MappingIterator, } from "asynciterator";
+type TreeNode<T> = {
+    [property: string]: T[] | TreeNode<T>;
+};
+export type Tree<T> = T[] | TreeNode<T>;
+type Subtree<T> = {
+    type: "node";
+    tree: TreeNode<T>;
+    parent?: Subtree<T>;
+    items: string[];
+    path: string[];
+    index: number;
+} | {
+    type: "leaf";
+    parent?: Subtree<T>;
+    items: T[];
+    path: string[];
+    index: number;
+};
+export declare class TreeIterator<T> extends AsyncIterator<[...string[], T]> {
+    private _tree;
+    private _pointer;
+    constructor(tree: Tree<T>);
+    read(): [...string[], T] | null;
+    protected _buildPointerFromSource(tree: Tree<T>, path?: string[]): Subtree<T>;
+    protected _findNextCommonSegment(): void;
+    protected _findNextLeaf(): void;
+}
+//# sourceMappingURL=asynciterator.d.ts.map

package/script/library/asynciterator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asynciterator.d.ts","sourceRoot":"","sources":["../../src/library/asynciterator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,OAAO,EACL,aAAa,EACb,KAAK,aAAa,EAClB,eAAe,GAChB,MAAM,eAAe,CAAC;AAEvB,KAAK,QAAQ,CAAC,CAAC,IAAI;IACjB,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExC,KAAK,OAAO,CAAC,CAAC,IAAI;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,GAAG;IACF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,qBAAa,YAAY,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,QAAQ,CAAa;gBAEjB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAOhB,IAAI;IAyBb,SAAS,CAAC,uBAAuB,CAC/B,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EACb,IAAI,GAAE,MAAM,EAAO,GAClB,OAAO,CAAC,CAAC,CAAC;IA0Bb,SAAS,CAAC,sBAAsB;IAehC,SAAS,CAAC,aAAa;CAaxB"}

package/script/library/decoder.d.ts

@@ -0,0 +1,7 @@
+import type { Options } from "./options.js";
+import { Graph } from "./rdf.js";
+import type { ExpandedSchema } from "./schema/mod.js";
+export declare const decode: (graph: Graph, schema: ExpandedSchema, options: Options) => DecodedNode[];
+type DecodedNode = Record<string, unknown>;
+export {};
+//# sourceMappingURL=decoder.d.ts.map

package/script/library/decoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../../src/library/decoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAuB,MAAM,UAAU,CAAC;AACtD,OAAO,KAAK,EAAoB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAKxE,eAAO,MAAM,MAAM,UACV,KAAK,UACJ,cAAc,WACb,OAAO,kBAGjB,CAAC;AAEF,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/script/library/encoder.d.ts

@@ -0,0 +1,8 @@
+import type { Options } from "./options.js";
+import { DataFactory, type RDF } from "./rdf.js";
+import type { ExpandedSchema } from "./schema/mod.js";
+type DecodedNode = Record<string, unknown>;
+export declare const encode: (node: DecodedNode, schema: ExpandedSchema, options: Options, includeType?: boolean, variableInitCounter?: number) => RDF.Quad[];
+export declare const encodeValue: (value: unknown, datatype: string, df: DataFactory) => RDF.Literal | import("rdf-data-factory").Literal | import("rdf-data-factory").NamedNode<string>;
+export {};
+//# sourceMappingURL=encoder.d.ts.map

package/script/library/encoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../../src/library/encoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAY,KAAK,GAAG,EAAE,MAAM,UAAU,CAAC;AAC3D,OAAO,KAAK,EAAoB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAMxE,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAI3C,eAAO,MAAM,MAAM,SACX,WAAW,UACT,cAAc,WACb,OAAO,oEAWjB,CAAC;AAEF,eAAO,MAAM,WAAW,UACf,OAAO,YACJ,MAAM,MACZ,WAAW,oGAMhB,CAAC"}

package/script/library/engine/mod.d.ts

@@ -0,0 +1,3 @@
+export * from "./query_engine.js";
+export * from "./types.js";
+//# sourceMappingURL=mod.d.ts.map

package/script/library/engine/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../../src/library/engine/mod.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,YAAY,CAAC"}

package/script/library/engine/query_engine.d.ts

@@ -0,0 +1,58 @@
+import { type RDF } from "../rdf.js";
+import { type IQueryEngine, type QueryContext } from "./types.js";
+import { type ResolverType } from "./query_resolvers.js";
+/**
+ * A query engine that can query a SPARQL endpoint.
+ *
+ * Implements {@link IQueryEngine} interface.
+ *
+ * This engine is used by default if no other engine is configured.
+ * See {@link Options} for more details.
+ *
+ * If you need to query other data sources, or multiple SPARQL endpoints,
+ * you can use [Comunica](https://comunica.dev) instead, extend this engine,
+ * or implement your own.
+ */
+export declare class QueryEngine implements IQueryEngine {
+    protected getSparqlEndpoint(context?: QueryContext): string;
+    protected getFetch(context?: QueryContext): typeof fetch;
+    protected query(body: string, requestType: "application/sparql-query" | "application/sparql-update", responseType: string, context?: QueryContext): Promise<Response>;
+    protected queryAndResolve<T extends ResolverType>(type: T, query: string, context?: QueryContext): Promise<{
+        boolean: boolean;
+        bindings: RDF.ResultStream<RDF.Bindings>;
+        quads: RDF.ResultStream<RDF.Quad>;
+    }[T]>;
+    /**
+     * Executes a SPARQL SELECT query and returns a stream of bindings.
+     *
+     * @param query SPARQL query string
+     * @param context Engine context
+     * @returns Stream of bindings
+     */
+    queryBindings(query: string, context?: QueryContext): Promise<RDF.ResultStream<RDF.Bindings>>;
+    /**
+     * Executes a SPARQL ASK query and returns a boolean result.
+     *
+     * @param query SPARQL query string
+     * @param context Engine context
+     * @returns Boolean result
+     */
+    queryBoolean(query: string, context?: QueryContext): Promise<boolean>;
+    /**
+     * Executes a SPARQL CONSTRUCT query and returns a stream of quads.
+     *
+     * @param query SPARQL query string
+     * @param context Engine context
+     * @returns Stream of quads
+     */
+    queryQuads(query: string, context?: QueryContext): Promise<RDF.ResultStream<RDF.Quad>>;
+    /**
+     * Executes a SPARQL UPDATE query and returns nothing.
+     *
+     * @param query SPARQL query string
+     * @param context Engine context
+     * @returns Nothing
+     */
+    queryVoid(query: string, context?: QueryContext): Promise<void>;
+}
+//# sourceMappingURL=query_engine.d.ts.map

package/script/library/engine/query_engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query_engine.d.ts","sourceRoot":"","sources":["../../../src/library/engine/query_engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAGL,KAAK,YAAY,EAClB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;GAWG;AACH,qBAAa,WAAY,YAAW,YAAY;IAC9C,SAAS,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,MAAM;IAkC3D,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,KAAK;IAIxD,SAAS,CAAC,KAAK,CACb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,0BAA0B,GAAG,2BAA2B,EACrE,YAAY,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,QAAQ,CAAC;cAaJ,eAAe,CAAC,CAAC,SAAS,YAAY,EACpD,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY;;kBArEL,IAAK,YAAY,CAAC,IAAI,QAEzC;eAAa,IAAK,YAAY,CAAE,IAAG,IAAI;;IAuFvC;;;;;;OAMG;IACI,aAAa,CAClB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAI1C;;;;;;OAMG;IACI,YAAY,CACjB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;OAMG;IACH,UAAU,CACR,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAItC;;;;;;OAMG;IACG,SAAS,CACb,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,IAAI,CAAC;CAQjB"}

package/script/library/engine/query_engine_proxy.d.ts

@@ -0,0 +1,12 @@
+import { type RDF } from "../rdf.js";
+import type { IQueryEngine, QueryContext } from "./types.js";
+export declare class QueryEngineProxy {
+    private readonly engine;
+    private readonly context;
+    constructor(engine: IQueryEngine, context: QueryContext);
+    queryBoolean(query: string): Promise<boolean>;
+    queryBindings(query: string): Promise<RDF.Bindings[]>;
+    queryGraph(query: string): Promise<import("../rdf.js").Graph>;
+    queryVoid(query: string): Promise<void>;
+}
+//# sourceMappingURL=query_engine_proxy.d.ts.map

package/script/library/engine/query_engine_proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query_engine_proxy.d.ts","sourceRoot":"","sources":["../../../src/library/engine/query_engine_proxy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,KAAK,GAAG,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE7D,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;gBAE3B,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY;IAKvD,YAAY,CAAC,KAAK,EAAE,MAAM;IAIpB,aAAa,CAAC,KAAK,EAAE,MAAM;IAQ3B,UAAU,CAAC,KAAK,EAAE,MAAM;IAQ9B,SAAS,CAAC,KAAK,EAAE,MAAM;CAGxB"}

package/script/library/engine/query_resolvers.d.ts

@@ -0,0 +1,11 @@
+import { type RDF } from "../rdf.js";
+type ResolveFormat = {
+    "boolean": boolean;
+    "bindings": RDF.ResultStream<RDF.Bindings>;
+    "quads": RDF.ResultStream<RDF.Quad>;
+};
+export type ResolverType = keyof ResolveFormat;
+export declare const getResponseTypes: (resolverType: ResolverType) => string[];
+export declare const resolve: <T extends ResolverType>(resolverType: T, response: Response) => Promise<ResolveFormat[T]>;
+export {};
+//# sourceMappingURL=query_resolvers.d.ts.map

package/script/library/engine/query_resolvers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query_resolvers.d.ts","sourceRoot":"","sources":["../../../src/library/engine/query_resolvers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoC,KAAK,GAAG,EAAW,MAAM,WAAW,CAAC;AAOhF,KAAK,aAAa,GAAG;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC3C,OAAO,EAAE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC;AAmH/C,eAAO,MAAM,gBAAgB,iBAAkB,YAAY,aACrB,CAAC;AAEvC,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,YAAY,gBAC9B,CAAC,YACL,QAAQ,8BAkBnB,CAAC"}

package/script/library/engine/types.d.ts

@@ -0,0 +1,24 @@
+import type { IQueryContextCommon, QuerySourceUnidentified } from "@comunica/types";
+import { RDF } from "../rdf.js";
+/**
+ * A set of context entries that can be passed to a query engine,
+ * such as data sources, fetch configuration, etc.
+ *
+ * @example
+ * ```typescript
+ * import { QueryContext, QueryEngine } from "ldkit";
+ *
+ * const context: QueryContext = {
+ *   sources: ["https://dbpedia.org/sparql"],
+ * };
+ *
+ * const engine = new QueryEngine();
+ * await engine.queryBoolean("ASK { ?s ?p ?o }", context);
+ * ```
+ */
+export type QueryContext = RDF.QueryStringContext & RDF.QuerySourceContext<QuerySourceUnidentified> & IQueryContextCommon;
+/**
+ * Interface of a query engine compatible with LDkit
+ */
+export type IQueryEngine = RDF.StringSparqlQueryable<RDF.SparqlResultSupport, QueryContext>;
+//# sourceMappingURL=types.d.ts.map

package/script/library/engine/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/library/engine/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,uBAAuB,EACxB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,YAAY,GACpB,GAAG,CAAC,kBAAkB,GACtB,GAAG,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,GAC/C,mBAAmB,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,GAAG,CAAC,qBAAqB,CAClD,GAAG,CAAC,mBAAmB,EACvB,YAAY,CACb,CAAC"}