@spyglassmc/core 0.4.45 → 0.4.46

package/lib/common/Dev.js

@@ -1,3 +1,4 @@
+import { bigintJsonNumberReplacer } from './index.js';
 export var Dev;
 (function (Dev) {
     function assertDefined(value) {
@@ -68,12 +69,12 @@ export var Dev;
         if (value && typeof value === 'object') {
             try {
                 const seen = new Set();
-                return JSON.stringify(value, (_k, v) => {
+                return JSON.stringify(value, (k, v) => {
                     if (v && typeof v === 'object') {
                         return seen.has(v) ? '[Circular]' : (seen.add(v), v);
                     }
                     else {
-                        return v;
+                        return bigintJsonNumberReplacer(k, v);
                     }
                 });
             }

package/lib/common/index.d.ts

@@ -1,5 +1,6 @@
 export * from './Dev.js';
 export * from './externals/index.js';
+export * from './json.js';
 export * from './Logger.js';
 export * from './Operations.js';
 export * from './ReadonlyProxy.js';

package/lib/common/index.js

@@ -1,5 +1,6 @@
 export * from './Dev.js';
 export * from './externals/index.js';
+export * from './json.js';
 export * from './Logger.js';
 export * from './Operations.js';
 export * from './ReadonlyProxy.js';

package/lib/common/json.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Json replacer that writes bigints as a json string of the form `"$$type:bigint;$$value:91"`.
+ * Intended to be used with `bigintJsonLosslessReviver`
+ * @param _key The key at which the value lives
+ * @param value The value to encode
+ * @returns Replaced value
+ */
+export declare function bigintJsonLosslessReplacer(_key: string, value: any): any;
+/**
+ * Json reviver that revives bigints encoded by `bigintJsonLosslessReplacer`
+ * @param _key
+ * @param value
+ * @returns
+ */
+export declare function bigintJsonLosslessReviver(_key: string, value: any): any;
+/**
+ * Json replacer that replaces bigints with raw json number literals, encoding the entire number.
+ * @param _key The key at which the value lives
+ * @param value The value to encode
+ * @returns Replaced value
+ */
+export declare function bigintJsonNumberReplacer(_key: string, value: any): any;
+/**
+ * Json reviver that when encountering a number will decide whether that number needs to be
+ * represented as a bigint in order to be lossless. Uses normal numbers whenever possible or required.
+ * @param _key The key at which the value lives
+ * @param value The value that was read
+ * @param data Additional data, source includes the raw json value.
+ * @returns The javascript value
+ */
+export declare function bigintJsonNumberReviver(_key: string, value: any, data?: {
+    source?: string;
+}): any;
+//# sourceMappingURL=json.d.ts.map

package/lib/common/json.js

@@ -0,0 +1,53 @@
+/**
+ * Json replacer that writes bigints as a json string of the form `"$$type:bigint;$$value:91"`.
+ * Intended to be used with `bigintJsonLosslessReviver`
+ * @param _key The key at which the value lives
+ * @param value The value to encode
+ * @returns Replaced value
+ */
+export function bigintJsonLosslessReplacer(_key, value) {
+    return typeof value === 'bigint'
+        ? `$$type:bigint;$$value:${value}`
+        : value;
+}
+/**
+ * Json reviver that revives bigints encoded by `bigintJsonLosslessReplacer`
+ * @param _key
+ * @param value
+ * @returns
+ */
+export function bigintJsonLosslessReviver(_key, value) {
+    return typeof value === 'string' && value.startsWith('$$type:bigint;$$value:')
+        ? BigInt(value.substring(22))
+        : value;
+}
+/**
+ * Json replacer that replaces bigints with raw json number literals, encoding the entire number.
+ * @param _key The key at which the value lives
+ * @param value The value to encode
+ * @returns Replaced value
+ */
+export function bigintJsonNumberReplacer(_key, value) {
+    return typeof value === 'bigint'
+        ? JSON.rawJSON(value.toString())
+        : value;
+}
+/**
+ * Json reviver that when encountering a number will decide whether that number needs to be
+ * represented as a bigint in order to be lossless. Uses normal numbers whenever possible or required.
+ * @param _key The key at which the value lives
+ * @param value The value that was read
+ * @param data Additional data, source includes the raw json value.
+ * @returns The javascript value
+ */
+export function bigintJsonNumberReviver(_key, value, data) {
+    return typeof value === 'number'
+        && data?.source !== undefined
+        && !data.source.includes('.')
+        && !data.source.includes('e')
+        && !data.source.includes('E')
+        && BigInt(value).toString() !== data.source
+        ? BigInt(data.source)
+        : value;
+}
+//# sourceMappingURL=json.js.map

package/lib/common/util.d.ts

@@ -141,4 +141,34 @@ export declare function normalizeUri(uri: string): string;
  * ```
  */
 export type InheritReadonly<TARGET extends AstNode, INPUT extends DeepReadonly<AstNode> | undefined> = INPUT & (INPUT extends ReadWrite<AstNode> ? TARGET : DeepReadonly<TARGET>);
+/**
+ * Checks if the numeric value of a number or bigint is the same. Undefined is **not** the same as
+ * 0 for this function.
+ * @param a The first number to compare
+ * @param b The second number to compare
+ * @returns True if the numeric falue is equal, false otherwise.
+ */
+export declare function numericEquals(a: bigint | number | undefined, b: bigint | number | undefined): boolean;
+/**
+ * Tries to convert a numeric type to number if that is possible without precision loss.
+ * Undefined stays untouched.
+ * @param n The numeric value
+ * @returns The numeric value converted to a number if there was no precision loss, the given value
+ * otherwise
+ */
+export declare function tryConvertToNumberWithoutPrecisionLoss<T extends (number | bigint | undefined)>(n: T): number | T;
+/**
+ * Compares two numeric types and finds the smallest
+ * @param a The first value
+ * @param b The second value
+ * @returns The smaller value of `a` and `b`
+ */
+export declare function min<T extends (number | bigint)>(a: T, b: T): T;
+/**
+ * Compares two numeric types and finds the biggest
+ * @param a The first value
+ * @param b The second value
+ * @returns The bigger value of `a` and `b`
+ */
+export declare function max<T extends (number | bigint)>(a: T, b: T): T;
 //# sourceMappingURL=util.d.ts.map

package/lib/common/util.js

@@ -267,4 +267,48 @@ export function normalizeUri(uri) {
     obj.pathname = normalizeUriPathname(obj.pathname);
     return obj.toString();
 }
+/**
+ * Checks if the numeric value of a number or bigint is the same. Undefined is **not** the same as
+ * 0 for this function.
+ * @param a The first number to compare
+ * @param b The second number to compare
+ * @returns True if the numeric falue is equal, false otherwise.
+ */
+export function numericEquals(a, b) {
+    return tryConvertToNumberWithoutPrecisionLoss(a) === tryConvertToNumberWithoutPrecisionLoss(b);
+}
+/**
+ * Tries to convert a numeric type to number if that is possible without precision loss.
+ * Undefined stays untouched.
+ * @param n The numeric value
+ * @returns The numeric value converted to a number if there was no precision loss, the given value
+ * otherwise
+ */
+export function tryConvertToNumberWithoutPrecisionLoss(n) {
+    if (typeof n === 'bigint') {
+        const num = Number(n);
+        if (BigInt(num) === n) {
+            return num;
+        }
+    }
+    return n;
+}
+/**
+ * Compares two numeric types and finds the smallest
+ * @param a The first value
+ * @param b The second value
+ * @returns The smaller value of `a` and `b`
+ */
+export function min(a, b) {
+    return a < b ? a : b;
+}
+/**
+ * Compares two numeric types and finds the biggest
+ * @param a The first value
+ * @param b The second value
+ * @returns The bigger value of `a` and `b`
+ */
+export function max(a, b) {
+    return a > b ? a : b;
+}
 //# sourceMappingURL=util.js.map

package/lib/parser/string.d.ts

@@ -6,11 +6,11 @@ import type { Parser, Result, Returnable } from './Parser.js';
 export declare function string(options: StringOptions): InfallibleParser<StringNode>;
 export declare function parseStringValue<T extends Returnable>(parser: Parser<T>, value: string, map: IndexMap, ctx: ParserContext): Result<T>;
 export declare const BrigadierUnquotableCharacters: readonly ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "_", ".", "+", "-"];
-export declare const BrigadierUnquotableCharacterSet: Set<"0" | "k" | "v" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
+export declare const BrigadierUnquotableCharacterSet: Set<"0" | "k" | "v" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "e" | "E" | "i" | "p" | "-" | "+" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
 export declare const BrigadierUnquotablePattern: RegExp;
 export declare const BrigadierUnquotableOption: {
     allowEmpty: boolean;
-    allowList: Set<"0" | "k" | "v" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "i" | "p" | "-" | "+" | "e" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
+    allowList: Set<"0" | "k" | "v" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "e" | "E" | "i" | "p" | "-" | "+" | "a" | "b" | "c" | "d" | "f" | "g" | "h" | "j" | "l" | "m" | "n" | "o" | "q" | "r" | "s" | "t" | "u" | "w" | "x" | "y" | "z" | "_" | "A" | "B" | "C" | "D" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z">;
 };
 export declare const BrigadierStringOptions: StringOptions;
 export declare const brigadierString: InfallibleParser<StringNode>;

package/lib/service/CacheService.d.ts

@@ -7,7 +7,7 @@ import type { Project } from './Project.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export declare const LatestCacheVersion = 6;
+export declare const LatestCacheVersion = 7;
 /**
  * Checksums of cached files or roots.
  */

package/lib/service/CacheService.js

@@ -1,4 +1,4 @@
-import { Uri } from '../common/index.js';
+import { bigintJsonLosslessReplacer, bigintJsonLosslessReviver, Uri } from '../common/index.js';
 import { SymbolTable } from '../symbol/index.js';
 import { ArchiveUriSupporter } from './FileService.js';
 import { fileUtil } from './fileUtil.js';
@@ -6,7 +6,7 @@ import { fileUtil } from './fileUtil.js';
  * The format version of the cache. Should be increased when any changes that
  * could invalidate the cache are introduced to the Spyglass codebase.
  */
-export const LatestCacheVersion = 6;
+export const LatestCacheVersion = 7;
 var Checksums;
 (function (Checksums) {
     function create() {
@@ -87,7 +87,7 @@ export class CacheService {
         try {
             filePath = await this.getCacheFileUri();
             this.project.logger.info(`[CacheService#load] symbolCachePath = ${filePath}`);
-            const cache = (await fileUtil.readGzippedJson(this.project.externals, filePath));
+            const cache = (await fileUtil.readGzippedJson(this.project.externals, filePath, bigintJsonLosslessReviver));
             __profiler.task('Read File');
             if (cache.version === LatestCacheVersion) {
                 this.checksums = cache.checksums;
@@ -186,7 +186,7 @@ export class CacheService {
                 errors: this.errors,
             };
             __profiler.task('Unlink Symbols');
-            await fileUtil.writeGzippedJson(this.project.externals, filePath, cache);
+            await fileUtil.writeGzippedJson(this.project.externals, filePath, cache, bigintJsonLosslessReplacer);
             __profiler.task('Write File').finalize();
             return true;
         }

package/lib/service/fileUtil.d.ts

@@ -109,10 +109,10 @@ export declare namespace fileUtil {
     /**
      * @throws
      */
-    function readGzippedJson(externals: Externals, path: FsLocation): Promise<unknown>;
+    function readGzippedJson(externals: Externals, path: FsLocation, reviver?: (this: any, key: string, value: any) => any): Promise<unknown>;
     /**
      * @throws
      */
-    function writeGzippedJson(externals: Externals, path: FsLocation, data: any): Promise<void>;
+    function writeGzippedJson(externals: Externals, path: FsLocation, data: any, replacer?: (this: any, key: string, value: any) => any): Promise<void>;
 }
 //# sourceMappingURL=fileUtil.d.ts.map

package/lib/service/fileUtil.js

@@ -1,4 +1,4 @@
-import { bufferToString, Uri } from '../common/index.js';
+import { bigintJsonNumberReplacer, bigintJsonNumberReviver, bufferToString, Uri, } from '../common/index.js';
 export var fileUtil;
 (function (fileUtil) {
     /**
@@ -228,7 +228,7 @@ export var fileUtil;
      * @throws
      */
     async function readJson(externals, path) {
-        return JSON.parse(bufferToString(await readFile(externals, path)));
+        return JSON.parse(bufferToString(await readFile(externals, path)), bigintJsonNumberReviver);
     }
     fileUtil.readJson = readJson;
     /* istanbul ignore next */
@@ -238,7 +238,7 @@ export var fileUtil;
      * @see {@link writeFile}
      */
     async function writeJson(externals, path, data) {
-        return writeFile(externals, path, JSON.stringify(data));
+        return writeFile(externals, path, JSON.stringify(data, bigintJsonNumberReplacer));
     }
     fileUtil.writeJson = writeJson;
     /**
@@ -261,15 +261,15 @@ export var fileUtil;
     /**
      * @throws
      */
-    async function readGzippedJson(externals, path) {
-        return JSON.parse(bufferToString(await readGzippedFile(externals, path)));
+    async function readGzippedJson(externals, path, reviver) {
+        return JSON.parse(bufferToString(await readGzippedFile(externals, path)), reviver ?? bigintJsonNumberReviver);
     }
     fileUtil.readGzippedJson = readGzippedJson;
     /**
      * @throws
      */
-    async function writeGzippedJson(externals, path, data) {
-        return writeGzippedFile(externals, path, JSON.stringify(data));
+    async function writeGzippedJson(externals, path, data, replacer) {
+        return writeGzippedFile(externals, path, JSON.stringify(data, replacer ?? bigintJsonNumberReplacer));
     }
     fileUtil.writeGzippedJson = writeGzippedJson;
 })(fileUtil || (fileUtil = {}));

package/lib/symbol/Symbol.js

@@ -1,5 +1,6 @@
 import rfdc from 'rfdc';
 import { isIterable } from '../common/index.js';
+import { bigintJsonLosslessReplacer, bigintJsonLosslessReviver } from '../common/json.js';
 import { Location, PositionRange, Range } from '../source/index.js';
 // #region Mcdoc Categories
 export const McdocCategories = Object.freeze(['mcdoc', 'mcdoc/dispatcher']);
@@ -399,14 +400,14 @@ export var SymbolTable;
      * a symbol table through the {@link deserialize} method.
      */
     function serialize(table) {
-        return JSON.stringify(unlink(table));
+        return JSON.stringify(unlink(table), bigintJsonLosslessReplacer);
     }
     SymbolTable.serialize = serialize;
     /**
      * @returns The symbol table represented by the string returned by the {@link serialize} method.
      */
     function deserialize(json) {
-        return link(JSON.parse(json));
+        return link(JSON.parse(json, bigintJsonLosslessReviver));
     }
     SymbolTable.deserialize = deserialize;
 })(SymbolTable || (SymbolTable = {}));

package/lib/symbol/SymbolUtil.d.ts

@@ -1,5 +1,5 @@
 import { TextDocument } from 'vscode-languageserver-textdocument';
-import type { DeepReadonly, ExternalEventEmitter, Externals } from '../common/index.js';
+import { type DeepReadonly, type ExternalEventEmitter, type Externals } from '../common/index.js';
 import type { AstNode } from '../node/index.js';
 import type { RangeLike } from '../source/index.js';
 import type { AllCategory, Symbol, SymbolLocationBuiltInContributor, SymbolLocationMetadata, SymbolMap, SymbolMetadata, SymbolTable, SymbolUsageType } from './Symbol.js';

package/lib/symbol/SymbolUtil.js

@@ -5,6 +5,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import { bigintJsonNumberReplacer, } from '../common/index.js';
 import { Range } from '../source/index.js';
 import { SymbolLocation, SymbolPath, SymbolUsageTypes } from './Symbol.js';
 export class SymbolUtil {
@@ -831,7 +832,7 @@ export var SymbolFormatter;
             + ` {${symbol.category}${symbol.subcategory ? ` (${symbol.subcategory})` : ''}}`
             + ` [${stringifyVisibility(symbol.visibility, symbol.visibilityRestriction)}]`);
         if (symbol.data) {
-            ans.push(`${IndentChar}data: ${JSON.stringify(symbol.data)}`);
+            ans.push(`${IndentChar}data: ${JSON.stringify(symbol.data, bigintJsonNumberReplacer)}`);
         }
         if (symbol.desc) {
             ans.push(`${IndentChar}description: ${symbol.desc}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spyglassmc/core",
-  "version": "0.4.45",
+  "version": "0.4.46",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -23,7 +23,7 @@
     "rfdc": "^1.3.0",
     "vscode-languageserver-textdocument": "^1.0.4",
     "whatwg-url": "^14.0.0",
-    "@spyglassmc/locales": "0.3.23"
+    "@spyglassmc/locales": "0.3.24"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.3",