@vertesia/common 1.0.0-dev.20260203.130115Z → 1.0.0-dev.20260225.024852Z

package/lib/types/store/conversation-state.d.ts

@@ -0,0 +1,132 @@
+import { CompletionResult, ExecutionTokenUsage, StatelessExecutionOptions, ToolUse } from "@llumiverse/common";
+import { ConversationStripOptions, ResolvedInteractionExecutionInfo, UserChannel } from "../interaction.js";
+import { ExecutionRunDocRef } from "../runs.js";
+import { Plan, WorkflowAncestor } from "./workflow.js";
+/**
+ * Lightweight tool reference for activity payloads.
+ * References tools stored in GCP instead of embedding full tool definitions.
+ */
+export interface ToolReference {
+    storage_key: string;
+    tool_count: number;
+    stored_at: string;
+}
+/**
+ * Conversation state passed between workflow activities.
+ * Contains all context needed to continue a multi-turn agent conversation.
+ */
+export interface ConversationState {
+    /**
+     * A reference to the run that started the conversation
+     */
+    run: ExecutionRunDocRef;
+    /**
+     * The execution environment with provider info for LLM calls.
+     */
+    environment: string;
+    /**
+     * The options to use on the next call.
+     */
+    options: StatelessExecutionOptions;
+    /**
+     * The tools to call next.
+     */
+    tool_use?: ToolUse[];
+    /**
+     * The output of the this conversation step
+     */
+    output: CompletionResult[];
+    /**
+     * The token usage of the this conversation step
+     */
+    token_usage?: ExecutionTokenUsage;
+    /** If a sub workflow execution, contains the parent's info */
+    parent?: WorkflowAncestor;
+    /** Full ancestry chain from root to immediate parent (for hierarchical aggregation) */
+    ancestors: WorkflowAncestor[];
+    /** If part of a larger agentic workflow, task id of this task */
+    task_id?: string;
+    /** Stores the most recent plan for reference by plan-related tools */
+    plan?: Plan;
+    /** Debug mode (more logs and persisted artifacts) */
+    debug?: boolean;
+    /**
+     * Configuration for stripping large data from conversation history.
+     * Passed to llumiverse ExecutionOptions.stripImagesAfterTurns.
+     */
+    strip_options?: ConversationStripOptions;
+    /** Conversation artifacts base url */
+    conversation_artifacts_base_url?: string;
+    /** Reference to tools stored in GCP instead of embedding full tool definitions */
+    tool_reference?: ToolReference;
+    /** Names of currently active tools (base + unlocked). Tool definitions loaded from tool_reference. */
+    active_tool_names?: string[];
+    /** Skills that have been used in this conversation (for auto-syncing scripts and package installation) */
+    used_skills?: UsedSkill[];
+    /** All available skills from registered tool collections (for upfront hydration in sandbox) */
+    available_skills?: AvailableSkill[];
+    /** Whether to stream LLM responses to Redis (cached from project config) */
+    streaming_enabled?: boolean;
+    /**
+     * Active communication channels with their current state.
+     * Channels can be updated as conversation progresses (e.g., email threading info).
+     */
+    user_channels?: UserChannel[];
+    /**
+     * The resolved interaction execution info.
+     * Contains interaction ID, name, version, and environment details.
+     */
+    resolvedInteraction?: ResolvedInteractionExecutionInfo;
+    /**
+     * End conversation metadata set when end_conversation tool is called.
+     * Signals the workflow to terminate gracefully.
+     */
+    end_conversation?: {
+        final_result?: string;
+        status?: 'success' | 'failure';
+        reason?: string;
+    };
+    /**
+     * Tools that have been unlocked by skills during the conversation.
+     * These tools were initially hidden (default: false) but became available
+     * when a skill with related_tools was called.
+     */
+    unlocked_tools?: string[];
+    /**
+     * Activity ID from the latest LLM call (for deduplication with streamed content).
+     * Set by streamToRedis when completing async activities.
+     */
+    latest_activity_id?: string;
+    /**
+     * Mapping of skill names to their related tools.
+     * When a skill is called, its related tools are added to unlocked_tools.
+     */
+    skill_tool_map?: Record<string, string[]>;
+    /**
+     * Current activity group ID for internal tool-execution progress messages.
+     * All updates emitted during one tool-execution cycle should share this ID.
+     */
+    active_activity_group_id?: string;
+    /** LLM stop reason from the latest call (e.g., "stop", "length", "tool_use") */
+    finish_reason?: string;
+}
+/** Skill metadata collected at workflow start for upfront sandbox hydration */
+export interface AvailableSkill {
+    /** Skill name (e.g., "analyze_data") - without the "learn_" prefix */
+    name: string;
+    /** Source URL of the skill collection (e.g., "https://tools.vertesia.io/api/skills/data-analysis") */
+    src: string;
+}
+/** Skill metadata tracked when a skill is used */
+export interface UsedSkill {
+    /** Skill name (e.g., "analyze_data") */
+    name: string;
+    /** Source URL of the skill collection (e.g., "https://tools.vertesia.io/api/skills/data-analysis") */
+    src: string;
+    /** Programming language (e.g., "python") */
+    language?: string;
+    /** Required packages (e.g., ["pandas", "numpy"]) */
+    packages?: string[];
+    /** System-level packages to install via sudo apt-get (e.g., ["poppler-utils"]) */
+    system_packages?: string[];
+}

