@xpert-ai/plugin-sdk 3.8.4 → 3.9.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xpert-ai/plugin-sdk",
-  "version": "3.8.4",
+  "version": "3.9.0-beta.0",
   "license": "AGPL-3.0",
   "repository": {
     "type": "git",
@@ -37,5 +37,6 @@
     "stream": "*",
     "yaml": "*",
     "zod": "*"
-  }
-}
+  },
+  "types": "./index.d.ts"
+}

package/src/index.d.ts

@@ -16,3 +16,4 @@ export * from './lib/channel/index';
 export * from './lib/file/index';
 export * from './lib/strategy';
 export * from './lib/sandbox/index';
+export * from './lib/view-extension/index';

package/src/lib/agent/handoff/handoff-processor.decorator.d.ts

@@ -8,4 +8,4 @@ export declare const HANDOFF_PROCESSOR_STRATEGY = "HANDOFF_PROCESSOR_STRATEGY";
  * 1) Which message types it handles
  * 2) Default execution policy (lane/timeout)
  */
-export declare function HandoffProcessorStrategy(provider: string, metadata: HandoffProcessorMetadata): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare function HandoffProcessorStrategy(provider: string, metadata: HandoffProcessorMetadata): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

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

@@ -1,2 +1,3 @@
+export * from './skill/index';
 export * from './middleware';
 export * from './handoff';

package/src/lib/agent/middleware/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const AGENT_MIDDLEWARE_STRATEGY = "AGENT_MIDDLEWARE_STRATEGY";
-export declare const AgentMiddlewareStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const AgentMiddlewareStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/agent/skill/skill-source-provider.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const SKILL_SOURCE_PROVIDER = "SKILL_SOURCE_PROVIDER";
-export declare const SkillSourceProviderStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const SkillSourceProviderStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/agent/skill/skill-source-provider.interface.d.ts

