@kevisual/project-search 0.0.1

package/dist/app.d.ts

@@ -0,0 +1,239 @@
+import { MeiliSearch } from 'meilisearch';
+import ParcelWatcher from '@parcel/watcher';
+import { EventEmitter } from 'eventemitter3';
+
+declare const app: any;
+declare const manager: any;
+
+interface ProjectManagerInterface {
+    removeProject(path: string): void;
+    getProject(path: string): any;
+    listProjects(): any[];
+    addProject(project: any): void;
+}
+
+declare class Scheduler {
+    private queue;
+    private running;
+    /** 当前在队列中等待执行的任务 key 集合（不含正在执行的） */
+    private pendingKeys;
+    /**
+     * 添加任务
+     * @param key 任务唯一标识（如文件路径）
+     * @param execute 任务执行函数
+     * @returns true 表示已加入队列；false 表示该 key 已存在，跳过
+     */
+    add(key: string, execute: () => Promise<void>): boolean;
+    private _run;
+    /** 队列中等待执行的任务数量（不含正在执行的） */
+    get pendingCount(): number;
+}
+
+type FileProjectData = {
+    /**
+     * meilisearch 文档 ID（文件绝对路径的 base64url 编码，无碰撞且唯一）
+     */
+    id: string;
+    /**
+     * 文件路径的 md5 hash，用于快速索引/查找
+     */
+    hash: string;
+    /**
+     * 文件对应相关信息
+     *
+     * 具体文件路径
+     */
+    filepath: string;
+    content?: string;
+    lastModified: number;
+    size: number;
+    /**
+     * 项目路径，文件所在的项目路径，方便搜索结果展示和过滤
+     */
+    projectPath: string;
+    repo: string;
+    /**
+     * 人工编辑的字段，方便搜索结果展示和过滤
+     */
+    title?: string;
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    link?: string;
+};
+declare class ProjectSearch {
+    meiliSearch: MeiliSearch;
+    scheduler: Scheduler;
+    constructor({ apiHost, apiKey }?: {
+        apiHost?: string;
+        apiKey?: string;
+    });
+    private get index();
+    /** 全文搜索 */
+    searchFiles(query?: string, options?: {
+        projectPath?: string;
+        repo?: string;
+        title?: string;
+        tags?: string | string[];
+        summary?: string;
+        description?: string;
+        link?: string;
+        /**
+         * ['projectPath:asc']
+         */
+        sort?: string[];
+        limit?: number;
+        getContent?: boolean;
+    }): Promise<FileProjectData[]>;
+    /** 初始化索引（设置可过滤字段） */
+    ensureIndex(): Promise<void>;
+    /** 添加或完整覆盖一个文件文档 */
+    private _upsertFile;
+    /** 更新文档的人工编辑字段（title/tags/summary/description/link），不影响文件内容等其他字段 */
+    updateDocument(filePath: string, opts: {
+        title?: string;
+        tags?: string[];
+        summary?: string;
+        description?: string;
+        link?: string;
+    }): Promise<void>;
+    /** 删除某个项目下所有已索引的文件文档 */
+    removeProjectFiles(projectPath: string): Promise<void>;
+    /** 将文件变更通过 scheduler 安全入队 */
+    syncFileChange({ type, path: filePath, projectPath, repo }: {
+        type: 'create' | 'update' | 'delete';
+        path: string;
+        projectPath: string;
+        repo: string;
+    }): void;
+    /**
+     * 全量同步整个项目目录到 meilisearch
+     * 1. 扫描本地文件，逐一 upsert
+     * 2. 对比 meilisearch 中已有文档，删除本地已不存在的文件记录
+     */
+    initialSync(projectPath: string, repo: string): Promise<void>;
+}
+
+type ProjectDoc = {
+    /**
+     * 文档 ID，使用 path 的 base64url 编码
+     */
+    id: string;
+    name?: string;
+    path: string;
+    /**
+     * 用 git remote url 唯一标识项目
+     */
+    repo: string;
+    /**
+     * 人工编辑的字段，方便搜索结果展示和过滤
+     */
+    title?: string;
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    link?: string;
+    /**
+     * 项目状态：active 活动中 | inactive 非活动
+     */
+    status?: 'active' | 'inactive';
+};
+declare class ProjectStore {
+    meiliSearch: MeiliSearch;
+    constructor({ apiHost, apiKey }?: {
+        apiHost?: string;
+        apiKey?: string;
+    });
+    private get index();
+    ensureIndex(): Promise<void>;
+    init(): Promise<void>;
+    addProject(input: {
+        name?: string;
+        path: string;
+        repo: string;
+        status?: 'active' | 'inactive';
+    }): Promise<void>;
+    removeProject(projectPath: string): Promise<void>;
+    listProjects(): Promise<ProjectDoc[]>;
+    getProject(projectPath: string): Promise<ProjectDoc | null>;
+    updateProject(projectPath: string, opts: {
+        name?: string;
+        repo?: string;
+        title?: string;
+        tags?: string[];
+        summary?: string;
+        description?: string;
+        link?: string;
+        status?: 'active' | 'inactive';
+    }): Promise<void>;
+}
+
+declare class ProjectListener {
+    projectPath: string;
+    subscribe: ParcelWatcher.AsyncSubscription | null;
+    isWatching: boolean;
+    emitter: EventEmitter;
+    private updateDebounceMap;
+    constructor(options: {
+        projectPath: string;
+        emitter: EventEmitter;
+    });
+    startListening(): Promise<void>;
+    stopListening(): Promise<void>;
+}
+
+type Project = {
+    name?: string;
+    path: string;
+    /**
+     * 用 git remote url 唯一标识项目，方便搜索结果展示和过滤
+     */
+    repo: string;
+    listener: ProjectListener;
+};
+type ProjectInput = Omit<Project, "listener">;
+type ProjectInfo = Omit<Project, "listener"> & {
+    status: "active" | "inactive";
+};
+type ProjectManagerOpt = {
+    meiliSearchOptions?: {
+        apiHost?: string;
+        apiKey?: string;
+    };
+};
+declare class ProjectManager implements ProjectManagerInterface {
+    projects: Map<string, Project>;
+    projectSearch: ProjectSearch;
+    projectStore: ProjectStore;
+    emitter: EventEmitter;
+    constructor(options?: ProjectManagerOpt);
+    /**
+     * 初始化：从 store 加载已持久化的项目，检查本地目录存在后启动监听
+     */
+    init(): Promise<void>;
+    /**
+     * 添加项目：创建监听器、启动监听、触发全量初始同步
+     */
+    addProject(input: ProjectInput): Promise<ProjectInfo>;
+    removeProject(projectPath: string): Promise<void>;
+    getProject(projectPath: string): Project;
+    /** 停止项目文件监听，但不删除索引数据 */
+    stopProject(projectPath: string): Promise<void>;
+    getProjectInfo(project: Project): ProjectInfo;
+    listProjects(): ProjectInfo[];
+    getFile(filepath: string): Promise<{
+        filepath: string;
+        content: string;
+        type: string;
+    } | null>;
+    deleteFile(filepath: string): Promise<boolean>;
+}
+
+declare class FileSearch {
+    searchFiles(options?: {
+        cwd?: string;
+        ignore?: string[];
+    }): Promise<any>;
+}
+
+export { FileSearch, ProjectListener, ProjectManager, ProjectSearch, Scheduler, app, manager };