@polkadot/types-codec 9.14.1 → 10.0.1

package/native/Text.js

@@ -1,36 +1,32 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
 import { compactAddLength, compactFromU8aLim, compactToU8a, hexToU8a, isHex, isString, isU8a, stringToU8a, u8aToHex, u8aToString } from '@polkadot/util';
-import { Raw } from "./Raw.js";
+import { Raw } from './Raw.js';
 const MAX_LENGTH = 128 * 1024;
-
 /** @internal */
 function decodeText(value) {
-  if (isU8a(value)) {
-    if (!value.length) {
-      return ['', 0];
-    }
-
-    // for Raw, the internal buffer does not have an internal length
-    // (the same applies in e.g. Bytes, where length is added at encoding-time)
-    if (value instanceof Raw) {
-      return [u8aToString(value), 0];
-    }
-    const [offset, length] = compactFromU8aLim(value);
-    const total = offset + length;
-    if (length > MAX_LENGTH) {
-      throw new Error(`Text: length ${length.toString()} exceeds ${MAX_LENGTH}`);
-    } else if (total > value.length) {
-      throw new Error(`Text: required length less than remainder, expected at least ${total}, found ${value.length}`);
-    }
-    return [u8aToString(value.subarray(offset, total)), total];
-  } else if (isHex(value)) {
-    return [u8aToString(hexToU8a(value)), 0];
-  }
-  return [value ? value.toString() : '', 0];
+    if (isU8a(value)) {
+        if (!value.length) {
+            return ['', 0];
+        }
+        // for Raw, the internal buffer does not have an internal length
+        // (the same applies in e.g. Bytes, where length is added at encoding-time)
+        if (value instanceof Raw) {
+            return [u8aToString(value), 0];
+        }
+        const [offset, length] = compactFromU8aLim(value);
+        const total = offset + length;
+        if (length > MAX_LENGTH) {
+            throw new Error(`Text: length ${length.toString()} exceeds ${MAX_LENGTH}`);
+        }
+        else if (total > value.length) {
+            throw new Error(`Text: required length less than remainder, expected at least ${total}, found ${value.length}`);
+        }
+        return [u8aToString(value.subarray(offset, total)), total];
+    }
+    else if (isHex(value)) {
+        return [u8aToString(hexToU8a(value)), 0];
+    }
+    return [value ? value.toString() : '', 0];
 }
