@undefineds.co/xpod 0.2.42 → 0.2.44

package/dist/storage/quint/value-types.d.ts

@@ -0,0 +1,32 @@
+import type { Term } from '@rdfjs/types';
+/**
+ * Declares what kind of RDF object value a predicate stores.
+ *
+ * This is schema data, not a query policy. Query capabilities are derived
+ * from the declared data type:
+ * - text/numeric/dateTime/iri/blankNode/literal with objectKey support
+ *   can use exact/prefix/range/order.
+ * - longText is stored for DB-side text search/contains and must not fall
+ *   back to in-memory scans for range/order semantics.
+ */
+export type PredicateObjectDataType = 'iri' | 'blankNode' | 'text' | 'longText' | 'numeric' | 'dateTime' | 'literal';
+export interface PredicateObjectDataTypes {
+    [predicate: string]: PredicateObjectDataType;
+}
+export interface ObjectIndexFields {
+    objectKind: PredicateObjectDataType;
+    objectKey: string | null;
+    objectText: string | null;
+}
+export interface ObjectIndexOptions {
+    predicate?: string;
+    predicateObjectDataTypes?: PredicateObjectDataTypes;
+    textMaxBytes?: number;
+}
+export declare const DEFAULT_TEXT_MAX_BYTES = 2048;
+export declare function getPredicateObjectDataType(predicate: string | undefined, predicateObjectDataTypes: PredicateObjectDataTypes | undefined): PredicateObjectDataType | undefined;
+export declare function objectIndexFieldsFromTerm(term: Term, options?: ObjectIndexOptions): ObjectIndexFields;
+export declare function objectIndexFieldsFromSerialized(serialized: string, options?: ObjectIndexOptions): ObjectIndexFields;
+export declare function objectIndexFieldsFromOperatorValue(value: unknown, serialized: string, options?: ObjectIndexOptions): ObjectIndexFields;
+export declare function isObjectValueComparable(fields: ObjectIndexFields): boolean;
+export declare function literalFromPlainText(value: string): Term;

