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

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

@@ -15,33 +15,33 @@ export interface IAuditableItemGraphUpdateRequest {
     /**
      * The data to be used in the vertex.
      */
-    body?: {
+    body: {
         /**
-         * The metadata to be used in the vertex as JSON-LD.
+         * The object to be used in the vertex as JSON-LD.
          */
-        metadata?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
         /**
          * Alternative aliases that can be used to identify the vertex.
          */
         aliases?: {
             id: string;
-            format?: string;
-            metadata?: IJsonLdNodeObject;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
         }[];
         /**
          * The resources attached to the vertex.
          */
         resources?: {
-            id: string;
-            metadata?: IJsonLdNodeObject;
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
         }[];
         /**
          * The edges connected to the vertex.
          */
         edges?: {
             id: string;
-            relationship: string;
-            metadata?: IJsonLdNodeObject;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
         }[];
     };
 }

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of auditable item graph data.
+ */
+export declare const AuditableItemGraphContexts: {
+    /**
+     * The context root for the auditable item graph types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/aig/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of auditable item graph data.
+ */
+export type AuditableItemGraphContexts = (typeof AuditableItemGraphContexts)[keyof typeof AuditableItemGraphContexts];

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

@@ -0,0 +1,17 @@
+/**
+ * The topics for auditable item graph event bus notifications.
+ */
+export declare const AuditableItemGraphTopics: {
+    /**
+     * A vertex was created.
+     */
+    readonly VertexCreated: "auditable-item-graph:vertex-created";
+    /**
+     * A vertex was updated.
+     */
+    readonly VertexUpdated: "auditable-item-graph:vertex-updated";
+};
+/**
+ * The topics for auditable item graph event bus notifications.
+ */
+export type AuditableItemGraphTopics = (typeof AuditableItemGraphTopics)[keyof typeof AuditableItemGraphTopics];

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

@@ -2,50 +2,34 @@
  * The types of auditable item graph data.
  */
 export declare const AuditableItemGraphTypes: {
-    /**
-     * The context uri for the auditable item graph types.
-     */
-    readonly ContextUri: "https://schema.twindev.org/aig/";
-    /**
-     * The context root for the auditable item graph types.
-     */
-    readonly ContextJsonld: "https://schema.twindev.org/aig/types.jsonld";
     /**
      * Represents auditable item graph vertex.
      */
-    readonly Vertex: "https://schema.twindev.org/aig/AuditableItemGraphVertex";
+    readonly Vertex: "AuditableItemGraphVertex";
     /**
      * Represents auditable item graph alias.
      */
-    readonly Alias: "https://schema.twindev.org/aig/AuditableItemGraphAlias";
+    readonly Alias: "AuditableItemGraphAlias";
     /**
      * Represents auditable item graph resource.
      */
-    readonly Resource: "https://schema.twindev.org/aig/AuditableItemGraphResource";
+    readonly Resource: "AuditableItemGraphResource";
     /**
      * Represents auditable item graph edge.
      */
-    readonly Edge: "https://schema.twindev.org/aig/AuditableItemGraphEdge";
+    readonly Edge: "AuditableItemGraphEdge";
     /**
      * Represents auditable item graph  changeset.
      */
-    readonly Changeset: "https://schema.twindev.org/aig/AuditableItemGraphChangeset";
+    readonly Changeset: "AuditableItemGraphChangeset";
     /**
      * Represents patch operation.
      */
-    readonly PatchOperation: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation";
-    /**
-     * Represents the immutable credential payload.
-     */
-    readonly Credential: "https://schema.twindev.org/aig/AuditableItemGraphPatchCredential";
-    /**
-     * Represents auditable item stream verification.
-     */
-    readonly Verification: "https://schema.twindev.org/aig/AuditableItemGraphVerification";
+    readonly PatchOperation: "AuditableItemGraphPatchOperation";
     /**
-     * Represents auditable item stream verification state.
+     * Represents auditable item stream vertex list.
      */
-    readonly VerificationState: "https://schema.twindev.org/aig/AuditableItemGraphVerificationState";
+    readonly VertexList: "AuditableItemGraphVertexList";
 };
 /**
  * The types of auditable item graph data.

package/dist/types/models/eventBus/IAuditableItemGraphEventBusVertexCreated.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Event bus payload for vertex created.
+ */
+export interface IAuditableItemGraphEventBusVertexCreated {
+    /**
+     * The id of the vertex created.
+     */
+    id: string;
+}

package/dist/types/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.d.ts

@@ -0,0 +1,14 @@
+import type { IPatchOperation } from "@twin.org/core";
+/**
+ * Event bus payload for vertex updated.
+ */
+export interface IAuditableItemGraphEventBusVertexUpdated {
+    /**
+     * The id of the vertex updated.
+     */
+    id: string;
+    /**
+     * The patches in the changeset.
+     */
+    patches: IPatchOperation[];
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.30
 
 - Initial Release

package/docs/reference/index.md

@@ -10,28 +10,30 @@
 - [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
 - [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
 - [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
-- [IAuditableItemGraphCredential](interfaces/IAuditableItemGraphCredential.md)
 - [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
 - [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
-- [IAuditableItemGraphVerification](interfaces/IAuditableItemGraphVerification.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
+- [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
 - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
 - [IAuditableItemGraphGetRequest](interfaces/IAuditableItemGraphGetRequest.md)
 - [IAuditableItemGraphGetResponse](interfaces/IAuditableItemGraphGetResponse.md)
 - [IAuditableItemGraphListRequest](interfaces/IAuditableItemGraphListRequest.md)
 - [IAuditableItemGraphListResponse](interfaces/IAuditableItemGraphListResponse.md)
 - [IAuditableItemGraphUpdateRequest](interfaces/IAuditableItemGraphUpdateRequest.md)
+- [IAuditableItemGraphEventBusVertexCreated](interfaces/IAuditableItemGraphEventBusVertexCreated.md)
+- [IAuditableItemGraphEventBusVertexUpdated](interfaces/IAuditableItemGraphEventBusVertexUpdated.md)
 
 ## Type Aliases
 
-- [JsonReturnType](type-aliases/JsonReturnType.md)
+- [AuditableItemGraphContexts](type-aliases/AuditableItemGraphContexts.md)
+- [AuditableItemGraphTopics](type-aliases/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](type-aliases/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)
 
 ## Variables
 
+- [AuditableItemGraphContexts](variables/AuditableItemGraphContexts.md)
+- [AuditableItemGraphTopics](variables/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](variables/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](variables/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -4,15 +4,15 @@ Interface describing an alias for a vertex.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
-### format?
+### @context
 
-> `optional` **format**: `string`
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The format of the id in the alias.
+JSON-LD Context.
 
 ***
 
@@ -22,54 +22,66 @@ The format of the id in the alias.
 
 The id of the element.
 
-#### Inherited from
+#### Overrides
 
 [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
 
 ***
 
-### created
+### type
 
-> **created**: `number`
+> **type**: `"AuditableItemGraphAlias"`
 
-The timestamp of when the element was created.
+JSON-LD Type.
 
-#### Inherited from
+***
+
+### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`created`](IAuditableItemGraphAuditedElement.md#created)
+The JSON-LD annotation object for the alias.
+
+***
+
+### aliasFormat?
+
+> `optional` **aliasFormat**: `string`
+
+The format of the id in the alias.
 
 ***
 
-### updated?
+### dateCreated?
 
-> `optional` **updated**: `number`
+> `optional` **dateCreated**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was created.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`updated`](IAuditableItemGraphAuditedElement.md#updated)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
 
 ***
 
-### deleted?
+### dateModified?
 
-> `optional` **deleted**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was deleted, as we never actually remove items.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`deleted`](IAuditableItemGraphAuditedElement.md#deleted)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
 
 ***
 
-### metadata?
+### dateDeleted?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **dateDeleted**: `string`
 
-The metadata to associate with the element as JSON-LD.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-`IAuditableItemGraphMetadataElement.metadata`
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -10,32 +10,32 @@ Interface describing the base properties for auditable elements.
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 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.
 
 ***
 
-### 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.
 
 ***
 
-### 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.

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -4,11 +4,35 @@ Interface describing a set of updates to the vertex.
 
 ## Properties
 
-### created
+### @context
 
-> **created**: `number`
+> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The timestamp of when the changeset was created.
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphChangeset"`
+
+JSON-LD Type.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the changeset.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the changeset was created.
 
 ***
 
@@ -28,24 +52,16 @@ The patches in the changeset.
 
 ***
 
-### hash
-
-> **hash**: `string`
-
-The hash for the changeset.
-
-***
-
-### signature
+### proofId?
 
-> **signature**: `string`
+> `optional` **proofId**: `string`
 
-The signature for the changeset.
+The immutable proof id which contains the signature for this changeset.
 
 ***
 
-### immutableStorageId?
+### verification?
 
-> `optional` **immutableStorageId**: `string`
+> `optional` **verification**: `IImmutableProofVerification`
 
-The immutable storage id containing the signature for the changeset.
+The verification for the changeset.