soliddoc 0.6.0-beta.36

package/dist/utils/assert-equal-types.d.ts

@@ -0,0 +1,2 @@
+export type AssertEqual<T, U> = [T, U] extends [U, T] ? true : never;
+//# sourceMappingURL=assert-equal-types.d.ts.map

package/dist/utils/assert-equal-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-equal-types.d.ts","sourceRoot":"","sources":["../../src/utils/assert-equal-types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC"}

package/dist/utils/assert-equal-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=assert-equal-types.js.map

package/dist/utils/assert-equal-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert-equal-types.js","sourceRoot":"","sources":["../../src/utils/assert-equal-types.ts"],"names":[],"mappings":""}

package/dist/utils/clone.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Deep cloning good enough for simple objects like solc output. Types are not
+ * sound because the function may lose information: non-enumerable properties,
+ * symbols, undefined values, prototypes, etc.
+ */
+export declare const clone: <T>(obj: T) => T;
+//# sourceMappingURL=clone.d.ts.map

package/dist/utils/clone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.d.ts","sourceRoot":"","sources":["../../src/utils/clone.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,KAAK,kBAAoD,CAAC"}

package/dist/utils/clone.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clone = void 0;
+/**
+ * Deep cloning good enough for simple objects like solc output. Types are not
+ * sound because the function may lose information: non-enumerable properties,
+ * symbols, undefined values, prototypes, etc.
+ */
+const clone = (obj) => JSON.parse(JSON.stringify(obj));
+exports.clone = clone;
+//# sourceMappingURL=clone.js.map

package/dist/utils/clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clone.js","sourceRoot":"","sources":["../../src/utils/clone.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,KAAK,GAAG,CAAI,GAAM,EAAK,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;AAA1D,QAAA,KAAK,SAAqD"}

package/dist/utils/ensure-array.d.ts

@@ -0,0 +1,4 @@
+type IfArray<T> = T extends any[] ? T : never;
+export declare function ensureArray<T>(x: T | T[]): T[] | IfArray<T>;
+export {};
+//# sourceMappingURL=ensure-array.d.ts.map

package/dist/utils/ensure-array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure-array.d.ts","sourceRoot":"","sources":["../../src/utils/ensure-array.ts"],"names":[],"mappings":"AAGA,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,EAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE9C,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAM3D"}

package/dist/utils/ensure-array.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureArray = void 0;
+function ensureArray(x) {
+    if (Array.isArray(x)) {
+        return x;
+    }
+    else {
+        return [x];
+    }
+}
+exports.ensureArray = ensureArray;
+//# sourceMappingURL=ensure-array.js.map

package/dist/utils/ensure-array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure-array.js","sourceRoot":"","sources":["../../src/utils/ensure-array.ts"],"names":[],"mappings":";;;AAKA,SAAgB,WAAW,CAAI,CAAU;IACvC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACpB,OAAO,CAAC,CAAC;KACV;SAAM;QACL,OAAO,CAAC,CAAC,CAAC,CAAC;KACZ;AACH,CAAC;AAND,kCAMC"}

package/dist/utils/execall.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Iterates over all contiguous matches of the regular expression over the
+ * text. Stops as soon as the regular expression no longer matches at the
+ * current position.
+ */
+export declare function execAll(re: RegExp, text: string): Generator<RegExpExecArray, void, unknown>;
+//# sourceMappingURL=execall.d.ts.map

package/dist/utils/execall.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execall.d.ts","sourceRoot":"","sources":["../../src/utils/execall.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAiB,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,6CAYhD"}

package/dist/utils/execall.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execAll = void 0;
+/**
+ * Iterates over all contiguous matches of the regular expression over the
+ * text. Stops as soon as the regular expression no longer matches at the
+ * current position.
+ */
+function* execAll(re, text) {
+    re = new RegExp(re, re.flags + (re.sticky ? '' : 'y'));
+    while (true) {
+        const match = re.exec(text);
+        // We break out of the loop if there is no match or if the empty string is
+        // matched because no progress will be made and it will loop indefinitely.
+        if (!match?.[0])
+            break;
+        yield match;
+    }
+}
+exports.execAll = execAll;
+//# sourceMappingURL=execall.js.map

