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

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.
Files changed (31) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/cjs/index.cjs +28 -0
  4. package/dist/esm/index.mjs +26 -0
  5. package/dist/types/index.d.ts +10 -0
  6. package/dist/types/models/IDocument.d.ts +88 -0
  7. package/dist/types/models/IDocumentList.d.ts +28 -0
  8. package/dist/types/models/IDocumentManagementComponent.d.ts +78 -0
  9. package/dist/types/models/api/IDocumentManagementGetRequest.d.ts +59 -0
  10. package/dist/types/models/api/IDocumentManagementGetResponse.d.ts +17 -0
  11. package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts +44 -0
  12. package/dist/types/models/api/IDocumentManagementQueryResponse.d.ts +17 -0
  13. package/dist/types/models/api/IDocumentManagementRemoveRequest.d.ts +28 -0
  14. package/dist/types/models/api/IDocumentManagementSetRequest.d.ts +45 -0
  15. package/dist/types/models/documentDataTypes.d.ts +25 -0
  16. package/docs/changelog.md +5 -0
  17. package/docs/examples.md +1 -0
  18. package/docs/reference/index.md +21 -0
  19. package/docs/reference/interfaces/IDocument.md +147 -0
  20. package/docs/reference/interfaces/IDocumentList.md +35 -0
  21. package/docs/reference/interfaces/IDocumentManagementComponent.md +272 -0
  22. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +109 -0
  23. package/docs/reference/interfaces/IDocumentManagementGetResponse.md +23 -0
  24. package/docs/reference/interfaces/IDocumentManagementQueryRequest.md +73 -0
  25. package/docs/reference/interfaces/IDocumentManagementQueryResponse.md +23 -0
  26. package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md +43 -0
  27. package/docs/reference/interfaces/IDocumentManagementSetRequest.md +61 -0
  28. package/docs/reference/type-aliases/DocumentTypes.md +5 -0
  29. package/docs/reference/variables/DocumentTypes.md +31 -0
  30. package/locales/en.json +3 -0
  31. package/package.json +43 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2024 IOTA Stiftung.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,21 @@
