@pezkuwi/types-codec 16.5.8 → 16.5.9

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 {};

package/build/native/Set.js

@@ -1,215 +0,0 @@
-import { BN, bnToBn, bnToU8a, isBn, isNumber, isString, isU8a, isUndefined, objectProperties, stringify, stringPascalCase, u8aToBn, u8aToHex, u8aToU8a } from '@pezkuwi/util';
-import { compareArray } from '../utils/index.js';
-function encodeSet(setValues, values) {
-    const encoded = new BN(0);
-    for (let i = 0, count = values.length; i < count; i++) {
-        encoded.ior(bnToBn(setValues[values[i]] || 0));
-    }
-    return encoded;
-}
-/** @internal */
-function decodeSetArray(setValues, values) {
-    const count = values.length;
-    const result = new Array(count);
-    for (let i = 0; i < count; i++) {
-        const key = values[i];
-        if (isUndefined(setValues[key])) {
-            throw new Error(`Set: Invalid key '${key}' passed to Set, allowed ${Object.keys(setValues).join(', ')}`);
-        }
-        result[i] = key;
-    }
-    return result;
-}
-/** @internal */
-function decodeSetNumber(setValues, _value) {
-    const bn = bnToBn(_value);
-    const keys = Object.keys(setValues);
-    const result = [];
-    for (let i = 0, count = keys.length; i < count; i++) {
-        const key = keys[i];
-        if (bn.and(bnToBn(setValues[key])).eq(bnToBn(setValues[key]))) {
-            result.push(key);
-        }
-    }
-    const computed = encodeSet(setValues, result);
-    if (!bn.eq(computed)) {
-        throw new Error(`Set: Mismatch decoding '${bn.toString()}', computed as '${computed.toString()}' with ${result.join(', ')}`);
-    }
-    return result;
-}
-/** @internal */
-function decodeSet(setValues, value = 0, bitLength) {
-    if (bitLength % 8 !== 0) {
-        throw new Error(`Expected valid bitLength, power of 8, found ${bitLength}`);
-    }
-    const byteLength = bitLength / 8;
-    if (isU8a(value)) {
-        return value.length === 0
-            ? []
-            : decodeSetNumber(setValues, u8aToBn(value.subarray(0, byteLength), { isLe: true }));
-    }
-    else if (isString(value)) {
-        return decodeSet(setValues, u8aToU8a(value), byteLength);
-    }
-    else if (value instanceof Set || Array.isArray(value)) {
-        const input = Array.isArray(value)
-            ? value
-            : [...value.values()];
-        return decodeSetArray(setValues, input);
-    }
-    return decodeSetNumber(setValues, value);
-}
-/**
- * @name Set
- * @description
- * An Set is an array of string values, represented an an encoded type by
- * a bitwise representation of the values.
- */
-export class CodecSet extends Set {
-    registry;
-    createdAtHash;
-    initialU8aLength;
-    isStorageFallback;
-    #allowed;
-    #byteLength;
-    constructor(registry, setValues, value, bitLength = 8) {
-        super(decodeSet(setValues, value, bitLength));
-        this.registry = registry;
-        this.#allowed = setValues;
-        this.#byteLength = bitLength / 8;
-    }
-    static with(values, bitLength) {
-        return class extends CodecSet {
-            static {
-                const keys = Object.keys(values);
-                const count = keys.length;
-                const isKeys = new Array(count);
-                for (let i = 0; i < count; i++) {
-                    isKeys[i] = `is${stringPascalCase(keys[i])}`;
-                }
-                objectProperties(this.prototype, isKeys, (_, i, self) => self.strings.includes(keys[i]));
-            }
-            constructor(registry, value) {
-                super(registry, values, value, bitLength);
-            }
-        };
-    }
-    /**
-     * @description The length of the value when encoded as a Uint8Array
-     */
-    get encodedLength() {
-        return this.#byteLength;
-    }
-    /**
-     * @description returns a hash of the contents
-     */
-    get hash() {
-        return this.registry.hash(this.toU8a());
-    }
-    /**
-     * @description true is the Set contains no values
-     */
-    get isEmpty() {
-        return this.size === 0;
-    }
-    /**
-     * @description The actual set values as a string[]
-     */
-    get strings() {
-        return [...super.values()];
-    }
-    /**
-     * @description The encoded value for the set members
-     */
-    get valueEncoded() {
-        return encodeSet(this.#allowed, this.strings);
-    }
-    /**
-     * @description adds a value to the Set (extended to allow for validity checking)
-     */
-    add = (key) => {
-        // ^^^ add = () property done to assign this instance's this, otherwise Set.add creates "some" chaos
-        // we have the isUndefined(this._setValues) in here as well, add is used internally
-        // in the Set constructor (so it is undefined at this point, and should allow)
-        if (this.#allowed && isUndefined(this.#allowed[key])) {
-            throw new Error(`Set: Invalid key '${key}' on add`);
-        }
-        super.add(key);
-        return this;
-    };
-    /**
-     * @description Compares the value of the input to see if there is a match
-     */
-    eq(other) {
-        if (Array.isArray(other)) {
-            // we don't actually care about the order, sort the values
-            return compareArray(this.strings.sort(), other.sort());
-        }
-        else if (other instanceof Set) {
-            return this.eq([...other.values()]);
-        }
-        else if (isNumber(other) || isBn(other)) {
-            return this.valueEncoded.eq(bnToBn(other));
-        }
-        return false;
-    }
-    /**
-     * @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.toJSON();
-    }
-    /**
-     * @description Converts the Object to JSON, typically used for RPC transfers
-     */
-    toJSON() {
-        return this.strings;
-    }
-    /**
-     * @description The encoded value for the set members
-     */
-    toNumber() {
-        return this.valueEncoded.toNumber();
-    }
-    /**
-     * @description Converts the value in a best-fit primitive form
-     */
-    toPrimitive() {
-        return this.toJSON();
-    }
-    /**
-     * @description Returns the base runtime type name for this instance
-     */
-    toRawType() {
-        return stringify({ _set: this.#allowed });
-    }
-    /**
-     * @description Returns the string representation of the value
-     */
-    toString() {
-        return `[${this.strings.join(', ')}]`;
-    }
-    /**
-     * @description Encodes the value as a Uint8Array as per the SCALE specifications
-     */
-    toU8a(_isBare) {
-        return bnToU8a(this.valueEncoded, {
-            bitLength: this.#byteLength * 8,
-            isLe: true
-        });
-    }
-}