@ctrl/ts-base32 2.1.3 → 4.0.0

package/README.md

@@ -1,4 +1,4 @@
-# ts-base32 [![npm](https://badgen.net/npm/v/@ctrl/ts-base32)](https://www.npmjs.com/package/@ctrl/ts-base32) [![CircleCI](https://badgen.net/circleci/github/scttcper/ts-base32)](https://circleci.com/gh/scttcper/ts-base32) [![coverage](https://badgen.net/codecov/c/github/scttcper/ts-base32)](https://codecov.io/gh/scttcper/ts-base32) [![bundlesize](https://badgen.net/bundlephobia/min/@ctrl/ts-base32)](https://bundlephobia.com/result?p=@ctrl/ts-base32)
+# ts-base32 [![npm](https://badgen.net/npm/v/@ctrl/ts-base32)](https://www.npmjs.com/package/@ctrl/ts-base32) [![coverage](https://badgen.net/codecov/c/github/scttcper/ts-base32)](https://codecov.io/gh/scttcper/ts-base32) [![bundlesize](https://badgen.net/bundlephobia/min/@ctrl/ts-base32)](https://bundlephobia.com/result?p=@ctrl/ts-base32)
 
 Base32 encode and decode in typescript exported as both commonjs and tree shakeable modules. Support for RFC4648, RFC4648_HEX, and CROCKFORD base32 encoding. Mostly directly taken from LinusU's packages.
 
@@ -14,17 +14,18 @@ npm install @ctrl/ts-base32
 
 ```ts
 import { base32Encode, base32Decode } from '@ctrl/ts-base32';
+import { stringToUint8Array, uint8ArrayToString } from 'uint8array-extras';
 
-console.log(base32Encode(Buffer.from('a')));
+console.log(base32Encode(stringToUint8Array('a')));
 // 'ME======'
 
-console.log(base32Encode(Buffer.from('a'), { padding: false }));
+console.log(base32Encode(stringToUint8Array('a'), { padding: false }));
 // 'ME'
 
 console.log(base32Decode('ME======'));
-// ArrayBuffer { byteLength: 1 }
+// Uint8Array
 
-console.log(Buffer.from(base32Decode('ME======')).toString());
+console.log(uint8ArrayToString(base32Decode('ME======'))
 // 'a'
 ```
 
@@ -32,4 +33,4 @@ console.log(Buffer.from(base32Decode('ME======')).toString());
 
 base32-encode - https://github.com/LinusU/base32-encode  
 base32-decode - https://github.com/LinusU/base32-decode  
-hex-to-array-buffer - https://github.com/LinusU/hex-to-array-buffer
+uint8array-extras - https://github.com/sindresorhus/uint8array-extras

package/dist/src/index.d.ts

@@ -1,10 +1,10 @@
 type Variant = 'RFC3548' | 'RFC4648' | 'RFC4648-HEX' | 'Crockford';
