mcbe-leveldb 1.7.3 → 1.9.0

package/Changelog.md

@@ -1,3 +1,110 @@
+# v1.9.0
+
+## Additions
+
+-   Added the `LevelChunkMetaDataDictionary` NBT schema.
+-   Added the `Digest` NBT schema.
+
+## Changes
+
+-   Changed the custom data structure of the `Digest` content type.
+
+## Fixes
+
+-   `prettyPrintSNBT` no longer inserts newlines when the `indent` option is set to `0`. 
+
+# v1.8.0
+
+## Critical Fixes
+
+-   Fixed a bug that has been around since the first version of this module where `MetaDataHash` keys were detected as `BlendingBiomeHeight` keys, `GeneratedPreCavesAndCliffsBlending` keys were detected as `MetaDataHash` keys, and `BlendingBiomeHeight` keys were detected as `GeneratedPreCavesAndCliffsBlending` keys.
+
+## Additions
+
+-   Added a custom serializer and parser for the `LevelChunkMetaDataDictionary` content type.
+-   Added the `BiomeIdsTable` content type.
+-   Added the `BiomeIdsTable` NBT schema.
+-   Added the `VillageRaid` content type.
+-   Added the `VillageRaid` NBT schema.
+-   Added the `PositionTrackingDB` content type.
+-   Added the `PositionTrackingLastId` content type.
+-   Added the `GenerationSeed` content type.
+-   Added the `LegacyDimension` content type.
+-   Added the `MVillages` content type.
+-   Added the `Villages` content type.
+-   Added the `LevelSpawnWasFixed` content type.
+-   Added a default value to the following properties of the following NBT schemas:
+    -   `Map`
+        -   `unlimitedTracking`
+        -   `scale`
+    -   `Scoreboard`
+        -   `DisplayObjectives[number].SortOrder`
+    -   `LevelDat`
+        -   `functioncommandlimit`
+        -   `maxcommandchainlength`
+        -   `prid`
+    -   `ActorPrefix`
+        -   `Color`
+        -   `Color2`
+        -   `MarkVariant`
+        -   `OwnerNew`
+        -   `SkinID`
+        -   `Strength`
+        -   `StrengthMax`
+        -   `Variant`
+    -   `Entity_ItemEntity`
+        -   `OwnerID`
+    -   `Block_Piston`
+        -   `NewState`
+-   Added enums to the following non-boolean properties of the following NBT schemas (added enums on boolean properties are not being listed in the changelog):
+    -   `Scoreboard`
+        -   `DisplayObjectives[number].SortOrder`
+        -   `Objectives[number].Criteria`
+-   Added enums to many boolean NBT schema properties.
+-   Added descriptions and titles to many NBT schema properties.
+-   Added the `verticalFlySpeed` property to the `abilities` property of the `LevelDat` NBT schema.
+-   Added the `isRandomSeedAllowed` property to the `LevelDat` NBT schema.
+-   Added the `projectilescanbreakblocks` property to the `LevelDat` NBT schema.
+-   Added the `showrecipemessages` property to the `LevelDat` NBT schema.
+-   Added the `tntexplosiondropdecay` property to the `LevelDat` NBT schema.
+-   Documented the `InventoryVersion` property of the `LevelDat` NBT schema.
+-   Added more information to the documentation of the `texturePacksRequired` property of the `LevelDat` NBT schema.
+
+## Changes
+
+-   Documentation refactor to replace `Unknown.` in documentation entries of NBT schemas with one of:
+    -   `UNKNOWN.`: If the schema for that tag is incomplete or completely empty as it is unknown what properties it has.
+    -   `UNDOCUMENTED.`: If the tag with that description has not been documented yet or it is unknown what it does.
+-   Updated the `BiomeData` from `v1.21.80` to `v1.21.110` (the update has zero actual changes).
+-   Many properties of the `VillageDwellers`, `VillageInfo`, `VillagePOI`, and `VillagePlayers` NBT schemas are now marked as required.
+
+## Fixes
+
+-   Fixed a bug where the `list[number].id` property of the `BiomeData` NBT schema was of type `byte` instead of `short`.
+-   Fixed an incorrect TypeScript type version of the `Scoreboard` NBT schema.
+-   Fixed a bug where empty object types in the TypeScript type versions of NBT schemas were generated as `{}` instead of `object`.
+-   Fixed a bug where a few optional properties of the `VibrationListener` property of the `Entity_Allay` NBT schema were incorrectly marked as required.
+-   Fixed an incorrect NBT schema for the `decorations[number].key` property of the `Map` NBT schema.
+-   Removed a `minimum` value from the list items of the `structure_world_origin` property of the `StructureTemplate` NBT schema that should not have been there.
+-   Fixed the descriptions of the list items of the `structure_world_origin` property of the `StructureTemplate` NBT schema.
+-   Fixed an incorrect NBT schema for the `structure.palette.default.block_position_data` property of the `StructureTemplate` NBT schema.
+-   Fixed incorrect NBT schemas for following properties of the `LevelDat` NBT schema:
+    -   `editorWorldType`
+    -   `eduOffer`
+    -   `functioncommandlimit`
+    -   `spawnradius`
+-   Fixed a bug where the `LevelDat` NBT schema had the `limitedWorldDepth` property incorrectly capitalized as `LimitedWorldDepth`.
+-   Fixed a bug where the `LevelDat` NBT schema had the `limitedWorldWidth` property incorrectly capitalized as `LimitedWorldWidth`.
+-   Fixed an incorrectly structured default value for the `LevelName` property of the `LevelDat` NBT schema.
+-   Fixed incorrect documentation for the `NetworkVersion` property of the `LevelDat` NBT schema.
+-   Fixed a bug where a the following optional properties of the `ActorPrefix` NBT schema were incorrectly marked as required:
+    -   `CustomNameVisible`
+    -   `Fire`
+    -   `Persistent`
+-   Minor whitespace fixes with some instances of the following in the documentation:
+    -   `*needs testing*`
+    -   `*info needed*`
+
 # v1.7.3
 
 ## Fixes

