rdfjs-resource 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MutableResource.d.ts

@@ -0,0 +1,30 @@
+import type { BlankNode, DataFactory, NamedNode, Quad, Quad_Graph, Quad_Object, Variable } from "@rdfjs/types";
+import type { Maybe } from "purify-ts";
+import { Resource } from "./Resource.js";
+type Value = Exclude<Quad_Object, Quad | Variable>;
+/**
+ * Resource subclass with operations to mutate the underlying dataset.
+ */
+export declare class MutableResource<IdentifierT extends Resource.Identifier = Resource.Identifier, MutateGraphT extends MutableResource.MutateGraph = MutableResource.MutateGraph> extends Resource<IdentifierT> {
+    readonly dataFactory: DataFactory;
+    readonly mutateGraph: MutateGraphT;
+    constructor({ dataFactory, mutateGraph, ...resourceParameters }: MutableResource.Parameters<IdentifierT, MutateGraphT>);
+    add(predicate: NamedNode, value: Value): this;
+    addMaybe(predicate: NamedNode, value: Maybe<Value>): this;
+    addList(predicate: NamedNode, valuesList: Iterable<Value>, options?: MutableResource.AddListOptions): this;
+    delete(predicate: NamedNode, value?: Value): this;
+    set(predicate: NamedNode, value: Value): this;
+}
+export declare namespace MutableResource {
+    interface AddListOptions {
+        generateIdentifier?: (item: Value, itemIndex: number) => BlankNode | NamedNode;
+        rdfType?: NamedNode;
+    }
+    type MutateGraph = Exclude<Quad_Graph, Variable>;
+    interface Parameters<IdentifierT extends Resource.Identifier, MutateGraphT extends MutateGraph> extends Resource.Parameters<IdentifierT> {
+        dataFactory: DataFactory;
+        mutateGraph: MutateGraphT;
+    }
+}
+export {};
+//# sourceMappingURL=MutableResource.d.ts.map

package/MutableResource.js

@@ -0,0 +1,46 @@
+import { rdf } from "@tpluscode/rdf-ns-builders";
+import { Resource } from "./Resource.js";
+import { createRdfList } from "./createRdfList.js";
+/**
+ * Resource subclass with operations to mutate the underlying dataset.
+ */
+export class MutableResource extends Resource {
+    constructor({ dataFactory, mutateGraph, ...resourceParameters }) {
+        super(resourceParameters);
+        this.dataFactory = dataFactory;
+        this.mutateGraph = mutateGraph;
+    }
+    add(predicate, value) {
+        this.dataset.add(this.dataFactory.quad(this.identifier, predicate, value, this.mutateGraph));
+        return this;
+    }
+    addMaybe(predicate, value) {
+        value.ifJust((value) => this.add(predicate, value));
+        return this;
+    }
+    addList(predicate, valuesList, options) {
+        const listIdentifier = createRdfList({
+            dataFactory: this.dataFactory,
+            dataset: this.dataset,
+            generateIdentifier: options?.generateIdentifier,
+            items: valuesList,
+        });
+        if (options?.rdfType) {
+            this.dataset.add(this.dataFactory.quad(listIdentifier, rdf.type, options.rdfType, this.mutateGraph));
+        }
+        return this.add(predicate, listIdentifier);
+    }
+    delete(predicate, value) {
+        for (const quad of [
+            ...this.dataset.match(this.identifier, predicate, value, this.mutateGraph),
+        ]) {
+            this.dataset.delete(quad);
+        }
+        return this;
+    }
+    set(predicate, value) {
+        this.delete(predicate);
+        return this.add(predicate, value);
+    }
+}
+//# sourceMappingURL=MutableResource.js.map

package/MutableResourceSet.d.ts

@@ -0,0 +1,19 @@
+import type { DataFactory, DatasetCore } from "@rdfjs/types";
+import { MutableResource } from "./MutableResource.js";
+import type { Resource } from "./Resource.js";
+import { ResourceSet } from "./ResourceSet.js";
+/**
+ * A ResourceSet wraps an RDF/JS dataset with convenient resource factory methods.
+ */
+export declare class MutableResourceSet extends ResourceSet {
+    protected readonly dataFactory: DataFactory;
+    constructor({ dataFactory, dataset, }: {
+        dataFactory: DataFactory;
+        dataset: DatasetCore;
+    });
+    mutableResource({ identifier, mutateGraph, }: {
+        identifier: Resource.Identifier;
+        mutateGraph: MutableResource.MutateGraph;
+    }): MutableResource;
+}
+//# sourceMappingURL=MutableResourceSet.d.ts.map

