docus 1.0.7 → 2.1.0

package/dist/runtime/app/components/prose/ProseH2.vue

@@ -0,0 +1,3 @@
+<template>
+  <h2><slot /></h2>
+</template>

package/dist/runtime/app/components/prose/ProseH3.vue

@@ -0,0 +1,3 @@
+<template>
+  <h3><slot /></h3>
+</template>

package/dist/runtime/app/components/prose/ProseH4.vue

@@ -0,0 +1,3 @@
+<template>
+  <h4><slot /></h4>
+</template>

package/dist/runtime/app/components/prose/ProseH5.vue

@@ -0,0 +1,3 @@
+<template>
+  <h5><slot /></h5>
+</template>

package/dist/runtime/app/components/prose/ProseH6.vue

@@ -0,0 +1,3 @@
+<template>
+  <h6><slot /></h6>
+</template>

package/dist/runtime/app/components/prose/ProseHr.vue

@@ -0,0 +1,3 @@
+<template>
+  <hr />
+</template>

package/dist/runtime/app/components/prose/ProseImg.vue

@@ -0,0 +1,32 @@
+<template>
+  <img :src="src" :alt="alt" :width="width" :height="height" />
+</template>
+
+<script>
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+module.exports = void 0;
+var _default = {
+  props: {
+    src: {
+      type: String,
+      default: ""
+    },
+    alt: {
+      type: String,
+      default: ""
+    },
+    width: {
+      type: [String, Number],
+      default: void 0
+    },
+    height: {
+      type: [String, Number],
+      default: void 0
+    }
+  }
+};
+module.exports = _default;</script>

package/dist/runtime/app/components/prose/ProseImg.vue.d.ts

@@ -0,0 +1,21 @@
+declare const _default: {
+    props: {
+        src: {
+            type: StringConstructor;
+            default: string;
+        };
+        alt: {
+            type: StringConstructor;
+            default: string;
+        };
+        width: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: any;
+        };
+        height: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: any;
+        };
+    };
+};
+export default _default;

package/dist/runtime/app/components/prose/ProseLi.vue

@@ -0,0 +1,3 @@
+<template>
+  <li><slot /></li>
+</template>

package/dist/runtime/app/components/prose/ProseOl.vue

@@ -0,0 +1,5 @@
+<template>
+  <ol>
+    <slot />
+  </ol>
+</template>

package/dist/runtime/app/components/prose/ProseParagraph.vue

@@ -0,0 +1,3 @@
+<template>
+  <p><slot /></p>
+</template>

package/dist/runtime/app/components/prose/ProseStrong.vue

@@ -0,0 +1,5 @@
+<template>
+  <strong>
+    <slot />
+  </strong>
+</template>

package/dist/runtime/app/components/prose/ProseTable.vue

@@ -0,0 +1,5 @@
+<template>
+  <table>
+    <slot />
+  </table>
+</template>

package/dist/runtime/app/components/prose/ProseTbody.vue

@@ -0,0 +1,5 @@
+<template>
+  <tbody>
+    <slot />
+  </tbody>
+</template>

package/dist/runtime/app/components/prose/ProseTd.vue

@@ -0,0 +1,5 @@
+<template>
+  <td>
+    <slot />
+  </td>
+</template>

package/dist/runtime/app/components/prose/ProseTh.vue

@@ -0,0 +1,5 @@
+<template>
+  <th>
+    <slot />
+  </th>
+</template>

package/dist/runtime/app/components/prose/ProseThead.vue

@@ -0,0 +1,5 @@
+<template>
+  <thead>
+    <slot />
+  </thead>
+</template>

package/dist/runtime/app/components/prose/ProseTr.vue

@@ -0,0 +1,5 @@
+<template>
+  <tr>
+    <slot />
+  </tr>
+</template>

package/dist/runtime/app/components/prose/ProseUl.vue

@@ -0,0 +1,5 @@
+<template>
+  <ul>
+    <slot />
+  </ul>
+</template>

