docus 1.0.4 → 2.1.0

package/dist/runtime/transformers/json.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+module.exports = transformJSON;
+
+function transformJSON(_id, input) {
+  if (typeof input === "string") return {
+    body: JSON.parse(input)
+  };
+  return {
+    body: input
+  };
+}

package/dist/runtime/transformers/json.mjs

@@ -0,0 +1,5 @@
+export default function transformJSON(_id, input) {
+  if (typeof input === "string")
+    return { body: JSON.parse(input) };
+  return { body: input };
+}

package/dist/runtime/transformers/markdown/index.d.ts

@@ -0,0 +1,8 @@
+export default function transformMarkdown(id: string, input: string): Promise<{
+    body: {
+        raw: string;
+        ast: import("@docus/mdc").MDCRoot;
+        toc: import("@docus/mdc").Toc;
+    };
+    meta: any;
+}>;

package/dist/runtime/transformers/markdown/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+module.exports = transformMarkdown;
+
+var _mdc = require("@docus/mdc");
+
+var _context = require("../../context");
+
+var _utils = require("../utils");
+
+async function transformMarkdown(id, input) {
+  const context = (0, _context.useDocusContext)();
+  const result = await (0, _mdc.parse)(input, context.transformers.markdown);
+  const pathMeta = (0, _utils.getPathMeta)(id, {
+    locales: context.locales.codes,
+    defaultLocale: context.locales.defaultLocale
+  });
+  result.meta = { ...pathMeta,
+    ...result.meta
+  };
+  return result;
+}

package/dist/runtime/transformers/markdown/index.mjs

@@ -0,0 +1,16 @@
+import { parse } from "@docus/mdc";
+import { useDocusContext } from "../../context.mjs";
+import { getPathMeta } from "../utils/index.mjs";
+export default async function transformMarkdown(id, input) {
+  const context = useDocusContext();
+  const result = await parse(input, context.transformers.markdown);
+  const pathMeta = getPathMeta(id, {
+    locales: context.locales.codes,
+    defaultLocale: context.locales.defaultLocale
+  });
+  result.meta = {
+    ...pathMeta,
+    ...result.meta
+  };
+  return result;
+}

package/dist/runtime/transformers/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './path';

package/dist/runtime/transformers/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _path = require("./path");
+
+Object.keys(_path).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _path[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _path[key];
+    }
+  });
+});

package/dist/runtime/transformers/utils/index.mjs

@@ -0,0 +1 @@
+export * from "./path.mjs";

package/dist/runtime/transformers/utils/path.d.ts

@@ -0,0 +1,26 @@
+export declare function generatePosition(path: string): string;
+/**
+ * Clean up special keywords from path part
+ */
+export declare function generateSlug(name: string): string;
+export declare function generateTitleFromSlug(slug: string): string;
+export declare function generateTo(path: string): string;
+export declare function isDraft(path: string): boolean;
+/**
+ * Files or directories that starts with underscore `_` will mark as hidden
+ * @param path content path
+ * @returns true if the is part in the path that starts with `_`
+ */
+export declare function isHidden(path: string): boolean;
+export declare function getPathMeta(id: string, { locales, defaultLocale }?: {
+    locales?: string[];
+    defaultLocale?: string;
+}): {
+    slug: string;
+    title: string;
+    position: string;
+    to: string;
+    draft: boolean;
+    page: boolean;
+    language: string;
+};

package/dist/runtime/transformers/utils/path.js