package/MutableResourceSet.js

@@ -0,0 +1,20 @@
+import { MutableResource } from "./MutableResource.js";
+import { ResourceSet } from "./ResourceSet.js";
+/**
+ * A ResourceSet wraps an RDF/JS dataset with convenient resource factory methods.
+ */
+export class MutableResourceSet extends ResourceSet {
+    constructor({ dataFactory, dataset, }) {
+        super({ dataset });
+        this.dataFactory = dataFactory;
+    }
+    mutableResource({ identifier, mutateGraph, }) {
+        return new MutableResource({
+            dataFactory: this.dataFactory,
+            dataset: this.dataset,
+            identifier,
+            mutateGraph,
+        });
+    }
+}
+//# sourceMappingURL=MutableResourceSet.js.map

package/README.md

@@ -0,0 +1,2 @@
+# rdfjs-resource
+Resource abstraction over RDF/JS Datasets

package/Resource.d.ts

@@ -0,0 +1,87 @@
+import type { BlankNode, DataFactory, DatasetCore, Literal, NamedNode, Quad, Quad_Object, Quad_Subject, Variable } from "@rdfjs/types";
+import { Either, Maybe } from "purify-ts";
+/**
+ * A Resource abstraction over subjects or objects in an RDF/JS dataset.
+ */
+export declare class Resource<IdentifierT extends Resource.Identifier = Resource.Identifier> {
+    readonly dataset: DatasetCore;
+    readonly identifier: IdentifierT;
+    constructor({ dataset, identifier }: Resource.Parameters<IdentifierT>);
+    isInstanceOf(class_: NamedNode, options?: {
+        excludeSubclasses?: boolean;
+        instanceOfPredicate?: NamedNode;
+        subClassOfPredicate?: NamedNode;
+    }): boolean;
+    /**
+     * Consider the resource itself as an RDF list.
+     */
+    toList(): Either<Error, readonly Resource.Value[]>;
+    /**
+     * Get the first matching value of dataset statements (this.identifier, property, value).
+     */
+    value(property: NamedNode, filter?: (value: Resource.Value) => boolean): Maybe<Resource.Value>;
+    /**
+     * Get the first matching subject of dataset statements (subject, property, this.identifier).
+     */
+    valueOf(property: NamedNode, filter?: (subject: Resource.ValueOf) => boolean): Maybe<Resource.ValueOf>;
+    /**
+     * Get all values of dataset statements (this.identifier, property, value).
+     */
+    values(property: NamedNode): Generator<Resource.Value>;
+    /**
+     * Get the first subject of dataset statements (subject, property, this.identifier).
+     */
+    valuesOf(property: NamedNode): Generator<Resource.ValueOf>;
+}
+export declare namespace Resource {
+    type Identifier = BlankNode | NamedNode;
+    namespace Identifier {
+        function fromString({ dataFactory, identifier, }: {
+            dataFactory: DataFactory;
+            identifier: string;
+        }): BlankNode | NamedNode<string>;
+        function toString(identifier: Identifier): string;
+    }
+    interface Parameters<IdentifierT extends Identifier> {
+        dataset: DatasetCore;
+        identifier: IdentifierT;
+    }
+    class Value {
+        private readonly object;
+        private readonly subjectResource;
+        constructor(object: Exclude<Quad_Object, Quad | Variable>, subjectResource: Resource);
+        isBoolean(): boolean;
+        isDate(): boolean;
+        isIdentifier(): boolean;
+        isIri(): boolean;
+        isList(): boolean;
+        isLiteral(): boolean;
+        isNumber(): boolean;
+        isPrimitive(): boolean;
+        isString(): boolean;
+        toBoolean(): Maybe<boolean>;
+        toDate(): Maybe<Date>;
+        toIdentifier(): Maybe<Resource.Identifier>;
+        toIri(): Maybe<NamedNode>;
+        toLiteral(): Maybe<Literal>;
+        toList(): Either<Error, readonly Resource.Value[]>;
+        toNamedResource(): Maybe<Resource<NamedNode>>;
+        toNumber(): Maybe<number>;
+        toPrimitive(): Maybe<boolean | Date | number | string>;
+        toResource(): Maybe<Resource>;
+        toString(): Maybe<string>;
+        toTerm(): Exclude<Quad_Object, Quad | Variable>;
+    }
+    class ValueOf {
+        private readonly objectResource;
+        private readonly subject;
+        constructor(objectResource: Resource, subject: Exclude<Quad_Subject, Quad | Variable>);
+        isIri(): boolean;
+        toIdentifier(): Identifier;
+        toIri(): Maybe<NamedNode>;
+        toNamedResource(): Maybe<Resource<NamedNode>>;
+        toResource(): Resource;
+        toTerm(): Exclude<Quad_Subject, Quad | Variable>;
+    }
+}
+//# sourceMappingURL=Resource.d.ts.map

