@algorandfoundation/algokit-utils 10.0.0-alpha.20 → 10.0.0-alpha.21

package/packages/sdk/src/convert.mjs

@@ -1,25 +0,0 @@
-//#region packages/sdk/src/convert.ts
-const MICROALGOS_TO_ALGOS_RATIO = 1e6;
-const INVALID_MICROALGOS_ERROR_MSG = "Microalgos should be positive and less than 2^53 - 1.";
-/**
-* microalgosToAlgos converts microalgos to algos
-* @param microalgos - number
-* @returns number
-*/
-function microalgosToAlgos(microalgos) {
-	if (microalgos < 0 || !Number.isSafeInteger(microalgos)) throw new Error(INVALID_MICROALGOS_ERROR_MSG);
-	return microalgos / MICROALGOS_TO_ALGOS_RATIO;
-}
-/**
-* algosToMicroalgos converts algos to microalgos
-* @param algos - number
-* @returns number
-*/
-function algosToMicroalgos(algos) {
-	const microalgos = algos * MICROALGOS_TO_ALGOS_RATIO;
-	return Math.round(microalgos);
-}
-
-//#endregion
-export { INVALID_MICROALGOS_ERROR_MSG, algosToMicroalgos, microalgosToAlgos };
-//# sourceMappingURL=convert.mjs.map

package/packages/sdk/src/convert.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"convert.mjs","names":[],"sources":["../../../../packages/sdk/src/convert.ts"],"sourcesContent":["const MICROALGOS_TO_ALGOS_RATIO = 1e6\nexport const INVALID_MICROALGOS_ERROR_MSG = 'Microalgos should be positive and less than 2^53 - 1.'\n\n/**\n * microalgosToAlgos converts microalgos to algos\n * @param microalgos - number\n * @returns number\n */\nexport function microalgosToAlgos(microalgos: number) {\n  if (microalgos < 0 || !Number.isSafeInteger(microalgos)) {\n    throw new Error(INVALID_MICROALGOS_ERROR_MSG)\n  }\n  return microalgos / MICROALGOS_TO_ALGOS_RATIO\n}\n\n/**\n * algosToMicroalgos converts algos to microalgos\n * @param algos - number\n * @returns number\n */\nexport function algosToMicroalgos(algos: number) {\n  const microalgos = algos * MICROALGOS_TO_ALGOS_RATIO\n  return Math.round(microalgos)\n}\n"],"mappings":";AAAA,MAAM,4BAA4B;AAClC,MAAa,+BAA+B;;;;;;AAO5C,SAAgB,kBAAkB,YAAoB;AACpD,KAAI,aAAa,KAAK,CAAC,OAAO,cAAc,WAAW,CACrD,OAAM,IAAI,MAAM,6BAA6B;AAE/C,QAAO,aAAa;;;;;;;AAQtB,SAAgB,kBAAkB,OAAe;CAC/C,MAAM,aAAa,QAAQ;AAC3B,QAAO,KAAK,MAAM,WAAW"}

package/packages/sdk/src/encoding/binarydata.d.ts

@@ -1,34 +0,0 @@
-//#region packages/sdk/src/encoding/binarydata.d.ts
-/**
- * Convert a base64 string to a Uint8Array for Node.js and browser environments.
- * @returns A Uint8Array
- */
-declare function base64ToBytes(base64String: string): Uint8Array;
-/**
- * Convert a Uint8Array to a base64 string for Node.js and browser environments.
- * @returns A base64 string
- */
-declare function bytesToBase64(byteArray: Uint8Array): string;
-/**
- * Convert a byte array to a UTF-8 string. Warning: not all byte arrays are valid UTF-8.
- * @returns A decoded string
- */
-declare function bytesToString(byteArray: Uint8Array): string;
-/**
- * Returns a Uint8Array given an input string or Uint8Array.
- * @returns A base64 string
- */
-declare function coerceToBytes(input: Uint8Array | string): Uint8Array;
-/**
- * Convert a Uint8Array to a hex string for Node.js and browser environments.
- * @returns A hex string
- */
-declare function bytesToHex(byteArray: Uint8Array): string;
-/**
- * Convert a hex string to Uint8Array for Node.js and browser environments.
- * @returns A Uint8Array
- */
-declare function hexToBytes(hexString: string): Uint8Array;
-//#endregion
-export { base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, hexToBytes };
-//# sourceMappingURL=binarydata.d.ts.map

