docus 2.1.0 → 3.0.0-beta.1

package/dist/runtime/server/content.d.ts

@@ -1,46 +0,0 @@
-import type { Storage } from 'unstorage';
-import type { MDCRoot } from 'types';
-interface DocusContent {
-    body: MDCRoot;
-    meta: Record<string, any>;
-}
-export declare const contentStorage: Storage;
-export declare const buildStorage: Storage;
-export declare const previewStorage: Storage;
-/**
- * Read content form source file, generate and cache the content
- *
- * @param id Content ID
- * @param previewKey Preview id
- * @returns Transformed content
- */
-export declare function buildContent(id: string, previewKey?: string): Promise<DocusContent>;
-/**
- * Return transformed conntent if it exists in cache or build it on demand
- *
- * @param id Content ID
- * @param previewKey Preview ID
- * @returns Transformed content
- */
-export declare function getContent(id: string, previewKey?: string): Promise<DocusContent>;
-/**
- * Find list of contents
- *
- * @param id Base if for lookup
- * @param previewKey Preview ID
- * @returns List of content in given base path
- */
-export declare function getList(id?: string, previewKey?: string): Promise<{
-    id: string;
-}[]>;
-/**
- * Search content database for a given query
- *
- * @param to Base path for search
- * @param body Search options
- * @param previewKey Preview ID
- * @returns Single content of list of contents that matchs the search
- */
-export declare function searchContent(to: string, body: any, previewKey?: string): Promise<any>;
-export declare const getNavigation: (previewKey?: string) => Promise<any>;
-export {};

package/dist/runtime/server/content.js

@@ -1,175 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildContent = buildContent;
-exports.contentStorage = exports.buildStorage = void 0;
-exports.getContent = getContent;
-exports.getList = getList;
-exports.previewStorage = exports.getNavigation = void 0;
-exports.searchContent = searchContent;
-
-var _unstorage = require("unstorage");
-
-var _micromatch = _interopRequireDefault(require("micromatch"));
-
-var _transformers = require("../transformers");
-
-var _database = require("../database");
-
-var _navigation = require("../navigation");
-
-var _context = require("../context");
-
-var _cache = require("./utils/cache");
-
-var _storage = require("#storage");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function prefixStorage(storage2, base) {
-  const nsStorage = (0, _unstorage.prefixStorage)(storage2, base);
-  const prefixRegex = new RegExp(`^${base}:`);
-
-  nsStorage.getKeys = (id = "") => {
-    return storage2.getKeys(base + ":" + id).then(keys => keys.map(key => key.replace(prefixRegex, "")));
-  };
-
-  return nsStorage;
-}
-
-const contentStorage = prefixStorage(_storage.storage, "docus:source");
-exports.contentStorage = contentStorage;
-const buildStorage = prefixStorage(_storage.storage, "assets:docus:build");
-exports.buildStorage = buildStorage;
-const previewStorage = prefixStorage(_storage.storage, "docus:preview");
-exports.previewStorage = previewStorage;
-const isProduction = process.env.NODE_ENV === "production";
-
-const withCache = (name, fn) => isProduction ? (0, _cache.cachify)(fn, {
-  name,
-  swr: true,
-  ttl: 6e4,
-  integrity: "docus"
-}) : fn;
-
-async function getData(id, previewKey) {
-  let body;
-  let meta;
-
-  if (previewKey) {
-    body = await previewStorage.getItem(`${previewKey}:${id}`);
-    meta = await previewStorage.getMeta(`${previewKey}:${id}`);
-  }
-
-  if (!body) {
-    body = await contentStorage.getItem(id);
-    meta = await contentStorage.getMeta(id);
-  }
-
-  if (body && typeof body === "object") {
-    body = JSON.stringify(typeof body.default !== "undefined" ? body.default : body);
-  }
-
-  if (typeof body !== "string") {
-    body = body + "";
-  }
-
-  return {
-    body,
-    meta
-  };
-}
-
-const getContentKeys = async id => {
-  let keys = await buildStorage.getKeys(id);
-
-  if (keys.length === 0) {
-    keys = await contentStorage.getKeys(id);
-    const context = (0, _context.useDocusContext)();
-    keys = _micromatch.default.not(keys, context?.ignoreList || []);
-  }
-
-  return keys;
-};
-
-const getPreviewKeys = async (id, previewKey) => {
-  let keys = (await previewStorage.getKeys(id ? `${previewKey}:${id}` : previewKey)).map(key => key.replace(`${previewKey}:`, ""));
-  const context = (0, _context.useDocusContext)();
-  keys = _micromatch.default.not(keys, context?.ignoreList || []);
-  return keys;
-};
-
-async function getKeys(id, previewKey) {
-  let keys = await getContentKeys(id);
-
-  if (previewKey) {
-    const previewKeys = await getPreviewKeys(id, previewKey);
-    keys = keys.filter(key => !previewKeys.includes(key));
-    keys.push(...previewKeys);
-  }
-
-  return keys;
-}
-
-async function buildContent(id, previewKey) {
-  const data = await getData(id, previewKey);
-
-  if (typeof data.body === "undefined" || data.body === null) {
-    throw new Error(`Content not found: ${id}`);
-  }
-
-  const transformResult = await (0, _transformers.getTransformer)(id)(id, data.body);
-  const content = {
-    meta: { ...data.meta,
-      ...transformResult.meta
-    },
-    body: transformResult.body
-  };
-
-  if (!previewKey) {
-    await buildStorage.setItem(id, content);
-  }
-
-  return content;
-}
-
-async function getContent(id, previewKey) {
-  let content = !previewKey && (await buildStorage.getItem(id));
-
-  if (!content) {
-    content = await buildContent(id, previewKey);
-  }
-
-  return content;
-}
-
-async function getList(id, previewKey) {
-  const keys = await getKeys(id, previewKey);
-  return Promise.all(keys.map(async key => {
-    const content = await getContent(key, previewKey);
-    return {
-      id: key,
-      ...content.meta
-    };
-  }));
-}
-
-async function searchContent(to, body, previewKey) {
-  const navigation = await getNavigation(previewKey);
-  const db = await (0, _database.createDatabase)(navigation);
-  return db.search(to, body);
-}
-
-const getNavigationCached = withCache("navigation", async () => (0, _navigation.generateNavigation)(await getList()));
-
-const getNavigation = async previewKey => {
-  if (!previewKey) {
-    return getNavigationCached();
-  }
-
-  return (0, _navigation.generateNavigation)(await getList(void 0, previewKey));
-};
-
-exports.getNavigation = getNavigation;

