Merge branch 'main' into electron_newwindow

Author: SiriusXT

_regroup/package.json

@@ -48,9 +48,7 @@
     "lorem-ipsum": "2.0.8",    
     "rcedit": "4.0.1",
     "rimraf": "6.1.0",    
-    "tslib": "2.8.1",    
-    "typedoc": "0.28.14",
-    "typedoc-plugin-missing-exports": "4.1.2"
+    "tslib": "2.8.1" 
   },
   "optionalDependencies": {
     "appdmg": "0.6.6"

_regroup/typedoc.json

@@ -0,0 +1,22 @@
+{
+  "name": "build-docs",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/main.ts",
+  "scripts": {
+    "start": "tsx ."
+  },
+  "keywords": [],
+  "author": "Elian Doran <[email protected]>",
+  "license": "AGPL-3.0-only",
+  "packageManager": "[email protected]",
+  "devDependencies": {
+    "@redocly/cli": "2.10.0",
+    "archiver": "7.0.1",
+    "fs-extra": "11.3.2",
+    "react": "19.2.0",
+    "react-dom": "19.2.0",
+    "typedoc": "0.28.14",
+    "typedoc-plugin-missing-exports": "4.1.2"
+  }
+}

apps/build-docs/package.json

@@ -0,0 +1,36 @@
+/**
+ * The backend script API is accessible to code notes with the "JS (backend)" language.
+ *
+ * The entire API is exposed as a single global: {@link api}
+ *
+ * @module Backend Script API
+ */
+
+/**
+ * This file creates the entrypoint for TypeDoc that simulates the context from within a
+ * script note on the server side.
+ *
+ * Make sure to keep in line with backend's `script_context.ts`.
+ */
+
+export type { default as AbstractBeccaEntity } from "../../server/src/becca/entities/abstract_becca_entity.js";
+export type { default as BAttachment } from "../../server/src/becca/entities/battachment.js";
+export type { default as BAttribute } from "../../server/src/becca/entities/battribute.js";
+export type { default as BBranch } from "../../server/src/becca/entities/bbranch.js";
+export type { default as BEtapiToken } from "../../server/src/becca/entities/betapi_token.js";
+export type { BNote };
+export type { default as BOption } from "../../server/src/becca/entities/boption.js";
+export type { default as BRecentNote } from "../../server/src/becca/entities/brecent_note.js";
+export type { default as BRevision } from "../../server/src/becca/entities/brevision.js";
+
+import BNote from "../../server/src/becca/entities/bnote.js";
+import BackendScriptApi, { type Api } from "../../server/src/services/backend_script_api.js";
+
+export type { Api };
+
+const fakeNote = new BNote();
+
+/**
+ * The `api` global variable allows access to the backend script API, which is documented in {@link Api}.
+ */
+export const api: Api = new BackendScriptApi(fakeNote, {});

apps/build-docs/src/backend_script_entrypoint.ts

@@ -4,14 +4,17 @@ process.env.NODE_ENV = "development";
 
 import cls from "@triliumnext/server/src/services/cls.js";
 import { dirname, join, resolve } from "path";
-import fs, { copyFile } from "fs/promises";
-import fsExtra, { createWriteStream, type WriteStream } from "fs-extra";
+import * as fs from "fs/promises";
+import * as fsExtra from "fs-extra";
 import archiver from "archiver";
+import { WriteStream } from "fs";
+import { execSync } from "child_process";
+import BuildContext from "./context.js";
 
 const DOCS_ROOT = "../../../docs";
 const OUTPUT_DIR = "../../site";
 
-async function main() {
+async function buildDocsInner() {
     const i18n = await import("@triliumnext/server/src/services/i18n.js");
     await i18n.initializeTranslations();
 
@@ -30,7 +33,7 @@ async function main() {
             "export",
             null
         );
-        const fileOutputStream = createWriteStream(zipFilePath);
+        const fileOutputStream = fsExtra.createWriteStream(zipFilePath);
         await exportToZip(taskContext, branch, "share", fileOutputStream);
         await waitForStreamToFinish(fileOutputStream);
         await extractZip(zipFilePath, OUTPUT_DIR);
@@ -41,7 +44,7 @@ async function main() {
     }
 
     // Copy favicon.
-    await copyFile("../../apps/website/src/assets/favicon.ico", join(OUTPUT_DIR, "favicon.ico"));
+    await fs.copyFile("../../apps/website/src/assets/favicon.ico", join(OUTPUT_DIR, "favicon.ico"));
 
     console.log("Documentation built successfully!");
 }
@@ -106,4 +109,19 @@ export async function extractZip(zipFilePath: string, outputPath: string, ignore
     });
 }
 
