@rdfx/resource 0.0.1

package/dist/Values.js

@@ -0,0 +1,221 @@
+import { Either, Left } from "purify-ts";
+import { MissingValueError } from "./MissingValueError.js";
+/**
+ * Iterable sequence of values of a given type.
+ *
+ * Resource.values returns instances of this class instead of a simple array of values in order to
+ * (1) preserve the focus resource that .values was invoked on, in case of errors
+ * (2) preserve the propertyPath that .values was invoked with, in case of errors
+ * (3) return purify types from methods like .find instead of null or undefined
+ * (4) add some methods that aren't on arrays, like .chainMap and .head
+ *
+ * The class doesn't try to implement the entire Array interface. Methods are added as needed by downstream code.
+ */
+export class Values {
+    constructor({ focusResource, propertyPath, }) {
+        this.focusResource = focusResource;
+        this.propertyPath = propertyPath;
+    }
+    /**
+     * Create a Values instance that is empty.
+     */
+    static empty(parameters) {
+        return new EmptyValues(parameters);
+    }
+    /**
+     * Create a Values instance from an array of values.
+     */
+    static fromArray(parameters) {
+        if (Values.length === 0) {
+            return Values.empty(parameters);
+        }
+        return new ArrayValues(parameters);
+    }
+    /**
+     * Create a Values instance from a single value.
+     */
+    static fromValue(parameters) {
+        return new SingletonValues(parameters);
+    }
+    /**
+     * For each value in the sequence, try to convert it to a new type / transform it using the provided callback.
+     *
+     * If any conversion fails, return the failure (the Left).
+     *
+     * If all of the conversions succeed, return a new Values with the converted values.
+     *
+     * This is a combination of Either.chain and Either.map.
+     */
+    chainMap(callback) {
+        const newValues = [];
+        let valueI = 0;
+        for (const value of this) {
+            const callbackResult = callback(value, valueI);
+            if (callbackResult.isLeft()) {
+                return callbackResult;
+            }
+            newValues.push(callbackResult.extract());
+            valueI++;
+        }
+        return Either.of(Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: newValues,
+        }));
+    }
+    /**
+     * Concatenate another values of the same type to this Values, returning a new Values instance.
+     */
+    concat(...values) {
+        return Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: this.toArray().concat(...values),
+        });
+    }
+    /**
+     * Filter the values, returning a new Values instance.
+     */
+    filter(propertyPath) {
+        const filteredValues = [];
+        let valueI = 0;
+        for (const value of this) {
+            if (propertyPath(value, valueI)) {
+                filteredValues.push(value);
+            }
+            valueI++;
+        }
+        return Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: filteredValues,
+        });
+    }
+    /**
+     * Find a value that satisfies the given propertyPath.
+     *
+     * Return Right if a value satisfies the propertyPath, otherwise Left.
+     */
+    find(propertyPath) {
+        let valueI = 0;
+        for (const value of this) {
+            if (propertyPath(value, valueI)) {
+                return Either.of(value);
+            }
+            valueI++;
+        }
+        return Left(new MissingValueError({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+        }));
+    }
+    /**
+     * Flatten a Values of iterables into a new Values.
+     *
+     * Equivalent of Array.flat.
+     */
+    flat() {
+        return Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: this.toArray().flat(),
+        });
+    }
+    /**
+     * Map each value to an array of values of a new type. Flatten those arrays and return the result as a new Values.
+     */
+    flatMap(callback) {
+        const newValues = [];
+        let valueI = 0;
+        for (const value of this) {
+            newValues.push(...callback(value, valueI));
+            valueI++;
+        }
+        return Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: newValues,
+        });
+    }
+    /**
+     * Get the head of this sequence of values if the sequence is non-empty. Otherwise return Left.
+     */
+    head() {
+        for (const value of this) {
+            return Either.of(value);
+        }
+        return Left(new MissingValueError({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+        }));
+    }
+    /**
+     * Map each value to a value of a new type and return a new Values with the mapped results.
+     */
+    map(callback) {
+        const newValues = [];
+        let valueI = 0;
+        for (const value of this) {
+            newValues.push(callback(value, valueI));
+            valueI++;
+        }
+        return Values.fromArray({
+            focusResource: this.focusResource,
+            propertyPath: this.propertyPath,
+            values: newValues,
+        });
+    }
+}
+/**
+ * Private implementation of Resource.Values that iterates over an array.
+ *
+ * Must be in the same file to avoid circular dependencies.
+ */
+class ArrayValues extends Values {
+    constructor({ values, ...superParameters }) {
+        super(superParameters);
+        this.values = values;
+    }
+    get length() {
+        return this.values.length;
+    }
+    [Symbol.iterator]() {
+        return this.values[Symbol.iterator]();
+    }
+    toArray() {
+        return this.values;
+    }
+}
+/**
+ * Private implementation of Resource.Values that is empty.
+ */
+class EmptyValues extends Values {
+    get length() {
+        return 0;
+    }
+    [Symbol.iterator]() {
+        return this.toArray()[Symbol.iterator]();
+    }
+    toArray() {
+        return [];
+    }
+}
+/**
+ * Private implementation of Values that iterates over a single value.
+ *
+ * Must be in the same file to avoid circular dependencies.
+ */
+class SingletonValues extends Values {
+    constructor({ value, ...superParameters }) {
+        super(superParameters);
+        this.length = 1;
+        this.value = value;
+    }
+    *[Symbol.iterator]() {
+        yield this.value;
+    }
+    toArray() {
+        return [this.value];
+    }
+}
+//# sourceMappingURL=Values.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./PropertyPath.js";
+export * from "./Resource.js";
+export * from "./ResourceSet.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from "./PropertyPath.js";
+export * from "./Resource.js";
+export * from "./ResourceSet.js";
+//# sourceMappingURL=index.js.map

