@xpert-ai/plugin-sdk 3.6.2 → 3.6.5

package/package.json

@@ -1,13 +1,22 @@
 {
   "name": "@xpert-ai/plugin-sdk",
-  "version": "3.6.2",
+  "version": "3.6.5",
   "license": "AGPL-3.0",
-  "dependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xpert-ai/xpert.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xpert-ai/xpert/issues"
+  },
   "main": "./index.cjs.js",
   "module": "./index.esm.js",
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "js-tiktoken": "^1.0.21"
+  },
   "peerDependencies": {
     "@langchain/core": "*",
     "@metad/contracts": "*",
@@ -16,9 +25,12 @@
     "lodash-es": "*",
     "i18next-fs-backend": "*",
     "i18next": "*",
-    "zod": "*",
+    "jsonwebtoken": "*",
     "fs": "*",
+    "path": "*",
+    "passport-jwt": "*",
     "stream": "*",
-    "path": "*"
+    "yaml": "*",
+    "zod": "*"
   }
 }

package/src/lib/ai-model/errors.d.ts

@@ -3,3 +3,5 @@ export declare class AiModelNotFoundException extends NotFoundException {
 }
 export declare class CredentialsValidateFailedError extends ForbiddenException {
 }
+export declare class AIModelProviderNotFoundException extends NotFoundException {
+}

package/src/lib/ai-model/index.d.ts

@@ -6,3 +6,4 @@ export * from './types';
 export * from './llm';
 export * from './errors';
 export * from './openai-compatible';
+export * from './utils/index';

package/src/lib/ai-model/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './tokenizer';

package/src/lib/ai-model/utils/tokenizer.d.ts

@@ -0,0 +1,10 @@
+import type { TiktokenEncoding } from 'js-tiktoken';
+/**
+ * Count tokens in text
+ * 1) Preferred: js-tiktoken precise encoding
+ * 2) Fallback: estimated token count
+ */
+export declare function countTokensSafe(text: string, opts?: {
+    model?: string;
+    encodingName?: TiktokenEncoding | string;
+}): number;

package/src/lib/core/context/index.d.ts

@@ -0,0 +1,2 @@
+export * from './request-context';
+export * from './request-context.middleware';

package/src/lib/core/context/request-context.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { IUser, LanguagesEnum, PermissionsEnum, RolesEnum } from '@metad/contracts';
+import type { IncomingMessage, ServerResponse } from 'http';
+import { AsyncLocalStorage } from 'node:async_hooks';
+export declare class RequestContext {
+    readonly request: IncomingMessage;
+    readonly response: ServerResponse;
+    readonly reqId: string;
+    readonly userId?: string;
+    readonly extras: Record<string, any>;
+    constructor(request: IncomingMessage, response: ServerResponse, reqId: string, userId?: string, extras?: Record<string, any>);
+    static currentRequestContext(): RequestContext;
+    static currentRequest(): IncomingMessage;
+    static currentTenantId(): string;
+    static currentUserId(): string;
+    static currentRoleId(): string;
+    static currentUser(throwError?: boolean): IUser;
+    static hasPermission(permission: PermissionsEnum | string, throwError?: boolean): boolean;
+    /**
+     * Retrieves the language code from the headers of the current request.
+     * @returns The language code (LanguagesEnum) extracted from the headers, or the default language (ENGLISH) if not found.
+     */
+    static getLanguageCode(): LanguagesEnum;
+    static getOrganizationId(): string;
+    static hasPermissions(findPermissions: Array<PermissionsEnum | string>, throwError?: boolean): boolean;
+    static hasAnyPermission(findPermissions: PermissionsEnum[], throwError?: boolean): boolean;
+    static currentToken(throwError?: boolean): any;
+    /**
+     * Checks if the current user has a specific role.
+     * @param {RolesEnum} role - The role to check.
+     * @param {boolean} throwError - Flag indicating whether to throw an error if the role is not granted.
+     * @returns {boolean} - True if the user has the role, otherwise false.
+     */
+    static hasRole(role: RolesEnum, throwError?: boolean): boolean;
+    /**
+     * Checks if the current request context has any of the specified roles.
+     *
+     * @param roles - An array of roles to check.
+     * @param throwError - Whether to throw an error if no roles are found.
+     * @returns True if any of the required roles are found, otherwise false.
+     */
+    static hasRoles(roles: RolesEnum[], throwError?: boolean): boolean;
+}
+export declare const als: AsyncLocalStorage<RequestContext>;
+export declare function getRequestContext(): RequestContext;

