hyperbook 0.33.2 → 0.34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperbook",
-  "version": "0.33.2",
+  "version": "0.34.0",
   "author": "Mike Barkmin",
   "homepage": "https://github.com/openpatch/hyperbook#readme",
   "license": "MIT",
@@ -31,6 +31,7 @@
     "@types/cross-spawn": "6.0.6",
     "@types/prompts": "2.4.9",
     "@types/tar": "6.1.13",
+    "@types/ws": "^8.5.12",
     "@vercel/ncc": "0.38.1",
     "archiver": "7.0.1",
     "async-retry": "1.3.3",
@@ -43,16 +44,19 @@
     "rimraf": "5.0.7",
     "tar": "6.2.1",
     "update-check": "1.5.4",
-    "@platforms/web": "0.33.2"
+    "chokidar": "3.6.0",
+    "mime": "^4.0.4",
+    "ws": "^8.18.0",
+    "@hyperbook/markdown": "0.10.0"
   },
   "dependencies": {
-    "@hyperbook/fs": "0.13.0",
-    "@hyperbook/types": "0.8.1"
+    "@hyperbook/types": "0.9.0",
+    "@hyperbook/fs": "0.14.0"
   },
   "scripts": {
     "version": "pnpm build",
     "lint": "tsc --noEmit",
     "dev": "ncc build ./index.ts -w -o dist/",
-    "build": "rimraf dist && ncc build ./index.ts -o ./dist/ -e \"hyperbook-simple-template\" --minify --no-cache --no-source-map-register && node ./postbuild.mjs"
+    "build": "rimraf dist && ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register && node postbuild.mjs"
   }
 }

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 Mike Barkmin
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/templates/default/.hyperbook/package.json

@@ -1,50 +0,0 @@
-{
-  "name": "@platforms/web",
-  "version": "0.33.2",
-  "private": true,
-  "dependencies": {
-    "gray-matter": "4.0.3",
-    "next": "13.4.5",
-    "react": "18.3.1",
-    "react-dom": "18.3.1",
-    "react-redux": "9.1.2",
-    "redux": "5.0.1",
-    "redux-persist": "6.0.0",
-    "@hyperbook/drawer": "0.1.2",
-    "@hyperbook/element-alert": "0.2.2",
-    "@hyperbook/element-bitflow": "0.2.2",
-    "@hyperbook/element-bookmarks": "0.3.3",
-    "@hyperbook/element-audio": "0.2.2",
-    "@hyperbook/element-collapsible": "0.4.2",
-    "@hyperbook/element-dl": "0.2.3",
-    "@hyperbook/element-embed": "0.2.2",
-    "@hyperbook/element-excalidraw": "0.6.2",
-    "@hyperbook/element-online-ide": "0.6.2",
-    "@hyperbook/element-mermaid": "0.3.6",
-    "@hyperbook/element-plantuml": "0.2.2",
-    "@hyperbook/element-protect": "0.4.2",
-    "@hyperbook/element-scratchblock": "0.2.2",
-    "@hyperbook/element-qr": "0.3.2",
-    "@hyperbook/element-slideshow": "0.0.2",
-    "@hyperbook/element-sql-ide": "0.5.2",
-    "@hyperbook/element-struktog": "0.2.2",
-    "@hyperbook/element-tiles": "0.1.4",
-    "@hyperbook/element-video": "0.2.3",
-    "@hyperbook/element-term": "0.2.2",
-    "@hyperbook/element-youtube": "0.2.2",
-    "@hyperbook/element-tabs": "0.2.2",
-    "@hyperbook/fs": "0.13.0",
-    "@hyperbook/markdown": "0.9.6",
-    "@hyperbook/shell": "0.7.5",
-    "@hyperbook/provider": "0.4.2",
-    "@hyperbook/styles": "0.4.0",
-    "@hyperbook/store": "0.2.1"
-  },
-  "devDependencies": {
-    "@hyperbook/next-watch": "0.7.3"
-  },
-  "scripts": {
-    "next:dev": "next-hyperbook-watch",
-    "next:build": "next build"
-  }
-}

package/dist/templates/default/.hyperbook/src/index.css

@@ -1,14 +0,0 @@
-html,
-body {
-  overflow-x: hidden;
-  margin: 0;
-}
-
-body {
-  -ms-overflow-style: none; /* IE and Edge */
-  scrollbar-width: none; /* Firefox */
-}
-
-body::-webkit-scrollbar {
-  display: none;
-}

package/dist/templates/default/.hyperbook/src/pages/[[...page]].js

