ldkit 1.1.0 → 2.1.0

package/types/rdf.d.ts

@@ -1 +1,14 @@
-export * from "./library/rdf.js";
+/**
+ * RDF utilities
+ *
+ * This module contains a re-export of external RDF libraries that are used
+ * in LDkit and may be used in tandem with LDkit in Linked Data applications as well.
+ *
+ * Included packages:
+ * - [@rdfjs/types](https://github.com/rdfjs/types) [RDF/JS](https://rdf.js.org/) authoritative TypeScript typings
+ * - [n3](https://rdf.js.org/N3.js/) RDF parser and serializer
+ * - [rdf-data-factory](https://github.com/rubensworks/rdf-data-factory.js) A TypeScript/JavaScript implementation of the RDF/JS data factory
+ * - [rdf-literal](https://github.com/rubensworks/rdf-literal.js) Translates between RDF literals and JavaScript primitives
+ * @module
+ */
+export { DataFactory, DefaultGraph, fromRdf, N3, type RDF, toRdf, } from "./library/rdf.js";

package/types/sparql.d.ts

@@ -1 +1,14 @@
+/**
+ * SPARQL builders that provide a fluent interface for building SPARQL queries
+ *
+ * @example
+ * ```typescript
+ * import { SELECT } from "ldkit/sparql";
+ *
+ * const query = SELECT`?s ?p ?o`.WHERE`?s ?p ?o`.LIMIT(10).build();
+ * console.log(query); // SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 10;
+ * ```
+ *
+ * @module
+ */
 export * from "./library/sparql/mod.js";

package/esm/library/global.js

@@ -1,25 +0,0 @@
-import { QueryEngine } from "./engine/mod.js";
-let defaultContext = undefined;
-let defaultEngine = undefined;
-export const setDefaultContext = (context) => {
-    defaultContext = context;
-};
-export const resolveContext = (context) => {
-    if (!context && !defaultContext) {
-        throw new Error("No context found. Please create a default context or pass one to createLens function");
-    }
-    return context || defaultContext;
-};
-export const setDefaultEngine = (engine) => {
-    defaultEngine = engine;
-};
-export const resolveEngine = (engine) => {
-    if (!engine && !defaultEngine) {
-        setDefaultEngine(new QueryEngine());
-        // TODO: consider the consequences here, maybe log a warning?
-        /*throw new Error(
-          "No engine found. Please create a default engine or pass one to createLens function",
-        );*/
-    }
-    return engine || defaultEngine;
-};

package/esm/library/lens/query_helper.js

