strc 1.1.0 → 2.0.0-test

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 JustDeveloper <https://justdeveloper.is-a.dev/>
+Copyright (c) 2025-2026 JustDeveloper <https://justdeveloper.is-a.dev/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,53 @@
-## JavaScript String Compressor
-#### An UMD compression algorithm for strings in JavaScript.
-Advanced string compression library supporting multiple languages and character encodings.
-- 🗜️ High compression ratios (up to 8:1 for numbers)
-- 🌍 Multilingual support (English, Russian, Japanese, Hindi, Bengali, and more)
-- 🔧 Zero dependencies
-- 📦 TypeScript support
+# JSSC — JavaScript String Compressor
+**JSSC (JavaScript String Compressor)** is an open-source, lossless **string compression algorithm** designed specifically for JavaScript.
+
+It operates directly on JavaScript strings (UTF-16) and produces compressed data that is also a valid JavaScript string.
+
+JSSC is distributed as a **UMD module** and can be used in browsers, Node.js, Deno, and other JavaScript environments.
+
+## Key Features
+- ✨ **Lossless compression**
+- 🗜️ **High compression ratios**
+  - up to **8:1** for numeric data
+  - strong results for repetitive and structured text
+- 🌍 **Multilingual support**
+  - English, Russian, Japanese, Chinese, Hindi, Bengali, and more
+- 📦 **JSON support**
+  - JSON is converted to [JUSTC](https://just.js.org/justc) before compression
+- ⚙️ **String → String**
+  - no binary buffers
+  - no external metadata
+  - all required information is embedded into the compressed string itself
+- 🧠 **Self-validating compression**
+  - every compression mode is verified by decompression before being accepted
+- 🔁 **Recursive optimization mode**
+  - optional multi-pass compression (mode 31)
+- 📜 TypeScript definitions included
+- 🌐 **UMD build** for browsers and static websites
+
+## Important Version Compatibility Notice
+⚠️ **Compressed strings produced by JSSC v1.x.x are NOT compatible with v2.x.x**
+
+Reasons:
+- The first 16 bits (header layout) were slightly redesigned
+- New compression modes were added
+- Character encoding tables were extended
+
+## Character Encoding
+JSSC operates on **JavaScript UTF-16 code units**, not on UTF-8 bytes.
+
+This means:
+- Any character representable in a JavaScript string is supported
+- Compression works at the UTF-16 level
+- One JavaScript character = **16 bits**
+- Binary data must be converted to strings before compression
+
+## Project Name vs npm Package Name
+The project is called **JSSC** (JavaScript String Compressor).
+
+The npm package is published under the name **`strc`**, because the name `jssc` is already occupied on npm by an unrelated Java-based package.
+
+Both names refer to the same project.
 
 ## Installation
 Install via npm
@@ -12,9 +55,12 @@ Install via npm
 npm i strc
 ```
 
-Or you can use it on your website by inserting the following HTML `script` tag.
+> The npm package name is `strc`, but the library itself is **JSSC**.
+
+Or you can use it on your website by inserting the following HTML `script` tags.
 ```html
-<script type="text/javascript" src="https://jssc.js.org/script.js"></script>
+<script src="https://unpkg.com/justc"></script>
+<script src="https://unpkg.com/strc"></script>
 ```
 
 ## Usage
@@ -22,33 +68,57 @@ Or you can use it on your website by inserting the following HTML `script` tag.
 ```js
 const { compress, decompress } = require('strc');
 
-const example = compress("Hello, world!");
-decompress(example);
+const example = await compress("Hello, world!");
+await decompress(example);
 ```
 
 #### TypeScript
 ```ts
 import { compress, decompress } from 'strc';
 
-const example = compress("Hello, world!");
-decompress(example);
+const example = await compress("Hello, world!");
+await decompress(example);
+```
+
+#### Deno (server-side)
+```ts
+import JSSC from 'https://jssc.js.org/script.js';
+
+const example = await JSSC.compress("Hello, world!");
+await JSSC.decompress(example);
 ```
 
-#### Browsers/Frontend (static websites)
+#### Browsers / Frontend (UMD)
+When using the UMD build via CDN, the library is exposed globally as `JSSC`.
 ```html
-<script type="text/javascript" src="https://jssc.js.org/script.js"></script>
+<script src="https://unpkg.com/justc"></script>
+<script src="https://unpkg.com/strc"></script>
 ```
 ```js
-const compressed   = JSSC.compress("Hello, world!");
-const decompressed = JSSC.decompress(compressed);
+const compressed   = await JSSC.compress("Hello, world!");
+const decompressed = await JSSC.decompress(compressed);
 ```
 
 ## API
-#### `compress(str: string): string`
-Compresses a string and returns the compressed result.
+#### `compress(input: string | object | number): Promise<string>`
+Compresses the input and returns a compressed JavaScript string.
 
-#### `decompress(str: string): string`
-Decompresses a previously compressed string.
+#### `decompress(input: string, stringify?: boolean): Promise<string | object | number>`
+Decompresses a previously compressed string/object/integer.
+
+## Dependencies
+JSSC depends on:
+- <img align="top" src="https://just.js.org/justc/logo-50.svg" alt="JUSTC Logo" width="26" height="26"> [JUSTC](https://just.js.org/justc) by [JustStudio.](https://juststudio.is-a.dev/)
 
 ## License
-[MIT © 2025 JustDeveloper](https://github.com/JustDeveloper1/JSSC/blob/main/LICENSE)
+[MIT © 2025-2026 JustDeveloper](https://github.com/JustDeveloper1/JSSC/blob/main/LICENSE)
+
+---
+## Minified Build
+For `.min.js`, I use [UglifyJS](https://github.com/mishoo/UglifyJS) by [Mihai Bazon](https://github.com/mishoo).
+```bash
+npm i uglify-js
+```
+```bash
+uglifyjs index.js -c -m "reserved=['compress','decompress']" -o index.min.js
+```

package/index.d.ts

@@ -2,7 +2,7 @@
 
 MIT License
 
-Copyright (c) 2025 JustDeveloper <https://justdeveloper.is-a.dev/>
+Copyright (c) 2025-2026 JustDeveloper <https://justdeveloper.is-a.dev/>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -35,30 +35,81 @@ SOFTWARE.
 
 */
 
+/**
+ * JavaScript String Compressor - compress options
+ * @license MIT
+ * @copyright (c) 2025-2026 JustDeveloper <<https://justdeveloper.is-a.dev>>
+ * @since 2.0.0
+ */
+export interface compressOptions {
+    JUSTC?: boolean,
+    recursiveCompression?: boolean,
+    segmentation?: boolean
+}
+
 /**
  * JavaScript String Compressor - compress function
  * @param str - Input string to compress
  * @returns Compressed string
  * @example
- * compress('Hello, World!');
+ * await compress('Hello, World!');
  * @since 1.0.0
  */
-export function compress(str: string): string;
+export function compress(str: string, options?: compressOptions): Promise<string>;
+/**
+ * JavaScript String Compressor - compress function
+ * @param obj - Input object to compress
+ * > **Note: it will `JSON.stringify()` your object so it may lose some data if your object has getters/setters/non-enumerables/etc.!**
+ * @returns Compressed string
+ * @example
+ * await compress({a: "b"});
+ * @since 2.0.0
+ */
+export function compress(obj: object, options?: compressOptions): Promise<string>;
+/**
+ * JavaScript String Compressor - compress function
+ * @param int - Input integer to compress
+ * @returns Compressed string
+ * @example
+ * await compress(10);
+ * @since 2.0.0
+ */
+export function compress(int: number, options?: compressOptions): Promise<string>;
 
 /**
  * JavaScript String Compressor - decompress function
  * @param str - Compressed string to decompress
  * @returns Decompressed string
  * @example
- * decompress(compressedString);
+ * await decompress(compressedString);
  * @since 1.0.0
  */
-export function decompress(str: string): string;
+export function decompress(str: string): Promise<string>;
+/**
+ * JavaScript String Compressor - decompress function
+ * @param str - Compressed object to decompress
+ * @param stringify - Always return string? (`JSON.stringify()` object outputs)
+ * @returns Decompressed string
+ * @example
+ * await decompress(compressedString);
+ * @since 2.0.0
+ */
+export function decompress(str: string, stringify?: boolean): Promise<object|string>;
+/**
+ * JavaScript String Compressor - decompress function
+ * @param str - Compressed object to decompress
+ * @param stringify - Always return string? (`.toString()` integer outputs)
+ * @returns Decompressed string
+ * @example
+ * await decompress(compressedString);
+ * @since 2.0.0
+ */
+export function decompress(str: string, stringify?: boolean): Promise<number|string>;
 
 /**
  * JavaScript String Compressor
  * @license MIT
- * @copyright (c) 2025 JustDeveloper <<https://justdeveloper.is-a.dev>>
+ * @copyright (c) 2025-2026 JustDeveloper <<https://justdeveloper.is-a.dev>>
  * @since 1.0.0
  */
 declare const JSSC: {