dsh-featherhunter-plugin-base 0.0.0-stage → 0.0.2-drill

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FeatherHunter
+
+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/README.md

@@ -1,3 +1,47 @@
-# Temporary Holding Version
+# dsh-featherhunter-plugin-base
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+FeatherHunter DSH 插件共用的基础包：设置面板里的**联系作者弹窗 / 作者插件推荐卡**，
+以及 **README 四块内容**（联系区、star 历史、致谢、MORE）的渲染与同步工具。
+
+- 纯 ESM，零运行时依赖，单包三入口。
+- `./client` 不 import React：宿主把 React 传进 `createBaseUI(React, options)`，共享宿主的 reconciler。
+- 数据唯一真源在仓库 `contact/`，构建后发布为 `data/manifest.json` + `data/img/`，经 npm CDN 分发。
+- 首次渲染用包内置基线（飞书 + QQ），随后回源更新；二维码过期时降级为链接。
+
+## 入口
+
+| 入口 | 内容 |
+| --- | --- |
+| `dsh-featherhunter-plugin-base/core` | 类型、manifest 校验、排序 / 语言 / 有效期工具、内置基线 |
+| `dsh-featherhunter-plugin-base/client` | `createBaseUI(React, options)`：`ContactButton` / `ContactRow` / `AuthorPlugins` / `openContactModal` / `closeContactModal` / `preloadContent` |
+| `dsh-featherhunter-plugin-base/node` | README 四块渲染器 + `verifyBlock` + CLI（`readme:init` / `readme:sync` / `contact:update` / `doctor`） |
+
+## 使用
+
+```ts
+import { createBaseUI } from "dsh-featherhunter-plugin-base/client";
+
+const base = createBaseUI(React, { lang: "zh", selfId: "deck" });
+// <base.ContactButton /> / <base.AuthorPlugins />
+```
+
+```sh
+npx dsh-base readme:sync --check
+npx dsh-base doctor
+```
+
+## 开发
+
+```sh
+npm install
+npm run typecheck
+npm test
+npm run build
+npm run build:demo   # demo/index.html 可直接用浏览器打开
+```
+
+数据从源图到发布清单的完整流程见票 03；CDN 分发与回滚见票 02。
+
+## License
+
+MIT

package/data/manifest.json

