@zvec/zvec-grep 0.1.5 → 0.1.7

package/dist/engine/service/workspace-index.js

@@ -0,0 +1,157 @@
+import { workspaceIndexDetail, detail, EngineError, errorDetails, } from "../errors.js";
+import { getWorkspaceIndexStatus, indexWorkspace, indexWorkspacePaths, } from "../pipeline/indexing/index.js";
+import { searchWorkspaceIndex } from "../pipeline/search/index.js";
+import { createWorkspaceIndexStorage, } from "../storage/index.js";
+import { CURRENT_INDEX_VERSION } from "../types.js";
+export class WorkspaceIndex {
+    info;
+    storage;
+    embedding;
+    embeddingModel;
+    closed = false;
+    constructor(info, options) {
+        this.info = info;
+        this.embeddingModel = options.embeddingModel;
+        this.embedding = requireWorkspaceIndexEmbedding(info, "open");
+        this.validateIndexVersion();
+        if (this.embeddingModel) {
+            this.validateEmbeddingSchema(this.embeddingModel);
+        }
+        if (options.mode === "write") {
+            this.storage = createWorkspaceIndexStorage({
+                storagePath: info.path,
+                readOnly: false,
+                embedding: this.embedding,
+            });
+        }
+        else {
+            this.storage = createWorkspaceIndexStorage({
+                storagePath: info.path,
+                readOnly: true,
+            });
+        }
+    }
+    get name() {
+        return this.info.name;
+    }
+    index(options = {}) {
+        if (this.storage.readOnly) {
+            throw new EngineError("Cannot update a read-only workspace index", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.READ_ONLY",
+                context: workspaceIndexOperationDetails(this.name, "index"),
+            });
+        }
+        const embeddingModel = this.requireEmbeddingModel("index");
+        const context = {
+            workspaceIndex: this.info,
+            embeddingModel,
+            storage: this.storage,
+            embeddingConcurrency: options.embeddingConcurrency,
+            onProgress: options.onProgress,
+            signal: options.signal,
+        };
+        return options.changedPaths && options.changedPaths.length > 0
+            ? indexWorkspacePaths(context, options.changedPaths)
+            : indexWorkspace(context);
+    }
+    status() {
+        return getWorkspaceIndexStatus(this.info, this.storage.listFiles());
+    }
+    searchPlan(plan) {
+        return searchWorkspaceIndex(plan, {
+            workspaceIndex: this.info,
+            embeddingModel: this.embeddingModel,
+            storage: this.storage,
+        });
+    }
+    close() {
+        if (this.closed) {
+            return;
+        }
+        this.storage.close();
+        this.closed = true;
+    }
+    validateIndexVersion() {
+        if (this.info.indexVersion !== CURRENT_INDEX_VERSION) {
+            throw new EngineError("Workspace index version is not supported", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.VERSION_MISMATCH",
+                context: errorDetails([
+                    workspaceIndexDetail(this.name),
+                    detail("expected", CURRENT_INDEX_VERSION),
+                    detail("actual", this.info.indexVersion),
+                    detail("hint", 'Recreate the index with the current zvec-grep version; run "zg index --rebuild" for a workspace index.'),
+                ]),
+            });
+        }
+    }
+    validateEmbeddingSchema(current) {
+        this.validateIndexVersion();
+        const expected = this.embedding;
+        if (expected.provider !== current.info.provider) {
+            throw new EngineError("Workspace index embedding provider does not match current model", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.EMBEDDING_PROVIDER_MISMATCH",
+                context: workspaceIndexMismatchDetails(this.name, expected.provider, current.info.provider),
+            });
+        }
+        if (expected.model !== current.info.name) {
+            throw new EngineError("Workspace index embedding model does not match current model", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.EMBEDDING_MODEL_MISMATCH",
+                context: workspaceIndexMismatchDetails(this.name, expected.model, current.info.name),
+            });
+        }
+        if (expected.dimension !== current.info.dimension) {
+            throw new EngineError("Workspace index embedding dimension does not match current model", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.EMBEDDING_DIMENSION_MISMATCH",
+                context: workspaceIndexMismatchDetails(this.name, expected.dimension, current.info.dimension),
+            });
+        }
+        if (expected.metric !== current.info.metric) {
+            throw new EngineError("Workspace index embedding metric does not match current model", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.EMBEDDING_METRIC_MISMATCH",
+                context: workspaceIndexMismatchDetails(this.name, expected.metric, current.info.metric),
+            });
+        }
+    }
+    requireEmbeddingModel(operation) {
+        if (!this.embeddingModel) {
+            throw new EngineError("Workspace index operation requires an embedding model", {
+                code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.EMBEDDING_MODEL_REQUIRED",
+                context: workspaceIndexOperationDetails(this.name, operation),
+            });
+        }
+        return this.embeddingModel;
+    }
+}
+function workspaceIndexOperationDetails(name, operation) {
+    return errorDetails([
+        workspaceIndexDetail(name),
+        detail("operation", operation),
+    ]);
+}
+function workspaceIndexMismatchDetails(name, expected, actual) {
+    return errorDetails([
+        workspaceIndexDetail(name),
+        detail("expected", expected),
+        detail("actual", actual),
+    ]);
+}
+export function isWorkspaceIndexed(info) {
+    return (info?.embedding !== null &&
+        info?.embedding !== undefined &&
+        info.indexVersion !== null &&
+        info.indexVersion !== undefined);
+}
+function requireWorkspaceIndexEmbedding(info, operation) {
+    if (isWorkspaceIndexed(info)) {
+        return info.embedding;
+    }
+    throw new EngineError("Workspace index has not been built", {
+        code: "ZVEC_GREP.ENGINE.WORKSPACE_INDEX.MISSING",
+        context: errorDetails([
+            workspaceIndexDetail(info.name),
+            detail("operation", operation),
+            detail("hint", "Run zg index to build this index."),
+        ]),
+    });
+}
+//# sourceMappingURL=workspace-index.js.map

