@gsknnft/bigint-buffer 1.3.2 → 1.4.2

package/package.json

@@ -1,12 +1,56 @@
 {
   "name": "@gsknnft/bigint-buffer",
-  "version": "1.3.2",
-  "description": "bigint to buffer conversion with native support",
+  "version": "1.4.2",
+  "description": "bigint to buffer conversion with native support and built-in conversion helpers",
   "main": "dist/index.js",
-  "browser": {
-    "./dist/node.js": "./dist/browser.js"
+  "module": "dist/index.js",
+  "browser": "dist/browser.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./conversion": {
+      "types": "./dist/conversion/index.d.ts",
+      "import": "./dist/conversion/index.js",
+      "require": "./dist/conversion/index.cjs"
+    }
+  },
+  "files": [
+    "dist/",
+    "helper/",
+    "src/",
+    "binding.gyp",
+    "build/",
+    "README.md",
+    "LICENSE"
+  ],
+  "workspaces": [],
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "coverage": "vitest cover ./test/index.js",
+    "lint": "gts check",
+    "install": "node-gyp rebuild",
+    "prepublishOnly": "rm -rf build/Makefile; rm build/gyp-*; rm build/*.mk; rm build/*.Makefile; rm *.tgz",
+    "clean:js": "npm clean && rm -rf build/* dist/*",
+    "test:browser": "vite test --browser",
+    "test:node": "mocha build/src/**/*.spec.js --timeout 40000",
+    "declare": "tsc -p . --declaration --emitDeclarationOnly --outDir dist/types",
+    "benchmark": "node -r ts-node/register src/index.bench.ts",
+    "typedoc": "typedoc --out docs $(pwd)/src $(pwd)/helper --target es6 --mode file --tsconfig ./tsconfig.json --excludePrivate --excludeProtected --excludeNotExported --exclude '**/*+(spec|bench).ts'",
+    "rebuild:native": "node-gyp rebuild",
+    "build": "vite build && npm run declare && tsc -p . && cpy \"index.d.ts\" ../dist --cwd dist/types && cpy \"conversion/index.d.ts\" ../dist/conversion --cwd dist/types",
+    "compile": "vite build && npm run declare && tsc -p . && cpy \"index.d.ts\" ../dist/types --cwd dist/types && cpy \"conversion/index.d.ts\" ../dist/conversion --cwd dist/types",
+    "check": "eslint src/**/*.ts src/conversion/**/*.ts src/index.spec.ts src/conversion/test/**/*.ts",
+    "test:vitest": "vitest",
+    "test:all": "pnpm run test && pnpm run benchmark",
+    "clean": "gts clean",
+    "fix": "gts fix",
+    "pretest": "npm run compile",
+    "posttest": "npm run check"
   },
-  "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/gsknnft/bigint-buffer.git"
@@ -22,49 +66,57 @@
     "napi"
   ],
   "license": "Apache-2.0",
