@guanghechen/byte 1.0.0-alpha.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0-alpha.1 (2023-10-22)
+
+
+### Features
+
+* ✨ add @guanghechen/byte ([23c4579](https://github.com/guanghechen/sora/commit/23c4579b3c82a710c026c3e1ffa5df27e240ef83))

package/README.md

@@ -0,0 +1,71 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.0-alpha.1/packages/byte#readme">@guanghechen/byte</a>
+  </h1>
+  <div align="center">
+    <a href="https://www.npmjs.com/package/@guanghechen/byte">
+      <img
+        alt="Npm Version"
+        src="https://img.shields.io/npm/v/@guanghechen/byte.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/byte">
+      <img
+        alt="Npm Download"
+        src="https://img.shields.io/npm/dm/@guanghechen/byte.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/byte">
+      <img
+        alt="Npm License"
+        src="https://img.shields.io/npm/l/@guanghechen/byte.svg"
+      />
+    </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs"
+        src="https://img.shields.io/badge/module_formats-cjs-green.svg"
+      />
+    </a>
+    <a href="https://github.com/nodejs/node">
+      <img
+        alt="Node.js Version"
+        src="https://img.shields.io/node/v/@guanghechen/byte"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Tested with Jest"
+        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
+      />
+    </a>
+    <a href="https://github.com/prettier/prettier">
+      <img
+        alt="Code Style: prettier"
+        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
+      />
+    </a>
+  </div>
+</header>
+<br/>
+
+Utility functions for bytes (Uint8Array).
+
+
+## Install
+
+* npm
+
+  ```bash
+  npm install --save @guanghechen/byte
+  ```
+
+* yarn
+
+  ```bash
+  yarn add @guanghechen/byte
+  ```
+
+## Usage
+
+[homepage]: https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.0-alpha.1/packages/byte#readme

package/lib/cjs/index.cjs

@@ -0,0 +1,147 @@
+'use strict';
+
+const hexCodeMap = {
+    0: 0x00,
+    1: 0x01,
+    2: 0x02,
+    3: 0x03,
+    4: 0x04,
+    5: 0x05,
+    6: 0x06,
+    7: 0x07,
+    8: 0x08,
+    9: 0x09,
+    a: 0x0a,
+    b: 0x0b,
+    c: 0x0c,
+    d: 0x0d,
+    e: 0x0e,
+    f: 0x0f,
+    A: 0x0a,
+    B: 0x0b,
+    C: 0x0c,
+    D: 0x0d,
+    E: 0x0e,
+    F: 0x0f,
+};
+const invHexCodeMap = [
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    'a',
+    'b',
+    'c',
+    'd',
+    'e',
+    'f',
+];
+function hexText2bytes(hexText) {
+    if (hexText.length % 2 !== 0) {
+        throw new Error('[hexText2bytes] Hex string length must be even.');
+    }
+    const bytesSize = hexText.length / 2;
+    const bytes = new Uint8Array(bytesSize);
+    for (let i = 0, j = 0; i < bytesSize; ++i, j += 2) {
+        const high = hexCodeMap[hexText[j]];
+        const low = hexCodeMap[hexText[j + 1]];
+        if (high === undefined) {
+            throw new Error(`[hexText2bytes] bad hex string, unknown char (${hexText[j]}).`);
+        }
+        if (low === undefined) {
+            throw new Error(`[hexText2bytes] bad hex string, unknown char (${hexText[j + 1]}).`);
+        }
+        bytes[i] = (high << 4) | low;
+    }
+    return bytes;
+}
+function bytes2HexText(bytes) {
+    const hexText = new Array(bytes.length * 2);
+    for (let i = 0, j = 0; i < bytes.length; ++i, j += 2) {
+        const high = bytes[i] >>> 4;
+        const low = bytes[i] & 0x0f;
+        hexText[j] = invHexCodeMap[high];
+        hexText[j + 1] = invHexCodeMap[low];
+    }
+    return hexText.join('');
+}
+
+const textEncoder = new TextEncoder();
+const textDecoder = new TextDecoder('utf8', { fatal: true });
+function utf8Text2bytes(utf8Text) {
+    return textEncoder.encode(utf8Text);
+}
+function bytes2Utf8Text(bytes) {
+    return textDecoder.decode(bytes);
+}
+
+function text2bytes(text, encoding) {
+    switch (encoding) {
+        case 'utf8':
+        case 'utf-8':
+            return utf8Text2bytes(text);
+        case 'hex':
+            return hexText2bytes(text);
+        default:
+            throw new TypeError(`[text2bytes] Unsupported encoding: ${encoding}.`);
+    }
+}
+function bytes2text(bytes, encoding) {
+    switch (encoding) {
+        case 'utf8':
+        case 'utf-8':
+            return bytes2Utf8Text(bytes);
+        case 'hex':
+            return bytes2HexText(bytes);
+        default:
+            throw new TypeError(`[bytes2text] Unsupported encoding: ${encoding}.`);
+    }
+}
+
+function destroyBytes(bytes) {
+    bytes.fill(0);
+    bytes.fill(1);
+    bytes.fill(Math.random() * 127);
+}
+function destroyBytesList(bytesList) {
+    for (const bytes of bytesList)
+        destroyBytes(bytes);
+}
+
+function mergeBytes(bytesList) {
+    const bytesSize = bytesList.reduce((acc, cur) => acc + cur.length, 0);
+    const result = new Uint8Array(bytesSize);
+    let k = 0;
+    for (const bytes of bytesList) {
+        for (let i = 0; i < bytes.length; ++i, ++k) {
+            result[k] = bytes[i];
+        }
+    }
+    return result;
+}
+
+function randomBytes(size) {
+    const bytes = new Uint8Array(size);
+    for (let i = 0; i < size; i++) {
+        const v = Math.random() * 256;
+        bytes[i] = v >>> 0;
+    }
+    return bytes;
+}
+
+exports.bytes2HexText = bytes2HexText;
+exports.bytes2Utf8Text = bytes2Utf8Text;
+exports.bytes2text = bytes2text;
+exports.destroyBytes = destroyBytes;
+exports.destroyBytesList = destroyBytesList;
+exports.hexText2bytes = hexText2bytes;
+exports.mergeBytes = mergeBytes;
+exports.randomBytes = randomBytes;
+exports.text2bytes = text2bytes;
+exports.utf8Text2bytes = utf8Text2bytes;

package/lib/esm/index.mjs

@@ -0,0 +1,136 @@
+const hexCodeMap = {
+    0: 0x00,
+    1: 0x01,
+    2: 0x02,
+    3: 0x03,
+    4: 0x04,
+    5: 0x05,
+    6: 0x06,
+    7: 0x07,
+    8: 0x08,
+    9: 0x09,
+    a: 0x0a,
+    b: 0x0b,
+    c: 0x0c,
+    d: 0x0d,
+    e: 0x0e,
+    f: 0x0f,
+    A: 0x0a,
+    B: 0x0b,
+    C: 0x0c,
+    D: 0x0d,
+    E: 0x0e,
+    F: 0x0f,
+};
+const invHexCodeMap = [
+    '0',
+    '1',
+    '2',
+    '3',
+    '4',
+    '5',
+    '6',
+    '7',
+    '8',
+    '9',
+    'a',
+    'b',
+    'c',
+    'd',
+    'e',
+    'f',
+];
+function hexText2bytes(hexText) {
+    if (hexText.length % 2 !== 0) {
+        throw new Error('[hexText2bytes] Hex string length must be even.');
+    }
+    const bytesSize = hexText.length / 2;
+    const bytes = new Uint8Array(bytesSize);
+    for (let i = 0, j = 0; i < bytesSize; ++i, j += 2) {
+        const high = hexCodeMap[hexText[j]];
+        const low = hexCodeMap[hexText[j + 1]];
+        if (high === undefined) {
+            throw new Error(`[hexText2bytes] bad hex string, unknown char (${hexText[j]}).`);
+        }
+        if (low === undefined) {
+            throw new Error(`[hexText2bytes] bad hex string, unknown char (${hexText[j + 1]}).`);
+        }
+        bytes[i] = (high << 4) | low;
+    }
+    return bytes;
+}
+function bytes2HexText(bytes) {
+    const hexText = new Array(bytes.length * 2);
+    for (let i = 0, j = 0; i < bytes.length; ++i, j += 2) {
+        const high = bytes[i] >>> 4;
+        const low = bytes[i] & 0x0f;
+        hexText[j] = invHexCodeMap[high];
+        hexText[j + 1] = invHexCodeMap[low];
+    }
+    return hexText.join('');
+}
+
+const textEncoder = new TextEncoder();
+const textDecoder = new TextDecoder('utf8', { fatal: true });
+function utf8Text2bytes(utf8Text) {
+    return textEncoder.encode(utf8Text);
+}
+function bytes2Utf8Text(bytes) {
+    return textDecoder.decode(bytes);
+}
+
+function text2bytes(text, encoding) {
+    switch (encoding) {
+        case 'utf8':
+        case 'utf-8':
+            return utf8Text2bytes(text);
+        case 'hex':
+            return hexText2bytes(text);
+        default:
+            throw new TypeError(`[text2bytes] Unsupported encoding: ${encoding}.`);
+    }
+}
+function bytes2text(bytes, encoding) {
+    switch (encoding) {
+        case 'utf8':
+        case 'utf-8':
+            return bytes2Utf8Text(bytes);
+        case 'hex':
+            return bytes2HexText(bytes);
+        default:
+            throw new TypeError(`[bytes2text] Unsupported encoding: ${encoding}.`);
+    }
+}
+
+function destroyBytes(bytes) {
+    bytes.fill(0);
+    bytes.fill(1);
+    bytes.fill(Math.random() * 127);
+}
+function destroyBytesList(bytesList) {
+    for (const bytes of bytesList)
+        destroyBytes(bytes);
+}
+
+function mergeBytes(bytesList) {
+    const bytesSize = bytesList.reduce((acc, cur) => acc + cur.length, 0);
+    const result = new Uint8Array(bytesSize);
+    let k = 0;
+    for (const bytes of bytesList) {
+        for (let i = 0; i < bytes.length; ++i, ++k) {
+            result[k] = bytes[i];
+        }
+    }
+    return result;
+}
+
+function randomBytes(size) {
+    const bytes = new Uint8Array(size);
+    for (let i = 0; i < size; i++) {
+        const v = Math.random() * 256;
+        bytes[i] = v >>> 0;
+    }
+    return bytes;
+}
+
+export { bytes2HexText, bytes2Utf8Text, bytes2text, destroyBytes, destroyBytesList, hexText2bytes, mergeBytes, randomBytes, text2bytes, utf8Text2bytes };

package/lib/types/index.d.ts

@@ -0,0 +1,38 @@
+type IByteEncoding = 'utf8' | 'utf-8' | 'hex';
+
+/**
+ * Encode the string to Uint8Array with the given encoding.
+ * @param data
+ * @param encoding
+ * @returns
+ */
+declare function text2bytes(text: string, encoding: IByteEncoding): Uint8Array;
+declare function bytes2text(bytes: Readonly<Uint8Array>, encoding: IByteEncoding): string;
+
+declare function hexText2bytes(hexText: string): Uint8Array;
+declare function bytes2HexText(bytes: Readonly<Uint8Array>): string;
+
+declare function utf8Text2bytes(utf8Text: string): Uint8Array;
+declare function bytes2Utf8Text(bytes: Readonly<Uint8Array>): string;
+
+/**
+ * Fill the bytes with random numbers.
+ * @param bytes
+ */
+declare function destroyBytes(bytes: Uint8Array): void;
+/**
+ * Destroy bytes lists.
+ * @param bytesList
+ */
+declare function destroyBytesList(bytesList: Uint8Array[]): void;
+
+declare function mergeBytes(bytesList: ReadonlyArray<Uint8Array>): Uint8Array;
+
+/**
+ * Generate a random bytes with the given size.
+ * @param size
+ * @returns
+ */
+declare function randomBytes(size: number): Uint8Array;
+
+export { type IByteEncoding, bytes2HexText, bytes2Utf8Text, bytes2text, destroyBytes, destroyBytesList, hexText2bytes, mergeBytes, randomBytes, text2bytes, utf8Text2bytes };

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@guanghechen/byte",
+  "version": "1.0.0-alpha.1",
+  "description": "Utility functions for bytes (Uint8Array).",
+  "author": {
+    "name": "guanghechen",
+    "url": "https://github.com/guanghechen/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.0-alpha.0",
+    "directory": "packages/byte"
+  },
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.0-alpha.0/packages/byte#readme",
+  "keywords": [
+    "Uint8Array"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./lib/esm/index.mjs",
+      "require": "./lib/cjs/index.cjs",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.mjs",
+  "types": "./lib/types/index.d.ts",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.map",
+    "package.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "../../node_modules/.bin/rimraf lib/ && ../../node_modules/.bin/cross-env NODE_ENV=production ../../node_modules/.bin/rollup -c ../../rollup.config.mjs",
+    "prepublishOnly": "yarn build",
+    "test": "node --experimental-vm-modules ../../node_modules/.bin/jest --config ../../jest.config.mjs --rootDir ."
+  },
+  "gitHead": "c62824a430a456f7a6c0823d7c32002a24fe738d"
+}