@twin.org/document-management-service 0.0.3-next.1 → 0.0.3-next.11
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/es/documentManagementRoutes.js +57 -48
- package/dist/es/documentManagementRoutes.js.map +1 -1
- package/dist/es/documentManagementService.js +45 -46
- package/dist/es/documentManagementService.js.map +1 -1
- package/dist/types/documentManagementService.d.ts +10 -4
- package/docs/changelog.md +142 -0
- package/docs/open-api/spec.json +39 -61
- package/docs/reference/classes/DocumentManagementService.md +5 -5
- package/package.json +2 -2
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,147 @@
|
|
|
1
1
|
# @twin.org/document-management-service - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.11](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.10...document-management-service-v0.0.3-next.11) (2026-02-25)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update schemas ([310261d](https://github.com/twinfoundation/document-management/commit/310261d620254d9c00dfa8fbb470948af9101778))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
16
|
+
|
|
17
|
+
## [0.0.3-next.10](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.9...document-management-service-v0.0.3-next.10) (2026-02-11)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* add ts-to-jsonld-context tool ([da11115](https://github.com/twinfoundation/document-management/commit/da111155614dc7f7789480c8b0d2f03c66a16ae4))
|
|
23
|
+
* blobHash to integrity ([#38](https://github.com/twinfoundation/document-management/issues/38)) ([2d45756](https://github.com/twinfoundation/document-management/commit/2d457565ba61d260ace12a762e592b6b1a65788d))
|
|
24
|
+
* update naming ([409990b](https://github.com/twinfoundation/document-management/commit/409990b025bc3a0619969643bb1bfe634140696f))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.9 to 0.0.3-next.10
|
|
32
|
+
|
|
33
|
+
## [0.0.3-next.9](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.8...document-management-service-v0.0.3-next.9) (2026-01-26)
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
### Features
|
|
37
|
+
|
|
38
|
+
* use new hosting url for cursor links ([5cf4220](https://github.com/twinfoundation/document-management/commit/5cf4220e80e727e324193f46017f45bf828f1249))
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Dependencies
|
|
42
|
+
|
|
43
|
+
* The following workspace dependencies were updated
|
|
44
|
+
* dependencies
|
|
45
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.8 to 0.0.3-next.9
|
|
46
|
+
|
|
47
|
+
## [0.0.3-next.8](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.7...document-management-service-v0.0.3-next.8) (2026-01-26)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Bug Fixes
|
|
51
|
+
|
|
52
|
+
* pagination indexing off by one ([f0f28bf](https://github.com/twinfoundation/document-management/commit/f0f28bf1aab57ed86b3872923f89f5fa9400ad82))
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### Dependencies
|
|
56
|
+
|
|
57
|
+
* The following workspace dependencies were updated
|
|
58
|
+
* dependencies
|
|
59
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.7 to 0.0.3-next.8
|
|
60
|
+
|
|
61
|
+
## [0.0.3-next.7](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.6...document-management-service-v0.0.3-next.7) (2026-01-23)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Features
|
|
65
|
+
|
|
66
|
+
* replace nextItem property with Link header ([#34](https://github.com/twinfoundation/document-management/issues/34)) ([3f04c3f](https://github.com/twinfoundation/document-management/commit/3f04c3fb5c9ec0c56f213089a15cc247fbfbd59c))
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Dependencies
|
|
70
|
+
|
|
71
|
+
* The following workspace dependencies were updated
|
|
72
|
+
* dependencies
|
|
73
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
74
|
+
|
|
75
|
+
## [0.0.3-next.6](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.5...document-management-service-v0.0.3-next.6) (2026-01-22)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### Features
|
|
79
|
+
|
|
80
|
+
* update contexts ([#32](https://github.com/twinfoundation/document-management/issues/32)) ([2fc1d92](https://github.com/twinfoundation/document-management/commit/2fc1d9200ecd8b755efb552c5f84f996cb61e64a))
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Dependencies
|
|
84
|
+
|
|
85
|
+
* The following workspace dependencies were updated
|
|
86
|
+
* dependencies
|
|
87
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
88
|
+
|
|
89
|
+
## [0.0.3-next.5](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.4...document-management-service-v0.0.3-next.5) (2026-01-14)
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Features
|
|
93
|
+
|
|
94
|
+
* update contexts and namespaces ([#29](https://github.com/twinfoundation/document-management/issues/29)) ([ef7abc0](https://github.com/twinfoundation/document-management/commit/ef7abc01d10b3f9528be8afaa21dbd00181939ae))
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Dependencies
|
|
98
|
+
|
|
99
|
+
* The following workspace dependencies were updated
|
|
100
|
+
* dependencies
|
|
101
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
102
|
+
|
|
103
|
+
## [0.0.3-next.4](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.3...document-management-service-v0.0.3-next.4) (2026-01-06)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Features
|
|
107
|
+
|
|
108
|
+
* update unece dependencies ([a27548c](https://github.com/twinfoundation/document-management/commit/a27548cdebbe1d9577fc8341166538c2f07348a3))
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### Dependencies
|
|
112
|
+
|
|
113
|
+
* The following workspace dependencies were updated
|
|
114
|
+
* dependencies
|
|
115
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
116
|
+
|
|
117
|
+
## [0.0.3-next.3](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.2...document-management-service-v0.0.3-next.3) (2025-12-03)
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### Features
|
|
121
|
+
|
|
122
|
+
* use updated unece types ([c141a89](https://github.com/twinfoundation/document-management/commit/c141a895138cb45fa0b1e95c42f56e31708c846c))
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### Dependencies
|
|
126
|
+
|
|
127
|
+
* The following workspace dependencies were updated
|
|
128
|
+
* dependencies
|
|
129
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.2 to 0.0.3-next.3
|
|
130
|
+
|
|
131
|
+
## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.1...document-management-service-v0.0.3-next.2) (2025-11-28)
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
### Features
|
|
135
|
+
|
|
136
|
+
* update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
### Dependencies
|
|
140
|
+
|
|
141
|
+
* The following workspace dependencies were updated
|
|
142
|
+
* dependencies
|
|
143
|
+
* @twin.org/document-management-models bumped from 0.0.3-next.1 to 0.0.3-next.2
|
|
144
|
+
|
|
3
145
|
## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.3-next.0...document-management-service-v0.0.3-next.1) (2025-11-12)
|
|
4
146
|
|
|
5
147
|
|
package/docs/open-api/spec.json
CHANGED
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"schema": {
|
|
69
69
|
"type": "string"
|
|
70
70
|
},
|
|
71
|
-
"description": "e.g. aig
|
|
71
|
+
"description": "e.g. aig%3A123456"
|
|
72
72
|
}
|
|
73
73
|
}
|
|
74
74
|
},
|
|
@@ -240,7 +240,7 @@
|
|
|
240
240
|
"type": "DigitalDocument",
|
|
241
241
|
"name": "bill-of-lading"
|
|
242
242
|
},
|
|
243
|
-
"
|
|
243
|
+
"integrity": "sha256-E3Duqrp6bHojSx+CzDttAToAiP1eFkCDAPBbKLABVGM=",
|
|
244
244
|
"blobStorageId": "blob:memory:1370eeaaba7a6c7a234b1f82cc3b6d013a0088fd5e16408300f05b28b0015463",
|
|
245
245
|
"dateCreated": "2024-08-22T04:13:20.000Z",
|
|
246
246
|
"organizationIdentity": "did:entity-storage:0x0101010101010101010101010101010101010101010101010101010101010101",
|
|
@@ -451,10 +451,7 @@
|
|
|
451
451
|
"in": "query",
|
|
452
452
|
"required": false,
|
|
453
453
|
"schema": {
|
|
454
|
-
"type":
|
|
455
|
-
"boolean",
|
|
456
|
-
"string"
|
|
457
|
-
]
|
|
454
|
+
"type": "string"
|
|
458
455
|
}
|
|
459
456
|
},
|
|
460
457
|
{
|
|
@@ -463,10 +460,7 @@
|
|
|
463
460
|
"in": "query",
|
|
464
461
|
"required": false,
|
|
465
462
|
"schema": {
|
|
466
|
-
"type":
|
|
467
|
-
"boolean",
|
|
468
|
-
"string"
|
|
469
|
-
]
|
|
463
|
+
"type": "string"
|
|
470
464
|
}
|
|
471
465
|
},
|
|
472
466
|
{
|
|
@@ -475,10 +469,7 @@
|
|
|
475
469
|
"in": "query",
|
|
476
470
|
"required": false,
|
|
477
471
|
"schema": {
|
|
478
|
-
"type":
|
|
479
|
-
"boolean",
|
|
480
|
-
"string"
|
|
481
|
-
]
|
|
472
|
+
"type": "string"
|
|
482
473
|
}
|
|
483
474
|
},
|
|
484
475
|
{
|
|
@@ -487,10 +478,7 @@
|
|
|
487
478
|
"in": "query",
|
|
488
479
|
"required": false,
|
|
489
480
|
"schema": {
|
|
490
|
-
"type":
|
|
491
|
-
"boolean",
|
|
492
|
-
"string"
|
|
493
|
-
]
|
|
481
|
+
"type": "string"
|
|
494
482
|
}
|
|
495
483
|
},
|
|
496
484
|
{
|
|
@@ -564,9 +552,9 @@
|
|
|
564
552
|
"itemListElement": [
|
|
565
553
|
{
|
|
566
554
|
"@context": [
|
|
555
|
+
"https://schema.org",
|
|
567
556
|
"https://schema.twindev.org/documents/",
|
|
568
|
-
"https://schema.twindev.org/common/"
|
|
569
|
-
"https://schema.org"
|
|
557
|
+
"https://schema.twindev.org/common/"
|
|
570
558
|
],
|
|
571
559
|
"type": "Document",
|
|
572
560
|
"id": "2721000:0",
|
|
@@ -575,7 +563,7 @@
|
|
|
575
563
|
"documentCode": "unece:DocumentCodeList#705",
|
|
576
564
|
"documentRevision": 0,
|
|
577
565
|
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
578
|
-
"
|
|
566
|
+
"integrity": "sha256-123456",
|
|
579
567
|
"dateCreated": "2024-01-01T00:00:00Z",
|
|
580
568
|
"annotationObject": {
|
|
581
569
|
"@context": "https://schema.org",
|
|
@@ -606,9 +594,9 @@
|
|
|
606
594
|
"itemListElement": [
|
|
607
595
|
{
|
|
608
596
|
"@context": [
|
|
597
|
+
"https://schema.org",
|
|
609
598
|
"https://schema.twindev.org/documents/",
|
|
610
|
-
"https://schema.twindev.org/common/"
|
|
611
|
-
"https://schema.org"
|
|
599
|
+
"https://schema.twindev.org/common/"
|
|
612
600
|
],
|
|
613
601
|
"type": "Document",
|
|
614
602
|
"id": "2721000:0",
|
|
@@ -617,7 +605,7 @@
|
|
|
617
605
|
"documentCode": "unece:DocumentCodeList#705",
|
|
618
606
|
"documentRevision": 0,
|
|
619
607
|
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
620
|
-
"
|
|
608
|
+
"integrity": "sha256-123456",
|
|
621
609
|
"dateCreated": "2024-01-01T00:00:00Z",
|
|
622
610
|
"annotationObject": {
|
|
623
611
|
"@context": "https://schema.org",
|
|
@@ -763,9 +751,9 @@
|
|
|
763
751
|
"DocumentManagementGetRevisionResponseExample": {
|
|
764
752
|
"value": {
|
|
765
753
|
"@context": [
|
|
754
|
+
"https://schema.org",
|
|
766
755
|
"https://schema.twindev.org/documents/",
|
|
767
|
-
"https://schema.twindev.org/common/"
|
|
768
|
-
"https://schema.org"
|
|
756
|
+
"https://schema.twindev.org/common/"
|
|
769
757
|
],
|
|
770
758
|
"type": "Document",
|
|
771
759
|
"id": "2721000:0",
|
|
@@ -774,7 +762,7 @@
|
|
|
774
762
|
"documentCode": "unece:DocumentCodeList#705",
|
|
775
763
|
"documentRevision": 1,
|
|
776
764
|
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
777
|
-
"
|
|
765
|
+
"integrity": "sha256-123456",
|
|
778
766
|
"dateCreated": "2024-01-01T00:00:00Z",
|
|
779
767
|
"annotationObject": {
|
|
780
768
|
"@context": "https://schema.org",
|
|
@@ -795,9 +783,9 @@
|
|
|
795
783
|
"DocumentManagementGetRevisionResponseExample": {
|
|
796
784
|
"value": {
|
|
797
785
|
"@context": [
|
|
786
|
+
"https://schema.org",
|
|
798
787
|
"https://schema.twindev.org/documents/",
|
|
799
|
-
"https://schema.twindev.org/common/"
|
|
800
|
-
"https://schema.org"
|
|
788
|
+
"https://schema.twindev.org/common/"
|
|
801
789
|
],
|
|
802
790
|
"type": "Document",
|
|
803
791
|
"id": "2721000:0",
|
|
@@ -806,7 +794,7 @@
|
|
|
806
794
|
"documentCode": "unece:DocumentCodeList#705",
|
|
807
795
|
"documentRevision": 1,
|
|
808
796
|
"blobStorageId": "blob-memory:c57d94b088f4c6d2cb32ded014813d0c786aa00134c8ee22f84b1e2545602a70",
|
|
809
|
-
"
|
|
797
|
+
"integrity": "sha256-123456",
|
|
810
798
|
"dateCreated": "2024-01-01T00:00:00Z",
|
|
811
799
|
"annotationObject": {
|
|
812
800
|
"@context": "https://schema.org",
|
|
@@ -1034,15 +1022,15 @@
|
|
|
1034
1022
|
"prefixItems": [
|
|
1035
1023
|
{
|
|
1036
1024
|
"type": "string",
|
|
1037
|
-
"const": "https://schema.
|
|
1025
|
+
"const": "https://schema.org"
|
|
1038
1026
|
},
|
|
1039
1027
|
{
|
|
1040
1028
|
"type": "string",
|
|
1041
|
-
"const": "https://schema.twindev.org/
|
|
1029
|
+
"const": "https://schema.twindev.org/documents/"
|
|
1042
1030
|
},
|
|
1043
1031
|
{
|
|
1044
1032
|
"type": "string",
|
|
1045
|
-
"const": "https://schema.org"
|
|
1033
|
+
"const": "https://schema.twindev.org/common/"
|
|
1046
1034
|
}
|
|
1047
1035
|
],
|
|
1048
1036
|
"items": {
|
|
@@ -1060,62 +1048,62 @@
|
|
|
1060
1048
|
},
|
|
1061
1049
|
"documentId": {
|
|
1062
1050
|
"type": "string",
|
|
1063
|
-
"description": "The id of the document."
|
|
1051
|
+
"description": "The id of the document. json-ld type:schema:identifier"
|
|
1064
1052
|
},
|
|
1065
1053
|
"documentIdFormat": {
|
|
1066
1054
|
"type": "string",
|
|
1067
|
-
"description": "The format of the document id."
|
|
1055
|
+
"description": "The format of the document id. json-ld type:schema:Text"
|
|
1068
1056
|
},
|
|
1069
1057
|
"documentCode": {
|
|
1070
|
-
"$ref": "https://schema.twindev.org/unece/
|
|
1058
|
+
"$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
|
|
1071
1059
|
},
|
|
1072
1060
|
"documentRevision": {
|
|
1073
1061
|
"type": "number",
|
|
1074
|
-
"description": "The revision of the document as a 0 based index."
|
|
1062
|
+
"description": "The revision of the document as a 0 based index. json-ld type:schema:Integer"
|
|
1075
1063
|
},
|
|
1076
1064
|
"annotationObject": {
|
|
1077
1065
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
|
|
1078
1066
|
},
|
|
1079
1067
|
"blobStorageId": {
|
|
1080
1068
|
"type": "string",
|
|
1081
|
-
"description": "The blob storage id for the document."
|
|
1069
|
+
"description": "The blob storage id for the document. json-ld type:schema:identifier"
|
|
1082
1070
|
},
|
|
1083
|
-
"
|
|
1071
|
+
"integrity": {
|
|
1084
1072
|
"type": "string",
|
|
1085
|
-
"description": "The
|
|
1073
|
+
"description": "The integrity of the blob data. json-ld namespace:twin-common"
|
|
1086
1074
|
},
|
|
1087
1075
|
"blobStorageEntry": {
|
|
1088
1076
|
"$ref": "https://schema.twindev.org/blob-storage/BlobStorageEntry"
|
|
1089
1077
|
},
|
|
1090
1078
|
"extractedData": {
|
|
1091
|
-
"description": "The data extracted from the document using data extraction services."
|
|
1079
|
+
"description": "The data extracted from the document using data extraction services. json-ld type:json"
|
|
1092
1080
|
},
|
|
1093
1081
|
"attestationId": {
|
|
1094
1082
|
"type": "string",
|
|
1095
|
-
"description": "The attestation for the document if one was created."
|
|
1083
|
+
"description": "The attestation for the document if one was created. json-ld type:schema:identifier"
|
|
1096
1084
|
},
|
|
1097
1085
|
"attestationInformation": {
|
|
1098
1086
|
"$ref": "https://schema.twindev.org/attestation/AttestationInformation"
|
|
1099
1087
|
},
|
|
1100
1088
|
"dateCreated": {
|
|
1101
1089
|
"type": "string",
|
|
1102
|
-
"description": "The date/time of when the document was created."
|
|
1090
|
+
"description": "The date/time of when the document was created. json-ld namespace:schema"
|
|
1103
1091
|
},
|
|
1104
1092
|
"dateModified": {
|
|
1105
1093
|
"type": "string",
|
|
1106
|
-
"description": "The date/time of when the document was modified."
|
|
1094
|
+
"description": "The date/time of when the document was modified. json-ld namespace:schema"
|
|
1107
1095
|
},
|
|
1108
1096
|
"dateDeleted": {
|
|
1109
1097
|
"type": "string",
|
|
1110
|
-
"description": "The date/time of when the document was deleted, as we never actually remove items."
|
|
1098
|
+
"description": "The date/time of when the document was deleted, as we never actually remove items. json-ld namespace:schema"
|
|
1111
1099
|
},
|
|
1112
1100
|
"organizationIdentity": {
|
|
1113
1101
|
"type": "string",
|
|
1114
|
-
"description": "The organization which added the document to the graph."
|
|
1102
|
+
"description": "The organization which added the document to the graph. json-ld namespace:twin-common"
|
|
1115
1103
|
},
|
|
1116
1104
|
"userIdentity": {
|
|
1117
1105
|
"type": "string",
|
|
1118
|
-
"description": "The user who added the document to the graph."
|
|
1106
|
+
"description": "The user who added the document to the graph. json-ld namespace:twin-common"
|
|
1119
1107
|
}
|
|
1120
1108
|
},
|
|
1121
1109
|
"required": [
|
|
@@ -1126,10 +1114,9 @@
|
|
|
1126
1114
|
"documentCode",
|
|
1127
1115
|
"documentRevision",
|
|
1128
1116
|
"blobStorageId",
|
|
1129
|
-
"
|
|
1117
|
+
"integrity",
|
|
1130
1118
|
"dateCreated"
|
|
1131
1119
|
],
|
|
1132
|
-
"additionalProperties": false,
|
|
1133
1120
|
"description": "Interface describing a document."
|
|
1134
1121
|
},
|
|
1135
1122
|
"DocumentList": {
|
|
@@ -1167,18 +1154,14 @@
|
|
|
1167
1154
|
"items": {
|
|
1168
1155
|
"$ref": "#/components/schemas/Document"
|
|
1169
1156
|
},
|
|
1170
|
-
"description": "The list of documents."
|
|
1157
|
+
"description": "The list of documents. json-ld namespace:schema"
|
|
1171
1158
|
},
|
|
1172
1159
|
"edges": {
|
|
1173
1160
|
"type": "array",
|
|
1174
1161
|
"items": {
|
|
1175
1162
|
"type": "string"
|
|
1176
1163
|
},
|
|
1177
|
-
"description": "The ids of the other vertices which are connected to the document."
|
|
1178
|
-
},
|
|
1179
|
-
"nextItem": {
|
|
1180
|
-
"type": "string",
|
|
1181
|
-
"description": "The cursor to get the next chunk of documents."
|
|
1164
|
+
"description": "The ids of the other vertices which are connected to the document. json-ld container:set"
|
|
1182
1165
|
}
|
|
1183
1166
|
},
|
|
1184
1167
|
"required": [
|
|
@@ -1186,7 +1169,6 @@
|
|
|
1186
1169
|
"type",
|
|
1187
1170
|
"itemListElement"
|
|
1188
1171
|
],
|
|
1189
|
-
"additionalProperties": false,
|
|
1190
1172
|
"description": "Interface describing a list of document entries."
|
|
1191
1173
|
},
|
|
1192
1174
|
"DocumentManagementCreateRequest": {
|
|
@@ -1201,7 +1183,7 @@
|
|
|
1201
1183
|
"description": "The format of the document identifier."
|
|
1202
1184
|
},
|
|
1203
1185
|
"documentCode": {
|
|
1204
|
-
"$ref": "https://schema.twindev.org/unece/
|
|
1186
|
+
"$ref": "https://schema.twindev.org/unece/UneceDocumentCodeList"
|
|
1205
1187
|
},
|
|
1206
1188
|
"blob": {
|
|
1207
1189
|
"type": "string",
|
|
@@ -1249,7 +1231,6 @@
|
|
|
1249
1231
|
"documentCode",
|
|
1250
1232
|
"blob"
|
|
1251
1233
|
],
|
|
1252
|
-
"additionalProperties": false,
|
|
1253
1234
|
"description": "The body parameters."
|
|
1254
1235
|
},
|
|
1255
1236
|
"DocumentManagementUpdateRequest": {
|
|
@@ -1285,7 +1266,6 @@
|
|
|
1285
1266
|
"description": "The auditable item graph vertices to connect the document to."
|
|
1286
1267
|
}
|
|
1287
1268
|
},
|
|
1288
|
-
"additionalProperties": false,
|
|
1289
1269
|
"description": "The body parameters."
|
|
1290
1270
|
},
|
|
1291
1271
|
"Error": {
|
|
@@ -1320,12 +1300,10 @@
|
|
|
1320
1300
|
"name",
|
|
1321
1301
|
"message"
|
|
1322
1302
|
],
|
|
1323
|
-
"additionalProperties": false,
|
|
1324
1303
|
"description": "Model to describe serialized error."
|
|
1325
1304
|
},
|
|
1326
1305
|
"NotFoundResponse": {
|
|
1327
1306
|
"type": "object",
|
|
1328
|
-
"additionalProperties": false,
|
|
1329
1307
|
"properties": {
|
|
1330
1308
|
"notFoundId": {
|
|
1331
1309
|
"type": "string",
|
|
@@ -78,7 +78,7 @@ The format of the document identifier.
|
|
|
78
78
|
|
|
79
79
|
##### documentCode
|
|
80
80
|
|
|
81
|
-
`
|
|
81
|
+
`UneceDocumentCodeList`
|
|
82
82
|
|
|
83
83
|
The code for the document type.
|
|
84
84
|
|
|
@@ -182,7 +182,7 @@ Nothing.
|
|
|
182
182
|
|
|
183
183
|
### get()
|
|
184
184
|
|
|
185
|
-
> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise
|
|
185
|
+
> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
|
|
186
186
|
|
|
187
187
|
Get a document using it's auditable item graph vertex id and optional revision.
|
|
188
188
|
|
|
@@ -248,7 +248,7 @@ Limit the number of items to return, defaults to 1 so only most recent is return
|
|
|
248
248
|
|
|
249
249
|
#### Returns
|
|
250
250
|
|
|
251
|
-
`Promise
|
|
251
|
+
`Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
|
|
252
252
|
|
|
253
253
|
The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
|
|
254
254
|
|
|
@@ -359,7 +359,7 @@ Nothing.
|
|
|
359
359
|
|
|
360
360
|
### query()
|
|
361
361
|
|
|
362
|
-
> **query**(`documentId`, `cursor?`, `limit?`): `Promise
|
|
362
|
+
> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
|
|
363
363
|
|
|
364
364
|
Find all the document with a specific id.
|
|
365
365
|
|
|
@@ -385,7 +385,7 @@ The limit to get the next chunk of documents.
|
|
|
385
385
|
|
|
386
386
|
#### Returns
|
|
387
387
|
|
|
388
|
-
`Promise
|
|
388
|
+
`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
|
|
389
389
|
|
|
390
390
|
The graph vertices that contain documents referencing the specified document id.
|
|
391
391
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/document-management-service",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.11",
|
|
4
4
|
"description": "Document management contract implementation and REST endpoint definitions",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"@twin.org/crypto": "next",
|
|
24
24
|
"@twin.org/data-json-ld": "next",
|
|
25
25
|
"@twin.org/data-processing-models": "next",
|
|
26
|
-
"@twin.org/document-management-models": "0.0.3-next.
|
|
26
|
+
"@twin.org/document-management-models": "0.0.3-next.11",
|
|
27
27
|
"@twin.org/entity": "next",
|
|
28
28
|
"@twin.org/entity-storage-models": "next",
|
|
29
29
|
"@twin.org/nameof": "next",
|