@@ -0,0 +1,88 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generatePosition = generatePosition;
+exports.generateSlug = generateSlug;
+exports.generateTitleFromSlug = generateTitleFromSlug;
+exports.generateTo = generateTo;
+exports.getPathMeta = getPathMeta;
+exports.isDraft = isDraft;
+exports.isHidden = isHidden;
+
+var _scule = require("scule");
+
+var _ufo = require("ufo");
+
+const SEMVER_REGEX = /^(\d+)(\.\d+)*(\.x)?$/;
+
+function generatePosition(path) {
+  const position = path.split(/[/:]/).filter(Boolean).map(part => {
+    const match = part.match(/^(\d+)\./);
+
+    if (match) {
+      return padLeft(match[1], 4);
+    }
+
+    return "9999";
+  }).join("");
+  return padRight(position, 12);
+}
+
+function generateSlug(name) {
+  if (SEMVER_REGEX.test(name)) {
+    return name;
+  }
+
+  return name.replace(/^_/, "").replace(/(\d+\.)?(.*)/, "$2").replace(/^index/, "").replace(/\.draft/, "");
+}
+
+function generateTitleFromSlug(slug) {
+  return slug.split(/[\s-]/g).map(_scule.pascalCase).join(" ");
+}
+
+function generateTo(path) {
+  return (0, _ufo.withLeadingSlash)((0, _ufo.withoutTrailingSlash)(path.split("/").map(generateSlug).join("/")));
+}
+
+function isDraft(path) {
+  return !!path.match(/\.draft(\/|\.|$)/);
+}
+
+function isHidden(path) {
+  return path.split("/").some(part => part.match(/^_.*/));
+}
+
+function padLeft(value, length) {
+  return ("0".repeat(length) + value).substr(String(value).length);
+}
+
+function padRight(value, length) {
+  return (value + "0".repeat(length)).substr(0, length);
+}
+
+function getPathMeta(id, {
+  locales = ["en"],
+  defaultLocale = "en"
+} = {}) {
+  const regexp = new RegExp(`^/?(${locales.join("|")})`, "gi");
+  const paths = id.split(".").slice(0, -1).join(".").split(/:/g).slice(1);
+  let path = paths.join("/");
+  const [language] = path.match(regexp) || [];
+
+  if (language) {
+    path = path.replace(regexp, "");
+  }
+
+  const slug = generateSlug(paths[paths.length - 1]);
+  return {
+    slug,
+    title: generateTitleFromSlug(slug),
+    position: generatePosition(path),
+    to: generateTo(path),
+    draft: isDraft(path),
+    page: !isHidden(path),
+    language: language || defaultLocale
+  };
+}

package/dist/runtime/transformers/utils/path.mjs

@@ -0,0 +1,56 @@
+import { pascalCase } from "scule";
+import { withoutTrailingSlash, withLeadingSlash } from "ufo";
+const SEMVER_REGEX = /^(\d+)(\.\d+)*(\.x)?$/;
+export function generatePosition(path) {
+  const position = path.split(/[/:]/).filter(Boolean).map((part) => {
+    const match = part.match(/^(\d+)\./);
+    if (match) {
+      return padLeft(match[1], 4);
+    }
+    return "9999";
+  }).join("");
+  return padRight(position, 12);
+}
+export function generateSlug(name) {
+  if (SEMVER_REGEX.test(name)) {
+    return name;
+  }
+  return name.replace(/^_/, "").replace(/(\d+\.)?(.*)/, "$2").replace(/^index/, "").replace(/\.draft/, "");
+}
+export function generateTitleFromSlug(slug) {
+  return slug.split(/[\s-]/g).map(pascalCase).join(" ");
+}
+export function generateTo(path) {
+  return withLeadingSlash(withoutTrailingSlash(path.split("/").map(generateSlug).join("/")));
+}
+export function isDraft(path) {
+  return !!path.match(/\.draft(\/|\.|$)/);
+}
+export function isHidden(path) {
+  return path.split("/").some((part) => part.match(/^_.*/));
+}
+function padLeft(value, length) {
+  return ("0".repeat(length) + value).substr(String(value).length);
+}
+function padRight(value, length) {
+  return (value + "0".repeat(length)).substr(0, length);
+}
+export function getPathMeta(id, { locales = ["en"], defaultLocale = "en" } = {}) {
+  const regexp = new RegExp(`^/?(${locales.join("|")})`, "gi");
+  const paths = id.split(".").slice(0, -1).join(".").split(/:/g).slice(1);
+  let path = paths.join("/");
+  const [language] = path.match(regexp) || [];
+  if (language) {
+    path = path.replace(regexp, "");
+  }
+  const slug = generateSlug(paths[paths.length - 1]);
+  return {
+    slug,
+    title: generateTitleFromSlug(slug),
+    position: generatePosition(path),
+    to: generateTo(path),
+    draft: isDraft(path),
+    page: !isHidden(path),
+    language: language || defaultLocale
+  };
+}

package/dist/runtime/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './log';

package/dist/runtime/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _log = require("./log");
+
+Object.keys(_log).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _log[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _log[key];
+    }
+  });
+});

package/dist/runtime/utils/index.mjs

@@ -0,0 +1 @@
+export * from "./log.mjs";

