@qvac/sdk 0.8.1 → 1.0.0

package/bare-imports.json

@@ -1,44 +0,0 @@
-{
-  "#rpc": {
-    "react-native": "./dist/client/rpc/expo-rpc-client.js",
-    "bare": "./dist/client/rpc/bare-client.js",
-    "default": "./dist/client/rpc/node-rpc-client.js"
-  },
-  "child_process": {
-    "bare": "bare-subprocess",
-    "default": "child_process"
-  },
-  "crypto": {
-    "bare": "bare-crypto",
-    "default": "crypto"
-  },
-  "fs": {
-    "bare": "bare-fs",
-    "default": "fs"
-  },
-  "os": {
-    "bare": "bare-os",
-    "default": "os"
-  },
-  "path": {
-    "bare": "bare-path",
-    "default": "path"
-  },
-  "process": {
-    "bare": "bare-process",
-    "default": "process"
-  },
-  "readline": {
-    "bare": "bare-readline",
-    "default": "readline"
-  },
-  "url": {
-    "bare": "bare-url",
-    "default": "url"
-  },
-  "node:url": {
-    "bare": "bare-url",
-    "default": "node:url"
-  }
-}
-

package/dist/client/api/get-model-info.d.ts

@@ -1,36 +0,0 @@
-import { type GetModelInfoParams } from "../../schemas/index";
-export declare function getModelInfo(params: GetModelInfoParams): Promise<{
-    name: string;
-    modelId: string;
-    expectedSize: number;
-    sha256Checksum: string;
-    addon: "llm" | "whisper" | "embeddings" | "nmt" | "parakeet" | "tts" | "ocr" | "vad" | "other";
-    isCached: boolean;
-    isLoaded: boolean;
-    cacheFiles: {
-        filename: string;
-        path: string;
-        expectedSize: number;
-        sha256Checksum: string;
-        isCached: boolean;
-        actualSize?: number | undefined;
-        cachedAt?: Date | undefined;
-    }[];
-    registryPath?: string | undefined;
-    registrySource?: string | undefined;
-    blobCoreKey?: string | undefined;
-    blobBlockOffset?: number | undefined;
-    blobBlockLength?: number | undefined;
-    blobByteOffset?: number | undefined;
-    engine?: string | undefined;
-    quantization?: string | undefined;
-    params?: string | undefined;
-    actualSize?: number | undefined;
-    cachedAt?: Date | undefined;
-    loadedInstances?: {
-        registryId: string;
-        loadedAt: Date;
-        config?: unknown;
-    }[] | undefined;
-}>;
-//# sourceMappingURL=get-model-info.d.ts.map

package/dist/client/api/get-model-info.js

@@ -1,14 +0,0 @@
-import {} from "../../schemas/index.js";
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
-export async function getModelInfo(params) {
-    const request = {
-        type: "getModelInfo",
-        name: params.name,
-    };
-    const response = await send(request);
-    if (response.type !== "getModelInfo") {
-        throw new InvalidResponseError("getModelInfo");
-    }
-    return response.modelInfo;
-}

package/dist/client/api/heartbeat.d.ts

@@ -1,30 +0,0 @@
-import { type HeartbeatResponse } from "../../schemas/index";
-import type { DelegateBase } from "../../schemas/delegate";
-/**
- * Checks if a delegated provider is online by sending a heartbeat round-trip.
- * Can also be used to check if the local SDK worker is responsive.
- *
- * @param params - Delegation target to check
- * @param params.delegate - The provider to check (topic + publicKey + optional timeout)
- * @returns A promise that resolves to a heartbeat response if the provider is reachable.
- * @throws {QvacErrorBase} When the provider is unreachable or the response is invalid.
- *
- * @example
- * // Check if a delegated provider is online
- * try {
- *   await heartbeat({
- *     delegate: { topic: "topicHex", providerPublicKey: "peerHex", timeout: 3000 },
- *   });
- *   console.log("Provider is online");
- * } catch {
- *   console.log("Provider is offline");
- * }
- *
- * @example
- * // Check if the local SDK worker is responsive
- * await heartbeat();
- */
-export declare function heartbeat(params?: {
-    delegate?: DelegateBase;
-}): Promise<HeartbeatResponse>;
-//# sourceMappingURL=heartbeat.d.ts.map

package/dist/client/api/heartbeat.js