package/Resource.js

@@ -0,0 +1,258 @@
+import { Either, Just, Left, Maybe, Nothing } from "purify-ts";
+import { fromRdf } from "rdf-literal";
+import { getRdfList } from "./getRdfList.js";
+import { isRdfInstanceOf } from "./isRdfInstanceOf.js";
+function defaultValueOfFilter(_valueOf) {
+    return true;
+}
+function defaultValueFilter(_value) {
+    return true;
+}
+/**
+ * A Resource abstraction over subjects or objects in an RDF/JS dataset.
+ */
+export class Resource {
+    constructor({ dataset, identifier }) {
+        this.dataset = dataset;
+        this.identifier = identifier;
+    }
+    isInstanceOf(class_, options) {
+        return isRdfInstanceOf({
+            class_,
+            dataset: this.dataset,
+            instance: this.identifier,
+            ...options,
+        });
+    }
+    /**
+     * Consider the resource itself as an RDF list.
+     */
+    toList() {
+        return Either.encase(() => [
+            ...getRdfList({
+                dataset: this.dataset,
+                node: this.identifier,
+            }),
+        ].map((value) => new Resource.Value(value, this)));
+    }
+    /**
+     * Get the first matching value of dataset statements (this.identifier, property, value).
+     */
+    value(property, filter) {
+        const filter_ = filter ?? defaultValueFilter;
+        for (const value of this.values(property)) {
+            if (filter_(value)) {
+                return Maybe.of(value);
+            }
+        }
+        return Maybe.empty();
+    }
+    /**
+     * Get the first matching subject of dataset statements (subject, property, this.identifier).
+     */
+    valueOf(property, filter) {
+        const filter_ = filter ?? defaultValueOfFilter;
+        for (const valueOf_ of this.valuesOf(property)) {
+            if (filter_(valueOf_)) {
+                return Just(valueOf_);
+            }
+        }
+        return Nothing;
+    }
+    /**
+     * Get all values of dataset statements (this.identifier, property, value).
+     */
+    *values(property) {
+        for (const quad of this.dataset.match(this.identifier, property, null, null)) {
+            switch (quad.object.termType) {
+                case "BlankNode":
+                case "Literal":
+                case "NamedNode":
+                    yield new Resource.Value(quad.object, this);
+                    break;
+            }
+        }
+    }
+    /**
+     * Get the first subject of dataset statements (subject, property, this.identifier).
+     */
+    *valuesOf(property) {
+        for (const quad of this.dataset.match(null, property, this.identifier, null)) {
+            switch (quad.subject.termType) {
+                case "BlankNode":
+                case "NamedNode":
+                    yield new Resource.ValueOf(this, quad.subject);
+                    break;
+            }
+        }
+    }
+}
+(function (Resource) {
+    let Identifier;
+    (function (Identifier) {
+        function fromString({ dataFactory, identifier, }) {
+            if (identifier.startsWith("_:")) {
+                return dataFactory.blankNode(identifier.substring("_:".length));
+            }
+            if (identifier.startsWith("<") &&
+                identifier.endsWith(">") &&
+                identifier.length > 2) {
+                return dataFactory.namedNode(identifier.substring(1, identifier.length - 1));
+            }
+            throw new RangeError(identifier);
+        }
+        Identifier.fromString = fromString;
+        // biome-ignore lint/suspicious/noShadowRestrictedNames: <explanation>
+        function toString(identifier) {
+            switch (identifier.termType) {
+                case "BlankNode":
+                    return `_:${identifier.value}`;
+                case "NamedNode":
+                    return `<${identifier.value}>`;
+            }
+        }
+        Identifier.toString = toString;
+    })(Identifier = Resource.Identifier || (Resource.Identifier = {}));
+    class Value {
+        constructor(object, subjectResource) {
+            this.object = object;
+            this.subjectResource = subjectResource;
+        }
+        isBoolean() {
+            return this.toBoolean().isJust();
+        }
+        isDate() {
+            return this.toDate().isJust();
+        }
+        isIdentifier() {
+            switch (this.object.termType) {
+                case "BlankNode":
+                case "NamedNode":
+                    return true;
+                default:
+                    return false;
+            }
+        }
+        isIri() {
+            return this.object.termType === "NamedNode";
+        }
+        isList() {
+            return this.toList().isRight();
+        }
+        isLiteral() {
+            return this.object.termType === "Literal";
+        }
+        isNumber() {
+            return this.toNumber().isJust();
+        }
+        isPrimitive() {
+            return this.toPrimitive().isJust();
+        }
+        isString() {
+            return this.toString().isJust();
+        }
+        toBoolean() {
+            return this.toPrimitive().chain((primitive) => typeof primitive === "boolean" ? Just(primitive) : Nothing);
+        }
+        toDate() {
+            return this.toPrimitive().chain((primitive) => primitive instanceof Date ? Just(primitive) : Nothing);
+        }
+        toIdentifier() {
+            switch (this.object.termType) {
+                case "BlankNode":
+                case "NamedNode":
+                    return Just(this.object);
+                default:
+                    return Nothing;
+            }
+        }
+        toIri() {
+            return this.object.termType === "NamedNode" ? Just(this.object) : Nothing;
+        }
+        toLiteral() {
+            return this.object.termType === "Literal" ? Just(this.object) : Nothing;
+        }
+        toList() {
+            const object = this.object;
+            switch (object.termType) {
+                case "BlankNode":
+                case "NamedNode": {
+                    return Either.encase(() => {
+                        return [
+                            ...getRdfList({
+                                dataset: this.subjectResource.dataset,
+                                node: object,
+                            }),
+                        ].map((value) => new Value(value, this.subjectResource));
+                    });
+                }
+                default:
+                    return Left(new Error("object is not an identifier"));
+            }
+        }
+        toNamedResource() {
+            return this.toIri().map((identifier) => new Resource({
+                dataset: this.subjectResource.dataset,
+                identifier,
+            }));
+        }
+        toNumber() {
+            return this.toPrimitive().chain((primitive) => typeof primitive === "number" ? Just(primitive) : Nothing);
+        }
+        toPrimitive() {
+            if (this.object.termType !== "Literal") {
+                return Nothing;
+            }
+            try {
+                return Just(fromRdf(this.object, true));
+            }
+            catch {
+                return Nothing;
+            }
+        }
+        toResource() {
+            return this.toIdentifier().map((identifier) => new Resource({ dataset: this.subjectResource.dataset, identifier }));
+        }
+        toString() {
+            return this.toPrimitive().chain((primitive) => typeof primitive === "string" ? Just(primitive) : Nothing);
+        }
+        toTerm() {
+            return this.object;
+        }
+    }
+    Resource.Value = Value;
+    class ValueOf {
+        constructor(objectResource, subject) {
+            this.objectResource = objectResource;
+            this.subject = subject;
+        }
+        isIri() {
+            return this.subject.termType === "NamedNode";
+        }
+        toIdentifier() {
+            return this.subject;
+        }
+        toIri() {
+            return this.subject.termType === "NamedNode"
+                ? Just(this.subject)
+                : Nothing;
+        }
+        toNamedResource() {
+            return this.toIri().map((identifier) => new Resource({
+                dataset: this.objectResource.dataset,
+                identifier,
+            }));
+        }
+        toResource() {
+            return new Resource({
+                dataset: this.objectResource.dataset,
+                identifier: this.subject,
+            });
+        }
+        toTerm() {
+            return this.subject;
+        }
+    }
+    Resource.ValueOf = ValueOf;
+})(Resource || (Resource = {}));
+//# sourceMappingURL=Resource.js.map

