@notion-headless-cms/notion-katex 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 kjfsm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+import { BlockEnricher } from "@notion-headless-cms/notion-orm";
+
+//#region src/index.d.ts
+/** `notionKatex()` のオプション。KaTeX の renderToString に渡すオプションのサブセット。 */
+interface NotionKatexOptions {
+  /** 数式をブロック表示（display mode）にする。デフォルト: true。 */
+  displayMode?: boolean;
+  /** レンダリングエラーを throw する。false の場合はエラー時に __cachedHtml を設定しない。デフォルト: false。 */
+  throwOnError?: boolean;
+  /** KaTeX マクロ定義。 */
+  macros?: Record<string, string>;
+}
+/** equation ブロックに `__cachedHtml` が付与された拡張型。 */
+type EquationBlockWithCachedHtml = {
+  type: "equation";
+  equation: {
+    expression: string;
+    __cachedHtml: string;
+  };
+};
+/**
+ * fetch 時に Notion の equation ブロックを KaTeX で HTML 化し、
+ * `block.equation.__cachedHtml` に埋め込む `BlockEnricher` を返す。
+ *
+ * `react-renderer` の Equation スタブは `__cachedHtml` があれば
+ * `dangerouslySetInnerHTML` で描画するため、Workers バンドルから katex を除外できる。
+ *
+ * @example
+ * ```ts
+ * import { notionKatex } from "@notion-headless-cms/notion-katex";
+ * import { createNotionCollection } from "@notion-headless-cms/notion-orm";
+ *
+ * source: createNotionCollection({
+ *   token: process.env.NOTION_TOKEN,
+ *   dataSourceId: "...",
+ *   enrichers: [notionKatex({ displayMode: true })],
+ * });
+ * ```
+ */
+declare function notionKatex(opts?: NotionKatexOptions): BlockEnricher;
+//#endregion
+export { EquationBlockWithCachedHtml, NotionKatexOptions, notionKatex };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,47 @@
+import katex from "katex";
+//#region src/index.ts
+/**
+* fetch 時に Notion の equation ブロックを KaTeX で HTML 化し、
+* `block.equation.__cachedHtml` に埋め込む `BlockEnricher` を返す。
+*
+* `react-renderer` の Equation スタブは `__cachedHtml` があれば
+* `dangerouslySetInnerHTML` で描画するため、Workers バンドルから katex を除外できる。
+*
+* @example
+* ```ts
+* import { notionKatex } from "@notion-headless-cms/notion-katex";
+* import { createNotionCollection } from "@notion-headless-cms/notion-orm";
+*
+* source: createNotionCollection({
+*   token: process.env.NOTION_TOKEN,
+*   dataSourceId: "...",
+*   enrichers: [notionKatex({ displayMode: true })],
+* });
+* ```
+*/
+function notionKatex(opts) {
+	const katexOpts = {
+		displayMode: opts?.displayMode ?? true,
+		throwOnError: opts?.throwOnError ?? false,
+		...opts?.macros && { macros: opts.macros }
+	};
+	return async (blocks) => {
+		enrichBlocks(blocks, katexOpts);
+		return blocks;
+	};
+}
+function enrichBlocks(blocks, opts) {
+	for (const block of blocks) {
+		if (block.type === "equation") {
+			const eq = block.equation;
+			try {
+				eq.__cachedHtml = katex.renderToString(eq.expression, opts);
+			} catch {}
+		}
+		if (block.children?.length) enrichBlocks(block.children, opts);
+	}
+}
+//#endregion
+export { notionKatex };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type {\n  BlockEnricher,\n  NotionBlockTreeNode,\n} from \"@notion-headless-cms/notion-orm\";\nimport katex from \"katex\";\n\n/** `notionKatex()` のオプション。KaTeX の renderToString に渡すオプションのサブセット。 */\nexport interface NotionKatexOptions {\n  /** 数式をブロック表示（display mode）にする。デフォルト: true。 */\n  displayMode?: boolean;\n  /** レンダリングエラーを throw する。false の場合はエラー時に __cachedHtml を設定しない。デフォルト: false。 */\n  throwOnError?: boolean;\n  /** KaTeX マクロ定義。 */\n  macros?: Record<string, string>;\n}\n\n/** equation ブロックに `__cachedHtml` が付与された拡張型。 */\nexport type EquationBlockWithCachedHtml = {\n  type: \"equation\";\n  equation: { expression: string; __cachedHtml: string };\n};\n\n/**\n * fetch 時に Notion の equation ブロックを KaTeX で HTML 化し、\n * `block.equation.__cachedHtml` に埋め込む `BlockEnricher` を返す。\n *\n * `react-renderer` の Equation スタブは `__cachedHtml` があれば\n * `dangerouslySetInnerHTML` で描画するため、Workers バンドルから katex を除外できる。\n *\n * @example\n * ```ts\n * import { notionKatex } from \"@notion-headless-cms/notion-katex\";\n * import { createNotionCollection } from \"@notion-headless-cms/notion-orm\";\n *\n * source: createNotionCollection({\n *   token: process.env.NOTION_TOKEN,\n *   dataSourceId: \"...\",\n *   enrichers: [notionKatex({ displayMode: true })],\n * });\n * ```\n */\nexport function notionKatex(opts?: NotionKatexOptions): BlockEnricher {\n  const katexOpts = {\n    displayMode: opts?.displayMode ?? true,\n    throwOnError: opts?.throwOnError ?? false,\n    ...(opts?.macros && { macros: opts.macros }),\n  };\n\n  return async (\n    blocks: NotionBlockTreeNode[],\n  ): Promise<NotionBlockTreeNode[]> => {\n    enrichBlocks(blocks, katexOpts);\n    return blocks;\n  };\n}\n\ntype KatexRenderOptions = {\n  displayMode: boolean;\n  throwOnError: boolean;\n  macros?: Record<string, string>;\n};\n\nfunction enrichBlocks(\n  blocks: NotionBlockTreeNode[],\n  opts: KatexRenderOptions,\n): void {\n  for (const block of blocks) {\n    if (block.type === \"equation\") {\n      const eq = block.equation as {\n        expression: string;\n        __cachedHtml?: string;\n      };\n      try {\n        eq.__cachedHtml = katex.renderToString(eq.expression, opts);\n      } catch {\n        // レンダリング失敗時は __cachedHtml を設定せず、react-renderer の <pre> フォールバックを使う\n      }\n    }\n    if (block.children?.length) {\n      enrichBlocks(block.children, opts);\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAyCA,SAAgB,YAAY,MAA0C;CACpE,MAAM,YAAY;EAChB,aAAa,MAAM,eAAe;EAClC,cAAc,MAAM,gBAAgB;EACpC,GAAI,MAAM,UAAU,EAAE,QAAQ,KAAK,QAAQ;EAC5C;AAED,QAAO,OACL,WACmC;AACnC,eAAa,QAAQ,UAAU;AAC/B,SAAO;;;AAUX,SAAS,aACP,QACA,MACM;AACN,MAAK,MAAM,SAAS,QAAQ;AAC1B,MAAI,MAAM,SAAS,YAAY;GAC7B,MAAM,KAAK,MAAM;AAIjB,OAAI;AACF,OAAG,eAAe,MAAM,eAAe,GAAG,YAAY,KAAK;WACrD;;AAIV,MAAI,MAAM,UAAU,OAClB,cAAa,MAAM,UAAU,KAAK"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@notion-headless-cms/notion-katex",
+  "version": "0.1.1",
+  "description": "Notion equation ブロックを fetch 時に KaTeX で pre-render し、Workers バンドルから katex を除外する拡張パッケージ",
+  "keywords": [
+    "notion",
+    "headless-cms",
+    "katex",
+    "math",
+    "equation",
+    "pre-render",
+    "typescript"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/kjfsm/notion-headless-cms#readme",
+  "bugs": {
+    "url": "https://github.com/kjfsm/notion-headless-cms/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kjfsm/notion-headless-cms.git",
+    "directory": "packages/notion-katex"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "katex": "^0.16.11",
+    "@notion-headless-cms/notion-orm": "0.1.23"
+  },
+  "devDependencies": {
+    "katex": "^0.16.11",
+    "@notion-headless-cms/notion-orm": "0.1.23"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --dts --sourcemap --out-dir dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage --coverage.reporter=lcov --coverage.reporter=text",
+    "publint": "publint --strict",
+    "attw": "attw --pack . --profile esm-only"
+  }
+}