@_linked/core 0.0.1 → 1.0.0-next.20260211072341

package/src/ontologies/shacl.ts

@@ -1,136 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-import {NodeReferenceValue} from '../utils/NodeReference.js';
-import {Prefix} from '../utils/Prefix.js';
-import {createNameSpace} from '../utils/NameSpace.js';
-
-const base = 'http://www.w3.org/ns/shacl#';
-export const _ontologyResource: NodeReferenceValue = {id: base};
-Prefix.add('shacl', base);
-
-export const ns = createNameSpace(base);
-
-//add your ontology nodes here
-const _class = ns('class');
-const datatype = ns('datatype');
-const declare = ns('declare');
-const _in = ns('in');
-const maxCount = ns('maxCount');
-const minCount = ns('minCount');
-const inList = ns('inList');
-const name = ns('name');
-const description = ns('description');
-const NodeShape = ns('NodeShape');
-const optional = ns('optional');
-const Parameter = ns('Parameter');
-const PrefixDeclaration = ns('PrefixDeclaration');
-const path = ns('path');
-const property = ns('property');
-const prefix = ns('prefix');
-const PropertyShape = ns('PropertyShape');
-const targetClass = ns('targetClass');
-const targetNode = ns('targetNode');
-const node = ns('node');
-const nodeKind = ns('nodeKind');
-const Shape = ns('Shape');
-
-const BlankNode = ns('BlankNode');
-const IRI = ns('IRI');
-const Literal = ns('Literal');
-const BlankNodeOrIRI = ns('BlankNodeOrIRI');
-const BlankNodeOrLiteral = ns('BlankNodeOrLiteral');
-const IRIOrLiteral = ns('IRIOrLiteral');
-
-export const languageIn = ns('languageIn');
-export const lessThan = ns('lessThan');
-export const lessThanOrEquals = ns('lessThanOrEquals');
-export const maxExclusive = ns('maxExclusive');
-export const maxInclusive = ns('maxInclusive');
-export const maxLength = ns('maxLength');
-export const minExclusive = ns('minExclusive');
-export const minInclusive = ns('minInclusive');
-export const minLength = ns('minLength');
-export const pattern = ns('pattern');
-export const uniqueLang = ns('uniqueLang');
-export const ValidationReport = ns('ValidationReport');
-export const conforms = ns('conforms');
-export const ValidationResult = ns('ValidationResult');
-export const focusNode = ns('focusNode');
-export const sourceShape = ns('sourceShape');
-export const resultSeverity = ns('resultSeverity');
-export const resultPath = ns('resultPath');
-export const value = ns('value');
-export const message = ns('message');
-export const Violation = ns('Violation');
-export const AbstractResult = ns('AbstractResult');
-export const sourceConstraintComponent = ns('sourceConstraintComponent');
-export const ClassConstraintComponent = ns('ClassConstraintComponent');
-export const NodeConstraintComponent = ns('NodeConstraintComponent');
-export const DatatypeConstraintComponent = ns('DatatypeConstraintComponent');
-export const MinLengthConstraintComponent = ns('MinLengthConstraintComponent');
-export const MaxLengthConstraintComponent = ns('MaxLengthConstraintComponent');
-export const result = ns('result');
-
-//make sure every node is also exported here
-export const shacl = {
-  class: _class,
-  datatype,
-  declare,
-  in: _in,
-  maxCount,
-  minCount,
-  name,
-  description,
-  node,
-  NodeShape,
-  optional,
-  Parameter,
-  PrefixDeclaration,
-  path,
-  prefix,
-  property,
-  PropertyShape,
-  Shape,
-  targetClass,
-  targetNode,
-  BlankNode,
-  IRI,
-  Literal,
-  BlankNodeOrIRI,
-  BlankNodeOrLiteral,
-  IRIOrLiteral,
-  nodeKind,
-  inList,
-  languageIn,
-  lessThan,
-  lessThanOrEquals,
-  maxExclusive,
-  maxInclusive,
-  maxLength,
-  minExclusive,
-  minInclusive,
-  minLength,
-  pattern,
-  uniqueLang,
-  ValidationReport,
-  conforms,
-  ValidationResult,
-  focusNode,
-  sourceShape,
-  resultSeverity,
-  resultPath,
-  value,
-  message,
-  Violation,
-  sourceConstraintComponent,
-  ClassConstraintComponent,
-  NodeConstraintComponent,
-  DatatypeConstraintComponent,
-  MinLengthConstraintComponent,
-  MaxLengthConstraintComponent,
-  AbstractResult,
-  result,
-};

