@algorandfoundation/algokit-utils 9.2.0 → 10.0.0-alpha.10

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

@@ -0,0 +1,108 @@
+const require_encoding = require('../encoding.js');
+let algorand_msgpack = require("algorand-msgpack");
+
+//#region packages/sdk/src/encoding/schema/map.ts
+/**
+* Applies the omitEmpty flag to all entries in the array.
+* @param entries - The entries to apply the flag to.
+* @returns A new array with the omitEmpty flag applied to all entries.
+*/
+function allOmitEmpty(entries) {
+	return entries.map((entry) => ({
+		...entry,
+		omitEmpty: true
+	}));
+}
+/**
+* Schema for a map/struct with a fixed set of known string fields.
+*/
+var NamedMapSchema = class NamedMapSchema extends require_encoding.Schema {
+	entries;
+	constructor(entries) {
+		super();
+		this.entries = entries;
+		this.checkEntries();
+	}
+	/**
+	* Adds new entries to the map schema. WARNING: this is a mutable operation, and you should be very
+	* careful when using it. Any error that happens here is non-recoverable and will corrupt the
+	* NamedMapSchema object;
+	* @param entries - The entries to add.
+	*/
+	pushEntries(...entries) {
+		this.entries.push(...entries);
+		this.checkEntries();
+	}
+	checkEntries() {
+		for (const entry of this.entries) if (entry.embedded) {
+			if (entry.key !== "") throw new Error("Embedded entries must have an empty key");
+			if (!(entry.valueSchema instanceof NamedMapSchema)) throw new Error("Embedded entry valueSchema must be a NamedMapSchema");
+		}
+		const keys = /* @__PURE__ */ new Set();
+		for (const entry of this.getEntries()) {
+			if (keys.has(entry.key)) throw new Error(`Duplicate key: ${entry.key}`);
+			keys.add(entry.key);
+		}
+	}
+	/**
+	* Returns all top-level entries, properly accounting for fields from embedded entries.
+	* @returns An array of all top-level entries for this map.
+	*/
+	getEntries() {
+		const entries = [];
+		for (const entry of this.entries) if (entry.embedded) entries.push(...entry.valueSchema.getEntries());
+		else entries.push(entry);
+		return entries;
+	}
+	defaultValue() {
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) map.set(entry.key, entry.valueSchema.defaultValue());
+		return map;
+	}
+	isDefaultValue(data) {
+		if (!(data instanceof Map)) return false;
+		for (const entry of this.getEntries()) if (!entry.valueSchema.isDefaultValue(data.get(entry.key))) return false;
+		return true;
+	}
+	prepareMsgpack(data) {
+		if (!(data instanceof Map)) throw new Error(`NamedMapSchema data must be a Map. Got (${typeof data}) ${data}`);
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) {
+			const value = data.get(entry.key);
+			if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) continue;
+			map.set(entry.key, entry.valueSchema.prepareMsgpack(value));
+		}
+		return map;
+	}
+	fromPreparedMsgpack(encoded, rawStringProvider) {
+		if (!(encoded instanceof Map)) throw new Error("NamedMapSchema data must be a Map");
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) if (encoded.has(entry.key)) map.set(entry.key, entry.valueSchema.fromPreparedMsgpack(encoded.get(entry.key), rawStringProvider.withMapValue(entry.key)));
+		else if (entry.omitEmpty) map.set(entry.key, entry.valueSchema.defaultValue());
+		else throw new Error(`Missing key: ${entry.key}`);
+		return map;
+	}
+	prepareJSON(data, options) {
+		if (!(data instanceof Map)) throw new Error("NamedMapSchema data must be a Map");
+		const obj = {};
+		for (const entry of this.getEntries()) {
+			const value = data.get(entry.key);
+			if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) continue;
+			obj[entry.key] = entry.valueSchema.prepareJSON(value, options);
+		}
+		return obj;
+	}
+	fromPreparedJSON(encoded) {
+		if (encoded == null || typeof encoded !== "object" || Array.isArray(encoded)) throw new Error("NamedMapSchema data must be an object");
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) if (Object.prototype.hasOwnProperty.call(encoded, entry.key)) map.set(entry.key, entry.valueSchema.fromPreparedJSON(encoded[entry.key]));
+		else if (entry.omitEmpty) map.set(entry.key, entry.valueSchema.defaultValue());
+		else throw new Error(`Missing key: ${entry.key}`);
+		return map;
+	}
+};
+
+//#endregion
+exports.NamedMapSchema = NamedMapSchema;
+exports.allOmitEmpty = allOmitEmpty;
+//# sourceMappingURL=map.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.js","names":["Schema","entries: NamedMapEntry[]","obj: { [key: string]: JSONEncodingData }"],"sources":["../../../../../../packages/sdk/src/encoding/schema/map.ts"],"sourcesContent":["import { RawBinaryString } from 'algorand-msgpack'\nimport { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\nimport { ensureUint64, arrayEqual } from '../../utils/utils.js'\nimport { bytesToString, coerceToBytes, bytesToBase64, base64ToBytes } from '../binarydata.js'\n\n/* eslint-disable class-methods-use-this */\n\n/**\n * Describes a key-value entry in a NamedMapSchema.\n */\nexport interface NamedMapEntry {\n  /**\n   * Key of the entry. Must be unique for this map.\n   */\n  key: string\n  /**\n   * The Schema for the entry's value.\n   */\n  valueSchema: Schema\n  /**\n   * If true, the entry will be omitted from the encoding if the value is the default value.\n   */\n  omitEmpty: boolean\n  /**\n   * If true, valueSchema must be a NamedMapSchema and key must be the empty string. The fields of\n   * valueSchema will be embedded directly in the parent map.\n   *\n   * omitEmpty is ignored for embedded entries. Instead, the individual omitEmpty values of the\n   * embedded fields are used.\n   */\n  embedded?: boolean\n}\n\n/**\n * Applies the omitEmpty flag to all entries in the array.\n * @param entries - The entries to apply the flag to.\n * @returns A new array with the omitEmpty flag applied to all entries.\n */\nexport function allOmitEmpty(entries: Array<Omit<NamedMapEntry, 'omitEmpty'>>): NamedMapEntry[] {\n  return entries.map((entry) => ({ ...entry, omitEmpty: true }))\n}\n\n/**\n * Schema for a map/struct with a fixed set of known string fields.\n */\nexport class NamedMapSchema extends Schema {\n  private readonly entries: NamedMapEntry[]\n\n  constructor(entries: NamedMapEntry[]) {\n    super()\n    this.entries = entries\n    this.checkEntries()\n  }\n\n  /**\n   * Adds new entries to the map schema. WARNING: this is a mutable operation, and you should be very\n   * careful when using it. Any error that happens here is non-recoverable and will corrupt the\n   * NamedMapSchema object;\n   * @param entries - The entries to add.\n   */\n  public pushEntries(...entries: NamedMapEntry[]) {\n    this.entries.push(...entries)\n    this.checkEntries()\n  }\n\n  private checkEntries() {\n    for (const entry of this.entries) {\n      if (entry.embedded) {\n        if (entry.key !== '') {\n          throw new Error('Embedded entries must have an empty key')\n        }\n        if (!(entry.valueSchema instanceof NamedMapSchema)) {\n          throw new Error('Embedded entry valueSchema must be a NamedMapSchema')\n        }\n      }\n    }\n\n    const keys = new Set<string>()\n    for (const entry of this.getEntries()) {\n      if (keys.has(entry.key)) {\n        throw new Error(`Duplicate key: ${entry.key}`)\n      }\n      keys.add(entry.key)\n    }\n  }\n\n  /**\n   * Returns all top-level entries, properly accounting for fields from embedded entries.\n   * @returns An array of all top-level entries for this map.\n   */\n  public getEntries(): NamedMapEntry[] {\n    const entries: NamedMapEntry[] = []\n    for (const entry of this.entries) {\n      if (entry.embedded) {\n        const embeddedMapSchema = entry.valueSchema as NamedMapSchema\n        entries.push(...embeddedMapSchema.getEntries())\n      } else {\n        entries.push(entry)\n      }\n    }\n    return entries\n  }\n\n  public defaultValue(): Map<string, unknown> {\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      map.set(entry.key, entry.valueSchema.defaultValue())\n    }\n    return map\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    if (!(data instanceof Map)) return false\n    for (const entry of this.getEntries()) {\n      if (!entry.valueSchema.isDefaultValue(data.get(entry.key))) {\n        return false\n      }\n    }\n    return true\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`NamedMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const map = new Map<string, MsgpackEncodingData>()\n    for (const entry of this.getEntries()) {\n      const value = data.get(entry.key)\n      if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) {\n        continue\n      }\n      map.set(entry.key, entry.valueSchema.prepareMsgpack(value))\n    }\n    return map\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<string, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('NamedMapSchema data must be a Map')\n    }\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      if (encoded.has(entry.key)) {\n        map.set(entry.key, entry.valueSchema.fromPreparedMsgpack(encoded.get(entry.key), rawStringProvider.withMapValue(entry.key)))\n      } else if (entry.omitEmpty) {\n        map.set(entry.key, entry.valueSchema.defaultValue())\n      } else {\n        throw new Error(`Missing key: ${entry.key}`)\n      }\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error('NamedMapSchema data must be a Map')\n    }\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const entry of this.getEntries()) {\n      const value = data.get(entry.key)\n      if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) {\n        continue\n      }\n      obj[entry.key] = entry.valueSchema.prepareJSON(value, options)\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<string, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('NamedMapSchema data must be an object')\n    }\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      if (Object.prototype.hasOwnProperty.call(encoded, entry.key)) {\n        map.set(entry.key, entry.valueSchema.fromPreparedJSON(encoded[entry.key]))\n      } else if (entry.omitEmpty) {\n        map.set(entry.key, entry.valueSchema.defaultValue())\n      } else {\n        throw new Error(`Missing key: ${entry.key}`)\n      }\n    }\n    return map\n  }\n}\n\n/**\n * Combines multiple maps into a single map. Throws an error if any of the maps have duplicate keys.\n * @param maps - The maps to combine.\n * @returns A new map with all the entries from the input maps.\n */\nexport function combineMaps<K, V>(...maps: Array<Map<K, V>>): Map<K, V> {\n  const combined = new Map<K, V>()\n  for (const map of maps) {\n    for (const [key, value] of map) {\n      if (combined.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      combined.set(key, value)\n    }\n  }\n  return combined\n}\n\n/**\n * Converts a map to a new map with different keys and values.\n * @param map - The map to convert.\n * @param func - The function to convert each entry.\n * @returns A new map with the converted entries.\n */\nexport function convertMap<K1, V1, K2, V2>(map: Map<K1, V1>, func: (k: K1, v: V1) => [K2, V2]): Map<K2, V2> {\n  const mapped = new Map<K2, V2>()\n  for (const [key, value] of map) {\n    const [newKey, newValue] = func(key, value)\n    mapped.set(newKey, newValue)\n  }\n  return mapped\n}\n\n/**\n * Schema for a map with a variable number of uint64 keys.\n */\nexport class Uint64MapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<bigint, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`Uint64MapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<bigint, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      const bigintKey = ensureUint64(key)\n      if (prepared.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      prepared.set(bigintKey, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<bigint, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('Uint64MapSchema data must be a Map')\n    }\n    const map = new Map<bigint, unknown>()\n    for (const [key, value] of encoded) {\n      const bigintKey = ensureUint64(key)\n      if (map.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      map.set(bigintKey, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`Uint64MapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<bigint, JSONEncodingData>()\n    for (const [key, value] of data) {\n      const bigintKey = ensureUint64(key)\n      if (prepared.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      prepared.set(bigintKey, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key.toString()] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<bigint, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('Uint64MapSchema data must be an object')\n    }\n    const map = new Map<bigint, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      const bigintKey = BigInt(key)\n      if (map.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      map.set(bigintKey, this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Schema for a map with a variable number of string keys.\n */\nexport class StringMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<string, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`StringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (prepared.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      prepared.set(key, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<string, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('StringMapSchema data must be a Map')\n    }\n    const map = new Map<string, unknown>()\n    for (const [key, value] of encoded) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (map.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      map.set(key, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`StringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (prepared.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      prepared.set(key, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<string, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('StringMapSchema data must be an object')\n    }\n    const map = new Map<string, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      if (map.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      map.set(key, this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Schema for a map with a variable number of byte array keys.\n */\nexport class ByteArrayMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<Uint8Array, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`ByteArrayMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<Uint8Array, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      prepared.set(key, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<Uint8Array, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('ByteArrayMapSchema data must be a Map')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of encoded) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      map.set(key, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`ByteArrayMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      const b64Encoded = bytesToBase64(key)\n      if (prepared.has(b64Encoded)) {\n        throw new Error(`Duplicate key (base64): ${b64Encoded}`)\n      }\n      prepared.set(b64Encoded, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<Uint8Array, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('ByteArrayMapSchema data must be an object')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      map.set(base64ToBytes(key), this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Converts any RawBinaryString values to regular strings in a MsgpackEncodingData object.\n *\n * Note this conversion may be lossy if the binary data is not valid UTF-8.\n *\n * @returns A new object with RawBinaryString values converted to strings.\n */\nfunction convertRawStringsInMsgpackValue(value: MsgpackEncodingData): MsgpackEncodingData {\n  if (value instanceof RawBinaryString) {\n    return bytesToString(value.rawBinaryValue as Uint8Array)\n  }\n  if (value instanceof Map) {\n    const newMap = new Map<string | number | bigint | Uint8Array, MsgpackEncodingData>()\n    for (const [key, val] of value) {\n      newMap.set(convertRawStringsInMsgpackValue(key) as string | number | bigint | Uint8Array, convertRawStringsInMsgpackValue(val))\n    }\n    return newMap\n  }\n  if (Array.isArray(value)) {\n    return value.map(convertRawStringsInMsgpackValue)\n  }\n  return value\n}\n\n/**\n * Schema for a map with a variable number of binary string keys.\n *\n * See SpecialCaseBinaryStringSchema for more information about the key type.\n */\nexport class SpecialCaseBinaryStringMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<Uint8Array, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`SpecialCaseBinaryStringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<RawBinaryString, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      prepared.set(new RawBinaryString(key), this.valueSchema.prepareMsgpack(value))\n    }\n    // Cast is needed because RawBinaryString is not part of the standard MsgpackEncodingData\n    return prepared as unknown as Map<Uint8Array, MsgpackEncodingData>\n  }\n\n  public fromPreparedMsgpack(_encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<Uint8Array, unknown> {\n    const map = new Map<Uint8Array, unknown>()\n    const keysAndValues = rawStringProvider.getRawStringKeysAndValuesAtCurrentLocation()\n    for (const [key, value] of keysAndValues) {\n      map.set(\n        key,\n        this.valueSchema.fromPreparedMsgpack(\n          convertRawStringsInMsgpackValue(value),\n          rawStringProvider.withMapValue(new RawBinaryString(key)),\n        ),\n      )\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`SpecialCaseBinaryStringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      // Not safe to convert to string for all binary data\n      const keyStringValue = bytesToString(key)\n      if (!options.lossyBinaryStringConversion && !arrayEqual(coerceToBytes(keyStringValue), key)) {\n        throw new Error(\n          `Invalid UTF-8 byte array encountered. Encode with lossyBinaryStringConversion enabled to bypass this check. Base64 value: ${bytesToBase64(key)}`,\n        )\n      }\n      prepared.set(keyStringValue, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<Uint8Array, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('SpecialCaseBinaryStringMapSchema data must be an object')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      map.set(coerceToBytes(key), this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,aAAa,SAAmE;AAC9F,QAAO,QAAQ,KAAK,WAAW;EAAE,GAAG;EAAO,WAAW;EAAM,EAAE;;;;;AAMhE,IAAa,iBAAb,MAAa,uBAAuBA,wBAAO;CACzC,AAAiB;CAEjB,YAAY,SAA0B;AACpC,SAAO;AACP,OAAK,UAAU;AACf,OAAK,cAAc;;;;;;;;CASrB,AAAO,YAAY,GAAG,SAA0B;AAC9C,OAAK,QAAQ,KAAK,GAAG,QAAQ;AAC7B,OAAK,cAAc;;CAGrB,AAAQ,eAAe;AACrB,OAAK,MAAM,SAAS,KAAK,QACvB,KAAI,MAAM,UAAU;AAClB,OAAI,MAAM,QAAQ,GAChB,OAAM,IAAI,MAAM,0CAA0C;AAE5D,OAAI,EAAE,MAAM,uBAAuB,gBACjC,OAAM,IAAI,MAAM,sDAAsD;;EAK5E,MAAM,uBAAO,IAAI,KAAa;AAC9B,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;AACrC,OAAI,KAAK,IAAI,MAAM,IAAI,CACrB,OAAM,IAAI,MAAM,kBAAkB,MAAM,MAAM;AAEhD,QAAK,IAAI,MAAM,IAAI;;;;;;;CAQvB,AAAO,aAA8B;EACnC,MAAMC,UAA2B,EAAE;AACnC,OAAK,MAAM,SAAS,KAAK,QACvB,KAAI,MAAM,SAER,SAAQ,KAAK,GADa,MAAM,YACE,YAAY,CAAC;MAE/C,SAAQ,KAAK,MAAM;AAGvB,SAAO;;CAGT,AAAO,eAAqC;EAC1C,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;AAEtD,SAAO;;CAGT,AAAO,eAAe,MAAwB;AAC5C,MAAI,EAAE,gBAAgB,KAAM,QAAO;AACnC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,CAAC,MAAM,YAAY,eAAe,KAAK,IAAI,MAAM,IAAI,CAAC,CACxD,QAAO;AAGX,SAAO;;CAGT,AAAO,eAAe,MAAoC;AACxD,MAAI,EAAE,gBAAgB,KACpB,OAAM,IAAI,MAAM,2CAA2C,OAAO,KAAK,IAAI,OAAO;EAEpF,MAAM,sBAAM,IAAI,KAAkC;AAClD,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;GACrC,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI;AACjC,OAAI,MAAM,aAAa,MAAM,YAAY,eAAe,MAAM,CAC5D;AAEF,OAAI,IAAI,MAAM,KAAK,MAAM,YAAY,eAAe,MAAM,CAAC;;AAE7D,SAAO;;CAGT,AAAO,oBAAoB,SAA8B,mBAAmE;AAC1H,MAAI,EAAE,mBAAmB,KACvB,OAAM,IAAI,MAAM,oCAAoC;EAEtD,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,QAAQ,IAAI,MAAM,IAAI,CACxB,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,oBAAoB,QAAQ,IAAI,MAAM,IAAI,EAAE,kBAAkB,aAAa,MAAM,IAAI,CAAC,CAAC;WACnH,MAAM,UACf,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;MAEpD,OAAM,IAAI,MAAM,gBAAgB,MAAM,MAAM;AAGhD,SAAO;;CAGT,AAAO,YAAY,MAAe,SAA+C;AAC/E,MAAI,EAAE,gBAAgB,KACpB,OAAM,IAAI,MAAM,oCAAoC;EAEtD,MAAMC,MAA2C,EAAE;AACnD,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;GACrC,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI;AACjC,OAAI,MAAM,aAAa,MAAM,YAAY,eAAe,MAAM,CAC5D;AAEF,OAAI,MAAM,OAAO,MAAM,YAAY,YAAY,OAAO,QAAQ;;AAEhE,SAAO;;CAGT,AAAO,iBAAiB,SAAiD;AACvE,MAAI,WAAW,QAAQ,OAAO,YAAY,YAAY,MAAM,QAAQ,QAAQ,CAC1E,OAAM,IAAI,MAAM,wCAAwC;EAE1D,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,OAAO,UAAU,eAAe,KAAK,SAAS,MAAM,IAAI,CAC1D,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,iBAAiB,QAAQ,MAAM,KAAK,CAAC;WACjE,MAAM,UACf,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;MAEpD,OAAM,IAAI,MAAM,gBAAgB,MAAM,MAAM;AAGhD,SAAO"}

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