package/packages/sdk/src/encoding/binarydata.js

@@ -1,65 +0,0 @@
-const require_utils = require('../utils/utils.js');
-
-//#region packages/sdk/src/encoding/binarydata.ts
-/**
-* Convert a base64 string to a Uint8Array for Node.js and browser environments.
-* @returns A Uint8Array
-*/
-function base64ToBytes(base64String) {
-	if (require_utils.isNode()) return new Uint8Array(Buffer.from(base64String, "base64"));
-	const binString = atob(base64String);
-	return Uint8Array.from(binString, (m) => m.codePointAt(0));
-}
-/**
-* Convert a Uint8Array to a base64 string for Node.js and browser environments.
-* @returns A base64 string
-*/
-function bytesToBase64(byteArray) {
-	if (require_utils.isNode()) return Buffer.from(byteArray).toString("base64");
-	const binString = Array.from(byteArray, (x) => String.fromCodePoint(x)).join("");
-	return btoa(binString);
-}
-/**
-* Convert a byte array to a UTF-8 string. Warning: not all byte arrays are valid UTF-8.
-* @returns A decoded string
-*/
-function bytesToString(byteArray) {
-	return new TextDecoder().decode(byteArray);
-}
-/**
-* Returns a Uint8Array given an input string or Uint8Array.
-* @returns A base64 string
-*/
-function coerceToBytes(input) {
-	if (typeof input === "string") return new TextEncoder().encode(input);
-	return input;
-}
-/**
-* Convert a Uint8Array to a hex string for Node.js and browser environments.
-* @returns A hex string
-*/
-function bytesToHex(byteArray) {
-	if (require_utils.isNode()) return Buffer.from(byteArray).toString("hex");
-	return Array.from(byteArray).map((i) => i.toString(16).padStart(2, "0")).join("");
-}
-/**
-* Convert a hex string to Uint8Array for Node.js and browser environments.
-* @returns A Uint8Array
-*/
-function hexToBytes(hexString) {
-	if (require_utils.isNode()) return Buffer.from(hexString, "hex");
-	let hex = hexString;
-	if (hexString.length % 2 !== 0) hex = hexString.padStart(1, "0");
-	const byteArray = new Uint8Array(hex.length / 2);
-	for (let i = 0; i < hex.length / 2; i++) byteArray[i] = parseInt(hex.slice(2 * i, 2 * i + 2), 16);
-	return byteArray;
-}
-
-//#endregion
-exports.base64ToBytes = base64ToBytes;
-exports.bytesToBase64 = bytesToBase64;
-exports.bytesToHex = bytesToHex;
-exports.bytesToString = bytesToString;
-exports.coerceToBytes = coerceToBytes;
-exports.hexToBytes = hexToBytes;
-//# sourceMappingURL=binarydata.js.map