package/src/ontologies/xsd.ts

@@ -1,47 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-import {NodeReferenceValue} from '../utils/NodeReference.js';
-import {Prefix} from '../utils/Prefix.js';
-
-const base = 'http://www.w3.org/2001/XMLSchema#';
-export const ns = (term: string): NodeReferenceValue => ({id: base + term});
-
-export const _ontologyResource = ns('');
-Prefix.add('xsd', base);
-
-const string = ns('string');
-const boolean = ns('boolean');
-const date = ns('date');
-const integer = ns('integer');
-const float = ns('float');
-const double = ns('double');
-const time = ns('time');
-const duration = ns('duration');
-const decimal = ns('decimal');
-const gYear = ns('gYear');
-const Bytes = ns('Bytes');
-const long = ns('long');
-const dateTime = ns('dateTime');
-
-//not yet required by core so why define it?
-//export var boolean:NamedNode = nodes.getOrCreate(base+"boolean");
-
-export const xsd = {
-  _ontologyResource,
-  string,
-  boolean,
-  date,
-  integer,
-  float,
-  double,
-  time,
-  duration,
-  decimal,
-  gYear,
-  Bytes,
-  long,
-  dateTime,
-};

package/src/package.ts

@@ -1,11 +0,0 @@
-import {corePackage} from './utils/Package.js';
-
-export const {
-  linkedShape,
-  linkedUtil,
-  linkedOntology,
-  registerPackageExport,
-  registerPackageModule,
-  packageExports,
-  getPackageShape,
-} = corePackage;

package/src/queries/CreateQuery.ts

@@ -1,41 +0,0 @@
-import {Shape} from '../shapes/Shape.js';
-import {NodeShape} from '../shapes/SHACL.js';
-import {LinkedQuery} from './SelectQuery.js';
-import {AddId, NodeDescriptionValue, UpdatePartial} from './QueryFactory.js';
-import {MutationQueryFactory} from './MutationQuery.js';
-
-export interface CreateQuery<ResponseType = null> extends LinkedQuery {
-  type: 'create';
-  shape: NodeShape;
-  description: NodeDescriptionValue;
-}
-
-export type CreateResponse<U> = AddId<U, true>;
-
-export class CreateQueryFactory<
-  ShapeType extends Shape,
-  U extends UpdatePartial<ShapeType>,
-> extends MutationQueryFactory {
-  readonly id: string;
-  readonly description: NodeDescriptionValue;
-
-  constructor(
-    public shapeClass: typeof Shape,
-    updateObjectOrFn: U,
-  ) {
-    super();
-    this.description = this.convertUpdateObject(
-      updateObjectOrFn,
-      this.shapeClass.shape,
-      true,
-    );
-  }
-
-  getQueryObject(): CreateQuery<AddId<U, true>> {
-    return {
-      type: 'create',
-      shape: this.shapeClass.shape,
-      description: this.description,
-    };
-  }
-}

package/src/queries/DeleteQuery.ts

@@ -1,54 +0,0 @@
-import {Shape} from '../shapes/Shape.js';
-import {NodeShape} from '../shapes/SHACL.js';
-import {LinkedQuery} from './SelectQuery.js';
-import {NodeReferenceValue, UpdatePartial} from './QueryFactory.js';
-import {MutationQueryFactory, NodeId} from './MutationQuery.js';
-
-export interface DeleteQuery extends LinkedQuery {
-  type: 'delete';
-  shape: NodeShape;
-  ids: NodeReferenceValue[];
-}
-
-export type DeleteResponse = {
-  /**
-   * The IDs of the items that were successfully deleted.
-   */
-  deleted: NodeReferenceValue[];
-  /**
-   * The number of successfully deleted items.
-   */
-  count: number;
-  /**
-   * The IDs of the items that couldn't be deleted.
-   */
-  failed?: NodeReferenceValue[];
-  /**
-   * A mapping of IDs to error messages for the items that couldn't be deleted.
-   */
-  errors?: Record<string, string>;
-};
-
-export class DeleteQueryFactory<
-  ShapeType extends Shape,
-  U extends UpdatePartial<ShapeType>,
-> extends MutationQueryFactory {
-  readonly id: string;
-  readonly ids: NodeReferenceValue[];
-
-  constructor(
-    public shapeClass: typeof Shape,
-    ids: NodeId[] | NodeId,
-  ) {
-    super();
-    this.ids = this.convertNodeReferences(ids);
-  }
-
-  getQueryObject(): DeleteQuery {
-    return {
-      type: 'delete',
-      shape: this.shapeClass.shape,
-      ids: this.ids,
-    };
-  }
-}

