@gsknnft/bigint-buffer 1.3.1 → 1.4.1

package/dist/types/dist/dist/index.d.ts

@@ -0,0 +1,80 @@
+import * as conversionUtils from "./conversion/src/ts/index";
+export { conversionUtils };
+export declare let isNative: boolean;
+/**
+ * Convert a little-endian buffer into a BigInt.
+ * @param buf The little-endian buffer to convert
+ * @returns A BigInt with the little-endian representation of buf.
+ */
+export declare function toBigIntLE(buf: Buffer): bigint;
+export declare function validateBigIntBuffer(): boolean;
+/**
+ * Convert a big-endian buffer into a BigInt
+ * @param buf The big-endian buffer to convert.
+ * @returns A BigInt with the big-endian representation of buf.
+ */
+export declare function toBigIntBE(buf: Buffer): bigint;
+/**
+ * Convert a BigInt to a little-endian buffer.
+ * @param num   The BigInt to convert.
+ * @param width The number of bytes that the resulting buffer should be.
+ * @returns A little-endian buffer representation of num.
+ */
+export declare function toBufferLE(num: bigint, width: number): Buffer;
+/**
+ * Convert a BigInt to a big-endian buffer.
+ * @param num   The BigInt to convert.
+ * @param width The number of bytes that the resulting buffer should be.
+ * @returns A big-endian buffer representation of num.
+ */
+export declare function toBufferBE(num: bigint, width: number): Buffer;
+/**
+ * Convert a bigint to a Buffer with automatic sizing.
+ * Uses big-endian encoding and calculates the minimum buffer size needed.
+ * @param num The bigint to convert
+ * @returns A big-endian Buffer representation
+ */
+export declare function bigintToBuf(num: bigint): Buffer;
+/**
+ * Convert a Buffer to a bigint.
+ * Assumes big-endian encoding.
+ * @param buf The buffer to convert
+ * @returns A bigint representation of the buffer
+ */
+export declare function bufToBigint(buf: Buffer): bigint;
+/**
+ * Convert a bigint to a hexadecimal string.
+ * @param num The bigint to convert
+ * @returns A hexadecimal string (without '0x' prefix)
+ */
+export declare function bigintToHex(num: bigint): string;
+/**
+ * Convert a hexadecimal string to a bigint.
+ * @param hex The hexadecimal string (with or without '0x' prefix)
+ * @returns A bigint representation
+ */
+export declare function hexToBigint(hex: string): bigint;
+/**
+ * Convert a bigint to a decimal text string.
+ * @param num The bigint to convert
+ * @returns A decimal string representation
+ */
+export declare function bigintToText(num: bigint): string;
+/**
+ * Convert a decimal text string to a bigint.
+ * @param text The decimal string to convert
+ * @returns A bigint representation
+ */
+export declare function textToBigint(text: string): bigint;
+/**
+ * Convert a bigint to a base64 string.
+ * @param num The bigint to convert
+ * @returns A base64 string representation
+ */
+export declare function bigintToBase64(num: bigint): string;
+/**
+ * Convert a base64 string to a bigint.
+ * @param base64 The base64 string to convert
+ * @returns A bigint representation
+ */
+export declare function base64ToBigint(base64: string): bigint;

