@pezkuwi/types-codec 16.5.5 → 16.5.8

package/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/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/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/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/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;

package/cjs/extended/Type.d.ts

@@ -0,0 +1,16 @@
+import type { Registry } from '../types/index.js';
+import { Text } from '../native/Text.js';
+/**
+ * @name Type
+ * @description
+ * This is a extended version of Text, specifically to handle types. Here we rely fully
+ * on what Text provides us, however we also adjust the types received from the runtime,
+ * i.e. we remove the `T::` prefixes found in some types for consistency across implementation.
+ */
+export declare class Type extends Text {
+    constructor(registry: Registry, value?: Text | Uint8Array | string);
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}

package/cjs/extended/Type.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = void 0;
+const Text_js_1 = require("../native/Text.js");
+const index_js_1 = require("../utils/index.js");
+/**
+ * @name Type
+ * @description
+ * This is a extended version of Text, specifically to handle types. Here we rely fully
+ * on what Text provides us, however we also adjust the types received from the runtime,
+ * i.e. we remove the `T::` prefixes found in some types for consistency across implementation.
+ */
+class Type extends Text_js_1.Text {
+    constructor(registry, value = '') {
+        super(registry, value);
+        this.setOverride((0, index_js_1.sanitize)(this.toString()));
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return 'Type';
+    }
+}
+exports.Type = Type;

package/cjs/extended/U8aFixed.d.ts

@@ -0,0 +1,16 @@
+import type { AnyU8a, CodecClass, Registry, U8aBitLength } from '../types/index.js';
+import { Raw } from '../native/Raw.js';
+/**
+ * @name U8aFixed
+ * @description
+ * A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant
+ * to be used directly, rather is should be subclassed with the specific lengths.
+ */
+export declare class U8aFixed extends Raw {
+    constructor(registry: Registry, value?: AnyU8a, bitLength?: U8aBitLength);
+    static with(bitLength: U8aBitLength, typeName?: string): CodecClass<U8aFixed>;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+}

package/cjs/extended/U8aFixed.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.U8aFixed = void 0;
+const util_1 = require("@pezkuwi/util");
+const Raw_js_1 = require("../native/Raw.js");
+/** @internal */
+function decodeU8aFixed(value, bitLength) {
+    const u8a = (0, util_1.u8aToU8a)(value);
+    const byteLength = bitLength / 8;
+    if (!u8a.length) {
+        return [new Uint8Array(byteLength), 0];
+    }
+    if ((0, util_1.isU8a)(value) ? u8a.length < byteLength : u8a.length !== byteLength) {
+        throw new Error(`Expected input with ${byteLength} bytes (${bitLength} bits), found ${u8a.length} bytes`);
+    }
+    return [u8a.subarray(0, byteLength), byteLength];
+}
+/**
+ * @name U8aFixed
+ * @description
+ * A U8a that manages a a sequence of bytes up to the specified bitLength. Not meant
+ * to be used directly, rather is should be subclassed with the specific lengths.
+ */
+class U8aFixed extends Raw_js_1.Raw {
+    constructor(registry, value = new Uint8Array(), bitLength = 256) {
+        const [u8a, decodedLength] = decodeU8aFixed(value, bitLength);
+        super(registry, u8a, decodedLength);
+    }
+    static with(bitLength, typeName) {
+        return class extends U8aFixed {
+            constructor(registry, value) {
+                super(registry, value, bitLength);
+            }
+            toRawType() {
+                return typeName || super.toRawType();
+            }
+        };
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `[u8;${this.length}]`;
+    }
+}
+exports.U8aFixed = U8aFixed;

package/cjs/extended/WrapperKeepOpaque.d.ts

@@ -0,0 +1,40 @@
+import type { AnyJson, Codec, CodecClass, Inspect, Registry } from '../types/index.js';
+import { Bytes } from './Bytes.js';
+type OpaqueName = 'WrapperKeepOpaque' | 'WrapperOpaque';
+interface Options {
+    opaqueName?: OpaqueName;
+}
+export declare class WrapperKeepOpaque<T extends Codec> extends Bytes {
+    #private;
+    constructor(registry: Registry, typeName: CodecClass<T> | string, value?: unknown, { opaqueName }?: Options);
+    static with<T extends Codec>(Type: CodecClass<T> | string): CodecClass<WrapperKeepOpaque<T>>;
+    /**
+     * @description Checks if the wrapper is decodable
+     */
+    get isDecoded(): boolean;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @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 value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii?: boolean): any;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Converts the Object to to a string (either decoded or bytes)
+     */
+    toString(): string;
+    /**
+     * @description Returns the decoded that the WrapperKeepOpaque represents (if available), throws if non-decodable
+     */
+    unwrap(): T;
+}
+export {};

