@hamster-note/document-parser 0.2.1 → 0.3.1

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { IntermediateDocument, Number2 } from "@hamster-note/types";
+import { IntermediateDocument, IntermediateOutline, Number2 } from "@hamster-note/types";
 
 //#region src/types/DocumentAnchor.d.ts
 interface DocumentAnchorWithTextId {
@@ -49,5 +49,29 @@ declare function listRegisteredParsers(): {
   parser: DocumentParserConstructor<DocumentParser>;
 }[];
 //#endregion
-export { DocumentAnchor, DocumentAnchorWithPosition, DocumentAnchorWithTextId, DocumentParser, DocumentParserConstructor, ParseOptions, ParserInput, getParserByExt, listRegisteredParsers, parse, registerParser, unregisterParser };
+//#region src/Page/index.d.ts
+declare enum RenderViews {
+  THUMBNAIL = "thumbnail",
+  TEXT = "text",
+}
+interface RenderOptions {
+  views: RenderViews[];
+  scale: number;
+}
+declare abstract class HamsterPage {
+  abstract render(container: HTMLDivElement, options?: RenderOptions): Promise<void>;
+  abstract getNumber(): number;
+  abstract getSize(scale: number): Number2;
+  abstract getPureText(): string;
+}
+//#endregion
+//#region src/Document/index.d.ts
+declare abstract class HamsterDocument {
+  abstract getPages(): Promise<HamsterPage[]>;
+  abstract getPage(pageNumber: number): Promise<HamsterPage | undefined>;
+  abstract getOutline(): Promise<IntermediateOutline | undefined>;
+  abstract getCover(): Promise<HTMLCanvasElement | HTMLImageElement>;
+}
+//#endregion
+export { DocumentAnchor, DocumentAnchorWithPosition, DocumentAnchorWithTextId, DocumentParser, DocumentParserConstructor, HamsterDocument, HamsterPage, ParseOptions, ParserInput, RenderOptions, RenderViews, getParserByExt, listRegisteredParsers, parse, registerParser, unregisterParser };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -62,5 +62,18 @@ function listRegisteredParsers() {
 }
 
 //#endregion
-export { DocumentParser, getParserByExt, listRegisteredParsers, parse, registerParser, unregisterParser };
+//#region src/Page/index.ts
+let RenderViews = /* @__PURE__ */ function(RenderViews$1) {
+	RenderViews$1["THUMBNAIL"] = "thumbnail";
+	RenderViews$1["TEXT"] = "text";
+	return RenderViews$1;
+}({});
+var HamsterPage = class {};
+
+//#endregion
+//#region src/Document/index.ts
+var HamsterDocument = class {};
+
+//#endregion
+export { DocumentParser, HamsterDocument, HamsterPage, RenderViews, getParserByExt, listRegisteredParsers, parse, registerParser, unregisterParser };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/Parser/index.ts","../src/register/index.ts"],"sourcesContent":["import type { IntermediateDocument } from '@hamster-note/types'\n\n// 解析器通用输入，兼容 Browser / Worker / Node（Buffer 属于 ArrayBufferView）\nexport type ParserInput = ArrayBuffer | ArrayBufferView | Blob\n\nexport abstract class DocumentParser {\n  // 子类必须声明支持的扩展名列表（不带点），用于注册分发\n  static readonly exts: readonly string[] = []\n\n  /**\n   * 将原始输入解析为中间文档结构。\n   * - 输入必须是内存态数据（ArrayBuffer / ArrayBufferView / Blob）\n   * - 失败时抛出异常；不要返回 undefined。\n   */\n  abstract encode(input: ParserInput): Promise<IntermediateDocument>\n\n  /**\n   * 可选：从中间文档逆序列化回原始文件数据。\n   * 默认不支持，需要的子类自行实现。\n   */\n  decode(_intermediateDocument: IntermediateDocument): Promise<ParserInput> {\n    return Promise.reject(new Error('decode is not implemented'))\n  }\n\n  // 将各种输入转换为 ArrayBuffer，方便子类直接消费二进制\n  protected static async toArrayBuffer(\n    input: ParserInput\n  ): Promise<ArrayBuffer> {\n    if (input instanceof ArrayBuffer) {\n      return input\n    }\n    if (ArrayBuffer.isView(input)) {\n      // 拷贝为独立的 ArrayBuffer，避免 SharedArrayBuffer 兼容性问题\n      const buffer = new ArrayBuffer(input.byteLength)\n      new Uint8Array(buffer).set(\n        new Uint8Array(input.buffer, input.byteOffset, input.byteLength)\n      )\n      return buffer\n    }\n    if (typeof Blob !== 'undefined' && input instanceof Blob) {\n      return input.arrayBuffer()\n    }\n    throw new TypeError('Unsupported parser input')\n  }\n\n  // 子类若需要 Uint8Array，可直接复用\n  protected static async toUint8Array(input: ParserInput): Promise<Uint8Array> {\n    const buffer = await DocumentParser.toArrayBuffer(input)\n    return new Uint8Array(buffer)\n  }\n}\n","import type { DocumentParser, ParserInput } from '../Parser/index'\nimport type { IntermediateDocument } from '@hamster-note/types'\n\nexport interface DocumentParserConstructor<\n  T extends DocumentParser = DocumentParser\n> {\n  new (): T\n  readonly exts: readonly string[]\n}\n\nconst parserMap: Map<string, DocumentParserConstructor> = new Map()\n\nconst normalizeExt = (ext: string) => ext.replace(/^\\./, '').toLowerCase()\n\n// 注册解析器：防止重复注册同扩展名的不同类\nexport const registerParser = (Parser: DocumentParserConstructor) => {\n  if (!Array.isArray(Parser.exts) || Parser.exts.length === 0) {\n    throw new Error('Parser.exts 必须是非空数组')\n  }\n  Parser.exts.forEach((ext) => {\n    const key = normalizeExt(ext)\n    const exists = parserMap.get(key)\n    if (exists && exists !== Parser) {\n      throw new Error(`扩展名 ${key} 已被其他解析器占用`)\n    }\n    parserMap.set(key, Parser)\n  })\n}\n\nexport function unregisterParser(Parser: DocumentParserConstructor) {\n  Parser.exts.forEach((ext) => {\n    const key = normalizeExt(ext)\n    const exists = parserMap.get(key)\n    if (exists === Parser) {\n      parserMap.delete(key)\n    }\n  })\n}\n\nexport function getParserByExt(\n  ext?: string\n): DocumentParserConstructor | undefined {\n  if (!ext) return undefined\n  return parserMap.get(normalizeExt(ext))\n}\n\nexport interface ParseOptions {\n  filename?: string\n  ext?: string\n  parser?: DocumentParserConstructor\n}\n\nexport async function parse(\n  input: ParserInput,\n  options: ParseOptions = {}\n): Promise<IntermediateDocument> {\n  const extFromName = options.filename?.split('.').pop()\n  const ext = options.ext ?? extFromName\n  const Parser = options.parser ?? getParserByExt(ext)\n\n  if (!Parser) {\n    throw new Error(\n      `未找到匹配的解析器，扩展名: ${ext ?? '未知'}，已注册: ${[\n        ...parserMap.keys()\n      ].join(', ')}`\n    )\n  }\n\n  const parser = new Parser()\n  return parser.encode(input)\n}\n\n// 便于测试或运行时可观测性\nexport function listRegisteredParsers() {\n  return [...parserMap.entries()].map(([ext, ctor]) => ({ ext, parser: ctor }))\n}\n"],"mappings":";AAKA,IAAsB,iBAAtB,MAAsB,eAAe;CAEnC,OAAgB,OAA0B,EAAE;;;;;CAa5C,OAAO,uBAAmE;AACxE,SAAO,QAAQ,uBAAO,IAAI,MAAM,4BAA4B,CAAC;;CAI/D,aAAuB,cACrB,OACsB;AACtB,MAAI,iBAAiB,YACnB,QAAO;AAET,MAAI,YAAY,OAAO,MAAM,EAAE;GAE7B,MAAM,SAAS,IAAI,YAAY,MAAM,WAAW;AAChD,OAAI,WAAW,OAAO,CAAC,IACrB,IAAI,WAAW,MAAM,QAAQ,MAAM,YAAY,MAAM,WAAW,CACjE;AACD,UAAO;;AAET,MAAI,OAAO,SAAS,eAAe,iBAAiB,KAClD,QAAO,MAAM,aAAa;AAE5B,QAAM,IAAI,UAAU,2BAA2B;;CAIjD,aAAuB,aAAa,OAAyC;EAC3E,MAAM,SAAS,MAAM,eAAe,cAAc,MAAM;AACxD,SAAO,IAAI,WAAW,OAAO;;;;;;ACtCjC,MAAM,4BAAoD,IAAI,KAAK;AAEnE,MAAM,gBAAgB,QAAgB,IAAI,QAAQ,OAAO,GAAG,CAAC,aAAa;AAG1E,MAAa,kBAAkB,WAAsC;AACnE,KAAI,CAAC,MAAM,QAAQ,OAAO,KAAK,IAAI,OAAO,KAAK,WAAW,EACxD,OAAM,IAAI,MAAM,sBAAsB;AAExC,QAAO,KAAK,SAAS,QAAQ;EAC3B,MAAM,MAAM,aAAa,IAAI;EAC7B,MAAM,SAAS,UAAU,IAAI,IAAI;AACjC,MAAI,UAAU,WAAW,OACvB,OAAM,IAAI,MAAM,OAAO,IAAI,YAAY;AAEzC,YAAU,IAAI,KAAK,OAAO;GAC1B;;AAGJ,SAAgB,iBAAiB,QAAmC;AAClE,QAAO,KAAK,SAAS,QAAQ;EAC3B,MAAM,MAAM,aAAa,IAAI;AAE7B,MADe,UAAU,IAAI,IAAI,KAClB,OACb,WAAU,OAAO,IAAI;GAEvB;;AAGJ,SAAgB,eACd,KACuC;AACvC,KAAI,CAAC,IAAK,QAAO;AACjB,QAAO,UAAU,IAAI,aAAa,IAAI,CAAC;;AASzC,eAAsB,MACpB,OACA,UAAwB,EAAE,EACK;CAC/B,MAAM,cAAc,QAAQ,UAAU,MAAM,IAAI,CAAC,KAAK;CACtD,MAAM,MAAM,QAAQ,OAAO;CAC3B,MAAM,SAAS,QAAQ,UAAU,eAAe,IAAI;AAEpD,KAAI,CAAC,OACH,OAAM,IAAI,MACR,kBAAkB,OAAO,KAAK,QAAQ,CACpC,GAAG,UAAU,MAAM,CACpB,CAAC,KAAK,KAAK,GACb;AAIH,QADe,IAAI,QAAQ,CACb,OAAO,MAAM;;AAI7B,SAAgB,wBAAwB;AACtC,QAAO,CAAC,GAAG,UAAU,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW;EAAE;EAAK,QAAQ;EAAM,EAAE"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/Parser/index.ts","../src/register/index.ts","../src/Page/index.ts","../src/Document/index.ts"],"sourcesContent":["import type { IntermediateDocument } from '@hamster-note/types'\n\n// 解析器通用输入，兼容 Browser / Worker / Node（Buffer 属于 ArrayBufferView）\nexport type ParserInput = ArrayBuffer | ArrayBufferView | Blob\n\nexport abstract class DocumentParser {\n  // 子类必须声明支持的扩展名列表（不带点），用于注册分发\n  static readonly exts: readonly string[] = []\n\n  /**\n   * 将原始输入解析为中间文档结构。\n   * - 输入必须是内存态数据（ArrayBuffer / ArrayBufferView / Blob）\n   * - 失败时抛出异常；不要返回 undefined。\n   */\n  abstract encode(input: ParserInput): Promise<IntermediateDocument>\n\n  /**\n   * 可选：从中间文档逆序列化回原始文件数据。\n   * 默认不支持，需要的子类自行实现。\n   */\n  decode(_intermediateDocument: IntermediateDocument): Promise<ParserInput> {\n    return Promise.reject(new Error('decode is not implemented'))\n  }\n\n  // 将各种输入转换为 ArrayBuffer，方便子类直接消费二进制\n  protected static async toArrayBuffer(\n    input: ParserInput\n  ): Promise<ArrayBuffer> {\n    if (input instanceof ArrayBuffer) {\n      return input\n    }\n    if (ArrayBuffer.isView(input)) {\n      // 拷贝为独立的 ArrayBuffer，避免 SharedArrayBuffer 兼容性问题\n      const buffer = new ArrayBuffer(input.byteLength)\n      new Uint8Array(buffer).set(\n        new Uint8Array(input.buffer, input.byteOffset, input.byteLength)\n      )\n      return buffer\n    }\n    if (typeof Blob !== 'undefined' && input instanceof Blob) {\n      return input.arrayBuffer()\n    }\n    throw new TypeError('Unsupported parser input')\n  }\n\n  // 子类若需要 Uint8Array，可直接复用\n  protected static async toUint8Array(input: ParserInput): Promise<Uint8Array> {\n    const buffer = await DocumentParser.toArrayBuffer(input)\n    return new Uint8Array(buffer)\n  }\n}\n","import type { DocumentParser, ParserInput } from '../Parser/index'\nimport type { IntermediateDocument } from '@hamster-note/types'\n\nexport interface DocumentParserConstructor<\n  T extends DocumentParser = DocumentParser\n> {\n  new (): T\n  readonly exts: readonly string[]\n}\n\nconst parserMap: Map<string, DocumentParserConstructor> = new Map()\n\nconst normalizeExt = (ext: string) => ext.replace(/^\\./, '').toLowerCase()\n\n// 注册解析器：防止重复注册同扩展名的不同类\nexport const registerParser = (Parser: DocumentParserConstructor) => {\n  if (!Array.isArray(Parser.exts) || Parser.exts.length === 0) {\n    throw new Error('Parser.exts 必须是非空数组')\n  }\n  Parser.exts.forEach((ext) => {\n    const key = normalizeExt(ext)\n    const exists = parserMap.get(key)\n    if (exists && exists !== Parser) {\n      throw new Error(`扩展名 ${key} 已被其他解析器占用`)\n    }\n    parserMap.set(key, Parser)\n  })\n}\n\nexport function unregisterParser(Parser: DocumentParserConstructor) {\n  Parser.exts.forEach((ext) => {\n    const key = normalizeExt(ext)\n    const exists = parserMap.get(key)\n    if (exists === Parser) {\n      parserMap.delete(key)\n    }\n  })\n}\n\nexport function getParserByExt(\n  ext?: string\n): DocumentParserConstructor | undefined {\n  if (!ext) return undefined\n  return parserMap.get(normalizeExt(ext))\n}\n\nexport interface ParseOptions {\n  filename?: string\n  ext?: string\n  parser?: DocumentParserConstructor\n}\n\nexport async function parse(\n  input: ParserInput,\n  options: ParseOptions = {}\n): Promise<IntermediateDocument> {\n  const extFromName = options.filename?.split('.').pop()\n  const ext = options.ext ?? extFromName\n  const Parser = options.parser ?? getParserByExt(ext)\n\n  if (!Parser) {\n    throw new Error(\n      `未找到匹配的解析器，扩展名: ${ext ?? '未知'}，已注册: ${[\n        ...parserMap.keys()\n      ].join(', ')}`\n    )\n  }\n\n  const parser = new Parser()\n  return parser.encode(input)\n}\n\n// 便于测试或运行时可观测性\nexport function listRegisteredParsers() {\n  return [...parserMap.entries()].map(([ext, ctor]) => ({ ext, parser: ctor }))\n}\n","import { Number2 } from '@hamster-note/types'\n\nexport enum RenderViews {\n  THUMBNAIL = 'thumbnail',\n  TEXT = 'text'\n}\n\nexport interface RenderOptions {\n  views: RenderViews[]\n  scale: number\n}\n\nexport abstract class HamsterPage {\n  abstract render(\n    container: HTMLDivElement,\n    options?: RenderOptions\n  ): Promise<void>\n  abstract getNumber(): number\n  abstract getSize(scale: number): Number2\n  abstract getPureText(): string\n}\n","import { HamsterPage } from '../Page'\nimport { IntermediateOutline } from '@hamster-note/types'\n\nexport abstract class HamsterDocument {\n  abstract getPages(): Promise<HamsterPage[]>\n  abstract getPage(pageNumber: number): Promise<HamsterPage | undefined>\n  abstract getOutline(): Promise<IntermediateOutline | undefined>\n  abstract getCover(): Promise<HTMLCanvasElement | HTMLImageElement>\n}\n"],"mappings":";AAKA,IAAsB,iBAAtB,MAAsB,eAAe;CAEnC,OAAgB,OAA0B,EAAE;;;;;CAa5C,OAAO,uBAAmE;AACxE,SAAO,QAAQ,uBAAO,IAAI,MAAM,4BAA4B,CAAC;;CAI/D,aAAuB,cACrB,OACsB;AACtB,MAAI,iBAAiB,YACnB,QAAO;AAET,MAAI,YAAY,OAAO,MAAM,EAAE;GAE7B,MAAM,SAAS,IAAI,YAAY,MAAM,WAAW;AAChD,OAAI,WAAW,OAAO,CAAC,IACrB,IAAI,WAAW,MAAM,QAAQ,MAAM,YAAY,MAAM,WAAW,CACjE;AACD,UAAO;;AAET,MAAI,OAAO,SAAS,eAAe,iBAAiB,KAClD,QAAO,MAAM,aAAa;AAE5B,QAAM,IAAI,UAAU,2BAA2B;;CAIjD,aAAuB,aAAa,OAAyC;EAC3E,MAAM,SAAS,MAAM,eAAe,cAAc,MAAM;AACxD,SAAO,IAAI,WAAW,OAAO;;;;;;ACtCjC,MAAM,4BAAoD,IAAI,KAAK;AAEnE,MAAM,gBAAgB,QAAgB,IAAI,QAAQ,OAAO,GAAG,CAAC,aAAa;AAG1E,MAAa,kBAAkB,WAAsC;AACnE,KAAI,CAAC,MAAM,QAAQ,OAAO,KAAK,IAAI,OAAO,KAAK,WAAW,EACxD,OAAM,IAAI,MAAM,sBAAsB;AAExC,QAAO,KAAK,SAAS,QAAQ;EAC3B,MAAM,MAAM,aAAa,IAAI;EAC7B,MAAM,SAAS,UAAU,IAAI,IAAI;AACjC,MAAI,UAAU,WAAW,OACvB,OAAM,IAAI,MAAM,OAAO,IAAI,YAAY;AAEzC,YAAU,IAAI,KAAK,OAAO;GAC1B;;AAGJ,SAAgB,iBAAiB,QAAmC;AAClE,QAAO,KAAK,SAAS,QAAQ;EAC3B,MAAM,MAAM,aAAa,IAAI;AAE7B,MADe,UAAU,IAAI,IAAI,KAClB,OACb,WAAU,OAAO,IAAI;GAEvB;;AAGJ,SAAgB,eACd,KACuC;AACvC,KAAI,CAAC,IAAK,QAAO;AACjB,QAAO,UAAU,IAAI,aAAa,IAAI,CAAC;;AASzC,eAAsB,MACpB,OACA,UAAwB,EAAE,EACK;CAC/B,MAAM,cAAc,QAAQ,UAAU,MAAM,IAAI,CAAC,KAAK;CACtD,MAAM,MAAM,QAAQ,OAAO;CAC3B,MAAM,SAAS,QAAQ,UAAU,eAAe,IAAI;AAEpD,KAAI,CAAC,OACH,OAAM,IAAI,MACR,kBAAkB,OAAO,KAAK,QAAQ,CACpC,GAAG,UAAU,MAAM,CACpB,CAAC,KAAK,KAAK,GACb;AAIH,QADe,IAAI,QAAQ,CACb,OAAO,MAAM;;AAI7B,SAAgB,wBAAwB;AACtC,QAAO,CAAC,GAAG,UAAU,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,WAAW;EAAE;EAAK,QAAQ;EAAM,EAAE;;;;;ACxE/E,IAAY,sDAAL;AACL;AACA;;;AAQF,IAAsB,cAAtB,MAAkC;;;;ACTlC,IAAsB,kBAAtB,MAAsC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hamster-note/document-parser",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "",
   "scripts": {
     "build:all": "rolldown --config rolldown.config.ts",
@@ -8,10 +8,12 @@
     "test": "echo 'no-test'",
     "lint": "echo 'no-lint'"
   },
-  "dependencies": {
+  "dependencies": {},
+  "peerDependencies": {
     "@hamster-note/types": "^0.5.1"
   },
   "devDependencies": {
+    "@hamster-note/types": "^0.5.1",
     "@eslint/js": "^9.39.2",
     "rolldown": "^1.0.0-beta.58",
     "rolldown-plugin-dts": "^0.20.0",
@@ -38,6 +40,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js",
       "import": "./dist/index.js"
     }
   },