feat(parser): strict 옵션 추가

packages/parser/src/index.ts

@@ -26,4 +26,7 @@ export * from './constants/ctrl-id.js'
 export * from './models/document.js'
 export * from './models/controls/page-definition.js'
 
+// type export only
+export type * from './types/parser.js'
+
 export * from './parse.js'

packages/parser/src/models/controls/common-properties.ts

@@ -21,6 +21,7 @@ import type { HWPRecord } from '../record.js'
 import { SectionTagID } from '../../constants/tag-id.js'
 import type { HWPVersion } from '../version.js'
 import { ParagraphList } from './paragraph-list.js'
+import type { ParseOptions } from '../../types/parser.js'
 
 /**
  * 개체 공통 속성
@@ -112,6 +113,7 @@ export class CommonProperties {
     record: HWPRecord,
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const reader = new ByteReader(record.data)
     const ctrlId = reader.readUInt32()
@@ -185,7 +187,7 @@ export class CommonProperties {
 
     const caption =
       iterator.peek().id === SectionTagID.HWPTAG_LIST_HEADER
-        ? Caption.fromRecords(iterator, version)
+        ? Caption.fromRecords(iterator, version, options)
         : undefined
 
     return new CommonProperties(
@@ -404,14 +406,15 @@ export class Caption {
   static fromRecords(
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const record = iterator.next()
     if (record.id !== SectionTagID.HWPTAG_LIST_HEADER) {
       throw new Error('Caption: Record has wrong ID')
     }
 
     const reader = new ByteReader(record.data)
-    const paragraphs = ParagraphList.fromReader(reader, iterator, version)
+    const paragraphs = ParagraphList.fromReader(reader, iterator, version, options)
 
     const attribute = reader.readUInt32()
     const align = mapCaptionAlign(getBitValue(attribute, 0, 1))

packages/parser/src/models/controls/content.ts

@@ -15,6 +15,7 @@
  */
 
 import { CommonCtrlID, OtherCtrlID } from '../../constants/ctrl-id.js'
+import type { ParseOptions } from '../../types/parser.js'
 import type { PeekableIterator } from '../../utils/generator.js'
 import type { HWPRecord } from '../record.js'
 import { HWPVersion } from '../version.js'
