braille-codec 0.0.1-rc1

package/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+    tags:
+      - '*'
+
+jobs:
+  build-and-test:
+    name: build & test
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '22'
+          cache: 'pnpm'
+          cache-dependency-path: 'pnpm-lock.yaml'
+
+      - name: Install JS deps
+        run: pnpm install --frozen-lockfile
+
+      - name: Run Node tests
+        run: pnpm test
+
+  publish:
+    name: Publish to npm on tag
+    runs-on: ubuntu-latest
+    needs: build-and-test
+    if: startsWith(github.ref, 'refs/tags/')
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+          run_install: false
+
+      - name: Setup Node and npm auth
+        uses: actions/setup-node@v6
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+          always-auth: true
+          cache: 'pnpm'
+          cache-dependency-path: './pnpm-lock.yaml'
+
+      - name: Install pnpm
+        run: npm install -g pnpm@10
+
+      - name: Install JS deps
+        run: pnpm install --frozen-lockfile
+
+      - name: Set package.json version from tag
+        run: |
+          TAG=${GITHUB_REF#refs/tags/}
+          VERSION=${TAG#v}
+          echo "Setting package.json version to $VERSION"
+          VERSION=$VERSION node -e 'const fs=require("fs"); const pkg=JSON.parse(fs.readFileSync("package.json","utf8")); pkg.version=process.env.VERSION; fs.writeFileSync("package.json", JSON.stringify(pkg,null,2)+"\n");'
+
+      - name: Build package
+        run: pnpm build
+
+      - name: Publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          pnpm npm publish --access public

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,10 @@
+# Braille Codec (braille-codec)
+
+한국어 점자를 디코딩 할 수 있는 라이브러리 입니다.
+
+**주의** 아직 개발 중이라 일부 글자는 손상됩니다!
+
+# Thanks
+
+- https://github.com/dev-five-git/braillify
+

package/bin/braille-decode

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+"use strict";
+
+// Simple CLI wrapper for the Decoder exported from the built library
+// Usage: echo "⠠⠁⠃" | braille-decode
+
+const fs = require('fs');
+const path = require('path');
+
+function loadDecoder() {
+  // Prefer the compiled cjs build at dist/index.cjs
+  const distPath = path.join(__dirname, '..', 'dist', 'index.cjs');
+  if (fs.existsSync(distPath)) {
+    const lib = require(distPath);
+    if (lib && lib.Decoder) return lib.Decoder;
+  }
+
+  // Fallback: try requiring package entry (may work if built as module)
+  try {
+    const lib = require(path.join(__dirname, '..'));
+    if (lib && lib.Decoder) return lib.Decoder;
+  } catch (e) {
+    // ignore
+  }
+
+  console.error('Please run the project build first (e.g. npm run build) so the CLI can load the compiled library.');
+  process.exit(1);
+}
+
+const Decoder = loadDecoder();
+const decoder = new Decoder();
+
+let input = '';
+process.stdin.setEncoding('utf8');
+process.stdin.on('data', chunk => input += chunk);
+process.stdin.on('end', () => {
+  // Detect if input contains braille unicode characters (U+2800..U+28FF)
+  const hasBrailleUnicode = Array.from(input).some(ch => {
+    const code = ch.charCodeAt(0);
+    return code >= 0x2800 && code <= 0x28ff;
+  });
+
+  let output;
+  if (hasBrailleUnicode) {
+    output = decoder.translateToText(input);
+  } else {
+    // Treat as ASCII braille and convert first
+    const uni = decoder.asciiBrailleToUnicode(input);
+    output = decoder.translateToText(uni);
+  }
+
+  process.stdout.write(output);
+});
+
+// If stdin is a TTY (no pipe), read from argv instead
+if (process.stdin.isTTY) {
+  const arg = process.argv.slice(2).join(' ');
+  if (arg) {
+    input = arg;
+    process.stdin.emit('end');
+  } else {
+    // show simple help
+    console.log('Usage: echo "⠠⠁" | braille-decode');
+  }
+}
+

package/dist/decoder/constants/char_english.d.ts

@@ -0,0 +1 @@
+export declare const ENGLISH_ALPHABET: Record<number, string>;

package/dist/decoder/constants/char_shortcut.d.ts

@@ -0,0 +1 @@
+export declare const KOREAN_SHORTCUTS: Record<string, string>;

package/dist/decoder/constants/choseong.d.ts

@@ -0,0 +1 @@
+export declare const KOREAN_CHOSEONG: Record<number, string>;

package/dist/decoder/constants/index.d.ts

@@ -0,0 +1,10 @@
+export * from './utils';
+export * from './choseong';
+export * from './jungsong';
+export * from './jongseong';
+export * from './char_shortcut';
+export * from './char_english';
+export * from './number';
+export * from './symbol';
+export * from './indicators';
+export declare const ASCII_BRAILLE_MAP: Record<string, number>;

package/dist/decoder/constants/indicators.d.ts

@@ -0,0 +1,6 @@
+export declare const NUMBER_INDICATOR: number;
+export declare const ENGLISH_INDICATOR: number;
+export declare const ENGLISH_TERMINATOR: number;
+export declare const UPPERCASE_INDICATOR: number;
+export declare const KOREAN_PART_INDICATOR: number;
+export declare const KOREAN_CONSONANT_INDICATOR: number;

package/dist/decoder/constants/jongseong.d.ts

@@ -0,0 +1 @@
+export declare const KOREAN_JONGSEONG: Record<number, string>;

package/dist/decoder/constants/jungsong.d.ts

@@ -0,0 +1 @@
+export declare const KOREAN_JUNGSEONG: Record<string, string>;

package/dist/decoder/constants/number.d.ts

@@ -0,0 +1 @@
+export declare const NUMBERS: Record<number, string>;

package/dist/decoder/constants/symbol.d.ts

@@ -0,0 +1 @@
+export declare const SYMBOLS: Record<string, string>;

package/dist/decoder/constants/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const BRAILLE_UNICODE_START = 10240;
+export declare function decodeUnicode(char: string): number;
+export declare function encodeUnicode(dot: number): string;

package/dist/decoder/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Braille Decoder
+ * Supports English, Special Characters, and Korean.
+ * Reference: braillify/libs/braillify/src
+ */
+export declare class Decoder {
+    private jungseongMap;
+    private shortcutMap;
+    private symbolMap;
+    private readonly CHOSEONG;
+    private readonly JUNGSEONG;
+    private readonly JONGSEONG;
+    private choMap;
+    private jungMap;
+    private jongMap;
+    constructor();
+    /**
+     * Initialize lookup tables from constants for efficient decoding
+     */
+    private initializeLookupTables;
+    /**
+     * Converts ASCII Braille (BRL) to Unicode Braille.
+     * Example: asciiBrailleToUnicode('abcd') -> '⠁⠃⠉⠙'
+     */
+    asciiBrailleToUnicode(input: string): string;
+    /**
+     * Translates Unicode Braille to Text.
+     * Supports Korean, English, Numbers, and Symbols.
+     */
+    translateToText(input: string): string;
+    /**
+     * Compose Korean syllable from jamo
+     */
+    private composeKoreanSyllable;
+    /**
+     * Decompose Korean syllable to jamo
+     */
+    private decomposeSyllable;
+    /**
+     * Add jongseong to existing syllable
+     */
+    private addJongseongToSyllable;
+    /**
+     * Translates Unicode Braille to Text (single line).
+     * Supports Korean, English, Numbers, and Symbols.
+     */
+    translateToTextOneLine(input: string): string;
+    private matchJungseong;
+    private matchShortcut;
+    private matchSymbol;
+}

package/dist/decoder/index.test.d.ts

@@ -0,0 +1 @@
+export {};