@vertesia/common 0.51.0 → 0.54.0

package/src/store/activity-catalog.ts

@@ -1,4 +1,4 @@
-export type TsPropType = "string" | "number" | "boolean" | "record" | "object" | "array" | "enum" | "literal" | "union" | "promise" | "any";
+export type TsPropType = "string" | "number" | "boolean" | "record" | "object" | "array" | "enum" | "literal" | "union" | "promise" | "any" | "void";
 
 // generic types are replaced by "any"
 export interface ActivityTypeDefinition {
@@ -12,7 +12,7 @@ export interface ActivityTypeDefinition {
     value: string | boolean | number | null;
     // in case of objects
     members?: ActivityPropertyDefinition[];
-    // in case of arrays or promises will be innertype (i.e. the element type for arrays)
+    // in case of arrays or promises will be innerType (i.e. the element type for arrays)
     innerType?: ActivityTypeDefinition;
     // in case of enums the enum values will be here
     enum?: string[] | number[] | undefined;

package/src/store/agent.ts

@@ -1,6 +1,6 @@
 export interface CreateAgentDeploymentRequest {
     /**
-     * The agent ID is composed from the agent organization and the agen name, separated by a slash.
+     * The agent ID is composed from the agent organization and the agent name, separated by a slash.
      * Example: vertesia/docgen-agent
      */
     agentId: string;

package/src/store/collections.ts

@@ -2,8 +2,8 @@ import { BaseObject } from "./common.js";
 import { ColumnLayout, ContentObjectTypeRef } from "./store.js";
 
 export enum CollectionStatus {
-    active = 'active',
-    archived = 'archived'
+    active = "active",
+    archived = "archived",
 }
 
 export interface CreateCollectionPayload {
@@ -16,13 +16,14 @@ export interface CreateCollectionPayload {
     properties?: Record<string, any>;
     parent?: string | null;
     table_layout?: ColumnLayout[] | null;
+    allowed_types?: string[];
 }
 
 export interface CollectionItem extends BaseObject {
     /**
      * A flag to indicate if the collection is dynamic or static.
      * If the collection is dynamic, the members are determined by a query using the query field.
-     * Id the collection is static, the members are explicitly defined jusing the members array.
+     * If the collection is static, the members are explicitly defined using the members array.
      */
     dynamic: boolean;
     status: CollectionStatus;
@@ -37,6 +38,11 @@ export interface CollectionItem extends BaseObject {
      * The layout defined in the type could serve as a fallback if not defined here.
      */
     table_layout?: ColumnLayout[];
+
+    /**
+     * The allowed types for the collection.
+     */
+    allowed_types?: string[];
 }
 
 export interface Collection extends CollectionItem {

package/src/store/common.ts

@@ -1,10 +1,30 @@
+/**
+ * Base interface for all domain objects in the system.
+ * Provides common properties shared across all business entities.
+ */
 export interface BaseObject {
+    /** Unique identifier for the object */
     id: string;
+
+    /** Human-readable name or title */
     name: string;
+
+    /** Optional detailed description of the object */
     description?: string;
+
+    /** Optional array of categorization tags */
     tags?: string[];
+
+    /** Identifier of the user who last modified the object */
     updated_by: string;
+
+    /** Identifier of the user who created the object */
     created_by: string;
+
+    /** ISO timestamp of when the object was created */
     created_at: string;
+
+    /** ISO timestamp of when the object was last updated */
     updated_at: string;
-}
+
+}

package/src/store/doc-analyzer.ts

@@ -1,4 +1,4 @@
-import { WorkflowExecutionPayload, WorkflowExecutionStatus } from "./workflow.js";
+import { WorkflowExecutionPayload, WorkflowRunStatus } from "./workflow.js";
 
 export interface PdfToRichtextOptions {
     features: string[];
@@ -6,9 +6,8 @@ export interface PdfToRichtextOptions {
     [key: string]: any;
 }
 
-
-export interface PdfToRichTextWorkflowParams extends Omit<WorkflowExecutionPayload, "vars"> {
-    vars: PdfToRichtextOptions
+export interface PdfToRichTextWorkflowPayload extends Omit<WorkflowExecutionPayload, "vars"> {
+    vars: PdfToRichtextOptions;
 }
 
 /**
@@ -17,16 +16,17 @@ export interface PdfToRichTextWorkflowParams extends Omit<WorkflowExecutionPaylo
 export interface DocImage {
     id?: string;
     page_number?: number;
-    image_number?: number;
-    title?: string;
-    url?: string;
     description?: string;
     is_meaningful?: boolean;
     width?: number;
     height?: number;
-    path?: string;
 }
 
+/**
+ * The export type formats for tables.
+ */
+export type ExportTableFormats = 'json' | 'csv' | 'xml';
+
 /**
  * Represents a table in a document that has been analyzed
  */
@@ -58,28 +58,22 @@ export interface DocTableJson extends DocTable {
 /**
  * Represents a document analysis run status
  */
-export interface DocAnalyzeRunStatusResponse {
-    workflow_id: string | null;
-    run_id: string | null;
-    status: WorkflowExecutionStatus;
+export interface DocAnalyzeRunStatusResponse extends WorkflowRunStatus {
     progress?: DocAnalyzerProgress;
 }
 
-
 export interface DocAnalyzerResultResponse {
     document?: string;
     tables?: DocTableCsv[] | DocTableJson[];
     images?: DocImage[];
-    parts?: { id: string, title: string }[];
     annotated?: string | null;
 }
 
-
 export interface DocAnalyzerProgress {
-    pages: DocAnalyzerProgressStatus,
-    images: DocAnalyzerProgressStatus,
-    tables: DocAnalyzerProgressStatus,
-    visuals: DocAnalyzerProgressStatus,
+    pages: DocAnalyzerProgressStatus;
+    images: DocAnalyzerProgressStatus;
+    tables: DocAnalyzerProgressStatus;
+    visuals: DocAnalyzerProgressStatus;
     started_at?: number;
     percent: number;
 }
@@ -89,4 +83,70 @@ interface DocAnalyzerProgressStatus {
     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>[];
+}

package/src/store/dsl-workflow.ts

@@ -16,7 +16,7 @@ export interface DSLWorkflowExecutionPayload extends WorkflowExecutionPayload {
 }
 
 /**
- * The payload for a DSL acitivty options.
+ * The payload for a DSL activity options.
  *
  * @see ActivityOptions in @temporalio/common
  */
@@ -58,7 +58,7 @@ export interface ActivityFetchSpec {
      */
     type: "document" | "document_type" | "interaction_run";
     /**
-     * An optinal URI to the data source.
+     * An optional URI to the data source.
      */
     source?: string;
     /**
@@ -72,13 +72,13 @@ export interface ActivityFetchSpec {
     select?: string;
 
     /**
-     * The number of results to return. If the result is limitedto 1 the result will be a single object
+     * 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 objectthrow an error.
+     * 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";
@@ -107,7 +107,7 @@ export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<str
     description?: string;
     /**
      * Activities parameters. These parameters can be either literals
-     * (hardcoded strings, numbers, booleans, obejcts, arrays etc.), either
+     * (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.
@@ -116,14 +116,14 @@ export interface DSLActivitySpec<PARAMS extends Record<string, any> = Record<str
     /**
      * 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 worlkfow execution vars.
+     * 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 fow now basic expreion like: $true, $false, $eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $regexp
+     * 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}}
      */
@@ -186,7 +186,7 @@ export interface DSLChildWorkflowStep extends DSLWorkflowStepBase {
     /**
      * 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 worlkfow execution vars.
+     * 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;
@@ -257,7 +257,7 @@ export interface DSLWorkflowSpecWithActivities extends DSLWorkflowSpecBase {
 }
 
 /**
- * activities and steps fields are mutally exclusive
+ * 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.
  */

package/src/store/index.ts

@@ -8,3 +8,4 @@ export * from "./object-types.js";
 export * from "./store.js";
 export * from "./temporalio.js";
 export * from "./workflow.js";
+export * from "./signals.js";

package/src/store/signals.ts

@@ -0,0 +1,5 @@
+export interface UserInputSignal {
+    message: string;
+    metadata?: Record<string, any>;
+    auth_token?: string;
+}

package/src/store/store.ts

@@ -1,18 +1,17 @@
-import { SearchPayload } from '../payload.js';
-import { SupportedEmbeddingTypes } from '../project.js';
-import { ComplexSearchQuery } from '../query.js';
-import { BaseObject } from './common.js';
-import { RenditionProperties } from './index.js';
+import { SearchPayload } from "../payload.js";
+import { SupportedEmbeddingTypes } from "../project.js";
+import { ComplexSearchQuery } from "../query.js";
+import { BaseObject } from "./common.js";
+import { RenditionProperties } from "./index.js";
 
 export enum ContentObjectStatus {
-    created = 'created',
-    processing = 'processing', // the was created and still processing
-    completed = 'completed',
-    failed = 'failed',
-    archived = 'archived',
+    created = "created",
+    processing = "processing", // the was created and still processing
+    completed = "completed",
+    failed = "failed",
+    archived = "archived",
 }
 
-
 export interface Embedding {
     model: string; //the model used to generate this embedding
     values: number[];
@@ -28,8 +27,7 @@ export interface ContentObject<T = any> extends ContentObjectItem<T> {
     transcript?: Transcript;
 }
 
-
-export type ContentNature = 'video' | 'image' | 'audio' | 'document' | 'code' | 'other';
+export type ContentNature = "video" | "image" | "audio" | "document" | "code" | "other";
 
 export interface Dimensions {
     width: number;
@@ -48,12 +46,10 @@ export interface GenerationRunMetadata {
     target?: string;
 }
 
-
-
 export interface ContentMetadata {
     // Common fields for all media types
     type?: ContentNature;
-    size?: number;      // in bytes
+    size?: number; // in bytes
     languages?: string[];
     location?: Location;
     generation_runs: GenerationRunMetadata[];
@@ -63,25 +59,25 @@ export interface ContentMetadata {
 // Example of type-specific metadata interfaces (optional, for better type safety)
 export interface TemporalMediaMetadata extends ContentMetadata {
     duration?: number; // in seconds
-    transcript?: Transcript
+    transcript?: Transcript;
 }
 
 export interface ImageMetadata extends ContentMetadata {
-    type: 'image';
+    type: "image";
     dimensions?: Dimensions;
 }
 
 export interface AudioMetadata extends TemporalMediaMetadata {
-    type: 'audio';
+    type: "audio";
 }
 
 export interface VideoMetadata extends TemporalMediaMetadata {
-    type: 'video';
+    type: "video";
     dimensions?: Dimensions;
 }
 
 export interface DocumentMetadata extends ContentMetadata {
-    type: 'document';
+    type: "document";
     page_count?: number;
     content_processor?: {
         type?: string;
@@ -91,7 +87,7 @@ export interface DocumentMetadata extends ContentMetadata {
         image_count: number;
         zone_count: number;
         needs_ocr_count?: number;
-    }
+    };
 }
 
 export interface Transcript {
@@ -101,12 +97,12 @@ export interface Transcript {
 }
 
 export interface TranscriptSegment {
-    start: number
-    text: string
-    speaker?: number
-    end?: number
-    language?: string
-    confidence?: number
+    start: number;
+    text: string;
+    speaker?: number;
+    end?: number;
+    confidence?: number;
+    language?: string;
 }
 
 export interface ContentSource {
@@ -120,34 +116,99 @@ export interface ContentSource {
     etag?: string;
 }
 
+/**
+ *
+ */
+export interface RevisionInfo {
+    /** Direct parent revision id (omit on the first revision) */
+    parent?: string;
+
+    /** The root revision id (omit on the first revision) */
+    root: string;
+
+    /** True if this revision is the head revision */
+    head: boolean;
+
+    /** Human‑friendly tag or state ("v1.2", "approved") */
+    label?: string;
+
+    /** Extra parents when two branches are merged (leave undefined until needed) */
+    //merge_parents?: string[]; //maybe later
+
+    /** Pointer to a diff / patch blob if you store deltas instead of full content */
+    //delta_ref?: string;
+}
+
 /**
  * The content object item is a simplified version of the ContentObject that is returned by the store API when listing objects.
  */
-export interface ContentObjectItem<T = any> extends BaseObject {
-    root?: string; // the ID of the root parent object. The root object doesn't have the root field set.
+export interface ContentObjectItem<T = Record<string, any>> extends BaseObject {
     parent: string; // the id of the direct parent object. The root object doesn't have the parent field set.
+
+    /** An optional path based location for the object */
     location: string; // the path of the parent object
+
+    /**
+     * Object status.
+     * - created: the object was created and is being processed
+     * - processing: the object is being processed
+     * - completed: the object was processed and is ready to use
+     * - failed: the object processing failed
+     * - archived: the object was archived and is no longer available
+     */
     status: ContentObjectStatus;
-    // A ref to the object type
+
+    /**
+     * Object type id.
+     */
     type?: ContentObjectTypeRef;
-    // the content source URL and type
+
+    /**
+     * Content source information, typically a link to an object store
+     */
     content: ContentSource;
+
+    /**
+     * External identifier for integration with other systems
+     */
     external_id?: string;
-    properties: T | Record<string, any>; // a JSON object that describes the object
+
+    /** The object properties. This is a JSON object that describes the object, matching the object type schema */
+    properties: T; // a JSON object that describes the object
+
+    /** Technical metadata of the object */
     metadata?: VideoMetadata | AudioMetadata | ImageMetadata | DocumentMetadata | ContentMetadata;
+
+    /** Token information  */
     tokens?: {
         count: number; // the number of tokens in the text
         encoding: string; // the encoding used to calculate the tokens
         etag: string; //the etag of the text used for the token count
     };
+
+    /**
+     * Revision information. This is used to track the history of the object.
+     */
+    revision: RevisionInfo; // the revision info of the object
+
+    /**
+     * Soft delete flag. When true, the object should be considered deleted
+     * but is still retained in the database for historical purposes.
+     */
+    is_deleted?: boolean;
+
+    /**
+     * Soft lock flag. When true, the object should be considered read-only
+     * and modification attempts should be rejected.
+     */
+    is_locked?: boolean;
 }
 
 /**
- * When creating from an uploaded file the content shouild be an URL to the uploaded file
+ * When creating from an uploaded file the content should be an URL to the uploaded file
  */
-export interface CreateContentObjectPayload<T = any> extends Partial<Omit<ContentObject<T>,
-    'id' | 'root' | 'created_at' | 'updated_at' | 'type'
-    | 'owner'>> {
+export interface CreateContentObjectPayload<T = any>
+    extends Partial<Omit<ContentObject<T>, "id" | "root" | "created_at" | "updated_at" | "type" | "owner">> {
     id?: string; // An optional existing object ID to be replaced by the new one
     type?: string; // the object type ID
     generation_run_info?: GenerationRunMetadata;
@@ -158,7 +219,7 @@ export interface ContentObjectTypeRef {
     name: string;
 }
 
-export interface ComplexSearchPayload extends Omit<SearchPayload, 'query'> {
+export interface ComplexSearchPayload extends Omit<SearchPayload, "query"> {
     query?: ComplexSearchQuery;
 }
 
@@ -185,21 +246,28 @@ export interface ColumnLayout {
      */
     default?: any;
 }
-export interface ContentObjectType extends ContentObjectTypeItem {
-    object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
-}
+export interface ContentObjectType extends ContentObjectTypeItem {}
 export interface ContentObjectTypeItem extends BaseObject {
     is_chunkable?: boolean;
+    /**
+     * This is only included in ContentObjectTypeItem if explicitly requested
+     * It is always included in ContentObjectType
+     */
     table_layout?: ColumnLayout[];
+    /**
+     * this is only included in ContentObjectTypeItem if explicitly requested
+     * It is always included in ContentObjectType
+     */
+    object_schema?: Record<string, any>; // an optional JSON schema for the object properties.
 }
 
-export interface CreateContentObjectTypePayload extends Omit<ContentObjectType, 'id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'> {
-}
+export interface CreateContentObjectTypePayload
+    extends Omit<ContentObjectType, "id" | "created_at" | "updated_at" | "created_by" | "updated_by"> {}
 
 export enum WorkflowRuleInputType {
-    single = 'single',
-    multiple = 'multiple',
-    none = 'none'
+    single = "single",
+    multiple = "multiple",
+    none = "none",
 }
 export interface WorkflowRuleItem extends BaseObject {
     // the name of the workflow function
@@ -229,18 +297,16 @@ export interface WorkflowRule extends WorkflowRuleItem {
     customer_override?: boolean;
 }
 
-
 export interface CreateWorkflowRulePayload extends UploadWorkflowRulePayload {
     name: string; // required
     endpoint: string; // required
 }
-export interface UploadWorkflowRulePayload extends Partial<Omit<WorkflowRule, 'id' | 'created_at' | 'updated_at' | 'owner'>> {
-}
+export interface UploadWorkflowRulePayload
+    extends Partial<Omit<WorkflowRule, "id" | "created_at" | "updated_at" | "owner">> {}
 
 export interface GetRenditionResponse {
-
-    status: 'found' | 'generating' | 'failed';
-    rendition?: ContentObject<RenditionProperties> //TODO add <Rendition>
+    status: "found" | "generating" | "failed";
+    rendition?: ContentObject<RenditionProperties>; //TODO add <Rendition>
     workflow_run_id?: string;
 }