@nsnanocat/preference-panes 0.9.16 → 1.1.0

package/src/build.mjs

@@ -1,5 +1,5 @@
 import { readFile } from "node:fs/promises";
-import { BoxJS } from "./BoxJS.mjs";
+import { normalizeBoxJs } from "./browser/boxjs.mjs";
 
 /**
  * 仅生成模块前端文件，不复制配置或生成绑定业务的读写脚本。
@@ -10,12 +10,11 @@ import { BoxJS } from "./BoxJS.mjs";
  */
 export async function build(boxjs, css = "") {
     if (typeof css !== "string") throw new TypeError("CSS must be a string");
-    const catalog = new BoxJS(boxjs);
-    const module = catalog.module.module;
-    const [html, app] = await Promise.all([readFile(new URL("../dist/module/index.html", import.meta.url), "utf8"), readFile(new URL("../dist/module/app.mjs", import.meta.url), "utf8")]);
+    const module = normalizeBoxJs(boxjs).module;
+    const [html, index] = await Promise.all([readFile(new URL("../dist/module/index.html", import.meta.url), "utf8"), readFile(new URL("../dist/module/index.mjs", import.meta.url), "utf8")]);
     return {
         [`settings/${module}/index.html`]: html,
-        "settings/assets/app.mjs": app,
+        "settings/assets/index.mjs": index,
         [`settings/assets/${module}.css`]: css,
     };
 }

package/src/index.d.ts

@@ -92,8 +92,8 @@ export interface SettingsRequest {
      */
     headers?: Record<string, string | undefined>;
     /**
-     * POST 的正文为一个 form 字段，字段名是完整 @root.path
-     * POST contains one form field whose name is the complete @root.path.
+     * 模块动作的 JSON 正文
+     * JSON body for a module action.
      */
     body?: string;
 }
@@ -268,6 +268,20 @@ export interface BoxJSSubscription extends BoxJSMetadata {
  * The sole data configuration input.
  */
 export type BoxJSInput = BoxJSSetting[] | BoxJSApp | BoxJSSubscription;
+/**
+ * 模块 API 返回的原始 BoxJS 与当前值模型。
+ * Raw BoxJS and current-value model returned by the module API.
+ */
+export interface ModuleModel {
+    /** 模块路径段 / Module path segment. */
+    module: string;
+    /** API 获取的原始 BoxJS JSON / Raw BoxJS JSON fetched by the API. */
+    boxjs: BoxJSInput;
+    /** API 读取到的原始已保存字段值 / Raw persisted field values read by the API. */
+    values: Record<string, JsonValue>;
+    /** 后续 API 动作使用的 BoxJS JSON 地址 / BoxJS JSON URL used by later API actions. */
+    configURL: string;
+}
 /**
  * 生成模块前端文件，不复制配置、不生成绑定模块的代理脚本。
  * Build module frontend files without copying configuration or producing bound proxy scripts.

package/src/web.mjs

@@ -0,0 +1,52 @@
+import { URL } from "@nsnanocat/url";
+import { $app } from "@nsnanocat/util/lib/app.mjs";
+import { done } from "@nsnanocat/util/lib/done.mjs";
+import assets from "#assets";
+import { pageInputs } from "./lib/page-inputs.mjs";
+
+/**
+ * 返回模块页面及其公共浏览器资源，不处理 API、网络或持久化。
+ * Serve module pages and common browser assets without handling APIs, network access or persistence.
+ * @returns {void} 响应已交给代理宿主 / Response delivered to the proxy host.
+ */
+function run() {
+    const request = globalThis.$request;
+    let result;
+    try {
+        const url = new URL(request.url);
+        if (/^\/settings\/[a-zA-Z0-9_-]+\/?$/.test(url.pathname)) {
+            if (!["GET", "HEAD"].includes(request.method)) result = response(request, 405, { error: "Method not allowed" });
+            else {
+                const inputs = encodeURIComponent(JSON.stringify(pageInputs(url, request.headers)));
+                result = response(request, 200, assets.page.body.replace("</head>", `<meta name="preference-panes-inputs" content="${inputs}"></head>`), "text/html");
+            }
+        } else {
+            const asset = assets[url.pathname];
+            if (asset) result = ["GET", "HEAD"].includes(request.method) ? response(request, 200, asset.body, asset.type) : response(request, 405, { error: "Method not allowed" });
+        }
+    } catch (error) {
+        console.error(`PreferencePanes Web: ${error.message}`);
+        result = response(request, 500, { error: error.message });
+    }
+    if (!result) done({});
+    else done($app === "Quantumult X" ? result : { response: result });
+}
+
+/**
+ * 构造静态资源响应，HEAD 请求不返回正文。
+ * Build a static resource response without a body for HEAD requests.
+ * @param {import("./index.js").SettingsRequest} request 代理请求 / Proxy request.
+ * @param {number} status HTTP 状态 / HTTP status.
+ * @param {unknown} body 响应正文 / Response body.
+ * @param {string} [type] 媒体类型 / Media type.
+ * @returns {import("./index.js").SettingsResponse} 静态资源响应 / Static resource response.
+ */
+function response(request, status, body, type = "application/json") {
+    return {
+        status,
+        headers: { "Content-Type": `${type}; charset=utf-8`, "Cache-Control": "no-store", "X-Content-Type-Options": "nosniff" },
+        body: request.method === "HEAD" ? "" : type === "application/json" ? JSON.stringify(body) : body,
+    };
+}
+
+run();