-cls.init(main);
+export default async function buildDocs({ gitRootDir }: BuildContext) {
+    // Build the share theme.
+    execSync(`pnpm run --filter share-theme build`, {
+        stdio: "inherit",
+        cwd: gitRootDir
+    });
+
+    // Trigger the actual build.
+    await new Promise((res, rej) => {
+        cls.init(() => {
+            buildDocsInner()
+                .catch(rej)
+                .then(res);
+        });
+    });
+}

apps/edit-docs/src/build-docs.ts renamed to apps/build-docs/src/build-docs.ts

@@ -0,0 +1,4 @@
+export default interface BuildContext {
+    gitRootDir: string;
+    baseDir: string;
+}

apps/build-docs/src/context.ts

@@ -0,0 +1,28 @@
+/**
+ * The front script API is accessible to code notes with the "JS (frontend)" language.
+ *
+ * The entire API is exposed as a single global: {@link api}
+ *
+ * @module Frontend Script API
+ */
+
+/**
+ * This file creates the entrypoint for TypeDoc that simulates the context from within a
+ * script note.
+ *
+ * Make sure to keep in line with frontend's `script_context.ts`.
+ */
+
+export type { default as BasicWidget } from "../../client/src/widgets/basic_widget.js";
+export type { default as FAttachment } from "../../client/src/entities/fattachment.js";
+export type { default as FAttribute } from "../../client/src/entities/fattribute.js";
+export type { default as FBranch } from "../../client/src/entities/fbranch.js";
+export type { default as FNote } from "../../client/src/entities/fnote.js";
+export type { Api } from "../../client/src/services/frontend_script_api.js";
+export type { default as NoteContextAwareWidget } from "../../client/src/widgets/note_context_aware_widget.js";
+export type { default as RightPanelWidget } from "../../client/src/widgets/right_panel_widget.js";
+
+import FrontendScriptApi, { type Api } from "../../client/src/services/frontend_script_api.js";
+
+//@ts-expect-error
+export const api: Api = new FrontendScriptApi();

apps/build-docs/src/frontend_script_entrypoint.ts

@@ -0,0 +1,26 @@
+import { join } from "path";
+import BuildContext from "./context";
+import buildSwagger from "./swagger";
+import { existsSync, mkdirSync, rmSync } from "fs";
+import buildDocs from "./build-docs";
+import buildScriptApi from "./script-api";
+
+const context: BuildContext = {
+    gitRootDir: join(__dirname, "../../../"),
+    baseDir: join(__dirname, "../../../site")
+};
+
+async function main() {
+    // Clean input dir.
+    if (existsSync(context.baseDir)) {
+        rmSync(context.baseDir, { recursive: true });
+    }
+    mkdirSync(context.baseDir);
+
+    // Start building.
+    await buildDocs(context);
+    buildSwagger(context);
+    buildScriptApi(context);
+}
+
+main();

apps/build-docs/src/main.ts

@@ -0,0 +1,15 @@
+import { execSync } from "child_process";
+import BuildContext from "./context";
+import { join } from "path";
+
+export default function buildScriptApi({ baseDir, gitRootDir }: BuildContext) {
+    // Generate types
+    execSync(`pnpm typecheck`, { stdio: "inherit", cwd: gitRootDir });
+
+    for (const config of [ "backend", "frontend" ]) {
+        const outDir = join(baseDir, "script-api", config);
+        execSync(`pnpm typedoc --options typedoc.${config}.json --html "${outDir}"`, {
+            stdio: "inherit"
+        });
+    }
+}

apps/build-docs/src/script-api.ts

@@ -0,0 +1,32 @@
+import BuildContext from "./context";
+import { join } from "path";
+import { execSync } from "child_process";
+import { mkdirSync } from "fs";
+
+interface BuildInfo {
+    specPath: string;
+    outDir: string;
+}
+
+const DIR_PREFIX = "rest-api";
+
+const buildInfos: BuildInfo[] = [
+    {
+        // Paths are relative to Git root.
+        specPath: "apps/server/internal.openapi.yaml",
+        outDir: `${DIR_PREFIX}/internal`
+    },
+    {
+        specPath: "apps/server/etapi.openapi.yaml",
+        outDir: `${DIR_PREFIX}/etapi`
+    }
+];
+
+export default function buildSwagger({ baseDir, gitRootDir }: BuildContext) {
+    for (const { specPath, outDir } of buildInfos) {
+        const absSpecPath = join(gitRootDir, specPath);
+        const targetDir = join(baseDir, outDir);
+        mkdirSync(targetDir, { recursive: true });
+        execSync(`pnpm redocly build-docs ${absSpecPath} -o ${targetDir}/index.html`, { stdio: "inherit" });
+    }
+}