@@ -36,14 +37,15 @@ export function parseControl(
   current: HWPRecord,
   iterator: PeekableIterator<HWPRecord>,
   version: HWPVersion,
+  options: ParseOptions,
 ): ControlContent {
   switch (ctrlId) {
     case OtherCtrlID.Section:
       return SectionControl.fromRecord(current, iterator, version)
     case CommonCtrlID.Table:
-      return TableControl.fromRecord(current, iterator, version)
+      return TableControl.fromRecord(current, iterator, version, options)
     case CommonCtrlID.GenShapeObject:
-      return GenShapeObjectControl.fromRecord(current, iterator, version)
+      return GenShapeObjectControl.fromRecord(current, iterator, version, options)
     default:
       return UnknownControl.fromRecord(current, iterator)
   }

packages/parser/src/models/controls/draw-text.ts

@@ -1,4 +1,5 @@
 import { SectionTagID } from '../../constants/tag-id.js'
+import type { ParseOptions } from '../../types/parser.js'
 import { ByteReader } from '../../utils/byte-reader.js'
 import type { PeekableIterator } from '../../utils/generator.js'
 import type { HWPRecord } from '../record.js'
@@ -27,14 +28,15 @@ export class DrawText {
   static fromRecords(
     records: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const record = records.next()
     if (record.id !== SectionTagID.HWPTAG_LIST_HEADER) {
       throw new Error('BodyText: DrawText: Record has wrong ID')
     }
 
     const reader = new ByteReader(record.data)
-    const paragraphs = ParagraphList.fromReader(reader, records, version)
+    const paragraphs = ParagraphList.fromReader(reader, records, version, options)
 
     const marginLeft = reader.readUInt16()
     const marginRight = reader.readUInt16()

packages/parser/src/models/controls/index.ts

@@ -20,13 +20,15 @@ import type { HWPRecord } from '../record.js'
 import { SectionTagID } from '../../constants/tag-id.js'
 import { type ControlContent, parseControl } from './content.js'
 import { HWPVersion } from '../version.js'
+import type { ParseOptions } from '../../types/parser.js'
 
 export class Control {
   constructor(public id: number, public content: ControlContent) {}
 
   static fromRecords(
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const current = iterator.next()
     if (current.id !== SectionTagID.HWPTAG_CTRL_HEADER) {
@@ -36,7 +38,7 @@ export class Control {
     const reader = new ByteReader(current.data)
     const id = reader.readUInt32()
 
-    const content = parseControl(id, current, iterator, version)
+    const content = parseControl(id, current, iterator, version, options)
 
     return new Control(id, content)
   }

packages/parser/src/models/controls/paragraph-list.ts

@@ -19,6 +19,7 @@ import type { PeekableIterator } from '../../utils/generator.js'
 import type { HWPRecord } from '../record.js'
 import type { HWPVersion } from '../version.js'
 import { Paragraph } from '../paragraph.js'
+import type { ParseOptions } from '../../types/parser.js'
 
 /**
  * 문단 리스트
@@ -33,13 +34,14 @@ export class ParagraphList {
     reader: ByteReader,
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const header = ParagraphListHeader.fromReader(reader)
 
     // NOTE: 나머지 속성은 사용처에서 파싱해야함
     const paragraphs: Paragraph[] = []
     for (let i = 0; i < header.count; i++) {
-      paragraphs.push(Paragraph.fromRecord(iterator, version))
+      paragraphs.push(Paragraph.fromRecord(iterator, version, options))
     }
 
     return new ParagraphList(header, paragraphs)

packages/parser/src/models/controls/shapes/picture.ts

@@ -15,6 +15,7 @@
  */
 
 import { SectionTagID } from '../../../constants/tag-id.js'
+import type { ParseOptions } from '../../../types/parser.js'
 import { getBitValue, getFlag } from '../../../utils/bit-utils.js'
 import { ByteReader } from '../../../utils/byte-reader.js'
 import type { PeekableIterator } from '../../../utils/generator.js'
@@ -49,11 +50,13 @@ export class PictureControl {
     record: HWPRecord,
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const commonProperties = CommonProperties.fromRecord(
       record,
       iterator,
       version,
+      options,
     )
     const elementProperties = ElementProperties.fromRecords(iterator, false)
     const content = PictureRecord.fromRecords(iterator)

packages/parser/src/models/controls/shapes/shape.ts

@@ -15,6 +15,7 @@
  */
 
 import { SectionTagID } from '../../../constants/tag-id.js'
+import type { ParseOptions } from '../../../types/parser.js'
 import type { PeekableIterator } from '../../../utils/generator.js'
 import type { HWPRecord } from '../../record.js'
 import type { HWPVersion } from '../../version.js'
@@ -42,18 +43,20 @@ export class GenShapeObjectControl {
     record: HWPRecord,
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const commonProperties = CommonProperties.fromRecord(
       record,
       iterator,
       version,
+      options,
     )
 
     const elementProperties = ElementProperties.fromRecords(iterator, true)
 
     const drawText =
       iterator.peek().id === SectionTagID.HWPTAG_LIST_HEADER
-        ? DrawText.fromRecords(iterator, version)
+        ? DrawText.fromRecords(iterator, version, options)
         : null
 
     const content = parseContent(elementProperties, record, iterator)

packages/parser/src/models/controls/table.ts

@@ -22,6 +22,7 @@ import { HWPVersion } from '../version.js'
 import { CommonProperties } from './common-properties.js'
 import { SectionTagID } from '../../constants/tag-id.js'
 import { ParagraphList } from './paragraph-list.js'
+import type { ParseOptions } from '../../types/parser.js'
 
 export class TableControl {
   constructor(
@@ -35,11 +36,13 @@ export class TableControl {
     record: HWPRecord,
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const commonProperties = CommonProperties.fromRecord(
       record,
       iterator,
       version,
+      options,
     )
 
     const next = iterator.next()
@@ -54,7 +57,7 @@ export class TableControl {
     )
 
     for (let i = 0; i < cellCount; i++) {
-      cells.push(Cell.fromRecords(iterator, version))
+      cells.push(Cell.fromRecords(iterator, version, options))
     }
 
     return new TableControl(commonProperties, tableRecord, cells)
@@ -209,14 +212,15 @@ export class Cell {
   static fromRecords(
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const record = iterator.next()
     if (record.id !== SectionTagID.HWPTAG_LIST_HEADER) {
       throw new Error('BodyText: Cell: Record has wrong ID')
     }
 
     const reader = new ByteReader(record.data)
-    const paragraphs = ParagraphList.fromReader(reader, iterator, version)
+    const paragraphs = ParagraphList.fromReader(reader, iterator, version, options)
 
     const column = reader.readUInt16()
     const row = reader.readUInt16()

packages/parser/src/models/document.ts

@@ -15,11 +15,13 @@
  */
 
 import { find, read } from 'cfb'
+import { inflate } from 'pako'
+
 import { DocInfo } from './doc-info/doc-info.js'
 import { HWPHeader } from './header.js'
 import { Section } from './section.js'
 import { BinData } from './bin-data.js'
-import { inflate } from 'pako'
+import type { ParseOptions } from '../types/parser.js'
 
 export class HWPDocument {
   constructor(
@@ -29,7 +31,7 @@ export class HWPDocument {
     public binDataList: BinData[],
   ) {}
 
-  static fromBytes(buffer: Uint8Array) {
+  static fromBytes(buffer: Uint8Array, options: ParseOptions) {
     const container = read(buffer, {
       type: 'array',
     })
@@ -45,7 +47,7 @@ export class HWPDocument {
       if (!entry) {
         throw new Error('Section not exist')
       }
-      sections.push(Section.fromEntry(entry, header))
+      sections.push(Section.fromEntry(entry, header, options))
     }
 
     const binDataList: BinData[] = []

packages/parser/src/models/paragraph.ts

@@ -26,6 +26,7 @@ import { CharList } from './char-list.js'
 import { collectChildren } from '../utils/record.js'
 import { RangeTag } from './range-tag.js'
 import { CharShape } from './char-shape.js'
+import type { ParseOptions } from '../types/parser.js'
 
 export class Paragraph {
   constructor(
@@ -40,6 +41,7 @@ export class Paragraph {
   static fromRecord(
     iterator: PeekableIterator<HWPRecord>,
     version: HWPVersion,
+    options: ParseOptions,
   ) {
     const current = iterator.next()
     const header = ParagraphHeader.fromRecord(current, version)
@@ -98,11 +100,11 @@ export class Paragraph {
 
     const controls: Control[] = chars
       .extendedControls()
-      .map(() => Control.fromRecords(iterator, version))
+      .map(() => Control.fromRecords(iterator, version, options))
 
     const unknown = collectChildren(iterator, current.level)
 
-    if (unknown.length > 0) {
+    if (options.strict && unknown.length > 0) {
       throw new Error('BodyText: Paragraph: Unknown records')
     }
 

packages/parser/src/models/section.ts

@@ -21,27 +21,28 @@ import type { HWPHeader } from './header.js'
 import { Paragraph } from './paragraph.js'
 import { ByteReader } from '../utils/byte-reader.js'
 import { PeekableIterator } from '../utils/generator.js'
+import type { ParseOptions } from '../types/parser.js'
 
 export class Section {
   constructor(public paragraphs: Paragraph[]) {}
 
-  static fromEntry(entry: CFB$Entry, header: HWPHeader): Section {
+  static fromEntry(entry: CFB$Entry, header: HWPHeader, options: ParseOptions): Section {
     const content = Uint8Array.from(entry.content)
 
     if (header.flags.compressed) {
       const decoded = inflate(content, { windowBits: -15 })
-      return Section.fromBuffer(decoded.buffer, header)
+      return Section.fromBuffer(decoded.buffer, header, options)
     }
 
-    return Section.fromBuffer(content.buffer, header)
+    return Section.fromBuffer(content.buffer, header, options)
   }
 
-  static fromBuffer(buffer: ArrayBuffer, header: HWPHeader): Section {
+  static fromBuffer(buffer: ArrayBuffer, header: HWPHeader, options: ParseOptions): Section {
     const reader = new ByteReader(buffer)
     const records = new PeekableIterator(reader.records())
     const paragraphs: Paragraph[] = []
     while (!records.isDone()) {
-      paragraphs.push(Paragraph.fromRecord(records, header.version))
+      paragraphs.push(Paragraph.fromRecord(records, header.version, options))
     }
     return new Section(paragraphs)
   }

packages/parser/src/parse.ts

@@ -15,9 +15,15 @@
  */
 
 import { HWPDocument } from './models/document.js'
+import type { ParseOptions } from './types/parser.js'
 
-export function parse(buffer: Uint8Array | ArrayBuffer): HWPDocument {
-  return HWPDocument.fromBytes(convertTypedArray(buffer))
+export function parse(
+  buffer: Uint8Array | ArrayBuffer,
+  { strict = true }: Partial<ParseOptions> = {},
+): HWPDocument {
+  return HWPDocument.fromBytes(convertTypedArray(buffer), {
+    strict,
+  })
 }
 
 function convertTypedArray(data: Uint8Array | ArrayBuffer): Uint8Array {

packages/parser/src/types/parser.ts

@@ -0,0 +1,3 @@
+export interface ParseOptions {
+  strict: boolean
+}