package/lib/types/store/conversation-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conversation-state.d.ts","sourceRoot":"","sources":["../../../src/store/conversation-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC/G,OAAO,EAAE,wBAAwB,EAAE,gCAAgC,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,GAAG,EAAE,kBAAkB,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,yBAAyB,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAElC,8DAA8D;IAC9D,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B,uFAAuF;IACvF,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAE9B,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,sEAAsE;IACtE,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,qDAAqD;IACrD,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,aAAa,CAAC,EAAE,wBAAwB,CAAC;IAEzC,sCAAsC;IACtC,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC,kFAAkF;IAClF,cAAc,CAAC,EAAE,aAAa,CAAC;IAE/B,sGAAsG;IACtG,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B,0GAA0G;IAC1G,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC;IAE1B,+FAA+F;IAC/F,gBAAgB,CAAC,EAAE,cAAc,EAAE,CAAC;IAEpC,4EAA4E;IAC5E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,EAAE,CAAC;IAE9B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,gCAAgC,CAAC;IAEvD;;;OAGG;IACH,gBAAgB,CAAC,EAAE;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IAEF;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAE1C;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC,gFAAgF;IAChF,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,+EAA+E;AAC/E,MAAM,WAAW,cAAc;IAC3B,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,sGAAsG;IACtG,GAAG,EAAE,MAAM,CAAC;CACf;AAED,kDAAkD;AAClD,MAAM,WAAW,SAAS;IACtB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,sGAAsG;IACtG,GAAG,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kFAAkF;IAClF,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B"}

package/lib/types/store/doc-analyzer.d.ts