package/dist/runtime/server/content.mjs

@@ -1,114 +0,0 @@
-import { prefixStorage as unstoragePrefixStorage } from "unstorage";
-import micromatch from "micromatch";
-import { getTransformer } from "../transformers/index.mjs";
-import { createDatabase } from "../database/index.mjs";
-import { generateNavigation } from "../navigation.mjs";
-import { useDocusContext } from "../context.mjs";
-import { cachify } from "./utils/cache.mjs";
-import { storage } from "#storage";
-function prefixStorage(storage2, base) {
-  const nsStorage = unstoragePrefixStorage(storage2, base);
-  const prefixRegex = new RegExp(`^${base}:`);
-  nsStorage.getKeys = (id = "") => {
-    return storage2.getKeys(base + ":" + id).then((keys) => keys.map((key) => key.replace(prefixRegex, "")));
-  };
-  return nsStorage;
-}
-export const contentStorage = prefixStorage(storage, "docus:source");
-export const buildStorage = prefixStorage(storage, "assets:docus:build");
-export const previewStorage = prefixStorage(storage, "docus:preview");
-const isProduction = process.env.NODE_ENV === "production";
-const withCache = (name, fn) => isProduction ? cachify(fn, { name, swr: true, ttl: 6e4, integrity: "docus" }) : fn;
-async function getData(id, previewKey) {
-  let body;
-  let meta;
-  if (previewKey) {
-    body = await previewStorage.getItem(`${previewKey}:${id}`);
-    meta = await previewStorage.getMeta(`${previewKey}:${id}`);
-  }
-  if (!body) {
-    body = await contentStorage.getItem(id);
-    meta = await contentStorage.getMeta(id);
-  }
-  if (body && typeof body === "object") {
-    body = JSON.stringify(typeof body.default !== "undefined" ? body.default : body);
-  }
-  if (typeof body !== "string") {
-    body = body + "";
-  }
-  return {
-    body,
-    meta
-  };
-}
-const getContentKeys = async (id) => {
-  let keys = await buildStorage.getKeys(id);
-  if (keys.length === 0) {
-    keys = await contentStorage.getKeys(id);
-    const context = useDocusContext();
-    keys = micromatch.not(keys, context?.ignoreList || []);
-  }
-  return keys;
-};
-const getPreviewKeys = async (id, previewKey) => {
-  let keys = (await previewStorage.getKeys(id ? `${previewKey}:${id}` : previewKey)).map((key) => key.replace(`${previewKey}:`, ""));
-  const context = useDocusContext();
-  keys = micromatch.not(keys, context?.ignoreList || []);
-  return keys;
-};
-async function getKeys(id, previewKey) {
-  let keys = await getContentKeys(id);
-  if (previewKey) {
-    const previewKeys = await getPreviewKeys(id, previewKey);
-    keys = keys.filter((key) => !previewKeys.includes(key));
-    keys.push(...previewKeys);
-  }
-  return keys;
-}
-export async function buildContent(id, previewKey) {
-  const data = await getData(id, previewKey);
-  if (typeof data.body === "undefined" || data.body === null) {
-    throw new Error(`Content not found: ${id}`);
-  }
-  const transformResult = await getTransformer(id)(id, data.body);
-  const content = {
-    meta: {
-      ...data.meta,
-      ...transformResult.meta
-    },
-    body: transformResult.body
-  };
-  if (!previewKey) {
-    await buildStorage.setItem(id, content);
-  }
-  return content;
-}
-export async function getContent(id, previewKey) {
-  let content = !previewKey && await buildStorage.getItem(id);
-  if (!content) {
-    content = await buildContent(id, previewKey);
-  }
-  return content;
-}
-export async function getList(id, previewKey) {
-  const keys = await getKeys(id, previewKey);
-  return Promise.all(keys.map(async (key) => {
-    const content = await getContent(key, previewKey);
-    return {
-      id: key,
-      ...content.meta
-    };
-  }));
-}
-export async function searchContent(to, body, previewKey) {
-  const navigation = await getNavigation(previewKey);
-  const db = await createDatabase(navigation);
-  return db.search(to, body);
-}
-const getNavigationCached = withCache("navigation", async () => generateNavigation(await getList()));
-export const getNavigation = async (previewKey) => {
-  if (!previewKey) {
-    return getNavigationCached();
-  }
-  return generateNavigation(await getList(void 0, previewKey));
-};

