hwpkit-dev 0.0.1

package/license.md

@@ -0,0 +1,136 @@
+```
+                GNU LESSER GENERAL PUBLIC LICENSE
+                   Version 2.1, February 1999
+```
+
+Copyright (C) 2026 INMD1
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+[This LGPL license applies to the project **hwpkit** developed by **INMD1**.]
+
+---
+
+### Preamble
+
+The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU Lesser General Public Licenses are intended to guarantee your freedom to share and change free software—to make sure the software is free for all its users.
+
+This license, the Lesser General Public License, applies to some specially designated software packages—typically libraries—of the Free Software Foundation and other authors who decide to use it. You can use it too.
+
+When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software and use pieces of it in new free programs, and that you are informed that you can do these things.
+
+To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it.
+
+For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files so that users can relink them with the library after making changes.
+
+We protect your rights with a two-step method:
+(1) we copyright the library, and
+(2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library.
+
+---
+
+## TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+**0. Definitions.**
+This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder saying it may be distributed under the terms of this Lesser General Public License.
+
+"Library" refers to any such software library or work.
+"Work based on the Library" means either the Library or any derivative work under copyright law.
+
+---
+
+**1. You may copy and distribute verbatim copies of the Library's complete source code** as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty.
+
+---
+
+**2. You may modify your copy or copies of the Library** or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications provided that you also meet all of these conditions:
+
+* a) The modified work must itself be a software library.
+* b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change.
+* c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License.
+* d) If a facility refers to a function or table supplied by an application program, the facility must still operate if the application does not supply it.
+
+---
+
+**3. You may opt to apply the terms of the ordinary GNU General Public License** instead of this License to a given copy of the Library.
+
+---
+
+**4. You may copy and distribute the Library (or a portion or derivative of it) in object code or executable form** under the terms of Sections 1 and 2 provided that you accompany it with the complete corresponding machine-readable source code.
+
+---
+
+**5. A program that contains no derivative of any portion of the Library** but is designed to work with the Library by being compiled or linked with it is called a "work that uses the Library". Such a work is not a derivative work of the Library, and therefore falls outside the scope of this License.
+
+---
+
+**6. As an exception**, you may combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer’s own use and reverse engineering for debugging such modifications.
+
+---
+
+**7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License**, and distribute such a combined library.
+
+---
+
+**8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License.** Any attempt otherwise is void and will automatically terminate your rights under this License.
+
+---
+
+**9. You are not required to accept this License**, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works.
+
+---
+
+**10. Each time you redistribute the Library**, the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms.
+
+---
+
+**11. If, as a consequence of a court judgment or allegation of patent infringement**, conditions are imposed on you that contradict the conditions of this License, they do not excuse you from the conditions of this License.
+
+---
+
+**12. If the distribution and/or use of the Library is restricted in certain countries** either by patents or by copyrighted interfaces, the original copyright holder may add an explicit geographical distribution limitation.
+
+---
+
+**13. The Free Software Foundation may publish revised and/or new versions** of the Lesser General Public License from time to time.
+
+---
+
+**14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible**, write to the author to ask for permission.
+
+---
+
+## NO WARRANTY
+
+**15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY** for the Library, to the extent permitted by applicable law.
+
+---
+
+**16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING** will any copyright holder be liable for damages arising out of the use or inability to use the Library.
+
+---
+
+## END OF TERMS AND CONDITIONS
+
+---
+
+### How to Apply These Terms to Your New Libraries
+
+To apply these terms to your own library, attach the following notices:
+
+```
+TO — Copyright (C) 2026 INMD1
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU Lesser General Public License for more details.
+```
+
+---

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "hwpkit-dev",
+  "description": "HWP/HWPX/DOCX/MD 양방향 문서 변환 라이브러리",
+  "version": "0.0.1",
+  "author": {
+    "name": "INMD1",
+    "email": "lyw514549@gmail.com",
+    "github": "https://github.com/INMD1"
+  },
+  "license": "LGPL-2.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/INMD1/hwpkit.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "playground": "vite --config playground/vite.config.ts"
+  },
+  "dependencies": {
+    "pako": "^2.1.0",
+    "saxes": "^6.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.24",
+    "@types/pako": "^2.0.3",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "vite": "^5.4.21",
+    "vitest": "^2.0.0"
+  }
+}

package/src/contract/decoder.ts

@@ -0,0 +1,7 @@
+import type { DocRoot } from '../model/doc-tree';
+import type { Outcome } from './result';
+
+export interface Decoder {
+  readonly format: string;
+  decode(data: Uint8Array): Promise<Outcome<DocRoot>>;
+}

package/src/contract/encoder.ts

@@ -0,0 +1,7 @@
+import type { DocRoot } from '../model/doc-tree';
+import type { Outcome } from './result';
+
+export interface Encoder {
+  readonly format: string;
+  encode(doc: DocRoot): Promise<Outcome<Uint8Array>>;
+}

package/src/contract/result.ts

@@ -0,0 +1,21 @@
+export type Outcome<T> = Ok<T> | Fail;
+
+export interface Ok<T> {
+  ok: true;
+  data: T;
+  warns: string[];
+}
+
+export interface Fail {
+  ok: false;
+  error: string;
+  warns: string[];
+}
+
+export function succeed<T>(data: T, warns: string[] = []): Ok<T> {
+  return { ok: true, data, warns };
+}
+
+export function fail(error: string, warns: string[] = []): Fail {
+  return { ok: false, error, warns };
+}