package/dist/engine/service/workspace-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-index.js","sourceRoot":"","sources":["../../../src/engine/service/workspace-index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,MAAM,EACN,WAAW,EACX,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,uBAAuB,EACvB,cAAc,EACd,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EACL,2BAA2B,GAE5B,MAAM,qBAAqB,CAAC;AAU7B,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAOpD,MAAM,OAAO,cAAc;IAOd;IANM,OAAO,CAAwB;IAC/B,SAAS,CAAgC;IACzC,cAAc,CAAkB;IACzC,MAAM,GAAG,KAAK,CAAC;IAEvB,YACW,IAAwB,EACjC,OAA8B;QADrB,SAAI,GAAJ,IAAI,CAAoB;QAGjC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,8BAA8B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9D,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACpD,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,GAAG,2BAA2B,CAAC;gBACzC,WAAW,EAAE,IAAI,CAAC,IAAI;gBACtB,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,2BAA2B,CAAC;gBACzC,WAAW,EAAE,IAAI,CAAC,IAAI;gBACtB,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,UAAwB,EAAE;QAC9B,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC1B,MAAM,IAAI,WAAW,CAAC,2CAA2C,EAAE;gBACjE,IAAI,EAAE,4CAA4C;gBAClD,OAAO,EAAE,8BAA8B,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC;aAC5D,CAAC,CAAC;QACL,CAAC;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG;YACd,cAAc,EAAE,IAAI,CAAC,IAAI;YACzB,cAAc;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,oBAAoB,EAAE,OAAO,CAAC,oBAAoB;YAClD,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;QACF,OAAO,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;YAC5D,CAAC,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC;YACpD,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,MAAM;QACJ,OAAO,uBAAuB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,UAAU,CAAC,IAAgB;QACzB,OAAO,oBAAoB,CAAC,IAAI,EAAE;YAChC,cAAc,EAAE,IAAI,CAAC,IAAI;YACzB,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC,CAAC;IACL,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACrB,CAAC;IAEO,oBAAoB;QAC1B,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,qBAAqB,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CAAC,0CAA0C,EAAE;gBAChE,IAAI,EAAE,mDAAmD;gBACzD,OAAO,EAAE,YAAY,CAAC;oBACpB,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;oBAC/B,MAAM,CAAC,UAAU,EAAE,qBAAqB,CAAC;oBACzC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;oBACxC,MAAM,CACJ,MAAM,EACN,wGAAwG,CACzG;iBACF,CAAC;aACH,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAEO,uBAAuB,CAAC,OAAuB;QACrD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;QAEhC,IAAI,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChD,MAAM,IAAI,WAAW,CACnB,iEAAiE,EACjE;gBACE,IAAI,EAAE,8DAA8D;gBACpE,OAAO,EAAE,6BAA6B,CACpC,IAAI,CAAC,IAAI,EACT,QAAQ,CAAC,QAAQ,EACjB,OAAO,CAAC,IAAI,CAAC,QAAQ,CACtB;aACF,CACF,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACzC,MAAM,IAAI,WAAW,CACnB,8DAA8D,EAC9D;gBACE,IAAI,EAAE,2DAA2D;gBACjE,OAAO,EAAE,6BAA6B,CACpC,IAAI,CAAC,IAAI,EACT,QAAQ,CAAC,KAAK,EACd,OAAO,CAAC,IAAI,CAAC,IAAI,CAClB;aACF,CACF,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YAClD,MAAM,IAAI,WAAW,CACnB,kEAAkE,EAClE;gBACE,IAAI,EAAE,+DAA+D;gBACrE,OAAO,EAAE,6BAA6B,CACpC,IAAI,CAAC,IAAI,EACT,QAAQ,CAAC,SAAS,EAClB,OAAO,CAAC,IAAI,CAAC,SAAS,CACvB;aACF,CACF,CAAC;QACJ,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5C,MAAM,IAAI,WAAW,CACnB,+DAA+D,EAC/D;gBACE,IAAI,EAAE,4DAA4D;gBAClE,OAAO,EAAE,6BAA6B,CACpC,IAAI,CAAC,IAAI,EACT,QAAQ,CAAC,MAAM,EACf,OAAO,CAAC,IAAI,CAAC,MAAM,CACpB;aACF,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,SAAiB;QAC7C,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,WAAW,CACnB,uDAAuD,EACvD;gBACE,IAAI,EAAE,2DAA2D;gBACjE,OAAO,EAAE,8BAA8B,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC;aAC9D,CACF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;CACF;AAED,SAAS,8BAA8B,CACrC,IAAY,EACZ,SAAiB;IAEjB,OAAO,YAAY,CAAC;QAClB,oBAAoB,CAAC,IAAI,CAAC;QAC1B,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC;KAC/B,CAAC,CAAC;AACL,CAAC;AAED,SAAS,6BAA6B,CACpC,IAAY,EACZ,QAAyB,EACzB,MAAuB;IAEvB,OAAO,YAAY,CAAC;QAClB,oBAAoB,CAAC,IAAI,CAAC;QAC1B,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC;QAC5B,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;KACzB,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,IAA2C;IAK3C,OAAO,CACL,IAAI,EAAE,SAAS,KAAK,IAAI;QACxB,IAAI,EAAE,SAAS,KAAK,SAAS;QAC7B,IAAI,CAAC,YAAY,KAAK,IAAI;QAC1B,IAAI,CAAC,YAAY,KAAK,SAAS,CAChC,CAAC;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,IAAwB,EACxB,SAAiB;IAEjB,IAAI,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,MAAM,IAAI,WAAW,CAAC,oCAAoC,EAAE;QAC1D,IAAI,EAAE,0CAA0C;QAChD,OAAO,EAAE,YAAY,CAAC;YACpB,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC;YAC9B,MAAM,CAAC,MAAM,EAAE,mCAAmC,CAAC;SACpD,CAAC;KACH,CAAC,CAAC;AACL,CAAC"}