package/dist/utils/execall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execall.js","sourceRoot":"","sources":["../../src/utils/execall.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,QAAe,CAAC,CAAC,OAAO,CAAC,EAAU,EAAE,IAAY;IAC/C,EAAE,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAEvD,OAAO,IAAI,EAAE;QACX,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5B,0EAA0E;QAC1E,0EAA0E;QAC1E,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAAE,MAAM;QAEvB,MAAM,KAAK,CAAC;KACb;AACH,CAAC;AAZD,0BAYC"}

package/dist/utils/fs-exists.d.ts

@@ -0,0 +1,4 @@
+export declare function exists(path: string, mode?: number): Promise<boolean>;
+export declare function findExists(...paths: string[]): Promise<string | undefined>;
+export declare function findIn(f: string, dirs: string[]): Promise<string | undefined>;
+//# sourceMappingURL=fs-exists.d.ts.map

package/dist/utils/fs-exists.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs-exists.d.ts","sourceRoot":"","sources":["../../src/utils/fs-exists.ts"],"names":[],"mappings":"AAGA,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,MAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAO1F;AAED,wBAAsB,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAMhF;AAED,wBAAsB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAEnF"}

package/dist/utils/fs-exists.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findIn = exports.findExists = exports.exists = void 0;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+async function exists(path, mode = fs_1.constants.R_OK) {
+    try {
+        await fs_1.promises.access(path, mode);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.exists = exists;
+async function findExists(...paths) {
+    for (const p of paths) {
+        if (await exists(p)) {
+            return p;
+        }
+    }
+}
+exports.findExists = findExists;
+async function findIn(f, dirs) {
+    return findExists(...dirs.map(d => path_1.default.resolve(d, f)));
+}
+exports.findIn = findIn;
+//# sourceMappingURL=fs-exists.js.map

package/dist/utils/fs-exists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs-exists.js","sourceRoot":"","sources":["../../src/utils/fs-exists.ts"],"names":[],"mappings":";;;;;;AAAA,2BAA+C;AAC/C,gDAAwB;AAEjB,KAAK,UAAU,MAAM,CAAC,IAAY,EAAE,OAAe,cAAS,CAAC,IAAI;IACtE,IAAI;QACF,MAAM,aAAE,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,wBAOC;AAEM,KAAK,UAAU,UAAU,CAAC,GAAG,KAAe;IACjD,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;QACrB,IAAI,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE;YACnB,OAAO,CAAC,CAAC;SACV;KACF;AACH,CAAC;AAND,gCAMC;AAEM,KAAK,UAAU,MAAM,CAAC,CAAS,EAAE,IAAc;IACpD,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,cAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAFD,wBAEC"}

package/dist/utils/is-child.d.ts

@@ -0,0 +1,2 @@
+export declare function isChild(file: string, parent: string): boolean;
+//# sourceMappingURL=is-child.d.ts.map

package/dist/utils/is-child.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-child.d.ts","sourceRoot":"","sources":["../../src/utils/is-child.ts"],"names":[],"mappings":"AAEA,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAEnD"}

package/dist/utils/is-child.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isChild = void 0;
+const path_1 = __importDefault(require("path"));
+function isChild(file, parent) {
+    return path_1.default.normalize(file + path_1.default.sep).startsWith(path_1.default.normalize(parent + path_1.default.sep));
+}
+exports.isChild = isChild;
+//# sourceMappingURL=is-child.js.map

package/dist/utils/is-child.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-child.js","sourceRoot":"","sources":["../../src/utils/is-child.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAExB,SAAgB,OAAO,CAAC,IAAY,EAAE,MAAc;IAClD,OAAO,cAAI,CAAC,SAAS,CAAC,IAAI,GAAG,cAAI,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,cAAI,CAAC,SAAS,CAAC,MAAM,GAAG,cAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACvF,CAAC;AAFD,0BAEC"}

package/dist/utils/item-type.d.ts

@@ -0,0 +1,3 @@
+import { DocItem } from '../doc-item';
+export declare function itemType(item: DocItem): string;
+//# sourceMappingURL=item-type.d.ts.map

package/dist/utils/item-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-type.d.ts","sourceRoot":"","sources":["../../src/utils/item-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAI9C"}

package/dist/utils/item-type.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.itemType = void 0;
+function itemType(item) {
+    return item.nodeType
+        .replace(/(Definition|Declaration)$/, '')
+        .replace(/(\w)([A-Z])/g, '$1 $2');
+}
+exports.itemType = itemType;
+//# sourceMappingURL=item-type.js.map

package/dist/utils/item-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"item-type.js","sourceRoot":"","sources":["../../src/utils/item-type.ts"],"names":[],"mappings":";;;AAEA,SAAgB,QAAQ,CAAC,IAAa;IACpC,OAAO,IAAI,CAAC,QAAQ;SACjB,OAAO,CAAC,2BAA2B,EAAE,EAAE,CAAC;SACxC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AAJD,4BAIC"}

package/dist/utils/map-keys.d.ts

@@ -0,0 +1,2 @@
+export declare function mapKeys<T>(obj: Record<string, T>, fn: (key: string) => string): Record<string, T>;
+//# sourceMappingURL=map-keys.d.ts.map

package/dist/utils/map-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-keys.d.ts","sourceRoot":"","sources":["../../src/utils/map-keys.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAEjG"}

package/dist/utils/map-keys.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapKeys = void 0;
+function mapKeys(obj, fn) {
+    return Object.fromEntries(Object.entries(obj).map(([k, v]) => [fn(k), v]));
+}
+exports.mapKeys = mapKeys;
+//# sourceMappingURL=map-keys.js.map

package/dist/utils/map-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-keys.js","sourceRoot":"","sources":["../../src/utils/map-keys.ts"],"names":[],"mappings":";;;AAAA,SAAgB,OAAO,CAAI,GAAsB,EAAE,EAA2B;IAC5E,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAFD,0BAEC"}

package/dist/utils/map-values.d.ts

@@ -0,0 +1,4 @@
+export declare function mapValues<T, U>(obj: Record<string, T>, fn: (value: T) => U): Record<string, U>;
+export declare function filterValues<T, U extends T>(obj: Record<string, T>, fn: (value: T) => value is U): Record<string, U>;
+export declare function filterValues<T>(obj: Record<string, T>, fn: (value: T) => boolean): Record<string, T>;
+//# sourceMappingURL=map-values.d.ts.map

package/dist/utils/map-values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-values.d.ts","sourceRoot":"","sources":["../../src/utils/map-values.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAM9F;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AACtH,wBAAgB,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC"}

package/dist/utils/map-values.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterValues = exports.mapValues = void 0;
+function mapValues(obj, fn) {
+    const res = {};
+    for (const [k, v] of Object.entries(obj)) {
+        res[k] = fn(v);
+    }
+    return res;
+}
+exports.mapValues = mapValues;
+function filterValues(obj, fn) {
+    const res = {};
+    for (const [k, v] of Object.entries(obj)) {
+        if (fn(v)) {
+            res[k] = v;
+        }
+    }
+    return res;
+}
+exports.filterValues = filterValues;
+//# sourceMappingURL=map-values.js.map

package/dist/utils/map-values.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-values.js","sourceRoot":"","sources":["../../src/utils/map-values.ts"],"names":[],"mappings":";;;AAAA,SAAgB,SAAS,CAAO,GAAsB,EAAE,EAAmB;IACzE,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACxC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;KAChB;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAND,8BAMC;AAID,SAAgB,YAAY,CAAI,GAAsB,EAAE,EAAyB;IAC/E,MAAM,GAAG,GAAsB,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACxC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;YACT,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACZ;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AARD,oCAQC"}

package/dist/utils/memoized-getter.d.ts

@@ -0,0 +1,4 @@
+export declare function defineGetterMemoized<K extends keyof any, T, O extends {
+    [k in K]?: T;
+}>(obj: O, key: K, getter: () => T): void;
+//# sourceMappingURL=memoized-getter.d.ts.map

package/dist/utils/memoized-getter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoized-getter.d.ts","sourceRoot":"","sources":["../../src/utils/memoized-getter.ts"],"names":[],"mappings":"AAAA,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,EAAE,CAAC,EAAE,CAAC,SAAS;KAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;CAAE,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,QAsBvH"}

package/dist/utils/memoized-getter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineGetterMemoized = void 0;
+function defineGetterMemoized(obj, key, getter) {
+    let state = 'todo';
+    let value;
+    Object.defineProperty(obj, key, {
+        enumerable: true,
+        get() {
+            switch (state) {
+                case 'done':
+                    return value;
+                case 'doing':
+                    throw new Error("Detected recursion");
+                case 'todo':
+                    state = 'doing';
+                    value = getter();
+                    state = 'done';
+                    return value;
+            }
+        }
+    });
+}
+exports.defineGetterMemoized = defineGetterMemoized;
+//# sourceMappingURL=memoized-getter.js.map

package/dist/utils/memoized-getter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoized-getter.js","sourceRoot":"","sources":["../../src/utils/memoized-getter.ts"],"names":[],"mappings":";;;AAAA,SAAgB,oBAAoB,CAAqD,GAAM,EAAE,GAAM,EAAE,MAAe;IACtH,IAAI,KAAK,GAA8B,MAAM,CAAC;IAC9C,IAAI,KAAQ,CAAC;IAEb,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;QAC9B,UAAU,EAAE,IAAI;QAChB,GAAG;YACD,QAAQ,KAAK,EAAE;gBACb,KAAK,MAAM;oBACT,OAAO,KAAK,CAAC;gBAEf,KAAK,OAAO;oBACV,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBAExC,KAAK,MAAM;oBACT,KAAK,GAAG,OAAO,CAAC;oBAChB,KAAK,GAAG,MAAM,EAAE,CAAC;oBACjB,KAAK,GAAG,MAAM,CAAC;oBACf,OAAO,KAAK,CAAC;aAChB;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAtBD,oDAsBC"}

package/dist/utils/natspec.d.ts

@@ -0,0 +1,19 @@
+import { DocItemWithContext } from '../site';
+export interface NatSpec {
+    title?: string;
+    notice?: string;
+    dev?: string;
+    params?: {
+        name: string;
+        description: string;
+    }[];
+    returns?: {
+        name?: string;
+        description: string;
+    }[];
+    custom?: {
+        [tag: string]: string;
+    };
+}
+export declare function parseNatspec(item: DocItemWithContext): NatSpec;
+//# sourceMappingURL=natspec.d.ts.map

package/dist/utils/natspec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"natspec.d.ts","sourceRoot":"","sources":["../../src/utils/natspec.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAoB,MAAM,SAAS,CAAC;AAQ/D,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;IACJ,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;KACrB,EAAE,CAAC;IACJ,MAAM,CAAC,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAsG9D"}

package/dist/utils/natspec.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseNatspec = void 0;
+const utils_1 = require("solidity-ast/utils");
+const site_1 = require("../site");
+const arrays_equal_1 = require("./arrays-equal");
+const execall_1 = require("./execall");
+const item_type_1 = require("./item-type");
+const ItemError_1 = require("./ItemError");
+const read_item_docs_1 = require("./read-item-docs");
+const scope_1 = require("./scope");
+function parseNatspec(item) {
+    var _a;
+    if (!item[site_1.DOC_ITEM_CONTEXT])
+        throw new Error(`Not an item or item is missing context`);
+    let res = {};
+    const docSource = (0, read_item_docs_1.readItemDocs)(item);
+    const docString = docSource !== undefined
+        ? cleanUpDocstringFromSource(docSource)
+        : 'documentation' in item && item.documentation
+            ? typeof item.documentation === 'string'
+                ? item.documentation
+                : cleanUpDocstringFromSolc(item.documentation.text)
+            : '';
+    const tagMatches = (0, execall_1.execAll)(/^(?:@(\w+|custom:[a-z][a-z-]*) )?((?:(?!^@(?:\w+|custom:[a-z][a-z-]*) )[^])*)/m, docString);
+    let inheritFrom;
+    for (const [, tag = 'notice', content] of tagMatches) {
+        if (content === undefined)
+            throw new ItemError_1.ItemError('Unexpected error', item);
+        if (tag === 'dev' || tag === 'notice') {
+            res[tag] ?? (res[tag] = '');
+            res[tag] += content;
+        }
+        if (tag === 'title') {
+            res.title = content.trim();
+        }
+        if (tag === 'param') {
+            const paramMatches = content.match(/(\w+) ([^]*)/);
+            if (paramMatches) {
+                const [, name, description] = paramMatches;
+                res.params ?? (res.params = []);
+                res.params.push({ name, description: description.trim() });
+            }
+        }
+        if (tag === 'return') {
+            if (!('returnParameters' in item)) {
+                throw new ItemError_1.ItemError(`Item does not contain return parameters`, item);
+            }
+            res.returns ?? (res.returns = []);
+            const i = res.returns.length;
+            const p = item.returnParameters.parameters[i];
+            if (p === undefined) {
+                throw new ItemError_1.ItemError('Got more @return tags than expected', item);
+            }
+            if (!p.name) {
+                res.returns.push({ description: content.trim() });
+            }
+            else {
+                const paramMatches = content.match(/(\w+)( ([^]*))?/);
+                if (!paramMatches || paramMatches[1] !== p.name) {
+                    throw new ItemError_1.ItemError(`Expected @return tag to start with name '${p.name}'`, item);
+                }
+                const [, name, description] = paramMatches;
+                res.returns.push({ name, description: description?.trim() ?? '' });
+            }
+        }
+        if (tag?.startsWith('custom:')) {
+            const key = tag.replace(/^custom:/, '');
+            res.custom ?? (res.custom = {});
+            (_a = res.custom)[key] ?? (_a[key] = '');
+            res.custom[key] += content;
+        }
+        if (tag === 'inheritdoc') {
+            if (!(item.nodeType === 'FunctionDefinition' || item.nodeType === 'VariableDeclaration')) {
+                throw new ItemError_1.ItemError(`Expected function or variable but saw ${(0, item_type_1.itemType)(item)}`, item);
+            }
+            const parentContractName = content.trim();
+            const parentContract = (0, scope_1.getContractsInScope)(item)[parentContractName];
+            if (!parentContract) {
+                throw new ItemError_1.ItemError(`Parent contract '${parentContractName}' not found`, item);
+            }
+            inheritFrom = [...(0, utils_1.findAll)('FunctionDefinition', parentContract)].find(f => item.baseFunctions?.includes(f.id));
+        }
+    }
+    if (docString.length === 0) {
+        if ('baseFunctions' in item && item.baseFunctions?.length === 1) {
+            const baseFn = item[site_1.DOC_ITEM_CONTEXT].build.deref('FunctionDefinition', item.baseFunctions[0]);
+            const shouldInherit = item.nodeType === 'VariableDeclaration' || (0, arrays_equal_1.arraysEqual)(item.parameters.parameters, baseFn.parameters.parameters, p => p.name);
+            if (shouldInherit) {
+                inheritFrom = baseFn;
+            }
+        }
+    }
+    if (res.dev)
+        res.dev = res.dev.trim();
+    if (res.notice)
+        res.notice = res.notice.trim();
+    if (inheritFrom) {
+        res = { ...parseNatspec(inheritFrom), ...res };
+    }
+    return res;
+}
+exports.parseNatspec = parseNatspec;
+// Fix solc buggy parsing of doc comments.
+// Reverse engineered from solc behavior.
+function cleanUpDocstringFromSolc(text) {
+    return text
+        .replace(/\n\n?^[ \t]*(?:\*|\/\/\/)/mg, '\n\n')
+        .replace(/^[ \t]?/mg, '');
+}
+function cleanUpDocstringFromSource(text) {
+    return text
+        .replace(/^\/\*\*(.*)\*\/$/s, '$1')
+        .trim()
+        .replace(/^[ \t]*(\*|\/\/\/)[ \t]?/mg, '');
+}
+//# sourceMappingURL=natspec.js.map

package/dist/utils/natspec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"natspec.js","sourceRoot":"","sources":["../../src/utils/natspec.ts"],"names":[],"mappings":";;;AACA,8CAA6C;AAC7C,kCAA+D;AAC/D,iDAA6C;AAC7C,uCAAoC;AACpC,2CAAuC;AACvC,2CAAwC;AACxC,qDAAgD;AAChD,mCAA8C;AAmB9C,SAAgB,YAAY,CAAC,IAAwB;;IACnD,IAAI,CAAC,IAAI,CAAC,uBAAgB,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAEvF,IAAI,GAAG,GAAY,EAAE,CAAC;IAEtB,MAAM,SAAS,GAAG,IAAA,6BAAY,EAAC,IAAI,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,SAAS,KAAK,SAAS;QACvC,CAAC,CAAC,0BAA0B,CAAC,SAAS,CAAC;QACvC,CAAC,CAAC,eAAe,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa;YAC/C,CAAC,CAAC,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ;gBACxC,CAAC,CAAC,IAAI,CAAC,aAAa;gBACpB,CAAC,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YACnD,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,UAAU,GAAG,IAAA,iBAAO,EACxB,gFAAgF,EAChF,SAAS,CACV,CAAC;IAEF,IAAI,WAA2C,CAAC;IAEhD,KAAK,MAAM,CAAC,EAAE,GAAG,GAAG,QAAQ,EAAE,OAAO,CAAC,IAAI,UAAU,EAAE;QACpD,IAAI,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,qBAAS,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QAEzE,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,QAAQ,EAAE;YACrC,GAAG,CAAC,GAAG,MAAP,GAAG,CAAC,GAAG,IAAM,EAAE,EAAC;YAChB,GAAG,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC;SACrB;QAED,IAAI,GAAG,KAAK,OAAO,EAAE;YACnB,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;SAC5B;QAED,IAAI,GAAG,KAAK,OAAO,EAAE;YACnB,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACnD,IAAI,YAAY,EAAE;gBAChB,MAAM,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,YAAwC,CAAC;gBACvE,GAAG,CAAC,MAAM,KAAV,GAAG,CAAC,MAAM,GAAK,EAAE,EAAC;gBAClB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC5D;SACF;QAED,IAAI,GAAG,KAAK,QAAQ,EAAE;YACpB,IAAI,CAAC,CAAC,kBAAkB,IAAI,IAAI,CAAC,EAAE;gBACjC,MAAM,IAAI,qBAAS,CAAC,yCAAyC,EAAE,IAAI,CAAC,CAAC;aACtE;YACD,GAAG,CAAC,OAAO,KAAX,GAAG,CAAC,OAAO,GAAK,EAAE,EAAC;YACnB,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;YAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,SAAS,EAAE;gBACnB,MAAM,IAAI,qBAAS,CAAC,qCAAqC,EAAE,IAAI,CAAC,CAAC;aAClE;YACD,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE;gBACX,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aACnD;iBAAM;gBACL,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;gBACtD,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE;oBAC/C,MAAM,IAAI,qBAAS,CAAC,4CAA4C,CAAC,CAAC,IAAI,GAAG,EAAE,IAAI,CAAC,CAAC;iBAClF;gBACD,MAAM,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,YAAyC,CAAC;gBACxE,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;aACpE;SACF;QAED,IAAI,GAAG,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE;YAC9B,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACxC,GAAG,CAAC,MAAM,KAAV,GAAG,CAAC,MAAM,GAAK,EAAE,EAAC;YAClB,MAAA,GAAG,CAAC,MAAM,EAAC,GAAG,SAAH,GAAG,IAAM,EAAE,EAAC;YACvB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC;SAC5B;QAED,IAAI,GAAG,KAAK,YAAY,EAAE;YACxB,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,KAAK,oBAAoB,IAAI,IAAI,CAAC,QAAQ,KAAK,qBAAqB,CAAC,EAAE;gBACxF,MAAM,IAAI,qBAAS,CAAC,yCAAyC,IAAA,oBAAQ,EAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;aACtF;YACD,MAAM,kBAAkB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;YAC1C,MAAM,cAAc,GAAG,IAAA,2BAAmB,EAAC,IAAI,CAAC,CAAC,kBAAkB,CAAC,CAAC;YACrE,IAAI,CAAC,cAAc,EAAE;gBACnB,MAAM,IAAI,qBAAS,CAAC,oBAAoB,kBAAkB,aAAa,EAAE,IAAI,CAAC,CAAC;aAChF;YACD,WAAW,GAAG,CAAC,GAAG,IAAA,eAAO,EAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAChH;KACF;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,IAAI,eAAe,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,MAAM,KAAK,CAAC,EAAE;YAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,uBAAgB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAE,CAAC,CAAC;YAChG,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,KAAK,qBAAqB,IAAI,IAAA,0BAAW,EAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACpJ,IAAI,aAAa,EAAE;gBACjB,WAAW,GAAG,MAAM,CAAC;aACtB;SACF;KACF;IAED,IAAI,GAAG,CAAC,GAAG;QAAE,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IACtC,IAAI,GAAG,CAAC,MAAM;QAAE,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAE/C,IAAI,WAAW,EAAE;QACf,GAAG,GAAG,EAAE,GAAG,YAAY,CAAC,WAAiC,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC;KACtE;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAtGD,oCAsGC;AAED,0CAA0C;AAC1C,yCAAyC;AACzC,SAAS,wBAAwB,CAAC,IAAY;IAC5C,OAAO,IAAI;SACR,OAAO,CAAC,6BAA6B,EAAE,MAAM,CAAC;SAC9C,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAY;IAC9C,OAAO,IAAI;SACR,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC;SAClC,IAAI,EAAE;SACN,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;AAC/C,CAAC"}

