@docmana/sdk 0.4.0 → 0.9.0

package/dist/types.d.ts

@@ -25,11 +25,19 @@ export interface TokenCache {
 export interface PathFileInput {
     path: string;
 }
-export type FileInput = string | PathFileInput | Uint8Array | NodeJS.ReadableStream;
-export interface RunFlowInput {
-    file?: FileInput;
-    files?: FileInput[];
-    fileName?: string;
+export interface NamedFileInput {
+    data: Uint8Array | NodeJS.ReadableStream;
+    filename: string;
+    contentType?: string;
+}
+export type FileInput = string | PathFileInput | NamedFileInput;
+export interface RunFlowParams {
+    files: FileInput[];
+    useDraftVersion?: boolean;
+    language?: string;
+    context?: Record<string, unknown>;
+}
+export interface RunFlowOptions {
     signal?: AbortSignal;
     timeoutMs?: number;
     pollIntervalMs?: number;
@@ -47,20 +55,81 @@ export interface RunFlowInput {
         elapsedMs: number;
         retryAfterMs: number;
     }) => void;
-    useDraftVersion?: boolean;
-    language?: string;
-    context?: Record<string, unknown>;
 }
-export interface RunFlowWithCallbackInput {
-    file?: FileInput;
-    files?: FileInput[];
-    fileName?: string;
+export interface RunFlowAsyncOptions {
     signal?: AbortSignal;
-    useDraftVersion?: boolean;
-    language?: string;
-    context?: Record<string, unknown>;
-    /** URL Consumer will POST the completion result to (wire: `callback_url`). */
-    callbackUrl: string;
+}
+export interface RunFlowAsyncParams extends RunFlowParams {
+    /** URL Consumer will POST the completion result to (wire: `callbackUrl`). */
+    callbackUrl?: string;
+}
+export interface FlowListItem {
+    id: string;
+    name: string;
+    state: string;
+}
+export interface AccessibleOrganization {
+    id: string;
+    name: string;
+}
+export interface OrganizationDocument {
+    path: string;
+    name: string;
+    size: number;
+    lastModified: string;
+    contentType?: string;
+}
+export interface OrganizationDocumentsPayload {
+    configured: boolean;
+    documents: OrganizationDocument[];
+}
+export interface DownloadedOrganizationDocument {
+    bytes: Uint8Array;
+    filename: string;
+    contentType?: string;
+}
+export interface FlowDocumentRequirement {
+    docId: string;
+    label: string;
+    required: boolean;
+}
+export interface FlowMetadata {
+    flowId: string;
+    name?: string;
+    contextSchema: Record<string, unknown>;
+    languages: string[];
+    minScore?: number;
+    documents: FlowDocumentRequirement[];
+}
+export interface FlowDefinitionField {
+    fieldKey: string;
+    path: string;
+    type?: string;
+}
+export interface FlowDefinitionNodeMetadata {
+    title?: string;
+    uniqueName?: string;
+    assessmentType?: string;
+    scoreAssessment: boolean;
+    scoreAcceptanceThreshold?: number;
+    description?: string;
+    enabled?: boolean;
+}
+export interface FlowDefinitionNode {
+    nodeId: string;
+    type: string;
+    label: string;
+    uniqueName?: string;
+    parentId?: string;
+    fields: FlowDefinitionField[];
+    metadata?: FlowDefinitionNodeMetadata;
+}
+export interface FlowDefinition {
+    flowId: string;
+    name?: string;
+    languages: string[];
+    minScore?: number;
+    nodes: FlowDefinitionNode[];
 }
 export type { DocmanaExecutionResult } from "./models/docmana-execution-result.model.js";
 export type { DocmanaDocumentMapping } from "./models/docmana-document-mapping.model.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docmana/sdk",
-  "version": "0.4.0",
+  "version": "0.9.0",
   "description": "Official Docmana SDK — run document-analysis flows with a single call.",
   "license": "MIT",
   "type": "module",