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

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexUpdated.md

@@ -0,0 +1,19 @@
+# Interface: IAuditableItemGraphEventBusVertexUpdated
+
+Event bus payload for vertex updated.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the vertex updated.
+
+***
+
+### patches
+
+> **patches**: `IPatchOperation`[]
+
+The patches in the changeset.

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -38,13 +38,13 @@ The query parameters.
 
 #### includeDeleted?
 
-> `optional` **includeDeleted**: `boolean`
+> `optional` **includeDeleted**: `string` \| `boolean`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
 #### includeChangesets?
 
-> `optional` **includeChangesets**: `boolean`
+> `optional` **includeChangesets**: `string` \| `boolean`
 
 Whether to include the changesets of the vertex, defaults to false.
 

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -30,10 +30,22 @@ The id or alias to try and find.
 
 #### idMode?
 
-> `optional` **idMode**: `"both"` \| `"id"` \| `"alias"`
+> `optional` **idMode**: `"id"` \| `"alias"` \| `"both"`
 
 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`
+
+The conditions to filter the streams, JSON stringified IComparator[].
+
 #### orderBy?
 
 > `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
@@ -50,7 +62,7 @@ The direction for the order, defaults to desc.
 
 > `optional` **properties**: `string`
 
-The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,vertexObject".
+The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
 
 #### cursor?
 
@@ -60,6 +72,6 @@ The optional cursor to get next chunk.
 
 #### pageSize?
 
-> `optional` **pageSize**: `number`
+> `optional` **pageSize**: `string` \| `number`
 
 The maximum number of entities in a page.

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -6,7 +6,7 @@ The patch operation for JSON diffs.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -22,7 +22,7 @@ JSON-LD Type.
 
 ### patchOperation
 
-> **patchOperation**: `"replace"` \| `"add"` \| `"remove"` \| `"copy"` \| `"move"` \| `"test"`
+> **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
 The operation that was performed on the item.
 

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -8,9 +8,9 @@ Interface describing an auditable item graph vertex resource.
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 
@@ -20,9 +20,9 @@ The id of the element.
 
 ***
 
-### dateCreated
+### dateCreated?
 
-> **dateCreated**: `string`
+> `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
 
@@ -58,7 +58,7 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -18,15 +18,15 @@ The id of the vertex to update.
 
 ***
 
-### body?
+### body
 
-> `optional` **body**: `object`
+> **body**: `object`
 
 The data to be used in the vertex.
 
-#### vertexObject?
+#### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The object to be used in the vertex as JSON-LD.
 

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -8,21 +8,9 @@ Interface describing an auditable item graph vertex.
 
 ## Properties
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-`Omit.id`
-
-***
-
-### dateCreated
+### dateCreated?
 
-> **dateCreated**: `string`
+> `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
 
@@ -58,12 +46,24 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+`Omit.id`
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphVertex"`
@@ -80,11 +80,11 @@ The identity of the node which controls the vertex.
 
 ***
 
-### vertexObject?
+### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the vertex.
+The JSON-LD annotation object for the vertex.
 
 ***
 

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -6,7 +6,7 @@ Interface describing an auditable item graph vertex list.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -14,22 +14,22 @@ JSON-LD Context.
 
 ### type
 
-> **type**: `"AuditableItemGraphVertexList"`
+> **type**: \[`"ItemList"`, `"AuditableItemGraphVertexList"`\]
 
 JSON-LD Type.
 
 ***
 
-### vertices
+### itemListElement
 
-> **vertices**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+> **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The list of vertices.
 
 ***
 
-### cursor?
+### nextItem?
 
-> `optional` **cursor**: `string`
+> `optional` **nextItem**: `string`
 
 The cursor to get the next chunk of vertices.

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

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphContexts
+
+> **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

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphTopics
+
+> **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/docs/reference/variables/AuditableItemGraphContexts.md

@@ -0,0 +1,19 @@
+# Variable: AuditableItemGraphContexts
+
+> `const` **AuditableItemGraphContexts**: `object`
+
+The contexts of auditable item graph data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
+
+The context root for the auditable item graph types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/AuditableItemGraphTopics.md

@@ -0,0 +1,19 @@
+# Variable: AuditableItemGraphTopics
+
+> `const` **AuditableItemGraphTopics**: `object`
+
+The topics for auditable item graph event bus notifications.
+
+## Type declaration
+
+### VertexCreated
+
+> `readonly` **VertexCreated**: `"auditable-item-graph:vertex-created"` = `"auditable-item-graph:vertex-created"`
+
+A vertex was created.
+
+### VertexUpdated
+
+> `readonly` **VertexUpdated**: `"auditable-item-graph:vertex-updated"` = `"auditable-item-graph:vertex-updated"`
+
+A vertex was updated.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -6,18 +6,18 @@ The types of auditable item graph data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
-
-The context root for the auditable item graph types.
-
 ### Vertex
 
 > `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`
 
 Represents auditable item graph vertex.
 
+### VertexList
+
+> `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
+
+Represents auditable item graph vertex list.
+
 ### Alias
 
 > `readonly` **Alias**: `"AuditableItemGraphAlias"` = `"AuditableItemGraphAlias"`
@@ -47,27 +47,3 @@ Represents auditable item graph  changeset.
 > `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
