@polkadot/types-codec 8.13.1 → 8.14.2-12

package/abstract/Array.d.ts

@@ -57,6 +57,10 @@ export declare abstract class AbstractArray<T extends Codec> extends Array<T> im
      * @description Converts the Object to JSON, typically used for RPC transfers
      */
     toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): AnyJson;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/abstract/Array.js

@@ -139,6 +139,20 @@ export class AbstractArray extends Array {
 
     return result;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    const result = new Array(this.length);
+
+    for (let i = 0; i < this.length; i++) {
+      result[i] = this[i] && this[i].toPrimitive();
+    }
+
+    return result;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/abstract/Base.d.ts

@@ -43,6 +43,10 @@ export declare abstract class AbstractBase<T extends Codec> implements Codec {
      * @description Converts the Object to JSON, typically used for RPC transfers
      */
     toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): AnyJson;
     /**
      * @description Returns the string representation of the value
      */

package/abstract/Base.js

@@ -81,6 +81,14 @@ export class AbstractBase {
   toJSON() {
     return this.#raw.toJSON();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the string representation of the value
    */

package/abstract/Int.d.ts

@@ -59,6 +59,10 @@ export declare abstract class AbstractInt extends BN implements INumber {
      * @description Converts the Object to JSON, typically used for RPC transfers
      */
     toJSON(onlyHex?: boolean): any;
+    /**
+     * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+     */
+    toPrimitive(): number | string;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/abstract/Int.js

@@ -194,6 +194,14 @@ export class AbstractInt extends BN {
     //   - this.#bitLength - the type bits (this should be used, however contracts RPC is problematic)
     return onlyHex || super.bitLength() > MAX_NUMBER_BITS ? this.toHex() : this.toNumber();
   }
+  /**
+   * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+   */
+
+
+  toPrimitive() {
+    return super.bitLength() > MAX_NUMBER_BITS ? this.toString() : this.toNumber();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/base/Compact.d.ts

@@ -69,6 +69,10 @@ export declare class Compact<T extends INumber> implements ICompact<T> {
      * @description Returns the number representation for the value
      */
     toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): string | number;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/base/Compact.js

@@ -158,6 +158,14 @@ export class Compact {
   toNumber() {
     return this.#raw.toNumber();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/base/DoNotConstruct.d.ts

@@ -28,6 +28,7 @@ export declare class DoNotConstruct implements Codec {
     toHex(): HexString;
     toHuman(): AnyJson;
     toJSON(): AnyJson;
+    toPrimitive(): AnyJson;
     toRawType(): string;
     toString(): string;
     toU8a(): Uint8Array;

package/base/DoNotConstruct.js

@@ -68,6 +68,10 @@ export class DoNotConstruct {
     throw this.#neverError;
   }
 
+  toPrimitive() {
+    throw this.#neverError;
+  }
+
   toRawType() {
     throw this.#neverError;
   }

package/base/Enum.d.ts

@@ -58,11 +58,6 @@ export declare class Enum implements IEnum {
      * @description Checks if the Enum points to a [[Null]] type
      */
     get isNone(): boolean;
-    /**
-     * @description Checks if the Enum points to a [[Null]] type
-     * @deprecated use isNone
-     */
-    get isNull(): boolean;
     /**
      * @description The available keys for this enum
      */
@@ -103,6 +98,10 @@ export declare class Enum implements IEnum {
      * @description Returns the number representation for the value
      */
     toNumber(): number;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): AnyJson;
     /**
      * @description Returns a raw struct representation of the enum types
      */

package/base/Enum.js

@@ -192,37 +192,40 @@ export class Enum {
   }
 
   static with(Types) {
-    const keys = Array.isArray(Types) ? Types : Object.keys(Types);
-    const asKeys = new Array(keys.length);
-    const isKeys = new Array(keys.length);
-
-    for (let i = 0; i < keys.length; i++) {
-      const name = stringPascalCase(keys[i]);
-      asKeys[i] = `as${name}`;
-      isKeys[i] = `is${name}`;
-    }
+    var _class;
 
     let definition; // eslint-disable-next-line no-return-assign
 
     const setDefinition = d => definition = d;
 
-    return class extends Enum {
+    return _class = class extends Enum {
       constructor(registry, value, index) {
         super(registry, Types, value, index, {
           definition,
           setDefinition
         });
-        objectProperties(this, isKeys, (_, i) => this.type === keys[i]);
-        objectProperties(this, asKeys, (k, i) => {
-          if (!this[isKeys[i]]) {
-            throw new Error(`Cannot convert '${this.type}' via ${k}`);
-          }
+      }
 
-          return this.value;
-        });
+    }, (() => {
+      const keys = Array.isArray(Types) ? Types : Object.keys(Types);
+      const asKeys = new Array(keys.length);
+      const isKeys = new Array(keys.length);
+
+      for (let i = 0; i < keys.length; i++) {
+        const name = stringPascalCase(keys[i]);
+        asKeys[i] = `as${name}`;
+        isKeys[i] = `is${name}`;
       }
 
-    };
+      objectProperties(_class.prototype, isKeys, (_, i, self) => self.type === keys[i]);
+      objectProperties(_class.prototype, asKeys, (k, i, self) => {
+        if (self.type !== keys[i]) {
+          throw new Error(`Cannot convert '${self.type}' via ${k}`);
+        }
+
+        return self.value;
+      });
+    })(), _class;
   }
   /**
    * @description The length of the value when encoded as a Uint8Array
@@ -280,15 +283,6 @@ export class Enum {
   get isNone() {
     return this.#raw instanceof Null;
   }
-  /**
-   * @description Checks if the Enum points to a [[Null]] type
-   * @deprecated use isNone
-   */
-
-
-  get isNull() {
-    return this.isNone;
-  }
   /**
    * @description The available keys for this enum
    */
@@ -402,6 +396,16 @@ export class Enum {
   toNumber() {
     return this.index;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#isBasic ? this.type : {
+      [stringCamelCase(this.type)]: this.#raw.toPrimitive()
+    };
+  }
   /**
    * @description Returns a raw struct representation of the enum types
    */

package/base/Null.d.ts

@@ -36,6 +36,10 @@ export declare class Null implements Codec {
      * @description Converts the Object to JSON, typically used for RPC transfers
      */
     toJSON(): null;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): null;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/base/Null.js

@@ -64,6 +64,14 @@ export class Null {
   toJSON() {
     return null;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return null;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/base/Option.d.ts

@@ -63,6 +63,10 @@ export declare class Option<T extends Codec> implements IOption<T> {
      * @description Converts the Object to JSON, typically used for RPC transfers
      */
     toJSON(): AnyJson;
+    /**
+     * @description Converts the value in a best-fit primitive form
+     */
+    toPrimitive(): AnyJson;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/base/Option.js

@@ -201,6 +201,14 @@ export class Option {
   toJSON() {
     return this.isNone ? null : this.#raw.toJSON();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.isNone ? null : this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/base/Result.d.ts

@@ -15,10 +15,6 @@ export declare class Result<O extends Codec, E extends Codec> extends Enum imple
      * @description Returns the wrapper Err value (if isErr)
      */
     get asErr(): E;
-    /**
-     * @deprecated Use asErr
-     */
-    get asError(): E;
     /**
      * @description Returns the wrapper Ok value (if isOk)
      */
@@ -31,10 +27,6 @@ export declare class Result<O extends Codec, E extends Codec> extends Enum imple
      * @description Checks if the Result wraps an Err value
      */
     get isErr(): boolean;
-    /**
-     * @deprecated Use isErr
-     */
-    get isError(): boolean;
     /**
      * @description Checks if the Result wraps an Ok value
      */

package/base/Result.js

@@ -37,14 +37,6 @@ export class Result extends Enum {
 
     return this.value;
   }
-  /**
-   * @deprecated Use asErr
-   */
-
-
-  get asError() {
-    return this.asErr;
-  }
   /**
    * @description Returns the wrapper Ok value (if isOk)
    */
@@ -73,14 +65,6 @@ export class Result extends Enum {
   get isErr() {
     return !this.isOk;
   }
-  /**
-   * @deprecated Use isErr
-   */
-
-
-  get isError() {
-    return this.isErr;
-  }
   /**
    * @description Checks if the Result wraps an Ok value
    */

package/cjs/abstract/Array.js

@@ -148,6 +148,20 @@ class AbstractArray extends Array {
 
     return result;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    const result = new Array(this.length);
+
+    for (let i = 0; i < this.length; i++) {
+      result[i] = this[i] && this[i].toPrimitive();
+    }
+
+    return result;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/abstract/Base.js

@@ -88,6 +88,14 @@ class AbstractBase {
   toJSON() {
     return this.#raw.toJSON();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the string representation of the value
    */

package/cjs/abstract/Int.js

@@ -211,6 +211,14 @@ class AbstractInt extends _util.BN {
     //   - this.#bitLength - the type bits (this should be used, however contracts RPC is problematic)
     return onlyHex || super.bitLength() > MAX_NUMBER_BITS ? this.toHex() : this.toNumber();
   }
+  /**
+   * @description Returns the value in a primitive form, either number when <= 52 bits, or string otherwise
+   */
+
+
+  toPrimitive() {
+    return super.bitLength() > MAX_NUMBER_BITS ? this.toString() : this.toNumber();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/base/Compact.js

@@ -168,6 +168,14 @@ class Compact {
   toNumber() {
     return this.#raw.toNumber();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/base/DoNotConstruct.js

@@ -76,6 +76,10 @@ class DoNotConstruct {
     throw this.#neverError;
   }
 
+  toPrimitive() {
+    throw this.#neverError;
+  }
+
   toRawType() {
     throw this.#neverError;
   }

package/cjs/base/Enum.js

@@ -210,37 +210,40 @@ class Enum {
   }
 
   static with(Types) {
-    const keys = Array.isArray(Types) ? Types : Object.keys(Types);
-    const asKeys = new Array(keys.length);
-    const isKeys = new Array(keys.length);
-
-    for (let i = 0; i < keys.length; i++) {
-      const name = (0, _util.stringPascalCase)(keys[i]);
-      asKeys[i] = `as${name}`;
-      isKeys[i] = `is${name}`;
-    }
+    var _class;
 
     let definition; // eslint-disable-next-line no-return-assign
 
     const setDefinition = d => definition = d;
 
-    return class extends Enum {
+    return _class = class extends Enum {
       constructor(registry, value, index) {
         super(registry, Types, value, index, {
           definition,
           setDefinition
         });
-        (0, _util.objectProperties)(this, isKeys, (_, i) => this.type === keys[i]);
-        (0, _util.objectProperties)(this, asKeys, (k, i) => {
-          if (!this[isKeys[i]]) {
-            throw new Error(`Cannot convert '${this.type}' via ${k}`);
-          }
+      }
 
-          return this.value;
-        });
+    }, (() => {
+      const keys = Array.isArray(Types) ? Types : Object.keys(Types);
+      const asKeys = new Array(keys.length);
+      const isKeys = new Array(keys.length);
+
+      for (let i = 0; i < keys.length; i++) {
+        const name = (0, _util.stringPascalCase)(keys[i]);
+        asKeys[i] = `as${name}`;
+        isKeys[i] = `is${name}`;
       }
 
-    };
+      (0, _util.objectProperties)(_class.prototype, isKeys, (_, i, self) => self.type === keys[i]);
+      (0, _util.objectProperties)(_class.prototype, asKeys, (k, i, self) => {
+        if (self.type !== keys[i]) {
+          throw new Error(`Cannot convert '${self.type}' via ${k}`);
+        }
+
+        return self.value;
+      });
+    })(), _class;
   }
   /**
    * @description The length of the value when encoded as a Uint8Array
@@ -298,15 +301,6 @@ class Enum {
   get isNone() {
     return this.#raw instanceof _Null.Null;
   }
-  /**
-   * @description Checks if the Enum points to a [[Null]] type
-   * @deprecated use isNone
-   */
-
-
-  get isNull() {
-    return this.isNone;
-  }
   /**
    * @description The available keys for this enum
    */
@@ -420,6 +414,16 @@ class Enum {
   toNumber() {
     return this.index;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#isBasic ? this.type : {
+      [(0, _util.stringCamelCase)(this.type)]: this.#raw.toPrimitive()
+    };
+  }
   /**
    * @description Returns a raw struct representation of the enum types
    */

package/cjs/base/Null.js

@@ -72,6 +72,14 @@ class Null {
   toJSON() {
     return null;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return null;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/base/Option.js

@@ -211,6 +211,14 @@ class Option {
   toJSON() {
     return this.isNone ? null : this.#raw.toJSON();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.isNone ? null : this.#raw.toPrimitive();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/base/Result.js

@@ -45,14 +45,6 @@ class Result extends _Enum.Enum {
 
     return this.value;
   }
-  /**
-   * @deprecated Use asErr
-   */
-
-
-  get asError() {
-    return this.asErr;
-  }
   /**
    * @description Returns the wrapper Ok value (if isOk)
    */
@@ -81,14 +73,6 @@ class Result extends _Enum.Enum {
   get isErr() {
     return !this.isOk;
   }
-  /**
-   * @deprecated Use isErr
-   */
-
-
-  get isError() {
-    return this.isErr;
-  }
   /**
    * @description Checks if the Result wraps an Ok value
    */

package/cjs/extended/BTreeSet.js

@@ -197,6 +197,20 @@ class BTreeSet extends Set {
   toRawType() {
     return `BTreeSet<${this.registry.getClassName(this.#ValClass) || new this.#ValClass(this.registry).toRawType()}>`;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    const json = [];
+
+    for (const v of this.values()) {
+      json.push(v.toPrimitive());
+    }
+
+    return json;
+  }
   /**
    * @description Returns the string representation of the value
    */

package/cjs/extended/Map.js

@@ -11,6 +11,8 @@ var _Array = require("../abstract/Array");
 
 var _Enum = require("../base/Enum");
 
+var _Raw = require("../native/Raw");
+
 var _Struct = require("../native/Struct");
 
 var _utils = require("../utils");
@@ -178,7 +180,7 @@ class CodecMap extends Map {
     const json = {};
 
     for (const [k, v] of this.entries()) {
-      json[k.toString()] = v.toHuman(isExtended);
+      json[k instanceof _Raw.Raw && k.isAscii ? k.toUtf8() : k.toString()] = v.toHuman(isExtended);
     }
 
     return json;
@@ -197,6 +199,20 @@ class CodecMap extends Map {
 
     return json;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    const json = {};
+
+    for (const [k, v] of this.entries()) {
+      json[k instanceof _Raw.Raw && k.isAscii ? k.toUtf8() : k.toString()] = v.toPrimitive();
+    }
+
+    return json;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/cjs/extended/WrapperKeepOpaque.js

@@ -84,6 +84,14 @@ class WrapperKeepOpaque extends _Bytes.Bytes {
   toHuman(isExtended) {
     return this.#decoded ? this.#decoded.toHuman(isExtended) : super.toHuman();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.#decoded ? this.#decoded.toPrimitive() : super.toPrimitive();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */