@qvac/sdk 0.8.1 → 1.0.0

package/dist/schemas/sdk-config.js

@@ -1,136 +0,0 @@
-import { z } from "zod";
-import { logLevelSchema } from "./logging-stream.js";
-import { ModelType } from "./model-types.js";
-import { llmConfigBaseSchema, embedConfigBaseSchema } from "./llamacpp-config.js";
-import { whisperConfigSchema, parakeetConfigSchema, } from "./transcription-config.js";
-import { ocrConfigSchema } from "./ocr.js";
-import { runtimeContextSchema } from "./runtime-context.js";
-// Alias keys for user convenience (maps to canonical types)
-const AliasKeys = {
-    llm: "llm",
-    whisper: "whisper",
-    embeddings: "embeddings",
-    nmt: "nmt",
-    parakeet: "parakeet",
-    tts: "tts",
-    ocr: "ocr",
-};
-/**
- * Device match criteria for device-specific config defaults.
- * All specified criteria must match (AND logic).
- */
-export const deviceMatchSchema = z.object({
-    /** Platform to match: "android" or "ios" */
-    platform: runtimeContextSchema.shape.platform,
-    /** Device brand to match (case-insensitive exact match, e.g., "google", "samsung") */
-    deviceBrand: z.string().optional(),
-    /** Device model prefix to match (e.g., "Pixel 10" matches "Pixel 10 Pro") */
-    deviceModelPrefix: z.string().optional(),
-    /** Device model substring to match (e.g., "Galaxy" matches "Samsung Galaxy S25") */
-    deviceModelContains: z.string().optional(),
-});
-/**
- * Device-specific model config defaults.
- * Accepts both canonical keys (e.g., "llamacpp-completion") and alias keys (e.g., "llm").
- * NMT and TTS use passthrough since they don't have device-relevant config.
- */
-export const deviceConfigDefaultsSchema = z
-    .object({
-    // Canonical keys
-    [ModelType.llamacppCompletion]: llmConfigBaseSchema.optional(),
-    [ModelType.llamacppEmbedding]: embedConfigBaseSchema.optional(),
-    [ModelType.whispercppTranscription]: whisperConfigSchema
-        .partial()
-        .optional(),
-    [ModelType.parakeetTranscription]: parakeetConfigSchema
-        .partial()
-        .optional(),
-    [ModelType.nmtcppTranslation]: z.record(z.string(), z.unknown()).optional(),
-    [ModelType.onnxTts]: z.record(z.string(), z.unknown()).optional(),
-    [ModelType.onnxOcr]: ocrConfigSchema.partial().optional(),
-    // Alias keys (user-friendly)
-    [AliasKeys.llm]: llmConfigBaseSchema.optional(),
-    [AliasKeys.embeddings]: embedConfigBaseSchema.optional(),
-    [AliasKeys.whisper]: whisperConfigSchema.partial().optional(),
-    [AliasKeys.parakeet]: parakeetConfigSchema.partial().optional(),
-    [AliasKeys.nmt]: z.record(z.string(), z.unknown()).optional(),
-    [AliasKeys.tts]: z.record(z.string(), z.unknown()).optional(),
-    [AliasKeys.ocr]: ocrConfigSchema.partial().optional(),
-})
-    .partial();
-/**
- * A device pattern rule for applying config defaults.
- */
-export const devicePatternSchema = z.object({
-    /** Human-readable name for this pattern (used in logs) */
-    name: z.string(),
-    /** Match criteria - all specified fields must match */
-    match: deviceMatchSchema,
-    /** Config defaults to apply when matched */
-    defaults: deviceConfigDefaultsSchema,
-});
-const directoryPath = z.string().transform((s) => s.replace(/\/+$/, ""));
-/**
- * QVAC SDK Configuration Schema
- *
- * This configuration is loaded once at SDK initialization from a config file
- * (qvac.config.json, qvac.config.js, or qvac.config.ts) and remains immutable
- * throughout the SDK's lifetime.
- */
-export const qvacConfigSchema = z.object({
-    /**
-     * Absolute path to the directory where models and other cached assets are stored.
-     * If not specified, defaults to ~/.qvac/models
-     */
-    cacheDirectory: directoryPath.optional(),
-    /**
-     * Array of Hyperswarm relay public keys (hex strings) for improved P2P connectivity.
-     * Blind relays help with NAT traversal and firewall bypassing.
-     */
-    swarmRelays: z.array(z.string()).optional(),
-    /**
-     * Global log level for all SDK loggers.
-     * Options: "error", "warn", "info", "debug"
-     * Defaults to "info".
-     */
-    loggerLevel: logLevelSchema.optional(),
-    /**
-     * Enable or disable console output for SDK loggers.
-     * When false, logs are only sent to streams/transports, not printed to console.
-     * Defaults to true.
-     */
-    loggerConsoleOutput: z.boolean().optional(),
-    /**
-     * Maximum number of concurrent HTTP downloads for sharded models.
-     * Higher values may improve download speed but increase memory usage.
-     * Defaults to 3.
-     */
-    httpDownloadConcurrency: z.number().int().positive().optional(),
-    /**
-     * Timeout in milliseconds for HTTP connection establishment.
-     * This applies to HEAD and GET requests.
-     * If the connection is not established within this time, the request fails.
-     * Defaults to 10000 (10 seconds).
-     */
-    httpConnectionTimeoutMs: z.number().int().positive().optional(),
-    /**
-     * Device-specific config defaults.
-     * Use this to override model config defaults for specific devices.
-     * User-defined patterns are checked before SDK built-in patterns.
-     * First matching pattern wins.
-     *
-     * @example
-     * ```json
-     * {
-     *   "deviceDefaults": [
-     *     {
-     *       "name": "Custom Samsung",
-     *       "match": { "platform": "android", "deviceBrand": "samsung" },
-     *       "defaults": { "llm": { "device": "cpu" } }
-     *     }
-     *   ]
-     * }
-     * ```
-     */
-    deviceDefaults: z.array(devicePatternSchema).optional(),
-});

