@3sixty/auditable-item-graph-service 0.0.0-stage → 0.20.0-next.0

package/dist/es/schema.js

@@ -0,0 +1,27 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { EntitySchemaFactory, EntitySchemaHelper } from "@3sixty/entity";
+import { AuditableItemGraphAlias } from "./entities/auditableItemGraphAlias.js";
+import { AuditableItemGraphChangeset } from "./entities/auditableItemGraphChangeset.js";
+import { AuditableItemGraphEdge } from "./entities/auditableItemGraphEdge.js";
+import { AuditableItemGraphPatch } from "./entities/auditableItemGraphPatch.js";
+import { AuditableItemGraphResource } from "./entities/auditableItemGraphResource.js";
+import { AuditableItemGraphVertex } from "./entities/auditableItemGraphVertex.js";
+import { AuditableItemGraphVertexIndex } from "./entities/auditableItemGraphVertexIndex.js";
+import { AuditableItemGraphVertexV0 } from "./entities/auditableItemGraphVertexV0.js";
+import { AuditableItemGraphVertexV1 } from "./entities/auditableItemGraphVertexV1.js";
+/**
+ * Initialize the schema for the auditable item graph entity storage connector.
+ */
+export function initSchema() {
+    EntitySchemaFactory.register("AuditableItemGraphVertex", () => EntitySchemaHelper.getSchema(AuditableItemGraphVertex));
+    EntitySchemaFactory.register("AuditableItemGraphVertexV0", () => EntitySchemaHelper.getSchema(AuditableItemGraphVertexV0));
+    EntitySchemaFactory.register("AuditableItemGraphVertexV1", () => EntitySchemaHelper.getSchema(AuditableItemGraphVertexV1));
+    EntitySchemaFactory.register("AuditableItemGraphVertexIndex", () => EntitySchemaHelper.getSchema(AuditableItemGraphVertexIndex));
+    EntitySchemaFactory.register("AuditableItemGraphAlias", () => EntitySchemaHelper.getSchema(AuditableItemGraphAlias));
+    EntitySchemaFactory.register("AuditableItemGraphResource", () => EntitySchemaHelper.getSchema(AuditableItemGraphResource));
+    EntitySchemaFactory.register("AuditableItemGraphEdge", () => EntitySchemaHelper.getSchema(AuditableItemGraphEdge));
+    EntitySchemaFactory.register("AuditableItemGraphChangeset", () => EntitySchemaHelper.getSchema(AuditableItemGraphChangeset));
+    EntitySchemaFactory.register("AuditableItemGraphPatch", () => EntitySchemaHelper.getSchema(AuditableItemGraphPatch));
+}
+//# sourceMappingURL=schema.js.map