package/packages/sdk/src/encoding/binarydata.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"binarydata.js","names":["isNode"],"sources":["../../../../../packages/sdk/src/encoding/binarydata.ts"],"sourcesContent":["import { isNode } from '../utils/utils.js'\n\n/**\n * Convert a base64 string to a Uint8Array for Node.js and browser environments.\n * @returns A Uint8Array\n */\nexport function base64ToBytes(base64String: string): Uint8Array {\n  if (isNode()) {\n    return new Uint8Array(Buffer.from(base64String, 'base64'))\n  }\n  /* eslint-env browser */\n  const binString = atob(base64String)\n  return Uint8Array.from(binString, (m) => m.codePointAt(0)!)\n}\n\n/**\n * Convert a Uint8Array to a base64 string for Node.js and browser environments.\n * @returns A base64 string\n */\nexport function bytesToBase64(byteArray: Uint8Array): string {\n  if (isNode()) {\n    return Buffer.from(byteArray).toString('base64')\n  }\n  /* eslint-env browser */\n  const binString = Array.from(byteArray, (x) => String.fromCodePoint(x)).join('')\n  return btoa(binString)\n}\n\n/**\n * Convert a byte array to a UTF-8 string. Warning: not all byte arrays are valid UTF-8.\n * @returns A decoded string\n */\nexport function bytesToString(byteArray: Uint8Array): string {\n  return new TextDecoder().decode(byteArray)\n}\n\n/**\n * Returns a Uint8Array given an input string or Uint8Array.\n * @returns A base64 string\n */\nexport function coerceToBytes(input: Uint8Array | string): Uint8Array {\n  if (typeof input === 'string') {\n    return new TextEncoder().encode(input)\n  }\n  return input\n}\n\n/**\n * Convert a Uint8Array to a hex string for Node.js and browser environments.\n * @returns A hex string\n */\nexport function bytesToHex(byteArray: Uint8Array): string {\n  if (isNode()) {\n    return Buffer.from(byteArray).toString('hex')\n  }\n  return Array.from(byteArray)\n    .map((i) => i.toString(16).padStart(2, '0'))\n    .join('')\n}\n\n/**\n * Convert a hex string to Uint8Array for Node.js and browser environments.\n * @returns A Uint8Array\n */\nexport function hexToBytes(hexString: string): Uint8Array {\n  if (isNode()) {\n    return Buffer.from(hexString, 'hex')\n  }\n  let hex = hexString\n  if (hexString.length % 2 !== 0) {\n    hex = hexString.padStart(1, '0')\n  }\n  const byteArray = new Uint8Array(hex.length / 2)\n  for (let i = 0; i < hex.length / 2; i++) {\n    byteArray[i] = parseInt(hex.slice(2 * i, 2 * i + 2), 16)\n  }\n  return byteArray\n}\n"],"mappings":";;;;;;;AAMA,SAAgB,cAAc,cAAkC;AAC9D,KAAIA,sBAAQ,CACV,QAAO,IAAI,WAAW,OAAO,KAAK,cAAc,SAAS,CAAC;CAG5D,MAAM,YAAY,KAAK,aAAa;AACpC,QAAO,WAAW,KAAK,YAAY,MAAM,EAAE,YAAY,EAAE,CAAE;;;;;;AAO7D,SAAgB,cAAc,WAA+B;AAC3D,KAAIA,sBAAQ,CACV,QAAO,OAAO,KAAK,UAAU,CAAC,SAAS,SAAS;CAGlD,MAAM,YAAY,MAAM,KAAK,YAAY,MAAM,OAAO,cAAc,EAAE,CAAC,CAAC,KAAK,GAAG;AAChF,QAAO,KAAK,UAAU;;;;;;AAOxB,SAAgB,cAAc,WAA+B;AAC3D,QAAO,IAAI,aAAa,CAAC,OAAO,UAAU;;;;;;AAO5C,SAAgB,cAAc,OAAwC;AACpE,KAAI,OAAO,UAAU,SACnB,QAAO,IAAI,aAAa,CAAC,OAAO,MAAM;AAExC,QAAO;;;;;;AAOT,SAAgB,WAAW,WAA+B;AACxD,KAAIA,sBAAQ,CACV,QAAO,OAAO,KAAK,UAAU,CAAC,SAAS,MAAM;AAE/C,QAAO,MAAM,KAAK,UAAU,CACzB,KAAK,MAAM,EAAE,SAAS,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAC3C,KAAK,GAAG;;;;;;AAOb,SAAgB,WAAW,WAA+B;AACxD,KAAIA,sBAAQ,CACV,QAAO,OAAO,KAAK,WAAW,MAAM;CAEtC,IAAI,MAAM;AACV,KAAI,UAAU,SAAS,MAAM,EAC3B,OAAM,UAAU,SAAS,GAAG,IAAI;CAElC,MAAM,YAAY,IAAI,WAAW,IAAI,SAAS,EAAE;AAChD,MAAK,IAAI,IAAI,GAAG,IAAI,IAAI,SAAS,GAAG,IAClC,WAAU,KAAK,SAAS,IAAI,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG;AAE1D,QAAO"}

package/packages/sdk/src/encoding/binarydata.mjs

