@polkadot/types-codec 6.12.2-10

package/native/Text.js

@@ -0,0 +1,178 @@
+import _classPrivateFieldLooseBase from "@babel/runtime/helpers/esm/classPrivateFieldLooseBase";
+import _classPrivateFieldLooseKey from "@babel/runtime/helpers/esm/classPrivateFieldLooseKey";
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+import { assert, compactAddLength, compactFromU8a, hexToU8a, isHex, isString, isU8a, stringToU8a, u8aToHex, u8aToString } from '@polkadot/util';
+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] = compactFromU8a(value);
+    const total = offset + length.toNumber();
+    assert(length.lten(MAX_LENGTH), () => `Text: length ${length.toString()} exceeds ${MAX_LENGTH}`);
+    assert(total <= value.length, () => `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
+ * This is a string wrapper, along with the length. It is used both for strings as well
+ * as items such as documentation. It simply extends the standard JS `String` built-in
+ * object, inheriting all methods exposed from `String`.
+ * @noInheritDoc
+ */
+// TODO
+//   - Strings should probably be trimmed (docs do come through with extra padding)
+
+
+var _initialU8aLength = /*#__PURE__*/_classPrivateFieldLooseKey("initialU8aLength");
+
+var _override = /*#__PURE__*/_classPrivateFieldLooseKey("override");
+
+export class Text extends String {
+  constructor(registry, value) {
+    const [str, decodedLength] = decodeText(value);
+    super(str);
+    this.registry = void 0;
+    this.createdAtHash = void 0;
+    Object.defineProperty(this, _initialU8aLength, {
+      writable: true,
+      value: void 0
+    });
+    Object.defineProperty(this, _override, {
+      writable: true,
+      value: null
+    });
+    this.registry = registry;
+    _classPrivateFieldLooseBase(this, _initialU8aLength)[_initialU8aLength] = decodedLength;
+  }
+  /**
+   * @description The length of the value when encoded as a Uint8Array
+   */
+
+
+  get encodedLength() {
+    return this.toU8a().length;
+  }
+  /**
+   * @description The length of the initial encoded value (Only available when constructed from a Uint8Array)
+   */
+
+
+  get initialU8aLength() {
+    return _classPrivateFieldLooseBase(this, _initialU8aLength)[_initialU8aLength];
+  }
+  /**
+   * @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 Set an override value for this
+   */
+
+
+  setOverride(override) {
+    _classPrivateFieldLooseBase(this, _override)[_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 Returns the base runtime type name for this instance
+   */
+
+
+  toRawType() {
+    return 'Text';
+  }
+  /**
+   * @description Returns the string representation of the value
+   */
+
+
+  toString() {
+    return _classPrivateFieldLooseBase(this, _override)[_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.cjs

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Bool", {
+  enumerable: true,
+  get: function () {
+    return _Bool.bool;
+  }
+});
+Object.defineProperty(exports, "CodecDate", {
+  enumerable: true,
+  get: function () {
+    return _Date.CodecDate;
+  }
+});
+Object.defineProperty(exports, "CodecSet", {
+  enumerable: true,
+  get: function () {
+    return _Set.CodecSet;
+  }
+});
+Object.defineProperty(exports, "Date", {
+  enumerable: true,
+  get: function () {
+    return _Date.CodecDate;
+  }
+});
+Object.defineProperty(exports, "Json", {
+  enumerable: true,
+  get: function () {
+    return _Json.Json;
+  }
+});
+Object.defineProperty(exports, "Raw", {
+  enumerable: true,
+  get: function () {
+    return _Raw.Raw;
+  }
+});
+Object.defineProperty(exports, "Set", {
+  enumerable: true,
+  get: function () {
+    return _Set.CodecSet;
+  }
+});
+Object.defineProperty(exports, "Struct", {
+  enumerable: true,
+  get: function () {
+    return _Struct.Struct;
+  }
+});
+Object.defineProperty(exports, "Text", {
+  enumerable: true,
+  get: function () {
+    return _Text.Text;
+  }
+});
+Object.defineProperty(exports, "bool", {
+  enumerable: true,
+  get: function () {
+    return _Bool.bool;
+  }
+});
+
+var _Bool = require("./Bool.cjs");
+
+var _Date = require("./Date.cjs");
+
+var _Json = require("./Json.cjs");
+
+var _Raw = require("./Raw.cjs");
+
+var _Set = require("./Set.cjs");
+
+var _Struct = require("./Struct.cjs");
+
+var _Text = require("./Text.cjs");

package/native/index.d.ts

@@ -0,0 +1,7 @@
+export { bool, bool as Bool } from './Bool';
+export { CodecDate, CodecDate as Date } from './Date';
+export { Json } from './Json';
+export { Raw } from './Raw';
+export { CodecSet, CodecSet as Set } from './Set';
+export { Struct } from './Struct';
+export { Text } from './Text';

package/native/index.js

@@ -0,0 +1,9 @@
+// Copyright 2017-2021 @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 { 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

@@ -0,0 +1,387 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/polkadot-js/api/issues",
+  "contributors": [],
+  "description": "Implementation of the Parity codec",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "homepage": "https://github.com/polkadot-js/api/tree/master/packages/types-codec#readme",
+  "license": "Apache-2.0",
+  "maintainers": [],
+  "name": "@polkadot/types-codec",
+  "repository": {
+    "directory": "packages/types-codec",
+    "type": "git",
+    "url": "https://github.com/polkadot-js/api.git"
+  },
+  "sideEffects": [
+    "./detectPackage.js",
+    "./detectPackage.cjs"
+  ],
+  "type": "module",
+  "version": "6.12.2-10",
+  "main": "index.js",
+  "dependencies": {
+    "@babel/runtime": "^7.16.5",
+    "@polkadot/util": "^8.1.2"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.cjs",
+      "default": "./index.js"
+    },
+    "./abstract": {
+      "require": "./abstract/index.cjs",
+      "default": "./abstract/index.js"
+    },
+    "./abstract/AbstractArray": {
+      "require": "./abstract/AbstractArray.cjs",
+      "default": "./abstract/AbstractArray.js"
+    },
+    "./abstract/AbstractArray.d.ts": "./abstract/AbstractArray.d.ts",
+    "./abstract/AbstractInt": {
+      "require": "./abstract/AbstractInt.cjs",
+      "default": "./abstract/AbstractInt.js"
+    },
+    "./abstract/AbstractInt.d.ts": "./abstract/AbstractInt.d.ts",
+    "./abstract/index.d.ts": "./abstract/index.d.ts",
+    "./base": {
+      "require": "./base/index.cjs",
+      "default": "./base/index.js"
+    },
+    "./base/Base": {
+      "require": "./base/Base.cjs",
+      "default": "./base/Base.js"
+    },
+    "./base/Base.d.ts": "./base/Base.d.ts",
+    "./base/Compact": {
+      "require": "./base/Compact.cjs",
+      "default": "./base/Compact.js"
+    },
+    "./base/Compact.d.ts": "./base/Compact.d.ts",
+    "./base/DoNotConstruct": {
+      "require": "./base/DoNotConstruct.cjs",
+      "default": "./base/DoNotConstruct.js"
+    },
+    "./base/DoNotConstruct.d.ts": "./base/DoNotConstruct.d.ts",
+    "./base/Enum": {
+      "require": "./base/Enum.cjs",
+      "default": "./base/Enum.js"
+    },
+    "./base/Enum.d.ts": "./base/Enum.d.ts",
+    "./base/index.d.ts": "./base/index.d.ts",
+    "./base/Int": {
+      "require": "./base/Int.cjs",
+      "default": "./base/Int.js"
+    },
+    "./base/Int.d.ts": "./base/Int.d.ts",
+    "./base/Null": {
+      "require": "./base/Null.cjs",
+      "default": "./base/Null.js"
+    },
+    "./base/Null.d.ts": "./base/Null.d.ts",
+    "./base/Option": {
+      "require": "./base/Option.cjs",
+      "default": "./base/Option.js"
+    },
+    "./base/Option.d.ts": "./base/Option.d.ts",
+    "./base/Result": {
+      "require": "./base/Result.cjs",
+      "default": "./base/Result.js"
+    },
+    "./base/Result.d.ts": "./base/Result.d.ts",
+    "./base/Tuple": {
+      "require": "./base/Tuple.cjs",
+      "default": "./base/Tuple.js"
+    },
+    "./base/Tuple.d.ts": "./base/Tuple.d.ts",
+    "./base/UInt": {
+      "require": "./base/UInt.cjs",
+      "default": "./base/UInt.js"
+    },
+    "./base/UInt.d.ts": "./base/UInt.d.ts",
+    "./base/Vec": {
+      "require": "./base/Vec.cjs",
+      "default": "./base/Vec.js"
+    },
+    "./base/Vec.d.ts": "./base/Vec.d.ts",
+    "./base/VecAny": {
+      "require": "./base/VecAny.cjs",
+      "default": "./base/VecAny.js"
+    },
+    "./base/VecAny.d.ts": "./base/VecAny.d.ts",
+    "./base/VecFixed": {
+      "require": "./base/VecFixed.cjs",
+      "default": "./base/VecFixed.js"
+    },
+    "./base/VecFixed.d.ts": "./base/VecFixed.d.ts",
+    "./bundle": {
+      "require": "./bundle.cjs",
+      "default": "./bundle.js"
+    },
+    "./bundle.d.ts": "./bundle.d.ts",
+    "./detectPackage": {
+      "require": "./detectPackage.cjs",
+      "default": "./detectPackage.js"
+    },
+    "./detectPackage.d.ts": "./detectPackage.d.ts",
+    "./extended": {
+      "require": "./extended/index.cjs",
+      "default": "./extended/index.js"
+    },
+    "./extended/BitVec": {
+      "require": "./extended/BitVec.cjs",
+      "default": "./extended/BitVec.js"
+    },
+    "./extended/BitVec.d.ts": "./extended/BitVec.d.ts",
+    "./extended/BTreeMap": {
+      "require": "./extended/BTreeMap.cjs",
+      "default": "./extended/BTreeMap.js"
+    },
+    "./extended/BTreeMap.d.ts": "./extended/BTreeMap.d.ts",
+    "./extended/BTreeSet": {
+      "require": "./extended/BTreeSet.cjs",
+      "default": "./extended/BTreeSet.js"
+    },
+    "./extended/BTreeSet.d.ts": "./extended/BTreeSet.d.ts",
+    "./extended/Bytes": {
+      "require": "./extended/Bytes.cjs",
+      "default": "./extended/Bytes.js"
+    },
+    "./extended/Bytes.d.ts": "./extended/Bytes.d.ts",
+    "./extended/HashMap": {
+      "require": "./extended/HashMap.cjs",
+      "default": "./extended/HashMap.js"
+    },
+    "./extended/HashMap.d.ts": "./extended/HashMap.d.ts",
+    "./extended/index.d.ts": "./extended/index.d.ts",
+    "./extended/Linkage": {
+      "require": "./extended/Linkage.cjs",
+      "default": "./extended/Linkage.js"
+    },
+    "./extended/Linkage.d.ts": "./extended/Linkage.d.ts",
+    "./extended/Map": {
+      "require": "./extended/Map.cjs",
+      "default": "./extended/Map.js"
+    },
+    "./extended/Map.d.ts": "./extended/Map.d.ts",
+    "./extended/Range": {
+      "require": "./extended/Range.cjs",
+      "default": "./extended/Range.js"
+    },
+    "./extended/Range.d.ts": "./extended/Range.d.ts",
+    "./extended/Type": {
+      "require": "./extended/Type.cjs",
+      "default": "./extended/Type.js"
+    },
+    "./extended/Type.d.ts": "./extended/Type.d.ts",
+    "./extended/U8aFixed": {
+      "require": "./extended/U8aFixed.cjs",
+      "default": "./extended/U8aFixed.js"
+    },
+    "./extended/U8aFixed.d.ts": "./extended/U8aFixed.d.ts",
+    "./extended/WrapperOpaque": {
+      "require": "./extended/WrapperOpaque.cjs",
+      "default": "./extended/WrapperOpaque.js"
+    },
+    "./extended/WrapperOpaque.d.ts": "./extended/WrapperOpaque.d.ts",
+    "./index.d.ts": "./index.d.ts",
+    "./native": {
+      "require": "./native/index.cjs",
+      "default": "./native/index.js"
+    },
+    "./native/Bool": {
+      "require": "./native/Bool.cjs",
+      "default": "./native/Bool.js"
+    },
+    "./native/Bool.d.ts": "./native/Bool.d.ts",
+    "./native/Date": {
+      "require": "./native/Date.cjs",
+      "default": "./native/Date.js"
+    },
+    "./native/Date.d.ts": "./native/Date.d.ts",
+    "./native/index.d.ts": "./native/index.d.ts",
+    "./native/Json": {
+      "require": "./native/Json.cjs",
+      "default": "./native/Json.js"
+    },
+    "./native/Json.d.ts": "./native/Json.d.ts",
+    "./native/Raw": {
+      "require": "./native/Raw.cjs",
+      "default": "./native/Raw.js"
+    },
+    "./native/Raw.d.ts": "./native/Raw.d.ts",
+    "./native/Set": {
+      "require": "./native/Set.cjs",
+      "default": "./native/Set.js"
+    },
+    "./native/Set.d.ts": "./native/Set.d.ts",
+    "./native/Struct": {
+      "require": "./native/Struct.cjs",
+      "default": "./native/Struct.js"
+    },
+    "./native/Struct.d.ts": "./native/Struct.d.ts",
+    "./native/Text": {
+      "require": "./native/Text.cjs",
+      "default": "./native/Text.js"
+    },
+    "./native/Text.d.ts": "./native/Text.d.ts",
+    "./package.json": "./package.json",
+    "./packageInfo": {
+      "require": "./packageInfo.cjs",
+      "default": "./packageInfo.js"
+    },
+    "./packageInfo.d.ts": "./packageInfo.d.ts",
+    "./primitive": {
+      "require": "./primitive/index.cjs",
+      "default": "./primitive/index.js"
+    },
+    "./primitive/I128": {
+      "require": "./primitive/I128.cjs",
+      "default": "./primitive/I128.js"
+    },
+    "./primitive/I128.d.ts": "./primitive/I128.d.ts",
+    "./primitive/I16": {
+      "require": "./primitive/I16.cjs",
+      "default": "./primitive/I16.js"
+    },
+    "./primitive/I16.d.ts": "./primitive/I16.d.ts",
+    "./primitive/I256": {
+      "require": "./primitive/I256.cjs",
+      "default": "./primitive/I256.js"
+    },
+    "./primitive/I256.d.ts": "./primitive/I256.d.ts",
+    "./primitive/I32": {
+      "require": "./primitive/I32.cjs",
+      "default": "./primitive/I32.js"
+    },
+    "./primitive/I32.d.ts": "./primitive/I32.d.ts",
+    "./primitive/I64": {
+      "require": "./primitive/I64.cjs",
+      "default": "./primitive/I64.js"
+    },
+    "./primitive/I64.d.ts": "./primitive/I64.d.ts",
+    "./primitive/I8": {
+      "require": "./primitive/I8.cjs",
+      "default": "./primitive/I8.js"
+    },
+    "./primitive/I8.d.ts": "./primitive/I8.d.ts",
+    "./primitive/index.d.ts": "./primitive/index.d.ts",
+    "./primitive/U128": {
+      "require": "./primitive/U128.cjs",
+      "default": "./primitive/U128.js"
+    },
+    "./primitive/U128.d.ts": "./primitive/U128.d.ts",
+    "./primitive/U16": {
+      "require": "./primitive/U16.cjs",
+      "default": "./primitive/U16.js"
+    },
+    "./primitive/U16.d.ts": "./primitive/U16.d.ts",
+    "./primitive/U256": {
+      "require": "./primitive/U256.cjs",
+      "default": "./primitive/U256.js"
+    },
+    "./primitive/U256.d.ts": "./primitive/U256.d.ts",
+    "./primitive/U32": {
+      "require": "./primitive/U32.cjs",
+      "default": "./primitive/U32.js"
+    },
+    "./primitive/U32.d.ts": "./primitive/U32.d.ts",
+    "./primitive/U64": {
+      "require": "./primitive/U64.cjs",
+      "default": "./primitive/U64.js"
+    },
+    "./primitive/U64.d.ts": "./primitive/U64.d.ts",
+    "./primitive/U8": {
+      "require": "./primitive/U8.cjs",
+      "default": "./primitive/U8.js"
+    },
+    "./primitive/U8.d.ts": "./primitive/U8.d.ts",
+    "./primitive/USize": {
+      "require": "./primitive/USize.cjs",
+      "default": "./primitive/USize.js"
+    },
+    "./primitive/USize.d.ts": "./primitive/USize.d.ts",
+    "./types": {
+      "require": "./types/index.cjs",
+      "default": "./types/index.js"
+    },
+    "./types/codec": {
+      "require": "./types/codec.cjs",
+      "default": "./types/codec.js"
+    },
+    "./types/codec.d.ts": "./types/codec.d.ts",
+    "./types/helpers": {
+      "require": "./types/helpers.cjs",
+      "default": "./types/helpers.js"
+    },
+    "./types/helpers.d.ts": "./types/helpers.d.ts",
+    "./types/index.d.ts": "./types/index.d.ts",
+    "./types/interfaces": {
+      "require": "./types/interfaces.cjs",
+      "default": "./types/interfaces.js"
+    },
+    "./types/interfaces.d.ts": "./types/interfaces.d.ts",
+    "./types/registry": {
+      "require": "./types/registry.cjs",
+      "default": "./types/registry.js"
+    },
+    "./types/registry.d.ts": "./types/registry.d.ts",
+    "./utils": {
+      "require": "./utils/index.cjs",
+      "default": "./utils/index.js"
+    },
+    "./utils/compareArray": {
+      "require": "./utils/compareArray.cjs",
+      "default": "./utils/compareArray.js"
+    },
+    "./utils/compareArray.d.ts": "./utils/compareArray.d.ts",
+    "./utils/compareMap": {
+      "require": "./utils/compareMap.cjs",
+      "default": "./utils/compareMap.js"
+    },
+    "./utils/compareMap.d.ts": "./utils/compareMap.d.ts",
+    "./utils/compareSet": {
+      "require": "./utils/compareSet.cjs",
+      "default": "./utils/compareSet.js"
+    },
+    "./utils/compareSet.d.ts": "./utils/compareSet.d.ts",
+    "./utils/decodeU8a": {
+      "require": "./utils/decodeU8a.cjs",
+      "default": "./utils/decodeU8a.js"
+    },
+    "./utils/decodeU8a.d.ts": "./utils/decodeU8a.d.ts",
+    "./utils/index.d.ts": "./utils/index.d.ts",
+    "./utils/mapToTypeMap": {
+      "require": "./utils/mapToTypeMap.cjs",
+      "default": "./utils/mapToTypeMap.js"
+    },
+    "./utils/mapToTypeMap.d.ts": "./utils/mapToTypeMap.d.ts",
+    "./utils/sanitize": {
+      "require": "./utils/sanitize.cjs",
+      "default": "./utils/sanitize.js"
+    },
+    "./utils/sanitize.d.ts": "./utils/sanitize.d.ts",
+    "./utils/sortValues": {
+      "require": "./utils/sortValues.cjs",
+      "default": "./utils/sortValues.js"
+    },
+    "./utils/sortValues.d.ts": "./utils/sortValues.d.ts",
+    "./utils/typesToMap": {
+      "require": "./utils/typesToMap.cjs",
+      "default": "./utils/typesToMap.js"
+    },
+    "./utils/typesToMap.d.ts": "./utils/typesToMap.d.ts",
+    "./utils/typeToConstructor": {
+      "require": "./utils/typeToConstructor.cjs",
+      "default": "./utils/typeToConstructor.js"
+    },
+    "./utils/typeToConstructor.d.ts": "./utils/typeToConstructor.d.ts",
+    "./utils/util": {
+      "require": "./utils/util.cjs",
+      "default": "./utils/util.js"
+    },
+    "./utils/util.d.ts": "./utils/util.d.ts"
+  }
+}

package/packageInfo.cjs

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.packageInfo = void 0;
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+// Auto-generated by @polkadot/dev, do not edit
+const packageInfo = {
+  name: '@polkadot/types-codec',
+  version: '6.12.2-10'
+};
+exports.packageInfo = packageInfo;

package/packageInfo.d.ts

@@ -0,0 +1,4 @@
+export declare const packageInfo: {
+    name: string;
+    version: string;
+};