@xylabs/hex 4.13.15 → 4.13.16

package/README.md

@@ -1,67 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/hex
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs Hex Helpers
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-Various Hex helper functions for conversion and formatting
+Version: 4.13.15
 
-### Hex
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-hexFrom - Convert unknown type to hex string 
-
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/hex
-```
-
-Using yarn:
+## Documentation
 
-```sh
-yarn add @xylabs/hex
-```
+Coming Soon!
 
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/hex.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/hex
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/hex
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/hex

package/dist/neutral/index.d.ts

@@ -1,78 +1,5 @@
-type AssertCallback = (value: unknown, message: string) => string | boolean;
-type AssertConfig = string | AssertCallback | boolean;
-
-type Hex = Exclude<Lowercase<string>, 'reserved-hex-value'>;
-/** Configuration of validation and output format */
-interface HexConfig {
-    bitLength?: number;
-    byteSize?: number;
-    prefix?: boolean;
-}
-
-declare function asHex(value: unknown): Hex | undefined;
-declare function asHex(value: unknown, assert: AssertConfig): Hex;
-
-/** Takes unknown value and tries our best to convert it to a hex string */
-declare const hexFrom: (
-/** Supported types are string, number, bigint, and ArrayBuffer */
-value: string | number | bigint | ArrayBufferLike, 
-/** Configuration of output format and validation */
-config?: HexConfig) => Hex;
-
-/** Convert an ArrayBuffer to a hex string */
-declare const hexFromArrayBuffer: (
-/** The buffer to be converted */
-buffer: ArrayBufferLike, 
-/** Configuration of output format and validation */
-config?: HexConfig) => Hex;
-
-/** Convert a bigint to a hex string */
-declare const hexFromBigInt: (
-/** The bigint to be converted */
-value: bigint, 
-/** Configuration of output format and validation */
-config?: HexConfig) => Hex;
-
-declare const hexFromHexString: (value: string, config?: HexConfig) => Hex;
-
-declare const hexFromNumber: (value: number, config?: HexConfig) => Hex;
-
-declare const isHex: (value: unknown, config?: HexConfig) => value is Hex;
-
-declare const isHexZero: (value?: string) => boolean | undefined;
-
-declare const toHexLegacy: (buffer: ArrayBuffer) => string;
-
-declare const bitsToNibbles: (value: number) => number;
-declare const nibblesToBits: (value: number) => number;
-
-declare const hexRegex: RegExp;
-declare const hexRegexWithPrefix: RegExp;
-
-/** takes any value and tries our best to convert it to a hex string */
-declare const toHex: (
-/** Supported types are string, number, bigint, and ArrayBuffer */
-value: string | number | bigint | ArrayBufferLike, 
-/** Configuration of output format and validation */
-config?: HexConfig) => Lowercase<string>;
-
-type Address = Exclude<Hex, 'reserved-address-value'>;
-declare const ZERO_ADDRESS: Address;
-declare const toAddress: (value: string | number | bigint | ArrayBufferLike, config?: HexConfig) => Lowercase<string>;
-declare const isAddress: (value: unknown, config?: HexConfig) => value is Address;
-declare function asAddress(value: unknown): Address | undefined;
-declare function asAddress(value: unknown, assert: AssertConfig): Address;
-
-declare const ZERO_HASH: Hash;
-type HashBitLength = 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
-declare const HashBitLength: HashBitLength[];
-declare const isHashBitLength: (value: unknown) => value is HashBitLength;
-type Hash = Exclude<Hex, 'reserved-hash-value'>;
-declare const isHash: (value: unknown, bitLength?: HashBitLength) => value is Hash;
-declare function asHash(value: unknown): Hash | undefined;
-declare function asHash(value: unknown, assert: AssertConfig): Hash;
-
-declare function hexToBigInt(hex: Hex): bigint;
-
-export { HashBitLength, ZERO_ADDRESS, ZERO_HASH, asAddress, asHash, asHex, bitsToNibbles, hexFrom, hexFromArrayBuffer, hexFromBigInt, hexFromHexString, hexFromNumber, hexRegex, hexRegexWithPrefix, hexToBigInt, isAddress, isHash, isHashBitLength, isHex, isHexZero, nibblesToBits, toAddress, toHex, toHexLegacy };
-export type { Address, Hash, Hex, HexConfig };
+export * from './address.ts';
+export * from './hash.ts';
+export * from './hex/index.ts';
+export * from './hexToBigInt.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/address.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=address.spec.d.ts.map

package/dist/neutral/spec/address.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"address.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/address.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/hash.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=hash.spec.d.ts.map

package/dist/neutral/spec/hash.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/hash.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/hex.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=hex.spec.d.ts.map

package/dist/neutral/spec/hex.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/hex.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/hex",
-  "version": "4.13.15",
+  "version": "4.13.16",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -39,12 +39,12 @@
     "packages/**/*"
   ],
   "dependencies": {
-    "@xylabs/typeof": "^4.13.15"
+    "@xylabs/typeof": "^4.13.16"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
-    "@xylabs/vitest-extended": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/vitest-extended": "^4.13.16",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/build/neutral/index.d.ts

@@ -1,5 +0,0 @@
-export * from './address.ts';
-export * from './hash.ts';
-export * from './hex/index.ts';
-export * from './hexToBigInt.ts';
-//# sourceMappingURL=index.d.ts.map