plugin-file-preview-auth 1.3.5 → 1.3.6

package/dist/server/plugin.js

@@ -325,10 +325,14 @@ class PluginFilePreviewAuthServer extends import_server.Plugin {
           const params = ctx.action.params || {};
           const reqBody = ctx.request.body || {};
           const values = params.values || {};
-          const attachmentId = values.attachmentId || reqBody.attachmentId;
-          if (!attachmentId) {
+          const rawAttachmentId = values.attachmentId || reqBody.attachmentId;
+          if (!rawAttachmentId) {
             ctx.throw(400, "attachmentId is required");
           }
+          const attachmentId = normalizeOcrAttachmentId(rawAttachmentId);
+          if (!attachmentId) {
+            ctx.throw(400, "attachmentId must be a numeric attachment record id");
+          }
           this.assertAuthenticated(ctx);
           const repo = ctx.db.getRepository("attachments");
           const attachment = await repo.findOne({ filterByTk: attachmentId });
@@ -352,10 +356,14 @@ class PluginFilePreviewAuthServer extends import_server.Plugin {
           const reqQuery = ctx.request.query || {};
           const reqBody = ctx.request.body || {};
           const values = params.values || {};
-          const attachmentId = values.attachmentId || params.attachmentId || reqQuery.attachmentId || reqBody.attachmentId;
-          if (!attachmentId) {
+          const rawAttachmentId = values.attachmentId || params.attachmentId || reqQuery.attachmentId || reqBody.attachmentId;
+          if (!rawAttachmentId) {
             ctx.throw(400, "attachmentId is required");
           }
+          const attachmentId = normalizeOcrAttachmentId(rawAttachmentId);
+          if (!attachmentId) {
+            ctx.throw(400, "attachmentId must be a numeric attachment record id");
+          }
           this.assertAuthenticated(ctx);
           const repo = ctx.db.getRepository("attachments");
           const attachment = await repo.findOne({ filterByTk: attachmentId });
@@ -1160,6 +1168,16 @@ function isLikelyRecordId(value) {
   const text = String(value);
   return !text.includes("/") && !text.startsWith("http://") && !text.startsWith("https://");
 }
+function normalizeOcrAttachmentId(value) {
+  if (typeof value === "number") {
+    return Number.isInteger(value) && value > 0 ? value : null;
+  }
+  if (typeof value === "string") {
+    const trimmed = value.trim();
+    return /^\d+$/.test(trimmed) ? trimmed : null;
+  }
+  return null;
+}
 function getUrlCandidates(value) {
   if (!value) return [];
   const original = decodePossiblyEncodedUrl(String(value));

package/package.json

@@ -1,45 +1,57 @@
-{
-  "name": "plugin-file-preview-auth",
-  "displayName": "Authenticated File Previewer",
-  "displayName.vi-VN": "Xem trước file có xác thực",
-  "displayName.zh-CN": "认证文件预览",
-  "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.3.5",
-  "main": "dist/server/index.js",
-  "files": [
-    "dist",
-    "public",
-    "client.js",
-    "client.d.ts",
-    "server.js",
-    "server.d.ts",
-    "README.md"
-  ],
-  "peerDependencies": {
-    "@nocobase/client": "2.x",
-    "@nocobase/database": "2.x",
-    "@nocobase/plugin-ai": "2.x",
-    "@nocobase/plugin-file-manager": "2.x",
-    "@nocobase/server": "2.x",
-    "@nocobase/utils": "2.x"
-  },
-  "peerDependenciesMeta": {
-    "@nocobase/plugin-ai": {
-      "optional": true
-    }
-  },
-  "devDependencies": {},
-  "keywords": [
-    "File manager",
-    "File preview",
-    "Authentication"
-  ],
-  "license": "Apache-2.0",
-  "dependencies": {
-    "docx-preview": "^0.3.3",
-    "react-pptx-preview-kit": "^0.1.9",
-    "xlsx": "^0.18.5"
-  }
-}
+{
+  "name": "plugin-file-preview-auth",
+  "displayName": "Authenticated File Previewer",
+  "displayName.vi-VN": "Xem trước file có xác thực",
+  "displayName.zh-CN": "认证文件预览",
+  "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.3.6",
+  "main": "dist/server/index.js",
+  "files": [
+    "dist",
+    "public",
+    "client.js",
+    "client.d.ts",
+    "server.js",
+    "server.d.ts",
+    "README.md",
+    "client-v2.js",
+    "client-v2.d.ts",
+    "src"
+  ],
+  "peerDependencies": {
+    "@aws-sdk/client-s3": "*",
+    "@nocobase/client": "2.x",
+    "@nocobase/database": "2.x",
+    "@nocobase/plugin-ai": "2.x",
+    "@nocobase/plugin-file-manager": "2.x",
+    "@nocobase/server": "2.x",
+    "@nocobase/utils": "2.x",
+    "@nocobase/client-v2": "2.x",
+    "@nocobase/flow-engine": "2.x"
+  },
+  "peerDependenciesMeta": {
+    "@nocobase/plugin-ai": {
+      "optional": true
+    }
+  },
+  "devDependencies": {},
+  "keywords": [
+    "File manager",
+    "File preview",
+    "Authentication"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "docx-preview": "^0.3.3",
+    "react-pptx-preview-kit": "^0.1.9",
+    "xlsx": "^0.18.5"
+  },
+  "nocobase": {
+    "supportedVersions": [
+      "2.x"
+    ],
+    "editionLevel": 0
+  }
+}

package/src/client/AIFilePreviewAction.tsx

@@ -0,0 +1,282 @@
+/**
+ * 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, { useCallback, useEffect, useMemo, useState } from 'react';
+import { FileTextOutlined, RobotOutlined } from '@ant-design/icons';
+import { Button, Dropdown, Space, Tooltip, message } from 'antd';
+import type { MenuProps } from 'antd';
+import type { Application } from '@nocobase/client';
+import { useChatBoxActions, useAIConfigRepository, type AIEmployee } from '@nocobase/plugin-ai/client';
+import { useT } from './locale';
+
+export const FILE_PREVIEW_WORK_CONTEXT_TYPE = 'file-preview';
+
+const AI_EMPLOYEE_STORAGE_KEY = 'plugin-file-preview-auth.aiEmployee';
+
+function getFileDisplayName(file: any): string {
+  if (!file) return 'file';
+  if (file.title && file.extname) return `${file.title}${file.extname}`;
+  return file.filename || file.name || file.title || 'file';
+}
+
+function getFileContextUid(file: any): string {
+  const stableValue = file?.id ?? file?.uid ?? file?.url ?? file?.path ?? getFileDisplayName(file);
+  return `file-preview:${String(stableValue)}`;
+}
+
+function normalizePreviewFile(file: any) {
+  return {
+    id: file?.id,
+    uid: file?.uid,
+    url: file?.url,
+    preview: file?.preview,
+    filename: file?.filename || file?.name,
+    name: file?.name || file?.filename,
+    title: file?.title,
+    extname: file?.extname,
+    mimetype: file?.mimetype,
+    size: file?.size,
+    path: file?.path,
+    storageId: file?.storageId ?? file?.storage_id ?? file?.storage?.id,
+    storage_id: file?.storage_id,
+    storageType: file?.storageType || file?.storage?.type,
+    storageName: file?.storageName || file?.storage?.name,
+    storage: file?.storage,
+    collectionName: file?.collectionName,
+  };
+}
+
+export function createFilePreviewWorkContext(file: any) {
+  return {
+    type: FILE_PREVIEW_WORK_CONTEXT_TYPE,
+    uid: getFileContextUid(file),
+    title: getFileDisplayName(file),
+    content: {
+      source: 'plugin-file-preview-auth',
+      file: normalizePreviewFile(file),
+    },
+  };
+}
+
+function getStoredAIEmployeeUsername() {
+  try {
+    return window.localStorage.getItem(AI_EMPLOYEE_STORAGE_KEY) || '';
+  } catch {
+    return '';
+  }
+}
+
+function setStoredAIEmployeeUsername(username: string) {
+  try {
+    window.localStorage.setItem(AI_EMPLOYEE_STORAGE_KEY, username);
+  } catch {
+    // Ignore storage restrictions in embedded/sandboxed clients.
+  }
+}
+
+function getEmployeeLabel(employee: AIEmployee) {
+  return employee?.nickname || employee?.username || '';
+}
+
+class AIFilePreviewActionBoundary extends React.Component<{ children: React.ReactNode }, { hasError: boolean }> {
+  constructor(props: { children: React.ReactNode }) {
+    super(props);
+    this.state = { hasError: false };
+  }
+
+  static getDerivedStateFromError() {
+    return { hasError: true };
+  }
+
+  render() {
+    if (this.state.hasError) {
+      return null;
+    }
+    return this.props.children;
+  }
+}
+
+const AIFilePreviewActionInner: React.FC<{ file: any }> = ({ file }) => {
+  const t = useT();
+  const aiConfigRepository = useAIConfigRepository();
+  const { triggerTask } = useChatBoxActions();
+  const [employees, setEmployees] = useState<AIEmployee[]>([]);
+  const [loading, setLoading] = useState(false);
+  const [asking, setAsking] = useState(false);
+
+  useEffect(() => {
+    let cancelled = false;
+    if (!aiConfigRepository?.getAIEmployees) {
+      return;
+    }
+
+    const cached = aiConfigRepository.aiEmployees || [];
+    if (cached.length) {
+      setEmployees([...cached]);
+      return;
+    }
+
+    setLoading(true);
+    aiConfigRepository
+      .getAIEmployees()
+      .then((list) => {
+        if (!cancelled) {
+          setEmployees([...(list || [])]);
+          setLoading(false);
+        }
+      })
+      .catch(() => {
+        if (!cancelled) {
+          setEmployees([]);
+          setLoading(false);
+        }
+      });
+
+    return () => {
+      cancelled = true;
+    };
+  }, [aiConfigRepository]);
+
+  const orderedEmployees = useMemo(() => {
+    const selected = getStoredAIEmployeeUsername();
+    if (!selected) {
+      return employees;
+    }
+    return [...employees].sort((a, b) => {
+      if (a.username === selected) return -1;
+      if (b.username === selected) return 1;
+      return 0;
+    });
+  }, [employees]);
+
+  const openAIChat = useCallback(
+    async (employee: AIEmployee) => {
+      if (!employee || !file) {
+        return;
+      }
+
+      setAsking(true);
+      try {
+        setStoredAIEmployeeUsername(employee.username);
+        await triggerTask({
+          aiEmployee: employee,
+          tasks: [
+            {
+              title: getFileDisplayName(file),
+              message: {
+                user: t('Please help me analyze the file currently open in preview.'),
+                workContext: [createFilePreviewWorkContext(file)],
+              },
+              autoSend: false,
+            },
+          ],
+        });
+      } catch {
+        message.error(t('Failed to open AI chat'));
+      } finally {
+        setAsking(false);
+      }
+    },
+    [file, t, triggerTask],
+  );
+
+  const menuItems: MenuProps['items'] = orderedEmployees.map((employee) => ({
+    key: employee.username,
+    label: getEmployeeLabel(employee),
+    onClick: () => openAIChat(employee),
+  }));
+
+  if (!loading && !orderedEmployees.length) {
+    return null;
+  }
+
+  if (orderedEmployees.length === 1) {
+    return (
+      <Tooltip title={t('Ask AI')}>
+        <Button
+          type="text"
+          size="small"
+          icon={<RobotOutlined />}
+          loading={asking || loading}
+          onClick={(event) => {
+            event.stopPropagation();
+            openAIChat(orderedEmployees[0]);
+          }}
+        >
+          {t('Ask AI')}
+        </Button>
+      </Tooltip>
+    );
+  }
+
+  return (
+    <Tooltip title={t('Ask AI')}>
+      <Dropdown menu={{ items: menuItems }} trigger={['click']} placement="bottomRight" disabled={asking || loading}>
+        <Button
+          type="text"
+          size="small"
+          icon={<RobotOutlined />}
+          loading={asking || loading}
+          onClick={(event) => event.stopPropagation()}
+        >
+          {t('Ask AI')}
+        </Button>
+      </Dropdown>
+    </Tooltip>
+  );
+};
+
+export const AIFilePreviewAction: React.FC<{ file: any }> = ({ file }) => {
+  return (
+    <AIFilePreviewActionBoundary>
+      <AIFilePreviewActionInner file={file} />
+    </AIFilePreviewActionBoundary>
+  );
+};
+
+export function registerFilePreviewAIWorkContext(app: Application) {
+  let aiPlugin: any;
+  try {
+    aiPlugin = app.pm.get('ai') as any;
+  } catch {
+    return;
+  }
+  const aiManager = aiPlugin?.aiManager;
+  if (!aiManager?.registerWorkContext) {
+    return;
+  }
+
+  const options = {
+    name: FILE_PREVIEW_WORK_CONTEXT_TYPE,
+    tag: {
+      Component: ({ item }: { item: any }) => (
+        <Space>
+          <FileTextOutlined />
+          <span>{item?.title || ''}</span>
+        </Space>
+      ),
+    },
+    chatbox: {
+      Component: ({ item }: { item: any }) => (
+        <Space>
+          <FileTextOutlined />
+          <span>{item?.title || ''}</span>
+        </Space>
+      ),
+    },
+  };
+
+  try {
+    if (!aiManager.getWorkContext?.(FILE_PREVIEW_WORK_CONTEXT_TYPE)) {
+      aiManager.registerWorkContext(FILE_PREVIEW_WORK_CONTEXT_TYPE, options);
+    }
+  } catch {
+    // Duplicate registration can happen during hot reload. It is harmless.
+  }
+}

package/src/client/__tests__/ocr-utils.test.ts

@@ -0,0 +1,85 @@
+import { extractOcrStatusRecord, getOcrAttachmentId, isOcrCompleteStatus, normalizeOcrAttachmentId } from '../index';
+
+describe('file preview OCR client utils', () => {
+  describe('normalizeOcrAttachmentId', () => {
+    it('accepts numeric attachment ids', () => {
+      expect(normalizeOcrAttachmentId(12)).toBe(12);
+      expect(normalizeOcrAttachmentId('12')).toBe('12');
+      expect(normalizeOcrAttachmentId(' 12 ')).toBe('12');
+    });
+
+    it('rejects URLs and upload-only ids', () => {
+      expect(normalizeOcrAttachmentId('http://localhost/storage/uploads/test.pdf')).toBeNull();
+      expect(normalizeOcrAttachmentId('/storage/uploads/test.pdf')).toBeNull();
+      expect(normalizeOcrAttachmentId('rc-upload-1710000000000-1')).toBeNull();
+    });
+  });
+
+  describe('getOcrAttachmentId', () => {
+    it('uses response.id when file.id is a storage URL', () => {
+      expect(
+        getOcrAttachmentId({
+          id: 'http://localhost/storage/uploads/yyyy-test%20(1)-lcqadd.pdf',
+          uid: 'rc-upload-1',
+          response: {
+            id: 42,
+          },
+        }),
+      ).toBe(42);
+    });
+
+    it('falls back to a numeric uid for persisted attachment records', () => {
+      expect(
+        getOcrAttachmentId({
+          id: '/storage/uploads/yyyy-test.pdf',
+          uid: '88',
+        }),
+      ).toBe('88');
+    });
+  });
+
+  describe('isOcrCompleteStatus', () => {
+    it('only treats result statuses as completed', () => {
+      expect(isOcrCompleteStatus('waiting-verify')).toBe(true);
+      expect(isOcrCompleteStatus('success')).toBe(true);
+      expect(isOcrCompleteStatus('no-ocr')).toBe(false);
+      expect(isOcrCompleteStatus('pending-ocr')).toBe(false);
+      expect(isOcrCompleteStatus('failed')).toBe(false);
+    });
+  });
+
+  describe('extractOcrStatusRecord', () => {
+    it('unwraps NocoBase double data responses', () => {
+      const record = extractOcrStatusRecord({
+        data: {
+          data: {
+            id: 4,
+            attachmentId: 57,
+            status: 'waiting-verify',
+            data: { pages: [] },
+            error: null,
+          },
+        },
+      });
+
+      expect(record?.id).toBe(4);
+      expect(record?.attachmentId).toBe(57);
+      expect(record?.status).toBe('waiting-verify');
+    });
+
+    it('unwraps action responses with ok and data', () => {
+      const record = extractOcrStatusRecord({
+        data: {
+          ok: true,
+          data: {
+            id: 5,
+            status: 'pending-ocr',
+          },
+        },
+      });
+
+      expect(record?.id).toBe(5);
+      expect(record?.status).toBe('pending-ocr');
+    });
+  });
+});