@faubulous/mentor-rdf 1.4.2 → 2.0.0

package/dist/rdf/dataset-view.d.ts

@@ -0,0 +1,94 @@
+import * as rdfjs from "@rdfjs/types";
+import type { Store } from "./store";
+/**
+ * Options for creating a {@link DatasetView}.
+ */
+export interface DatasetViewOptions {
+    /**
+     * URIs of the named graphs to scope the view to. If undefined, the view spans all quads in the store.
+     */
+    graphUris?: readonly string[];
+    /**
+     * Graph terms to scope the view to. Takes precedence over `graphUris`. Use this to scope
+     * the view to graphs that cannot be expressed as URIs, such as the default graph.
+     */
+    graphs?: readonly rdfjs.Quad_Graph[];
+    /**
+     * Restrict the view to quads with this subject.
+     */
+    subject?: rdfjs.Term | null;
+    /**
+     * Restrict the view to quads with this predicate.
+     */
+    predicate?: rdfjs.Term | null;
+    /**
+     * Restrict the view to quads with this object.
+     */
+    object?: rdfjs.Term | null;
+    /**
+     * Whether to include inferred triples from the inference graphs associated with the scoped
+     * graphs. If undefined, inferred triples are included when a reasoner is available. If `true`
+     * without a reasoner, an error is thrown. Only applies when the view is scoped to graphs.
+     */
+    includeInferred?: boolean;
+}
+/**
+ * A lazy, read-only RDF/JS DatasetCore view over a {@link Store}, optionally scoped to a set
+ * of graphs and a quad pattern. The view does not copy any quads: iteration, counting and
+ * containment checks delegate to the store's indexes, so the view always reflects the current
+ * contents of the store.
+ */
+export declare class DatasetView implements rdfjs.DatasetCore<rdfjs.Quad> {
+    private readonly _store;
+    private readonly _s;
+    private readonly _p;
+    private readonly _o;
+    /**
+     * The graph terms the view is scoped to, including inference graphs if enabled.
+     * `undefined` means the view spans all graphs; an empty array means the view is provably empty.
+     */
+    private readonly _scope?;
+    private _cachedSize?;
+    private _cachedSizeVersion;
+    constructor(store: Store, options?: DatasetViewOptions);
+    private static _resolveScope;
+    /**
+     * Get the number of quads in the view. Computed from the store's indexes and memoized
+     * until the store is modified.
+     */
+    get size(): number;
+    /**
+     * Not supported: the view is read-only.
+     * @throws An error indicating that the view is read-only.
+     */
+    add(_quad: rdfjs.Quad): this;
+    /**
+     * Not supported: the view is read-only.
+     * @throws An error indicating that the view is read-only.
+     */
+    delete(_quad: rdfjs.Quad): this;
+    /**
+     * Indicates if the view contains a specific quad.
+     * @param quad The quad to be checked.
+     * @returns `true` if the quad matches the view's pattern and scope and exists in the store.
+     */
+    has(quad: rdfjs.Quad): boolean;
+    /**
+     * Get a new view narrowed to the quads matching the given pattern. The constraints of this
+     * view are intersected with the given pattern: a term that conflicts with an existing
+     * constraint results in an empty view.
+     * @param subject The optional subject.
+     * @param predicate The optional predicate.
+     * @param object The optional object.
+     * @param graph The optional graph.
+     * @returns A new read-only dataset view of the matching quads.
+     */
+    match(subject?: rdfjs.Term | null, predicate?: rdfjs.Term | null, object?: rdfjs.Term | null, graph?: rdfjs.Term | null): DatasetView;
+    /**
+     * Intersect an existing term constraint with an incoming one.
+     * @returns The effective term constraint, or `undefined` if the terms conflict.
+     */
+    private static _intersectTerm;
+    [Symbol.iterator](): Iterator<rdfjs.Quad>;
+    private _iterate;
+}

package/dist/rdf/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./class-repository";
 export * from "./data-factory";
+export * from "./dataset-view";
 export * from "./individual-repository";
 export * from "./property-repository";
 export * from "./reasoners/owl-reasoner";

package/dist/rdf/store.d.ts

@@ -1,6 +1,7 @@
 import * as rdfjs from "@rdfjs/types";
 import { EventEmitter } from "stream";
 import { Reasoner } from "./reasoners/reasoner";
+import { DatasetView } from "./dataset-view";
 /**
  * Indicates an error when a triple is not found in the store.
  */
@@ -11,7 +12,7 @@ export declare class TripleNotFoundError extends Error {
      */
     constructor(subject: rdfjs.Quad_Subject | null, predicate: rdfjs.Quad_Predicate | null, object: rdfjs.Quad_Object | null);
 }