package/ResourceSet.d.ts

@@ -0,0 +1,20 @@
+import type { DatasetCore, NamedNode } from "@rdfjs/types";
+import { Resource } from "./Resource.js";
+import type { GetRdfInstanceQuadsParameters } from "./getRdfInstanceQuads.js";
+/**
+ * A ResourceSet wraps an RDF/JS dataset with convenient resource factory methods.
+ */
+export declare class ResourceSet {
+    readonly dataset: DatasetCore;
+    constructor({ dataset }: {
+        dataset: DatasetCore;
+    });
+    instancesOf(class_: NamedNode, options?: ResourceSet.InstancesOfOptions): Generator<Resource>;
+    namedInstancesOf(class_: NamedNode, options?: ResourceSet.InstancesOfOptions): Generator<Resource<NamedNode>>;
+    namedResource(identifier: NamedNode): Resource<NamedNode>;
+    resource(identifier: Resource.Identifier): Resource;
+}
+export declare namespace ResourceSet {
+    type InstancesOfOptions = Omit<GetRdfInstanceQuadsParameters, "class_" | "dataset">;
+}
+//# sourceMappingURL=ResourceSet.d.ts.map

package/ResourceSet.js

@@ -0,0 +1,42 @@
+import { Resource } from "./Resource.js";
+import { getRdfInstances } from "./getRdfInstances.js";
+/**
+ * A ResourceSet wraps an RDF/JS dataset with convenient resource factory methods.
+ */
+export class ResourceSet {
+    constructor({ dataset }) {
+        this.dataset = dataset;
+    }
+    *instancesOf(class_, options) {
+        for (const identifier of getRdfInstances({
+            class_,
+            dataset: this.dataset,
+            ...options,
+        })) {
+            yield this.resource(identifier);
+        }
+    }
+    *namedInstancesOf(class_, options) {
+        for (const identifier of getRdfInstances({
+            class_,
+            dataset: this.dataset,
+            ...options,
+        })) {
+            if (identifier.termType === "NamedNode")
+                yield this.namedResource(identifier);
+        }
+    }
+    namedResource(identifier) {
+        return new Resource({
+            dataset: this.dataset,
+            identifier,
+        });
+    }
+    resource(identifier) {
+        return new Resource({
+            dataset: this.dataset,
+            identifier,
+        });
+    }
+}
+//# sourceMappingURL=ResourceSet.js.map