@@ -0,0 +1,158 @@
+{
+  "schema": 1,
+  "version": "0.0.2-drill",
+  "revision": 2,
+  "updatedAt": "2026-10-31T00:00:00+08:00",
+  "fallbackUrl": "https://github.com/FeatherHunter/featherhunter-plugin-manage",
+  "groups": [
+    {
+      "id": "feishu",
+      "platform": "feishu",
+      "order": 10,
+      "readmeTitle": {
+        "zh": "飞书群（主）",
+        "en": "Feishu Group (Main)"
+      },
+      "alt": {
+        "zh": "DSH 插件交流群 飞书群二维码",
+        "en": "DSH plugin community group Feishu QR code"
+      },
+      "card": "card-feishu.png",
+      "qr": {
+        "kind": "remote",
+        "path": "qr-feishu.png"
+      },
+      "title": {
+        "zh": "DSH 插件交流群",
+        "en": "DSH Plugin Community"
+      },
+      "subtitle": {
+        "zh": "用户418832的组织",
+        "en": "User 418832's organization"
+      },
+      "note": {
+        "zh": "该二维码永久有效",
+        "en": "This QR code never expires"
+      }
+    },
+    {
+      "id": "qq",
+      "platform": "qq",
+      "order": 20,
+      "readmeTitle": {
+        "zh": "QQ群（新）",
+        "en": "QQ Group (New)"
+      },
+      "alt": {
+        "zh": "DSH 插件交流群 QQ 群二维码",
+        "en": "DSH plugin community group QQ QR code"
+      },
+      "card": "card-qq.png",
+      "qr": {
+        "kind": "remote",
+        "path": "qr-qq.png"
+      },
+      "title": {
+        "zh": "DSH 插件交流群",
+        "en": "DSH Plugin Community"
+      },
+      "subtitle": {
+        "zh": "群号：1020866453",
+        "en": "Group ID: 1020866453"
+      },
+      "note": {
+        "zh": "扫一扫二维码，加入群聊",
+        "en": "Scan the QR code to join the group chat"
+      }
+    },
+    {
+      "id": "wechat",
+      "platform": "wechat",
+      "order": 30,
+      "readmeTitle": {
+        "zh": "微信群（新）",
+        "en": "WeChat Group (New)"
+      },
+      "alt": {
+        "zh": "DSH 插件交流群微信群二维码",
+        "en": "DSH plugin community group WeChat QR code"
+      },
+      "card": "card-wechat-2026-11-06.png",
+      "qr": {
+        "kind": "remote",
+        "path": "qr-wechat-2026-11-06.png"
+      },
+      "title": {
+        "zh": "DSH 插件交流群",
+        "en": "DSH Plugin Community"
+      },
+      "subtitle": {
+        "zh": "群聊：DSH 插件交流群",
+        "en": "Group chat: DSH Plugin Community"
+      },
+      "validUntil": "2026-11-06"
+    }
+  ],
+  "plugins": [
+    {
+      "id": "deck",
+      "order": 10,
+      "verifiedAt": "2026-10-30",
+      "name": "dsh-mattpocock-skills-deck",
+      "repo": "FeatherHunter/dsh-mattpocock-skills-deck",
+      "desc": {
+        "zh": "近 30 万 star 的 mattpocock/skills 整套预置好（27 个技能），装好即用。",
+        "en": "The whole mattpocock/skills set (nearly 300k stars) preinstalled — 27 skills, ready as soon as it is installed."
+      },
+      "url": "https://github.com/FeatherHunter/dsh-mattpocock-skills-deck"
+    },
+    {
+      "id": "prompt",
+      "order": 20,
+      "verifiedAt": "2026-10-30",
+      "name": "dsh-prompt",
+      "repo": "FeatherHunter/dsh-prompt",
+      "desc": {
+        "zh": "经常反复重复的模板化提示词，存成自定义模板，选中后直接注入，不再需要耗费精力。",
+        "en": "The boilerplate prompts you keep retyping, saved as custom templates and injected on selection — no more wasted effort."
+      },
+      "url": "https://github.com/FeatherHunter/dsh-prompt"
+    },
+    {
+      "id": "palette",
+      "order": 30,
+      "verifiedAt": "2026-10-30",
+      "name": "dsh-opencode-palette",
+      "repo": "FeatherHunter/dsh-opencode-palette",
+      "desc": {
+        "zh": "38 款 opencode 经典配色 + 20+自定义主题 一键换装 DSH。",
+        "en": "38 classic opencode themes + 20+ custom themes — reskin DSH in one click."
+      },
+      "url": "https://github.com/FeatherHunter/dsh-opencode-palette"
+    },
+    {
+      "id": "im",
+      "order": 40,
+      "verifiedAt": "2026-10-30",
+      "name": "dsh-im-companion",
+      "repo": "FeatherHunter/dsh-im-companion",
+      "desc": {
+        "zh": "给 dsh-im 加了「助理」和「家」的概念。",
+        "en": "Adds the ideas of an “assistant” and a “home” to dsh-im."
+      },
+      "url": "https://github.com/FeatherHunter/dsh-im-companion"
+    },
+    {
+      "id": "ilife",
+      "order": 50,
+      "verifiedAt": "2026-10-30",
+      "name": "ilife",
+      "repo": "FeatherHunter/ilife",
+      "desc": {
+        "zh": "⚠️建设中⚠️爱生活：居家生活套件，记账、运动、饮食、体重、食谱、物品管理、作息规划、备忘录等。",
+        "en": "⚠️Work in progress⚠️ iLife, the home-life suite: bookkeeping, exercise, diet, weight, recipes, item management, schedule planning, memos and more."
+      },
+      "url": "https://github.com/FeatherHunter/ilife"
+    }
+  ]
+}

package/dist/client/content.d.ts

