lzma1 0.1.0 → 0.1.2

package/LICENSE

@@ -1,201 +1,21 @@
-                                 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 2025 Filip Seman
-
-   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.
+MIT License
+
+Copyright (c) 2023 Filip Seman <filip.seman@pm.me>
+
+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

@@ -42,30 +42,50 @@ npm install lzma1
 
 ```html
 <script type="module">
-	import { compress, decompress } from "https://esm.sh/lzma1@latest";
+	import {
+		compress,
+		decompress,
+		compressString,
+		decompressString
+	} from "https://esm.sh/lzma1@latest";
 </script>
 ```
 
 ## Quick start
 
-The library provides two main functions: `compress` and `decompress`:
+The library provides four main functions for compression and decompression:
 
 ```ts
-compress(data: string | Uint8Array, mode?: Mode): Int8Array
-decompress(data: Uint8Array | ArrayBuffer): string | Int8Array
+// For binary data
+compress(data: Uint8Array | ArrayBuffer, mode?: 1-9): Uint8Array
+decompress(data: Uint8Array | ArrayBuffer): Uint8Array
+
+// For string data
+compressString(data: string, mode?: 1-9): Uint8Array
+decompressString(data: Uint8Array | ArrayBuffer): string
+```
+
+You can also import the `LZMA` class directly for more advanced usage:
+
+```ts
+import { LZMA } from "lzma1";
+
+const lzma = new LZMA();
+const compressed = lzma.compressString("Hello World!", 5);
+const decompressed = lzma.decompressString(compressed);
 ```
 
 ### Compressing a string
 
 ```js
 import {
-	compress,
-	decompress,
+	compressString,
+	decompressString,
 } from "lzma1";
 
 const data = "Hello World!";
-const compressed = compress(data, 1); // Using compression level 1 (fastest)
-const decompressed = decompress(compressed);
+const compressed = compressString(data, 1); // Using compression level 1 (fastest)
+const decompressed = decompressString(compressed);
 
 // data === decompressed
 ```
@@ -84,7 +104,7 @@ const compressed = compress(binaryData, 5); // Default compression level
 
 // Decompress back to binary
 const decompressed = decompress(compressed);
-// decompressed will be an Int8Array
+// decompressed will be a Uint8Array
 ```
 
 ### HTML example
@@ -94,46 +114,29 @@ A simple browser example:
 ```html
 <!DOCTYPE html>
 <html>