@@ -1,60 +0,0 @@
-import { isNode } from "../utils/utils.mjs";
-
-//#region packages/sdk/src/encoding/binarydata.ts
-/**
-* Convert a base64 string to a Uint8Array for Node.js and browser environments.
-* @returns A Uint8Array
-*/
-function base64ToBytes(base64String) {
-	if (isNode()) return new Uint8Array(Buffer.from(base64String, "base64"));
-	const binString = atob(base64String);
-	return Uint8Array.from(binString, (m) => m.codePointAt(0));
-}
-/**
-* Convert a Uint8Array to a base64 string for Node.js and browser environments.
-* @returns A base64 string
-*/
-function bytesToBase64(byteArray) {
-	if (isNode()) return Buffer.from(byteArray).toString("base64");
-	const binString = Array.from(byteArray, (x) => String.fromCodePoint(x)).join("");
-	return btoa(binString);
-}
-/**
-* Convert a byte array to a UTF-8 string. Warning: not all byte arrays are valid UTF-8.
-* @returns A decoded string
-*/
-function bytesToString(byteArray) {
-	return new TextDecoder().decode(byteArray);
-}
-/**
-* Returns a Uint8Array given an input string or Uint8Array.
-* @returns A base64 string
-*/
-function coerceToBytes(input) {
-	if (typeof input === "string") return new TextEncoder().encode(input);
-	return input;
-}
-/**
-* Convert a Uint8Array to a hex string for Node.js and browser environments.
-* @returns A hex string
-*/
-function bytesToHex(byteArray) {
-	if (isNode()) return Buffer.from(byteArray).toString("hex");
-	return Array.from(byteArray).map((i) => i.toString(16).padStart(2, "0")).join("");
-}
-/**
-* Convert a hex string to Uint8Array for Node.js and browser environments.
-* @returns A Uint8Array
-*/
-function hexToBytes(hexString) {
-	if (isNode()) return Buffer.from(hexString, "hex");
-	let hex = hexString;
-	if (hexString.length % 2 !== 0) hex = hexString.padStart(1, "0");
-	const byteArray = new Uint8Array(hex.length / 2);
-	for (let i = 0; i < hex.length / 2; i++) byteArray[i] = parseInt(hex.slice(2 * i, 2 * i + 2), 16);
-	return byteArray;
-}
-
-//#endregion
-export { base64ToBytes, bytesToBase64, bytesToHex, bytesToString, coerceToBytes, hexToBytes };
-//# sourceMappingURL=binarydata.mjs.map

