@docmana/sdk 0.3.5 → 0.8.0

package/dist/types.d.ts

@@ -0,0 +1,145 @@
+export interface DocmanaConfig {
+    apiBaseUrl: string;
+    accessToken?: string;
+    getAccessToken?: (options?: {
+        forceRefresh?: boolean;
+    }) => string | Promise<string>;
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    pollMaxIntervalMs?: number;
+    fetch?: typeof fetch;
+    headers?: Record<string, string>;
+}
+export interface TokenCacheEntry {
+    accessToken: string;
+    expiresAt: number;
+    clientId: string;
+    tokenEndpoint: string;
+    scope: string;
+}
+export interface TokenCache {
+    read(): Promise<TokenCacheEntry | null>;
+    write(entry: TokenCacheEntry): Promise<void>;
+    clear(): Promise<void>;
+}
+export interface PathFileInput {
+    path: 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;
+    pollMaxIntervalMs?: number;
+    onPoll?: (event: {
+        executionResultId: string;
+        status: string;
+        attempt: number;
+        elapsedMs: number;
+        nextPollAfterMs?: number;
+    }) => void;
+    onRateLimit?: (event: {
+        executionResultId: string;
+        attempt: number;
+        elapsedMs: number;
+        retryAfterMs: number;
+    }) => void;
+}
+export interface RunFlowAsyncOptions {
+    signal?: AbortSignal;
+}
+export interface RunFlowAsyncParams extends RunFlowParams {
+    /** URL Consumer will POST the completion result to (wire: `callback_url`). */
+    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";
+export type { DocmanaDocumentResult } from "./models/docmana-document-result.model.js";
+export type { DocmanaNodeResult } from "./models/docmana-node-result.model.js";
+export type { DocmanaScoreNodeResult } from "./models/docmana-score-node-result.model.js";
+export type { DocmanaCrossValidationResult } from "./models/docmana-cross-validation-result.model.js";
+export type { DocmanaConclusionResult } from "./models/docmana-conclusion-result.model.js";
+export type { DocmanaClassificationResult } from "./models/docmana-classification-result.model.js";
+export type { DocmanaMetadataExtractionResult } from "./models/docmana-metadata-extraction-result.model.js";
+export type { DocmanaExtractionResult } from "./models/docmana-extraction-result.model.js";
+export type { DocmanaValidationResult } from "./models/docmana-validation-result.model.js";
+export type { ExecutionStatus } from "./models/execution-status.enum.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docmana/sdk",
-  "version": "0.3.5",
+  "version": "0.8.0",
   "description": "Official Docmana SDK — run document-analysis flows with a single call.",
   "license": "MIT",
   "type": "module",
@@ -18,7 +18,7 @@
     }
   },
   "bin": {
-    "docmana": "./dist/cli.mjs"
+    "docmana": "dist/cli.mjs"
   },
   "files": [
     "dist",
@@ -27,10 +27,11 @@
     "CHANGELOG.md"
   ],
   "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "dependencies": {
-    "commander": "^14.0.3"
+    "commander": "^15.0.0"
   },
   "scripts": {
     "build": "tsup",
@@ -48,17 +49,19 @@
     "prepublishOnly": "npm run check && npm run build"
   },
   "devDependencies": {
-    "@types/node": "^22.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "@vitest/coverage-v8": "^2.0.0",
-    "eslint": "^9.0.0",
-    "prettier": "^3.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.6.0",
-    "typescript-eslint": "^8.60.1",
-    "undici": "^7.24.4",
-    "vitest": "^2.0.0",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.9.3",
+    "@typescript-eslint/eslint-plugin": "^8.61.0",
+    "@typescript-eslint/parser": "^8.61.0",
+    "@vitest/coverage-v8": "^4.1.8",
+    "eslint": "^10.5.0",
+    "prettier": "^3.8.4",
+    "tsup": "^8.5.1",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.61.0",
+    "undici": "^8.4.1",
+    "vitest": "^4.1.8",
     "yalc": "^1.0.0-pre.53"
   }
 }

