@pezkuwi/types-codec 16.5.17 → 16.5.18

package/src/extended/WrapperOpaque.ts

@@ -0,0 +1,27 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Codec, CodecClass, Registry } from '../types/index.js';
+
+import { WrapperKeepOpaque } from './WrapperKeepOpaque.js';
+
+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/src/extended/index.ts

@@ -0,0 +1,17 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+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/src/index.ts

@@ -0,0 +1,6 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import './packageDetect.js';
+
+export * from './bundle.js';

package/src/mod.ts

@@ -0,0 +1,4 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+export * from './index.js';

package/src/native/Bool.spec.ts

@@ -0,0 +1,74 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { CodecTo } from '@pezkuwi/types-codec/types';
+
+import { TypeRegistry } from '@pezkuwi/types';
+import { Bool } from '@pezkuwi/types-codec';
+
+describe('Bool', (): void => {
+  const registry = new TypeRegistry();
+
+  describe('decode', (): void => {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    const testDecode = (type: string, input: Uint8Array | boolean | Boolean | Bool | number, expected: boolean): void =>
+      it(`can decode from ${type}`, (): void => {
+        expect(new Bool(registry, input).toJSON()).toBe(expected);
+      });
+
+    testDecode('Bool', new Bool(registry, true), true);
+    testDecode('Boolean', Boolean(true), true);
+    testDecode('boolean', true, true);
+    testDecode('number', 1, true);
+    testDecode('Uint8Array', Uint8Array.from([1]), true);
+  });
+
+  describe('encode', (): void => {
+    const testEncode = (to: CodecTo, expected: string | Uint8Array | boolean, value: boolean): void =>
+      it(`can encode ${to}`, (): void => {
+        expect(new Bool(registry, value)[to]()).toEqual(expected);
+      });
+
+    testEncode('toJSON', true, true);
+    testEncode('toHex', '0x01', true);
+    testEncode('toString', 'true', true);
+    testEncode('toU8a', Uint8Array.from([1]), true);
+    testEncode('toU8a', Uint8Array.from([0]), false);
+  });
+
+  it('correctly encodes length', (): void => {
+    expect(new Bool(registry, true).encodedLength).toEqual(1);
+  });
+
+  describe('utils', (): void => {
+    it('compares against a boolean', (): void => {
+      expect(new Bool(registry, true).eq(true)).toBe(true);
+    });
+
+    it('compares against a Bool', (): void => {
+      expect(new Bool(registry, false).eq(new Bool(registry, false))).toBe(true);
+    });
+
+    it('has isTrue', (): void => {
+      expect(new Bool(registry, true).isTrue).toBe(true);
+    });
+
+    it('has isFalse', (): void => {
+      expect(new Bool(registry, true).isFalse).toBe(false);
+    });
+
+    it('has sane isEmpty aligning with the rest', (): void => {
+      expect(new Bool(registry).isEmpty).toBe(true);
+      expect(new Bool(registry, false).isEmpty).toBe(true);
+      expect(new Bool(registry, true).isEmpty).toBe(false);
+    });
+
+    it('has a sane inspect', (): void => {
+      expect(new Bool(registry, true).inspect()).toEqual({
+        outer: [new Uint8Array([1])]
+      });
+    });
+  });
+});

package/src/native/Bool.ts