package/createRdfList.d.ts

@@ -0,0 +1,14 @@
+import type { BlankNode, DataFactory, DatasetCore, DefaultGraph, Literal, NamedNode } from "@rdfjs/types";
+/**
+ * Create an RDF list for a sequence of items and return the list's identifier
+ *
+ * The generateIdentifier function can be used to generate custom identifiers for the list and its tails instead of using blank nodes.
+ */
+export declare function createRdfList({ dataFactory, dataset, generateIdentifier, graph, items, }: {
+    dataFactory: DataFactory;
+    dataset: DatasetCore;
+    generateIdentifier?: (item: BlankNode | Literal | NamedNode, itemIndex: number) => BlankNode | NamedNode;
+    graph?: BlankNode | DefaultGraph | NamedNode;
+    items: Iterable<BlankNode | Literal | NamedNode>;
+}): BlankNode | NamedNode;
+//# sourceMappingURL=createRdfList.d.ts.map

package/createRdfList.js

@@ -0,0 +1,33 @@
+import { rdf } from "@tpluscode/rdf-ns-builders";
+/**
+ * Create an RDF list for a sequence of items and return the list's identifier
+ *
+ * The generateIdentifier function can be used to generate custom identifiers for the list and its tails instead of using blank nodes.
+ */
+export function createRdfList({ dataFactory, dataset, generateIdentifier, graph, items, }) {
+    if (!generateIdentifier) {
+        generateIdentifier = () => dataFactory.blankNode();
+    }
+    let currentHead;
+    let list;
+    let itemIndex = 0;
+    for (const item of items) {
+        const newHead = generateIdentifier(item, itemIndex);
+        if (currentHead) {
+            dataset.add(dataFactory.quad(currentHead, rdf.rest, newHead, graph));
+            currentHead = newHead;
+        }
+        else {
+            currentHead = list = newHead;
+        }
+        dataset.add(dataFactory.quad(currentHead, rdf.first, item, graph));
+        itemIndex++;
+    }
+    if (!list) {
+        return rdf.nil;
+    }
+    // biome-ignore lint/style/noNonNullAssertion: <explanation>
+    dataset.add(dataFactory.quad(currentHead, rdf.rest, rdf.nil, graph));
+    return list;
+}
+//# sourceMappingURL=createRdfList.js.map

