@twin.org/document-management-models 0.0.3-next.1 → 0.0.3-next.2

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 (8) hide show
  1. package/dist/es/models/api/IDocumentManagementGetRequest.js.map +1 -1
  2. package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js.map +1 -1
  3. package/dist/types/models/api/IDocumentManagementGetRequest.d.ts +4 -4
  4. package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts +3 -3
  5. package/docs/changelog.md +7 -0
  6. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +4 -4
  7. package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md +3 -3
  8. package/package.json +1 -1
package/dist/es/models/api/IDocumentManagementGetRequest.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IDocumentManagementGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * Include deleted documents in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeRemoved?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\n\t\t/**\n\t\t * PLimit the number of items to return, defaults to 1 so only most recent is returned.\n\t\t * @default 1\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of revisions.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IDocumentManagementGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: string;\n\n\t\t/**\n\t\t * Include deleted documents in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeRemoved?: string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\n\t\t/**\n\t\t * PLimit the number of items to return, defaults to 1 so only most recent is returned.\n\t\t * @default 1\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get the next chunk of revisions.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
package/dist/es/models/api/IDocumentManagementGetRevisionRequest.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IDocumentManagementGetRevisionRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to get.\n\t\t */\n\t\trevision: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: boolean | string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: boolean | string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: boolean | string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IDocumentManagementGetRevisionRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IDocumentManagementGetRevisionRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get a document revision from an auditable item graph vertex.\n */\nexport interface IDocumentManagementGetRevisionRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The full id of the document to get.\n\t\t */\n\t\tauditableItemGraphDocumentId: string;\n\n\t\t/**\n\t\t * The revision of the document to get.\n\t\t */\n\t\trevision: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the blob storage metadata in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageMetadata?: string;\n\n\t\t/**\n\t\t * Include the blob storage data in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeBlobStorageData?: string;\n\n\t\t/**\n\t\t * Include the attestation information in the response.\n\t\t * @default false\n\t\t */\n\t\tincludeAttestation?: string;\n\n\t\t/**\n\t\t * If provided will extract data from the document using the specified rule group id.\n\t\t */\n\t\textractRuleGroupId?: string;\n\n\t\t/**\n\t\t * By default extraction will auto detect the mime type of the document, this can be used to override the detection.\n\t\t */\n\t\textractMimeType?: string;\n\t};\n}\n"]}
package/dist/types/models/api/IDocumentManagementGetRequest.d.ts CHANGED
@@ -26,22 +26,22 @@ export interface IDocumentManagementGetRequest {
26
26
  * Include the blob storage metadata in the response.
27
27
  * @default false
28
28
  */
29
- includeBlobStorageMetadata?: boolean | string;
29
+ includeBlobStorageMetadata?: string;
30
30
  /**
31
31
  * Include the blob storage data in the response.
32
32
  * @default false
33
33
  */
34
- includeBlobStorageData?: boolean | string;
34
+ includeBlobStorageData?: string;
35
35
  /**
36
36
  * Include the attestation information in the response.
37
37
  * @default false
38
38
  */
39
- includeAttestation?: boolean | string;
39
+ includeAttestation?: string;
40
40
  /**
41
41
  * Include deleted documents in the response.
42
42
  * @default false
43
43
  */
44
- includeRemoved?: boolean | string;
44
+ includeRemoved?: string;
45
45
  /**
46
46
  * If provided will extract data from the document using the specified rule group id.
47
47
  */
package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts CHANGED
@@ -30,17 +30,17 @@ export interface IDocumentManagementGetRevisionRequest {
30
30
  * Include the blob storage metadata in the response.
31
31
  * @default false
32
32
  */
33
- includeBlobStorageMetadata?: boolean | string;
33
+ includeBlobStorageMetadata?: string;
34
34
  /**
35
35
  * Include the blob storage data in the response.
36
36
  * @default false
37
37
  */
38
- includeBlobStorageData?: boolean | string;
38
+ includeBlobStorageData?: string;
39
39
  /**
40
40
  * Include the attestation information in the response.
41
41
  * @default false
42
42
  */
43
- includeAttestation?: boolean | string;
43
+ includeAttestation?: string;
44
44
  /**
45
45
  * If provided will extract data from the document using the specified rule group id.
46
46
  */
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/document-management-models - Changelog
2
2
 
3
+ ## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.1...document-management-models-v0.0.3-next.2) (2025-11-28)
4
+
5
+
6
+ ### Features
7
+
8
+ * update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
9
+
3
10
  ## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.0...document-management-models-v0.0.3-next.1) (2025-11-12)
4
11
 
5
12
 
package/docs/reference/interfaces/IDocumentManagementGetRequest.md CHANGED
@@ -38,7 +38,7 @@ The query parameters.
38
38
 
39
39
  #### includeBlobStorageMetadata?
40
40
 
41
- > `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
41
+ > `optional` **includeBlobStorageMetadata**: `string`
42
42
 
43
43
  Include the blob storage metadata in the response.
44
44
 
@@ -50,7 +50,7 @@ false
50
50
 
51
51
  #### includeBlobStorageData?
52
52
 
53
- > `optional` **includeBlobStorageData**: `string` \| `boolean`
53
+ > `optional` **includeBlobStorageData**: `string`
54
54
 
55
55
  Include the blob storage data in the response.
56
56
 
@@ -62,7 +62,7 @@ false
62
62
 
63
63
  #### includeAttestation?
64
64
 
65
- > `optional` **includeAttestation**: `string` \| `boolean`
65
+ > `optional` **includeAttestation**: `string`
66
66
 
67
67
  Include the attestation information in the response.
68
68
 
@@ -74,7 +74,7 @@ false
74
74
 
75
75
  #### includeRemoved?
76
76
 
77
- > `optional` **includeRemoved**: `string` \| `boolean`
77
+ > `optional` **includeRemoved**: `string`
78
78
 
79
79
  Include deleted documents in the response.
80
80
 
package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md CHANGED
@@ -44,7 +44,7 @@ The query parameters.
44
44
 
45
45
  #### includeBlobStorageMetadata?
46
46
 
47
- > `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
47
+ > `optional` **includeBlobStorageMetadata**: `string`
48
48
 
49
49
  Include the blob storage metadata in the response.
50
50
 
@@ -56,7 +56,7 @@ false
56
56
 
57
57
  #### includeBlobStorageData?
58
58
 
59
- > `optional` **includeBlobStorageData**: `string` \| `boolean`
59
+ > `optional` **includeBlobStorageData**: `string`
60
60
 
61
61
  Include the blob storage data in the response.
62
62
 
@@ -68,7 +68,7 @@ false
68
68
 
69
69
  #### includeAttestation?
70
70
 
71
- > `optional` **includeAttestation**: `string` \| `boolean`
71
+ > `optional` **includeAttestation**: `string`
72
72
 
73
73
  Include the attestation information in the response.
74
74
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/document-management-models",
3
- "version": "0.0.3-next.1",
3
+ "version": "0.0.3-next.2",
4
4
  "description": "Models which define the structure of the document management connectors and services",
5
5
  "repository": {
6
6
  "type": "git",