@twin.org/auditable-item-graph-service 0.10.1-next.2 → 0.10.1-next.4

package/dist/es/auditableItemGraphService.js

@@ -3,7 +3,7 @@
 import { HealthCategory, HealthStatus } from "@twin.org/api-models";
 import { AuditableItemGraphAuditMode, AuditableItemGraphContexts, AuditableItemGraphDataTypes, AuditableItemGraphMetricIds, AuditableItemGraphMetrics, AuditableItemGraphTopics, AuditableItemGraphTypes, VerifyDepth } from "@twin.org/auditable-item-graph-models";
 import { ContextIdHelper, ContextIdKeys, ContextIdStore } from "@twin.org/context";
-import { ArrayHelper, BaseError, Coerce, ComponentFactory, Converter, GeneralError, Guards, Is, JsonHelper, Mutex, NotFoundError, ObjectHelper, RandomHelper, StringHelper, Urn, Validation } from "@twin.org/core";
+import { ArrayHelper, BaseError, Coerce, ComponentFactory, GeneralError, Guards, Is, JsonHelper, Mutex, NotFoundError, ObjectHelper, RandomHelper, StringHelper, Urn, Validation } from "@twin.org/core";
 import { DataTypeHelper } from "@twin.org/data-core";
 import { JsonLdDataTypes, JsonLdHelper, JsonLdProcessor } from "@twin.org/data-json-ld";
 import { ComparisonOperator, LogicalOperator, SortDirection } from "@twin.org/entity";
@@ -11,6 +11,7 @@ import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
 import { ImmutableProofContexts, ImmutableProofFailure, ImmutableProofTypes } from "@twin.org/immutable-proof-models";
 import { SchemaOrgContexts, SchemaOrgDataTypes, SchemaOrgTypes } from "@twin.org/standards-schema-org";
 import { MetricHelper } from "@twin.org/telemetry-models";
+import { AuditableItemGraphVertexIndexHelper } from "./utils/auditableItemGraphVertexIndexHelper.js";
 /**
  * Class for performing auditable item graph operations.
  */
@@ -1624,7 +1625,7 @@ export class AuditableItemGraphService {
             property: "vertexId",
             comparison: ComparisonOperator.Equals,
             value: vertex.id
-        }, ["id", "type", "value", "dateCreated", "dateModified"]);
+        }, ["id", "type", "value", "valueHash", "dateCreated", "dateModified"]);
         // Collapse by row id first. A paged read can return the same row on more than one page,
         // and without this a retained row could be queued for removal by its own duplicate.
         const existingById = new Map();
@@ -1643,16 +1644,13 @@ export class AuditableItemGraphService {
             const requiredEntry = required.get(key);
             if (!Is.empty(requiredEntry) && !retainedKeys.has(key)) {
                 retainedKeys.add(key);
-                if (entry.dateCreated !== vertex.dateCreated || entry.dateModified !== indexDateModified) {
-                    // Keep the row id so the copied dates are corrected in place rather than duplicated.
-                    writeEntries.push({
-                        id,
-                        vertexId: vertex.id,
-                        type: requiredEntry.type,
-                        value: requiredEntry.value,
-                        dateCreated: vertex.dateCreated,
-                        dateModified: indexDateModified
-                    });
+                const requiredIndexEntry = AuditableItemGraphVertexIndexHelper.createIndexEntry(vertex.id, requiredEntry.type, requiredEntry.value, vertex.dateCreated, indexDateModified);
+                if (entry.dateCreated !== requiredIndexEntry.dateCreated ||
+                    entry.dateModified !== requiredIndexEntry.dateModified ||
+                    entry.valueHash !== requiredIndexEntry.valueHash) {
+                    // Keep the row id so the copied dates and hash are corrected in place rather than
+                    // duplicated.
+                    writeEntries.push({ ...requiredIndexEntry, id });
                 }
             }
             else {
@@ -1661,14 +1659,7 @@ export class AuditableItemGraphService {
         }
         for (const [key, entry] of required) {
             if (!retainedKeys.has(key)) {
-                writeEntries.push({
-                    id: Converter.bytesToHex(RandomHelper.generate(16)),
-                    vertexId: vertex.id,
-                    type: entry.type,
-                    value: entry.value,
-                    dateCreated: vertex.dateCreated,
-                    dateModified: indexDateModified
-                });
+                writeEntries.push(AuditableItemGraphVertexIndexHelper.createIndexEntry(vertex.id, entry.type, entry.value, vertex.dateCreated, indexDateModified));
             }
         }
         if (removeIds.length > 0) {
@@ -1709,7 +1700,8 @@ export class AuditableItemGraphService {
         };
     }
     /**
-     * Build the condition matching one index type and value.
+     * Build the condition matching one index type and value. Exact matches are looked up by the
+     * value hash, a partial match can only be answered by the value itself.
      * @param type The index type to match.
      * @param comparison The comparison to apply to the value.
      * @param value The index value or values to match, already lower cased.
@@ -1717,11 +1709,20 @@ export class AuditableItemGraphService {
      * @internal
      */
     indexTypeValueCondition(type, comparison, value) {
+        const valueCondition = comparison === ComparisonOperator.Includes
+            ? { property: "value", comparison, value }
+            : {
+                property: "valueHash",
+                comparison,
+                value: Is.array(value)
+                    ? value.map(v => AuditableItemGraphVertexIndexHelper.hashValue(v))
+                    : AuditableItemGraphVertexIndexHelper.hashValue(value)
+            };
         return {
             logicalOperator: LogicalOperator.And,
             conditions: [
                 { property: "type", comparison: ComparisonOperator.Equals, value: type },
-                { property: "value", comparison, value }
+                valueCondition
             ]
         };
     }
@@ -1813,9 +1814,9 @@ export class AuditableItemGraphService {
                     value: AuditableItemGraphService._INDEX_TYPE_ALIAS
                 },
                 {
-                    property: "value",
+                    property: "valueHash",
                     comparison: ComparisonOperator.Equals,
-                    value: aliasId.toLowerCase()
+                    value: AuditableItemGraphVertexIndexHelper.hashValue(aliasId)
                 },
                 {
                     property: "vertexId",