@hugoalh/adler32 0.4.0 → 0.5.1

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2024\~2025 hugoalh
+Copyright © 2024\~2026 HUGOALH
 
 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:
 

package/README.md

@@ -2,54 +2,52 @@
 
 [**⚖️** MIT](./LICENSE.md)
 
-[![GitHub: hugoalh/adler32-es](https://img.shields.io/github/v/release/hugoalh/adler32-es?label=hugoalh/adler32-es&labelColor=181717&logo=github&logoColor=ffffff&sort=semver&style=flat "GitHub: hugoalh/adler32-es")](https://github.com/hugoalh/adler32-es)
-[![JSR: @hugoalh/adler32](https://img.shields.io/jsr/v/@hugoalh/adler32?label=@hugoalh/adler32&labelColor=F7DF1E&logo=jsr&logoColor=000000&style=flat "JSR: @hugoalh/adler32")](https://jsr.io/@hugoalh/adler32)
-[![NPM: @hugoalh/adler32](https://img.shields.io/npm/v/@hugoalh/adler32?label=@hugoalh/adler32&labelColor=CB3837&logo=npm&logoColor=ffffff&style=flat "NPM: @hugoalh/adler32")](https://www.npmjs.com/package/@hugoalh/adler32)
+🔗
+[DistBoard @hugoalh](https://hugoalh.github.io/distboard/adler32_ecmascript)
+● [GitHub](https://github.com/hugoalh/adler32-es)
+● [JSR](https://jsr.io/@hugoalh/adler32)
+● [NPM](https://www.npmjs.com/package/@hugoalh/adler32)
 
-An ECMAScript (JavaScript & TypeScript) module to get the checksum of the data with algorithm Adler32.
+An ECMAScript module to get the checksum of the data with algorithm Adler32.
 
-## 🔰 Begin
+## 🎯 Runtime Targets
 
-### 🎯 Targets
+Any runtime which support ECMAScript should able to use this; These runtimes are officially supported:
 
-| **Targets** | **Remote** | **JSR** | **NPM** |
-|:--|:-:|:-:|:-:|
-| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ✔️ | ✔️ |
-| **[Deno](https://deno.land/)** >= v2.1.0 | ✔️ | ✔️ | ✔️ |
-| **[NodeJS](https://nodejs.org/)** >= v20.9.0 | ❌ | ✔️ | ✔️ |
+- **[Bun](https://bun.sh/)** >= v1.1.0
+- **[Deno](https://deno.land/)** >= v2.1.0
+- **[NodeJS](https://nodejs.org/)** >= v20.9.0
 
-> [!NOTE]
-> - It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.
+## 🛡️ Runtime Permissions
+
+This does not request any runtime permission.
 
-### #️⃣ Resources Identifier
+## #️⃣ Sources & Entrypoints
 
-- **Remote - GitHub Raw:**
+- GitHub Raw
   ```
   https://raw.githubusercontent.com/hugoalh/adler32-es/{Tag}/mod.ts
   ```
-- **JSR:**
+- JSR
   ```
-  [jsr:]@hugoalh/adler32[@{Tag}]
+  jsr:@hugoalh/adler32[@{Tag}]
   ```
-- **NPM:**
+- NPM
   ```
-  [npm:]@hugoalh/adler32[@{Tag}]
+  npm:@hugoalh/adler32[@{Tag}]
   ```
 
-> [!NOTE]
-> - For usage of remote resources, it is recommended to import the entire module with the main path `mod.ts`, however it is also able to import part of the module with sub path if available, but do not import if:
->
->   - it's path has an underscore prefix (e.g.: `_foo.ts`, `_util/bar.ts`), or
->   - it is a benchmark or test file (e.g.: `foo.bench.ts`, `foo.test.ts`), or
->   - it's symbol has an underscore prefix (e.g.: `_bar`, `_foo`).
->
->   These elements are not considered part of the public API, thus no stability is guaranteed for them.
-> - For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub entrypoints.
-> - It is recommended to use this module with tag for immutability.
+| **Name** | **Path** | **Description** |
+|:--|:--|:--|
+| `.` | `./mod.ts` | Default. |
 
-### 🛡️ Runtime Permissions
-
-*This module does not request any runtime permission.*
+> [!NOTE]
+> - Different runtimes have vary support for the sources and entrypoints, visit the runtime documentation for more information.
+> - It is recommended to include tag for immutability.
+> - These are not part of the public APIs hence should not be used:
+>   - Benchmark/Test file (e.g.: `example.bench.ts`, `example.test.ts`).
+>   - Entrypoint name or path include any underscore prefix (e.g.: `_example.ts`, `foo/_example.ts`).
+>   - Identifier/Namespace/Symbol include any underscore prefix (e.g.: `_example`, `Foo._example`).
 
 ## 🧩 APIs
 
@@ -58,33 +56,29 @@ An ECMAScript (JavaScript & TypeScript) module to get the checksum of the data w
     constructor(data?: Adler32AcceptDataType);
     get freezed(): boolean;
     freeze(): this;
-    hash(): bigint;
-    hashBase16(): string;
-    hashBase32Hex(): string;
-    hashBase36(): string;
-    hashBase64(): string;
-    hashBase64URL(): string;
-    hashBigInt(): bigint;
-    hashBuffer(): Buffer;
+    hash(): Uint8Array;
     hashHex(): string;
-    hashHexPadding(): string;
-    hashNumber(): number;
     update(data: Adler32AcceptDataType): this;
-    static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
+    updateFromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<this>;
   }
   ```
 - ```ts
-  type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
+  type Adler32AcceptDataType =
+    | string
+    | BigUint64Array
+    | Uint8Array
+    | Uint16Array
+    | Uint32Array;
   ```
 
 > [!NOTE]
 > - For the full or prettier documentation, can visit via:
->   - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/documentation_generator/)
+>   - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/doc/)
 >   - [JSR](https://jsr.io/@hugoalh/adler32)
 
 ## ✍️ Examples
 
 - ```ts
-  new Adler32("Wikipedia").hashHexPadding();
+  new Adler32("Wikipedia").hashHex();
   //=> "11E60398"
   ```

package/mod.d.ts

@@ -1,4 +1,3 @@
-import { Buffer } from "node:buffer";
 export type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
 /**
  * Get the checksum of the data with algorithm Adler32.
@@ -8,7 +7,7 @@ export declare class Adler32 {
     get [Symbol.toStringTag](): string;
     /**
      * Initialize.
-     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
+     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update} and {@linkcode Adler32.updateFromStream}.
      */
     constructor(data?: Adler32AcceptDataType);
     /**
@@ -22,65 +21,15 @@ export declare class Adler32 {
      */
     freeze(): this;
     /**
-     * Get the checksum of the data, in original format.
-     * @returns {bigint}
+     * Get the checksum of the data, in Uint8Array.
+     * @returns {Uint8Array}
      */
-    hash(): bigint;
+    hash(): Uint8Array;
     /**
-     * Get the checksum of the data, in Base16.
-     * @returns {string}
-     */
-    hashBase16(): string;
-    /**
-     * Get the checksum of the data, in Base32Hex ({@link https://datatracker.ietf.org/doc/html/rfc4648#section-7 RFC 4648 §7}).
-     * @returns {string}
-     */
-    hashBase32Hex(): string;
-    /**
-     * Get the checksum of the data, in Base36.
-     * @returns {string}
-     */
-    hashBase36(): string;
-    /**
-     * Get the checksum of the data, in Base64.
-     * @returns {string}
-     */
-    hashBase64(): string;
-    /**
-     * Get the checksum of the data, in Base64URL.
-     * @returns {string}
-     */
-    hashBase64URL(): string;
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInt(): bigint;
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInteger: () => bigint;
-    /**
-     * Get the checksum of the data, in Buffer.
-     * @returns {Buffer}
-     */
-    hashBuffer(): Buffer;
-    /**
-     * Get the checksum of the data, in hex/hexadecimal without padding.
+     * Get the checksum of the data, in hexadecimal with padding.
      * @returns {string}
      */
     hashHex(): string;
-    /**
-     * Get the checksum of the data, in hex/hexadecimal with padding.
-     * @returns {string}
-     */
-    hashHexPadding(): string;
-    /**
-     * Get the checksum of the data, in number.
-     * @returns {number}
-     */
-    hashNumber(): number;
     /**
      * Append data.
      * @param {Adler32AcceptDataType} data Data.
@@ -88,11 +37,11 @@ export declare class Adler32 {
      */
     update(data: Adler32AcceptDataType): this;
     /**
-     * Initialize from the readable stream.
-     * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
-     * @returns {Promise<Adler32>}
+     * Append data from the readable stream.
+     * @param {ReadableStream<Adler32AcceptDataType>} stream Data from the readable stream.
+     * @returns {Promise<this>}
      */
-    static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
+    updateFromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<this>;
 }
 export default Adler32;
 //# sourceMappingURL=mod.d.ts.map

package/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;AACrG;;GAEG;AACH,qBAAa,OAAO;;IACnB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAUD;;;OAGG;gBACS,IAAI,CAAC,EAAE,qBAAqB;IAgBxC;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IACD;;;OAGG;IACH,MAAM,IAAI,IAAI;IAId;;;OAGG;IACH,IAAI,IAAI,MAAM;IAId;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAIvB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAIvB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,cAAc,EAAE,MAAM,MAAM,CAAmB;IAC/C;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,OAAO,IAAI,MAAM;IAGjB;;;OAGG;IACH,cAAc,IAAI,MAAM;IAGxB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAQzC;;;;OAIG;WACU,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAOxF;AACD,eAAe,OAAO,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["src/mod.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,qBAAqB,GAC9B,MAAM,GACN,cAAc,GACd,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AACf;;GAEG;AACH,qBAAa,OAAO;;IACnB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAMD;;;OAGG;gBACS,IAAI,CAAC,EAAE,qBAAqB;IAKxC;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IACD;;;OAGG;IACH,MAAM,IAAI,IAAI;IAId;;;OAGG;IACH,IAAI,IAAI,UAAU;IAIlB;;;OAGG;IACH,OAAO,IAAI,MAAM;IASjB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAazC;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAMpF;AACD,eAAe,OAAO,CAAC"}

package/mod.js

@@ -1,4 +1,7 @@
-import { Buffer } from "node:buffer";
+if (typeof Uint8Array.fromHex === "undefined") {
+    //deno-lint-ignore hugoalh/no-import-dynamic -- Polyfill.
+    await import("es-arraybuffer-base64/Uint8Array.fromHex/auto");
+}
 /**
  * Get the checksum of the data with algorithm Adler32.
  */
@@ -7,34 +10,19 @@ export class Adler32 {
         return "Adler32";
     }
     #freezed = false;
-    #hash = null;
-    #hashBase16 = null;
-    #hashBase32Hex = null;
-    #hashBase36 = null;
-    #hashBase64 = null;
-    #hashBase64URL = null;
+    #hashHex = null;
+    #hashUint8Array = null;
     #a = 1n;
     #b = 0n;
     /**
      * Initialize.
-     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
+     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update} and {@linkcode Adler32.updateFromStream}.
      */
     constructor(data) {
         if (typeof data !== "undefined") {
             this.update(data);
         }
     }
-    #clearStorage() {
-        if (this.#freezed) {
-            throw new Error(`Instance is freezed!`);
-        }
-        this.#hash = null;
-        this.#hashBase16 = null;
-        this.#hashBase32Hex = null;
-        this.#hashBase36 = null;
-        this.#hashBase64 = null;
-        this.#hashBase64URL = null;
-    }
     /**
      * Whether the instance is freezed.
      * @returns {boolean}
@@ -51,92 +39,25 @@ export class Adler32 {
         return this;
     }
     /**
-     * Get the checksum of the data, in original format.
-     * @returns {bigint}
+     * Get the checksum of the data, in Uint8Array.
+     * @returns {Uint8Array}
      */
     hash() {
-        this.#hash ??= this.#b * 65536n + this.#a;
-        return this.#hash;
-    }
-    /**
-     * Get the checksum of the data, in Base16.
-     * @returns {string}
-     */
-    hashBase16() {
-        this.#hashBase16 ??= this.hashBigInt().toString(16).toUpperCase();
-        return this.#hashBase16;
+        this.#hashUint8Array ??= Uint8Array.fromHex(this.hashHex());
+        return Uint8Array.from(this.#hashUint8Array);
     }
     /**
-     * Get the checksum of the data, in Base32Hex ({@link https://datatracker.ietf.org/doc/html/rfc4648#section-7 RFC 4648 §7}).
-     * @returns {string}
-     */
-    hashBase32Hex() {
-        this.#hashBase32Hex ??= this.hashBigInt().toString(32).toUpperCase();
-        return this.#hashBase32Hex;
-    }
-    /**
-     * Get the checksum of the data, in Base36.
-     * @returns {string}
-     */
-    hashBase36() {
-        this.#hashBase36 ??= this.hashBigInt().toString(36).toUpperCase();
-        return this.#hashBase36;
-    }
-    /**
-     * Get the checksum of the data, in Base64.
-     * @returns {string}
-     */
-    hashBase64() {
-        this.#hashBase64 ??= this.hashBuffer().toString("base64");
-        return this.#hashBase64;
-    }
-    /**
-     * Get the checksum of the data, in Base64URL.
-     * @returns {string}
-     */
-    hashBase64URL() {
-        this.#hashBase64URL ??= this.hashBuffer().toString("base64url");
-        return this.#hashBase64URL;
-    }
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInt() {
-        return this.hash();
-    }
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInteger = this.hashBigInt;
-    /**
-     * Get the checksum of the data, in Buffer.
-     * @returns {Buffer}
-     */
-    hashBuffer() {
-        return Buffer.from(this.hashBase16(), "hex");
-    }
-    /**
-     * Get the checksum of the data, in hex/hexadecimal without padding.
+     * Get the checksum of the data, in hexadecimal with padding.
      * @returns {string}
      */
     hashHex() {
-        return this.hashBase16();
-    }
-    /**
-     * Get the checksum of the data, in hex/hexadecimal with padding.
-     * @returns {string}
-     */
-    hashHexPadding() {
-        return this.hashHex().padStart(8, "0");
-    }
-    /**
-     * Get the checksum of the data, in number.
-     * @returns {number}
-     */
-    hashNumber() {
-        return Number(this.hash());
+        if (this.#hashHex === null) {
+            this.#hashHex = (this.#b * 65536n + this.#a).toString(16).toUpperCase().padStart(8, "0");
+            if (this.#hashHex.length !== 8) {
+                throw new Error(`Unexpected hash hex result \`${this.#hashHex}\`! Please submit a bug report.`);
+            }
+        }
+        return this.#hashHex;
     }
     /**
      * Append data.
@@ -144,24 +65,28 @@ export class Adler32 {
      * @returns {this}
      */
     update(data) {
-        this.#clearStorage();
-        for (const byte of ((typeof data === "string") ? new TextEncoder().encode(data) : data)) {
+        if (this.#freezed) {
+            throw new Error(`Instance is freezed!`);
+        }
+        this.#hashHex = null;
+        this.#hashUint8Array = null;
+        const dataFmt = (typeof data === "string") ? new TextEncoder().encode(data) : data;
+        for (const byte of dataFmt) {
             this.#a = (this.#a + BigInt(byte)) % 65521n;
             this.#b = (this.#b + this.#a) % 65521n;
         }
         return this;
     }
     /**
-     * Initialize from the readable stream.
-     * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
-     * @returns {Promise<Adler32>}
+     * Append data from the readable stream.
+     * @param {ReadableStream<Adler32AcceptDataType>} stream Data from the readable stream.
+     * @returns {Promise<this>}
      */
-    static async fromStream(stream) {
-        const instance = new this();
+    async updateFromStream(stream) {
         for await (const chunk of stream) {
-            instance.update(chunk);
+            this.update(chunk);
         }
-        return instance;
+        return this;
     }
 }
 export default Adler32;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/adler32",
-	"version": "0.4.0",
+	"version": "0.5.1",
 	"description": "A module to get the checksum of the data with algorithm Adler32.",
 	"keywords": [
 		"adler32",
@@ -28,11 +28,12 @@
 		"type": "git",
 		"url": "git+https://github.com/hugoalh/adler32-es.git"
 	},
-	"scripts": {},
+	"dependencies": {
+		"es-arraybuffer-base64": "^1.1.2"
+	},
 	"devDependencies": {
-		"@types/node": "^20.9.0"
+		"@types/node": "^24.5.0"
 	},
-	"engines": {},
 	"private": false,
 	"publishConfig": {
 		"access": "public"