package/dist/utils/read-item-docs.d.ts

@@ -0,0 +1,3 @@
+import { DocItemWithContext } from '../site';
+export declare function readItemDocs(item: DocItemWithContext): string | undefined;
+//# sourceMappingURL=read-item-docs.d.ts.map

package/dist/utils/read-item-docs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-item-docs.d.ts","sourceRoot":"","sources":["../../src/utils/read-item-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA2B,MAAM,SAAS,CAAC;AAEtE,wBAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,MAAM,GAAG,SAAS,CAWzE"}

package/dist/utils/read-item-docs.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readItemDocs = void 0;
+const site_1 = require("../site");
+function readItemDocs(item) {
+    const { build } = item[site_1.DOC_ITEM_CONTEXT];
+    // Note that Solidity 0.5 has item.documentation: string even though the
+    // types do not reflect that. This is why we check typeof === object.
+    if ('documentation' in item && item.documentation && typeof item.documentation === 'object') {
+        const { source, start, length } = decodeSrc(item.documentation.src, build);
+        const content = build.input.sources[source]?.content;
+        if (content !== undefined) {
+            return Buffer.from(content, 'utf8').slice(start, start + length).toString('utf8');
+        }
+    }
+}
+exports.readItemDocs = readItemDocs;
+function decodeSrc(src, build) {
+    const [start, length, sourceId] = src.split(':').map(s => parseInt(s));
+    if (start === undefined || length === undefined || sourceId === undefined) {
+        throw new Error(`Bad source string ${src}`);
+    }
+    const source = Object.keys(build.output.sources).find(s => build.output.sources[s]?.id === sourceId);
+    if (source === undefined) {
+        throw new Error(`No source with id ${sourceId}`);
+    }
+    return { source, start, length };
+}
+//# sourceMappingURL=read-item-docs.js.map

