wendang 0.0.1 → 0.1.0

package/dist/types/shared/workbook.d.ts

@@ -0,0 +1,56 @@
+/** Neutral workbook wire format. Keep in sync with web/src/shared/workbook.ts. */
+export interface WorkbookCell {
+    v?: string | number | boolean | null;
+    f?: string;
+    t?: number;
+    s?: string | Record<string, unknown> | null;
+    p?: {
+        body?: {
+            dataStream?: string;
+        };
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+export interface WorkbookSheet {
+    id: string;
+    name: string;
+    rowCount: number;
+    columnCount: number;
+    cellData?: Record<string, Record<string, WorkbookCell | null>>;
+    mergeData?: Array<{
+        startRow: number;
+        endRow: number;
+        startColumn: number;
+        endColumn: number;
+    }>;
+    rowData?: Record<string, Record<string, unknown>>;
+    columnData?: Record<string, Record<string, unknown>>;
+    [key: string]: unknown;
+}
+export interface WorkbookSnapshot {
+    id: string;
+    name: string;
+    sheetOrder: string[];
+    sheets: Record<string, WorkbookSheet>;
+    styles?: Record<string, Record<string, unknown>>;
+    [key: string]: unknown;
+}
+export interface WorkbookDocument {
+    type: 'workbook';
+    formatVersion: 1;
+    workbook: WorkbookSnapshot;
+}
+export declare const WORKBOOK_LIMITS: {
+    readonly sheets: 20;
+    readonly rows: 10000;
+    readonly columns: 200;
+    readonly cells: 50000;
+    readonly bytes: number;
+};
+export declare function isWorkbookDocument(value: unknown): value is WorkbookDocument;
+export declare function emptyWorkbook(id: string): WorkbookDocument;
+/** Validate the complete snapshot without silently dropping supported engine attributes. */
+export declare function validateWorkbook(raw: unknown): WorkbookDocument;
+export declare function workbookCellText(cell: WorkbookCell | null | undefined): string;
+export declare function workbookText(doc: WorkbookDocument): string;

package/dist/types/spreadsheet.d.ts

@@ -0,0 +1 @@
+export * from './shared/workbook.js';

package/dist/types/types.d.ts

@@ -0,0 +1,3 @@
+export * from './shared/types.js';
+export type { WorkbookDocument, WorkbookSnapshot, WorkbookSheet, WorkbookCell } from './shared/workbook.js';
+export type { MindMapJson, MindMapModel, MindMapViewState } from './shared/mind-map.js';

package/dist/types/validation/callout.d.ts

@@ -0,0 +1 @@
+export * from '../shared/callout.js';

package/dist/types/validation/doc-node-whitelist.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 文档节点白名单（**纯数据，无依赖**）。
+ *
+ * 为什么单独成文件：白名单需要被三处引用——
+ *  1) 服务端校验（doc-schema.service.ts）
+ *  2) 一致性测试（与前端 node-catalog 交叉核对）
+ *  3) 导出序列化器的防漂移测试
+ * 若把它放在 doc-schema.service.ts 里，测试导入会连带加载 Nest 依赖，
+ * 导致 spec 在测试环境下加载失败（实测：整个测试文件被静默跳过）。
+ *
+ * 因此这里只放数据，不放逻辑，任何一方都能安全引用。
+ *
+ * 新增节点时必须同时更新：
+ *  1) 本文件
+ *  2) 前端 web/src/shared/node-catalog.ts
+ *  3) 导出序列化器 markdown-serializer.ts 的处理分支
+ * 三处一致性由测试自动核对（读取真实文件，而非维护测试内副本）。
+ */
+export declare const ALLOWED_NODES: Set<string>;
+/** 允许的标记类型。 */
+export declare const ALLOWED_MARKS: Set<string>;

package/dist/types/validation/error.d.ts

@@ -0,0 +1,7 @@
+export declare class ContentValidationError extends Error {
+    code: string;
+    status: number;
+    details?: Record<string, unknown> | undefined;
+    constructor(code: string, message: string, status?: number, details?: Record<string, unknown> | undefined);
+    static validation(message: string): ContentValidationError;
+}

package/dist/types/validation/mind-map.d.ts

@@ -0,0 +1,22 @@
+/** Kept independent of Nest and of the editing engine: usable by validation and export. */
+interface JsonNode {
+    type?: string;
+    attrs?: Record<string, unknown>;
+    text?: string;
+    content?: JsonNode[];
+}
+interface Topic {
+    id: string;
+    parentId: string;
+    order: number;
+    text: string;
+    description?: string;
+    note?: string;
+    attachmentId?: string;
+}
+export declare function validateMindMap(node: JsonNode): void;
+/** Same deterministic tree projection as the reader; orphan/cycle conflicts never discard text. */
+export declare function mindMapOutline(node: JsonNode): Array<Topic & {
+    depth: number;
+}>;
+export {};

package/dist/types/validation/schema-version.d.ts

@@ -0,0 +1,2 @@
+/** 协同握手与正文写入共用，不依赖 Nest 服务。 */
+export declare const CONTENT_SCHEMA_VERSION = 10;

package/dist/types/validation/schema.d.ts