package/getRdfInstanceQuads.d.ts

@@ -0,0 +1,16 @@
+import type { DatasetCore, NamedNode, Quad, Quad_Graph, Variable } from "@rdfjs/types";
+export interface GetRdfInstanceQuadsParameters {
+    class_: NamedNode;
+    dataset: DatasetCore;
+    excludeSubclasses?: boolean;
+    graph?: Exclude<Quad_Graph, Variable> | null;
+    instanceOfPredicate?: NamedNode;
+    subClassOfPredicate?: NamedNode;
+}
+/**
+ * Get all unique RDF instanceQuads of a given class in the given dataset.
+ *
+ * Returns the quads declaring an instance to be of the given class or one of its subclasses.
+ */
+export declare function getRdfInstanceQuads({ class_, dataset, graph, excludeSubclasses, instanceOfPredicate, subClassOfPredicate, }: GetRdfInstanceQuadsParameters): Generator<Quad>;
+//# sourceMappingURL=getRdfInstanceQuads.d.ts.map

package/getRdfInstanceQuads.js

@@ -0,0 +1,59 @@
+import TermSet from "@rdfjs/term-set";
+import { rdf, rdfs } from "@tpluscode/rdf-ns-builders";
+/**
+ * Get all unique RDF instanceQuads of a given class in the given dataset.
+ *
+ * Returns the quads declaring an instance to be of the given class or one of its subclasses.
+ */
+export function* getRdfInstanceQuads({ class_, dataset, graph, excludeSubclasses, instanceOfPredicate, subClassOfPredicate, }) {
+    yield* getRdfInstanceQuadsRecursive({
+        class_,
+        dataset,
+        graph: graph ?? null,
+        excludeSubclasses: excludeSubclasses ?? false,
+        instanceOfPredicate: instanceOfPredicate ?? rdf.type,
+        instanceQuads: new TermSet(),
+        subClassOfPredicate: subClassOfPredicate ?? rdfs.subClassOf,
+        visitedClasses: new TermSet(),
+    });
+}
+function* getRdfInstanceQuadsRecursive({ class_, dataset, excludeSubclasses, graph, instanceOfPredicate, instanceQuads, subClassOfPredicate, visitedClasses, }) {
+    // Get instanceQuads of the class
+    for (const quad of dataset.match(null, instanceOfPredicate, class_, graph)) {
+        switch (quad.subject.termType) {
+            case "BlankNode":
+            case "NamedNode":
+                if (!instanceQuads.has(quad)) {
+                    yield quad;
+                    instanceQuads.add(quad);
+                }
+                break;
+            default:
+                break;
+        }
+    }
+    visitedClasses.add(class_);
+    if (excludeSubclasses) {
+        return;
+    }
+    // Recurse into class's sub-classes that haven't been visited yet.
+    for (const quad of dataset.match(null, subClassOfPredicate, class_, graph)) {
+        if (quad.subject.termType !== "NamedNode") {
+            continue;
+        }
+        if (visitedClasses.has(quad.subject)) {
+            continue;
+        }
+        yield* getRdfInstanceQuadsRecursive({
+            class_: quad.subject,
+            dataset,
+            excludeSubclasses,
+            graph,
+            instanceOfPredicate,
+            instanceQuads,
+            subClassOfPredicate,
+            visitedClasses,
+        });
+    }
+}
+//# sourceMappingURL=getRdfInstanceQuads.js.map

package/getRdfInstances.d.ts

@@ -0,0 +1,7 @@
+import type { BlankNode, NamedNode } from "@rdfjs/types";
+import { type GetRdfInstanceQuadsParameters } from "./getRdfInstanceQuads.js";
+/**
+ * Get all unique RDF instances of a given class in the given dataset.
+ */
+export declare function getRdfInstances(kwds: GetRdfInstanceQuadsParameters): Generator<BlankNode | NamedNode>;
+//# sourceMappingURL=getRdfInstances.d.ts.map

