vue3-sphinx-xml 0.1.0-beta.0

package/dist/entry.js

@@ -0,0 +1,707 @@
+import Vue3Katex from "@hsorby/vue3-katex";
+import "katex/dist/katex.min.css";
+import { openBlock, createElementBlock, createElementVNode, toDisplayString, pushScopeId, popScopeId, computed, defineAsyncComponent, toRefs, unref, Fragment, renderList, createBlock, resolveDynamicComponent, ref, watch } from "vue";
+import { useRouter, useRoute } from "vue-router";
+import { useStore } from "vuex";
+import { pathToRegexp } from "path-to-regexp";
+import axios from "axios";
+const decodeHTML = (encoded) => {
+  let elem = document.createElement("textarea");
+  elem.innerHTML = encoded;
+  return elem.value;
+};
+const determineRouteUrl = (route) => {
+  const regex = pathToRegexp(route.matched[0].path);
+  let fullPath = route.fullPath;
+  if (route.hash) {
+    fullPath = fullPath.replace(route.hash, "");
+  }
+  const matched = fullPath.match(regex);
+  let base = matched[0];
+  if (matched[matched.length - 1]) {
+    base = matched[0].replace(`/${matched[matched.length - 1]}`, "");
+  }
+  return base;
+};
+const constructPageNameFromRoute = (route) => {
+  let pageName = void 0;
+  try {
+    pageName = route.params.pageName.join("/");
+  } catch (_) {
+    pageName = route.params.pageName;
+  }
+  return pageName;
+};
+const _hoisted_1$2 = /* @__PURE__ */ createElementVNode("span", null, "It seems the component was not found.", -1);
+const _sfc_main$3 = {
+  props: {
+    node: {
+      type: void 0
+    },
+    componentName: {
+      type: String
+    }
+  },
+  setup(__props) {
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock("div", null, [
+        createElementVNode("h3", null, "Missing: '" + toDisplayString(__props.componentName) + "' from Sphinx XML output", 1),
+        _hoisted_1$2
+      ]);
+    };
+  }
+};
+var Loading_vue_vue_type_style_index_0_scoped_true_lang = "";
+var _export_sfc = (sfc, props) => {
+  const target = sfc.__vccOpts || sfc;
+  for (const [key, val] of props) {
+    target[key] = val;
+  }
+  return target;
+};
+const _withScopeId = (n) => (pushScopeId("data-v-97cc632a"), n = n(), popScopeId(), n);
+const _hoisted_1$1 = { class: "loading-container" };
+const _hoisted_2 = /* @__PURE__ */ _withScopeId(() => /* @__PURE__ */ createElementVNode("span", null, "Loading page component", -1));
+const _hoisted_3 = /* @__PURE__ */ _withScopeId(() => /* @__PURE__ */ createElementVNode("span", { class: "lds-roller" }, [
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div"),
+  /* @__PURE__ */ createElementVNode("div")
+], -1));
+const _hoisted_4 = [
+  _hoisted_2,
+  _hoisted_3
+];
+const _sfc_main$2 = {
+  props: {
+    node: {
+      type: void 0
+    },
+    componentName: {
+      type: String
+    }
+  },
+  setup(__props) {
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock("div", _hoisted_1$1, _hoisted_4);
+    };
+  }
+};
+var LoadingComponent = /* @__PURE__ */ _export_sfc(_sfc_main$2, [["__scopeId", "data-v-97cc632a"]]);
+const nodeNameTagNameMap = /* @__PURE__ */ new Map([
+  ["bullet_list", "ul"],
+  ["button", "button"],
+  ["definition", "dd"],
+  ["definition_list", "dl"],
+  ["definition_list_item", "dt"],
+  ["div", "div"],
+  ["emphasis", "em"],
+  ["enumerated_list", "ol"],
+  ["glossary", "div"],
+  ["inline", "span"],
+  ["label", "span"],
+  ["list_item", "li"],
+  ["line", "p"],
+  ["paragraph", "p"],
+  ["rubric", "h3"],
+  ["strong", "strong"],
+  ["subscript", "sub"],
+  ["superscript", "sup"],
+  ["table", "table"],
+  ["tbody", "tbody"],
+  ["entry", "td"],
+  ["row", "tr"],
+  ["thead", "thead"],
+  ["term", "dt"],
+  ["title_reference", "cite"]
+]);
+const nodeNameTemplateNameMap = /* @__PURE__ */ new Map([
+  ["#text", "Text"],
+  ["block_quote", "BlockQuote"],
+  ["caption", "FigureCaption"],
+  ["caption_number", "CaptionNumber"],
+  ["download_reference", "DownloadReference"],
+  ["footnote_reference", "FootnoteReference"],
+  ["line_block", "LineBlock"],
+  ["literal_block", "LiteralBlock"],
+  ["math_block", "MathBlock"],
+  ["number_reference", "NumberReference"]
+]);
+function __variableDynamicImportRuntime1__(path) {
+  switch (path) {
+    case "../components/templates/BlockQuote.vue":
+      return import("./BlockQuote.js");
+    case "../components/templates/CaptionNumber.vue":
+      return import("./CaptionNumber.js");
+    case "../components/templates/ColumnGroup.vue":
+      return import("./ColumnGroup.js");
+    case "../components/templates/Comment.vue":
+      return import("./Comment.js");
+    case "../components/templates/Compound.vue":
+      return import("./Compound.js");
+    case "../components/templates/Container.vue":
+      return import("./Container.js");
+    case "../components/templates/DirectElementMap.vue":
+      return import("./DirectElementMap.js");
+    case "../components/templates/Document.vue":
+      return Promise.resolve().then(function() {
+        return Document;
+      });
+    case "../components/templates/DownloadReference.vue":
+      return import("./DownloadReference.js");
+    case "../components/templates/Figure.vue":
+      return import("./Figure.js");
+    case "../components/templates/FigureCaption.vue":
+      return import("./FigureCaption.js");
+    case "../components/templates/Footnote.vue":
+      return import("./Footnote.js");
+    case "../components/templates/FootnoteReference.vue":
+      return import("./FootnoteReference.js");
+    case "../components/templates/Image.vue":
+      return import("./Image.js");
+    case "../components/templates/Legend.vue":
+      return import("./Legend.js");
+    case "../components/templates/LineBlock.vue":
+      return import("./LineBlock.js");
+    case "../components/templates/LineSingle.vue":
+      return import("./LineSingle.js");
+    case "../components/templates/Literal.vue":
+      return import("./Literal.js");
+    case "../components/templates/LiteralBlock.vue":
+      return import("./LiteralBlock.js");
+    case "../components/templates/Math.vue":
+      return import("./Math.js");
+    case "../components/templates/MathBlock.vue":
+      return import("./MathBlock.js");
+    case "../components/templates/Note.vue":
+      return import("./Note.js");
+    case "../components/templates/NumberReference.vue":
+      return import("./NumberReference.js");
+    case "../components/templates/Problematic.vue":
+      return import("./Problematic.js");
+    case "../components/templates/Raw.vue":
+      return import("./Raw.js");
+    case "../components/templates/Reference.vue":
+      return import("./Reference.js");
+    case "../components/templates/Section.vue":
+      return import("./Section.js");
+    case "../components/templates/StandardElement.vue":
+      return import("./StandardElement.js");
+    case "../components/templates/Text.vue":
+      return import("./Text.js");
+    case "../components/templates/Title.vue":
+      return import("./Title.js");
+    case "../components/templates/TodoNode.vue":
+      return import("./TodoNode.js");
+    case "../components/templates/Topic.vue":
+      return import("./Topic.js");
+    case "../components/templates/Transition.vue":
+      return import("./Transition.js");
+    default:
+      return new Promise(function(resolve, reject) {
+        (typeof queueMicrotask === "function" ? queueMicrotask : setTimeout)(reject.bind(null, new Error("Unknown variable dynamic import: " + path)));
+      });
+  }
+}
+function __variableDynamicImportRuntime0__(path) {
+  switch (path) {
+    case "../components/templates/BlockQuote.vue":
+      return import("./BlockQuote.js");
+    case "../components/templates/CaptionNumber.vue":
+      return import("./CaptionNumber.js");
+    case "../components/templates/ColumnGroup.vue":
+      return import("./ColumnGroup.js");
+    case "../components/templates/Comment.vue":
+      return import("./Comment.js");
+    case "../components/templates/Compound.vue":
+      return import("./Compound.js");
+    case "../components/templates/Container.vue":
+      return import("./Container.js");
+    case "../components/templates/DirectElementMap.vue":
+      return import("./DirectElementMap.js");
+    case "../components/templates/Document.vue":
+      return Promise.resolve().then(function() {
+        return Document;
+      });
+    case "../components/templates/DownloadReference.vue":
+      return import("./DownloadReference.js");
+    case "../components/templates/Figure.vue":
+      return import("./Figure.js");
+    case "../components/templates/FigureCaption.vue":
+      return import("./FigureCaption.js");
+    case "../components/templates/Footnote.vue":
+      return import("./Footnote.js");
+    case "../components/templates/FootnoteReference.vue":
+      return import("./FootnoteReference.js");
+    case "../components/templates/Image.vue":
+      return import("./Image.js");
+    case "../components/templates/Legend.vue":
+      return import("./Legend.js");
+    case "../components/templates/LineBlock.vue":
+      return import("./LineBlock.js");
+    case "../components/templates/LineSingle.vue":
+      return import("./LineSingle.js");
+    case "../components/templates/Literal.vue":
+      return import("./Literal.js");
+    case "../components/templates/LiteralBlock.vue":
+      return import("./LiteralBlock.js");
+    case "../components/templates/Math.vue":
+      return import("./Math.js");
+    case "../components/templates/MathBlock.vue":
+      return import("./MathBlock.js");
+    case "../components/templates/Note.vue":
+      return import("./Note.js");
+    case "../components/templates/NumberReference.vue":
+      return import("./NumberReference.js");
+    case "../components/templates/Problematic.vue":
+      return import("./Problematic.js");
+    case "../components/templates/Raw.vue":
+      return import("./Raw.js");
+    case "../components/templates/Reference.vue":
+      return import("./Reference.js");
+    case "../components/templates/Section.vue":
+      return import("./Section.js");
+    case "../components/templates/StandardElement.vue":
+      return import("./StandardElement.js");
+    case "../components/templates/Text.vue":
+      return import("./Text.js");
+    case "../components/templates/Title.vue":
+      return import("./Title.js");
+    case "../components/templates/TodoNode.vue":
+      return import("./TodoNode.js");
+    case "../components/templates/Topic.vue":
+      return import("./Topic.js");
+    case "../components/templates/Transition.vue":
+      return import("./Transition.js");
+    default:
+      return new Promise(function(resolve, reject) {
+        (typeof queueMicrotask === "function" ? queueMicrotask : setTimeout)(reject.bind(null, new Error("Unknown variable dynamic import: " + path)));
+      });
+  }
+}
+function defineChildComponent(name, node) {
+  let properties = void 0;
+  if (node.nodeName === "#text") {
+    if (!node.nodeValue.trim()) {
+      return null;
+    }
+    properties = {
+      text: node.nodeValue
+    };
+  } else if (node.nodeName === "title") {
+    let parentNode = node.parentNode;
+    let depth = 0;
+    let isTopic = false;
+    if (parentNode.nodeName === "topic") {
+      isTopic = true;
+    } else {
+      while (parentNode) {
+        if (parentNode.nodeName === "section") {
+          depth += 1;
+        }
+        parentNode = parentNode.parentNode;
+      }
+    }
+    properties = {
+      depth,
+      isTopic
+    };
+  }
+  const component = defineAsyncComponent({
+    loader: () => {
+      return __variableDynamicImportRuntime0__(`../components/templates/${name}.vue`);
+    },
+    loadingComponent: LoadingComponent,
+    errorComponent: _sfc_main$3
+  });
+  return {
+    component,
+    name,
+    node,
+    properties
+  };
+}
+function defineColgroupComponent(node, colspecs) {
+  const name = "ColumnGroup";
+  const component = defineAsyncComponent({
+    loader: () => {
+      return __variableDynamicImportRuntime1__(`../components/templates/${name}.vue`);
+    },
+    loadingComponent: LoadingComponent,
+    errorComponent: _sfc_main$3
+  });
+  const properties = {
+    colspecs
+  };
+  return {
+    component,
+    name,
+    node,
+    properties
+  };
+}
+function mapToComponentName(name) {
+  let componentName = name.charAt(0).toUpperCase() + name.slice(1);
+  if (nodeNameTemplateNameMap.has(name)) {
+    componentName = nodeNameTemplateNameMap.get(name);
+  } else if (nodeNameTagNameMap.has(name)) {
+    componentName = "StandardElement";
+  }
+  return componentName;
+}
+function addTGroup(components, node, columns) {
+  if (node === null) {
+    return components;
+  }
+  let colspecs = [];
+  for (const colspec of node.querySelectorAll("colspec")) {
+    colspecs.push(colspec.getAttribute("colwidth"));
+  }
+  if (colspecs.length !== columns) {
+    console.log("Something is not right.");
+  }
+  components.push(defineColgroupComponent(node, colspecs));
+  return components;
+}
+function addComponents(components, node) {
+  if (node === null) {
+    return components;
+  }
+  let childTarget = null;
+  for (const child of node.childNodes) {
+    const childName = child.nodeName;
+    if (childName === "compact_paragraph") {
+      components = addComponents(components, child);
+    } else if (childName === "tgroup") {
+      const columnCount = Number(child.getAttribute("cols"));
+      components = addTGroup(components, child, columnCount);
+      components = addComponents(components, child);
+    } else if (childName === "colspec")
+      ;
+    else {
+      if (childName === "target") {
+        childTarget = child.getAttribute("refid");
+      } else {
+        if (childName !== "#text" && childTarget) {
+          child.setAttribute("id", childTarget);
+          childTarget = "";
+        }
+        const componentName = mapToComponentName(childName);
+        const item = defineChildComponent(componentName, child);
+        if (item) {
+          components.push(item);
+        }
+      }
+    }
+  }
+  return components;
+}
+function useChildren(element) {
+  const children = computed(() => {
+    return addComponents([], element.value);
+  });
+  return {
+    children
+  };
+}
+function useClasses(element) {
+  const classes = computed(() => {
+    let classesString = element.value.getAttribute("classes");
+    let classes2 = [];
+    if (classesString) {
+      classes2 = classesString.split(" ");
+    }
+    return [element.value.nodeName.toLowerCase(), ...classes2];
+  });
+  return {
+    classes
+  };
+}
+const _hoisted_1 = ["id"];
+const _sfc_main$1 = {
+  props: {
+    element: {
+      type: void 0,
+      default: { empty: true }
+    },
+    id: {
+      type: String,
+      default: ""
+    }
+  },
+  setup(__props) {
+    const props = __props;
+    const { element, id } = toRefs(props);
+    const { children } = useChildren(element);
+    return (_ctx, _cache) => {
+      return openBlock(), createElementBlock("div", { id: unref(id) }, [
+        (openBlock(true), createElementBlock(Fragment, null, renderList(unref(children), (c, index) => {
+          return openBlock(), createBlock(resolveDynamicComponent(c.component), {
+            key: "document_component_" + index,
+            node: c.node,
+            componentName: c.name,
+            properties: c.properties
+          }, null, 8, ["node", "componentName", "properties"]);
+        }), 128))
+      ], 8, _hoisted_1);
+    };
+  }
+};
+var Document = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  "default": _sfc_main$1
+}, Symbol.toStringTag, { value: "Module" }));
+const _sfc_main = {
+  props: {
+    baseURL: {
+      type: String,
+      default: "/"
+    },
+    downloadBaseURL: {
+      type: String,
+      default: ""
+    },
+    imagesBaseURL: {
+      type: String,
+      default: ""
+    },
+    indexFileName: {
+      type: String,
+      default: "index"
+    },
+    pageNotFoundName: {
+      type: String,
+      default: "404"
+    },
+    scrollDelay: {
+      type: Number,
+      default: 200
+    }
+  },
+  setup(__props) {
+    const props = __props;
+    const {
+      baseURL,
+      downloadBaseURL,
+      imagesBaseURL,
+      indexFileName,
+      pageNotFoundName,
+      scrollDelay
+    } = toRefs(props);
+    const router = useRouter();
+    const route = useRoute();
+    const store = useStore();
+    let element = ref(null);
+    let scrollToTarget = ref(void 0);
+    let id = ref("");
+    let previousRoute = {
+      path: void 0,
+      hash: void 0
+    };
+    function followScrollTarget(elem) {
+      setTimeout(() => {
+        scrollToTarget.value = elem.offsetTop;
+        window.scrollTo({
+          top: elem.offsetTop,
+          behavior: "smooth"
+        });
+        setTimeout(() => {
+          if (scrollToTarget.value !== elem.offsetTop) {
+            followScrollTarget(elem);
+          }
+        }, 10);
+      }, scrollDelay.value);
+    }
+    watch(route, (to) => {
+      if (previousRoute.path === void 0 || to.path !== previousRoute.path) {
+        fetchPageData(to);
+        if (to.hash) {
+          setTimeout(() => {
+            let hash = to.hash;
+            if (hash.startsWith("#")) {
+              hash = hash.slice(1);
+            }
+            const elem = document.getElementById(hash);
+            if (elem) {
+              followScrollTarget(elem);
+            }
+          }, scrollDelay.value);
+        }
+      } else if (to.path === previousRoute.path && to.hash) {
+        let hash = to.hash;
+        if (hash.startsWith("#")) {
+          hash = hash.slice(1);
+        }
+        const elem = document.getElementById(hash);
+        if (elem) {
+          window.scrollTo({
+            top: elem.offsetTop,
+            behavior: "smooth"
+          });
+        }
+      }
+      previousRoute.path = to.path;
+      previousRoute.hash = to.hash;
+    }, { flush: "pre", immediate: true, deep: true });
+    function fetchPageData(routeTo) {
+      let pageName = constructPageNameFromRoute(routeTo);
+      if (!pageName) {
+        pageName = indexFileName.value;
+      }
+      const resolvedImagesBaseURL = imagesBaseURL.value === "" ? `${baseURL.value}/_images` : imagesBaseURL.value;
+      const resolvedDownloadBaseURL = downloadBaseURL.value === "" ? `${baseURL.value}/_downloads` : downloadBaseURL.value;
+      const routeURL = determineRouteUrl(routeTo);
+      store.dispatch("sphinx/fetchPage", {
+        page_name: pageName,
+        page_route: routeURL,
+        page_url: baseURL.value,
+        page_downloads: resolvedDownloadBaseURL,
+        page_images: resolvedImagesBaseURL
+      }).then((response) => {
+        if (response) {
+          element.value = response;
+          id.value = "page_" + pageName.replace("/", "_");
+        } else {
+          router.push({
+            name: pageNotFoundName.value,
+            params: {
+              type: "page",
+              message: `Could not find Sphinx page '${pageName}.xml'.`
+            }
+          });
+        }
+      });
+    }
+    return (_ctx, _cache) => {
+      return openBlock(), createBlock(_sfc_main$1, {
+        element: unref(element),
+        id: unref(id)
+      }, null, 8, ["element", "id"]);
+    };
+  }
+};
+const apiClient = axios.create({
+  withCredentials: false,
+  headers: {
+    Accept: "text/xml",
+    "Content-Type": "text/xml"
+  },
+  timeout: 1e4
+});
+var SphinxService = {
+  getPage(baseURL, page) {
+    return apiClient.get(`${baseURL}/${page}.xml`);
+  }
+};
+const namespaced = true;
+const state = {
+  pages: /* @__PURE__ */ new Map(),
+  urlMap: /* @__PURE__ */ new Map(),
+  inflight: /* @__PURE__ */ new Map(),
+  downloadURLs: /* @__PURE__ */ new Map(),
+  imagesURLs: /* @__PURE__ */ new Map()
+};
+const mutations = {
+  APPEND_PAGE(state2, { routeURL, page }) {
+    let pages = state2.pages.get(routeURL);
+    if (!pages) {
+      pages = [];
+    }
+    pages.push(page);
+    state2.pages.set(routeURL, pages);
+  },
+  ADD_INFLIGHT(state2, { routeURL, page_name, pending }) {
+    let inflightMap = state2.inflight.get(routeURL);
+    if (!inflightMap) {
+      inflightMap = /* @__PURE__ */ new Map();
+    }
+    inflightMap.set(page_name, pending);
+    state2.inflight.set(routeURL, inflightMap);
+  },
+  REMOVE_INFLIGHT(state2, { routeURL, id }) {
+    state2.inflight.get(routeURL).delete(id);
+  },
+  REGISTER_ROUTE_URL(state2, { baseURL, routeURL, downloadsURL, imagesURL }) {
+    const registeredURL = state2.pages.get(routeURL);
+    if (!registeredURL) {
+      state2.pages.set(routeURL, []);
+      state2.urlMap.set(routeURL, baseURL);
+      state2.downloadURLs.set(routeURL, downloadsURL);
+      state2.imagesURLs.set(routeURL, imagesURL);
+      state2.inflight.set(routeURL, /* @__PURE__ */ new Map());
+    }
+  }
+};
+const actions = {
+  fetchPage({ commit, getters: getters2 }, payload) {
+    const page_name = payload.page_name;
+    const page_route = payload.page_route;
+    const base_url = payload.page_url;
+    commit("REGISTER_ROUTE_URL", {
+      baseURL: base_url,
+      routeURL: page_route,
+      downloadsURL: payload.page_downloads,
+      imagesURL: payload.page_images
+    });
+    const existingPage = getters2.getPageById(page_route, page_name);
+    if (existingPage) {
+      return Promise.resolve(existingPage);
+    }
+    if (getters2.isInflight(page_route, page_name)) {
+      return getters2.getInflight(page_route, page_name);
+    }
+    const pending = SphinxService.getPage(base_url, page_name).then((response) => {
+      let parser = new DOMParser();
+      let xmlDoc = parser.parseFromString(response.data, "text/xml");
+      const documentElement = xmlDoc.querySelector("document");
+      commit("APPEND_PAGE", { routeURL: page_route, page: documentElement });
+      commit("REMOVE_INFLIGHT", { routeURL: page_route, id: page_name });
+      return documentElement;
+    }).catch(() => {
+      commit("REMOVE_INFLIGHT", { routeURL: page_route, id: page_name });
+    });
+    commit("ADD_INFLIGHT", { routeURL: page_route, page_name, pending });
+    return pending;
+  }
+};
+const getters = {
+  getPageById: (state2) => (routeURL, id) => {
+    return state2.pages.get(routeURL).find((page) => page.id === id);
+  },
+  getInflight: (state2) => (routeURL, id) => {
+    return state2.inflight.get(routeURL).get(id);
+  },
+  isInflight: (state2) => (routeURL, id) => {
+    return !!state2.inflight.get(routeURL).get(id);
+  },
+  getBaseUrl: (state2) => (routeURL) => {
+    return state2.urlMap.get(routeURL);
+  },
+  getDownloadURL: (state2) => (routeURL) => {
+    return state2.downloadURLs.get(routeURL);
+  },
+  getImagesURL: (state2) => (routeURL) => {
+    return state2.imagesURLs.get(routeURL);
+  }
+};
+var SphinxStore = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null,
+  namespaced,
+  state,
+  mutations,
+  actions,
+  getters
+}, Symbol.toStringTag, { value: "Module" }));
+function installVue3SphinxXml(app, options = {}) {
+  if (!options.store) {
+    throw "Please provide a store!!";
+  }
+  options.store.registerModule("sphinx", SphinxStore);
+  app.use(Vue3Katex, options.katex);
+}
+export { _export_sfc as _, useClasses as a, decodeHTML as b, constructPageNameFromRoute as c, determineRouteUrl as d, _sfc_main as e, installVue3SphinxXml as i, nodeNameTagNameMap as n, useChildren as u };
+//# sourceMappingURL=entry.js.map