plugin-file-preview-auth 1.3.5 → 1.3.6

package/src/client/locale.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+
+// @ts-ignore
+import pkg from './../../package.json';
+import { useApp } from '@nocobase/client';
+
+export function useT() {
+  const app = useApp();
+  return (str: string) => app.i18n.t(str, { ns: [pkg.name, 'client'] });
+}
+
+export function tStr(key: string) {
+  return `{{t(${JSON.stringify(key)}, { ns: ['${pkg.name}', 'client'], nsMode: 'fallback' })}}`;
+}

package/src/client-v2/index.tsx

@@ -0,0 +1 @@
+export { default } from './plugin';

package/src/client-v2/plugin.tsx

@@ -0,0 +1,7 @@
+import { Plugin, Application } from '@nocobase/client-v2';
+
+export class PluginFilePreviewAuthClient extends Plugin<Record<string, never>, Application> {
+  async load() {}
+}
+
+export default PluginFilePreviewAuthClient;

package/{dist/index.d.ts → src/index.ts}

@@ -1,10 +1,11 @@
-/**
- * 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';
+/**
+ * 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/src/locale/en-US.json

@@ -0,0 +1,14 @@
+{
+  "Preview": "Preview",
+  "Open in new window": "Open in new window",
+  "Download": "Download",
+  "Close": "Close",
+  "Loading preview...": "Loading preview...",
+  "Failed to load file preview": "Failed to load file preview",
+  "Failed to download file": "Failed to download file",
+  "Ask AI": "Ask AI",
+  "Please help me analyze the file currently open in preview.": "Please help me analyze the file currently open in preview.",
+  "Failed to open AI chat": "Failed to open AI chat",
+  "This file type cannot be previewed. Click Download to save the file.": "This file type cannot be previewed. Click Download to save the file.",
+  "This file type cannot be previewed. ": "This file type cannot be previewed. "
+}

package/src/locale/vi-VN.json

@@ -0,0 +1,14 @@
+{
+  "Preview": "Xem trước",
+  "Open in new window": "Mở trong cửa sổ mới",
+  "Download": "Tải xuống",
+  "Close": "Đóng",
+  "Loading preview...": "Đang tải xem trước...",
+  "Failed to load file preview": "Không thể tải xem trước file",
+  "Failed to download file": "Không thể tải file",
+  "Ask AI": "Hỏi AI",
+  "Please help me analyze the file currently open in preview.": "Hãy giúp tôi phân tích file đang được mở xem trước.",
+  "Failed to open AI chat": "Không thể mở chat AI",
+  "This file type cannot be previewed. Click Download to save the file.": "Loại file này không thể xem trước. Nhấn Tải xuống để lưu file.",
+  "This file type cannot be previewed. ": "Loại file này không thể xem trước. "
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,14 @@
+{
+  "Preview": "预览",
+  "Open in new window": "在新窗口中打开",
+  "Download": "下载",
+  "Close": "关闭",
+  "Loading preview...": "正在加载预览...",
+  "Failed to load file preview": "无法加载文件预览",
+  "Failed to download file": "无法下载文件",
+  "Ask AI": "询问 AI",
+  "Please help me analyze the file currently open in preview.": "请帮我分析当前正在预览的文件。",
+  "Failed to open AI chat": "无法打开 AI 聊天",
+  "This file type cannot be previewed. Click Download to save the file.": "此文件类型不支持预览。请点击下载以保存文件。",
+  "This file type cannot be previewed. ": "此文件类型不支持预览。"
+}

package/src/server/__tests__/smoke.test.ts

@@ -0,0 +1,17 @@
+import { createMockServer } from '@nocobase/test';
+
+describe('Authenticated File Previewer plugin smoke', () => {
+  let app;
+
+  afterEach(async () => {
+    await app?.destroy();
+  });
+
+  it('loads without starting the full app', async () => {
+    app = await createMockServer({
+      plugins: ['nocobase', 'file-preview-auth'],
+    });
+
+    expect(app).toBeTruthy();
+  });
+});

package/src/server/collections/attachment-ocr-results.ts

@@ -0,0 +1,40 @@
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'attachmentOcrResults',
+  title: 'Attachment OCR results',
+  dumpRules: 'required',
+  migrationRules: ['schema-only', 'overwrite'],
+  indexes: [
+    {
+      fields: ['attachmentId'],
+      unique: true,
+    },
+    {
+      fields: ['status'],
+    },
+  ],
+  fields: [
+    {
+      type: 'belongsTo',
+      name: 'attachment',
+      target: 'attachments',
+      foreignKey: 'attachmentId',
+      onDelete: 'CASCADE',
+      interface: 'm2o',
+    },
+    {
+      type: 'string',
+      name: 'status',
+      defaultValue: 'no-ocr',
+    },
+    {
+      type: 'json',
+      name: 'data',
+    },
+    {
+      type: 'text',
+      name: 'error',
+    },
+  ],
+});

package/{dist/server/collections/file-preview-auth.d.ts → src/server/collections/file-preview-auth.ts}

@@ -2,21 +2,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
+ * 
+ * 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
+ * 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 {
+  name: 'filePreviewAuth',
+  dumpRules: 'skip',
+  autoGenId: true,
+  createdAt: false,
+  updatedAt: false,
+  fields: [
+    {
+      name: 'name',
+      type: 'string',
+    },
+  ],
 };
-export default _default;

package/src/server/excel-parser-handler.ts

@@ -0,0 +1,128 @@
+/**
+ * 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';
+import * as XLSX from 'xlsx';
+
+// Local copies of plugin-document-parser contracts — avoids a compile-time dependency.
+
+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>;
+}
+
+// ─── Constants ────────────────────────────────────────────────────────────────
+
+const XLSX_EXTNAMES = new Set(['.xlsx', '.xls']);
+const XLSX_MIMETYPES = new Set([
+  'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  'application/vnd.ms-excel',
+]);
+
+function resolveExtname(attachment: AttachmentLike): string {
+  if (attachment.extname) return attachment.extname.toLowerCase();
+  const name = attachment.filename ?? attachment.name ?? '';
+  const idx = name.lastIndexOf('.');
+  return idx >= 0 ? name.slice(idx).toLowerCase() : '';
+}
+
+// ─── Handler ──────────────────────────────────────────────────────────────────
+
+/**
+ * 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 class ExcelParserHandler implements InternalParserHandler {
+  readonly name = 'file-preview-auth-excel-parser';
+
+  supports(attachment: AttachmentLike): boolean {
+    if (attachment.mimetype && XLSX_MIMETYPES.has(attachment.mimetype)) return true;
+    return XLSX_EXTNAMES.has(resolveExtname(attachment));
+  }
+
+  async parse(attachment: AttachmentLike, ctx: Context): Promise<InternalParseResult> {
+    const docParserPlugin = ((ctx.app as any).pm?.get('@nocobase/plugin-document-parser') || (ctx.app as any).pm?.get('plugin-document-parser')) as any;
+    if (!docParserPlugin?.fetchFileBuffer) {
+      ctx.log?.warn?.('[ExcelParser] plugin-document-parser not available — cannot fetch file bytes');
+      return { text: '', handled: false };
+    }
+
+    const { buffer } = await docParserPlugin.fetchFileBuffer(ctx, attachment);
+
+    const workbook = XLSX.read(buffer, { type: 'buffer' });
+
+    const parts: string[] = [];
+    for (const sheetName of workbook.SheetNames) {
+      const sheet = workbook.Sheets[sheetName];
+      const rows = XLSX.utils.sheet_to_json<string[]>(sheet, { header: 1, defval: '' }) as string[][];
+      // Drop trailing fully-empty rows
+      while (rows.length > 0 && rows[rows.length - 1].every((c) => String(c).trim() === '')) {
+        rows.pop();
+      }
+      if (rows.length === 0) continue;
+
+      const escape = (v: any) =>
+        String(v ?? '')
+          .replace(/\|/g, '\\|')
+          .replace(/\n/g, ' ');
+      const toRow = (cells: string[], colCount: number) => {
+        const padded = Array.from({ length: colCount }, (_, i) => escape(cells[i] ?? ''));
+        return `| ${padded.join(' | ')} |`;
+      };
+
+      const colCount = Math.max(...rows.map((r) => r.length));
+      const header = toRow(rows[0], colCount);
+      const separator = `| ${Array(colCount).fill('---').join(' | ')} |`;
+      const body = rows.slice(1).map((r) => toRow(r, colCount));
+
+      parts.push(`### Sheet: ${sheetName}\n\n${[header, separator, ...body].join('\n')}`);
+    }
+
+    return { text: parts.join('\n\n'), handled: true };
+  }
+}

package/{dist/server/index.d.ts → src/server/index.ts}

@@ -1,9 +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 { default } from './plugin';
+/**
+ * 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/src/server/migrations/20260528000000-move-ocr-fields-out-of-attachments.ts

@@ -0,0 +1,39 @@
+import { Migration } from '@nocobase/server';
+
+export default class extends Migration {
+  on = 'afterLoad';
+
+  async up() {
+    const attachments = this.db.getCollection('attachments');
+    if (!attachments) {
+      return;
+    }
+
+    const queryInterface = this.db.sequelize.getQueryInterface();
+    const tableName = attachments.getTableNameWithSchema();
+    const columns = await queryInterface.describeTable(tableName).catch(() => null);
+    if (!columns) {
+      return;
+    }
+
+    await this.db.sequelize.transaction(async (transaction) => {
+      if (columns.ocrStatus) {
+        await queryInterface.removeColumn(tableName, 'ocrStatus', { transaction });
+      }
+      if (columns.ocrData) {
+        await queryInterface.removeColumn(tableName, 'ocrData', { transaction });
+      }
+
+      const fieldRepo = this.db.getRepository('fields');
+      if (fieldRepo) {
+        await fieldRepo.destroy({
+          filter: {
+            collectionName: 'attachments',
+            name: ['ocrStatus', 'ocrData'],
+          },
+          transaction,
+        });
+      }
+    });
+  }
+}