package/dist/es/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAC;AAC5F,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AACtF,OAAO,EAAE,0BAA0B,EAAE,MAAM,0CAA0C,CAAC;AAEtF;;GAEG;AACH,MAAM,UAAU,UAAU;IACzB,mBAAmB,CAAC,QAAQ,6BAAqC,GAAG,EAAE,CACrE,kBAAkB,CAAC,SAAS,CAAC,wBAAwB,CAAC,CACtD,CAAC;IACF,mBAAmB,CAAC,QAAQ,+BAAuC,GAAG,EAAE,CACvE,kBAAkB,CAAC,SAAS,CAAC,0BAA0B,CAAC,CACxD,CAAC;IACF,mBAAmB,CAAC,QAAQ,+BAAuC,GAAG,EAAE,CACvE,kBAAkB,CAAC,SAAS,CAAC,0BAA0B,CAAC,CACxD,CAAC;IACF,mBAAmB,CAAC,QAAQ,kCAA0C,GAAG,EAAE,CAC1E,kBAAkB,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAC3D,CAAC;IACF,mBAAmB,CAAC,QAAQ,4BAAoC,GAAG,EAAE,CACpE,kBAAkB,CAAC,SAAS,CAAC,uBAAuB,CAAC,CACrD,CAAC;IACF,mBAAmB,CAAC,QAAQ,+BAAuC,GAAG,EAAE,CACvE,kBAAkB,CAAC,SAAS,CAAC,0BAA0B,CAAC,CACxD,CAAC;IACF,mBAAmB,CAAC,QAAQ,2BAAmC,GAAG,EAAE,CACnE,kBAAkB,CAAC,SAAS,CAAC,sBAAsB,CAAC,CACpD,CAAC;IACF,mBAAmB,CAAC,QAAQ,gCAAwC,GAAG,EAAE,CACxE,kBAAkB,CAAC,SAAS,CAAC,2BAA2B,CAAC,CACzD,CAAC;IACF,mBAAmB,CAAC,QAAQ,4BAAoC,GAAG,EAAE,CACpE,kBAAkB,CAAC,SAAS,CAAC,uBAAuB,CAAC,CACrD,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { EntitySchemaFactory, EntitySchemaHelper } from \"@3sixty/entity\";\nimport { nameof } from \"@3sixty/nameof\";\nimport { AuditableItemGraphAlias } from \"./entities/auditableItemGraphAlias.js\";\nimport { AuditableItemGraphChangeset } from \"./entities/auditableItemGraphChangeset.js\";\nimport { AuditableItemGraphEdge } from \"./entities/auditableItemGraphEdge.js\";\nimport { AuditableItemGraphPatch } from \"./entities/auditableItemGraphPatch.js\";\nimport { AuditableItemGraphResource } from \"./entities/auditableItemGraphResource.js\";\nimport { AuditableItemGraphVertex } from \"./entities/auditableItemGraphVertex.js\";\nimport { AuditableItemGraphVertexIndex } from \"./entities/auditableItemGraphVertexIndex.js\";\nimport { AuditableItemGraphVertexV0 } from \"./entities/auditableItemGraphVertexV0.js\";\nimport { AuditableItemGraphVertexV1 } from \"./entities/auditableItemGraphVertexV1.js\";\n\n/**\n * Initialize the schema for the auditable item graph entity storage connector.\n */\nexport function initSchema(): void {\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphVertex>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphVertex)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphVertexV0>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphVertexV0)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphVertexV1>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphVertexV1)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphVertexIndex>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphVertexIndex)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphAlias>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphAlias)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphResource>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphResource)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphEdge>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphEdge)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphChangeset>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphChangeset)\n\t);\n\tEntitySchemaFactory.register(nameof<AuditableItemGraphPatch>(), () =>\n\t\tEntitySchemaHelper.getSchema(AuditableItemGraphPatch)\n\t);\n}\n"]}

package/dist/es/utils/auditableItemGraphVertexIndexHelper.js

@@ -0,0 +1,57 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, Is, JsonHelper, ObjectHelper } from "@3sixty/core";
+import { Blake2b } from "@3sixty/crypto";
+/**
+ * Helper methods for building auditable item graph vertex index entries.
+ */
+export class AuditableItemGraphVertexIndexHelper {
+    /**
+     * Create the index entry for one type and value of a vertex. The value is case folded and
+     * hashed, and the id is derived from the content so the same entry always produces the same id.
+     * The modification date is excluded from the id as it is optional and changes over time.
+     * @param vertexId The id of the vertex the entry refers to.
+     * @param type The index type.
+     * @param value The index value.
+     * @param dateCreated The creation date of the vertex.
+     * @param dateModified The modification date of the vertex.
+     * @returns The index entry.
+     */
+    static createIndexEntry(vertexId, type, value, dateCreated, dateModified) {
+        const foldedValue = AuditableItemGraphVertexIndexHelper.foldValue(value);
+        const entry = {
+            vertexId,
+            type,
+            value: foldedValue ?? value,
+            valueHash: AuditableItemGraphVertexIndexHelper.hashValue(foldedValue) ?? "",
+            dateCreated
+        };
+        return {
+            id: Converter.bytesToHex(Blake2b.sum256(ObjectHelper.toBytes(JsonHelper.canonicalize(entry)))),
+            ...entry,
+            dateModified
+        };
+    }
+    /**
+     * Hash an index value so the composite index key has a fixed size whatever the value length.
+     * The value is case folded first so lookups are case insensitive.
+     * @param value The value to hash.
+     * @returns The base64 url encoded Blake2b-160 hash, or undefined when there is no value.
+     */
+    static hashValue(value) {
+        const folded = AuditableItemGraphVertexIndexHelper.foldValue(value);
+        return Is.stringValue(folded)
+            ? Converter.bytesToBase64Url(Blake2b.sum160(Converter.utf8ToBytes(folded)))
+            : undefined;
+    }
+    /**
+     * Case fold an index value.
+     * @param value The value to fold.
+     * @returns The lower cased value, or undefined when there is no value.
+     * @internal
+     */
+    static foldValue(value) {
+        return Is.stringValue(value) ? value.toLowerCase() : undefined;
+    }
+}
+//# sourceMappingURL=auditableItemGraphVertexIndexHelper.js.map

