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

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 (34) hide show
  1. package/dist/cjs/index.cjs +17 -3
  2. package/dist/esm/index.mjs +17 -4
  3. package/dist/types/index.d.ts +5 -2
  4. package/dist/types/models/IDocument.d.ts +10 -9
  5. package/dist/types/models/IDocumentAttestation.d.ts +41 -0
  6. package/dist/types/models/IDocumentList.d.ts +9 -4
  7. package/dist/types/models/IDocumentManagementComponent.d.ts +50 -34
  8. package/dist/types/models/api/{IDocumentManagementSetRequest.d.ts → IDocumentManagementCreateRequest.d.ts} +19 -12
  9. package/dist/types/models/api/IDocumentManagementGetRequest.d.ts +5 -9
  10. package/dist/types/models/api/IDocumentManagementGetResponse.d.ts +2 -2
  11. package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts +7 -22
  12. package/dist/types/models/api/IDocumentManagementQueryResponse.d.ts +2 -2
  13. package/dist/types/models/api/IDocumentManagementRemoveRequest.d.ts +5 -15
  14. package/dist/types/models/api/IDocumentManagementUpdateRequest.d.ts +36 -0
  15. package/dist/types/models/documentContexts.d.ts +17 -0
  16. package/dist/types/models/{documentDataTypes.d.ts → documentTypes.d.ts} +4 -8
  17. package/docs/changelog.md +22 -1
  18. package/docs/reference/index.md +5 -1
  19. package/docs/reference/interfaces/IDocument.md +6 -6
  20. package/docs/reference/interfaces/IDocumentAttestation.md +59 -0
  21. package/docs/reference/interfaces/IDocumentList.md +9 -1
  22. package/docs/reference/interfaces/IDocumentManagementComponent.md +110 -72
  23. package/docs/reference/interfaces/{IDocumentManagementSetRequest.md → IDocumentManagementCreateRequest.md} +21 -17
  24. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +8 -14
  25. package/docs/reference/interfaces/IDocumentManagementGetResponse.md +1 -1
  26. package/docs/reference/interfaces/IDocumentManagementQueryRequest.md +11 -43
  27. package/docs/reference/interfaces/IDocumentManagementQueryResponse.md +1 -1
  28. package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md +7 -27
  29. package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md +43 -0
  30. package/docs/reference/type-aliases/DocumentContexts.md +5 -0
  31. package/docs/reference/type-aliases/DocumentTypes.md +1 -1
  32. package/docs/reference/variables/DocumentContexts.md +19 -0
  33. package/docs/reference/variables/DocumentTypes.md +6 -12
  34. package/package.json +2 -1
@@ -0,0 +1,43 @@
1
+ # Interface: IDocumentManagementUpdateRequest
2
+
3
+ Request to update a document as an auditable item graph vertex.
4
+
5
+ ## Properties
6
+
7
+ ### pathParams
8
+
9
+ > **pathParams**: `object`
10
+
11
+ The path parameters.
12
+
13
+ #### auditableItemGraphDocumentId
14
+
15
+ > **auditableItemGraphDocumentId**: `string`
16
+
17
+ The full id of the document to get.
18
+
19
+ ***
20
+
21
+ ### body
22
+
23
+ > **body**: `object`
24
+
25
+ The body parameters.
26
+
27
+ #### blob?
28
+
29
+ > `optional` **blob**: `string`
30
+
31
+ The data to create the document with, in base64.
32
+
33
+ #### annotationObject?
34
+
35
+ > `optional` **annotationObject**: `IJsonLdNodeObject`
36
+
37
+ Additional information to associate with the document.
38
+
39
+ #### auditableItemGraphEdges?
40
+
41
+ > `optional` **auditableItemGraphEdges**: `object`[]
42
+
43
+ The auditable item graph vertices to connect the document to.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DocumentContexts
2
+
3
+ > **DocumentContexts** = *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\[keyof *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\]
4
+
5
+ The contexts of document management objects.
@@ -1,5 +1,5 @@
1
1
  # Type Alias: DocumentTypes
2
2
 
3
- > **DocumentTypes**: *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\[keyof *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\]
3
+ > **DocumentTypes** = *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\[keyof *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\]
4
4
 
5
5
  The types of document management objects.
@@ -0,0 +1,19 @@
1
+ # Variable: DocumentContexts
2
+
3
+ > `const` **DocumentContexts**: `object`
4
+
5
+ The contexts of document management objects.
6
+
7
+ ## Type declaration
8
+
9
+ ### ContextRoot
10
+
11
+ > `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
12
+
13
+ The context root for the document types.
14
+
15
+ ### ContextRootCommon
16
+
17
+ > `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
18
+
19
+ The context root for the common types.
@@ -6,24 +6,18 @@ The types of document management objects.
6
6
 
7
7
  ## Type declaration
8
8
 
9
- ### ContextRoot
10
-
11
- > `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
12
-
13
- The context root for the document types.
14
-
15
- ### ContextRootCommon
16
-
17
- > `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
18
-
19
- The context root for the common types.
20
-
21
9
  ### Document
22
10
 
23
11
  > `readonly` **Document**: `"Document"` = `"Document"`
24
12
 
25
13
  Represents a document.
26
14
 
15
+ ### DocumentAttestation
16
+
17
+ > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
18
+
19
+ Represents a document attestation.
20
+
27
21
  ### DocumentList
28
22
 
29
23
  > `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/document-management-models",
3
- "version": "0.0.1-next.1",
3
+ "version": "0.0.1-next.10",
4
4
  "description": "Models which define the structure of the document management connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,6 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/attestation-models": "next",
18
+ "@twin.org/auditable-item-graph-models": "next",
18
19
  "@twin.org/blob-storage-models": "next",
19
20
  "@twin.org/core": "next",
20
21
  "@twin.org/data-json-ld": "next",