@@ -0,0 +1,140 @@
+import { WorkflowExecutionPayload, WorkflowRunStatus } from "./workflow.js";
+export interface PdfToRichtextOptions {
+    features?: string[];
+    debug?: boolean;
+    [key: string]: any;
+}
+export interface PdfToRichTextWorkflowPayload extends Omit<WorkflowExecutionPayload, "vars"> {
+    vars: PdfToRichtextOptions;
+}
+/**
+ * Represents a image in a document that has been analyzed
+ */
+export interface DocImage {
+    id?: string;
+    page_number?: number;
+    description?: string;
+    is_meaningful?: boolean;
+    width?: number;
+    height?: number;
+}
+/**
+ * The export type formats for tables.
+ */
+export type ExportTableFormats = 'json' | 'csv' | 'xml';
+/**
+ * Represents a table in a document that has been analyzed
+ */
+export interface DocTable {
+    page_number?: number;
+    table_number?: number;
+    title?: string;
+    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";
+    title?: string;
+    data: string;
+}
+/**
+ * Represents a table in a document that has been analyzed in JSON format
+ */
+export interface DocTableJson extends DocTable {
+    format: "application/json";
+    title?: string;
+    data: Object[];
+}
+/**
+ * Output format for document processing workflows
+ */
+export type DocProcessorOutputFormat = "xml" | "markdown";
+/**
+ * Represents a document analysis run status
+ */
+export interface DocAnalyzeRunStatusResponse extends WorkflowRunStatus {
+    progress?: DocAnalyzerProgress;
+    /** The output format being used for processing (markdown or xml) */
+    output_format?: DocProcessorOutputFormat;
+}
+export interface DocAnalyzerResultResponse {
+    document?: string;
+    tables?: DocTableCsv[] | DocTableJson[];
+    images?: DocImage[];
+    annotated?: string | null;
+}
+export interface DocAnalyzerProgress {
+    pages: DocAnalyzerProgressStatus;
+    images: DocAnalyzerProgressStatus;
+    tables: DocAnalyzerProgressStatus;
+    visuals: DocAnalyzerProgressStatus;
+    started_at?: number;
+    percent: number;
+    /** The output format being used for processing (markdown or xml) */
+    output_format?: DocProcessorOutputFormat;
+}
+interface DocAnalyzerProgressStatus {
+    total: number;
+    processed: number;
+    success: number;
+    failed: number;
+}
+/**
+ * Adapt Tables Parameters, part of the request
+ */
+export interface AdaptTablesParams {
+    /**
+     * JSON Schema to to convert the table into
+     */
+    target_schema: string;
+    /**
+     * Natural language description of the type item the table are composed of
+     */
+    item_name: string;
+    /**
+     * Natural language description of the type of table or item to convert
+     */
+    instructions?: string;
+    /**
+     * Format to return the data in (csv, json)
+     */
+    format?: "csv" | "json";
+    /**
+     * Process the table as a whole or by page
+     */
+    process_as?: "page" | "table";
+    /**
+     * Process the table as a CSV file
+     */
+    process_as_csv?: boolean;
+}
+interface DocAnalyzerRequestBase {
+    synchronous?: boolean;
+    notify_endpoints?: string[];
+    /**
+     * What environment to use to run the request
+     * If none specified the project embedded environment will be used
+     */
+    environment?: string;
+}
+export interface AdaptTablesRequest extends DocAnalyzerRequestBase, AdaptTablesParams {
+}
+/**
+ * Get Adapted Tables Request
+ * @param raw If true, the raw data will be returned
+ * @param format The format to return the data in (csv, json)
+ */
+export interface GetAdaptedTablesRequestQuery {
+    raw?: boolean;
+    format: "csv" | "json";
+}
+/**
+ * The adapted table result format
+ */
+export interface AdaptedTable {
+    comment?: string;
+    data: Record<string, any>[];
+}
+export {};

package/lib/types/store/doc-analyzer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-analyzer.d.ts","sourceRoot":"","sources":["../../../src/store/doc-analyzer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAE5E,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED,MAAM,WAAW,4BAA6B,SAAQ,IAAI,CAAC,wBAAwB,EAAE,MAAM,CAAC;IACxF,IAAI,EAAE,oBAAoB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IACzC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC1C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,KAAK,GAAG,UAAU,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IAClE,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,oEAAoE;IACpE,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C;AAED,MAAM,WAAW,yBAAyB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,CAAC;IACxC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,yBAAyB,CAAC;IACjC,MAAM,EAAE,yBAAyB,CAAC;IAClC,MAAM,EAAE,yBAAyB,CAAC;IAClC,OAAO,EAAE,yBAAyB,CAAC;IACnC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,aAAa,CAAC,EAAE,wBAAwB,CAAC;CAC5C;AAED,UAAU,yBAAyB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,UAAU,sBAAsB;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAmB,SAAQ,sBAAsB,EAAE,iBAAiB;CAAG;AAExF;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;CAC1B;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;CAC/B"}

package/lib/types/store/dsl-workflow.d.ts