@@ -0,0 +1,116 @@
+import type { Manifest } from "../core/types";
+/**
+ * Remote manifest transport (ticket 05).
+ *
+ * The contact modal must always paint the bundled baseline first and only then
+ * swap in the published manifest. Everything in this module is therefore
+ * best-effort: any failure (timeout, HTTP error, invalid JSON, invalid data,
+ * oversized image) silently degrades to the baseline, never to an error state.
+ */
+/** Published package name; the CDN URLs below are derived from it. */
+export declare const PACKAGE_NAME = "dsh-featherhunter-plugin-base";
+/** One request may take at most 1.5s; there are no retries. */
+export declare const MANIFEST_TIMEOUT_MS = 1500;
+/** A fetched manifest (success or failure) is reused for 30 minutes. */
+export declare const MANIFEST_CACHE_TTL_MS: number;
+/** Hard cap for a single QR image, enforced before it is shown. */
+export declare const MAX_IMAGE_BYTES: number;
+/** The only hosts the client is allowed to talk to (images and manifest). */
+export declare const ALLOWED_CDN_HOSTS: readonly string[];
+/** Minimal structural view of a fetch Response; easy to fake in tests. */
+export interface FetchResponseLike {
+    ok: boolean;
+    status: number;
+    headers: {
+        get(name: string): string | null;
+    };
+    text(): Promise<string>;
+    arrayBuffer(): Promise<ArrayBuffer>;
+}
+export type FetchLike = (url: string, init?: {
+    signal?: AbortSignal;
+    cache?: string;
+    credentials?: string;
+}) => Promise<FetchResponseLike>;
+/** A loaded and validated manifest plus the QR images prefetched for it. */
+export interface LoadedContent {
+    manifest: Manifest;
+    /** Channel name that produced the manifest ("unpkg" / "npmmirror" / ...). */
+    source: string;
+    /** Timestamp (loader clock) at which the manifest was accepted. */
+    fetchedAt: number;
+    /** Prefetched QR images keyed by "<version>/<path>", values are data URIs. */
+    images: Map<string, string>;
+}
+/** Context handed to a channel loader. */
+export interface ChannelContext {
+    packageName: string;
+    fetchText: (url: string) => Promise<string>;
+    fetchJson: (url: string) => Promise<unknown>;
+}
+/** One CDN channel; the channels are tried in array order. */
+export interface ManifestChannel {
+    name: string;
+    load: (context: ChannelContext) => Promise<{
+        raw: unknown;
+        url: string;
+    }>;
+}
+export interface ContentLoaderOptions {
+    /** Explicit manifest URL; when set, the default CDN channels are not used. */
+    manifestUrl?: string;
+    packageName?: string;
+    fetchImpl?: FetchLike;
+    timeoutMs?: number;
+    maxImageBytes?: number;
+    /** Clock override (testing seam). */
+    now?: () => number;
+    /** Channel override (testing seam). */
+    channels?: ManifestChannel[];
+}
+/** True for https URLs only. */
+export declare function isHttpsUrl(value: string): boolean;
+/** True when the URL is https and its host is on the CDN allowlist. */
+export declare function isAllowedCdnUrl(value: string): boolean;
+/** Exact-version QR image URLs, primary jsDelivr then the npmmirror mirror. */
+export declare function imageUrls(version: string, path: string, packageName?: string): string[];
+/** The three published channels, in fallback order. */
+export declare function defaultChannels(packageName?: string): ManifestChannel[];
+/**
+ * Validate a remote manifest beyond what parseManifest checks: length limits
+ * for user-visible text, a sane version, safe image paths and https links.
+ * Throws an Error whose message starts with "manifest: ".
+ */
+export declare function validateRemoteManifest(raw: unknown): Manifest;
+/** Drop the module cache; tests use this, production never needs it. */
+export declare function resetContentCache(): void;
+export declare class ContentLoader {
+    readonly packageName: string;
+    readonly timeoutMs: number;
+    readonly maxImageBytes: number;
+    private readonly fetchImpl;
+    private readonly now;
+    private readonly channels;
+    constructor(options?: ContentLoaderOptions);
+    /** Cached content when it is still inside the 30 minute window. */
+    getCached(): LoadedContent | null;
+    /**
+     * Fetch and validate the manifest once per 30 minutes; concurrent callers
+     * share one request. Resolves to null when every channel failed.
+     */
+    load(): Promise<LoadedContent | null>;
+    /** Prefetch every remote QR image of a manifest (best effort). */
+    ensureImages(content: LoadedContent): Promise<void>;
+    /** Data URI for a remote QR path, or null when it is not prefetched. */
+    imageFor(content: LoadedContent | null, path: string): string | null;
+    /** Warm the cache: manifest plus images. Never rejects. */
+    preload(): Promise<void>;
+    private loadImage;
+    private fetchImage;
+    private fetchContent;
+    private fetchText;
+    /** One request with the 1.5s abort window; the timer is always cleared. */
+    private request;
+}
+/** Build a loader bound to the published package (or a custom manifest URL). */
+export declare function createContentLoader(options?: ContentLoaderOptions): ContentLoader;

package/dist/client/index.d.ts

@@ -0,0 +1,15 @@
+import type * as ReactNamespace from "react";
+import type { BaseUI, BaseUIOptions } from "./types";
+export type * from "./types";
+/**
+ * Build the settings-panel widgets bound to the injected React runtime.
+ *
+ * The client bundle never imports React: the host passes its own copy so this
+ * package shares the host's reconciler and context.
+ */
+export declare function createBaseUI(React: typeof ReactNamespace, options?: BaseUIOptions): BaseUI;
+export { BASE_CSS, BASE_STYLE_ID, ensureBaseStyles } from "./styles";
+export { MESSAGES, resolveText } from "./texts";
+export type { TextKey, TextOverrides } from "./texts";
+export { ALLOWED_CDN_HOSTS, ContentLoader, MANIFEST_CACHE_TTL_MS, MANIFEST_TIMEOUT_MS, MAX_IMAGE_BYTES, createContentLoader, defaultChannels, imageUrls, isAllowedCdnUrl, isHttpsUrl, resetContentCache, validateRemoteManifest, } from "./content";
+export type { ContentLoaderOptions, FetchLike, FetchResponseLike, LoadedContent, ManifestChannel } from "./content";