package/src/queries/MutationQuery.ts

@@ -1,287 +0,0 @@
-import {
-  LiteralUpdateValue,
-  NodeDescriptionValue,
-  NodeReferenceValue,
-  PropUpdateValue,
-  QueryFactory,
-  SetModification,
-  SetModificationValue,
-  SinglePropertyUpdateValue,
-  UpdateNodePropertyValue,
-  UpdatePartial,
-} from './QueryFactory.js';
-import {NodeShape, PropertyShape} from '../shapes/SHACL.js';
-import {Shape} from '../shapes/Shape.js';
-import {getShapeClass} from '../utils/ShapeClass.js';
-
-export type NodeId = {id: string} | string;
-
-export class MutationQueryFactory extends QueryFactory {
-  protected convertUpdateObject(
-    obj,
-    shape: NodeShape,
-    allowTopLevelId: boolean = false,
-  ): NodeDescriptionValue {
-    if (typeof obj === 'object' && !(obj instanceof Date) && obj !== null) {
-      if (!allowTopLevelId && 'id' in obj) {
-        throw new Error(
-          'You cannot use id in the top level of an update object',
-        );
-      }
-      return this.convertNodeDescription(obj, shape);
-    } else if (typeof obj === 'function') {
-      //TODO
-      throw new Error('Update functions are not implemented yet');
-    } else {
-      throw new Error('Invalid update object');
-    }
-  }
-
-  protected isSetModification(obj, shape) {
-    // return obj.add || obj.remove;
-    let hasAdd = obj.add;
-    let hasRemove = obj.remove;
-    let numKeysExpected = (hasAdd ? 1 : 0) + (hasRemove ? 1 : 0);
-    let numKeys = Object.getOwnPropertyNames(obj).length;
-    return hasAdd || (hasRemove && numKeysExpected === numKeys);
-  }
-
-  protected convertSetModification(
-    obj: SetModification<any>,
-    shape: PropertyShape,
-  ): SetModificationValue {
-    if (!obj.add && !obj.remove) {
-      throw new Error('Set modification should have either add or remove key');
-    }
-    const res: SetModificationValue = {};
-    if (obj.add) {
-      res.$add = this.convertSetAddValue(obj.add, shape);
-    }
-    if (obj.remove) {
-      res.$remove = this.convertSetRemoveValue(obj.remove, shape);
-    }
-    return res;
-  }
-
-  protected convertSetRemoveValue(
-    obj: UpdatePartial | UpdatePartial[],
-    shape: PropertyShape,
-  ): NodeReferenceValue[] {
-    //the user can either pass an array of node references or a single node reference
-    //either way we should return an array of node reference values
-    if (Array.isArray(obj)) {
-      return obj.map((o) => this.convertSingleRemoveValue(o, shape));
-    } else {
-      return [this.convertSingleRemoveValue(obj, shape)];
-    }
-  }
-
-  protected convertSetAddValue(
-    obj: UpdatePartial | UpdatePartial[],
-    shape: PropertyShape,
-  ): UpdatePartial[] {
-    if (Array.isArray(obj)) {
-      return obj.map((o) => this.convertUpdateValue(o, shape) as UpdatePartial);
-    } else {
-      return [this.convertUpdateValue(obj, shape) as UpdatePartial];
-    }
-  }
-
-  protected convertSingleRemoveValue(
-    value,
-    shape: PropertyShape,
-  ): NodeReferenceValue {
-    if (this.isNodeReference(value)) {
-      return this.convertNodeReference(value);
-    } else {
-      throw new Error(
-        `Invalid value for ${shape.label}.$remove. Expected an object with an id as key: {id:string}`,
-      );
-    }
-  }
-
-  protected convertNodeDescription(
-    obj: Object,
-    shape: NodeShape,
-  ): NodeDescriptionValue {
-    const props = shape.getPropertyShapes(true);
-    const fields: UpdateNodePropertyValue[] = [];
-    let id;
-    if (obj && '__id' in obj) {
-      //if the object has a __id key, then we should use that in the result
-      id = obj.__id.toString();
-      //but we should not include it in the fields
-      delete obj.__id;
-    }
-    for (var key in obj) {
-      let propShape = props.find((p) => p.label === key);
-      if (!propShape) {
-        throw Error(
-          `Invalid property key: ${key}. The shape ${shape.label || shape.id.split('/').pop()} does not have a registered property with this name. Make sure the get/set method exists, and that it uses a @objectProperty or @literalProperty decorator.`,
-        );
-      } else {
-        fields.push(this.createNodePropertyValue(obj[key], propShape));
-      }
-    }
-    const res: NodeDescriptionValue = {
-      fields,
-      shape,
-    };
-    if (id) {
-      res.__id = id;
-    }
-
-    return res;
-  }
-
-  protected createNodePropertyValue(
-    value,
-    propShape: PropertyShape,
-  ): UpdateNodePropertyValue {
-    // let value = obj[propShape.label];
-    return {
-      prop: propShape,
-      val: this.convertUpdateValue(value, propShape),
-    } as UpdateNodePropertyValue;
-  }
-
-  protected convertUpdateValue(
-    value,
-    propShape?: PropertyShape,
-    allowArrays: boolean = true,
-  ): PropUpdateValue {
-    //single value which will
-    if (
-      typeof value === 'string' ||
-      typeof value === 'number' ||
-      typeof value === 'boolean' ||
-      value instanceof Date
-    ) {
-      return value as LiteralUpdateValue;
-    }
-
-    //if multiple items are given as value of this prop
-    if (Array.isArray(value)) {
-      if (!allowArrays) {
-        throw new Error('Nested arrays are not allowed as values of keys');
-      }
-      //then convert each value, but disallow nested arrays moving forward
-      return value.map((o) => {
-        return this.convertUpdateValue(o, propShape, false);
-      }) as SinglePropertyUpdateValue[];
-    } else if (typeof value === 'undefined') {
-      return value;
-    } else if (value === null) {
-      //unsetting a value with null is also possible. But we pass it as undefined in the query object
-      return undefined;
-    } else if (typeof value === 'object') {
-      if (this.isNodeReference(value)) {
-        return this.convertNodeReference(value);
-      } else {
-        let valueShape: NodeShape = null;
-        if (propShape.valueShape) {
-          const shapeClass = getShapeClass(propShape.valueShape);
-          valueShape = shapeClass?.shape || null;
-          if (!valueShape) {
-            throw new Error(
-              `Shape class not found for ${propShape.valueShape.id}`,
-            );
-          }
-        }
-        //pass the value shape of the property as the node shape of this value
-        if (!propShape.valueShape) {
-          //It's possible to define the shape of the value in the value itself for properties who do not define the shape in their objectProperty
-          if (value.shape) {
-            if (!(value.shape.shape instanceof NodeShape)) {
-              throw new Error(
-                `The value of property "shape" is invalid and should be a class that extends Shape.`,
-              );
-            }
-            valueShape = (value.shape as typeof Shape).shape;
-          } else {
-            //TODO: not sure if this should be an error. Does every @linkedObject need to define the shape of the values?
-            // If not, then how do we continue? because currently we use the value shape to look up further property shapes
-            throw new Error(
-              `Cannot update properties with plain objects if the shape of the values is not known. Make sure get/set ${propShape.parentNodeShape.label}.${propShape.label} defines the 'shape' key in its @objectProperty decorator.`,
-            );
-          }
-        }
-        //never keep a shape key in the value object
-        if (value.shape) {
-          //double check that IF a shape value is provided, that it matches the shape from the @objectProperty decorator
-          if ((value.shape as typeof Shape).shape.id !== valueShape.id) {
-            throw new Error(
-              `The property 'shape' is reserved in LINCD and should not be used here in this way. The ${propShape.label} property already defines the shape of the value as ${propShape.label}. If you want to use a different shape, use the 'shape' key in the @objectProperty decorator.`,
-            );
-          }
-          delete value.shape;
-        }
-
-        if (this.isSetModification(value, propShape)) {
-          return this.convertSetModification(value, propShape);
-        } else {
-          return this.convertNodeDescription(value, valueShape);
-        }
-        // //check if the property shape allows a single value
-        // if(propShape.maxCount === 1) {
-        //   //if yes, then the object should be seen as a node description
-        //   return this.convertNodeDescription(value,propShape.valueShape);
-        // } else {
-        //   if(this.isSetModification(value,propShape)) {
-        //     //but if multiple values are allowed, the value should either be an Array of node descriptions
-        //     //OR an object with add or remove keys
-        //     return this.convertSetModification(value,propShape);
-        //   } else {
-        //     //it must be a set overwrite, and it must be coming from an array
-        //     if(!allowArrays) {
-        //       return this.convertNodeDescription(value,propShape.valueShape);
-        //     } else {
-        //       throw new Error("Invalid array value. Should be a node reference or node description")
-        //     }
-        //   }
-        // }
-      }
-    }
-    throw new Error(`Unsupported update value type: ${typeof value}`);
-  }
-
-  protected isNodeReference(obj): obj is NodeReferenceValue {
-    //check if obj is an object with an id property
-    //if yes, all other properties are ignored
-    return typeof obj === 'object' && obj !== null && 'id' in obj; // && Object.keys(obj).length === 1);
-    //and id is the only property
-  }
-
-  protected convertNodeReferences(
-    input: NodeId[] | NodeId,
-  ): NodeReferenceValue[] {
-    if (Array.isArray(input)) {
-      return input.map((o) => {
-        return this.convertNodeReferenceOrString(o);
-      });
-    } else {
-      return [this.convertNodeReferenceOrString(input)];
-    }
-  }
-
-  protected convertNodeReferenceOrString(
-    o: {id: string} | string,
-  ): NodeReferenceValue {
-    if (typeof o === 'string') {
-      return {id: o};
-    } else if (this.isNodeReference(o)) {
-      return this.convertNodeReference(o);
-    } else {
-      throw new Error(`Invalid node reference: ${JSON.stringify(o)}`);
-    }
-  }
-
-  protected convertNodeReference(obj: {id: string}): NodeReferenceValue {
-    //ensure there are no other properties in the object
-    // if (Object.keys(obj).length > 1)
-    // {
-    //   throw new Error('Cannot have id and other properties in the same value object');
-    // }
-    return {id: obj.id};
-  }
-}