package/dist/utils/read-item-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-item-docs.js","sourceRoot":"","sources":["../../src/utils/read-item-docs.ts"],"names":[],"mappings":";;;AAAA,kCAAsE;AAEtE,SAAgB,YAAY,CAAC,IAAwB;IACnD,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,uBAAgB,CAAC,CAAC;IACzC,wEAAwE;IACxE,qEAAqE;IACrE,IAAI,eAAe,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,IAAI,OAAO,IAAI,CAAC,aAAa,KAAK,QAAQ,EAAE;QAC3F,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC3E,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QACrD,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACnF;KACF;AACH,CAAC;AAXD,oCAWC;AAED,SAAS,SAAS,CAAC,GAAW,EAAE,KAAY;IAC1C,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,IAAI,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE;QACzE,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC;KAC7C;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,KAAK,QAAQ,CAAC,CAAC;IACrG,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAC;KAClD;IACD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AACnC,CAAC"}

package/dist/utils/scope.d.ts

@@ -0,0 +1,6 @@
+import { ContractDefinition } from "solidity-ast";
+import { DocItemWithContext } from "../site";
+export declare function getContractsInScope(item: DocItemWithContext): Record<string, ContractDefinition & {
+    name: string;
+}>;
+//# sourceMappingURL=scope.d.ts.map