package/dist/runtime/app/composables/helpers.d.ts

@@ -0,0 +1,4 @@
+import type { Context } from '@nuxt/types';
+export declare const clientAsyncData: ($nuxt: any) => void;
+export declare const detectPreview: (context: Context) => string | false;
+export declare const normalizePreviewScope: (scope: string) => string;

package/dist/runtime/app/composables/helpers.js

@@ -0,0 +1,66 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.normalizePreviewScope = exports.detectPreview = exports.clientAsyncData = void 0;
+
+var _vue = _interopRequireDefault(require("vue"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const clientAsyncData = $nuxt => {
+  if (process.client) {
+    const loadedComponents = new Set();
+
+    const loadComponents = function (components) {
+      if (!components) return;
+      return Array.from(components).map(async function (name) {
+        const component = _vue.default.component(name);
+
+        if (!loadedComponents.has(name) && typeof component === "function" && !component.options) {
+          loadedComponents.add(name);
+
+          try {
+            await _vue.default.component(name)();
+          } catch (e) {}
+        }
+      });
+    };
+
+    window.onNuxtReady(nuxt => {
+      $nuxt = nuxt;
+      const originalFetchPayload = $nuxt.fetchPayload;
+
+      if (originalFetchPayload) {
+        $nuxt.fetchPayload = async function (...args) {
+          const payload = await originalFetchPayload(...args);
+          loadComponents(new Set(payload.data[0]?.page?.template));
+          return payload;
+        };
+      }
+
+      loadComponents(new Set("NuxtContent"));
+    });
+  }
+};
+
+exports.clientAsyncData = clientAsyncData;
+
+const detectPreview = context => {
+  const {
+    route
+  } = context;
+
+  if (process.server && route.query._preview) {
+    return String(route.query._preview).replace(/\/$/, "");
+  }
+
+  return false;
+};
+
+exports.detectPreview = detectPreview;
+
+const normalizePreviewScope = scope => scope.replace("_preview/", "");
+
+exports.normalizePreviewScope = normalizePreviewScope;

package/dist/runtime/app/composables/helpers.mjs

@@ -0,0 +1,40 @@
+import Vue from "vue";
+export const clientAsyncData = ($nuxt) => {
+  if (process.client) {
+    const loadedComponents = new Set();
+    const loadComponents = function(components) {
+      if (!components)
+        return;
+      return Array.from(components).map(async function(name) {
+        const component = Vue.component(name);
+        if (!loadedComponents.has(name) && typeof component === "function" && !component.options) {
+          loadedComponents.add(name);
+          try {
+            await Vue.component(name)();
+          } catch (e) {
+          }
+        }
+      });
+    };
+    window.onNuxtReady((nuxt) => {
+      $nuxt = nuxt;
+      const originalFetchPayload = $nuxt.fetchPayload;
+      if (originalFetchPayload) {
+        $nuxt.fetchPayload = async function(...args) {
+          const payload = await originalFetchPayload(...args);
+          loadComponents(new Set(payload.data[0]?.page?.template));
+          return payload;
+        };
+      }
+      loadComponents(new Set("NuxtContent"));
+    });
+  }
+};
+export const detectPreview = (context) => {
+  const { route } = context;
+  if (process.server && route.query._preview) {
+    return String(route.query._preview).replace(/\/$/, "");
+  }
+  return false;
+};
+export const normalizePreviewScope = (scope) => scope.replace("_preview/", "");

package/dist/runtime/app/composables/index.d.ts

@@ -0,0 +1,90 @@
+import type { DefaultThemeConfig, DocusConfig } from 'types';
+export { useDocusStyles } from './style';
+export declare enum StateTypes {
+    Config = "docus-config",
+    Theme = "docus-theme",
+    Layout = "docus-layout",
+    CurrentPage = "docus-current-page",
+    Navigation = "docus-navigation",
+    CurrentNav = "docus-current-nav",
+    CurrentPath = "docus-current-path"
+}
+/**
+ * Create the $docus runtime injection instance.
+ */
+export declare const createDocus: (nuxtApp: NuxtAppCompat, _config: {
+    docusConfig: DocusConfig;
+    themeConfig: DefaultThemeConfig;
+}) => {
+    $docus: {
+        config: Ref<DocusConfig>;
+        content: any;
+        theme: Ref<DefaultThemeConfig>;
+        layout: Ref<DefaultThemeConfig>;
+        page: Ref<DocusDocument>;
+        navigation: {
+            state: Ref<DocusNavigationState>;
+            currentNav: Ref<DocusCurrentNav>;
+            currentPath: Ref<string>;
+            getPageTemplate: (page: DocusDocument) => string;
+            fetchNavigation: (locale?: string) => Promise<void>;
+            isLinkActive: (to: string) => boolean;
+            updateCurrentNav: () => void;
+            getPreviousAndNextLink: (page: DocusDocument) => Promise<any>;
+            get: (params: DocusNavigationGetParameters) => {
+                title: string;
+                to: string;
+                parent: any;
+                links: any;
+            };
+        };
+    };
+    init: () => Promise<void>;
+};
+/**
+ * Access the Docus runtime API.
+ */
+export declare const useDocus: () => {
+    content: DocusContent<any>;
+    config: Ref<DocusConfig>;
+    theme: Ref<DefaultThemeConfig>;
+    layout: Ref<DefaultThemeConfig>;
+    page: Ref<DocusDocument>;
+    navigation: {
+        state: Ref<DocusNavigationState>;
+        currentNav: Ref<DocusCurrentNav>;
+        currentPath: Ref<string>;
+        getPageTemplate: (page: DocusDocument) => string;
+        fetchNavigation: (locale?: string) => Promise<void>;
+        isLinkActive: (to: string) => boolean;
+        updateCurrentNav: () => void;
+        getPreviousAndNextLink: (page: DocusDocument) => Promise<any>;
+        get: (params: DocusNavigationGetParameters) => {
+            title: string;
+            to: string;
+            parent: any;
+            links: any;
+        };
+    };
+};
+/**
+ * Access the content querying functions.
+ */
+export declare const useDocusContent: () => any;
+/**
+ * Access the config object.
+ */
+export declare const useDocusConfig: () => Ref<DocusConfig>;
+/**
+ * Access the theme config object.
+ */
+export declare const useDocusTheme: () => Ref<DefaultThemeConfig>;
+/**
+ * Access the layout config object.
+ */
+export declare const useDocusLayout: () => Ref<DefaultThemeConfig>;
+/**
+ * Access the current page object.
+ */
+export declare const useDocusPage: () => Ref<DocusDocument>;
+export { useDocusNavigation } from './navigation';

package/dist/runtime/app/composables/index.js

@@ -0,0 +1,108 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useDocusLayout = exports.useDocusContent = exports.useDocusConfig = exports.useDocus = exports.createDocus = exports.StateTypes = void 0;
+Object.defineProperty(exports, "useDocusNavigation", {
+  enumerable: true,
+  get: function () {
+    return _navigation.useDocusNavigation;
+  }
+});
+exports.useDocusPage = void 0;
+Object.defineProperty(exports, "useDocusStyles", {
+  enumerable: true,
+  get: function () {
+    return _style.useDocusStyles;
+  }
+});
+exports.useDocusTheme = void 0;
+
+var _helpers = require("./helpers");
+
+var _navigation = require("./navigation");
+
+var _style = require("./style");
+
+var _app = require("#app");
+
+var StateTypes;
+exports.StateTypes = StateTypes;
+
+(function (StateTypes2) {
+  StateTypes2["Config"] = "docus-config";
+  StateTypes2["Theme"] = "docus-theme";
+  StateTypes2["Layout"] = "docus-layout";
+  StateTypes2["CurrentPage"] = "docus-current-page";
+  StateTypes2["Navigation"] = "docus-navigation";
+  StateTypes2["CurrentNav"] = "docus-current-nav";
+  StateTypes2["CurrentPath"] = "docus-current-path";
+})(StateTypes || (exports.StateTypes = StateTypes = {}));
+
+const createDocus = (nuxtApp, _config) => {
+  const $nuxt = nuxtApp.nuxt2Context.app;
+  const docusConfig = (0, _app.useState)(StateTypes.Config, () => ({ ..._config.docusConfig,
+    preview: (0, _helpers.detectPreview)($nuxt.context)
+  }));
+  if (docusConfig.value.preview) $nuxt.$content = $nuxt.$content.preview(docusConfig.value.preview);
+  const docusTheme = (0, _app.useState)(StateTypes.Theme, () => ({ ..._config.themeConfig
+  }));
+  const docusLayout = (0, _app.useState)(StateTypes.Layout, () => _config.themeConfig?.layout || {});
+  const docusCurrentPage = (0, _app.useState)(StateTypes.CurrentPage);
+  (0, _style.createDocusStyles)($nuxt.context);
+  (0, _helpers.clientAsyncData)($nuxt);
+  (0, _navigation.createDocusNavigation)($nuxt.context, docusConfig, $nuxt.$content);
+  const $docus = {
+    config: docusConfig,
+    content: $nuxt.$content,
+    theme: docusTheme,
+    layout: docusLayout,
+    page: docusCurrentPage,
+    navigation: (0, _navigation.useDocusNavigation)()
+  };
+  return {
+    $docus,
+    init: async () => {
+      await $docus.navigation.fetchNavigation();
+      $docus.navigation.updateCurrentNav();
+    }
+  };
+};
+
+exports.createDocus = createDocus;
+
+const useDocus = () => ({
+  content: (0, _app.useNuxtApp)().vue2App.$content,
+  config: (0, _app.useState)(StateTypes.Config),
+  theme: (0, _app.useState)(StateTypes.Theme),
+  layout: (0, _app.useState)(StateTypes.Layout),
+  page: (0, _app.useState)(StateTypes.CurrentPage),
+  navigation: (0, _navigation.useDocusNavigation)()
+});
+
+exports.useDocus = useDocus;
+
+const useDocusContent = () => {
+  const $content = (0, _app.useNuxtApp)().vue2App.$content;
+  const preview = (0, _app.useState)(StateTypes.Config).value.preview || false;
+  return preview ? $content.preview((0, _helpers.normalizePreviewScope)(preview)) : $content;
+};
+
+exports.useDocusContent = useDocusContent;
+
+const useDocusConfig = () => (0, _app.useState)(StateTypes.Config);
+
+exports.useDocusConfig = useDocusConfig;
+
+const useDocusTheme = () => (0, _app.useState)(StateTypes.Theme);
+
+exports.useDocusTheme = useDocusTheme;
+
+const useDocusLayout = () => (0, _app.useState)(StateTypes.Layout);
+
+exports.useDocusLayout = useDocusLayout;
+
+const useDocusPage = () => (0, _app.useState)(StateTypes.CurrentPage);
+
+exports.useDocusPage = useDocusPage;

package/dist/runtime/app/composables/index.mjs

@@ -0,0 +1,63 @@
+import { clientAsyncData, detectPreview, normalizePreviewScope } from "./helpers.mjs";
+import { createDocusNavigation, useDocusNavigation } from "./navigation.mjs";
+import { createDocusStyles } from "./style.mjs";
+import { useNuxtApp, useState } from "#app";
+export { useDocusStyles } from "./style.mjs";
+export var StateTypes;
+(function(StateTypes2) {
+  StateTypes2["Config"] = "docus-config";
+  StateTypes2["Theme"] = "docus-theme";
+  StateTypes2["Layout"] = "docus-layout";
+  StateTypes2["CurrentPage"] = "docus-current-page";
+  StateTypes2["Navigation"] = "docus-navigation";
+  StateTypes2["CurrentNav"] = "docus-current-nav";
+  StateTypes2["CurrentPath"] = "docus-current-path";
+})(StateTypes || (StateTypes = {}));
+export const createDocus = (nuxtApp, _config) => {
+  const $nuxt = nuxtApp.nuxt2Context.app;
+  const docusConfig = useState(StateTypes.Config, () => ({
+    ..._config.docusConfig,
+    preview: detectPreview($nuxt.context)
+  }));
+  if (docusConfig.value.preview)
+    $nuxt.$content = $nuxt.$content.preview(docusConfig.value.preview);
+  const docusTheme = useState(StateTypes.Theme, () => ({ ..._config.themeConfig }));
+  const docusLayout = useState(StateTypes.Layout, () => _config.themeConfig?.layout || {});
+  const docusCurrentPage = useState(StateTypes.CurrentPage);
+  createDocusStyles($nuxt.context);
+  clientAsyncData($nuxt);
+  createDocusNavigation($nuxt.context, docusConfig, $nuxt.$content);
+  const $docus = {
+    config: docusConfig,
+    content: $nuxt.$content,
+    theme: docusTheme,
+    layout: docusLayout,
+    page: docusCurrentPage,
+    navigation: useDocusNavigation()
+  };
+  return {
+    $docus,
+    init: async () => {
+      await $docus.navigation.fetchNavigation();
+      $docus.navigation.updateCurrentNav();
+    }
+  };
+};
+export const useDocus = () => ({
+  content: useNuxtApp().vue2App.$content,
+  config: useState(StateTypes.Config),
+  theme: useState(StateTypes.Theme),
+  layout: useState(StateTypes.Layout),
+  page: useState(StateTypes.CurrentPage),
+  navigation: useDocusNavigation()
+});
+export const useDocusContent = () => {
+  const $content = useNuxtApp().vue2App.$content;
+  const preview = useState(StateTypes.Config).value.preview || false;
+  return preview ? $content.preview(normalizePreviewScope(preview)) : $content;
+};
+export const useDocusConfig = () => useState(StateTypes.Config);
+export const useDocusTheme = () => useState(StateTypes.Theme);
+export const useDocusLayout = () => useState(StateTypes.Layout);
+export const useDocusPage = () => useState(StateTypes.CurrentPage);
+export { useDocusNavigation } from "./navigation.mjs";

package/dist/runtime/app/composables/navigation.d.ts

@@ -0,0 +1,37 @@
+import { Context } from '@nuxt/types';
+import type { NavItem } from 'types';
+/**
+ * Handling all the navigation querying logic.
+ */
+export declare const createDocusNavigation: (context: Context, config: Ref<DocusConfig>, content: DocusContent<any>) => void;
+/**
+ * Access the navigation state and helpers.
+ */
+export declare const useDocusNavigation: () => {
+    state: Ref<DocusNavigationState>;
+    currentNav: Ref<DocusCurrentNav>;
+    currentPath: Ref<string>;
+    getPageTemplate: (page: DocusDocument) => string;
+    fetchNavigation: (locale?: string) => Promise<void>;
+    isLinkActive: (to: string) => boolean;
+    updateCurrentNav: () => void;
+    getPreviousAndNextLink: (page: DocusDocument) => Promise<any>;
+    get: (params: DocusNavigationGetParameters) => {
+        title: string | undefined;
+        to: string | undefined;
+        parent: NavItem | undefined;
+        links: any;
+    };
+};
+/**
+ * Access the navigation state.
+ */
+export declare const useDocusNavigationState: () => Ref<DocusNavigationState>;
+/**
+ * Access the current navigation.
+ */
+export declare const useDocusCurrentNav: () => Ref<DocusCurrentNav>;
+/**
+ * Access the current path.
+ */
+export declare const useDocusCurrentPath: () => Ref<string>;