package/dist/es/utils/auditableItemGraphVertexIndexHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditableItemGraphVertexIndexHelper.js","sourceRoot":"","sources":["../../../src/utils/auditableItemGraphVertexIndexHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,MAAM,OAAO,mCAAmC;IAC/C;;;;;;;;;;OAUG;IACI,MAAM,CAAC,gBAAgB,CAC7B,QAAgB,EAChB,IAAY,EACZ,KAAa,EACb,WAAmB,EACnB,YAAqB;QAErB,MAAM,WAAW,GAAG,mCAAmC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAEzE,MAAM,KAAK,GAA+D;YACzE,QAAQ;YACR,IAAI;YACJ,KAAK,EAAE,WAAW,IAAI,KAAK;YAC3B,SAAS,EAAE,mCAAmC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;YAC3E,WAAW;SACX,CAAC;QAEF,OAAO;YACN,EAAE,EAAE,SAAS,CAAC,UAAU,CACvB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CACpE;YACD,GAAG,KAAK;YACR,YAAY;SACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,KAAc;QACrC,MAAM,MAAM,GAAG,mCAAmC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC;YAC5B,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YAC3E,CAAC,CAAC,SAAS,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,SAAS,CAAC,KAAc;QACtC,OAAO,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAChE,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, Is, JsonHelper, ObjectHelper } from \"@3sixty/core\";\nimport { Blake2b } from \"@3sixty/crypto\";\nimport type { AuditableItemGraphVertexIndex } from \"../entities/auditableItemGraphVertexIndex.js\";\n\n/**\n * Helper methods for building auditable item graph vertex index entries.\n */\nexport class AuditableItemGraphVertexIndexHelper {\n\t/**\n\t * Create the index entry for one type and value of a vertex. The value is case folded and\n\t * hashed, and the id is derived from the content so the same entry always produces the same id.\n\t * The modification date is excluded from the id as it is optional and changes over time.\n\t * @param vertexId The id of the vertex the entry refers to.\n\t * @param type The index type.\n\t * @param value The index value.\n\t * @param dateCreated The creation date of the vertex.\n\t * @param dateModified The modification date of the vertex.\n\t * @returns The index entry.\n\t */\n\tpublic static createIndexEntry(\n\t\tvertexId: string,\n\t\ttype: string,\n\t\tvalue: string,\n\t\tdateCreated: string,\n\t\tdateModified?: string\n\t): AuditableItemGraphVertexIndex {\n\t\tconst foldedValue = AuditableItemGraphVertexIndexHelper.foldValue(value);\n\n\t\tconst entry: Omit<AuditableItemGraphVertexIndex, \"id\" | \"dateModified\"> = {\n\t\t\tvertexId,\n\t\t\ttype,\n\t\t\tvalue: foldedValue ?? value,\n\t\t\tvalueHash: AuditableItemGraphVertexIndexHelper.hashValue(foldedValue) ?? \"\",\n\t\t\tdateCreated\n\t\t};\n\n\t\treturn {\n\t\t\tid: Converter.bytesToHex(\n\t\t\t\tBlake2b.sum256(ObjectHelper.toBytes(JsonHelper.canonicalize(entry)))\n\t\t\t),\n\t\t\t...entry,\n\t\t\tdateModified\n\t\t};\n\t}\n\n\t/**\n\t * Hash an index value so the composite index key has a fixed size whatever the value length.\n\t * The value is case folded first so lookups are case insensitive.\n\t * @param value The value to hash.\n\t * @returns The base64 url encoded Blake2b-160 hash, or undefined when there is no value.\n\t */\n\tpublic static hashValue(value?: string): string | undefined {\n\t\tconst folded = AuditableItemGraphVertexIndexHelper.foldValue(value);\n\t\treturn Is.stringValue(folded)\n\t\t\t? Converter.bytesToBase64Url(Blake2b.sum160(Converter.utf8ToBytes(folded)))\n\t\t\t: undefined;\n\t}\n\n\t/**\n\t * Case fold an index value.\n\t * @param value The value to fold.\n\t * @returns The lower cased value, or undefined when there is no value.\n\t * @internal\n\t */\n\tprivate static foldValue(value?: string): string | undefined {\n\t\treturn Is.stringValue(value) ? value.toLowerCase() : undefined;\n\t}\n}\n"]}