package/dist/utils/scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../../src/utils/scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAc,MAAM,cAAc,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAO7C,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,kBAAkB;;GAwC3D"}

package/dist/utils/scope.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getContractsInScope = void 0;
+const utils_1 = require("solidity-ast/utils");
+const map_values_1 = require("./map-values");
+const map_keys_1 = require("./map-keys");
+function getContractsInScope(item) {
+    const cache = new WeakMap();
+    return (0, map_values_1.filterValues)(flattenScope(run(item.__item_context.file)), (0, utils_1.isNodeType)('ContractDefinition'));
+    function run(file) {
+        if (cache.has(file)) {
+            return cache.get(file);
+        }
+        const scope = {};
+        cache.set(file, scope);
+        for (const c of file.nodes) {
+            if ('name' in c) {
+                scope[c.name] = () => ({ definition: c });
+            }
+        }
+        for (const i of (0, utils_1.findAll)('ImportDirective', file)) {
+            const importedFile = item.__item_context.build.deref('SourceUnit', i.sourceUnit);
+            const importedScope = run(importedFile);
+            if (i.unitAlias) {
+                scope[i.unitAlias] = () => ({ namespace: importedScope });
+            }
+            else if (i.symbolAliases.length === 0) {
+                Object.assign(scope, importedScope);
+            }
+            else {
+                for (const a of i.symbolAliases) {
+                    // Delayed function call supports circular dependencies
+                    scope[a.local ?? a.foreign.name] = importedScope[a.foreign.name] ?? (() => importedScope[a.foreign.name]());
+                }
+            }
+        }
+        ;
+        return scope;
+    }
+}
+exports.getContractsInScope = getContractsInScope;
+function flattenScope(scope) {
+    return Object.fromEntries(Object.entries(scope).flatMap(([k, fn]) => {
+        const v = fn();
+        if ('definition' in v) {
+            return [[k, v.definition]];
+        }
+        else {
+            return Object.entries((0, map_keys_1.mapKeys)(flattenScope(v.namespace), k2 => k + '.' + k2));
+        }
+    }));
+}
+//# sourceMappingURL=scope.js.map