@@ -1,102 +0,0 @@
-import { encode } from "../encoder.js";
-export class QueryHelper {
-    constructor(entity, schema, context, variableInitCounter = 0) {
-        Object.defineProperty(this, "entity", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "schema", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "context", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "variableInitCounter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "quads", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "variableQuads", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.entity = entity;
-        this.schema = schema;
-        this.context = context;
-        this.variableInitCounter = variableInitCounter;
-    }
-    getQuads() {
-        if (!this.quads) {
-            this.quads = encode(this.entity, this.schema, this.context, this.variableInitCounter);
-        }
-        return this.quads;
-    }
-    getVariableQuads() {
-        if (!this.variableQuads) {
-            this.variableQuads = encode(this.getEntityWithReplacedVariables(), this.schema, this.context, this.variableInitCounter);
-        }
-        return this.variableQuads;
-    }
-    getDeleteQuads() {
-        return this.getVariableQuads().filter((quad) => quad.object.termType === "Variable");
-    }
-    getInsertQuads() {
-        return this.getQuads();
-    }
-    getWhereQuads() {
-        return this.getVariableQuads();
-    }
-    getEntityWithReplacedVariables() {
-        return this.replaceVariables(this.entity, this.schema);
-    }
-    replaceVariables(entity, schema) {
-        return Object.keys(entity).reduce((output, key) => {
-            const value = entity[key];
-            if (key === "$id") {
-                output.$id = value;
-                return output;
-            }
-            if (key === "$type") {
-                output.$type = value;
-                return output;
-            }
-            const property = schema[key];
-            if (!property) {
-                throw new Error("Unknown field '${key}' detected in entity");
-            }
-            if (!property["@context"]) {
-                output[key] = null;
-                return output;
-            }
-            if (property["@array"]) {
-                if (value.length === 0) {
-                    output[key] = null;
-                }
-                else {
-                    output[key] = value.map((subEntity) => this.replaceVariables(subEntity, property["@context"]));
-                }
-            }
-            else {
-                output[key] = this.replaceVariables(value, property["@context"]);
-            }
-            return output;
-        }, {});
-    }
-}

package/esm/library/namespaces/ldkit.js

@@ -1,6 +0,0 @@
-import { createNamespace } from "./namespace.js";
-export default createNamespace({
-    iri: "http://ldkit/",
-    prefix: "ldkit:",
-    terms: ["Resource"],
-});

package/esm/library/namespaces/mod.js

@@ -1,13 +0,0 @@
-export { default as dbo } from "./dbo.js";
-export { default as dc } from "./dc.js";
-export { default as dcterms } from "./dcterms.js";
-export { default as foaf } from "./foaf.js";
-export { default as gr } from "./gr.js";
-export { default as ldkit } from "./ldkit.js";
-export { default as rdf } from "./rdf.js";
-export { default as rdfs } from "./rdfs.js";
-export { default as schema } from "./schema.js";
-export { default as sioc } from "./sioc.js";
-export { default as skos } from "./skos.js";
-export { default as xsd } from "./xsd.js";
-export { createNamespace } from "./namespace.js";

package/esm/library/namespaces/namespace.js

@@ -1,11 +0,0 @@
-export const createNamespace = (namespaceSpec) => Object.assign(
-//<X extends I>(f: [X]) =>
-//  `${namespaceSpec.prefix}:${f}` as `${string & P}${string & X}`,
-namespaceSpec.terms.reduce((acc, term) => {
-    //acc[term] = `${namespaceSpec.prefix}${term}`
-    acc[term] = `${namespaceSpec.iri}${term}`;
-    return acc;
-}, {}), {
-    $prefix: namespaceSpec["prefix"],
-    $iri: namespaceSpec["iri"],
-});

package/script/library/global.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveEngine = exports.setDefaultEngine = exports.resolveContext = exports.setDefaultContext = void 0;
-const mod_js_1 = require("./engine/mod.js");
-let defaultContext = undefined;
-let defaultEngine = undefined;
-const setDefaultContext = (context) => {
-    defaultContext = context;
-};
-exports.setDefaultContext = setDefaultContext;
-const resolveContext = (context) => {
-    if (!context && !defaultContext) {
-        throw new Error("No context found. Please create a default context or pass one to createLens function");
-    }
-    return context || defaultContext;
-};
-exports.resolveContext = resolveContext;
-const setDefaultEngine = (engine) => {
-    defaultEngine = engine;
-};
-exports.setDefaultEngine = setDefaultEngine;
-const resolveEngine = (engine) => {
-    if (!engine && !defaultEngine) {
-        (0, exports.setDefaultEngine)(new mod_js_1.QueryEngine());
-        // TODO: consider the consequences here, maybe log a warning?
-        /*throw new Error(
-          "No engine found. Please create a default engine or pass one to createLens function",
-        );*/
-    }
-    return engine || defaultEngine;
-};
-exports.resolveEngine = resolveEngine;

package/script/library/lens/query_helper.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryHelper = void 0;
-const encoder_js_1 = require("../encoder.js");
-class QueryHelper {
-    constructor(entity, schema, context, variableInitCounter = 0) {
-        Object.defineProperty(this, "entity", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "schema", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "context", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "variableInitCounter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "quads", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "variableQuads", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.entity = entity;
-        this.schema = schema;
-        this.context = context;
-        this.variableInitCounter = variableInitCounter;
-    }
-    getQuads() {
-        if (!this.quads) {
-            this.quads = (0, encoder_js_1.encode)(this.entity, this.schema, this.context, this.variableInitCounter);
-        }
-        return this.quads;
-    }
-    getVariableQuads() {
-        if (!this.variableQuads) {
-            this.variableQuads = (0, encoder_js_1.encode)(this.getEntityWithReplacedVariables(), this.schema, this.context, this.variableInitCounter);
-        }
-        return this.variableQuads;
-    }
-    getDeleteQuads() {
-        return this.getVariableQuads().filter((quad) => quad.object.termType === "Variable");
-    }
-    getInsertQuads() {
-        return this.getQuads();
-    }
-    getWhereQuads() {
-        return this.getVariableQuads();
-    }
-    getEntityWithReplacedVariables() {
-        return this.replaceVariables(this.entity, this.schema);
-    }
-    replaceVariables(entity, schema) {
-        return Object.keys(entity).reduce((output, key) => {
-            const value = entity[key];
-            if (key === "$id") {
-                output.$id = value;
-                return output;
-            }
-            if (key === "$type") {
-                output.$type = value;
-                return output;
-            }
-            const property = schema[key];
-            if (!property) {
-                throw new Error("Unknown field '${key}' detected in entity");
-            }
-            if (!property["@context"]) {
-                output[key] = null;
-                return output;
-            }
-            if (property["@array"]) {
-                if (value.length === 0) {
-                    output[key] = null;
-                }
-                else {
-                    output[key] = value.map((subEntity) => this.replaceVariables(subEntity, property["@context"]));
-                }
-            }
-            else {
-                output[key] = this.replaceVariables(value, property["@context"]);
-            }
-            return output;
-        }, {});
-    }
-}
-exports.QueryHelper = QueryHelper;

package/script/library/namespaces/ldkit.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const namespace_js_1 = require("./namespace.js");
-exports.default = (0, namespace_js_1.createNamespace)({
-    iri: "http://ldkit/",
-    prefix: "ldkit:",
-    terms: ["Resource"],
-});

package/script/library/namespaces/mod.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNamespace = exports.xsd = exports.skos = exports.sioc = exports.schema = exports.rdfs = exports.rdf = exports.ldkit = exports.gr = exports.foaf = exports.dcterms = exports.dc = exports.dbo = void 0;
-var dbo_js_1 = require("./dbo.js");
-Object.defineProperty(exports, "dbo", { enumerable: true, get: function () { return __importDefault(dbo_js_1).default; } });
-var dc_js_1 = require("./dc.js");
-Object.defineProperty(exports, "dc", { enumerable: true, get: function () { return __importDefault(dc_js_1).default; } });
-var dcterms_js_1 = require("./dcterms.js");
-Object.defineProperty(exports, "dcterms", { enumerable: true, get: function () { return __importDefault(dcterms_js_1).default; } });
-var foaf_js_1 = require("./foaf.js");
-Object.defineProperty(exports, "foaf", { enumerable: true, get: function () { return __importDefault(foaf_js_1).default; } });
-var gr_js_1 = require("./gr.js");
-Object.defineProperty(exports, "gr", { enumerable: true, get: function () { return __importDefault(gr_js_1).default; } });
-var ldkit_js_1 = require("./ldkit.js");
-Object.defineProperty(exports, "ldkit", { enumerable: true, get: function () { return __importDefault(ldkit_js_1).default; } });
-var rdf_js_1 = require("./rdf.js");
-Object.defineProperty(exports, "rdf", { enumerable: true, get: function () { return __importDefault(rdf_js_1).default; } });
-var rdfs_js_1 = require("./rdfs.js");
-Object.defineProperty(exports, "rdfs", { enumerable: true, get: function () { return __importDefault(rdfs_js_1).default; } });
-var schema_js_1 = require("./schema.js");
-Object.defineProperty(exports, "schema", { enumerable: true, get: function () { return __importDefault(schema_js_1).default; } });
-var sioc_js_1 = require("./sioc.js");
-Object.defineProperty(exports, "sioc", { enumerable: true, get: function () { return __importDefault(sioc_js_1).default; } });
-var skos_js_1 = require("./skos.js");
-Object.defineProperty(exports, "skos", { enumerable: true, get: function () { return __importDefault(skos_js_1).default; } });
-var xsd_js_1 = require("./xsd.js");
-Object.defineProperty(exports, "xsd", { enumerable: true, get: function () { return __importDefault(xsd_js_1).default; } });
-var namespace_js_1 = require("./namespace.js");
-Object.defineProperty(exports, "createNamespace", { enumerable: true, get: function () { return namespace_js_1.createNamespace; } });

package/script/library/namespaces/namespace.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNamespace = void 0;
-const createNamespace = (namespaceSpec) => Object.assign(
-//<X extends I>(f: [X]) =>
-//  `${namespaceSpec.prefix}:${f}` as `${string & P}${string & X}`,
-namespaceSpec.terms.reduce((acc, term) => {
-    //acc[term] = `${namespaceSpec.prefix}${term}`
-    acc[term] = `${namespaceSpec.iri}${term}`;
-    return acc;
-}, {}), {
-    $prefix: namespaceSpec["prefix"],
-    $iri: namespaceSpec["iri"],
-});
-exports.createNamespace = createNamespace;

package/types/library/global.d.ts

@@ -1,5 +0,0 @@
-import type { Context, IQueryEngine } from "./rdf.js";
-export declare const setDefaultContext: (context: Context) => void;
-export declare const resolveContext: (context?: Context) => Context;
-export declare const setDefaultEngine: (engine: IQueryEngine) => void;
-export declare const resolveEngine: (engine?: IQueryEngine) => IQueryEngine;

package/types/library/lens/query_helper.d.ts

@@ -1,19 +0,0 @@
-import type { Context, RDF } from "../rdf.js";
-import type { Schema } from "../schema/mod.js";
-import type { Entity } from "./types.js";
-export declare class QueryHelper {
-    private readonly entity;
-    private readonly schema;
-    private readonly context;
-    private readonly variableInitCounter;
-    private quads?;
-    private variableQuads?;
-    constructor(entity: Entity, schema: Schema, context: Context, variableInitCounter?: number);
-    getQuads(): RDF.Quad[];
-    getVariableQuads(): RDF.Quad[];
-    getDeleteQuads(): RDF.Quad[];
-    getInsertQuads(): RDF.Quad[];
-    getWhereQuads(): RDF.Quad[];
-    private getEntityWithReplacedVariables;
-    private replaceVariables;
-}