@mnaoumov/typescript-dev-toolkit 1.3.1 → 2.0.0

package/dist/lib/cjs/docs-site/api-doc-package-sites.cjs

@@ -0,0 +1,118 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+(function () {
+function ensureBrowserProcess() {
+  const browserProcess = {
+    browser: true,
+    cwd() {
+      return '/';
+    },
+    env: {},
+    platform: 'android'
+  };
+
+  const existingProcess = globalThis.process;
+
+  if (!existingProcess) {
+    globalThis.process = browserProcess;
+    return;
+  }
+
+  if (existingProcess.versions?.node) {
+    return;
+  }
+
+  const existingProcessRecord = existingProcess;
+
+  for (const [key, value] of Object.entries(browserProcess)) {
+    existingProcessRecord[key] ??= value;
+  }
+
+  existingProcessRecord['browser'] = true;
+}
+
+ensureBrowserProcess();
+})();
+
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var api_doc_package_sites_exports = {};
+__export(api_doc_package_sites_exports, {
+  DEFAULT_PACKAGE_SITES: () => DEFAULT_PACKAGE_SITES,
+  clearPackageDeclarations: () => clearPackageDeclarations,
+  getPackageTypeUrl: () => getPackageTypeUrl,
+  registerPackageDeclaration: () => registerPackageDeclaration
+});
+module.exports = __toCommonJS(api_doc_package_sites_exports);
+var import_reg_exp = require('@mnaoumov/typescript-lib/reg-exp');
+var import_api_doc_route_segments = require('./api-doc-route-segments.cjs');
+var import_api_doc_settings = require('./api-doc-settings.cjs');
+const PACKAGE_DECLARATION_REG_EXP = /\/node_modules\/(?<Package>(?:@[^/]+\/)?[^/]+)\/dist\/lib\/(?:cjs|esm)\/(?<Path>.+?)(?:\.d\.[cm]?ts)?$/;
+const DEFAULT_PACKAGE_SITES = new Map([
+  "@mnaoumov/obsidian-dev-toolkit",
+  "@mnaoumov/obsidian-lib",
+  "@mnaoumov/typescript-dev-toolkit",
+  "@mnaoumov/typescript-lib",
+  "@mnaoumov/typescript-test-toolkit"
+].map((packageName) => [packageName, `https://mnaoumov.dev/${packageName.slice("@mnaoumov/".length)}/`]));
+const moduleState = {
+  urls: /* @__PURE__ */ new Map()
+};
+function clearPackageDeclarations() {
+  moduleState.urls.clear();
+}
+function getPackageTypeUrl(name) {
+  return moduleState.urls.get(name) ?? void 0;
+}
+function registerPackageDeclaration(name, declarationFilePath) {
+  const url = toPackageTypeUrl({ declarationFilePath, name, settings: (0, import_api_doc_settings.getApiDocSettings)() });
+  if (url === void 0) {
+    return;
+  }
+  const existing = moduleState.urls.get(name);
+  if (existing === void 0) {
+    moduleState.urls.set(name, url);
+  } else if (existing !== url) {
+    moduleState.urls.set(name, null);
+  }
+}
+function toPackageTypeUrl(params) {
+  const { declarationFilePath, name, settings } = params;
+  const match = PACKAGE_DECLARATION_REG_EXP.exec(declarationFilePath.replaceAll("\\", "/"));
+  if (match === null) {
+    return void 0;
+  }
+  const packageName = (0, import_reg_exp.getMandatoryNamedGroup)(match, "Package");
+  const path = (0, import_reg_exp.getMandatoryNamedGroup)(match, "Path");
+  if (packageName === settings.packageName) {
+    return void 0;
+  }
+  const site = settings.packageSites.get(packageName);
+  return site === void 0 ? void 0 : `${site}api/${path}/${(0, import_api_doc_route_segments.toRouteSegmentPreserveCase)(name)}/`;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_PACKAGE_SITES,
+  clearPackageDeclarations,
+  getPackageTypeUrl,
+  registerPackageDeclaration
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9kb2NzLXNpdGUvYXBpLWRvYy1wYWNrYWdlLXNpdGVzLnRzIl0sInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogQGZpbGVcbiAqXG4gKiBDcm9zcy1zaXRlIGxpbmtzOiBhIHR5cGUgZGVjbGFyZWQgaW4gYW5vdGhlciBkb2N1bWVudGVkIHBhY2thZ2UgbGlua3MgdG8gaXRzIHBhZ2Ugb24gdGhhdCBwYWNrYWdlJ3Mgc2l0ZS5cbiAqXG4gKiBBIHR5cGUgaXMgcmVjb2duaXplZCBieSB3aGVyZSBpdHMgZGVjbGFyYXRpb24gbGl2ZXMsIG5vdCBieSBpdHMgbmFtZTogYSBkZWNsYXJhdGlvbiB1bmRlclxuICogYG5vZGVfbW9kdWxlcy88cGFja2FnZT4vZGlzdC9saWIve2VzbSxjanN9LzxwYXRoPi5kLnttdHMsY3RzfWAgb2YgYSBwYWNrYWdlIGluXG4gKiB7QGxpbmsgQXBpRG9jU2V0dGluZ3MucGFja2FnZVNpdGVzfSBpcyB0aGUgcGFnZSBgPHNpdGU+YXBpLzxwYXRoPi88VHlwZT4vYCwgYnVpbHQgd2l0aCB0aGUgZ2VuZXJhdG9yJ3Mgb3duIHNsdWdcbiAqIHJ1bGVzLCBiZWNhdXNlIHRoYXQgc2l0ZSB3YXMgZ2VuZXJhdGVkIGZyb20gdGhlIHNhbWUgdHJlZS5cbiAqL1xuXG5pbXBvcnQgeyBnZXRNYW5kYXRvcnlOYW1lZEdyb3VwIH0gZnJvbSAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliL3JlZy1leHAnO1xuXG5pbXBvcnQgdHlwZSB7IEFwaURvY1NldHRpbmdzIH0gZnJvbSAnLi9hcGktZG9jLXNldHRpbmdzLnRzJztcblxuaW1wb3J0IHsgdG9Sb3V0ZVNlZ21lbnRQcmVzZXJ2ZUNhc2UgfSBmcm9tICcuL2FwaS1kb2Mtcm91dGUtc2VnbWVudHMudHMnO1xuaW1wb3J0IHsgZ2V0QXBpRG9jU2V0dGluZ3MgfSBmcm9tICcuL2FwaS1kb2Mtc2V0dGluZ3MudHMnO1xuXG5jb25zdCBQQUNLQUdFX0RFQ0xBUkFUSU9OX1JFR19FWFAgPSAvXFwvbm9kZV9tb2R1bGVzXFwvKD88UGFja2FnZT4oPzpAW14vXStcXC8pP1teL10rKVxcL2Rpc3RcXC9saWJcXC8oPzpjanN8ZXNtKVxcLyg/PFBhdGg+Lis/KSg/OlxcLmRcXC5bY21dP3RzKT8kLztcblxuLyoqXG4gKiBUaGUgZG9jdW1lbnRhdGlvbiBzaXRlcyBvZiB0aGUgYEBtbmFvdW1vdmAgcGFja2FnZXMsIHdoaWNoIGVhY2ggc2l0ZSBsaW5rcyB0byB1bmxlc3MgdG9sZCBvdGhlcndpc2UuXG4gKi9cbmV4cG9ydCBjb25zdCBERUZBVUxUX1BBQ0tBR0VfU0lURVM6IFJlYWRvbmx5TWFwPHN0cmluZywgc3RyaW5nPiA9IG5ldyBNYXAoW1xuICAnQG1uYW91bW92L29ic2lkaWFuLWRldi10b29sa2l0JyxcbiAgJ0BtbmFvdW1vdi9vYnNpZGlhbi1saWInLFxuICAnQG1uYW91bW92L3R5cGVzY3JpcHQtZGV2LXRvb2xraXQnLFxuICAnQG1uYW91bW92L3R5cGVzY3JpcHQtbGliJyxcbiAgJ0BtbmFvdW1vdi90eXBlc2NyaXB0LXRlc3QtdG9vbGtpdCdcbl0ubWFwKChwYWNrYWdlTmFtZSkgPT4gW3BhY2thZ2VOYW1lLCBgaHR0cHM6Ly9tbmFvdW1vdi5kZXYvJHtwYWNrYWdlTmFtZS5zbGljZSgnQG1uYW91bW92LycubGVuZ3RoKX0vYF0pKTtcblxuaW50ZXJmYWNlIE1vZHVsZVN0YXRlIHtcbiAgLyoqXG4gICAqIFR5cGUgbmFtZSB0byBpdHMgcGFnZSBVUkw7IGBudWxsYCB3aGVuIHR3byBwYWNrYWdlcyBkZWNsYXJlIHRoZSBuYW1lLCB3aGljaCBjYW5ub3QgYmUgdG9sZCBhcGFydCBmcm9tIHRleHQuXG4gICAqL1xuICByZWFkb25seSB1cmxzOiBNYXA8c3RyaW5nLCBudWxsIHwgc3RyaW5nPjtcbn1cblxuY29uc3QgbW9kdWxlU3RhdGU6IE1vZHVsZVN0YXRlID0ge1xuICB1cmxzOiBuZXcgTWFwKClcbn07XG5cbmludGVyZmFjZSBUb1BhY2thZ2VUeXBlVXJsUGFyYW1zIHtcbiAgcmVhZG9ubHkgZGVjbGFyYXRpb25GaWxlUGF0aDogc3RyaW5nO1xuICByZWFkb25seSBuYW1lOiBzdHJpbmc7XG4gIHJlYWRvbmx5IHNldHRpbmdzOiBBcGlEb2NTZXR0aW5ncztcbn1cblxuLyoqXG4gKiBGb3JnZXRzIGV2ZXJ5IGRlY2xhcmF0aW9uIHtAbGluayByZWdpc3RlclBhY2thZ2VEZWNsYXJhdGlvbn0gcmVjb3JkZWQuXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBjbGVhclBhY2thZ2VEZWNsYXJhdGlvbnMoKTogdm9pZCB7XG4gIG1vZHVsZVN0YXRlLnVybHMuY2xlYXIoKTtcbn1cblxuLyoqXG4gKiBHZXRzIHRoZSBwYWdlIFVSTCBvZiBhIHR5cGUgZGVjbGFyZWQgaW4gYW5vdGhlciBkb2N1bWVudGVkIHBhY2thZ2UuXG4gKlxuICogQHBhcmFtIG5hbWUgLSBUaGUgdHlwZSdzIG5hbWUsIGFzIHR5cGUgdGV4dCBwcmludHMgaXQuXG4gKiBAcmV0dXJucyBUaGUgVVJMLCBvciBgdW5kZWZpbmVkYCB3aGVuIG5vIGRvY3VtZW50ZWQgcGFja2FnZSBkZWNsYXJlcyBleGFjdGx5IG9uZSB0eXBlIG9mIHRoYXQgbmFtZS5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGdldFBhY2thZ2VUeXBlVXJsKG5hbWU6IHN0cmluZyk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gIHJldHVybiBtb2R1bGVTdGF0ZS51cmxzLmdldChuYW1lKSA/PyB1bmRlZmluZWQ7XG59XG5cbi8qKlxuICogUmVjb3JkcyB3aGVyZSBhIHR5cGUgaXMgZGVjbGFyZWQsIHNvIGl0cyByZWZlcmVuY2VzIGxpbmsgdG8gaXRzIHBhZ2Ugb24gdGhhdCBwYWNrYWdlJ3Mgc2l0ZS5cbiAqXG4gKiBBIGRlY2xhcmF0aW9uIG91dHNpZGUgZXZlcnkge0BsaW5rIEFwaURvY1NldHRpbmdzLnBhY2thZ2VTaXRlc30gcGFja2FnZSBpcyBpZ25vcmVkLiBBIG5hbWUgdHdvIHBhY2thZ2VzIGRlY2xhcmUgaXNcbiAqIHJlbWVtYmVyZWQgYXMgYW1iaWd1b3VzIGFuZCBuZXZlciBsaW5rZWQuXG4gKlxuICogQHBhcmFtIG5hbWUgLSBUaGUgdHlwZSdzIG5hbWUuXG4gKiBAcGFyYW0gZGVjbGFyYXRpb25GaWxlUGF0aCAtIFRoZSBkZWNsYXJhdGlvbiBmaWxlJ3MgcGF0aCwgd2l0aCBvciB3aXRob3V0IGl0cyBgLmQubXRzYCAvIGAuZC5jdHNgIGV4dGVuc2lvbi5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIHJlZ2lzdGVyUGFja2FnZURlY2xhcmF0aW9uKG5hbWU6IHN0cmluZywgZGVjbGFyYXRpb25GaWxlUGF0aDogc3RyaW5nKTogdm9pZCB7XG4gIGNvbnN0IHVybCA9IHRvUGFja2FnZVR5cGVVcmwoeyBkZWNsYXJhdGlvbkZpbGVQYXRoLCBuYW1lLCBzZXR0aW5nczogZ2V0QXBpRG9jU2V0dGluZ3MoKSB9KTtcbiAgaWYgKHVybCA9PT0gdW5kZWZpbmVkKSB7XG4gICAgcmV0dXJuO1xuICB9XG5cbiAgY29uc3QgZXhpc3RpbmcgPSBtb2R1bGVTdGF0ZS51cmxzLmdldChuYW1lKTtcbiAgaWYgKGV4aXN0aW5nID09PSB1bmRlZmluZWQpIHtcbiAgICBtb2R1bGVTdGF0ZS51cmxzLnNldChuYW1lLCB1cmwpO1xuICB9IGVsc2UgaWYgKGV4aXN0aW5nICE9PSB1cmwpIHtcbiAgICBtb2R1bGVTdGF0ZS51cmxzLnNldChuYW1lLCBudWxsKTtcbiAgfVxufVxuXG5mdW5jdGlvbiB0b1BhY2thZ2VUeXBlVXJsKHBhcmFtczogVG9QYWNrYWdlVHlwZVVybFBhcmFtcyk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gIGNvbnN0IHsgZGVjbGFyYXRpb25GaWxlUGF0aCwgbmFtZSwgc2V0dGluZ3MgfSA9IHBhcmFtcztcbiAgY29uc3QgbWF0Y2ggPSBQQUNLQUdFX0RFQ0xBUkFUSU9OX1JFR19FWFAuZXhlYyhkZWNsYXJhdGlvbkZpbGVQYXRoLnJlcGxhY2VBbGwoJ1xcXFwnLCAnLycpKTtcbiAgaWYgKG1hdGNoID09PSBudWxsKSB7XG4gICAgcmV0dXJuIHVuZGVmaW5lZDtcbiAgfVxuXG4gIGNvbnN0IHBhY2thZ2VOYW1lID0gZ2V0TWFuZGF0b3J5TmFtZWRHcm91cChtYXRjaCwgJ1BhY2thZ2UnKTtcbiAgY29uc3QgcGF0aCA9IGdldE1hbmRhdG9yeU5hbWVkR3JvdXAobWF0Y2gsICdQYXRoJyk7XG4gIGlmIChwYWNrYWdlTmFtZSA9PT0gc2V0dGluZ3MucGFja2FnZU5hbWUpIHtcbiAgICByZXR1cm4gdW5kZWZpbmVkO1xuICB9XG5cbiAgY29uc3Qgc2l0ZSA9IHNldHRpbmdzLnBhY2thZ2VTaXRlcy5nZXQocGFja2FnZU5hbWUpO1xuICByZXR1cm4gc2l0ZSA9PT0gdW5kZWZpbmVkID8gdW5kZWZpbmVkIDogYCR7c2l0ZX1hcGkvJHtwYXRofS8ke3RvUm91dGVTZWdtZW50UHJlc2VydmVDYXNlKG5hbWUpfS9gO1xufVxuIl0sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFBQTtBQUFBO0FBQUE7QUFXQSxxQkFBdUM7QUFJdkMsb0NBQTJDO0FBQzNDLDhCQUFrQztBQUVsQyxNQUFNLDhCQUE4QjtBQUs3QixNQUFNLHdCQUFxRCxJQUFJLElBQUk7QUFBQSxFQUN4RTtBQUFBLEVBQ0E7QUFBQSxFQUNBO0FBQUEsRUFDQTtBQUFBLEVBQ0E7QUFDRixFQUFFLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxhQUFhLHdCQUF3QixZQUFZLE1BQU0sYUFBYSxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7QUFTeEcsTUFBTSxjQUEyQjtBQUFBLEVBQy9CLE1BQU0sb0JBQUksSUFBSTtBQUNoQjtBQVdPLFNBQVMsMkJBQWlDO0FBQy9DLGNBQVksS0FBSyxNQUFNO0FBQ3pCO0FBUU8sU0FBUyxrQkFBa0IsTUFBa0M7QUFDbEUsU0FBTyxZQUFZLEtBQUssSUFBSSxJQUFJLEtBQUs7QUFDdkM7QUFXTyxTQUFTLDJCQUEyQixNQUFjLHFCQUFtQztBQUMxRixRQUFNLE1BQU0saUJBQWlCLEVBQUUscUJBQXFCLE1BQU0sY0FBVSwyQ0FBa0IsRUFBRSxDQUFDO0FBQ3pGLE1BQUksUUFBUSxRQUFXO0FBQ3JCO0FBQUEsRUFDRjtBQUVBLFFBQU0sV0FBVyxZQUFZLEtBQUssSUFBSSxJQUFJO0FBQzFDLE1BQUksYUFBYSxRQUFXO0FBQzFCLGdCQUFZLEtBQUssSUFBSSxNQUFNLEdBQUc7QUFBQSxFQUNoQyxXQUFXLGFBQWEsS0FBSztBQUMzQixnQkFBWSxLQUFLLElBQUksTUFBTSxJQUFJO0FBQUEsRUFDakM7QUFDRjtBQUVBLFNBQVMsaUJBQWlCLFFBQW9EO0FBQzVFLFFBQU0sRUFBRSxxQkFBcUIsTUFBTSxTQUFTLElBQUk7QUFDaEQsUUFBTSxRQUFRLDRCQUE0QixLQUFLLG9CQUFvQixXQUFXLE1BQU0sR0FBRyxDQUFDO0FBQ3hGLE1BQUksVUFBVSxNQUFNO0FBQ2xCLFdBQU87QUFBQSxFQUNUO0FBRUEsUUFBTSxrQkFBYyx1Q0FBdUIsT0FBTyxTQUFTO0FBQzNELFFBQU0sV0FBTyx1Q0FBdUIsT0FBTyxNQUFNO0FBQ2pELE1BQUksZ0JBQWdCLFNBQVMsYUFBYTtBQUN4QyxXQUFPO0FBQUEsRUFDVDtBQUVBLFFBQU0sT0FBTyxTQUFTLGFBQWEsSUFBSSxXQUFXO0FBQ2xELFNBQU8sU0FBUyxTQUFZLFNBQVksR0FBRyxJQUFJLE9BQU8sSUFBSSxRQUFJLDBEQUEyQixJQUFJLENBQUM7QUFDaEc7IiwibmFtZXMiOltdfQ==

package/dist/lib/cjs/docs-site/api-doc-package-sites.d.cts

@@ -0,0 +1,36 @@
+/// <reference path="../library-references.d.cts" />
+/**
+ * @file
+ *
+ * Cross-site links: a type declared in another documented package links to its page on that package's site.
+ *
+ * A type is recognized by where its declaration lives, not by its name: a declaration under
+ * `node_modules/<package>/dist/lib/{esm,cjs}/<path>.d.{mts,cts}` of a package in
+ * {@link ApiDocSettings.packageSites} is the page `<site>api/<path>/<Type>/`, built with the generator's own slug
+ * rules, because that site was generated from the same tree.
+ */
+/**
+ * The documentation sites of the `@mnaoumov` packages, which each site links to unless told otherwise.
+ */
+export declare const DEFAULT_PACKAGE_SITES: ReadonlyMap<string, string>;
+/**
+ * Forgets every declaration {@link registerPackageDeclaration} recorded.
+ */
+export declare function clearPackageDeclarations(): void;
+/**
+ * Gets the page URL of a type declared in another documented package.
+ *
+ * @param name - The type's name, as type text prints it.
+ * @returns The URL, or `undefined` when no documented package declares exactly one type of that name.
+ */
+export declare function getPackageTypeUrl(name: string): string | undefined;
+/**
+ * Records where a type is declared, so its references link to its page on that package's site.
+ *
+ * A declaration outside every {@link ApiDocSettings.packageSites} package is ignored. A name two packages declare is
+ * remembered as ambiguous and never linked.
+ *
+ * @param name - The type's name.
+ * @param declarationFilePath - The declaration file's path, with or without its `.d.mts` / `.d.cts` extension.
+ */
+export declare function registerPackageDeclaration(name: string, declarationFilePath: string): void;