@hamster-note/document-parser 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 仓鼠笔记
+
+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/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@hamster-note/document-parser",
+  "version": "0.1.0",
+  "description": "",
+  "scripts": {
+    "build:all": "echo 'no-build'",
+    "test": "echo 'no-test'"
+  },
+  "dependencies": {
+    "@hamster-note/types": "^0.1.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@system-ui-js/development-base": "^0.1.2",
+    "@typescript-eslint/eslint-plugin": "^8.50.0",
+    "@typescript-eslint/parser": "^8.50.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-sonarjs": "^3.0.5",
+    "globals": "^15.14.0",
+    "prettier": "^3.7.4",
+    "prettier-config-standard": "^7.0.0",
+    "typescript": "^5.0.2",
+    "typescript-eslint": "^8.50.0"
+  },
+  "main": "src/index.ts",
+  "module": "src/index.ts",
+  "types": "src/index.ts",
+  "files": [
+    "src"
+  ],
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}

package/src/Document/index.ts

@@ -0,0 +1,13 @@
+import { HamsterPage } from '../Page'
+import { IntermediateOutline } from '@hamster-note/types'
+
+export abstract class HamsterDocument {
+  // 获取 Page 对象列表
+  abstract getPages(): Promise<HamsterPage[]>
+  // 获取 Page 对象
+  abstract getPage(pageNumber: number): Promise<HamsterPage | undefined>
+  // 获取大纲（PDF如果有内置的话）
+  abstract getOutline(): Promise<IntermediateOutline | undefined>
+  // 获取封面
+  abstract getCover(): Promise<HTMLCanvasElement | HTMLImageElement>
+}

package/src/Page/index.ts

@@ -0,0 +1,22 @@
+import { Number2 } from '@hamster-note/types'
+
+export enum RenderViews {
+  THUMBNAIL = 'thumbnail',
+  TEXT = 'text'
+}
+
+export interface RenderOptions {
+  views: RenderViews[]
+  scale: number
+}
+
+export abstract class HamsterPage {
+  abstract render(
+    container: HTMLDivElement,
+    options?: RenderOptions
+  ): Promise<void>
+  abstract getNumber(): number
+  abstract getSize(scale: number): Number2
+  abstract getPureText(): string
+  // abstract getTextDom
+}

package/src/Parser/index.ts

@@ -0,0 +1,28 @@
+import { HamsterDocument } from '../Document'
+import { IntermediateDocument } from '@hamster-note/types'
+
+export class DocumentParser {
+  static readonly ext: string
+  // Base static methods to be overridden by concrete parsers
+  static async encode(
+    _file: File | ArrayBuffer
+  ): Promise<IntermediateDocument | HamsterDocument | undefined> {
+    return Promise.resolve(undefined)
+  }
+  static async decode(
+    _intermediateDocument: IntermediateDocument
+  ): Promise<File | ArrayBuffer | undefined> {
+    return Promise.resolve(undefined)
+  }
+  protected static async toArrayBuffer(
+    fileOrBuffer: File | ArrayBuffer
+  ): Promise<ArrayBuffer> {
+    if (fileOrBuffer instanceof ArrayBuffer) return fileOrBuffer
+    return await new Promise<ArrayBuffer>((resolve, reject) => {
+      const reader = new FileReader()
+      reader.readAsArrayBuffer(fileOrBuffer)
+      reader.onload = () => resolve(reader.result as ArrayBuffer)
+      reader.onerror = (e) => reject(e)
+    })
+  }
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './Document'
+export * from './Page'
+export * from './types/DocumentAnchor'
+export * from './Parser'
+export * from './register'

package/src/register/index.ts

@@ -0,0 +1,30 @@
+import { DocumentParser } from '../Parser'
+
+// Store constructors (classes), not instances
+const parserMap: Map<string, typeof DocumentParser> = new Map()
+
+// Register a parser class (constructor) which exposes a static `ext`
+export const registerParser = (parser: typeof DocumentParser) => {
+  console.log(parser.ext, parser)
+  parserMap.set(parser.ext, parser)
+}
+
+export function getParser(file: File): typeof DocumentParser | undefined {
+  const extension = file.name.split('.').pop()
+  if (!extension) {
+    return undefined
+  }
+  return parserMap.get(extension)
+}
+
+export function parse(file: File) {
+  const Parser = getParser(file)
+  console.log('Parse:', Parser)
+  if (!Parser) {
+    return undefined
+  }
+  // call static encode on the parser class
+  const res = Parser.encode(file)
+  // res.then((_doc) => { /* window.doc1 = _doc */ })
+  return res
+}

package/src/types/DocumentAnchor.ts

@@ -0,0 +1,17 @@
+// 文档锚（标记了文字id）
+import { Number2 } from '@hamster-note/types'
+
+export interface DocumentAnchorWithTextId {
+  pageId: string
+  textId?: string
+}
+
+// 文档锚（标记了位置）
+export interface DocumentAnchorWithPosition {
+  pageId: string
+  position: Number2
+}
+
+export type DocumentAnchor =
+  | DocumentAnchorWithPosition
+  | DocumentAnchorWithTextId