@@ -0,0 +1,107 @@
+import { Schema } from "../encoding.mjs";
+import { RawBinaryString } from "algorand-msgpack";
+
+//#region packages/sdk/src/encoding/schema/map.ts
+/**
+* Applies the omitEmpty flag to all entries in the array.
+* @param entries - The entries to apply the flag to.
+* @returns A new array with the omitEmpty flag applied to all entries.
+*/
+function allOmitEmpty(entries) {
+	return entries.map((entry) => ({
+		...entry,
+		omitEmpty: true
+	}));
+}
+/**
+* Schema for a map/struct with a fixed set of known string fields.
+*/
+var NamedMapSchema = class NamedMapSchema extends Schema {
+	entries;
+	constructor(entries) {
+		super();
+		this.entries = entries;
+		this.checkEntries();
+	}
+	/**
+	* Adds new entries to the map schema. WARNING: this is a mutable operation, and you should be very
+	* careful when using it. Any error that happens here is non-recoverable and will corrupt the
+	* NamedMapSchema object;
+	* @param entries - The entries to add.
+	*/
+	pushEntries(...entries) {
+		this.entries.push(...entries);
+		this.checkEntries();
+	}
+	checkEntries() {
+		for (const entry of this.entries) if (entry.embedded) {
+			if (entry.key !== "") throw new Error("Embedded entries must have an empty key");
+			if (!(entry.valueSchema instanceof NamedMapSchema)) throw new Error("Embedded entry valueSchema must be a NamedMapSchema");
+		}
+		const keys = /* @__PURE__ */ new Set();
+		for (const entry of this.getEntries()) {
+			if (keys.has(entry.key)) throw new Error(`Duplicate key: ${entry.key}`);
+			keys.add(entry.key);
+		}
+	}
+	/**
+	* Returns all top-level entries, properly accounting for fields from embedded entries.
+	* @returns An array of all top-level entries for this map.
+	*/
+	getEntries() {
+		const entries = [];
+		for (const entry of this.entries) if (entry.embedded) entries.push(...entry.valueSchema.getEntries());
+		else entries.push(entry);
+		return entries;
+	}
+	defaultValue() {
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) map.set(entry.key, entry.valueSchema.defaultValue());
+		return map;
+	}
+	isDefaultValue(data) {
+		if (!(data instanceof Map)) return false;
+		for (const entry of this.getEntries()) if (!entry.valueSchema.isDefaultValue(data.get(entry.key))) return false;
+		return true;
+	}
+	prepareMsgpack(data) {
+		if (!(data instanceof Map)) throw new Error(`NamedMapSchema data must be a Map. Got (${typeof data}) ${data}`);
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) {
+			const value = data.get(entry.key);
+			if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) continue;
+			map.set(entry.key, entry.valueSchema.prepareMsgpack(value));
+		}
+		return map;
+	}
+	fromPreparedMsgpack(encoded, rawStringProvider) {
+		if (!(encoded instanceof Map)) throw new Error("NamedMapSchema data must be a Map");
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) if (encoded.has(entry.key)) map.set(entry.key, entry.valueSchema.fromPreparedMsgpack(encoded.get(entry.key), rawStringProvider.withMapValue(entry.key)));
+		else if (entry.omitEmpty) map.set(entry.key, entry.valueSchema.defaultValue());
+		else throw new Error(`Missing key: ${entry.key}`);
+		return map;
+	}
+	prepareJSON(data, options) {
+		if (!(data instanceof Map)) throw new Error("NamedMapSchema data must be a Map");
+		const obj = {};
+		for (const entry of this.getEntries()) {
+			const value = data.get(entry.key);
+			if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) continue;
+			obj[entry.key] = entry.valueSchema.prepareJSON(value, options);
+		}
+		return obj;
+	}
+	fromPreparedJSON(encoded) {
+		if (encoded == null || typeof encoded !== "object" || Array.isArray(encoded)) throw new Error("NamedMapSchema data must be an object");
+		const map = /* @__PURE__ */ new Map();
+		for (const entry of this.getEntries()) if (Object.prototype.hasOwnProperty.call(encoded, entry.key)) map.set(entry.key, entry.valueSchema.fromPreparedJSON(encoded[entry.key]));
+		else if (entry.omitEmpty) map.set(entry.key, entry.valueSchema.defaultValue());
+		else throw new Error(`Missing key: ${entry.key}`);
+		return map;
+	}
+};
+
+//#endregion
+export { NamedMapSchema, allOmitEmpty };
+//# sourceMappingURL=map.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"map.mjs","names":["entries: NamedMapEntry[]","obj: { [key: string]: JSONEncodingData }"],"sources":["../../../../../../packages/sdk/src/encoding/schema/map.ts"],"sourcesContent":["import { RawBinaryString } from 'algorand-msgpack'\nimport { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\nimport { ensureUint64, arrayEqual } from '../../utils/utils.js'\nimport { bytesToString, coerceToBytes, bytesToBase64, base64ToBytes } from '../binarydata.js'\n\n/* eslint-disable class-methods-use-this */\n\n/**\n * Describes a key-value entry in a NamedMapSchema.\n */\nexport interface NamedMapEntry {\n  /**\n   * Key of the entry. Must be unique for this map.\n   */\n  key: string\n  /**\n   * The Schema for the entry's value.\n   */\n  valueSchema: Schema\n  /**\n   * If true, the entry will be omitted from the encoding if the value is the default value.\n   */\n  omitEmpty: boolean\n  /**\n   * If true, valueSchema must be a NamedMapSchema and key must be the empty string. The fields of\n   * valueSchema will be embedded directly in the parent map.\n   *\n   * omitEmpty is ignored for embedded entries. Instead, the individual omitEmpty values of the\n   * embedded fields are used.\n   */\n  embedded?: boolean\n}\n\n/**\n * Applies the omitEmpty flag to all entries in the array.\n * @param entries - The entries to apply the flag to.\n * @returns A new array with the omitEmpty flag applied to all entries.\n */\nexport function allOmitEmpty(entries: Array<Omit<NamedMapEntry, 'omitEmpty'>>): NamedMapEntry[] {\n  return entries.map((entry) => ({ ...entry, omitEmpty: true }))\n}\n\n/**\n * Schema for a map/struct with a fixed set of known string fields.\n */\nexport class NamedMapSchema extends Schema {\n  private readonly entries: NamedMapEntry[]\n\n  constructor(entries: NamedMapEntry[]) {\n    super()\n    this.entries = entries\n    this.checkEntries()\n  }\n\n  /**\n   * Adds new entries to the map schema. WARNING: this is a mutable operation, and you should be very\n   * careful when using it. Any error that happens here is non-recoverable and will corrupt the\n   * NamedMapSchema object;\n   * @param entries - The entries to add.\n   */\n  public pushEntries(...entries: NamedMapEntry[]) {\n    this.entries.push(...entries)\n    this.checkEntries()\n  }\n\n  private checkEntries() {\n    for (const entry of this.entries) {\n      if (entry.embedded) {\n        if (entry.key !== '') {\n          throw new Error('Embedded entries must have an empty key')\n        }\n        if (!(entry.valueSchema instanceof NamedMapSchema)) {\n          throw new Error('Embedded entry valueSchema must be a NamedMapSchema')\n        }\n      }\n    }\n\n    const keys = new Set<string>()\n    for (const entry of this.getEntries()) {\n      if (keys.has(entry.key)) {\n        throw new Error(`Duplicate key: ${entry.key}`)\n      }\n      keys.add(entry.key)\n    }\n  }\n\n  /**\n   * Returns all top-level entries, properly accounting for fields from embedded entries.\n   * @returns An array of all top-level entries for this map.\n   */\n  public getEntries(): NamedMapEntry[] {\n    const entries: NamedMapEntry[] = []\n    for (const entry of this.entries) {\n      if (entry.embedded) {\n        const embeddedMapSchema = entry.valueSchema as NamedMapSchema\n        entries.push(...embeddedMapSchema.getEntries())\n      } else {\n        entries.push(entry)\n      }\n    }\n    return entries\n  }\n\n  public defaultValue(): Map<string, unknown> {\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      map.set(entry.key, entry.valueSchema.defaultValue())\n    }\n    return map\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    if (!(data instanceof Map)) return false\n    for (const entry of this.getEntries()) {\n      if (!entry.valueSchema.isDefaultValue(data.get(entry.key))) {\n        return false\n      }\n    }\n    return true\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`NamedMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const map = new Map<string, MsgpackEncodingData>()\n    for (const entry of this.getEntries()) {\n      const value = data.get(entry.key)\n      if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) {\n        continue\n      }\n      map.set(entry.key, entry.valueSchema.prepareMsgpack(value))\n    }\n    return map\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<string, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('NamedMapSchema data must be a Map')\n    }\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      if (encoded.has(entry.key)) {\n        map.set(entry.key, entry.valueSchema.fromPreparedMsgpack(encoded.get(entry.key), rawStringProvider.withMapValue(entry.key)))\n      } else if (entry.omitEmpty) {\n        map.set(entry.key, entry.valueSchema.defaultValue())\n      } else {\n        throw new Error(`Missing key: ${entry.key}`)\n      }\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error('NamedMapSchema data must be a Map')\n    }\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const entry of this.getEntries()) {\n      const value = data.get(entry.key)\n      if (entry.omitEmpty && entry.valueSchema.isDefaultValue(value)) {\n        continue\n      }\n      obj[entry.key] = entry.valueSchema.prepareJSON(value, options)\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<string, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('NamedMapSchema data must be an object')\n    }\n    const map = new Map<string, unknown>()\n    for (const entry of this.getEntries()) {\n      if (Object.prototype.hasOwnProperty.call(encoded, entry.key)) {\n        map.set(entry.key, entry.valueSchema.fromPreparedJSON(encoded[entry.key]))\n      } else if (entry.omitEmpty) {\n        map.set(entry.key, entry.valueSchema.defaultValue())\n      } else {\n        throw new Error(`Missing key: ${entry.key}`)\n      }\n    }\n    return map\n  }\n}\n\n/**\n * Combines multiple maps into a single map. Throws an error if any of the maps have duplicate keys.\n * @param maps - The maps to combine.\n * @returns A new map with all the entries from the input maps.\n */\nexport function combineMaps<K, V>(...maps: Array<Map<K, V>>): Map<K, V> {\n  const combined = new Map<K, V>()\n  for (const map of maps) {\n    for (const [key, value] of map) {\n      if (combined.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      combined.set(key, value)\n    }\n  }\n  return combined\n}\n\n/**\n * Converts a map to a new map with different keys and values.\n * @param map - The map to convert.\n * @param func - The function to convert each entry.\n * @returns A new map with the converted entries.\n */\nexport function convertMap<K1, V1, K2, V2>(map: Map<K1, V1>, func: (k: K1, v: V1) => [K2, V2]): Map<K2, V2> {\n  const mapped = new Map<K2, V2>()\n  for (const [key, value] of map) {\n    const [newKey, newValue] = func(key, value)\n    mapped.set(newKey, newValue)\n  }\n  return mapped\n}\n\n/**\n * Schema for a map with a variable number of uint64 keys.\n */\nexport class Uint64MapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<bigint, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`Uint64MapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<bigint, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      const bigintKey = ensureUint64(key)\n      if (prepared.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      prepared.set(bigintKey, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<bigint, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('Uint64MapSchema data must be a Map')\n    }\n    const map = new Map<bigint, unknown>()\n    for (const [key, value] of encoded) {\n      const bigintKey = ensureUint64(key)\n      if (map.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      map.set(bigintKey, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`Uint64MapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<bigint, JSONEncodingData>()\n    for (const [key, value] of data) {\n      const bigintKey = ensureUint64(key)\n      if (prepared.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      prepared.set(bigintKey, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key.toString()] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<bigint, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('Uint64MapSchema data must be an object')\n    }\n    const map = new Map<bigint, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      const bigintKey = BigInt(key)\n      if (map.has(bigintKey)) {\n        throw new Error(`Duplicate key: ${bigintKey}`)\n      }\n      map.set(bigintKey, this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Schema for a map with a variable number of string keys.\n */\nexport class StringMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<string, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`StringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (prepared.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      prepared.set(key, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<string, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('StringMapSchema data must be a Map')\n    }\n    const map = new Map<string, unknown>()\n    for (const [key, value] of encoded) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (map.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      map.set(key, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`StringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (typeof key !== 'string') {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      if (prepared.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      prepared.set(key, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<string, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('StringMapSchema data must be an object')\n    }\n    const map = new Map<string, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      if (map.has(key)) {\n        throw new Error(`Duplicate key: ${key}`)\n      }\n      map.set(key, this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Schema for a map with a variable number of byte array keys.\n */\nexport class ByteArrayMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<Uint8Array, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`ByteArrayMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<Uint8Array, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      prepared.set(key, this.valueSchema.prepareMsgpack(value))\n    }\n    return prepared\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<Uint8Array, unknown> {\n    if (!(encoded instanceof Map)) {\n      throw new Error('ByteArrayMapSchema data must be a Map')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of encoded) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      map.set(key, this.valueSchema.fromPreparedMsgpack(value, rawStringProvider.withMapValue(key)))\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`ByteArrayMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      const b64Encoded = bytesToBase64(key)\n      if (prepared.has(b64Encoded)) {\n        throw new Error(`Duplicate key (base64): ${b64Encoded}`)\n      }\n      prepared.set(b64Encoded, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<Uint8Array, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('ByteArrayMapSchema data must be an object')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      map.set(base64ToBytes(key), this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n\n/**\n * Converts any RawBinaryString values to regular strings in a MsgpackEncodingData object.\n *\n * Note this conversion may be lossy if the binary data is not valid UTF-8.\n *\n * @returns A new object with RawBinaryString values converted to strings.\n */\nfunction convertRawStringsInMsgpackValue(value: MsgpackEncodingData): MsgpackEncodingData {\n  if (value instanceof RawBinaryString) {\n    return bytesToString(value.rawBinaryValue as Uint8Array)\n  }\n  if (value instanceof Map) {\n    const newMap = new Map<string | number | bigint | Uint8Array, MsgpackEncodingData>()\n    for (const [key, val] of value) {\n      newMap.set(convertRawStringsInMsgpackValue(key) as string | number | bigint | Uint8Array, convertRawStringsInMsgpackValue(val))\n    }\n    return newMap\n  }\n  if (Array.isArray(value)) {\n    return value.map(convertRawStringsInMsgpackValue)\n  }\n  return value\n}\n\n/**\n * Schema for a map with a variable number of binary string keys.\n *\n * See SpecialCaseBinaryStringSchema for more information about the key type.\n */\nexport class SpecialCaseBinaryStringMapSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): Map<Uint8Array, unknown> {\n    return new Map()\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data instanceof Map && data.size === 0\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`SpecialCaseBinaryStringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<RawBinaryString, MsgpackEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key} (${typeof key})`)\n      }\n      prepared.set(new RawBinaryString(key), this.valueSchema.prepareMsgpack(value))\n    }\n    // Cast is needed because RawBinaryString is not part of the standard MsgpackEncodingData\n    return prepared as unknown as Map<Uint8Array, MsgpackEncodingData>\n  }\n\n  public fromPreparedMsgpack(_encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): Map<Uint8Array, unknown> {\n    const map = new Map<Uint8Array, unknown>()\n    const keysAndValues = rawStringProvider.getRawStringKeysAndValuesAtCurrentLocation()\n    for (const [key, value] of keysAndValues) {\n      map.set(\n        key,\n        this.valueSchema.fromPreparedMsgpack(\n          convertRawStringsInMsgpackValue(value),\n          rawStringProvider.withMapValue(new RawBinaryString(key)),\n        ),\n      )\n    }\n    return map\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (!(data instanceof Map)) {\n      throw new Error(`SpecialCaseBinaryStringMapSchema data must be a Map. Got (${typeof data}) ${data}`)\n    }\n    const prepared = new Map<string, JSONEncodingData>()\n    for (const [key, value] of data) {\n      if (!(key instanceof Uint8Array)) {\n        throw new Error(`Invalid key: ${key}`)\n      }\n      // Not safe to convert to string for all binary data\n      const keyStringValue = bytesToString(key)\n      if (!options.lossyBinaryStringConversion && !arrayEqual(coerceToBytes(keyStringValue), key)) {\n        throw new Error(\n          `Invalid UTF-8 byte array encountered. Encode with lossyBinaryStringConversion enabled to bypass this check. Base64 value: ${bytesToBase64(key)}`,\n        )\n      }\n      prepared.set(keyStringValue, this.valueSchema.prepareJSON(value, options))\n    }\n    // Convert map to object\n    const obj: { [key: string]: JSONEncodingData } = {}\n    for (const [key, value] of prepared) {\n      obj[key] = value\n    }\n    return obj\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): Map<Uint8Array, unknown> {\n    if (encoded == null || typeof encoded !== 'object' || Array.isArray(encoded)) {\n      throw new Error('SpecialCaseBinaryStringMapSchema data must be an object')\n    }\n    const map = new Map<Uint8Array, unknown>()\n    for (const [key, value] of Object.entries(encoded)) {\n      map.set(coerceToBytes(key), this.valueSchema.fromPreparedJSON(value))\n    }\n    return map\n  }\n}\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,aAAa,SAAmE;AAC9F,QAAO,QAAQ,KAAK,WAAW;EAAE,GAAG;EAAO,WAAW;EAAM,EAAE;;;;;AAMhE,IAAa,iBAAb,MAAa,uBAAuB,OAAO;CACzC,AAAiB;CAEjB,YAAY,SAA0B;AACpC,SAAO;AACP,OAAK,UAAU;AACf,OAAK,cAAc;;;;;;;;CASrB,AAAO,YAAY,GAAG,SAA0B;AAC9C,OAAK,QAAQ,KAAK,GAAG,QAAQ;AAC7B,OAAK,cAAc;;CAGrB,AAAQ,eAAe;AACrB,OAAK,MAAM,SAAS,KAAK,QACvB,KAAI,MAAM,UAAU;AAClB,OAAI,MAAM,QAAQ,GAChB,OAAM,IAAI,MAAM,0CAA0C;AAE5D,OAAI,EAAE,MAAM,uBAAuB,gBACjC,OAAM,IAAI,MAAM,sDAAsD;;EAK5E,MAAM,uBAAO,IAAI,KAAa;AAC9B,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;AACrC,OAAI,KAAK,IAAI,MAAM,IAAI,CACrB,OAAM,IAAI,MAAM,kBAAkB,MAAM,MAAM;AAEhD,QAAK,IAAI,MAAM,IAAI;;;;;;;CAQvB,AAAO,aAA8B;EACnC,MAAMA,UAA2B,EAAE;AACnC,OAAK,MAAM,SAAS,KAAK,QACvB,KAAI,MAAM,SAER,SAAQ,KAAK,GADa,MAAM,YACE,YAAY,CAAC;MAE/C,SAAQ,KAAK,MAAM;AAGvB,SAAO;;CAGT,AAAO,eAAqC;EAC1C,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;AAEtD,SAAO;;CAGT,AAAO,eAAe,MAAwB;AAC5C,MAAI,EAAE,gBAAgB,KAAM,QAAO;AACnC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,CAAC,MAAM,YAAY,eAAe,KAAK,IAAI,MAAM,IAAI,CAAC,CACxD,QAAO;AAGX,SAAO;;CAGT,AAAO,eAAe,MAAoC;AACxD,MAAI,EAAE,gBAAgB,KACpB,OAAM,IAAI,MAAM,2CAA2C,OAAO,KAAK,IAAI,OAAO;EAEpF,MAAM,sBAAM,IAAI,KAAkC;AAClD,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;GACrC,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI;AACjC,OAAI,MAAM,aAAa,MAAM,YAAY,eAAe,MAAM,CAC5D;AAEF,OAAI,IAAI,MAAM,KAAK,MAAM,YAAY,eAAe,MAAM,CAAC;;AAE7D,SAAO;;CAGT,AAAO,oBAAoB,SAA8B,mBAAmE;AAC1H,MAAI,EAAE,mBAAmB,KACvB,OAAM,IAAI,MAAM,oCAAoC;EAEtD,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,QAAQ,IAAI,MAAM,IAAI,CACxB,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,oBAAoB,QAAQ,IAAI,MAAM,IAAI,EAAE,kBAAkB,aAAa,MAAM,IAAI,CAAC,CAAC;WACnH,MAAM,UACf,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;MAEpD,OAAM,IAAI,MAAM,gBAAgB,MAAM,MAAM;AAGhD,SAAO;;CAGT,AAAO,YAAY,MAAe,SAA+C;AAC/E,MAAI,EAAE,gBAAgB,KACpB,OAAM,IAAI,MAAM,oCAAoC;EAEtD,MAAMC,MAA2C,EAAE;AACnD,OAAK,MAAM,SAAS,KAAK,YAAY,EAAE;GACrC,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI;AACjC,OAAI,MAAM,aAAa,MAAM,YAAY,eAAe,MAAM,CAC5D;AAEF,OAAI,MAAM,OAAO,MAAM,YAAY,YAAY,OAAO,QAAQ;;AAEhE,SAAO;;CAGT,AAAO,iBAAiB,SAAiD;AACvE,MAAI,WAAW,QAAQ,OAAO,YAAY,YAAY,MAAM,QAAQ,QAAQ,CAC1E,OAAM,IAAI,MAAM,wCAAwC;EAE1D,MAAM,sBAAM,IAAI,KAAsB;AACtC,OAAK,MAAM,SAAS,KAAK,YAAY,CACnC,KAAI,OAAO,UAAU,eAAe,KAAK,SAAS,MAAM,IAAI,CAC1D,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,iBAAiB,QAAQ,MAAM,KAAK,CAAC;WACjE,MAAM,UACf,KAAI,IAAI,MAAM,KAAK,MAAM,YAAY,cAAc,CAAC;MAEpD,OAAM,IAAI,MAAM,gBAAgB,MAAM,MAAM;AAGhD,SAAO"}

