@zvec/zvec-grep 0.2.1 → 0.2.2

package/dist/engine/models/artifact-downloader.d.ts

@@ -0,0 +1,77 @@
+export type ModelArtifactSourceKind = "huggingface" | "modelscope";
+export type ModelArtifactSource = Readonly<{
+    kind: ModelArtifactSourceKind;
+    repo: string;
+    revision: string;
+    cacheDirectory: string;
+    /** Maps a remote artifact path to a path relative to cacheDirectory. */
+    localPaths?: Readonly<Record<string, string>>;
+}>;
+export type ModelArtifact = Readonly<{
+    path: string;
+    size: number;
+    sha256: string;
+}>;
+export type ModelArtifactDownloadProgress = Readonly<{
+    model: string;
+    source: ModelArtifactSourceKind;
+    artifact: string;
+    downloadedBytes: number;
+    totalBytes: number;
+}>;
+export type ResolvedModelArtifacts = Readonly<{
+    source: ModelArtifactSource;
+    directory: string;
+    /** Absolute local paths keyed by the corresponding remote artifact path. */
+    paths: Readonly<Record<string, string>>;
+}>;
+export type ArtifactDownloadFailureKind = "http" | "network" | "timeout" | "integrity" | "filesystem" | "aborted" | "callback" | "invalid-input";
+export declare class ArtifactDownloadError extends Error {
+    readonly kind: ArtifactDownloadFailureKind;
+    readonly source?: ModelArtifactSourceKind | undefined;
+    readonly artifact?: string | undefined;
+    readonly status?: number | undefined;
+    readonly fallbackAllowed: boolean;
+    constructor(message: string, kind: ArtifactDownloadFailureKind, source?: ModelArtifactSourceKind | undefined, artifact?: string | undefined, status?: number | undefined, options?: ErrorOptions);
+}
+export declare class ModelArtifactResolutionError extends AggregateError {
+    readonly model: string;
+    readonly primaryError: unknown;
+    readonly fallbackError: unknown;
+    constructor(model: string, primaryError: unknown, fallbackError: unknown);
+}
+export declare function isFallbackEligibleArtifactError(error: unknown): boolean;
+export type ArtifactDownloaderDependencies = Readonly<{
+    fetch: typeof globalThis.fetch;
+    setTimeout: (callback: () => void, milliseconds: number) => ReturnType<typeof setTimeout>;
+    clearTimeout: (handle: ReturnType<typeof setTimeout>) => void;
+    now: () => number;
+}>;
+export type ResolveModelArtifactsOptions = Readonly<{
+    model: string;
+    sources: readonly ModelArtifactSource[];
+    artifacts: readonly ModelArtifact[];
+    onProgress?: (progress: ModelArtifactDownloadProgress) => void;
+    /** The verified missing files for this source; resets progress on fallback. */
+    onDownloadPlan?: (artifacts: readonly ModelArtifact[]) => void;
+    onFallback?: (message: string) => void;
+    dependencies?: Partial<ArtifactDownloaderDependencies>;
+    timeouts?: Partial<Readonly<{
+        responseHeaderMs: number;
+        readIdleMs: number;
+    }>>;
+    lock?: Partial<Readonly<{
+        pollMs: number;
+        staleMs: number;
+        heartbeatMs: number;
+    }>>;
+}>;
+/**
+ * Resolves a complete, integrity-checked local artifact snapshot.
+ *
+ * Cache lookup is performed for every source before any network request. Source
+ * order is always Hugging Face followed by ModelScope, independent of the input
+ * array order.
+ */
+export declare function resolveModelArtifacts(options: ResolveModelArtifactsOptions): Promise<ResolvedModelArtifacts>;
+export declare function modelArtifactUrl(source: Pick<ModelArtifactSource, "kind" | "repo" | "revision">, artifactPath: string): string;