package/dist/schemas/sdk-errors-client.d.ts

@@ -1,31 +0,0 @@
-import { type ErrorCodesMap } from "@qvac/error";
-export declare const SDK_CLIENT_ERROR_CODES: {
-    readonly INVALID_RESPONSE_TYPE: 50001;
-    readonly INVALID_OPERATION_IN_RESPONSE: 50002;
-    readonly STREAM_ENDED_WITHOUT_RESPONSE: 50003;
-    readonly INVALID_AUDIO_CHUNK_TYPE: 50004;
-    readonly INVALID_TOOLS_ARRAY: 50005;
-    readonly INVALID_TOOL_SCHEMA: 50006;
-    readonly OCR_FAILED: 50007;
-    readonly RPC_NO_HANDLER: 50200;
-    readonly RPC_REQUEST_NOT_SENT: 50201;
-    readonly RPC_RESPONSE_STREAM_NOT_CREATED: 50202;
-    readonly RPC_CONNECTION_FAILED: 50203;
-    readonly PROVIDER_START_FAILED: 50400;
-    readonly PROVIDER_STOP_FAILED: 50401;
-    readonly DELEGATE_NO_FINAL_RESPONSE: 50402;
-    readonly DELEGATE_PROVIDER_ERROR: 50403;
-    readonly DELEGATE_CONNECTION_FAILED: 50404;
-    readonly SDK_NOT_FOUND_IN_NODE_MODULES: 50600;
-    readonly WORKER_FILE_NOT_FOUND: 50601;
-    readonly CONFIG_FILE_NOT_FOUND: 50602;
-    readonly CONFIG_FILE_INVALID: 50603;
-    readonly CONFIG_FILE_PARSE_FAILED: 50604;
-    readonly CONFIG_VALIDATION_FAILED: 50605;
-    readonly PEAR_WORKER_ENTRY_REQUIRED: 50606;
-    readonly MULTIPLE_SDK_INSTALLATIONS: 50607;
-    readonly PROFILER_INVALID_CAPACITY: 50800;
-};
-declare const clientErrorDefinitions: ErrorCodesMap;
-export { clientErrorDefinitions as SDK_CLIENT_ERROR_DEFINITIONS };
-//# sourceMappingURL=sdk-errors-client.d.ts.map