-
-### Credential
-
-> `readonly` **Credential**: `"AuditableItemGraphPatchCredential"` = `"AuditableItemGraphPatchCredential"`
-
-Represents the immutable credential payload.
-
-### Verification
-
-> `readonly` **Verification**: `"AuditableItemGraphVerification"` = `"AuditableItemGraphVerification"`
-
-Represents auditable item stream verification.
-
-### VerificationState
-
-> `readonly` **VerificationState**: `"AuditableItemGraphVerificationState"` = `"AuditableItemGraphVerificationState"`
-
-Represents auditable item stream verification state.
-
-### VertexList
-
-> `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
-
-Represents auditable item stream vertex list.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",
@@ -14,23 +14,25 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/data-core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/web": "next"
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/data-core": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/immutable-proof-models": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-schema-org": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"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",

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

@@ -1,34 +0,0 @@
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-/**
- * The data stored immutably for the graph in a verifiable credential.
- */
-export interface IAuditableItemGraphCredential {
-    /**
-     * JSON-LD Context.
-     */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
-    /**
-     * JSON-LD Type.
-     */
-    type: typeof AuditableItemGraphTypes.Credential;
-    /**
-     * The date/time of when the changeset was created.
-     */
-    dateCreated: string;
-    /**
-     * The user identity that created the changes.
-     */
-    userIdentity: string;
-    /**
-     * The signature for the changeset.
-     */
-    signature: string;
-    /**
-     * The signature for the changeset.
-     */
-    hash: string;
-    /**
-     * The integrity data for this changeset, encrypted.
-     */
-    integrity?: string;
-}

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

@@ -1,29 +0,0 @@
-import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
-import type { AuditableItemGraphVerificationState } from "./auditableItemGraphVerificationState";
-/**
- * Interface describing an auditable item graph verification.
- */
-export interface IAuditableItemGraphVerification {
-    /**
-     * JSON-LD Context.
-     */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
-    /**
-     * JSON-LD Type.
-     */
-    type: typeof AuditableItemGraphTypes.Verification;
-    /**
-     * The date/time of the verification.
-     */
-    dateCreated: string;
-    /**
-     * The state of the verification.
-     */
-    state: AuditableItemGraphVerificationState;
-    /**
-     * The state properties.
-     */
-    stateProperties?: {
-        [id: string]: unknown;
-    };
-}

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

@@ -1,37 +0,0 @@
-/**
- * The state of the verification.
- */
-export declare const AuditableItemGraphVerificationState: {
-    /**
-     * OK.
-     */
-    readonly Ok: "ok";
-    /**
-     * The stored hash does not matched the calculated one.
-     */
-    readonly HashMismatch: "hashMismatch";
-    /**
-     * The signature verification failed.
-     */
-    readonly SignatureNotVerified: "signatureNotVerified";
-    /**
-     * The credential in the immutable storage was revoked.
-     */
-    readonly CredentialRevoked: "credentialRevoked";
-    /**
-     * Immutable hash mismatch.
-     */
-    readonly ImmutableHashMismatch: "immutableHashMismatch";
-    /**
-     * Immutable signature mismatch.
-     */
-    readonly ImmutableSignatureMismatch: "immutableSignatureMismatch";
-    /**
-     * Integrity data mismatch.
-     */
-    readonly IntegrityDataMismatch: "integrityDataMismatch";
-};
-/**
- * The state of the verification.
- */
-export type AuditableItemGraphVerificationState = (typeof AuditableItemGraphVerificationState)[keyof typeof AuditableItemGraphVerificationState];

package/docs/reference/interfaces/IAuditableItemGraphCredential.md

@@ -1,59 +0,0 @@
-# Interface: IAuditableItemGraphCredential
-
-The data stored immutably for the graph in a verifiable credential.
-
-## Properties
-
-### @context
-
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
-
-JSON-LD Context.
-
-***
-
-### type
-
-> **type**: `"AuditableItemGraphPatchCredential"`
-
-JSON-LD Type.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `string`
-
-The date/time of when the changeset was created.
-
-***
-
-### userIdentity
-
-> **userIdentity**: `string`
-
-The user identity that created the changes.
-
-***
-
-### signature
-
-> **signature**: `string`
-
-The signature for the changeset.
-
-***
-
-### hash
-
-> **hash**: `string`
-
-The signature for the changeset.
-
-***
-
-### integrity?
-
-> `optional` **integrity**: `string`
-
-The integrity data for this changeset, encrypted.

package/docs/reference/interfaces/IAuditableItemGraphVerification.md

@@ -1,47 +0,0 @@
-# Interface: IAuditableItemGraphVerification
-
-Interface describing an auditable item graph verification.
-
-## Properties
-
-### @context
-
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
-
-JSON-LD Context.
-
-***
-
-### type
-
-> **type**: `"AuditableItemGraphVerification"`
-
-JSON-LD Type.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `string`
-
-The date/time of the verification.
-
-***
-
-### state
-
-> **state**: [`AuditableItemGraphVerificationState`](../type-aliases/AuditableItemGraphVerificationState.md)
-
-The state of the verification.
-
-***
-
-### stateProperties?
-
-> `optional` **stateProperties**: `object`
-
-The state properties.
-
-#### Index Signature
-
- \[`id`: `string`\]: `unknown`

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

@@ -1,5 +0,0 @@
-# Type Alias: AuditableItemGraphVerificationState
-
-> **AuditableItemGraphVerificationState**: *typeof* [`AuditableItemGraphVerificationState`](../variables/AuditableItemGraphVerificationState.md)\[keyof *typeof* [`AuditableItemGraphVerificationState`](../variables/AuditableItemGraphVerificationState.md)\]
-
-The state of the verification.