@minecraft/api-docs-generator 1.0.0

package/lib/test/versionParsing.test.js

@@ -0,0 +1,147 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils = __importStar(require("../utilities"));
+const semver_1 = __importDefault(require("semver"));
+const vitest_1 = require("vitest");
+const versionEqualityTestCases = [
+    {
+        testDescription: 'Appending to beta version with minecraft preview version',
+        expectedString: '1.2.3-beta.4.5.6-preview.7',
+        inputModuleVersion: semver_1.default.parse('1.2.3-beta'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6-preview.7'),
+        onlyUsePrereleaseInfo: false,
+    },
+    {
+        testDescription: 'Appending to beta version with minecraft non-preview version',
+        expectedString: '1.2.3-beta.4.5.6-stable',
+        inputModuleVersion: semver_1.default.parse('1.2.3-beta'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6'),
+        onlyUsePrereleaseInfo: false,
+    },
+    {
+        testDescription: 'Appending to non-beta version with minecraft preview version',
+        expectedString: '1.2.3-rc.4.5.6-preview.7',
+        inputModuleVersion: semver_1.default.parse('1.2.3'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6-preview.7'),
+        onlyUsePrereleaseInfo: false,
+    },
+    {
+        testDescription: 'Appending to non-beta version with minecraft non-preview version',
+        expectedString: '1.2.3',
+        inputModuleVersion: semver_1.default.parse('1.2.3'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6'),
+        onlyUsePrereleaseInfo: false,
+    },
+    {
+        testDescription: 'Only leveraging pre-release information for minecraft version',
+        expectedString: '1.2.3-preview.20',
+        inputModuleVersion: semver_1.default.parse('1.2.3'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6-preview.20'),
+        onlyUsePrereleaseInfo: true,
+    },
+    {
+        testDescription: 'Does not use minecraft version override if it is not a pre-release version',
+        expectedString: '1.2.3',
+        inputModuleVersion: semver_1.default.parse('1.2.3'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6'),
+        onlyUsePrereleaseInfo: true,
+    },
+    {
+        testDescription: 'Removes prerelease info from minecraft version override when only using prerelease info from input',
+        expectedString: '1.2.3-preview.20',
+        inputModuleVersion: semver_1.default.parse('1.2.3-beta.0'),
+        inputMinecraftVersion: semver_1.default.parse('4.5.6-preview.20'),
+        onlyUsePrereleaseInfo: true,
+    },
+];
+(0, vitest_1.describe)(`Version Parsing`, () => {
+    for (const versionTest of versionEqualityTestCases) {
+        (0, vitest_1.it)(versionTest.testDescription, function () {
+            (0, vitest_1.expect)(versionTest.expectedString).toEqual(utils.appendMinecraftVersion(versionTest.inputModuleVersion, versionTest.inputMinecraftVersion, versionTest.onlyUsePrereleaseInfo));
+        });
+    }
+    (0, vitest_1.it)('Sorts Versions Correctly', () => {
+        const versionOrderTestCases = [
+            {
+                expectedOrder: 2,
+                moduleVersion: semver_1.default.parse('1.0.0-beta'),
+                minecraftVersion: semver_1.default.parse('1.1.0-preview.1'),
+            },
+            {
+                expectedOrder: 0,
+                moduleVersion: semver_1.default.parse('1.0.0-beta'),
+                minecraftVersion: semver_1.default.parse('1.0.0-preview.1'),
+            },
+            {
+                expectedOrder: 1,
+                moduleVersion: semver_1.default.parse('1.0.0-beta'),
+                minecraftVersion: semver_1.default.parse('1.0.0'),
+            },
+            {
+                expectedOrder: 5,
+                moduleVersion: semver_1.default.parse('1.0.0'),
+                minecraftVersion: semver_1.default.parse('1.2.0'),
+            },
+            {
+                expectedOrder: 3,
+                moduleVersion: semver_1.default.parse('1.0.0-beta'),
+                minecraftVersion: semver_1.default.parse('1.1.0'),
+            },
+            {
+                expectedOrder: 4,
+                moduleVersion: semver_1.default.parse('1.0.0'),
+                minecraftVersion: semver_1.default.parse('1.2.0-preview.1'),
+            },
+            {
+                expectedOrder: 6,
+                moduleVersion: semver_1.default.parse('1.1.0-beta'),
+                minecraftVersion: semver_1.default.parse('1.1.0-preview.1'),
+            },
+        ];
+        const sortedVersions = versionOrderTestCases.sort((a, b) => {
+            const aVersion = utils.appendMinecraftVersion(a.moduleVersion, a.minecraftVersion);
+            const bVersion = utils.appendMinecraftVersion(b.moduleVersion, b.minecraftVersion);
+            return semver_1.default.compare(aVersion, bVersion);
+        });
+        for (let i = 0; i < sortedVersions.length; ++i) {
+            (0, vitest_1.expect)(i).toEqual(sortedVersions[i].expectedOrder);
+        }
+    });
+    (0, vitest_1.it)("Beta Minecraft release modules are 'less than' non-beta release modules", () => {
+        const betaMinecraftRelease = semver_1.default.parse('1.2.3-preview.4');
+        const nonBetaMinecraftRelease = semver_1.default.parse('1.2.3');
+        const betaModule = utils.appendMinecraftVersion(semver_1.default.parse('1.0.0-beta'), betaMinecraftRelease);
+        const nonBetaModule = utils.appendMinecraftVersion(semver_1.default.parse('1.0.0-beta'), nonBetaMinecraftRelease);
+        (0, vitest_1.expect)(semver_1.default.lt(betaModule, nonBetaModule)).toBeTruthy();
+        (0, vitest_1.expect)(semver_1.default.gt(nonBetaModule, betaModule)).toBeTruthy();
+    });
+});
+//# sourceMappingURL=versionParsing.test.js.map

package/lib/test/versionParsing.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"versionParsing.test.js","sourceRoot":"","sources":["../../src/test/versionParsing.test.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAElC,oDAAsC;AACtC,oDAA4B;AAC5B,mCAA8C;AAU9C,MAAM,wBAAwB,GAA8B;IACxD;QACI,eAAe,EAAE,0DAA0D;QAC3E,cAAc,EAAE,4BAA4B;QAC5C,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;QAC9C,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;QACtD,qBAAqB,EAAE,KAAK;KAC/B;IACD;QACI,eAAe,EAAE,8DAA8D;QAC/E,cAAc,EAAE,yBAAyB;QACzC,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;QAC9C,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5C,qBAAqB,EAAE,KAAK;KAC/B;IACD;QACI,eAAe,EAAE,8DAA8D;QAC/E,cAAc,EAAE,0BAA0B;QAC1C,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzC,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;QACtD,qBAAqB,EAAE,KAAK;KAC/B;IACD;QACI,eAAe,EAAE,kEAAkE;QACnF,cAAc,EAAE,OAAO;QACvB,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzC,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5C,qBAAqB,EAAE,KAAK;KAC/B;IACD;QACI,eAAe,EAAE,+DAA+D;QAChF,cAAc,EAAE,kBAAkB;QAClC,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzC,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACvD,qBAAqB,EAAE,IAAI;KAC9B;IACD;QACI,eAAe,EAAE,4EAA4E;QAC7F,cAAc,EAAE,OAAO;QACvB,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzC,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5C,qBAAqB,EAAE,IAAI;KAC9B;IACD;QACI,eAAe,EACX,oGAAoG;QACxG,cAAc,EAAE,kBAAkB;QAClC,kBAAkB,EAAE,gBAAM,CAAC,KAAK,CAAC,cAAc,CAAC;QAChD,qBAAqB,EAAE,gBAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;QACvD,qBAAqB,EAAE,IAAI;KAC9B;CACJ,CAAC;AAQF,IAAA,iBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,KAAK,MAAM,WAAW,IAAI,wBAAwB,EAAE,CAAC;QACjD,IAAA,WAAE,EAAC,WAAW,CAAC,eAAe,EAAE;YAC5B,IAAA,eAAM,EAAC,WAAW,CAAC,cAAc,CAAC,CAAC,OAAO,CACtC,KAAK,CAAC,sBAAsB,CACxB,WAAW,CAAC,kBAAkB,EAC9B,WAAW,CAAC,qBAAqB,EACjC,WAAW,CAAC,qBAAqB,CACpC,CACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,IAAA,WAAE,EAAC,0BAA0B,EAAE,GAAG,EAAE;QAChC,MAAM,qBAAqB,GAA2B;YAClD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACzC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACpD;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACzC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACpD;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACzC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;aAC1C;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;gBACpC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;aAC1C;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACzC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;aAC1C;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC;gBACpC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACpD;YACD;gBACI,aAAa,EAAE,CAAC;gBAChB,aAAa,EAAE,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACzC,gBAAgB,EAAE,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC;aACpD;SACJ,CAAC;QAEF,MAAM,cAAc,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACvD,MAAM,QAAQ,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,gBAAgB,CAAC,CAAC;YACnF,MAAM,QAAQ,GAAG,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,gBAAgB,CAAC,CAAC;YACnF,OAAO,gBAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC7C,IAAA,eAAM,EAAC,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,yEAAyE,EAAE,GAAG,EAAE;QAC/E,MAAM,oBAAoB,GAAG,gBAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC7D,MAAM,uBAAuB,GAAG,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtD,MAAM,UAAU,GAAG,KAAK,CAAC,sBAAsB,CAAC,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC,CAAC;QAClG,MAAM,aAAa,GAAG,KAAK,CAAC,sBAAsB,CAAC,gBAAM,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAC,CAAC;QAExG,IAAA,eAAM,EAAC,gBAAM,CAAC,EAAE,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QAC1D,IAAA,eAAM,EAAC,gBAAM,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/utilities/AppendVersion.d.ts

@@ -0,0 +1,8 @@
+import semver from 'semver';
+/**
+ * Appends unique build info to pre-release tags to ensure unique module names per release.
+ *
+ * If 'onlyUsePrereleaseInfo' is set to true, we only use the prerelease part of the Minecraft version,
+ * e.g. "-preview.5" out of "1.2.3-preview.5"
+ */
+export declare function appendMinecraftVersion(parsedVersion: semver.SemVer, minecraftVersion: semver.SemVer, onlyUsePrereleaseInfo?: boolean): string;

package/lib/utilities/AppendVersion.js

@@ -0,0 +1,46 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendMinecraftVersion = appendMinecraftVersion;
+const semver_1 = __importDefault(require("semver"));
+/**
+ * Appends unique build info to pre-release tags to ensure unique module names per release.
+ *
+ * If 'onlyUsePrereleaseInfo' is set to true, we only use the prerelease part of the Minecraft version,
+ * e.g. "-preview.5" out of "1.2.3-preview.5"
+ */
+function appendMinecraftVersion(parsedVersion, minecraftVersion, onlyUsePrereleaseInfo) {
+    const versionToAppend = onlyUsePrereleaseInfo && minecraftVersion.prerelease.length > 0
+        ? minecraftVersion.prerelease.join('.')
+        : minecraftVersion.toString();
+    let correctedVersion = !onlyUsePrereleaseInfo
+        ? parsedVersion
+        : semver_1.default.parse(`${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}`);
+    if (minecraftVersion.prerelease.length === 2) {
+        // Pre-release Minecraft
+        if (correctedVersion.prerelease.length > 0) {
+            // Pre-release module
+            correctedVersion = semver_1.default.parse(`${correctedVersion.format()}.${versionToAppend}`);
+        }
+        else {
+            // Stable module
+            correctedVersion = semver_1.default.parse(`${correctedVersion.format()}-${onlyUsePrereleaseInfo ? '' : 'rc.'}${versionToAppend}`);
+        }
+    }
+    else if (minecraftVersion.prerelease.length === 0) {
+        // Stable Minecraft
+        if (correctedVersion.prerelease.length > 0) {
+            // Pre-release module
+            correctedVersion = semver_1.default.parse(`${correctedVersion.format()}.${versionToAppend}-stable`);
+        }
+    }
+    else {
+        throw new Error(`Unexpected prerelease tag in Minecraft version '${minecraftVersion.format()}'.`);
+    }
+    return correctedVersion.format();
+}
+//# sourceMappingURL=AppendVersion.js.map

package/lib/utilities/AppendVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppendVersion.js","sourceRoot":"","sources":["../../src/utilities/AppendVersion.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;AAUlC,wDAoCC;AA5CD,oDAA4B;AAE5B;;;;;GAKG;AACH,SAAgB,sBAAsB,CAClC,aAA4B,EAC5B,gBAA+B,EAC/B,qBAA+B;IAE/B,MAAM,eAAe,GACjB,qBAAqB,IAAI,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;QAC3D,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC;QACvC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;IAEtC,IAAI,gBAAgB,GAAG,CAAC,qBAAqB;QACzC,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,gBAAM,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC;IAE3F,IAAI,gBAAgB,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3C,wBAAwB;QACxB,IAAI,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,qBAAqB;YACrB,gBAAgB,GAAG,gBAAM,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC,CAAC;QACvF,CAAC;aAAM,CAAC;YACJ,gBAAgB;YAChB,gBAAgB,GAAG,gBAAM,CAAC,KAAK,CAC3B,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,eAAe,EAAE,CACzF,CAAC;QACN,CAAC;IACL,CAAC;SAAM,IAAI,gBAAgB,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClD,mBAAmB;QACnB,IAAI,gBAAgB,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,qBAAqB;YACrB,gBAAgB,GAAG,gBAAM,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,IAAI,eAAe,SAAS,CAAC,CAAC;QAC9F,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,KAAK,CAAC,mDAAmD,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,gBAAgB,CAAC,MAAM,EAAE,CAAC;AACrC,CAAC"}

package/lib/utilities/Complete.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Small helper that makes every field in a struct non-optional, but re-adds undefined in the explicit type.
+ * This allows us to ensure we don't miss any fields on generation update, but still allow for undefined values
+ */
+export type Complete<T> = {
+    [P in keyof Required<T>]: T[P] extends Required<T>[P] ? T[P] : T[P] | undefined;
+};

package/lib/utilities/Complete.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Complete.js.map

package/lib/utilities/Complete.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Complete.js","sourceRoot":"","sources":["../../src/utilities/Complete.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC"}

package/lib/utilities/DeepCopyJson.d.ts

@@ -0,0 +1,4 @@
+export type DeepCopyType<T> = T extends object ? {
+    [K in keyof T]: DeepCopyType<T[K]>;
+} : T;
+export declare function deepCopyJson<T>(value: T): DeepCopyType<T>;

package/lib/utilities/DeepCopyJson.js

@@ -0,0 +1,46 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepCopyJson = deepCopyJson;
+const log = __importStar(require("../Logger"));
+function deepCopyJson(value) {
+    // eslint-disable-next-line unicorn/no-null
+    if (value === undefined || value === null) {
+        return undefined;
+    }
+    try {
+        return JSON.parse(
+        // eslint-disable-next-line unicorn/no-null
+        JSON.stringify(value, (_key, value) => (typeof value === 'undefined' ? null : value)));
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            log.error(`deepCopyJson failed: ${e.message} @ ${e.stack}`);
+        }
+    }
+}
+//# sourceMappingURL=DeepCopyJson.js.map

package/lib/utilities/DeepCopyJson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeepCopyJson.js","sourceRoot":"","sources":["../../src/utilities/DeepCopyJson.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;AAMlC,oCAeC;AAnBD,+CAAiC;AAIjC,SAAgB,YAAY,CAAI,KAAQ;IACpC,2CAA2C;IAC3C,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,IAAI,CAAC;QACD,OAAO,IAAI,CAAC,KAAK;QACb,2CAA2C;QAC3C,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,IAAY,EAAE,KAAc,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CACtF,CAAC;IACzB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;AACL,CAAC"}

package/lib/utilities/GetFiles.d.ts

@@ -0,0 +1,3 @@
+export declare function readFile(filePath: string): Buffer | undefined;
+export declare function getFiles(dir: string): string[];
+export declare function getFilesRecursively(dir: string): string[];

package/lib/utilities/GetFiles.js

@@ -0,0 +1,44 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = readFile;
+exports.getFiles = getFiles;
+exports.getFilesRecursively = getFilesRecursively;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function readFile(filePath) {
+    try {
+        const fileData = fs_1.default.readFileSync(filePath);
+        return fileData;
+    }
+    catch {
+        return undefined;
+    }
+}
+function getFiles(dir) {
+    try {
+        const files = fs_1.default.readdirSync(dir);
+        return files;
+    }
+    catch {
+        return [];
+    }
+}
+function getFilesRecursively(dir) {
+    try {
+        const dirents = fs_1.default.readdirSync(dir, { withFileTypes: true });
+        const files = dirents.map(dirent => {
+            const res = path_1.default.resolve(dir, dirent.name);
+            return dirent.isDirectory() ? getFilesRecursively(res) : res;
+        });
+        return Array.prototype.concat(...files);
+    }
+    catch {
+        return [];
+    }
+}
+//# sourceMappingURL=GetFiles.js.map

package/lib/utilities/GetFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GetFiles.js","sourceRoot":"","sources":["../../src/utilities/GetFiles.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;AAKlC,4BAOC;AAED,4BAOC;AAED,kDAWC;AAhCD,4CAAoB;AACpB,gDAAwB;AAExB,SAAgB,QAAQ,CAAC,QAAgB;IACrC,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,OAAO,QAAQ,CAAC;IACpB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC;AAED,SAAgB,QAAQ,CAAC,GAAW;IAChC,IAAI,CAAC;QACD,MAAM,KAAK,GAAG,YAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,KAAK,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC;AAED,SAAgB,mBAAmB,CAAC,GAAW;IAC3C,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,YAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC/B,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3C,OAAO,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACjE,CAAC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,KAAK,CAAa,CAAC;IACxD,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC"}

package/lib/utilities/LongestCommonSubsequence.d.ts

@@ -0,0 +1,3 @@
+export type GenericObject = Record<string, unknown>;
+export declare function longestCommonSubsequence(oldArray: GenericObject[], newArray: GenericObject[], key: string): unknown[];
+export declare function diffArray(oldArray: GenericObject[] | undefined, newArray: GenericObject[] | undefined, key: string): GenericObject[];

package/lib/utilities/LongestCommonSubsequence.js

@@ -0,0 +1,123 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.longestCommonSubsequence = longestCommonSubsequence;
+exports.diffArray = diffArray;
+// https://en.wikipedia.org/wiki/Longest_common_subsequence
+// returns the longest common subsequence of the two arrays (returns the keys)
+// this can be used to generate additions and removals as everything that is returned from this
+// is the key of common elements found in both arrays
+function longestCommonSubsequence(oldArray, newArray, key) {
+    // create LCS comparison array initialized to 0
+    const c = new Array(oldArray.length + 1);
+    for (let i = 0; i < c.length; ++i) {
+        c[i] = new Array(newArray.length + 1);
+        for (let j = 0; j < c[i].length; ++j) {
+            c[i][j] = 0;
+        }
+    }
+    for (let i = 1; i <= oldArray.length; ++i) {
+        for (let j = 1; j <= newArray.length; ++j) {
+            if (oldArray[i - 1][key] === newArray[j - 1][key]) {
+                c[i][j] = c[i - 1][j - 1] + 1;
+            }
+            else {
+                c[i][j] = Math.max(c[i][j - 1], c[i - 1][j]);
+            }
+        }
+    }
+    // backtrack to build LCS values (we backtrace because the matrix traversal starts
+    // from the end which represents the longest of the common subsequences)
+    let i = oldArray.length;
+    let j = newArray.length;
+    const ret = [];
+    while (i !== 0 && j !== 0) {
+        if (oldArray[i - 1][key] === newArray[j - 1][key]) {
+            ret.push(oldArray[i - 1][key]);
+            i -= 1;
+            j -= 1;
+        }
+        // this helps us traverse the matrix by finding the next largest LCS at the current point
+        else if (c[i][j - 1] > c[i - 1][j]) {
+            j -= 1;
+        }
+        else {
+            i -= 1;
+        }
+    }
+    // the return value we constructed is backwards because we traversed the matrix backwards, so we reverse this
+    return ret.reverse();
+}
+// https://en.wikipedia.org/wiki/Diff
+// Using the LCS from above, we can see what was removed from oldArray as objects not found in the LCS
+// and what was added are objects in newArray not found in LCS
+// key is the object we are comparing with
+// returns an array holding the diffed information the following format:
+// array: [
+//    {
+//        "key": "name",
+//        ...
+//    },
+//    {
+//        "key": "name",
+//        "$added": true,
+//        ...
+//    },
+//    {
+//        "key": "name",
+//        "$removed": true,
+//        ...
+//    },
+//]
+function diffArray(oldArray, newArray, key) {
+    const oldArrayOrEmpty = oldArray ?? [];
+    const newArrayOrEmpty = newArray ?? [];
+    const lcs = longestCommonSubsequence(oldArrayOrEmpty, newArrayOrEmpty, key);
+    let i = 0;
+    let j = 0;
+    const ret = [];
+    const makeRemoval = (item) => {
+        const objectRemoved = {
+            ...item,
+            $removed: true,
+        };
+        ret.push(objectRemoved);
+        ++i;
+    };
+    const makeAddition = (item) => {
+        const objectAdded = {
+            ...item,
+            $added: true,
+        };
+        ret.push(objectAdded);
+        ++j;
+    };
+    // lcs is sorted against both arrays, so we can safely traverse each array
+    // up until we find the common element
+    for (const common of lcs) {
+        // removals, things in old but not in new or common up to our current common
+        while (i < oldArrayOrEmpty.length && common !== oldArrayOrEmpty[i][key]) {
+            makeRemoval(oldArrayOrEmpty[i]);
+        }
+        // additions, things in new but not in common or old up to our current common
+        while (j < newArrayOrEmpty.length && common !== newArrayOrEmpty[j][key]) {
+            makeAddition(newArrayOrEmpty[j]);
+        }
+        // finally add the common element
+        ret.push(oldArrayOrEmpty[i]);
+        ++i;
+        ++j;
+    }
+    // add any remaining removals
+    while (i < oldArrayOrEmpty.length) {
+        makeRemoval(oldArrayOrEmpty[i]);
+    }
+    // add any remaining additions
+    while (j < newArrayOrEmpty.length) {
+        makeAddition(newArrayOrEmpty[j]);
+    }
+    // final array complete
+    return ret;
+}
+//# sourceMappingURL=LongestCommonSubsequence.js.map

package/lib/utilities/LongestCommonSubsequence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LongestCommonSubsequence.js","sourceRoot":"","sources":["../../src/utilities/LongestCommonSubsequence.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAQlC,4DAyCC;AAuBD,8BAuDC;AA3HD,2DAA2D;AAC3D,8EAA8E;AAC9E,+FAA+F;AAC/F,qDAAqD;AACrD,SAAgB,wBAAwB,CAAC,QAAyB,EAAE,QAAyB,EAAE,GAAW;IACtG,+CAA+C;IAC/C,MAAM,CAAC,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAe,CAAC;IACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAa,CAAC;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;IACL,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACxC,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACJ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACjD,CAAC;QACL,CAAC;IACL,CAAC;IAED,kFAAkF;IAClF,wEAAwE;IACxE,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;IACxB,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;IACxB,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACxB,IAAI,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YAChD,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,CAAC,IAAI,CAAC,CAAC;YACP,CAAC,IAAI,CAAC,CAAC;QACX,CAAC;QACD,yFAAyF;aACpF,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,CAAC,IAAI,CAAC,CAAC;QACX,CAAC;aAAM,CAAC;YACJ,CAAC,IAAI,CAAC,CAAC;QACX,CAAC;IACL,CAAC;IAED,6GAA6G;IAC7G,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC;AACzB,CAAC;AAED,qCAAqC;AACrC,sGAAsG;AACtG,8DAA8D;AAC9D,0CAA0C;AAC1C,wEAAwE;AACxE,WAAW;AACX,OAAO;AACP,wBAAwB;AACxB,aAAa;AACb,QAAQ;AACR,OAAO;AACP,wBAAwB;AACxB,yBAAyB;AACzB,aAAa;AACb,QAAQ;AACR,OAAO;AACP,wBAAwB;AACxB,2BAA2B;AAC3B,aAAa;AACb,QAAQ;AACR,GAAG;AACH,SAAgB,SAAS,CAAC,QAAqC,EAAE,QAAqC,EAAE,GAAW;IAC/G,MAAM,eAAe,GAAoB,QAAQ,IAAI,EAAE,CAAC;IACxD,MAAM,eAAe,GAAoB,QAAQ,IAAI,EAAE,CAAC;IACxD,MAAM,GAAG,GAAG,wBAAwB,CAAC,eAAe,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;IAC5E,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,MAAM,GAAG,GAAoB,EAAE,CAAC;IAEhC,MAAM,WAAW,GAAG,CAAC,IAAmB,EAAE,EAAE;QACxC,MAAM,aAAa,GAAG;YAClB,GAAG,IAAI;YACP,QAAQ,EAAE,IAAI;SACjB,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxB,EAAE,CAAC,CAAC;IACR,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,CAAC,IAAmB,EAAE,EAAE;QACzC,MAAM,WAAW,GAAG;YAChB,GAAG,IAAI;YACP,MAAM,EAAE,IAAI;SACf,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtB,EAAE,CAAC,CAAC;IACR,CAAC,CAAC;IAEF,0EAA0E;IAC1E,sCAAsC;IACtC,KAAK,MAAM,MAAM,IAAI,GAAG,EAAE,CAAC;QACvB,4EAA4E;QAC5E,OAAO,CAAC,GAAG,eAAe,CAAC,MAAM,IAAI,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACpC,CAAC;QAED,6EAA6E;QAC7E,OAAO,CAAC,GAAG,eAAe,CAAC,MAAM,IAAI,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;QAED,iCAAiC;QACjC,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,EAAE,CAAC,CAAC;QACJ,EAAE,CAAC,CAAC;IACR,CAAC;IAED,6BAA6B;IAC7B,OAAO,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;QAChC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,CAAC;IACD,8BAA8B;IAC9B,OAAO,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;QAChC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IAED,uBAAuB;IACvB,OAAO,GAAG,CAAC;AACf,CAAC"}

package/lib/utilities/MergeArrays.d.ts

@@ -0,0 +1 @@
+export declare function mergeOptionalArrays<T>(parent: T[] | undefined | null, merge: T[] | undefined | null): T[] | undefined;

package/lib/utilities/MergeArrays.js

@@ -0,0 +1,15 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeOptionalArrays = mergeOptionalArrays;
+function mergeOptionalArrays(parent, merge) {
+    if (parent && merge) {
+        return [...parent, ...merge];
+    }
+    if (parent) {
+        return parent;
+    }
+    return merge;
+}
+//# sourceMappingURL=MergeArrays.js.map

package/lib/utilities/MergeArrays.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MergeArrays.js","sourceRoot":"","sources":["../../src/utilities/MergeArrays.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,kDAUC;AAVD,SAAgB,mBAAmB,CAAI,MAA8B,EAAE,KAA6B;IAChG,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;QAClB,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,MAAM,EAAE,CAAC;QACT,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/lib/utilities/RemoveProperty.d.ts

@@ -0,0 +1 @@
+export declare function removePropertyRecursive(value: Record<string, unknown>, propertyName: string): void;

package/lib/utilities/RemoveProperty.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePropertyRecursive = removePropertyRecursive;
+function removePropertyRecursive(value, propertyName) {
+    for (const prop in value) {
+        if (prop === propertyName) {
+            delete value[prop];
+        }
+        else if (typeof value[prop] === 'object') {
+            removePropertyRecursive(value[prop], propertyName);
+        }
+    }
+}
+//# sourceMappingURL=RemoveProperty.js.map

package/lib/utilities/RemoveProperty.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemoveProperty.js","sourceRoot":"","sources":["../../src/utilities/RemoveProperty.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,0DAQC;AARD,SAAgB,uBAAuB,CAAC,KAA8B,EAAE,YAAoB;IACxF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzC,uBAAuB,CAAC,KAAK,CAAC,IAAI,CAA4B,EAAE,YAAY,CAAC,CAAC;QAClF,CAAC;IACL,CAAC;AACL,CAAC"}

package/lib/utilities/ScanObject.d.ts

@@ -0,0 +1,13 @@
+import { KeyToParentTypeMapping, KeyToTypeMapping } from '../modules/KeyToTypeMapping';
+export declare function scanObjectForMemberArray(object: Record<string, unknown>, callback: (parentObject: Record<string, Array<unknown>>, propertyName: string) => void): void;
+/**
+ * Scan for all objects with a property with the specified name.
+ *
+ * If KeyType exists as a key of KeyToTypeMapping, the parent object is a Record with a key of the mapped type,
+ * If KeyType also exists as a key of KeyToParentTypeMapping, the parent object is the type defined in that mapping
+ * Otherwise if the KeyType is not a key of either mapping, the parent object is a dictionary with unknown keys
+ */
+export declare function scanObjectForMemberWithName<KeyType extends string, ParentType = KeyType extends keyof KeyToTypeMapping ? KeyType extends keyof KeyToParentTypeMapping ? KeyToParentTypeMapping[KeyType] : Record<KeyType, KeyToTypeMapping[KeyType]> : Record<string, unknown>>(object: Record<string, unknown>, memberName: KeyType, callback: (parentObject: ParentType) => void): void;
+export declare function scanObjectForMembersWithNamesNoChangelog<KeyType1 extends keyof KeyToTypeMapping, KeyType2 extends keyof KeyToTypeMapping, ParentType = Pick<KeyToTypeMapping, KeyType1 | KeyType2>>(object: Record<string, unknown>, memberName1: KeyType1, memberName2: KeyType2, callback: (parentObject: ParentType) => void): void;
+export declare function scanObjectForMembersWithNames<KeyType1 extends keyof KeyToTypeMapping, KeyType2 extends keyof KeyToTypeMapping, ParentType = Pick<KeyToTypeMapping, KeyType1 | KeyType2>>(object: Record<string, unknown>, memberName1: KeyType1, memberName2: KeyType2, callback: (parentObject: ParentType) => void): void;
+export declare function scanObjectForMemberWithAnyNamesFromList(object: Record<string, unknown>, memberNames: string[], callback: (parentObject: Record<string, unknown>, propertyName: string) => void): void;