1
+ # TWIN Document Management Models
2
+
3
+ Models which define the structure of the document management contracts and connectors.
4
+
5
+ ## Installation
6
+
7
+ ```shell
8
+ npm install @twin.org/document-management-models
9
+ ```
10
+
11
+ ## Examples
12
+
13
+ Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
14
+
15
+ ## Reference
16
+
17
+ Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
18
+
19
+ ## Changelog
20
+
21
+ The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
@@ -0,0 +1,28 @@
1
+ 'use strict';
2
+
3
+ // Copyright 2024 IOTA Stiftung.
4
+ // SPDX-License-Identifier: Apache-2.0.
5
+ /**
6
+ * The types of document management objects.
7
+ */
8
+ // eslint-disable-next-line @typescript-eslint/naming-convention
9
+ const DocumentTypes = {
10
+ /**
11
+ * The context root for the document types.
12
+ */
13
+ ContextRoot: "https://schema.twindev.org/documents/",
14
+ /**
15
+ * The context root for the common types.
16
+ */
17
+ ContextRootCommon: "https://schema.twindev.org/common/",
18
+ /**
19
+ * Represents a document.
20
+ */
21
+ Document: "Document",
22
+ /**
23
+ * Represents a document list.
24
+ */
25
+ DocumentList: "DocumentList"
26
+ };
27
+
28
+ exports.DocumentTypes = DocumentTypes;
@@ -0,0 +1,26 @@
1
+ // Copyright 2024 IOTA Stiftung.
2
+ // SPDX-License-Identifier: Apache-2.0.
3
+ /**
4
+ * The types of document management objects.
5
+ */
6
+ // eslint-disable-next-line @typescript-eslint/naming-convention
7
+ const DocumentTypes = {
8
+ /**
9
+ * The context root for the document types.
10
+ */
11
+ ContextRoot: "https://schema.twindev.org/documents/",
12
+ /**
13
+ * The context root for the common types.
14
+ */
15
+ ContextRootCommon: "https://schema.twindev.org/common/",
16
+ /**
17
+ * Represents a document.
18
+ */
19
+ Document: "Document",
20
+ /**
21
+ * Represents a document list.
22
+ */
23
+ DocumentList: "DocumentList"
24
+ };
25
+
26
+ export { DocumentTypes };
@@ -0,0 +1,10 @@
1
+ export * from "./models/api/IDocumentManagementGetRequest";
2
+ export * from "./models/api/IDocumentManagementGetResponse";
3
+ export * from "./models/api/IDocumentManagementQueryRequest";
4
+ export * from "./models/api/IDocumentManagementQueryResponse";
5
+ export * from "./models/api/IDocumentManagementRemoveRequest";
6
+ export * from "./models/api/IDocumentManagementSetRequest";
7
+ export * from "./models/documentDataTypes";
8
+ export * from "./models/IDocument";
9
+ export * from "./models/IDocumentList";
10
+ export * from "./models/IDocumentManagementComponent";
@@ -0,0 +1,88 @@
1
+ import type { IAttestationInformation } from "@twin.org/attestation-models";
2
+ import type { IBlobStorageEntry } from "@twin.org/blob-storage-models";
3
+ import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
4
+ import type { SchemaOrgTypes } from "@twin.org/standards-schema-org";
5
+ import type { UneceDocumentCodes } from "@twin.org/standards-unece";
6
+ import type { DocumentTypes } from "./documentDataTypes";
7
+ /**
8
+ * Interface describing a document.
9
+ */
10
+ export interface IDocument {
11
+ /**
12
+ * JSON-LD Context.
13
+ */
14
+ "@context": [
15
+ typeof DocumentTypes.ContextRoot,
16
+ typeof DocumentTypes.ContextRootCommon,
17
+ typeof SchemaOrgTypes.ContextRoot,
18
+ ...IJsonLdContextDefinitionElement[]
19
+ ];
20
+ /**
21
+ * JSON-LD Type.
22
+ */
23
+ type: typeof DocumentTypes.Document;
24
+ /**
25
+ * The full id of the document.
26
+ */
27
+ id: string;
28
+ /**
29
+ * The id of the document.
30
+ */
31
+ documentId: string;
32
+ /**
33
+ * The format of the document id.
34
+ */
35
+ documentIdFormat?: string;
36
+ /**
37
+ * The code for the document type.
38
+ */
39
+ documentCode: UneceDocumentCodes;
40
+ /**
41
+ * The revision of the document as a 0 based index.
42
+ */
43
+ documentRevision: number;
44
+ /**
45
+ * Additional annotation information for the document.
46
+ */
47
+ annotationObject?: IJsonLdNodeObject;
48
+ /**
49
+ * The blob storage id for the document.
50
+ */
51
+ blobStorageId: string;
52
+ /**
53
+ * The hash of the blob data.
54
+ */
55
+ blobHash: string;
56
+ /**
57
+ * The additional JSON-LD for blob storage if it was requested.
58
+ */
59
+ blobStorageEntry?: IBlobStorageEntry;
60
+ /**
61
+ * The attestation for the document if one was created.
62
+ */
63
+ attestationId?: string;
64
+ /**
65
+ * The additional JSON-LD for attestation storage if it was requested.
66
+ */
67
+ attestationInformation?: IAttestationInformation;
68
+ /**
69
+ * The date/time of when the document was created.
70
+ */
71
+ dateCreated: string;
72
+ /**
73
+ * The date/time of when the document was modified.
74
+ */
75
+ dateModified?: string;
76
+ /**
77
+ * The date/time of when the document was deleted, as we never actually remove items.
78
+ */
79
+ dateDeleted?: string;
80
+ /**
81
+ * The previous revisions of the document.
82
+ */
83
+ revisions?: IDocument[];
84
+ /**
85
+ * The cursor to get the next chunk of revisions.
86
+ */
87
+ revisionCursor?: string;
88
+ }
@@ -0,0 +1,28 @@
1
+ import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
2
+ import type { DocumentTypes } from "./documentDataTypes";
3
+ import type { IDocument } from "./IDocument";
4
+ /**
5
+ * Interface describing a document entry list.
6
+ */
7
+ export interface IDocumentList {
8
+ /**
9
+ * JSON-LD Context.
10
+ */
11
+ "@context": [
12
+ typeof DocumentTypes.ContextRoot,
13
+ typeof DocumentTypes.ContextRootCommon,
14
+ ...IJsonLdContextDefinitionElement[]
15
+ ];
16
+ /**
17
+ * JSON-LD Type.
18
+ */
19
+ type: typeof DocumentTypes.DocumentList;
20
+ /**
21
+ * The list of documents.
22
+ */
23
+ documents: IDocument[];
24
+ /**
25
+ * The cursor to get the next chunk of documents.
26
+ */
27
+ cursor?: string;
28
+ }
@@ -0,0 +1,78 @@
1
+ import type { IComponent } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { UneceDocumentCodes } from "@twin.org/standards-unece";
4
+ import type { IDocument } from "./IDocument";
5
+ import type { IDocumentList } from "./IDocumentList";
6
+ /**
7
+ * Interface describing an document management contract.
8
+ */
9
+ export interface IDocumentManagementComponent extends IComponent {
10
+ /**
11
+ * Store a document in an auditable item graph vertex and add its content to blob storage.
12
+ * If the document id already exists and the blob data is different a new revision will be created.
13
+ * For any other changes the current revision will be updated.
14
+ * @param auditableItemGraphId The auditable item graph vertex id to create the document on.
15
+ * @param documentId The document id to create.
16
+ * @param documentIdFormat The format of the document identifier.
17
+ * @param documentCode The code for the document type.
18
+ * @param blob The data to create the document with.
19
+ * @param annotationObject Additional information to associate with the document.
20
+ * @param createAttestation Flag to create an attestation for the document, defaults to false.
21
+ * @param userIdentity The identity to perform the auditable item graph operation with.
22
+ * @param nodeIdentity The node identity to use for vault operations.
23
+ * @returns The identifier for the document which includes the auditable item graph identifier.
24
+ */
25
+ set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean, userIdentity?: string, nodeIdentity?: string): Promise<string>;
26
+ /**
27
+ * Get a specific document from an auditable item graph vertex.
28
+ * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
29
+ * @param identifier The identifier of the document to get.
30
+ * @param options Additional options for the get operation.
31
+ * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
32
+ * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
33
+ * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
34
+ * @param options.includeRemoved Flag to include deleted documents, defaults to false.
35
+ * @param options.maxRevisionCount Max number of revisions to return, defaults to 0.
36
+ * @param revisionCursor The cursor to get the next chunk of revisions.
37
+ * @param userIdentity The identity to perform the auditable item graph operation with.
38
+ * @param nodeIdentity The node identity to use for vault operations.
39
+ * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
40
+ */
41
+ get(auditableItemGraphId: string, identifier: string, options?: {
42
+ includeBlobStorageMetadata?: boolean;
43
+ includeBlobStorageData?: boolean;
44
+ includeAttestation?: boolean;
45
+ includeRemoved?: boolean;
46
+ maxRevisionCount?: number;
47
+ }, revisionCursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
48
+ /**
49
+ * Remove a specific document from an auditable item graph vertex.
50
+ * The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
51
+ * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
52
+ * @param identifier The identifier of the document to remove.
53
+ * @param options Additional options for the remove operation.
54
+ * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
55
+ * @param userIdentity The identity to perform the auditable item graph operation with.
56
+ * @param nodeIdentity The node identity to use for vault operations.
57
+ * @returns Nothing.
58
+ */
59
+ remove(auditableItemGraphId: string, identifier: string, options?: {
60
+ removeAllRevisions?: boolean;
61
+ }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
62
+ /**
63
+ * Query an auditable item graph vertex for documents.
64
+ * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
65
+ * @param documentCodes The document codes to query for, if undefined gets all document codes.
66
+ * @param options Additional options for the query operation.
67
+ * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
68
+ * @param options.includeRemoved Flag to include deleted documents, defaults to false.
69
+ * @param cursor The cursor to get the next chunk of documents.
70
+ * @param userIdentity The identity to perform the auditable item graph operation with.
71
+ * @param nodeIdentity The node identity to use for vault operations.
72
+ * @returns The most recent revisions of each document, cursor is set if there are more documents.
73
+ */
74
+ query(auditableItemGraphId: string, documentCodes?: UneceDocumentCodes[], options?: {
75
+ includeMostRecentRevisions?: boolean;
76
+ includeRemoved?: boolean;
77
+ }, cursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
78
+ }
@@ -0,0 +1,59 @@
1
+ import type { HeaderTypes, MimeTypes } from "@twin.org/web";
2
+ /**
3
+ * Request to get a document from an auditable item graph vertex.
4
+ */
5
+ export interface IDocumentManagementGetRequest {
6
+ /**
7
+ * The headers which can be used to determine the response data type.
8
+ */
9
+ headers?: {
10
+ [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
11
+ };
12
+ /**
13
+ * The path parameters.
14
+ */
15
+ pathParams: {
16
+ /**
17
+ * The id of the auditable item graph vertex to store the document on.
18
+ */
19
+ auditableItemGraphId: string;
20
+ /**
21
+ * The full id of the document to get.
22
+ */
23
+ documentId: string;
24
+ };
25
+ /**
26
+ * The query parameters.
27
+ */
28
+ query?: {
29
+ /**
30
+ * Include the blob storage metadata in the response.
31
+ * @default false
32
+ */
33
+ includeBlobStorageMetadata?: boolean;
34
+ /**
35
+ * Include the blob storage data in the response.
36
+ * @default false
37
+ */
38
+ includeBlobStorageData?: boolean;
39
+ /**
40
+ * Include the attestation information in the response.
41
+ * @default false
42
+ */
43
+ includeAttestation?: boolean;
44
+ /**
45
+ * Include deleted documents in the response.
46
+ * @default false
47
+ */
48
+ includeRemoved?: boolean;
49
+ /**
50
+ * Max number of revisions to return.
51
+ * @default 0
52
+ */
53
+ maxRevisionCount?: number;
54
+ /**
55
+ * The cursor to get the next chunk of revisions.
56
+ */
57
+ revisionCursor?: string;
58
+ };
59
+ }
@@ -0,0 +1,17 @@
1
+ import type { HeaderTypes, MimeTypes } from "@twin.org/web";
2
+ import type { IDocument } from "../IDocument";
3
+ /**
4
+ * Response to get a document and optionally revisions from an auditable item graph vertex.
5
+ */
6
+ export interface IDocumentManagementGetResponse {
7
+ /**
8
+ * The headers which can be used to determine the response data type.
9
+ */
10
+ headers?: {
11
+ [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
12
+ };
13
+ /**
14
+ * The body parameters.
15
+ */
16
+ body: IDocument;
17
+ }
@@ -0,0 +1,44 @@
1
+ import type { HeaderTypes, MimeTypes } from "@twin.org/web";
2
+ /**
3
+ * Request to get a list of document from an auditable item graph vertex.
4
+ */
5
+ export interface IDocumentManagementQueryRequest {
6
+ /**
7
+ * The headers which can be used to determine the response data type.
8
+ */
9
+ headers?: {
10
+ [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
11
+ };
12
+ /**
13
+ * The path parameters.
14
+ */
15
+ pathParams: {
16
+ /**
17
+ * The id of the auditable item graph vertex which contains the documents.
18
+ */
19
+ auditableItemGraphId: string;
20
+ };
21
+ /**
22
+ * The query parameters.
23
+ */
24
+ query?: {
25
+ /**
26
+ * List of comma separated document codes to filter the query.
27
+ */
28
+ documentCodes?: string;
29
+ /**
30
+ * Include deleted documents in the response.
31
+ * @default false
32
+ */
33
+ includeRemoved?: boolean;
34
+ /**
35
+ * Include the most recent 5 revisions, use the individual get to retrieve more.
36
+ * @default false
37
+ */
38
+ includeMostRecentRevisions?: boolean;
39
+ /**
40
+ * The cursor to get the next chunk of documents.
41
+ */
42
+ cursor?: string;
43
+ };
44
+ }
@@ -0,0 +1,17 @@
1
+ import type { HeaderTypes, MimeTypes } from "@twin.org/web";
2
+ import type { IDocumentList } from "../IDocumentList";
3
+ /**
4
+ * Response to query the documents from an auditable item graph vertex.
5
+ */
6
+ export interface IDocumentManagementQueryResponse {
7
+ /**
8
+ * The headers which can be used to determine the response data type.
9
+ */
10
+ headers?: {
11
+ [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
12
+ };
13
+ /**
14
+ * The body parameters.
15
+ */
16
+ body: IDocumentList;
17
+ }
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Request to remove a document from an auditable item graph.
3
+ */
4
+ export interface IDocumentManagementRemoveRequest {
5
+ /**
6
+ * The path parameters.
7
+ */
8
+ pathParams: {
9
+ /**
10
+ * The id of the auditable item graph vertex to remove the document from.
11
+ */
12
+ auditableItemGraphId: string;
13
+ /**
14
+ * The full id of the document to remove.
15
+ */
16
+ documentId: string;
17
+ };
18
+ /**
19
+ * The query parameters.
20
+ */
21
+ query?: {
22
+ /**
23
+ * Flag to remove all revisions of the document.
24
+ * @default false
25
+ */
26
+ removeAllRevisions?: boolean;
27
+ };
28
+ }