@godcreator/word-report 0.3.1 → 0.4.0

package/dist/{assemble-3cx8L2vo.mjs → assemble-D25NLmLx.mjs}

@@ -994,12 +994,21 @@ function assembleDocument(entry, files, options = {}) {
 	}
 	const counts = {
 		decimal: 0,
-		appendix: 0,
-		figure: 0,
-		table: 0
+		appendix: 0
 	};
 	let appendixSeen = false;
-	const eqCounts = /* @__PURE__ */ new Map();
+	const chapterCounts = {
+		figure: /* @__PURE__ */ new Map(),
+		table: /* @__PURE__ */ new Map(),
+		equation: /* @__PURE__ */ new Map()
+	};
+	/** 图、编号表格、编号公式各自按所在的顶层章从 1 编，写成「章号-n」；导出 Word 的题注同样取章号，不在编号章里就没有章号可取 */
+	function chapterNumber(node, kind, chapter) {
+		if (!chapter) fail(node, `Numbered ${kind} outside a numbered chapter`);
+		const n = (chapterCounts[kind].get(chapter) ?? 0) + 1;
+		chapterCounts[kind].set(chapter, n);
+		return `${chapter}-${n}`;
+	}
 	function blockNumbers(blocks, depth = 0, chapter, parentNumber, parentMode, tables = 0) {
 		let decimal = 0;
 		for (const node of blocks) {
@@ -1029,18 +1038,15 @@ function assembleDocument(entry, files, options = {}) {
 				continue;
 			}
 			if (node.type === "figure") {
-				number = String(++counts.figure);
+				number = chapterNumber(node, "figure", chapter);
 				label = `图 ${number}`;
 			}
 			if (node.type === "table" && node.numbered) {
-				number = String(++counts.table);
+				number = chapterNumber(node, "table", chapter);
 				label = `表 ${number}`;
 			}
 			if (node.type === "equation" && node.numbered) {
-				if (!chapter) fail(node, "Numbered equation outside a numbered chapter");
-				const n = (eqCounts.get(chapter) ?? 0) + 1;
-				eqCounts.set(chapter, n);
-				number = `${chapter}-${n}`;
+				number = chapterNumber(node, "equation", chapter);
 				label = `式（${number}）`;
 			}
 			if (node.id) index[node.id] = {

package/dist/cli.mjs

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
-import { n as reportExport, r as checkReports } from "./export-TbclsIsE.mjs";
-import { r as reportEntryOf } from "./report-files-DM9Ea6yK.mjs";
+import { n as reportExport, r as checkReports } from "./export-DJQiBPPU.mjs";
+import { r as reportEntryOf } from "./report-files-CgWzLxH-.mjs";
 import path from "node:path";
 import { realpathSync } from "node:fs";
 import { fileURLToPath } from "node:url";

package/dist/core.mjs

@@ -1 +1 @@
-export { o as ReportContentError, t as assembleDocument, a as parseReportJson, n as safeRelativePath, r as validateDocument } from "./assemble-3cx8L2vo.mjs";
+export { o as ReportContentError, t as assembleDocument, a as parseReportJson, n as safeRelativePath, r as validateDocument } from "./assemble-D25NLmLx.mjs";

package/dist/{export-TbclsIsE.mjs → export-DJQiBPPU.mjs}

@@ -1,5 +1,5 @@
-import { a as parseReportJson, i as walk, n as safeRelativePath, o as ReportContentError, r as validateDocument, t as assembleDocument } from "./assemble-3cx8L2vo.mjs";
-import { a as reportsDirName } from "./report-files-DM9Ea6yK.mjs";
+import { a as parseReportJson, i as walk, n as safeRelativePath, o as ReportContentError, r as validateDocument, t as assembleDocument } from "./assemble-D25NLmLx.mjs";
+import { a as reportsDirName } from "./report-files-CgWzLxH-.mjs";
 import { access, mkdir, open, readFile, readdir, realpath, rename, stat, unlink, writeFile } from "node:fs/promises";
 import path from "node:path";
 import { createHash, randomUUID } from "node:crypto";

package/dist/node.mjs

@@ -1,3 +1,3 @@
-import { i as readReport, n as reportExport, r as checkReports, t as reportEntry } from "./export-TbclsIsE.mjs";
-import { a as reportsDirName, i as reportIdsOf, n as readReportFiles, r as reportEntryOf, t as REPORT_ID_PATTERN } from "./report-files-DM9Ea6yK.mjs";
+import { i as readReport, n as reportExport, r as checkReports, t as reportEntry } from "./export-DJQiBPPU.mjs";
+import { a as reportsDirName, i as reportIdsOf, n as readReportFiles, r as reportEntryOf, t as REPORT_ID_PATTERN } from "./report-files-CgWzLxH-.mjs";
 export { REPORT_ID_PATTERN, checkReports, readReport, readReportFiles, reportEntry, reportEntryOf, reportExport, reportIdsOf, reportsDirName };

package/dist/{report-files-DM9Ea6yK.mjs → report-files-CgWzLxH-.mjs}

@@ -1,4 +1,4 @@
-import { a as parseReportJson, n as safeRelativePath, o as ReportContentError, r as validateDocument } from "./assemble-3cx8L2vo.mjs";
+import { a as parseReportJson, n as safeRelativePath, o as ReportContentError, r as validateDocument } from "./assemble-D25NLmLx.mjs";
 import { readFile, readdir, realpath, stat } from "node:fs/promises";
 import path from "node:path";
 //#region src/node/report-files.ts

package/dist/site-server.d.mts

@@ -10,19 +10,15 @@ type WordReportSite = {
   hrefBase: string;
   pageComments: (page: string) => ReportPageComments;
 };
-/** loader 用到的路由参数：报告页是 :report，图片再加 *；图片的 loader 收到 request 时按 If-None-Match 回 304 */
+/** loader 用到的路由参数：报告页是 :report，图片再加 * */
 type ReportRouteArgs = {
   params: Partial<Record<string, string>>;
-  request?: Request;
 };
 /** 报告列表：站点 reports/ 下的每份报告各一行；读不对的报告也列出来，带上原话 */
 declare function reportListLoader(_args: ReportRouteArgs, site: WordReportSite): Promise<ReportListData>;
 /** 报告页：整份报告组装成一页（各章按 include 的顺序接在一起）；报告读不对直接报错，原话在错误页上 */
 declare function reportPageLoader({ params }: ReportRouteArgs, site: WordReportSite): Promise<ReportPageData>;
-/**
- * 报告里的一张图：地址是组装后的路径 assets/<文档 id>/<文件名>，只给这份报告用到的图。
- * 浏览器每次都来问（no-cache），ETag 由文件大小与修改时间算出，没变就回 304、不再传图
- */
-declare function reportAssetLoader({ params, request }: ReportRouteArgs, site: WordReportSite): Promise<Response>;
+/** 报告里的一张图：地址是组装后的路径 assets/<文档 id>/<文件名>，只给这份报告用到的图 */
+declare function reportAssetLoader({ params }: ReportRouteArgs, site: WordReportSite): Promise<Response>;
 //#endregion
 export { type ReportListData, type ReportPageComments, type ReportPageData, ReportRouteArgs, type ReportSummary, type ReportTocItem, WordReportSite, reportAssetLoader, reportListLoader, reportPageLoader };

package/dist/site-server.mjs

@@ -1,60 +1,18 @@
-import { t as assembleDocument } from "./assemble-3cx8L2vo.mjs";
-import { i as reportIdsOf, n as readReportFiles, r as reportEntryOf, t as REPORT_ID_PATTERN } from "./report-files-DM9Ea6yK.mjs";
+import { t as assembleDocument } from "./assemble-D25NLmLx.mjs";
+import { i as reportIdsOf, n as readReportFiles, r as reportEntryOf, t as REPORT_ID_PATTERN } from "./report-files-CgWzLxH-.mjs";
 import { n as reportHrefOf } from "./page-data-DLPoVgXy.mjs";
-import { readFile, realpath, stat } from "node:fs/promises";
 import path from "node:path";
 import { createReadStream } from "node:fs";
 import { Readable } from "node:stream";
 //#region src/site/loaders.server.ts
 /**
-* `@godcreator/word-report/site/server`：报告列表、报告页与报告里图片的 loader。报告从站点 reports/ 现读，
-* 报告页与图片在 JSON 原文没变时沿用上一次的组装结果。
+* `@godcreator/word-report/site/server`：报告列表、报告页与报告里图片的 loader，报告每次从站点 reports/ 现读、现组装。
 */
 /** 组装结果里有 Object.create(null) 的对象：换成普通对象再交给 React Router 序列化 */
 const plainOf = (result) => JSON.parse(JSON.stringify(result));
-/**
-* 每份报告最近一次组装，键是站点目录加报告 id。一页报告的几十张图同时请求，组装一次要几百毫秒到几秒、
-* 全在一个线程上排队：不共用的话，最后一张图要等几十次组装
-*/
-const latestAssemblies = /* @__PURE__ */ new Map();
-async function assembleFromDisk(siteDir, reportId) {
-	const entry = reportEntryOf(reportId);
-	const files = await readReportFiles(siteDir, entry);
-	return {
-		files,
-		result: assembleDocument(entry, files, { mode: "complete" })
-	};
-}
-/** 上次组装读过的每个 JSON 文件原文都没变；文件没了也算变了，交给重新组装去报错 */
-async function sameFilesOnDisk(siteDir, files) {
-	const root = await realpath(siteDir);
-	return (await Promise.all(Object.entries(files).map(async ([relative, text]) => {
-		try {
-			return await readFile(path.join(root, relative), "utf8") === text;
-		} catch (error) {
-			if (error.code === "ENOENT") return false;
-			throw error;
-		}
-	}))).every(Boolean);
-}
-/** 报告的整份组装结果：JSON 原文和上次一样就用上次的，同时到的请求共用同一次组装；结果只读，要改先复制 */
 async function assembledReport(siteDir, reportId) {
-	const key = `${path.resolve(siteDir)}\0${reportId}`;
-	const latest = latestAssemblies.get(key);
-	if (latest !== void 0) {
-		const assembly = await latest;
-		if (await sameFilesOnDisk(siteDir, assembly.files)) return assembly.result;
-	}
-	const newer = latestAssemblies.get(key);
-	if (newer !== void 0 && newer !== latest) return (await newer).result;
-	const fresh = assembleFromDisk(siteDir, reportId);
-	latestAssemblies.set(key, fresh);
-	try {
-		return (await fresh).result;
-	} catch (error) {
-		if (latestAssemblies.get(key) === fresh) latestAssemblies.delete(key);
-		throw error;
-	}
+	const entry = reportEntryOf(reportId);
+	return assembleDocument(entry, await readReportFiles(siteDir, entry), { mode: "complete" });
 }
 /** 地址里的报告 id：形状不对或站点里没有这份报告都是 404 */
 async function reportIdOf(params, siteDir) {
@@ -130,29 +88,15 @@ const imageContentTypes = {
 	".jpg": "image/jpeg",
 	".jpeg": "image/jpeg"
 };
-/**
-* 报告里的一张图：地址是组装后的路径 assets/<文档 id>/<文件名>，只给这份报告用到的图。
-* 浏览器每次都来问（no-cache），ETag 由文件大小与修改时间算出，没变就回 304、不再传图
-*/
-async function reportAssetLoader({ params, request }, site) {
+/** 报告里的一张图：地址是组装后的路径 assets/<文档 id>/<文件名>，只给这份报告用到的图 */
+async function reportAssetLoader({ params }, site) {
 	const reportId = await reportIdOf(params, site.siteDir);
 	const compiledPath = `assets/${params["*"] ?? ""}`;
 	const source = (await assembledReport(site.siteDir, reportId)).assets[compiledPath];
 	if (source === void 0) return new Response(`报告 ${reportId} 里没有图 ${compiledPath}`, { status: 404 });
 	const contentType = imageContentTypes[path.extname(source).toLowerCase()];
 	if (contentType === void 0) throw new Error(`报告 ${reportId} 的图 ${source} 不是 png 或 jpg`);
-	const file = path.join(site.siteDir, source);
-	const { size, mtimeMs } = await stat(file);
-	const headers = {
-		"content-type": contentType,
-		"cache-control": "no-cache",
-		etag: `"${size.toString(16)}-${Math.trunc(mtimeMs).toString(16)}"`
-	};
-	if (request?.headers.get("if-none-match") === headers.etag) return new Response(null, {
-		status: 304,
-		headers
-	});
-	return new Response(Readable.toWeb(createReadStream(file)), { headers });
+	return new Response(Readable.toWeb(createReadStream(path.join(site.siteDir, source))), { headers: { "content-type": contentType } });
 }
 //#endregion
 export { reportAssetLoader, reportListLoader, reportPageLoader };

package/dist/site.mjs

@@ -1,4 +1,4 @@
-import { t as assembleDocument } from "./assemble-3cx8L2vo.mjs";
+import { t as assembleDocument } from "./assemble-D25NLmLx.mjs";
 import { n as reportHrefOf, t as reportAssetHrefOf } from "./page-data-DLPoVgXy.mjs";
 import { Link, useLoaderData } from "react-router";
 import { DocsBody, DocsPage, DocsTitle } from "@fumadocs/base-ui/layouts/docs/page";

package/engine/src/docreport/compose.py

@@ -61,10 +61,19 @@ class Composer:
         if kind not in ('Table', 'Figure'):
             raise ValueError(f'Unknown caption kind: {kind}')
         name = {'Table': '表', 'Figure': '图'}[kind]
-        number = self.field_token('SEQ ' + kind + r' \* ARABIC', bookmark)
+        number = self.chapter_number(r'STYLEREF 1 \s', 'SEQ ' + kind + r' \* ARABIC \s 1', bookmark)
         return self.paragraph(f'{name} {number}  {text}',
                               'Table Caption' if kind == 'Table' else -35)
 
+    def chapter_number(self, chapter_code, sequence_code, bookmark):
+        """Return「章号-序号」 placeholders; ``bookmark`` spans both fields so REF shows the whole number."""
+        chapter = self.field_token(chapter_code)
+        number = self.field_token(sequence_code)
+        index = len(self._pending_numbers)
+        begin, end = f'@NUMSTART{index}@', f'@NUMEND{index}@'
+        self._pending_numbers.append((begin, end, bookmark))
+        return f'{begin}{chapter}-{number}{end}'
+
     def list(self, items, ordered=False):
         doc = self.doc
         list_start = doc.Content.End - 1
@@ -100,12 +109,8 @@ class Composer:
                                       boldSymbol=bold_symbol))
         if inline:
             return self.paragraph(before + token + after)
-        chapter = self.field_token(r'STYLEREF 1 \s')
-        number = self.field_token(r'SEQ Equation \* ARABIC \s 1')
-        index = len(self._pending_numbers)
-        begin, end = f'@NUMSTART{index}@', f'@NUMEND{index}@'
-        self._pending_numbers.append((begin, end, bookmark))
-        return self.paragraph(f'\t{token}\t({begin}{chapter}-{number}{end})', 'Equation')
+        number = self.chapter_number(r'STYLEREF 1 \s', r'SEQ Equation \* ARABIC \s 1', bookmark)
+        return self.paragraph(f'\t{token}\t({number})', 'Equation')
 
     def footnote(self, token, text):
         rng = self.doc.Content.Duplicate
@@ -313,12 +318,26 @@ class ContentComposer(Composer):
                     setattr(run.Font, {'strong': 'Bold', 'em': 'Italic', 'sup': 'Superscript', 'sub': 'Subscript'}[mark], True)
         return rng
 
+    def chapter_sequence(self, kind, bookmark):
+        """「章号-序号」 for an equation, figure or table in the current top-level chapter."""
+        if self.chapter_is_appendix:
+            # The SEQ "\s 1" restart only fires on built-in Heading 1
+            # paragraphs; the template's Appendix Heading is Normal-based,
+            # so appendix sequences never restart there. Giving each
+            # appendix its own SEQ identifier keeps a natural 1, 2, 3 …
+            # count that renumbers on insert or delete like main chapters,
+            # without touching heading styles or their linked lists.
+            letter = chr(ord('A') + self.appendix_count - 1)
+            return self.chapter_number(r'STYLEREF "Appendix Heading" \s',
+                                       'SEQ ' + kind + 'Appendix' + letter + r' \* ARABIC', bookmark)
+        return self.chapter_number(r'STYLEREF 1 \s', 'SEQ ' + kind + r' \* ARABIC \s 1', bookmark)
+
     def numbered_caption(self, node, kind):
         from .content import bookmark
         numbered = node.get('numbered', True)
         prefix = ''
         if numbered:
-            prefix = {'Figure': '图 ', 'Table': '表 '}[kind] + self.field_token('SEQ ' + kind + r' \* ARABIC', bookmark(node['id'], '_n')) + '  '
+            prefix = {'Figure': '图 ', 'Table': '表 '}[kind] + self.chapter_sequence(kind, bookmark(node['id'], '_n')) + '  '
         rng = self.rich_paragraph(node['caption'], 'Table Caption' if kind == 'Table' else -35, prefix=prefix)
         title = self.part(rng, utf16_length(prefix), rng.End - rng.Start - utf16_length(prefix) - 1)
         self.mark(node['id'], title, '_t')
@@ -416,24 +435,9 @@ class ContentComposer(Composer):
         token = self.math_token(node, False)
         suffix = ''
         if node['numbered']:
-            chapter = self.field_token(r'STYLEREF 1 \s' if self.chapter_style == 'Heading 1' else r'STYLEREF "Appendix Heading" \s')
-            if self.chapter_is_appendix:
-                # The SEQ "\s 1" restart only fires on built-in Heading 1
-                # paragraphs; the template's Appendix Heading is Normal-based,
-                # so appendix sequences never restart there. Giving each
-                # appendix its own SEQ identifier keeps a natural 1, 2, 3 …
-                # count that renumbers on insert or delete like main chapters,
-                # without touching heading styles or their linked lists.
-                letter = chr(ord('A') + self.appendix_count - 1)
-                number = self.field_token(r'SEQ EquationAppendix' + letter + r' \* ARABIC')
-            else:
-                number = self.field_token(r'SEQ Equation \* ARABIC \s 1')
-            self.chapter_first_equation = False
-            i = len(self._pending_numbers)
-            begin, end = f'@NUMSTART{i}@', f'@NUMEND{i}@'
             from .content import bookmark
-            self._pending_numbers.append((begin, end, bookmark(node['id'], '_n')))
-            suffix = f'\t({begin}{chapter}-{number}{end})'
+            self.chapter_first_equation = False
+            suffix = '\t(' + self.chapter_sequence('Equation', bookmark(node['id'], '_n')) + ')'
         rng = self.paragraph('\t' + token + suffix, 'Equation')
         rng.ParagraphFormat.TabStops.ClearAll()
         rng.ParagraphFormat.TabStops.Add(self.width / 2, 1, 0)

package/engine/src/docreport/content.py

@@ -166,7 +166,10 @@ def validate_content(content, directory):
                 blocks(item["children"], depth + 1, scope, mode, tables)
             elif kind == "equation" and item["numbered"]:
                 require(chapter is not None, f"{item['id']}: numbered equation outside a chapter")
+            elif kind == "figure":
+                require(chapter is not None, f"{item['id']}: numbered figure outside a chapter")
             elif kind == "table":
+                require(chapter is not None or not item["numbered"], f"{item['id']}: numbered table outside a chapter")
                 require(tables < 6, f"{item['id']}: Word renderer supports at most six table levels")
                 for row in item["rows"]:
                     for cell in row["cells"]:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@godcreator/word-report",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "author": {
     "name": "godcreator"
   },