@@ -0,0 +1,272 @@
+import { StringValue } from "ms";
+import { BaseObject } from "./common.js";
+import { WorkflowExecutionPayload } from "./index.js";
+import { ParentClosePolicyType } from "./temporalio.js";
+/**
+ * Discriminator for workflow input type - either object IDs or GCS file URIs
+ */
+export type WorkflowInputType = 'objectIds' | 'files';
+/**
+ * File reference with URL and mimetype
+ */
+export interface WorkflowInputFile {
+    url: string;
+    mimetype: string;
+}
+/**
+ * Discriminated union for workflow inputs.
+ * Workflows can accept either a list of object IDs (existing behavior) OR a list of file references (new).
+ */
+export type WorkflowInput = {
+    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 {
+    /**
+     * 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.
+     */
+    workflow: DSLWorkflowSpec;
+}
+/**
+ * The payload for a DSL activity options.
+ *
+ * @see ActivityOptions in @temporalio/common
+ */
+export interface DSLActivityOptions {
+    startToCloseTimeout?: StringValue | number;
+    scheduleToStartTimeout?: StringValue | number;
+    scheduleToCloseTimeout?: StringValue | number;
+    retry?: DSLRetryPolicy;
+}
+/**
+ * The payload for a DSL retry policy.
+ *
+ * @see RetryPolicy in @temporalio/common
+ */
+export interface DSLRetryPolicy {
+    backoffCoefficient?: number;
+    initialInterval?: StringValue | number;
+    maximumAttempts?: number;
+    maximumInterval?: StringValue | number;
+    nonRetryableErrorTypes?: string[];
+}
+/**
+ * The payload for a DSL activity execution.
+ */
+export interface DSLActivityExecutionPayload<ParamsT extends Record<string, any>> extends WorkflowExecutionPayload {
+    activity: DSLActivitySpec;
+    params: ParamsT;
+    workflow_name: string;
+    debug_mode?: boolean;
+}
+export type ImportSpec = (string | Record<string, string>)[];
+export interface ActivityFetchSpec {
+    /**
+     * The data provider name
+     */
+    type: "document" | "document_type" | "interaction_run";
+    /**
+     * An optional URI to the data source.
+     */
+    source?: string;
+    /**
+     * The query to be executed by the data provider
+     */
+    query: Record<string, any>;
+    /**
+     * a string of space separated field names.
+     * Prefix a field name with "-" to exclude it from the result.
+     */
+    select?: string;
+    /**
+     * The number of results to return. If the result is limited to 1 the result will be a single object
+     */
+    limit?: number;
+    /**
+     * How to handle not found objects.
+     * 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";
+}
+export interface DSLWorkflowStepBase {
+    /**
+     * The type fo the step.
+     * If not set defaults to "activity"
+     */
+    type: "activity" | "workflow";
+}
+export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<string, any>> {
+    /**
+     * The name of the activity function
+     */
+    name: string;
+    /**
+     * Title of the activity to be displayed in the UI workflow builder
+     */
+    title?: string;
+    /**
+     * The description of the activity to e displayed in the UI workflow builder
+     */
+    description?: string;
+    /**
+     * Activities parameters. These parameters can be either literals
+     * (hardcoded strings, numbers, booleans, objects, arrays etc.), either
+     * references to the workflow variables.
+     * The workflow variables are built from the workflow params (e.g. the workflow configuration)
+     * and from the result of the previous activities.
+     */
+    params?: PARAMS;
+    /**
+     * The name of the workflow variable that will store the result of the activity
+     * If not specified the result will not be stored
+     * The parameters describe how the actual parameters will be obtained from the workflow execution vars.
+     * since it may contain references to workflow execution vars.
+     */
+    output?: string;
+    /**
+     * A JSON expression which evaluate to true or false similar to mongo matches.
+     * We support for now basic expression like: $true, $false, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $regexp
+     * {$eq: {name: value}},
+     * Ex: {$eq: {wfVarName: value}}
+     */
+    condition?: Record<string, any>;
+    /**
+     * The import spec is used to import data from workflow variables.
+     * The import spec is a list of variable names to import from the workflow context.
+     * You can also use objects to rename the imported variables, or to reference an expression.
+     * Example:
+     * ["runId", {"typeId": "docType.id"}]
+     */
+    import?: ImportSpec;
+    /**
+     * The fetch phase is used to fetch data from external sources.
+     */
+    fetch?: Record<string, ActivityFetchSpec>;
+    /**
+     * Projection to apply to the result. Not all activities support this.
+     */
+    projection?: never | Record<string, any>;
+    /**
+     * If true the activity will be executed in parallel with the other activities.
+     * (i.e. the workflow will not wait for the activity to finish before starting the next one)
+     */
+    parallel?: boolean;
+    /**
+     * Await for a parallel activity execution to return.
+     */
+    await?: string;
+    /**
+     * Activity options for configuring the activity execution, which overrides the activity options
+     * defined at workflow level.
+     */
+    options?: DSLActivityOptions;
+}
+export interface DSLActivityStep<PARAMS extends Record<string, any> = Record<string, any>> extends DSLActivitySpec<PARAMS>, DSLWorkflowStepBase {
+    type: "activity";
+}
+export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
+    type: "workflow";
+    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>;
+    async?: boolean;
+    /**
+     * The name of the workflow variable that will store the result of the child workflow (if async the workflow id is stored)
+     * If not specified the result will not be stored
+     * The parameters describe how the actual parameters will be obtained from the workflow execution vars.
+     * since it may contain references to workflow execution vars.
+     */
+    output?: string;
+    /**
+     * A JSON expression which evaluates to true or false similar to mongo matches.
+     * The child workflow will only execute if the condition is satisfied.
+     * Example: {$eq: {wfVarName: value}}
+     */
+    condition?: Record<string, any>;
+    /**
+     * 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;
+    /**
+     * If true, copy the parent's workspace artifacts (scripts/, files/, skills/, docs/, out/)
+     * to the child workflow's agent space before execution. Defaults to true.
+     * conversation.json and tools.json are never copied.
+     */
+    inherit_artifacts?: boolean;
+    options?: {
+        memo?: Record<string, any>;
+        retry?: DSLRetryPolicy;
+        searchAttributes?: Record<string, string[] | number[] | boolean[] | Date[]>;
+        taskQueue?: string;
+        workflowExecutionTimeout?: StringValue | number;
+        workflowRunTimeout?: StringValue | number;
+        workflowTaskTimeout?: StringValue | number;
+        workflowId?: string;
+        cronSchedule?: string;
+        parentClosePolicy?: ParentClosePolicyType;
+    };
+}
+export type DSLWorkflowStep = DSLActivityStep | DSLChildWorkflowStep;
+export interface DSLWorkflowSpecBase {
+    name: string;
+    description?: string;
+    tags?: string[];
+    steps?: DSLWorkflowStep[] | never;
+    /**
+     * @deprecated use steps instead
+     */
+    activities?: DSLActivitySpec[] | never;
+    vars: Record<string, any>;
+    options?: DSLActivityOptions;
+    result?: string;
+    debug_mode?: boolean;
+}
+export interface DSLWorkflowSpecWithSteps extends DSLWorkflowSpecBase {
+    steps: DSLWorkflowStep[];
+    /**
+     * @deprecated use steps instead
+     */
+    activities?: never;
+}
+/**
+ * @deprecated use steps instead
+ */
+export interface DSLWorkflowSpecWithActivities extends DSLWorkflowSpecBase {
+    steps?: never;
+    /**
+     * @deprecated use steps instead
+     */
+    activities: DSLActivitySpec[];
+}
+/**
+ * activities and steps fields are mutually exclusive
+ * 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.
+ */
+export type DSLWorkflowSpec = DSLWorkflowSpecWithSteps | DSLWorkflowSpecWithActivities;
+export interface DSLWorkflowDefinition extends BaseObject, DSLWorkflowSpecBase {
+    input_schema?: Record<string, any>;
+    activities?: DSLActivitySpec[];
+    steps?: DSLWorkflowStep[];
+}
+export interface WorkflowDefinitionRef {
+    id: string;
+    name: string;
+    description?: string;
+    tags?: string[];
+    created_at: Date;
+    updated_at: Date;
+}
+export declare const WorkflowDefinitionRefPopulate = "id name description tags created_at updated_at";

