@cparra/apexdocs 2.25.0 → 3.0.0-alpha.10

package/examples/markdown/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "plain-markdown",
+  "scripts": {
+    "docs:clean": "rimraf docs",
+    "docs:build": "ts-node ../../src/cli/generate.ts markdown",
+    "docs:help": "ts-node ../../src/cli/generate.ts markdown --help",
+    "docs:gen": "npm run docs:clean && npm run docs:build"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.2"
+  },
+  "dependencies": {
+    "rimraf": "^5.0.7"
+  },
+  "apexdocs": {
+    "sourceDir": "force-app",
+    "scope": ["global", "public", "protected", "private", "namespaceaccessible"],
+    "namespace": "ns"
+  }
+}

package/examples/markdown/sfdx-project.json

@@ -0,0 +1,12 @@
+{
+  "packageDirectories": [
+    {
+      "path": "force-app",
+      "default": true
+    }
+  ],
+  "name": "plain-markdown",
+  "namespace": "",
+  "sfdcLoginUrl": "https://login.salesforce.com",
+  "sourceApiVersion": "59.0"
+}

package/examples/vitepress/.forceignore

@@ -0,0 +1,12 @@
+# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
+# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
+#
+
+package.xml
+
+# LWC configuration files
+**/jsconfig.json
+**/.eslintrc.json
+
+# LWC Jest
+**/__tests__/**

package/examples/vitepress/apexdocs.config.ts

@@ -0,0 +1,106 @@
+import { defineMarkdownConfig, DocPageData } from '../../src';
+import * as fs from 'node:fs';
+
+function loadFileAsync(filePath: string): Promise<string> {
+  return new Promise((resolve, reject) => {
+    fs.readFile(filePath, 'utf8', (err, data) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(data);
+      }
+    });
+  });
+}
+
+function writeFileAsync(filePath: string, data: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    fs.writeFile(filePath, data, (err) => {
+      if (err) {
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  });
+}
+
+export default defineMarkdownConfig({
+  sourceDir: 'force-app',
+  scope: ['global', 'public', 'protected', 'private', 'namespaceaccessible'],
+  namespace: 'apexdocs',
+  transformReferenceGuide: async (referenceGuide) => {
+    const frontMatter = await loadFileAsync('./docs/index-frontmatter.md');
+    return {
+      ...referenceGuide,
+      frontmatter: frontMatter,
+    };
+  },
+  transformDocs: async (docs) => {
+    // Update sidebar
+    const sidebar = [
+      {
+        text: 'API Reference',
+        items: [
+          {
+            text: 'Grouped By Type',
+            items: [
+              {
+                text: 'Classes',
+                items: docs.filter((doc) => doc.source.type === 'class').map(toSidebarLink),
+              },
+              {
+                text: 'Interfaces',
+                items: docs.filter((doc) => doc.source.type === 'interface').map(toSidebarLink),
+              },
+              {
+                text: 'Enums',
+                items: docs.filter((doc) => doc.source.type === 'enum').map(toSidebarLink),
+              },
+            ],
+          },
+          {
+            text: 'Grouped by Group',
+            items: Array.from(extractGroups(docs)).map(([groupName, groupDocs]) => ({
+              text: groupName,
+              items: groupDocs.map(toSidebarLink),
+            })),
+          },
+        ],
+      },
+    ];
+    await writeFileAsync('./docs/.vitepress/sidebar.json', JSON.stringify(sidebar, null, 2));
+
+    return docs;
+  },
+  transformDocPage: async (docPage) => {
+    return {
+      ...docPage,
+      frontmatter: {
+        title: docPage.source.name,
+      },
+    };
+  },
+});
+
+function toSidebarLink(doc: DocPageData) {
+  return {
+    text: doc.source.name,
+    link: doc.outputDocPath,
+  };
+}
+
+function extractGroups(docs: DocPageData[]) {
+  const groups = new Map<string, DocPageData[]>();
+  for (const doc of docs) {
+    if (!doc.group) {
+      continue;
+    }
+
+    const groupDocs = groups.get(doc.group) ?? [];
+    groupDocs.push(doc);
+    groups.set(doc.group, groupDocs);
+  }
+
+  return groups;
+}

package/examples/vitepress/config/project-scratch-def.json

@@ -0,0 +1,13 @@
+{
+  "orgName": "vitepress example",
+  "edition": "Developer",
+  "features": ["EnableSetPasswordInApi"],
+  "settings": {
+    "lightningExperienceSettings": {
+      "enableS1DesktopEnabled": true
+    },
+    "mobileSettings": {
+      "enableS1EncryptedStoragePref2": false
+    }
+  }
+}

package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js

@@ -0,0 +1,259 @@
+import {
+  useMediaQuery
+} from "./chunk-E5DZZB2I.js";
+import {
+  computed,
+  ref,
+  shallowRef,
+  watch
+} from "./chunk-574YRH25.js";
+
+// node_modules/vitepress/dist/client/theme-default/index.js
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/fonts.css";
+
+// node_modules/vitepress/dist/client/theme-default/without-fonts.js
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/vars.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/base.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/icons.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/utils.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/components/custom-block.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code-group.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/components/vp-doc.css";
+import "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/styles/components/vp-sponsor.css";
+import VPBadge from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue";
+import Layout from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/Layout.vue";
+import { default as default2 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue";
+import { default as default3 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPImage.vue";
+import { default as default4 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPButton.vue";
+import { default as default5 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPHomeContent.vue";
+import { default as default6 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPHomeHero.vue";
+import { default as default7 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPHomeFeatures.vue";
+import { default as default8 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPHomeSponsors.vue";
+import { default as default9 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPDocAsideSponsors.vue";
+import { default as default10 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPSponsors.vue";
+import { default as default11 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPTeamPage.vue";
+import { default as default12 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageTitle.vue";
+import { default as default13 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageSection.vue";
+import { default as default14 } from "/Users/cesarparra/IdeaProjects/apexdocs/examples/vitepress/node_modules/vitepress/dist/client/theme-default/components/VPTeamMembers.vue";
+
+// node_modules/vitepress/dist/client/theme-default/support/utils.js
+import { withBase } from "vitepress";
+
+// node_modules/vitepress/dist/client/theme-default/composables/data.js
+import { useData as useData$ } from "vitepress";
+var useData = useData$;
+
+// node_modules/vitepress/dist/client/theme-default/support/utils.js
+function ensureStartingSlash(path) {
+  return /^\//.test(path) ? path : `/${path}`;
+}
+
+// node_modules/vitepress/dist/client/theme-default/support/sidebar.js
+function getSidebar(_sidebar, path) {
+  if (Array.isArray(_sidebar))
+    return addBase(_sidebar);
+  if (_sidebar == null)
+    return [];
+  path = ensureStartingSlash(path);
+  const dir = Object.keys(_sidebar).sort((a, b) => {
+    return b.split("/").length - a.split("/").length;
+  }).find((dir2) => {
+    return path.startsWith(ensureStartingSlash(dir2));
+  });
+  const sidebar = dir ? _sidebar[dir] : [];
+  return Array.isArray(sidebar) ? addBase(sidebar) : addBase(sidebar.items, sidebar.base);
+}
+function getSidebarGroups(sidebar) {
+  const groups = [];
+  let lastGroupIndex = 0;
+  for (const index in sidebar) {
+    const item = sidebar[index];
+    if (item.items) {
+      lastGroupIndex = groups.push(item);
+      continue;
+    }
+    if (!groups[lastGroupIndex]) {
+      groups.push({ items: [] });
+    }
+    groups[lastGroupIndex].items.push(item);
+  }
+  return groups;
+}
+function addBase(items, _base) {
+  return [...items].map((_item) => {
+    const item = { ..._item };
+    const base = item.base || _base;
+    if (base && item.link)
+      item.link = base + item.link;
+    if (item.items)
+      item.items = addBase(item.items, base);
+    return item;
+  });
+}
+
+// node_modules/vitepress/dist/client/theme-default/composables/sidebar.js
+function useSidebar() {
+  const { frontmatter, page, theme: theme2 } = useData();
+  const is960 = useMediaQuery("(min-width: 960px)");
+  const isOpen = ref(false);
+  const _sidebar = computed(() => {
+    const sidebarConfig = theme2.value.sidebar;
+    const relativePath = page.value.relativePath;
+    return sidebarConfig ? getSidebar(sidebarConfig, relativePath) : [];
+  });
+  const sidebar = ref(_sidebar.value);
+  watch(_sidebar, (next, prev) => {
+    if (JSON.stringify(next) !== JSON.stringify(prev))
+      sidebar.value = _sidebar.value;
+  });
+  const hasSidebar = computed(() => {
+    return frontmatter.value.sidebar !== false && sidebar.value.length > 0 && frontmatter.value.layout !== "home";
+  });
+  const leftAside = computed(() => {
+    if (hasAside)
+      return frontmatter.value.aside == null ? theme2.value.aside === "left" : frontmatter.value.aside === "left";
+    return false;
+  });
+  const hasAside = computed(() => {
+    if (frontmatter.value.layout === "home")
+      return false;
+    if (frontmatter.value.aside != null)
+      return !!frontmatter.value.aside;
+    return theme2.value.aside !== false;
+  });
+  const isSidebarEnabled = computed(() => hasSidebar.value && is960.value);
+  const sidebarGroups = computed(() => {
+    return hasSidebar.value ? getSidebarGroups(sidebar.value) : [];
+  });
+  function open() {
+    isOpen.value = true;
+  }
+  function close() {
+    isOpen.value = false;
+  }
+  function toggle() {
+    isOpen.value ? close() : open();
+  }
+  return {
+    isOpen,
+    sidebar,
+    sidebarGroups,
+    hasSidebar,
+    hasAside,
+    leftAside,
+    isSidebarEnabled,
+    open,
+    close,
+    toggle
+  };
+}
+
+// node_modules/vitepress/dist/client/theme-default/composables/local-nav.js
+import { onContentUpdated } from "vitepress";
+
+// node_modules/vitepress/dist/client/theme-default/composables/outline.js
+import { getScrollOffset } from "vitepress";
+var resolvedHeaders = [];
+function getHeaders(range) {
+  const headers = [
+    ...document.querySelectorAll(".VPDoc :where(h1,h2,h3,h4,h5,h6)")
+  ].filter((el) => el.id && el.hasChildNodes()).map((el) => {
+    const level = Number(el.tagName[1]);
+    return {
+      element: el,
+      title: serializeHeader(el),
+      link: "#" + el.id,
+      level
+    };
+  });
+  return resolveHeaders(headers, range);
+}
+function serializeHeader(h) {
+  let ret = "";
+  for (const node of h.childNodes) {
+    if (node.nodeType === 1) {
+      if (node.classList.contains("VPBadge") || node.classList.contains("header-anchor") || node.classList.contains("ignore-header")) {
+        continue;
+      }
+      ret += node.textContent;
+    } else if (node.nodeType === 3) {
+      ret += node.textContent;
+    }
+  }
+  return ret.trim();
+}
+function resolveHeaders(headers, range) {
+  if (range === false) {
+    return [];
+  }
+  const levelsRange = (typeof range === "object" && !Array.isArray(range) ? range.level : range) || 2;
+  const [high, low] = typeof levelsRange === "number" ? [levelsRange, levelsRange] : levelsRange === "deep" ? [2, 6] : levelsRange;
+  headers = headers.filter((h) => h.level >= high && h.level <= low);
+  resolvedHeaders.length = 0;
+  for (const { element, link } of headers) {
+    resolvedHeaders.push({ element, link });
+  }
+  const ret = [];
+  outer: for (let i = 0; i < headers.length; i++) {
+    const cur = headers[i];
+    if (i === 0) {
+      ret.push(cur);
+    } else {
+      for (let j = i - 1; j >= 0; j--) {
+        const prev = headers[j];
+        if (prev.level < cur.level) {
+          ;
+          (prev.children || (prev.children = [])).push(cur);
+          continue outer;
+        }
+      }
+      ret.push(cur);
+    }
+  }
+  return ret;
+}
+
+// node_modules/vitepress/dist/client/theme-default/composables/local-nav.js
+function useLocalNav() {
+  const { theme: theme2, frontmatter } = useData();
+  const headers = shallowRef([]);
+  const hasLocalNav = computed(() => {
+    return headers.value.length > 0;
+  });
+  onContentUpdated(() => {
+    headers.value = getHeaders(frontmatter.value.outline ?? theme2.value.outline);
+  });
+  return {
+    headers,
+    hasLocalNav
+  };
+}
+
+// node_modules/vitepress/dist/client/theme-default/without-fonts.js
+var theme = {
+  Layout,
+  enhanceApp: ({ app }) => {
+    app.component("Badge", VPBadge);
+  }
+};
+var without_fonts_default = theme;
+export {
+  default2 as VPBadge,
+  default4 as VPButton,
+  default9 as VPDocAsideSponsors,
+  default5 as VPHomeContent,
+  default7 as VPHomeFeatures,
+  default6 as VPHomeHero,
+  default8 as VPHomeSponsors,
+  default3 as VPImage,
+  default10 as VPSponsors,
+  default14 as VPTeamMembers,
+  default11 as VPTeamPage,
+  default13 as VPTeamPageSection,
+  default12 as VPTeamPageTitle,
+  without_fonts_default as default,
+  useLocalNav,
+  useSidebar
+};
+//# sourceMappingURL=@theme_index.js.map

package/examples/vitepress/docs/.vitepress/cache/deps/@theme_index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../node_modules/vitepress/dist/client/theme-default/index.js", "../../../../node_modules/vitepress/dist/client/theme-default/without-fonts.js", "../../../../node_modules/vitepress/dist/client/theme-default/support/utils.js", "../../../../node_modules/vitepress/dist/client/theme-default/composables/data.js", "../../../../node_modules/vitepress/dist/client/theme-default/support/sidebar.js", "../../../../node_modules/vitepress/dist/client/theme-default/composables/sidebar.js", "../../../../node_modules/vitepress/dist/client/theme-default/composables/local-nav.js", "../../../../node_modules/vitepress/dist/client/theme-default/composables/outline.js"],
+  "sourcesContent": ["import './styles/fonts.css';\nexport * from './without-fonts';\nexport { default as default } from './without-fonts';\n", "import './styles/vars.css';\nimport './styles/base.css';\nimport './styles/icons.css';\nimport './styles/utils.css';\nimport './styles/components/custom-block.css';\nimport './styles/components/vp-code.css';\nimport './styles/components/vp-code-group.css';\nimport './styles/components/vp-doc.css';\nimport './styles/components/vp-sponsor.css';\nimport VPBadge from './components/VPBadge.vue';\nimport Layout from './Layout.vue';\nexport { default as VPBadge } from './components/VPBadge.vue';\nexport { default as VPImage } from './components/VPImage.vue';\nexport { default as VPButton } from './components/VPButton.vue';\nexport { default as VPHomeContent } from './components/VPHomeContent.vue';\nexport { default as VPHomeHero } from './components/VPHomeHero.vue';\nexport { default as VPHomeFeatures } from './components/VPHomeFeatures.vue';\nexport { default as VPHomeSponsors } from './components/VPHomeSponsors.vue';\nexport { default as VPDocAsideSponsors } from './components/VPDocAsideSponsors.vue';\nexport { default as VPSponsors } from './components/VPSponsors.vue';\nexport { default as VPTeamPage } from './components/VPTeamPage.vue';\nexport { default as VPTeamPageTitle } from './components/VPTeamPageTitle.vue';\nexport { default as VPTeamPageSection } from './components/VPTeamPageSection.vue';\nexport { default as VPTeamMembers } from './components/VPTeamMembers.vue';\nexport { useSidebar } from './composables/sidebar';\nexport { useLocalNav } from './composables/local-nav';\nconst theme = {\n    Layout,\n    enhanceApp: ({ app }) => {\n        app.component('Badge', VPBadge);\n    }\n};\nexport default theme;\n", "import { withBase } from 'vitepress';\nimport { useData } from '../composables/data';\nimport { isExternal, treatAsHtml } from '../../shared';\nexport function throttleAndDebounce(fn, delay) {\n    let timeoutId;\n    let called = false;\n    return () => {\n        if (timeoutId)\n            clearTimeout(timeoutId);\n        if (!called) {\n            fn();\n            (called = true) && setTimeout(() => (called = false), delay);\n        }\n        else\n            timeoutId = setTimeout(fn, delay);\n    };\n}\nexport function ensureStartingSlash(path) {\n    return /^\\//.test(path) ? path : `/${path}`;\n}\nexport function normalizeLink(url) {\n    const { pathname, search, hash, protocol } = new URL(url, 'http://a.com');\n    if (isExternal(url) ||\n        url.startsWith('#') ||\n        !protocol.startsWith('http') ||\n        !treatAsHtml(pathname))\n        return url;\n    const { site } = useData();\n    const normalizedPath = pathname.endsWith('/') || pathname.endsWith('.html')\n        ? url\n        : url.replace(/(?:(^\\.+)\\/)?.*$/, `$1${pathname.replace(/(\\.md)?$/, site.value.cleanUrls ? '' : '.html')}${search}${hash}`);\n    return withBase(normalizedPath);\n}\n", "import { useData as useData$ } from 'vitepress';\nexport const useData = useData$;\n", "import { ensureStartingSlash } from './utils';\nimport { isActive } from '../../shared';\n/**\n * Get the `Sidebar` from sidebar option. This method will ensure to get correct\n * sidebar config from `MultiSideBarConfig` with various path combinations such\n * as matching `guide/` and `/guide/`. If no matching config was found, it will\n * return empty array.\n */\nexport function getSidebar(_sidebar, path) {\n    if (Array.isArray(_sidebar))\n        return addBase(_sidebar);\n    if (_sidebar == null)\n        return [];\n    path = ensureStartingSlash(path);\n    const dir = Object.keys(_sidebar)\n        .sort((a, b) => {\n        return b.split('/').length - a.split('/').length;\n    })\n        .find((dir) => {\n        // make sure the multi sidebar key starts with slash too\n        return path.startsWith(ensureStartingSlash(dir));\n    });\n    const sidebar = dir ? _sidebar[dir] : [];\n    return Array.isArray(sidebar)\n        ? addBase(sidebar)\n        : addBase(sidebar.items, sidebar.base);\n}\n/**\n * Get or generate sidebar group from the given sidebar items.\n */\nexport function getSidebarGroups(sidebar) {\n    const groups = [];\n    let lastGroupIndex = 0;\n    for (const index in sidebar) {\n        const item = sidebar[index];\n        if (item.items) {\n            lastGroupIndex = groups.push(item);\n            continue;\n        }\n        if (!groups[lastGroupIndex]) {\n            groups.push({ items: [] });\n        }\n        groups[lastGroupIndex].items.push(item);\n    }\n    return groups;\n}\nexport function getFlatSideBarLinks(sidebar) {\n    const links = [];\n    function recursivelyExtractLinks(items) {\n        for (const item of items) {\n            if (item.text && item.link) {\n                links.push({\n                    text: item.text,\n                    link: item.link,\n                    docFooterText: item.docFooterText\n                });\n            }\n            if (item.items) {\n                recursivelyExtractLinks(item.items);\n            }\n        }\n    }\n    recursivelyExtractLinks(sidebar);\n    return links;\n}\n/**\n * Check if the given sidebar item contains any active link.\n */\nexport function hasActiveLink(path, items) {\n    if (Array.isArray(items)) {\n        return items.some((item) => hasActiveLink(path, item));\n    }\n    return isActive(path, items.link)\n        ? true\n        : items.items\n            ? hasActiveLink(path, items.items)\n            : false;\n}\nfunction addBase(items, _base) {\n    return [...items].map((_item) => {\n        const item = { ..._item };\n        const base = item.base || _base;\n        if (base && item.link)\n            item.link = base + item.link;\n        if (item.items)\n            item.items = addBase(item.items, base);\n        return item;\n    });\n}\n", "import { useMediaQuery } from '@vueuse/core';\nimport { computed, onMounted, onUnmounted, ref, watch, watchEffect, watchPostEffect } from 'vue';\nimport { isActive } from '../../shared';\nimport { hasActiveLink as containsActiveLink, getSidebar, getSidebarGroups } from '../support/sidebar';\nimport { useData } from './data';\nexport function useSidebar() {\n    const { frontmatter, page, theme } = useData();\n    const is960 = useMediaQuery('(min-width: 960px)');\n    const isOpen = ref(false);\n    const _sidebar = computed(() => {\n        const sidebarConfig = theme.value.sidebar;\n        const relativePath = page.value.relativePath;\n        return sidebarConfig ? getSidebar(sidebarConfig, relativePath) : [];\n    });\n    const sidebar = ref(_sidebar.value);\n    watch(_sidebar, (next, prev) => {\n        if (JSON.stringify(next) !== JSON.stringify(prev))\n            sidebar.value = _sidebar.value;\n    });\n    const hasSidebar = computed(() => {\n        return (frontmatter.value.sidebar !== false &&\n            sidebar.value.length > 0 &&\n            frontmatter.value.layout !== 'home');\n    });\n    const leftAside = computed(() => {\n        if (hasAside)\n            return frontmatter.value.aside == null\n                ? theme.value.aside === 'left'\n                : frontmatter.value.aside === 'left';\n        return false;\n    });\n    const hasAside = computed(() => {\n        if (frontmatter.value.layout === 'home')\n            return false;\n        if (frontmatter.value.aside != null)\n            return !!frontmatter.value.aside;\n        return theme.value.aside !== false;\n    });\n    const isSidebarEnabled = computed(() => hasSidebar.value && is960.value);\n    const sidebarGroups = computed(() => {\n        return hasSidebar.value ? getSidebarGroups(sidebar.value) : [];\n    });\n    function open() {\n        isOpen.value = true;\n    }\n    function close() {\n        isOpen.value = false;\n    }\n    function toggle() {\n        isOpen.value ? close() : open();\n    }\n    return {\n        isOpen,\n        sidebar,\n        sidebarGroups,\n        hasSidebar,\n        hasAside,\n        leftAside,\n        isSidebarEnabled,\n        open,\n        close,\n        toggle\n    };\n}\n/**\n * a11y: cache the element that opened the Sidebar (the menu button) then\n * focus that button again when Menu is closed with Escape key.\n */\nexport function useCloseSidebarOnEscape(isOpen, close) {\n    let triggerElement;\n    watchEffect(() => {\n        triggerElement = isOpen.value\n            ? document.activeElement\n            : undefined;\n    });\n    onMounted(() => {\n        window.addEventListener('keyup', onEscape);\n    });\n    onUnmounted(() => {\n        window.removeEventListener('keyup', onEscape);\n    });\n    function onEscape(e) {\n        if (e.key === 'Escape' && isOpen.value) {\n            close();\n            triggerElement?.focus();\n        }\n    }\n}\nexport function useSidebarControl(item) {\n    const { page, hash } = useData();\n    const collapsed = ref(false);\n    const collapsible = computed(() => {\n        return item.value.collapsed != null;\n    });\n    const isLink = computed(() => {\n        return !!item.value.link;\n    });\n    const isActiveLink = ref(false);\n    const updateIsActiveLink = () => {\n        isActiveLink.value = isActive(page.value.relativePath, item.value.link);\n    };\n    watch([page, item, hash], updateIsActiveLink);\n    onMounted(updateIsActiveLink);\n    const hasActiveLink = computed(() => {\n        if (isActiveLink.value) {\n            return true;\n        }\n        return item.value.items\n            ? containsActiveLink(page.value.relativePath, item.value.items)\n            : false;\n    });\n    const hasChildren = computed(() => {\n        return !!(item.value.items && item.value.items.length);\n    });\n    watchEffect(() => {\n        collapsed.value = !!(collapsible.value && item.value.collapsed);\n    });\n    watchPostEffect(() => {\n        ;\n        (isActiveLink.value || hasActiveLink.value) && (collapsed.value = false);\n    });\n    function toggle() {\n        if (collapsible.value) {\n            collapsed.value = !collapsed.value;\n        }\n    }\n    return {\n        collapsed,\n        collapsible,\n        isLink,\n        isActiveLink,\n        hasActiveLink,\n        hasChildren,\n        toggle\n    };\n}\n", "import { onContentUpdated } from 'vitepress';\nimport { computed, shallowRef } from 'vue';\nimport { getHeaders } from '../composables/outline';\nimport { useData } from './data';\nexport function useLocalNav() {\n    const { theme, frontmatter } = useData();\n    const headers = shallowRef([]);\n    const hasLocalNav = computed(() => {\n        return headers.value.length > 0;\n    });\n    onContentUpdated(() => {\n        headers.value = getHeaders(frontmatter.value.outline ?? theme.value.outline);\n    });\n    return {\n        headers,\n        hasLocalNav\n    };\n}\n", "import { getScrollOffset } from 'vitepress';\nimport { onMounted, onUnmounted, onUpdated } from 'vue';\nimport { throttleAndDebounce } from '../support/utils';\nimport { useAside } from './aside';\n// cached list of anchor elements from resolveHeaders\nconst resolvedHeaders = [];\nexport function resolveTitle(theme) {\n    return ((typeof theme.outline === 'object' &&\n        !Array.isArray(theme.outline) &&\n        theme.outline.label) ||\n        theme.outlineTitle ||\n        'On this page');\n}\nexport function getHeaders(range) {\n    const headers = [\n        ...document.querySelectorAll('.VPDoc :where(h1,h2,h3,h4,h5,h6)')\n    ]\n        .filter((el) => el.id && el.hasChildNodes())\n        .map((el) => {\n        const level = Number(el.tagName[1]);\n        return {\n            element: el,\n            title: serializeHeader(el),\n            link: '#' + el.id,\n            level\n        };\n    });\n    return resolveHeaders(headers, range);\n}\nfunction serializeHeader(h) {\n    let ret = '';\n    for (const node of h.childNodes) {\n        if (node.nodeType === 1) {\n            if (node.classList.contains('VPBadge') ||\n                node.classList.contains('header-anchor') ||\n                node.classList.contains('ignore-header')) {\n                continue;\n            }\n            ret += node.textContent;\n        }\n        else if (node.nodeType === 3) {\n            ret += node.textContent;\n        }\n    }\n    return ret.trim();\n}\nexport function resolveHeaders(headers, range) {\n    if (range === false) {\n        return [];\n    }\n    const levelsRange = (typeof range === 'object' && !Array.isArray(range)\n        ? range.level\n        : range) || 2;\n    const [high, low] = typeof levelsRange === 'number'\n        ? [levelsRange, levelsRange]\n        : levelsRange === 'deep'\n            ? [2, 6]\n            : levelsRange;\n    headers = headers.filter((h) => h.level >= high && h.level <= low);\n    // clear previous caches\n    resolvedHeaders.length = 0;\n    // update global header list for active link rendering\n    for (const { element, link } of headers) {\n        resolvedHeaders.push({ element, link });\n    }\n    const ret = [];\n    outer: for (let i = 0; i < headers.length; i++) {\n        const cur = headers[i];\n        if (i === 0) {\n            ret.push(cur);\n        }\n        else {\n            for (let j = i - 1; j >= 0; j--) {\n                const prev = headers[j];\n                if (prev.level < cur.level) {\n                    ;\n                    (prev.children || (prev.children = [])).push(cur);\n                    continue outer;\n                }\n            }\n            ret.push(cur);\n        }\n    }\n    return ret;\n}\nexport function useActiveAnchor(container, marker) {\n    const { isAsideEnabled } = useAside();\n    const onScroll = throttleAndDebounce(setActiveLink, 100);\n    let prevActiveLink = null;\n    onMounted(() => {\n        requestAnimationFrame(setActiveLink);\n        window.addEventListener('scroll', onScroll);\n    });\n    onUpdated(() => {\n        // sidebar update means a route change\n        activateLink(location.hash);\n    });\n    onUnmounted(() => {\n        window.removeEventListener('scroll', onScroll);\n    });\n    function setActiveLink() {\n        if (!isAsideEnabled.value) {\n            return;\n        }\n        const scrollY = window.scrollY;\n        const innerHeight = window.innerHeight;\n        const offsetHeight = document.body.offsetHeight;\n        const isBottom = Math.abs(scrollY + innerHeight - offsetHeight) < 1;\n        // resolvedHeaders may be repositioned, hidden or fix positioned\n        const headers = resolvedHeaders\n            .map(({ element, link }) => ({\n            link,\n            top: getAbsoluteTop(element)\n        }))\n            .filter(({ top }) => !Number.isNaN(top))\n            .sort((a, b) => a.top - b.top);\n        // no headers available for active link\n        if (!headers.length) {\n            activateLink(null);\n            return;\n        }\n        // page top\n        if (scrollY < 1) {\n            activateLink(null);\n            return;\n        }\n        // page bottom - highlight last link\n        if (isBottom) {\n            activateLink(headers[headers.length - 1].link);\n            return;\n        }\n        // find the last header above the top of viewport\n        let activeLink = null;\n        for (const { link, top } of headers) {\n            if (top > scrollY + getScrollOffset() + 4) {\n                break;\n            }\n            activeLink = link;\n        }\n        activateLink(activeLink);\n    }\n    function activateLink(hash) {\n        if (prevActiveLink) {\n            prevActiveLink.classList.remove('active');\n        }\n        if (hash == null) {\n            prevActiveLink = null;\n        }\n        else {\n            prevActiveLink = container.value.querySelector(`a[href=\"${decodeURIComponent(hash)}\"]`);\n        }\n        const activeLink = prevActiveLink;\n        if (activeLink) {\n            activeLink.classList.add('active');\n            marker.value.style.top = activeLink.offsetTop + 39 + 'px';\n            marker.value.style.opacity = '1';\n        }\n        else {\n            marker.value.style.top = '33px';\n            marker.value.style.opacity = '0';\n        }\n    }\n}\nfunction getAbsoluteTop(element) {\n    let offsetTop = 0;\n    while (element !== document.body) {\n        if (element === null) {\n            // child element is:\n            // - not attached to the DOM (display: none)\n            // - set to fixed position (not scrollable)\n            // - body or html element (null offsetParent)\n            return NaN;\n        }\n        offsetTop += element.offsetTop;\n        element = element.offsetParent;\n    }\n    return offsetTop;\n}\n"],
+  "mappings": ";;;;;;;;;;;AAAA,OAAO;;;ACAP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO;AACP,OAAO,aAAa;AACpB,OAAO,YAAY;AACnB,SAAoB,WAAXA,gBAA0B;AACnC,SAAoB,WAAXA,gBAA0B;AACnC,SAAoB,WAAXA,gBAA2B;AACpC,SAAoB,WAAXA,gBAAgC;AACzC,SAAoB,WAAXA,gBAA6B;AACtC,SAAoB,WAAXA,gBAAiC;AAC1C,SAAoB,WAAXA,gBAAiC;AAC1C,SAAoB,WAAXA,gBAAqC;AAC9C,SAAoB,WAAXA,iBAA6B;AACtC,SAAoB,WAAXA,iBAA6B;AACtC,SAAoB,WAAXA,iBAAkC;AAC3C,SAAoB,WAAXA,iBAAoC;AAC7C,SAAoB,WAAXA,iBAAgC;;;ACvBzC,SAAS,gBAAgB;;;ACAzB,SAAS,WAAW,gBAAgB;AAC7B,IAAM,UAAU;;;ADgBhB,SAAS,oBAAoB,MAAM;AACtC,SAAO,MAAM,KAAK,IAAI,IAAI,OAAO,IAAI,IAAI;AAC7C;;;AEXO,SAAS,WAAW,UAAU,MAAM;AACvC,MAAI,MAAM,QAAQ,QAAQ;AACtB,WAAO,QAAQ,QAAQ;AAC3B,MAAI,YAAY;AACZ,WAAO,CAAC;AACZ,SAAO,oBAAoB,IAAI;AAC/B,QAAM,MAAM,OAAO,KAAK,QAAQ,EAC3B,KAAK,CAAC,GAAG,MAAM;AAChB,WAAO,EAAE,MAAM,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,EAAE;AAAA,EAC9C,CAAC,EACI,KAAK,CAACC,SAAQ;AAEf,WAAO,KAAK,WAAW,oBAAoBA,IAAG,CAAC;AAAA,EACnD,CAAC;AACD,QAAM,UAAU,MAAM,SAAS,GAAG,IAAI,CAAC;AACvC,SAAO,MAAM,QAAQ,OAAO,IACtB,QAAQ,OAAO,IACf,QAAQ,QAAQ,OAAO,QAAQ,IAAI;AAC7C;AAIO,SAAS,iBAAiB,SAAS;AACtC,QAAM,SAAS,CAAC;AAChB,MAAI,iBAAiB;AACrB,aAAW,SAAS,SAAS;AACzB,UAAM,OAAO,QAAQ,KAAK;AAC1B,QAAI,KAAK,OAAO;AACZ,uBAAiB,OAAO,KAAK,IAAI;AACjC;AAAA,IACJ;AACA,QAAI,CAAC,OAAO,cAAc,GAAG;AACzB,aAAO,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;AAAA,IAC7B;AACA,WAAO,cAAc,EAAE,MAAM,KAAK,IAAI;AAAA,EAC1C;AACA,SAAO;AACX;AAiCA,SAAS,QAAQ,OAAO,OAAO;AAC3B,SAAO,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC,UAAU;AAC7B,UAAM,OAAO,EAAE,GAAG,MAAM;AACxB,UAAM,OAAO,KAAK,QAAQ;AAC1B,QAAI,QAAQ,KAAK;AACb,WAAK,OAAO,OAAO,KAAK;AAC5B,QAAI,KAAK;AACL,WAAK,QAAQ,QAAQ,KAAK,OAAO,IAAI;AACzC,WAAO;AAAA,EACX,CAAC;AACL;;;ACnFO,SAAS,aAAa;AACzB,QAAM,EAAE,aAAa,MAAM,OAAAC,OAAM,IAAI,QAAQ;AAC7C,QAAM,QAAQ,cAAc,oBAAoB;AAChD,QAAM,SAAS,IAAI,KAAK;AACxB,QAAM,WAAW,SAAS,MAAM;AAC5B,UAAM,gBAAgBA,OAAM,MAAM;AAClC,UAAM,eAAe,KAAK,MAAM;AAChC,WAAO,gBAAgB,WAAW,eAAe,YAAY,IAAI,CAAC;AAAA,EACtE,CAAC;AACD,QAAM,UAAU,IAAI,SAAS,KAAK;AAClC,QAAM,UAAU,CAAC,MAAM,SAAS;AAC5B,QAAI,KAAK,UAAU,IAAI,MAAM,KAAK,UAAU,IAAI;AAC5C,cAAQ,QAAQ,SAAS;AAAA,EACjC,CAAC;AACD,QAAM,aAAa,SAAS,MAAM;AAC9B,WAAQ,YAAY,MAAM,YAAY,SAClC,QAAQ,MAAM,SAAS,KACvB,YAAY,MAAM,WAAW;AAAA,EACrC,CAAC;AACD,QAAM,YAAY,SAAS,MAAM;AAC7B,QAAI;AACA,aAAO,YAAY,MAAM,SAAS,OAC5BA,OAAM,MAAM,UAAU,SACtB,YAAY,MAAM,UAAU;AACtC,WAAO;AAAA,EACX,CAAC;AACD,QAAM,WAAW,SAAS,MAAM;AAC5B,QAAI,YAAY,MAAM,WAAW;AAC7B,aAAO;AACX,QAAI,YAAY,MAAM,SAAS;AAC3B,aAAO,CAAC,CAAC,YAAY,MAAM;AAC/B,WAAOA,OAAM,MAAM,UAAU;AAAA,EACjC,CAAC;AACD,QAAM,mBAAmB,SAAS,MAAM,WAAW,SAAS,MAAM,KAAK;AACvE,QAAM,gBAAgB,SAAS,MAAM;AACjC,WAAO,WAAW,QAAQ,iBAAiB,QAAQ,KAAK,IAAI,CAAC;AAAA,EACjE,CAAC;AACD,WAAS,OAAO;AACZ,WAAO,QAAQ;AAAA,EACnB;AACA,WAAS,QAAQ;AACb,WAAO,QAAQ;AAAA,EACnB;AACA,WAAS,SAAS;AACd,WAAO,QAAQ,MAAM,IAAI,KAAK;AAAA,EAClC;AACA,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AACJ;;;AC/DA,SAAS,wBAAwB;;;ACAjC,SAAS,uBAAuB;AAKhC,IAAM,kBAAkB,CAAC;AAQlB,SAAS,WAAW,OAAO;AAC9B,QAAM,UAAU;AAAA,IACZ,GAAG,SAAS,iBAAiB,kCAAkC;AAAA,EACnE,EACK,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,cAAc,CAAC,EAC1C,IAAI,CAAC,OAAO;AACb,UAAM,QAAQ,OAAO,GAAG,QAAQ,CAAC,CAAC;AAClC,WAAO;AAAA,MACH,SAAS;AAAA,MACT,OAAO,gBAAgB,EAAE;AAAA,MACzB,MAAM,MAAM,GAAG;AAAA,MACf;AAAA,IACJ;AAAA,EACJ,CAAC;AACD,SAAO,eAAe,SAAS,KAAK;AACxC;AACA,SAAS,gBAAgB,GAAG;AACxB,MAAI,MAAM;AACV,aAAW,QAAQ,EAAE,YAAY;AAC7B,QAAI,KAAK,aAAa,GAAG;AACrB,UAAI,KAAK,UAAU,SAAS,SAAS,KACjC,KAAK,UAAU,SAAS,eAAe,KACvC,KAAK,UAAU,SAAS,eAAe,GAAG;AAC1C;AAAA,MACJ;AACA,aAAO,KAAK;AAAA,IAChB,WACS,KAAK,aAAa,GAAG;AAC1B,aAAO,KAAK;AAAA,IAChB;AAAA,EACJ;AACA,SAAO,IAAI,KAAK;AACpB;AACO,SAAS,eAAe,SAAS,OAAO;AAC3C,MAAI,UAAU,OAAO;AACjB,WAAO,CAAC;AAAA,EACZ;AACA,QAAM,eAAe,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK,IAChE,MAAM,QACN,UAAU;AAChB,QAAM,CAAC,MAAM,GAAG,IAAI,OAAO,gBAAgB,WACrC,CAAC,aAAa,WAAW,IACzB,gBAAgB,SACZ,CAAC,GAAG,CAAC,IACL;AACV,YAAU,QAAQ,OAAO,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,SAAS,GAAG;AAEjE,kBAAgB,SAAS;AAEzB,aAAW,EAAE,SAAS,KAAK,KAAK,SAAS;AACrC,oBAAgB,KAAK,EAAE,SAAS,KAAK,CAAC;AAAA,EAC1C;AACA,QAAM,MAAM,CAAC;AACb,QAAO,UAAS,IAAI,GAAG,IAAI,QAAQ,QAAQ,KAAK;AAC5C,UAAM,MAAM,QAAQ,CAAC;AACrB,QAAI,MAAM,GAAG;AACT,UAAI,KAAK,GAAG;AAAA,IAChB,OACK;AACD,eAAS,IAAI,IAAI,GAAG,KAAK,GAAG,KAAK;AAC7B,cAAM,OAAO,QAAQ,CAAC;AACtB,YAAI,KAAK,QAAQ,IAAI,OAAO;AACxB;AACA,WAAC,KAAK,aAAa,KAAK,WAAW,CAAC,IAAI,KAAK,GAAG;AAChD,mBAAS;AAAA,QACb;AAAA,MACJ;AACA,UAAI,KAAK,GAAG;AAAA,IAChB;AAAA,EACJ;AACA,SAAO;AACX;;;ADhFO,SAAS,cAAc;AAC1B,QAAM,EAAE,OAAAC,QAAO,YAAY,IAAI,QAAQ;AACvC,QAAM,UAAU,WAAW,CAAC,CAAC;AAC7B,QAAM,cAAc,SAAS,MAAM;AAC/B,WAAO,QAAQ,MAAM,SAAS;AAAA,EAClC,CAAC;AACD,mBAAiB,MAAM;AACnB,YAAQ,QAAQ,WAAW,YAAY,MAAM,WAAWA,OAAM,MAAM,OAAO;AAAA,EAC/E,CAAC;AACD,SAAO;AAAA,IACH;AAAA,IACA;AAAA,EACJ;AACJ;;;ALSA,IAAM,QAAQ;AAAA,EACV;AAAA,EACA,YAAY,CAAC,EAAE,IAAI,MAAM;AACrB,QAAI,UAAU,SAAS,OAAO;AAAA,EAClC;AACJ;AACA,IAAO,wBAAQ;",
+  "names": ["default", "dir", "theme", "theme"]
+}

package/examples/vitepress/docs/.vitepress/cache/deps/_metadata.json

@@ -0,0 +1,40 @@
+{
+  "hash": "4a05af45",
+  "configHash": "7f7b0dad",
+  "lockfileHash": "8018888b",
+  "browserHash": "73d477e4",
+  "optimized": {
+    "vue": {
+      "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
+      "file": "vue.js",
+      "fileHash": "d22fde12",
+      "needsInterop": false
+    },
+    "vitepress > @vue/devtools-api": {
+      "src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
+      "file": "vitepress___@vue_devtools-api.js",
+      "fileHash": "5478d716",
+      "needsInterop": false
+    },
+    "vitepress > @vueuse/core": {
+      "src": "../../../../node_modules/@vueuse/core/index.mjs",
+      "file": "vitepress___@vueuse_core.js",
+      "fileHash": "23bf9c76",
+      "needsInterop": false
+    },
+    "@theme/index": {
+      "src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
+      "file": "@theme_index.js",
+      "fileHash": "07dcd573",
+      "needsInterop": false
+    }
+  },
+  "chunks": {
+    "chunk-E5DZZB2I": {
+      "file": "chunk-E5DZZB2I.js"
+    },
+    "chunk-574YRH25": {
+      "file": "chunk-574YRH25.js"
+    }
+  }
+}