@vertesia/client 0.51.0 → 0.54.0

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright 2024 Composable
+Copyright 2024 Composable Prompts
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.

package/package.json

@@ -1,36 +1,51 @@
 {
   "name": "@vertesia/client",
-  "version": "0.51.0",
+  "version": "0.54.0",
   "type": "module",
   "types": "./lib/types/index.d.ts",
   "files": [
     "lib",
     "src"
   ],
+  "license": "Apache-2.0",
   "devDependencies": {
-    "@types/eventsource": "^1.1.14",
-    "@types/node": "^20.8.9",
+    "@types/node": "^22.13.5",
     "ts-dual-module": "^0.6.3",
     "typescript": "^5.0.2",
-    "vitest": "^2.1.9"
+    "vitest": "^3.0.9"
   },
   "dependencies": {
-    "eventsource": "^2.0.2",
-    "@llumiverse/core": "0.15.0",
-    "@vertesia/api-fetch-client": "0.51.0",
-    "@vertesia/common": "0.51.0"
+    "eventsource": "^3.0.6",
+    "@vertesia/common": "0.54.0",
+    "@llumiverse/core": "0.17.0",
+    "@vertesia/api-fetch-client": "0.54.0"
   },
   "ts_dual_module": {
     "outDir": "lib"
   },
   "exports": {
-    "types": "./lib/types/index.d.ts",
-    "import": "./lib/esm/index.js",
-    "require": "./lib/cjs/index.js"
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./node": {
+      "types": "./lib/types/nodejs/index.d.ts",
+      "import": "./lib/esm/nodejs/index.js",
+      "require": "./lib/cjs/nodejs/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "node": [
+        "./lib/types/nodejs/index.d.ts"
+      ]
+    }
   },
   "scripts": {
     "eslint": "eslint './src/**/*.{jsx,js,tsx,ts}'",
     "build": "pnpm exec tsmod build",
-    "clean": "rimraf ./node_modules ./lib ./tsconfig.tsbuildinfo"
+    "clean": "rimraf ./node_modules ./lib ./tsconfig.tsbuildinfo",
+    "test": "vitest run"
   }
 }

package/src/AccountApi.ts

@@ -1,5 +1,5 @@
 import { ApiTopic, ClientBase } from "@vertesia/api-fetch-client";
