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

package/dist/es/schemas/AuditableItemGraphVertex.json

@@ -0,0 +1,100 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/aig/AuditableItemGraphVertex",
+    "title": "AuditableItemGraphVertex",
+    "description": "Interface describing an auditable item graph vertex.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.3sixty.global/aig/"
+                },
+                {
+                    "const": "https://schema.3sixty.global/common/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.3sixty.global/json-ld/JsonLdContextDefinitionElement"
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
+        },
+        "id": {
+            "type": "string",
+            "description": "The id of the element."
+        },
+        "type": {
+            "const": "AuditableItemGraphVertex",
+            "description": "JSON-LD Type."
+        },
+        "organizationIdentity": {
+            "type": "string",
+            "description": "The identity of the organization which controls the vertex."
+        },
+        "auditMode": {
+            "$ref": "https://schema.3sixty.global/aig/AuditableItemGraphAuditMode",
+            "description": "How the mutations of the vertex are recorded, when absent the vertex behaves as audited.\nOnce a vertex is set to bypass it can not be returned to audited."
+        },
+        "annotationObject": {
+            "$ref": "https://schema.3sixty.global/json-ld/JsonLdNodeObject",
+            "description": "The JSON-LD annotation object for the vertex."
+        },
+        "aliases": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.3sixty.global/aig/AuditableItemGraphAlias"
+            },
+            "description": "Alternative aliases that can be used to identify the vertex."
+        },
+        "resources": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.3sixty.global/aig/AuditableItemGraphResource"
+            },
+            "description": "The resources attached to the vertex."
+        },
+        "edges": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.3sixty.global/aig/AuditableItemGraphEdge"
+            },
+            "description": "Edges connected to the vertex."
+        },
+        "verified": {
+            "type": "boolean",
+            "description": "Is the vertex verified, will only be populated when verification is requested.\nAlways undefined when the vertex is in bypass mode."
+        },
+        "version": {
+            "type": "number",
+            "description": "The version of the vertex, populated only when getting a specific version.\nAlways undefined when the vertex is in bypass mode.\nMaps to https://schema.org/version."
+        }
+    },
+    "required": [
+        "@context",
+        "id",
+        "type"
+    ],
+    "allOf": [
+        {
+            "description": "Interface describing the base properties for auditable elements.",
+            "type": "object",
+            "properties": {
+                "dateCreated": {
+                    "type": "string",
+                    "description": "The date/time of when the element was created."
+                },
+                "dateModified": {
+                    "type": "string",
+                    "description": "The date/time of when the element was modified."
+                },
+                "dateDeleted": {
+                    "type": "string",
+                    "description": "The date/time of when the element was deleted, as we never actually remove items."
+                }
+            },
+            "$comment": "Inlined utility base type AuditableItemGraphAuditedElement so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/AuditableItemGraphVertexList.json

@@ -0,0 +1,52 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/aig/AuditableItemGraphVertexList",
+    "title": "AuditableItemGraphVertexList",
+    "description": "Interface describing an auditable item graph vertex list.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.org"
+                },
+                {
+                    "const": "https://schema.3sixty.global/aig/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.3sixty.global/json-ld/JsonLdContextDefinitionElement"
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "ItemList"
+                },
+                {
+                    "const": "AuditableItemGraphVertexList"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
+            "description": "JSON-LD Type."
+        },
+        "itemListElement": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.3sixty.global/aig/AuditableItemGraphVertex"
+            },
+            "description": "The list of vertices."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "itemListElement"
+    ]
+}

package/dist/es/schemas/AuditableItemGraphVertexVersionList.json

@@ -0,0 +1,64 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.3sixty.global/aig/AuditableItemGraphVertexVersionList",
+    "title": "AuditableItemGraphVertexVersionList",
+    "description": "Interface describing a list of auditable item graph vertex version numbers.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "https://schema.org"
+                },
+                {
+                    "const": "https://schema.3sixty.global/aig/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.3sixty.global/json-ld/JsonLdContextDefinitionElement"
+            },
+            "minItems": 2,
+            "description": "JSON-LD Context."
+        },
+        "type": {
+            "type": "array",
+            "prefixItems": [
+                {
+                    "const": "ItemList"
+                },
+                {
+                    "const": "AuditableItemGraphVertexVersionList"
+                }
+            ],
+            "items": false,
+            "minItems": 2,
+            "maxItems": 2,
+            "description": "JSON-LD Type."
+        },
+        "itemListElement": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "version": {
+                        "type": "number"
+                    },
+                    "dateCreated": {
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "version",
+                    "dateCreated"
+                ]
+            },
+            "description": "The list of versions."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "itemListElement"
+    ]
+}

package/dist/types/compiled/validators.d.ts

