@polkadot/types-codec 8.12.2 → 8.14.2-11

package/native/Set.js

@@ -97,20 +97,23 @@ export class CodecSet extends Set {
   }
 
   static with(values, bitLength) {
-    const keys = Object.keys(values);
-    const isKeys = new Array(keys.length);
+    var _class;
 
-    for (let i = 0; i < keys.length; i++) {
-      isKeys[i] = `is${stringPascalCase(keys[i])}`;
-    }
-
-    return class extends CodecSet {
+    return _class = class extends CodecSet {
       constructor(registry, value) {
         super(registry, values, value, bitLength);
-        objectProperties(this, isKeys, (_, i) => this.strings.includes(keys[i]));
       }
 
-    };
+    }, (() => {
+      const keys = Object.keys(values);
+      const isKeys = new Array(keys.length);
+
+      for (let i = 0; i < keys.length; i++) {
+        isKeys[i] = `is${stringPascalCase(keys[i])}`;
+      }
+
+      objectProperties(_class.prototype, isKeys, (_, i, self) => self.strings.includes(keys[i]));
+    })(), _class;
   }
   /**
    * @description The length of the value when encoded as a Uint8Array
@@ -226,6 +229,14 @@ export class CodecSet extends Set {
   toNumber() {
     return this.valueEncoded.toNumber();
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    return this.toJSON();
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/native/Struct.d.ts

@@ -35,15 +35,10 @@ export declare class Struct<S extends TypesDef = TypesDef, V extends {
      * @description The available keys for this struct
      */
     get defKeys(): string[];
-    getT<T>(key: string): T;
     /**
      * @description Checks if the value is an empty value
      */
     get isEmpty(): boolean;
-    /**
-     * @description Returns the Type description of the structure
-     */
-    get Type(): E;
     /**
      * @description The length of the value when encoded as a Uint8Array
      */
@@ -52,19 +47,27 @@ export declare class Struct<S extends TypesDef = TypesDef, V extends {
      * @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 name The name of the entry to retrieve
+     * @param key The name of the entry to retrieve
      */
-    get(name: keyof S): Codec | undefined;
+    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>(key: string): T;
     /**
      * @description Returns a breakdown of the hex encoding for this Codec
      */
@@ -85,6 +88,10 @@ export declare class Struct<S extends TypesDef = TypesDef, V extends {
      * @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(): Record<string, AnyJson>;
     /**
      * @description Returns the base runtime type name for this instance
      */

package/native/Struct.js

@@ -95,21 +95,24 @@ export class Struct extends Map {
   }
 
   static with(Types, jsonMap) {
-    const keys = Object.keys(Types);
+    var _class;
+
     let definition; // eslint-disable-next-line no-return-assign
 
     const setDefinition = d => definition = d;
 
-    return class extends Struct {
+    return _class = class extends Struct {
       constructor(registry, value) {
         super(registry, Types, value, jsonMap, {
           definition,
           setDefinition
         });
-        objectProperties(this, keys, k => this.get(k));
       }
 
-    };
+    }, (() => {
+      const keys = Object.keys(Types);
+      objectProperties(_class.prototype, keys, (k, _, self) => self.get(k));
+    })(), _class;
   }
   /**
    * @description The available keys for this struct
@@ -119,10 +122,6 @@ export class Struct extends Map {
   get defKeys() {
     return this.#Types[1];
   }
-
-  getT(key) {
-    return this.get(key);
-  }
   /**
    * @description Checks if the value is an empty value
    */
@@ -137,21 +136,6 @@ export class Struct extends Map {
 
     return true;
   }
-  /**
-   * @description Returns the Type description of the structure
-   */
-
-
-  get Type() {
-    const result = {};
-    const [Types, keys] = this.#Types;
-
-    for (let i = 0; i < keys.length; i++) {
-      result[keys[i]] = new Types[i](this.registry).toRawType();
-    }
-
-    return result;
-  }
   /**
    * @description The length of the value when encoded as a Uint8Array
    */
@@ -174,6 +158,21 @@ export class Struct extends Map {
   get hash() {
     return this.registry.hash(this.toU8a());
   }
+  /**
+   * @description Returns the Type description of the structure
+   */
+
+
+  get Type() {
+    const result = {};
+    const [Types, keys] = this.#Types;
+
+    for (let i = 0; i < keys.length; i++) {
+      result[keys[i]] = new Types[i](this.registry).toRawType();
+    }
+
+    return result;
+  }
   /**
    * @description Compares the value of the input to see if there is a match
    */
@@ -184,12 +183,12 @@ export class Struct extends Map {
   }
   /**
    * @description Returns a specific names entry in the structure
-   * @param name The name of the entry to retrieve
+   * @param key The name of the entry to retrieve
    */
 
 
-  get(name) {
-    return super.get(name);
+  get(key) {
+    return super.get(key);
   }
   /**
    * @description Returns the values of a member at a specific index (Rather use get(name) for performance)
@@ -199,6 +198,14 @@ export class Struct extends Map {
   getAtIndex(index) {
     return this.toArray()[index];
   }
+  /**
+   * @description Returns the a types value by name
+   */
+
+
+  getT(key) {
+    return super.get(key);
+  }
   /**
    * @description Returns a breakdown of the hex encoding for this Codec
    */
@@ -256,12 +263,31 @@ export class Struct extends Map {
     const json = {};
 
     for (const [k, v] of this.entries()) {
-      const jsonKey = this.#jsonMap.get(k) || k;
+      const jsonKey = this.#jsonMap.get(k) || k; // We actually log inside the U8a decoding and use JSON.stringify(...), which
+      // means that the Vec may be partially populated (same applies to toHuman, same check)
+
       json[jsonKey] = v && v.toJSON();
     }
 
     return json;
   }
+  /**
+   * @description Converts the value in a best-fit primitive form
+   */
+
+
+  toPrimitive() {
+    const json = {};
+
+    for (const [k, v] of this.entries()) {
+      const jsonKey = this.#jsonMap.get(k) || k; // We actually log inside the U8a decoding and use JSON.stringify(...), which
+      // means that the Vec may be partially populated (same applies to toHuman, same check)
+
+      json[jsonKey] = v && v.toPrimitive();
+    }
+
+    return json;
+  }
   /**
    * @description Returns the base runtime type name for this instance
    */

package/native/Text.d.ts

@@ -56,6 +56,10 @@ export declare class Text extends String implements IText {
      * @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
      */

package/native/Text.js

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

package/package.json

@@ -20,7 +20,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "8.12.2",
+  "version": "8.14.2-11",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -434,8 +434,8 @@
     }
   },
   "dependencies": {
-    "@babel/runtime": "^7.18.6",
-    "@polkadot/util": "^10.0.2",
-    "@polkadot/x-bigint": "^10.0.2"
+    "@babel/runtime": "^7.18.9",
+    "@polkadot/util": "^10.1.1",
+    "@polkadot/x-bigint": "^10.1.1"
   }
-}
+}

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.12.2'
+  version: '8.14.2-11'
 };

