plugin-file-preview-auth 1.2.3 → 1.2.6

package/dist/client/AIFilePreviewAction.d.ts

@@ -0,0 +1,37 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+import type { Application } from '@nocobase/client';
+export declare const FILE_PREVIEW_WORK_CONTEXT_TYPE = "file-preview";
+export declare function createFilePreviewWorkContext(file: any): {
+    type: string;
+    uid: string;
+    title: string;
+    content: {
+        source: string;
+        file: {
+            id: any;
+            uid: any;
+            url: any;
+            preview: any;
+            filename: any;
+            name: any;
+            title: any;
+            extname: any;
+            mimetype: any;
+            size: any;
+            path: any;
+            storageId: any;
+        };
+    };
+};
+export declare const AIFilePreviewAction: React.FC<{
+    file: any;
+}>;
+export declare function registerFilePreviewAIWorkContext(app: Application): void;

package/dist/client/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Plugin } from '@nocobase/client';
+export declare class PluginFilePreviewAuthClient extends Plugin {
+    load(): Promise<void>;
+}
+export default PluginFilePreviewAuthClient;

package/dist/client/locale.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare function useT(): (str: string) => string;
+export declare function tStr(key: string): string;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export * from './server';
+export { default } from './server';

package/dist/server/collections/attachments.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    name: string;
+    fields: ({
+        name: string;
+        type: string;
+        defaultValue: string;
+    } | {
+        name: string;
+        type: string;
+        defaultValue?: undefined;
+    })[];
+};
+export default _default;

package/dist/server/collections/file-preview-auth.d.ts

@@ -0,0 +1,22 @@
+/**
+ * DUMMY COLLECTION
+ * This collection is created to prevent NocoBase workflow/ACL from throwing the error:
+ * '[Workflow pre-action]: collection "filePreviewAuth" not found'
+ *
+ * Since 'filePreviewAuth' is registered as a resourcer in plugin.ts, NocoBase
+ * implicitly looks for a collection with the same name.
+ * We set dumpRules: 'skip' and avoid timestamps to ensure this collection
+ * is completely ignored during backups/migrations and doesn't pollute the actual DB.
+ */
+declare const _default: {
+    name: string;
+    dumpRules: string;
+    autoGenId: boolean;
+    createdAt: boolean;
+    updatedAt: boolean;
+    fields: {
+        name: string;
+        type: string;
+    }[];
+};
+export default _default;

package/dist/server/excel-parser-handler.d.ts

@@ -0,0 +1,60 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { Context } from '@nocobase/actions';
+interface AttachmentLike {
+    id?: string | number;
+    filename?: string;
+    name?: string;
+    mimetype?: string;
+    extname?: string;
+    url?: string;
+    storageId?: number;
+    size?: number;
+    meta?: Record<string, any>;
+    [key: string]: any;
+}
+interface InternalParseResult {
+    text: string;
+    handled: boolean;
+}
+export interface InternalParserHandler {
+    name: string;
+    supports(attachment: AttachmentLike): boolean;
+    parse(attachment: AttachmentLike, ctx: Context): Promise<InternalParseResult>;
+}
+/**
+ * Server-side Excel parser handler.
+ *
+ * Uses SheetJS (xlsx) — the same library already bundled by this plugin for
+ * client-side XLSX preview — to extract plain text from .xlsx/.xls files on
+ * the server.
+ *
+ * Each worksheet is converted to CSV and separated by a section header so LLMs
+ * can distinguish sheet boundaries:
+ *
+ *   === Sheet: Sheet1 ===
+ *   col1,col2,col3
+ *   val1,val2,val3
+ *
+ *   === Sheet: Sheet2 ===
+ *   ...
+ *
+ * This handler is registered into plugin-document-parser's InternalParserRegistry
+ * by PluginFilePreviewAuthServer with `prepend: true` so it takes priority over
+ * any other handlers that might be registered later.
+ *
+ * File bytes are fetched via plugin-document-parser's public `fetchFileBuffer`
+ * helper, which transparently handles both S3 URLs and local file paths.
+ */
+export declare class ExcelParserHandler implements InternalParserHandler {
+    readonly name = "file-preview-auth-excel-parser";
+    supports(attachment: AttachmentLike): boolean;
+    parse(attachment: AttachmentLike, ctx: Context): Promise<InternalParseResult>;
+}
+export {};

package/dist/server/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export { default } from './plugin';

package/dist/server/ocr/tesseract-runner.d.ts