@@ -0,0 +1,53 @@
+import type { ICompiledValidator } from "@3sixty/data-core";
+/**
+ * Compiled validator for the AuditableItemGraphAuditMode schema.
+ */
+export declare const CompiledAuditableItemGraphAuditMode: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphAlias schema.
+ */
+export declare const CompiledAuditableItemGraphAlias: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphAuditedElement schema.
+ */
+export declare const CompiledAuditableItemGraphAuditedElement: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphChangeset schema.
+ */
+export declare const CompiledAuditableItemGraphChangeset: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphChangesetList schema.
+ */
+export declare const CompiledAuditableItemGraphChangesetList: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphEdge schema.
+ */
+export declare const CompiledAuditableItemGraphEdge: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphListPatch schema.
+ */
+export declare const CompiledAuditableItemGraphListPatch: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphPartialVertex schema.
+ */
+export declare const CompiledAuditableItemGraphPartialVertex: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphPatchOperation schema.
+ */
+export declare const CompiledAuditableItemGraphPatchOperation: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphResource schema.
+ */
+export declare const CompiledAuditableItemGraphResource: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphVertex schema.
+ */
+export declare const CompiledAuditableItemGraphVertex: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphVertexList schema.
+ */
+export declare const CompiledAuditableItemGraphVertexList: ICompiledValidator;
+/**
+ * Compiled validator for the AuditableItemGraphVertexVersionList schema.
+ */
+export declare const CompiledAuditableItemGraphVertexVersionList: ICompiledValidator;

package/dist/types/dataTypes/auditableItemGraphDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for auditable item graph.
+ */
+export declare class AuditableItemGraphDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,40 @@
+export * from "./compiled/validators.js";
+export * from "./dataTypes/auditableItemGraphDataTypes.js";
+export * from "./models/api/IAuditableItemGraphChangesetGetRequest.js";
+export * from "./models/api/IAuditableItemGraphChangesetGetResponse.js";
+export * from "./models/api/IAuditableItemGraphChangesetListRequest.js";
+export * from "./models/api/IAuditableItemGraphChangesetListResponse.js";
+export * from "./models/api/IAuditableItemGraphCreateRequest.js";
+export * from "./models/api/IAuditableItemGraphGetRequest.js";
+export * from "./models/api/IAuditableItemGraphGetResponse.js";
+export * from "./models/api/IAuditableItemGraphListRequest.js";
+export * from "./models/api/IAuditableItemGraphListResponse.js";
+export * from "./models/api/IAuditableItemGraphRemoveProofRequest.js";
+export * from "./models/api/IAuditableItemGraphUpdateRequest.js";
+export * from "./models/api/IAuditableItemGraphUpdatePartialRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetResponse.js";
+export * from "./models/api/IAuditableItemGraphVersionListRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionListResponse.js";
+export * from "./models/auditableItemGraphAuditMode.js";
+export * from "./models/auditableItemGraphContexts.js";
+export * from "./models/auditableItemGraphMetricIds.js";
+export * from "./models/auditableItemGraphMetrics.js";
+export * from "./models/auditableItemGraphTopics.js";
+export * from "./models/auditableItemGraphTypes.js";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js";
+export * from "./models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js";
+export * from "./models/IAuditableItemGraphAlias.js";
+export * from "./models/IAuditableItemGraphAuditedElement.js";
+export * from "./models/IAuditableItemGraphChangeset.js";
+export * from "./models/IAuditableItemGraphChangesetList.js";
+export * from "./models/IAuditableItemGraphComponent.js";
+export * from "./models/IAuditableItemGraphEdge.js";
+export * from "./models/IAuditableItemGraphPatchOperation.js";
+export * from "./models/IAuditableItemGraphListPatch.js";
+export * from "./models/IAuditableItemGraphPartialVertex.js";
+export * from "./models/IAuditableItemGraphResource.js";
+export * from "./models/IAuditableItemGraphVertex.js";
+export * from "./models/IAuditableItemGraphVertexList.js";
+export * from "./models/IAuditableItemGraphVertexVersionList.js";
+export * from "./models/verifyDepth.js";

package/dist/types/models/IAuditableItemGraphAlias.d.ts

@@ -0,0 +1,36 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
+/**
+ * Interface describing an alias for a vertex.
+ */
+export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Alias;
+    /**
+     * The JSON-LD annotation object for the alias.
+     * @json-ld namespace:twin-common
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * The format of the id in the alias.
+     * @json-ld type:sch:Text
+     */
+    aliasFormat?: string;
+    /**
+     * Whether the alias should be unique across the graph, meaning that no other vertex can have the same alias. Defaults to false.
+     * @json-ld type:sch:Boolean
+     */
+    unique?: boolean;
+}

package/dist/types/models/IAuditableItemGraphAuditedElement.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Interface describing the base properties for auditable elements.
+ */
+export interface IAuditableItemGraphAuditedElement {
+    /**
+     * The id of the element.
+     */
+    id?: string;
+    /**
+     * The date/time of when the element was created.
+     * @json-ld namespace:sch
+     */
+    dateCreated?: string;
+    /**
+     * The date/time of when the element was modified.
+     * @json-ld namespace:sch
+     */
+    dateModified?: string;
+    /**
+     * The date/time of when the element was deleted, as we never actually remove items.
+     * @json-ld namespace:sch
+     */
+    dateDeleted?: string;
+}

