@twin.org/document-management-models 0.0.1-next.2 → 0.0.1-next.4

package/dist/cjs/index.cjs

@@ -19,6 +19,10 @@ const DocumentTypes = {
      * Represents a document.
      */
     Document: "Document",
+    /**
+     * Represents a document attestation.
+     */
+    DocumentAttestation: "DocumentAttestation",
     /**
      * Represents a document list.
      */

package/dist/esm/index.mjs

@@ -17,6 +17,10 @@ const DocumentTypes = {
      * Represents a document.
      */
     Document: "Document",
+    /**
+     * Represents a document attestation.
+     */
+    DocumentAttestation: "DocumentAttestation",
     /**
      * Represents a document list.
      */

package/dist/types/index.d.ts

@@ -6,5 +6,6 @@ export * from "./models/api/IDocumentManagementRemoveRequest";
 export * from "./models/api/IDocumentManagementSetRequest";
 export * from "./models/documentDataTypes";
 export * from "./models/IDocument";
+export * from "./models/IDocumentAttestation";
 export * from "./models/IDocumentList";
 export * from "./models/IDocumentManagementComponent";

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

@@ -77,6 +77,14 @@ export interface IDocument {
      * The date/time of when the document was deleted, as we never actually remove items.
      */
     dateDeleted?: string;
+    /**
+     * The node which added the document to the graph.
+     */
+    nodeIdentity: string;
+    /**
+     * The user who added the document to the graph.
+     */
+    userIdentity: string;
     /**
      * The previous revisions of the document.
      */

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

@@ -0,0 +1,40 @@
+import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { DocumentTypes } from "./documentDataTypes";
+/**
+ * Interface describing a document attestation.
+ */
+export interface IDocumentAttestation {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof DocumentTypes.ContextRoot,
+        typeof DocumentTypes.ContextRootCommon,
+        typeof SchemaOrgTypes.ContextRoot
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof DocumentTypes.DocumentAttestation;
+    /**
+     * The id of the document.
+     */
+    documentId: string;
+    /**
+     * The code for the document type.
+     */
+    documentCode: UneceDocumentCodes;
+    /**
+     * The revision of the document as a 0 based index.
+     */
+    documentRevision: number;
+    /**
+     * The date/time of when the document was created.
+     */
+    dateCreated: string;
+    /**
+     * The hash of the document being attested.
+     */
+    blobHash: string;
+}

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

@@ -17,12 +17,19 @@ export interface IDocumentManagementComponent extends IComponent {
      * @param documentCode The code for the document type.
      * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options Additional options for the set operation.
+     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.includeIdAsAlias Include the document id as an alias to the aig vertex, defaults to false.
+     * @param options.aliasAnnotationObject Additional information to associate with the alias.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns The identifier for the document which includes the auditable item graph identifier.
      */
-    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, options?: {
+        createAttestation?: boolean;
+        includeIdAsAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Get a specific document from an auditable item graph vertex.
      * @param auditableItemGraphId The auditable item graph vertex id to get the document from.

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

@@ -41,5 +41,13 @@ export interface IDocumentManagementSetRequest {
          * Flag to create an attestation for the document, defaults to false
          */
         createAttestation?: boolean;
+        /**
+         * Include the document id as an alias to the aig vertex, defaults to false.
+         */
+        includeIdAsAlias?: boolean;
+        /**
+         * Additional information to associate with the alias.
+         */
+        aliasAnnotationObject?: IJsonLdNodeObject;
     };
 }

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

@@ -14,6 +14,10 @@ export declare const DocumentTypes: {
      * Represents a document.
      */
     readonly Document: "Document";
+    /**
+     * Represents a document attestation.
+     */
+    readonly DocumentAttestation: "DocumentAttestation";
     /**
      * Represents a document list.
      */

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/document-management-models - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.4
 
 - Initial Release

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Interfaces
 
 - [IDocument](interfaces/IDocument.md)
+- [IDocumentAttestation](interfaces/IDocumentAttestation.md)
 - [IDocumentList](interfaces/IDocumentList.md)
 - [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
 - [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)

package/docs/reference/interfaces/IDocument.md

@@ -132,6 +132,22 @@ The date/time of when the document was deleted, as we never actually remove item
 
 ***
 
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The node which added the document to the graph.
+
+***
+
+### userIdentity
+
+> **userIdentity**: `string`
+
+The user who added the document to the graph.
+
+***
+
 ### revisions?
 
 > `optional` **revisions**: [`IDocument`](IDocument.md)[]

package/docs/reference/interfaces/IDocumentAttestation.md

@@ -0,0 +1,59 @@
+# Interface: IDocumentAttestation
+
+Interface describing a document attestation.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"DocumentAttestation"`
+
+JSON-LD Type.
+
+***
+
+### documentId
+
+> **documentId**: `string`
+
+The id of the document.
+
+***
+
+### documentCode
+
+> **documentCode**: `string`
+
+The code for the document type.
+
+***
+
+### documentRevision
+
+> **documentRevision**: `number`
+
+The revision of the document as a 0 based index.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the document was created.
+
+***
+
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the document being attested.

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -10,7 +10,7 @@ Interface describing an document management contract.
 
 ### set()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Store a document in an auditable item graph vertex and add its content to blob storage.
 If the document id already exists and the blob data is different a new revision will be created.
@@ -54,12 +54,28 @@ The data to create the document with.
 
 Additional information to associate with the document.
 
-##### createAttestation?
+##### options?
+
+Additional options for the set operation.
+
+###### createAttestation?
 
 `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
+###### includeIdAsAlias?
+
+`boolean`
+
+Include the document id as an alias to the aig vertex, defaults to false.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the alias.
+
 ##### userIdentity?
 
 `string`

package/docs/reference/interfaces/IDocumentManagementSetRequest.md

@@ -59,3 +59,15 @@ Additional information to associate with the document.
 > `optional` **createAttestation**: `boolean`
 
 Flag to create an attestation for the document, defaults to false
+
+#### includeIdAsAlias?
+
+> `optional` **includeIdAsAlias**: `boolean`
+
+Include the document id as an alias to the aig vertex, defaults to false.
+
+#### aliasAnnotationObject?
+
+> `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
+
+Additional information to associate with the alias.

package/docs/reference/variables/DocumentTypes.md

@@ -24,6 +24,12 @@ The context root for the common types.
 
 Represents a document.
 
+### DocumentAttestation
+
+> `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
+
+Represents a document attestation.
+
 ### DocumentList
 
 > `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.4",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",