-export declare class Store implements rdfjs.Source<rdfjs.Quad> {
+export declare class Store implements rdfjs.DatasetCore<rdfjs.Quad> {
     /**
      * The adapted RDF.js triple store implementation.
      *
@@ -27,6 +28,19 @@ export declare class Store implements rdfjs.Source<rdfjs.Quad> {
      * The reasoner to be used for inference.
      */
     readonly reasoner?: Reasoner;
+    /**
+     * A monotonic counter that is incremented on every mutation of the store.
+     */
+    private _version;
+    /**
+     * Monotonic counters per graph URI, incremented on every mutation of the graph.
+     */
+    private readonly _graphVersions;
+    /**
+     * Get a monotonic counter that is incremented on every mutation of the store.
+     * Can be used to cheaply detect whether the store has changed.
+     */
+    get version(): number;
     /**
      * Get the number of triples in all graphs of the store.
      */
@@ -41,6 +55,14 @@ export declare class Store implements rdfjs.Source<rdfjs.Quad> {
      */
     constructor(reasoner?: Reasoner);
     [Symbol.iterator](): Iterator<rdfjs.Quad, any, any>;
+    /**
+     * Get a monotonic counter for a single graph, incremented on every mutation of the graph.
+     * Can be used to cheaply detect whether the contents of a graph have changed.
+     * @param graphUri A graph URI.
+     * @returns The current version of the graph; `0` if the graph was never modified.
+     */
+    getGraphVersion(graphUri: string): number;
+    private _touchGraph;
     /**
      * Loads a set of W3C Standard ontologies into the store (RDF, RDFA, RDFS, OWL, SKOS, SHACL, XSD).
      */
@@ -150,14 +172,30 @@ export declare class Store implements rdfjs.Source<rdfjs.Quad> {
      */
     countQuads(subject?: rdfjs.Term | null, predicate?: rdfjs.Term | null, object?: rdfjs.Term | null, graph?: rdfjs.Term | null): number;
     /**
-     * Returns a stream of quads matching the given pattern.
+     * 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.
      * @param subject The optional subject.
      * @param predicate The optional predicate.
      * @param object The optional object.
      * @param graph The optional graph.
-     * @returns A stream of matching quads.
+     * @returns A read-only dataset view of the matching quads.
+     */
+    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.
+     * @param subject The optional subject.
+     * @param predicate The optional predicate.
+     * @param object The optional object.
+     * @param graph The optional graph.
+     */
+    matchQuads(subject?: rdfjs.Term | null, predicate?: rdfjs.Term | null, object?: rdfjs.Term | null, graph?: rdfjs.Term | null): Generator<rdfjs.Quad>;
+    /**
+     * Get an RDF/JS `Source` interface for the store that streams matching quads.
+     * Primarily intended for query engines such as Comunica that operate on quad streams.
+     * @returns A source that returns a stream of quads for a given pattern.
      */
-    match(subject?: rdfjs.Term | null, predicate?: rdfjs.Term | null, object?: rdfjs.Term | null, graph?: rdfjs.Term | null): rdfjs.Stream<rdfjs.Quad>;
+    asSource(): rdfjs.Source<rdfjs.Quad>;
     /**
      * Query the store for triples matching the given pattern supporting multiple graphs.
      * @param graphUris Optional graph URI or array of graph URIs to query.
@@ -176,12 +214,16 @@ export declare class Store implements rdfjs.Source<rdfjs.Quad> {
      */
     any(graphUris: string | string[] | undefined, subject: rdfjs.Quad_Subject | null, predicate: rdfjs.Quad_Predicate | null, object: rdfjs.Quad_Object | null, includeInferred?: boolean): boolean;
     /**
-     * Get a new DatasetCore containing all quads from the specified graphs.
+     * Get a read-only DatasetCore view of all quads in the specified graphs.
+     * The view is lazy and live: it reflects the current contents of the store without
+     * copying any quads. If you need an immutable snapshot, copy the view into a new
+     * dataset, e.g. `RdfStore.createDefault().asDataset()`.
      * @param graphUris Optional graph URI or array of graph URIs. If undefined, all quads are included.
-     * @param includeInferred Whether to include inferred triples. Defaults to false.
-     * @returns A new DatasetCore instance with the matching quads.
+     * @param includeInferred Whether to include inferred triples. If undefined, inferred triples
+     *  are included when a reasoner is available. If `true` without a reasoner, an error is thrown.
+     * @returns A read-only dataset view of the matching quads.
      */
-    getDataset(graphUris?: string | string[], includeInferred?: boolean): rdfjs.DatasetCore;
+    getDataset(graphUris?: string | string[], includeInferred?: boolean): DatasetView;
     /**
      * Get the first triple matching the given pattern in the store.
      * @param graphUris Optional graph URI or array of graph URIs to query.

package/package.json

@@ -10,7 +10,7 @@
     "ontology",
     "vocabulary"
   ],
-  "version": "1.4.2",
+  "version": "2.0.0",
   "private": false,
   "author": {
     "name": "Sebastian Faubel"
@@ -60,6 +60,14 @@
     "typescript": "^6.0.3",
     "vitest": "^4.1.9"
   },
+  "overrides": {
+    "got": "^11.8.6",
+    "tmp": "^0.2.7",
+    "gry": "^6.1.1",
+    "git-url-parse": "^16.1.0",
+    "git-up": "^8.1.1",
+    "parse-url": "^11.1.0"
+  },
   "dependencies": {
     "@faubulous/mentor-rdf-parsers": "^1.9.0",
     "memory-level": "^3.1.0",