@@ -0,0 +1,34 @@
+export interface OcrRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    unit: string;
+}
+export interface OcrWordItem {
+    id: string;
+    key: string;
+    value: string;
+    page: number;
+    confidence: number;
+    rect: OcrRect;
+    status: string;
+}
+export declare class TesseractRunner {
+    private log;
+    constructor(app: any);
+    /**
+     * Run Tesseract OCR on a file (PDF or Image).
+     * Generates word-level coordinates and text.
+     */
+    runOcr(filePath: string, attachmentId: number): Promise<{
+        pages: Array<{
+            page_number: number;
+            items: OcrWordItem[];
+        }>;
+    }>;
+    private executeTesseract;
+    private parseTsv;
+    private convertPdfToImages;
+    private generateMockOcrData;
+}

package/dist/server/ocr/tesseract-worker.d.ts

@@ -0,0 +1,26 @@
+export declare class TesseractWorker {
+    private app;
+    private db;
+    private log;
+    private runner;
+    private isRunning;
+    private pollTimer;
+    private redisKey;
+    constructor(app: any);
+    /**
+     * Start the background worker.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the background worker.
+     */
+    stop(): void;
+    /**
+     * Enqueue a new OCR job.
+     */
+    enqueue(attachmentId: number): Promise<boolean>;
+    private getRedisClient;
+    private listenRedisQueue;
+    private startDbPolling;
+    private processJob;
+}

package/dist/server/ocr/tesseract-worker.js

@@ -158,7 +158,7 @@ class TesseractWorker {
       if (!fileManager) {
         throw new Error("File manager plugin is not active.");
       }
-      const storageModel = fileManager.storagesCache.get(attachment.storageId);
+      const storageModel = getStorageFromCache(fileManager.storagesCache, attachment.storageId);
       if (!storageModel || storageModel.type !== "local") {
         this.log.info(`[TesseractWorker] Non-local storage detected or virtual file. Using fallback.`);
       }
@@ -185,6 +185,25 @@ class TesseractWorker {
     }
   }
 }
+function getStorageFromCache(cache, storageId) {
+  if (storageId === void 0 || storageId === null) return void 0;
+  let res = cache.get(storageId);
+  if (res) return res;
+  const strId = String(storageId);
+  res = cache.get(strId);
+  if (res) return res;
+  const numId = Number(storageId);
+  if (!isNaN(numId)) {
+    res = cache.get(numId);
+    if (res) return res;
+  }
+  for (const [k, v] of cache.entries()) {
+    if (String(k) === strId) {
+      return v;
+    }
+  }
+  return void 0;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   TesseractWorker

package/dist/server/plugin.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Plugin } from '@nocobase/server';
+export declare class PluginFilePreviewAuthServer extends Plugin {
+    private cache;
+    private ocrWorker;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+    afterEnable(): Promise<void>;
+    beforeDisable(): Promise<void>;
+    beforeDestroy(): Promise<void>;
+    /**
+     * Disable NocoBase's built-in Office previewer after plugins have loaded.
+     * This keeps this authenticated previewer as the active Office handler without causing a restart loop.
+     */
+    private disableBuiltinOfficePreviewer;
+    private registerDownloadApi;
+    private registerAIWorkContext;
+    private resolveAttachment;
+    private assertCanAccessAttachment;
+    private assertAuthenticated;
+    private consumeUploadedParseFile;
+    private extractUploadedFileText;
+    private getMarkItDownParserPlugin;
+    private extractAttachmentText;
+    private readAttachmentAsText;
+    private formatAttachmentWorkContext;
+    /**
+     * Register Excel handler into plugin-document-parser's InternalParserRegistry.
+     * Uses prepend:true so SheetJS takes priority over the AI-loader fallback.
+     * Silent no-op when plugin-document-parser is not loaded.
+     */
+    private registerExcelParser;
+}
+export default PluginFilePreviewAuthServer;

package/dist/server/plugin.js