package/getRdfInstances.js

@@ -0,0 +1,10 @@
+import { getRdfInstanceQuads, } from "./getRdfInstanceQuads.js";
+/**
+ * Get all unique RDF instances of a given class in the given dataset.
+ */
+export function* getRdfInstances(kwds) {
+    for (const instanceQuad of getRdfInstanceQuads(kwds)) {
+        yield instanceQuad.subject;
+    }
+}
+//# sourceMappingURL=getRdfInstances.js.map

package/getRdfList.d.ts

@@ -0,0 +1,7 @@
+import type { BlankNode, DatasetCore, DefaultGraph, Literal, NamedNode } from "@rdfjs/types";
+export declare function getRdfList({ dataset, graph, node, }: {
+    dataset: DatasetCore;
+    graph?: BlankNode | DefaultGraph | NamedNode | null;
+    node: BlankNode | NamedNode;
+}): Generator<BlankNode | Literal | NamedNode>;
+//# sourceMappingURL=getRdfList.d.ts.map

package/getRdfList.js

@@ -0,0 +1,49 @@
+import TermSet from "@rdfjs/term-set";
+import { rdf } from "@tpluscode/rdf-ns-builders";
+export function* getRdfList({ dataset, graph, node, }) {
+    if (node.equals(rdf.nil)) {
+        return;
+    }
+    const firstObjects = [
+        ...new TermSet([...dataset.match(node, rdf.first, null, graph)].map((quad) => quad.object)),
+    ];
+    if (firstObjects.length === 0) {
+        throw new RangeError(`RDF list ${node.value} has no rdf:first quad`);
+    }
+    if (firstObjects.length > 1) {
+        throw new RangeError(`RDF list ${node.value} has multiple rdf:first objects: ${JSON.stringify(firstObjects.map((object) => object.value))}`);
+    }
+    const firstObject = firstObjects[0];
+    switch (firstObject.termType) {
+        case "BlankNode":
+        case "Literal":
+        case "NamedNode":
+            break;
+        default:
+            throw new RangeError(`rdf:first from ${node.value} must point to a blank or named node or a literal, not ${firstObject.termType}`);
+    }
+    const restObjects = [
+        ...new TermSet([...dataset.match(node, rdf.rest, null, graph)].map((quad) => quad.object)),
+    ];
+    if (restObjects.length === 0) {
+        throw new RangeError(`RDF list ${node.value} has no rdf:rest quad`);
+    }
+    if (restObjects.length > 1) {
+        throw new RangeError(`RDF list ${node.value} has multiple rdf:rest objects: ${JSON.stringify(restObjects.map((object) => object.value))}`);
+    }
+    const restObject = restObjects[0];
+    switch (restObject.termType) {
+        case "BlankNode":
+        case "NamedNode":
+            break;
+        default:
+            throw new RangeError(`rdf:rest from ${node.value} must point to a blank or named node, not ${restObject.termType}`);
+    }
+    yield firstObject;
+    yield* getRdfList({
+        dataset,
+        graph,
+        node: restObject,
+    });
+}
+//# sourceMappingURL=getRdfList.js.map

package/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./createRdfList.js";
+export * from "./MutableResource.js";
+export * from "./MutableResourceSet.js";
+export * from "./Resource.js";
+export * from "./ResourceSet.js";
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,6 @@
+export * from "./createRdfList.js";
+export * from "./MutableResource.js";
+export * from "./MutableResourceSet.js";
+export * from "./Resource.js";
+export * from "./ResourceSet.js";
+//# sourceMappingURL=index.js.map

package/isRdfInstanceOf.d.ts

@@ -0,0 +1,6 @@
+import type { BlankNode, NamedNode } from "@rdfjs/types";
+import type { GetRdfInstanceQuadsParameters } from "./getRdfInstanceQuads.js";
+export declare function isRdfInstanceOf({ class_, instance, dataset, excludeSubclasses, instanceOfPredicate, subClassOfPredicate, }: GetRdfInstanceQuadsParameters & {
+    instance: BlankNode | NamedNode;
+}): boolean;
+//# sourceMappingURL=isRdfInstanceOf.d.ts.map

package/isRdfInstanceOf.js