-  "dependencies": {
+  "pnpm": {
+    "overrides": {
+      "tmp": "0.2.5"
+    }
+  },
+  "optionalDependencies": {
     "bindings": "^1.5.0"
   },
   "devDependencies": {
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-esm-shim": "0.1.8",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-replace": "6.0.3",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@types/benchmark": "^2.1.5",
     "@types/bn.js": "^5.2.0",
     "@types/chai": "^5.2.3",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24.9.1",
+    "@types/node": "^24.10.1",
+    "@vitest/coverage-v8": "4.0.14",
+    "assertion-error": "^2.0.1",
     "benchmark": "^2.1.4",
+    "bindings": "1.5.0",
     "bn.js": "^5.2.2",
-    "chai": "^4.1.2",
-    "coveralls": "^3.1.1",
     "cpy-cli": "^6.0.0",
-    "cross-env": "^6.0.3",
-    "gts": "^0.8.0",
-    "istanbul": "^0.4.1",
-    "karma": "^3.0.0",
-    "karma-chrome-launcher": "^2.2.0",
+    "cross-env": "^10.1.0",
+    "eslint": "^9.39.1",
+    "globals": "^16.5.0",
+    "gts": "^6.0.2",
+    "jiti": "^2.6.1",
+    "karma": "^6.4.4",
+    "karma-chrome-launcher": "^3.2.0",
     "karma-env-preprocessor": "^0.1.1",
-    "karma-mocha": "^1.3.0",
+    "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
-    "karma-webpack": "^3.0.0",
+    "karma-webpack": "^5.0.1",
     "microtime": "^3.0.0",
-    "mkdirp": "^0.5.1",
-    "mocha": "^5.2.0",
-    "pre-commit": "^1.2.2",
-    "rollup": "^4.52.5",
-    "@rollup/plugin-replace": "6.0.3",
+    "mkdirp": "^3.0.1",
+    "rollup": "^4.53.3",
     "ts-loader": "^9.5.4",
     "ts-node": "^10.9.2",
     "typedoc": "^0.28.14",
     "typescript": "5.9.3",
-    "webpack": "5.102.1",
+    "typescript-eslint": "^8.48.0",
+    "undici-types": "^7.16.0",
+    "vite": "7.2.4",
+    "vitest": "^4.0.14",
+    "webpack": "5.103.0",
     "webpack-cli": "6.0.1"
   },
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
   "engines": {
     "node": ">=24.0.0"
   },
@@ -74,23 +126,5 @@
   "contributors": [
     "Gordon Skinner <gsknnft@gmail.com> (https://github.com/gsknnft)",
     "Michael Wei <mwei@vmware.com> (https://github.com/no2chem)"
-  ],
-  "scripts": {
-    "test": "npm run test:node && npm run test:browser",
-    "coverage": "istanbul cover ./test/index.js",
-    "coveralls": "npm run coverage && coveralls <coverage/lcov.info",
-    "lint": "gts check",
-    "install": "npm run rebuild || echo \"Couldn't build bindings. Non-native version used.\"",
-    "test:browser": "karma start karma.conf.js",
-    "test:node": "mocha build/src/**/*.spec.js --timeout 40000",
-    "benchmark": "node -r ts-node/register src/index.bench.ts",
-    "typedoc": "typedoc --out docs $(pwd)/src $(pwd)/helper --target es6 --mode file --tsconfig ./tsconfig.json --excludePrivate --excludeProtected --excludeNotExported --exclude '**/*+(spec|bench).ts'",
-    "rebuild": "node-gyp rebuild",
-    "check": "gts check",
-    "clean": "gts clean",
-    "compile": "tsc -p . && rollup -c rollup.cjs.config.js && rollup -c rollup.esm.config.js && cp build/src/index.d.ts dist/index.d.ts",
-    "fix": "gts fix",
-    "pretest": "npm run compile",
-    "posttest": "npm run check"
-  }
-}
+  ]
+}

package/src/bigint-buffer.test.ts

@@ -0,0 +1,11 @@
+import {describe, expect, it} from 'vitest';
+
+describe('bigint-buffer', () => {
+  it('should convert bigint to buffer and back', () => {
+    // Example test, replace with real logic
+    const big = BigInt('12345678901234567890');
+    const buf = Buffer.from(big.toString(16), 'hex');
+    const result = BigInt('0x' + buf.toString('hex'));
+    expect(result).toBe(big);
+  });
+});

package/src/conversion/.github/workflows/build-and-test.yml