package/dist/runtime/server/socket.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="node" />
-import type { IncomingMessage } from 'http';
-/**
- * WebSocket server useful for live content reload.
- */
-export declare function useWebSocket(): {
-    serve: (req: IncomingMessage, socket?: import("net").Socket, head?: any) => void;
-    broadcast: (data: any) => void;
-};

package/dist/runtime/server/socket.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useWebSocket = useWebSocket;
-
-var _ws = require("ws");
-
-let wss;
-
-function useWebSocket() {
-  if (!wss) wss = new _ws.Server({
-    noServer: true
-  });
-
-  const serve = (req, socket = req.socket, head = "") => wss.handleUpgrade(req, socket, head, client => wss.emit("connection", client, req));
-
-  const broadcast = data => {
-    data = JSON.stringify(data);
-
-    for (const client of wss.clients) {
-      try {
-        client.send(data);
-      } catch (err) {}
-    }
-  };
-
-  return {
-    serve,
-    broadcast
-  };
-}

package/dist/runtime/server/socket.mjs

@@ -1,20 +0,0 @@
-import { Server } from "ws";
-let wss;
-export function useWebSocket() {
-  if (!wss)
-    wss = new Server({ noServer: true });
-  const serve = (req, socket = req.socket, head = "") => wss.handleUpgrade(req, socket, head, (client) => wss.emit("connection", client, req));
-  const broadcast = (data) => {
-    data = JSON.stringify(data);
-    for (const client of wss.clients) {
-      try {
-        client.send(data);
-      } catch (err) {
-      }
-    }
-  };
-  return {
-    serve,
-    broadcast
-  };
-}

package/dist/runtime/server/utils/cache.d.ts

@@ -1,19 +0,0 @@
-import type { Handle } from 'h3';
-export interface CacheEntry {
-    value?: any;
-    expires?: number;
-    mtime?: number;
-    integrity?: string;
-}
-export interface CachifyOptions {
-    name: string;
-    getKey?: (...args: any[]) => string;
-    transform?: (entry: CacheEntry, ...args: any[]) => any;
-    group?: string;
-    integrity?: any;
-    ttl?: number;
-    swr?: boolean;
-    base?: string;
-}
-export declare function cachify(fn: (...args: any[]) => any, opts: CachifyOptions): (...args: any[]) => Promise<any>;
-export declare function cachifyHandle(handle: Handle, opts: Omit<CachifyOptions, 'getKey'>): (...args: any[]) => Promise<any>;

