@vertesia/common 0.78.0-dev-28b447d → 0.79.0

package/src/apps.ts

@@ -15,33 +15,6 @@ export interface AppUIConfig {
     isolation?: "shadow" | "css";
 }
 
-export interface AppInteractionRef {
-    /**
-     * The interaction code name
-     */
-    name: string;
-
-    /**
-     * The url to get the interaction specification
-    */
-    url: string;
-
-    /**
-     * The interaction title. Optional. To be used in studio UI when the interaction is displayed
-     */
-    title?: string;
-
-    /**
-     * The interaction description. Optional. To be used in studio UI when the interaction is displayed
-     */
-    description?: string;
-}
-export interface ResolvedAppInteractionRef extends AppInteractionRef {
-    /**
-     * The interaction unique name (can also be used as an ID) that can be used to execute the interaction.
-     */
-    id: string;
-}
 export interface AppManifestData {
     /**
      * The name of the app, used as the id in the system.
@@ -81,13 +54,6 @@ export interface AppManifestData {
      */
     tool_collections?: string[]
 
-    /**
-     * An URL providing interactions definitions in JSON format.
-     * GET interactions_url should return a JSON object with the interactions definitions.
-     * GET `${interactions_url}/${endpoint}` should return a JSON object with the interaction definition for the specified endpoint.
-     */
-    interactions?: AppInteractionRef[];
-
     /**
      * A JSON chema for the app installation settings.
      */

package/src/index.ts

@@ -28,4 +28,5 @@ export * from './user.js';
 export * from './utils/auth.js';
 export * from './utils/schemas.js';
 export type * from './utils/type-helpers.js';
-export * from './sts-token-types.js';
+export * from './versions.js';
+

package/src/interaction.ts

@@ -4,7 +4,6 @@ import type {
     JSONSchema,
     Modalities,
     ModelOptions,
-    PromptRole,
     StatelessExecutionOptions,
     ToolDefinition,
     ToolUse,
@@ -16,12 +15,10 @@ import { ExecutionTokenUsage } from "@llumiverse/common";
 import { ExecutionEnvironmentRef } from "./environment.js";
 import { ProjectRef } from "./project.js";
 import {
-    ExecutablePromptSegmentDef,
     PopulatedPromptSegmentDef,
     PromptSegmentDef,
     PromptTemplateRef,
     PromptTemplateRefWithSchema,
-    TemplateType,
 } from "./prompt.js";
 import { ExecutionRunDocRef } from "./runs.js";
 import { AccountRef } from "./user.js";
@@ -32,79 +29,6 @@ export interface InteractionExecutionError {
     data?: any;
 }
 
-
-// ------------------ in code interactions -----------------
-export interface InCodePrompt {
-    role: PromptRole,
-    content: string,
-    content_type: TemplateType;
-    schema?: JSONSchema;
-}
-export interface InCodeInteraction {
-    /**
-     * The id of the interaction. Required.
-     * The id is a unique identifier for the interaction.
-     * It is recommended to use a URL safe string and not include spaces. 
-     * The id composaed  by some namespace or prefix and the interaction name.
-     * Example: sys:generic_question, app:review_contract, tmp:my_temp_interaction
-     */
-    id: string;
-
-    /**
-     * The interaction code name. Required. 
-     * Should be a URL safe string and not include spaces. It is recommended to use kebab-case or camel-case.
-     * The endpoints must satisfy the following regexp: /^[a-zA-Z0-9-_]+$/. No whitespaces or special characters are allowed.
-     */
-    name: string;
-
-    /**
-     * A title for the interaction. If not provided, the endpoint will be used.
-     */
-    title?: string;
-
-    /**
-     * An optional description of the interaction.
-     */
-    description?: string;
-
-    /**
-     * The JSON schema to be used for the result if any.
-     */
-    result_schema?: JSONSchema;
-
-    /**
-     * The modality of the interaction output. 
-     * If not specified Modalities.Text is assumed.
-     */
-    output_modality?: Modalities,
-
-    /**
-     * How to store the run data for executions of this interaction.
-     * Defaults to STANDARD.
-     */
-    storage?: RunDataStorageLevel;
-
-    /**
-     * Optional tags for the interaction.
-     */
-    tags?: string[];
-
-    /**
-     * Default options for the model to be used when executing this interaction.
-     * (like temperature etc)
-     */
-    model_options?: ModelOptions;
-
-    /**
-     * The prompts composing the interaction. Required.
-     */
-    prompts: InCodePrompt[]
-
-}
-export interface InteractionSpec extends Omit<InCodeInteraction, 'id'> {
-}
-// ---------------------------------------------------------
-
 /**
  * The payload to query the interaction endpoints
  */
@@ -243,31 +167,28 @@ export interface CachePolicy {
     ttl: number;
 }
 export type InteractionVisibility = "public" | "private";
-
-export interface InteractionData {
+export interface Interaction {
     readonly id: string;
     name: string;
     endpoint: string;
     description?: string;
-    project: string | ProjectRef;
-    tags: string[];
-    result_schema?: JSONSchema4 | SchemaRef;
-    environment?: string | ExecutionEnvironmentRef;
-    model?: string;
-    model_options?: ModelOptions;
-    restriction?: RunDataStorageLevel;
-    output_modality?: Modalities;
-}
-export interface Interaction extends InteractionData {
     status: InteractionStatus;
     parent?: string;
     // only used for versions (status === "published")
     visibility: InteractionVisibility;
     version: number;
+    tags: string[];
     test_data?: JSONObject;
     interaction_schema?: JSONSchema4 | SchemaRef;
+    result_schema?: JSONSchema4 | SchemaRef;
     cache_policy?: CachePolicy;
+    model: string;
+    model_options?: ModelOptions;
     prompts: PromptSegmentDef[];
+    output_modality?: Modalities;
+    environment: string | ExecutionEnvironmentRef;
+    restriction?: RunDataStorageLevel;
+    project: string | ProjectRef;
     // only for drafts - when it was last published
     last_published_at?: Date;
     created_by: string;
@@ -280,14 +201,6 @@ export interface PopulatedInteraction extends Omit<Interaction, "prompts"> {
     prompts: PopulatedPromptSegmentDef[];
 }
 
-/**
- * Used to describe an interaction that can be executed. Contains only the interaction data useful
- * to execute the interaction plus the prompt templates
- */
-export interface ExecutableInteraction extends InteractionData {
-    prompts: ExecutablePromptSegmentDef[];
-}
-
 export interface InteractionCreatePayload
     extends Omit<
         Interaction,
@@ -358,12 +271,6 @@ export interface InteractionExecutionPayload {
      * The workflow related to this Interaction Run.
      */
     workflow?: ExecutionRunWorkflow;
-
-    /**
-     * Only used by ad-hoc interactions which defines the prompt in the execution payload itself
-     * These are temporary interactions using "tmp:" suffix.
-     */
-    prompts?: InCodePrompt[];
 }
 
 export interface NamedInteractionExecutionPayload extends InteractionExecutionPayload {
@@ -517,7 +424,7 @@ export interface RunSource {
     client_ip: string;
 }
 
-export interface BaseExecutionRun<P = any> {
+export interface ExecutionRun<P = any> {
     readonly id: string;
     /**
      * Only used by runs that were created by a virtual run to point toward the virtual run parent
@@ -536,12 +443,8 @@ export interface BaseExecutionRun<P = any> {
      */
     parameters: P; //params used to create the interaction, only in varies on?
     tags?: string[];
-    // only set when the target interaction is a stored interaction
-    //TODO check the code where Interaction type is used (should be in run details)
-    // TODO when execution string is passed as the type of interaction
-    interaction?: string | Interaction;
-    // only set when the target interaction is an in-code interaction
-    interaction_code?: string; // Interaction code name in case of in-code interaction (not stored in the DB as an Interaction document)
+    //TODO a string is returned when executing not the interaction object
+    interaction: Interaction;
     //TODO a string is returned when execution not the env object
     environment: ExecutionEnvironmentRef;
     modelId: string;
@@ -574,14 +477,6 @@ export interface BaseExecutionRun<P = any> {
     workflow?: ExecutionRunWorkflow;
 }
 
-export interface ExecutionRun<P = any> extends BaseExecutionRun<P> {
-    interaction?: string;
-}
-
-export interface PopulatedExecutionRun<P = any> extends BaseExecutionRun<P> {
-    interaction?: Interaction;
-}
-
 export interface ExecutionRunWorkflow {
     /**
      * The Temporal Workflow Run ID related to this Interaction Run.
@@ -615,8 +510,7 @@ export interface InteractionExecutionResult<P = any> extends ExecutionRun<P> {
 }
 
 export interface ExecutionRunRef extends Omit<ExecutionRun, "result" | "parameters" | "interaction"> {
-    interaction?: InteractionRef;
-    interaction_code?: string;
+    interaction: InteractionRef;
 }
 
 export const ExecutionRunRefSelect = "-result -parameters -result_schema -prompt";

package/src/project.ts

@@ -142,7 +142,9 @@ export interface EmbeddingsStatusResponse {
     status: string;
     embeddingRunsInProgress: number;
     totalRunsInProgress: number;
+    totalIndexableObjects: number;
     embeddingsModels: string[];
+    objectsWithEmbeddings: number;
     vectorIndex: {
         status: "READY" | "PENDING" | "DELETING" | "ABSENT",
         name?: string,

package/src/prompt.ts

@@ -1,7 +1,7 @@
-import type { JSONObject } from "@llumiverse/common";
-import { PromptRole } from "@llumiverse/common";
 import type { JSONSchema4 } from "json-schema";
+import type { JSONObject } from "@llumiverse/common";
 import { ProjectRef } from "./project.js";
+import { PromptRole } from "@llumiverse/common";
 
 export interface ChatPromptSchema {
     role: PromptRole.user | PromptRole.assistant;
@@ -31,13 +31,6 @@ export interface PopulatedPromptSegmentDef
     extends Omit<PromptSegmentDef, "template"> {
     template?: PromptTemplate;
 }
-/**
- * Used for prompt rendering at interaction execution
- */
-export interface ExecutablePromptSegmentDef
-    extends Omit<PromptSegmentDef, "template"> {
-    template?: ExecutablePromptTemplate;
-}
 
 export interface PromptTemplateRef {
     id: string;
@@ -54,25 +47,25 @@ export interface PromptTemplateRefWithSchema extends PromptTemplateRef {
 
 export enum TemplateType {
     text = "text",
+    js = "js",
     jst = "jst",
 }
-export interface ExecutablePromptTemplate {
-    role: PromptRole;
-    content: string;
-    content_type: TemplateType;
-    inputSchema?: JSONSchema4;
-}
-export interface PromptTemplate extends ExecutablePromptTemplate {
+
+export interface PromptTemplate {
     id: string;
     name: string;
+    role: PromptRole;
     status: PromptStatus;
     version: number;
     // only to be used by published versions
     // the id draft version which is the source of this published version (only when published)
     parent?: string;
     description?: string;
+    content_type: TemplateType;
+    content: string;
     test_data?: JSONObject; // optional test data satisfying the schema
     script?: string; // cache the template output
+    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 schema will define the whole input data

package/src/store/workflow.ts

@@ -66,7 +66,7 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
      * The list of endpoints to notify when the workflow finishes.
      * It is handled by a sub-workflow execution, so the main workflow will not wait for the notification to be sent.
      */
-    notify_endpoints?: string[];
+    notify_endpoints?: (string | WebHookSpec)[];
 
     /** If this is a child workflow, parent contains parent's ids  */
     parent?: {
@@ -85,6 +85,17 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
 
 }
 
+export interface WebHookSpec {
+    /**
+     * The webhook URL to call using POST method
+     */
+    url: string;
+    /**
+     * the API version to use if any
+     */
+    version?: number;
+}
+
 export interface WorkflowExecutionPayload<T = Record<string, any>> extends WorkflowExecutionBaseParams<T> {
     /**
      * The event which started the workflow who created the activity.
@@ -410,42 +421,3 @@ export interface Plan {
 }
 
 export const LOW_PRIORITY_TASK_QUEUE = "low_priority";
-
-/**
- * WebSocket message types for bidirectional communication
- */
-export interface WebSocketSignalMessage {
-    type: 'signal';
-    signalName: string;
-    data: any;
-    requestId?: string | number;
-}
-
-export interface WebSocketPingMessage {
-    type: 'ping';
-}
-
-export interface WebSocketPongMessage {
-    type: 'pong';
-}
-
-export interface WebSocketAckMessage {
-    type: 'ack';
-    requestId: string | number;
-}
-
-export interface WebSocketErrorMessage {
-    type: 'error';
-    requestId?: string | number;
-    error: string;
-}
-
-export type WebSocketClientMessage =
-    | WebSocketSignalMessage
-    | WebSocketPingMessage;
-
-export type WebSocketServerMessage =
-    | WebSocketPongMessage
-    | WebSocketAckMessage
-    | WebSocketErrorMessage
-    | AgentMessage;

package/src/utils/schemas.ts

@@ -1,8 +1,8 @@
-import type { JSONSchema } from "@llumiverse/common";
 import { PromptRole } from "@llumiverse/common";
+import type { JSONSchema } from "@llumiverse/common";
 import type { JSONSchema4 } from "json-schema";
 import { InteractionRefWithSchema, PopulatedInteraction } from "../interaction.js";
-import { ExecutablePromptSegmentDef, PromptSegmentDefType } from "../prompt.js";
+import { PopulatedPromptSegmentDef, PromptSegmentDef, PromptSegmentDefType, PromptTemplateRefWithSchema } from "../prompt.js";
 
 
 export function mergeJSONSchemas(schemas: JSONSchema[]) {
@@ -22,7 +22,7 @@ export function mergeJSONSchemas(schemas: JSONSchema[]) {
     return schema;
 }
 
-export function _mergePromptsSchema(prompts: ExecutablePromptSegmentDef[]) {
+export function _mergePromptsSchema(prompts: PromptSegmentDef<PromptTemplateRefWithSchema>[] | PopulatedPromptSegmentDef[]) {
     const props: Record<string, JSONSchema4> = {};
     let required: string[] = [];
     for (const prompt of prompts) {
@@ -59,5 +59,5 @@ export function _mergePromptsSchema(prompts: ExecutablePromptSegmentDef[]) {
 
 export function mergePromptsSchema(interaction: InteractionRefWithSchema | PopulatedInteraction) {
     if (!interaction.prompts) return null;
-    return _mergePromptsSchema(interaction.prompts as ExecutablePromptSegmentDef[]);
+    return _mergePromptsSchema(interaction.prompts);
 }

package/src/versions.ts

@@ -0,0 +1,3 @@
+export enum ApiVersions {
+    COMPLETION_RESULT_V1 = 20250925,
+}

package/src/sts-token-types.ts

@@ -1,114 +0,0 @@
-/**
- * STS Token Request Types
- * These types define the structure for token requests to the Security Token Service
- */
-
-export type TokenType = 'apikey' | 'user' | 'project' | 'environment' | 'agent' | 'service_account';
-
-interface BaseTokenRequest {
-    type: TokenType;
-    audience?: string;
-}
-
-// API key doesn't need account/project as it's determined from the key
-export interface ApiKeyTokenRequest extends BaseTokenRequest {
-    type: 'apikey';
-    key: string;
-}
-
-// User token needs optional account/project for scoping
-export interface UserTokenRequest extends BaseTokenRequest {
-    type: 'user';
-    user_id?: string; // Optional - can be determined from auth token
-    account_id?: string; // Optional - for scoping to specific account
-    project_id?: string; // Optional - for scoping to specific project
-    expires_at?: number;
-
-    on_behalf_of?: string; // Optional - user ID when acting on behalf of another user
-}
-
-// Project token requires project_id and account_id
-export interface ProjectTokenRequest extends BaseTokenRequest {
-    type: 'project';
-    project_id: string;
-    account_id: string;
-}
-
-// Environment token requires IDs - names fetched from DB
-export interface EnvironmentTokenRequest extends BaseTokenRequest {
-    type: 'environment';
-    environment_id: string;
-    environment_name: string; // Still required as environments may not be in DB
-    project_id: string; // Will fetch name and verify account
-    account_id: string; // Will fetch name and verify project belongs to it
-}
-
-// Agent token for service accounts acting as agents
-export interface AgentTokenRequest extends BaseTokenRequest {
-    type: 'agent';
-    account_id: string;
-    project_id: string; // Will verify it belongs to account
-    name?: string;
-    on_behalf_of: string; // Required: signed Vertesia token to verify user context
-}
-
-// Service account token
-export interface ServiceAccountTokenRequest extends BaseTokenRequest {
-    type: 'service_account';
-    account_id: string;
-    project_id: string; // Will verify it belongs to account
-    roles?: string[]; // Optional - roles for the service account token
-    name?: string;
-}
-
-export type IssueTokenRequest =
-    | ApiKeyTokenRequest
-    | UserTokenRequest
-    | ProjectTokenRequest
-    | EnvironmentTokenRequest
-    | AgentTokenRequest
-    | ServiceAccountTokenRequest;
-
-export interface RefreshTokenRequest {
-    token: string;
-}
-
-export interface RevokeTokenRequest {
-    token: string;
-}
-
-// Helper type guards for type narrowing
-export function isApiKeyRequest(req: IssueTokenRequest): req is ApiKeyTokenRequest {
-    return req.type === 'apikey';
-}
-
-export function isUserRequest(req: IssueTokenRequest): req is UserTokenRequest {
-    return req.type === 'user';
-}
-
-export function isProjectRequest(req: IssueTokenRequest): req is ProjectTokenRequest {
-    return req.type === 'project';
-}
-
-export function isEnvironmentRequest(req: IssueTokenRequest): req is EnvironmentTokenRequest {
-    return req.type === 'environment';
-}
-
-export function isAgentRequest(req: IssueTokenRequest): req is AgentTokenRequest {
-    return req.type === 'agent';
-}
-
-export function isServiceAccountRequest(req: IssueTokenRequest): req is ServiceAccountTokenRequest {
-    return req.type === 'service_account';
-}
-
-// Response types
-export interface TokenResponse {
-    token: string;
-}
-
-export interface ValidateTokenResponse {
-    valid: boolean;
-    payload?: any;
-    error?: string;
-}