package/dist/literalDatatypeDefinitions.d.ts

@@ -0,0 +1,24 @@
+type LiteralDatatypeDefinition = {
+    kind: "bigdecimal";
+    readonly range: [undefined, undefined];
+} | {
+    kind: "bigint";
+    range: readonly [bigint | undefined, bigint | undefined];
+} | {
+    kind: "boolean";
+} | {
+    kind: "date";
+} | {
+    kind: "datetime";
+} | {
+    kind: "float";
+    readonly range: readonly [number, number];
+} | {
+    kind: "int";
+    readonly range: readonly [number, number];
+} | {
+    kind: "string";
+};
+export declare const literalDatatypeDefinitions: Record<string, LiteralDatatypeDefinition>;
+export {};
+//# sourceMappingURL=literalDatatypeDefinitions.d.ts.map

package/dist/literalDatatypeDefinitions.js

@@ -0,0 +1,116 @@
+export const literalDatatypeDefinitions = {
+    // Boolean
+    "http://www.w3.org/2001/XMLSchema#boolean": {
+        kind: "boolean",
+    },
+    // Date
+    "http://www.w3.org/2001/XMLSchema#date": {
+        kind: "date",
+    },
+    // Date-time
+    "http://www.w3.org/2001/XMLSchema#dateTime": {
+        kind: "datetime",
+    },
+    "http://www.w3.org/2001/XMLSchema#dateTimeStamp": {
+        kind: "datetime",
+    },
+    // Fixed-width floats
+    // 32-bit
+    "http://www.w3.org/2001/XMLSchema#float": {
+        kind: "float",
+        range: [-3.4028235e38, 3.4028235e38],
+    },
+    // 64-bit
+    "http://www.w3.org/2001/XMLSchema#double": {
+        kind: "float",
+        // Number.MIN_VALUE is the smallest positive number greater than 0
+        range: [-Number.MAX_VALUE, Number.MAX_VALUE],
+    },
+    // Arbitrary precision decimal
+    "http://www.w3.org/2001/XMLSchema#decimal": {
+        kind: "bigdecimal",
+        range: [undefined, undefined],
+    },
+    // Fixed-width integers
+    // 8-bit signed
+    "http://www.w3.org/2001/XMLSchema#byte": {
+        kind: "int",
+        range: [-128, 127],
+    },
+    // 16-bit signed
+    "http://www.w3.org/2001/XMLSchema#short": {
+        kind: "int",
+        range: [-32768, 32767],
+    },
+    // 32-bit signed
+    "http://www.w3.org/2001/XMLSchema#int": {
+        kind: "int",
+        range: [-2147483648, 2147483647],
+    },
+    // 64-bit signed
+    "http://www.w3.org/2001/XMLSchema#long": {
+        kind: "bigint",
+        range: [-9223372036854775808n, 9223372036854775807n],
+    },
+    // 8-bit unsigned
+    "http://www.w3.org/2001/XMLSchema#unsignedByte": {
+        kind: "int",
+        range: [0, 255],
+    },
+    // 16-bit unsigned
+    "http://www.w3.org/2001/XMLSchema#unsignedShort": {
+        kind: "int",
+        range: [0, 65535],
+    },
+    // 32-bit unsigned
+    "http://www.w3.org/2001/XMLSchema#unsignedInt": {
+        kind: "int",
+        range: [0, 4294967295],
+    },
+    // 64-bit unsigned
+    "http://www.w3.org/2001/XMLSchema#unsignedLong": {
+        kind: "bigint",
+        range: [0n, 18446744073709551615n],
+    },
+    // Arbitrary precision integers
+    "http://www.w3.org/2001/XMLSchema#integer": {
+        kind: "bigint",
+        range: [undefined, undefined],
+    },
+    "http://www.w3.org/2001/XMLSchema#negativeInteger": {
+        kind: "bigint",
+        range: [undefined, -1n],
+    },
+    "http://www.w3.org/2001/XMLSchema#nonNegativeInteger": {
+        kind: "bigint",
+        range: [0n, undefined],
+    },
+    "http://www.w3.org/2001/XMLSchema#nonPositiveInteger": {
+        kind: "bigint",
+        range: [undefined, 0n],
+    },
+    "http://www.w3.org/2001/XMLSchema#positiveInteger": {
+        kind: "bigint",
+        range: [1n, undefined],
+    },
+    // String
+    "http://www.w3.org/1999/02/22-rdf-syntax-ns#dirLangString": {
+        kind: "string",
+    },
+    "http://www.w3.org/1999/02/22-rdf-syntax-ns#langString": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#anyURI": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#base64Binary": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#duration": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#hexBinary": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#language": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#Name": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#NCName": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#NMTOKEN": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#NOTATION": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#normalizedString": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#QName": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#string": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#time": { kind: "string" },
+    "http://www.w3.org/2001/XMLSchema#token": { kind: "string" },
+};
+//# sourceMappingURL=literalDatatypeDefinitions.js.map

