@twin.org/auditable-item-graph-rest-client 0.0.1-next.9 → 0.0.2-next.1

package/dist/cjs/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var apiCore = require('@twin.org/api-core');
+var apiModels = require('@twin.org/api-models');
 var core = require('@twin.org/core');
 var web = require('@twin.org/web');
 
@@ -23,31 +24,27 @@ class AuditableItemGraphClient extends apiCore.BaseRestClient {
     }
     /**
      * Create a new graph vertex.
-     * @param vertexObject The object for the vertex.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to create.
+     * @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.
      */
-    async create(vertexObject, aliases, resources, edges) {
+    async create(vertex) {
         const response = await this.fetch("/", "POST", {
-            body: {
-                vertexObject,
-                aliases,
-                resources,
-                edges
-            }
+            body: vertex
         });
         return response.headers[web.HeaderTypes.Location];
     }
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.
-     * @returns The vertex if found.
      * @param options Additional options for the get operation.
      * @param options.includeDeleted Whether to include deleted/updated 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.
      */
     async get(id, options) {
@@ -69,42 +66,41 @@ class AuditableItemGraphClient extends apiCore.BaseRestClient {
     }
     /**
      * Update a graph vertex.
-     * @param id The id of the vertex to update.
-     * @param vertexObject The object for the vertex as JSON-LD.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @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 Nothing.
      */
-    async update(id, vertexObject, aliases, resources, edges) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+    async update(vertex) {
+        core.Guards.object(this.CLASS_NAME, "vertex", vertex);
+        core.Guards.stringValue(this.CLASS_NAME, "vertex.id", vertex.id);
+        const { id, ...rest } = vertex;
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
-            body: {
-                vertexObject,
-                aliases,
-                resources,
-                edges
-            }
+            body: rest
         });
     }
     /**
-     * Remove the immutable storage for an item.
+     * Remove the verifiable storage for an item, not supported on client.
      * @param id The id of the vertex to get.
      * @returns Nothing.
      * @throws NotFoundError if the vertex is not found.
-     * @internal
      */
