@guanghechen/byte 1.0.3 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+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,6 +1,6 @@
 <header>
   <h1 align="center">
-    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.3/packages/byte#readme">@guanghechen/byte</a>
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/byte@2.0.0/packages/byte#readme">@guanghechen/byte</a>
   </h1>
   <div align="center">
     <a href="https://www.npmjs.com/package/@guanghechen/byte">
@@ -49,7 +49,8 @@
 </header>
 <br/>
 
-Utility functions for bytes (Uint8Array).
+Utility functions for bytes (Uint8Array). Provides encoding/decoding between bytes and various text
+formats (base64, hex, utf8), along with common byte manipulation utilities.
 
 ## Install
 
@@ -67,5 +68,70 @@ Utility functions for bytes (Uint8Array).
 
 ## Usage
 
+### Encoding / Decoding
+
+```typescript
+import {
+  text2bytes,
+  bytes2text,
+  base64Text2bytes,
+  bytes2base64Text,
+  hexText2bytes,
+  bytes2hexText,
+  utf8Text2bytes,
+  bytes2utf8Text,
+} from '@guanghechen/byte'
+
+// Generic encoding/decoding with encoding type
+const bytes = text2bytes('Hello World', 'utf8')
+const text = bytes2text(bytes, 'utf8') // 'Hello World'
+
+// Base64
+const base64Bytes = base64Text2bytes('SGVsbG8gV29ybGQ=')
+const base64Text = bytes2base64Text(new Uint8Array([72, 101, 108, 108, 111])) // 'SGVsbG8='
+
+// Hex
+const hexBytes = hexText2bytes('48656c6c6f')
+const hexText = bytes2hexText(new Uint8Array([72, 101, 108, 108, 111])) // '48656c6c6f'
+
+// UTF-8
+const utf8Bytes = utf8Text2bytes('Hello')
+const utf8Text = bytes2utf8Text(utf8Bytes) // 'Hello'
+```
+
+### Byte Manipulation
+
+```typescript
+import {
+  mergeBytes,
+  areSameBytes,
+  randomBytes,
+  destroyBytes,
+} from '@guanghechen/byte'
+
+// Merge multiple Uint8Arrays into one
+const merged = mergeBytes([
+  new Uint8Array([1, 2]),
+  new Uint8Array([3, 4]),
+]) // Uint8Array [1, 2, 3, 4]
+
+// Compare two Uint8Arrays
+const isEqual = areSameBytes(
+  new Uint8Array([1, 2, 3]),
+  new Uint8Array([1, 2, 3]),
+) // true
+
+// Generate cryptographically random bytes
+const random = randomBytes(16) // 16 random bytes
+
+// Securely destroy sensitive byte data
+const sensitiveData = new Uint8Array([1, 2, 3, 4])
+destroyBytes(sensitiveData) // Overwrites with zeros, ones, then random values
+```
+
+## Reference
+
+- [homepage][homepage]
+
 [homepage]:
-  https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.3/packages/byte#readme
+  https://github.com/guanghechen/sora/tree/@guanghechen/byte@2.0.0/packages/byte#readme

package/lib/cjs/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var crypto = require('crypto');
+var node_crypto = require('node:crypto');
 
 const CODES = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
 const CODE_PADDING = '=';
@@ -225,7 +225,7 @@ function mergeBytes(bytesList) {
 }
 
 function randomBytes(size) {
-    const bytes = crypto.randomBytes(size);
+    const bytes = node_crypto.randomBytes(size);
     return Uint8Array.from(bytes);
 }
 

package/lib/esm/index.mjs

@@ -1,4 +1,4 @@
-import { randomBytes as randomBytes$1 } from 'crypto';
+import { randomBytes as randomBytes$1 } from 'node:crypto';
 
 const CODES = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
 const CODE_PADDING = '=';

package/lib/types/index.d.ts

@@ -43,11 +43,12 @@ declare function mergeBytes(bytesList: ReadonlyArray<Uint8Array>): Uint8Array;
 /**
  * Generate a random bytes with the given size.
  *
- * Use randomBytes from 'crypto' cause it returns true random numbers.
+ * Use randomBytes from 'node:crypto' cause it returns true random numbers.
  *
  * @param size
  * @returns
  */
 declare function randomBytes(size: number): Uint8Array;
 
-export { type IByteEncoding, areSameBytes, base64Text2bytes, bytes2base64Text, bytes2hexText, bytes2text, bytes2utf8Text, destroyBytes, destroyBytesList, hexText2bytes, mergeBytes, randomBytes, text2bytes, utf8Text2bytes, validateBase64Text };
+export { areSameBytes, base64Text2bytes, bytes2base64Text, bytes2hexText, bytes2text, bytes2utf8Text, destroyBytes, destroyBytesList, hexText2bytes, mergeBytes, randomBytes, text2bytes, utf8Text2bytes, validateBase64Text };
+export type { IByteEncoding };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/byte",
-  "version": "1.0.3",
+  "version": "2.0.1",
   "description": "Utility functions for bytes (Uint8Array).",
   "author": {
     "name": "guanghechen",
@@ -8,20 +8,20 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.2",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@2.0.0",
     "directory": "packages/byte"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@1.0.2/packages/byte#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/byte@2.0.0/packages/byte#readme",
   "keywords": [
     "Uint8Array"
   ],
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -37,5 +37,11 @@
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "c46c7cc64c02c61047fbc7dff2ce8f6b21d4da2c"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}