package/dist/types/auditableItemGraphRoutes.d.ts

@@ -0,0 +1,94 @@
+import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@3sixty/api-models";
+import { type IAuditableItemGraphChangesetGetRequest, type IAuditableItemGraphChangesetGetResponse, type IAuditableItemGraphChangesetListRequest, type IAuditableItemGraphChangesetListResponse, type IAuditableItemGraphCreateRequest, type IAuditableItemGraphGetRequest, type IAuditableItemGraphGetResponse, type IAuditableItemGraphListRequest, type IAuditableItemGraphListResponse, type IAuditableItemGraphRemoveProofRequest, type IAuditableItemGraphUpdatePartialRequest, type IAuditableItemGraphUpdateRequest, type IAuditableItemGraphVersionGetRequest, type IAuditableItemGraphVersionGetResponse, type IAuditableItemGraphVersionListRequest, type IAuditableItemGraphVersionListResponse } from "@3sixty/auditable-item-graph-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsAuditableItemGraph: ITag[];
+/**
+ * The REST routes for auditable item graph.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesAuditableItemGraph(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Create the graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @param baseRouteName The base route name for the API.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphCreateRequest, baseRouteName: string): Promise<ICreatedResponse>;
+/**
+ * Get the graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphGetRequest): Promise<IAuditableItemGraphGetResponse>;
+/**
+ * Get the graph vertex changeset list.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphChangesetList(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphChangesetListRequest): Promise<IAuditableItemGraphChangesetListResponse>;
+/**
+ * Get the graph vertex changeset.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphChangesetGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphChangesetGetRequest): Promise<IAuditableItemGraphChangesetGetResponse>;
+/**
+ * Update the graph vertex (PUT - full replacement of vertex state).
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphUpdateRequest): Promise<INoContentResponse>;
+/**
+ * Partially update the graph vertex (PATCH - optional scalars; list fields use `{ add, remove }`).
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphUpdatePartial(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphUpdatePartialRequest): Promise<INoContentResponse>;
+/**
+ * Query the graph vertices.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphList(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphListRequest): Promise<IAuditableItemGraphListResponse>;
+/**
+ * Get the graph vertex at a specific version.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphVersionGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphVersionGetRequest): Promise<IAuditableItemGraphVersionGetResponse>;
+/**
+ * Remove the notarization proof from all changesets of a graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphRemoveProof(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphRemoveProofRequest): Promise<INoContentResponse>;
+/**
+ * Get all versions of a graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function auditableItemGraphVersionList(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphVersionListRequest): Promise<IAuditableItemGraphVersionListResponse>;

package/dist/types/auditableItemGraphService.d.ts

@@ -0,0 +1,164 @@
+import { type HealthApplicationCallback, type IHealth, type IHealthProviderComponent } from "@3sixty/api-models";
+import { VerifyDepth, type IAuditableItemGraphChangeset, type IAuditableItemGraphChangesetList, type IAuditableItemGraphComponent, type IAuditableItemGraphPartialVertex, type IAuditableItemGraphVertex, type IAuditableItemGraphVertexList, type IAuditableItemGraphVertexVersionList } from "@3sixty/auditable-item-graph-models";
+import { SortDirection, type EntityCondition } from "@3sixty/entity";
+import type { IAuditableItemGraphServiceConstructorOptions } from "./models/IAuditableItemGraphServiceConstructorOptions.js";
+/**
+ * Class for performing auditable item graph operations.
+ */
+export declare class AuditableItemGraphService implements IAuditableItemGraphComponent, IHealthProviderComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * The namespace for the service changeset.
+     */
+    static readonly NAMESPACE_CHANGESET: string;
+    /**
+     * The namespace for the service edge.
+     */
+    static readonly NAMESPACE_EDGE: string;
+    /**
+     * Create a new instance of AuditableItemGraphService.
+     * @param options The dependencies for the auditable item graph connector.
+     */
+    constructor(options?: IAuditableItemGraphServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Runs a set/get/remove cycle against the vertex entity storage using the organisation identity
+     * from the current context.
+     * @param callback The callback to invoke when a deferred health result is ready.
+     * @returns The health status of the service.
+     */
+    healthApplication(callback: HealthApplicationCallback): Promise<IHealth[] | undefined>;
+    /**
+     * Register all AIG metrics with the telemetry component.
+     * @returns A promise that resolves when all metrics have been registered.
+     */
+    start(): Promise<void>;
+    /**
+     * Create a new graph vertex.
+     * @param vertex The vertex to create.
+     * @param vertex.auditMode How the mutations of the vertex are recorded, defaults to audited.
+     * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
+     * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
+     * @param vertex.resources The resources attached to the vertex.
+     * @param vertex.edges The edges connected to the vertex.
+     * @returns The id of the new graph item.
+     */
+    create(vertex: Omit<IAuditableItemGraphVertex, "id">): Promise<string>;
+    /**
+     * Update a graph vertex (PUT - full replacement of vertex state).
+     * Concurrent updates for the same vertex are serialized via `Mutex` on the vertex id.
+     * @param vertex The vertex to update.
+     * @returns A promise that resolves when the vertex has been updated.
+     * @throws GeneralError If a bypass vertex is being switched back to audited.
+     */
+    update(vertex: IAuditableItemGraphVertex): Promise<void>;
+    /**
+     * Partially update a graph vertex (PATCH - explicit list patches; only defined properties applied).
+     * Serialized with `update` via `Mutex` on the same vertex id within this instance.
+     * @param partial The partial vertex update.
+     * @returns A promise that resolves when the partial update has been applied.
+     * @throws GeneralError If a bypass vertex is being switched back to audited.
+     */
+    updatePartial(partial: IAuditableItemGraphPartialVertex): Promise<void>;
+    /**
+     * Get a graph vertex.
+     * @param id The id of the vertex to get.
+     * @param options Additional options for the get operation.
+     * @param options.includeDeleted Whether to include deleted/updated aliases, resource, edges, defaults to false.
+     * @param options.verifySignatureDepth How many signatures to verify, defaults to "none".
+     * @returns The vertex if found.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    get(id: string, options?: {
+        includeDeleted?: boolean;
+        verifySignatureDepth?: VerifyDepth;
+    }): Promise<IAuditableItemGraphVertex>;
+    /**
+     * Get a graph vertex changeset list.
+     * @param id The id of the vertex to get.
+     * @param cursor The optional cursor to get next chunk.
+     * @param limit Limit the number of entities to return.
+     * @param options Additional options for the get operation.
+     * @param options.verifySignatureDepth How many signatures to verify, defaults to "none".
+     * @returns The vertex if found.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    getChangesets(id: string, cursor?: string, limit?: number, options?: {
+        verifySignatureDepth?: VerifyDepth;
+    }): Promise<{
+        changesets: IAuditableItemGraphChangesetList;
+        cursor?: string;
+    }>;
+    /**
+     * Get a graph vertex changeset.
+     * @param id The id of the vertex to get.
+     * @param options Additional options for the get operation.
+     * @param options.verifySignatureDepth How many signatures to verify, defaults to "none".
+     * @returns The vertex if found.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    getChangeset(id: string, options?: {
+        verifySignatureDepth?: VerifyDepth;
+    }): Promise<IAuditableItemGraphChangeset>;
+    /**
+     * Get a graph vertex at a specific version.
+     * @param id The id of the vertex.
+     * @param version The version number to retrieve.
+     * @returns The vertex reconstructed at that version.
+     * @throws NotFoundError if the vertex or version is not found, a bypass vertex never has versions.
+     */
+    getVersion(id: string, version: number): Promise<IAuditableItemGraphVertex>;
+    /**
+     * Get all versions of a graph vertex.
+     * @param id The id of the vertex.
+     * @param options Additional options for the operation.
+     * @param options.after Only return versions created after this ISO 8601 timestamp (exclusive).
+     * @param options.before Only return versions created before this ISO 8601 timestamp (exclusive).
+     * @returns The list of vertex versions, a bypass vertex returns a single baseline entry for its
+     * current state when that falls within the requested range.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    getVersions(id: string, options?: {
+        after?: string;
+        before?: string;
+    }): Promise<IAuditableItemGraphVertexVersionList>;
+    /**
+     * Remove the proof for an item.
+     * @param id The id of the vertex to remove the proof from.
+     * @returns A promise that resolves when the proof has been removed from all changesets.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    removeProof(id: string): Promise<void>;
+    /**
+     * Query the graph for vertices.
+     * @param options The query options.
+     * @param options.id The optional id to look for.
+     * @param options.idMode Look in id, alias or both, defaults to both.
+     * @param options.idExact Find only exact matches, default to false meaning partial matching.
+     * @param options.resourceTypes Include vertices with specific resource types.
+     * @param conditions Conditions to use in the query.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to desc.
+     * @param properties The properties to return, if not provided defaults to id, created, aliases and object.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The maximum number of entities to return, a page can contain fewer so follow
+     * the cursor until it is absent to read them all.
+     * @returns The entities, which can be partial if a limited keys list was provided.
+     */
+    query(options?: {
+        id?: string;
+        idMode?: "id" | "alias" | "both";
+        idExact?: boolean;
+        resourceTypes?: string[];
+    }, conditions?: EntityCondition<IAuditableItemGraphVertex>, orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, limit?: number): Promise<{
+        entries: IAuditableItemGraphVertexList;
+        cursor?: string;
+    }>;
+}