package/src/lib/core/context/request-context.middleware.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="node" />
+import { IUser } from '@metad/contracts';
+import { NestMiddleware } from '@nestjs/common';
+import { IncomingMessage, ServerResponse } from 'node:http';
+export declare class RequestContextMiddleware implements NestMiddleware {
+    use(req: IncomingMessage, _res: ServerResponse, next: () => void): void;
+}
+export declare function runWithRequestContext(req: Partial<IncomingMessage> & {
+    user?: IUser;
+}, res: Partial<ServerResponse>, next: () => void): void;

package/src/lib/core/index.d.ts

@@ -3,3 +3,4 @@ export * from './permissions';
 export * from './schema';
 export * from './i18n';
 export * from './utils';
+export * from './context/index';

package/src/lib/data/datasource/adapter.strategy.d.ts

@@ -11,8 +11,16 @@ export declare abstract class AdapterDataSourceStrategy<TOptions extends Adapter
     abstract readonly name: string;
     readonly description?: string;
     private configurationSchemaCache;
+    private runners;
     protected constructor(runnerClass: DBQueryRunnerType, extraArgs?: unknown[]);
-    create(options: TOptions): Promise<DBQueryRunner>;
+    /**
+     * Get from cache or create new instance of DB adapter.
+     *
+     * @param options
+     * @param id
+     * @returns
+     */
+    create(options: TOptions, id?: string): Promise<DBQueryRunner>;
     configurationSchema(): Promise<Record<string, unknown>>;
     teardown(runner: DBQueryRunner): Promise<void>;
     protected instantiateRunner(options: TOptions | undefined): DBQueryRunner;

package/src/lib/data/datasource/strategy.interface.d.ts

@@ -6,7 +6,7 @@ export interface IDataSourceStrategy<TOptions extends AdapterBaseOptions = Adapt
     /**
      * Create a query runner for the given data source options.
      */
-    create(options: TOptions): Promise<DBQueryRunner> | DBQueryRunner;
+    create(options: TOptions, id?: string): Promise<DBQueryRunner> | DBQueryRunner;
     /**
      * Optional configuration schema description for UI generation.
      */

package/src/lib/data/datasource/types.d.ts