package/dist/vocabularies.d.ts

@@ -0,0 +1,36 @@
+export declare namespace rdf {
+    const first: import("@rdfjs/types").NamedNode<"http://www.w3.org/1999/02/22-rdf-syntax-ns#first">;
+    const nil: import("@rdfjs/types").NamedNode<"http://www.w3.org/1999/02/22-rdf-syntax-ns#nil">;
+    const rest: import("@rdfjs/types").NamedNode<"http://www.w3.org/1999/02/22-rdf-syntax-ns#rest">;
+    const type: import("@rdfjs/types").NamedNode<"http://www.w3.org/1999/02/22-rdf-syntax-ns#type">;
+}
+export declare namespace rdfs {
+    const subClassOf: import("@rdfjs/types").NamedNode<"http://www.w3.org/2000/01/rdf-schema#subClassOf">;
+}
+export declare namespace sh {
+    const alternativePath: import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/shacl#alternativePath">;
+    const inversePath: import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/shacl#inversePath">;
+    const oneOrMorePath: import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/shacl#oneOrMorePath">;
+    const zeroOrMorePath: import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/shacl#zeroOrMorePath">;
+    const zeroOrOnePath: import("@rdfjs/types").NamedNode<"http://www.w3.org/ns/shacl#zeroOrOnePath">;
+}
+export declare namespace xsd {
+    const boolean: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#boolean">;
+    const byte: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#byte">;
+    const date: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#date">;
+    const dateTime: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#dateTime">;
+    const dateTimeStamp: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#dateTimeStamp">;
+    const decimal: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#decimal">;
+    const double: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#double">;
+    const float: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#float">;
+    const int: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#int">;
+    const integer: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#integer">;
+    const long: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#long">;
+    const short: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#short">;
+    const string: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#string">;
+    const unsignedByte: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#unsignedByte">;
+    const unsignedInt: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#unsignedInt">;
+    const unsignedLong: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#unsignedLong">;
+    const unsignedShort: import("@rdfjs/types").NamedNode<"http://www.w3.org/2001/XMLSchema#unsignedShort">;
+}
+//# sourceMappingURL=vocabularies.d.ts.map

