@docmana/sdk 0.16.0 → 0.17.0

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/CHANGELOG.md CHANGED
@@ -1,6 +1,10 @@
1
- # Changelog
2
-
3
- ## 0.16.0
1
+ # Changelog
2
+
3
+ ## 0.17.0
4
+ - Expose the optional `flowVersion` on `DocmanaExecutionResult`, preserving the
5
+ exact Docmana flow version used by an execution in polling and callback results.
6
+
7
+ ## 0.16.0
4
8
  - Scope organization document access to a specific organization: `listOrganizationDocuments`
5
9
  now accepts an `organization` option and `downloadOrganizationDocument(s)` an optional
6
10
  `organization` argument, both forwarded as the `?organization=` query param (relayed to
package/README.md CHANGED
@@ -118,7 +118,8 @@ use `RunFlowParams` for request data:
118
118
  - `getStatus(executionResultId)` calls
119
119
  `GET /v1/executions/:executionResultId/status`.
120
120
  - `getResult(executionResultId, signal?, language?)` calls
121
- `GET /v1/executions/:executionResultId/result`.
121
+ `GET /v1/executions/:executionResultId/result`; its result includes the optional
122
+ `flowVersion` identifying the exact flow version used by the execution.
122
123
  - `runFlow(flowId, params, options?)` starts async execution, polls status, fetches the
123
124
  result, respects `X-Poll-After` and `429 Retry-After` while polling, and throws
124
125
  `DocmanaExecutionError` if the result status is `FAILED`.
@@ -15,6 +15,7 @@ export interface DocmanaApiExecutionResult {
15
15
  restructured_documents?: VirtualDocument[];
16
16
  execution_id?: string;
17
17
  flowId?: string;
18
+ flowVersion?: number;
18
19
  total_running_time?: number;
19
20
  total_running_time_node?: number;
20
21
  total_tokens?: number;
@@ -6,6 +6,7 @@ export interface DocmanaExecutionResult {
6
6
  status: string;
7
7
  executionId: string;
8
8
  flowId?: string;
9
+ flowVersion?: number;
9
10
  totalDocuments?: number;
10
11
  totalPages?: number;
11
12
  totalTokens?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docmana/sdk",
3
- "version": "0.16.0",
3
+ "version": "0.17.0",
4
4
  "description": "Official Docmana SDK — run document-analysis flows with a single call.",
5
5
  "license": "MIT",
6
6
  "type": "module",