@nsnanocat/preference-panes 0.9.16 → 1.0.0

package/src/BoxJS.mjs

@@ -1,72 +0,0 @@
-import { validatePathParts } from "./lib/settings-path.mjs";
-
-/**
- * BoxJS 的共同目录：模块、存储根和展示元数据都来自同一份 JSON。
- * Shared BoxJS catalog deriving modules, storage roots and metadata from one JSON document.
- */
-export class BoxJS {
-    /**
-     * 建立路径索引，不解析控件类型，也不读写持久化存储。
-     * Index field paths without interpreting controls or accessing persistence.
-     * @param {unknown} input 字段数组、单个 app 或 apps 订阅 / Field array, app or apps subscription.
-     */
-    constructor(input) {
-        if (!input || typeof input !== "object") throw new TypeError("Expected BoxJS JSON");
-        const document = JSON.parse(JSON.stringify(input));
-        const apps = Array.isArray(document) ? [{ settings: document }] : (document.apps ?? [document]);
-        if (!Array.isArray(apps)) throw new TypeError("Expected BoxJS apps array");
-        this.modules = new Map();
-        for (const app of apps) {
-            if (!app || !Array.isArray(app.settings)) throw new TypeError("Expected BoxJS settings array");
-            for (const entry of app.settings) {
-                if (typeof entry.id !== "string") throw new TypeError("BoxJS settings require string IDs");
-                if (!entry.id.startsWith("@")) {
-                    if (Array.isArray(document)) throw new TypeError("BoxJS settings require @root.path IDs");
-                    continue;
-                }
-                const [storageKey, ...parts] = entry.id.slice(1).split(".");
-                if (!storageKey || storageKey.startsWith("@") || parts.length < 2) throw new TypeError("A BoxJS setting must be below a literal storage root and module");
-                validatePathParts(parts);
-                const module = parts[0];
-                let target = this.modules.get(module);
-                if (!target) {
-                    target = { module, storageKey, entries: [], owners: new Set() };
-                    this.modules.set(module, target);
-                }
-                if (target.storageKey !== storageKey) throw new TypeError(`A module must use one storage root: ${module}`);
-                target.entries.push(entry);
-                target.owners.add(app);
-            }
-        }
-        this.metadata = metadata(Array.isArray(document) ? {} : document);
-        for (const target of this.modules.values()) target.metadata = target.owners.size === 1 ? metadata([...target.owners][0]) : {};
-    }
-
-    /**
-     * 取得本次导入的唯一模块，避免把模块数据变成项目目录。
-     * Get the single imported module without turning module data into a project directory.
-     * @returns {object} 唯一模块的目录项 / The single module entry.
-     */
-    get module() {
-        if (this.modules.size !== 1) throw new TypeError("Import BoxJS JSON for exactly one module");
-        return this.modules.values().next().value;
-    }
-}
-
-/**
- * 保留标准 BoxJS 展示信息；script 仅为元数据，不执行。
- * Retain standard BoxJS presentation data; script is metadata only and never executed.
- * @param {object} source BoxJS app 或订阅 / BoxJS app or subscription.
- * @returns {object} 经过类型检查的展示信息 / Type-checked presentation metadata.
- */
-function metadata(source) {
-    const result = {};
-    for (const key of ["id", "name", "author", "repo", "script", "icon", "description", "desc", "icons", "descs"]) {
-        if (source[key] === undefined) continue;
-        const multiple = key === "icons" || key === "descs";
-        const values = multiple ? source[key] : [source[key]];
-        if (!Array.isArray(values) || values.some(item => typeof item !== "string")) throw new TypeError(`Invalid BoxJS app ${key}`);
-        result[key] = multiple ? [...values] : source[key];
-    }
-    return result;
-}

package/src/Store.mjs

