@vertesia/common 0.78.0 → 0.79.0

package/package.json

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

package/src/apikey.ts

@@ -90,6 +90,7 @@ export interface AuthTokenPayload {
 
 export enum PrincipalType {
     User = "user",
+    Group = "group",
     ApiKey = "apikey",
     ServiceAccount = "service_account",
 }

package/src/apps.ts

@@ -1,3 +1,4 @@
+import { JSONSchema } from "@llumiverse/common";
 
 export interface AppUIConfig {
     /**
@@ -36,6 +37,12 @@ export interface AppManifestData {
      */
     icon?: string;
 
+    /**
+     * A color name to be used as the color of the app card (e.g. blue, red, green, etc.)
+     * If not specified a random color will be picked.
+     */
+    color?: string;
+
     status: "beta" | "stable" | "deprecated"
 
     ui?: AppUIConfig
@@ -46,6 +53,11 @@ export interface AppManifestData {
      * If the `?import` query string is used the tool will be imported as a javascript module and not executed through a POST on the collections endpoint.
      */
     tool_collections?: string[]
+
+    /**
+     * A JSON chema for the app installation settings.
+     */
+    settings_schema?: JSONSchema;
 }
 export interface AppManifest extends AppManifestData {
     id: string;
@@ -73,3 +85,23 @@ export interface AppInstallationPayload {
 }
 
 export type AppInstallationKind = 'ui' | 'tools' | 'all';
+
+/**
+ * A descriptiojn of the tools provided by an app
+ */
+export interface AppToolCollection {
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * Optional collection description
+     */
+    description?: string;
+
+    /**
+     * the tools provided by this collection
+     */
+    tools: { name: string, description?: string }[]
+}

package/src/index.ts

@@ -17,6 +17,7 @@ export * from "./Progress.js";
 export * from './project.js';
 export * from './prompt.js';
 export * from './query.js';
+export * from './rate-limiter.js';
 export * from './refs.js';
 export * from './runs.js';
 export * from "./store/index.js";
@@ -26,4 +27,6 @@ export * from './transient-tokens.js';
 export * from './user.js';
 export * from './utils/auth.js';
 export * from './utils/schemas.js';
-export type * from './utils/type-helpers.js'
+export type * from './utils/type-helpers.js';
+export * from './versions.js';
+

package/src/interaction.ts

@@ -1,4 +1,5 @@
 import type {
+    CompletionResult,
     JSONObject,
     JSONSchema,
     Modalities,
@@ -284,7 +285,7 @@ export interface NamedInteractionExecutionPayload extends InteractionExecutionPa
 // ================= async execution payloads ====================
 export type ToolRef = string | { name: string; description: string };
 
-interface AsyncExecutionPayloadBase extends Omit<NamedInteractionExecutionPayload,"toolDefinitions" | "stream"> {
+interface AsyncExecutionPayloadBase extends Omit<NamedInteractionExecutionPayload, "toolDefinitions" | "stream"> {
     type: "conversation" | "interaction";
 
     /**
@@ -381,6 +382,10 @@ export interface ToolResultContent {
     content: string;
     is_error: boolean;
     files?: string[];
+    /**
+     * Can contain metadata returned by the tool executor.
+     */
+    meta?: Record<string, any>;
 }
 
 export interface ToolResult extends ToolResultContent {
@@ -398,7 +403,7 @@ export interface UserMessagePayload extends ResumeConversationPayload {
     message: string;
 }
 
-export type CheckpointConversationPayload = Omit<ToolResultsPayload, "results">;
+export type CheckpointConversationPayload = Omit<ToolResultsPayload, "results" | "tools">
 
 // ================= end async execution payloads ====================
 
@@ -419,7 +424,7 @@ export interface RunSource {
     client_ip: string;
 }
 
-export interface ExecutionRun<P = any, R = 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
@@ -430,7 +435,7 @@ export interface ExecutionRun<P = any, R = any> {
         selected?: boolean;
         scores?: Record<string, number>;
     };
-    result: R;
+    result: CompletionResult[] // Any new result will actually be CompletionResult[], the old typing is R, and R used to default to any.
     /**
      * The parameters used to create the interaction.
      * If the parameters contains the special property "@memory" it will be used
@@ -450,7 +455,7 @@ export interface ExecutionRun<P = any, R = any> {
     prompt: any;
     token_use?: ExecutionTokenUsage;
     chunks?: number;
-    execution_time?: number; //s
+    execution_time?: number; // ms
     created_at: Date;
     updated_at: Date;
     account: AccountRef;
@@ -498,7 +503,7 @@ export interface ExecutionRunWorkflow {
     activity_type?: string;
 }
 
-export interface InteractionExecutionResult<P = any, R = any> extends ExecutionRun<P, R> {
+export interface InteractionExecutionResult<P = any> extends ExecutionRun<P> {
     tool_use?: ToolUse[];
     conversation?: unknown;
     options?: StatelessExecutionOptions;
@@ -551,3 +556,14 @@ export interface GenerateTestDataPayload {
 export interface ImprovePromptPayload {
     config: InteractionExecutionConfiguration;
 }
+
+export interface RateLimitRequestPayload {
+    interaction: string,
+    environment_id?: string,
+    model_id?: string,
+    workflow_run_id?: string
+}
+
+export interface RateLimitRequestResponse {
+    delay_ms: number;
+}

package/src/payload.ts

@@ -13,10 +13,8 @@ import {
 export interface SearchPayload {
     facets?: FacetSpec[];
     /**
-     * If the facets should respect "limit"
-     * If true, the facet count be limited to the number of results in the query.
-     * If false, the facet count will be calculated over all objects.
-     * Default is true.
+     * If the facets should be limited to the current page of results.
+     * Defaults to false. When false, the facets are independent of the search results page.
      */
     limit_facets?: boolean;
     query?: SimpleSearchQuery;

package/src/query.ts

@@ -43,6 +43,7 @@ export interface SimpleSearchQuery {
 }
 
 export interface ObjectSearchQuery extends SimpleSearchQuery {
+    id?: string;
     createdFrom?: string;
     createdTo?: string;
     updatedFrom?: string;
@@ -86,6 +87,7 @@ export interface RunSearchQuery extends SimpleSearchQuery {
     finish_reason?: string;
     created_by?: string;
     workflow_run_ids?: string[];
+    run_ids?: string[];
 }
 
 export interface WorkflowExecutionSearchQuery extends SimpleSearchQuery {

package/src/rate-limiter.ts

@@ -0,0 +1,34 @@
+/**
+ * Rate Limiter Types
+ */
+
+export interface RateLimiterCapacity {
+    current: number;
+    base: number;
+    max: number;
+}
+
+export interface RateLimiterBreakerState {
+    state: 'open' | 'closed';
+    is_open: boolean;
+    last_opened_at?: string;
+    consecutive_failures?: number;
+}
+
+export interface RateLimiterModelStatus {
+    model_id: string;
+    admitted: number;
+    delayed: number;
+    capacity: RateLimiterCapacity;
+    breaker: RateLimiterBreakerState;
+    last_updated: string;
+}
+
+export interface RateLimiterStatus {
+    environment_id: string;
+    model_id: string;
+    status: RateLimiterModelStatus;
+}
+
+// Always return an array for consistency
+export type RateLimiterStatusResponse = RateLimiterStatus[];

package/src/store/collections.ts

@@ -69,4 +69,5 @@ export interface CollectionSearchPayload {
     offset?: number;
     name?: string;
     type?: string;
+    types?: string[];
 }

package/src/store/store.ts

@@ -3,6 +3,13 @@ import { SupportedEmbeddingTypes } from "../project.js";
 import { ComplexSearchQuery } from "../query.js";
 import { BaseObject } from "./common.js";
 
+export enum ContentObjectApiHeaders {
+    COLLECTION_ID = 'x-collection-id',
+    PROCESSING_PRIORITY = 'x-processing-priority',
+    CREATE_REVISION = 'x-create-revision',
+    REVISION_LABEL = 'x-revision-label',
+}
+
 export enum ContentObjectStatus {
     created = "created",
     processing = "processing", // the was created and still processing

package/src/store/workflow.ts

@@ -12,6 +12,13 @@ export enum ContentEventName {
     api_request = "api_request",
 }
 
+export interface Queue {
+    name: string;
+    // use either suffix or full name. fullname has precedence over suffix
+    queue_suffix?: string; // suffix to append to the base queue name
+    queue_full_name?: string; // full name
+}
+
 export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
     /**
      * The ref of the user who initiated the workflow.
@@ -59,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?: {
@@ -72,14 +79,21 @@ export interface WorkflowExecutionBaseParams<T = Record<string, any>> {
     };
 
     /**
-     * Whether to route resource intensive tasks to a heavy load queue. Managed by the application.
+     *  List of enabled processing queues. Managed by the application.
      */
-    _enable_heavy_task_routing?: boolean;
+    _enabled_queues?: Queue[];
+
+}
 
+export interface WebHookSpec {
+    /**
+     * The webhook URL to call using POST method
+     */
+    url: string;
     /**
-     * The suffix to append to the task queue name for heavy load routing. Managed by the application.
+     * the API version to use if any
      */
-    _heavy_task_queue_suffix?: string;
+    version?: number;
 }
 
 export interface WorkflowExecutionPayload<T = Record<string, any>> extends WorkflowExecutionBaseParams<T> {

package/src/versions.ts

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