@@ -1,38 +0,0 @@
-import {} from "../../schemas/index.js";
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
-/**
- * Checks if a delegated provider is online by sending a heartbeat round-trip.
- * Can also be used to check if the local SDK worker is responsive.
- *
- * @param params - Delegation target to check
- * @param params.delegate - The provider to check (topic + publicKey + optional timeout)
- * @returns A promise that resolves to a heartbeat response if the provider is reachable.
- * @throws {QvacErrorBase} When the provider is unreachable or the response is invalid.
- *
- * @example
- * // Check if a delegated provider is online
- * try {
- *   await heartbeat({
- *     delegate: { topic: "topicHex", providerPublicKey: "peerHex", timeout: 3000 },
- *   });
- *   console.log("Provider is online");
- * } catch {
- *   console.log("Provider is offline");
- * }
- *
- * @example
- * // Check if the local SDK worker is responsive
- * await heartbeat();
- */
-export async function heartbeat(params) {
-    const request = {
-        type: "heartbeat",
-        ...(params?.delegate && { delegate: params.delegate }),
-    };
-    const response = await send(request);
-    if (response.type !== "heartbeat") {
-        throw new InvalidResponseError("heartbeat");
-    }
-    return response;
-}

package/dist/client/api/invoke-plugin.d.ts

@@ -1,15 +0,0 @@
-import type { RPCOptions } from "../../schemas/index";
-export interface InvokePluginOptions<TParams = unknown> {
-    modelId: string;
-    handler: string;
-    params: TParams;
-}
-/**
- * Invoke a non-streaming plugin handler.
- */
-export declare function invokePlugin<TResponse = unknown, TParams = unknown>(options: InvokePluginOptions<TParams>, rpcOptions?: RPCOptions): Promise<TResponse>;
-/**
- * Invoke a streaming plugin handler.
- */
-export declare function invokePluginStream<TResponse = unknown, TParams = unknown>(options: InvokePluginOptions<TParams>, rpcOptions?: RPCOptions): AsyncGenerator<TResponse>;
-//# sourceMappingURL=invoke-plugin.d.ts.map

package/dist/client/api/invoke-plugin.js

@@ -1,38 +0,0 @@
-import { send, stream } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
-/**
- * Invoke a non-streaming plugin handler.
- */
-export async function invokePlugin(options, rpcOptions) {
-    const request = {
-        type: "pluginInvoke",
-        modelId: options.modelId,
-        handler: options.handler,
-        params: options.params,
-    };
-    const response = await send(request, rpcOptions);
-    if (response.type !== "pluginInvoke") {
-        throw new InvalidResponseError("pluginInvoke");
-    }
-    return response.result;
-}
-/**
- * Invoke a streaming plugin handler.
- */
-export async function* invokePluginStream(options, rpcOptions) {
-    const request = {
-        type: "pluginInvokeStream",
-        modelId: options.modelId,
-        handler: options.handler,
-        params: options.params,
-    };
-    for await (const chunk of stream(request, rpcOptions)) {
-        const response = chunk;
-        if (response.type !== "pluginInvokeStream") {
-            throw new InvalidResponseError("pluginInvokeStream");
-        }
-        if (!response.done) {
-            yield response.result;
-        }
-    }
-}

package/dist/client/api/ocr.d.ts

@@ -1,31 +0,0 @@
-import { type OCRClientParams, type OCRTextBlock, type OCRStats } from "../../schemas/index";
-/**
- * Performs Optical Character Recognition (OCR) on an image to extract text.
- *
- * @param params - The OCR parameters
- * @param params.modelId - The identifier of the loaded OCR model to use
- * @param params.image - Image input as either a file path (string) or image buffer
- * @param params.options - Optional OCR options (e.g., paragraph mode)
- * @param params.stream - Whether to stream blocks as they're detected (true) or return all at once (false). Defaults to false
- * @returns Object with blockStream generator, blocks promise, and stats promise
- * @example
- * ```typescript
- * // Non-streaming mode (default) - get all blocks at once
- * const { blocks } = ocr({ modelId, image: "/path/to/image.png" });
- * for (const block of await blocks) {
- *   console.log(block.text, block.bbox, block.confidence);
- * }
- *
- * // Streaming mode - process blocks as they arrive
- * const { blockStream } = ocr({ modelId, image: imageBuffer, stream: true });
- * for await (const blocks of blockStream) {
- *   console.log("Detected:", blocks);
- * }
- * ```
- */
-export declare function ocr(params: OCRClientParams): {
-    blockStream: AsyncGenerator<OCRTextBlock[]>;
-    blocks: Promise<OCRTextBlock[]>;
-    stats: Promise<OCRStats | undefined>;
-};
-//# sourceMappingURL=ocr.d.ts.map