-<body>
-    <textarea id="input">Hello World!</textarea><br>
-    <button id="run">Compress & Decompress</button>>
-    <div id="result"></div>
-
-    <script type="module">
-        import { compress, decompress } from "https://esm.sh/lzma1@latest";
-
-        document.getElementById("run").onclick = () => {
-            const text = document.getElementById("input").value;
-            const compressed = compress(text);
-            const decompressed = decompress(compressed);
-
-            document.getElementById("result").innerHTML =
-                `Original: ${text.length} bytes<br>` +
-                `Compressed: ${compressed.length} bytes<br>` +
-                `Result: ${decompressed}`;
-        };
-    </script>
-</body>
+	<body>
+		<textarea id="input">Hello World!</textarea><br />
+		<button id="run">Compress & Decompress</button>
+		<div id="result"></div>
+
+		<script type="module">
+			import { compressString, decompressString } from "https://esm.sh/lzma1@latest";
+
+			document.getElementById("run").onclick = () => {
+				const text = document.getElementById("input").value;
+				const compressed = compressString(text);
+				const decompressed = decompressString(compressed);
+
+				document.getElementById("result").innerHTML =
+					`Original: ${text.length} bytes<br>` +
+					`Compressed: ${compressed.length} bytes<br>` +
+					`Result: ${decompressed}`;
+			};
+		</script>
+	</body>
 </html>
 ```
 
-### Advanced usage
-
-You can control the compression level (1-9) to balance between speed and compression ratio:
-
-```js
-import { compress } from "lzma1";
-
-// Fastest compression (level 1)
-const fastCompressed = compress(data, 1);
-
-// Balanced compression (level 5)
-const balancedCompressed = compress(data, 5);
-
-// Maximum compression (level 9)
-const maxCompressed = compress(data, 9);
-```
-
 ## How it works
 
 LZMA (Lempel-Ziv-Markov chain Algorithm) is a compression algorithm that uses a
@@ -142,7 +145,8 @@ commonly used in the 7z archive format.
 
 ### LZMA header
 
-The LZMA compressed data begins with a header that contains information needed for decompression:
+The LZMA compressed data begins with a header that contains information needed
+for decompression:
 
 ![lzma](./docs/lzma.svg)
 

package/lib/index.d.ts

@@ -1,6 +1,37 @@
 /**
  * @license
  * Copyright Filip Seman
- * SPDX-License-Identifier: Apache-2.0
+ * SPDX-License-Identifier: MIT
  */
-export { compress, compressString, decompress, decompressString, LZMA } from "./lzma.js";
+import { LZMA } from "./lzma.js";
+export { LZMA } from "./lzma.js";
+/**
+ * Compresses data using LZMA algorithm
+ *
+ * @param data Data to compress - can be Uint8Array or ArrayBuffer
+ * @param mode Compression mode (1-9), defaults to 5
+ * @returns Compressed data as a byte array
+ */
+export declare function compress(data: Uint8Array | ArrayBuffer, mode?: keyof LZMA["CompressionModes"]): Uint8Array;
+/**
+ * Compresses data using LZMA algorithm
+ *
+ * @param data String to compress
+ * @param mode Compression mode (1-9), defaults to 5
+ * @returns Compressed data as byte array
+ */
+export declare function compressString(data: string, mode?: keyof LZMA["CompressionModes"]): Uint8Array;
+/**
+ * Decompresses LZMA compressed data
+ *
+ * @param data Compressed data as Uint8Array or ArrayBuffer
+ * @returns Decompressed data
+ */
+export declare function decompress(data: Uint8Array | ArrayBuffer): Uint8Array;
+/**
+ * Decompresses LZMA compressed data
+ *
+ * @param data Compressed data as Uint8Array or ArrayBuffer
+ * @returns Decompressed data as string
+ */
+export declare function decompressString(data: Uint8Array | ArrayBuffer): string;

package/lib/index.js

@@ -1,6 +1,49 @@
 /**
  * @license
  * Copyright Filip Seman
- * SPDX-License-Identifier: Apache-2.0
+ * SPDX-License-Identifier: MIT
  */
-export { compress, compressString, decompress, decompressString, LZMA } from "./lzma.js";
+import { LZMA } from "./lzma.js";
+export { LZMA } from "./lzma.js";
+/**
+ * Compresses data using LZMA algorithm
+ *
+ * @param data Data to compress - can be Uint8Array or ArrayBuffer
+ * @param mode Compression mode (1-9), defaults to 5
+ * @returns Compressed data as a byte array
+ */
+export function compress(data, mode = 5) {
+    const lzma = new LZMA();
+    return new Uint8Array(lzma.compress(data, mode));
+}
+/**
+ * Compresses data using LZMA algorithm
+ *
+ * @param data String to compress
+ * @param mode Compression mode (1-9), defaults to 5
+ * @returns Compressed data as byte array
+ */
+export function compressString(data, mode = 5) {
+    const lzma = new LZMA();
+    return new Uint8Array(lzma.compressString(data, mode));
+}
+/**
+ * Decompresses LZMA compressed data
+ *
+ * @param data Compressed data as Uint8Array or ArrayBuffer
+ * @returns Decompressed data
+ */
+export function decompress(data) {
+    const lzma = new LZMA();
+    return new Uint8Array(lzma.decompress(data));
+}
+/**
+ * Decompresses LZMA compressed data
+ *
+ * @param data Compressed data as Uint8Array or ArrayBuffer
+ * @returns Decompressed data as string
+ */
+export function decompressString(data) {
+    const lzma = new LZMA();
+    return lzma.decompressString(data);
+}

package/lib/lzma.d.ts

@@ -1,19 +1,3 @@
-/**
- * Converts a number to a signed 8-bit integer using DataView.
- *
- * Previously, this was done with bitwise operations (value << 24 >> 24), but
- * that approach was obscure and hard to understand. Using DataView improves
- * readability and ensures correct 8-bit conversion.
- */
-export declare function toSigned8bit(value: number): number;
-/**
- * Converts a number to a signed 16-bit integer using DataView.
- *
- * Previously, this was done with bitwise operations (value << 16 >> 16), but
- * that approach was obscure and hard to understand. Using DataView improves
- * readability and ensures correct 16-bit conversion.
- */
-export declare function toSigned16bit(value: number): number;
 export declare class LZMA {
     #private;
     readonly CompressionModes: {
@@ -75,38 +59,8 @@ export declare class LZMA {
     InitBitModels(probs: number[]): void;
     GetPrice(Prob: number, symbol: number): number;
     encodeString(inputString: string): number[];
-    compress(data: Uint8Array | ArrayBuffer, mode?: keyof typeof this.CompressionModes): number[];
-    compressString(data: string, mode?: keyof typeof this.CompressionModes): number[];
+    compress(data: Uint8Array | ArrayBuffer, mode?: keyof typeof this.CompressionModes): Int8Array;
+    compressString(data: string, mode?: keyof typeof this.CompressionModes): Int8Array;
     decompress(bytearray: Uint8Array | ArrayBuffer): number[];
     decompressString(bytearray: Uint8Array | ArrayBuffer): string;
 }
-/**
- * Compresses data using LZMA algorithm
- *
- * @param data Data to compress - can be Uint8Array or ArrayBuffer
- * @param mode Compression mode (1-9), defaults to 5
- * @returns Compressed data as a byte array
- */
-export declare function compress(data: Uint8Array | ArrayBuffer, mode?: keyof LZMA["CompressionModes"]): Uint8Array;
-/**
- * Compresses data using LZMA algorithm
- *
- * @param data String to compress
- * @param mode Compression mode (1-9), defaults to 5
- * @returns Compressed data as byte array
- */
-export declare function compressString(data: string, mode?: keyof LZMA["CompressionModes"]): Uint8Array;
-/**
- * Decompresses LZMA compressed data
- *
- * @param data Compressed data as Uint8Array or ArrayBuffer
- * @returns Decompressed data
- */
-export declare function decompress(data: Uint8Array | ArrayBuffer): Uint8Array;
-/**
- * Decompresses LZMA compressed data
- *
- * @param data Compressed data as Uint8Array or ArrayBuffer
- * @returns Decompressed data as string
- */
-export declare function decompressString(data: Uint8Array | ArrayBuffer): string;