package/dist/storage/quint/value-types.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_TEXT_MAX_BYTES = void 0;
+exports.getPredicateObjectDataType = getPredicateObjectDataType;
+exports.objectIndexFieldsFromTerm = objectIndexFieldsFromTerm;
+exports.objectIndexFieldsFromSerialized = objectIndexFieldsFromSerialized;
+exports.objectIndexFieldsFromOperatorValue = objectIndexFieldsFromOperatorValue;
+exports.isObjectValueComparable = isObjectValueComparable;
+exports.literalFromPlainText = literalFromPlainText;
+const n3_1 = require("n3");
+const serialization_1 = require("./serialization");
+exports.DEFAULT_TEXT_MAX_BYTES = 2048;
+const XSD_STRING = 'http://www.w3.org/2001/XMLSchema#string';
+const RDF_LANG_STRING = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#langString';
+const textEncoder = new TextEncoder();
+function getPredicateObjectDataType(predicate, predicateObjectDataTypes) {
+    if (!predicate || !predicateObjectDataTypes)
+        return undefined;
+    return predicateObjectDataTypes[predicate];
+}
+function objectIndexFieldsFromTerm(term, options = {}) {
+    const serialized = (0, serialization_1.serializeObject)(term);
+    const declaredType = getPredicateObjectDataType(options.predicate, options.predicateObjectDataTypes);
+    const textMaxBytes = options.textMaxBytes ?? exports.DEFAULT_TEXT_MAX_BYTES;
+    if (term.termType === 'NamedNode') {
+        assertDeclaredType(declaredType, 'iri', options.predicate);
+        return { objectKind: 'iri', objectKey: serialized, objectText: null };
+    }
+    if (term.termType === 'BlankNode') {
+        assertDeclaredType(declaredType, 'blankNode', options.predicate);
+        return { objectKind: 'blankNode', objectKey: serialized, objectText: null };
+    }
+    if (term.termType !== 'Literal') {
+        return { objectKind: 'literal', objectKey: serialized, objectText: null };
+    }
+    const literal = term;
+    const datatype = literal.datatype?.value;
+    if (datatype && serialization_1.NUMERIC_TYPES.has(datatype)) {
+        assertDeclaredType(declaredType, 'numeric', options.predicate);
+        return { objectKind: 'numeric', objectKey: serialized, objectText: null };
+    }
+    if (datatype === serialization_1.DATETIME_TYPE) {
+        assertDeclaredType(declaredType, 'dateTime', options.predicate);
+        return { objectKind: 'dateTime', objectKey: serialized, objectText: null };
+    }
+    if (!isTextLiteral(literal)) {
+        assertDeclaredType(declaredType, 'literal', options.predicate);
+        return serializedTextLength(serialized) <= textMaxBytes
+            ? { objectKind: 'literal', objectKey: serialized, objectText: literal.value }
+            : { objectKind: 'literal', objectKey: null, objectText: literal.value };
+    }
+    if (declaredType === 'longText') {
+        return { objectKind: 'longText', objectKey: null, objectText: literal.value };
+    }
+    if (declaredType === 'text') {
+        if (serializedTextLength(serialized) > textMaxBytes) {
+            throw new Error(`Predicate ${options.predicate ?? '(unknown)'} is declared as text, but the object exceeds ${textMaxBytes} bytes`);
+        }
+        return { objectKind: 'text', objectKey: serialized, objectText: literal.value };
+    }
+    assertDeclaredType(declaredType, 'text', options.predicate);
+    return serializedTextLength(serialized) <= textMaxBytes
+        ? { objectKind: 'text', objectKey: serialized, objectText: literal.value }
+        : { objectKind: 'longText', objectKey: null, objectText: literal.value };
+}
+function objectIndexFieldsFromSerialized(serialized, options = {}) {
+    return objectIndexFieldsFromTerm((0, serialization_1.deserializeObject)(serialized), options);
+}
+function objectIndexFieldsFromOperatorValue(value, serialized, options = {}) {
+    if (isTermLike(value)) {
+        return objectIndexFieldsFromTerm(value, options);
+    }
+    const declaredType = getPredicateObjectDataType(options.predicate, options.predicateObjectDataTypes);
+    if (declaredType === 'longText') {
+        return { objectKind: 'longText', objectKey: null, objectText: String(value) };
+    }
+    return objectIndexFieldsFromSerialized(serialized, options);
+}
+function isObjectValueComparable(fields) {
+    return fields.objectKey !== null && fields.objectKind !== 'longText';
+}
+function literalFromPlainText(value) {
+    return n3_1.DataFactory.literal(value);
+}
+function isTextLiteral(literal) {
+    const datatype = literal.datatype?.value;
+    return !datatype || datatype === XSD_STRING || datatype === RDF_LANG_STRING;
+}
+function serializedTextLength(value) {
+    return textEncoder.encode(value).byteLength;
+}
+function assertDeclaredType(declaredType, actualType, predicate) {
+    if (!declaredType || declaredType === actualType || declaredType === 'literal')
+        return;
+    throw new Error(`Predicate ${predicate ?? '(unknown)'} is declared as ${declaredType}, but received ${actualType}`);
+}
+function isTermLike(value) {
+    return !!value && typeof value === 'object' && 'termType' in value;
+}
+//# sourceMappingURL=value-types.js.map