package/dist/types/entities/auditableItemGraphAlias.d.ts

@@ -0,0 +1,34 @@
+import { type IJsonLdNodeObject } from "@3sixty/data-json-ld";
+/**
+ * Class describing the auditable item graph alias.
+ */
+export declare class AuditableItemGraphAlias {
+    /**
+     * The alternative alias for the vertex.
+     */
+    id: string;
+    /**
+     * The format of the alias for the vertex.
+     */
+    aliasFormat?: string;
+    /**
+     * The date/time of when the alias was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the alias was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the alias was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * Object to associate with the alias as JSON-LD.
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * Whether the alias should be unique across the graph, meaning that no other vertex can have the same alias. Defaults to false.
+     */
+    unique?: boolean;
+}

package/dist/types/entities/auditableItemGraphChangeset.d.ts

@@ -0,0 +1,34 @@
+import type { AuditableItemGraphPatch } from "./auditableItemGraphPatch.js";
+/**
+ * Class describing a set of updates to the vertex.
+ */
+export declare class AuditableItemGraphChangeset {
+    /**
+     * The id of the changeset.
+     */
+    id: string;
+    /**
+     * The vertex the changeset belongs to.
+     */
+    vertexId: string;
+    /**
+     * The date/time of when the changeset was created.
+     */
+    dateCreated: string;
+    /**
+     * The identity of the user who made the changeset.
+     */
+    userIdentity?: string;
+    /**
+     * The patches in the changeset.
+     */
+    patches: AuditableItemGraphPatch[];
+    /**
+     * The immutable proof id which contains the signature for this changeset.
+     */
+    proofId?: string;
+    /**
+     * The version number of the vertex after this changeset was applied.
+     */
+    version?: number;
+}

