unicode-escaper 1.0.0

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,410 @@
+# unicode-escaper
+
+A robust, zero-dependency Unicode escape/unescape library for JavaScript and TypeScript. Supports multiple escape formats, bidirectional conversion, and streaming for large files.
+
+[![npm version](https://img.shields.io/npm/v/unicode-escaper.svg)](https://www.npmjs.com/package/unicode-escaper)
+[![License](https://img.shields.io/npm/l/unicode-escaper.svg)](https://github.com/Jeong-Min-Cho/unicode-escaper/blob/main/LICENSE)
+
+## Features
+
+- **Multiple escape formats**: `\uXXXX`, `\u{XXXXX}`, `\xNN`, `&#xNNNN;`, `&#NNNN;`, `U+XXXX`
+- **Bidirectional**: Both escape and unescape in one package
+- **Streaming support**: Process large files efficiently with Node.js and Web Streams
+- **Full Unicode support**: Handles BMP, supplementary planes, surrogate pairs, and emoji
+- **Zero dependencies**: Lightweight and fast
+- **TypeScript-first**: Written in TypeScript with strict types
+- **Dual ESM/CJS**: Works with both module systems
+- **Customizable filters**: Control exactly which characters to escape
+
+## Installation
+
+```bash
+npm install unicode-escaper
+# or
+pnpm add unicode-escaper
+# or
+yarn add unicode-escaper
+```
+
+## Quick Start
+
+```typescript
+import { escape, unescape } from "unicode-escaper";
+
+// Escape non-ASCII characters
+escape("Hello 世界");
+// => 'Hello \u4E16\u754C'
+
+// Unescape back to original
+unescape("Hello \\u4E16\\u754C");
+// => 'Hello 世界'
+```
+
+## Escape Formats
+
+| Format         | Example    | Description                                  |
+| -------------- | ---------- | -------------------------------------------- |
+| `unicode`      | `\u4E16`   | Standard JavaScript Unicode escape (default) |
+| `unicode-es6`  | `\u{4E16}` | ES6 Unicode escape (supports full range)     |
+| `hex`          | `\xE9`     | Hex escape (0x00-0xFF only)                  |
+| `html-hex`     | `世` | HTML hexadecimal entity                      |
+| `html-decimal` | `世` | HTML decimal entity                          |
+| `codepoint`    | `U+4E16`   | Unicode code point notation                  |
+
+## API Reference
+
+### Core Functions
+
+#### `escape(input, options?)`
+
+Escapes Unicode characters in a string.
+
+```typescript
+import { escape } from "unicode-escaper";
+
+// Default: preserve ASCII, escape everything else
+escape("Café 世界 😀");
+// => 'Caf\u00E9 \u4E16\u754C \uD83D\uDE00'
+
+// Use ES6 format for emoji (cleaner output)
+escape("Hello 😀", { format: "unicode-es6" });
+// => 'Hello \u{1F600}'
+
+// HTML entities
+escape("Café", { format: "html-hex" });
+// => 'Café'
+
+escape("Café", { format: "html-decimal" });
+// => 'Café'
+
+// Escape everything (including ASCII)
+escape("Hi", { preserveAscii: false });
+// => '\u0048\u0069'
+
+// Preserve Latin-1 characters
+escape("Café 世界", { preserveLatin1: true });
+// => 'Café \u4E16\u754C'
+
+// Lowercase hex digits
+escape("世", { uppercase: false });
+// => '\u4e16'
+```
+
+#### `unescape(input, options?)`
+
+Unescapes Unicode sequences back to characters.
+
+```typescript
+import { unescape } from "unicode-escaper";
+
+// Automatically detects and unescapes all formats
+unescape("\\u4E16"); // => '世'
+unescape("\\u{1F600}"); // => '😀'
+unescape("\\xE9"); // => 'é'
+unescape("世"); // => '世'
+unescape("世"); // => '世'
+unescape("U+4E16"); // => '世'
+
+// Handle surrogate pairs
+unescape("\\uD83D\\uDE00"); // => '😀'
+
+// Only unescape specific formats
+unescape("\\u4E16 世", { formats: ["unicode"] });
+// => '世 世'
+
+// Strict mode (throws on invalid sequences)
+unescape("\\uZZZZ", { lenient: false });
+// => throws Error
+```
+
+### Convenience Functions
+
+```typescript
+import {
+  escapeToUnicode, // \uXXXX format
+  escapeToUnicodeES6, // \u{XXXXX} format
+  escapeToHex, // \xNN format
+  escapeToHtmlHex, // &#xNNNN; format
+  escapeToHtmlDecimal, // &#NNNN; format
+  escapeToCodePoint, // U+XXXX format
+  escapeAll, // Escape all characters
+  escapeNonPrintable, // Escape control chars and non-ASCII
+} from "unicode-escaper";
+
+escapeToUnicodeES6("😀"); // => '\u{1F600}'
+escapeToHtmlHex("世"); // => '世'
+escapeAll("Hi"); // => '\u0048\u0069'
+```
+
+```typescript
+import {
+  unescapeUnicode, // Only \uXXXX
+  unescapeUnicodeES6, // Only \u{XXXXX}
+  unescapeHex, // Only \xNN
+  unescapeHtmlHex, // Only &#xNNNN;
+  unescapeHtmlDecimal, // Only &#NNNN;
+  unescapeCodePoint, // Only U+XXXX
+  unescapeHtml, // Both HTML formats
+  unescapeJs, // All JavaScript formats
+} from "unicode-escaper";
+```
+
+### Custom Filters
+
+Control which characters to escape using filter functions:
+
+```typescript
+import { escape, isNotAscii, isNotBmp, and, or, oneOf } from "unicode-escaper";
+
+// Escape only non-ASCII (default behavior)
+escape("Hello 世界", { filter: isNotAscii });
+
+// Escape only emoji (non-BMP characters)
+escape("Hello 世界 😀", { filter: isNotBmp });
+// => 'Hello 世界 \uD83D\uDE00'
+
+// Escape vowels
+escape("Hello", { filter: oneOf("aeiouAEIOU") });
+// => 'H\u0065ll\u006F'
+
+// Combine filters
+escape("Test", { filter: and(isNotAscii, isNotBmp) });
+```
+
+Available filters:
+
+- `isAscii` / `isNotAscii` - ASCII range (0x00-0x7F)
+- `isLatin1` / `isNotLatin1` - Latin-1 range (0x00-0xFF)
+- `isBmp` / `isNotBmp` - Basic Multilingual Plane (0x0000-0xFFFF)
+- `isPrintableAscii` / `isNotPrintableAscii` - Printable ASCII (0x20-0x7E)
+- `isControl` - Control characters
+- `isWhitespace` - Whitespace characters
+- `isSurrogate` / `isHighSurrogate` / `isLowSurrogate` - Surrogate code points
+- `inRange(start, end)` / `notInRange(start, end)` - Custom range
+- `oneOf(chars)` / `noneOf(chars)` - Character set
+- `and(...filters)` / `or(...filters)` / `not(filter)` - Combinators
+- `all` / `none` - Always true/false
+
+### Utility Functions
+
+```typescript
+import {
+  getCodePoint, // Get code point of a character
+  fromCodePoint, // Create character from code point
+  getCharInfo, // Get detailed character information
+  toCodePoints, // Convert string to code point array
+  fromCodePoints, // Convert code point array to string
+  codePointLength, // Get length in code points (not UTF-16)
+  toHex, // Convert code point to hex string
+  parseHex, // Parse hex string to code point
+  isValidUnicode, // Check for unpaired surrogates
+  normalizeNFC, // Normalize to NFC
+  normalizeNFD, // Normalize to NFD
+  unicodeEquals, // Compare Unicode equivalence
+} from "unicode-escaper";
+
+// Get code point
+getCodePoint("😀"); // => 128512 (0x1F600)
+
+// Character info
+getCharInfo("😀");
+// => {
+//   char: '😀',
+//   codePoint: 128512,
+//   hex: '1F600',
+//   isAscii: false,
+//   isBmp: false,
+//   isLatin1: false,
+//   isHighSurrogate: false,
+//   isLowSurrogate: false,
+//   utf16Length: 2
+// }
+
+// Code point length (differs from string.length for emoji)
+"😀".length; // => 2 (UTF-16 code units)
+codePointLength("😀"); // => 1 (actual characters)
+
+// Parse various formats
+parseHex("U+1F600"); // => 128512
+parseHex("0x4E16"); // => 19990
+parseHex("\\u{4E16}"); // => 19990
+```
+
+### Streaming Support
+
+Process large files efficiently without loading everything into memory:
+
+#### Node.js Streams
+
+```typescript
+import { createReadStream, createWriteStream } from "fs";
+import { pipeline } from "stream/promises";
+import { EscapeStream, UnescapeStream } from "unicode-escaper";
+
+// Escape a file
+await pipeline(
+  createReadStream("input.txt", "utf8"),
+  new EscapeStream({ escapeOptions: { format: "unicode-es6" } }),
+  createWriteStream("escaped.txt")
+);
+
+// Unescape a file
+await pipeline(
+  createReadStream("escaped.txt", "utf8"),
+  new UnescapeStream(),
+  createWriteStream("output.txt")
+);
+```
+
+#### Web Streams API
+
+```typescript
+import {
+  createWebEscapeStream,
+  createWebUnescapeStream,
+} from "unicode-escaper";
+
+// Works in browsers and modern Node.js
+const response = await fetch("data.txt");
+const escaped = response.body
+  .pipeThrough(new TextDecoderStream())
+  .pipeThrough(createWebEscapeStream({ format: "html-hex" }))
+  .pipeThrough(new TextEncoderStream());
+```
+
+### Detection Utilities
+
+```typescript
+import { hasEscapeSequences, countEscapeSequences } from "unicode-escaper";
+
+hasEscapeSequences("\\u4E16"); // => true
+hasEscapeSequences("Hello"); // => false
+
+countEscapeSequences("\\u4E16\\u754C"); // => 2
+
+// Filter by format
+hasEscapeSequences("\\u4E16", ["unicode"]); // => true
+hasEscapeSequences("\\u4E16", ["html-hex"]); // => false
+```
+
+## TypeScript Support
+
+Full TypeScript support with strict types:
+
+```typescript
+import type {
+  EscapeFormat,
+  EscapeOptions,
+  UnescapeOptions,
+  FilterFunction,
+  CharacterInfo,
+  EscapeResult,
+} from "unicode-escaper";
+
+// Type-safe options
+const options: EscapeOptions = {
+  format: "unicode-es6",
+  preserveAscii: true,
+  uppercase: true,
+};
+
+// Custom filter with proper typing
+const myFilter: FilterFunction = (char, codePoint) => {
+  return codePoint > 0x7f;
+};
+```
+
+## Comparison with escape-unicode
+
+| Feature         | escape-unicode   | unicode-escaper |
+| --------------- | ---------------- | --------------- |
+| Escape formats  | `\uXXXX` only    | 6 formats       |
+| Unescape        | Separate package | Built-in        |
+| Streaming       | No               | Yes             |
+| Web Streams     | No               | Yes             |
+| ESM + CJS       | CJS only         | Both            |
+| Browser support | Node only        | Both            |
+| TypeScript      | Yes              | Yes (strict)    |
+| Zero deps       | Yes              | Yes             |
+
+## International Language Support
+
+Fully tested with diverse Unicode scripts:
+
+| Language   | Script                  | Example        | Escaped                                |
+| ---------- | ----------------------- | -------------- | -------------------------------------- |
+| Korean     | Hangul                  | 안녕하세요     | `\uC548\uB155\uD558\uC138\uC694`       |
+| Japanese   | Hiragana/Katakana/Kanji | こんにちは     | `\u3053\u3093\u306B\u3061\u306F`       |
+| Arabic     | Arabic                  | مرحبا          | `\u0645\u0631\u062D\u0628\u0627`       |
+| Thai       | Thai                    | สวัสดี         | `\u0E2A\u0E27\u0E31\u0E2A\u0E14\u0E35` |
+| Russian    | Cyrillic                | Привет         | `\u041F\u0440\u0438\u0432\u0435\u0442` |
+| Hindi      | Devanagari              | नमस्ते         | `\u0928\u092E\u0938\u094D\u0924\u0947` |
+| Chinese    | Han                     | 你好           | `\u4F60\u597D`                         |
+| Vietnamese | Latin Extended         | Xin chào       | `Xin ch\u00E0o`                        |
+| French     | Latin Extended         | Café           | `Caf\u00E9`                            |
+| Turkish    | Latin Extended         | Türkçe         | `T\u00FCrk\u00E7e`                     |
+| Spanish    | Latin Extended         | ¡Hola!         | `\u00A1Hola!`                          |
+| Portuguese | Latin Extended         | São Paulo      | `S\u00E3o Paulo`                       |
+
+```typescript
+import { escape, unescape } from "unicode-escaper";
+
+// Korean
+escape("안녕하세요"); // => '\uC548\uB155\uD558\uC138\uC694'
+
+// Japanese (mixed scripts)
+escape("東京 とうきょう トウキョウ");
+
+// Arabic (RTL)
+escape("مرحبا"); // => '\u0645\u0631\u062D\u0628\u0627'
+
+// Thai (with tone marks)
+escape("สวัสดี");
+
+// Russian
+escape("Привет"); // => '\u041F\u0440\u0438\u0432\u0435\u0442'
+
+// Hindi (with combining marks)
+escape("नमस्ते"); // => '\u0928\u092E\u0938\u094D\u0924\u0947'
+
+// Chinese
+escape("你好世界"); // => '\u4F60\u597D\u4E16\u754C'
+
+// Vietnamese (with diacritics)
+escape("Xin chào"); // => 'Xin ch\u00E0o'
+
+// Turkish (special i variants)
+escape("İstanbul"); // => '\u0130stanbul'
+
+// Spanish (inverted punctuation)
+escape("¡Hola!"); // => '\u00A1Hola!'
+
+// Portuguese (tildes and cedilla)
+escape("São Paulo"); // => 'S\u00E3o Paulo'
+
+// Mixed multi-language content
+const mixed = "Hello 안녕 こんにちは 你好 مرحبا สวัสดี Привет नमस्ते";
+unescape(escape(mixed)) === mixed; // => true
+```
+
+### Supported Features
+
+- **Combining characters**: Thai tone marks, Arabic diacritics, Hindi matras/virama, Vietnamese diacritics
+- **Bidirectional text**: RTL markers, mixed LTR/RTL content
+- **Native numerals**: Thai ๒๐๒๔, Arabic ٢٠٢٤, Devanagari २०२४
+- **Conjunct consonants**: Hindi samyuktakshar (क्ष, त्र, ज्ञ)
+- **Supplementary planes**: Emoji, ancient scripts, mathematical symbols
+- **Normalization**: Handles NFC/NFD forms correctly
+- **Extended Latin**: French accents, Turkish special i (ı İ), Spanish ñ, Portuguese ã/õ
+
+## Browser Support
+
+Works in all modern browsers that support ES2022. For older browsers, you may need polyfills for:
+
+- `String.prototype.codePointAt`
+- `String.fromCodePoint`
+- Web Streams API (if using streaming)
+
+## License
+
+Apache-2.0