@@ -1,57 +0,0 @@
-import React from "react";
-import { Shell } from "@hyperbook/shell";
-import { Markdown } from "@hyperbook/markdown";
-import { useActivePageId, useLink } from "@hyperbook/provider";
-import { Fragment } from "react";
-import { vfile, hyperbook } from "@hyperbook/fs";
-import { useScrollHash } from "../useScrollHash";
-import path from "path";
-function BookPage({ markdown, data, navigation }) {
-  const Link = useLink();
-  useActivePageId();
-  useScrollHash();
-  return /* @__PURE__ */ React.createElement(Fragment, null, /* @__PURE__ */ React.createElement(Shell, { navigation }, /* @__PURE__ */ React.createElement("article", null, /* @__PURE__ */ React.createElement(Markdown, { children: markdown, showToc: data.toc !== false })), !data.hide && /* @__PURE__ */ React.createElement("div", { className: "jump-container" }, navigation.previous ? /* @__PURE__ */ React.createElement(Link, { className: "jump previous", href: navigation.previous.href }, navigation.previous.name) : /* @__PURE__ */ React.createElement("div", { className: "flex" }), navigation.next ? /* @__PURE__ */ React.createElement(Link, { className: "jump next", href: navigation.next.href }, navigation.next.name) : /* @__PURE__ */ React.createElement("div", { className: "flex" }))));
-}
-const getStaticProps = async ({ params }) => {
-  const root = process.env.root ?? process.cwd();
-  let href = "";
-  if (params.page) {
-    href = path.join(...params.page);
-  }
-  const file = await vfile.get(root, "book", "/" + href);
-  const { content, data } = file.markdown;
-  const hyperbookJson = await hyperbook.getJson(root);
-  const navigation = await hyperbook.getNavigation(root, file);
-  return {
-    props: {
-      locale: data?.lang || hyperbookJson.language,
-      markdown: content,
-      data,
-      navigation
-    }
-  };
-};
-const getStaticPaths = async () => {
-  const root = process.env.root ?? process.cwd();
-  const files = await vfile.listForFolder(root, "book");
-  const paths = files.map((f) => {
-    const page = f.path.href.slice(1).split("/");
-    if (f.name === "index" && f.path.directory === "") {
-      page.pop();
-    }
-    return {
-      params: {
-        page
-      }
-    };
-  });
-  return {
-    paths,
-    fallback: false
-  };
-};
-export {
-  BookPage as default,
-  getStaticPaths,
-  getStaticProps
-};

package/dist/templates/default/.hyperbook/src/pages/_app.js