package/dist/utils/scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.js","sourceRoot":"","sources":["../../src/utils/scope.ts"],"names":[],"mappings":";;;AACA,8CAAyD;AAEzD,6CAAuD;AACvD,yCAAqC;AAKrC,SAAgB,mBAAmB,CAAC,IAAwB;IAC1D,MAAM,KAAK,GAAG,IAAI,OAAO,EAAqB,CAAC;IAE/C,OAAO,IAAA,yBAAY,EACjB,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAC3C,IAAA,kBAAU,EAAC,oBAAoB,CAAC,CACjC,CAAC;IAEF,SAAS,GAAG,CAAC,IAAgB;QAC3B,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACnB,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC;SACzB;QAED,MAAM,KAAK,GAAU,EAAE,CAAC;QAExB,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAEvB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE;YAC1B,IAAI,MAAM,IAAI,CAAC,EAAE;gBACf,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC;aAC3C;SACF;QAED,KAAK,MAAM,CAAC,IAAI,IAAA,eAAO,EAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE;YAChD,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;YACjF,MAAM,aAAa,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;YACxC,IAAI,CAAC,CAAC,SAAS,EAAE;gBACf,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAC;aAC3D;iBAAM,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;aACrC;iBAAM;gBACL,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE;oBAC/B,uDAAuD;oBACvD,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAE,EAAE,CAAC,CAAC;iBAC9G;aACF;SACF;QAAA,CAAC;QAEF,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAxCD,kDAwCC;AAED,SAAS,YAAY,CAAC,KAAY;IAChC,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE;QACxC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC;QACf,IAAI,YAAY,IAAI,CAAC,EAAE;YACrB,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAU,CAAC,CAAC;SACrC;aAAM;YACL,OAAO,MAAM,CAAC,OAAO,CAAC,IAAA,kBAAO,EAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC;SAC/E;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC"}