package/dist/client/api/ocr.js

@@ -1,88 +0,0 @@
-import { ocrStreamResponseSchema, } from "../../schemas/index.js";
-import { stream as streamRpc } from "../rpc/rpc-client.js";
-/**
- * Performs Optical Character Recognition (OCR) on an image to extract text.
- *
- * @param params - The OCR parameters
- * @param params.modelId - The identifier of the loaded OCR model to use
- * @param params.image - Image input as either a file path (string) or image buffer
- * @param params.options - Optional OCR options (e.g., paragraph mode)
- * @param params.stream - Whether to stream blocks as they're detected (true) or return all at once (false). Defaults to false
- * @returns Object with blockStream generator, blocks promise, and stats promise
- * @example
- * ```typescript
- * // Non-streaming mode (default) - get all blocks at once
- * const { blocks } = ocr({ modelId, image: "/path/to/image.png" });
- * for (const block of await blocks) {
- *   console.log(block.text, block.bbox, block.confidence);
- * }
- *
- * // Streaming mode - process blocks as they arrive
- * const { blockStream } = ocr({ modelId, image: imageBuffer, stream: true });
- * for await (const blocks of blockStream) {
- *   console.log("Detected:", blocks);
- * }
- * ```
- */
-export function ocr(params) {
-    const request = {
-        type: "ocrStream",
-        modelId: params.modelId,
-        image: typeof params.image === "string"
-            ? { type: "filePath", value: params.image }
-            : { type: "base64", value: params.image.toString("base64") },
-        ...(params.options && { options: params.options }),
-    };
-    let ocrStats;
-    let statsResolver = () => { };
-    const statsPromise = new Promise((resolve) => {
-        statsResolver = resolve;
-    });
-    if (params.stream) {
-        const blockStream = (async function* () {
-            for await (const response of streamRpc(request)) {
-                if (response.type === "ocrStream") {
-                    const streamResponse = ocrStreamResponseSchema.parse(response);
-                    if (streamResponse.blocks && streamResponse.blocks.length > 0) {
-                        yield streamResponse.blocks;
-                    }
-                    if (streamResponse.done) {
-                        ocrStats = streamResponse.stats;
-                        statsResolver(ocrStats);
-                    }
-                }
-            }
-        })();
-        return {
-            blockStream,
-            blocks: Promise.resolve([]),
-            stats: statsPromise,
-        };
-    }
-    else {
-        const blockStream = (async function* () {
-            // Empty generator for non-streaming mode
-        })();
-        const blocksPromise = (async () => {
-            let allBlocks = [];
-            for await (const response of streamRpc(request)) {
-                if (response.type === "ocrStream") {
-                    const streamResponse = ocrStreamResponseSchema.parse(response);
-                    if (streamResponse.blocks) {
-                        allBlocks = allBlocks.concat(streamResponse.blocks);
-                    }
-                    if (streamResponse.done) {
-                        ocrStats = streamResponse.stats;
-                        statsResolver(ocrStats);
-                    }
-                }
-            }
-            return allBlocks;
-        })();
-        return {
-            blockStream,
-            blocks: blocksPromise,
-            stats: statsPromise,
-        };
-    }
-}

package/dist/client/api/registry.d.ts

@@ -1,14 +0,0 @@
-import type { ModelRegistryEntry, ModelRegistryEntryAddon } from "../../schemas/index";
-export type { ModelRegistryEntry, ModelRegistryEntryAddon };
-export interface ModelRegistrySearchParams {
-    filter?: string;
-    engine?: string;
-    quantization?: string;
-    modelType?: ModelRegistryEntryAddon;
-    addon?: ModelRegistryEntryAddon;
-}
-declare function modelRegistryList(): Promise<ModelRegistryEntry[]>;
-declare function modelRegistrySearch(params?: ModelRegistrySearchParams): Promise<ModelRegistryEntry[]>;
-declare function modelRegistryGetModel(registryPath: string, registrySource: string): Promise<ModelRegistryEntry>;
-export { modelRegistryList, modelRegistrySearch, modelRegistryGetModel };
-//# sourceMappingURL=registry.d.ts.map

package/dist/client/api/registry.js