@@ -1,4 +1,4 @@
-import { ISkillRepository, ISkillRepositoryIndex, TSkillSourceMeta } from "@metad/contracts";
+import { ISkillRepository, ISkillRepositoryIndex, TSkillSourceMeta } from '@metad/contracts';
 export interface ISkillSourceProvider {
     type: string;
     meta: TSkillSourceMeta;

package/src/lib/channel/strategy.interface.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { IIntegration } from '@metad/contracts';
 import { Request, Response, NextFunction } from 'express';
 /**

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

@@ -1,6 +1,4 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { IUser, LanguagesEnum, PermissionsEnum, RolesEnum } from '@metad/contracts';
+import { IApiKey, IRequestScopeContext, IUser, LanguagesEnum, PermissionsEnum, RolesEnum } from '@metad/contracts';
 import type { IncomingMessage, ServerResponse } from 'http';
 import { AsyncLocalStorage } from 'node:async_hooks';
 export declare class RequestContext {
@@ -12,6 +10,7 @@ export declare class RequestContext {
     constructor(request: IncomingMessage, response: ServerResponse, reqId: string, userId?: string, extras?: Record<string, any>);
     static currentRequestContext(): RequestContext;
     static currentRequest(): IncomingMessage;
+    static currentApiKey(): IApiKey | null;
     static currentTenantId(): string;
     static currentUserId(): string;
     static currentRoleId(): string;
@@ -22,7 +21,11 @@ export declare class RequestContext {
      * @returns The language code (LanguagesEnum) extracted from the headers, or the default language (ENGLISH) if not found.
      */
     static getLanguageCode(): LanguagesEnum;
-    static getOrganizationId(): string;
+    static getScope(): IRequestScopeContext;
+    static getOrganizationId(): string | null;
+    static isTenantScope(): boolean;
+    static isOrganizationScope(): boolean;
+    static requireOrganizationScope(): string;
     static hasPermissions(findPermissions: Array<PermissionsEnum | string>, throwError?: boolean): boolean;
     static hasAnyPermission(findPermissions: PermissionsEnum[], throwError?: boolean): boolean;
     static currentToken(throwError?: boolean): any;

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { IUser } from '@metad/contracts';
 import { NestMiddleware } from '@nestjs/common';
 import { IncomingMessage, ServerResponse } from 'node:http';

package/src/lib/core/file-system.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { FileSystemPermission } from './permissions';
 /**
  * Restricted FileSystem based on granted permissions
@@ -35,7 +33,7 @@ export declare class XpFileSystem {
     /**
      * Read file contents
      */
-    readFile(filePath: string, encoding?: BufferEncoding): Promise<Buffer>;
+    readFile(filePath: string, encoding?: BufferEncoding): Promise<NonSharedBuffer>;
     /**
      * Write file contents
      */

package/src/lib/core/permissions/analytics.d.ts

@@ -1,4 +1,3 @@
-import type { DSCoreService } from '@metad/ocap-core';
 import type { BasePermission } from './general';
 export type AnalyticsPermissionOperation = 'dscore' | 'query' | 'model' | 'indicator' | 'create_indicator';
 /**
@@ -37,9 +36,9 @@ export interface AnalyticsIndicatorValidationInput {
 /**
  * Analytics service exposed to plugins under permission control.
  */
-export interface AnalyticsPermissionService {
+export interface AnalyticsPermissionService<TDSCoreService = unknown> {
     resolveChatBIModels(modelIds: string[]): Promise<AnalyticsResolvedChatBIModel[]>;
-    getDSCoreService(input?: AnalyticsDSCoreInput): Promise<DSCoreService>;
+    getDSCoreService(input?: AnalyticsDSCoreInput): Promise<TDSCoreService>;
     visitChatBIModel(modelId: string, cubeName: string): Promise<void>;
     ensureCreateIndicatorAccess(): Promise<void>;
     validateIndicatorStatement(input: AnalyticsIndicatorValidationInput): Promise<void>;

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

@@ -1,2 +1,2 @@
 export declare const DATASOURCE_STRATEGY = "DATASOURCE_STRATEGY";
-export declare const DataSourceStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const DataSourceStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

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

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as _axios from 'axios';
 import { Readable } from 'stream';
 import { IColumnDef, IDSSchema, IDSTable } from '@metad/contracts';

package/src/lib/file/file-storage/provider.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const FILE_STORAGE_PROVIDER = "FILE_STORAGE_PROVIDER";
-export declare const FileStorageProvider: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const FileStorageProvider: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/file/file-storage/provider.interface.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { FileStorageOption, FileSystem, UploadedFile } from '@metad/contracts';
 export interface IFileStorageProvider {
     readonly name: string;

package/src/lib/file/file-upload/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const FILE_UPLOAD_TARGET_STRATEGY = "FILE_UPLOAD_TARGET_STRATEGY";
-export declare const FileUploadTargetStrategy: (type: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const FileUploadTargetStrategy: (type: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/file/file-upload/strategy.interface.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { IFileAssetDestination, IFileAssetSource, IStorageFile, IUploadFileTarget } from '@metad/contracts';
 export type TFileUploadRequestContext = {
     tenantId?: string;

package/src/lib/integration/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const INTEGRATION_STRATEGY = "INTEGRATION_STRATEGY";
-export declare const IntegrationStrategyKey: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const IntegrationStrategyKey: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

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

@@ -2,4 +2,4 @@ export declare const IMAGE_UNDERSTANDING_STRATEGY = "IMAGE_UNDERSTANDING_STRATEG
 /**
  * Decorator to mark a provider as an Image Understanding Strategy
  */
-export declare const ImageUnderstandingStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const ImageUnderstandingStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/rag/knowledge/knowledge-strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const KNOWLEDGE_STRATEGY = "KNOWLEDGE_STRATEGY";
-export declare const KnowledgeStrategyKey: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const KnowledgeStrategyKey: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/rag/retriever/strategy.decorator.d.ts

@@ -2,4 +2,4 @@ export declare const RETRIEVER_STRATEGY = "RETRIEVER_STRATEGY";
 /**
  * Decorator to mark a provider as a Retriever Strategy
  */
-export declare const RetrieverStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const RetrieverStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/rag/source/strategy.decorator.d.ts

@@ -2,4 +2,4 @@ export declare const DOCUMENT_SOURCE_STRATEGY = "DOCUMENT_SOURCE_STRATEGY";
 /**
  * Decorator to mark a provider as a Document Source Strategy
  */
-export declare const DocumentSourceStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const DocumentSourceStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/rag/textsplitter/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const TEXT_SPLITTER_STRATEGY = "TEXT_SPLITTER_STRATEGY";
-export declare const TextSplitterStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const TextSplitterStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/rag/transformer/strategy.decorator.d.ts

@@ -2,4 +2,4 @@ export declare const DOCUMENT_TRANSFORMER_STRATEGY = "DOCUMENT_TRANSFORMER_STRAT
 /**
  * Decorator to mark a provider as a Document Transformer Strategy
  */
-export declare const DocumentTransformerStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const DocumentTransformerStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/sandbox/protocol.d.ts

@@ -1,3 +1,4 @@
+import { IBackendProtocol, TSandboxConfigurable } from '@metad/contracts';
 import type { SandboxExecutionOptions } from './execution';
 /**
  * Protocol definition for pluggable memory backends.
@@ -190,7 +191,7 @@ export interface FileUploadResponse {
  * Methods can return either direct values or Promises, allowing both
  * synchronous and asynchronous implementations.
  */
-export interface BackendProtocol {
+export interface BackendProtocol extends IBackendProtocol {
     /**
      * Structured listing with file metadata.
      *
@@ -346,13 +347,8 @@ export interface SandboxBackendProtocol extends BackendProtocol {
     /** Canonical sandbox environment identifier bound to this backend */
     readonly environmentId?: string | null;
 }
-/**
- * Type guard to check if a backend supports execution.
- *
- * @param backend - Backend instance to check
- * @returns True if the backend implements SandboxBackendProtocol
- */
-export declare function isSandboxBackend(backend: BackendProtocol): backend is SandboxBackendProtocol;
+export declare function isSandboxBackend(backend: unknown): backend is SandboxBackendProtocol;
+export declare function resolveSandboxBackend(sandbox: TSandboxConfigurable | SandboxBackendProtocol | null | undefined | unknown): SandboxBackendProtocol | null;
 /**
  * State and store container for backend initialization.
  *

package/src/lib/sandbox/sandbox.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const SANDBOX_PROVIDER = "SANDBOX_PROVIDER";
-export declare const SandboxProviderStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const SandboxProviderStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/strategy.d.ts

@@ -1,6 +1,6 @@
-import { OnModuleInit } from "@nestjs/common";
-import { DiscoveryService, Reflector } from "@nestjs/core";
-import { StrategyBus } from "./core/strategy-bus";
+import { OnModuleInit } from '@nestjs/common';
+import { DiscoveryService, Reflector } from '@nestjs/core';
+import { StrategyBus } from './core/strategy-bus';
 export declare class BaseStrategyRegistry<S> implements OnModuleInit {
     protected readonly strategyKey: string;
     protected discoveryService: DiscoveryService;

package/src/lib/toolset/strategy.decorator.d.ts

@@ -2,4 +2,4 @@ export declare const TOOLSET_STRATEGY = "TOOLSET_STRATEGY";
 /**
  * Decorator to mark a provider as a Toolset Strategy
  */
-export declare const ToolsetStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const ToolsetStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/vectorstore/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const VECTOR_STORE_STRATEGY = "VECTOR_STORE_STRATEGY";
-export declare const VectorStoreStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const VectorStoreStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/view-extension/index.d.ts

@@ -0,0 +1,3 @@
+export * from './provider.decorator';
+export * from './provider.interface';
+export * from './provider.registry';

package/src/lib/view-extension/provider.decorator.d.ts

@@ -0,0 +1,2 @@
+export declare const VIEW_EXTENSION_PROVIDER = "VIEW_EXTENSION_PROVIDER";
+export declare const ViewExtensionProvider: (providerKey: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/view-extension/provider.interface.d.ts

@@ -0,0 +1,7 @@
+import { XpertExtensionViewManifest, XpertResolvedViewHostContext, XpertViewActionRequest, XpertViewActionResult, XpertViewDataResult, XpertViewQuery } from '@metad/contracts';
+export interface IXpertViewExtensionProvider {
+    supports(context: XpertResolvedViewHostContext): Promise<boolean> | boolean;
+    getViewManifests(context: XpertResolvedViewHostContext, slot: string): Promise<XpertExtensionViewManifest[]> | XpertExtensionViewManifest[];
+    getViewData(context: XpertResolvedViewHostContext, viewKey: string, query: XpertViewQuery): Promise<XpertViewDataResult> | XpertViewDataResult;
+    executeViewAction?(context: XpertResolvedViewHostContext, viewKey: string, actionKey: string, request: XpertViewActionRequest): Promise<XpertViewActionResult> | XpertViewActionResult;
+}

package/src/lib/view-extension/provider.registry.d.ts

@@ -0,0 +1,10 @@
+import { DiscoveryService, Reflector } from '@nestjs/core';
+import { BaseStrategyRegistry } from '../strategy';
+import { IXpertViewExtensionProvider } from './provider.interface';
+export declare class ViewExtensionProviderRegistry extends BaseStrategyRegistry<IXpertViewExtensionProvider> {
+    constructor(discoveryService: DiscoveryService, reflector: Reflector);
+    listEntries(organizationId?: string): Array<{
+        providerKey: string;
+        provider: IXpertViewExtensionProvider;
+    }>;
+}

package/src/lib/workflow/node/strategy.decorator.d.ts

@@ -2,4 +2,4 @@ export declare const WORKFLOW_NODE_STRATEGY = "WORKFLOW_NODE_STRATEGY";
 /**
  * Decorator to mark a provider as a Workflow Node Strategy
  */
-export declare const WorkflowNodeStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const WorkflowNodeStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/src/lib/workflow/trigger/strategy.decorator.d.ts

@@ -1,2 +1,2 @@
 export declare const WORKFLOW_TRIGGER_STRATEGY = "WORKFLOW_TRIGGER_STRATEGY";
-export declare const WorkflowTriggerStrategy: (provider: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+export declare const WorkflowTriggerStrategy: (provider: string) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";