package/dist/index.d.cts

@@ -1,349 +0,0 @@
-interface DocmanaDocumentMapping {
-    name: string;
-    reference: string;
-}
-
-interface DocmanaNodeResult {
-    status: string;
-    errors?: string[];
-    /** Human-readable rationale (language-specific). Returned for every node. */
-    feedback?: string;
-    data?: Record<string, unknown>;
-}
-
-interface DocmanaScoreNodeResult extends DocmanaNodeResult {
-    /** Numeric confidence (0..100), identical across languages (not translated). */
-    score?: number;
-}
-
-interface DocmanaClassificationResult extends DocmanaScoreNodeResult {
-}
-
-interface DocmanaMetadataExtractionResult extends DocmanaNodeResult {
-}
-
-interface DocmanaExtractionResult extends DocmanaNodeResult {
-}
-
-interface DocmanaValidationResult extends DocmanaScoreNodeResult {
-}
-
-interface DocmanaDocumentResult {
-    status: string;
-    classifications?: Record<string, DocmanaClassificationResult>;
-    metadataExtraction?: DocmanaMetadataExtractionResult;
-    extractions?: Record<string, DocmanaExtractionResult>;
-    validations?: Record<string, DocmanaValidationResult>;
-}
-
-interface DocmanaCrossValidationResult extends DocmanaScoreNodeResult {
-}
-
-interface DocmanaConclusionResult extends DocmanaScoreNodeResult {
-}
-
-interface DocmanaExecutionResult {
-    status: string;
-    executionId: string;
-    errors?: string[];
-    documents: {
-        mappings: DocmanaDocumentMapping[];
-        [docKey: string]: DocmanaDocumentResult | DocmanaDocumentMapping[];
-    };
-    crossValidations?: Record<string, DocmanaCrossValidationResult>;
-    conclusions?: Record<string, DocmanaConclusionResult>;
-}
-
-type ExecutionStatus = "Pending" | "Running" | "Incompleted" | "Completed" | "Failed";
-
-interface DocmanaConfig {
-    clientId: string;
-    clientSecret: string;
-    apiBaseUrl?: string;
-    tokenEndpoint?: string;
-    scope?: string;
-    timeoutMs?: number;
-    pollIntervalMs?: number;
-    fetch?: typeof fetch;
-    headers?: Record<string, string>;
-    tokenCache?: TokenCache;
-}
-interface TokenCacheEntry {
-    accessToken: string;
-    expiresAt: number;
-    clientId: string;
-    tokenEndpoint: string;
-    scope: string;
-}
-interface TokenCache {
-    read(): Promise<TokenCacheEntry | null>;
-    write(entry: TokenCacheEntry): Promise<void>;
-    clear(): Promise<void>;
-}
-interface PathFileInput {
-    path: string;
-}
-type FileInput = string | PathFileInput | Uint8Array | NodeJS.ReadableStream;
-interface RunFlowInput {
-    file?: FileInput;
-    files?: FileInput[];
-    fileName?: string;
-    signal?: AbortSignal;
-    timeoutMs?: number;
-    pollIntervalMs?: number;
-    once?: boolean;
-    language?: string;
-    context?: Record<string, unknown>;
-}
-interface RunFlowWithCallbackInput {
-    file?: FileInput;
-    files?: FileInput[];
-    fileName?: string;
-    signal?: AbortSignal;
-    once?: boolean;
-    context?: Record<string, unknown>;
-    /** URL docmana-API will POST the completion notification to (wire: `callback_url`). */
-    callbackUrl: string;
-}
-
-declare class Docmana {
-    private readonly config;
-    private readonly http;
-    constructor(config: DocmanaConfig);
-    runFlowAsync(flowId: string, input: RunFlowInput): Promise<{
-        executionResultId: string;
-        fileIds: string[];
-    }>;
-    runFlowWithCallback(flowId: string, input: RunFlowWithCallbackInput): Promise<{
-        executionResultId: string;
-        fileIds: string[];
-    }>;
-    getStatus(executionResultId: string, signal?: AbortSignal): Promise<{
-        status: ExecutionStatus | string;
-    }>;
-    getResult(executionResultId: string, signal?: AbortSignal, language?: string): Promise<DocmanaExecutionResult>;
-    runFlow(flowId: string, input: RunFlowInput): Promise<DocmanaExecutionResult>;
-}
-
-declare class DocmanaError extends Error {
-    readonly status?: number;
-    readonly requestId?: string;
-    readonly code: string;
-    constructor(message: string, opts?: {
-        status?: number;
-        requestId?: string;
-        code?: string;
-    });
-}
-declare class DocmanaAuthError extends DocmanaError {
-    constructor(message: string, opts?: {
-        status?: number;
-        requestId?: string;
-    });
-}
-declare class DocmanaPermissionError extends DocmanaError {
-    constructor(message: string, opts?: {
-        status?: number;
-        requestId?: string;
-    });
-}
-declare class DocmanaNotFoundError extends DocmanaError {
-    constructor(message: string, opts?: {
-        status?: number;
-        requestId?: string;
-    });
-}
-declare class DocmanaRequestError extends DocmanaError {
-    constructor(message: string, opts?: {
-        status?: number;
-        requestId?: string;
-    });
-}
-declare class DocmanaExecutionError extends DocmanaError {
-    readonly errors: unknown[];
-    readonly result?: DocmanaExecutionResult;
-    constructor(message: string, errors?: unknown[], result?: DocmanaExecutionResult);
-}
-declare class DocmanaTimeoutError extends DocmanaError {
-    constructor(message: string);
-}
-declare class DocmanaAbortError extends DocmanaError {
-    constructor(message: string);
-}
-
-interface PhysicalDocument {
-    physical_document_name: string;
-    physical_document_id: string;
-    physical_document_path?: string;
-    page_from: number;
-    page_to: number;
-    physical_document_url?: string;
-    metadata?: Record<string, unknown>;
-}
-
-interface DocumentContent {
-    coordinates_unit?: string;
-    pages?: Array<Array<Record<string, unknown>>>;
-}
-
-interface VirtualDocument {
-    source: PhysicalDocument;
-    virtual_document_name: string;
-    virtual_document_id: string;
-    is_translated: boolean;
-    document_types?: string[];
-    content?: DocumentContent;
-}
-
-type FlowNodeType = "Start" | "Finish" | "DataMapping" | "Classification" | "Extraction" | "Validation" | "CrossValidation" | "MetadataExtraction";
-
-interface FlowConfigs {
-    description?: string | null;
-    useIntelligentSplitting: boolean;
-    useSplittingAsContextOnly: boolean;
-    useDetectAndClassifyPII: boolean;
-    enableChatFeature: boolean;
-    defaultLanguage?: string | null;
-    additionalLanguages?: string[] | null;
-    enableDocumentPersistenceForViewing: boolean;
-    preClassificationAggregatorPrompt?: string | null;
-    preClassificationSummarizerPrompt?: string | null;
-    enforceSingleClassificationPerDocument?: boolean | null;
-    useFraudDetection: boolean;
-    fraudDetectionThreshold: number;
-    useMetadataExtraction: boolean;
-}
-
-interface FlowNodePromptMessage {
-    role: string;
-    content: string;
-    type?: string | null;
-}
-interface FlowNodePromptOutputStructure {
-    output_structure: Record<string, {
-        type: string;
-        description?: string | null;
-        items?: Record<string, unknown> | null;
-        properties?: Record<string, unknown> | null;
-        context?: string | null;
-    }>;
-}
-interface FlowNode {
-    node_id: string;
-    label: string;
-    unique_name?: string | null;
-    type: FlowNodeType;
-    has_single_document_type: boolean;
-    prompt_id?: string | null;
-    commit?: string | null;
-    target_language?: string | null;
-    mock_results?: Record<string, unknown> | null;
-    enabled?: boolean;
-    model?: string | null;
-    classification_priority?: number;
-    prompt_messages?: {
-        messages: FlowNodePromptMessage[];
-    } | null;
-    prompt_output_structure?: FlowNodePromptOutputStructure | null;
-}
-
-interface FlowEdge {
-    source: string;
-    target: string;
-}
-
-interface Flow {
-    flow_id: string;
-    name: string;
-    version: number;
-    configs: FlowConfigs;
-    nodes: FlowNode[];
-    edges: FlowEdge[];
-}
-
-interface NodeTranslationResult {
-    status?: string;
-    running_time?: number | null;
-    feedback?: string | null;
-    score?: number | null;
-    [key: string]: unknown;
-}
-
-interface ExecutionProgress {
-    status: string;
-    errors?: string[];
-}
-
-interface DocmanaApiDocumentRequest {
-    name: string;
-    file_extension: string;
-    sas_url: string;
-    blob_name: string;
-    uuid_file: string;
-    physical_document_id?: string | null;
-    doc_key: string | null;
-    status?: string | null;
-    error_message?: string | null;
-    message?: string | null;
-    message_code?: string | null;
-    metadata?: Record<string, unknown> | null;
-    is_temporary_upload?: boolean;
-}
-
-interface DocmanaApiNodeResult {
-    node_id?: string;
-    node_name?: string | null;
-    node_type?: string | null;
-    feature_name?: string | null;
-    running_time?: number | null;
-    status?: string;
-    score?: number | null;
-    feedback?: string | null;
-    translations?: Record<string, NodeTranslationResult> | null;
-    tokens?: number | null;
-    input_tokens?: number | null;
-    output_tokens?: number | null;
-    errors?: string[];
-    mana?: number | null;
-    model?: string | null;
-    tool_calls?: Record<string, unknown>[] | null;
-    prompt_id?: string | null;
-    prompt?: string | null;
-    prompt_name?: string | null;
-    label?: string | null;
-    scoreDescription?: string | null;
-    score_description?: string | null;
-    result?: unknown;
-    documentType?: string | null;
-    [key: string]: unknown;
-}
-
-interface DocmanaApiDocumentExecutionResult {
-    document?: DocmanaApiDocumentRequest;
-    node_results?: DocmanaApiNodeResult[];
-    status?: string;
-    error?: string | null;
-    [key: string]: unknown;
-}
-
-interface DocmanaApiExecutionResult {
-    status: ExecutionStatus | string;
-    error?: string;
-    errors?: string[];
-    document_requests?: DocmanaApiDocumentRequest[];
-    flow?: Flow | null;
-    results?: DocmanaApiDocumentExecutionResult[];
-    restructured_documents?: VirtualDocument[];
-    execution_id?: string;
-    total_running_time?: number;
-    total_running_time_node?: number;
-    total_tokens?: number;
-    total_input_tokens?: number;
-    total_output_tokens?: number;
-    total_documents?: number;
-    total_pages?: number;
-    event_timestamp?: string;
-    [key: string]: unknown;
-}
-
-export { Docmana, DocmanaAbortError, type DocmanaApiDocumentExecutionResult, type DocmanaApiDocumentRequest, type DocmanaApiExecutionResult, type DocmanaApiNodeResult, DocmanaAuthError, type DocmanaClassificationResult, type DocmanaConclusionResult, type DocmanaConfig, type DocmanaCrossValidationResult, type DocmanaDocumentMapping, type DocmanaDocumentResult, DocmanaError, DocmanaExecutionError, type DocmanaExecutionResult, type DocmanaExtractionResult, type DocmanaMetadataExtractionResult, type DocmanaNodeResult, DocmanaNotFoundError, DocmanaPermissionError, DocmanaRequestError, type DocmanaScoreNodeResult, DocmanaTimeoutError, type DocmanaValidationResult, type DocumentContent, type ExecutionProgress, type ExecutionStatus, type FileInput, type Flow, type FlowConfigs, type FlowEdge, type FlowNode, type FlowNodeType, type NodeTranslationResult, type PhysicalDocument, type RunFlowInput, type RunFlowWithCallbackInput, type VirtualDocument };