@twin.org/document-management-models 0.0.1-next.1

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

@@ -0,0 +1,45 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { UneceDocumentCodes } from "@twin.org/standards-unece";
+/**
+ * Request to set a document in an auditable item graph vertex.
+ */
+export interface IDocumentManagementSetRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the auditable item graph vertex to store the document on.
+         */
+        auditableItemGraphId: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The document id to create.
+         */
+        documentId: string;
+        /**
+         * The format of the document identifier.
+         */
+        documentIdFormat: string | undefined;
+        /**
+         * The code for the document type.
+         */
+        documentCode: UneceDocumentCodes;
+        /**
+         * The data to create the document with, in base64.
+         */
+        blob: string;
+        /**
+         * Additional information to associate with the document.
+         */
+        annotationObject?: IJsonLdNodeObject;
+        /**
+         * Flag to create an attestation for the document, defaults to false
+         */
+        createAttestation?: boolean;
+    };
+}

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

@@ -0,0 +1,25 @@
+/**
+ * The types of document management objects.
+ */
+export declare const DocumentTypes: {
+    /**
+     * The context root for the document types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/documents/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+    /**
+     * Represents a document.
+     */
+    readonly Document: "Document";
+    /**
+     * Represents a document list.
+     */
+    readonly DocumentList: "DocumentList";
+};
+/**
+ * The types of document management objects.
+ */
+export type DocumentTypes = (typeof DocumentTypes)[keyof typeof DocumentTypes];

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/document-management-models - Examples

package/docs/reference/index.md