package/dist/types/models/IAuditableItemGraphChangeset.d.ts

@@ -0,0 +1,57 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { IImmutableProofVerification } from "@3sixty/immutable-proof-models";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation.js";
+/**
+ * Interface describing a set of changes to the vertex.
+ */
+export interface IAuditableItemGraphChangeset {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: [
+        typeof AuditableItemGraphContexts.Context,
+        typeof AuditableItemGraphContexts.ContextCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Changeset;
+    /**
+     * The id of the changeset.
+     */
+    id: string;
+    /**
+     * The date/time of when the changeset was created.
+     * @json-ld namespace:sch
+     */
+    dateCreated: string;
+    /**
+     * The user identity that created the changes.
+     * @json-ld namespace:twin-common
+     */
+    userIdentity?: string;
+    /**
+     * The patches in the changeset.
+     * @json-ld container:set
+     */
+    patches: IAuditableItemGraphPatchOperation[];
+    /**
+     * The immutable proof id which contains the signature for this changeset.
+     * @json-ld type:sch:identifier
+     */
+    proofId?: string;
+    /**
+     * The verification for the changeset.
+     * @json-ld id
+     */
+    verification?: IImmutableProofVerification;
+    /**
+     * The version number of the vertex after this changeset was applied.
+     * Maps to https://schema.org/version.
+     * @json-ld namespace:sch
+     */
+    version?: number;
+}

package/dist/types/models/IAuditableItemGraphChangesetList.d.ts

@@ -0,0 +1,27 @@
+import type { IJsonLdContextDefinitionElement } from "@3sixty/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@3sixty/standards-schema-org";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
+/**
+ * Interface describing an auditable item graph changeset list.
+ */
+export interface IAuditableItemGraphChangesetList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.ChangesetList];
+    /**
+     * The list of changesets.
+     * @json-ld namespace:sch
+     */
+    [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphChangeset[];
+}

package/dist/types/models/IAuditableItemGraphComponent.d.ts

@@ -0,0 +1,143 @@
+import type { IComponent } from "@3sixty/core";
+import type { EntityCondition, SortDirection } from "@3sixty/entity";
+import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
+import type { IAuditableItemGraphChangesetList } from "./IAuditableItemGraphChangesetList.js";
+import type { IAuditableItemGraphPartialVertex } from "./IAuditableItemGraphPartialVertex.js";
+import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
+import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList.js";
+import type { IAuditableItemGraphVertexVersionList } from "./IAuditableItemGraphVertexVersionList.js";
+import type { VerifyDepth } from "./verifyDepth.js";
+/**
+ * Interface describing an auditable item graph contract.
+ */
+export interface IAuditableItemGraphComponent extends IComponent {
+    /**
+     * 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.
+     * Multi-replica deployments are not coordinated.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @param vertex.auditMode How the mutations of the vertex are recorded, when absent the current mode is kept.
+     * @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 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); only properties that are not undefined are applied.
+     * Sub-lists use explicit `{ add, remove }` patch objects. Serialized with `update()` via `Mutex`
+     * on the same vertex id.
+     * @param partial The partial vertex update (must include `id`).
+     * @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 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 changeset if found, always empty for a bypass vertex.
+     * @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 changeset if found.
+     * @throws NotFoundError if the vertex or changeset is not found, a bypass vertex never has changesets.
+     */
+    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 dateCreated.
+     * @param orderByDirection The direction for the order, defaults to descending.
+     * @param properties The properties to return, if not provided defaults to id, dateCreated, 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/models/IAuditableItemGraphEdge.d.ts

@@ -0,0 +1,36 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@3sixty/data-json-ld";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
+/**
+ * Interface describing an edge between two vertices in an auditable item graph.
+ */
+export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedElement {
+    /**
+     * JSON-LD Context.
+     */
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    /**
+     * The id of the element.
+     */
+    id?: string;
+    /**
+     * The target vertex id the edge connects to.
+     * @json-ld type:@id
+     */
+    targetId: string;
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof AuditableItemGraphTypes.Edge;
+    /**
+     * The JSON-LD annotation object for the edge.
+     * @json-ld namespace:twin-common
+     */
+    annotationObject?: IJsonLdNodeObject;
+    /**
+     * The relationships between the two vertices.
+     * @json-ld container:set
+     */
+    edgeRelationships: string[];
+}

package/dist/types/models/IAuditableItemGraphListPatch.d.ts

@@ -0,0 +1,18 @@
+import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
+import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
+import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
+/**
+ * PATCH operations for a sub-list on a vertex.
+ */
+export interface IAuditableItemGraphListPatch<TItem = IAuditableItemGraphEdge | IAuditableItemGraphAlias | IAuditableItemGraphResource> {
+    /**
+     * Items to add or update in the active set.
+     * @json-ld container:set
+     */
+    add?: TItem[];
+    /**
+     * Identifiers of items to remove from the active set (soft-delete).
+     * @json-ld container:set
+     */
+    remove?: string[];
+}