package/src/queries/QueryContext.ts

@@ -1,41 +0,0 @@
-import {QShape, QueryShape} from './SelectQuery.js';
-import {Shape} from '../shapes/Shape.js';
-
-const queryContext = new Map<string, QShape<any, any, any>>();
-
-export function getQueryContext<T extends Shape>(name: string): QShape<T> {
-  if (!queryContext.has(name)) {
-    //TODO:should return something here so that the query still works and returns default values
-    // like NullQueryShape or similar
-    return null;
-  }
-  return queryContext.get(name);
-}
-
-export function setQueryContext(name: string, value: any, shapeType?) {
-  //if a QResult was provided
-  if (value && typeof value.id === 'string') {
-    //convert to QShape
-    if (!shapeType) {
-      console.warn(
-        'setQueryContext: value is a QResult but no shapeType provided',
-        value,
-      );
-      return;
-    }
-    const shape = new (shapeType as any)();
-    shape.id = value.id;
-    shape.__queryContextId = value.id;
-    value = QueryShape.create(shape);
-    //const converted = QueryBuilderObject.convertOriginal(shape,null,null);
-  }
-  if (value instanceof Shape) {
-    //convert to QShape
-    value = new QueryShape(value);
-  } else if (value && !(value instanceof QueryShape)) {
-    console.warn('setQueryContext: value is not a QueryShape or Shape', value);
-    return;
-  }
-
-  queryContext.set(name, value);
-}