@twin.org/document-management-service 0.0.1-next.5 → 0.0.1-next.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +27 -27
- package/dist/esm/index.mjs +32 -32
- package/docs/changelog.md +1 -1
- package/package.json +2 -2
package/dist/cjs/index.cjs
CHANGED
|
@@ -113,9 +113,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
113
113
|
response: {
|
|
114
114
|
body: {
|
|
115
115
|
"@context": [
|
|
116
|
-
documentManagementModels.
|
|
117
|
-
documentManagementModels.
|
|
118
|
-
standardsSchemaOrg.
|
|
116
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
117
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
118
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
119
119
|
],
|
|
120
120
|
type: documentManagementModels.DocumentTypes.Document,
|
|
121
121
|
id: "documents:705:2721000:rev-0",
|
|
@@ -147,9 +147,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
147
147
|
response: {
|
|
148
148
|
body: {
|
|
149
149
|
"@context": [
|
|
150
|
-
documentManagementModels.
|
|
151
|
-
documentManagementModels.
|
|
152
|
-
standardsSchemaOrg.
|
|
150
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
151
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
152
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
153
153
|
],
|
|
154
154
|
type: documentManagementModels.DocumentTypes.Document,
|
|
155
155
|
id: "documents:705:2721000:rev-0",
|
|
@@ -235,14 +235,14 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
235
235
|
id: "DocumentManagementQueryResponseExample",
|
|
236
236
|
response: {
|
|
237
237
|
body: {
|
|
238
|
-
"@context": [documentManagementModels.
|
|
238
|
+
"@context": [documentManagementModels.DocumentContexts.ContextRoot, documentManagementModels.DocumentContexts.ContextRootCommon],
|
|
239
239
|
type: documentManagementModels.DocumentTypes.DocumentList,
|
|
240
240
|
documents: [
|
|
241
241
|
{
|
|
242
242
|
"@context": [
|
|
243
|
-
documentManagementModels.
|
|
244
|
-
documentManagementModels.
|
|
245
|
-
standardsSchemaOrg.
|
|
243
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
244
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
245
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
246
246
|
],
|
|
247
247
|
type: documentManagementModels.DocumentTypes.Document,
|
|
248
248
|
id: "documents:705:2721000:rev-0",
|
|
@@ -275,14 +275,14 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
275
275
|
id: "DocumentManagementListResponseJsonLdExample",
|
|
276
276
|
response: {
|
|
277
277
|
body: {
|
|
278
|
-
"@context": [documentManagementModels.
|
|
278
|
+
"@context": [documentManagementModels.DocumentContexts.ContextRoot, documentManagementModels.DocumentContexts.ContextRootCommon],
|
|
279
279
|
type: documentManagementModels.DocumentTypes.DocumentList,
|
|
280
280
|
documents: [
|
|
281
281
|
{
|
|
282
282
|
"@context": [
|
|
283
|
-
documentManagementModels.
|
|
284
|
-
documentManagementModels.
|
|
285
|
-
standardsSchemaOrg.
|
|
283
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
284
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
285
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
286
286
|
],
|
|
287
287
|
type: documentManagementModels.DocumentTypes.Document,
|
|
288
288
|
id: "documents:705:2721000:rev-0",
|
|
@@ -494,7 +494,7 @@ class DocumentManagementService {
|
|
|
494
494
|
}
|
|
495
495
|
else {
|
|
496
496
|
vertex.aliases.push({
|
|
497
|
-
"@context": auditableItemGraphModels.
|
|
497
|
+
"@context": auditableItemGraphModels.AuditableItemGraphContexts.ContextRoot,
|
|
498
498
|
type: auditableItemGraphModels.AuditableItemGraphTypes.Alias,
|
|
499
499
|
id: documentId,
|
|
500
500
|
aliasFormat: documentIdFormat,
|
|
@@ -541,9 +541,9 @@ class DocumentManagementService {
|
|
|
541
541
|
// to determine the next revision number.
|
|
542
542
|
const document = {
|
|
543
543
|
"@context": [
|
|
544
|
-
documentManagementModels.
|
|
545
|
-
documentManagementModels.
|
|
546
|
-
standardsSchemaOrg.
|
|
544
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
545
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
546
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
547
547
|
],
|
|
548
548
|
type: documentManagementModels.DocumentTypes.Document,
|
|
549
549
|
id: this.createIdentifier(documentCode, documentId, documentRevision),
|
|
@@ -564,7 +564,7 @@ class DocumentManagementService {
|
|
|
564
564
|
}
|
|
565
565
|
// Add the new revision in to the AIG
|
|
566
566
|
vertex.resources.push({
|
|
567
|
-
"@context": auditableItemGraphModels.
|
|
567
|
+
"@context": auditableItemGraphModels.AuditableItemGraphContexts.ContextRoot,
|
|
568
568
|
type: auditableItemGraphModels.AuditableItemGraphTypes.Resource,
|
|
569
569
|
resourceObject: document
|
|
570
570
|
});
|
|
@@ -724,9 +724,9 @@ class DocumentManagementService {
|
|
|
724
724
|
}
|
|
725
725
|
const docList = {
|
|
726
726
|
"@context": [
|
|
727
|
-
documentManagementModels.
|
|
728
|
-
documentManagementModels.
|
|
729
|
-
standardsSchemaOrg.
|
|
727
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
728
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
729
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
730
730
|
],
|
|
731
731
|
type: documentManagementModels.DocumentTypes.DocumentList,
|
|
732
732
|
documents: finalDocs,
|
|
@@ -882,12 +882,12 @@ class DocumentManagementService {
|
|
|
882
882
|
if (options.includeBlobStorageMetadata || options.includeBlobStorageData) {
|
|
883
883
|
const blobEntry = await this._blobStorageComponent.get(document.blobStorageId, options.includeBlobStorageData, userIdentity, nodeIdentity);
|
|
884
884
|
document.blobStorageEntry = blobEntry;
|
|
885
|
-
document["@context"].push(blobStorageModels.
|
|
885
|
+
document["@context"].push(blobStorageModels.BlobStorageContexts.ContextRoot);
|
|
886
886
|
}
|
|
887
887
|
if (options.includeAttestation && core.Is.stringValue(document.attestationId)) {
|
|
888
888
|
const attestationInformation = await this._attestationComponent.get(document.attestationId);
|
|
889
889
|
document.attestationInformation = attestationInformation;
|
|
890
|
-
document["@context"].push(attestationModels.
|
|
890
|
+
document["@context"].push(attestationModels.AttestationContexts.ContextRoot);
|
|
891
891
|
}
|
|
892
892
|
document.revisions = core.Is.arrayValue(revisions) ? revisions : undefined;
|
|
893
893
|
document.revisionCursor = nextRevisionCursor;
|
|
@@ -903,9 +903,9 @@ class DocumentManagementService {
|
|
|
903
903
|
async createAttestation(document, userIdentity, nodeIdentity) {
|
|
904
904
|
const documentAttestation = {
|
|
905
905
|
"@context": [
|
|
906
|
-
documentManagementModels.
|
|
907
|
-
documentManagementModels.
|
|
908
|
-
standardsSchemaOrg.
|
|
906
|
+
documentManagementModels.DocumentContexts.ContextRoot,
|
|
907
|
+
documentManagementModels.DocumentContexts.ContextRootCommon,
|
|
908
|
+
standardsSchemaOrg.SchemaOrgContexts.ContextRoot
|
|
909
909
|
],
|
|
910
910
|
type: documentManagementModels.DocumentTypes.DocumentAttestation,
|
|
911
911
|
documentId: document.documentId,
|
package/dist/esm/index.mjs
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { HttpParameterHelper } from '@twin.org/api-models';
|
|
2
2
|
import { Guards, ComponentFactory, Converter, Coerce, Is, ObjectHelper, BaseError, GeneralError, Urn, NotFoundError } from '@twin.org/core';
|
|
3
|
-
import { DocumentTypes } from '@twin.org/document-management-models';
|
|
4
|
-
import {
|
|
3
|
+
import { DocumentTypes, DocumentContexts } from '@twin.org/document-management-models';
|
|
4
|
+
import { SchemaOrgContexts, SchemaOrgDataTypes } from '@twin.org/standards-schema-org';
|
|
5
5
|
import { UneceDocumentCodes } from '@twin.org/standards-unece';
|
|
6
6
|
import { HttpStatusCode, HeaderTypes, MimeTypes } from '@twin.org/web';
|
|
7
|
-
import {
|
|
8
|
-
import { AuditableItemGraphTypes } from '@twin.org/auditable-item-graph-models';
|
|
9
|
-
import {
|
|
7
|
+
import { AttestationContexts } from '@twin.org/attestation-models';
|
|
8
|
+
import { AuditableItemGraphTypes, AuditableItemGraphContexts } from '@twin.org/auditable-item-graph-models';
|
|
9
|
+
import { BlobStorageContexts } from '@twin.org/blob-storage-models';
|
|
10
10
|
import { Sha256 } from '@twin.org/crypto';
|
|
11
11
|
import { JsonLdProcessor } from '@twin.org/data-json-ld';
|
|
12
12
|
|
|
@@ -111,9 +111,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
111
111
|
response: {
|
|
112
112
|
body: {
|
|
113
113
|
"@context": [
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
114
|
+
DocumentContexts.ContextRoot,
|
|
115
|
+
DocumentContexts.ContextRootCommon,
|
|
116
|
+
SchemaOrgContexts.ContextRoot
|
|
117
117
|
],
|
|
118
118
|
type: DocumentTypes.Document,
|
|
119
119
|
id: "documents:705:2721000:rev-0",
|
|
@@ -145,9 +145,9 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
145
145
|
response: {
|
|
146
146
|
body: {
|
|
147
147
|
"@context": [
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
148
|
+
DocumentContexts.ContextRoot,
|
|
149
|
+
DocumentContexts.ContextRootCommon,
|
|
150
|
+
SchemaOrgContexts.ContextRoot
|
|
151
151
|
],
|
|
152
152
|
type: DocumentTypes.Document,
|
|
153
153
|
id: "documents:705:2721000:rev-0",
|
|
@@ -233,14 +233,14 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
233
233
|
id: "DocumentManagementQueryResponseExample",
|
|
234
234
|
response: {
|
|
235
235
|
body: {
|
|
236
|
-
"@context": [
|
|
236
|
+
"@context": [DocumentContexts.ContextRoot, DocumentContexts.ContextRootCommon],
|
|
237
237
|
type: DocumentTypes.DocumentList,
|
|
238
238
|
documents: [
|
|
239
239
|
{
|
|
240
240
|
"@context": [
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
241
|
+
DocumentContexts.ContextRoot,
|
|
242
|
+
DocumentContexts.ContextRootCommon,
|
|
243
|
+
SchemaOrgContexts.ContextRoot
|
|
244
244
|
],
|
|
245
245
|
type: DocumentTypes.Document,
|
|
246
246
|
id: "documents:705:2721000:rev-0",
|
|
@@ -273,14 +273,14 @@ function generateRestRoutesDocumentManagement(baseRouteName, componentName) {
|
|
|
273
273
|
id: "DocumentManagementListResponseJsonLdExample",
|
|
274
274
|
response: {
|
|
275
275
|
body: {
|
|
276
|
-
"@context": [
|
|
276
|
+
"@context": [DocumentContexts.ContextRoot, DocumentContexts.ContextRootCommon],
|
|
277
277
|
type: DocumentTypes.DocumentList,
|
|
278
278
|
documents: [
|
|
279
279
|
{
|
|
280
280
|
"@context": [
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
281
|
+
DocumentContexts.ContextRoot,
|
|
282
|
+
DocumentContexts.ContextRootCommon,
|
|
283
|
+
SchemaOrgContexts.ContextRoot
|
|
284
284
|
],
|
|
285
285
|
type: DocumentTypes.Document,
|
|
286
286
|
id: "documents:705:2721000:rev-0",
|
|
@@ -492,7 +492,7 @@ class DocumentManagementService {
|
|
|
492
492
|
}
|
|
493
493
|
else {
|
|
494
494
|
vertex.aliases.push({
|
|
495
|
-
"@context":
|
|
495
|
+
"@context": AuditableItemGraphContexts.ContextRoot,
|
|
496
496
|
type: AuditableItemGraphTypes.Alias,
|
|
497
497
|
id: documentId,
|
|
498
498
|
aliasFormat: documentIdFormat,
|
|
@@ -539,9 +539,9 @@ class DocumentManagementService {
|
|
|
539
539
|
// to determine the next revision number.
|
|
540
540
|
const document = {
|
|
541
541
|
"@context": [
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
542
|
+
DocumentContexts.ContextRoot,
|
|
543
|
+
DocumentContexts.ContextRootCommon,
|
|
544
|
+
SchemaOrgContexts.ContextRoot
|
|
545
545
|
],
|
|
546
546
|
type: DocumentTypes.Document,
|
|
547
547
|
id: this.createIdentifier(documentCode, documentId, documentRevision),
|
|
@@ -562,7 +562,7 @@ class DocumentManagementService {
|
|
|
562
562
|
}
|
|
563
563
|
// Add the new revision in to the AIG
|
|
564
564
|
vertex.resources.push({
|
|
565
|
-
"@context":
|
|
565
|
+
"@context": AuditableItemGraphContexts.ContextRoot,
|
|
566
566
|
type: AuditableItemGraphTypes.Resource,
|
|
567
567
|
resourceObject: document
|
|
568
568
|
});
|
|
@@ -722,9 +722,9 @@ class DocumentManagementService {
|
|
|
722
722
|
}
|
|
723
723
|
const docList = {
|
|
724
724
|
"@context": [
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
725
|
+
DocumentContexts.ContextRoot,
|
|
726
|
+
DocumentContexts.ContextRootCommon,
|
|
727
|
+
SchemaOrgContexts.ContextRoot
|
|
728
728
|
],
|
|
729
729
|
type: DocumentTypes.DocumentList,
|
|
730
730
|
documents: finalDocs,
|
|
@@ -880,12 +880,12 @@ class DocumentManagementService {
|
|
|
880
880
|
if (options.includeBlobStorageMetadata || options.includeBlobStorageData) {
|
|
881
881
|
const blobEntry = await this._blobStorageComponent.get(document.blobStorageId, options.includeBlobStorageData, userIdentity, nodeIdentity);
|
|
882
882
|
document.blobStorageEntry = blobEntry;
|
|
883
|
-
document["@context"].push(
|
|
883
|
+
document["@context"].push(BlobStorageContexts.ContextRoot);
|
|
884
884
|
}
|
|
885
885
|
if (options.includeAttestation && Is.stringValue(document.attestationId)) {
|
|
886
886
|
const attestationInformation = await this._attestationComponent.get(document.attestationId);
|
|
887
887
|
document.attestationInformation = attestationInformation;
|
|
888
|
-
document["@context"].push(
|
|
888
|
+
document["@context"].push(AttestationContexts.ContextRoot);
|
|
889
889
|
}
|
|
890
890
|
document.revisions = Is.arrayValue(revisions) ? revisions : undefined;
|
|
891
891
|
document.revisionCursor = nextRevisionCursor;
|
|
@@ -901,9 +901,9 @@ class DocumentManagementService {
|
|
|
901
901
|
async createAttestation(document, userIdentity, nodeIdentity) {
|
|
902
902
|
const documentAttestation = {
|
|
903
903
|
"@context": [
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
904
|
+
DocumentContexts.ContextRoot,
|
|
905
|
+
DocumentContexts.ContextRootCommon,
|
|
906
|
+
SchemaOrgContexts.ContextRoot
|
|
907
907
|
],
|
|
908
908
|
type: DocumentTypes.DocumentAttestation,
|
|
909
909
|
documentId: document.documentId,
|
package/docs/changelog.md
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/document-management-service",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.6",
|
|
4
4
|
"description": "Document management contract implementation and REST endpoint definitions",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"@twin.org/core": "next",
|
|
22
22
|
"@twin.org/crypto": "next",
|
|
23
23
|
"@twin.org/data-json-ld": "next",
|
|
24
|
-
"@twin.org/document-management-models": "0.0.1-next.
|
|
24
|
+
"@twin.org/document-management-models": "0.0.1-next.6",
|
|
25
25
|
"@twin.org/entity": "next",
|
|
26
26
|
"@twin.org/entity-storage-models": "next",
|
|
27
27
|
"@twin.org/nameof": "next",
|