@gsknnft/bigint-buffer 1.3.0 → 1.3.2

package/okg.md

@@ -1,180 +0,0 @@
-{
-  "name": "bigint-conversion",
-  "version": "2.4.3",
-  "description": "Convert to/from BigInt from/to Buffer, ArrayBuffer, hex string, utf8-encoded text string.",
-  "keywords": [
-    "BigInt",
-    "bignum",
-    "big integer",
-    "text",
-    "utf8",
-    "hex",
-    "Buffer",
-    "ArrayBuffer",
-    "TypedArray"
-  ],
-  "license": "MIT",
-  "author": {
-    "name": "Juan Hernández Serrano",
-    "email": "j.hernandez@upc.edu",
-    "url": "https://github.com/juanelas"
-  },
-  "repository": "github:juanelas/bigint-conversion",
-  "main": "./dist/cjs/index.node.js",
-  "browser": "./dist/esm/index.browser.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "node": {
-        "import": {
-          "types": "./dist/index.d.ts",
-          "default": "./dist/esm/index.node.js"
-        },
-        "require": {
-          "types": "./dist/index.d.ts",
-          "default": "./dist/cjs/index.node.js"
-        }
-      },
-      "script": "./dist/bundle.iife.js",
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/esm/index.browser.js"
-      }
-    },
-    "./esm-browser-bundle": "./dist/esm/bundle.min.js",
-    "./dist/esm/bundle.min.js": "./dist/esm/bundle.min.js",
-    "./esm-browser-bundle-nomin": "./dist/esm/bundle.js",
-    "./dist/esm/bundle.js": "./dist/esm/bundle.js",
-    "./iife-browser-bundle": "./dist/bundle.iife.js",
-    "./dist/bundle.iife.js": "./dist/bundle.iife.js",
-    "./umd-browser-bundle": "./dist/bundle.umd.js",
-    "./dist/bundle.umd.js": "./dist/bundle.umd.js",
-    "./dist/cjs/index.node": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/cjs/index.node.js"
-    },
-    "./dist/esm/index.node": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/esm/index.node.js"
-    },
-    "./dist/esm/index.browser": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/esm/index.browser.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "imports": {
-    "#pkg": {
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/cjs/index.node.js"
-      },
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/esm/index.node.js"
-      },
-      "default": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/esm/index.browser.js"
-      }
-    }
-  },
-  "directories": {
-    "build": "./build",
-    "dist": "./dist",
-    "docs": "./docs",
-    "src": "./src",
-    "test": "./test",
-    "benchmark": "./benchmark",
-    "mocha-ts": "./.mocha-ts"
-  },
-  "scripts": {
-    "_build:cleantypes": "rimraf .types",
-    "_build:cjsAndesmPkgJsons": "node ./build/bin/post-build.js",
-    "build": "run-s lint:src build:js lint:test docs",
-    "build:js": "rollup -c build/rollup.config.mjs",
-    "postbuild:js": "run-s _build:cleantypes _build:cjsAndesmPkgJsons",
-    "clean": "rimraf .mocha-ts coverage dist .types docs",
-    "coverage": "c8 --clean --check-coverage --exclude \"{src/ts/**/*.spec.ts,src/ts/**/*.test.ts,test,test-vectors,build}\" --exclude-after-remap --reporter=text --reporter=lcov node ./build/bin/mocha-ts.js --commonjs ",
-    "docs": "node build/build.docs.js",
-    "git:add": "git add -A",
-    "lint": "ts-standard --fix",
-    "lint:src": "ts-standard --fix \"src/**/!(*.spec|*.test).ts\"",
-    "lint:test": "ts-standard --fix \"{test/**/*.ts,src/**/*.spec.ts,src/**/*.test.ts}\"",
-    "mocha-ts": "node --experimental-modules --experimental-json-modules --es-module-specifier-resolution=node ./build/bin/mocha-ts.js ",
-    "mocha-ts:cjs": "node ./build/bin/mocha-ts.js --commonjs ",
-    "mocha-ts:watch": "npm run mocha-ts:cjs -- --watch --timeout 0",
-    "mocha-ts:browser": "node build/testing/browser/index.js ",
-    "mocha-ts:browser-headless": "node build/testing/browser/index.js headless ",
-    "preversion": "run-s clean lint:src build:js lint:test coverage test:browser-headless",
-    "version": "run-s docs git:add",
-    "postversion": "git push --follow-tags",
-    "test": "run-s test:node test:browser-headless",
-    "test:browser": "npm run mocha-ts:browser",
-    "test:browser-headless": "npm run mocha-ts:browser-headless",
-    "test:node": "run-s test:node-cjs test:node-esm",
-    "test:node-cjs": "npm run mocha-ts:cjs ",
-    "test:node-esm": "npm run mocha-ts ",
-    "watch": "npm run mocha-ts:watch "
-  },
-  "ts-standard": {
-    "project": "tsconfig.json",
-    "env": [
-      "mocha"
-    ],
-    "globals": [
-      "IS_BROWSER",
-      "browser",
-      "page",
-      "chai"
-    ],
-    "ignore": [
-      "dist/**/*",
-      "examples/**/*",
-      "types/**/*",
-      "benchmark/**/*"
-    ]
-  },
-  "nodeBrowserSkel": {
-    "badges": {
-      "workflow": true,
-      "coveralls": true
-    },
-    "git": {
-      "branch": "main"
-    }
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-inject": "^5.0.5",
-    "@rollup/plugin-json": "^6.0.1",
-    "@rollup/plugin-multi-entry": "^6.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-replace": "^5.0.5",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
-    "@types/chai": "^4.3.10",
-    "@types/mocha": "^10.0.4",
-    "c8": "^8.0.1",
-    "chai": "^4.3.10",
-    "dotenv": "^16.3.1",
-    "glob": "^10.3.10",
-    "json5": "^2.2.3",
-    "minimatch": "^9.0.3",
-    "mocha": "^10.2.0",
-    "npm-run-all": "^4.1.5",
-    "pirates": "^4.0.6",
-    "puppeteer": "^21.5.1",
-    "rimraf": "^5.0.5",
-    "rollup": "^4.3.0",
-    "rollup-plugin-dts": "^6.1.0",
-    "ts-standard": "^12.0.2",
-    "tslib": "^2.6.2",
-    "typedoc": "^0.25.3",
-    "typedoc-plugin-markdown": "^3.17.1",
-    "typescript": "^5.0.0"
-  },
-  "dependencies": {
-    "@juanelas/base64": "^1.1.2"
-  }
-}

