@vertesia/common 1.2.0 → 1.4.0-dev.20260614.160504Z

package/src/store/doc-analyzer.ts

@@ -1,17 +1,17 @@
-import type { JSONObject } from "../json.js";
-import { WorkflowExecutionPayload, WorkflowRunStatus } from "./workflow.js";
+import type { JSONObject } from '../json.js';
+import type { WorkflowExecutionPayload, WorkflowRunStatus } from './workflow.js';
 
 export interface PdfToRichtextOptions {
     features?: string[];
     debug?: boolean;
-    [key: string]: any;
+    [key: string]: unknown;
 }
 
-export interface PdfToRichTextWorkflowPayload extends Omit<WorkflowExecutionPayload, "vars"> {
+export interface PdfToRichTextWorkflowPayload extends Omit<WorkflowExecutionPayload, 'vars'> {
     vars: PdfToRichtextOptions;
 }
 
-export interface TransformTablesWorkflowPayload extends Omit<WorkflowExecutionPayload, "vars"> {
+export interface TransformTablesWorkflowPayload extends Omit<WorkflowExecutionPayload, 'vars'> {
     vars: AdaptTablesParams;
     environment?: string;
 }
@@ -47,14 +47,14 @@ export interface DocTable {
     page_number?: number;
     table_number?: number;
     title?: string;
-    format: "application/csv" | "application/json";
+    format: 'application/csv' | 'application/json';
 }
 
 /**
  * Represents a table in a document that has been analyzed in CSV format
  */
 export interface DocTableCsv extends DocTable {
-    format: "application/csv";
+    format: 'application/csv';
     title?: string;
     data: string;
 }
@@ -63,15 +63,17 @@ export interface DocTableCsv extends DocTable {
  * Represents a table in a document that has been analyzed in JSON format
  */
 export interface DocTableJson extends DocTable {
-    format: "application/json";
+    format: 'application/json';
     title?: string;
     data: JSONObject[];
 }
 
+export type DocTableResponse = DocTableCsv | DocTableJson;
+
 /**
  * Output format for document processing workflows
  */
-export type DocProcessorOutputFormat = "xml" | "markdown";
+export type DocProcessorOutputFormat = 'xml' | 'markdown';
 
 /**
  * Represents a document analysis run status
@@ -84,7 +86,7 @@ export interface DocAnalyzeRunStatusResponse extends WorkflowRunStatus {
 
 export interface DocAnalyzerResultResponse {
     document?: string;
-    tables?: DocTableCsv[] | DocTableJson[];
+    tables?: DocTableResponse[];
     images?: DocImage[];
     annotated?: string | null;
 }
@@ -129,12 +131,12 @@ export interface AdaptTablesParams {
     /**
      * Format to return the data in (csv, json)
      */
-    format?: "csv" | "json";
+    format?: 'csv' | 'json';
 
     /**
      * Process the table as a whole or by page
      */
-    process_as?: "page" | "table";
+    process_as?: 'page' | 'table';
 
     /**
      * Process the table as a CSV file
@@ -163,12 +165,18 @@ export interface AdaptTablesRequest extends DocAnalyzerRequestBase, AdaptTablesP
  */
 export interface GetAdaptedTablesRequestQuery {
     raw?: boolean;
-    format: "csv" | "json";
+    format: 'csv' | 'json';
 }
 /**
  * The adapted table result format
  */
 export interface AdaptedTable {
     comment?: string;
-    data: Record<string, any>[];
+    data: Record<string, unknown>[];
+}
+
+export type AdaptedTableResponse = Record<string, AdaptedTable>;
+
+export interface AnnotatedPdfResponse {
+    url: string | null;
 }

package/src/store/dsl-workflow.ts

@@ -1,8 +1,8 @@
-import { StringValue } from "ms";
-import { ToolExecutionMetadata } from "../tool-execution.js";
-import { BaseObject } from "./common.js";
-import { WorkflowExecutionPayload } from "./index.js";
-import { ParentClosePolicyType } from "./temporalio.js";
+import type { StringValue } from 'ms';
+import type { ToolExecutionMetadata } from '../tool-execution.js';
+import type { BaseObject } from './common.js';
+import type { WorkflowExecutionPayload } from './index.js';
+import type { ParentClosePolicyType } from './temporalio.js';
 
 export type DurationValue = StringValue | number;
 
@@ -23,14 +23,17 @@ export interface WorkflowInputFile {
  * Discriminated union for workflow inputs.
  * Workflows can accept either a list of object IDs (existing behavior) OR a list of file references (new).
  */
+/**
+ * @discriminator inputType
+ */
 export type WorkflowInput =
-    | { inputType: 'objectIds', objectIds: string[] }
-    | { inputType: 'files', files: WorkflowInputFile[] };
+    | { inputType: 'objectIds'; objectIds: string[] }
+    | { inputType: 'files'; files: WorkflowInputFile[] };
 
 /**
  * The payload sent when starting a workflow from the temporal client to the workflow instance.
  */
-export interface DSLWorkflowExecutionPayload extends WorkflowExecutionPayload {
+export interface DSLWorkflowExecutionPayload extends WorkflowExecutionPayload<Record<string, unknown>> {
     /**
      * The workflow definition to be used by the DSL workflow.
      * If a dsl workflow is executed and no definition is provided the workflow will fail.
@@ -69,20 +72,21 @@ export type WorkflowSearchAttributes = Record<string, WorkflowSearchAttributeVal
 /**
  * The payload for a DSL activity execution.
  */
-export interface DSLActivityExecutionPayload<ParamsT extends Record<string, any>> extends WorkflowExecutionPayload {
+export interface DSLActivityExecutionPayload<ParamsT extends object> extends WorkflowExecutionPayload {
     activity: DSLActivitySpec;
     params: ParamsT;
     workflow_name: string;
     debug_mode?: boolean;
+    toolRunId?: string;
+    activityGroupId?: string;
 }
 
-
 export type ImportSpec = (string | Record<string, string>)[];
 export interface ActivityFetchSpec {
     /**
      * The data provider name
      */
-    type: "document" | "document_type" | "interaction_run";
+    type: 'document' | 'document_type' | 'interaction_run';
     /**
      * An optional URI to the data source.
      */
@@ -90,7 +94,7 @@ export interface ActivityFetchSpec {
     /**
      * The query to be executed by the data provider
      */
-    query: Record<string, any>;
+    query: Record<string, unknown>;
     /**
      * a string of space separated field names.
      * Prefix a field name with "-" to exclude it from the result.
@@ -107,7 +111,7 @@ export interface ActivityFetchSpec {
      * 1. ignore - Ignore and return an empty array for multi objects query (or undefined for single object query) or empty array for multiple objects throw an error.
      * 2. throw - Throw an error if the object or no objects are found.
      */
-    on_not_found?: "ignore" | "throw";
+    on_not_found?: 'ignore' | 'throw';
 }
 
 export interface DSLWorkflowStepBase {
@@ -115,10 +119,10 @@ export interface DSLWorkflowStepBase {
      * The type fo the step.
      * If not set defaults to "activity"
      */
-    type: "activity" | "workflow";
+    type: 'activity' | 'workflow';
 }
 
-export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<string, any>> {
+export interface DSLActivitySpec<PARAMS extends object = Record<string, unknown>> {
     /**
      * The name of the activity function
      */
@@ -153,7 +157,7 @@ export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<str
      * {$eq: {name: value}},
      * Ex: {$eq: {wfVarName: value}}
      */
-    condition?: Record<string, any>;
+    condition?: Record<string, unknown>;
 
     /**
      * The import spec is used to import data from workflow variables.
@@ -172,7 +176,7 @@ export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<str
     /**
      * Projection to apply to the result. Not all activities support this.
      */
-    projection?: never | Record<string, any>;
+    projection?: never | Record<string, unknown>;
 
     // ---------- Optional features not implemented in a first step ------------
     /**
@@ -193,19 +197,21 @@ export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<str
     options?: DSLActivityOptions;
 }
 
-export interface DSLActivityStep<PARAMS extends Record<string, any> = Record<string, any>> extends DSLActivitySpec<PARAMS>, DSLWorkflowStepBase {
-    type: "activity";
+export interface DSLActivityStep<PARAMS extends object = Record<string, unknown>>
+    extends DSLActivitySpec<PARAMS>,
+        DSLWorkflowStepBase {
+    type: 'activity';
 }
 
 export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
-    type: "workflow";
+    type: 'workflow';
     // the workflow endpoint to run
     name: string;
     /**
      * The parameters to pass to the child workflow.
      * These parameters will be merged over the parent workflow vars and passed altogether to the child workflow.
      */
-    vars?: Record<string, any>;
+    vars?: Record<string, unknown>;
     // whether or not to wait for the workflow to finish.
     // default is false. (the parent workflow will await for the workflow to finish)
     async?: boolean;
@@ -221,14 +227,14 @@ export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
      * The child workflow will only execute if the condition is satisfied.
      * Example: {$eq: {wfVarName: value}}
      */
-    condition?: Record<string, any>;
+    condition?: Record<string, unknown>;
     /**
      * In case the dslWorkflow is used as a child workflow the spec is used to define the child workflow.
      * If spec is defined then the name must be "dslWorkflow"
      */
     spec?: DSLWorkflowSpec;
     options?: {
-        memo?: Record<string, any>;
+        memo?: Record<string, unknown>;
         retry?: DSLRetryPolicy;
         searchAttributes?: WorkflowSearchAttributes;
         taskQueue?: string;
@@ -242,9 +248,12 @@ export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
         //cancellationType
         //versioningIntent
         //workflowIdReusePolicy
-    }
+    };
 }
 
+/**
+ * @discriminator type
+ */
 export type DSLWorkflowStep = DSLActivityStep | DSLChildWorkflowStep;
 
 export interface DSLWorkflowSpecBase {
@@ -260,7 +269,7 @@ export interface DSLWorkflowSpecBase {
 
     // a dictionary of vars to initialize the workflow execution vars
     // Initial vars cannot contains references to other vars
-    vars: Record<string, any>;
+    vars: Record<string, unknown>;
     // activity options that apply to all activities within the workflow
     options?: DSLActivityOptions;
     // the name of the variable that will hold the workflow result
@@ -270,6 +279,7 @@ export interface DSLWorkflowSpecBase {
 }
 
 export interface DSLWorkflowSpecWithSteps extends DSLWorkflowSpecBase {
+    spec_format: 'steps';
     steps: DSLWorkflowStep[];
     /**
      * @deprecated use steps instead
@@ -281,6 +291,7 @@ export interface DSLWorkflowSpecWithSteps extends DSLWorkflowSpecBase {
  * @deprecated use steps instead
  */
 export interface DSLWorkflowSpecWithActivities extends DSLWorkflowSpecBase {
+    spec_format: 'activities';
     steps?: never;
     /**
      * @deprecated use steps instead
@@ -293,15 +304,29 @@ export interface DSLWorkflowSpecWithActivities extends DSLWorkflowSpecBase {
  * steps was added after activities and may contain a mix of activities and other tasks like exec child workflows.
  * For backward compatibility we keep the activities field as a fallback but one should use one or the other not both.
  */
+/**
+ * @discriminator spec_format
+ */
 export type DSLWorkflowSpec = DSLWorkflowSpecWithSteps | DSLWorkflowSpecWithActivities;
 
+export function withDSLWorkflowSpecDiscriminator(spec: DSLWorkflowSpecBase): DSLWorkflowSpec {
+    if ('steps' in spec && spec.steps) {
+        return { ...spec, spec_format: 'steps' } as DSLWorkflowSpecWithSteps;
+    }
+    return { ...spec, spec_format: 'activities' } as DSLWorkflowSpecWithActivities;
+}
+
 export interface DSLWorkflowDefinition extends BaseObject, DSLWorkflowSpecBase {
     // an optional JSON schema to describe the input vars of the workflow.
-    input_schema?: Record<string, any>;
+    input_schema?: Record<string, unknown>;
     activities?: DSLActivitySpec[];
     steps?: DSLWorkflowStep[];
 }
 
+export interface DSLWorkflowDefinitionResponse extends DSLWorkflowDefinition {
+    spec_format: 'steps' | 'activities';
+}
+
 export interface WorkflowDefinitionRef {
     id: string;
     name: string;
@@ -311,13 +336,13 @@ export interface WorkflowDefinitionRef {
     updated_at: Date;
 }
 
-export const WorkflowDefinitionRefPopulate = "id name description tags created_at updated_at"
+export const WorkflowDefinitionRefPopulate = 'id name description tags created_at updated_at';
 
 /**
  * Payload sent to a remote activity endpoint on a tool server.
  * This is POSTed by the `executeRemoteActivity` bridge activity.
  */
-export interface RemoteActivityExecutionPayload<ParamsT extends Record<string, any> = Record<string, any>> {
+export interface RemoteActivityExecutionPayload<ParamsT extends object = Record<string, unknown>> {
     /** The activity name (unprefixed, as known by the tool server) */
     activity_name: string;
     /** The resolved activity parameters */
@@ -331,7 +356,7 @@ export interface RemoteActivityExecutionPayload<ParamsT extends Record<string, a
  */
 export interface RemoteActivityExecutionResponse {
     /** The result data (stored into workflow vars via the step's `output` field) */
-    result: any;
+    result: unknown;
     /** Whether the execution failed */
     is_error?: boolean;
     /** Error message if is_error is true */

package/src/store/hive-memory.ts

@@ -1,4 +1,4 @@
-import { BaseObject } from "./common.js";
+import type { BaseObject } from './common.js';
 
 /**
  * Tool recommendation within a hive memory unit
@@ -18,8 +18,8 @@ export type HiveMemoryScope = 'project' | 'account';
  */
 export interface HiveMemoryItem extends BaseObject {
     // Classification
-    task_category: string;  // "document-analysis", "data-extraction", etc.
-    domain?: string;        // "financial", "legal", etc.
+    task_category: string; // "document-analysis", "data-extraction", etc.
+    domain?: string; // "financial", "legal", etc.
 
     // Summary
     summary: string;
@@ -28,10 +28,10 @@ export interface HiveMemoryItem extends BaseObject {
     tools_involved: string[];
 
     // Quality metrics
-    confidence_score: number;     // 0-1
+    confidence_score: number; // 0-1
     usage_count: number;
-    success_correlation: number;  // correlation with successful runs
-    contribution_count: number;   // number of runs that contributed
+    success_correlation: number; // correlation with successful runs
+    contribution_count: number; // number of runs that contributed
 
     // Scoping
     scope: HiveMemoryScope;
@@ -129,18 +129,18 @@ export interface UpdateHiveMemoryPayload {
  */
 export interface HiveMemorySearchParams {
     // Semantic search
-    query?: string;              // Natural language query
-    embedding?: number[];        // Pre-computed embedding for vector search
+    query?: string; // Natural language query
+    embedding?: number[]; // Pre-computed embedding for vector search
 
     // Filters
     task_category?: string;
     domain?: string;
     tools_involved?: string[];
     scope?: HiveMemoryScope;
-    min_confidence?: number;     // Minimum confidence score (0-1)
+    min_confidence?: number; // Minimum confidence score (0-1)
 
     // Pagination
-    limit?: number;              // Default: 5
+    limit?: number; // Default: 5
     offset?: number;
 }
 

package/src/store/index.ts

@@ -1,17 +1,19 @@
-export * from "./activity-catalog.js";
-export * from "./agent-run.js";
-export * from "./collections.js";
-export * from "./common.js";
-export * from "./conversation-state.js";
-export * from "./doc-analyzer.js";
-export * from "./dsl-workflow.js";
-export * from "./hive-memory.js";
-export * from "./object-types.js";
-export * from "./schedule.js";
-export * from "./signals.js";
-export * from "./store.js";
-export * from "./rendering.js";
-export * from "./temporalio.js";
-export * from "./worker.js";
-export * from "./workflow.js";
-
+export * from './activity-catalog.js';
+export * from './agent-run.js';
+export * from './collections.js';
+export * from './common.js';
+export * from './conversation-state.js';
+export * from './doc-analyzer.js';
+export * from './dsl-workflow.js';
+export * from './hive-memory.js';
+export * from './object-types.js';
+export * from './process.js';
+export * from './process-schema.js';
+export * from './process-validation.js';
+export * from './rendering.js';
+export * from './schedule.js';
+export * from './signals.js';
+export * from './store.js';
+export * from './task.js';
+export * from './temporalio.js';
+export * from './workflow.js';

package/src/store/ms.d.ts

@@ -1,11 +1,42 @@
 /**
  * Types for the `ms` package (version 3.0.0-canary.1)
  */
-declare module "ms" {
-    declare type Unit = 'Years' | 'Year' | 'Yrs' | 'Yr' | 'Y' | 'Weeks' | 'Week' | 'W' | 'Days' | 'Day' | 'D' | 'Hours' | 'Hour' | 'Hrs' | 'Hr' | 'H' | 'Minutes' | 'Minute' | 'Mins' | 'Min' | 'M' | 'Seconds' | 'Second' | 'Secs' | 'Sec' | 's' | 'Milliseconds' | 'Millisecond' | 'Msecs' | 'Msec' | 'Ms';
+declare module 'ms' {
+    declare type Unit =
+        | 'Years'
+        | 'Year'
+        | 'Yrs'
+        | 'Yr'
+        | 'Y'
+        | 'Weeks'
+        | 'Week'
+        | 'W'
+        | 'Days'
+        | 'Day'
+        | 'D'
+        | 'Hours'
+        | 'Hour'
+        | 'Hrs'
+        | 'Hr'
+        | 'H'
+        | 'Minutes'
+        | 'Minute'
+        | 'Mins'
+        | 'Min'
+        | 'M'
+        | 'Seconds'
+        | 'Second'
+        | 'Secs'
+        | 'Sec'
+        | 's'
+        | 'Milliseconds'
+        | 'Millisecond'
+        | 'Msecs'
+        | 'Msec'
+        | 'Ms';
     declare type UnitAnyCase = Unit | Uppercase<Unit> | Lowercase<Unit>;
     export declare type StringValue = `${number}` | `${number}${UnitAnyCase}` | `${number} ${UnitAnyCase}`;
     declare function ms(value: StringValue, options?: Options): number;
     declare function ms(value: number, options?: Options): string;
     export default ms;
-}
+}