package/dist/runtime/server/utils/cache.js

@@ -1,110 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.cachify = cachify;
-exports.cachifyHandle = cachifyHandle;
-
-var _murmurhashEs = require("murmurhash-es");
-
-var _storage = require("#storage");
-
-function cachify(fn, opts) {
-  const pending = {};
-  opts.base = process.env.NODE_ENV === "development" ? "/root/node_modules/.cache/cachify" : "/cache";
-  const group = opts.group || "";
-  const name = opts.name || fn.name || "_";
-  const integrity = (0, _murmurhashEs.murmurHashV3)(JSON.stringify(opts.integrity || fn)) + "-" + name;
-
-  async function get(key, resolver) {
-    const cacheKey = [opts.base, group, name, key].filter(Boolean).join(":");
-    const entry = (await _storage.storage.getItem(cacheKey)) || {};
-    const ttl = (opts.ttl ?? opts.ttl ?? 0) * 1e3;
-
-    if (ttl) {
-      entry.expires = Date.now() + ttl;
-    }
-
-    const expired = entry.integrity !== integrity || ttl && Date.now() - (entry.mtime || 0) > ttl;
-
-    const _resolve = async () => {
-      if (!pending[key]) {
-        pending[key] = resolver();
-      }
-
-      entry.value = await pending[key];
-      entry.mtime = Date.now();
-      entry.integrity = integrity;
-      delete pending[key];
-
-      _storage.storage.setItem(cacheKey, entry).catch(console.error);
-    };
-
-    const _resolvePromise = expired ? _resolve() : Promise.resolve();
-
-    if (opts.swr && entry.value) {
-      _resolvePromise.catch(console.error);
-
-      return Promise.resolve(entry);
-    }
-
-    return _resolvePromise.then(() => entry);
-  }
-
-  return async (...args) => {
-    const key = (opts.getKey || getKey)(...args);
-    const entry = await get(key, () => fn(...args));
-    let value = entry.value;
-
-    if (opts.transform) {
-      value = (await opts.transform(entry, ...args)) || value;
-    }
-
-    return value;
-  };
-}
-
-function getKey(...args) {
-  return "args" + (0, _murmurhashEs.murmurHashV3)(JSON.stringify(args));
-}
-
-function cachifyHandle(handle, opts) {
-  const _opts = {
-    getKey: req => req.originalUrl || req.url,
-
-    transform(entry, _req, res) {
-      for (const header in entry.value.headers) {
-        res.setHeader(header, entry.value.headers[header]);
-      }
-
-      const cacheControl = [];
-
-      if (opts.swr) {
-        if (opts.ttl) {
-          cacheControl.push(`s-maxage=${opts.ttl / 1e3}`);
-        }
-
-        cacheControl.push("stale-while-revalidate");
-      } else if (opts.ttl) {
-        cacheControl.push(`max-age=${opts.ttl / 1e3}`);
-      }
-
-      if (cacheControl.length) {
-        res.setHeader("Cache-Control", cacheControl.join(", "));
-      }
-
-      return entry.value.body;
-    },
-
-    ...opts
-  };
-  return cachify(async (req, res) => {
-    const body = await handle(req, res);
-    const headers = res.getHeaders();
-    return {
-      body,
-      headers
-    };
-  }, _opts);
-}

package/dist/runtime/server/utils/cache.mjs

