@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-tsc/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;
+}

package/build-tsc/native/Date.d.ts

@@ -0,0 +1,84 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyNumber, Inspect, INumber, IU8a, Registry, UIntBitLength } from '../types/index.js';
+import { BN } from '@pezkuwi/util';
+/**
+ * @name Date
+ * @description
+ * A wrapper around seconds/timestamps. Internally the representation only has
+ * second precicion (aligning with Rust), so any numbers passed an/out are always
+ * per-second. For any encoding/decoding the 1000 multiplier would be applied to
+ * get it in line with JavaScript formats. It extends the base JS `Date` object
+ * and has all the methods available that are applicable to any `Date`
+ * @noInheritDoc
+ */
+export declare class CodecDate extends Date implements INumber {
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: CodecDate | Date | AnyNumber);
+    /**
+     * @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
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description Returns the number of bits in the value
+     */
+    bitLength(): UIntBitLength;
+    /**
+     * @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 BigInt representation of the number
+     */
+    toBigInt(): bigint;
+    /**
+     * @description Returns the BN representation of the timestamp
+     */
+    toBn(): BN;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(isLe?: boolean): 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(): any;
+    /**
+     * @description Returns the number representation for the timestamp
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): number;
+    /**
+     * @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;
+}

package/build-tsc/native/Float.d.ts

@@ -0,0 +1,68 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyFloat, CodecClass, IFloat, Inspect, IU8a, Registry } from '../types/index.js';
+interface Options {
+    bitLength?: 32 | 64;
+}
+/**
+ * @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 declare class Float extends Number implements IFloat {
+    #private;
+    readonly encodedLength: number;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: AnyFloat, { bitLength }?: Options);
+    static with(bitLength: 32 | 64): CodecClass<Float>;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Returns true if the type wraps an empty/default all-0 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
+     */
+    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 Returns the number representation (Same as valueOf)
+     */
+    toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): number;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Encodes the value as a Uint8Array as per the SCALE specifications
+     */
+    toU8a(_isBare?: boolean): Uint8Array;
+}
+export {};

package/build-tsc/native/Json.d.ts

@@ -0,0 +1,69 @@
+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-tsc/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/build-tsc/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/build-tsc/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 {};

package/build-tsc/native/Text.d.ts

@@ -0,0 +1,77 @@
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyString, AnyU8a, Inspect, IText, IU8a, Registry } from '../types/index.js';
+/**
+ * @name Text
+ * @description
+ * This is a string wrapper, along with the length. It is used both for strings as well
+ * as items such as documentation. It simply extends the standard JS `String` built-in
+ * object, inheriting all methods exposed from `String`.
+ * @noInheritDoc
+ */
+export declare class Text extends String implements IText {
+    #private;
+    readonly registry: Registry;
+    createdAtHash?: IU8a;
+    initialU8aLength?: number;
+    isStorageFallback?: boolean;
+    constructor(registry: Registry, value?: null | AnyString | AnyU8a | {
+        toString: () => string;
+    });
+    /**
+     * @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
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): 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 Set an override value for this
+     */
+    setOverride(override: string): void;
+    /**
+     * @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 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
+     * @param isBare true when the value has none of the type-specific prefixes (internal)
+     */
+    toU8a(isBare?: boolean): Uint8Array;
+}

package/build-tsc/native/index.d.ts

@@ -0,0 +1,8 @@
+export { bool as Bool, bool } from './Bool.js';
+export { CodecDate, CodecDate as Date } from './Date.js';
+export { Float } from './Float.js';
+export { Json } from './Json.js';
+export { Raw } from './Raw.js';
+export { CodecSet, CodecSet as Set } from './Set.js';
+export { Struct } from './Struct.js';
+export { Text } from './Text.js';

package/build-tsc/packageDetect.d.ts

@@ -0,0 +1 @@
+export {};

package/build-tsc/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/build-tsc/primitive/F32.d.ts

@@ -0,0 +1,11 @@
+import { Float } from '../native/Float.js';
+declare const f32_base: import("../types/codec.js").CodecClass<Float, any[]>;
+/**
+ * @name f32
+ * @description
+ * A 32-bit float
+ */
+export declare class f32 extends f32_base {
+    readonly __FloatType = "f32";
+}
+export {};