@pezkuwi/types-codec 16.5.13 → 16.5.15

package/build/native/Float.js

@@ -1,107 +0,0 @@
-import { floatToU8a, isHex, isU8a, u8aToFloat, u8aToHex, u8aToU8a } from '@pezkuwi/util';
-/**
- * @name Float
- * @description
- * A Codec wrapper for F32 & F64 values. You generally don't want to be using
- * f32/f64 in your runtime, operations on fixed points numbers are preferable. This class
- * was explicitly added since scale-codec has a flag that enables this and it is available
- * in some eth_* RPCs
- */
-export class Float extends Number {
-    encodedLength;
-    registry;
-    createdAtHash;
-    initialU8aLength;
-    isStorageFallback;
-    #bitLength;
-    constructor(registry, value, { bitLength = 32 } = {}) {
-        super(isU8a(value) || isHex(value)
-            ? value.length === 0
-                ? 0
-                : u8aToFloat(u8aToU8a(value), { bitLength })
-            : (value || 0));
-        this.#bitLength = bitLength;
-        this.encodedLength = bitLength / 8;
-        this.initialU8aLength = this.encodedLength;
-        this.registry = registry;
-    }
-    static with(bitLength) {
-        return class extends Float {
-            constructor(registry, value) {
-                super(registry, value, { bitLength });
-            }
-        };
-    }
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash() {
-        return this.registry.hash(this.toU8a());
-    }
-    /**
-     * @description Returns true if the type wraps an empty/default all-0 value
-     */
-    get isEmpty() {
-        return this.valueOf() === 0;
-    }
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other) {
-        return this.valueOf() === Number(other);
-    }
-    /**
-     * @description Returns a breakdown of the hex encoding for this Codec
-     */
-    inspect() {
-        return {
-            outer: [this.toU8a()]
-        };
-    }
-    /**
-     * @description Returns a hex string representation of the value
-     */
-    toHex() {
-        return u8aToHex(this.toU8a());
-    }
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman() {
-        return this.toString();
-    }
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON() {
-        // Not sure if this is actually a hex or a string value
-        // (would need to check against RPCs to see the result here)
-        return this.toHex();
-    }
-    /**
-     * @description Returns the number representation (Same as valueOf)
-     */
-    toNumber() {
-        return this.valueOf();
-    }
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive() {
-        return this.toNumber();
-    }
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType() {
-        return `f${this.#bitLength}`;
-    }
-    /**
-     * @description Encodes the value as a Uint8Array as per the SCALE specifications
-     */
-    toU8a(_isBare) {
-        return floatToU8a(this, {
-            bitLength: this.#bitLength
-        });
-    }
-}

package/build/native/Json.d.ts

@@ -1,69 +0,0 @@
-import type { HexString } from '@pezkuwi/util/types';
-import type { AnyJson, Codec, Inspect, IU8a, Registry } from '../types/index.js';
-/**
- * @name Json
- * @description
- * Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it
- * implements a Codec, it is limited in that it can only be used with input objects via RPC,
- * i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys
- * @noInheritDoc
- */
-export declare class Json extends Map<string, any> implements Codec {
-    readonly registry: Registry;
-    createdAtHash?: IU8a;
-    initialU8aLength?: number;
-    isStorageFallback?: boolean;
-    constructor(registry: Registry, value?: Record<string, unknown> | null);
-    /**
-     * @description Always 0, never encodes as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash(): IU8a;
-    /**
-     * @description Checks if the value is an empty value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Returns a typed value from the internal map
-     */
-    getT<T>(key: string): T;
-    /**
-     * @description Unimplemented, will throw
-     */
-    inspect(): Inspect;
-    /**
-     * @description Unimplemented, will throw
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(): Record<string, AnyJson>;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): Record<string, AnyJson>;
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive(disableAscii?: boolean): Record<string, AnyJson>;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString(): string;
-    /**
-     * @description Unimplemented, will throw
-     */
-    toU8a(_isBare?: boolean): Uint8Array;
-}

package/build/native/Json.js