package/dist/types/index.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,80 @@
+import * as conversionUtils from "./conversion/src/ts/index";
+export { conversionUtils };
+export declare let isNative: boolean;
+/**
+ * Convert a little-endian buffer into a BigInt.
+ * @param buf The little-endian buffer to convert
+ * @returns A BigInt with the little-endian representation of buf.
+ */
+export declare function toBigIntLE(buf: Buffer): bigint;
+export declare function validateBigIntBuffer(): boolean;
+/**
+ * Convert a big-endian buffer into a BigInt
+ * @param buf The big-endian buffer to convert.
+ * @returns A BigInt with the big-endian representation of buf.
+ */
+export declare function toBigIntBE(buf: Buffer): bigint;
+/**
+ * Convert a BigInt to a little-endian buffer.
+ * @param num   The BigInt to convert.
+ * @param width The number of bytes that the resulting buffer should be.
+ * @returns A little-endian buffer representation of num.
+ */
+export declare function toBufferLE(num: bigint, width: number): Buffer;
+/**
+ * Convert a BigInt to a big-endian buffer.
+ * @param num   The BigInt to convert.
+ * @param width The number of bytes that the resulting buffer should be.
+ * @returns A big-endian buffer representation of num.
+ */
+export declare function toBufferBE(num: bigint, width: number): Buffer;
+/**
+ * Convert a bigint to a Buffer with automatic sizing.
+ * Uses big-endian encoding and calculates the minimum buffer size needed.
+ * @param num The bigint to convert
+ * @returns A big-endian Buffer representation
+ */
+export declare function bigintToBuf(num: bigint): Buffer;
+/**
+ * Convert a Buffer to a bigint.
+ * Assumes big-endian encoding.
+ * @param buf The buffer to convert
+ * @returns A bigint representation of the buffer
+ */
+export declare function bufToBigint(buf: Buffer): bigint;
+/**
+ * Convert a bigint to a hexadecimal string.
+ * @param num The bigint to convert
+ * @returns A hexadecimal string (without '0x' prefix)
+ */
+export declare function bigintToHex(num: bigint): string;
+/**
+ * Convert a hexadecimal string to a bigint.
+ * @param hex The hexadecimal string (with or without '0x' prefix)
+ * @returns A bigint representation
+ */
+export declare function hexToBigint(hex: string): bigint;
+/**
+ * Convert a bigint to a decimal text string.
+ * @param num The bigint to convert
+ * @returns A decimal string representation
+ */
+export declare function bigintToText(num: bigint): string;
+/**
+ * Convert a decimal text string to a bigint.
+ * @param text The decimal string to convert
+ * @returns A bigint representation
+ */
+export declare function textToBigint(text: string): bigint;
+/**
+ * Convert a bigint to a base64 string.
+ * @param num The bigint to convert
+ * @returns A base64 string representation
+ */
+export declare function bigintToBase64(num: bigint): string;
+/**
+ * Convert a base64 string to a bigint.
+ * @param base64 The base64 string to convert
+ * @returns A bigint representation
+ */
+export declare function base64ToBigint(base64: string): bigint;

package/dist/types/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/eslint.config.ts

@@ -0,0 +1,12 @@
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  {
+    files: ["**/*.{js,mjs,cjs,ts,mts,cts}"],
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },
+    ignores: ["*/build/**", "*/dist/**", "*/coverage/**", "*/test/**", "/src/index.spec.ts", "*/*.test.ts"],
+  },
+  tseslint.configs.recommended,
+]);

package/package.json

