@metad/contracts 3.6.0-beta.2 → 3.6.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@metad/contracts",
-  "version": "3.6.0-beta.2",
+  "version": "3.6.0",
   "license": "AGPL-3.0",
   "scripts": {
     "docs": "yarn typedoc --out ./.docs"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js"
-}
+}

package/src/ai/index.d.ts

@@ -24,6 +24,7 @@ export * from './xpert-tool.model';
 export * from './xpert-toolset.model';
 export * from './xpert-workspace.model';
 export * from './xpert.model';
+export * from './xpert.utils';
 export * from './types';
 export * from './xpert-template.model';
 export * from './xpert-task.model';

package/src/ai/knowledge-doc.model.d.ts

@@ -152,11 +152,11 @@ export type TKnowledgeDocument = {
 /**
  * Document, include file, web pages, folder, virtual, etc.
  */
-export interface IKnowledgeDocument extends TKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
+export interface IKnowledgeDocument<T = Metadata> extends TKnowledgeDocument, IBasePerTenantAndOrganizationEntityModel {
     parent?: IKnowledgeDocument | null;
     children?: IKnowledgeDocument[];
     chunks?: DocumentInterface[];
-    metadata?: Metadata;
+    metadata?: T;
 }
 export interface IDocumentChunk<Metadata = DocumentMetadata> {
     id: string;

package/src/ai/knowledge-pipeline.d.ts

@@ -1,22 +1,40 @@
-import { I18nObject } from '../types';
+import { I18nObject, IconDefinition } from '../types';
 import { ICopilotModel } from './copilot-model.model';
 import { KnowledgeStructureEnum } from './knowledgebase.model';
 import { IWorkflowNode, WorkflowNodeTypeEnum } from './xpert-workflow.model';
+import { TXpertParameter } from './xpert.model';
 export interface IDocumentNodeProvider {
     name: string;
     label: I18nObject;
-    icon?: {
-        svg?: string;
-        color?: string;
-    };
+    icon?: IconDefinition;
     description?: I18nObject;
     helpUrl?: string;
     configSchema: any;
 }
+/**
+ * Category of document source provider
+ */
 export declare enum DocumentSourceProviderCategoryEnum {
+    /**
+     * Local files uploaded directly to the system
+     */
     LocalFile = "local-file",
-    RemoteFile = "remote-file",
+    /**
+     * Remote file systems, e.g. S3, FTP, etc.
+     */
+    FileSystem = "file-system",
+    /**
+     * Online documents, e.g. public URLs, Google Docs, etc.
+     */
+    OnlineDocument = "online-document",
+    /**
+     * Web crawling from public websites
+     */
     WebCrawl = "web-crawl",
+    /**
+     * Database connections, e.g. MySQL, PostgreSQL, etc.
+     * @deprecated Planning
+     */
     Database = "database"
 }
 export interface IDocumentSourceProvider extends IDocumentNodeProvider {
@@ -34,6 +52,7 @@ export interface IDocumentUnderstandingProvider extends IDocumentNodeProvider {
 export interface IWFNSource extends IWorkflowNode {
     type: WorkflowNodeTypeEnum.SOURCE;
     provider: string;
+    parameters?: TXpertParameter[];
     config: any;
     integrationId?: string;
 }

package/src/ai/knowledgebase.model.d.ts

@@ -73,6 +73,7 @@ export type TKnowledgebase = {
     similarityThreshold?: number;
     vectorSimilarityWeight?: number;
     /**
+     * @deprecated
      * default parser ID
      */
     parserId?: string;
@@ -103,9 +104,22 @@ export interface IKnowledgebase extends TKnowledgebase, IBasePerWorkspaceEntityM
     integration?: IIntegration;
     pipeline?: IXpert;
 }
+/**
+ * Knowledgebase permission levels
+ */
 export declare enum KnowledgebasePermission {
+    /**
+     * Only visible to you
+     * @default
+     */
     Private = "private",
+    /**
+     * Visible to all members in the organization
+     */
     Organization = "organization",
+    /**
+     * Visible to all members in the tenant
+     */
     Public = "public"
 }
 /**
@@ -143,3 +157,4 @@ export declare const KnowledgeTask = "task_id";
 export declare const KnowledgeSources = "sources";
 export declare const KnowledgeDocuments = "documents";
 export declare const KnowledgeFolderId = "folder_id";
+export declare const KNOWLEDGE_STAGE_NAME = "stage";

package/src/ai/xpert-workflow.model.d.ts

@@ -1,4 +1,4 @@
-import { I18nObject } from "../types";
+import { I18nObject, IconDefinition } from "../types";
 import { ICopilotModel } from "./copilot-model.model";
 import { TKBRecallParams } from "./knowledgebase.model";
 import { ApiAuthType, TErrorHandling, TXpertRefParameter } from "./types";
@@ -6,11 +6,7 @@ import { TStateVariable, TXpertParameter } from "./xpert.model";
 export type TWorkflowNodeMeta = {
     name: string;
     label: I18nObject;
-    icon: {
-        svg?: string;
-        remixicon?: string;
-        color?: string;
-    };
+    icon: IconDefinition;
     configSchema: any;
 };
 export type TWorkflowTriggerMeta = TWorkflowNodeMeta;

package/src/ai/xpert.model.d.ts

@@ -319,6 +319,7 @@ export type TXpertParameter = {
     title?: string;
     description?: string | I18nObject;
     optional?: boolean;
+    default?: any;
     maximum?: number;
     options?: string[];
     item?: TXpertParameter[];
@@ -494,73 +495,3 @@ export type TChatOptions = {
      */
     tools?: (StructuredToolInterface | RunnableToolLike)[];
 };
-export declare function omitXpertRelations(xpert: Partial<IXpert>): {
-    environmentId?: string;
-    environment?: IEnvironment;
-    knowledgebase?: IKnowledgebase;
-    workspaceId?: string;
-    workspace?: import("./xpert-workspace.model").IXpertWorkspace;
-    publishAt?: Date;
-    deletedAt?: Date;
-    organizationId?: string;
-    organization?: import("..").IOrganization;
-    tenantId?: string;
-    tenant?: import("..").ITenant;
-    id?: string;
-    createdById?: string;
-    createdBy?: IUser;
-    updatedById?: string;
-    updatedBy?: IUser;
-    createdAt?: Date;
-    updatedAt?: Date;
-    slug?: string;
-    name?: string;
-    type?: XpertTypeEnum;
-    title?: string;
-    titleCN?: string;
-    description?: string;
-    active?: boolean;
-    avatar?: TAvatar;
-    starters?: string[];
-    options?: TXpertOptions;
-    agentConfig?: TXpertAgentConfig;
-    summarize?: TSummarize;
-    memory?: TLongTermMemory;
-    features?: TXpertFeatures;
-    version?: string;
-    latest?: boolean;
-    releaseNotes?: string;
-    graph?: TXpertGraph;
-    api?: TChatApi;
-    app?: TChatApp;
-    userId?: string;
-    user?: IUser;
-    copilotModel?: ICopilotModel;
-    copilotModelId?: string;
-    integrations?: IIntegration<any>[];
-    tags?: ITag[];
-};
-export declare function figureOutXpert(xpert: IXpert, isDraft: boolean): Partial<IXpert>;
-export declare function xpertLabel(agent: Partial<IXpert>): string;
-export declare function createXpertGraph(xpert: IXpert, position: IPoint): {
-    nodes: TXpertTeamNode[];
-    size: {
-        width: number;
-        height: number;
-    };
-    connections: TXpertTeamConnection[];
-};
-/**
- * Create all nodes of xpert and it's area size
- *
- * @param xpert
- * @returns
- */
-export declare function createXpertNodes(xpert: IXpert, position: IPoint): {
-    nodes: TXpertTeamNode[];
-    size: {
-        width: number;
-        height: number;
-    };
-};
-export declare function createAgentConnections(agent: IXpertAgent, collaborators: IXpert[]): any[];

package/src/ai/xpert.utils.d.ts

@@ -0,0 +1,80 @@
+import { IPoint } from '../types';
+import { IXpertAgent } from './xpert-agent.model';
+import { IXpert, TXpertTeamNode } from './xpert.model';
+export declare function omitXpertRelations(xpert: Partial<IXpert>): {
+    environmentId?: string;
+    environment?: import("./environment.model").IEnvironment;
+    knowledgebase?: import("./knowledgebase.model").IKnowledgebase;
+    workspaceId?: string;
+    workspace?: import("./xpert-workspace.model").IXpertWorkspace;
+    publishAt?: Date;
+    deletedAt?: Date;
+    organizationId?: string;
+    organization?: import("..").IOrganization;
+    tenantId?: string;
+    tenant?: import("..").ITenant;
+    id?: string;
+    createdById?: string;
+    createdBy?: import("..").IUser;
+    updatedById?: string;
+    updatedBy?: import("..").IUser;
+    createdAt?: Date;
+    updatedAt?: Date;
+    slug?: string;
+    name?: string;
+    type?: import("./xpert.model").XpertTypeEnum;
+    title?: string;
+    titleCN?: string;
+    description?: string;
+    active?: boolean;
+    avatar?: import("../types").TAvatar;
+    starters?: string[];
+    options?: import("./xpert.model").TXpertOptions;
+    agentConfig?: import("./xpert.model").TXpertAgentConfig;
+    summarize?: import("./xpert.model").TSummarize;
+    memory?: import("./xpert.model").TLongTermMemory;
+    features?: import("./xpert.model").TXpertFeatures;
+    version?: string;
+    latest?: boolean;
+    releaseNotes?: string;
+    graph?: import("./xpert.model").TXpertGraph;
+    api?: import("./xpert.model").TChatApi;
+    app?: import("./xpert.model").TChatApp;
+    userId?: string;
+    user?: import("..").IUser;
+    copilotModel?: import("./copilot-model.model").ICopilotModel;
+    copilotModelId?: string;
+    integrations?: import("..").IIntegration<any>[];
+    tags?: import("..").ITag[];
+};
+export declare function figureOutXpert(xpert: IXpert, isDraft: boolean): Partial<IXpert>;
+export declare function xpertLabel(agent: Partial<IXpert>): string;
+export declare function createXpertGraph(xpert: IXpert, position: IPoint): {
+    nodes: TXpertTeamNode[];
+    size: {
+        width: number;
+        height: number;
+    };
+    connections: import("./xpert.model").TXpertTeamConnection[];
+};
+export declare function locateNodes(nodes: TXpertTeamNode[], position: IPoint): {
+    size: {
+        width: number;
+        height: number;
+    };
+    nodes: TXpertTeamNode[];
+};
+/**
+ * Create all nodes of xpert and it's area size
+ *
+ * @param xpert
+ * @returns
+ */
+export declare function createXpertNodes(xpert: IXpert, position: IPoint): {
+    nodes: TXpertTeamNode[];
+    size: {
+        width: number;
+        height: number;
+    };
+};
+export declare function createAgentConnections(agent: IXpertAgent, collaborators: IXpert[]): any[];

package/src/base-entity.model.d.ts

@@ -3,7 +3,7 @@ import { IOrganization } from './organization.model';
 import { ID } from './types';
 import { IUser } from './user.model';
 export interface IBaseRelationsEntityModel {
-    readonly relations?: string[];
+    relations?: string[];
 }
 export interface IBaseSoftDeleteEntityModel {
     deletedAt?: Date;

package/src/feature.model.d.ts

@@ -71,8 +71,8 @@ export interface IFeatureToggle {
     lastSeenAt?: string | null;
 }
 export declare enum FeatureEnum {
-    FEATURE_DASHBOARD = "FEATURE_DASHBOARD",
     FEATURE_HOME = "FEATURE_HOME",
+    FEATURE_DASHBOARD = "FEATURE_DASHBOARD",
     FEATURE_JOB = "FEATURE_JOB",
     FEATURE_EMPLOYEES = "FEATURE_EMPLOYEES",
     FEATURE_MANAGE_INVITE = "FEATURE_MANAGE_INVITE",

package/src/index.d.ts

@@ -23,7 +23,7 @@ export * from './seed.model';
 export * from './tag-entity.model';
 export * from './tenant.model';
 export * from './translation.model';
-export type { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel } from './base-entity.model';
+export type { IBasePerTenantAndOrganizationEntityModel, IBasePerTenantEntityModel, IBaseRelationsEntityModel } from './base-entity.model';
 export type { IBaseEntityModel as BaseEntityModel } from './base-entity.model';
 export * from './role.model';
 export * from './user-organization.model';

package/src/integration.model.d.ts

@@ -2,7 +2,7 @@ import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
 import { IOrganizationProjectsUpdateInput } from './organization-projects.model';
 import { IOrganizationUpdateInput } from './organization.model';
 import { ITag } from './tag-entity.model';
-import { I18nObject, TAvatar, TParameterSchema } from './types';
+import { I18nObject, IconDefinition, TAvatar, TParameterSchema } from './types';
 export interface IIntegration<T = any> extends IBasePerTenantAndOrganizationEntityModel {
     name: string;
     description?: string;
@@ -76,10 +76,7 @@ export type TIntegrationProvider = {
     label: I18nObject;
     description?: I18nObject;
     avatar?: string;
-    icon?: {
-        svg: string;
-        color: string;
-    };
+    icon?: IconDefinition;
     webhook?: boolean;
     schema?: TParameterSchema;
     features?: IntegrationFeatureEnum[];

package/src/plugin.d.ts

@@ -4,10 +4,10 @@ export interface PluginMeta {
     name: PluginName;
     version: string;
     icon?: IconDefinition;
-    category?: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration';
+    category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration';
     displayName: string;
     description: string;
     keywords?: string[];
-    author?: string;
+    author: string;
     homepage?: string;
 }