@vertesia/common 0.52.0 → 0.54.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertesia/common",
-  "version": "0.52.0",
+  "version": "0.54.0",
   "type": "module",
   "types": "./lib/types/index.d.ts",
   "files": [

package/src/apikey.ts

@@ -64,5 +64,5 @@ export interface AuthTokenPayload {
 export enum PrincipalType {
     User = "user",
     ApiKey = "apikey",
-    ServiceAcount = "service_account",
+    ServiceAccount = "service_account",
 }

package/src/common.ts

@@ -3,6 +3,8 @@ export interface FindPayload {
     offset?: number;
     limit?: number;
     select?: string;
+    show_all_revisions?: boolean;
+    from_root?: string;
 }
 
 

package/src/index.ts

@@ -8,6 +8,7 @@ export * from './integrations.js';
 export * from './interaction.js';
 export * from './meters.js';
 export * from './payload.js';
+export * from "./plugin.js";
 export * from "./Progress.js";
 export * from './project.js';
 export * from './prompt.js';
@@ -21,4 +22,3 @@ export * from './user.js';
 export * from './utils/advanced-content-processing.js';
 export * from './utils/auth.js';
 export * from './utils/schemas.js';
-

package/src/integrations.ts

@@ -18,7 +18,7 @@ export interface AwsConfiguration extends IntegrationConfigurationBase {
     s3_role_arn: string;
 }
 
-export interface MacgicPdfConfiguration extends IntegrationConfigurationBase {
+export interface MagicPdfConfiguration extends IntegrationConfigurationBase {
     // No additional configuration
     default_features?: string[];
     default_zones?: string[];

package/src/interaction.ts

@@ -42,13 +42,13 @@ export interface InteractionEndpointQuery {
 
     /**
      * Filter by interaction endpoint name to include only the specified endpoints
-     * * If both includes and excludes are specified then omly the includes filter will be used.
+     * * If both includes and excludes are specified then only the includes filter will be used.
      */
     includes?: string[];
 
     /**
      * Filter by interaction endpoint name to excludes the specified endpoints.
-     * If both includes and excludes are specified then omly the includes filter will be used.
+     * If both includes and excludes are specified then only the includes filter will be used.
      */
     excludes?: string[];
 
@@ -104,7 +104,7 @@ export interface InteractionRefWithSchema extends Omit<InteractionRef, "prompts"
 
 export interface InteractionsExportPayload {
     /**
-     * The name of the interaction. If not spcified all the interactions in the current project will be exported
+     * The name of the interaction. If not specified all the interactions in the current project will be exported
      */
     name?: string;
     /*
@@ -239,7 +239,7 @@ export interface InteractionForkPayload {
 export interface InteractionExecutionPayload {
     /**
      * If a `@memory` property exists on the input data then the value will be used as the value of a memory pack location.
-     * and the other proerties of the data will contain the memory pack mapping.
+     * and the other properties of the data will contain the memory pack mapping.
      */
     data?: Record<string, any> | `memory:${string}`;
     config?: InteractionExecutionConfiguration;
@@ -336,6 +336,24 @@ export interface AsyncConversationExecutionPayload extends AsyncExecutionPayload
      * Whether to disable the generation of interaction tools or not.
      */
     disable_interaction_tools?: boolean;
+
+    /**
+     * On which scope should the searched by applied, by the search_tool.
+     * Only supports collection scope or null for now.
+     */
+    search_scope?: string;
+
+    /**
+     * The collection in which this workflow is executing
+     */
+    collection_id?: string;
+
+    /**
+     * The token threshold in thousands (K) for creating checkpoints.
+     * If total tokens exceed this value, a checkpoint will be created.
+     * If not specified, default value of 150K tokens will be used.
+     */
+    checkpoint_tokens?: number;
 }
 
 export interface AsyncInteractionExecutionPayload extends AsyncExecutionPayloadBase {
@@ -413,7 +431,7 @@ export interface ExecutionRun<P = any, R = any> {
     /**
      * The parameters used to create the interaction.
      * If the parameters contains the special property "@memory" it will be used
-     * to locate a meory pack and the other properties will be used as the memory pack mapping.
+     * to locate a memory pack and the other properties will be used as the memory pack mapping.
      */
     parameters: P; //params used to create the interaction, only in varies on?
     tags?: string[];

package/src/payload.ts

@@ -1,10 +1,22 @@
-import { FacetSpec } from './facets.js';
-import { ComplexSearchQuery, InteractionSearchQuery, ObjectSearchQuery, ObjectTypeSearchQuery, PromptSearchQuery, RunSearchQuery, SimpleSearchQuery, VectorSearchQuery } from './query.js';
+import { FacetSpec } from "./facets.js";
+import {
+    ComplexSearchQuery,
+    InteractionSearchQuery,
+    ObjectSearchQuery,
+    ObjectTypeSearchQuery,
+    PromptSearchQuery,
+    RunSearchQuery,
+    SimpleSearchQuery,
+    VectorSearchQuery,
+} from "./query.js";
 
 export interface SearchPayload {
     query?: SimpleSearchQuery;
     limit?: number;
     offset?: number;
+    select?: string;
+    show_all_revisions?: boolean;
+    from_root?: string;
 }
 
 export interface ComputeFacetPayload {
@@ -59,4 +71,4 @@ export interface ExportPropertiesResponse {
     type: string;
     name: string;
     data: Blob;
-}
+}

package/src/plugin.ts

@@ -0,0 +1,12 @@
+/**
+ * A vertesia plugin manifest
+ */
+export interface PluginManifest {
+    id: string;
+    src: string;
+    name: string;
+    version: string;
+    publisher: string;
+    description?: string;
+    icon?: string;
+}

package/src/project.ts

@@ -106,6 +106,7 @@ export interface Project {
     account: string;
     configuration: ProjectConfiguration;
     integrations: Map<string, any>;
+    plugins: string[];
     created_by: string,
     updated_by: string,
     created_at: Date;

package/src/prompt.ts

@@ -68,7 +68,7 @@ export interface PromptTemplate {
     inputSchema?: JSONSchema4;
     project: string | ProjectRef; // or projectRef? ObjectIdType;
     // The name of a field in the input data that is of the specified schema and on each the template will iterate.
-    // If not specified then the sceham will define the whole input data
+    // If not specified then the schema will define the whole input data
     tags?: string[];
     // only for drafts - when it was last published
     last_published_at?: Date;

package/src/query.ts

@@ -3,14 +3,14 @@ import { SupportedEmbeddingTypes } from './project.js';
 
 export interface RunListingQueryOptions {
     project?: string;
-    interaction?: string;
+    interaction?: string | string[];
     limit?: number;
     offset?: number;
     filters?: RunListingFilters;
 }
 
 export interface RunListingFilters {
-    interaction?: string,
+    interaction?: string | string[],
     status?: ExecutionRunStatus,
     model?: string,
     environment?: string,
@@ -43,11 +43,12 @@ export interface ObjectSearchQuery extends SimpleSearchQuery {
 }
 
 export interface ObjectTypeSearchQuery extends SimpleSearchQuery {
-    chunckable?: boolean;
+    chunkable?: boolean;
 }
 
 export interface PromptSearchQuery extends SimpleSearchQuery {
     role?: string;
+    matchInteractions?: boolean;
 }
 
 export interface InteractionSearchQuery extends SimpleSearchQuery {
@@ -84,4 +85,5 @@ export interface WorkflowExecutionSearchQuery extends SimpleSearchQuery {
 
 export interface ComplexSearchQuery extends ObjectSearchQuery {
     vector?: VectorSearchQuery;
+    match?: Record<string, any>;
 }

package/src/runs.ts

@@ -12,7 +12,7 @@ export interface ExecutionRunDocRef {
 
 /**
  * Interaction execution payload for creating a new run
- * It uses interaction field (from NamedInteractionExecutionPayload) to pass the intercation ID to run
+ * It uses interaction field (from NamedInteractionExecutionPayload) to pass the interaction ID to run
  */
 export interface RunCreatePayload extends NamedInteractionExecutionPayload {
 }
@@ -27,7 +27,7 @@ export interface RangeValue {
     lte?: number | string,
 }
 
-export interface RunSearchMetaRepsonse {
+export interface RunSearchMetaResponse {
     count: {
         lower_bound?: number,
         total?: number,

package/src/store/activity-catalog.ts

@@ -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

@@ -121,12 +121,12 @@ export interface AdaptTablesParams {
 }
 
 interface DocAnalyzerRequestBase {
-    synchroneous?: boolean;
+    synchronous?: boolean;
 
     notify_endpoints?: string[];
 
     /**
-     * What environmenet to use to run the request
+     * What environment to use to run the request
      * If none specified the project embedded environment will be used
      */
     environment?: string;

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/signals.ts

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