@twin.org/document-management-service 0.0.2-next.4 → 0.0.3-next.2

package/docs/open-api/spec.json

@@ -243,7 +243,7 @@
 																"blobHash": "sha256:E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
 																"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
 																"dateCreated": "2024-08-22T04:13:20.000Z",
-																"nodeIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
+																"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
 																"userIdentity": "did:entity-storage:0x0404040404040404040404040404040404040404040404040404040404040404"
 															}
 														}
@@ -451,10 +451,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -463,10 +460,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -475,10 +469,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -487,10 +478,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"boolean",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -582,7 +570,7 @@
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -624,7 +612,7 @@
 														"@type": "DigitalDocument",
 														"name": "myfile.pdf"
 													},
-													"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+													"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 													"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 												}
 											]
@@ -781,7 +769,7 @@
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -813,7 +801,7 @@
 												"@type": "DigitalDocument",
 												"name": "myfile.pdf"
 											},
-											"nodeIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
+											"organizationIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363",
 											"userIdentity": "did:entity-storage:0x6363636363636363636363636363636363636363636363636363636363636363"
 										}
 									}
@@ -1030,9 +1018,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1047,7 +1032,10 @@
 								"type": "string",
 								"const": "https://schema.org"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1109,9 +1097,9 @@
 						"type": "string",
 						"description": "The date/time of when the document was deleted, as we never actually remove items."
 					},
-					"nodeIdentity": {
+					"organizationIdentity": {
 						"type": "string",
-						"description": "The node which added the document to the graph."
+						"description": "The organization which added the document to the graph."
 					},
 					"userIdentity": {
 						"type": "string",
@@ -1127,9 +1115,7 @@
 					"documentRevision",
 					"blobStorageId",
 					"blobHash",
-					"dateCreated",
-					"nodeIdentity",
-					"userIdentity"
+					"dateCreated"
 				],
 				"additionalProperties": false,
 				"description": "Interface describing a document."
@@ -1140,9 +1126,6 @@
 					"@context": {
 						"type": "array",
 						"minItems": 3,
-						"items": {
-							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-						},
 						"description": "JSON-LD Context.",
 						"prefixItems": [
 							{
@@ -1157,7 +1140,10 @@
 								"type": "string",
 								"const": "https://schema.twindev.org/common/"
 							}
-						]
+						],
+						"items": {
+							"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+						}
 					},
 					"type": {
 						"type": "string",
@@ -1166,23 +1152,17 @@
 					},
 					"itemListElement": {
 						"type": "array",
-						"items": false,
-						"description": "The list of documents.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/Document"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/Document"
+						},
+						"description": "The list of documents."
 					},
 					"edges": {
 						"type": "array",
-						"items": false,
-						"description": "The ids of the other vertices which are connected to the document.",
-						"prefixItems": [
-							{
-								"type": "string"
-							}
-						]
+						"items": {
+							"type": "string"
+						},
+						"description": "The ids of the other vertices which are connected to the document."
 					},
 					"nextItem": {
 						"type": "string",
@@ -1220,28 +1200,25 @@
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": false,
-						"description": "The auditable item graph vertices to connect the document to.",
-						"prefixItems": [
-							{
-								"type": "object",
-								"properties": {
-									"targetId": {
-										"type": "string"
-									},
-									"addAlias": {
-										"type": "boolean"
-									},
-									"aliasAnnotationObject": {
-										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-									}
+						"items": {
+							"type": "object",
+							"properties": {
+								"targetId": {
+									"type": "string"
 								},
-								"required": [
-									"targetId"
-								],
-								"additionalProperties": false
-							}
-						]
+								"addAlias": {
+									"type": "boolean"
+								},
+								"aliasAnnotationObject": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							},
+							"required": [
+								"targetId"
+							],
+							"additionalProperties": false
+						},
+						"description": "The auditable item graph vertices to connect the document to."
 					},
 					"createAttestation": {
 						"type": "boolean",
@@ -1275,28 +1252,25 @@
 					},
 					"auditableItemGraphEdges": {
 						"type": "array",
-						"items": false,
-						"description": "The auditable item graph vertices to connect the document to.",
-						"prefixItems": [
-							{
-								"type": "object",
-								"properties": {
-									"targetId": {
-										"type": "string"
-									},
-									"addAlias": {
-										"type": "boolean"
-									},
-									"aliasAnnotationObject": {
-										"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
-									}
+						"items": {
+							"type": "object",
+							"properties": {
+								"targetId": {
+									"type": "string"
 								},
-								"required": [
-									"targetId"
-								],
-								"additionalProperties": false
-							}
-						]
+								"addAlias": {
+									"type": "boolean"
+								},
+								"aliasAnnotationObject": {
+									"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+								}
+							},
+							"required": [
+								"targetId"
+							],
+							"additionalProperties": false
+						},
+						"description": "The auditable item graph vertices to connect the document to."
 					}
 				},
 				"additionalProperties": false,

package/docs/reference/classes/DocumentManagementService.md

@@ -36,9 +36,27 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDocumentManagementComponent.className`
+
+***
+
 ### create()
 
-> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
 Store a document as 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.
@@ -56,7 +74,7 @@ The document id to create.
 
 The format of the document identifier.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### documentCode
 
@@ -104,18 +122,6 @@ Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 Annotation object for the alias.
 
-##### 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`\>
@@ -130,7 +136,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ### update()
 
-> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
 Update a document as an auditable item graph vertex and add its content to blob storage.
 If the blob data is different a new revision will be created.
@@ -162,18 +168,6 @@ Additional information to associate with the document.
 
 The auditable item graph vertices to connect the document to, if undefined retains current connections.
 
-##### 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`\>
@@ -188,7 +182,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocumentList`\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<`IDocumentList`\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -252,18 +246,6 @@ The cursor to get the next chunk of revisions.
 
 Limit the number of items to return, defaults to 1 so only most recent is returned.
 
-##### 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`\>
@@ -278,7 +260,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### getRevision()
 
-> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocument`\>
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocument`\>
 
 Get a document revision using it's auditable item graph vertex id.
 
@@ -330,18 +312,6 @@ If provided will extract data from the document using the specified rule group i
 
 By default extraction will auto detect the mime type of the document, this can be used to override the detection.
 
-##### 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`\>
@@ -356,7 +326,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### removeRevision()
 
-> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
 Remove an auditable item graph vertex using it's id.
 The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
@@ -375,18 +345,6 @@ The auditable item graph vertex id which contains the document.
 
 The revision of the document to remove.
 
-##### 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`\>
@@ -401,7 +359,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
 Find all the document with a specific id.
 
@@ -425,18 +383,6 @@ The cursor to get the next chunk of documents.
 
 The limit 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`\<`IAuditableItemGraphVertexList`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.2",
 	"description": "Document management contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,11 +18,12 @@
 		"@twin.org/attestation-models": "next",
 		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/blob-storage-models": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/data-processing-models": "next",
-		"@twin.org/document-management-models": "0.0.2-next.4",
+		"@twin.org/document-management-models": "0.0.3-next.2",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",
@@ -30,20 +31,18 @@
 		"@twin.org/standards-unece": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"