package/dist/engine/service/zvec-grep.d.ts

@@ -1,2 +1,13 @@
-import type { CreateZvecGrepOptions, ZvecGrep } from "./types.js";
+import { type EmbeddingRuntimeConfig } from "../config.js";
+import { type EmbeddingModel, type EmbeddingModelInfo } from "../models/index.js";
+import type { CreateZvecGrepOptions, ZvecGrep, ZvecGrepContextOptions, ZvecGrepContextResult } from "./types.js";
+export type EmbeddingModelIdentity = Pick<EmbeddingModelInfo, "provider" | "name">;
 export declare function createZvecGrep(options?: CreateZvecGrepOptions): Promise<ZvecGrep>;
+export type WorkspaceReadSession = {
+    readonly root: string;
+    context(options: ZvecGrepContextOptions): Promise<ZvecGrepContextResult>;
+    close(): Promise<void>;
+};
+export declare function openWorkspaceReadSession(startRoot: string, embeddingModel?: EmbeddingModel): WorkspaceReadSession;
+export declare function createEmbeddingModelForIdentity(identity: EmbeddingModelIdentity, options?: CreateZvecGrepOptions, workspaceRuntime?: EmbeddingRuntimeConfig): EmbeddingModel;
+export declare function embeddingModelPoolKeyForIdentity(identity: EmbeddingModelIdentity, options?: CreateZvecGrepOptions, workspaceRuntime?: EmbeddingRuntimeConfig): string;