@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build/cjs/extended/Bytes.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bytes = void 0;
+const util_1 = require("@pezkuwi/util");
+const Raw_js_1 = require("../native/Raw.js");
+const MAX_LENGTH = 10 * 1024 * 1024;
+/** @internal */
+function decodeBytesU8a(value) {
+    if (!value.length) {
+        return [new Uint8Array(), 0];
+    }
+    // handle all other Uint8Array inputs, these do have a length prefix
+    const [offset, length] = (0, util_1.compactFromU8aLim)(value);
+    const total = offset + length;
+    if (length > MAX_LENGTH) {
+        throw new Error(`Bytes length ${length.toString()} exceeds ${MAX_LENGTH}`);
+    }
+    else if (total > value.length) {
+        throw new Error(`Bytes: required length less than remainder, expected at least ${total}, found ${value.length}`);
+    }
+    return [value.subarray(offset, total), total];
+}
+/**
+ * @name Bytes
+ * @description
+ * A Bytes wrapper for Vec<u8>. The significant difference between this and a normal Uint8Array
+ * is that this version allows for length-encoding. (i.e. it is a variable-item codec, the same
+ * as what is found in [[Text]] and [[Vec]])
+ */
+class Bytes extends Raw_js_1.Raw {
+    constructor(registry, value) {
+        const [u8a, decodedLength] = (0, util_1.isU8a)(value) && !(value instanceof Raw_js_1.Raw)
+            ? decodeBytesU8a(value)
+            : Array.isArray(value) || (0, util_1.isString)(value)
+                ? [(0, util_1.u8aToU8a)(value), 0]
+                : [value, 0];
+        super(registry, u8a, decodedLength);
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.length + (0, util_1.compactToU8a)(this.length).length;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(isBare) {
+        const clength = (0, util_1.compactToU8a)(this.length);
+        return {
+            outer: isBare
+                ? [super.toU8a()]
+                : this.length
+                    ? [clength, super.toU8a()]
+                    : [clength]
+        };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Bytes';
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        return isBare
+            ? super.toU8a(isBare)
+            : (0, util_1.compactAddLength)(this);
+    }
+}
+exports.Bytes = Bytes;

package/build/cjs/extended/HashMap.d.ts

@@ -0,0 +1,5 @@
+import type { Codec, CodecClass } from '../types/index.js';
+import { CodecMap } from './Map.js';
+export declare class HashMap<K extends Codec = Codec, V extends Codec = Codec> extends CodecMap<K, V> {
+    static with<K extends Codec, V extends Codec>(keyType: CodecClass<K> | string, valType: CodecClass<V> | string): CodecClass<CodecMap<K, V>>;
+}

package/build/cjs/extended/HashMap.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HashMap = void 0;
+const Map_js_1 = require("./Map.js");
+class HashMap extends Map_js_1.CodecMap {
+    static with(keyType, valType) {
+        return class extends HashMap {
+            constructor(registry, value) {
+                super(registry, keyType, valType, value);
+            }
+        };
+    }
+}
+exports.HashMap = HashMap;

package/build/cjs/extended/Linkage.d.ts

@@ -0,0 +1,37 @@
+import type { Codec, CodecClass, Registry } from '../types/index.js';
+import { Option } from '../base/Option.js';
+import { Tuple } from '../base/Tuple.js';
+import { Struct } from '../native/Struct.js';
+type TypeWithValues = [CodecClass, any[]];
+/**
+ * @name Linkage
+ * @description The wrapper for the result from a LinkedMap
+ */
+export declare class Linkage<T extends Codec> extends Struct {
+    constructor(registry: Registry, Type: CodecClass | string, value?: unknown);
+    static withKey<O extends Codec>(Type: CodecClass | string): CodecClass<Linkage<O>>;
+    /**
+     * @description Returns the next item the Linkage is pointing to
+     */
+    get previous(): Option<T>;
+    /**
+     * @description Returns the previous item the Linkage is pointing to
+     */
+    get next(): Option<T>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Custom toU8a which with bare mode does not return the linkage if empty
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}
+/**
+ * @name LinkageResult
+ * @description A Linkage keys/Values tuple
+ */
+export declare class LinkageResult extends Tuple {
+    constructor(registry: Registry, [TypeKey, keys]: TypeWithValues, [TypeValue, values]: TypeWithValues);
+}
+export {};

package/build/cjs/extended/Linkage.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkageResult = exports.Linkage = void 0;
+const Option_js_1 = require("../base/Option.js");
+const Tuple_js_1 = require("../base/Tuple.js");
+const Vec_js_1 = require("../base/Vec.js");
+const Struct_js_1 = require("../native/Struct.js");
+const EMPTY = new Uint8Array();
+/**
+ * @name Linkage
+ * @description The wrapper for the result from a LinkedMap
+ */
+class Linkage extends Struct_js_1.Struct {
+    constructor(registry, Type, value) {
+        super(registry, {
+            previous: Option_js_1.Option.with(Type),
+            // eslint-disable-next-line sort-keys
+            next: Option_js_1.Option.with(Type)
+        }, value);
+    }
+    static withKey(Type) {
+        return class extends Linkage {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Returns the next item the Linkage is pointing to
+     */
+    get previous() {
+        return this.get('previous');
+    }
+    /**
+     * @description Returns the previous item the Linkage is pointing to
+     */
+    get next() {
+        return this.get('next');
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `Linkage<${this.next.toRawType(true)}>`;
+    }
+    /**
+     * @description Custom toU8a which with bare mode does not return the linkage if empty
+     */
+    toU8a(isBare) {
+        // As part of a storage query (where these appear), in the case of empty, the values
+        // are NOT populated by the node - follow the same logic, leaving it empty
+        return this.isEmpty
+            ? EMPTY
+            : super.toU8a(isBare);
+    }
+}
+exports.Linkage = Linkage;
+/**
+ * @name LinkageResult
+ * @description A Linkage keys/Values tuple
+ */
+class LinkageResult extends Tuple_js_1.Tuple {
+    constructor(registry, [TypeKey, keys], [TypeValue, values]) {
+        super(registry, {
+            Keys: Vec_js_1.Vec.with(TypeKey),
+            Values: Vec_js_1.Vec.with(TypeValue)
+        }, [keys, values]);
+    }
+}
+exports.LinkageResult = LinkageResult;

package/build/cjs/extended/Map.d.ts

@@ -0,0 +1,59 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, Codec, CodecClass, IMap, Inspect, IU8a, Registry } from '../types/index.js';
+export declare class CodecMap<K extends Codec = Codec, V extends Codec = Codec> extends Map<K, V> implements IMap<K, V> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, keyType: CodecClass<K> | string, valType: CodecClass<V> | string, rawValue: Uint8Array | string | Map<any, any> | undefined, type?: 'BTreeMap' | 'HashMap');
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description Returns a hash of the value
+     */
+    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 breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    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): 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): 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
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/build/cjs/extended/Map.js

