@twin.org/auditable-item-graph-models 0.0.1-next.36 → 0.0.1-next.38

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

@@ -94,6 +94,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @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 dateCreated.
      * @param orderByDirection The direction for the order, defaults to descending.
@@ -105,5 +106,6 @@ export interface IAuditableItemGraphComponent extends IComponent {
     query(options?: {
         id?: string;
         idMode?: "id" | "alias" | "both";
+        resourceTypes?: string[];
     }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
 }

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

@@ -23,6 +23,10 @@ export interface IAuditableItemGraphListRequest {
          * Which field to look in with the id, defaults to both.
          */
         idMode?: "id" | "alias" | "both";
+        /**
+         * Include vertices with specific resource types, comma separated.
+         */
+        resourceTypes?: string;
         /**
          * The conditions to filter the streams, JSON stringified IComparator[].
          */

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
+## [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)
+
+
+### 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))
+
+## [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)
+
+
+### Features
+
+* improve comments ([97f311a](https://github.com/twinfoundation/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))
+
 ## [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)
 
 

package/docs/reference/classes/AuditableItemGraphDataTypes.md

@@ -4,13 +4,13 @@ Handle all the data types for auditable item graph.
 
 ## Constructors
 
-### new AuditableItemGraphDataTypes()
+### Constructor
 
-> **new AuditableItemGraphDataTypes**(): [`AuditableItemGraphDataTypes`](AuditableItemGraphDataTypes.md)
+> **new AuditableItemGraphDataTypes**(): `AuditableItemGraphDataTypes`
 
 #### Returns
 
-[`AuditableItemGraphDataTypes`](AuditableItemGraphDataTypes.md)
+`AuditableItemGraphDataTypes`
 
 ## Methods
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,7 +10,7 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
@@ -66,7 +66,7 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update a graph vertex.
 
@@ -128,7 +128,7 @@ Nothing.
 
 ### get()
 
-> **get**(`id`, `options`?): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 Get a graph vertex.
 
@@ -176,7 +176,7 @@ NotFoundError if the vertex is not found.
 
 ### removeVerifiable()
 
-> **removeVerifiable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Remove the verifiable storage for an item.
 
@@ -208,7 +208,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?`, `pageSize?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
@@ -230,6 +230,12 @@ The optional id to look for.
 
 Look in id, alias or both, defaults to both.
 
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
+
 ##### conditions?
 
 `IComparator`[]

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -34,6 +34,12 @@ The id or alias to try and find.
 
 Which field to look in with the id, defaults to both.
 
+#### resourceTypes?
+
+> `optional` **resourceTypes**: `string`
+
+Include vertices with specific resource types, comma separated.
+
 #### conditions?
 
 > `optional` **conditions**: `string`

package/docs/reference/type-aliases/AuditableItemGraphContexts.md

@@ -1,5 +1,5 @@
 # Type Alias: AuditableItemGraphContexts
 
-> **AuditableItemGraphContexts**: *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\[keyof *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\]
+> **AuditableItemGraphContexts** = *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\[keyof *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\]
 
 The contexts of auditable item graph data.

package/docs/reference/type-aliases/AuditableItemGraphTopics.md

@@ -1,5 +1,5 @@
 # Type Alias: AuditableItemGraphTopics
 
-> **AuditableItemGraphTopics**: *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\[keyof *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\]
+> **AuditableItemGraphTopics** = *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\[keyof *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\]
 
 The topics for auditable item graph event bus notifications.

package/docs/reference/type-aliases/AuditableItemGraphTypes.md

@@ -1,5 +1,5 @@
 # Type Alias: AuditableItemGraphTypes
 
-> **AuditableItemGraphTypes**: *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\[keyof *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\]
+> **AuditableItemGraphTypes** = *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\[keyof *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\]
 
 The types of auditable item graph data.

package/docs/reference/type-aliases/VerifyDepth.md

@@ -1,5 +1,5 @@
 # Type Alias: VerifyDepth
 
-> **VerifyDepth**: *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\[keyof *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\]
+> **VerifyDepth** = *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\[keyof *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\]
 
 How deep to verify the signatures.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.36",
+	"version": "0.0.1-next.38",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",