@@ -1,117 +0,0 @@
-import { isFunction, objectProperties, stringify } from '@pezkuwi/util';
-import { compareMap } from '../utils/index.js';
-/** @internal */
-function decodeJson(value) {
-    return Object.entries(value || {});
-}
-/**
- * @name Json
- * @description
- * Wraps the a JSON structure retrieve via RPC. It extends the standard JS Map with. While it
- * implements a Codec, it is limited in that it can only be used with input objects via RPC,
- * i.e. no hex decoding. Unlike a struct, this waps a JSON object with unknown keys
- * @noInheritDoc
- */
-export class Json extends Map {
-    registry;
-    createdAtHash;
-    initialU8aLength;
-    isStorageFallback;
-    constructor(registry, value) {
-        const decoded = decodeJson(value);
-        super(decoded);
-        this.registry = registry;
-        objectProperties(this, decoded.map(([k]) => k), (k) => this.get(k));
-    }
-    /**
-     * @description Always 0, never encodes as a Uint8Array
-     */
-    get encodedLength() {
-        return 0 | 0;
-    }
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash() {
-        return this.registry.hash(this.toU8a());
-    }
-    /**
-     * @description Checks if the value is an empty value
-     */
-    get isEmpty() {
-        return [...this.keys()].length === 0;
-    }
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other) {
-        return compareMap(this, other);
-    }
-    /**
-     * @description Returns a typed value from the internal map
-     */
-    getT(key) {
-        return this.get(key);
-    }
-    /**
-     * @description Unimplemented, will throw
-     */
-    inspect() {
-        throw new Error('Unimplemented');
-    }
-    /**
-     * @description Unimplemented, will throw
-     */
-    toHex() {
-        throw new Error('Unimplemented');
-    }
-    /**
-     * @description Converts the Object to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman() {
-        return [...this.entries()].reduce((json, [key, value]) => {
-            json[key] = isFunction(value?.toHuman)
-                ? value.toHuman()
-                : value;
-            return json;
-        }, {});
-    }
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON() {
-        return [...this.entries()].reduce((json, [key, value]) => {
-            json[key] = value;
-            return json;
-        }, {});
-    }
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive(disableAscii) {
-        return [...this.entries()].reduce((json, [key, value]) => {
-            json[key] = isFunction(value.toPrimitive)
-                ? value.toPrimitive(disableAscii)
-                : value;
-            return json;
-        }, {});
-    }
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType() {
-        return 'Json';
-    }
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString() {
-        return stringify(this.toJSON());
-    }
-    /**
-     * @description Unimplemented, will throw
-     */
-    toU8a(_isBare) {
-        throw new Error('Unimplemented');
-    }
-}

package/build/native/Raw.d.ts

@@ -1,87 +0,0 @@
-import type { HexString } from '@pezkuwi/util/types';
-import type { AnyJson, AnyU8a, Inspect, IU8a, Registry } from '../types/index.js';
-/**
- * @name Raw
- * @description
- * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
- * from other implementations where it will consume the full Uint8Array as passed to it.
- * As such it is meant to be subclassed where the wrapper takes care of the
- * actual lengths instead of used directly.
- * @noInheritDoc
- */
-export declare class Raw extends Uint8Array implements IU8a {
-    readonly registry: Registry;
-    createdAtHash?: IU8a | undefined;
-    initialU8aLength?: number | undefined;
-    isStorageFallback?: boolean;
-    /**
-     * @description This ensures that operators such as clice, filter, map, etc. return
-     * new Array instances (without this we need to apply overrides)
-     */
-    static get [Symbol.species](): typeof Uint8Array;
-    constructor(registry: Registry, value?: AnyU8a, initialU8aLength?: number);
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash(): IU8a;
-    /**
-     * @description Returns true if the wrapped value contains only ASCII printable characters
-     */
-    get isAscii(): boolean;
-    /**
-     * @description Returns true if the type wraps an empty/default all-0 value
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description Returns true if the wrapped value contains only utf8 characters
-     */
-    get isUtf8(): boolean;
-    /**
-     * @description Returns the number of bits in the value
-     */
-    bitLength(): number;
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Returns a breakdown of the hex encoding for this Codec
-     */
-    inspect(): Inspect;
-    /**
-     * @description Returns a hex string representation of the value
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(_isExtended?: boolean, disableAscii?: boolean): AnyJson;
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): string;
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive(disableAscii?: boolean): AnyJson;
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString(): string;
-    /**
-     * @description Encodes the value as a Uint8Array as per the SCALE specifications
-     */
-    toU8a(_isBare?: boolean): Uint8Array;
-    /**
-     * @description Returns the wrapped data as a UTF-8 string
-     */
-    toUtf8(): string;
-}

package/build/native/Raw.js