@@ -188,28 +188,44 @@ class PluginFilePreviewAuthServer extends import_server.Plugin {
             await this.assertCanAccessAttachment(ctx, attachment);
           }
           try {
-            const storageModel = fileManager.storagesCache.get(attachment.storageId);
-            if (storageModel && (storageModel.type === "s3" || storageModel.type === "aws-s3")) {
+            let matchedKey = null;
+            const rawStorageId = attachment.storageId || getAttachmentValue(attachment, "storageId");
+            if (rawStorageId) {
+              const strId = String(rawStorageId);
+              for (const key of fileManager.storagesCache.keys()) {
+                if (String(key) === strId) {
+                  matchedKey = key;
+                  break;
+                }
+              }
+            }
+            const attachmentObj = typeof attachment.toJSON === "function" ? attachment.toJSON() : { ...attachment };
+            if (matchedKey !== null) {
+              attachmentObj.storageId = matchedKey;
+            }
+            const storageModel = getStorageFromCache(fileManager.storagesCache, attachmentObj.storageId);
+            if (storageModel && (storageModel.type === "s3" || storageModel.type === "aws-s3" || storageModel.type === "s3-private")) {
               const StorageTypeClass = fileManager.storageTypes.get(storageModel.type);
               const storageInstance = new StorageTypeClass(storageModel);
-              if (storageInstance.client) {
+              const s3Client = storageInstance.client || (typeof storageInstance.getS3Client === "function" ? storageInstance.getS3Client() : null);
+              if (s3Client) {
                 const { GetObjectCommand } = require("@aws-sdk/client-s3");
-                const key = storageInstance.getFileKey(attachment);
+                const key = storageInstance.getFileKey(attachmentObj);
                 const getCommand = new GetObjectCommand({
                   Bucket: storageModel.options.bucket,
                   Key: key
                 });
-                const response = await storageInstance.client.send(getCommand);
-                ctx.type = response.ContentType || attachment.mimetype || "application/octet-stream";
-                ctx.attachment(attachment.filename);
+                const response = await s3Client.send(getCommand);
+                ctx.type = response.ContentType || attachmentObj.mimetype || "application/octet-stream";
+                ctx.attachment(attachmentObj.filename);
                 ctx.body = response.Body;
                 await next();
                 return;
               }
             }
-            const { stream, contentType } = await fileManager.getFileStream(attachment);
-            ctx.type = contentType || attachment.mimetype || "application/octet-stream";
-            ctx.attachment(attachment.filename);
+            const { stream, contentType } = await fileManager.getFileStream(attachmentObj);
+            ctx.type = contentType || attachmentObj.mimetype || "application/octet-stream";
+            ctx.attachment(attachmentObj.filename);
             ctx.body = stream;
           } catch (err) {
             this.log.error(`[FilePreviewAuth] Error fetching stream for URL ${url}: ${err.message}`);
@@ -433,7 +449,22 @@ class PluginFilePreviewAuthServer extends import_server.Plugin {
     if (!(fileManager == null ? void 0 : fileManager.getFileStream)) {
       return "";
     }
-    const { stream } = await fileManager.getFileStream(attachment);
+    let matchedKey = null;
+    const rawStorageId = attachment.storageId || getAttachmentValue(attachment, "storageId");
+    if (rawStorageId) {
+      const strId = String(rawStorageId);
+      for (const key of fileManager.storagesCache.keys()) {
+        if (String(key) === strId) {
+          matchedKey = key;
+          break;
+        }
+      }
+    }
+    const attachmentObj = typeof attachment.toJSON === "function" ? attachment.toJSON() : { ...attachment };
+    if (matchedKey !== null) {
+      attachmentObj.storageId = matchedKey;
+    }
+    const { stream } = await fileManager.getFileStream(attachmentObj);
     const chunks = [];
     for await (const chunk of stream) {
       chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
@@ -479,6 +510,25 @@ class PluginFilePreviewAuthServer extends import_server.Plugin {
   }
 }
 var plugin_default = PluginFilePreviewAuthServer;
+function getStorageFromCache(cache, storageId) {
+  if (storageId === void 0 || storageId === null) return void 0;
+  let res = cache.get(storageId);
+  if (res) return res;
+  const strId = String(storageId);
+  res = cache.get(strId);
+  if (res) return res;
+  const numId = Number(storageId);
+  if (!isNaN(numId)) {
+    res = cache.get(numId);
+    if (res) return res;
+  }
+  for (const [k, v] of cache.entries()) {
+    if (String(k) === strId) {
+      return v;
+    }
+  }
+  return void 0;
+}
 function getAttachmentValue(attachment, key) {
   if (!attachment) return void 0;
   if (typeof attachment.get === "function") return attachment.get(key);

package/package.json

@@ -6,7 +6,7 @@
   "description": "Preview PDF, image, and text files with Bearer token authentication via blob URLs.",
   "description.vi-VN": "Xem trước file PDF, hình ảnh và văn bản với xác thực Bearer token qua blob URL.",
   "description.zh-CN": "通过 Bearer 令牌认证和 Blob URL 预览 PDF、图片和文本文件。",
-  "version": "1.2.3",
+  "version": "1.2.6",
   "main": "dist/server/index.js",
   "files": [
     "dist",