-export declare function base32Encode(buffer: ArrayBuffer, variant?: Variant, options?: Partial<{
+export declare function base32Encode(input: Uint8Array, variant?: Variant, options?: Partial<{
     padding: boolean;
 }>): string;
-export declare function base32Decode(input: string, variant?: Variant): ArrayBuffer;
+export declare function base32Decode(input: string, variant?: Variant): Uint8Array;
 /**
- * Turn a string of hexadecimal characters into an ArrayBuffer
+ * Turn a string of hexadecimal characters into an Uint8Array
  */
-export declare function hexToArrayBuffer(hex: string): ArrayBuffer;
+export declare function hexToUint8Array(hex: string): Uint8Array;
 export {};

package/dist/src/index.js

@@ -1,7 +1,7 @@
 const RFC4648 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
 const RFC4648_HEX = '0123456789ABCDEFGHIJKLMNOPQRSTUV';
 const CROCKFORD = '0123456789ABCDEFGHJKMNPQRSTVWXYZ';
-export function base32Encode(buffer, variant = 'RFC4648', options = {}) {
+export function base32Encode(input, variant = 'RFC4648', options = {}) {
     let alphabet;
     let defaultPadding;
     switch (variant) {
@@ -18,12 +18,13 @@ export function base32Encode(buffer, variant = 'RFC4648', options = {}) {
             alphabet = CROCKFORD;
             defaultPadding = false;
             break;
+        // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
         default:
             throw new Error(`Unknown base32 variant: ${variant}`);
     }
     const padding = options.padding ?? defaultPadding;
-    const length = buffer.byteLength;
-    const view = new Uint8Array(buffer);
+    const length = input.byteLength;
+    const view = new Uint8Array(input);
     let bits = 0;
     let value = 0;
     let output = '';
@@ -69,6 +70,7 @@ export function base32Decode(input, variant = 'RFC4648') {
             alphabet = CROCKFORD;
             cleanedInput = input.toUpperCase().replace(/O/g, '0').replace(/[IL]/g, '1');
             break;
+        // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
         default:
             throw new Error(`Unknown base32 variant: ${variant}`);
     }
@@ -85,12 +87,12 @@ export function base32Decode(input, variant = 'RFC4648') {
             bits -= 8;
         }
     }
-    return output.buffer;
+    return output;
 }
 /**
- * Turn a string of hexadecimal characters into an ArrayBuffer
+ * Turn a string of hexadecimal characters into an Uint8Array
  */
-export function hexToArrayBuffer(hex) {
+export function hexToUint8Array(hex) {
     if (hex.length % 2 !== 0) {
         throw new RangeError('Expected string to be an even number of characters');
     }
@@ -98,5 +100,5 @@ export function hexToArrayBuffer(hex) {
     for (let i = 0; i < hex.length; i += 2) {
         view[i / 2] = parseInt(hex.substring(i, i + 2), 16);
     }
-    return view.buffer;
+    return view;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ctrl/ts-base32",
-  "version": "2.1.3",
+  "version": "4.0.0",
   "description": "Base32 encoder/decoder with support for multiple variants",
   "author": "Scott Cooper <scttcper@gmail.com>",
   "license": "MIT",
@@ -21,10 +21,14 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "demo:build": "npm run build --workspace=demo",
-    "demo:watch": "npm run dev --workspace=demo",
-    "lint": "eslint --ext .ts .",
-    "lint:fix": "eslint --fix --ext .ts .",
+    "demo:build": "pnpm run -r build",
+    "demo:watch": "pnpm run -r dev",
+    "lint": "pnpm run '/^(lint:biome|lint:eslint)$/'",
+    "lint:biome": "biome check .",
+    "lint:eslint": "eslint --ext .ts,.tsx .",
+    "lint:fix": "pnpm run '/^(lint:biome|lint:eslint):fix$/'",
+    "lint:eslint:fix": "eslint --ext .ts,.tsx . --fix",
+    "lint:biome:fix": "biome check . --apply",
     "prepare": "npm run build",
     "build": "tsc",
     "test": "vitest run",
@@ -32,18 +36,15 @@
     "test:ci": "vitest run --coverage --reporter=junit --outputFile=./junit.xml"
   },
   "devDependencies": {
-    "@ctrl/eslint-config": "3.7.0",
-    "@sindresorhus/tsconfig": "3.0.1",
-    "@types/node": "20.1.0",
-    "@vitest/coverage-c8": "0.31.0",
-    "buffer": "6.0.3",
-    "c8": "7.13.0",
-    "typescript": "5.0.4",
-    "vitest": "0.31.0"
+    "@biomejs/biome": "1.5.3",
+    "@ctrl/eslint-config-biome": "2.0.9",
+    "@sindresorhus/tsconfig": "5.0.0",
+    "@types/node": "20.11.24",
+    "@vitest/coverage-v8": "1.3.1",
+    "typescript": "5.3.3",
+    "uint8array-extras": "^1.1.0",
+    "vitest": "1.3.1"
   },
-  "workspaces": [
-    "demo"
-  ],
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -54,6 +55,6 @@
     ]
   },
   "engines": {
-    "node": ">=14.16"
+    "node": ">=18"
   }
 }