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

package/dist/cjs/index.cjs

@@ -276,7 +276,6 @@ var properties$4 = {
 };
 var required$4 = [
 	"@context",
-	"id",
 	"targetId",
 	"type",
 	"edgeRelationships"

package/dist/esm/index.mjs

@@ -274,7 +274,6 @@ var properties$4 = {
 };
 var required$4 = [
 	"@context",
-	"id",
 	"targetId",
 	"type",
 	"edgeRelationships"

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

@@ -63,7 +63,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
             resourceObject?: IJsonLdNodeObject;
         }[];
         edges?: {
-            id: string;
+            id?: string;
             targetId: string;
             edgeRelationships: string[];
             annotationObject?: IJsonLdNodeObject;
@@ -103,8 +103,8 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @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 page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
     query(options?: {
@@ -112,5 +112,5 @@ export interface IAuditableItemGraphComponent extends IComponent {
         idMode?: "id" | "alias" | "both";
         idExact?: boolean;
         resourceTypes?: string[];
-    }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+    }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, limit?: number): Promise<IAuditableItemGraphVertexList>;
 }

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

@@ -13,7 +13,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     /**
      * The id of the element.
      */
-    id: string;
+    id?: string;
     /**
      * The target vertex id the edge connects to.
      */

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

@@ -52,8 +52,8 @@ export interface IAuditableItemGraphListRequest {
          */
         cursor?: string;
         /**
-         * The maximum number of entities in a page.
+         * Limit the number of entities to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

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

@@ -40,7 +40,7 @@ export interface IAuditableItemGraphUpdateRequest {
          * The edges connected to the vertex.
          */
         edges?: {
-            id: string;
+            id?: string;
             targetId: string;
             edgeRelationships: string[];
             annotationObject?: IJsonLdNodeObject;

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
+## [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)
+
+
+### Features
+
+* add validate-locales ([e76e6f6](https://github.com/twinfoundation/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)
+
+
+### Features
+
+* id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/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)
 
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -6,6 +6,14 @@ Interface describing an auditable item graph contract.
 
 - `IComponent`
 
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+All methods are optional, so we introduce an index signature to allow
+any additional properties or methods, which removes the TypeScript error where
+the class has no properties in common with the type.
+
 ## Methods
 
 ### create()
@@ -208,7 +216,7 @@ NotFoundError if the vertex is not found.
 
 ### query()
 
-> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
@@ -270,13 +278,13 @@ The properties to return, if not provided defaults to id, dateCreated, aliases a
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -52,9 +52,9 @@ JSON-LD Context.
 
 ***
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -76,8 +76,8 @@ The properties to return as a comma separated list, defaults to "id,dateCreated,
 
 The optional cursor to get next chunk.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.2-next.6",
+	"version": "0.0.2-next.8",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",
@@ -40,5 +40,20 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"auditable-item-graph",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/auditable-item-graph/issues"
+	},
+	"homepage": "https://twindev.org"
 }