package/dist/schemas/sdk-errors-client.js

@@ -1,143 +0,0 @@
-import { addCodes } from "@qvac/error";
-// Client-side error codes (50,001-52,000 range for this SDK)
-export const SDK_CLIENT_ERROR_CODES = {
-    // Response Validation Errors (50,001-50,199)
-    INVALID_RESPONSE_TYPE: 50001,
-    INVALID_OPERATION_IN_RESPONSE: 50002,
-    STREAM_ENDED_WITHOUT_RESPONSE: 50003,
-    INVALID_AUDIO_CHUNK_TYPE: 50004,
-    INVALID_TOOLS_ARRAY: 50005,
-    INVALID_TOOL_SCHEMA: 50006,
-    OCR_FAILED: 50007,
-    // RPC Communication Errors (50,200-50,399)
-    RPC_NO_HANDLER: 50200,
-    RPC_REQUEST_NOT_SENT: 50201,
-    RPC_RESPONSE_STREAM_NOT_CREATED: 50202,
-    RPC_CONNECTION_FAILED: 50203,
-    // Provider/Delegation Errors (50,400-50,599)
-    PROVIDER_START_FAILED: 50400,
-    PROVIDER_STOP_FAILED: 50401,
-    DELEGATE_NO_FINAL_RESPONSE: 50402,
-    DELEGATE_PROVIDER_ERROR: 50403,
-    DELEGATE_CONNECTION_FAILED: 50404,
-    // Build/Bundle Errors (50,600-50,799)
-    SDK_NOT_FOUND_IN_NODE_MODULES: 50600,
-    WORKER_FILE_NOT_FOUND: 50601,
-    CONFIG_FILE_NOT_FOUND: 50602,
-    CONFIG_FILE_INVALID: 50603,
-    CONFIG_FILE_PARSE_FAILED: 50604,
-    CONFIG_VALIDATION_FAILED: 50605,
-    PEAR_WORKER_ENTRY_REQUIRED: 50606,
-    MULTIPLE_SDK_INSTALLATIONS: 50607,
-    // Profiler Errors (50,800-50,899)
-    PROFILER_INVALID_CAPACITY: 50800,
-};
-const clientErrorDefinitions = {
-    // Response Validation Errors (50,001-50,199)
-    [SDK_CLIENT_ERROR_CODES.INVALID_RESPONSE_TYPE]: {
-        name: "INVALID_RESPONSE_TYPE",
-        message: (expected) => `Invalid response type received, expected: ${expected}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.INVALID_OPERATION_IN_RESPONSE]: {
-        name: "INVALID_OPERATION_IN_RESPONSE",
-        message: "Invalid operation type in response",
-    },
-    [SDK_CLIENT_ERROR_CODES.STREAM_ENDED_WITHOUT_RESPONSE]: {
-        name: "STREAM_ENDED_WITHOUT_RESPONSE",
-        message: "Stream ended without receiving final response",
-    },
-    [SDK_CLIENT_ERROR_CODES.INVALID_AUDIO_CHUNK_TYPE]: {
-        name: "INVALID_AUDIO_CHUNK_TYPE",
-        message: "Invalid audio chunk type received",
-    },
-    [SDK_CLIENT_ERROR_CODES.INVALID_TOOLS_ARRAY]: {
-        name: "INVALID_TOOLS_ARRAY",
-        message: "Invalid tools array provided",
-    },
-    [SDK_CLIENT_ERROR_CODES.INVALID_TOOL_SCHEMA]: {
-        name: "INVALID_TOOL_SCHEMA",
-        message: (details) => `Invalid tool schema: ${details}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.OCR_FAILED]: {
-        name: "OCR_FAILED",
-        message: (details) => `OCR operation failed${details ? `: ${details}` : ""}`,
-    },
-    // RPC Communication Errors (50,200-50,399)
-    [SDK_CLIENT_ERROR_CODES.RPC_NO_HANDLER]: {
-        name: "RPC_NO_HANDLER",
-        message: (requestType) => `No handler function registered for request type: ${requestType}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.RPC_REQUEST_NOT_SENT]: {
-        name: "RPC_REQUEST_NOT_SENT",
-        message: "Cannot perform operation - request has not been sent yet",
-    },
-    [SDK_CLIENT_ERROR_CODES.RPC_RESPONSE_STREAM_NOT_CREATED]: {
-        name: "RPC_RESPONSE_STREAM_NOT_CREATED",
-        message: "Cannot perform operation - response stream not created",
-    },
-    [SDK_CLIENT_ERROR_CODES.RPC_CONNECTION_FAILED]: {
-        name: "RPC_CONNECTION_FAILED",
-        message: (details) => `RPC connection failed: ${details}`,
-    },
-    // Provider/Delegation Errors (50,400-50,599)
-    [SDK_CLIENT_ERROR_CODES.PROVIDER_START_FAILED]: {
-        name: "PROVIDER_START_FAILED",
-        message: (details) => `Failed to start provider${details ? `: ${details}` : ""}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.PROVIDER_STOP_FAILED]: {
-        name: "PROVIDER_STOP_FAILED",
-        message: (details) => `Failed to stop provider${details ? `: ${details}` : ""}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.DELEGATE_NO_FINAL_RESPONSE]: {
-        name: "DELEGATE_NO_FINAL_RESPONSE",
-        message: "No final response received from delegated provider",
-    },
-    [SDK_CLIENT_ERROR_CODES.DELEGATE_PROVIDER_ERROR]: {
-        name: "DELEGATE_PROVIDER_ERROR",
-        message: (details) => `Delegated provider error: ${details}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.DELEGATE_CONNECTION_FAILED]: {
-        name: "DELEGATE_CONNECTION_FAILED",
-        message: (details) => `Failed to connect to delegated provider: ${details}`,
-    },
-    // Build/Bundle Errors (50,600-50,799)
-    [SDK_CLIENT_ERROR_CODES.SDK_NOT_FOUND_IN_NODE_MODULES]: {
-        name: "SDK_NOT_FOUND_IN_NODE_MODULES",
-        message: "QVAC SDK not found in node_modules. Checked: @qvac/sdk, @tetherto/sdk-mono, @tetherto/sdk-dev",
-    },
-    [SDK_CLIENT_ERROR_CODES.WORKER_FILE_NOT_FOUND]: {
-        name: "WORKER_FILE_NOT_FOUND",
-        message: (workerPath) => `Worker file not found at ${workerPath}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.CONFIG_FILE_NOT_FOUND]: {
-        name: "CONFIG_FILE_NOT_FOUND",
-        message: (searchPaths) => `Config file not found. Searched: ${searchPaths}. Create qvac.config.json, qvac.config.js, or qvac.config.ts in your project root.`,
-    },
-    [SDK_CLIENT_ERROR_CODES.CONFIG_FILE_INVALID]: {
-        name: "CONFIG_FILE_INVALID",
-        message: (filePath, reason) => `Config file at ${filePath} is invalid: ${reason}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.CONFIG_FILE_PARSE_FAILED]: {
-        name: "CONFIG_FILE_PARSE_FAILED",
-        message: (filePath, error) => `Failed to parse config file at ${filePath}: ${error}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.CONFIG_VALIDATION_FAILED]: {
-        name: "CONFIG_VALIDATION_FAILED",
-        message: (errors) => `Config validation failed: ${errors}`,
-    },
-    [SDK_CLIENT_ERROR_CODES.MULTIPLE_SDK_INSTALLATIONS]: {
-        name: "MULTIPLE_SDK_INSTALLATIONS",
-        message: (packages) => `Multiple QVAC SDK installations found: ${packages}. Remove all but one to avoid conflicts.`,
-    },
-    [SDK_CLIENT_ERROR_CODES.PEAR_WORKER_ENTRY_REQUIRED]: {
-        name: "PEAR_WORKER_ENTRY_REQUIRED",
-        message: (workerEntry) => `No plugins registered. Pear apps must spawn ${workerEntry} as the worker entry. Run \`npx qvac bundle sdk\` to generate it, then spawn the generated file instead of your worker directly.`,
-    },
-    // Profiler Errors (50,800-50,899)
-    [SDK_CLIENT_ERROR_CODES.PROFILER_INVALID_CAPACITY]: {
-        name: "PROFILER_INVALID_CAPACITY",
-        message: (minCapacity) => `Ring buffer capacity must be at least ${minCapacity}`,
-    },
-};
-addCodes(clientErrorDefinitions, { name: "qvac-sdk-client", version: "1.1.0" });
-export { clientErrorDefinitions as SDK_CLIENT_ERROR_DEFINITIONS };