package/dist/utils/test.d.ts

@@ -0,0 +1,8 @@
+import { TestFn } from 'ava';
+import { BuildInfo } from 'hardhat/types';
+interface Context {
+    build: BuildInfo[];
+}
+declare const test: TestFn<Context>;
+export default test;
+//# sourceMappingURL=test.d.ts.map

package/dist/utils/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../src/utils/test.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C,UAAU,OAAO;IACf,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,QAAA,MAAM,IAAI,iBAA2B,CAAC;AAQtC,eAAe,IAAI,CAAC"}

package/dist/utils/test.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const hardhat_1 = __importDefault(require("hardhat"));
+const fs_1 = require("fs");
+const test = ava_1.default;
+test.before('reading build info', async (t) => {
+    t.context.build = await Promise.all((await hardhat_1.default.artifacts.getBuildInfoPaths()).map(async (p) => JSON.parse(await fs_1.promises.readFile(p, 'utf8'))));
+});
+exports.default = test;
+//# sourceMappingURL=test.js.map

package/dist/utils/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../src/utils/test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAoC;AACpC,sDAA0B;AAE1B,2BAAoC;AAMpC,MAAM,IAAI,GAAG,aAAwB,CAAC;AAEtC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC1C,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,CAAC,MAAM,iBAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CACnG,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}