@@ -0,0 +1,49 @@
+import { ALLOWED_NODES } from './doc-node-whitelist.js';
+export { ALLOWED_NODES };
+/**
+ * 文档 schema 校验与派生提取（M0 定稿，见实施计划 4.1）。
+ *
+ * 职责：
+ * 1) 校验客户端提交的 ProseMirror JSON 是否只含白名单节点/标记 → 否则**拒绝写入**，
+ *    避免旧客户端遇到未知节点的文档时覆盖成空（对齐主方案第 3 节）。
+ * 2) 提取派生数据：正文引用的页面 ID（用于反向链接）、附件 ID。
+ *
+ * schemaVersion 升级策略：新增节点或旧客户端无法保留的持久属性时提升 SCHEMA_VERSION，并在此登记。
+ * 旧版本客户端读到更高版本文档时由前端拒编辑（本服务不影响读取）。
+ */
+/**
+ * 正文格式版本。
+ *
+ * 变更记录：
+ *  - 1：M0 初始版本（段落/标题/列表/引用/代码/表格/图片/页面引用/提及/公式）
+ *  - 2：新增 `fileAttachment`（视频或文件卡片）与 `callout`（高亮块）
+ *  - 3：新增块级格式属性 `textAlign`/`indent`（段落与标题）与行内样式标记
+ *       `textStyle`（文字颜色）/`highlight`（背景高亮）；同时补上此前遗漏的
+ *       `paragraph` 属性条目与表格 `colwidth`（列宽）
+ *  - 4：新增分栏节点 `columns`/`column`（等宽，无属性）
+ *  - 5：新增平台视频节点 `videoEmbed`
+ *  - 6：新增结构化思维导图 `mindMap` / `mindMapTopic`
+ *  - 7：导图描述、备注、关系节点、受限主题样式与图片引用；标题支持行内标记
+ *  - 8：思维导图分支方向 side，防止旧编辑器重写时丢失左右布局
+ *  - 9：高亮块图标与独立文字、边框、填充颜色
+ *  - 10：独立工作簿根格式 workbook（不进入 ProseMirror）
+ *
+ * 提升它的意义：客户端读到**更高版本**的文档时可以选择拒编辑（而非静默丢内容），
+ * 因此只要引入了新的节点类型就必须登记在此，不能只改白名单。
+ */
+export declare const SCHEMA_VERSION = 10;
+export interface ValidatedDoc {
+    doc: Record<string, unknown>;
+    schemaVersion: number;
+    linkTargetIds: string[];
+    attachmentIds: string[];
+    /** 正文中 @ 提及的用户 ID（去重），用于通知扇出 */
+    mentionUserIds: string[];
+}
+export declare class ContentSchemaService {
+    validate(raw: unknown, schemaVersion: number): ValidatedDoc;
+    /** 仅允许 http/https/mailto 与站内相对链接，阻断 javascript: 等危险协议。 */
+    private isSafeHref;
+    /** 纯文本投影：供 M0 搜索与摘要使用（不含 HTML，避免 XSS 面）。 */
+    extractPlainText(doc: unknown): string;
+}

package/dist/types/validation/video-embed.d.ts

@@ -0,0 +1 @@
+export * from '../shared/video-embed.js';

package/dist/types/validation/workbook.d.ts

@@ -0,0 +1 @@
+export * from '../shared/workbook.js';

package/package.json

@@ -1,14 +1,96 @@
 {
   "name": "wendang",
-  "version": "0.0.1",
-  "description": "wendang is under development.",
-  "author": "ztes",
+  "version": "0.1.0",
+  "description": "文档、工作表和思维导图的内容协议与校验核心。",
+  "type": "module",
   "license": "UNLICENSED",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "internal/*": [
+        "dist/types/shared/*"
+      ],
+      "validation/*": [
+        "dist/types/validation/*"
+      ],
+      "*": [
+        "dist/types/*"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./document": {
+      "types": "./dist/types/document.d.ts",
+      "import": "./dist/esm/document.js",
+      "require": "./dist/cjs/document.js"
+    },
+    "./spreadsheet": {
+      "types": "./dist/types/spreadsheet.d.ts",
+      "import": "./dist/esm/spreadsheet.js",
+      "require": "./dist/cjs/spreadsheet.js"
+    },
+    "./mindmap": {
+      "types": "./dist/types/mindmap.d.ts",
+      "import": "./dist/esm/mindmap.js",
+      "require": "./dist/cjs/mindmap.js"
+    },
+    "./schema": {
+      "types": "./dist/types/schema.d.ts",
+      "import": "./dist/esm/schema.js",
+      "require": "./dist/cjs/schema.js"
+    },
+    "./types": {
+      "types": "./dist/types/types.d.ts",
+      "import": "./dist/esm/types.js",
+      "require": "./dist/cjs/types.js"
+    },
+    "./internal/*": {
+      "types": "./dist/types/shared/*.d.ts",
+      "import": "./dist/esm/shared/*.js",
+      "require": "./dist/cjs/shared/*.js"
+    },
+    "./validation/*": {
+      "types": "./dist/types/validation/*.d.ts",
+      "import": "./dist/esm/validation/*.js",
+      "require": "./dist/cjs/validation/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
   "files": [
-    "README.md"
+    "dist",
+    "README.md",
+    "LICENSE",
+    "NOTICE.md",
+    "third-party-notices"
   ],
+  "engines": {
+    "node": ">=20.19"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
+  },
+  "author": "ztes",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitee.com/ztes/wendang.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://gitee.com/ztes/wendang",
+  "bugs": {
+    "url": "https://gitee.com/ztes/wendang/issues"
+  },
+  "scripts": {
+    "build": "node ../../scripts/build-core.mjs",
+    "dev": "node ../../scripts/build-core.mjs --watch",
+    "typecheck": "tsc --noEmit"
   }
-}
+}