@@ -0,0 +1,204 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodecMap = void 0;
+const util_1 = require("@pezkuwi/util");
+const Array_js_1 = require("../abstract/Array.js");
+const Enum_js_1 = require("../base/Enum.js");
+const Raw_js_1 = require("../native/Raw.js");
+const Struct_js_1 = require("../native/Struct.js");
+const index_js_1 = require("../utils/index.js");
+const l = (0, util_1.logger)('Map');
+/** @internal */
+function decodeMapFromU8a(registry, KeyClass, ValClass, u8a) {
+    const output = new Map();
+    const [offset, count] = (0, util_1.compactFromU8aLim)(u8a);
+    const types = [];
+    for (let i = 0; i < count; i++) {
+        types.push(KeyClass, ValClass);
+    }
+    const [values, decodedLength] = (0, index_js_1.decodeU8a)(registry, new Array(types.length), u8a.subarray(offset), [types, []]);
+    for (let i = 0, count = values.length; i < count; i += 2) {
+        output.set(values[i], values[i + 1]);
+    }
+    return [KeyClass, ValClass, output, offset + decodedLength];
+}
+/** @internal */
+function decodeMapFromMap(registry, KeyClass, ValClass, value) {
+    const output = new Map();
+    for (const [key, val] of value.entries()) {
+        const isComplex = KeyClass.prototype instanceof Array_js_1.AbstractArray ||
+            KeyClass.prototype instanceof Struct_js_1.Struct ||
+            KeyClass.prototype instanceof Enum_js_1.Enum;
+        try {
+            output.set(key instanceof KeyClass
+                ? key
+                : new KeyClass(registry, isComplex && typeof key === 'string' ? JSON.parse(key) : key), val instanceof ValClass
+                ? val
+                : new ValClass(registry, val));
+        }
+        catch (error) {
+            l.error('Failed to decode key or value:', error.message);
+            throw error;
+        }
+    }
+    return [KeyClass, ValClass, output, 0];
+}
+/**
+ * Decode input to pass into constructor.
+ *
+ * @param KeyClass - Type of the map key
+ * @param ValClass - Type of the map value
+ * @param value - Value to decode, one of:
+ * - null
+ * - undefined
+ * - hex
+ * - Uint8Array
+ * - Map<any, any>, where both key and value types are either
+ *   constructors or decodeable values for their types.
+ * @param jsonMap
+ * @internal
+ */
+function decodeMap(registry, keyType, valType, value) {
+    const KeyClass = (0, index_js_1.typeToConstructor)(registry, keyType);
+    const ValClass = (0, index_js_1.typeToConstructor)(registry, valType);
+    if (!value) {
+        return [KeyClass, ValClass, new Map(), 0];
+    }
+    else if ((0, util_1.isU8a)(value) || (0, util_1.isHex)(value)) {
+        return decodeMapFromU8a(registry, KeyClass, ValClass, (0, util_1.u8aToU8a)(value));
+    }
+    else if (value instanceof Map) {
+        return decodeMapFromMap(registry, KeyClass, ValClass, value);
+    }
+    else if ((0, util_1.isObject)(value)) {
+        return decodeMapFromMap(registry, KeyClass, ValClass, new Map(Object.entries(value)));
+    }
+    throw new Error('Map: cannot decode type');
+}
+class CodecMap extends Map {
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #KeyClass;
+    #ValClass;
+    #type;
+    constructor(registry, keyType, valType, rawValue, type = 'HashMap') {
+        const [KeyClass, ValClass, decoded, decodedLength] = decodeMap(registry, keyType, valType, rawValue);
+        super(type === 'BTreeMap' ? (0, index_js_1.sortMap)(decoded) : decoded);
+        this.registry = registry;
+        this.initialU8aLength = decodedLength;
+        this.#KeyClass = KeyClass;
+        this.#ValClass = ValClass;
+        this.#type = type;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        let len = (0, util_1.compactToU8a)(this.size).length;
+        for (const [k, v] of this.entries()) {
+            len += k.encodedLength + v.encodedLength;
+        }
+        return len;
+    }
+    /**
+     * @description Returns a hash of the value
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty() {
+        return this.size === 0;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return (0, index_js_1.compareMap)(this, other);
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        const inner = [];
+        for (const [k, v] of this.entries()) {
+            inner.push(k.inspect());
+            inner.push(v.inspect());
+        }
+        return {
+            inner,
+            outer: [(0, util_1.compactToU8a)(this.size)]
+        };
+    }
+    /**
+     * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+     */
+    toHex() {
+        return (0, util_1.u8aToHex)(this.toU8a());
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended, disableAscii) {
+        const json = {};
+        for (const [k, v] of this.entries()) {
+            json[k instanceof Raw_js_1.Raw && !disableAscii && k.isAscii
+                ? k.toUtf8()
+                : k.toString()] = v.toHuman(isExtended, disableAscii);
+        }
+        return json;
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON() {
+        const json = {};
+        for (const [k, v] of this.entries()) {
+            json[k.toString()] = v.toJSON();
+        }
+        return json;
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        const json = {};
+        for (const [k, v] of this.entries()) {
+            json[k instanceof Raw_js_1.Raw && !disableAscii && k.isAscii
+                ? k.toUtf8()
+                : k.toString()] = v.toPrimitive(disableAscii);
+        }
+        return json;
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#type}<${this.registry.getClassName(this.#KeyClass) || new this.#KeyClass(this.registry).toRawType()},${this.registry.getClassName(this.#ValClass) || new this.#ValClass(this.registry).toRawType()}>`;
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return (0, util_1.stringify)(this.toJSON());
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        const encoded = [];
+        if (!isBare) {
+            encoded.push((0, util_1.compactToU8a)(this.size));
+        }
+        for (const [k, v] of this.entries()) {
+            encoded.push(k.toU8a(isBare), v.toU8a(isBare));
+        }
+        return (0, util_1.u8aConcatStrict)(encoded);
+    }
+}
+exports.CodecMap = CodecMap;

package/build/cjs/extended/OptionBool.d.ts

@@ -0,0 +1,36 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyBool, Inspect, Registry } from '../types/index.js';
+import { Option } from '../base/Option.js';
+import { bool as Bool } from '../native/Bool.js';
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+export declare class OptionBool extends Option<Bool> {
+    constructor(registry: Registry, value?: Option<Bool> | AnyBool | Uint8Array | HexString | null);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isFalse(): boolean;
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isTrue(): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare?: boolean): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/build/cjs/extended/OptionBool.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionBool = void 0;
+const util_1 = require("@pezkuwi/util");
+const Option_js_1 = require("../base/Option.js");
+const Bool_js_1 = require("../native/Bool.js");
+function decodeU8a(registry, value) {
+    // Encoded as -
+    //  - 0 = None
+    //  - 1 = True
+    //  - 2 = False
+    return value[0] === 0
+        ? null
+        : new Bool_js_1.bool(registry, value[0] === 1);
+}
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+class OptionBool extends Option_js_1.Option {
+    constructor(registry, value) {
+        super(registry, Bool_js_1.bool, (0, util_1.isU8a)(value) || (0, util_1.isHex)(value)
+            ? decodeU8a(registry, (0, util_1.u8aToU8a)(value))
+            : value);
+        this.initialU8aLength = 1;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return 1 | 0;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isFalse() {
+        return this.isSome
+            ? !this.value.valueOf()
+            : false;
+    }
+    /**
+     * @description Checks if the value is an empty value (always false)
+     */
+    get isTrue() {
+        return this.isSome
+            ? this.value.valueOf()
+            : false;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return { outer: [this.toU8a()] };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare) {
+        return isBare
+            ? 'bool'
+            : 'Option<bool>';
+    }
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare) {
+        if (isBare) {
+            return super.toU8a(true);
+        }
+        return this.isSome
+            ? new Uint8Array([this.isTrue ? 1 : 2])
+            : new Uint8Array([0]);
+    }
+}
+exports.OptionBool = OptionBool;

