@twin.org/auditable-item-graph-models 0.0.3-next.2 → 0.0.3-next.21

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

@@ -0,0 +1,69 @@
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetricIds: {
+    /**
+     * Number of vertices created.
+     */
+    readonly VerticesCreated: "aig_vertices_created";
+    /**
+     * Number of vertices updated.
+     */
+    readonly VerticesUpdated: "aig_vertices_updated";
+    /**
+     * Number of changesets created.
+     */
+    readonly ChangesetsCreated: "aig_changesets_created";
+    /**
+     * Number of aliases added.
+     */
+    readonly AliasesAdded: "aig_aliases_added";
+    /**
+     * Number of aliases modified.
+     */
+    readonly AliasesModified: "aig_aliases_modified";
+    /**
+     * Number of aliases deleted.
+     */
+    readonly AliasesDeleted: "aig_aliases_deleted";
+    /**
+     * Number of resources added.
+     */
+    readonly ResourcesAdded: "aig_resources_added";
+    /**
+     * Number of resources modified.
+     */
+    readonly ResourcesModified: "aig_resources_modified";
+    /**
+     * Number of resources deleted.
+     */
+    readonly ResourcesDeleted: "aig_resources_deleted";
+    /**
+     * Number of edges added.
+     */
+    readonly EdgesAdded: "aig_edges_added";
+    /**
+     * Number of edges modified.
+     */
+    readonly EdgesModified: "aig_edges_modified";
+    /**
+     * Number of edges deleted.
+     */
+    readonly EdgesDeleted: "aig_edges_deleted";
+    /**
+     * Number of queries executed.
+     */
+    readonly QueriesExecuted: "aig_queries_executed";
+    /**
+     * Number of verifications succeeded.
+     */
+    readonly VerificationsSucceeded: "aig_verifications_succeeded";
+    /**
+     * Number of verifications failed.
+     */
+    readonly VerificationsFailed: "aig_verifications_failed";
+};
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export type AuditableItemGraphMetricIds = (typeof AuditableItemGraphMetricIds)[keyof typeof AuditableItemGraphMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetrics: ITelemetryMetric[];

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

@@ -23,13 +23,29 @@ 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.
      */
     readonly PatchOperation: "AuditableItemGraphPatchOperation";
+    /**
+     * Represents auditable item graph vertex version list.
+     */
+    readonly VertexVersionList: "AuditableItemGraphVertexVersionList";
+    /**
+     * Represents auditable item graph partial vertex.
+     */
+    readonly PartialVertex: "AuditableItemGraphPartialVertex";
+    /**
+     * Represents auditable item graph list patch.
+     */
+    readonly ListPatch: "AuditableItemGraphListPatch";
 };
 /**
  * The types of auditable item graph data.

package/docs/changelog.md

@@ -1,196 +1,358 @@
-# @twin.org/auditable-item-graph-models - Changelog
+# Changelog
 
-## [0.0.3-next.2](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.1...auditable-item-graph-models-v0.0.3-next.2) (2026-01-14)
+## [0.0.3-next.21](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.20...auditable-item-graph-models-v0.0.3-next.21) (2026-06-03)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.19...auditable-item-graph-models-v0.0.3-next.20) (2026-06-03)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.18...auditable-item-graph-models-v0.0.3-next.19) (2026-06-02)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.17...auditable-item-graph-models-v0.0.3-next.18) (2026-05-29)
+
+
+### Features
+
+* update immutable proof usage ([#73](https://github.com/iotaledger/twin-auditable-item-graph/issues/73)) ([a5181d1](https://github.com/iotaledger/twin-auditable-item-graph/commit/a5181d172cbc492c7cc964d22724cc10c46fc52e))
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.16...auditable-item-graph-models-v0.0.3-next.17) (2026-05-27)
+
+
+### Bug Fixes
+
+* incremental edge merge and per-vertex update queue ([#70](https://github.com/iotaledger/twin-auditable-item-graph/issues/70)) ([91eb51d](https://github.com/iotaledger/twin-auditable-item-graph/commit/91eb51d135d2e609eebce90de099670f08eb20ca))
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.15...auditable-item-graph-models-v0.0.3-next.16) (2026-05-22)
+
+
+### Features
+
+* improved versioning ([#66](https://github.com/iotaledger/twin-auditable-item-graph/issues/66)) ([1b497cd](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b497cdc88eec9b6707b097283773e109baae3aa))
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.14...auditable-item-graph-models-v0.0.3-next.15) (2026-05-20)
+
+
+### Features
+
+* add event-driven telemetry metrics ([#63](https://github.com/iotaledger/twin-auditable-item-graph/issues/63)) ([8fe6cdd](https://github.com/iotaledger/twin-auditable-item-graph/commit/8fe6cdd0d56496402b766c151f002f475ddb8c0e))
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.13...auditable-item-graph-models-v0.0.3-next.14) (2026-05-18)
+
+
+### Features
+
+* add versions ([#60](https://github.com/iotaledger/twin-auditable-item-graph/issues/60)) ([5c36f94](https://github.com/iotaledger/twin-auditable-item-graph/commit/5c36f94b1155c01dddbc8d62f3f65d599916c521))
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.12...auditable-item-graph-models-v0.0.3-next.13) (2026-05-12)
+
+
+### Features
+
+* typescript 6 update ([2483c31](https://github.com/iotaledger/twin-auditable-item-graph/commit/2483c3171cff4c5ecedc83d958ab551291a4a487))
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.11...auditable-item-graph-models-v0.0.3-next.12) (2026-03-24)
+
+
+### Features
+
+* add vertex validation ([#54](https://github.com/iotaledger/twin-auditable-item-graph/issues/54)) ([d3ef124](https://github.com/iotaledger/twin-auditable-item-graph/commit/d3ef1241f60956dc296e22d063f188921255d68c))
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.10...auditable-item-graph-models-v0.0.3-next.11) (2026-02-25)
+
+
+### Features
+
+* update schemas ([b00bcac](https://github.com/iotaledger/twin-auditable-item-graph/commit/b00bcac6551fa524e8871e1b573a712ed0f30943))
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.9...auditable-item-graph-models-v0.0.3-next.10) (2026-02-24)
+
+
+### Features
+
+* add context id features ([#30](https://github.com/iotaledger/twin-auditable-item-graph/issues/30)) ([a35d37c](https://github.com/iotaledger/twin-auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
+* add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
+* add ts-to-jsonld-context tool ([08d360e](https://github.com/iotaledger/twin-auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
+* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/iotaledger/twin-auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
+* add validate-locales ([e76e6f6](https://github.com/iotaledger/twin-auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
+* changeset endpoints ([#44](https://github.com/iotaledger/twin-auditable-item-graph/issues/44)) ([7c854de](https://github.com/iotaledger/twin-auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
+* eslint migration to flat config ([1b42a3a](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
+* id optional in edge updates ([6b63fe3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
+* improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+* improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
+* replace nextItem property with Link header ([#39](https://github.com/iotaledger/twin-auditable-item-graph/issues/39)) ([b29a333](https://github.com/iotaledger/twin-auditable-item-graph/commit/b29a333ca78ca2091e54e3e6f4355f84c350007d))
+* update background task service ([e483ddb](https://github.com/iotaledger/twin-auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
+* update contexts ([#35](https://github.com/iotaledger/twin-auditable-item-graph/issues/35)) ([cdf0989](https://github.com/iotaledger/twin-auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
+* update contexts and namespaces ([#33](https://github.com/iotaledger/twin-auditable-item-graph/issues/33)) ([5dadb99](https://github.com/iotaledger/twin-auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
+* update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+* update edges to use targetId instead of id ([6c5d0e3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
+* update framework core ([88ad4e6](https://github.com/iotaledger/twin-auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
+* update targetid json context type ([1e47ca7](https://github.com/iotaledger/twin-auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
+* update ts-to-schema generation ([edce91e](https://github.com/iotaledger/twin-auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
+* use new nameof operators ([3921c4c](https://github.com/iotaledger/twin-auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
+* use shared store mechanism ([#10](https://github.com/iotaledger/twin-auditable-item-graph/issues/10)) ([da035e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+* use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
+
+
+### Bug Fixes
+
+* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+* query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.8...auditable-item-graph-models-v0.0.3-next.9) (2026-02-23)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-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/iotaledger/twin-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/iotaledger/twin-auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
+* changeset endpoints ([#44](https://github.com/iotaledger/twin-auditable-item-graph/issues/44)) ([7c854de](https://github.com/iotaledger/twin-auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
+* update targetid json context type ([1e47ca7](https://github.com/iotaledger/twin-auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-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)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.4...auditable-item-graph-models-v0.0.3-next.5) (2026-01-23)
+
+
+### Features
+
+* replace nextItem property with Link header ([#39](https://github.com/iotaledger/twin-auditable-item-graph/issues/39)) ([b29a333](https://github.com/iotaledger/twin-auditable-item-graph/commit/b29a333ca78ca2091e54e3e6f4355f84c350007d))
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.3...auditable-item-graph-models-v0.0.3-next.4) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.2...auditable-item-graph-models-v0.0.3-next.3) (2026-01-21)
+
+
+### Features
+
+* update contexts ([#35](https://github.com/iotaledger/twin-auditable-item-graph/issues/35)) ([cdf0989](https://github.com/iotaledger/twin-auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.1...auditable-item-graph-models-v0.0.3-next.2) (2026-01-14)
 
 
 ### Features
 
-* update contexts and namespaces ([#33](https://github.com/twinfoundation/auditable-item-graph/issues/33)) ([5dadb99](https://github.com/twinfoundation/auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
+* update contexts and namespaces ([#33](https://github.com/iotaledger/twin-auditable-item-graph/issues/33)) ([5dadb99](https://github.com/iotaledger/twin-auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
 
-## [0.0.3-next.1](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.0...auditable-item-graph-models-v0.0.3-next.1) (2025-11-28)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.0...auditable-item-graph-models-v0.0.3-next.1) (2025-11-28)
 
 
 ### Features
 
-* add context id features ([#30](https://github.com/twinfoundation/auditable-item-graph/issues/30)) ([a35d37c](https://github.com/twinfoundation/auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
-* add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
-* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
-* add validate-locales ([e76e6f6](https://github.com/twinfoundation/auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
-* eslint migration to flat config ([1b42a3a](https://github.com/twinfoundation/auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
-* id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
-* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
-* improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
-* update background task service ([e483ddb](https://github.com/twinfoundation/auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
-* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
-* update edges to use targetId instead of id ([6c5d0e3](https://github.com/twinfoundation/auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
-* update framework core ([88ad4e6](https://github.com/twinfoundation/auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
-* update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
-* use new nameof operators ([3921c4c](https://github.com/twinfoundation/auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
-* use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
-* use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
+* add context id features ([#30](https://github.com/iotaledger/twin-auditable-item-graph/issues/30)) ([a35d37c](https://github.com/iotaledger/twin-auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
+* add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
+* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/iotaledger/twin-auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
+* add validate-locales ([e76e6f6](https://github.com/iotaledger/twin-auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
+* eslint migration to flat config ([1b42a3a](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
+* id optional in edge updates ([6b63fe3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
+* improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+* improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
+* update background task service ([e483ddb](https://github.com/iotaledger/twin-auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
+* update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+* update edges to use targetId instead of id ([6c5d0e3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
+* update framework core ([88ad4e6](https://github.com/iotaledger/twin-auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
+* update ts-to-schema generation ([edce91e](https://github.com/iotaledger/twin-auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
+* use new nameof operators ([3921c4c](https://github.com/iotaledger/twin-auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
+* use shared store mechanism ([#10](https://github.com/iotaledger/twin-auditable-item-graph/issues/10)) ([da035e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+* use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
 
 
 ### Bug Fixes
 
-* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
-* query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+* query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
 
-## [0.0.2-next.8](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.7...auditable-item-graph-models-v0.0.2-next.8) (2025-10-09)
+## [0.0.2-next.8](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.7...auditable-item-graph-models-v0.0.2-next.8) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([e76e6f6](https://github.com/twinfoundation/auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
+* add validate-locales ([e76e6f6](https://github.com/iotaledger/twin-auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
 
-## [0.0.2-next.7](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.6...auditable-item-graph-models-v0.0.2-next.7) (2025-09-29)
+## [0.0.2-next.7](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.6...auditable-item-graph-models-v0.0.2-next.7) (2025-09-29)
 
 
 ### Features
 
-* id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
+* id optional in edge updates ([6b63fe3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
 
-## [0.0.2-next.6](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.5...auditable-item-graph-models-v0.0.2-next.6) (2025-09-29)
+## [0.0.2-next.6](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.5...auditable-item-graph-models-v0.0.2-next.6) (2025-09-29)
 
 
 ### Features
 
-* use new nameof operators ([3921c4c](https://github.com/twinfoundation/auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
+* use new nameof operators ([3921c4c](https://github.com/iotaledger/twin-auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
 
-## [0.0.2-next.5](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.4...auditable-item-graph-models-v0.0.2-next.5) (2025-09-26)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.4...auditable-item-graph-models-v0.0.2-next.5) (2025-09-26)
 
 
 ### Features
 
-* update edges to use targetId instead of id ([6c5d0e3](https://github.com/twinfoundation/auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
+* update edges to use targetId instead of id ([6c5d0e3](https://github.com/iotaledger/twin-auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.3...auditable-item-graph-models-v0.0.2-next.4) (2025-09-24)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.3...auditable-item-graph-models-v0.0.2-next.4) (2025-09-24)
 
 
 ### Features
 
-* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
+* add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/iotaledger/twin-auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
 
-## [0.0.2-next.3](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.2...auditable-item-graph-models-v0.0.2-next.3) (2025-08-29)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.2...auditable-item-graph-models-v0.0.2-next.3) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([1b42a3a](https://github.com/twinfoundation/auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
+* eslint migration to flat config ([1b42a3a](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
 
-## [0.0.2-next.2](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.1...auditable-item-graph-models-v0.0.2-next.2) (2025-08-20)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.1...auditable-item-graph-models-v0.0.2-next.2) (2025-08-20)
 
 
 ### Features
 
-* update framework core ([88ad4e6](https://github.com/twinfoundation/auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
+* update framework core ([88ad4e6](https://github.com/iotaledger/twin-auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
 
-## [0.0.2-next.1](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.0...auditable-item-graph-models-v0.0.2-next.1) (2025-07-21)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.0...auditable-item-graph-models-v0.0.2-next.1) (2025-07-21)
 
 
 ### Features
 
-* add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
-* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
-* improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
-* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
-* update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
-* use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
-* use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
+* add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
+* improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+* improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
+* update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+* update ts-to-schema generation ([edce91e](https://github.com/iotaledger/twin-auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
+* use shared store mechanism ([#10](https://github.com/iotaledger/twin-auditable-item-graph/issues/10)) ([da035e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+* use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
 
 
 ### Bug Fixes
 
-* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
-* query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+* query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
 
 ## 0.0.1 (2025-07-09)
 
 
 ### Features
 
-* release to production ([0ce06f7](https://github.com/twinfoundation/auditable-item-graph/commit/0ce06f7825aa72d04b7a2ffd8c98cb56290b9d16))
+* release to production ([0ce06f7](https://github.com/iotaledger/twin-auditable-item-graph/commit/0ce06f7825aa72d04b7a2ffd8c98cb56290b9d16))
 
-## [0.0.1-next.44](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.43...auditable-item-graph-models-v0.0.1-next.44) (2025-06-20)
+## [0.0.1-next.44](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.43...auditable-item-graph-models-v0.0.1-next.44) (2025-06-20)
 
 
 ### Bug Fixes
 
-* query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+* query params force coercion ([2dd9afe](https://github.com/iotaledger/twin-auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
 
-## [0.0.1-next.43](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.42...auditable-item-graph-models-v0.0.1-next.43) (2025-06-17)
+## [0.0.1-next.43](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.42...auditable-item-graph-models-v0.0.1-next.43) (2025-06-17)
 
 
 ### Features
 
-* improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
+* improve JSON schemas ([bec8dc1](https://github.com/iotaledger/twin-auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
 
-## [0.0.1-next.42](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.41...auditable-item-graph-models-v0.0.1-next.42) (2025-06-12)
+## [0.0.1-next.42](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.41...auditable-item-graph-models-v0.0.1-next.42) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+* update dependencies ([6986689](https://github.com/iotaledger/twin-auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
 
-## [0.0.1-next.41](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.40...auditable-item-graph-models-v0.0.1-next.41) (2025-06-03)
+## [0.0.1-next.41](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.40...auditable-item-graph-models-v0.0.1-next.41) (2025-06-03)
 
 
 ### Features
 
-* update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
+* update ts-to-schema generation ([edce91e](https://github.com/iotaledger/twin-auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
 
-## [0.0.1-next.40](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.39...auditable-item-graph-models-v0.0.1-next.40) (2025-05-28)
+## [0.0.1-next.40](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.39...auditable-item-graph-models-v0.0.1-next.40) (2025-05-28)
 
 
 ### Features
 
-* add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
+* add data types with fully qualified name ([93e1ee7](https://github.com/iotaledger/twin-auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
 
-## [0.0.1-next.39](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.38...auditable-item-graph-models-v0.0.1-next.39) (2025-05-08)
+## [0.0.1-next.39](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.38...auditable-item-graph-models-v0.0.1-next.39) (2025-05-08)
 
 
 ### Features
 
-* use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
+* use standard list json ld types ([8f53836](https://github.com/iotaledger/twin-auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
 
-## [0.0.1-next.38](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.37...auditable-item-graph-models-v0.0.1-next.38) (2025-04-17)
+## [0.0.1-next.38](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.37...auditable-item-graph-models-v0.0.1-next.38) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+* use shared store mechanism ([#10](https://github.com/iotaledger/twin-auditable-item-graph/issues/10)) ([da035e5](https://github.com/iotaledger/twin-auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
 
-## [0.0.1-next.37](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.36...auditable-item-graph-models-v0.0.1-next.37) (2025-04-11)
+## [0.0.1-next.37](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.36...auditable-item-graph-models-v0.0.1-next.37) (2025-04-11)
 
 
 ### Features
 
-* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+* improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
 
 
 ### Bug Fixes
 
-* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
 
-## [0.0.1-next.36](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.35...auditable-item-graph-models-v0.0.1-next.36) (2025-04-11)
+## [0.0.1-next.36](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.35...auditable-item-graph-models-v0.0.1-next.36) (2025-04-11)
 
 
 ### Bug Fixes
 
-* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+* only include alias in index if not deleted ([#6](https://github.com/iotaledger/twin-auditable-item-graph/issues/6)) ([5da3c41](https://github.com/iotaledger/twin-auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
 
-## [0.0.1-next.35](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.34...auditable-item-graph-models-v0.0.1-next.35) (2025-04-10)
+## [0.0.1-next.35](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.34...auditable-item-graph-models-v0.0.1-next.35) (2025-04-10)
 
 
 ### Miscellaneous Chores
 
 * **auditable-item-graph-models:** Synchronize repo versions
 
-## [0.0.1-next.34](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.33...auditable-item-graph-models-v0.0.1-next.34) (2025-03-28)
+## [0.0.1-next.34](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.33...auditable-item-graph-models-v0.0.1-next.34) (2025-03-28)
 
 
 ### Features
 
-* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+* improve comments ([97f311a](https://github.com/iotaledger/twin-auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
 
 ## v0.0.1-next.33
 

package/docs/examples.md

@@ -1 +1,22 @@
-# @twin.org/auditable-item-graph-models - Examples
+# Auditable Item Graph Models Examples
+
+Use these examples to initialise data type handling before interacting with graph APIs and JSON-LD payloads.
+
+## AuditableItemGraphDataTypes
+
+```typescript
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+import {
+  AuditableItemGraphContexts,
+  AuditableItemGraphDataTypes,
+  AuditableItemGraphTypes
+} from '@twin.org/auditable-item-graph-models';
+
+AuditableItemGraphDataTypes.registerTypes();
+
+const vertexType = `${AuditableItemGraphContexts.Namespace}${AuditableItemGraphTypes.Vertex}`;
+const handler = DataTypeHandlerFactory.get(vertexType);
+
+console.log(vertexType); // https://schema.twindev.org/auditable-item-graph/Vertex
+console.log(handler.type); // Vertex
+```

package/docs/reference/classes/AuditableItemGraphDataTypes.md

@@ -14,7 +14,7 @@ Handle all the data types for auditable item graph.
 
 ## Methods
 
-### registerTypes()
+### registerTypes() {#registertypes}
 
 > `static` **registerTypes**(): `void`