-
 /**
  * @name Text
  * @description
@@ -40,119 +36,115 @@ function decodeText(value) {
  * @noInheritDoc
  */
 export class Text extends String {
-  #override = null;
-  constructor(registry, value) {
-    const [str, decodedLength] = decodeText(value);
-    super(str);
-    this.registry = registry;
-    this.initialU8aLength = decodedLength;
-  }
-
-  /**
-   * @description The length of the value when encoded as a Uint8Array
-   */
-  get encodedLength() {
-    return this.toU8a().length;
-  }
-
-  /**
-   * @description returns a hash of the contents
-   */
-  get hash() {
-    return this.registry.hash(this.toU8a());
-  }
-
-  /**
-   * @description Checks if the value is an empty value
-   */
-  get isEmpty() {
-    return this.length === 0;
-  }
-
-  /**
-   * @description The length of the value
-   */
-  get length() {
-    // only included here since we ignore inherited docs
-    return super.length;
-  }
-
-  /**
-   * @description Compares the value of the input to see if there is a match
-   */
-  eq(other) {
-    return isString(other) ? this.toString() === other.toString() : false;
-  }
-
-  /**
-   * @description Returns a breakdown of the hex encoding for this Codec
-   */
-  inspect() {
-    const value = stringToU8a(super.toString());
-    return {
-      outer: value.length ? [compactToU8a(value.length), value] : [compactToU8a(value.length)]
-    };
-  }
-
-  /**
-   * @description Set an override value for this
-   */
-  setOverride(override) {
-    this.#override = override;
-  }
-
-  /**
-   * @description Returns a hex string representation of the value
-   */
-  toHex() {
-    // like with Vec<u8>, when we are encoding to hex, we don't actually add
-    // the length prefix (it is already implied by the actual string length)
-    return u8aToHex(this.toU8a(true));
-  }
-
-  /**
-   * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
-   */
-  toHuman() {
-    return this.toJSON();
-  }
-
-  /**
-   * @description Converts the Object to JSON, typically used for RPC transfers
-   */
-  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
-   */
-  toRawType() {
-    return 'Text';
-  }
-
-  /**
-   * @description Returns the string representation of the value
-   */
-  toString() {
-    return this.#override || super.toString();
-  }
-
-  /**
-   * @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) {
-    // NOTE Here we use the super toString (we are not taking overrides into account,
-    // rather encoding the original value the string was constructed with)
-    const encoded = stringToU8a(super.toString());
-    return isBare ? encoded : compactAddLength(encoded);
-  }
+    registry;
+    createdAtHash;
+    initialU8aLength;
+    isStorageFallback;
+    #override = null;
+    constructor(registry, value) {
+        const [str, decodedLength] = decodeText(value);
+        super(str);
+        this.registry = registry;
+        this.initialU8aLength = decodedLength;
+    }
+    /**
+     * @description The length of the value when encoded as a Uint8Array
+     */
+    get encodedLength() {
+        return this.toU8a().length;
+    }
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash() {
+        return this.registry.hash(this.toU8a());
+    }
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty() {
+        return this.length === 0;
+    }
+    /**
+     * @description The length of the value
+     */
+    get length() {
+        // only included here since we ignore inherited docs
+        return super.length;
+    }
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other) {
+        return isString(other)
+            ? this.toString() === other.toString()
+            : false;
+    }
+    /**
+     * @description Returns a breakdown of the hex encoding for this Codec
+     */
+    inspect() {
+        const value = stringToU8a(super.toString());
+        return {
+            outer: value.length
+                ? [compactToU8a(value.length), value]
+                : [compactToU8a(value.length)]
+        };
+    }
+    /**
+     * @description Set an override value for this
+     */
+    setOverride(override) {
+        this.#override = override;
+    }
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex() {
+        // like with Vec<u8>, when we are encoding to hex, we don't actually add
+        // the length prefix (it is already implied by the actual string length)
+        return u8aToHex(this.toU8a(true));
+    }
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman() {
+        return this.toJSON();
+    }
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    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
+     */
+    toRawType() {
+        return 'Text';
+    }
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString() {
+        return this.#override || super.toString();
+    }
+    /**
+     * @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) {
+        // NOTE Here we use the super toString (we are not taking overrides into account,
+        // rather encoding the original value the string was constructed with)
+        const encoded = stringToU8a(super.toString());
+        return isBare
+            ? encoded
+            : compactAddLength(encoded);
+    }
 }

package/native/index.js

@@ -1,11 +1,8 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { bool, bool as Bool } from "./Bool.js";
-export { CodecDate, CodecDate as Date } from "./Date.js";
-export { Float } from "./Float.js";
-export { Json } from "./Json.js";
-export { Raw } from "./Raw.js";
-export { CodecSet, CodecSet as Set } from "./Set.js";
-export { Struct } from "./Struct.js";
-export { Text } from "./Text.js";
+export { bool, bool as Bool } from './Bool.js';
+export { CodecDate, CodecDate as Date } from './Date.js';
+export { Float } from './Float.js';
+export { Json } from './Json.js';
+export { Raw } from './Raw.js';
+export { CodecSet, CodecSet as Set } from './Set.js';
+export { Struct } from './Struct.js';
+export { Text } from './Text.js';

package/package.json

@@ -20,7 +20,7 @@
     "./cjs/detectPackage.js"
   ],
   "type": "module",
-  "version": "9.14.1",
+  "version": "10.0.1",
   "main": "./cjs/index.js",
   "module": "./index.js",
   "types": "./index.d.ts",
@@ -261,7 +261,10 @@
       "require": "./cjs/native/Text.js",
       "default": "./native/Text.js"
     },
-    "./package.json": "./package.json",
+    "./package.json": {
+      "require": "./cjs/package.json",
+      "default": "./package.json"
+    },
     "./packageInfo.js": {
       "types": "./packageInfo.d.ts",
       "require": "./cjs/packageInfo.js",
@@ -434,8 +437,8 @@
     }
   },
   "dependencies": {
-    "@babel/runtime": "^7.20.13",
-    "@polkadot/util": "^10.4.1",
-    "@polkadot/x-bigint": "^10.4.1"
+    "@polkadot/util": "^11.0.1",
+    "@polkadot/x-bigint": "^11.0.1",
+    "tslib": "^2.5.0"
   }
 }

package/packageInfo.js

@@ -1,11 +1 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-// Do not edit, auto-generated by @polkadot/dev
-
-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: '9.14.1'
-};
+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: '10.0.1' };

package/primitive/F32.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Float } from "../native/Float.js";
-
+import { Float } from '../native/Float.js';
 /**
  * @name f32
  * @description
  * A 32-bit float
  */
 export class f32 extends Float.with(32) {
-  // NOTE without this, we cannot properly determine extensions
-  __FloatType = 'f32';
+    // NOTE without this, we cannot properly determine extensions
+    __FloatType = 'f32';
 }