package/packages/sdk/src/encoding/schema/optional.js

@@ -0,0 +1,46 @@
+const require_encoding = require('../encoding.js');
+
+//#region packages/sdk/src/encoding/schema/optional.ts
+/**
+* OptionalSchema allows for another schema-defined value to be optional.
+*
+* This expands the set of values which can be represented by the given schema to include `undefined`.
+*
+* Note that this schema considers `undefined` _and_ any default values from the underlying schema
+* to all be default values. This means that when using NamedMapSchema to omit default values, an
+* `undefined` value is indistinguishable from the given schema's default value; in this respect,
+* OptionalSchema does not affect the encoding of NamedMapSchema values, but rather allows the
+* application to restore omitted values as `undefined` instead of their default value.
+*
+* Upon decoding, this schema also allows null/undefined values to be acceptable as values.
+*/
+var OptionalSchema = class extends require_encoding.Schema {
+	constructor(valueSchema) {
+		super();
+		this.valueSchema = valueSchema;
+	}
+	defaultValue() {}
+	isDefaultValue(data) {
+		return data === void 0 || this.valueSchema.isDefaultValue(data);
+	}
+	prepareMsgpack(data) {
+		if (data === void 0) return;
+		return this.valueSchema.prepareMsgpack(data);
+	}
+	fromPreparedMsgpack(encoded, rawStringProvider) {
+		if (encoded === void 0 || encoded === null) return;
+		return this.valueSchema.fromPreparedMsgpack(encoded, rawStringProvider);
+	}
+	prepareJSON(data, options) {
+		if (data === void 0) return null;
+		return this.valueSchema.prepareJSON(data, options);
+	}
+	fromPreparedJSON(encoded) {
+		if (encoded === void 0 || encoded === null) return;
+		return this.valueSchema.fromPreparedJSON(encoded);
+	}
+};
+
+//#endregion
+exports.OptionalSchema = OptionalSchema;
+//# sourceMappingURL=optional.js.map

