dsh-skill-hub 0.0.1 → 0.2.0

package/lib/types/protocol.d.ts

@@ -0,0 +1,571 @@
+/**
+ * Shared API contract for dsh-skill-hub: the route paths and payload shapes
+ * both the host half and the browser half import. The browser half must never
+ * depend on host SDK packages, so registry types are re-spelled here as
+ * plain JSON-safe interfaces.
+ */
+/** Browser-facing base paths of the skill-hub API family. */
+export declare const SKILL_HUB_API: {
+    readonly catalog: "/api/skill-hub/catalog";
+    readonly skill: "/api/skill-hub/skill";
+    readonly skillDelete: "/api/skill-hub/skill/delete";
+    readonly toggle: "/api/skill-hub/toggle";
+    readonly toggleBatch: "/api/skill-hub/toggle-batch";
+    readonly create: "/api/skill-hub/create";
+    readonly stats: "/api/skill-hub/stats";
+    readonly config: "/api/skill-hub/config";
+    readonly market: "/api/skill-hub/market";
+    readonly marketSource: "/api/skill-hub/market/source";
+    readonly marketSourceDelete: "/api/skill-hub/market/source/delete";
+    readonly marketSourceRef: "/api/skill-hub/market/source/ref";
+    readonly marketCheck: "/api/skill-hub/market/check";
+    readonly marketSync: "/api/skill-hub/market/source/sync";
+    readonly repo: "/api/skill-hub/repo";
+    readonly repoImport: "/api/skill-hub/repo/import";
+    readonly update: "/api/skill-hub/update";
+    readonly groups: "/api/skill-hub/groups";
+    readonly tag: "/api/skill-hub/tag";
+    readonly tagDelete: "/api/skill-hub/tag/delete";
+    readonly tagMembers: "/api/skill-hub/tag/members";
+    readonly sources: "/api/skill-hub/sources";
+    readonly sourceCheck: "/api/skill-hub/sources/check";
+    readonly sourceSync: "/api/skill-hub/sources/sync";
+    readonly sourceDelete: "/api/skill-hub/sources/delete";
+    readonly sourceRestore: "/api/skill-hub/sources/restore";
+    readonly sourceTrashClear: "/api/skill-hub/sources/trash/clear";
+};
+/** User-level roots the hub may write to (matches dsh-skill-filesystem ranks 400/500). */
+export type WritableRoot = 'user-dsh' | 'user-agents';
+/** Invocation policy resolved by the registry, re-spelled for the wire. */
+export interface HubInvocation {
+    /** Whether model-facing catalogs may load this skill. */
+    modelInvocable: boolean;
+    /** Whether human-facing command catalogs may load this skill. */
+    userInvocable: boolean;
+}
+/** One enabled skill row in the catalog. */
+export interface CatalogSkill {
+    name: string;
+    description: string;
+    whenToUse?: string;
+    invocation: HubInvocation;
+    provider: string;
+    /** Whether the hub may toggle this skill (user-level filesystem skills only). */
+    writable: boolean;
+    /** SKILL.md creation time (epoch ms); used for "added" sorting. Absent when unknown. */
+    addedAt?: number;
+    /** SKILL.md last-modified time (epoch ms); used for "updated" display. Absent when unknown. */
+    updatedAt?: number;
+}
+/** One disabled skill tracked by the hub sidecar (SKILL.md renamed away). */
+export interface DisabledSkill {
+    name: string;
+    description: string;
+    /** Absolute path of the renamed file (SKILL.md.disabled / <name>.md.disabled). */
+    path: string;
+    root: WritableRoot;
+    disabledAt: number;
+}
+/** One discovery diagnostic: a file the filesystem provider skips, with the reason. */
+export interface DiagnosticEntry {
+    path: string;
+    root: string;
+    reason: string;
+}
+/** GET /api/skill-hub/catalog */
+export interface CatalogResponse {
+    ok: true;
+    /** Whether discovery completed within a stable catalog revision. */
+    complete: boolean;
+    /** Sorted winning summaries of every enabled skill (all roots + providers). */
+    skills: CatalogSkill[];
+    /** Skills the hub has toggled off (kept outside provider discovery). */
+    disabled: DisabledSkill[];
+    /** Files in the writable roots the provider ignores, with reasons. */
+    diagnostics: DiagnosticEntry[];
+}
+/** GET /api/skill-hub/skill */
+export interface SkillDetail {
+    name: string;
+    description: string;
+    whenToUse?: string;
+    invocation: HubInvocation;
+    provider: string;
+    /** Absolute file path when the skill came from disk. */
+    path?: string;
+    /** SKILL.md creation time (epoch ms); absent when the file is unreadable. */
+    addedAt?: number;
+    /** SKILL.md last-modified time (epoch ms); absent when the file is unreadable. */
+    updatedAt?: number;
+    /** Markdown instruction body. */
+    content: string;
+}
+export interface SkillDetailResponse {
+    ok: true;
+    skill: SkillDetail;
+}
+/** POST /api/skill-hub/skill/delete — 把单个技能移入回收站（可恢复）。 */
+export interface SkillDeleteRequest {
+    name: string;
+}
+/** POST /api/skill-hub/skill/delete */
+export interface SkillDeleteResponse {
+    ok: true;
+    name: string;
+    /** 移入回收站后的路径（目录或文件）。 */
+    path: string;
+}
+/** POST /api/skill-hub/toggle */
+export interface ToggleRequest {
+    /** Kebab-case skill name. */
+    name: string;
+    /** true re-enables a hub-disabled skill; false disables an enabled one. */
+    enabled: boolean;
+}
+export interface ToggleResponse {
+    ok: true;
+    /** Fresh catalog after the mutation (the filesystem provider may lag a beat). */
+    catalog: CatalogResponse;
+}
+/** POST /api/skill-hub/toggle-batch — one group of skills, one write. */
+export interface ToggleBatchRequest {
+    names: string[];
+    enabled: boolean;
+}
+/** POST /api/skill-hub/toggle-batch */
+export interface ToggleBatchResponse {
+    ok: true;
+    catalog: CatalogResponse;
+    /** Per-name failures (unknown/read-only skills); empty means all landed. */
+    failures: Array<{
+        name: string;
+        error: string;
+    }>;
+}
+/** POST /api/skill-hub/create */
+export interface CreateRequest {
+    /** Kebab-case skill name (validated with the official isSkillName grammar). */
+    name: string;
+    /** Optional one-line routing description for the frontmatter. */
+    description?: string;
+    /** Target user root; defaults to user-dsh (~/.dsh/skills). */
+    root?: WritableRoot;
+}
+export interface CreateResponse {
+    ok: true;
+    path: string;
+    root: WritableRoot;
+}
+/** One skill's invocation stats across the local session logs. */
+export interface SkillStat {
+    /** Kebab-case skill name. */
+    name: string;
+    /** How many sessions recorded a user-explicit invocation of this skill. */
+    count: number;
+    /** Unix epoch ms of the most recent invocation (absent when never called). */
+    lastUsed?: number;
+}
+/** GET /api/skill-hub/stats */
+export interface StatsResponse {
+    ok: true;
+    /** Whether a session-log source was available (false means counts are empty). */
+    available: boolean;
+    /** Sorted per-skill invocation counts. */
+    stats: SkillStat[];
+}
+/** JSON error body shared by every route. */
+export interface ErrorResponse {
+    error: string;
+}
+/** The skill hub's own runtime configuration, edited from the settings card. */
+export interface HubConfig {
+    /** Master switch: routes, provider, and announcement all go live with this. */
+    enabled: boolean;
+    /** When true, a system-prompt section announces the hub to every agent. */
+    announceToAgent: boolean;
+    /** Model-invocable dot color (#rrggbb); absent means the panel default. */
+    dotModelColor?: string;
+    /** User-invocable dot color (#rrggbb); absent means the panel default. */
+    dotUserColor?: string;
+    /** Show per-skill invocation count chip. Default true. */
+    showUseCount?: boolean;
+    /** Show per-skill last-used relative time. Default true. */
+    showUseTime?: boolean;
+    /** Show group-header usage summaries (count + last used). Default true. */
+    showGroupSummary?: boolean;
+}
+/**
+ * Hub config defaults — the single source every layer reads: the cordis
+ * schema (index.ts), the host's saved-override merge, and the routes'
+ * fallback view. Changing a default here changes all three.
+ */
+export declare const HUB_CONFIG_DEFAULTS: {
+    readonly enabled: true;
+    readonly announceToAgent: true;
+    readonly showUseCount: true;
+    readonly showUseTime: true;
+    readonly showGroupSummary: true;
+};
+/**
+ * Resolve the effective hub config: saved sidecar overrides win over the
+ * cordis composition entry (the web card owns runtime config), missing
+ * booleans fall back to HUB_CONFIG_DEFAULTS, and dot colors pass through
+ * (saved first, then base) only when set.
+ */
+export declare function resolveHubConfig(saved: Partial<HubConfig>, base?: Partial<HubConfig>): HubConfig;
+/** HEX color validation shared by host routes and the settings card. */
+export declare const HEX_COLOR_RE: RegExp;
+/** GET /api/skill-hub/config */
+export interface ConfigResponse {
+    ok: true;
+    /** Effective configuration (saved overrides merged over the defaults). */
+    config: HubConfig;
+    /** Raw user overrides persisted in the sidecar (absent fields inherit defaults). */
+    saved: Partial<HubConfig>;
+}
+/** POST /api/skill-hub/config — a partial patch; omitted fields keep their values. */
+export interface ConfigRequest {
+    /** Set the field; null clears the saved override so it re-inherits the default. */
+    enabled?: boolean | null;
+    /** Set the field; null clears the saved override so it re-inherits the default. */
+    announceToAgent?: boolean | null;
+    /** Set the field; null clears the saved override so it re-inherits the default. */
+    showUseCount?: boolean | null;
+    /** Set the field; null clears the saved override so it re-inherits the default. */
+    showUseTime?: boolean | null;
+    /** Set the field; null clears the saved override so it re-inherits the default. */
+    showGroupSummary?: boolean | null;
+    /** Set the dot color; null clears the saved override so it re-inherits the default. */
+    dotModelColor?: string | null;
+    /** Set the dot color; null clears the saved override so it re-inherits the default. */
+    dotUserColor?: string | null;
+}
+/** One market source: a tracked upstream repo plus its pinned version. */
+export interface MarketSourceRecord {
+    /** Repo slug (owner/repo). */
+    repo: string;
+    /** Pinned version: release tag, branch name, or custom ref. Absent = not yet pinned. */
+    ref?: string;
+    /** Commit the pinned ref last resolved to (update-check baseline). */
+    commitSha?: string;
+}
+/** GET /api/skill-hub/market — the user's added market sources. */
+export interface MarketSourcesResponse {
+    ok: true;
+    /** Added market sources, in addition order. */
+    repos: MarketSourceRecord[];
+}
+/** POST /api/skill-hub/market/source — add one repo as a market source. */
+export interface MarketSourceRequest {
+    /** owner/repo, owner/repo@ref, or a github.com URL. */
+    repo: string;
+}
+/** POST /api/skill-hub/market/source|delete */
+export interface MarketSourceResponse {
+    ok: true;
+    repos: MarketSourceRecord[];
+}
+/** POST /api/skill-hub/market/source/ref — pin a market source to an explicit ref. */
+export interface MarketSourceRefRequest {
+    repo: string;
+    /** Release tag or branch name chosen for the repo. */
+    ref: string;
+}
+/** GET /api/skill-hub/market/check — update check over market sources. */
+export interface MarketCheckResponse {
+    ok: true;
+    results: Array<{
+        repo: string;
+        /** Pinned ref, when one is recorded. */
+        ref?: string;
+        /** Latest release tag on the repo, when it has one. */
+        latestTag?: string;
+        /** Whether the pinned ref (or the repo) has moved ahead. */
+        updateAvailable: boolean;
+        /** Latest commit of the checked ref. */
+        commitSha: string;
+        /** Throttled: the check was skipped within the interval. */
+        throttled?: boolean;
+        error?: string;
+    }>;
+}
+/** POST /api/skill-hub/market/source/sync — align a market source to its pinned ref. */
+export interface MarketSyncResponse {
+    ok: true;
+    repo: string;
+    /** The ref the source is now pinned to. */
+    ref: string;
+    commitSha: string;
+    /** Local skills tracked from this repo (candidates for a batch update). */
+    skills: string[];
+}
+/** A skill discovered in a GitHub repo under skills/ or design-templates/. */
+export interface RepoSkillEntry {
+    /** Kebab-case skill name (directory basename). */
+    name: string;
+    /** Root-relative skill directory, e.g. skills/code-review. */
+    dir: string;
+    /** Root-relative SKILL.md path, e.g. skills/code-review/SKILL.md. */
+    path: string;
+    /** Repo root the skill lives in. */
+    root: RepoRoot;
+    /** Collection name recorded as origin after import. */
+    origin: string;
+    /** Number of files in the skill directory. */
+    fileCount: number;
+    /** Total bytes across all files in the skill directory. */
+    totalBytes: number;
+    /** Whether a same-named skill already exists locally. */
+    existing: boolean;
+}
+/** Supported skill roots in a GitHub repo. */
+export type RepoRoot = 'skills' | 'design-templates';
+/** GET /api/skill-hub/repo — discover importable skills in a GitHub repo. */
+export interface RepoDiscoverResponse {
+    ok: true;
+    repo: string;
+    /**
+     * Ref the discovery ran against (release tag / branch / default branch).
+     * Null means the repo has no release and no pinned ref — the client must
+     * ask the user to pick a branch (see `branches`) and pin it first.
+     */
+    ref: string | null;
+    /** Branch names to choose from when ref is null (default branch first). */
+    branches?: string[];
+    entries: RepoSkillEntry[];
+}
+/** POST /api/skill-hub/repo/import — install selected repo skills. */
+export interface RepoImportRequest {
+    repo: string;
+    /** Selected SKILL.md paths from the discover response. */
+    paths: string[];
+    /** The ref the discovery ran against; the import must use the same one. */
+    ref?: string;
+}
+/** POST /api/skill-hub/repo/import */
+export interface RepoImportResponse {
+    ok: true;
+    imported: Array<{
+        name: string;
+        origin: string;
+        path: string;
+    }>;
+    skipped: Array<{
+        name: string;
+        reason: 'exists';
+    }>;
+    failed: Array<{
+        name: string;
+        error: string;
+    }>;
+}
+/** GET /api/skill-hub/update — check the plugin's own latest GitHub release. */
+export interface UpdateCheckResponse {
+    ok: true;
+    /** Installed plugin version (from the bundled host build). */
+    currentVersion: string;
+    /** Latest release tag, normalized without the leading v; null when unknown. */
+    latestVersion: string | null;
+    /** True when latestVersion is strictly newer than currentVersion. */
+    updateAvailable: boolean;
+    /** Release page URL; null when unavailable. */
+    url: string | null;
+    /** Best-effort message when the check failed or no release exists. */
+    error?: string;
+}
+/** 用户自定义 tag 分组：纯组织视图，不改技能文件。 */
+export interface SkillTag {
+    /** 稳定 ID（新建时由宿主生成）。 */
+    id: string;
+    /** 显示名。 */
+    name: string;
+    /** 成员技能名（集合技能与独立技能都可加入）。 */
+    skillNames: string[];
+    /** 默认场景（「通用」）：系统预置、不可删除、新技能自动归入。 */
+    default?: boolean;
+}
+/** 系统集合组：按 origin（来源集合标识）自动聚合。 */
+export interface CollectionGroup {
+    /** 集合名（origin 值，如 "superpowers" / "anthropics/skills"）。 */
+    name: string;
+    /** 该集合下的技能名，按名称排序。 */
+    skillNames: string[];
+}
+/** GET /api/skill-hub/groups */
+export interface GroupsResponse {
+    ok: true;
+    /** 用户自定义 tag 分组（按创建顺序）。 */
+    tags: SkillTag[];
+    /** 系统集合组（按 origin 聚合，名称排序）。 */
+    collections: CollectionGroup[];
+    /** skillName → 集合名 的完整映射。 */
+    origins: Record<string, string>;
+}
+/** POST /api/skill-hub/tag — 新建（缺省 id）或重命名（带 id）。 */
+export interface TagSaveRequest {
+    /** 已有 tag 的 id；缺省表示新建。 */
+    id?: string;
+    /** 显示名（去空格后非空）。 */
+    name: string;
+}
+/** POST /api/skill-hub/tag */
+export interface TagSaveResponse {
+    ok: true;
+    /** 变更后的全部 tag。 */
+    tags: SkillTag[];
+}
+/** POST /api/skill-hub/tag/delete */
+export interface TagDeleteRequest {
+    id: string;
+}
+/** POST /api/skill-hub/tag/delete */
+export interface TagDeleteResponse {
+    ok: true;
+    tags: SkillTag[];
+}
+/** POST /api/skill-hub/tag/members — 直接设置某 tag 的完整成员列表（幂等）。 */
+export interface TagMembersRequest {
+    id: string;
+    /** 目标成员技能名；后端只保留目录中存在的名字。 */
+    skillNames: string[];
+}
+/** POST /api/skill-hub/tag/members */
+export interface TagMembersResponse {
+    ok: true;
+    tags: SkillTag[];
+}
+/** 来源跟踪记录：一组来自同一上游仓库根目录的技能。 */
+export interface SourceRecord {
+    /** GitHub owner/repo。 */
+    repo: string;
+    /** 显式分支/tag；缺省表示默认分支。 */
+    ref?: string;
+    /** 技能在仓库中的根目录。 */
+    root: RepoRoot;
+    /** 上次导入/同步时的上游 commit SHA；空 = 尚未核对过。 */
+    commitSha: string;
+    /** 该来源下的技能名（来源组 = 这些技能）。 */
+    skills: string[];
+    /** 仓库内路径 → 文件大小 的基线清单（差异检测用；缺失 = 无基线）。 */
+    manifest?: Record<string, number>;
+}
+/** 回收站条目：上游删除后跟进删除（移入 .trash）的技能。 */
+export interface TrashEntry {
+    name: string;
+    /** .trash 下的绝对路径。 */
+    path: string;
+    /** 移入回收站的时间（epoch ms）。 */
+    movedAt: number;
+    /** 移入回收站前的原始路径（目录或文件）；旧版本条目没有该字段。 */
+    sourcePath?: string;
+    /**
+     * 移入回收站前的来源跟踪快照（恢复时用它把技能重新挂回来源记录，
+     * 否则恢复后的技能会丢失来源归属、变成「个人技能」）。
+     */
+    origin?: {
+        repo: string;
+        root: RepoRoot;
+        ref?: string;
+        commitSha: string;
+    };
+    /** 移入回收站前所属的场景（tag）ID；恢复时重新加回这些场景。 */
+    tagIds?: string[];
+}
+/** GET /api/skill-hub/sources */
+export interface SourcesResponse {
+    ok: true;
+    /** 全部来源记录（按 repo 排序）。 */
+    sources: SourceRecord[];
+    /** skillName → 集合名（由 sources 派生）。 */
+    origins: Record<string, string>;
+    /** 来源集合组（按 origin 聚合）。 */
+    collections: CollectionGroup[];
+    /** 回收站内容。 */
+    trash: TrashEntry[];
+}
+/** POST /api/skill-hub/sources/check — 检查指定（或全部）来源的上游更新。 */
+export interface SourceCheckRequest {
+    /** 仅检查该 repo；缺省检查全部。 */
+    repo?: string;
+}
+/** 单个来源的检查结果。 */
+export interface SourceCheckResult {
+    repo: string;
+    ref?: string;
+    /** 检查失败时的原因（如仓库不可达/限流）。 */
+    error?: string;
+    /** 上游 commit 是否变化。 */
+    changed: boolean;
+    /** 上游最新 commit SHA（检查成功时）。 */
+    commitSha?: string;
+    /** 上游有更新的技能名（changed 时经 tree 差异得出）。 */
+    updated: string[];
+    /** 上游已删除的技能名（changed 时经 tree 差异得出）。 */
+    deleted: string[];
+    /** 节流跳过（距上次检查不足 5 分钟，未访问网络）。 */
+    throttled?: boolean;
+    /** 该来源此前没有快照（迁移/旧记录），本次已回填 commit，尚未有差异基线。 */
+    unverified?: boolean;
+}
+/** POST /api/skill-hub/sources/check */
+export interface SourceCheckResponse {
+    ok: true;
+    results: SourceCheckResult[];
+}
+/** POST /api/skill-hub/sources/sync — 按上游重新下载所选技能并更新快照。 */
+export interface SourceSyncRequest {
+    repo: string;
+    /** 要同步的技能名；缺省同步该来源全部技能。 */
+    skills?: string[];
+}
+/** POST /api/skill-hub/sources/sync */
+export interface SourceSyncResponse {
+    ok: true;
+    repo: string;
+    /** 同步后的上游 commit SHA。 */
+    commitSha: string;
+    /** 成功同步的技能。 */
+    synced: string[];
+    /** 失败的技能。 */
+    failed: Array<{
+        name: string;
+        error: string;
+    }>;
+}
+/** POST /api/skill-hub/sources/delete — 跟进上游删除，本地移入回收站。 */
+export interface SourceDeleteRequest {
+    repo: string;
+    /** 要删除的技能名（移入 .trash）。 */
+    skills: string[];
+}
+/** POST /api/skill-hub/sources/delete */
+export interface SourceDeleteResponse {
+    ok: true;
+    /** 已移入回收站的技能。 */
+    trashed: string[];
+    failed: Array<{
+        name: string;
+        error: string;
+    }>;
+}
+/** POST /api/skill-hub/sources/restore — 从回收站恢复一个技能。 */
+export interface SourceRestoreRequest {
+    name: string;
+}
+/** POST /api/skill-hub/sources/restore */
+export interface SourceRestoreResponse {
+    ok: true;
+    name: string;
+    path: string;
+}
+/** POST /api/skill-hub/sources/trash/clear — 永久删除回收站里的全部技能。 */
+export interface SourceTrashClearResponse {
+    ok: true;
+    /** 已永久删除的技能名。 */
+    deleted: string[];
+    /** 未能删除的技能（保留在回收站中）。 */
+    failed: Array<{
+        name: string;
+        error: string;
+    }>;
+}