@@ -0,0 +1,21 @@
+# @twin.org/document-management-models
+
+## Interfaces
+
+- [IDocument](interfaces/IDocument.md)
+- [IDocumentList](interfaces/IDocumentList.md)
+- [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
+- [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)
+- [IDocumentManagementGetResponse](interfaces/IDocumentManagementGetResponse.md)
+- [IDocumentManagementQueryRequest](interfaces/IDocumentManagementQueryRequest.md)
+- [IDocumentManagementQueryResponse](interfaces/IDocumentManagementQueryResponse.md)
+- [IDocumentManagementRemoveRequest](interfaces/IDocumentManagementRemoveRequest.md)
+- [IDocumentManagementSetRequest](interfaces/IDocumentManagementSetRequest.md)
+
+## Type Aliases
+
+- [DocumentTypes](type-aliases/DocumentTypes.md)
+
+## Variables
+
+- [DocumentTypes](variables/DocumentTypes.md)

package/docs/reference/interfaces/IDocument.md

@@ -0,0 +1,147 @@
+# Interface: IDocument
+
+Interface describing a document.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"Document"`
+
+JSON-LD Type.
+
+***
+
+### id
+
+> **id**: `string`
+
+The full id of the document.
+
+***
+
+### documentId
+
+> **documentId**: `string`
+
+The id of the document.
+
+***
+
+### documentIdFormat?
+
+> `optional` **documentIdFormat**: `string`
+
+The format of the document id.
+
+***
+
+### documentCode
+
+> **documentCode**: `string`
+
+The code for the document type.
+
+***
+
+### documentRevision
+
+> **documentRevision**: `number`
+
+The revision of the document as a 0 based index.
+
+***
+
+### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
+
+Additional annotation information for the document.
+
+***
+
+### blobStorageId
+
+> **blobStorageId**: `string`
+
+The blob storage id for the document.
+
+***
+
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the blob data.
+
+***
+
+### blobStorageEntry?
+
+> `optional` **blobStorageEntry**: `IBlobStorageEntry`
+
+The additional JSON-LD for blob storage if it was requested.
+
+***
+
+### attestationId?
+
+> `optional` **attestationId**: `string`
+
+The attestation for the document if one was created.
+
+***
+
+### attestationInformation?
+
+> `optional` **attestationInformation**: `IAttestationInformation`
+
+The additional JSON-LD for attestation storage if it was requested.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the document was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time of when the document was modified.
+
+***
+
+### dateDeleted?
+
+> `optional` **dateDeleted**: `string`
+
+The date/time of when the document was deleted, as we never actually remove items.
+
+***
+
+### revisions?
+
+> `optional` **revisions**: [`IDocument`](IDocument.md)[]
+
+The previous revisions of the document.
+
+***
+
+### revisionCursor?
+
+> `optional` **revisionCursor**: `string`
+
+The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentList.md

@@ -0,0 +1,35 @@
+# Interface: IDocumentList
+
+Interface describing a document entry list.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"DocumentList"`
+
+JSON-LD Type.
+
+***
+
+### documents
+
+> **documents**: [`IDocument`](IDocument.md)[]
+
+The list of documents.
+
+***
+
+### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get the next chunk of documents.

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -0,0 +1,272 @@
+# Interface: IDocumentManagementComponent
+
+Interface describing an document management contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### set()
+
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `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.
+For any other changes the current revision will be updated.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex id to create the document on.
+
+##### documentId
+
+`string`
+
+The document id to create.
+
+##### documentIdFormat
+
+The format of the document identifier.
+
+`undefined` | `string`
+
+##### documentCode
+
+`string`
+
+The code for the document type.
+
+##### blob
+
+`Uint8Array`
+
+The data to create the document with.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### createAttestation?
+
+`boolean`
+
+Flag to create an attestation for the document, defaults to false.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The identifier for the document which includes the auditable item graph identifier.
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocument`](IDocument.md)\>
+
+Get a specific document from an auditable item graph vertex.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex id to get the document from.
+
+##### identifier
+
+`string`
+
+The identifier of the document to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### includeRemoved?
+
+`boolean`
+
+Flag to include deleted documents, defaults to false.
+
+###### maxRevisionCount?
+
+`number`
+
+Max number of revisions to return, defaults to 0.
+
+##### revisionCursor?
+
+`string`
+
+The cursor to get the next chunk of revisions.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<[`IDocument`](IDocument.md)\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+***
+
+### remove()
+
+> **remove**(`auditableItemGraphId`, `identifier`, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+
+Remove a specific document from an auditable item graph vertex.
+The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex id to remove the document from.
+
+##### identifier
+
+`string`
+
+The identifier of the document to remove.
+
+##### options?
+
+Additional options for the remove operation.
+
+###### removeAllRevisions?
+
+`boolean`
+
+Flag to remove all revisions of the document, defaults to false.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### query()
+
+> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+
+Query an auditable item graph vertex for documents.
+
+#### Parameters
+
+##### auditableItemGraphId
+
+`string`
+
+The auditable item graph vertex to get the documents from.
+
+##### documentCodes?
+
+`string`[]
+
+The document codes to query for, if undefined gets all document codes.
+
+##### options?
+
+Additional options for the query operation.
+
+###### includeMostRecentRevisions?
+
+`boolean`
+
+Include the most recent 5 revisions, use the individual get to retrieve more.
+
+###### includeRemoved?
+
+`boolean`
+
+Flag to include deleted documents, defaults to false.
+
+##### cursor?
+
+`string`
+
+The cursor to get the next chunk of documents.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<[`IDocumentList`](IDocumentList.md)\>
+
+The most recent revisions of each document, cursor is set if there are more documents.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -0,0 +1,109 @@
+# Interface: IDocumentManagementGetRequest
+
+Request to get a document from an auditable item graph vertex.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphId
+
+> **auditableItemGraphId**: `string`
+
+The id of the auditable item graph vertex to store the document on.
+
+#### documentId
+
+> **documentId**: `string`
+
+The full id of the document to get.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### includeBlobStorageMetadata?
+
+> `optional` **includeBlobStorageMetadata**: `boolean`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData**: `boolean`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation**: `boolean`
+
+Include the attestation information in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeRemoved?
+
+> `optional` **includeRemoved**: `boolean`
+
+Include deleted documents in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### maxRevisionCount?
+
+> `optional` **maxRevisionCount**: `number`
+
+Max number of revisions to return.
+
+##### Default
+
+```ts
+0
+```
+
+#### revisionCursor?
+
+> `optional` **revisionCursor**: `string`
+
+The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDocumentManagementGetResponse
+
+Response to get a document and optionally revisions from an auditable item graph vertex.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IDocument`](IDocument.md)
+
+The body parameters.