package/dist/runtime/utils/log.d.ts

@@ -0,0 +1 @@
+export declare const logger: import("consola").Consola;

package/dist/runtime/utils/log.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.logger = void 0;
+
+var _consola = _interopRequireDefault(require("consola"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const logger = _consola.default.withScope("@docus");
+
+exports.logger = logger;

package/dist/runtime/utils/log.mjs

@@ -0,0 +1,2 @@
+import consola from "consola";
+export const logger = consola.withScope("@docus");

package/dist/runtime/utils/object.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns a new object with the specified keys
+ **/
+export declare const pick: (keys: string[]) => (obj: any) => any;
+/**
+ * Returns a new object with all the keys of the original object execept the ones specified.
+ **/
+export declare const omit: (keys: string[]) => (obj: any) => any;
+export declare const apply: (fn: (d: any) => any) => (data: any) => any;

package/dist/runtime/utils/object.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pick = exports.omit = exports.apply = void 0;
+
+const _pick = (obj, condition) => Object.keys(obj).filter(condition).reduce((newObj, key) => Object.assign(newObj, {
+  [key]: obj[key]
+}), {});
+
+const pick = keys => obj => keys && keys.length ? _pick(obj, key => keys.includes(key)) : obj;
+
+exports.pick = pick;
+
+const omit = keys => obj => keys && keys.length ? _pick(obj, key => !keys.includes(key)) : obj;
+
+exports.omit = omit;
+
+const apply = fn => data => Array.isArray(data) ? data.map(item => fn(item)) : fn(data);
+
+exports.apply = apply;

package/dist/runtime/utils/object.mjs

@@ -0,0 +1,4 @@
+const _pick = (obj, condition) => Object.keys(obj).filter(condition).reduce((newObj, key) => Object.assign(newObj, { [key]: obj[key] }), {});
+export const pick = (keys) => (obj) => keys && keys.length ? _pick(obj, (key) => keys.includes(key)) : obj;
+export const omit = (keys) => (obj) => keys && keys.length ? _pick(obj, (key) => !keys.includes(key)) : obj;
+export const apply = (fn) => (data) => Array.isArray(data) ? data.map((item) => fn(item)) : fn(data);

package/dist/templates/content.mjs

@@ -0,0 +1,50 @@
+import { withoutTrailingSlash, joinURL } from "ufo";
+import Query from "#docus/database/Query";
+const createQuery = (options) => (path, opts) => {
+  const to = typeof path === "string" ? path : "";
+  const params = (typeof path === "object" ? path : opts) || {};
+  return new Query(to, { ...params, ...options });
+};
+export function getContent(ctx, previewKey = "") {
+  let { $docus } = ctx.$config ? ctx.$config : ctx.nuxtState;
+  if (!$docus) {
+    $docus = {
+      apiBase: "_docus",
+      wsUrl: "ws://localhost:4000"
+    };
+  }
+  const query = previewKey ? "?preview=" + previewKey : "";
+  const fetch = (key, opts = void 0) => globalThis.$fetch(joinURL("/api", $docus.apiBase, key) + query, opts);
+  const get = (key) => fetch(joinURL("get", key));
+  const search = createQuery({
+    base: withoutTrailingSlash(joinURL("/api", $docus.apiBase, "search") + query)
+  });
+  if (previewKey) {
+    return {
+      fetch,
+      get,
+      search,
+      setItem: async (key, content) => {
+        await fetch("preview", { method: "POST", body: { key, content } });
+        if (typeof window !== "undefined") {
+          window.$nuxt.$emit("docus:content:preview", { key, event: "change" });
+        }
+      },
+      removeItem: async (key) => {
+        await fetch(joinURL("preview", key), { method: "DELETE" });
+        if (typeof window !== "undefined") {
+          window.$nuxt.$emit("docus:content:preview", { key, event: "remove" });
+        }
+      }
+    };
+  }
+  return {
+    fetch,
+    get,
+    search,
+    preview: (previewKey2 = "memory") => getContent(ctx, previewKey2)
+  };
+}
+export default async function(ctx, inject) {
+  inject("content", getContent(ctx));
+}

package/dist/templates/docus.mjs

@@ -0,0 +1,13 @@
+import { defineNuxtPlugin } from "#app";
+import { createDocus } from "#docus";
+import docusConfig from "#docus/cache/docus.config.json";
+import themeConfig from "#docus/cache/theme.config.json";
+export default defineNuxtPlugin(async (nuxt) => {
+  const { $docus, init } = createDocus(nuxt, { docusConfig, themeConfig });
+  nuxt.provide("docus", $docus);
+  nuxt.provide("navigation", $docus.navigation);
+  if (process.client) {
+    window.$docus = $docus;
+  }
+  await init();
+});

package/dist/templates/hot.mjs

@@ -0,0 +1,16 @@
+import { joinURL } from "ufo";
+import { useWebSocket } from "#docus/composables/websocket";
+export default async function(ctx) {
+  let { $docus } = ctx.$config ? ctx.$config : ctx.nuxtState;
+  if (!$docus) {
+    $docus = {
+      apiBase: "_docus",
+      wsUrl: "ws://localhost:4000"
+    };
+  }
+  if (process.client) {
+    const protocol = location.protocol === "https:" ? "wss" : "ws";
+    const baseUrl = joinURL($docus.wsUrl || `${protocol}://${location.hostname}:${location.port}`, $docus.apiBase);
+    useWebSocket(baseUrl)?.connect();
+  }
+}

package/dist/templates/i18n.mjs

@@ -0,0 +1,23 @@
+import { defineNuxtPlugin } from "#app";
+export default defineNuxtPlugin((nuxt) => {
+  nuxt.provide("contentLocalePath", (path) => {
+    const app = nuxt.vue2App;
+    const { localeCodes, defaultLocale } = nuxt.nuxt2Context.i18n;
+    let localePath = localeCodes.some((code) => path.startsWith(`/${code}`)) ? path : app.localePath(path);
+    if (localePath.startsWith(`/${defaultLocale}`)) {
+      localePath = localePath.replace(`/${defaultLocale}`, "");
+    }
+    if (path.endsWith("/") && !localePath.endsWith("/")) {
+      localePath += "/";
+    }
+    if (!path.endsWith("/") && localePath.endsWith("/")) {
+      localePath = localePath.replace(/\/*$/, "");
+    }
+    return localePath;
+  });
+  if (process.client) {
+    nuxt.nuxt2Context.i18n.onLanguageSwitched = () => {
+      window.$docus.navigation.fetchNavigation(nuxt.nuxt2Context.i18n.locale);
+    };
+  }
+});

package/dist/templates/options.mjs

@@ -0,0 +1,46 @@
+// @ts-nocheck
+<% 
+const remarkPlugins = options.transformers.markdown.remarkPlugins
+const rehypePlugins = options.transformers.markdown.rehypePlugins
+const components = options.transformers.markdown.components
+
+const serializeImportName = id => '_' + id.replace(/[^a-zA-Z0-9_$]/g, '_')
+%>
+<% components.forEach(item => { %>
+import <%= serializeImportName(item.name) %> from '<%= item.path %>'
+<% }) %>
+<% remarkPlugins.forEach(item => { %>
+import <%= serializeImportName(item[0] || item.name || item) %> from '<%= item[0] || item.name || item %>'
+<% }) %>
+<% rehypePlugins.forEach(item => { %>
+  import <%= serializeImportName(item[0] || item.name || item) %> from '<%= item[0] || item.name || item %>'
+  <% }) %>
+
+const _context = <%= JSON.stringify(options) %>
+
+_context.transformers.markdown.components = [
+  <% components.forEach(item => { %>{
+    name: '<%= item.name %>',
+    instance: <%= serializeImportName(item.name) %>,
+    options: <%= JSON.stringify(item.options || {}) %>
+  }, <% }) %>
+]
+
+_context.transformers.markdown.remarkPlugins = [
+  <% remarkPlugins.forEach(item => { %>{
+    name: '<%= item[0] || item.name || item  %>',
+    instance: <%= serializeImportName(item[0] || item.name || item) %>,
+    options: <%= JSON.stringify(item[1] || item.options || {}) %>
+  }, <% }) %>
+]
+
+_context.transformers.markdown.rehypePlugins = [
+  <% rehypePlugins.forEach(item => { %>{
+    name: '<%= item[0] || item.name || item  %>',
+    instance: <%= serializeImportName(item[0] || item.name || item) %>,
+    options: <%= JSON.stringify(item[1] || item.options || {}) %>
+  }, <% }) %>
+]
+
+export const context = _context
+export default _context