package/lib/types/store/dsl-workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dsl-workflow.d.ts","sourceRoot":"","sources":["../../../src/store/dsl-workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,OAAO,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GACnB;IAAE,SAAS,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,MAAM,EAAE,CAAA;CAAE,GAC/C;IAAE,SAAS,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,iBAAiB,EAAE,CAAA;CAAE,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,wBAAwB;IACzE;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,mBAAmB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC3C,sBAAsB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC9C,sBAAsB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IAC9C,KAAK,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;IACvC,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,wBAAwB;IAC9G,QAAQ,EAAE,eAAe,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAGD,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;AAC7D,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,IAAI,EAAE,UAAU,GAAG,eAAe,GAAG,iBAAiB,CAAC;IACvD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;CACjC;AAED,MAAM,WAAW,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACrF;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAGzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAChC;AAED,MAAM,WAAW,eAAe,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAE,SAAQ,eAAe,CAAC,MAAM,CAAC,EAAE,mBAAmB;IAC3I,IAAI,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAG3B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC;;;OAGG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC3B,KAAK,CAAC,EAAE,cAAc,CAAC;QACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAC5E,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,wBAAwB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAChD,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAC1C,mBAAmB,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;KAK7C,CAAA;CACJ;AAED,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG,oBAAoB,CAAC;AAErE,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB,KAAK,CAAC,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAIvC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAG7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACjE,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACtE,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,eAAe,EAAE,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,wBAAwB,GAAG,6BAA6B,CAAC;AAEvF,MAAM,WAAW,qBAAsB,SAAQ,UAAU,EAAE,mBAAmB;IAE1E,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACnC,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,KAAK,CAAC,EAAE,eAAe,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;CACpB;AAED,eAAO,MAAM,6BAA6B,mDAAmD,CAAA"}

