@polkadot/types-codec 6.12.2-2

package/native/Text.cjs

@@ -0,0 +1,193 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Text = void 0;
+
+var _classPrivateFieldLooseBase2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseBase"));
+
+var _classPrivateFieldLooseKey2 = _interopRequireDefault(require("@babel/runtime/helpers/classPrivateFieldLooseKey"));
+
+var _util = require("@polkadot/util");
+
+var _Raw = require("./Raw.cjs");
+
+// Copyright 2017-2021 @polkadot/types-codec authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+const MAX_LENGTH = 128 * 1024;
+/** @internal */
+
+function decodeText(value) {
+  if ((0, _util.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.Raw) {
+      return [(0, _util.u8aToString)(value), 0];
+    }
+
+    const [offset, length] = (0, _util.compactFromU8a)(value);
+    const total = offset + length.toNumber();
+    (0, _util.assert)(length.lten(MAX_LENGTH), () => `Text: length ${length.toString()} exceeds ${MAX_LENGTH}`);
+    (0, _util.assert)(total <= value.length, () => `Text: required length less than remainder, expected at least ${total}, found ${value.length}`);
+    return [(0, _util.u8aToString)(value.subarray(offset, total)), total];
+  } else if ((0, _util.isHex)(value)) {
+    return [(0, _util.u8aToString)((0, _util.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__*/(0, _classPrivateFieldLooseKey2.default)("initialU8aLength");
+
+var _override = /*#__PURE__*/(0, _classPrivateFieldLooseKey2.default)("override");
+
+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;
+    (0, _classPrivateFieldLooseBase2.default)(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 (0, _classPrivateFieldLooseBase2.default)(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 (0, _util.isString)(other) ? this.toString() === other.toString() : false;
+  }
+  /**
+   * @description Set an override value for this
+   */
+
+
+  setOverride(override) {
+    (0, _classPrivateFieldLooseBase2.default)(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 (0, _util.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 (0, _classPrivateFieldLooseBase2.default)(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 = (0, _util.stringToU8a)(super.toString());
+    return isBare ? encoded : (0, _util.compactAddLength)(encoded);
+  }
+
+}
+
+exports.Text = Text;

package/native/Text.d.ts

@@ -0,0 +1,71 @@
+import type { HexString } from '@polkadot/util/types';
+import type { AnyU8a, Codec, CodecRegistry, IU8a } from '../types';
+/**
+ * @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
+ */
+export declare class Text extends String implements Codec {
+    #private;
+    readonly registry: CodecRegistry;
+    createdAtHash?: IU8a;
+    constructor(registry: CodecRegistry, value?: null | Text | string | AnyU8a | {
+        toString: () => string;
+    });
+    /**
+     * @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 | undefined;
+    /**
+     * @description returns a hash of the contents
+     */
+    get hash(): IU8a;
+    /**
+     * @description Checks if the value is an empty value
+     */
+    get isEmpty(): boolean;
+    /**
+     * @description The length of the value
+     */
+    get length(): number;
+    /**
+     * @description Compares the value of the input to see if there is a match
+     */
+    eq(other?: unknown): boolean;
+    /**
+     * @description Set an override value for this
+     */
+    setOverride(override: string): void;
+    /**
+     * @description Returns a hex string representation of the value
+     */
+    toHex(): HexString;
+    /**
+     * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
+     */
+    toHuman(): string;
+    /**
+     * @description Converts the Object to JSON, typically used for RPC transfers
+     */
+    toJSON(): string;
+    /**
+     * @description Returns the base runtime type name for this instance
+     */
+    toRawType(): string;
+    /**
+     * @description Returns the string representation of the value
+     */
+    toString(): 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/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";