@pezkuwi/types-codec 16.5.6 → 16.5.8

package/build-deno/extended/Map.ts

@@ -0,0 +1,253 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyJson, Codec, CodecClass, IMap, Inspect, IU8a, Registry } from '../types/index.ts';
+
+import { compactFromU8aLim, compactToU8a, isHex, isObject, isU8a, logger, stringify, u8aConcatStrict, u8aToHex, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { AbstractArray } from '../abstract/Array.ts';
+import { Enum } from '../base/Enum.ts';
+import { Raw } from '../native/Raw.ts';
+import { Struct } from '../native/Struct.ts';
+import { compareMap, decodeU8a, sortMap, typeToConstructor } from '../utils/index.ts';
+
+const l = logger('Map');
+
+/** @internal */
+function decodeMapFromU8a<K extends Codec, V extends Codec> (registry: Registry, KeyClass: CodecClass<K>, ValClass: CodecClass<V>, u8a: Uint8Array): [CodecClass<K>, CodecClass<V>, Map<K, V>, number] {
+  const output = new Map<K, V>();
+  const [offset, count] = compactFromU8aLim(u8a);
+  const types = [];
+
+  for (let i = 0; i < count; i++) {
+    types.push(KeyClass, ValClass);
+  }
+
+  const [values, decodedLength] = 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] as K, values[i + 1] as V);
+  }
+
+  return [KeyClass, ValClass, output, offset + decodedLength];
+}
+
+/** @internal */
+function decodeMapFromMap<K extends Codec, V extends Codec> (registry: Registry, KeyClass: CodecClass<K>, ValClass: CodecClass<V>, value: Map<any, any>): [CodecClass<K>, CodecClass<V>, Map<K, V>, number] {
+  const output = new Map<K, V>();
+
+  for (const [key, val] of value.entries()) {
+    const isComplex = KeyClass.prototype instanceof AbstractArray ||
+      KeyClass.prototype instanceof Struct ||
+      KeyClass.prototype instanceof 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 as 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<K extends Codec, V extends Codec> (registry: Registry, keyType: CodecClass<K> | string, valType: CodecClass<V> | string, value?: Uint8Array | string | Map<any, any>): [CodecClass<K>, CodecClass<V>, Map<K, V>, number] {
+  const KeyClass = typeToConstructor(registry, keyType);
+  const ValClass = typeToConstructor(registry, valType);
+
+  if (!value) {
+    return [KeyClass, ValClass, new Map<K, V>(), 0];
+  } else if (isU8a(value) || isHex(value)) {
+    return decodeMapFromU8a<K, V>(registry, KeyClass, ValClass, u8aToU8a(value));
+  } else if (value instanceof Map) {
+    return decodeMapFromMap<K, V>(registry, KeyClass, ValClass, value);
+  } else if (isObject(value)) {
+    return decodeMapFromMap<K, V>(registry, KeyClass, ValClass, new Map(Object.entries(value)));
+  }
+
+  throw new Error('Map: cannot decode type');
+}
+
+export class CodecMap<K extends Codec = Codec, V extends Codec = Codec> extends Map<K, V> implements IMap<K, V> {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength?: number;
+  public isStorageFallback?: boolean;
+
+  readonly #KeyClass: CodecClass<K>;
+  readonly #ValClass: CodecClass<V>;
+  readonly #type: string;
+
+  constructor (registry: Registry, keyType: CodecClass<K> | string, valType: CodecClass<V> | string, rawValue: Uint8Array | string | Map<any, any> | undefined, type: 'BTreeMap' | 'HashMap' = 'HashMap') {
+    const [KeyClass, ValClass, decoded, decodedLength] = decodeMap(registry, keyType, valType, rawValue);
+
+    super(type === 'BTreeMap' ? 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
+   */
+  public get encodedLength (): number {
+    let len = 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
+   */
+  public get hash (): IU8a {
+    return this.registry.hash(this.toU8a());
+  }
+
+  /**
+   * @description Checks if the value is an empty value
+   */
+  public get isEmpty (): boolean {
+    return this.size === 0;
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return compareMap(this, other);
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public inspect (): Inspect {
+    const inner: Inspect[] = [];
+
+    for (const [k, v] of this.entries()) {
+      inner.push(k.inspect());
+      inner.push(v.inspect());
+    }
+
+    return {
+      inner,
+      outer: [compactToU8a(this.size)]
+    };
+  }
+
+  /**
+   * @description Returns a hex string representation of the value. isLe returns a LE (number-only) representation
+   */
+  public toHex (): HexString {
+    return u8aToHex(this.toU8a());
+  }
+
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+  public toHuman (isExtended?: boolean, disableAscii?: boolean): Record<string, AnyJson> {
+    const json: Record<string, AnyJson> = {};
+
+    for (const [k, v] of this.entries()) {
+      json[
+        k instanceof 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
+   */
+  public toJSON (): Record<string, AnyJson> {
+    const json: Record<string, AnyJson> = {};
+
+    for (const [k, v] of this.entries()) {
+      json[k.toString()] = v.toJSON();
+    }
+
+    return json;
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (disableAscii?: boolean): AnyJson {
+    const json: Record<string, AnyJson> = {};
+
+    for (const [k, v] of this.entries()) {
+      json[
+        k instanceof Raw && !disableAscii && k.isAscii
+          ? k.toUtf8()
+          : k.toString()
+      ] = v.toPrimitive(disableAscii);
+    }
+
+    return json;
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    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
+   */
+  public override toString (): string {
+    return 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)
+   */
+  public toU8a (isBare?: boolean): Uint8Array {
+    const encoded: Uint8Array[] = [];
+
+    if (!isBare) {
+      encoded.push(compactToU8a(this.size));
+    }
+
+    for (const [k, v] of this.entries()) {
+      encoded.push(k.toU8a(isBare), v.toU8a(isBare));
+    }
+
+    return u8aConcatStrict(encoded);
+  }
+}

package/build-deno/extended/OptionBool.ts

@@ -0,0 +1,91 @@
+
+import type { HexString } from 'https://deno.land/x/pezkuwi/util/types.ts';
+import type { AnyBool, Inspect, Registry } from '../types/index.ts';
+
+import { isHex, isU8a, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { Option } from '../base/Option.ts';
+import { bool as Bool } from '../native/Bool.ts';
+
+function decodeU8a (registry: Registry, value: Uint8Array): null | Bool {
+  // Encoded as -
+  //  - 0 = None
+  //  - 1 = True
+  //  - 2 = False
+  return value[0] === 0
+    ? null
+    : new Bool(registry, value[0] === 1);
+}
+
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+export class OptionBool extends Option<Bool> {
+  constructor (registry: Registry, value?: Option<Bool> | AnyBool | Uint8Array | HexString | null) {
+    super(
+      registry,
+      Bool,
+      isU8a(value) || isHex(value)
+        ? decodeU8a(registry, u8aToU8a(value))
+        : value
+    );
+
+    this.initialU8aLength = 1;
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public override get encodedLength (): number {
+    return 1 | 0;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isFalse (): boolean {
+    return this.isSome
+      ? !this.value.valueOf()
+      : false;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isTrue (): boolean {
+    return this.isSome
+      ? this.value.valueOf()
+      : false;
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public override inspect (): Inspect {
+    return { outer: [this.toU8a()] };
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public override toRawType (isBare?: boolean): string {
+    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)
+   */
+  public override toU8a (isBare?: boolean): Uint8Array {
+    if (isBare) {
+      return super.toU8a(true);
+    }
+
+    return this.isSome
+      ? new Uint8Array([this.isTrue ? 1 : 2])
+      : new Uint8Array([0]);
+  }
+}

package/build-deno/extended/Range.ts

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

package/build-deno/extended/RangeInclusive.ts

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

package/build-deno/extended/Type.ts

@@ -0,0 +1,27 @@
+
+import type { Registry } from '../types/index.ts';
+
+import { Text } from '../native/Text.ts';
+import { sanitize } from '../utils/index.ts';
+
+/**
+ * @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 class Type extends Text {
+  constructor (registry: Registry, value: Text | Uint8Array | string = '') {
+    super(registry, value);
+
+    this.setOverride(sanitize(this.toString()));
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public override toRawType (): string {
+    return 'Type';
+  }
+}

package/build-deno/extended/U8aFixed.ts

@@ -0,0 +1,55 @@
+
+import type { AnyU8a, CodecClass, Registry, U8aBitLength } from '../types/index.ts';
+
+import { isU8a, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { Raw } from '../native/Raw.ts';
+
+/** @internal */
+function decodeU8aFixed (value: AnyU8a, bitLength: U8aBitLength): [AnyU8a, number] {
+  const u8a = u8aToU8a(value);
+  const byteLength = bitLength / 8;
+
+  if (!u8a.length) {
+    return [new Uint8Array(byteLength), 0];
+  }
+
+  if (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.
+ */
+export class U8aFixed extends Raw {
+  constructor (registry: Registry, value: AnyU8a = new Uint8Array(), bitLength: U8aBitLength = 256) {
+    const [u8a, decodedLength] = decodeU8aFixed(value, bitLength);
+
+    super(registry, u8a, decodedLength);
+  }
+
+  public static with (bitLength: U8aBitLength, typeName?: string): CodecClass<U8aFixed> {
+    return class extends U8aFixed {
+      constructor (registry: Registry, value?: AnyU8a) {
+        super(registry, value, bitLength);
+      }
+
+      public override toRawType (): string {
+        return typeName || super.toRawType();
+      }
+    };
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public override toRawType (): string {
+    return `[u8;${this.length}]`;
+  }
+}

package/build-deno/extended/WrapperKeepOpaque.ts

@@ -0,0 +1,126 @@
+
+import type { AnyJson, AnyU8a, Codec, CodecClass, Inspect, Registry } from '../types/index.ts';
+
+import { compactAddLength, compactStripLength, compactToU8a, isHex, isU8a, u8aToU8a } from 'https://deno.land/x/pezkuwi/util/mod.ts';
+
+import { Raw } from '../native/Raw.ts';
+import { typeToConstructor } from '../utils/index.ts';
+import { Bytes } from './Bytes.ts';
+
+type OpaqueName = 'WrapperKeepOpaque' | 'WrapperOpaque';
+
+interface Options {
+  opaqueName?: OpaqueName;
+}
+
+function decodeRaw<T extends Codec> (registry: Registry, typeName: CodecClass<T> | string, value?: unknown): [CodecClass<T>, T | null, AnyU8a] {
+  const Type = typeToConstructor(registry, typeName);
+
+  if (isU8a(value) || isHex(value)) {
+    try {
+      const [, u8a] = isHex(value)
+        ? [0, u8aToU8a(value)]
+        : (value instanceof Raw)
+          ? [0, value.subarray()]
+          : compactStripLength(value);
+
+      return [Type, new Type(registry, u8a), value];
+    } catch {
+      return [Type, null, value];
+    }
+  }
+
+  const instance = new Type(registry, value);
+
+  return [Type, instance, compactAddLength(instance.toU8a())];
+}
+
+export class WrapperKeepOpaque<T extends Codec> extends Bytes {
+  readonly #Type: CodecClass<T>;
+  readonly #decoded: T | null;
+  readonly #opaqueName: OpaqueName;
+
+  constructor (registry: Registry, typeName: CodecClass<T> | string, value?: unknown, { opaqueName = 'WrapperKeepOpaque' }: Options = {}) {
+    const [Type, decoded, u8a] = decodeRaw(registry, typeName, value);
+
+    super(registry, u8a);
+
+    this.#Type = Type;
+    this.#decoded = decoded;
+    this.#opaqueName = opaqueName;
+  }
+
+  public static with<T extends Codec> (Type: CodecClass<T> | string): CodecClass<WrapperKeepOpaque<T>> {
+    return class extends WrapperKeepOpaque<T> {
+      constructor (registry: Registry, value?: AnyU8a | T) {
+        super(registry, Type, value);
+      }
+    };
+  }
+
+  /**
+   * @description Checks if the wrapper is decodable
+   */
+  public get isDecoded (): boolean {
+    return !!this.#decoded;
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public override inspect (): Inspect {
+    return this.#decoded
+      ? {
+        inner: [this.#decoded.inspect()],
+        outer: [compactToU8a(this.length)]
+      }
+      : {
+        outer: [compactToU8a(this.length), this.toU8a(true)]
+      };
+  }
+
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+  public override toHuman (isExtended?: boolean, disableAscii?: boolean): AnyJson {
+    return this.#decoded
+      ? this.#decoded.toHuman(isExtended, disableAscii)
+      : super.toHuman(isExtended, disableAscii);
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public override toPrimitive (disableAscii?: boolean): any {
+    return this.#decoded
+      ? this.#decoded.toPrimitive(disableAscii)
+      : super.toPrimitive(disableAscii);
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public override toRawType (): string {
+    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)
+   */
+  public override toString (): string {
+    return this.#decoded
+      ? this.#decoded.toString()
+      : super.toString();
+  }
+
+  /**
+   * @description Returns the decoded that the WrapperKeepOpaque represents (if available), throws if non-decodable
+   */
+  public unwrap (): T {
+    if (!this.#decoded) {
+      throw new Error(`${this.#opaqueName}: unwrapping an undecodable value`);
+    }
+
+    return this.#decoded;
+  }
+}

package/build-deno/extended/WrapperOpaque.ts

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

package/build-deno/extended/index.ts

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

package/build-deno/index.ts

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

package/build-deno/mod.ts

@@ -0,0 +1,2 @@
+
+export * from './index.ts';