package/dist/storage/quint/value-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"value-types.js","sourceRoot":"","sources":["../../../src/storage/quint/value-types.ts"],"names":[],"mappings":";;;AAoDA,gEAMC;AAED,8DAyDC;AAED,0EAKC;AAED,gFAeC;AAED,0DAEC;AAED,oDAEC;AArJD,2BAAiC;AAGjC,mDAKyB;AAqCZ,QAAA,sBAAsB,GAAG,IAAI,CAAC;AAE3C,MAAM,UAAU,GAAG,yCAAyC,CAAC;AAC7D,MAAM,eAAe,GAAG,uDAAuD,CAAC;AAEhF,MAAM,WAAW,GAAG,IAAI,WAAW,EAAE,CAAC;AAEtC,SAAgB,0BAA0B,CACxC,SAA6B,EAC7B,wBAA8D;IAE9D,IAAI,CAAC,SAAS,IAAI,CAAC,wBAAwB;QAAE,OAAO,SAAS,CAAC;IAC9D,OAAO,wBAAwB,CAAC,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED,SAAgB,yBAAyB,CAAC,IAAU,EAAE,UAA8B,EAAE;IACpF,MAAM,UAAU,GAAG,IAAA,+BAAe,EAAC,IAAI,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,0BAA0B,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrG,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,8BAAsB,CAAC;IAEpE,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QAClC,kBAAkB,CAAC,YAAY,EAAE,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3D,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACxE,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;QAClC,kBAAkB,CAAC,YAAY,EAAE,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QACjE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC9E,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC5E,CAAC;IAED,MAAM,OAAO,GAAG,IAAe,CAAC;IAChC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC;IAEzC,IAAI,QAAQ,IAAI,6BAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5C,kBAAkB,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/D,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC5E,CAAC;IAED,IAAI,QAAQ,KAAK,6BAAa,EAAE,CAAC;QAC/B,kBAAkB,CAAC,YAAY,EAAE,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAChE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IAC7E,CAAC;IAED,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,kBAAkB,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/D,OAAO,oBAAoB,CAAC,UAAU,CAAC,IAAI,YAAY;YACrD,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE;YAC7E,CAAC,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;IAC5E,CAAC;IAED,IAAI,YAAY,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;IAChF,CAAC;IAED,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;QAC5B,IAAI,oBAAoB,CAAC,UAAU,CAAC,GAAG,YAAY,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CACb,aAAa,OAAO,CAAC,SAAS,IAAI,WAAW,gDAAgD,YAAY,QAAQ,CAClH,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;IAClF,CAAC;IAED,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IAE5D,OAAO,oBAAoB,CAAC,UAAU,CAAC,IAAI,YAAY;QACrD,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE;QAC1E,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;AAC7E,CAAC;AAED,SAAgB,+BAA+B,CAC7C,UAAkB,EAClB,UAA8B,EAAE;IAEhC,OAAO,yBAAyB,CAAC,IAAA,iCAAiB,EAAC,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,SAAgB,kCAAkC,CAChD,KAAc,EACd,UAAkB,EAClB,UAA8B,EAAE;IAEhC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,yBAAyB,CAAC,KAAa,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,YAAY,GAAG,0BAA0B,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACrG,IAAI,YAAY,KAAK,UAAU,EAAE,CAAC;QAChC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;IAChF,CAAC;IAED,OAAO,+BAA+B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED,SAAgB,uBAAuB,CAAC,MAAyB;IAC/D,OAAO,MAAM,CAAC,SAAS,KAAK,IAAI,IAAI,MAAM,CAAC,UAAU,KAAK,UAAU,CAAC;AACvE,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAAa;IAChD,OAAO,gBAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,OAAgB;IACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC;IACzC,OAAO,CAAC,QAAQ,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,KAAK,eAAe,CAAC;AAC9E,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC;AAC9C,CAAC;AAED,SAAS,kBAAkB,CACzB,YAAiD,EACjD,UAAmC,EACnC,SAA6B;IAE7B,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,UAAU,IAAI,YAAY,KAAK,SAAS;QAAE,OAAO;IACvF,MAAM,IAAI,KAAK,CACb,aAAa,SAAS,IAAI,WAAW,mBAAmB,YAAY,kBAAkB,UAAU,EAAE,CACnG,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,UAAU,IAAI,KAAK,CAAC;AACrE,CAAC","sourcesContent":["import { DataFactory } from 'n3';\nimport type { Term, Literal } from '@rdfjs/types';\n\nimport {\n  DATETIME_TYPE,\n  NUMERIC_TYPES,\n  deserializeObject,\n  serializeObject,\n} from './serialization';\n\n/**\n * Declares what kind of RDF object value a predicate stores.\n *\n * This is schema data, not a query policy. Query capabilities are derived\n * from the declared data type:\n * - text/numeric/dateTime/iri/blankNode/literal with objectKey support\n *   can use exact/prefix/range/order.\n * - longText is stored for DB-side text search/contains and must not fall\n *   back to in-memory scans for range/order semantics.\n */\nexport type PredicateObjectDataType =\n  | 'iri'\n  | 'blankNode'\n  | 'text'\n  | 'longText'\n  | 'numeric'\n  | 'dateTime'\n  | 'literal';\n\nexport interface PredicateObjectDataTypes {\n  [predicate: string]: PredicateObjectDataType;\n}\n\nexport interface ObjectIndexFields {\n  objectKind: PredicateObjectDataType;\n  objectKey: string | null;\n  objectText: string | null;\n}\n\nexport interface ObjectIndexOptions {\n  predicate?: string;\n  predicateObjectDataTypes?: PredicateObjectDataTypes;\n  textMaxBytes?: number;\n}\n\nexport const DEFAULT_TEXT_MAX_BYTES = 2048;\n\nconst XSD_STRING = 'http://www.w3.org/2001/XMLSchema#string';\nconst RDF_LANG_STRING = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#langString';\n\nconst textEncoder = new TextEncoder();\n\nexport function getPredicateObjectDataType(\n  predicate: string | undefined,\n  predicateObjectDataTypes: PredicateObjectDataTypes | undefined,\n): PredicateObjectDataType | undefined {\n  if (!predicate || !predicateObjectDataTypes) return undefined;\n  return predicateObjectDataTypes[predicate];\n}\n\nexport function objectIndexFieldsFromTerm(term: Term, options: ObjectIndexOptions = {}): ObjectIndexFields {\n  const serialized = serializeObject(term);\n  const declaredType = getPredicateObjectDataType(options.predicate, options.predicateObjectDataTypes);\n  const textMaxBytes = options.textMaxBytes ?? DEFAULT_TEXT_MAX_BYTES;\n\n  if (term.termType === 'NamedNode') {\n    assertDeclaredType(declaredType, 'iri', options.predicate);\n    return { objectKind: 'iri', objectKey: serialized, objectText: null };\n  }\n\n  if (term.termType === 'BlankNode') {\n    assertDeclaredType(declaredType, 'blankNode', options.predicate);\n    return { objectKind: 'blankNode', objectKey: serialized, objectText: null };\n  }\n\n  if (term.termType !== 'Literal') {\n    return { objectKind: 'literal', objectKey: serialized, objectText: null };\n  }\n\n  const literal = term as Literal;\n  const datatype = literal.datatype?.value;\n\n  if (datatype && NUMERIC_TYPES.has(datatype)) {\n    assertDeclaredType(declaredType, 'numeric', options.predicate);\n    return { objectKind: 'numeric', objectKey: serialized, objectText: null };\n  }\n\n  if (datatype === DATETIME_TYPE) {\n    assertDeclaredType(declaredType, 'dateTime', options.predicate);\n    return { objectKind: 'dateTime', objectKey: serialized, objectText: null };\n  }\n\n  if (!isTextLiteral(literal)) {\n    assertDeclaredType(declaredType, 'literal', options.predicate);\n    return serializedTextLength(serialized) <= textMaxBytes\n      ? { objectKind: 'literal', objectKey: serialized, objectText: literal.value }\n      : { objectKind: 'literal', objectKey: null, objectText: literal.value };\n  }\n\n  if (declaredType === 'longText') {\n    return { objectKind: 'longText', objectKey: null, objectText: literal.value };\n  }\n\n  if (declaredType === 'text') {\n    if (serializedTextLength(serialized) > textMaxBytes) {\n      throw new Error(\n        `Predicate ${options.predicate ?? '(unknown)'} is declared as text, but the object exceeds ${textMaxBytes} bytes`,\n      );\n    }\n    return { objectKind: 'text', objectKey: serialized, objectText: literal.value };\n  }\n\n  assertDeclaredType(declaredType, 'text', options.predicate);\n\n  return serializedTextLength(serialized) <= textMaxBytes\n    ? { objectKind: 'text', objectKey: serialized, objectText: literal.value }\n    : { objectKind: 'longText', objectKey: null, objectText: literal.value };\n}\n\nexport function objectIndexFieldsFromSerialized(\n  serialized: string,\n  options: ObjectIndexOptions = {},\n): ObjectIndexFields {\n  return objectIndexFieldsFromTerm(deserializeObject(serialized), options);\n}\n\nexport function objectIndexFieldsFromOperatorValue(\n  value: unknown,\n  serialized: string,\n  options: ObjectIndexOptions = {},\n): ObjectIndexFields {\n  if (isTermLike(value)) {\n    return objectIndexFieldsFromTerm(value as Term, options);\n  }\n\n  const declaredType = getPredicateObjectDataType(options.predicate, options.predicateObjectDataTypes);\n  if (declaredType === 'longText') {\n    return { objectKind: 'longText', objectKey: null, objectText: String(value) };\n  }\n\n  return objectIndexFieldsFromSerialized(serialized, options);\n}\n\nexport function isObjectValueComparable(fields: ObjectIndexFields): boolean {\n  return fields.objectKey !== null && fields.objectKind !== 'longText';\n}\n\nexport function literalFromPlainText(value: string): Term {\n  return DataFactory.literal(value);\n}\n\nfunction isTextLiteral(literal: Literal): boolean {\n  const datatype = literal.datatype?.value;\n  return !datatype || datatype === XSD_STRING || datatype === RDF_LANG_STRING;\n}\n\nfunction serializedTextLength(value: string): number {\n  return textEncoder.encode(value).byteLength;\n}\n\nfunction assertDeclaredType(\n  declaredType: PredicateObjectDataType | undefined,\n  actualType: PredicateObjectDataType,\n  predicate: string | undefined,\n): void {\n  if (!declaredType || declaredType === actualType || declaredType === 'literal') return;\n  throw new Error(\n    `Predicate ${predicate ?? '(unknown)'} is declared as ${declaredType}, but received ${actualType}`,\n  );\n}\n\nfunction isTermLike(value: unknown): value is Term {\n  return !!value && typeof value === 'object' && 'termType' in value;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@undefineds.co/xpod",
-  "version": "0.2.42",
+  "version": "0.2.44",
   "description": "Xpod is an extended Community Solid Server, offering rich-feature, production-level Solid Pod and identity management.",
   "repository": "https://github.com/undefinedsco/xpod",
   "author": "developer@undefineds.co",