package/types/codec.d.ts

@@ -60,6 +60,10 @@ export interface 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 base runtime type name for this instance
      */
@@ -81,5 +85,5 @@ export interface CodecClass<T = Codec> {
     readonly __fallbackType?: string;
     new (registry: Registry, ...args: any[]): T;
 }
-export declare type CodecTo = 'toHex' | 'toJSON' | 'toString' | 'toU8a';
+export declare type CodecTo = 'toHex' | 'toJSON' | 'toPrimitive' | 'toString' | 'toU8a';
 export declare type ArgsDef = Record<string, CodecClass | string>;

package/types/interfaces.d.ts

@@ -24,6 +24,7 @@ export interface INumber extends Codec {
     toBigInt(): bigint;
     toBn(): BN;
     toNumber(): number;
+    toPrimitive(): string | number;
 }
 export interface IFloat extends Codec {
     toNumber(): number;

package/utils/decodeU8a.js

@@ -3,7 +3,7 @@
 import { u8aToHex } from '@polkadot/util';
 /** @internal */
 
-function formatFailure(registry, {
+function formatFailure(registry, result, {
   message
 }, u8a, i, count, Type, key) {
   let type = '';
@@ -11,7 +11,8 @@ function formatFailure(registry, {
   try {
     type = `: ${new Type(registry).toRawType()}`;
   } catch {// ignore
-  }
+  } // console.error(JSON.stringify(result, null, 2));
+
 
   return `decodeU8a: failed at ${u8aToHex(u8a.subarray(0, 16))}…${key ? ` on ${key}` : ''} (index ${i}/${count})${type}:: ${message}`;
 }
@@ -40,7 +41,7 @@ export function decodeU8a(registry, result, u8a, [Types, keys]) {
       i++;
     }
   } catch (error) {
-    throw new Error(formatFailure(registry, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
+    throw new Error(formatFailure(registry, result, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
   }
 
   return [result, offset];
@@ -65,7 +66,7 @@ export function decodeU8aStruct(registry, result, u8a, [Types, keys]) {
       i++;
     }
   } catch (error) {
-    throw new Error(formatFailure(registry, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
+    throw new Error(formatFailure(registry, result, error, u8a.subarray(offset), i, count, Types[i], keys[i]));
   }
 
   return [result, offset];
@@ -90,7 +91,7 @@ export function decodeU8aVec(registry, result, u8a, startAt, Type) {
       i++;
     }
   } catch (error) {
-    throw new Error(formatFailure(registry, error, u8a.subarray(offset), i, count, Type));
+    throw new Error(formatFailure(registry, result, error, u8a.subarray(offset), i, count, Type));
   }
 
   return [offset, offset - startAt];