@leismore/lmos-nodejs-unicode-print-chars 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Leismore™
+
+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/README.md

@@ -1,3 +1,144 @@
-# Temporary Holding Version
+# lmos-nodejs-unicode-print-chars
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A class represents a string of printable characters in Unicode.
+
+A robust Node.js utility to validate, sanitize, and ensure strings contain only **safe, printable Unicode characters**.
+
+## Motivation
+
+In text processing, certain characters are invisible but active. Legacy control characters like `BEL` (ASCII 07) can trigger machine bells, while `DEL` (ASCII 7F) can alter text streams.
+
+If an online form accepts user input and blindly processes it without validation, malicious or malformed inputs containing hidden control characters can disrupt your application, break JSON parsing, corrupt logs, or exploit text-rendering engines.
+
+While modern frameworks offer basic protections, the safest practice is defense-in-depth: stopping unwanted characters at the very beginning of their journey.
+
+This package provides a strict boundary for user data, ensuring that your strings consist entirely of valid, safe, and visible printable characters across the Unicode spectrum.
+
+## Installation
+
+`npm install @leismore/lmos-nodejs-unicode-print-chars`
+
+## Test
+
+`npm test`
+
+## Build
+
+`npm run build`
+
+## Examples
+
+```typescript
+
+import { PrintableCharsUni, PCUError } from '@leismore/lmos-nodejs-unicode-print-chars';
+
+const STRING_VALID_EN = 'I know that I know nothing. 🏛️';
+const STRING_VALID_ZH = '我唯一知道的就是我一无所知。';
+const STRING_VALID_JP = '私は自分が何も知らないということだけを知っている。';
+
+// Throws PCUError, if illegal characters
+const pcuEN = new PrintableCharsUni(STRING_VALID_EN);
+const pcuZH = new PrintableCharsUni(STRING_VALID_ZH);
+const pcuJP = new PrintableCharsUni(STRING_VALID_JP);
+
+/**
+ * Output:
+ * - I know that I know nothing. 🏛️
+ * - 我唯一知道的就是我一无所知。
+ * - 私は自分が何も知らないということだけを知っている。
+ */
+
+console.log(String(pcuEN));
+console.log(String(pcuZH));
+console.log(String(pcuJP));
+
+```
+
+## API Reference
+
+### Exports
+
+```typescript
+export { PCUError, PrintableCharsUni };
+export type { PCUErrorErr };
+```
+
+### PCUError
+
+**PCUError Class Properties**
+
+* `error`      : `PCUErrorErr`
+* `previous`?  : `Error`
+* `timestamp`  : `Date`
+
+`PCUError` is the Error class for this package. All errors thrown by this library are instances of this class, allowing you to easily catch and handle them in your application.
+
+`PCUError` extends the `LMError` class from [@leismore/lmos-nodejs-lmerror](https://www.npmjs.com/package/@leismore/lmos-nodejs-lmerror). For more details, please refer to the documentation of `@leismore/lmos-nodejs-lmerror`.
+
+### PCUErrorErr
+
+```typescript
+type PCUErrorErr = {
+  readonly message: string, // Message for human. Only ASCII printable characters allowed.
+  readonly code:    string  // Code for machine. Only letter, number, and underscore allowed.
+};
+```
+
+### PrintableCharsUni
+
+```typescript
+class PrintableCharsUni {
+
+    /**
+     * @throws {PCUError}
+     * 2    invalid_string
+     */
+    constructor(chars: string)
+
+    public toString(): string
+
+    public static isValid(chars: string): boolean
+
+    /**
+     * @throws {PCUError}
+     * 3    not_string
+     */
+    public static removeInvalidChars(chars: string): string
+
+}
+```
+
+`PrintableCharsUni` class represents a string of printable characters in Unicode.
+
+## License
+
+© [Leismore™](https://www.leismore.co) 2026
+
+[MIT License](https://github.com/leismore/lmos-nodejs-unicode-print-chars/blob/main/LICENSE)
+
+## Donation
+
+* [Leismore™](https://github.com/sponsors/leismore) on GitHub
+
+Help us to pay our bills, so we can focus on developing and maintaining this project.
+
+## Authors
+
+* [Kyle Chinn / Kai Qin / 秦凯](https://kyle.chinn.leismore.org) since 28 September 2026
+
+## Credits
+
+* [@leismore/lmos-nodejs-lmerror](https://www.npmjs.com/package/@leismore/lmos-nodejs-lmerror)
+
+## References
+
+* Unicode 18.0.0 <https://www.unicode.org/versions/Unicode18.0.0>
+
+
+
+
+------------------------------------------------------------------------------
+
+Product of [Leismore™ OpenSource](https://lmos.leismore.org) Project
+
+Supported by [Leismore™](https://www.leismore.co) (Australian Business Number: 25 935 862 619)

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+import { PCUError } from './lib/PCUError.js';
+import type { PCUErrorErr } from './lib/PCUError.js';
+import { PrintableCharsUni } from './lib/PrintableCharsUni.js';
+export { PCUError, PrintableCharsUni };
+export type { PCUErrorErr };

package/dist/src/index.js

@@ -0,0 +1,3 @@
+import { PCUError } from './lib/PCUError.js';
+import { PrintableCharsUni } from './lib/PrintableCharsUni.js';
+export { PCUError, PrintableCharsUni };

package/dist/src/lib/PCUError.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The Error class for this project.
+ *
+ * Code     Message
+ * 1        unknown
+ * 2        invalid_string
+ * 3        not_string
+ */
+import { LMError } from '@leismore/lmos-nodejs-lmerror';
+import type { LMErrorErr as PCUErrorErr } from '@leismore/lmos-nodejs-lmerror';
+declare class PCUError extends LMError {
+    /**
+     * @throws {Error}
+     *   invalid_error
+     *   invalid_error_message
+     *   invalid_error_code
+     *   invalid_previous
+     */
+    constructor(error: PCUErrorErr, previous?: Error);
+}
+export { PCUError };
+export type { PCUErrorErr };

package/dist/src/lib/PCUError.js

@@ -0,0 +1,23 @@
+/**
+ * The Error class for this project.
+ *
+ * Code     Message
+ * 1        unknown
+ * 2        invalid_string
+ * 3        not_string
+ */
+import { LMError } from '@leismore/lmos-nodejs-lmerror';
+class PCUError extends LMError {
+    /**
+     * @throws {Error}
+     *   invalid_error
+     *   invalid_error_message
+     *   invalid_error_code
+     *   invalid_previous
+     */
+    constructor(error, previous) {
+        super(error, undefined, previous);
+        this.name = 'PCUError';
+    }
+}
+export { PCUError };

package/dist/src/lib/PrintableCharsUni.d.ts

@@ -0,0 +1,21 @@
+/**
+ * PrintableCharsUni class represents a string of printable characters in Unicode.
+ */
+declare class PrintableCharsUni {
+    protected readonly chars: string;
+    /**
+     *
+     * @throws {PCUError}
+     * 2    invalid_string
+     */
+    constructor(chars: string);
+    toString(): string;
+    static isValid(chars: string): boolean;
+    /**
+     *
+     * @throws {PCUError}
+     * 3    not_string
+     */
+    static removeInvalidChars(chars: string): string;
+}
+export { PrintableCharsUni };

package/dist/src/lib/PrintableCharsUni.js

@@ -0,0 +1,39 @@
+/**
+ * PrintableCharsUni class represents a string of printable characters in Unicode.
+ */
+import { PCUError } from './PCUError.js';
+const regexValidString = /^[^\p{C}\p{Zl}\p{Zp}]+$/u;
+const regexInvalidChars = /[\p{C}\p{Zl}\p{Zp}]/ug;
+class PrintableCharsUni {
+    chars;
+    /**
+     *
+     * @throws {PCUError}
+     * 2    invalid_string
+     */
+    constructor(chars) {
+        if (!PrintableCharsUni.isValid(chars)) {
+            throw new PCUError({ code: '2', message: 'invalid_string' });
+        }
+        this.chars = chars;
+    }
+    toString() {
+        return this.chars;
+    }
+    /*  Static Methods */
+    static isValid(chars) {
+        return (typeof chars === 'string' && regexValidString.test(chars));
+    }
+    /**
+     *
+     * @throws {PCUError}
+     * 3    not_string
+     */
+    static removeInvalidChars(chars) {
+        if (typeof chars !== 'string') {
+            throw new PCUError({ code: '3', message: 'not_string' });
+        }
+        return chars.replace(regexInvalidChars, '');
+    }
+}
+export { PrintableCharsUni };

package/package.json

@@ -1,6 +1,56 @@
 {
   "name": "@leismore/lmos-nodejs-unicode-print-chars",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "A class represents a string of printable characters in Unicode.",
+  "keywords": [
+    "Unicode",
+    "Printable Characters",
+    "LMOS for Node.js",
+    "LMOS",
+    "Leismore OpenSource",
+    "Leismore",
+    "Node.js",
+    "NodeJS",
+    "Node"
+  ],
+  "homepage": "https://github.com/leismore/lmos-nodejs-unicode-print-chars#readme",
+  "bugs": {
+    "url": "https://github.com/leismore/lmos-nodejs-unicode-print-chars/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leismore/lmos-nodejs-unicode-print-chars.git"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/leismore"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Kyle Chinn",
+    "url": "https://kyle.chinn.leismore.org",
+    "email": "kyle.chinn@leismore.co"
+  },
+  "type": "module",
+  "types": "dist/src/index.d.ts",
+  "main": "dist/src/index.js",
+  "scripts": {
+    "test": "tsx test/test.ts",
+    "build": "tsc",
+    "start": "cd dist/src && node index.js",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build && npm run test"
+  },
+  "devDependencies": {
+    "@leismore/lmos-nodejs-primitives": "^1.2.4",
+    "@types/node": "^24.19.0",
+    "tsx": "^4.23.15",
+    "typescript": "^7.0.2"
+  },
+  "allowScripts": {
+    "esbuild@0.28.2": true
+  },
+  "dependencies": {
+    "@leismore/lmos-nodejs-lmerror": "^3.0.4"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions":
+  {
+    "lib":                          ["ES2024"],
+    "target":                        "ES2024",
+    "module":                        "nodenext",
+    "moduleResolution":              "nodenext",
+    "strict":                        true,
+    "resolveJsonModule":             true,
+    "declaration":                   true,
+    "allowJs":                       false,
+    "rootDir":                       ".",
+    "outDir":                        "dist",
+    "types":                        ["node"]
+  },
+  "include":            ["src/**/*", "test/**/*"]
+}