@@ -1,114 +0,0 @@
-import { URL } from "@nsnanocat/url";
-import { Lodash as _ } from "@nsnanocat/util/polyfill/Lodash.mjs";
-import { Storage } from "@nsnanocat/util/polyfill/Storage";
-import { response } from "./lib/response.mjs";
-import { validatePathParts } from "./lib/settings-path.mjs";
-
-/**
- * 无配置绑定的本地存储桥接；form 字段名就是完整 @root.path。
- * Unbound local storage bridge; the form field name is the complete @root.path.
- */
-export class Store {
-    /**
-     * POST /api/get、set、delete；不下载配置、不解析控件、不鉴权。
-     * POST /api/get, set or delete without config downloads, control parsing or authentication.
-     * @param {import("./index.js").SettingsRequest} request 代理请求 / Proxy request.
-     * @param {URL} [url] 已解析地址 / Parsed URL.
-     * @returns {Promise<import("./index.js").SettingsResponse | undefined>} 操作结果 / Operation result.
-     */
-    async handle(request, url = new URL(request.url)) {
-        if (!url.pathname.startsWith("/api/")) return;
-        const reply = (status, data) => response(request, status, data);
-        const action = url.pathname.slice(5);
-        if (!["get", "set", "delete"].includes(action)) return reply(404, { error: "Unknown action" });
-        if (request.method !== "POST") return reply(405, { error: "Use POST with a form body" });
-        const headers = Object.fromEntries(Object.entries(request.headers ?? {}).map(([key, value]) => [key.toLowerCase(), value]));
-        if (headers["content-type"]?.split(";")[0].trim().toLowerCase() !== "application/x-www-form-urlencoded") return reply(415, { error: "Expected application/x-www-form-urlencoded" });
-        if (typeof request.body !== "string" || request.body.length > 65536) return reply(400, { error: "Expected a form body up to 65536 characters" });
-        let parts, value;
-        try {
-            const fields = request.body.split("&");
-            if (fields.length !== 1) throw new TypeError("Send exactly one storage key");
-            const separator = fields[0].indexOf("=");
-            if (separator < 0) throw new TypeError("Expected @root.path=value");
-            const key = decodeURIComponent(fields[0].slice(0, separator).replace(/\+/g, " "));
-            value = decodeURIComponent(fields[0].slice(separator + 1).replace(/\+/g, " "));
-            if (!key.startsWith("@")) throw new TypeError("Storage keys must start with @");
-            parts = validatePathParts(key.slice(1).split("."));
-            if (parts.length < 2) throw new TypeError("Specify a storage root and child path");
-        } catch (error) {
-            return reply(400, { error: error.message });
-        }
-        if (action === "set") {
-            try {
-                value = JSON.parse(value);
-            } catch (error) {
-                if (!(error instanceof SyntaxError)) throw error;
-            }
-        }
-        const [storageKey, ...path] = parts;
-        try {
-            const root = Storage.getItem(storageKey, {});
-            if (!isRecord(root)) throw new TypeError("Stored root must be an object");
-            const parent = storageParent(root, path, action === "set");
-            const key = path.at(-1);
-            switch (action) {
-                case "get": {
-                    const result = parent ? _.get(parent, [key]) : undefined;
-                    return result === undefined ? reply(404, { error: "Stored path does not exist" }) : reply(200, result);
-                }
-                case "set":
-                    _.set(parent, [key], value);
-                    break;
-                case "delete":
-                    if (parent) _.unset(parent, [key]);
-                    break;
-            }
-            if (!Storage.setItem(storageKey, root)) throw new Error("Storage write failed");
-            return reply(200, action === "set" ? { saved: true } : { deleted: true });
-        } catch (error) {
-            return reply(500, { error: error.message });
-        }
-    }
-}
-
-/**
- * 判断根节点是否为普通对象。
- * Determine whether a root node is a plain object.
- * @param {unknown} value 待检查值 / Value to inspect.
- * @returns {boolean} 是否为普通对象 / Whether this is a plain object.
- */
-function isRecord(value) {
-    return value !== null && typeof value === "object" && Object.getPrototypeOf(value) === Object.prototype;
-}
-
-/**
- * 遍历父路径，兼容旧存储中 JSON 字符串形式的中间节点。
- * Traverse parents, supporting legacy intermediate nodes serialized as JSON strings.
- * @param {Record<string, unknown>} root 存储根 / Storage root.
- * @param {string[]} parts 完整路径 / Complete path.
- * @param {boolean} create 是否创建缺失节点 / Whether to create missing parents.
- * @returns {object | undefined} 父节点，缺失且不创建时为 undefined / Parent, or undefined when absent and not creating.
- * @throws {TypeError} 无法继续遍历标量节点 / A scalar node cannot be traversed.
- */
-function storageParent(root, parts, create) {
-    let parent = root;
-    for (const part of parts.slice(0, -1)) {
-        let next = _.get(parent, [part]);
-        switch (typeof next) {
-            case "undefined":
-                if (!create) return;
-                next = {};
-                break;
-            case "string":
-                next = JSON.parse(next);
-                break;
-            default:
-                break;
-        }
-        if (!isRecord(next) && !Array.isArray(next)) throw new TypeError("Stored parent is not an object or array");
-        _.set(parent, [part], next);
-        parent = next;
-    }
-    return parent;
-}