@@ -1,37 +0,0 @@
-import { send } from "../rpc/rpc-client.js";
-import { ModelRegistryQueryFailedError } from "../../utils/errors-client.js";
-function validateRegistryResponse(response, fallbackError) {
-    if (!response.success) {
-        throw new ModelRegistryQueryFailedError(response.error ?? fallbackError ?? "Unknown registry error");
-    }
-}
-async function modelRegistryList() {
-    const request = {
-        type: "modelRegistryList",
-    };
-    const response = (await send(request));
-    validateRegistryResponse(response);
-    return response.models;
-}
-async function modelRegistrySearch(params = {}) {
-    const { modelType, ...rest } = params;
-    const request = {
-        type: "modelRegistrySearch",
-        ...rest,
-        addon: modelType ?? rest.addon,
-    };
-    const response = (await send(request));
-    validateRegistryResponse(response);
-    return response.models;
-}
-async function modelRegistryGetModel(registryPath, registrySource) {
-    const request = {
-        type: "modelRegistryGetModel",
-        registryPath,
-        registrySource,
-    };
-    const response = (await send(request));
-    validateRegistryResponse(response, `Model not found: ${registrySource}/${registryPath}`);
-    return response.model;
-}
-export { modelRegistryList, modelRegistrySearch, modelRegistryGetModel };

package/dist/client/config-loader/config-utils.d.ts

@@ -1,5 +0,0 @@
-import { type QvacConfig } from "../../schemas/index";
-export type { QvacConfig };
-export declare function validateConfig(config: unknown): QvacConfig;
-export declare function parseJsonConfig(content: string, filePath: string): unknown;
-//# sourceMappingURL=config-utils.d.ts.map

package/dist/client/config-loader/config-utils.js

@@ -1,20 +0,0 @@
-import { qvacConfigSchema } from "../../schemas/index.js";
-import { ConfigValidationFailedError } from "../../utils/errors-client.js";
-export function validateConfig(config) {
-    const result = qvacConfigSchema.safeParse(config);
-    if (!result.success) {
-        const errors = result.error.issues
-            .map((e) => `${String(e.path.join("."))}:  ${e.message}`)
-            .join(", ");
-        throw new ConfigValidationFailedError(errors);
-    }
-    return result.data;
-}
-export function parseJsonConfig(content, filePath) {
-    try {
-        return JSON.parse(content);
-    }
-    catch {
-        throw new ConfigValidationFailedError(`Invalid JSON in config file: ${filePath}`);
-    }
-}

package/dist/client/config-loader/resolve-config.bare.d.ts

@@ -1,9 +0,0 @@
-import { type QvacConfig } from "./config-utils";
-/**
- * Resolution order for Bare:
- * 1. QVAC_CONFIG_PATH environment variable
- * 2. Config file in project root (qvac.config.ts, qvac.config.js, qvac.config.json)
- * 3. SDK defaults
- */
-export declare function resolveConfig(): Promise<QvacConfig | undefined>;
-//# sourceMappingURL=resolve-config.bare.d.ts.map

package/dist/client/config-loader/resolve-config.bare.js

@@ -1,87 +0,0 @@
-/**
- * Config loader for Bare runtime
- * Uses bare-fs and bare-path modules
- */
-import fs from "bare-fs";
-import path from "bare-path";
-import process from "bare-process";
-import { validateConfig, parseJsonConfig, } from "./config-utils.js";
-import { ConfigFileParseFailedError } from "../../utils/errors-client.js";
-import { getClientLogger } from "../../logging/index.js";
-const logger = getClientLogger();
-function findProjectRoot() {
-    return process.cwd();
-}
-function fileExists(filePath) {
-    return fs.existsSync(filePath);
-}
-function readFile(filePath) {
-    const result = fs.readFileSync(filePath, "utf-8");
-    return typeof result === "string" ? result : result.toString("utf-8");
-}
-function loadJsonConfig(filePath) {
-    const content = readFile(filePath);
-    const parsed = parseJsonConfig(content, filePath);
-    return validateConfig(parsed);
-}
-async function loadJsConfig(filePath) {
-    try {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const configModule = await import(filePath);
-        return validateConfig(configModule.default || configModule);
-    }
-    catch (error) {
-        throw new ConfigFileParseFailedError(filePath, error instanceof Error ? error.message : String(error), error);
-    }
-}
-function findConfigFile(searchDir) {
-    const configFiles = [
-        { name: "qvac.config.ts", type: "ts" },
-        { name: "qvac.config.js", type: "js" },
-        { name: "qvac.config.json", type: "json" },
-    ];
-    for (const { name, type } of configFiles) {
-        const filePath = path.resolve(searchDir, name);
-        if (fileExists(filePath)) {
-            return { path: filePath, type };
-        }
-    }
-    return undefined;
-}
-/**
- * Resolution order for Bare:
- * 1. QVAC_CONFIG_PATH environment variable
- * 2. Config file in project root (qvac.config.ts, qvac.config.js, qvac.config.json)
- * 3. SDK defaults
- */
-export async function resolveConfig() {
-    const configPath = process.env["QVAC_CONFIG_PATH"];
-    if (configPath) {
-        const normalizedPath = path.resolve(configPath);
-        if (fileExists(normalizedPath)) {
-            const ext = normalizedPath.endsWith(".json")
-                ? "json"
-                : normalizedPath.endsWith(".ts")
-                    ? "ts"
-                    : "js";
-            const config = ext === "json"
-                ? loadJsonConfig(normalizedPath)
-                : await loadJsConfig(normalizedPath);
-            logger.info(`✅ Loaded config from: ${normalizedPath}`);
-            return config;
-        }
-    }
-    const projectRoot = findProjectRoot();
-    if (projectRoot) {
-        const configFile = findConfigFile(projectRoot);
-        if (configFile) {
-            const config = configFile.type === "json"
-                ? loadJsonConfig(configFile.path)
-                : await loadJsConfig(configFile.path);
-            logger.info(`✅ Loaded config from: ${configFile.path}`);
-            return config;
-        }
-    }
-    logger.info("ℹ️ No config file found, using SDK defaults");
-    return undefined;
-}