@@ -0,0 +1,137 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyBool, Codec, Inspect, IU8a, Registry } from '../types/index.js';
+
+import { isU8a, u8aToHex } from '@pezkuwi/util';
+
+/**
+ * @name bool
+ * @description
+ * Representation for a boolean value in the system. It extends the base JS `Boolean` class
+ * @noInheritDoc
+ */
+export class bool extends Boolean implements Codec {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength = 1;
+  public isStorageFallback?: boolean;
+
+  constructor (registry: Registry, value: bool | AnyBool | Uint8Array | number = false) {
+    super(
+      isU8a(value)
+        ? value[0] === 1
+        : value instanceof Boolean
+          ? value.valueOf()
+          : !!value
+    );
+
+    this.registry = registry;
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public get encodedLength (): number {
+    return 1 | 0;
+  }
+
+  /**
+   * @description returns a hash of the contents
+   */
+  public get hash (): IU8a {
+    return this.registry.hash(this.toU8a());
+  }
+
+  /**
+   * @description Checks if the value is an empty value (true when it wraps false/default)
+   */
+  public get isEmpty (): boolean {
+    return this.isFalse;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isFalse (): boolean {
+    return !this.isTrue;
+  }
+
+  /**
+   * @description Checks if the value is an empty value (always false)
+   */
+  public get isTrue (): boolean {
+    return this.valueOf();
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return this.valueOf() === (
+      other instanceof Boolean
+        ? other.valueOf()
+        : other
+    );
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public inspect (): Inspect {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+
+  /**
+   * @description Returns a hex string representation of the value
+   */
+  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 (): boolean {
+    return this.toJSON();
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public toJSON (): boolean {
+    return this.valueOf();
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (): boolean {
+    return this.toJSON();
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return 'bool';
+  }
+
+  /**
+   * @description Returns the string representation of the value
+   */
+  public override toString (): string {
+    return this.toJSON().toString();
+  }
+
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    return new Uint8Array([this.valueOf() ? 1 : 0]);
+  }
+}

package/src/native/Date.spec.ts

@@ -0,0 +1,85 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import type { CodecTo } from '@pezkuwi/types-codec/types';
+
+import { TypeRegistry } from '@pezkuwi/types';
+import { CodecDate, U64 } from '@pezkuwi/types-codec';
+import { BN } from '@pezkuwi/util';
+
+describe('Date', (): void => {
+  const registry = new TypeRegistry();
+
+  describe('decode', (): void => {
+    const testDecode = (type: string, input: Date | CodecDate | U64 | number, expected: string | number, toJSON = false): void =>
+      it(`can decode from ${type}`, (): void => {
+        expect(new CodecDate(registry, input)[toJSON ? 'toJSON' : 'toISOString']()).toBe(expected);
+      });
+
+    testDecode('Date', new Date(1537968546280), '2018-09-26T13:29:06.280Z');
+    testDecode('CodecDate', new CodecDate(registry, 1234), 1234, true);
+    testDecode('number', 1234, 1234, true);
+    testDecode('U64', new U64(registry, 69), 69, true);
+  });
+
+  describe('encode', (): void => {
+    const testEncode = (to: 'toBigInt' | 'toBn' | 'toISOString' | 'toNumber' | CodecTo, expected: bigint | BN | number | string | Uint8Array): void =>
+      it(`can encode ${to}`, (): void => {
+        expect(new CodecDate(registry, 421)[to]()).toEqual(expected);
+      });
+
+    testEncode('toBigInt', 421n);
+    testEncode('toBn', new BN(421));
+    testEncode('toJSON', 421);
+    testEncode('toISOString', '1970-01-01T00:07:01.000Z');
+
+    testEncode('toNumber', 421);
+    testEncode('toU8a', Uint8Array.from([165, 1, 0, 0, 0, 0, 0, 0]));
+
+    it('can encode toString', (): void => {
+      const date = new Date(Date.UTC(1970, 0, 1, 2, 3, 4));
+
+      date.setTime(date.getTime() + date.getTimezoneOffset() * 60 * 1000);
+
+      expect(
+        new CodecDate(registry, date).toString()
+      ).toMatch(/^Thu Jan 01 1970 02:03:04/);
+    });
+
+    it('encodes default BE hex', (): void => {
+      expect(
+        new CodecDate(registry, 3).toHex()
+      ).toEqual('0x0000000000000003');
+    });
+
+    it('encodes options LE hex', (): void => {
+      expect(
+        new CodecDate(registry, 3).toHex(true)
+      ).toEqual('0x0300000000000000');
+    });
+
+    it('encodes correctly to BigInt', (): void => {
+      expect(
+        new CodecDate(registry, 41).toBigInt() + 1n
+      ).toEqual(42n);
+    });
+  });
+
+  describe('utils', (): void => {
+    it('compares values', (): void => {
+      expect(new CodecDate(registry, 123).eq(123)).toBe(true);
+    });
+
+    it('compares values (non-match)', (): void => {
+      expect(new CodecDate(registry, 123).eq(456)).toBe(false);
+    });
+
+    it('has a sane inspect', (): void => {
+      expect(new CodecDate(registry, 3).inspect()).toEqual({
+        outer: [new Uint8Array([3, 0, 0, 0, 0, 0, 0, 0])]
+      });
+    });
+  });
+});

package/src/native/Date.ts

@@ -0,0 +1,169 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { HexString } from '@pezkuwi/util/types';
+import type { AnyNumber, Inspect, INumber, IU8a, Registry, UIntBitLength } from '../types/index.js';
+
+import { BN, bnToBn, bnToHex, bnToU8a, isString, isU8a, u8aToBn } from '@pezkuwi/util';
+
+const BITLENGTH: UIntBitLength = 64;
+const U8A_OPTS = { bitLength: BITLENGTH, isLe: true };
+
+function decodeDate (value: CodecDate | Date | AnyNumber): Date {
+  if (isU8a(value)) {
+    value = u8aToBn(value.subarray(0, BITLENGTH / 8));
+  } else if (value instanceof Date) {
+    return value;
+  } else if (isString(value)) {
+    value = new BN(value.toString(), 10, 'le');
+  }
+
+  return new Date(
+    bnToBn(value as BN).toNumber() * 1000
+  );
+}
+
+/**
+ * @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 class CodecDate extends Date implements INumber {
+  readonly registry: Registry;
+
+  public createdAtHash?: IU8a;
+  public initialU8aLength = BITLENGTH / 8;
+  public isStorageFallback?: boolean;
+
+  constructor (registry: Registry, value: CodecDate | Date | AnyNumber = 0) {
+    super(decodeDate(value));
+
+    this.registry = registry;
+  }
+
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+  public get encodedLength (): number {
+    return BITLENGTH / 8;
+  }
+
+  /**
+   * @description returns a hash of the contents
+   */
+  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.getTime() === 0;
+  }
+
+  /**
+   * @description Returns the number of bits in the value
+   */
+  public bitLength (): UIntBitLength {
+    return BITLENGTH;
+  }
+
+  /**
+   * @description Compares the value of the input to see if there is a match
+   */
+  public eq (other?: unknown): boolean {
+    return decodeDate(other as AnyNumber).getTime() === this.getTime();
+  }
+
+  /**
+   * @description Returns a breakdown of the hex encoding for this Codec
+   */
+  public inspect (): Inspect {
+    return {
+      outer: [this.toU8a()]
+    };
+  }
+
+  /**
+   * @description Returns a BigInt representation of the number
+   */
+  public toBigInt (): bigint {
+    return BigInt(this.toNumber());
+  }
+
+  /**
+   * @description Returns the BN representation of the timestamp
+   */
+  public toBn (): BN {
+    return new BN(this.toNumber());
+  }
+
+  /**
+   * @description Returns a hex string representation of the value
+   */
+  public toHex (isLe = false): HexString {
+    return bnToHex(this.toBn(), {
+      bitLength: BITLENGTH,
+      isLe,
+      isNegative: false
+    });
+  }
+
+  /**
+   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+   */
+  public toHuman (): string {
+    return this.toISOString();
+  }
+
+  /**
+   * @description Converts the Object to JSON, typically used for RPC transfers
+   */
+  public override toJSON (): any {
+    // FIXME Return type should be number, but conflicts with Date.toJSON()
+    // which returns string
+    return this.toNumber();
+  }
+
+  /**
+   * @description Returns the number representation for the timestamp
+   */
+  public toNumber (): number {
+    return Math.ceil(this.getTime() / 1000);
+  }
+
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+  public toPrimitive (): number {
+    return this.toNumber();
+  }
+
+  /**
+   * @description Returns the base runtime type name for this instance
+   */
+  public toRawType (): string {
+    return 'Moment';
+  }
+
+  /**
+   * @description Returns the string representation of the value
+   */
+  public override toString (): string {
+    // only included here since we do not inherit docs
+    return super.toString();
+  }
+
+  /**
+   * @description Encodes the value as a Uint8Array as per the SCALE specifications
+   */
+  public toU8a (_isBare?: boolean): Uint8Array {
+    return bnToU8a(this.toNumber(), U8A_OPTS);
+  }
+}

package/src/native/Float.spec.ts

@@ -0,0 +1,51 @@
+// Copyright 2017-2025 @pezkuwi/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/// <reference types="@pezkuwi/dev-test/globals.d.ts" />
+
+import { TypeRegistry } from '@pezkuwi/types';
+import { F32, F64 } from '@pezkuwi/types-codec';
+
+describe('Float', (): void => {
+  const registry = new TypeRegistry();
+
+  describe('F32', (): void => {
+    it('has a sane toRawType()', (): void => {
+      expect(
+        new F32(registry).toRawType()
+      ).toEqual('f32');
+    });
+
+    it('constructs from Uint8Array', (): void => {
+      expect(
+        new F32(registry, new Uint8Array([0, 0, 0, 128])).toNumber()
+      ).toEqual(-0.0);
+    });
+
+    it('triggers isEmpty on 0', (): void => {
+      expect(
+        new F32(registry, 0).isEmpty
+      ).toEqual(true);
+    });
+
+    it('constructs from a float value', (): void => {
+      expect(
+        new F32(registry, 123.456).toString()
+      ).toEqual('123.456');
+    });
+  });
+
+  describe('F64', (): void => {
+    it('has a sane toRawType()', (): void => {
+      expect(
+        new F64(registry).toRawType()
+      ).toEqual('f64');
+    });
+
+    it('constructs from hex', (): void => {
+      expect(
+        new F64(registry, '0x0000000000000080').toNumber()
+      ).toEqual(-0.0);
+    });
+  });
+});