@@ -1,100 +1,115 @@
-{
-  "name": "@gsknnft/bigint-buffer",
-  "version": "1.3.1",
-  "description": "bigint to buffer conversion with native support",
-  "main": "dist/index.js",
-  "type": "module",
-  "browser": {
-    "./dist/node.js": "./dist/browser.js"
-  },
-  "types": "dist/index.d.ts",
-  "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.\"",
-    "prepare": "npm run compile",
-    "prepublishOnly": "rm -rf build/Release; rm build/Makefile; rm build/gyp-*; rm build/*.mk; rm build/*.Makefile; rm *.tgz",
-    "test:browser": "karma start karma.conf.js",
-    "test:node": "mocha -r ts-node/register src/**/*.spec.ts --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 && cpy build/src/*.d.ts dist",
-    "compileOG": "mkdirp dist && tsc -p . && rollup -c > dist/node.js && cross-env BROWSER=true rollup -c > dist/browser.js && cpx \"build/src/*.d.ts\" dist",
-    "fix": "gts fix",
-    "pretest": "npm run compile",
-    "posttest": "npm run check"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/gsknnft/bigint-buffer.git"
-  },
-  "bugs": {
-    "url": "https://github.com/gsknnft/bigint-buffer/issues"
-  },
-  "homepage": "https://github.com/gsknnft/bigintbuffer",
-  "keywords": [
-    "bigint",
-    "bignum",
-    "tc39-bigint",
-    "napi"
-  ],
-  "license": "Apache-2.0",
-  "dependencies": {
-    "bindings": "^1.5.0"
-  },
-  "devDependencies": {
-    "@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",
-    "benchmark": "^2.1.4",
-    "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",
-    "karma-env-preprocessor": "^0.1.1",
-    "karma-mocha": "^1.3.0",
-    "karma-mocha-reporter": "^2.2.5",
-    "karma-webpack": "^3.0.0",
-    "microtime": "^3.0.0",
-    "mkdirp": "^0.5.1",
-    "mocha": "^5.2.0",
-    "pre-commit": "^1.2.2",
-    "rollup": "^4.52.5",
-    "rollup-plugin-replace": "^2.2.0",
-    "ts-loader": "^9.5.4",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.28.14",
-    "typescript": "5.9.3",
-    "webpack": "5.102.1",
-    "webpack-cli": "6.0.1"
-  },
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    }
-  },
-  "engines": {
-    "node": ">=24.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "contributors": [
-    "Gordon Skinner <gsknnft@gmail.com> (https://github.com/gsknnft)",
-    "Michael Wei <mwei@vmware.com> (https://github.com/no2chem)"
-  ]
-}
+{
+  "name": "@gsknnft/bigint-buffer",
+  "version": "1.4.1",
+  "description": "bigint to buffer conversion with native support and built-in conversion helpers",
+  "main": "dist/index.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"
+    }
+  },
+  "workspaces": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gsknnft/bigint-buffer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gsknnft/bigint-buffer/issues"
+  },
+  "homepage": "https://github.com/gsknnft/bigintbuffer",
+  "keywords": [
+    "bigint",
+    "bignum",
+    "tc39-bigint",
+    "napi"
+  ],
+  "license": "Apache-2.0",
+  "optionalDependencies": {
+    "bindings": "^1.5.0"
+  },
+  "devDependencies": {
+    "jiti": "^2.6.1",
+    "@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.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",
+    "cpy-cli": "^6.0.0",
+    "cross-env": "^10.1.0",
+    "eslint": "^9.39.1",
+    "globals": "^16.5.0",
+    "gts": "^6.0.2",
+    "karma": "^6.4.4",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-webpack": "^5.0.1",
+    "microtime": "^3.0.0",
+    "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",
+    "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"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "contributors": [
+    "Gordon Skinner <gsknnft@gmail.com> (https://github.com/gsknnft)",
+    "Michael Wei <mwei@vmware.com> (https://github.com/no2chem)"
+  ],
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "coverage": "vitest cover ./test/index.js",
+    "lint": "gts check",
+    "install": "node-gyp rebuild",
+    "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"
+  }
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,14 @@
+packages:
+  - src/**
+
+ignoredBuiltDependencies:
+  - inotify
+
+onlyBuiltDependencies:
+  - core-js
+  - es5-ext
+  - esbuild
+  - fsevents
+  - microtime
+  - pre-commit
+  - spawn-sync

package/rollup.cjs.config.js

@@ -1,8 +1,13 @@
+import commonjs from '@rollup/plugin-commonjs';
+
 export default {
-  input: 'build/src/index.js',
+  input: 'build/index.js',
   output: {
     file: 'dist/index.cjs',
     format: 'cjs',
+    exports: 'named'
   },
-  external: ['bindings'],
-};
+  context: 'globalThis',
+  external: ['bindings', '@juanelas/base64'],
+  plugins: [commonjs()]
+};

package/rollup.conversion.cjs.config.js

@@ -0,0 +1,13 @@
+import commonjs from '@rollup/plugin-commonjs';
+
+export default {
+  input: 'build/conversion/index.js',
+  output: {
+    file: 'dist/conversion/index.cjs',
+    format: 'cjs',
+    exports: 'named'
+  },
+  context: 'globalThis',
+  external: ['bindings', '@juanelas/base64'],
+  plugins: [commonjs()]
+};

package/rollup.conversion.esm.config.js

@@ -0,0 +1,24 @@
+import replace from '@rollup/plugin-replace';
+import commonjs from '@rollup/plugin-commonjs';
+
+export default {
+  input: 'build/conversion/index.js',
+  output: {
+    file: 'dist/conversion/index.js',
+    format: 'esm'
+  },
+  context: 'globalThis',
+  external: ['bindings', '@juanelas/base64'],
+  plugins: [
+    commonjs({
+      include: /node_modules/,
+      namedExports: {
+        '@juanelas/base64': ['encode', 'decode']
+      }
+    }),
+    replace({
+      preventAssignment: true,
+      'process.browser': 'false'
+    })
+  ]
+};

package/rollup.esm.config.js

@@ -1,13 +1,24 @@
-import replace from 'rollup-plugin-replace';
+import replace from '@rollup/plugin-replace';
+import commonjs from '@rollup/plugin-commonjs';
 
 export default {
-    input: 'build/src/index.js',
+    input: 'build/index.js',
     output: {
-        format: 'cjs'
+        file: 'dist/index.js',
+        format: 'esm'
     },
+    context: 'globalThis',
+    external: ['bindings', '@juanelas/base64'],
     plugins: [
+        commonjs({
+            include: /node_modules/,
+            namedExports: {
+                '@juanelas/base64': ['encode', 'decode']
+            }
+        }),
         replace({
-            'process.browser': process.env.BROWSER === "true"
+            preventAssignment: true,
+            'process.browser': 'false'
         })
     ]
-};
+};