package/primitive/F64.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Float } from "../native/Float.js";
-
+import { Float } from '../native/Float.js';
 /**
  * @name f64
  * @description
  * A 64-bit float
  */
 export class f64 extends Float.with(64) {
-  // NOTE without this, we cannot properly determine extensions
-  __FloatType = 'f64';
+    // NOTE without this, we cannot properly determine extensions
+    __FloatType = 'f64';
 }

package/primitive/I128.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i128
  * @description
  * A 128-bit signed integer
  */
 export class i128 extends Int.with(128) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i128';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i128';
 }

package/primitive/I16.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i16
  * @description
  * A 16-bit signed integer
  */
 export class i16 extends Int.with(16) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i16';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i16';
 }

package/primitive/I256.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i256
  * @description
  * A 256-bit signed integer
  */
 export class i256 extends Int.with(256) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i256';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i256';
 }

package/primitive/I32.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i32
  * @description
  * A 32-bit signed integer
  */
 export class i32 extends Int.with(32) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i32';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i32';
 }

package/primitive/I64.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i64
  * @description
  * A 64-bit signed integer
  */
 export class i64 extends Int.with(64) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i64';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i64';
 }

package/primitive/I8.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { Int } from "../base/Int.js";
-
+import { Int } from '../base/Int.js';
 /**
  * @name i8
  * @description
  * An 8-bit signed integer
  */
 export class i8 extends Int.with(8) {
-  // NOTE without this, we cannot properly determine extensions
-  __IntType = 'i8';
+    // NOTE without this, we cannot properly determine extensions
+    __IntType = 'i8';
 }

package/primitive/U128.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u128
  * @description
  * A 128-bit unsigned integer
  */
 export class u128 extends UInt.with(128) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u128';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u128';
 }

package/primitive/U16.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u16
  * @description
  * A 16-bit unsigned integer
  */
 export class u16 extends UInt.with(16) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u16';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u16';
 }

package/primitive/U256.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u256
  * @description
  * A 256-bit unsigned integer
  */
 export class u256 extends UInt.with(256) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u256';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u256';
 }

package/primitive/U32.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u32
  * @description
  * A 32-bit unsigned integer
  */
 export class u32 extends UInt.with(32) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u32';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u32';
 }

package/primitive/U64.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u64
  * @description
  * A 64-bit unsigned integer
  */
 export class u64 extends UInt.with(64) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u64';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u64';
 }

package/primitive/U8.js

@@ -1,14 +1,10 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { UInt } from "../base/UInt.js";
-
+import { UInt } from '../base/UInt.js';
 /**
  * @name u8
  * @description
  * An 8-bit unsigned integer
  */
 export class u8 extends UInt.with(8) {
-  // NOTE without this, we cannot properly determine extensions
-  __UIntType = 'u8';
+    // NOTE without this, we cannot properly determine extensions
+    __UIntType = 'u8';
 }

package/primitive/USize.js

@@ -1,8 +1,4 @@
-// Copyright 2017-2023 @polkadot/types-codec authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { u32 } from "./U32.js";
-
+import { u32 } from './U32.js';
 /**
  * @name USize
  * @description
@@ -11,8 +7,8 @@ import { u32 } from "./U32.js";
  * It is not to be used, since it created consensus mismatches.
  */
 export class usize extends u32 {
-  constructor(registry, value) {
-    super(registry, value);
-    throw new Error('The `usize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally u64) and WASM (always u32) code. Use one of the `u32` or `u64` types explicitly.');
-  }
+    constructor(registry, value) {
+        super(registry, value);
+        throw new Error('The `usize` type should not be used. Since it is platform-specific, it creates incompatibilities between native (generally u64) and WASM (always u32) code. Use one of the `u32` or `u64` types explicitly.');
+    }
 }