@@ -1,140 +0,0 @@
-import { isAscii, isUndefined, isUtf8, u8aToHex, u8aToString, u8aToU8a } from '@pezkuwi/util';
-/**
- * @name Raw
- * @description
- * A basic wrapper around Uint8Array, with no frills and no fuss. It does differ
- * from other implementations where it will consume the full Uint8Array as passed to it.
- * As such it is meant to be subclassed where the wrapper takes care of the
- * actual lengths instead of used directly.
- * @noInheritDoc
- */
-export class Raw extends Uint8Array {
-    registry;
-    createdAtHash;
-    initialU8aLength;
-    isStorageFallback;
-    /**
-     * @description This ensures that operators such as clice, filter, map, etc. return
-     * new Array instances (without this we need to apply overrides)
-     */
-    static get [Symbol.species]() {
-        return Uint8Array;
-    }
-    constructor(registry, value, initialU8aLength) {
-        super(u8aToU8a(value));
-        this.registry = registry;
-        this.initialU8aLength = initialU8aLength;
-    }
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength() {
-        return this.length;
-    }
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash() {
-        return this.registry.hash(this.toU8a());
-    }
-    /**
-     * @description Returns true if the wrapped value contains only ASCII printable characters
-     */
-    get isAscii() {
-        return isAscii(this);
-    }
-    /**
-     * @description Returns true if the type wraps an empty/default all-0 value
-     */
-    get isEmpty() {
-        return !this.length || isUndefined(this.find((b) => !!b));
-    }
-    /**
-     * @description Returns true if the wrapped value contains only utf8 characters
-     */
-    get isUtf8() {
-        return isUtf8(this);
-    }
-    /**
-     * @description Returns the number of bits in the value
-     */
-    bitLength() {
-        return this.length * 8;
-    }
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other) {
-        if (other instanceof Uint8Array) {
-            return (this.length === other.length) &&
-                !this.some((b, index) => b !== other[index]);
-        }
-        return this.eq(u8aToU8a(other));
-    }
-    /**
-     * @description Returns a breakdown of the hex encoding for this Codec
-     */
-    inspect() {
-        return {
-            outer: [this.toU8a()]
-        };
-    }
-    /**
-     * @description Returns a hex string representation of the value
-     */
-    toHex() {
-        return u8aToHex(this);
-    }
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(_isExtended, disableAscii) {
-        return this.toPrimitive(disableAscii);
-    }
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON() {
-        return this.toHex();
-    }
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive(disableAscii) {
-        if (!disableAscii && this.isAscii) {
-            const text = this.toUtf8();
-            // ensure we didn't end up with multibyte codepoints
-            if (isAscii(text)) {
-                return text;
-            }
-        }
-        return this.toJSON();
-    }
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType() {
-        return 'Raw';
-    }
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString() {
-        return this.toHex();
-    }
-    /**
-     * @description Encodes the value as a Uint8Array as per the SCALE specifications
-     */
-    toU8a(_isBare) {
-        return Uint8Array.from(this);
-    }
-    /**
-     * @description Returns the wrapped data as a UTF-8 string
-     */
-    toUtf8() {
-        if (!this.isUtf8) {
-            throw new Error('The character sequence is not a valid Utf8 string');
-        }
-        return u8aToString(this);
-    }
-}

package/build/native/Set.d.ts

@@ -1,84 +0,0 @@
-import type { HexString } from '@pezkuwi/util/types';
-import type { CodecClass, Inspect, ISet, IU8a, Registry } from '../types/index.js';
-import { BN } from '@pezkuwi/util';
-type SetValues = Record<string, number | BN>;
-/**
- * @name Set
- * @description
- * An Set is an array of string values, represented an an encoded type by
- * a bitwise representation of the values.
- */
-export declare class CodecSet extends Set<string> implements ISet<string> {
-    #private;
-    readonly registry: Registry;
-    createdAtHash?: IU8a;
-    initialU8aLength?: number;
-    isStorageFallback?: boolean;
-    constructor(registry: Registry, setValues: SetValues, value?: string[] | Set<string> | Uint8Array | BN | number | string, bitLength?: number);
-    static with(values: SetValues, bitLength?: number): CodecClass<CodecSet>;
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength(): number;
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash(): IU8a;
-    /**
-     * @description true is the Set contains no values
-     */
-    get isEmpty(): boolean;
-    /**
-     * @description The actual set values as a string[]
-     */
-    get strings(): string[];
-    /**
-     * @description The encoded value for the set members
-     */
-    get valueEncoded(): BN;
-    /**
-     * @description adds a value to the Set (extended to allow for validity checking)
-     */
-    add: (key: string) => this;
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other?: unknown): boolean;
-    /**
-     * @description Returns a breakdown of the hex encoding for this Codec
-     */
-    inspect(): Inspect;
-    /**
-     * @description Returns a hex string representation of the value
-     */
-    toHex(): HexString;
-    /**
-     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-     */
-    toHuman(): string[];
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON(): string[];
-    /**
-     * @description The encoded value for the set members
-     */
-    toNumber(): number;
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive(): string[];
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType(): string;
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString(): string;
-    /**
-     * @description Encodes the value as a Uint8Array as per the SCALE specifications
-     */
-    toU8a(_isBare?: boolean): Uint8Array;
-}
-export {};