package/src/lib/response.mjs

@@ -1,16 +0,0 @@
-/**
- * 统一生成不可缓存的响应，HEAD 始终省略正文。
- * Create an uncached response, always omitting the body for HEAD.
- * @param {import("../index.js").SettingsRequest} request 宿主请求 / Host request.
- * @param {number} status HTTP 状态 / HTTP status.
- * @param {unknown} body JSON 数据或资源正文 / JSON data or resource body.
- * @param {string} [type] 媒体类型 / Media type.
- * @returns {import("../index.js").SettingsResponse} 通用响应 / Common response.
- */
-export 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,
-    };
-}

package/src/proxy/handler.mjs

@@ -1,39 +0,0 @@
-import { URL } from "@nsnanocat/url";
-import assets from "#assets";
-import { pageInputs } from "../lib/page-inputs.mjs";
-import { response } from "../lib/response.mjs";
-import { Store } from "../Store.mjs";
-import { complete } from "./response.mjs";
-
-/**
- * 通用代理入口：提供无鉴权 form 存储 API 及模块页面，不含业务配置。
- * Generic proxy entry serving unauthenticated form storage and module pages without business configuration.
- * @returns {Promise<void>} 已交给代理宿主的响应 / Response delivered to the proxy host.
- */
-async function run() {
-    const request = globalThis.$request;
-    let result;
-    try {
-        const url = new URL(request.url);
-        switch (true) {
-            case url.pathname.startsWith("/api/"):
-                result = await new Store().handle(request, url);
-                break;
-            case /^\/settings\/[a-zA-Z0-9_-]+\/?$/.test(url.pathname): {
-                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");
-                break;
-            }
-            default: {
-                const asset = assets[url.pathname];
-                if (asset) result = response(request, 200, asset.body, asset.type);
-            }
-        }
-        if (result && !url.pathname.startsWith("/api/") && !["GET", "HEAD"].includes(request.method)) result = response(request, 405, { error: "Method not allowed" });
-    } catch (error) {
-        console.error(`PreferencePanes: ${error.message}`);
-        result = response(request, 500, { error: error.message });
-    }
-    complete(result);
-}
-run();

package/src/proxy/response.mjs

@@ -1,16 +0,0 @@
-import { $app } from "@nsnanocat/util/lib/app.mjs";
-import { done } from "@nsnanocat/util/lib/done.mjs";
-
-/**
- * 统一适配代理的完成格式；未接管的请求原样继续。
- * Adapt the host completion format and pass through unhandled requests.
- * @param {import("../index.js").SettingsResponse | undefined} result 通用响应 / Common response.
- * @returns {void} 响应已交给宿主 / Response delivered to the host.
- */
-export function complete(result) {
-    if (!result) {
-        done({});
-        return;
-    }
-    done($app === "Quantumult X" ? result : { response: result });
-}