package/dist/types/entities/auditableItemGraphEdge.d.ts

@@ -0,0 +1,34 @@
+import { type IJsonLdNodeObject } from "@3sixty/data-json-ld";
+/**
+ * Class describing the auditable item graph edge.
+ */
+export declare class AuditableItemGraphEdge {
+    /**
+     * The id of the edge.
+     */
+    id: string;
+    /**
+     * The date/time of when the edge was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the edge was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the edge was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * The target id of the edge.
+     */
+    targetId: string;
+    /**
+     * The relationships between the two vertices.
+     */
+    edgeRelationships: string[];
+    /**
+     * Object to associate with the edge as JSON-LD.
+     */
+    annotationObject?: IJsonLdNodeObject;
+}

package/dist/types/entities/auditableItemGraphPatch.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Class describing the auditable item graph patches.
+ */
+export declare class AuditableItemGraphPatch {
+    /**
+     * The operation for the patch.
+     */
+    op: "add" | "remove" | "replace" | "move" | "copy" | "test";
+    /**
+     * The path for the patch.
+     */
+    path: string;
+    /**
+     * The from for the patch.
+     */
+    from?: string;
+    /**
+     * The value for the patch.
+     */
+    value?: unknown;
+}

package/dist/types/entities/auditableItemGraphResource.d.ts

