@vertesia/common 0.68.0 → 0.70.0

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@vertesia/common",
-  "version": "0.68.0",
+  "version": "0.70.0",
   "type": "module",
   "types": "./lib/types/index.d.ts",
   "files": [
     "lib",
-    "src"
+    "src",
+    "tsconfig.dist.json"
   ],
   "exports": {
     "types": "./lib/types/index.d.ts",
@@ -26,7 +27,7 @@
   "dependencies": {
     "ajv": "^8.16.0",
     "json-schema": "^0.4.0",
-    "@llumiverse/common": "0.20.0"
+    "@llumiverse/common": "0.21.0"
   },
   "ts_dual_module": {
     "outDir": "lib"

package/src/access-control.ts

@@ -27,6 +27,7 @@ export enum Permission {
     api_key_delete = "api_key:delete",
 
     account_read = "account:read",
+    account_write = "account:write",
     account_admin = "account:admin",
     manage_billing = "account:billing",
     account_member = "account:member",

package/src/apikey.ts

@@ -57,9 +57,25 @@ export interface AuthTokenPayload {
     project?: ProjectRef;
     project_roles?: ProjectRoles[];
 
+    /**
+     * The roles of the user in the application it has access
+     * The key is the unique app name (kebab-case) and the value a list of roles.
+     */
+    apps_roles: Record<string, string[]>,
+
     /** groups */
     groups?: UserGroupRef[]; //group ids
 
+    /**
+     * API endpoints information to be used with this token.
+     * Either a n API domain like 'api.vertesia.io' | 'api-preview.vertesia.io' | 'api-staging.vertesia.io' | 'local'
+     * or explicit studio and store URLs.
+     */
+    endpoints?: string | {
+        studio: string,
+        store: string
+    }
+
     iss: string; //issuer
     aud: string; //audience
     exp: number; //expires in (EPOC seconds)

package/src/apps.ts

@@ -0,0 +1,85 @@
+
+export interface AppRef {
+    id: string;
+    name: string;
+}
+
+export interface AppUIConfig {
+    /**
+     * The source URL of the app. The src can be a template which contain
+     * a variable named `buildId` which will be replaced with the current build id.
+     * For example: `/plugins/vertesia-review-center-${buildId}`
+     */
+    src: string;
+    /**
+     * Whether the app should be loaded as part of the host layout
+     * or in a new tab.
+     */
+    external?: boolean;
+}
+
+export interface AppManifestData {
+    /**
+     * The name of the app, used as the id in the system.
+     * Must be in kebab case (e.g. my-app).
+     */
+    name: string;
+
+    /**
+     * Which account is ownning the app.
+     * The property is defined only for customer apps.
+     * THis is always undefined for vertesia apps.
+     */
+    account?: string;
+
+    /**
+     * Whether the app is private to the owner account.
+     * If true the account property must be defined.
+     */
+    private?: boolean;
+
+    title: string;
+    description: string;
+    publisher: string;
+
+    /**
+     * A svg icon for the app.
+     */
+    icon?: string;
+
+    status: "beta" | "stable" | "deprecated" | "hidden"
+
+    ui?: AppUIConfig
+
+    /**
+     * A list of tool collections endpoints to be used by this app.
+     * A tools collection endpoint is an URL which may end with a `?import` query string.
+     * 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[]
+}
+export interface AppManifest extends AppManifestData {
+    id: string;
+    created_at: string;
+    updated_at: string;
+}
+
+export interface AppInstallation {
+    id: string;
+    project: string; // the project where the app is installed
+    manifest: string; // the app manifest
+    settings?: Record<string, any>; // settings for the app installation
+    created_at: string;
+    updated_at: string;
+}
+
+export interface AppInstallationWithManifest extends Omit<AppInstallation, 'manifest'> {
+    manifest: AppManifest; // the app manifest data
+}
+
+export interface AppInstallationPayload {
+    app_id: string,
+    settings?: Record<string, any>
+}
+
+export type AppInstallationKind = 'ui' | 'tools' | 'all';

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from './access-control.js';
 export * from './analytics.js';
 export * from './apikey.js';
+export * from './apps.js';
 export * from './common.js';
 export * from './environment.js';
 export * from "./facets.js";
@@ -12,7 +13,6 @@ export * from './json.js';
 export * from './meters.js';
 export * from './model_utility.js';
 export * from './payload.js';
-export * from "./plugin.js";
 export * from "./Progress.js";
 export * from './project.js';
 export * from './prompt.js';
@@ -26,4 +26,3 @@ export * from './transient-tokens.js';
 export * from './user.js';
 export * from './utils/auth.js';
 export * from './utils/schemas.js';
-

package/src/project.ts

@@ -17,6 +17,8 @@ export enum ProjectRoles {
     reader = "reader", // can only read (browse)
     billing = "billing", // can only manage billings
     member = "member", // can only access, but no specific permissions
+    app_user = "app_user", // can access and perform read/write operations in the context of an app
+    app_reader = "app_reader", // can access and perform read operations in the context of an app
 }
 
 export function isRoleIncludedIn(role: string, includingRole: string) {

package/src/user.ts

@@ -81,6 +81,7 @@ export interface AccountRef {
 }
 export const AccountRefPopulate = "id name";
 
+export const AppRefPopulate = "id name";
 
 export interface InviteUserRequestPayload {
     email: string;

package/tsconfig.dist.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "composite": true,
+        "declaration": true,
+        "declarationMap": true,
+        "jsx": "react-jsx",
+        "target": "ES2022",
+        "module": "ESNext",
+        "moduleResolution": "Bundler",
+        "rootDir": "./src",
+        "outDir": "./lib"
+    },
+    "include": [
+        "src"
+    ],
+    "exclude": [
+        "**/*.test.*",
+        "**/*.spec.*"
+    ]
+}

package/lib/cjs/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":""}

package/lib/esm/plugin.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=plugin.js.map

package/lib/esm/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":""}

package/lib/types/plugin.d.ts

@@ -1,54 +0,0 @@
-import { JSONObject, ToolDefinition, ToolUse } from "@llumiverse/common";
-import { AsyncConversationExecutionPayload } from "./interaction.js";
-import { WorkflowExecutionBaseParams } from "./store/index.js";
-/**
- * A vertesia plugin manifest
- */
-export interface PluginManifest<MetaT = any> {
-    id: string;
-    /**
-     * The kind of the plugin.
-     */
-    kind: "ui" | "tool";
-    /**
-     * A metadata field which can be used for each kind of plugin to store additional data
-     */
-    metadata?: MetaT;
-    src: string;
-    name: string;
-    version: string;
-    publisher: string;
-    title?: string;
-    description?: string;
-    icon?: string;
-    /**
-     * Whether the plugin should be loaded as part of the host layout
-     * or in a new tab.
-     * If external is true, the plugin must manage itself the global layout of the page.
-     * It will be loaded in a new tab.
-     * If external is false the plugin will be loaded as a page of the host application and it will share the same layout.
-     * Default is false.
-     * This is only usefull for UI plugins.
-     */
-    external?: boolean;
-    /**
-     * The default is "beta".
-     */
-    status?: "beta" | "stable" | "deprecated" | "hidden";
-}
-export interface UIPluginManifest extends PluginManifest {
-    kind: "ui";
-    metadata: never;
-}
-export interface ToolPluginManifest extends PluginManifest {
-    kind: "tool";
-    /**
-     * The definitions of the exported tools
-     */
-    metadata: ToolDefinition[];
-}
-export interface PluginToolContext<ParamsT = JSONObject> {
-    payload: WorkflowExecutionBaseParams<AsyncConversationExecutionPayload>;
-    tool_use: ToolUse<ParamsT>;
-    plugin: string;
-}

package/lib/types/plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,iCAAiC,EAAE,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK,GAAG,GAAG;IACvC,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAC;CACxD;AAED,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACpD,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,KAAK,CAAC;CACnB;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACtD,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO,GAAG,UAAU;IACnD,OAAO,EAAE,2BAA2B,CAAC,iCAAiC,CAAC,CAAC;IACxE,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAClB"}

package/src/plugin.ts

@@ -1,58 +0,0 @@
-import { JSONObject, ToolDefinition, ToolUse } from "@llumiverse/common";
-import { AsyncConversationExecutionPayload } from "./interaction.js";
-import { WorkflowExecutionBaseParams } from "./store/index.js";
-
-/**
- * A vertesia plugin manifest
- */
-export interface PluginManifest<MetaT = any> {
-    id: string;
-    /**
-     * The kind of the plugin.
-     */
-    kind: "ui" | "tool";
-    /**
-     * A metadata field which can be used for each kind of plugin to store additional data
-     */
-    metadata?: MetaT;
-    src: string;
-    name: string;
-    version: string;
-    publisher: string;
-    title?: string;
-    description?: string;
-    icon?: string;
-    /**
-     * Whether the plugin should be loaded as part of the host layout
-     * or in a new tab.
-     * If external is true, the plugin must manage itself the global layout of the page.
-     * It will be loaded in a new tab.
-     * If external is false the plugin will be loaded as a page of the host application and it will share the same layout.
-     * Default is false.
-     * This is only usefull for UI plugins.
-     */
-    external?: boolean;
-    /**
-     * The default is "beta".
-     */
-    status?: "beta" | "stable" | "deprecated" | "hidden";
-}
-
-export interface UIPluginManifest extends PluginManifest {
-    kind: "ui";
-    metadata: never;
-}
-
-export interface ToolPluginManifest extends PluginManifest {
-    kind: "tool";
-    /**
-     * The definitions of the exported tools
-     */
-    metadata: ToolDefinition[];
-}
-
-export interface PluginToolContext<ParamsT = JSONObject> {
-    payload: WorkflowExecutionBaseParams<AsyncConversationExecutionPayload>;
-    tool_use: ToolUse<ParamsT>; //params?
-    plugin: string; // plugin id
-}