@@ -1,75 +0,0 @@
-import { murmurHashV3 } from "murmurhash-es";
-import { storage } from "#storage";
-export function cachify(fn, opts) {
-  const pending = {};
-  opts.base = process.env.NODE_ENV === "development" ? "/root/node_modules/.cache/cachify" : "/cache";
-  const group = opts.group || "";
-  const name = opts.name || fn.name || "_";
-  const integrity = murmurHashV3(JSON.stringify(opts.integrity || fn)) + "-" + name;
-  async function get(key, resolver) {
-    const cacheKey = [opts.base, group, name, key].filter(Boolean).join(":");
-    const entry = await storage.getItem(cacheKey) || {};
-    const ttl = (opts.ttl ?? opts.ttl ?? 0) * 1e3;
-    if (ttl) {
-      entry.expires = Date.now() + ttl;
-    }
-    const expired = entry.integrity !== integrity || ttl && Date.now() - (entry.mtime || 0) > ttl;
-    const _resolve = async () => {
-      if (!pending[key]) {
-        pending[key] = resolver();
-      }
-      entry.value = await pending[key];
-      entry.mtime = Date.now();
-      entry.integrity = integrity;
-      delete pending[key];
-      storage.setItem(cacheKey, entry).catch(console.error);
-    };
-    const _resolvePromise = expired ? _resolve() : Promise.resolve();
-    if (opts.swr && entry.value) {
-      _resolvePromise.catch(console.error);
-      return Promise.resolve(entry);
-    }
-    return _resolvePromise.then(() => entry);
-  }
-  return async (...args) => {
-    const key = (opts.getKey || getKey)(...args);
-    const entry = await get(key, () => fn(...args));
-    let value = entry.value;
-    if (opts.transform) {
-      value = await opts.transform(entry, ...args) || value;
-    }
-    return value;
-  };
-}
-function getKey(...args) {
-  return "args" + murmurHashV3(JSON.stringify(args));
-}
-export function cachifyHandle(handle, opts) {
-  const _opts = {
-    getKey: (req) => req.originalUrl || req.url,
-    transform(entry, _req, res) {
-      for (const header in entry.value.headers) {
-        res.setHeader(header, entry.value.headers[header]);
-      }
-      const cacheControl = [];
-      if (opts.swr) {
-        if (opts.ttl) {
-          cacheControl.push(`s-maxage=${opts.ttl / 1e3}`);
-        }
-        cacheControl.push("stale-while-revalidate");
-      } else if (opts.ttl) {
-        cacheControl.push(`max-age=${opts.ttl / 1e3}`);
-      }
-      if (cacheControl.length) {
-        res.setHeader("Cache-Control", cacheControl.join(", "));
-      }
-      return entry.value.body;
-    },
-    ...opts
-  };
-  return cachify(async (req, res) => {
-    const body = await handle(req, res);
-    const headers = res.getHeaders();
-    return { body, headers };
-  }, _opts);
-}

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

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage } from 'http';
-export declare function usePreview(req: IncomingMessage): string;
-export declare function useKey(req: IncomingMessage): string;

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

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useKey = useKey;
-exports.usePreview = usePreview;
-
-var _h = require("h3");
-
-function usePreview(req) {
-  const query = (0, _h.useQuery)(req);
-  return (query.preview || "").replace(/\//g, ":");
-}
-
-function useKey(req) {
-  return (req.url || "").split("?")[0].replace(/^\//, "");
-}

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

@@ -1,8 +0,0 @@
-import { useQuery } from "h3";
-export function usePreview(req) {
-  const query = useQuery(req);
-  return (query.preview || "").replace(/\//g, ":");
-}
-export function useKey(req) {
-  return (req.url || "").split("?")[0].replace(/^\//, "");
-}

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

@@ -1 +0,0 @@
-export declare function getTransformer(id: string): (id: string, body: string) => any;

package/dist/runtime/transformers/index.js

@@ -1,26 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getTransformer = getTransformer;
-
-var _markdown = _interopRequireDefault(require("./markdown"));
-
-var _json = _interopRequireDefault(require("./json"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const transformers = {
-  default: (_id = "", body = "") => ({
-    body,
-    meta: {}
-  }),
-  ".md": _markdown.default,
-  ".json": _json.default
-};
-const exts = Object.keys(transformers);
-
-function getTransformer(id) {
-  return transformers[exts.find(ext => id.endsWith(ext)) || "default"];
-}

package/dist/runtime/transformers/index.mjs

@@ -1,11 +0,0 @@
-import markdown from "./markdown/index.mjs";
-import json from "./json.mjs";
-const transformers = {
-  default: (_id = "", body = "") => ({ body, meta: {} }),
-  ".md": markdown,
-  ".json": json
-};
-const exts = Object.keys(transformers);
-export function getTransformer(id) {
-  return transformers[exts.find((ext) => id.endsWith(ext)) || "default"];
-}

package/dist/runtime/transformers/json.d.ts

@@ -1,3 +0,0 @@
-export default function transformJSON(_id: string, input: string | object): {
-    body: any;
-};