@pezkuwi/types-codec 16.5.5 → 16.5.8

package/cjs/native/Raw.d.ts

@@ -0,0 +1,87 @@
+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/cjs/native/Raw.js

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Raw = void 0;
+const util_1 = require("@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
+ */
+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((0, util_1.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 (0, util_1.isAscii)(this);
+    }
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 value
+     */
+    get isEmpty() {
+        return !this.length || (0, util_1.isUndefined)(this.find((b) => !!b));
+    }
+    /**
+     * @description Returns true if the wrapped value contains only utf8 characters
+     */
+    get isUtf8() {
+        return (0, util_1.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((0, util_1.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 (0, util_1.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 ((0, util_1.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 (0, util_1.u8aToString)(this);
+    }
+}
+exports.Raw = Raw;

package/cjs/native/Set.d.ts

@@ -0,0 +1,84 @@
+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/cjs/native/Set.js

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodecSet = void 0;
+const util_1 = require("@pezkuwi/util");
+const index_js_1 = require("../utils/index.js");
+function encodeSet(setValues, values) {
+    const encoded = new util_1.BN(0);
+    for (let i = 0, count = values.length; i < count; i++) {
+        encoded.ior((0, util_1.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 ((0, util_1.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 = (0, util_1.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((0, util_1.bnToBn)(setValues[key])).eq((0, util_1.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 ((0, util_1.isU8a)(value)) {
+        return value.length === 0
+            ? []
+            : decodeSetNumber(setValues, (0, util_1.u8aToBn)(value.subarray(0, byteLength), { isLe: true }));
+    }
+    else if ((0, util_1.isString)(value)) {
+        return decodeSet(setValues, (0, util_1.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.
+ */
+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${(0, util_1.stringPascalCase)(keys[i])}`;
+                }
+                (0, util_1.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 && (0, util_1.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 (0, index_js_1.compareArray)(this.strings.sort(), other.sort());
+        }
+        else if (other instanceof Set) {
+            return this.eq([...other.values()]);
+        }
+        else if ((0, util_1.isNumber)(other) || (0, util_1.isBn)(other)) {
+            return this.valueEncoded.eq((0, util_1.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 (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() {
+        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 (0, util_1.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 (0, util_1.bnToU8a)(this.valueEncoded, {
+            bitLength: this.#byteLength * 8,
+            isLe: true
+        });
+    }
+}
+exports.CodecSet = CodecSet;

package/cjs/native/Struct.d.ts

@@ -0,0 +1,106 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyJson, BareOpts, Codec, CodecClass, DefinitionSetter, Inspect, IStruct, IU8a, Registry } from '../types/index.js';
+type TypesDef<T = Codec> = Record<string, string | CodecClass<T>>;
+type Definition = [CodecClass[], string[]];
+/**
+ * @name Struct
+ * @description
+ * A Struct defines an Object with key-value pairs - where the values are Codec values. It removes
+ * a lot of repetition from the actual coding, define a structure type, pass it the key/Codec
+ * values in the constructor and it manages the decoding. It is important that the constructor
+ * values matches 100% to the order in th Rust code, i.e. don't go crazy and make it alphabetical,
+ * it needs to decoded in the specific defined order.
+ * @noInheritDoc
+ */
+export declare class Struct<S extends TypesDef = TypesDef, V extends {
+    [K in keyof S]: any;
+} = {
+    [K in keyof S]: any;
+}, E extends {
+    [K in keyof S]: string;
+} = {
+    [K in keyof S]: string;
+}> extends Map<keyof S, Codec> implements IStruct<keyof S> {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a | undefined;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, Types: S, value?: V | Map<unknown, unknown> | unknown[] | HexString | null, jsonMap?: Map<string, string>, { definition, setDefinition }?: DefinitionSetter<Definition>);
+    static with<S extends TypesDef>(Types: S, jsonMap?: Map<string, string>): CodecClass<Struct<S>>;
+    /**
+     * @description The available keys for this struct
+     */
+    get defKeys(): string[];
+    /**
+     * @description Checks if the value is an empty value '{}'
+     */
+    get isEmpty(): boolean;
+    /**
+     * @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 the Type description of the structure
+     */
+    get Type(): E;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Returns a specific names entry in the structure
+     * @param key The name of the entry to retrieve
+     */
+    get(key: keyof S): Codec | undefined;
+    /**
+     * @description Returns the values of a member at a specific index (Rather use get(name) for performance)
+     */
+    getAtIndex(index: number): Codec;
+    /**
+     * @description Returns the a types value by name
+     */
+    getT<T = Codec>(key: string): T;
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(isBare?: BareOpts): Inspect;
+    /**
+     * @description Converts the Object to an standard JavaScript Array
+     */
+    toArray(): Codec[];
+    /**
+     * @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): 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 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?: BareOpts): Uint8Array;
+}
+export {};