@@ -0,0 +1,44 @@
+import TermSet from "@rdfjs/term-set";
+import { rdf, rdfs } from "@tpluscode/rdf-ns-builders";
+export function isRdfInstanceOf({ class_, instance, dataset, excludeSubclasses, instanceOfPredicate, subClassOfPredicate, }) {
+    return isRdfInstanceOfRecursive({
+        class_,
+        dataset,
+        excludeSubclasses: excludeSubclasses ?? false,
+        instance,
+        instanceOfPredicate: instanceOfPredicate ?? rdf.type,
+        subClassOfPredicate: subClassOfPredicate ?? rdfs.subClassOf,
+        visitedClasses: new TermSet(),
+    });
+}
+function isRdfInstanceOfRecursive({ class_, dataset, excludeSubclasses, instance, instanceOfPredicate, subClassOfPredicate, visitedClasses, }) {
+    for (const _ of dataset.match(instance, instanceOfPredicate, class_)) {
+        return true;
+    }
+    visitedClasses.add(class_);
+    if (excludeSubclasses) {
+        return false;
+    }
+    // Recurse into class's sub-classes that haven't been visited yet.
+    for (const quad of dataset.match(null, subClassOfPredicate, class_, null)) {
+        if (quad.subject.termType !== "NamedNode") {
+            continue;
+        }
+        if (visitedClasses.has(quad.subject)) {
+            continue;
+        }
+        if (isRdfInstanceOfRecursive({
+            class_: quad.subject,
+            dataset,
+            excludeSubclasses,
+            instance,
+            instanceOfPredicate,
+            subClassOfPredicate,
+            visitedClasses,
+        })) {
+            return true;
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=isRdfInstanceOf.js.map

package/package.json

@@ -0,0 +1,51 @@
+{
+  "dependencies": {
+    "@rdfjs/term-set": "^1.1.0",
+    "@rdfjs/types": "^1.1.0",
+    "@tpluscode/rdf-ns-builders": "^4.3.0",
+    "@types/rdfjs__term-set": "^1.0.2",
+    "purify-ts": "~2.1.0",
+    "rdf-literal": "^1.3.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.8.3",
+    "@tsconfig/strictest": "^2.0.5",
+    "@types/n3": "^1.16.5",
+    "n3": "^1.20.4",
+    "rimraf": "^6.0.1",
+    "typescript": "~5.5",
+    "vitest": "^2.0.5"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "main": "index.js",
+  "files": ["*.d.ts", "*.js"],
+  "license": "Apache-2.0",
+  "name": "rdfjs-resource",
+  "scripts": {
+    "build": "tsc -b",
+    "check": "biome check",
+    "check:write": "biome check --write",
+    "check:write:unsafe": "biome check --write --unsafe",
+    "clean": "rimraf *.d.ts* *.js *.js.map __tests__/*.d.ts* __tests__/*.js __tests__/*.js.map tsconfig.tsbuildinfo",
+    "format": "biome format",
+    "format:write": "biome format --write",
+    "format:write:unsafe": "biome format --write --unsafe",
+    "rebuild": "run-s clean build",
+    "lint": "biome lint",
+    "lint:write": "biome lint --write",
+    "lint:write:unsafe": "biome lint --write --unsafe",
+    "test": "biome check && vitest run",
+    "test:coverage": "biome check && vitest run --coverage",
+    "test:watch": "vitest watch",
+    "watch": "tsc -w --preserveWatchOutput"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/minorg/rdfjs-resource"
+  },
+  "type": "module",
+  "types": "index.d.ts",
+  "version": "1.0.0"
+}

package/vitest.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vite").UserConfig;
+export default _default;
+//# sourceMappingURL=vitest.config.d.ts.map

package/vitest.config.js

@@ -0,0 +1,15 @@
+/// <reference types="vitest" />
+import { defineConfig } from "vite";
+export default defineConfig({
+    test: {
+        coverage: {
+            provider: "v8",
+            reporter: ["text", "json-summary", "json"],
+            // If you want a coverage reports even if your tests are failing, include the reportOnFailure option
+            reportOnFailure: true,
+        },
+        include: ["**/*.test.ts"],
+        passWithNoTests: true,
+    },
+});
+//# sourceMappingURL=vitest.config.js.map