@twin.org/auditable-item-graph-models 0.0.3-next.6 → 0.0.3-next.8

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

@@ -0,0 +1,27 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/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:schema
+     */
+    [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphChangeset[];
+}

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

@@ -1,6 +1,8 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IComparator, SortDirection } from "@twin.org/entity";
+import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
+import type { IAuditableItemGraphChangesetList } from "./IAuditableItemGraphChangesetList.js";
 import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
 import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList.js";
 import type { VerifyDepth } from "./verifyDepth.js";
@@ -70,16 +72,41 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @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.includeChangesets Whether to include the changesets of the vertex, 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;
-        includeChangesets?: 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.
+     * @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.
+     */
+    getChangeset(id: string, options?: {
+        verifySignatureDepth?: VerifyDepth;
+    }): Promise<IAuditableItemGraphChangeset>;
     /**
      * Remove the verifiable storage for an item.
      * @param id The id of the vertex to remove the storage from.

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

@@ -16,6 +16,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     id?: string;
     /**
      * The target vertex id the edge connects to.
+     * json-ld type:@id
      */
     targetId: string;
     /**
@@ -24,10 +25,12 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     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/IAuditableItemGraphPatchOperation.d.ts

@@ -8,25 +8,29 @@ export interface IAuditableItemGraphPatchOperation {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
+    "@context"?: typeof AuditableItemGraphContexts.Context | [typeof AuditableItemGraphContexts.Context, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.PatchOperation;
     /**
      * The operation that was performed on the item.
+     * json-ld type:schema:Text
      */
     patchOperation: "add" | "remove" | "replace" | "move" | "copy" | "test";
     /**
      * The path to the object that was changed.
+     * json-ld type:schema:Text
      */
     patchPath: string;
     /**
      * The path the value was copied or moved from.
+     * json-ld type:schema:Text
      */
     patchFrom?: string;
     /**
      * The value to add.
+     * json-ld type:json
      */
     patchValue?: unknown;
 }

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

@@ -16,6 +16,7 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
     type: typeof AuditableItemGraphTypes.Resource;
     /**
      * The JSON-LD object for the resource.
+     * json-ld type:json
      */
     resourceObject?: IJsonLdNodeObject;
 }

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

@@ -3,7 +3,6 @@ import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
 import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias.js";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement.js";
-import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
 import type { IAuditableItemGraphEdge } from "./IAuditableItemGraphEdge.js";
 import type { IAuditableItemGraphResource } from "./IAuditableItemGraphResource.js";
 /**
@@ -28,30 +27,32 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
     type: typeof AuditableItemGraphTypes.Vertex;
     /**
      * The identity of the organization which controls the vertex.
+     * json-ld namespace:twin-common
      */
     organizationIdentity?: string;
     /**
      * The JSON-LD annotation object for the vertex.
+     * json-ld namespace:twin-common
      */
     annotationObject?: IJsonLdNodeObject;
     /**
      * Alternative aliases that can be used to identify the vertex.
+     * json-ld container:set
      */
     aliases?: IAuditableItemGraphAlias[];
     /**
      * The resources attached to the vertex.
+     * json-ld container:set
      */
     resources?: IAuditableItemGraphResource[];
     /**
      * Edges connected to the vertex.
+     * json-ld container:set
      */
     edges?: IAuditableItemGraphEdge[];
-    /**
-     * Changesets for the vertex.
-     */
-    changesets?: IAuditableItemGraphChangeset[];
     /**
      * Is the vertex verified, will only be populated when verification is requested.
+     * json-ld namespace:twin-common
      */
     verified?: boolean;
 }

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

@@ -21,6 +21,7 @@ export interface IAuditableItemGraphVertexList {
     type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexList];
     /**
      * The list of vertices.
+     * json-ld namespace:schema
      */
     [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
 }

package/dist/types/models/api/IAuditableItemGraphChangesetGetRequest.d.ts

@@ -0,0 +1,35 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex to get the changeset from.
+         */
+        id: string;
+        /**
+         * The id of the changeset to get.
+         */
+        changesetId: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphChangesetGetResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphChangeset } from "../IAuditableItemGraphChangeset.js";
+/**
+ * Response to getting an auditable item graph vertex changeset.
+ */
+export interface IAuditableItemGraphChangesetGetResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangeset;
+}

package/dist/types/models/api/IAuditableItemGraphChangesetListRequest.d.ts

@@ -0,0 +1,39 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { VerifyDepth } from "../verifyDepth.js";
+/**
+ * Get an auditable item graph changeset.
+ */
+export interface IAuditableItemGraphChangesetListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the changeset to get.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * The optional cursor to get next chunk.
+         */
+        cursor?: string;
+        /**
+         * Limit the number of entities to return.
+         */
+        limit?: string;
+        /**
+         * How many signatures to verify, none, current or all, defaults to "none".
+         */
+        verifySignatureDepth?: VerifyDepth;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphChangesetListResponse.d.ts

@@ -0,0 +1,18 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphChangesetList } from "../IAuditableItemGraphChangesetList.js";
+/**
+ * Response to getting an auditable item graph changeset list.
+ */
+export interface IAuditableItemGraphChangesetListResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+        [HeaderTypes.Link]?: string | string[];
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphChangesetList;
+}

package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts

