@autorag/librarian 2.6.3 → 2.8.0

package/dist/everything/bundle.d.ts

@@ -6,6 +6,12 @@
  * and nothing is installed system-wide.
  */
 export type EverythingArch = "x64" | "arm64";
+/**
+ * `"install"` extracts and verifies the pinned binaries when the workspace
+ * cache is missing or invalid; `"cached"` returns only an already extracted,
+ * hash-verified cache entry and never writes to disk.
+ */
+export type EverythingBinaryResolutionMode = "cached" | "install";
 export interface EverythingArchAssets {
     readonly everythingArchive: string;
     readonly everythingArchiveSha256: string;
@@ -31,6 +37,8 @@ export interface EnsureEverythingBinariesOptions {
     readonly bundleDir?: string;
     /** Bundle manifest. Defaults to `<bundleDir>/manifest.json`. */
     readonly manifest?: EverythingBundleManifest;
+    /** Defaults to `"install"`; `"cached"` is the read-only resolution a query uses. */
+    readonly mode?: EverythingBinaryResolutionMode;
 }
 export type EnsureEverythingBinariesResult = {
     readonly ok: true;
@@ -39,7 +47,7 @@ export type EnsureEverythingBinariesResult = {
     readonly source: "cached" | "installed";
 } | {
     readonly ok: false;
-    readonly reason: "unsupported-platform" | "bundle-missing" | "install-failed";
+    readonly reason: "unsupported-platform" | "bundle-missing" | "install-failed" | "not-installed";
     readonly message: string;
 };
 /**
@@ -56,7 +64,11 @@ export declare function everythingBinaryPaths(root: string, version: string, arc
 };
 export declare function loadEverythingBundleManifest(bundleDir: string): EverythingBundleManifest;
 /**
- * Extract and verify the bundled Everything + ES binaries for this Windows
- * host. Never throws: every failure is reported with its underlying message.
+ * Resolve the bundled Everything + ES binaries for this Windows host. Never
+ * throws: every failure is reported with its underlying message. `mode:
+ * "install"` (default) extracts and verifies them from the bundled ZIPs when
+ * the workspace cache is missing or invalid; `mode: "cached"` is read-only and
+ * reports `not-installed` instead of writing so a query can only use verified,
+ * already-extracted binaries.
  */
 export declare function ensureEverythingBinaries(options: EnsureEverythingBinariesOptions): Promise<EnsureEverythingBinariesResult>;

package/dist/everything/client.d.ts

@@ -1,4 +1,4 @@
-import { type EnsureEverythingBinariesResult } from "./bundle.js";
+import { type EnsureEverythingBinariesResult, type EverythingBinaryResolutionMode } from "./bundle.js";
 /**
  * Drives a private, user-level Everything instance per AutoRAG workspace.
  *
@@ -32,7 +32,7 @@ export interface EverythingSearchRequest {
     readonly offset?: number;
     readonly maxResults?: number;
 }
-export type EverythingFailureReason = "unsupported-platform" | "bundle-missing" | "install-failed" | "startup-failed" | "index-failed" | "search-failed";
+export type EverythingFailureReason = "unsupported-platform" | "bundle-missing" | "install-failed" | "not-installed" | "not-running" | "startup-failed" | "index-failed" | "search-failed";
 export interface EverythingFailure {
     readonly ok: false;
     readonly reason: EverythingFailureReason;
@@ -70,7 +70,12 @@ export interface EverythingClientOptions extends EverythingOptions {
     /** Folders Everything indexes (the configured search paths). */
     readonly folders: readonly string[];
     readonly platform?: NodeJS.Platform;
-    readonly resolveBinaries?: () => Promise<EnsureEverythingBinariesResult>;
+    /**
+     * Resolve the bundled executables. `"cached"` (queries and stop) must
+     * return only already extracted, hash-verified binaries; `"install"`
+     * (refresh/index) may extract them. Defaults to `ensureEverythingBinaries`.
+     */
+    readonly resolveBinaries?: (mode: EverythingBinaryResolutionMode) => Promise<EnsureEverythingBinariesResult>;
     readonly run?: EverythingRunner;
     readonly launch?: EverythingLauncher;
     readonly pollIntervalMs?: number;
@@ -105,16 +110,28 @@ export declare class EverythingClient {
     private operation;
     constructor(options: EverythingClientOptions);
     isSupported(): boolean;
-    /** Start the instance when needed and search it. */
+    /**
+     * Search the running instance. Read-only: never starts Everything, waits
+     * for it to index, or installs its binaries (refresh does that), so a query
+     * never pays startup or extraction cost. A cold cache reports
+     * `not-installed` with a refresh hint instead.
+     */
     search(request: EverythingSearchRequest): Promise<EverythingSearchResult>;
     /**
      * (Re)write the folder configuration, restart the instance so Everything
      * loads it, and wait until the database finished indexing.
      */
     index(): Promise<EverythingIndexResult>;
-    /** Exit this workspace's Everything instance if it is running. */
+    /** Exit this workspace's Everything instance if it is running. Never installs binaries. */
     stop(): Promise<void>;
     private serialize;
+    /**
+     * Resolve the ES + Everything executables. `"cached"` reads only the
+     * already extracted, hash-verified workspace cache and never writes;
+     * `"install"` (refresh/index) may extract from the bundled ZIPs. Only a
+     * verified resolution is memoized, so a cached-mode miss never poisons the
+     * install-mode resolution that refresh depends on.
+     */
     private resolveBinaries;
     private ensureRunning;
     /** Exit code 0 only when the instance answered with its version. */

package/dist/everything/index.d.ts

@@ -1,2 +1,2 @@
-export { type EnsureEverythingBinariesOptions, type EnsureEverythingBinariesResult, type EverythingArch, type EverythingArchAssets, type EverythingBundleManifest, ensureEverythingBinaries, everythingArch, everythingBinaryPaths, loadEverythingBundleManifest, resolveEverythingBundleDir, } from "./bundle.js";
+export { type EnsureEverythingBinariesOptions, type EnsureEverythingBinariesResult, type EverythingArch, type EverythingArchAssets, type EverythingBinaryResolutionMode, type EverythingBundleManifest, ensureEverythingBinaries, everythingArch, everythingBinaryPaths, loadEverythingBundleManifest, resolveEverythingBundleDir, } from "./bundle.js";
 export { buildEverythingIni, buildEverythingSearchArgs, EverythingClient, type EverythingClientOptions, type EverythingEntry, type EverythingFailure, type EverythingFailureReason, type EverythingIndexResult, type EverythingLauncher, type EverythingOptions, type EverythingRunner, type EverythingRunResult, type EverythingSearchRequest, type EverythingSearchResult, type EverythingSort, everythingInstanceName, parseEverythingJson, } from "./client.js";

package/dist/filesystem/name-search.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Literal (never regex) file-name search over configured filesystem roots.
+ *
+ * This is a discovery-only backend: it walks directories directly and never
+ * consults a parsed mirror/index, so a name can be found before any refresh
+ * has run. It never opens file contents — only directory listings are read.
+ *
+ * Path safety is the whole point of this module:
+ * - configured roots are `realpath`-pinned; missing roots degrade to a
+ *   diagnostic instead of an exception;
+ * - `request.root` may only select a configured root or a real subdirectory
+ *   *inside* one (realpath containment), so it can never widen scope;
+ * - child symlinks are never followed, so a symlink inside a root cannot leak
+ *   results from outside it;
+ * - when nothing can be searched, the result is an empty page plus a warning
+ *   diagnostic, never an arbitrary global `/` scan.
+ */
+/** A single matched entry, with its canonical absolute filesystem path. */
+export interface FileNameSearchMatch {
+    readonly path: string;
+    readonly type: "file" | "folder";
+}
+/** A non-fatal problem encountered while resolving or walking roots. */
+export interface FileNameSearchDiagnostic {
+    readonly code: string;
+    readonly severity: "warning";
+    readonly source: string;
+    readonly message: string;
+}
+export interface FileNameSearchRequest {
+    readonly query: string;
+    /** Configured root or subdirectory (absolute or root-relative) to limit the walk to. */
+    readonly root?: string;
+    /** Match the query against the path relative to the search root instead of the file name. */
+    readonly matchPath?: boolean;
+    /** Case-sensitive matching. Defaults to case-insensitive. */
+    readonly matchCase?: boolean;
+    readonly kind?: "files" | "folders";
+    readonly maxResults?: number;
+    readonly offset?: number;
+    readonly signal?: AbortSignal;
+}
+export interface FileNameSearchResult {
+    readonly ok: true;
+    readonly backend: "filesystem" | "everything";
+    readonly results: readonly FileNameSearchMatch[];
+    readonly truncated: boolean;
+    readonly diagnostics: readonly FileNameSearchDiagnostic[];
+}
+/** Resolve one requested root inside the configured roots for backend routing. */
+export declare function resolveConfiguredFileSearchRoot(roots: readonly string[], requestRoot: string): Promise<string | undefined>;
+/**
+ * Keep provider-returned file-name hits inside configured roots and exclusions.
+ * Revalidates lstat/realpath so an external index cannot widen MCP scope.
+ */
+export declare function filterFileNameSearchMatches(roots: readonly string[], candidates: readonly FileNameSearchMatch[], excludePaths?: readonly string[]): Promise<FileNameSearchMatch[]>;
+export declare function searchFileNames(roots: readonly string[], request: FileNameSearchRequest, excludePaths?: readonly string[]): Promise<FileNameSearchResult>;

package/dist/fsearch/client.d.ts

@@ -90,6 +90,8 @@ export interface FSearchClientOptions extends FSearchOptions {
     readonly root: string;
     /** Folders FSearch indexes (the configured search paths). */
     readonly folders: readonly string[];
+    /** Additional configured folders omitted from the index. */
+    readonly excludeFolders?: readonly string[];
     readonly platform?: NodeJS.Platform;
     readonly run?: FSearchRunner;
     readonly launch?: FSearchLauncher;
@@ -144,7 +146,11 @@ export declare class FSearchClient {
     private operation;
     constructor(options: FSearchClientOptions);
     isSupported(): boolean;
-    /** Search the workspace database, building it on first use; walks when fsearch-cli is missing. */
+    /**
+     * Search the prebuilt workspace database. Read-only: a missing database is
+     * never built here (refresh does that), so a query never pays for indexing.
+     * Without fsearch-cli or a database, it walks the configured folders.
+     */
     search(request: FSearchSearchRequest): Promise<FSearchSearchResult>;
     /** (Re)build the database over the configured folders and keep the watch daemon live. */
     index(): Promise<FSearchIndexResult>;

package/dist/index.d.ts

@@ -8,6 +8,7 @@ export * from "./everything/index.js";
 export * from "./fsearch/index.js";
 export * from "./jikji/index.js";
 export * from "./manifest/index.js";
+export { type AutoRAGMcpServerOptions, createAutoRAGMcpServer } from "./mcp/server.js";
 export * from "./memory/index.js";
 export * from "./minsync/index.js";
 export * from "./mirror/index.js";