package/rollup.config.js

@@ -1,16 +0,0 @@
-import replace from '@rollup/plugin-replace';
-
-export default {
-  input: 'build/src/index.js',
-  output: {
-    format: 'esm',
-    file: 'dist/node.js'
-  },
-  external: ['bindings'], // ← This is the fix
-  plugins: [
-    replace({
-      preventAssignment: true,
-      'process.browser': JSON.stringify(process.env.BROWSER === 'true')
-    })
-  ]
-}

package/src/conversion/LICENSE

@@ -1,21 +0,0 @@
-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

@@ -1,48 +0,0 @@
-[![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

@@ -1,34 +0,0 @@
-**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

@@ -1,27 +0,0 @@
-[**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

@@ -1,43 +0,0 @@
-[**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

@@ -1,35 +0,0 @@
-[**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.

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

@@ -1,43 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / bigintToHex
-
-# Function: bigintToHex()
-
-> **bigintToHex**(`a`, `prefix0x`, `byteLength?`): `string`
-
-Defined in: index.ts:177
-
-Converts a non-negative bigint to a hexadecimal string
-
-## Parameters
-
-### a
-
-`bigint`
-
-a non negative bigint
-
-### prefix0x
-
-`boolean` = `false`
-
-set to true to prefix the output with '0x'
-
-### byteLength?
-
-`number`
-
-pad the output to have the desired byte length. Notice that the hex length is double the byte length.
-
-## Returns
-
-`string`
-
-hexadecimal representation of the input bigint
-
-## Throws
-
-RangeError if a < 0

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

@@ -1,31 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / bigintToText
-
-# Function: bigintToText()
-
-> **bigintToText**(`a`): `string`
-
-Defined in: index.ts:204
-
-Converts a non-negative bigint representing a binary array of utf-8 encoded text to a string of utf-8 text
-
-## Parameters
-
-### a
-
-`bigint`
-
-A non-negative bigint representing a binary array of utf-8 encoded text.
-
-## Returns
-
-`string`
-
-a string text with utf-8 encoding
-
-## Throws
-
-RangeError if a < 0.

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

@@ -1,25 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / bufToBigint
-
-# Function: bufToBigint()
-
-> **bufToBigint**(`buf`): `bigint`
-
-Defined in: index.ts:154
-
-Converts an ArrayBuffer, TypedArray or Buffer (node.js) to a bigint
-
-## Parameters
-
-### buf
-
-`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
-
-## Returns
-
-`bigint`
-
-a bigint

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

@@ -1,37 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / bufToHex
-
-# Function: bufToHex()
-
-> **bufToHex**(`buf`, `prefix0x`, `byteLength?`): `string`
-
-Defined in: index.ts:269
-
-Returns the hexadecimal representation of a buffer.
-
-## Parameters
-
-### buf
-
-`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
-
-### prefix0x
-
-`boolean` = `false`
-
-set to true to prefix the output with '0x'
-
-### byteLength?
-
-`number`
-
-pad the output to have the desired byte length. Notice that the hex length is double the byte length.
-
-## Returns
-
-`string`
-
-a string with a hexadecimal representation of the input buffer

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

@@ -1,27 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / bufToText
-
-# Function: bufToText()
-
-> **bufToText**(`buf`): `string`
-
-Defined in: index.ts:239
-
-Converts an ArrayBuffer, TypedArray or Buffer (in Node.js) containing utf-8 encoded text to a string of utf-8 text
-
-## Parameters
-
-### buf
-
-A buffer containing utf-8 encoded text
-
-`ArrayBuffer` | `Buffer`\<`ArrayBufferLike`\> | [`TypedArray`](../type-aliases/TypedArray.md)
-
-## Returns
-
-`string`
-
-a string text with utf-8 encoding

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

@@ -1,29 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / hexToBigint
-
-# Function: hexToBigint()
-
-> **hexToBigint**(`hexStr`): `bigint`
-
-Defined in: index.ts:191
-
-Converts a hexadecimal string to a bigint
-
-## Parameters
-
-### hexStr
-
-`string`
-
-## Returns
-
-`bigint`
-
-a bigint
-
-## Throws
-
-RangeError if input string does not hold an hexadecimal number

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

@@ -1,37 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / hexToBuf
-
-# Function: hexToBuf()
-
-> **hexToBuf**(`hexStr`, `returnArrayBuffer`): `ArrayBuffer` \| `Buffer`\<`ArrayBufferLike`\>
-
-Defined in: index.ts:298
-
-Converts a hexadecimal string to a buffer
-
-## Parameters
-
-### hexStr
-
-`string`
-
-A string representing a number with hexadecimal notation
-
-### 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
-
-## Throws
-
-RangeError if input string does not hold an hexadecimal number

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

@@ -1,45 +0,0 @@
-[**bigint-conversion**](../README.md)
-
-***
-
-[bigint-conversion](../README.md) / parseHex
-
-# Function: parseHex()
-
-> **parseHex**(`a`, `prefix0x`, `byteLength?`): `string`
-
-Defined in: index.ts:119
-
-Parses a hexadecimal string for correctness and returns it with or without '0x' prefix, and/or with the specified byte length
-
-## Parameters
-
-### a
-
-`string`
-
-the string with an hexadecimal number to be parsed
-
-### prefix0x
-
-`boolean` = `false`
-
-set to true to prefix the output with '0x'
-
-### byteLength?
-
-`number`
-
-pad the output to have the desired byte length. Notice that the hex length is double the byte length.
-
-## Returns
-
-`string`
-
-## Throws
-
-RangeError if input string does not hold an hexadecimal number
-
-## Throws
-
-RangeError if requested byte length is less than the input byte length