@@ -36,6 +36,7 @@ export declare enum DBProtocolEnum {
 export interface QueryOptions {
     catalog?: string;
     headers?: Record<string, string>;
+    params?: Record<string, any>[];
 }
 export interface QueryResult<T = unknown> {
     status: 'OK' | 'ERROR';
@@ -59,6 +60,7 @@ export interface DBQueryRunner {
     jdbcDriver: string;
     configurationSchema: Record<string, unknown>;
     jdbcUrl(schema?: string): string;
+    initPool?(options: AdapterBaseOptions): Promise<void>;
     /**
      * Execute a sql query
      *
@@ -116,6 +118,11 @@ export interface DBQueryRunner {
      * @param options
      */
     dropTable(name: string, options?: QueryOptions): Promise<void>;
+    /**
+     * Unified table operation executor
+     */
+    tableOp(action: DBTableAction, params: DBTableOperationParams, options?: QueryOptions): Promise<any>;
+    tableDataOp<T = any>(action: DBTableDataAction, params: DBTableDataParams, options?: QueryOptions): Promise<T[] | number | any>;
     /**
      * Teardown all resources:
      * - close connection
@@ -135,12 +142,22 @@ export interface ColumnDef {
     fieldName: string;
     /**
      * Object value type, convert to db type
+     * - string
+     * - number
+     * - boolean
+     * - date
+     * - datetime
+     * - object
      */
     type: string;
     /**
      * Is primary key column
      */
     isKey: boolean;
+    /**
+     * Is required column
+     */
+    required?: boolean;
     /**
      * length of type for column: varchar, decimal ...
      */
@@ -190,6 +207,8 @@ export declare abstract class BaseQueryRunner<T extends AdapterBaseOptions = Ada
         catalog?: string;
     }): Promise<void>;
     dropTable(name: string, options?: any): Promise<void>;
+    tableOp(action: DBTableAction, params: DBTableOperationParams, options?: QueryOptions): Promise<any>;
+    tableDataOp(action: DBTableDataAction, params: DBTableDataParams, options?: QueryOptions): Promise<any>;
     abstract teardown(): Promise<void>;
 }
 export interface HttpAdapterOptions extends AdapterBaseOptions {
@@ -253,3 +272,63 @@ export interface File {
     /** `MemoryStorage` only: A Buffer containing the entire file. */
     buffer: Buffer;
 }
+export declare enum DBTableAction {
+    LIST_TABLES = "listTables",
+    TABLE_EXISTS = "tableExists",
+    CREATE_TABLE = "createTable",
+    DROP_TABLE = "dropTable",
+    RENAME_TABLE = "renameTable",
+    TRUNCATE_TABLE = "truncateTable",
+    ADD_COLUMN = "addColumn",
+    DROP_COLUMN = "dropColumn",
+    MODIFY_COLUMN = "modifyColumn",
+    CREATE_INDEX = "createIndex",
+    DROP_INDEX = "dropIndex",
+    GET_TABLE_INFO = "getTableInfo",
+    CLONE_TABLE_STRUCTURE = "cloneTableStructure",
+    CLONE_TABLE = "cloneTable",
+    OPTIMIZE_TABLE = "optimizeTable"
+}
+export interface DBTableOperationParams {
+    schema?: string;
+    table?: string;
+    newTable?: string;
+    columns?: ColumnDef[];
+    column?: ColumnDef;
+    columnName?: string;
+    index?: DBIndexDefinition;
+    indexName?: string;
+    createMode?: DBCreateTableMode;
+}
+export interface DBIndexDefinition {
+    name: string;
+    columns: string[];
+    unique?: boolean;
+    type?: 'btree' | 'hash' | 'gin' | 'bitmap' | 'fulltext' | string;
+}
+export declare enum DBCreateTableMode {
+    ERROR = "error",// 表已存在 → 报错
+    IGNORE = "ignore",// 表已存在 → 什么也不做
+    UPGRADE = "upgrade"
+}
+export declare enum DBTableDataAction {
+    INSERT = "insert",
+    UPDATE = "update",
+    UPSERT = "upsert",
+    DELETE = "delete",
+    SELECT = "select",
+    BULK_INSERT = "bulkInsert"
+}
+export interface DBTableDataParams {
+    schema?: string;
+    table: string;
+    columns?: Partial<ColumnDef>[];
+    where?: Record<string, any> | string;
+    orderBy?: string;
+    limit?: number;
+    offset?: number;
+    values?: Record<string, any> | Array<Record<string, any>>;
+    set?: Record<string, any>;
+    deleteWhere?: Record<string, any> | string;
+    conflictKeys?: string[];
+}

package/src/lib/rag/image/strategy.interface.d.ts

@@ -27,5 +27,5 @@ export interface IImageUnderstandingStrategy<TConfig extends TImageUnderstanding
     /**
      * Understand image files (e.g., OCR, VLM, Chart Parsing)
      */
-    understandImages(doc: IKnowledgeDocument<ChunkMetadata>, config: TConfig): Promise<TImageUnderstandingResult>;
+    understandImages(doc: IKnowledgeDocument, config: TConfig): Promise<TImageUnderstandingResult>;
 }