@twin.org/document-management-models 0.0.1-next.17 → 0.0.1-next.19

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/types/models/api/IDocumentManagementGetRequest.d.ts +5 -5
  2. package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts +3 -3
  3. package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts +1 -1
  4. package/docs/changelog.md +14 -0
  5. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +5 -5
  6. package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md +3 -3
  7. package/docs/reference/interfaces/IDocumentManagementQueryRequest.md +1 -1
  8. package/package.json +1 -1
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;
29
+ includeBlobStorageMetadata?: boolean | string;
30
30
  /**
31
31
  * Include the blob storage data in the response.
32
32
  * @default false
33
33
  */
34
- includeBlobStorageData?: boolean;
34
+ includeBlobStorageData?: boolean | string;
35
35
  /**
36
36
  * Include the attestation information in the response.
37
37
  * @default false
38
38
  */
39
- includeAttestation?: boolean;
39
+ includeAttestation?: boolean | string;
40
40
  /**
41
41
  * Include deleted documents in the response.
42
42
  * @default false
43
43
  */
44
- includeRemoved?: boolean;
44
+ includeRemoved?: boolean | string;
45
45
  /**
46
46
  * If provided will extract data from the document using the specified rule group id.
47
47
  */
@@ -54,7 +54,7 @@ export interface IDocumentManagementGetRequest {
54
54
  * Page size of items to return, defaults to 1 so only most recent is returned.
55
55
  * @default 1
56
56
  */
57
- pageSize?: string;
57
+ pageSize?: number | string;
58
58
  /**
59
59
  * The cursor to get the next chunk of revisions.
60
60
  */
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;
33
+ includeBlobStorageMetadata?: boolean | string;
34
34
  /**
35
35
  * Include the blob storage data in the response.
36
36
  * @default false
37
37
  */
38
- includeBlobStorageData?: boolean;
38
+ includeBlobStorageData?: boolean | string;
39
39
  /**
40
40
  * Include the attestation information in the response.
41
41
  * @default false
42
42
  */
43
- includeAttestation?: boolean;
43
+ includeAttestation?: boolean | string;
44
44
  /**
45
45
  * If provided will extract data from the document using the specified rule group id.
46
46
  */
package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts CHANGED
@@ -24,6 +24,6 @@ export interface IDocumentManagementQueryRequest {
24
24
  /**
25
25
  * The number of documents to return.
26
26
  */
27
- pageSize?: string;
27
+ pageSize?: number | string;
28
28
  };
29
29
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/document-management-models - Changelog
2
2
 
3
+ ## [0.0.1-next.19](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.18...document-management-models-v0.0.1-next.19) (2025-06-20)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
9
+
10
+ ## [0.0.1-next.18](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.17...document-management-models-v0.0.1-next.18) (2025-06-18)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **document-management-models:** Synchronize repo versions
16
+
3
17
  ## [0.0.1-next.17](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.16...document-management-models-v0.0.1-next.17) (2025-06-12)
4
18
 
5
19
 
package/docs/reference/interfaces/IDocumentManagementGetRequest.md CHANGED
@@ -38,7 +38,7 @@ The query parameters.
38
38
 
39
39
  #### includeBlobStorageMetadata?
40
40
 
41
- > `optional` **includeBlobStorageMetadata**: `boolean`
41
+ > `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
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**: `boolean`
53
+ > `optional` **includeBlobStorageData**: `string` \| `boolean`
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**: `boolean`
65
+ > `optional` **includeAttestation**: `string` \| `boolean`
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**: `boolean`
77
+ > `optional` **includeRemoved**: `string` \| `boolean`
78
78
 
79
79
  Include deleted documents in the response.
80
80
 
@@ -98,7 +98,7 @@ By default extraction will auto detect the mime type of the document, this can b
98
98
 
99
99
  #### pageSize?
100
100
 
101
- > `optional` **pageSize**: `string`
101
+ > `optional` **pageSize**: `string` \| `number`
102
102
 
103
103
  Page size of items to return, defaults to 1 so only most recent is returned.
104
104
 
package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md CHANGED
@@ -44,7 +44,7 @@ The query parameters.
44
44
 
45
45
  #### includeBlobStorageMetadata?
46
46
 
47
- > `optional` **includeBlobStorageMetadata**: `boolean`
47
+ > `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
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**: `boolean`
59
+ > `optional` **includeBlobStorageData**: `string` \| `boolean`
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**: `boolean`
71
+ > `optional` **includeAttestation**: `string` \| `boolean`
72
72
 
73
73
  Include the attestation information in the response.
74
74
 
package/docs/reference/interfaces/IDocumentManagementQueryRequest.md CHANGED
@@ -36,6 +36,6 @@ The cursor to get the next chunk of documents.
36
36
 
37
37
  #### pageSize?
38
38
 
39
- > `optional` **pageSize**: `string`
39
+ > `optional` **pageSize**: `string` \| `number`
40
40
 
41
41
  The number of documents to return.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/document-management-models",
3
- "version": "0.0.1-next.17",
3
+ "version": "0.0.1-next.19",
4
4
  "description": "Models which define the structure of the document management connectors and services",
5
5
  "repository": {
6
6
  "type": "git",