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

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -4,13 +4,13 @@ Interface describing an auditable item graph vertex resource.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 
@@ -20,48 +20,60 @@ The id of the element.
 
 ***
 
-### created
+### dateCreated?
 
-> **created**: `number`
+> `optional` **dateCreated**: `string`
 
-The timestamp of when the element was created.
+The date/time of when the element was created.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`created`](IAuditableItemGraphAuditedElement.md#created)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
 
 ***
 
-### updated?
+### dateModified?
 
-> `optional` **updated**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`updated`](IAuditableItemGraphAuditedElement.md#updated)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
 
 ***
 
-### deleted?
+### dateDeleted?
 
-> `optional` **deleted**: `number`
+> `optional` **dateDeleted**: `string`
 
-The timestamp of when the element was deleted, as we never actually remove items.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`deleted`](IAuditableItemGraphAuditedElement.md#deleted)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
 
 ***
 
-### metadata?
+### @context
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The metadata to associate with the element as JSON-LD.
+JSON-LD Context.
 
-#### Inherited from
+***
+
+### type
+
+> **type**: `"AuditableItemGraphResource"`
+
+JSON-LD Type.
+
+***
+
+### resourceObject?
+
+> `optional` **resourceObject**: `IJsonLdNodeObject`
 
-`IAuditableItemGraphMetadataElement.metadata`
+The JSON-LD object for the resource.

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

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

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -4,55 +4,71 @@ Interface describing an auditable item graph vertex.
 
 ## Extends
 
-- `Omit`\<[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md), `"deleted"`\>.`IAuditableItemGraphMetadataElement`
+- `Omit`\<[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md), `"deleted"`\>
 
 ## Properties
 
-### id
+### dateCreated?
 
-> **id**: `string`
+> `optional` **dateCreated**: `string`
 
-The id of the element.
+The date/time of when the element was created.
 
 #### Inherited from
 
-`Omit.id`
+`Omit.dateCreated`
 
 ***
 
-### created
+### dateModified?
 
-> **created**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was created.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-`Omit.created`
+`Omit.dateModified`
 
 ***
 
-### updated?
+### dateDeleted?
 
-> `optional` **updated**: `number`
+> `optional` **dateDeleted**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-`Omit.updated`
+`Omit.dateDeleted`
 
 ***
 
-### metadata?
+### @context
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The metadata to associate with the element as JSON-LD.
+JSON-LD Context.
 
-#### Inherited from
+***
 
-`IAuditableItemGraphMetadataElement.metadata`
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+`Omit.id`
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphVertex"`
+
+JSON-LD Type.
 
 ***
 
@@ -64,6 +80,14 @@ The identity of the node which controls the vertex.
 
 ***
 
+### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the vertex.
+
+***
+
 ### aliases?
 
 > `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
@@ -93,3 +117,11 @@ Edges connected to the vertex.
 > `optional` **changesets**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
 
 Changesets for the vertex.
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+Is the vertex verified, will only be populated when verification is requested.

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -0,0 +1,35 @@
+# Interface: IAuditableItemGraphVertexList
+
+Interface describing an auditable item graph vertex list.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+JSON-LD Type.
+
+***
+
+### itemListElement
+
+> **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+
+The list of vertices.
+
+***
+
+### nextItem?
+
+> `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,62 +6,38 @@ 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**: `"https://schema.twindev.org/aig/AuditableItemGraphVertex"` = `"https://schema.twindev.org/aig/AuditableItemGraphVertex"`
+> `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`
 
 Represents auditable item graph vertex.
 
 ### Alias
 
-> `readonly` **Alias**: `"https://schema.twindev.org/aig/AuditableItemGraphAlias"` = `"https://schema.twindev.org/aig/AuditableItemGraphAlias"`
+> `readonly` **Alias**: `"AuditableItemGraphAlias"` = `"AuditableItemGraphAlias"`
 
 Represents auditable item graph alias.
 
 ### Resource
 
-> `readonly` **Resource**: `"https://schema.twindev.org/aig/AuditableItemGraphResource"` = `"https://schema.twindev.org/aig/AuditableItemGraphResource"`
+> `readonly` **Resource**: `"AuditableItemGraphResource"` = `"AuditableItemGraphResource"`
 
 Represents auditable item graph resource.
 
 ### Edge
 
-> `readonly` **Edge**: `"https://schema.twindev.org/aig/AuditableItemGraphEdge"` = `"https://schema.twindev.org/aig/AuditableItemGraphEdge"`
+> `readonly` **Edge**: `"AuditableItemGraphEdge"` = `"AuditableItemGraphEdge"`
 
 Represents auditable item graph edge.
 
 ### Changeset
 
-> `readonly` **Changeset**: `"https://schema.twindev.org/aig/AuditableItemGraphChangeset"` = `"https://schema.twindev.org/aig/AuditableItemGraphChangeset"`
+> `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
 
 Represents auditable item graph  changeset.
 
 ### PatchOperation
 
-> `readonly` **PatchOperation**: `"https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"` = `"https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"`
+> `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
-
-### Credential
-
-> `readonly` **Credential**: `"https://schema.twindev.org/aig/AuditableItemGraphPatchCredential"` = `"https://schema.twindev.org/aig/AuditableItemGraphPatchCredential"`
-
-Represents the immutable credential payload.
-
-### Verification
-
-> `readonly` **Verification**: `"https://schema.twindev.org/aig/AuditableItemGraphVerification"` = `"https://schema.twindev.org/aig/AuditableItemGraphVerification"`
-
-Represents auditable item stream verification.
-
-### VerificationState
-
-> `readonly` **VerificationState**: `"https://schema.twindev.org/aig/AuditableItemGraphVerificationState"` = `"https://schema.twindev.org/aig/AuditableItemGraphVerificationState"`
-
-Represents auditable item stream verification state.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.4",
+	"version": "0.0.1-next.40",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,9 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
+		"@twin.org/immutable-proof-models": "next",
 		"@twin.org/nameof": "next",
+		"@twin.org/standards-schema-org": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -26,11 +28,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",

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

@@ -1,25 +0,0 @@
-/**
- * The data stored immutably for the graph in a verifiable credential.
- */
-export interface IAuditableItemGraphCredential {
-    /**
-     * The timestamp of when the changeset was created.
-     */
-    created: number;
-    /**
-     * 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/IAuditableItemGraphMetadataElement.d.ts

@@ -1,10 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-/**
- * Interface describing the base properties for auditable metadata elements.
- */
-export interface IAuditableItemGraphMetadataElement {
-    /**
-     * The metadata to associate with the element as JSON-LD.
-     */
-    metadata?: IJsonLdNodeObject;
-}

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

@@ -1,15 +0,0 @@
-import type { AuditableItemGraphVerificationState } from "./auditableItemGraphVerificationState";
-/**
- * Interface describing an auditable item graph verification.
- */
-export interface IAuditableItemGraphVerification {
-    [id: string]: unknown;
-    /**
-     * The epoch of the verification.
-     */
-    epoch: number;
-    /**
-     * The state of the verification.
-     */
-    state: AuditableItemGraphVerificationState;
-}

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,43 +0,0 @@
-# Interface: IAuditableItemGraphCredential
-
-The data stored immutably for the graph in a verifiable credential.
-
-## Properties
-
-### created
-
-> **created**: `number`
-
-The timestamp 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,23 +0,0 @@
-# Interface: IAuditableItemGraphVerification
-
-Interface describing an auditable item graph verification.
-
-## Indexable
-
- \[`id`: `string`\]: `unknown`
-
-## Properties
-
-### epoch
-
-> **epoch**: `number`
-
-The epoch of the verification.
-
-***
-
-### state
-
-> **state**: [`AuditableItemGraphVerificationState`](../type-aliases/AuditableItemGraphVerificationState.md)
-
-The state of the verification.

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.

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

@@ -1,13 +0,0 @@
-# Type Alias: JsonReturnType\<T, U, V\>
-
-> **JsonReturnType**\<`T`, `U`, `V`\>: `T` *extends* `"json"` ? `U` : `V`
-
-The return type based on the response type.
-
-## Type Parameters
-
-• **T**
-
-• **U**
-
-• **V**

package/docs/reference/variables/AuditableItemGraphVerificationState.md

@@ -1,49 +0,0 @@
-# Variable: AuditableItemGraphVerificationState
-
-> `const` **AuditableItemGraphVerificationState**: `object`
-
-The state of the verification.
-
-## Type declaration
-
-### Ok
-
-> `readonly` **Ok**: `"ok"` = `"ok"`
-
-OK.
-
-### HashMismatch
-
-> `readonly` **HashMismatch**: `"hashMismatch"` = `"hashMismatch"`
-
-The stored hash does not matched the calculated one.
-
-### SignatureNotVerified
-
-> `readonly` **SignatureNotVerified**: `"signatureNotVerified"` = `"signatureNotVerified"`
-
-The signature verification failed.
-
-### CredentialRevoked
-
-> `readonly` **CredentialRevoked**: `"credentialRevoked"` = `"credentialRevoked"`
-
-The credential in the immutable storage was revoked.
-
-### ImmutableHashMismatch
-
-> `readonly` **ImmutableHashMismatch**: `"immutableHashMismatch"` = `"immutableHashMismatch"`
-
-Immutable hash mismatch.
-
-### ImmutableSignatureMismatch
-
-> `readonly` **ImmutableSignatureMismatch**: `"immutableSignatureMismatch"` = `"immutableSignatureMismatch"`
-
-Immutable signature mismatch.
-
-### IntegrityDataMismatch
-
-> `readonly` **IntegrityDataMismatch**: `"integrityDataMismatch"` = `"integrityDataMismatch"`
-
-Integrity data mismatch.