package/dist/client/config-loader/resolve-config.expo.d.ts

@@ -1,11 +0,0 @@
-import { type QvacConfig } from "./config-utils";
-/**
- * Resolution order for Expo:
- * 1. QVAC_CONFIG_PATH environment variable (if set)
- * 2. Default Expo path: ${Paths.document.uri}qvac.config.json
- * 3. SDK defaults
- *
- * Note: Only JSON config files are supported in React Native
- */
-export declare function resolveConfig(): Promise<QvacConfig | undefined>;
-//# sourceMappingURL=resolve-config.expo.d.ts.map

package/dist/client/config-loader/resolve-config.expo.js

@@ -1,62 +0,0 @@
-/**
- * Config loader for Expo/React Native runtime
- * Only uses expo-file-system - no Node.js or Bare imports
- */
-import { File, Paths } from "expo-file-system";
-import { validateConfig, parseJsonConfig, } from "./config-utils.js";
-import { getClientLogger } from "../../logging/index.js";
-const logger = getClientLogger();
-function fileExists(filePath) {
-    try {
-        const file = new File(filePath);
-        return file.exists;
-    }
-    catch {
-        return false;
-    }
-}
-async function readFile(filePath) {
-    const file = new File(filePath);
-    return await file.text();
-}
-async function loadJsonConfig(filePath) {
-    const content = await readFile(filePath);
-    const parsed = parseJsonConfig(content, filePath);
-    return validateConfig(parsed);
-}
-/**
- * Resolution order for Expo:
- * 1. QVAC_CONFIG_PATH environment variable (if set)
- * 2. Default Expo path: ${Paths.document.uri}qvac.config.json
- * 3. SDK defaults
- *
- * Note: Only JSON config files are supported in React Native
- */
-export async function resolveConfig() {
-    // Check environment variable first
-    const configPath = typeof process !== "undefined"
-        ? process.env?.["QVAC_CONFIG_PATH"]
-        : undefined;
-    if (configPath) {
-        if (fileExists(configPath)) {
-            logger.info(`✅ Loaded config from: ${configPath}`);
-            return await loadJsonConfig(configPath);
-        }
-    }
-    // Try default Expo document directory path
-    try {
-        const documentDir = Paths.document.uri;
-        if (documentDir) {
-            const defaultExpoConfigPath = `${documentDir}qvac.config.json`;
-            if (fileExists(defaultExpoConfigPath)) {
-                logger.info(`✅ Loaded config from: ${defaultExpoConfigPath}`);
-                return await loadJsonConfig(defaultExpoConfigPath);
-            }
-        }
-    }
-    catch {
-        // Paths not available
-    }
-    logger.info("ℹ️ No config file found, using SDK defaults");
-    return undefined;
-}

package/dist/client/config-loader/resolve-config.node.d.ts

@@ -1,10 +0,0 @@
-import { type QvacConfig } from "./config-utils";
-/**
- * Resolution order for Node.js:
- * 1. QVAC_CONFIG_PATH environment variable
- * 2. Packaged Electron app (via process.resourcesPath)
- * 3. Config file in project root (qvac.config.ts, qvac.config.js, qvac.config.json)
- * 4. SDK defaults
- */
-export declare function resolveConfig(): Promise<QvacConfig | undefined>;
-//# sourceMappingURL=resolve-config.node.d.ts.map