@xpert-ai/plugin-sdk 3.6.2 → 3.6.3

package/package.json

@@ -1,7 +1,14 @@
 {
   "name": "@xpert-ai/plugin-sdk",
-  "version": "3.6.2",
+  "version": "3.6.3",
   "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xpert-ai/xpert.git"
+  },
+  "bugs": {
+    "url": "https://github.com/xpert-ai/xpert/issues"
+  },
   "dependencies": {},
   "main": "./index.cjs.js",
   "module": "./index.esm.js",
@@ -16,9 +23,11 @@
     "lodash-es": "*",
     "i18next-fs-backend": "*",
     "i18next": "*",
-    "zod": "*",
+    "jsonwebtoken": "*",
     "fs": "*",
+    "path": "*",
+    "passport-jwt": "*",
     "stream": "*",
-    "path": "*"
+    "zod": "*"
   }
 }

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,7 @@
+/// <reference types="node" />
+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: IncomingMessage, res: 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/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>;
 }