package/dist/vocabularies.js

@@ -0,0 +1,41 @@
+import DataFactory from "@rdfjs/data-model";
+export var rdf;
+(function (rdf) {
+    rdf.first = DataFactory.namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#first");
+    rdf.nil = DataFactory.namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#nil");
+    rdf.rest = DataFactory.namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#rest");
+    rdf.type = DataFactory.namedNode("http://www.w3.org/1999/02/22-rdf-syntax-ns#type");
+})(rdf || (rdf = {}));
+export var rdfs;
+(function (rdfs) {
+    rdfs.subClassOf = DataFactory.namedNode("http://www.w3.org/2000/01/rdf-schema#subClassOf");
+})(rdfs || (rdfs = {}));
+export var sh;
+(function (sh) {
+    sh.alternativePath = DataFactory.namedNode("http://www.w3.org/ns/shacl#alternativePath");
+    sh.inversePath = DataFactory.namedNode("http://www.w3.org/ns/shacl#inversePath");
+    sh.oneOrMorePath = DataFactory.namedNode("http://www.w3.org/ns/shacl#oneOrMorePath");
+    sh.zeroOrMorePath = DataFactory.namedNode("http://www.w3.org/ns/shacl#zeroOrMorePath");
+    sh.zeroOrOnePath = DataFactory.namedNode("http://www.w3.org/ns/shacl#zeroOrOnePath");
+})(sh || (sh = {}));
+export var xsd;
+(function (xsd) {
+    xsd.boolean = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#boolean");
+    xsd.byte = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#byte");
+    xsd.date = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#date");
+    xsd.dateTime = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#dateTime");
+    xsd.dateTimeStamp = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#dateTimeStamp");
+    xsd.decimal = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#decimal");
+    xsd.double = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#double");
+    xsd.float = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#float");
+    xsd.int = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#int");
+    xsd.integer = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#integer");
+    xsd.long = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#long");
+    xsd.short = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#short");
+    xsd.string = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#string");
+    xsd.unsignedByte = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#unsignedByte");
+    xsd.unsignedInt = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#unsignedInt");
+    xsd.unsignedLong = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#unsignedLong");
+    xsd.unsignedShort = DataFactory.namedNode("http://www.w3.org/2001/XMLSchema#unsignedShort");
+})(xsd || (xsd = {}));
+//# sourceMappingURL=vocabularies.js.map

package/package.json

@@ -0,0 +1,42 @@
+{
+  "dependencies": {
+    "@rdfx/literal": "0.0.1",
+    "@rdfjs/data-model": "~2.1.1",
+    "@rdfjs/term-set": "~2.0.3",
+    "@rdfjs/types": "~2.0.1",
+    "@types/rdfjs__data-model": "~2.0.9",
+    "@types/rdfjs__term-set": "~2.0.9",
+    "purify-ts": "~2.1.4"
+  },
+  "devDependencies": {
+    "@rdfjs/dataset": "~2.0.2",
+    "@tpluscode/rdf-ns-builders": "~4.3.0",
+    "@types/rdfjs__dataset": "~2.0.7",
+    "housemd": "0.1.3",
+    "ts-invariant": "~0.10.3"
+  },
+  "files": [
+    "README.md",
+    "dist/*.d.ts",
+    "dist/*.js"
+  ],
+  "license": "Apache-2.0",
+  "main": "./dist/index.js",
+  "name": "@rdfx/resource",
+  "packageManager": "npm@11.11.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/minorg/rdfx.git"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "clean": "rimraf dist",
+    "depcheck": "depcheck .",
+    "dev": "tsc -w --preserveWatchOutput",
+    "dev:tests": "tsc -p __tests__ -w --preserveWatchOutput",
+    "test": "cd ../.. && vitest run --project @rdfx/resource"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "version": "0.0.1"
+}