package/build/cjs/extended/Range.d.ts

@@ -0,0 +1,29 @@
+import type { AnyTuple, CodecClass, INumber, Registry } from '../types/index.js';
+import { Tuple } from '../base/Tuple.js';
+type RangeType = 'Range' | 'RangeInclusive';
+interface Options {
+    rangeName?: RangeType;
+}
+/**
+ * @name Range
+ * @description
+ * Rust `Range<T>` representation
+ */
+export declare class Range<T extends INumber> extends Tuple {
+    #private;
+    constructor(registry: Registry, Type: CodecClass<T> | string, value?: AnyTuple, { rangeName }?: Options);
+    static with<T extends INumber>(Type: CodecClass<T> | string): CodecClass<Range<T>>;
+    /**
+     * @description Returns the starting range value
+     */
+    get start(): T;
+    /**
+     * @description Returns the ending range value
+     */
+    get end(): T;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}
+export {};

package/build/cjs/extended/Range.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Range = void 0;
+const Tuple_js_1 = require("../base/Tuple.js");
+/**
+ * @name Range
+ * @description
+ * Rust `Range<T>` representation
+ */
+class Range extends Tuple_js_1.Tuple {
+    #rangeName;
+    constructor(registry, Type, value, { rangeName = 'Range' } = {}) {
+        super(registry, [Type, Type], value);
+        this.#rangeName = rangeName;
+    }
+    static with(Type) {
+        return class extends Range {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Returns the starting range value
+     */
+    get start() {
+        return this[0];
+    }
+    /**
+     * @description Returns the ending range value
+     */
+    get end() {
+        return this[1];
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#rangeName}<${this.start.toRawType()}>`;
+    }
+}
+exports.Range = Range;

package/build/cjs/extended/RangeInclusive.d.ts

@@ -0,0 +1,6 @@
+import type { AnyTuple, CodecClass, INumber, Registry } from '../types/index.js';
+import { Range } from './Range.js';
+export declare class RangeInclusive<T extends INumber = INumber> extends Range<T> {
+    constructor(registry: Registry, Type: CodecClass<T> | string, value?: AnyTuple);
+    static with<T extends INumber>(Type: CodecClass<T> | string): CodecClass<RangeInclusive<T>>;
+}

package/build/cjs/extended/RangeInclusive.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RangeInclusive = void 0;
+const Range_js_1 = require("./Range.js");
+class RangeInclusive extends Range_js_1.Range {
+    constructor(registry, Type, value) {
+        super(registry, Type, value, { rangeName: 'RangeInclusive' });
+    }
+    static with(Type) {
+        return class extends RangeInclusive {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+}
+exports.RangeInclusive = RangeInclusive;