@@ -1,135 +0,0 @@
-import React from "react";
-import "../index.css";
-import "@hyperbook/shell/index.css";
-import "@hyperbook/drawer/index.css";
-import "@hyperbook/markdown/katex.css";
-import "@hyperbook/markdown/index.css";
-import { Provider } from "@hyperbook/provider";
-import elementTab from "@hyperbook/element-tabs";
-import "@hyperbook/element-tabs/index.css";
-import elementAudio from "@hyperbook/element-audio";
-import "@hyperbook/element-audio/index.css";
-import elementVideo from "@hyperbook/element-video";
-import "@hyperbook/element-video/index.css";
-import elementAlert from "@hyperbook/element-alert";
-import "@hyperbook/element-alert/index.css";
-import elementTerm from "@hyperbook/element-term";
-import "@hyperbook/element-term/index.css";
-import elementYoutube from "@hyperbook/element-youtube";
-import "@hyperbook/element-youtube/index.css";
-import elementPlantuml from "@hyperbook/element-plantuml";
-import "@hyperbook/element-plantuml/index.css";
-import elementProtect from "@hyperbook/element-protect";
-import "@hyperbook/element-protect/index.css";
-import elementCollapsible from "@hyperbook/element-collapsible";
-import "@hyperbook/element-collapsible/index.css";
-import elementDl from "@hyperbook/element-dl";
-import "@hyperbook/element-dl/index.css";
-import elementBookmarks from "@hyperbook/element-bookmarks";
-import "@hyperbook/element-bookmarks/index.css";
-import elementStruktog from "@hyperbook/element-struktog";
-import "@hyperbook/element-struktog/index.css";
-import elementQr from "@hyperbook/element-qr";
-import "@hyperbook/element-qr/index.css";
-import elementMermaid from "@hyperbook/element-mermaid";
-import "@hyperbook/element-mermaid/index.css";
-import elementExcalidraw from "@hyperbook/element-excalidraw";
-import "@hyperbook/element-excalidraw/index.css";
-import elementEmbed from "@hyperbook/element-embed";
-import "@hyperbook/element-embed/index.css";
-import elementOnlineIde from "@hyperbook/element-online-ide";
-import "@hyperbook/element-online-ide/index.css";
-import elementSqlIde from "@hyperbook/element-sql-ide";
-import "@hyperbook/element-sql-ide/index.css";
-import elementBitflow from "@hyperbook/element-bitflow";
-import "@hyperbook/element-bitflow/index.css";
-import elementScratchblock from "@hyperbook/element-scratchblock";
-import "@hyperbook/element-scratchblock/index.css";
-import elementTiles from "@hyperbook/element-tiles";
-import "@hyperbook/element-tiles/index.css";
-import elementSlideshow from "@hyperbook/element-slideshow";
-import "@hyperbook/element-slideshow/index.css";
-import Link from "next/link";
-import Head from "next/head";
-import { Styles } from "@hyperbook/styles";
-import { localStorage, noopStorage } from "@hyperbook/store";
-import { useRouter } from "next/router";
-import { useEffect } from "react";
-import hb from "../../hyperbook.json";
-const MyLink = ({ ref, href, children, ...props }) => {
-  return /* @__PURE__ */ React.createElement(Link, { href, ...props }, children);
-};
-const makeUrl = ({ basePath }) => (path) => {
-  if (process.env.NODE_ENV === "production" && basePath && path?.startsWith("/")) {
-    if (basePath.endsWith("/")) {
-      path = basePath.slice(0, -1) + path;
-    } else {
-      path = basePath + path;
-    }
-  }
-  return path;
-};
-function MyApp({ Component, pageProps }) {
-  const router = useRouter();
-  useEffect(() => {
-    document.documentElement.lang = pageProps.locale;
-  }, [pageProps.locale]);
-  return /* @__PURE__ */ React.createElement(
-    Provider,
-    {
-      Link: MyLink,
-      Head,
-      config: hb,
-      makeUrl,
-      env: process.env.NODE_ENV === "production" ? "production" : "development",
-      elements: [
-        elementTab,
-        elementAudio,
-        elementVideo,
-        elementAlert,
-        elementTerm,
-        elementYoutube,
-        elementCollapsible,
-        elementPlantuml,
-        elementProtect,
-        elementDl,
-        elementEmbed,
-        elementBookmarks,
-        elementStruktog,
-        elementOnlineIde,
-        elementSqlIde,
-        elementQr,
-        elementMermaid,
-        elementExcalidraw,
-        elementScratchblock,
-        elementBitflow,
-        elementTiles,
-        elementSlideshow
-      ],
-      router,
-      storage: typeof window !== "undefined" ? localStorage : noopStorage,
-      loadFile: () => async (path) => {
-        return fetch(path).then((res) => res.text());
-      },
-      saveFile: () => async (path, content, rootFolder) => {
-        await fetch("/api/save", {
-          method: "POST",
-          headers: {
-            "Content-Type": "application/json"
-          },
-          body: JSON.stringify({
-            path,
-            content,
-            rootFolder
-          })
-        });
-      },
-      getActivePageId: async () => router.asPath.split("#")?.[0] || "/"
-    },
-    /* @__PURE__ */ React.createElement(Styles, null),
-    /* @__PURE__ */ React.createElement(Component, { ...pageProps })
-  );
-}
-export {
-  MyApp as default
-};

package/dist/templates/default/.hyperbook/src/pages/_document.js

@@ -1,11 +0,0 @@
-import React from "react";
-import Document, { Html, Head, Main, NextScript } from "next/document";
-class MyDocument extends Document {
-  render() {
-    return /* @__PURE__ */ React.createElement(Html, { lang: this.props.__NEXT_DATA__.props.pageProps.locale }, /* @__PURE__ */ React.createElement(Head, null), /* @__PURE__ */ React.createElement("body", null, /* @__PURE__ */ React.createElement(Main, null), /* @__PURE__ */ React.createElement(NextScript, null)));
-  }
-}
-var document_default = MyDocument;
-export {
-  document_default as default
-};

package/dist/templates/default/.hyperbook/src/pages/api/save.js

@@ -1,39 +0,0 @@
-import fs from "fs/promises";
-import path from "path";
-async function ensureDirectoryExistence(filePath) {
-  var dirname = path.dirname(filePath);
-  try {
-    await fs.access(dirname);
-    return true;
-  } catch (e) {
-    fs.mkdir(dirname).then(async () => ensureDirectoryExistence(dirname));
-  }
-}
-const config = {
-  api: {
-    bodyParser: {
-      sizeLimit: "32mb"
-    }
-  }
-};
-async function handler(req, res) {
-  if (process.env.NODE_ENV !== "development") {
-    res.status(404).json({ status: "failed" });
-  }
-  let { path: p, content, rootFolder } = req.body;
-  if (rootFolder) {
-    p = path.join(rootFolder, p);
-  }
-  p = path.join(__dirname, "..", "..", "..", "..", p);
-  try {
-    await ensureDirectoryExistence(p);
-    await fs.writeFile(p, content);
-    res.status(202).json({ status: "saved" });
-  } catch (e) {
-    res.status(400).json(e);
-  }
-}
-export {
-  config,
-  handler as default
-};