-import { Account, InviteUserRequestPayload, InviteUserResponsePayload, OnboardingProgress, ProjectRef, TransientToken, UpdateAccountPayload, User, UserInviteTokenData } from "@vertesia/common";
+import { Account, InviteUserRequestPayload, InviteUserResponsePayload, OnboardingProgress, ProjectRef, StripeBillingStatusResponse, TransientToken, UpdateAccountPayload, User, UserInviteTokenData } from "@vertesia/common";
 
 export default class AccountApi extends ApiTopic {
 
@@ -42,13 +42,21 @@ export default class AccountApi extends ApiTopic {
     }
 
     /**
-     * Fetch Invites for account
+     * Fetch Invites for Principal
      * @returns UserInviteTokenData[]
      * */
     listInvites(): Promise<TransientToken<UserInviteTokenData>[]> {
         return this.get('/invites');
     }
 
+    /**
+     * Fetch Invites for Account
+     * @returns UserInviteTokenData[]
+     * */
+    listAccountInvitation(id: string): Promise<TransientToken<UserInviteTokenData>[]> {
+        return this.get(`/invites/${id}`);
+    }
+
     /**
      * Accept Invite for account
      * @returns UserInviteTokenData
@@ -81,4 +89,8 @@ export default class AccountApi extends ApiTopic {
         return this.get('/google-token');
     }
 
+    getStripeBillingStatus(): Promise<StripeBillingStatusResponse> {
+        return this.get('/stripe-billing-status')
+    }
+
 }

package/src/AccountsApi.ts

@@ -11,6 +11,10 @@ export default class AccountsApi extends ApiTopic {
         return this.post('/', { payload: { name } });
     }
 
+    list(): Promise<Account[]> {
+        return this.get('/');
+    }
+
 
 
 

package/src/ApiKeysApi.ts

@@ -50,7 +50,7 @@ export class ApiKeysApi extends ApiTopic {
     }
 
     /**
-     * get or create a temporary public key which can be used from browser to browse and execute itneractions.
+     * get or create a temporary public key which can be used from browser to browse and execute interactions.
      * If a public key already exists for the given project (or for the current organization) then it is returned, otherwise a new one is created.
      * The payload object can contain the following properties:
      * - name: the name of the public key. If not specified a random name is generated.

package/src/EnvironmentsApi.ts

@@ -34,8 +34,8 @@ export default class EnvironmentsApi extends ApiTopic {
     }
 
     /**
-     * udpate enabled models and / or config. If enabled_models is not provided, the existing enabled models will not change.
-     * Same, if config is not provioded the exiting config is not changed.
+     * Update enabled models and / or config. If enabled_models is not provided, the existing enabled models will not change.
+     * Same, if config is not provided the exiting config is not changed.
      * If the config is provided then it will be updated without removing fields that are not provided.
      *
      * @param id

package/src/InteractionBase.ts

@@ -31,7 +31,7 @@ export class InteractionBase<P = any, R = any> {
      * the run completes or fails.
      * If the onChunk callback is passed then the streaming of the result is enabled.
      * The onChunk callback with be called with the next chunk of the result as soon as it is available.
-     * When all chunks are received the fucntion will return the resolved promise
+     * When all chunks are received the function will return the resolved promise
      * @param id of the interaction to execute
      * @param payload InteractionExecutionPayload
      * @param onChunk callback to be called when the next chunk of the response is available

package/src/InteractionsApi.ts

@@ -1,7 +1,7 @@
-import { ComputeInteractionFacetPayload, ExecutionRun, GenerateInteractionPayload, GenerateTestDataPayload, ImprovePromptPayload, Interaction, InteractionCreatePayload, InteractionExecutionPayload, InteractionForkPayload, InteractionPublishPayload, InteractionRef, InteractionRefWithSchema, InteractionUpdatePayload, InteractionsExportPayload, InteractionSearchPayload, InteractionSearchQuery } from "@vertesia/common";
 import { ApiTopic, ClientBase, ServerError } from "@vertesia/api-fetch-client";
+import { AsyncExecutionPayload, ComputeInteractionFacetPayload, ExecutionRun, GenerateInteractionPayload, GenerateTestDataPayload, ImprovePromptPayload, Interaction, InteractionCreatePayload, InteractionEndpointQuery, InteractionExecutionPayload, InteractionExecutionResult, InteractionForkPayload, InteractionPublishPayload, InteractionRef, InteractionRefWithSchema, InteractionSearchPayload, InteractionSearchQuery, InteractionUpdatePayload, InteractionsExportPayload } from "@vertesia/common";
 import { VertesiaClient } from "./client.js";
-import { executeInteraction, executeInteractionByName } from "./execute.js";
+import { executeInteraction, executeInteractionAsync, executeInteractionByName } from "./execute.js";
 
 export interface ComputeInteractionFacetsResponse {
     tags?: { _id: string, count: number }[];
@@ -9,6 +9,10 @@ export interface ComputeInteractionFacetsResponse {
     total?: { count: number }[];
 }
 
+export interface AsyncExecutionResult {
+    runId: string, workflowId: string
+}
+
 export default class InteractionsApi extends ApiTopic {
     constructor(parent: ClientBase) {
         super(parent, "/api/v1/interactions");
@@ -27,6 +31,15 @@ export default class InteractionsApi extends ApiTopic {
             }
         });
     }
+    /**
+     * Find interactions given a mongo match query.
+     * You can also specify if prompts schemas are included in the result
+     */
+    listEndpoints(payload: InteractionEndpointQuery): Promise<InteractionRef[]> {
+        return this.post("/endpoints", {
+            payload
+        });
+    }
 
     /**
      * List all interaction versions in the project having the given endpoint name.
@@ -79,7 +92,7 @@ export default class InteractionsApi extends ApiTopic {
     }
 
     /**
-     * Retrieve an existing interaction definiton
+     * Retrieve an existing interaction definition
      * @param id of the interaction to retrieve
      * @returns Interaction
      **/
@@ -88,7 +101,7 @@ export default class InteractionsApi extends ApiTopic {
     }
 
     /**
-     * Update an existing interaction definiton
+     * Update an existing interaction definition
      * @param id of the interaction to update
      * @param payload InteractionUpdatePayload
      * @returns Interaction
@@ -108,7 +121,7 @@ export default class InteractionsApi extends ApiTopic {
      * the run completes or fails.
      * If the onChunk callback is passed then the streaming of the result is enabled.
      * The onChunk callback with be called with the next chunk of the result as soon as it is available.
-     * When all chunks are received the fucntion will return the resolved promise
+     * When all chunks are received the function will return the resolved promise
      * @param id of the interaction to execute
      * @param payload InteractionExecutionPayload
      * @param onChunk callback to be called when the next chunk of the response is available
@@ -133,7 +146,7 @@ export default class InteractionsApi extends ApiTopic {
     /**
      * Same as execute but uses the interaction name selector instead of the id.
      *
-     * A name selector is the interaction endpoint name suffuxed with an optional tag or version wich is starting with a `@` character.
+     * A name selector is the interaction endpoint name suffixed with an optional tag or version which is starting with a `@` character.
      * The special `draft` tag is used to select the draft version of the interaction. If no tag or version is specified then the latest version is selected.
      * Examples of selectors:
      * - `ReviewContract` - select the latest version of the ReviewContract interaction
@@ -146,7 +159,7 @@ export default class InteractionsApi extends ApiTopic {
      * @returns
      */
     executeByName<P = any, R = any>(nameWithTag: string, payload: InteractionExecutionPayload = {},
-        onChunk?: (chunk: string) => void): Promise<ExecutionRun<P, R>> {
+        onChunk?: (chunk: string) => void): Promise<InteractionExecutionResult<P, R>> {
         return executeInteractionByName(this.client as VertesiaClient, nameWithTag, payload, onChunk).catch(err => {
             if (err instanceof ServerError && err.payload?.id) {
                 throw err.updateDetails({ run_id: err.payload.id });
@@ -156,6 +169,15 @@ export default class InteractionsApi extends ApiTopic {
         });
     }
 
+    /**
+     * Execute an interaction in an workflow
+     * @param payload
+     * @returns
+     */
+    executeAsync(payload: AsyncExecutionPayload): Promise<AsyncExecutionResult> {
+        return executeInteractionAsync(this.client as VertesiaClient, payload);
+    }
+
     publish(id: string, payload: InteractionPublishPayload): Promise<Interaction> {
         return this.post(`/${id}/publish`, {
             payload

package/src/PluginsApi.ts

@@ -0,0 +1,28 @@
+import { ApiTopic, ClientBase } from "@vertesia/api-fetch-client";
+import type { PluginManifest } from "@vertesia/common";
+
+export default class PluginsApi extends ApiTopic {
+
+    constructor(parent: ClientBase) {
+        super(parent, "/api/v1/plugins")
+    }
+
+    create(manifest: Omit<PluginManifest, 'id'>): Promise<PluginManifest> {
+        return this.post('/', { payload: manifest });
+    }
+
+    update(manifest: PluginManifest) {
+        return this.put(`/${manifest.id}`, { payload: manifest });
+    }
+
+    /**
+     * If a project ID is specified through the project query param
+     * then only the plugins that are enabled on the project are returned.
+     * @param query
+     * @returns
+     */
+    list(): Promise<PluginManifest[]> {
+        return this.get('/');
+    }
+
+}

package/src/ProjectsApi.ts

@@ -1,5 +1,5 @@
 import { ApiTopic, ClientBase } from "@vertesia/api-fetch-client";
-import { AwsConfiguration, GithubConfiguration, GladiaConfiguration, ICreateProjectPayload, MacgicPdfConfiguration, Project, ProjectIntegrationListEntry, ProjectRef, SupportedIntegrations } from "@vertesia/common";
+import { AwsConfiguration, GithubConfiguration, GladiaConfiguration, ICreateProjectPayload, MagicPdfConfiguration, PluginManifest, Project, ProjectIntegrationListEntry, ProjectRef, SupportedIntegrations } from "@vertesia/common";
 
 export default class ProjectsApi extends ApiTopic {
     constructor(parent: ClientBase) {
@@ -26,6 +26,14 @@ export default class ProjectsApi extends ApiTopic {
         });
     }
 
+    listPlugins(projectId: string): Promise<PluginManifest[]> {
+        return this.get(`/${projectId}/plugins`);
+    }
+
+    setPlugins(projectId: string, pluginIds: string[]): Promise<{ count: number }> {
+        return this.post(`/${projectId}/plugins`, { payload: { plugins: pluginIds } });
+    }
+
     integrations: IntegrationsConfigurationApi = new IntegrationsConfigurationApi(this);
 
 }
@@ -40,7 +48,7 @@ class IntegrationsConfigurationApi extends ApiTopic {
         return this.get(`/${projectId}/integrations`).then(res => res.integrations);
     }
 
-    retrieve(projectId: string, integrationId: SupportedIntegrations): Promise<GladiaConfiguration | GithubConfiguration | AwsConfiguration | MacgicPdfConfiguration | undefined> {
+    retrieve(projectId: string, integrationId: SupportedIntegrations): Promise<GladiaConfiguration | GithubConfiguration | AwsConfiguration | MagicPdfConfiguration | undefined> {
         return this.get(`/${projectId}/integrations/${integrationId}`).catch(err => {
             if (err.status === 404) {
                 return undefined;

package/src/PromptsApi.ts

@@ -123,7 +123,7 @@ export default class PromptsApi extends ApiTopic {
     }
 
     /**
-     * List the versions of the prompt template. Returens an empty array if no versions are found
+     * List the versions of the prompt template. Returns an empty array if no versions are found
      * @param id
      * @returns the versions list or an empty array if no versions are found
      */

package/src/RunsApi.ts

@@ -1,26 +1,38 @@
 import { ApiTopic, ClientBase } from "@vertesia/api-fetch-client";
-import { ComputeRunFacetPayload, ExecutionRun, ExecutionRunRef, FindPayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload } from "@vertesia/common";
+import {
+    CheckpointConversationPayload,
+    ComputeRunFacetPayload,
+    ExecutionRun,
+    ExecutionRunRef,
+    FindPayload,
+    RunCreatePayload,
+    RunListingFilters,
+    RunListingQueryOptions,
+    RunSearchPayload,
+    ToolResultsPayload,
+    UserMessagePayload,
+} from "@vertesia/common";
 import { VertesiaClient } from "./client.js";
+import { ExecutionResponse } from "@llumiverse/core";
 
 export interface FilterOption {
-    id: string,
-    name: string,
-    count: number
+    id: string;
+    name: string;
+    count: number;
 }
 
 export interface ComputeRunFacetsResponse {
-    environments?: { _id: string, count: number }[];
-    interactions?: { _id: string, count: number }[];
-    models?: { _id: string, count: number }[];
-    tags?: { _id: string, count: number }[];
-    status?: { _id: string, count: number }[];
+    environments?: { _id: string; count: number }[];
+    interactions?: { _id: string; count: number }[];
+    models?: { _id: string; count: number }[];
+    tags?: { _id: string; count: number }[];
+    status?: { _id: string; count: number }[];
     total?: { count: number }[];
 }
 
 export class RunsApi extends ApiTopic {
-
     constructor(parent: ClientBase) {
-        super(parent, "/api/v1/runs")
+        super(parent, "/api/v1/runs");
     }
 
     /**
@@ -30,30 +42,29 @@ export class RunsApi extends ApiTopic {
      * @returns InteractionResult[]
      **/
     list({ limit, offset, filters }: RunListingQueryOptions): Promise<ExecutionRunRef[]> {
-
         const query = {
             limit,
             offset,
-            ...filters
-        }
+            ...filters,
+        };
 
-        return this.get('/', { query: query });
+        return this.get("/", { query: query });
     }
 
     find(payload: FindPayload): Promise<ExecutionRun[]> {
         return this.post("/find", {
-            payload
+            payload,
         });
     }
 
     /**
      * Get a run by id
-     * 
+     *
      * @param id
      * @returns InteractionResult
      **/
-    retrieve<P=any, R=any>(id: string): Promise<ExecutionRun<P, R>> {
-        return this.get('/' + id);
+    retrieve<P = any, R = any>(id: string): Promise<ExecutionRun<P, R>> {
+        return this.get("/" + id);
     }
 
     /**
@@ -62,10 +73,9 @@ export class RunsApi extends ApiTopic {
      */
     filterOptions(field: string, filters: RunListingFilters): Promise<FilterOption[]> {
         const query = {
-            ...filters
-        }
+            ...filters,
+        };
         return this.get(`/filter-options/${field}`, { query });
-
     }
 
     create(payload: RunCreatePayload): Promise<ExecutionRun> {
@@ -73,14 +83,42 @@ export class RunsApi extends ApiTopic {
         if (sessionTags) {
             let tags = Array.isArray(sessionTags) ? sessionTags : [sessionTags];
             if (Array.isArray(payload.tags)) {
-                tags = tags.concat(payload.tags)
+                tags = tags.concat(payload.tags);
             } else if (payload.tags) {
-                tags = tags.concat([payload.tags])
+                tags = tags.concat([payload.tags]);
             }
-            payload = { ...payload, tags }
+            payload = { ...payload, tags };
         }
         return this.post("/", {
-            payload
+            payload,
+        });
+    }
+
+    /**
+     * Send tool results and continues the conversation
+     * @param payload
+     * @returns
+     */
+    sendToolResults(payload: ToolResultsPayload): Promise<ExecutionResponse> {
+        return this.post(`/tool-results`, {
+            payload,
+        });
+    }
+
+    /**
+     *
+     * @param payload
+     * @returns
+     */
+    sendUserMessage(payload: UserMessagePayload): Promise<ExecutionResponse> {
+        return this.post(`/user-message`, {
+            payload,
+        });
+    }
+
+    createCheckpoint(payload: CheckpointConversationPayload): Promise<ExecutionResponse> {
+        return this.post(`/checkpoint`, {
+            payload,
         });
     }
 
@@ -91,14 +129,13 @@ export class RunsApi extends ApiTopic {
      **/
     computeFacets(query: ComputeRunFacetPayload): Promise<ComputeRunFacetsResponse> {
         return this.post("/facets", {
-            payload: query
+            payload: query,
         });
     }
 
     search(payload: RunSearchPayload): Promise<ExecutionRunRef[]> {
         return this.post("/search", {
-            payload
+            payload,
         });
     }
-
-}
+}

package/src/client.test.ts

@@ -0,0 +1,94 @@
+import { describe, expect, test } from "vitest";
+import { VertesiaClient } from "./client";
+
+describe('Test Vertesia Client', () => {
+    test('Initialization with studio and zeno URLs', () => {
+        const client = new VertesiaClient({
+            serverUrl: 'https://api.vertesia.io',
+            storeUrl: 'https://api.vertesia.io',
+            apikey: '1234',
+        });
+        expect(client).toBeDefined();
+    });
+
+    test('Initialization with studio URL only', () => {
+        expect(() => {
+            new VertesiaClient({
+                serverUrl: 'https://api.vertesia.io',
+                storeUrl: '',
+            });
+        }).toThrowError("Parameter 'site' or 'storeUrl' is required for VertesiaClient");
+    });
+
+    test('Initialization with zeno URL only', () => {
+        expect(() => {
+            new VertesiaClient({
+                serverUrl: '',
+                storeUrl: 'https://api.vertesia.io',
+            });
+        }).toThrowError("Parameter 'site' or 'serverUrl' is required for VertesiaClient");
+    });
+
+    test('Initialization with same site', () => {
+        const client = new VertesiaClient({
+            serverUrl: 'https://api.vertesia.io',
+            storeUrl: 'https://api.vertesia.io',
+            site: 'api.vertesia.io',
+        });
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('https://api.vertesia.io');
+        expect(client.storeUrl).toBe('https://api.vertesia.io');
+    });
+
+    test('Initialization with default parameters', () => {
+        const client = new VertesiaClient();
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('https://api.vertesia.io');
+        expect(client.storeUrl).toBe('https://api.vertesia.io');
+    });
+
+    test('Initialization with site api-preview.vertesia.io', () => {
+        const client = new VertesiaClient({
+            site: 'api-preview.vertesia.io',
+        });
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('https://api-preview.vertesia.io');
+        expect(client.storeUrl).toBe('https://api-preview.vertesia.io');
+    });
+
+    test('Initialization with site api-staging.vertesia.io', () => {
+        const client = new VertesiaClient({
+            site: 'api-staging.vertesia.io',
+        });
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('https://api-staging.vertesia.io');
+        expect(client.storeUrl).toBe('https://api-staging.vertesia.io');
+    });
+
+    test('Initialization with site localhost', () => {
+        const client = new VertesiaClient({
+            serverUrl: 'http://localhost:8091',
+            storeUrl: 'http://localhost:8092',
+        });
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('http://localhost:8091');
+        expect(client.storeUrl).toBe('http://localhost:8092');
+    });
+
+    test('Initialization with overrides', () => {
+        const client = new VertesiaClient({
+            serverUrl: 'https://studio-server-production.api.becomposable.com',
+            storeUrl: 'https://zeno-server-production.api.becomposable.com',
+            site: 'api.vertesia.io',
+        });
+
+        expect(client).toBeDefined();
+        expect(client.baseUrl).toBe('https://studio-server-production.api.becomposable.com');
+        expect(client.storeUrl).toBe('https://zeno-server-production.api.becomposable.com');
+    });
+});