package/LevelUtils.d.ts

@@ -43,7 +43,7 @@ export declare const gameModes: readonly ["survival", "creative", "adventure", u
 /**
  * The content types for LevelDB entries.
  */
-export declare const DBEntryContentTypes: readonly ["Data3D", "Version", "Data2D", "Data2DLegacy", "SubChunkPrefix", "LegacyTerrain", "BlockEntity", "Entity", "PendingTicks", "LegacyBlockExtraData", "BiomeState", "FinalizedState", "ConversionData", "BorderBlocks", "HardcodedSpawners", "RandomTicks", "Checksums", "MetaDataHash", "GeneratedPreCavesAndCliffsBlending", "BlendingBiomeHeight", "BlendingData", "ActorDigestVersion", "LegacyVersion", "AABBVolumes", "VillageDwellers", "VillageInfo", "VillagePOI", "VillagePlayers", "Player", "PlayerClient", "ActorPrefix", "ChunkLoadedRequest", "Digest", "Map", "Portals", "SchedulerWT", "StructureTemplate", "TickingArea", "FlatWorldLayers", "Scoreboard", "Dimension", "AutonomousEntities", "BiomeData", "MobEvents", "DynamicProperties", "LevelChunkMetaDataDictionary", "RealmsStoriesData", "LevelDat", "ForcedWorldCorruption", "Unknown"];
+export declare const DBEntryContentTypes: readonly ["Data3D", "Version", "Data2D", "Data2DLegacy", "SubChunkPrefix", "LegacyTerrain", "BlockEntity", "Entity", "PendingTicks", "LegacyBlockExtraData", "BiomeState", "FinalizedState", "ConversionData", "BorderBlocks", "HardcodedSpawners", "RandomTicks", "Checksums", "GenerationSeed", "GeneratedPreCavesAndCliffsBlending", "BlendingBiomeHeight", "MetaDataHash", "BlendingData", "ActorDigestVersion", "LegacyVersion", "AABBVolumes", "VillageDwellers", "VillageInfo", "VillagePOI", "VillagePlayers", "VillageRaid", "Player", "PlayerClient", "ActorPrefix", "ChunkLoadedRequest", "Digest", "Map", "Portals", "SchedulerWT", "StructureTemplate", "TickingArea", "FlatWorldLayers", "LegacyDimension", "MVillages", "Villages", "LevelSpawnWasFixed", "PositionTrackingDB", "PositionTrackingLastId", "Scoreboard", "Dimension", "AutonomousEntities", "BiomeData", "BiomeIdsTable", "MobEvents", "DynamicProperties", "LevelChunkMetaDataDictionary", "RealmsStoriesData", "LevelDat", "ForcedWorldCorruption", "Unknown"];
 /**
  * The content type to format mapping for LevelDB entries.
  */
@@ -394,9 +394,11 @@ export declare const entryContentTypeToFormatMap: {
         readonly type: "unknown";
     };
     /**
-     * @todo Check if this still exists.
+     * Bounding boxes for structure spawns, such as a Nether Fortress or Pillager Outpost.
+     *
+     * @deprecated Replaced with {@link AABBVolumes} in either 1.21.120 or one of the 1.21.120 previews.
+     *
      * @todo Figure out how to parse this.
-     * @todo Add a description for this.
      */
     readonly HardcodedSpawners: {
         /**
@@ -416,23 +418,38 @@ export declare const entryContentTypeToFormatMap: {
         readonly type: "NBT";
     };
     /**
-     * @deprecated Only used in versions < 1.18.0.
+     * The low segment of the 4 byte halves of the seed value used to generate the chunk.
      *
-     * @todo Figure out how to parse this.
-     * @todo Add a description for this.
+     * The low segment can also be found by reading the first 4 bytes of the seed as a little-endian signed integer when it is encoded as a little-endian 64-bit signed integer.
+     *
+     * @todo Check if this still exists (I have only seen it in a world from a 1.19.60.22 dev build).
      */
-    readonly Checksums: {
+    readonly GenerationSeed: {
         /**
          * The format type of the data.
          */
-        readonly type: "unknown";
+        readonly type: "int";
+        /**
+         * How many bytes this integer is.
+         */
+        readonly bytes: 4;
+        /**
+         * The endianness of the data.
+         */
+        readonly format: "LE";
+        /**
+         * The signedness of the data.
+         */
+        readonly signed: true;
     };
     /**
-     * @todo Check if this still exists.
+     * xxHash64 checksums of `SubchunkBlocks`, `BlockEntities`, `Entities`, and `Data2D` values.
+     *
+     * @deprecated Only used in versions < 1.18.0.
+     *
      * @todo Figure out how to parse this.
-     * @todo Add a description for this.
      */
-    readonly MetaDataHash: {
+    readonly Checksums: {
         /**
          * The format type of the data.
          */
@@ -460,6 +477,19 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "unknown";
     };
+    /**
+     * A hash which is the key in the `LevelChunkMetaDataDictionary` record
+     * for the NBT metadata of this chunk. Seems like it might default to something dependent
+     * on the current game or chunk version.
+     *
+     * @todo Figure out how to parse this.
+     */
+    readonly MetaDataHash: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "unknown";
+    };
     /**
      * @todo Figure out how to parse this.
      * @todo Add a description for this.
@@ -505,6 +535,30 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly signed: false;
     };
+    /**
+     * @deprecated It is unknown when this was removed, it was found in a Windows 10 Edition Beta v0.15.0 world.
+     *
+     * @todo Add a schema for this.
+     * @todo Add a description for this.
+     */
+    readonly MVillages: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
+    /**
+     * @deprecated It is unknown when this was removed.
+     *
+     * @todo Add a schema for this.
+     * @todo Add a description for this.
+     */
+    readonly Villages: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
     /**
      * @see {@link NBTSchemas.nbtSchemas.VillageDwellers}
      *
@@ -549,6 +603,17 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "NBT";
     };
+    /**
+     * @see {@link NBTSchemas.nbtSchemas.VillageRaid}
+     *
+     * @todo Add a description for this.
+     */
+    readonly VillageRaid: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
     /**
      * A player's data.
      *
@@ -597,7 +662,7 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "custom";
         /**
-         * The format type that results from the {@link entryContentTypeToFormatMap.Entity.parse | parse} method.
+         * The format type that results from the {@link entryContentTypeToFormatMap.Digest.parse | parse} method.
          */
         readonly resultType: "JSONNBT";
         /**
@@ -610,21 +675,7 @@ export declare const entryContentTypeToFormatMap: {
          *
          * @throws {any} If an error occurs while parsing the data.
          */
-        readonly parse: (data: Buffer) => Promise<{
-            type: "compound";
-            value: {
-                entityIds: {
-                    type: "list";
-                    value: {
-                        type: "list";
-                        value: {
-                            type: "int";
-                            value: [id1: number, id2: number];
-                        }[];
-                    };
-                };
-            };
-        }>;
+        readonly parse: (data: Buffer) => Promise<NBTSchemas.NBTSchemaTypes.Digest>;
         /**
          * The function to serialize the data.
          *
@@ -632,22 +683,10 @@ export declare const entryContentTypeToFormatMap: {
          *
          * @param data The data to serialize.
          * @returns The serialized data, as a buffer.
+         *
+         * @throws {any} If an error occurs while parsing the data.
          */
-        readonly serialize: (data: {
-            type: "compound";
-            value: {
-                entityIds: {
-                    type: "list";
-                    value: {
-                        type: "list";
-                        value: {
-                            type: "int";
-                            value: [id1: number, id2: number];
-                        }[];
-                    };
-                };
-            };
-        }) => Buffer<ArrayBuffer>;
+        readonly serialize: (data: NBTSchemas.NBTSchemaTypes.Digest) => Buffer<ArrayBuffer>;
     };
     /**
      * The data for a map.
@@ -721,6 +760,48 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "ASCII";
     };
+    /**
+     * @deprecated It is unknown when this was removed, it was found in a Windows 10 Edition Beta v0.15.0 world.
+     *
+     * @todo Add a description for this.
+     */
+    readonly LevelSpawnWasFixed: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "UTF-8";
+        /**
+         * The default value to use when initializing a new entry.
+         *
+         * Value:
+         * ```typescript
+         * Buffer.from("True", "utf-8")
+         * ```
+         */
+        readonly defaultValue: Buffer<ArrayBuffer>;
+    };
+    /**
+     * Stores the location of a lodestone compass.
+     *
+     * @todo Add a schema for this.
+     */
+    readonly PositionTrackingDB: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
+    /**
+     * The last ID used for a lodestone compass.
+     *
+     * @todo Add a schema for this.
+     */
+    readonly PositionTrackingLastId: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
     /**
      * The scoreboard data (ex. from the [`/scoreboard`](https://minecraft.wiki/w/Commands/scoreboard) command).
      *
@@ -732,6 +813,18 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "NBT";
     };
+    /**
+     * @deprecated It is unknown when this was removed, it was found in a Windows 10 Edition Beta v0.15.0 world.
+     *
+     * @todo Add a schema for this.
+     * @todo Add a description for this.
+     */
+    readonly LegacyDimension: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
     /**
      * @todo Add a schema for this.
      * @todo Add a description for this.
@@ -766,6 +859,17 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "NBT";
     };
+    /**
+     * The content type of the `BiomeIdsTable` LevelDB key, which stores the numeric ID mappings for custom biomes.
+     *
+     * @see {@link NBTSchemas.nbtSchemas.BiomeIdsTable}
+     */
+    readonly BiomeIdsTable: {
+        /**
+         * The format type of the data.
+         */
+        readonly type: "NBT";
+    };
     /**
      * The content type of the `mobevents` LevelDB key, which stores what mob events are enabled or disabled.
      *
@@ -827,8 +931,11 @@ export declare const entryContentTypeToFormatMap: {
         readonly rawFileExtension: "dat";
     };
     /**
+     * Bounding boxes for structures, including structure spawns (such as a Pillager Outpost)
+     * and volumes where mobs cannot spawn through the normal biome-based means (such as
+     * Trial Chambers).
+     *
      * @todo Figure out how to parse this.
-     * @todo Add a description for this.
      */
     readonly AABBVolumes: {
         /**
@@ -857,145 +964,26 @@ export declare const entryContentTypeToFormatMap: {
         readonly defaultValue: Buffer<ArrayBufferLike>;
     };
     /**
-     * @todo Figure out what the little bits of data before each of the NBT data chunks are, and what the 4 bytes at the very beginning are.
-     * @todo Add a description for this.
+     * Stores the NBT metadata of all chunks. Maps the xxHash64 hash of NBT data
+     * to that NBT data, so that each chunk need only store 8 bytes instead of the entire
+     * NBT; most chunks have the same metadata.
      *
-     * `Array.from(data).reduce((a, b, i, ar)=>[...a, ...(Array.from(Buffer.from("0a000008", "hex")).every((v, ib)=>v === ar[i + ib]) ? [i] : [])], [])`
+     * The first 4 bytes represent the number of entries as a 32-bit little-endian integer (it is unknown if it is signed or not).
      *
-     * This seems to be 4 bytes, followed by multiple chunks of data formatted as 8 bytes plus an NBT compound.
-     * ```
-     * {BYTEx4}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}
-     * ```
+     * The first 4 bytes are followed by multiple chunks of data formatted as the 8 byte hash of the NBT data plus the NBT compound.
      *
-     * ```js
-     * const data = (await tabManager.selectedTab.db.get("LevelChunkMetaDataDictionary"));
-     * const extractedData = [];
-     * for (let i = 12; i < data.length; i += 8) {
-     *     const parsedData = await require("prismarine-nbt").parse(data.slice(i), "little");
-     *     extractedData.push([data.slice(i - 8, i), parsedData]);
-     *     i += parsedData.metadata.size;
-     * }
      * ```
-     *
-     * Example first 4 bytes:
-     * ```json
-     * {
-     *     "type": "Buffer",
-     *     "data": [
-     *         109,
-     *         0,
-     *         0,
-     *         0
-     *     ]
-     * }
-     * ```
-     *
-     * Example parsed NBT data chunk:
-     * ```json
-     * [
-     *     {
-     *         "type": "Buffer",
-     *         "data": [
-     *             190,
-     *             156,
-     *             149,
-     *             210,
-     *             211,
-     *             150,
-     *             247,
-     *             2
-     *         ]
-     *     },
-     *     {
-     *         "metadata": {
-     *             "size": 392,
-     *             "buffer": {} // ...
-     *         },
-     *         "parsed": {
-     *             "type": "compound",
-     *             "name": "",
-     *             "value": {
-     *                 "BiomeBaseGameVersion": {
-     *                     "type": "string",
-     *                     "value": "1.18.0"
-     *                 },
-     *                 "DimensionName": {
-     *                     "type": "string",
-     *                     "value": "Overworld"
-     *                 },
-     *                 "GenerationSeed": {
-     *                     "type": "long",
-     *                     "value": [
-     *                         -555685613,
-     *                         920043062
-     *                     ]
-     *                 },
-     *                 "GeneratorType": {
-     *                     "type": "int",
-     *                     "value": 1
-     *                 },
-     *                 "LastSavedBaseGameVersion": {
-     *                     "type": "string",
-     *                     "value": "1.21.122"
-     *                 },
-     *                 "LastSavedDimensionHeightRange": {
-     *                     "type": "compound",
-     *                     "value": {
-     *                         "max": {
-     *                             "type": "short",
-     *                             "value": 320
-     *                         },
-     *                         "min": {
-     *                             "type": "short",
-     *                             "value": -64
-     *                         }
-     *                     }
-     *                 },
-     *                 "OriginalBaseGameVersion": {
-     *                     "type": "string",
-     *                     "value": "1.21.71"
-     *                 },
-     *                 "OriginalDimensionHeightRange": {
-     *                     "type": "compound",
-     *                     "value": {
-     *                         "max": {
-     *                             "type": "short",
-     *                             "value": 320
-     *                         },
-     *                         "min": {
-     *                             "type": "short",
-     *                             "value": -64
-     *                         }
-     *                     }
-     *                 },
-     *                 "Overworld1_18HeightExtended": {
-     *                     "type": "short",
-     *                     "value": 1
-     *                 },
-     *                 "SkullFlatteningPerformed": {
-     *                     "type": "short",
-     *                     "value": 1
-     *                 },
-     *                 "UnderwaterLavaLakeFixed": {
-     *                     "type": "short",
-     *                     "value": 1
-     *                 },
-     *                 "WorldGenBelowZeroFixed": {
-     *                     "type": "short",
-     *                     "value": 1
-     *                 }
-     *             }
-     *         },
-     *         "type": "little"
-     *     }
-     * ]
+     * {BYTEx4}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}{BYTEx8}{NBTCompound}
      * ```
      */
     readonly LevelChunkMetaDataDictionary: {
         /**
          * The format type of the data.
          */
-        readonly type: "unknown";
+        readonly type: "custom";
+        readonly resultType: "JSONNBT";
+        readonly parse: (data: Buffer) => Promise<NBTSchemas.NBTSchemaTypes.LevelChunkMetaDataDictionary>;
+        readonly serialize: (data: NBTSchemas.NBTSchemaTypes.LevelChunkMetaDataDictionary) => Buffer<ArrayBuffer>;
     };
     /**
      * @todo Figure out how to parse this. (It seems that each one just has a value of 1 (`0x31`). It also seems that the data is actually based on the key, which has an id that can be used with the realms API to get the corresponding data.)
@@ -1372,7 +1360,7 @@ export type DBEntryContentType = (typeof DBEntryContentTypes)[number];
 /**
  * A content type of a LevelDB chunk key entry.
  */
-export type DBChunkKeyEntryContentType = "Data3D" | "Version" | "Data2D" | "Data2DLegacy" | "SubChunkPrefix" | "LegacyTerrain" | "BlockEntity" | "Entity" | "PendingTicks" | "LegacyBlockExtraData" | "BiomeState" | "FinalizedState" | "ConversionData" | "BorderBlocks" | "HardcodedSpawners" | "RandomTicks" | "Checksums" | "MetaDataHash" | "GeneratedPreCavesAndCliffsBlending" | "BlendingBiomeHeight" | "BlendingData" | "ActorDigestVersion" | "LegacyVersion" | "AABBVolumes";
+export type DBChunkKeyEntryContentType = "Data3D" | "Version" | "Data2D" | "Data2DLegacy" | "SubChunkPrefix" | "LegacyTerrain" | "BlockEntity" | "Entity" | "PendingTicks" | "LegacyBlockExtraData" | "BiomeState" | "FinalizedState" | "ConversionData" | "BorderBlocks" | "HardcodedSpawners" | "RandomTicks" | "Checksums" | "GenerationSeed" | "GeneratedPreCavesAndCliffsBlending" | "BlendingBiomeHeight" | "MetaDataHash" | "BlendingData" | "ActorDigestVersion" | "LegacyVersion" | "AABBVolumes";
 /**
  * Parses an integer from a buffer gives the number of bytes, endianness, signedness and offset.
  *
@@ -1514,6 +1502,8 @@ export declare function getContentTypeFromDBKey(key: Buffer): DBEntryContentType
 /**
  * Gets the biome type from its ID.
  *
+ * Only works with vanilla biomes.
+ *
  * @param id The ID of the biome.
  * @returns The biome type.
  */
@@ -1521,6 +1511,8 @@ export declare function getBiomeTypeFromID(id: number): keyof (typeof BiomeData)
 /**
  * Gets the biome ID from its type.
  *
+ * Only works with vanilla biomes.
+ *
  * @param type The type of the biome.
  * @returns The biome ID.
  */