@faubulous/mentor-rdf 2.1.9 → 2.2.0

package/dist/rdf/reasoners/reasoner.d.ts

@@ -33,6 +33,8 @@ export interface Reasoner {
     targetUriGenerator: GraphUriGenerator;
     /**
      * Apply inference on the source graph and store the inferred triples in the target graph.
+     * The source graph is iterated live while the inferred triples are added, so an
+     * implementation must only ever write to the target graph.
      * @param store The store to be inferenced.
      * @param sourceGraph The source graph where to find the triples to be inferenced.
      * @param targetGraph The optional target graph where to store the inferred triples. If none is provided, the graph from getGraphUri will be used.

package/dist/rdf/store.d.ts

@@ -14,16 +14,19 @@ export declare class TripleNotFoundError extends Error {
 }
 export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     /**
-     * The adapted RDF.js triple store implementation.
+     * The adapted RDF.js triple store implementation. Replaced by {@link clear}.
      *
-     * Note: Please do not use this directly, but rather use the `_ds` property to access the dataset.
+     * Reads go through `_store.readQuads`, a live iterator over the indexes. The dataset
+     * view's `match` is never used for reading: rdf-stores implements it by copying every
+     * matching quad into a new store first, which costs hundreds of megabytes and
+     * seconds for a graph the size of a workspace vocabulary.
      */
-    private readonly _store;
+    private _store;
     /**
-     * The RDF dataset containing the triples in the store, which should primarily be used
-     * for any operations so that the store can be swapped out with a different implementation.
+     * The RDF dataset view of {@link _store}, used for the mutations and membership
+     * checks of the `DatasetCore` interface.
      */
-    private readonly _ds;
+    private _ds;
     /**
      * The reasoner to be used for inference.
      */
@@ -89,8 +92,21 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     /**
      * Get the URIs of the graphs in the triple store.
      * @returns An array of graph URIs in no particular order.
+     * @note Every mutation of the store records the graph it touched, so the graphs are the
+     * recorded ones that still hold a triple. Matching all triples instead would copy the whole
+     * store, which takes seconds for a store holding a large workspace.
      */
     getGraphs(): string[];
+    /**
+     * Indicates if a graph holds at least one triple, without reading more than one.
+     * @param graph The graph term, or its URI with an empty string for the default graph.
+     */
+    private _hasTriples;
+    /**
+     * Resolves a graph URI to its term; an empty string denotes the default graph.
+     * @param graph The graph term or URI.
+     */
+    private _getGraphTerm;
     /**
      * Load a set of triples into the store.
      * @param quads An array of quads to be loaded into the store.
@@ -101,6 +117,12 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
      */
     private _remapBlankNodes;
     private _loadQuads;
+    /**
+     * Runs the reasoner over a graph. The reasoner is handed this store rather than the
+     * dataset view, so its reads are live iterators and its writes bump the graph versions.
+     * @param graphUri The URI of the source graph.
+     */
+    private _expand;
     /**
      * Create an RDF store from Turtle, N3 or N-Triples data.
      * @param input Input string in Turtle, N3 or N-Triples format.
@@ -111,6 +133,15 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
      * @returns A promise that resolves to an RDF store.
      */
     loadTurtle(input: string, graphUri: string, executeInference?: boolean, clearGraph?: boolean, onQuad?: (quad: rdfjs.Quad) => void): Store;
+    /**
+     * Reads the quads of a Turtle token stream. A valid document is read without a syntax
+     * tree, which is the fast path. A document the quad reader rejects is parsed with error
+     * recovery and read from its syntax tree, so that a partially valid document yields the
+     * quads it did before.
+     * @param tokens The tokens of the document.
+     * @returns The quads of the document.
+     */
+    private _readTurtleQuads;
     /**
      * Create an RDF store from N-Quads data.
      * @param input Input string in N-Quads format.
@@ -153,9 +184,17 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     executeInference(graphUri: rdfjs.Quad_Graph | string): void;
     /**
      * Delete named graphs from the store.
-     * @param graphUris URIs of the graphs to be deleted.
+     * @param graphUris URIs of the graphs to be deleted; an empty string denotes the default graph.
+     * @param includeInferred Whether to also delete the inference graph of each graph, as
+     * named by the reasoner's target URI generator. Ignored when the store has no reasoner.
+     */
+    deleteGraphs(graphUris: string[], includeInferred?: boolean): void;
+    /**
+     * Removes every quad from the store and releases the memory of the underlying store,
+     * including its term dictionary, which never shrinks when quads are deleted. The
+     * version counters keep increasing so that cached views and validators notice the change.
      */
-    deleteGraphs(graphUris: string[]): void;
+    clear(): void;
     /**
      * Get the URIs of ordered list members in the store.
      * @param graphUris Optional graph URI or array of graph URIs to query.
@@ -182,7 +221,9 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     /**
      * Returns a lazy, read-only dataset view of the quads matching the given pattern.
      * Implements the RDF/JS `DatasetCore.match` semantics: the result reflects the
-     * current contents of the store and does not copy any quads.
+     * current contents of the store and does not copy any quads. Because the view
+     * iterates the live indexes, do not add or delete quads while iterating it;
+     * take a snapshot with `Array.from(...)` first.
      * @param subject The optional subject.
      * @param predicate The optional predicate.
      * @param object The optional object.
@@ -191,7 +232,8 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
      */
     match(subject?: rdfjs.Term | null, predicate?: rdfjs.Term | null, object?: rdfjs.Term | null, graph?: rdfjs.Term | null): DatasetView;
     /**
-     * Synchronously iterate the quads matching a single pattern.
+     * Synchronously iterate the quads matching a single pattern. The iterator is live:
+     * do not add or delete quads while iterating; take a snapshot with `Array.from(...)` first.
      * @param subject The optional subject.
      * @param predicate The optional predicate.
      * @param object The optional object.
@@ -206,6 +248,8 @@ export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     asSource(): rdfjs.Source<rdfjs.Quad>;
     /**
      * Query the store for triples matching the given pattern supporting multiple graphs.
+     * The iterator is live: do not add or delete quads while iterating; take a snapshot
+     * with `Array.from(...)` first.
      * @param graphUris Optional graph URI or array of graph URIs to query.
      * @param subject A subject URI or null to match any subject.
      * @param predicate A predicate URI or null to match any predicate.

package/package.json

@@ -10,7 +10,7 @@
     "ontology",
     "vocabulary"
   ],
-  "version": "2.1.9",
+  "version": "2.2.0",
   "private": false,
   "author": {
     "name": "Sebastian Faubel"
@@ -68,7 +68,7 @@
     "parse-url": "^11.1.0"
   },
   "dependencies": {
-    "@faubulous/mentor-rdf-parsers": "^2.1.1",
+    "@faubulous/mentor-rdf-parsers": "^2.2.0",
     "memory-level": "^3.1.0",
     "quadstore": "^15.4.1",
     "rdf-stores": "^2.8.0",