package/lib/types/store/hive-memory.d.ts

@@ -0,0 +1,116 @@
+import { BaseObject } from "./common.js";
+/**
+ * Tool recommendation within a hive memory unit
+ */
+export interface HiveMemoryToolRecommendation {
+    tool_name: string;
+    guidance: string;
+}
+/**
+ * Memory unit scope - project-scoped by default, can be elevated to account
+ */
+export type HiveMemoryScope = 'project' | 'account';
+/**
+ * Base interface for hive memory items (list/summary view)
+ */
+export interface HiveMemoryItem extends BaseObject {
+    task_category: string;
+    domain?: string;
+    summary: string;
+    tools_involved: string[];
+    confidence_score: number;
+    usage_count: number;
+    success_correlation: number;
+    contribution_count: number;
+    scope: HiveMemoryScope;
+}
+/**
+ * Full hive memory unit with all learnings and patterns
+ */
+export interface HiveMemory extends HiveMemoryItem {
+    objective_patterns: string[];
+    general_learnings: string[];
+    best_practices: string[];
+    pitfalls_to_avoid: string[];
+    tool_recommendations: HiveMemoryToolRecommendation[];
+    embedding?: number[];
+    security?: Record<string, string[]>;
+}
+/**
+ * Payload for creating a new hive memory unit
+ */
+export interface CreateHiveMemoryPayload {
+    task_category: string;
+    domain?: string;
+    summary: string;
+    objective_patterns: string[];
+    general_learnings: string[];
+    best_practices?: string[];
+    pitfalls_to_avoid?: string[];
+    tool_recommendations?: HiveMemoryToolRecommendation[];
+    tools_involved?: string[];
+    confidence_score?: number;
+    scope?: HiveMemoryScope;
+    name?: string;
+    description?: string;
+    tags?: string[];
+}
+/**
+ * Payload for updating an existing hive memory unit
+ */
+export interface UpdateHiveMemoryPayload {
+    task_category?: string;
+    domain?: string;
+    summary?: string;
+    add_objective_patterns?: string[];
+    add_general_learnings?: string[];
+    add_best_practices?: string[];
+    add_pitfalls_to_avoid?: string[];
+    add_tool_recommendations?: HiveMemoryToolRecommendation[];
+    add_tools_involved?: string[];
+    confidence_score?: number;
+    increment_usage_count?: boolean;
+    increment_contribution_count?: boolean;
+    success_correlation?: number;
+    scope?: HiveMemoryScope;
+    name?: string;
+    description?: string;
+    tags?: string[];
+}
+/**
+ * Search parameters for finding relevant memories
+ */
+export interface HiveMemorySearchParams {
+    query?: string;
+    embedding?: number[];
+    task_category?: string;
+    domain?: string;
+    tools_involved?: string[];
+    scope?: HiveMemoryScope;
+    min_confidence?: number;
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Response from memory search
+ */
+export interface HiveMemorySearchResult {
+    memories: HiveMemory[];
+    total: number;
+}
+/**
+ * Formatted memory for agent consumption
+ */
+export interface FormattedMemoryForAgent {
+    category: string;
+    domain?: string;
+    summary: string;
+    learnings: string[];
+    best_practices: string[];
+    pitfalls_to_avoid: string[];
+    tool_guidance: {
+        tool: string;
+        guidance: string;
+    }[];
+    confidence: number;
+}