package/packages/sdk/src/encoding/binarydata.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"binarydata.mjs","names":[],"sources":["../../../../../packages/sdk/src/encoding/binarydata.ts"],"sourcesContent":["import { isNode } from '../utils/utils.js'\n\n/**\n * Convert a base64 string to a Uint8Array for Node.js and browser environments.\n * @returns A Uint8Array\n */\nexport function base64ToBytes(base64String: string): Uint8Array {\n  if (isNode()) {\n    return new Uint8Array(Buffer.from(base64String, 'base64'))\n  }\n  /* eslint-env browser */\n  const binString = atob(base64String)\n  return Uint8Array.from(binString, (m) => m.codePointAt(0)!)\n}\n\n/**\n * Convert a Uint8Array to a base64 string for Node.js and browser environments.\n * @returns A base64 string\n */\nexport function bytesToBase64(byteArray: Uint8Array): string {\n  if (isNode()) {\n    return Buffer.from(byteArray).toString('base64')\n  }\n  /* eslint-env browser */\n  const binString = Array.from(byteArray, (x) => String.fromCodePoint(x)).join('')\n  return btoa(binString)\n}\n\n/**\n * Convert a byte array to a UTF-8 string. Warning: not all byte arrays are valid UTF-8.\n * @returns A decoded string\n */\nexport function bytesToString(byteArray: Uint8Array): string {\n  return new TextDecoder().decode(byteArray)\n}\n\n/**\n * Returns a Uint8Array given an input string or Uint8Array.\n * @returns A base64 string\n */\nexport function coerceToBytes(input: Uint8Array | string): Uint8Array {\n  if (typeof input === 'string') {\n    return new TextEncoder().encode(input)\n  }\n  return input\n}\n\n/**\n * Convert a Uint8Array to a hex string for Node.js and browser environments.\n * @returns A hex string\n */\nexport function bytesToHex(byteArray: Uint8Array): string {\n  if (isNode()) {\n    return Buffer.from(byteArray).toString('hex')\n  }\n  return Array.from(byteArray)\n    .map((i) => i.toString(16).padStart(2, '0'))\n    .join('')\n}\n\n/**\n * Convert a hex string to Uint8Array for Node.js and browser environments.\n * @returns A Uint8Array\n */\nexport function hexToBytes(hexString: string): Uint8Array {\n  if (isNode()) {\n    return Buffer.from(hexString, 'hex')\n  }\n  let hex = hexString\n  if (hexString.length % 2 !== 0) {\n    hex = hexString.padStart(1, '0')\n  }\n  const byteArray = new Uint8Array(hex.length / 2)\n  for (let i = 0; i < hex.length / 2; i++) {\n    byteArray[i] = parseInt(hex.slice(2 * i, 2 * i + 2), 16)\n  }\n  return byteArray\n}\n"],"mappings":";;;;;;;AAMA,SAAgB,cAAc,cAAkC;AAC9D,KAAI,QAAQ,CACV,QAAO,IAAI,WAAW,OAAO,KAAK,cAAc,SAAS,CAAC;CAG5D,MAAM,YAAY,KAAK,aAAa;AACpC,QAAO,WAAW,KAAK,YAAY,MAAM,EAAE,YAAY,EAAE,CAAE;;;;;;AAO7D,SAAgB,cAAc,WAA+B;AAC3D,KAAI,QAAQ,CACV,QAAO,OAAO,KAAK,UAAU,CAAC,SAAS,SAAS;CAGlD,MAAM,YAAY,MAAM,KAAK,YAAY,MAAM,OAAO,cAAc,EAAE,CAAC,CAAC,KAAK,GAAG;AAChF,QAAO,KAAK,UAAU;;;;;;AAOxB,SAAgB,cAAc,WAA+B;AAC3D,QAAO,IAAI,aAAa,CAAC,OAAO,UAAU;;;;;;AAO5C,SAAgB,cAAc,OAAwC;AACpE,KAAI,OAAO,UAAU,SACnB,QAAO,IAAI,aAAa,CAAC,OAAO,MAAM;AAExC,QAAO;;;;;;AAOT,SAAgB,WAAW,WAA+B;AACxD,KAAI,QAAQ,CACV,QAAO,OAAO,KAAK,UAAU,CAAC,SAAS,MAAM;AAE/C,QAAO,MAAM,KAAK,UAAU,CACzB,KAAK,MAAM,EAAE,SAAS,GAAG,CAAC,SAAS,GAAG,IAAI,CAAC,CAC3C,KAAK,GAAG;;;;;;AAOb,SAAgB,WAAW,WAA+B;AACxD,KAAI,QAAQ,CACV,QAAO,OAAO,KAAK,WAAW,MAAM;CAEtC,IAAI,MAAM;AACV,KAAI,UAAU,SAAS,MAAM,EAC3B,OAAM,UAAU,SAAS,GAAG,IAAI;CAElC,MAAM,YAAY,IAAI,WAAW,IAAI,SAAS,EAAE;AAChD,MAAK,IAAI,IAAI,GAAG,IAAI,IAAI,SAAS,GAAG,IAClC,WAAU,KAAK,SAAS,IAAI,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG;AAE1D,QAAO"}

package/packages/sdk/src/encoding/encoding.d.ts