package/packages/sdk/src/encoding/schema/optional.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional.js","names":["Schema","valueSchema: Schema"],"sources":["../../../../../../packages/sdk/src/encoding/schema/optional.ts"],"sourcesContent":["import { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\n\n/* eslint-disable class-methods-use-this */\n\n/**\n * OptionalSchema allows for another schema-defined value to be optional.\n *\n * This expands the set of values which can be represented by the given schema to include `undefined`.\n *\n * Note that this schema considers `undefined` _and_ any default values from the underlying schema\n * to all be default values. This means that when using NamedMapSchema to omit default values, an\n * `undefined` value is indistinguishable from the given schema's default value; in this respect,\n * OptionalSchema does not affect the encoding of NamedMapSchema values, but rather allows the\n * application to restore omitted values as `undefined` instead of their default value.\n *\n * Upon decoding, this schema also allows null/undefined values to be acceptable as values.\n */\nexport class OptionalSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): undefined {\n    return undefined\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data === undefined || this.valueSchema.isDefaultValue(data)\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (data === undefined) {\n      return undefined\n    }\n    return this.valueSchema.prepareMsgpack(data)\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): unknown {\n    // JS undefined is encoded as msgpack nil, which may be decoded as JS null\n    if (encoded === undefined || encoded === null) {\n      return undefined\n    }\n    return this.valueSchema.fromPreparedMsgpack(encoded, rawStringProvider)\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (data === undefined) {\n      // JSON representation does not have undefined, only null\n      return null\n    }\n    return this.valueSchema.prepareJSON(data, options)\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): unknown {\n    if (encoded === undefined || encoded === null) {\n      return undefined\n    }\n    return this.valueSchema.fromPreparedJSON(encoded)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAiBA,IAAa,iBAAb,cAAoCA,wBAAO;CACzC,YAAY,AAAgBC,aAAqB;AAC/C,SAAO;EADmB;;CAI5B,AAAO,eAA0B;CAIjC,AAAO,eAAe,MAAwB;AAC5C,SAAO,SAAS,UAAa,KAAK,YAAY,eAAe,KAAK;;CAGpE,AAAO,eAAe,MAAoC;AACxD,MAAI,SAAS,OACX;AAEF,SAAO,KAAK,YAAY,eAAe,KAAK;;CAG9C,AAAO,oBAAoB,SAA8B,mBAAsD;AAE7G,MAAI,YAAY,UAAa,YAAY,KACvC;AAEF,SAAO,KAAK,YAAY,oBAAoB,SAAS,kBAAkB;;CAGzE,AAAO,YAAY,MAAe,SAA+C;AAC/E,MAAI,SAAS,OAEX,QAAO;AAET,SAAO,KAAK,YAAY,YAAY,MAAM,QAAQ;;CAGpD,AAAO,iBAAiB,SAAoC;AAC1D,MAAI,YAAY,UAAa,YAAY,KACvC;AAEF,SAAO,KAAK,YAAY,iBAAiB,QAAQ"}

package/packages/sdk/src/encoding/schema/optional.mjs

@@ -0,0 +1,46 @@
+import { Schema } from "../encoding.mjs";
+
+//#region packages/sdk/src/encoding/schema/optional.ts
+/**
+* OptionalSchema allows for another schema-defined value to be optional.
+*
+* This expands the set of values which can be represented by the given schema to include `undefined`.
+*
+* Note that this schema considers `undefined` _and_ any default values from the underlying schema
+* to all be default values. This means that when using NamedMapSchema to omit default values, an
+* `undefined` value is indistinguishable from the given schema's default value; in this respect,
+* OptionalSchema does not affect the encoding of NamedMapSchema values, but rather allows the
+* application to restore omitted values as `undefined` instead of their default value.
+*
+* Upon decoding, this schema also allows null/undefined values to be acceptable as values.
+*/
+var OptionalSchema = class extends Schema {
+	constructor(valueSchema) {
+		super();
+		this.valueSchema = valueSchema;
+	}
+	defaultValue() {}
+	isDefaultValue(data) {
+		return data === void 0 || this.valueSchema.isDefaultValue(data);
+	}
+	prepareMsgpack(data) {
+		if (data === void 0) return;
+		return this.valueSchema.prepareMsgpack(data);
+	}
+	fromPreparedMsgpack(encoded, rawStringProvider) {
+		if (encoded === void 0 || encoded === null) return;
+		return this.valueSchema.fromPreparedMsgpack(encoded, rawStringProvider);
+	}
+	prepareJSON(data, options) {
+		if (data === void 0) return null;
+		return this.valueSchema.prepareJSON(data, options);
+	}
+	fromPreparedJSON(encoded) {
+		if (encoded === void 0 || encoded === null) return;
+		return this.valueSchema.fromPreparedJSON(encoded);
+	}
+};
+
+//#endregion
+export { OptionalSchema };
+//# sourceMappingURL=optional.mjs.map

package/packages/sdk/src/encoding/schema/optional.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional.mjs","names":["valueSchema: Schema"],"sources":["../../../../../../packages/sdk/src/encoding/schema/optional.ts"],"sourcesContent":["import { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\n\n/* eslint-disable class-methods-use-this */\n\n/**\n * OptionalSchema allows for another schema-defined value to be optional.\n *\n * This expands the set of values which can be represented by the given schema to include `undefined`.\n *\n * Note that this schema considers `undefined` _and_ any default values from the underlying schema\n * to all be default values. This means that when using NamedMapSchema to omit default values, an\n * `undefined` value is indistinguishable from the given schema's default value; in this respect,\n * OptionalSchema does not affect the encoding of NamedMapSchema values, but rather allows the\n * application to restore omitted values as `undefined` instead of their default value.\n *\n * Upon decoding, this schema also allows null/undefined values to be acceptable as values.\n */\nexport class OptionalSchema extends Schema {\n  constructor(public readonly valueSchema: Schema) {\n    super()\n  }\n\n  public defaultValue(): undefined {\n    return undefined\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    return data === undefined || this.valueSchema.isDefaultValue(data)\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    if (data === undefined) {\n      return undefined\n    }\n    return this.valueSchema.prepareMsgpack(data)\n  }\n\n  public fromPreparedMsgpack(encoded: MsgpackEncodingData, rawStringProvider: MsgpackRawStringProvider): unknown {\n    // JS undefined is encoded as msgpack nil, which may be decoded as JS null\n    if (encoded === undefined || encoded === null) {\n      return undefined\n    }\n    return this.valueSchema.fromPreparedMsgpack(encoded, rawStringProvider)\n  }\n\n  public prepareJSON(data: unknown, options: PrepareJSONOptions): JSONEncodingData {\n    if (data === undefined) {\n      // JSON representation does not have undefined, only null\n      return null\n    }\n    return this.valueSchema.prepareJSON(data, options)\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): unknown {\n    if (encoded === undefined || encoded === null) {\n      return undefined\n    }\n    return this.valueSchema.fromPreparedJSON(encoded)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAiBA,IAAa,iBAAb,cAAoC,OAAO;CACzC,YAAY,AAAgBA,aAAqB;AAC/C,SAAO;EADmB;;CAI5B,AAAO,eAA0B;CAIjC,AAAO,eAAe,MAAwB;AAC5C,SAAO,SAAS,UAAa,KAAK,YAAY,eAAe,KAAK;;CAGpE,AAAO,eAAe,MAAoC;AACxD,MAAI,SAAS,OACX;AAEF,SAAO,KAAK,YAAY,eAAe,KAAK;;CAG9C,AAAO,oBAAoB,SAA8B,mBAAsD;AAE7G,MAAI,YAAY,UAAa,YAAY,KACvC;AAEF,SAAO,KAAK,YAAY,oBAAoB,SAAS,kBAAkB;;CAGzE,AAAO,YAAY,MAAe,SAA+C;AAC/E,MAAI,SAAS,OAEX,QAAO;AAET,SAAO,KAAK,YAAY,YAAY,MAAM,QAAQ;;CAGpD,AAAO,iBAAiB,SAAoC;AAC1D,MAAI,YAAY,UAAa,YAAY,KACvC;AAEF,SAAO,KAAK,YAAY,iBAAiB,QAAQ"}

package/packages/sdk/src/encoding/schema/uint64.js

@@ -0,0 +1,30 @@
+const require_utils = require('../../utils/utils.js');
+const require_encoding = require('../encoding.js');
+
+//#region packages/sdk/src/encoding/schema/uint64.ts
+var Uint64Schema = class extends require_encoding.Schema {
+	defaultValue() {
+		return BigInt(0);
+	}
+	isDefaultValue(data) {
+		if (typeof data === "bigint") return data === BigInt(0);
+		if (typeof data === "number") return data === 0;
+		return false;
+	}
+	prepareMsgpack(data) {
+		return require_utils.ensureUint64(data);
+	}
+	fromPreparedMsgpack(encoded, _rawStringProvider) {
+		return require_utils.ensureUint64(encoded);
+	}
+	prepareJSON(data, _options) {
+		return require_utils.ensureUint64(data);
+	}
+	fromPreparedJSON(encoded) {
+		return require_utils.ensureUint64(encoded);
+	}
+};
+
+//#endregion
+exports.Uint64Schema = Uint64Schema;
+//# sourceMappingURL=uint64.js.map

package/packages/sdk/src/encoding/schema/uint64.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint64.js","names":["Schema","ensureUint64"],"sources":["../../../../../../packages/sdk/src/encoding/schema/uint64.ts"],"sourcesContent":["import { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\nimport { ensureUint64 } from '../../utils/utils.js'\n\n/* eslint-disable class-methods-use-this */\n\nexport class Uint64Schema extends Schema {\n  public defaultValue(): bigint {\n    return BigInt(0)\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    if (typeof data === 'bigint') return data === BigInt(0)\n    if (typeof data === 'number') return data === 0\n    return false\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    return ensureUint64(data)\n  }\n\n  public fromPreparedMsgpack(\n    encoded: MsgpackEncodingData,\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    _rawStringProvider: MsgpackRawStringProvider,\n  ): bigint {\n    return ensureUint64(encoded)\n  }\n\n  public prepareJSON(\n    data: unknown,\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    _options: PrepareJSONOptions,\n  ): JSONEncodingData {\n    return ensureUint64(data)\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): bigint {\n    return ensureUint64(encoded)\n  }\n}\n"],"mappings":";;;;AAKA,IAAa,eAAb,cAAkCA,wBAAO;CACvC,AAAO,eAAuB;AAC5B,SAAO,OAAO,EAAE;;CAGlB,AAAO,eAAe,MAAwB;AAC5C,MAAI,OAAO,SAAS,SAAU,QAAO,SAAS,OAAO,EAAE;AACvD,MAAI,OAAO,SAAS,SAAU,QAAO,SAAS;AAC9C,SAAO;;CAGT,AAAO,eAAe,MAAoC;AACxD,SAAOC,2BAAa,KAAK;;CAG3B,AAAO,oBACL,SAEA,oBACQ;AACR,SAAOA,2BAAa,QAAQ;;CAG9B,AAAO,YACL,MAEA,UACkB;AAClB,SAAOA,2BAAa,KAAK;;CAG3B,AAAO,iBAAiB,SAAmC;AACzD,SAAOA,2BAAa,QAAQ"}

package/packages/sdk/src/encoding/schema/uint64.mjs

@@ -0,0 +1,30 @@
+import { ensureUint64 } from "../../utils/utils.mjs";
+import { Schema } from "../encoding.mjs";
+
+//#region packages/sdk/src/encoding/schema/uint64.ts
+var Uint64Schema = class extends Schema {
+	defaultValue() {
+		return BigInt(0);
+	}
+	isDefaultValue(data) {
+		if (typeof data === "bigint") return data === BigInt(0);
+		if (typeof data === "number") return data === 0;
+		return false;
+	}
+	prepareMsgpack(data) {
+		return ensureUint64(data);
+	}
+	fromPreparedMsgpack(encoded, _rawStringProvider) {
+		return ensureUint64(encoded);
+	}
+	prepareJSON(data, _options) {
+		return ensureUint64(data);
+	}
+	fromPreparedJSON(encoded) {
+		return ensureUint64(encoded);
+	}
+};
+
+//#endregion
+export { Uint64Schema };
+//# sourceMappingURL=uint64.mjs.map

package/packages/sdk/src/encoding/schema/uint64.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uint64.mjs","names":[],"sources":["../../../../../../packages/sdk/src/encoding/schema/uint64.ts"],"sourcesContent":["import { Schema, MsgpackEncodingData, MsgpackRawStringProvider, JSONEncodingData, PrepareJSONOptions } from '../encoding.js'\nimport { ensureUint64 } from '../../utils/utils.js'\n\n/* eslint-disable class-methods-use-this */\n\nexport class Uint64Schema extends Schema {\n  public defaultValue(): bigint {\n    return BigInt(0)\n  }\n\n  public isDefaultValue(data: unknown): boolean {\n    if (typeof data === 'bigint') return data === BigInt(0)\n    if (typeof data === 'number') return data === 0\n    return false\n  }\n\n  public prepareMsgpack(data: unknown): MsgpackEncodingData {\n    return ensureUint64(data)\n  }\n\n  public fromPreparedMsgpack(\n    encoded: MsgpackEncodingData,\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    _rawStringProvider: MsgpackRawStringProvider,\n  ): bigint {\n    return ensureUint64(encoded)\n  }\n\n  public prepareJSON(\n    data: unknown,\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    _options: PrepareJSONOptions,\n  ): JSONEncodingData {\n    return ensureUint64(data)\n  }\n\n  public fromPreparedJSON(encoded: JSONEncodingData): bigint {\n    return ensureUint64(encoded)\n  }\n}\n"],"mappings":";;;;AAKA,IAAa,eAAb,cAAkC,OAAO;CACvC,AAAO,eAAuB;AAC5B,SAAO,OAAO,EAAE;;CAGlB,AAAO,eAAe,MAAwB;AAC5C,MAAI,OAAO,SAAS,SAAU,QAAO,SAAS,OAAO,EAAE;AACvD,MAAI,OAAO,SAAS,SAAU,QAAO,SAAS;AAC9C,SAAO;;CAGT,AAAO,eAAe,MAAoC;AACxD,SAAO,aAAa,KAAK;;CAG3B,AAAO,oBACL,SAEA,oBACQ;AACR,SAAO,aAAa,QAAQ;;CAG9B,AAAO,YACL,MAEA,UACkB;AAClB,SAAO,aAAa,KAAK;;CAG3B,AAAO,iBAAiB,SAAmC;AACzD,SAAO,aAAa,QAAQ"}

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

@@ -0,0 +1,34 @@
+//#region packages/sdk/src/encoding/uint64.d.ts
+/**
+ * encodeUint64 converts an integer to its binary representation.
+ * @param num - The number to convert. This must be an unsigned integer less than
+ *   2^64.
+ * @returns An 8-byte typed array containing the big-endian encoding of the input
+ *   integer.
+ */
+declare function encodeUint64(num: number | bigint): Uint8Array;
+/**
+ * decodeUint64 produces an integer from a binary representation.
+ * @param data - An typed array containing the big-endian encoding of an unsigned integer
+ *   less than 2^64. This array must be at most 8 bytes long.
+ * @param decodingMode - Configure how the integer will be
+ *   decoded.
+ *
+ *   The options are:
+ *   * "safe": The integer will be decoded as a Number, but if it is greater than
+ *     Number.MAX_SAFE_INTEGER an error will be thrown.
+ *   * "mixed": The integer will be decoded as a Number if it is less than or equal to
+ *     Number.MAX_SAFE_INTEGER, otherwise it will be decoded as a BigInt.
+ *   * "bigint": The integer will always be decoded as a BigInt.
+ *
+ *   Defaults to "safe" if not included.
+ * @returns The integer that was encoded in the input data. The return type will
+ *   be determined by the parameter decodingMode.
+ */
+declare function decodeUint64(data: Uint8Array, decodingMode: 'safe'): number;
+declare function decodeUint64(data: Uint8Array, decodingMode: 'mixed'): number | bigint;
+declare function decodeUint64(data: Uint8Array, decodingMode: 'bigint'): bigint;
+declare function decodeUint64(data: Uint8Array): number;
+//#endregion
+export { decodeUint64, encodeUint64 };
+//# sourceMappingURL=uint64.d.ts.map

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

@@ -0,0 +1,34 @@
+const require_utils = require('../utils/utils.js');
+
+//#region packages/sdk/src/encoding/uint64.ts
+/**
+* encodeUint64 converts an integer to its binary representation.
+* @param num - The number to convert. This must be an unsigned integer less than
+*   2^64.
+* @returns An 8-byte typed array containing the big-endian encoding of the input
+*   integer.
+*/
+function encodeUint64(num) {
+	if (!(typeof num === "bigint" || Number.isInteger(num)) || num < 0 || num > BigInt("0xffffffffffffffff")) throw new Error("Input is not a 64-bit unsigned integer");
+	const encoding = new Uint8Array(8);
+	new DataView(encoding.buffer).setBigUint64(0, BigInt(num));
+	return encoding;
+}
+function decodeUint64(data, decodingMode = "safe") {
+	if (decodingMode !== "safe" && decodingMode !== "mixed" && decodingMode !== "bigint") throw new Error(`Unknown decodingMode option: ${decodingMode}`);
+	if (data.byteLength === 0 || data.byteLength > 8) throw new Error(`Data has unacceptable length. Expected length is between 1 and 8, got ${data.byteLength}`);
+	const encoding = require_utils.concatArrays(new Uint8Array(8 - data.byteLength), data);
+	const num = new DataView(encoding.buffer).getBigUint64(0);
+	const isBig = num > BigInt(Number.MAX_SAFE_INTEGER);
+	if (decodingMode === "safe") {
+		if (isBig) throw new Error(`Integer exceeds maximum safe integer: ${num.toString()}. Try decoding with "mixed" or "safe" decodingMode.`);
+		return Number(num);
+	}
+	if (decodingMode === "mixed" && !isBig) return Number(num);
+	return num;
+}
+
+//#endregion
+exports.decodeUint64 = decodeUint64;
+exports.encodeUint64 = encodeUint64;
+//# sourceMappingURL=uint64.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"uint64.js","names":["concatArrays"],"sources":["../../../../../packages/sdk/src/encoding/uint64.ts"],"sourcesContent":["import { concatArrays } from '../utils/utils.js'\n\n// NOTE: at the moment we specifically do not use Buffer.writeBigUInt64BE and\n// Buffer.readBigUInt64BE. This is because projects using webpack v4\n// automatically include an old version of the npm `buffer` package (v4.9.2 at\n// the time of writing), and this old version does not have these methods.\n\n/**\n * encodeUint64 converts an integer to its binary representation.\n * @param num - The number to convert. This must be an unsigned integer less than\n *   2^64.\n * @returns An 8-byte typed array containing the big-endian encoding of the input\n *   integer.\n */\nexport function encodeUint64(num: number | bigint) {\n  const isInteger = typeof num === 'bigint' || Number.isInteger(num)\n\n  if (!isInteger || num < 0 || num > BigInt('0xffffffffffffffff')) {\n    throw new Error('Input is not a 64-bit unsigned integer')\n  }\n\n  const encoding = new Uint8Array(8)\n  const view = new DataView(encoding.buffer)\n  view.setBigUint64(0, BigInt(num))\n\n  return encoding\n}\n\n/**\n * decodeUint64 produces an integer from a binary representation.\n * @param data - An typed array containing the big-endian encoding of an unsigned integer\n *   less than 2^64. This array must be at most 8 bytes long.\n * @param decodingMode - Configure how the integer will be\n *   decoded.\n *\n *   The options are:\n *   * \"safe\": The integer will be decoded as a Number, but if it is greater than\n *     Number.MAX_SAFE_INTEGER an error will be thrown.\n *   * \"mixed\": The integer will be decoded as a Number if it is less than or equal to\n *     Number.MAX_SAFE_INTEGER, otherwise it will be decoded as a BigInt.\n *   * \"bigint\": The integer will always be decoded as a BigInt.\n *\n *   Defaults to \"safe\" if not included.\n * @returns The integer that was encoded in the input data. The return type will\n *   be determined by the parameter decodingMode.\n */\nexport function decodeUint64(data: Uint8Array, decodingMode: 'safe'): number\nexport function decodeUint64(data: Uint8Array, decodingMode: 'mixed'): number | bigint\nexport function decodeUint64(data: Uint8Array, decodingMode: 'bigint'): bigint\nexport function decodeUint64(data: Uint8Array): number\nexport function decodeUint64(data: any, decodingMode: any = 'safe') {\n  if (decodingMode !== 'safe' && decodingMode !== 'mixed' && decodingMode !== 'bigint') {\n    throw new Error(`Unknown decodingMode option: ${decodingMode}`)\n  }\n\n  if (data.byteLength === 0 || data.byteLength > 8) {\n    throw new Error(`Data has unacceptable length. Expected length is between 1 and 8, got ${data.byteLength}`)\n  }\n\n  // insert 0s at the beginning if data is smaller than 8 bytes\n  const padding = new Uint8Array(8 - data.byteLength)\n  const encoding = concatArrays(padding, data)\n  const view = new DataView(encoding.buffer)\n\n  const num = view.getBigUint64(0)\n  const isBig = num > BigInt(Number.MAX_SAFE_INTEGER)\n\n  if (decodingMode === 'safe') {\n    if (isBig) {\n      throw new Error(`Integer exceeds maximum safe integer: ${num.toString()}. Try decoding with \"mixed\" or \"safe\" decodingMode.`)\n    }\n    return Number(num)\n  }\n\n  if (decodingMode === 'mixed' && !isBig) {\n    return Number(num)\n  }\n\n  return num\n}\n"],"mappings":";;;;;;;;;;AAcA,SAAgB,aAAa,KAAsB;AAGjD,KAAI,EAFc,OAAO,QAAQ,YAAY,OAAO,UAAU,IAAI,KAEhD,MAAM,KAAK,MAAM,OAAO,qBAAqB,CAC7D,OAAM,IAAI,MAAM,yCAAyC;CAG3D,MAAM,WAAW,IAAI,WAAW,EAAE;AAElC,CADa,IAAI,SAAS,SAAS,OAAO,CACrC,aAAa,GAAG,OAAO,IAAI,CAAC;AAEjC,QAAO;;AAyBT,SAAgB,aAAa,MAAW,eAAoB,QAAQ;AAClE,KAAI,iBAAiB,UAAU,iBAAiB,WAAW,iBAAiB,SAC1E,OAAM,IAAI,MAAM,gCAAgC,eAAe;AAGjE,KAAI,KAAK,eAAe,KAAK,KAAK,aAAa,EAC7C,OAAM,IAAI,MAAM,yEAAyE,KAAK,aAAa;CAK7G,MAAM,WAAWA,2BADD,IAAI,WAAW,IAAI,KAAK,WAAW,EACZ,KAAK;CAG5C,MAAM,MAFO,IAAI,SAAS,SAAS,OAAO,CAEzB,aAAa,EAAE;CAChC,MAAM,QAAQ,MAAM,OAAO,OAAO,iBAAiB;AAEnD,KAAI,iBAAiB,QAAQ;AAC3B,MAAI,MACF,OAAM,IAAI,MAAM,yCAAyC,IAAI,UAAU,CAAC,qDAAqD;AAE/H,SAAO,OAAO,IAAI;;AAGpB,KAAI,iBAAiB,WAAW,CAAC,MAC/B,QAAO,OAAO,IAAI;AAGpB,QAAO"}

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

@@ -0,0 +1,33 @@
+import { concatArrays } from "../utils/utils.mjs";
+
+//#region packages/sdk/src/encoding/uint64.ts
+/**
+* encodeUint64 converts an integer to its binary representation.
+* @param num - The number to convert. This must be an unsigned integer less than
+*   2^64.
+* @returns An 8-byte typed array containing the big-endian encoding of the input
+*   integer.
+*/
+function encodeUint64(num) {
+	if (!(typeof num === "bigint" || Number.isInteger(num)) || num < 0 || num > BigInt("0xffffffffffffffff")) throw new Error("Input is not a 64-bit unsigned integer");
+	const encoding = new Uint8Array(8);
+	new DataView(encoding.buffer).setBigUint64(0, BigInt(num));
+	return encoding;
+}
+function decodeUint64(data, decodingMode = "safe") {
+	if (decodingMode !== "safe" && decodingMode !== "mixed" && decodingMode !== "bigint") throw new Error(`Unknown decodingMode option: ${decodingMode}`);
+	if (data.byteLength === 0 || data.byteLength > 8) throw new Error(`Data has unacceptable length. Expected length is between 1 and 8, got ${data.byteLength}`);
+	const encoding = concatArrays(new Uint8Array(8 - data.byteLength), data);
+	const num = new DataView(encoding.buffer).getBigUint64(0);
+	const isBig = num > BigInt(Number.MAX_SAFE_INTEGER);
+	if (decodingMode === "safe") {
+		if (isBig) throw new Error(`Integer exceeds maximum safe integer: ${num.toString()}. Try decoding with "mixed" or "safe" decodingMode.`);
+		return Number(num);
+	}
+	if (decodingMode === "mixed" && !isBig) return Number(num);
+	return num;
+}
+
+//#endregion
+export { decodeUint64, encodeUint64 };
+//# sourceMappingURL=uint64.mjs.map