package/cjs/extended/WrapperKeepOpaque.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperKeepOpaque = void 0;
+const util_1 = require("@pezkuwi/util");
+const Raw_js_1 = require("../native/Raw.js");
+const index_js_1 = require("../utils/index.js");
+const Bytes_js_1 = require("./Bytes.js");
+function decodeRaw(registry, typeName, value) {
+    const Type = (0, index_js_1.typeToConstructor)(registry, typeName);
+    if ((0, util_1.isU8a)(value) || (0, util_1.isHex)(value)) {
+        try {
+            const [, u8a] = (0, util_1.isHex)(value)
+                ? [0, (0, util_1.u8aToU8a)(value)]
+                : (value instanceof Raw_js_1.Raw)
+                    ? [0, value.subarray()]
+                    : (0, util_1.compactStripLength)(value);
+            return [Type, new Type(registry, u8a), value];
+        }
+        catch {
+            return [Type, null, value];
+        }
+    }
+    const instance = new Type(registry, value);
+    return [Type, instance, (0, util_1.compactAddLength)(instance.toU8a())];
+}
+class WrapperKeepOpaque extends Bytes_js_1.Bytes {
+    #Type;
+    #decoded;
+    #opaqueName;
+    constructor(registry, typeName, value, { opaqueName = 'WrapperKeepOpaque' } = {}) {
+        const [Type, decoded, u8a] = decodeRaw(registry, typeName, value);
+        super(registry, u8a);
+        this.#Type = Type;
+        this.#decoded = decoded;
+        this.#opaqueName = opaqueName;
+    }
+    static with(Type) {
+        return class extends WrapperKeepOpaque {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description Checks if the wrapper is decodable
+     */
+    get isDecoded() {
+        return !!this.#decoded;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        return this.#decoded
+            ? {
+                inner: [this.#decoded.inspect()],
+                outer: [(0, util_1.compactToU8a)(this.length)]
+            }
+            : {
+                outer: [(0, util_1.compactToU8a)(this.length), this.toU8a(true)]
+            };
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(isExtended, disableAscii) {
+        return this.#decoded
+            ? this.#decoded.toHuman(isExtended, disableAscii)
+            : super.toHuman(isExtended, disableAscii);
+    }
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(disableAscii) {
+        return this.#decoded
+            ? this.#decoded.toPrimitive(disableAscii)
+            : super.toPrimitive(disableAscii);
+    }
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType() {
+        return `${this.#opaqueName}<${this.registry.getClassName(this.#Type) || (this.#decoded ? this.#decoded.toRawType() : new this.#Type(this.registry).toRawType())}>`;
+    }
+    /**
+     * @description Converts the Object to to a string (either decoded or bytes)
+     */
+    toString() {
+        return this.#decoded
+            ? this.#decoded.toString()
+            : super.toString();
+    }
+    /**
+     * @description Returns the decoded that the WrapperKeepOpaque represents (if available), throws if non-decodable
+     */
+    unwrap() {
+        if (!this.#decoded) {
+            throw new Error(`${this.#opaqueName}: unwrapping an undecodable value`);
+        }
+        return this.#decoded;
+    }
+}
+exports.WrapperKeepOpaque = WrapperKeepOpaque;

package/cjs/extended/WrapperOpaque.d.ts

@@ -0,0 +1,10 @@
+import type { Codec, CodecClass, Registry } from '../types/index.js';
+import { WrapperKeepOpaque } from './WrapperKeepOpaque.js';
+export declare class WrapperOpaque<T extends Codec> extends WrapperKeepOpaque<T> {
+    constructor(registry: Registry, typeName: CodecClass<T> | string, value?: unknown);
+    static with<T extends Codec>(Type: CodecClass<T> | string): CodecClass<WrapperKeepOpaque<T>>;
+    /**
+     * @description The inner value for this wrapper, in all cases it _should_ be decodable (unlike KeepOpaque)
+     */
+    get inner(): T;
+}

package/cjs/extended/WrapperOpaque.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperOpaque = void 0;
+const WrapperKeepOpaque_js_1 = require("./WrapperKeepOpaque.js");
+class WrapperOpaque extends WrapperKeepOpaque_js_1.WrapperKeepOpaque {
+    constructor(registry, typeName, value) {
+        super(registry, typeName, value, { opaqueName: 'WrapperOpaque' });
+    }
+    static with(Type) {
+        return class extends WrapperOpaque {
+            constructor(registry, value) {
+                super(registry, Type, value);
+            }
+        };
+    }
+    /**
+     * @description The inner value for this wrapper, in all cases it _should_ be decodable (unlike KeepOpaque)
+     */
+    get inner() {
+        return this.unwrap();
+    }
+}
+exports.WrapperOpaque = WrapperOpaque;

package/cjs/extended/index.d.ts

@@ -0,0 +1,14 @@
+export { BitVec } from './BitVec.js';
+export { BTreeMap } from './BTreeMap.js';
+export { BTreeSet } from './BTreeSet.js';
+export { Bytes } from './Bytes.js';
+export { HashMap } from './HashMap.js';
+export { Linkage } from './Linkage.js';
+export { CodecMap, CodecMap as Map } from './Map.js';
+export { OptionBool } from './OptionBool.js';
+export { Range } from './Range.js';
+export { RangeInclusive } from './RangeInclusive.js';
+export { Type } from './Type.js';
+export { U8aFixed } from './U8aFixed.js';
+export { WrapperKeepOpaque } from './WrapperKeepOpaque.js';
+export { WrapperOpaque } from './WrapperOpaque.js';

package/cjs/extended/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrapperOpaque = exports.WrapperKeepOpaque = exports.U8aFixed = exports.Type = exports.RangeInclusive = exports.Range = exports.OptionBool = exports.Map = exports.CodecMap = exports.Linkage = exports.HashMap = exports.Bytes = exports.BTreeSet = exports.BTreeMap = exports.BitVec = void 0;
+var BitVec_js_1 = require("./BitVec.js");
+Object.defineProperty(exports, "BitVec", { enumerable: true, get: function () { return BitVec_js_1.BitVec; } });
+var BTreeMap_js_1 = require("./BTreeMap.js");
+Object.defineProperty(exports, "BTreeMap", { enumerable: true, get: function () { return BTreeMap_js_1.BTreeMap; } });
+var BTreeSet_js_1 = require("./BTreeSet.js");
+Object.defineProperty(exports, "BTreeSet", { enumerable: true, get: function () { return BTreeSet_js_1.BTreeSet; } });
+var Bytes_js_1 = require("./Bytes.js");
+Object.defineProperty(exports, "Bytes", { enumerable: true, get: function () { return Bytes_js_1.Bytes; } });
+var HashMap_js_1 = require("./HashMap.js");
+Object.defineProperty(exports, "HashMap", { enumerable: true, get: function () { return HashMap_js_1.HashMap; } });
+var Linkage_js_1 = require("./Linkage.js");
+Object.defineProperty(exports, "Linkage", { enumerable: true, get: function () { return Linkage_js_1.Linkage; } });
+var Map_js_1 = require("./Map.js");
+Object.defineProperty(exports, "CodecMap", { enumerable: true, get: function () { return Map_js_1.CodecMap; } });
+Object.defineProperty(exports, "Map", { enumerable: true, get: function () { return Map_js_1.CodecMap; } });
+var OptionBool_js_1 = require("./OptionBool.js");
+Object.defineProperty(exports, "OptionBool", { enumerable: true, get: function () { return OptionBool_js_1.OptionBool; } });
+var Range_js_1 = require("./Range.js");
+Object.defineProperty(exports, "Range", { enumerable: true, get: function () { return Range_js_1.Range; } });
+var RangeInclusive_js_1 = require("./RangeInclusive.js");
+Object.defineProperty(exports, "RangeInclusive", { enumerable: true, get: function () { return RangeInclusive_js_1.RangeInclusive; } });
+var Type_js_1 = require("./Type.js");
+Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return Type_js_1.Type; } });
+var U8aFixed_js_1 = require("./U8aFixed.js");
+Object.defineProperty(exports, "U8aFixed", { enumerable: true, get: function () { return U8aFixed_js_1.U8aFixed; } });
+var WrapperKeepOpaque_js_1 = require("./WrapperKeepOpaque.js");
+Object.defineProperty(exports, "WrapperKeepOpaque", { enumerable: true, get: function () { return WrapperKeepOpaque_js_1.WrapperKeepOpaque; } });
+var WrapperOpaque_js_1 = require("./WrapperOpaque.js");
+Object.defineProperty(exports, "WrapperOpaque", { enumerable: true, get: function () { return WrapperOpaque_js_1.WrapperOpaque; } });

package/cjs/index.d.ts

@@ -0,0 +1,2 @@
+import './packageDetect.js';
+export * from './bundle.js';

package/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+require("./packageDetect.js");
+tslib_1.__exportStar(require("./bundle.js"), exports);

package/cjs/native/Bool.d.ts

@@ -0,0 +1,71 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyBool, Codec, Inspect, IU8a, Registry } from '../types/index.js';
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+export declare class bool extends Boolean implements Codec {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: bool | AnyBool | Uint8Array | 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 Checks if the value is an empty value (true when it wraps false/default)
+     */
+    get isEmpty(): boolean;
+    /**
+     * @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 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(): boolean;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): boolean;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): boolean;
+    /**
+     * @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;
+}