npm - mcbe-leveldb - Versions diffs - 1.8.0 → 1.9.1-jsonly - Mend

mcbe-leveldb 1.8.0 → 1.9.1-jsonly

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

package/Changelog.md CHANGED Viewed

@@ -1,3 +1,29 @@
+# v1.9.1
+## Critical Fixes
+-   Fixed an issue where the Data3D serializer could corrupt the data by serializing it with a number of bits per block that 32 was not divisible by (also made the parser able to parse those corrupted subchunks, though the referenced palette indices in the values arrays will likely be incorrect for those corrupted subchunks).
+## Additions
+-   Added the optional `name` property to the `GenericPrismarineJSONNBTSchema` JSON schema.
+-   Made many types `exactOptionalPropertyTypes` friendly.
+# 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

package/LevelUtils.d.ts CHANGED Viewed

@@ -662,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";
         /**
@@ -675,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.
          *
@@ -697,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.
@@ -996,136 +970,11 @@ export declare const entryContentTypeToFormatMap: {
      *
      * 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).
      *
-     * `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 are followed by multiple chunks of data formatted as the 8 byte hash of the NBT data plus the NBT compound.
      *
-     * 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}
      * ```
-     *
-     * ```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"
-     *     }
-     * ]
-     * ```
      */
     readonly LevelChunkMetaDataDictionary: {
         /**
@@ -1133,18 +982,8 @@ export declare const entryContentTypeToFormatMap: {
          */
         readonly type: "custom";
         readonly resultType: "JSONNBT";
-        readonly parse: (data: Buffer) => Promise<{
-            type: "compound";
-            value: {
-                [hashHex: string]: NBT.NBT;
-            };
-        }>;
-        readonly serialize: (data: {
-            type: "compound";
-            value: {
-                [hashHex: string]: NBT.NBT | NBT.Compound;
-            };
-        }) => Buffer<ArrayBuffer>;
+        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.)

package/LevelUtils.js CHANGED Viewed

@@ -229,12 +229,37 @@ function readSubchunkPaletteIds(buffer, offset, end) {
     }
     const values = new Array(4096);
     if (bitsPerBlock > 0) {
-        const blocksPerWord = Math.floor(32 / bitsPerBlock);
+        const blocksPerWord = 32 / bitsPerBlock;
         const wordCount = Math.floor(4095 / blocksPerWord) + 1;
         const mask = (1 << bitsPerBlock) - 1;
+        // console.warn(
+        //     "blocksPerWord:",
+        //     blocksPerWord,
+        //     "wordCount:",
+        //     wordCount,
+        //     "bitsPerBlock:",
+        //     bitsPerBlock,
+        //     "mask:",
+        //     mask,
+        //     "p:",
+        //     p,
+        //     "end:",
+        //     end,
+        //     "end-p:",
+        //     end - p,
+        //     "4*wordCount:",
+        //     4 * wordCount,
+        //     "flags:",
+        //     flags,
+        //     "isPersistent:",
+        //     isPersistent,
+        //     "offset:",
+        //     offset
+        // );
         if (end - p < 4 * wordCount) {
             throw new Error("Subchunk biome error: not enough data for block words.");
         }
+        // const originalP = p;
         let u = 0;
         for (let j = 0; j < wordCount; j++) {
             let temp = buffer[p] | (buffer[p + 1] << 8) | (buffer[p + 2] << 16) | (buffer[p + 3] << 24);
@@ -253,6 +278,15 @@ function readSubchunkPaletteIds(buffer, offset, end) {
         }
         const paletteSize = buffer[p] | (buffer[p + 1] << 8) | (buffer[p + 2] << 16) | (buffer[p + 3] << 24);
         p += 4;
+        // UNDONE: This does not actually restore the original data.
+        // Attempt to repair corrupted value data from versions <=v1.9.0 of the module.
+        // if (blocksPerWord !== Math.floor(blocksPerWord) && end - originalP < 4 * (Math.floor(4095 / Math.floor(blocksPerWord)) + 1)) {
+        //     for (let u = 0; u < 4096; u++) {
+        //         const v = values[u]!;
+        //         const repairedValue: number = Math.floor(v / 2);
+        //         values[u] = repairedValue;
+        //     }
+        // }
         return { values, isPersistent, paletteSize, newOffset: p };
     }
     else {
@@ -265,7 +299,10 @@ function readSubchunkPaletteIds(buffer, offset, end) {
 }
 function writeSubchunkPaletteIds(values, paletteSize) {
     const blockCount = values.length; // usually 16*16*16 = 4096
-    const bitsPerBlock = Math.max(1, Math.ceil(Math.log2(paletteSize)));
+    const bitsPerBlockOriginal = Math.max(1, Math.ceil(Math.log2(paletteSize)));
+    const bitsPerBlockDivisors = [1, 2, 4, 8, 16, 32];
+    const bitsPerBlock = bitsPerBlockDivisors.find((d) => d >= bitsPerBlockOriginal) ?? 32;
+    // console.log(bitsPerBlock);
     const wordsPerBlock = Math.ceil((blockCount * bitsPerBlock) / 32);
     const words = new Uint32Array(wordsPerBlock);
     // let bitIndex: number = 0;
@@ -1169,7 +1206,7 @@ export const entryContentTypeToFormatMap = {
          */
         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.
          */
         resultType: "JSONNBT",
         /**
@@ -1185,7 +1222,7 @@ export const entryContentTypeToFormatMap = {
         async parse(data) {
             const entityIds = [];
             for (let i = 0; i < data.length; i += 8) {
-                entityIds.push({ type: "int", value: [data.readInt32LE(i), data.readInt32LE(i + 4)] });
+                entityIds.push([data.readInt32LE(i), data.readInt32LE(i + 4)]);
             }
             return {
                 type: "compound",
@@ -1193,7 +1230,7 @@ export const entryContentTypeToFormatMap = {
                     entityIds: {
                         type: "list",
                         value: {
-                            type: "list",
+                            type: "long",
                             value: entityIds,
                         },
                     },
@@ -1207,12 +1244,14 @@ export 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.
          */
         serialize(data) {
             const rawData = data.value.entityIds.value.value.map((entityIds) => {
                 const buffer = Buffer.alloc(8);
-                buffer.writeInt32LE(entityIds.value[0], 0);
-                buffer.writeInt32LE(entityIds.value[1], 4);
+                buffer.writeInt32LE(entityIds[0], 0);
+                buffer.writeInt32LE(entityIds[1], 4);
                 return buffer;
             });
             return Buffer.concat(rawData);
@@ -1516,136 +1555,11 @@ export const entryContentTypeToFormatMap = {
      *
      * 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).
      *
-     * `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 are followed by multiple chunks of data formatted as the 8 byte hash of the NBT data plus the NBT compound.
      *
-     * 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}
      * ```
-     *
-     * ```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"
-     *     }
-     * ]
-     * ```
      */
     LevelChunkMetaDataDictionary: {
         /**