@@ -0,0 +1,116 @@
+# name: build, test (node and browser), coverage, publish to NPM
+
+# on:
+#   push:
+#     tags:
+#       - "v*.*.*"
+#   workflow_dispatch:
+
+# jobs:
+#   build:
+#     name: build
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Git checkout
+#         uses: actions/checkout@v3
+
+#       - name: Use Node.js 24
+#         uses: actions/setup-node@v3
+#         with:
+#           node-version: 24.x
+#           registry-url: "https://registry.npmjs.org"
+
+#       - name: install
+#         run: pnpm ci
+      
+#       - name: build
+#         run: pnpm run build
+
+#   nodetests:
+#     name: tests in Node.js
+#     needs: [build]
+#     runs-on: ${{ matrix.os }}
+#     strategy:
+#       matrix:
+#         os: [ubuntu-latest, windows-latest, macos-latest]
+#         node-version: [18.x, 20.x, 21.x]
+#       # When set to true, GitHub cancels all in-progress jobs if any matrix job fails.
+#       fail-fast: false
+#       # The maximum number of jobs that can run simultaneously. Set to 1 if you can't run tests in parallel
+#       # max-parallel: 1
+#     steps:
+#       - name: Git checkout
+#         uses: actions/checkout@v3
+
+#       - name: Use Node.js ${{ matrix.node-version }}
+#         uses: actions/setup-node@v3
+#         with:
+#           node-version: ${{ matrix.node-version }}
+#           registry-url: "https://registry.npmjs.org"
+
+#       - name: install
+#         run: pnpm i
+
+#       - name: node esm tests
+#         run: pnpm run test:node-esm
+#         # env:
+#         #   VARIABLE1: ${{ secrets.VARIABLE1 }}
+#         #   VARIABLE2: ${{ secrets.VARIABLE2 }}
+      
+#       - name: node cjs tests
+#         run: pnpm run test:node-cjs
+#         # env:
+#         #   VARIABLE1: ${{ secrets.VARIABLE1 }}
+#         #   VARIABLE2: ${{ secrets.VARIABLE2 }}
+
+#   browsertests:
+#     needs: [build]
+#     name: tests in browser
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Git checkout
+#         uses: actions/checkout@v3
+
+#       - name: Use Node.js 20
+#         uses: actions/setup-node@v3
+#         with:
+#           node-version: 20.x
+#           registry-url: "https://registry.npmjs.org"
+
+#       - name: install
+#         run: npm ci
+
+#       - name: browser tests
+#         run: npm run test:browser-headless
+#         # env:
+#         #   VARIABLE1: ${{ secrets.VARIABLE1 }}
+#         #   VARIABLE2: ${{ secrets.VARIABLE2 }}
+
+#   publish:
+#     needs: [nodetests, browsertests]
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Git checkout
+#         uses: actions/checkout@v3
+
+#       - name: Install Node.js
+#         uses: actions/setup-node@v3
+#         with:
+#           node-version: "20.x"
+#           registry-url: "https://registry.npmjs.org"
+
+#       - name: install
+#         run: npm ci
+        
+#       - name: coverage
+#         run: npm run coverage
+
+#       - name: send report to coveralls.io
+#         uses: coverallsapp/github-action@master
+#         with:
+#           github-token: ${{ secrets.GITHUB_TOKEN }}
+
+#       - name: NPM publish
+#         run: npm publish --access public
+#         env:
+#           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/src/conversion/CODE_OF_CONDUCT.md

@@ -0,0 +1,134 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
+

package/src/conversion/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Juan Hernández Serrano
+
+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/src/conversion/README.md