-    async removeImmutable(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id) {
+        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
     /**
      * 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.resourceTypes Include vertices with specific resource types.
+     * @param conditions Conditions to use in the query.
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created, aliases and object.
@@ -112,7 +108,7 @@ class AuditableItemGraphClient extends apiCore.BaseRestClient {
      * @param pageSize The maximum number of entities in a page.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    async query(options, orderBy, orderByDirection, properties, cursor, pageSize) {
+    async query(options, conditions, orderBy, orderByDirection, properties, cursor, pageSize) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -120,11 +116,13 @@ class AuditableItemGraphClient extends apiCore.BaseRestClient {
             query: {
                 id: options?.id,
                 idMode: options?.idMode,
+                resourceTypes: apiModels.HttpParameterHelper.arrayToString(options?.resourceTypes),
+                conditions: apiModels.HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
-                properties: properties?.join(","),
+                properties: apiModels.HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize
+                pageSize: core.Coerce.integer(pageSize)
             }
         });
         return response.body;

package/dist/esm/index.mjs

@@ -1,5 +1,6 @@
 import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, NotSupportedError } from '@twin.org/core';
+import { HttpParameterHelper } from '@twin.org/api-models';
+import { Guards, NotSupportedError, Coerce } from '@twin.org/core';
 import { HeaderTypes, MimeTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
@@ -21,31 +22,27 @@ class AuditableItemGraphClient extends BaseRestClient {
     }
     /**
      * Create a new graph vertex.
-     * @param vertexObject The object for the vertex.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to create.
+     * @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.
      */
-    async create(vertexObject, aliases, resources, edges) {
+    async create(vertex) {
         const response = await this.fetch("/", "POST", {
-            body: {
-                vertexObject,
-                aliases,
-                resources,
-                edges
-            }
+            body: vertex
         });
         return response.headers[HeaderTypes.Location];
     }
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.
-     * @returns The vertex if found.
      * @param options Additional options for the get operation.
      * @param options.includeDeleted Whether to include deleted/updated 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.
      */
     async get(id, options) {
@@ -67,42 +64,41 @@ class AuditableItemGraphClient extends BaseRestClient {
     }
     /**
      * Update a graph vertex.
-     * @param id The id of the vertex to update.
-     * @param vertexObject The object for the vertex as JSON-LD.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @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 Nothing.
      */
-    async update(id, vertexObject, aliases, resources, edges) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+    async update(vertex) {
+        Guards.object(this.CLASS_NAME, "vertex", vertex);
+        Guards.stringValue(this.CLASS_NAME, "vertex.id", vertex.id);
+        const { id, ...rest } = vertex;
         await this.fetch("/:id", "PUT", {
             pathParams: {
                 id
             },
-            body: {
-                vertexObject,
-                aliases,
-                resources,
-                edges
-            }
+            body: rest
         });
     }
     /**
-     * Remove the immutable storage for an item.
+     * Remove the verifiable storage for an item, not supported on client.
      * @param id The id of the vertex to get.
      * @returns Nothing.
      * @throws NotFoundError if the vertex is not found.
-     * @internal
      */
-    async removeImmutable(id) {
-        throw new NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id) {
+        throw new NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
     /**
      * 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.resourceTypes Include vertices with specific resource types.
+     * @param conditions Conditions to use in the query.
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created, aliases and object.
@@ -110,7 +106,7 @@ class AuditableItemGraphClient extends BaseRestClient {
      * @param pageSize The maximum number of entities in a page.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    async query(options, orderBy, orderByDirection, properties, cursor, pageSize) {
+    async query(options, conditions, orderBy, orderByDirection, properties, cursor, pageSize) {
         const response = await this.fetch("/", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -118,11 +114,13 @@ class AuditableItemGraphClient extends BaseRestClient {
             query: {
                 id: options?.id,
                 idMode: options?.idMode,
+                resourceTypes: HttpParameterHelper.arrayToString(options?.resourceTypes),
+                conditions: HttpParameterHelper.objectToString(conditions),
                 orderBy,
                 orderByDirection,
-                properties: properties?.join(","),
+                properties: HttpParameterHelper.arrayToString(properties),
                 cursor,
-                pageSize
+                pageSize: Coerce.integer(pageSize)
             }
         });
         return response.body;

package/dist/types/auditableItemGraphClient.d.ts

@@ -1,8 +1,8 @@
 import { BaseRestClient } from "@twin.org/api-core";
-import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import { type IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IAuditableItemGraphComponent, IAuditableItemGraphVertex, IAuditableItemGraphVertexList, VerifyDepth } from "@twin.org/auditable-item-graph-models";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { SortDirection } from "@twin.org/entity";
+import type { IComparator, SortDirection } from "@twin.org/entity";
 /**
  * Client for performing auditable item graph through to REST endpoints.
  */
@@ -18,32 +18,38 @@ export declare class AuditableItemGraphClient extends BaseRestClient implements
     constructor(config: IBaseRestClientConfig);
     /**
      * Create a new graph vertex.
-     * @param vertexObject The object for the vertex.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to create.
+     * @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(vertexObject?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        aliasFormat?: string;
-        aliasObject?: IJsonLdNodeObject;
-    }[], resources?: {
-        id: string;
-        resourceObject?: IJsonLdNodeObject;
-    }[], edges?: {
-        id: string;
-        edgeRelationship: string;
-        edgeObject?: IJsonLdNodeObject;
-    }[]): Promise<string>;
+    create(vertex: {
+        annotationObject?: IJsonLdNodeObject;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationships: string[];
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }): Promise<string>;
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.
-     * @returns The vertex if found.
      * @param options Additional options for the get operation.
      * @param options.includeDeleted Whether to include deleted/updated 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?: {
@@ -53,30 +59,46 @@ export declare class AuditableItemGraphClient extends BaseRestClient implements
     }): Promise<IAuditableItemGraphVertex>;
     /**
      * Update a graph vertex.
-     * @param id The id of the vertex to update.
-     * @param vertexObject The object for the vertex as JSON-LD.
-     * @param aliases Alternative aliases that can be used to identify the vertex.
-     * @param resources The resources attached to the vertex.
-     * @param edges The edges connected to the vertex.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @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 Nothing.
      */
-    update(id: string, vertexObject?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        aliasFormat?: string;
-        aliasObject?: IJsonLdNodeObject;
-    }[], resources?: {
+    update(vertex: {
         id: string;
-        resourceObject?: IJsonLdNodeObject;
-    }[], edges?: {
-        id: string;
-        edgeRelationship: string;
-        edgeObject?: IJsonLdNodeObject;
-    }[]): Promise<void>;
+        annotationObject?: IJsonLdNodeObject;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationships: string[];
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }): Promise<void>;
+    /**
+     * Remove the verifiable storage for an item, not supported on client.
+     * @param id The id of the vertex to get.
+     * @returns Nothing.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    removeVerifiable(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.resourceTypes Include vertices with specific resource types.
+     * @param conditions Conditions to use in the query.
      * @param orderBy The order for the results, defaults to created.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, created, aliases and object.
@@ -87,5 +109,6 @@ export declare class AuditableItemGraphClient extends BaseRestClient implements
     query(options?: {
         id?: string;
         idMode?: "id" | "alias" | "both";
-    }, orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+        resourceTypes?: string[];
+    }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
 }

package/docs/changelog.md

@@ -1,5 +1,195 @@
 # @twin.org/auditable-item-graph-rest-client - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.2-next.0...auditable-item-graph-rest-client-v0.0.2-next.1) (2025-07-21)
+
+
+### Features
+
+* rest client expose remove verifiable ([a22a743](https://github.com/twinfoundation/auditable-item-graph/commit/a22a743ddc39377630ea0a51ca3f6e97890832c9))
+* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+* use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+
+
+### 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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([0ce06f7](https://github.com/twinfoundation/auditable-item-graph/commit/0ce06f7825aa72d04b7a2ffd8c98cb56290b9d16))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.44](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.43...auditable-item-graph-rest-client-v0.0.1-next.44) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.43 to 0.0.1-next.44
+
+## [0.0.1-next.43](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.42...auditable-item-graph-rest-client-v0.0.1-next.43) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.42 to 0.0.1-next.43
+
+## [0.0.1-next.42](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.41...auditable-item-graph-rest-client-v0.0.1-next.42) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.41 to 0.0.1-next.42
+
+## [0.0.1-next.41](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.40...auditable-item-graph-rest-client-v0.0.1-next.41) (2025-06-03)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.40 to 0.0.1-next.41
+
+## [0.0.1-next.40](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.39...auditable-item-graph-rest-client-v0.0.1-next.40) (2025-05-28)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.39 to 0.0.1-next.40
+
+## [0.0.1-next.39](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.38...auditable-item-graph-rest-client-v0.0.1-next.39) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.38 to 0.0.1-next.39
+
+## [0.0.1-next.38](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.37...auditable-item-graph-rest-client-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.37 to 0.0.1-next.38
+
+## [0.0.1-next.37](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.36...auditable-item-graph-rest-client-v0.0.1-next.37) (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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [0.0.1-next.36](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.35...auditable-item-graph-rest-client-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.34...auditable-item-graph-rest-client-v0.0.1-next.35) (2025-04-10)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-rest-client-v0.0.1-next.33...auditable-item-graph-rest-client-v0.0.1-next.34) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/auditable-item-graph-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## v0.0.1-next.33
 
 - Initial Release

package/docs/reference/classes/AuditableItemGraphClient.md

@@ -12,21 +12,23 @@ Client for performing auditable item graph through to REST endpoints.
 
 ## Constructors
 
-### new AuditableItemGraphClient()
+### Constructor
 
-> **new AuditableItemGraphClient**(`config`): [`AuditableItemGraphClient`](AuditableItemGraphClient.md)
+> **new AuditableItemGraphClient**(`config`): `AuditableItemGraphClient`
 
 Create a new instance of AuditableItemGraphClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
 #### Returns
 
-[`AuditableItemGraphClient`](AuditableItemGraphClient.md)
+`AuditableItemGraphClient`
 
 #### Overrides
 
@@ -48,25 +50,37 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`vertexObject`?, `aliases`?, `resources`?, `edges`?): `Promise`\<`string`\>
+> **create**(`vertex`): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-• **vertexObject?**: `IJsonLdNodeObject`
+##### vertex
+
+The vertex to create.
+
+###### annotationObject?
+
+`IJsonLdNodeObject`
 
-The object for the vertex.
+The annotation object for the vertex as JSON-LD.
 
-• **aliases?**: `object`[]
+###### aliases?
+
+`object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-• **resources?**: `object`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
@@ -84,29 +98,37 @@ The id of the new graph item.
 
 ### get()
 
-> **get**(`id`, `options`?): `Promise`\<`IAuditableItemGraphVertex`\>
+> **get**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertex`\>
 
 Get a graph vertex.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the vertex to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted/updated aliases, resource, edges, defaults to false.
 
-• **options.includeChangesets?**: `boolean`
+###### includeChangesets?
+
+`boolean`
 
 Whether to include the changesets of the vertex, defaults to false.
 
-• **options.verifySignatureDepth?**: `VerifyDepth`
+###### verifySignatureDepth?
+
+`VerifyDepth`
 
 How many signatures to verify, defaults to "none".
 
@@ -128,29 +150,43 @@ NotFoundError if the vertex is not found.
 
 ### update()
 
-> **update**(`id`, `vertexObject`?, `aliases`?, `resources`?, `edges`?): `Promise`\<`void`\>
+> **update**(`vertex`): `Promise`\<`void`\>
 
 Update a graph vertex.
 
 #### Parameters
 
-• **id**: `string`
+##### vertex
+
+The vertex to update.
+
+###### id
+
+`string`
 
 The id of the vertex to update.
 
-• **vertexObject?**: `IJsonLdNodeObject`
+###### annotationObject?
 
-The object for the vertex as JSON-LD.
+`IJsonLdNodeObject`
 
-• **aliases?**: `object`[]
+The annotation object for the vertex as JSON-LD.
+
+###### aliases?
+
+`object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-• **resources?**: `object`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
@@ -166,43 +202,99 @@ Nothing.
 
 ***
 
+### removeVerifiable()
+
+> **removeVerifiable**(`id`): `Promise`\<`void`\>
+
+Remove the verifiable storage for an item, not supported on client.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.removeVerifiable`
+
+***
+
 ### query()
 
-> **query**(`options`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
 Query the graph for vertices.
 
 #### Parameters
 
-• **options?**
+##### options?
 
 The query options.
 
-• **options.id?**: `string`
+###### id?
+
+`string`
 
 The optional id to look for.
 
-• **options.idMode?**: `"both"` \| `"id"` \| `"alias"`
+###### idMode?
+
+`"id"` \| `"alias"` \| `"both"`
 
 Look in id, alias or both, defaults to both.
 
-• **orderBy?**: `"dateCreated"` \| `"dateModified"`
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
+
+##### conditions?
+
+`IComparator`[]
+
+Conditions to use in the query.
+
+##### orderBy?
 
 The order for the results, defaults to created.
 
-• **orderByDirection?**: `SortDirection`
+`"dateCreated"` | `"dateModified"`
+
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to descending.
 
-• **properties?**: keyof `IAuditableItemGraphVertex`[]
+##### properties?
+
+keyof `IAuditableItemGraphVertex`[]
 
 The properties to return, if not provided defaults to id, created, aliases and object.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-rest-client",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Auditable Item Graph contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,7 +16,7 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
-		"@twin.org/auditable-item-graph-models": "0.0.1-next.9",
+		"@twin.org/auditable-item-graph-models": "0.0.2-next.1",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
@@ -29,11 +29,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",