@@ -1,237 +0,0 @@
-import { IntDecoding } from "../types/intDecoding.js";
-import { RawBinaryString } from "algorand-msgpack";
-
-//#region packages/sdk/src/encoding/encoding.d.ts
-
-declare const ERROR_CONTAINS_EMPTY_STRING = "The object contains empty or 0 values. First empty or 0 value encountered during encoding: ";
-/**
- * msgpackRawEncode encodes objects using msgpack, regardless of whether there are
- * empty or 0 value fields.
- * @param obj - a dictionary to be encoded. May or may not contain empty or 0 values.
- * @returns msgpack representation of the object
- */
-declare function msgpackRawEncode(obj: unknown): Uint8Array;
-/**
- * encodeObj takes a javascript object and returns its msgpack encoding
- * Note that the encoding sorts the fields alphabetically
- * @param o - js object to be encoded. Must not contain empty or 0 values.
- * @returns Uint8Array binary representation
- * @throws Error containing ERROR_CONTAINS_EMPTY_STRING if the object contains empty or zero values
- *
- * @deprecated Use {@link msgpackRawEncode} instead. Note that function does not
- *   check for empty values like this one does.
- */
-declare function encodeObj(obj: Record<string | number | symbol, any>): Uint8Array;
-/**
- * Decodes msgpack bytes into a plain JavaScript object.
- * @param buffer - The msgpack bytes to decode
- * @param options - Options for decoding, including int decoding mode. See {@link IntDecoding} for more information.
- * @returns The decoded object
- */
-declare function msgpackRawDecode(buffer: ArrayLike<number>, options?: {
-  intDecoding: IntDecoding;
-}): unknown;
-/**
- * decodeObj takes a Uint8Array and returns its javascript obj
- * @param o - Uint8Array to decode
- * @returns object
- *
- * @deprecated Use {@link msgpackRawDecode} instead. Note that this function uses `IntDecoding.MIXED`
- *   while `msgpackRawDecode` defaults to `IntDecoding.BIGINT` for int decoding, though it is
- *   configurable.
- */
-declare function decodeObj(o: ArrayLike<number>): unknown;
-/**
- * Decodes msgpack bytes into a Map object. This supports decoding non-string map keys.
- * @param encoded - The msgpack bytes to decode
- * @param options - Options for decoding, including int decoding mode. See {@link IntDecoding} for more information.
- * @returns The decoded Map object
- */
-declare function msgpackRawDecodeAsMap(encoded: ArrayLike<number>, options?: {
-  intDecoding: IntDecoding;
-}): unknown;
-type MsgpackEncodingData = null | undefined | string | number | bigint | boolean | Uint8Array | MsgpackEncodingData[] | Map<string | number | bigint | Uint8Array, MsgpackEncodingData>;
-type JSONEncodingData = null | undefined | string | number | bigint | boolean | JSONEncodingData[] | {
-  [key: string]: JSONEncodingData;
-};
-declare function msgpackEncodingDataToJSONEncodingData(e: MsgpackEncodingData): JSONEncodingData;
-declare function jsonEncodingDataToMsgpackEncodingData(e: JSONEncodingData): MsgpackEncodingData;
-declare enum MsgpackObjectPathSegmentKind {
-  MAP_VALUE = 0,
-  ARRAY_ELEMENT = 1,
-}
-interface MsgpackObjectPathSegment {
-  kind: MsgpackObjectPathSegmentKind;
-  key: string | number | bigint | Uint8Array | RawBinaryString;
-}
-/**
- * This class is used to index into an encoded msgpack object and extract raw strings.
- */
-declare class MsgpackRawStringProvider {
-  private readonly parent?;
-  private readonly baseObjectBytes?;
-  private readonly segment?;
-  private resolvedCache;
-  private resolvedCachePresent;
-  constructor({
-    parent,
-    segment,
-    baseObjectBytes
-  }: {
-    parent: MsgpackRawStringProvider;
-    segment: MsgpackObjectPathSegment;
-    baseObjectBytes?: undefined;
-  } | {
-    parent?: undefined;
-    segment?: undefined;
-    baseObjectBytes: ArrayLike<number>;
-  });
-  /**
-   * Create a new provider that resolves to the current provider's map value at the given key.
-   */
-  withMapValue(key: string | number | bigint | Uint8Array | RawBinaryString): MsgpackRawStringProvider;
-  /**
-   * Create a new provider that resolves to the current provider's array element at the given index.
-   */
-  withArrayElement(index: number): MsgpackRawStringProvider;
-  /**
-   * Get the raw string at the current location. If the current location is not a raw string, an error is thrown.
-   */
-  getRawStringAtCurrentLocation(): Uint8Array;
-  /**
-   * Get the raw string map keys and values at the current location. If the current location is not a map, an error is thrown.
-   */
-  getRawStringKeysAndValuesAtCurrentLocation(): Map<Uint8Array, MsgpackEncodingData>;
-  /**
-   * Resolve the provider by extracting the value it indicates from the base msgpack object.
-   */
-  private resolve;
-  /**
-   * Get the path string of the current location indicated by the provider. Useful for debugging.
-   */
-  getPathString(): string;
-}
-/**
- * Options for {@link Schema.prepareJSON}
- */
-interface PrepareJSONOptions {
-  /**
-   * If true, allows invalid UTF-8 binary strings to be converted to JSON strings.
-   *
-   * Otherwise, an error will be thrown if encoding a binary string to a JSON cannot be done losslessly.
-   */
-  lossyBinaryStringConversion?: boolean;
-}
-/**
- * A Schema is used to prepare objects for encoding and decoding from msgpack and JSON.
- *
- * Schemas represent a specific type.
- */
-declare abstract class Schema {
-  /**
-   * Get the default value for this type.
-   */
-  abstract defaultValue(): unknown;
-  /**
-   * Checks if the value is the default value for this type.
-   * @param data - The value to check
-   * @returns True if the value is the default value, false otherwise
-   */
-  abstract isDefaultValue(data: unknown): boolean;
-  /**
-   * Prepares the encoding data for encoding to msgpack.
-   * @param data - Encoding data to be prepared.
-   * @returns A value ready to be msgpack encoded.
-   */
-  abstract prepareMsgpack(data: unknown): MsgpackEncodingData;
-  /**
-   * Restores the encoding data from a msgpack encoding object.
-   * @param encoded - The msgpack encoding object to restore.
-   * @param rawStringProvider - A provider for raw strings.
-   * @returns The original encoding data.
-   */
-  abstract fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): unknown;
-  /**
-   * Prepares the encoding data for encoding to JSON.
-   * @param data - The JSON encoding data to be prepared.
-   * @returns A value ready to be JSON encoded.
-   */
-  abstract prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData;
-  /**
-   * Restores the encoding data from a JSON encoding object.
-   * @param encoded - The JSON encoding object to restore.
-   * @returns The original encoding data.
-   */
-  abstract fromPreparedJSON(encoded: JSONEncodingData): unknown;
-}
-/**
- * An interface for objects that can be encoded and decoded to/from msgpack and JSON.
- */
-interface Encodable {
-  /**
-   * Extract the encoding data for this object. This data, after being prepared by the encoding
-   * Schema, can be encoded to msgpack or JSON.
-   */
-  toEncodingData(): unknown;
-  /**
-   * Get the encoding Schema for this object, used to prepare the encoding data for msgpack and JSON.
-   */
-  getEncodingSchema(): Schema;
-}
-/**
- * A type that represents the class of an Encodable object.
- */
-interface EncodableClass<T extends Encodable> {
-  /**
-   * Create a new instance of this class from the given encoding data.
-   * @param data - The encoding data to create the object from
-   */
-  fromEncodingData(data: unknown): T;
-  /**
-   * The encoding Schema for this class, used to prepare encoding data from msgpack and JSON.
-   */
-  readonly encodingSchema: Schema;
-}
-/**
- * Decode a msgpack byte array to an Encodable object.
- * @param encoded - The msgpack bytes to decode
- * @param c - The class of the object to decode. This class must match the object that was encoded.
- * @returns An instance of the class with the decoded data
- */
-declare function decodeMsgpack<T extends Encodable>(encoded: ArrayLike<number>, c: EncodableClass<T>): T;
-/**
- * Encode an Encodable object to a msgpack byte array.
- * @param e - The object to encode
- * @returns A msgpack byte array encoding of the object
- */
-declare function encodeMsgpack(e: Encodable): Uint8Array;
-/**
- * Decode a JSON string to an Encodable object.
- * @param encoded - The JSON string to decode
- * @param c - The class of the object to decode. This class must match the object that was encoded.
- * @returns An instance of the class with the decoded data
- */
-declare function decodeJSON<T extends Encodable>(encoded: string, c: EncodableClass<T>): T;
-interface EncodeJSONOptions {
-  /**
-   * Adds indentation, white space, and line break characters to the return-value JSON text to make
-   * it easier to read.
-   */
-  space?: string | number;
-  /**
-   * If true, allows invalid UTF-8 binary strings to be converted to JSON strings.
-   *
-   * Otherwise, an error will be thrown if encoding a binary string to a JSON cannot be done losslessly.
-   */
-  lossyBinaryStringConversion?: boolean;
-}
-/**
- * Encode an Encodable object to a JSON string.
- * @param e - The object to encode
- * @param options - Optional encoding options. See {@link EncodeJSONOptions} for more information.
- * @returns A JSON string encoding of the object
- */
-declare function encodeJSON(e: Encodable, options?: EncodeJSONOptions): string;
-//#endregion
-export { ERROR_CONTAINS_EMPTY_STRING, Encodable, EncodableClass, EncodeJSONOptions, JSONEncodingData, MsgpackEncodingData, MsgpackRawStringProvider, PrepareJSONOptions, Schema, decodeJSON, decodeMsgpack, decodeObj, encodeJSON, encodeMsgpack, encodeObj, jsonEncodingDataToMsgpackEncodingData, msgpackEncodingDataToJSONEncodingData, msgpackRawDecode, msgpackRawDecodeAsMap, msgpackRawEncode };
-//# sourceMappingURL=encoding.d.ts.map