package/lib/types/provider.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The hub's own skill provider, registered into the GLOBAL layer of the
+ * official ctx.skills registry.
+ *
+ * Why: in the dsh web app the base host skill-filesystem row is disabled on
+ * purpose — agent presets own local discovery by mounting their own
+ * skill-filesystem into their preset scope layers, so a host-plane query
+ * against the registry's empty global layer sees nothing. The hub needs a
+ * session-independent management view, so it contributes one itself: the
+ * user roots always, plus the project roots when the caller names a cwd.
+ *
+ * Agent views are unaffected: preset layers are nearer than the global
+ * layer, so a preset's own filesystem provider wins every duplicate name
+ * outright, and this provider only surfaces skills for presets that mount
+ * no filesystem row at all.
+ */
+import type { SkillCandidate, SkillDefinition, SkillProvider, SkillProviderControl } from '@deepseek-ai/dsh-skill';
+/**
+ * Global-layer skill provider for the hub's management catalog.
+ * Implements the official SkillProvider contract: list() returns
+ * invocation-neutral candidates; get() resolves the winning candidate's
+ * body. Both are readonly reads of the local skill roots.
+ */
+export declare class SkillHubProvider implements SkillProvider {
+    readonly name = "skill-hub";
+    private readonly home;
+    private readonly control;
+    private readonly watchTimer;
+    private rootStamp;
+    constructor(control: SkillProviderControl, home?: string);
+    /**
+     * Invalidate the registry cache when the discovered skill files changed.
+     * The stamp covers the per-skill discovery file's mtime + size (plus the
+     * entry set itself), so editing a SKILL.md body — not just adding or
+     * renaming directories — refreshes the GUI catalog.
+     */
+    private checkRoots;
+    list(options: {
+        cwd?: string;
+        signal?: AbortSignal;
+    }): Promise<readonly SkillCandidate[]>;
+    get(candidate: SkillCandidate): Promise<SkillDefinition | undefined>;
+    /** The roots this provider lists: user roots always, project roots with cwd. */
+    private roots;
+    /** Public hook for the routes: invalidate after hub-driven mutations. */
+    invalidate(): void;
+}