@@ -0,0 +1,48 @@
+[![Licence: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![Node.js CI](https://github.com/juanelas/bigint-conversion/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/juanelas/bigint-conversion/actions/workflows/build-and-test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/juanelas/bigint-conversion/badge.svg?branch=main)](https://coveralls.io/github/juanelas/bigint-conversion?branch=main)
+
+# bigint-conversion
+
+Convert to/from non-negative integers represented with [ES-2020 native JS implementation of BigInt](https://tc39.es/ecma262/#sec-bigint-objects) from/to:
+
+- `Buffer` (node.js) or `ArrayBuffer|TypedArray` (native js),
+- hex `string`,
+- utf8-encoded text `string`,
+- standard and url-safe base64 with and without padding.
+
+It provides a common interface for the conversions that works for both **node.js** and **native javascript**.
+
+> Note that there is not a directly visible `TypedArray()` constructor, but a set of typed array ones: `Int8Array()`, `Uint8Array()`, `Uint8ClampedArray()`, `Int16Array()`, `Uint16Array()`, `Int32Array()`, `Uint32Array()`, `Float32Array()`, `Float64Array()`, `BigInt64Array()`, `BigUint64Array()`.
+
+## Usage
+
+`bigint-conversion` can be imported to your project with `npm`:
+
+```console
+npm install bigint-conversion
+```
+
+Then either require (Node.js CJS):
+
+```javascript
+const bigintConversion = require('bigint-conversion')
+```
+
+or import (JavaScript ES module):
+
+```javascript
+import * as bigintConversion from 'bigint-conversion'
+```
+
+The appropriate version for browser or node is automatically exported.
+
+> BigInt is [ES-2020](https://tc39.es/ecma262/#sec-bigint-objects). In order to use it with TypeScript you should set `target` (and probably also `lib`) to at least `es2020` in `tsconfig.json`.
+
+You can also download the [IIFE bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\bundle.iife.js), the [ESM bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\esm\bundle.min.js) or the [UMD bundle](https://raw.githubusercontent.com/juanelas/bigint-conversion/main/dist\bundle.umd.js) and manually add it to your project, or, if you have already installed `bigint-conversion` in your project, just get the bundles from `node_modules/bigint-conversion/dist/bundles/`.
+
+## API reference documentation
+
+[Check the API](./docs/API.md)

package/src/conversion/docs/README.md

@@ -0,0 +1,34 @@
+**bigint-conversion**
+
+***
+
+# bigint-conversion
+
+## Type Aliases
+
+- [TypedArray](type-aliases/TypedArray.md)
+
+## Variables
+
+- [isNative](variables/isNative.md)
+
+## Functions
+
+- [base64ToBigint](functions/base64ToBigint.md)
+- [bigintToBase64](functions/bigintToBase64.md)
+- [bigintToBuf](functions/bigintToBuf.md)
+- [bigintToHex](functions/bigintToHex.md)
+- [bigintToText](functions/bigintToText.md)
+- [bufToBigint](functions/bufToBigint.md)
+- [bufToHex](functions/bufToHex.md)
+- [bufToText](functions/bufToText.md)
+- [hexToBigint](functions/hexToBigint.md)
+- [hexToBuf](functions/hexToBuf.md)
+- [parseHex](functions/parseHex.md)
+- [textToBigint](functions/textToBigint.md)
+- [textToBuf](functions/textToBuf.md)
+- [toBigIntBE](functions/toBigIntBE.md)
+- [toBigIntLE](functions/toBigIntLE.md)
+- [toBufferBE](functions/toBufferBE.md)
+- [toBufferLE](functions/toBufferLE.md)
+- [validateBigIntBuffer](functions/validateBigIntBuffer.md)

package/src/conversion/docs/functions/base64ToBigint.md

@@ -0,0 +1,27 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / base64ToBigint
+
+# Function: base64ToBigint()
+
+> **base64ToBigint**(`a`): `bigint`
+
+Defined in: index.ts:330
+
+Converts a base64 string to bigint.
+
+## Parameters
+
+### a
+
+`string`
+
+base64 string. It accepts standard and URL-safe base64 with and without padding
+
+## Returns
+
+`bigint`
+
+a bigint

package/src/conversion/docs/functions/bigintToBase64.md

@@ -0,0 +1,43 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToBase64
+
+# Function: bigintToBase64()
+
+> **bigintToBase64**(`a`, `urlsafe`, `padding`): `string`
+
+Defined in: index.ts:321
+
+Converts an arbitrary-size non-negative bigint to a base64 string
+
+## Parameters
+
+### a
+
+`bigint`
+
+a non negative bigint
+
+### urlsafe
+
+`boolean` = `false`
+
+if true Base64 URL encoding is used ('+' and '/' are replaced by '-', '_')
+
+### padding
+
+`boolean` = `true`
+
+if false, padding (trailing '=') is removed
+
+## Returns
+
+`string`
+
+a base64 representation of the input bigint
+
+## Throws
+
+Thrown if a < 0

package/src/conversion/docs/functions/bigintToBuf.md

@@ -0,0 +1,35 @@
+[**bigint-conversion**](../README.md)
+
+***
+
+[bigint-conversion](../README.md) / bigintToBuf
+
+# Function: bigintToBuf()
+
+> **bigintToBuf**(`a`, `returnArrayBuffer`): `ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: index.ts:144
+
+Converts an arbitrary-size non-negative bigint to an ArrayBuffer or a Buffer (default for Node.js)
+
+## Parameters
+
+### a
+
+`bigint`
+
+### returnArrayBuffer
+
+`boolean` = `false`
+
+In Node.js, it forces the output to be an ArrayBuffer instead of a Buffer.
+
+## Returns
+
+`ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
+
+an ArrayBuffer or a Buffer with a binary representation of the input bigint
+
+## Throws
+
+RangeError if a < 0.