@polkadot/types-codec 8.5.1 → 8.5.2-2

package/base/Option.d.ts

@@ -41,7 +41,7 @@ export declare class Option<T extends Codec> implements IOption<T> {
     /**
      * @description The actual value for the Option
      */
-    get value(): Codec;
+    get value(): T;
     /**
      * @description Compares the value of the input to see if there is a match
      */

package/cjs/extended/OptionBool.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.OptionBool = void 0;
+
+var _util = require("@polkadot/util");
+
+var _Option = require("../base/Option");
+
+var _Bool = require("../native/Bool");
+
+// Copyright 2017-2022 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+function decodeU8a(registry, value) {
+  // Encoded as -
+  //  - 0 = None
+  //  - 1 = True
+  //  - 2 = False
+  return value[0] === 0 ? null : new _Bool.bool(registry, value[0] === 1);
+}
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+
+
+class OptionBool extends _Option.Option {
+  constructor(registry, value) {
+    super(registry, _Bool.bool, (0, _util.isU8a)(value) || (0, _util.isHex)(value) ? decodeU8a(registry, (0, _util.u8aToU8a)(value)) : value);
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 1;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return 1;
+  }
+  /**
+   * @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/index.js

@@ -51,6 +51,12 @@ Object.defineProperty(exports, "Map", {
     return _Map.CodecMap;
   }
 });
+Object.defineProperty(exports, "OptionBool", {
+  enumerable: true,
+  get: function () {
+    return _OptionBool.OptionBool;
+  }
+});
 Object.defineProperty(exports, "Range", {
   enumerable: true,
   get: function () {
@@ -102,6 +108,8 @@ var _Linkage = require("./Linkage");
 
 var _Map = require("./Map");
 
+var _OptionBool = require("./OptionBool");
+
 var _Range = require("./Range");
 
 var _RangeInclusive = require("./RangeInclusive");

package/cjs/native/Bool.js

@@ -17,7 +17,6 @@ var _util = require("@polkadot/util");
  * @noInheritDoc
  */
 class bool extends Boolean {
-  // eslint-disable-next-line @typescript-eslint/ban-types
   constructor(registry) {
     let value = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     super((0, _util.isU8a)(value) ? value[0] === 1 : value instanceof Boolean ? value.valueOf() : !!value);

package/cjs/packageInfo.js

@@ -11,6 +11,6 @@ const packageInfo = {
   name: '@polkadot/types-codec',
   path: typeof __dirname === 'string' ? __dirname : 'auto',
   type: 'cjs',
-  version: '8.5.1'
+  version: '8.5.2-2'
 };
 exports.packageInfo = packageInfo;

package/extended/OptionBool.d.ts

@@ -0,0 +1,40 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyBool, Inspect, Registry } from '../types';
+import { Option } from '../base/Option';
+import { bool as Bool } from '../native/Bool';
+/**
+ * @name OptionBool
+ * @description A specific implementation of Option<bool> than allows for single-byte encoding
+ */
+export declare class OptionBool extends Option<Bool> {
+    constructor(registry: Registry, value?: Option<Bool> | AnyBool | Uint8Array | HexString | null);
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength(): number;
+    /**
+     * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+     */
+    get initialU8aLength(): number;
+    /**
+     * @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 Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect(): Inspect;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(isBare?: boolean): 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/extended/OptionBool.js

@@ -0,0 +1,88 @@
+// Copyright 2017-2022 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { isHex, isU8a, u8aToU8a } from '@polkadot/util';
+import { Option } from "../base/Option.js";
+import { bool as Bool } from "../native/Bool.js";
+
+function decodeU8a(registry, value) {
+  // 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 {
+  constructor(registry, value) {
+    super(registry, Bool, isU8a(value) || isHex(value) ? decodeU8a(registry, u8aToU8a(value)) : value);
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return 1;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return 1;
+  }
+  /**
+   * @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]);
+  }
+
+}

package/extended/index.d.ts

@@ -5,6 +5,7 @@ export { Bytes } from './Bytes';
 export { HashMap } from './HashMap';
 export { Linkage } from './Linkage';
 export { CodecMap, CodecMap as Map } from './Map';
+export { OptionBool } from './OptionBool';
 export { Range } from './Range';
 export { RangeInclusive } from './RangeInclusive';
 export { Type } from './Type';

package/extended/index.js

@@ -7,6 +7,7 @@ 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";

package/native/Bool.d.ts

@@ -1,5 +1,5 @@
 import type { HexString } from '@polkadot/util/types';
-import type { Codec, Inspect, IU8a, Registry } from '../types';
+import type { AnyBool, Codec, Inspect, IU8a, Registry } from '../types';
 /**
  * @name bool
  * @description
@@ -9,7 +9,7 @@ import type { Codec, Inspect, IU8a, Registry } from '../types';
 export declare class bool extends Boolean implements Codec {
     readonly registry: Registry;
     createdAtHash?: IU8a;
-    constructor(registry: Registry, value?: bool | Boolean | Uint8Array | boolean | number);
+    constructor(registry: Registry, value?: bool | AnyBool | Uint8Array | number);
     /**
      * @description The length of the value when encoded as a Uint8Array
      */

package/native/Bool.js

@@ -9,7 +9,6 @@ import { isU8a, u8aToHex } from '@polkadot/util';
  */
 
 export class bool extends Boolean {
-  // eslint-disable-next-line @typescript-eslint/ban-types
   constructor(registry, value = false) {
     super(isU8a(value) ? value[0] === 1 : value instanceof Boolean ? value.valueOf() : !!value);
     this.registry = registry;

package/package.json

@@ -20,7 +20,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "8.5.1",
+  "version": "8.5.2-2",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -172,6 +172,11 @@
       "require": "./cjs/extended/Map.js",
       "default": "./extended/Map.js"
     },
+    "./extended/OptionBool": {
+      "types": "./extended/OptionBool.d.ts",
+      "require": "./cjs/extended/OptionBool.js",
+      "default": "./extended/OptionBool.js"
+    },
     "./extended/Range": {
       "types": "./extended/Range.d.ts",
       "require": "./cjs/extended/Range.js",

package/packageInfo.js

@@ -5,5 +5,5 @@ export const packageInfo = {
   name: '@polkadot/types-codec',
   path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto',
   type: 'esm',
-  version: '8.5.1'
+  version: '8.5.2-2'
 };

package/types/helpers.d.ts

@@ -6,7 +6,8 @@ export declare type AnyJson = string | number | boolean | null | undefined | Any
 };
 export declare type AnyFunction = (...args: any[]) => any;
 export declare type AnyNumber = BN | bigint | Uint8Array | number | string;
-export declare type AnyString = string | string;
+export declare type AnyString = String | string;
+export declare type AnyBool = Boolean | boolean;
 export declare type AnyTuple = Codec[];
 export declare type AnyU8a = Uint8Array | number[] | string;
 export declare type UIntBitLength = 8 | 16 | 32 | 64 | 128 | 256;