package/dist/templates/default/.hyperbook/src/pages/glossary/[...term].js

@@ -1,59 +0,0 @@
-import React from "react";
-import { Shell } from "@hyperbook/shell";
-import { Fragment } from "react";
-import { useActivePageId, useLink } from "@hyperbook/provider";
-import { Markdown } from "@hyperbook/markdown";
-import { hyperbook, vfile } from "@hyperbook/fs";
-import { useScrollHash } from "../../useScrollHash";
-function Term({
-  markdown,
-  navigation,
-  data,
-  references
-}) {
-  const Link = useLink();
-  useActivePageId();
-  useScrollHash();
-  return /* @__PURE__ */ React.createElement(Shell, { navigation }, /* @__PURE__ */ React.createElement("article", null, /* @__PURE__ */ React.createElement(Markdown, { children: markdown, showToc: data.toc !== false }), /* @__PURE__ */ React.createElement("div", { className: "pages" }, references.map((p, i) => /* @__PURE__ */ React.createElement(Fragment, { key: p.path.href }, i > 0 && ", ", /* @__PURE__ */ React.createElement(Link, { href: p.path.href }, p.markdown?.data?.name ?? p.name))))));
-}
-const getStaticProps = async ({ params }) => {
-  const root = process.env.root ?? process.cwd();
-  const file = await vfile.get(
-    root,
-    "glossary",
-    "/glossary/" + params.term.join("/")
-  );
-  if (!file) {
-    throw Error(`Missing file ${file}`);
-  }
-  const { content, data } = await vfile.getMarkdown(file);
-  const hyperbookJson = await hyperbook.getJson(root);
-  const navigation = await hyperbook.getNavigation(root, file);
-  return {
-    props: {
-      locale: data?.lang || hyperbookJson.language,
-      markdown: content,
-      data,
-      references: file.references,
-      navigation
-    }
-  };
-};
-const getStaticPaths = async () => {
-  const root = process.env.root ?? process.cwd();
-  const files = await vfile.listForFolder(root, "glossary");
-  const paths = files.map((f) => ({
-    params: {
-      term: f.path.href.slice(10).split("/")
-    }
-  }));
-  return {
-    paths,
-    fallback: false
-  };
-};
-export {
-  Term as default,
-  getStaticPaths,
-  getStaticProps
-};

package/dist/templates/default/.hyperbook/src/pages/glossary/index.js

@@ -1,28 +0,0 @@
-import React from "react";
-import { Shell } from "@hyperbook/shell";
-import { useActivePageId, useLink } from "@hyperbook/provider";
-import { hyperbook, vfile } from "@hyperbook/fs";
-import { useScrollHash } from "../../useScrollHash";
-function Glossary({ glossary, navigation }) {
-  const Link = useLink();
-  useActivePageId();
-  useScrollHash();
-  return /* @__PURE__ */ React.createElement(Shell, { navigation }, /* @__PURE__ */ React.createElement("article", { className: "glossary" }, Object.keys(glossary).map((letter) => /* @__PURE__ */ React.createElement("div", { key: letter, className: "container" }, /* @__PURE__ */ React.createElement("div", { className: "letter" }, letter), /* @__PURE__ */ React.createElement("ul", { className: "terms" }, glossary[letter].map((term) => /* @__PURE__ */ React.createElement("li", { key: term.href }, /* @__PURE__ */ React.createElement(Link, { className: "term", href: term.href }, term.name))))))));
-}
-const getStaticProps = async () => {
-  const root = process.env.root ?? process.cwd();
-  const glossaryData = await vfile.getGlossary(root);
-  const hyperbookJson = await hyperbook.getJson(root);
-  const navigation = await hyperbook.getNavigation(root);
-  return {
-    props: {
-      locale: hyperbookJson.language,
-      glossary: glossaryData,
-      navigation
-    }
-  };
-};
-export {
-  Glossary as default,
-  getStaticProps
-};

package/dist/templates/default/.hyperbook/src/useScrollHash.js

@@ -1,14 +0,0 @@
-import { useEffect } from "react";
-const useScrollHash = () => {
-  useEffect(() => {
-    const hash = window.location.hash;
-    if (hash) {
-      setTimeout(() => {
-        document.querySelector(hash)?.scrollIntoView({ behavior: "smooth" });
-      }, 100);
-    }
-  });
-};
-export {
-  useScrollHash
-};