@@ -0,0 +1,26 @@
+import { type IJsonLdNodeObject } from "@3sixty/data-json-ld";
+/**
+ * Class describing the auditable item graph vertex resource.
+ */
+export declare class AuditableItemGraphResource {
+    /**
+     * The id of the resource.
+     */
+    id?: string;
+    /**
+     * The date/time of when the resource was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the resource was last modified.
+     */
+    dateModified?: string;
+    /**
+     * The timestamp of when the resource was deleted, as we never actually remove items.
+     */
+    dateDeleted?: string;
+    /**
+     * Object to associate with the resource as JSON-LD.
+     */
+    resourceObject?: IJsonLdNodeObject;
+}

package/dist/types/entities/auditableItemGraphVertex.d.ts

@@ -0,0 +1,50 @@
+import type { AuditableItemGraphAuditMode } from "@3sixty/auditable-item-graph-models";
+import { type IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphAlias } from "./auditableItemGraphAlias.js";
+import type { AuditableItemGraphEdge } from "./auditableItemGraphEdge.js";
+import type { AuditableItemGraphResource } from "./auditableItemGraphResource.js";
+/**
+ * Class describing the auditable item graph vertex.
+ */
+export declare class AuditableItemGraphVertex {
+    /**
+     * The id of the vertex.
+     */
+    id: string;
+    /**
+     * The identity of the organization which controls the vertex.
+     */
+    organizationIdentity: string;
+    /**
+     * The date/time of when the vertex was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the vertex was last modified.
+     */
+    dateModified?: string;
+    /**
+     * How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
+     */
+    auditMode?: AuditableItemGraphAuditMode;
+    /**
+     * Object to associate with the vertex as JSON-LD.
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * Alternative aliases that can be used to identify the vertex.
+     */
+    aliases?: AuditableItemGraphAlias[];
+    /**
+     * The resources attached to the vertex.
+     */
+    resources?: AuditableItemGraphResource[];
+    /**
+     * Edges connected to the vertex.
+     */
+    edges?: AuditableItemGraphEdge[];
+    /**
+     * The current version of the vertex, incremented on each changeset.
+     */
+    version?: number;
+}

package/dist/types/entities/auditableItemGraphVertexIndex.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Class describing the auditable item graph vertex index.
+ *
+ * The composite index is built on a fixed length hash of the value rather than the value itself,
+ * so its key stays within the size limit some databases place on an index key however long the
+ * value is.
+ */
+export declare class AuditableItemGraphVertexIndex {
+    /**
+     * The id of the index.
+     */
+    id: string;
+    /**
+     * The id of the vertex this index refers to.
+     */
+    vertexId: string;
+    /**
+     * Index type.
+     */
+    type: string;
+    /**
+     * Index value, case folded so lookups do not depend on the column collation.
+     */
+    value: string;
+    /**
+     * The hash of the value, used for exact lookups.
+     */
+    valueHash: string;
+    /**
+     * The date/time of when the vertex was created, copied so the index can order and page its
+     * own matches without reading the vertex.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the vertex was last modified, copied so a query ordered by the
+     * modified date can also be paged from the index.
+     */
+    dateModified?: string;
+}

package/dist/types/entities/auditableItemGraphVertexV0.d.ts

@@ -0,0 +1,53 @@
+import { type IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphAlias } from "./auditableItemGraphAlias.js";
+import type { AuditableItemGraphEdge } from "./auditableItemGraphEdge.js";
+import type { AuditableItemGraphResource } from "./auditableItemGraphResource.js";
+/**
+ * Class describing the auditable item graph vertex, version 0.
+ */
+export declare class AuditableItemGraphVertexV0 {
+    /**
+     * The id of the vertex.
+     */
+    id: string;
+    /**
+     * The identity of the organization which controls the vertex.
+     */
+    organizationIdentity: string;
+    /**
+     * The date/time of when the vertex was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time of when the vertex was last modified.
+     */
+    dateModified?: string;
+    /**
+     * Combined alias index for the vertex used for querying.
+     */
+    aliasIndex?: string;
+    /**
+     * Combined resource type index for the vertex used for querying.
+     */
+    resourceTypeIndex?: string;
+    /**
+     * Object to associate with the vertex as JSON-LD.
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * Alternative aliases that can be used to identify the vertex.
+     */
+    aliases?: AuditableItemGraphAlias[];
+    /**
+     * The resources attached to the vertex.
+     */
+    resources?: AuditableItemGraphResource[];
+    /**
+     * Edges connected to the vertex.
+     */
+    edges?: AuditableItemGraphEdge[];
+    /**
+     * The current version of the vertex, incremented on each changeset.
+     */
+    version?: number;
+}