package/dist/schemas/sdk-errors-registry.d.ts

@@ -1,6 +0,0 @@
-export declare const REGISTRY_ERROR_CODES: {
-    readonly FAILED_TO_CONNECT: 19001;
-    readonly FAILED_TO_CLOSE: 19002;
-    readonly MODEL_NOT_FOUND: 19003;
-};
-//# sourceMappingURL=sdk-errors-registry.d.ts.map

package/dist/schemas/sdk-errors-registry.js

@@ -1,8 +0,0 @@
-// Registry client error codes (19,001-20,000 range)
-// These match the codes from @qvac/registry-client/utils/error.js
-// Used for checking error types - the actual error definitions are in the registry client
-export const REGISTRY_ERROR_CODES = {
-    FAILED_TO_CONNECT: 19001,
-    FAILED_TO_CLOSE: 19002,
-    MODEL_NOT_FOUND: 19003,
-};

package/dist/schemas/sdk-errors-server.d.ts

@@ -1,89 +0,0 @@
-import { type ErrorCodesMap } from "@qvac/error";
-export declare const SDK_SERVER_ERROR_CODES: {
-    readonly MODEL_ALREADY_REGISTERED: 52001;
-    readonly MODEL_NOT_FOUND: 52002;
-    readonly MODEL_NOT_LOADED: 52003;
-    readonly MODEL_IS_DELEGATED: 52004;
-    readonly UNKNOWN_MODEL_TYPE: 52005;
-    readonly MODEL_LOAD_FAILED: 52200;
-    readonly MODEL_FILE_NOT_FOUND: 52201;
-    readonly MODEL_FILE_NOT_FOUND_IN_DIR: 52202;
-    readonly MODEL_FILE_LOCATE_FAILED: 52203;
-    readonly PROJECTION_MODEL_REQUIRED: 52204;
-    readonly VAD_MODEL_REQUIRED: 52205;
-    readonly TTS_ARTIFACTS_REQUIRED: 52208;
-    readonly TTS_REFERENCE_AUDIO_REQUIRED: 52209;
-    readonly PARAKEET_ARTIFACTS_REQUIRED: 52210;
-    readonly MODEL_UNLOAD_FAILED: 52400;
-    readonly EMBED_FAILED: 52401;
-    readonly EMBED_NO_EMBEDDINGS: 52402;
-    readonly TRANSCRIPTION_FAILED: 52403;
-    readonly AUDIO_FILE_NOT_FOUND: 52404;
-    readonly TRANSLATION_FAILED: 52405;
-    readonly COMPLETION_FAILED: 52406;
-    readonly ATTACHMENT_NOT_FOUND: 52407;
-    readonly CANCEL_FAILED: 52408;
-    readonly TEXT_TO_SPEECH_FAILED: 52409;
-    readonly CONFIG_RELOAD_NOT_SUPPORTED: 52410;
-    readonly MODEL_TYPE_MISMATCH: 52411;
-    readonly OCR_FAILED: 52412;
-    readonly IMAGE_FILE_NOT_FOUND: 52413;
-    readonly INVALID_IMAGE_INPUT: 52414;
-    readonly RAG_SAVE_FAILED: 52800;
-    readonly RAG_SEARCH_FAILED: 52801;
-    readonly RAG_DELETE_FAILED: 52802;
-    readonly RAG_UNKNOWN_OPERATION: 52803;
-    readonly RAG_HYPERDB_FAILED: 52804;
-    readonly RAG_WORKSPACE_MODEL_MISMATCH: 52805;
-    readonly RAG_WORKSPACE_NOT_FOUND: 52806;
-    readonly RAG_WORKSPACE_IN_USE: 52807;
-    readonly RAG_WORKSPACE_CLOSE_FAILED: 52808;
-    readonly RAG_LIST_WORKSPACES_FAILED: 52809;
-    readonly RAG_CHUNK_FAILED: 52810;
-    readonly RAG_WORKSPACE_NOT_OPEN: 52811;
-    readonly FILE_NOT_FOUND: 53000;
-    readonly DOWNLOAD_CANCELLED: 53001;
-    readonly CHECKSUM_VALIDATION_FAILED: 53002;
-    readonly HTTP_ERROR: 53003;
-    readonly NO_RESPONSE_BODY: 53004;
-    readonly RESPONSE_BODY_NOT_READABLE: 53005;
-    readonly NO_BLOB_FOUND: 53006;
-    readonly DOWNLOAD_ASSET_FAILED: 53007;
-    readonly SEEDING_NOT_SUPPORTED: 53008;
-    readonly HYPERDRIVE_DOWNLOAD_FAILED: 53009;
-    readonly INVALID_SHARD_URL_PATTERN: 53010;
-    readonly ARCHIVE_EXTRACTION_FAILED: 53011;
-    readonly ARCHIVE_UNSUPPORTED_TYPE: 53012;
-    readonly ARCHIVE_MISSING_SHARDS: 53013;
-    readonly PARTIAL_DOWNLOAD_OFFLINE: 53014;
-    readonly REGISTRY_DOWNLOAD_FAILED: 53015;
-    readonly DELETE_CACHE_FAILED: 53200;
-    readonly INVALID_DELETE_CACHE_PARAMS: 53201;
-    readonly CACHE_DIR_NOT_ABSOLUTE: 53202;
-    readonly CACHE_DIR_NOT_WRITABLE: 53203;
-    readonly SET_CONFIG_FAILED: 53350;
-    readonly CONFIG_ALREADY_SET: 53351;
-    readonly FFMPEG_NOT_AVAILABLE: 53500;
-    readonly AUDIO_PLAYER_FAILED: 53501;
-    readonly INVALID_AUDIO_CHUNK_TYPE: 53502;
-    readonly DELEGATE_NO_FINAL_RESPONSE: 53700;
-    readonly DELEGATE_CONNECTION_FAILED: 53701;
-    readonly DELEGATE_PROVIDER_ERROR: 53702;
-    readonly RPC_NO_DATA_RECEIVED: 53703;
-    readonly RPC_UNKNOWN_REQUEST_TYPE: 53704;
-    readonly PLUGIN_NOT_FOUND: 53850;
-    readonly PLUGIN_HANDLER_NOT_FOUND: 53851;
-    readonly PLUGIN_REQUEST_VALIDATION_FAILED: 53852;
-    readonly PLUGIN_RESPONSE_VALIDATION_FAILED: 53853;
-    readonly PLUGIN_ALREADY_REGISTERED: 53854;
-    readonly PLUGIN_HANDLER_TYPE_MISMATCH: 53855;
-    readonly PLUGIN_LOGGING_INVALID: 53856;
-    readonly PLUGIN_DEFINITION_INVALID: 53857;
-    readonly PLUGIN_MODEL_TYPE_RESERVED: 53858;
-    readonly PLUGIN_LOAD_CONFIG_VALIDATION_FAILED: 53859;
-    readonly PATH_TRAVERSAL: 53900;
-    readonly QVAC_MODEL_REGISTRY_QUERY_FAILED: 53950;
-};
-declare const serverErrorDefinitions: ErrorCodesMap;
-export { serverErrorDefinitions as SDK_SERVER_ERROR_DEFINITIONS };
-//# sourceMappingURL=sdk-errors-server.d.ts.map