@@ -27,10 +27,6 @@ export interface IAuditableItemGraphGetRequest {
          * Whether to include deleted aliases, resource, edges, defaults to false.
          */
         includeDeleted?: string;
-        /**
-         * Whether to include the changesets of the vertex, defaults to false.
-         */
-        includeChangesets?: string;
         /**
          * How many signatures to verify, none, current or all, defaults to "none".
          */

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

@@ -23,9 +23,13 @@ export declare const AuditableItemGraphTypes: {
      */
     readonly Edge: "AuditableItemGraphEdge";
     /**
-     * Represents auditable item graph  changeset.
+     * Represents auditable item graph changeset.
      */
     readonly Changeset: "AuditableItemGraphChangeset";
+    /**
+     * Represents auditable item graph changeset list.
+     */
+    readonly ChangesetList: "AuditableItemGraphChangesetList";
     /**
      * Represents patch operation.
      */

package/docs/changelog.md

@@ -1,5 +1,21 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
+## [0.0.3-next.8](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.7...auditable-item-graph-models-v0.0.3-next.8) (2026-02-11)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.6...auditable-item-graph-models-v0.0.3-next.7) (2026-02-11)
+
+
+### Features
+
+* add ts-to-jsonld-context tool ([08d360e](https://github.com/twinfoundation/auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
+* changeset endpoints ([#44](https://github.com/twinfoundation/auditable-item-graph/issues/44)) ([7c854de](https://github.com/twinfoundation/auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
+* update targetid json context type ([1e47ca7](https://github.com/twinfoundation/auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
+
 ## [0.0.3-next.6](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.5...auditable-item-graph-models-v0.0.3-next.6) (2026-01-26)
 
 

package/docs/reference/index.md

@@ -9,12 +9,17 @@
 - [IAuditableItemGraphAlias](interfaces/IAuditableItemGraphAlias.md)
 - [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
 - [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
+- [IAuditableItemGraphChangesetList](interfaces/IAuditableItemGraphChangesetList.md)
 - [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
 - [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
 - [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
 - [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
+- [IAuditableItemGraphChangesetGetRequest](interfaces/IAuditableItemGraphChangesetGetRequest.md)
+- [IAuditableItemGraphChangesetGetResponse](interfaces/IAuditableItemGraphChangesetGetResponse.md)
+- [IAuditableItemGraphChangesetListRequest](interfaces/IAuditableItemGraphChangesetListRequest.md)
+- [IAuditableItemGraphChangesetListResponse](interfaces/IAuditableItemGraphChangesetListResponse.md)
 - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
 - [IAuditableItemGraphGetRequest](interfaces/IAuditableItemGraphGetRequest.md)
 - [IAuditableItemGraphGetResponse](interfaces/IAuditableItemGraphGetResponse.md)

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -41,6 +41,7 @@ JSON-LD Type.
 > `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the alias.
+json-ld namespace:twin-common
 
 ***
 
@@ -49,6 +50,7 @@ The JSON-LD annotation object for the alias.
 > `optional` **aliasFormat**: `string`
 
 The format of the id in the alias.
+json-ld type:schema:Text
 
 ***
 
@@ -57,6 +59,7 @@ The format of the id in the alias.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -69,6 +72,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -81,6 +85,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:schema
 
 #### Inherited from
 

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -23,6 +23,7 @@ The id of the element.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:schema
 
 ***
 
@@ -31,6 +32,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:schema
 
 ***
 
@@ -39,3 +41,4 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:schema

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -4,9 +4,9 @@ Interface describing a set of changes to the vertex.
 
 ## Properties
 
-### @context
+### @context?
 
-> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -33,6 +33,7 @@ The id of the changeset.
 > **dateCreated**: `string`
 
 The date/time of when the changeset was created.
+json-ld namespace:schema
 
 ***
 
@@ -41,6 +42,7 @@ The date/time of when the changeset was created.
 > `optional` **userIdentity**: `string`
 
 The user identity that created the changes.
+json-ld namespace:twin-common
 
 ***
 
@@ -49,6 +51,7 @@ The user identity that created the changes.
 > **patches**: [`IAuditableItemGraphPatchOperation`](IAuditableItemGraphPatchOperation.md)[]
 
 The patches in the changeset.
+json-ld container:set
 
 ***
 
@@ -57,6 +60,7 @@ The patches in the changeset.
 > `optional` **proofId**: `string`
 
 The immutable proof id which contains the signature for this changeset.
+json-ld type:schema:identifier
 
 ***
 
@@ -65,3 +69,4 @@ The immutable proof id which contains the signature for this changeset.
 > `optional` **verification**: `IImmutableProofVerification`
 
 The verification for the changeset.
+json-ld id

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphChangesetGetRequest
+
+Get an auditable item graph vertex changeset.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to get the changeset from.
+
+#### changesetId
+
+> **changesetId**: `string`
+
+The id of the changeset to get.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### verifySignatureDepth?
+
+> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphChangesetGetResponse
+
+Response to getting an auditable item graph vertex changeset.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphChangesetList.md

@@ -0,0 +1,28 @@
+# Interface: IAuditableItemGraphChangesetList
+
+Interface describing an auditable item graph changeset list.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: \[`"ItemList"`, `"AuditableItemGraphChangesetList"`\]
+
+JSON-LD Type.
+
+***
+
+### itemListElement
+
+> **itemListElement**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
+
+The list of changesets.
+json-ld namespace:schema

package/docs/reference/interfaces/IAuditableItemGraphChangesetListRequest.md

@@ -0,0 +1,55 @@
+# Interface: IAuditableItemGraphChangesetListRequest
+
+Get an auditable item graph changeset.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the changeset to get.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The optional cursor to get next chunk.
+
+#### limit?
+
+> `optional` **limit**: `string`
+
+Limit the number of entities to return.
+
+#### verifySignatureDepth?
+
+> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphChangesetListResponse.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphChangesetListResponse
+
+Response to getting an auditable item graph changeset list.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
+***
+
+### body
+
+> **body**: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md)
+
+The response body.