@qvac/sdk 0.14.1 → 0.16.0

package/dist/client/api/ocr.js

@@ -1,5 +1,5 @@
-import { ocrStreamResponseSchema, } from "../../schemas/index.js";
-import { stream as streamRpc } from "../rpc/rpc-client.js";
+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.
  *
@@ -11,6 +11,15 @@ import { stream as streamRpc } from "../rpc/rpc-client.js";
  * @returns Object with blockStream generator, blocks promise, and stats promise
  * @example
  * ```typescript
+ * // Load an OCR model first. Registry GGUF models resolve their pipeline
+ * // and detector automatically:
+ * //   EasyOCR (default): OCR_LATIN  (CRAFT detector auto-derived)
+ * //   DocTR:             OCR_DOCTR  (DBNet detector auto-derived)
+ * const modelId = await loadModel({
+ *   modelSrc: OCR_LATIN.src,
+ *   modelType: MODEL_TYPES.ggmlOcr,
+ * });
+ *
  * // Non-streaming mode (default) - get all blocks at once
  * const { blocks } = ocr({ modelId, image: "/path/to/image.png" });
  * for (const block of await blocks) {
@@ -26,12 +35,12 @@ import { stream as streamRpc } from "../rpc/rpc-client.js";
  */
 export function ocr(params) {
     const request = {
-        type: "ocrStream",
+        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 }),
+        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 = () => { };
@@ -41,7 +50,7 @@ export function ocr(params) {
     if (params.stream) {
         const blockStream = (async function* () {
             for await (const response of streamRpc(request)) {
-                if (response.type === "ocrStream") {
+                if (response.type === 'ocrStream') {
                     const streamResponse = ocrStreamResponseSchema.parse(response);
                     if (streamResponse.blocks && streamResponse.blocks.length > 0) {
                         yield streamResponse.blocks;
@@ -56,7 +65,7 @@ export function ocr(params) {
         return {
             blockStream,
             blocks: Promise.resolve([]),
-            stats: statsPromise,
+            stats: statsPromise
         };
     }
     else {
@@ -66,7 +75,7 @@ export function ocr(params) {
         const blocksPromise = (async () => {
             let allBlocks = [];
             for await (const response of streamRpc(request)) {
-                if (response.type === "ocrStream") {
+                if (response.type === 'ocrStream') {
                     const streamResponse = ocrStreamResponseSchema.parse(response);
                     if (streamResponse.blocks) {
                         allBlocks = allBlocks.concat(streamResponse.blocks);
@@ -82,7 +91,7 @@ export function ocr(params) {
         return {
             blockStream,
             blocks: blocksPromise,
-            stats: statsPromise,
+            stats: statsPromise
         };
     }
 }

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

@@ -1,4 +1,4 @@
-import { type ProvideParams } from "../../schemas/index";
+import { type ProvideParams } from '../../schemas/index';
 /**
  * Starts a provider service that offers QVAC capabilities to remote peers.
  *

package/dist/client/api/provide.js

@@ -1,6 +1,6 @@
-import {} from "../../schemas/index.js";
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError, ProviderStartFailedError, } from "../../utils/errors-client.js";
+import {} from '../../schemas/index.js';
+import { send } from '../rpc/rpc-client.js';
+import { InvalidResponseError, ProviderStartFailedError } from '../../utils/errors-client.js';
 /**
  * Starts a provider service that offers QVAC capabilities to remote peers.
  *
@@ -19,12 +19,12 @@ import { InvalidResponseError, ProviderStartFailedError, } from "../../utils/err
  */
 export async function startQVACProvider(params = {}) {
     const request = {
-        type: "provide",
-        firewall: params.firewall,
+        type: 'provide',
+        firewall: params.firewall
     };
     const response = await send(request);
-    if (response.type !== "provide") {
-        throw new InvalidResponseError("provide");
+    if (response.type !== 'provide') {
+        throw new InvalidResponseError('provide');
     }
     if (response.error) {
         throw new ProviderStartFailedError(response.error);

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

@@ -1,4 +1,4 @@
-import type { RagChunkParams, RagDoc, RagIngestParams, RagSaveEmbeddingsParams, RagSaveEmbeddingsResult, RagSearchParams, RagSearchResult, RagDeleteEmbeddingsParams, RagReindexParams, RagReindexResult, RagWorkspaceInfo, RagCloseWorkspaceParams, RagDeleteWorkspaceParams, RPCOptions } from "../../schemas/index";
+import type { RagChunkParams, RagDoc, RagIngestParams, RagSaveEmbeddingsParams, RagSaveEmbeddingsResult, RagSearchParams, RagSearchResult, RagDeleteEmbeddingsParams, RagReindexParams, RagReindexResult, RagWorkspaceInfo, RagCloseWorkspaceParams, RagDeleteWorkspaceParams, RPCOptions } from '../../schemas/index';
 /**
  * Chunks documents into smaller pieces for embedding.
  * Part of the segregated flow: ragChunk() → embed() → ragSaveEmbeddings()

package/dist/client/api/rag.js

@@ -1,7 +1,7 @@
-import { send, stream } from "../rpc/rpc-client.js";
-import { InvalidResponseError, InvalidOperationError, StreamEndedError, RAGChunkFailedError, RAGSaveFailedError, RAGSearchFailedError, RAGDeleteFailedError, RAGCloseWorkspaceFailedError, RAGListWorkspacesFailedError, } from "../../utils/errors-client.js";
-import { generateClientRequestId } from "./client-request-id.js";
-import { decoratePromise } from "../../utils/decorate-promise.js";
+import { send, stream } from '../rpc/rpc-client.js';
+import { InvalidResponseError, InvalidOperationError, StreamEndedError, RAGChunkFailedError, RAGSaveFailedError, RAGSearchFailedError, RAGDeleteFailedError, RAGCloseWorkspaceFailedError, RAGListWorkspacesFailedError } from '../../utils/errors-client.js';
+import { generateClientRequestId } from './client-request-id.js';
+import { decoratePromise } from '../../utils/decorate-promise.js';
 // ============== Chunk ==============
 /**
  * Chunks documents into smaller pieces for embedding.
@@ -28,18 +28,18 @@ import { decoratePromise } from "../../utils/decorate-promise.js";
  */
 export async function ragChunk(params, options) {
     const request = {
-        type: "rag",
-        operation: "chunk",
-        ...params,
+        type: 'rag',
+        operation: 'chunk',
+        ...params
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGChunkFailedError(response.error);
     }
-    if (response.operation !== "chunk") {
+    if (response.operation !== 'chunk') {
         throw new InvalidOperationError();
     }
     return response.chunks;
@@ -92,46 +92,46 @@ export function ragIngest(params, options) {
 async function runRagIngest(params, requestId, options) {
     const { onProgress, ...requestParams } = params;
     const request = {
-        type: "rag",
-        operation: "ingest",
+        type: 'rag',
+        operation: 'ingest',
         ...requestParams,
         chunk: requestParams.chunk ?? true,
         withProgress: onProgress ? true : undefined,
-        requestId,
+        requestId
     };
     if (onProgress) {
         // Use streaming for progress updates
         for await (const event of stream(request, options)) {
-            if (event.type === "rag:progress" && event.operation === "ingest") {
+            if (event.type === 'rag:progress' && event.operation === 'ingest') {
                 const progress = event;
                 onProgress(progress.stage, progress.current, progress.total);
                 continue;
             }
-            if (event.type === "rag" && event.operation === "ingest") {
+            if (event.type === 'rag' && event.operation === 'ingest') {
                 if (!event.success) {
                     throw new RAGSaveFailedError(event.error);
                 }
                 return {
                     processed: event.processed,
-                    droppedIndices: event.droppedIndices,
+                    droppedIndices: event.droppedIndices
                 };
             }
         }
         throw new StreamEndedError();
     }
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGSaveFailedError(response.error);
     }
-    if (response.operation !== "ingest") {
+    if (response.operation !== 'ingest') {
         throw new InvalidOperationError();
     }
     return {
         processed: response.processed,
-        droppedIndices: response.droppedIndices,
+        droppedIndices: response.droppedIndices
     };
 }
 // ============== SaveEmbeddings ==============
@@ -176,21 +176,20 @@ export function ragSaveEmbeddings(params, options) {
 async function runRagSaveEmbeddings(params, requestId, options) {
     const { onProgress, ...requestParams } = params;
     const request = {
-        type: "rag",
-        operation: "saveEmbeddings",
+        type: 'rag',
+        operation: 'saveEmbeddings',
         ...requestParams,
         withProgress: onProgress ? true : undefined,
-        requestId,
+        requestId
     };
     if (onProgress) {
         for await (const event of stream(request, options)) {
-            if (event.type === "rag:progress" &&
-                event.operation === "saveEmbeddings") {
+            if (event.type === 'rag:progress' && event.operation === 'saveEmbeddings') {
                 const progress = event;
                 onProgress(progress.stage, progress.current, progress.total);
                 continue;
             }
-            if (event.type === "rag" && event.operation === "saveEmbeddings") {
+            if (event.type === 'rag' && event.operation === 'saveEmbeddings') {
                 if (!event.success) {
                     throw new RAGSaveFailedError(event.error);
                 }
@@ -200,13 +199,13 @@ async function runRagSaveEmbeddings(params, requestId, options) {
         throw new StreamEndedError();
     }
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGSaveFailedError(response.error);
     }
-    if (response.operation !== "saveEmbeddings") {
+    if (response.operation !== 'saveEmbeddings') {
         throw new InvalidOperationError();
     }
     return response.processed;
@@ -240,20 +239,20 @@ async function runRagSaveEmbeddings(params, requestId, options) {
  */
 export async function ragSearch(params, options) {
     const request = {
-        type: "rag",
-        operation: "search",
+        type: 'rag',
+        operation: 'search',
         ...params,
         topK: params.topK ?? 5,
-        n: params.n ?? 3,
+        n: params.n ?? 3
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGSearchFailedError(response.error);
     }
-    if (response.operation !== "search") {
+    if (response.operation !== 'search') {
         throw new InvalidOperationError();
     }
     return response.results;
@@ -280,18 +279,18 @@ export async function ragSearch(params, options) {
  */
 export async function ragDeleteEmbeddings(params, options) {
     const request = {
-        type: "rag",
-        operation: "deleteEmbeddings",
-        ...params,
+        type: 'rag',
+        operation: 'deleteEmbeddings',
+        ...params
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGDeleteFailedError(response.error);
     }
-    if (response.operation !== "deleteEmbeddings") {
+    if (response.operation !== 'deleteEmbeddings') {
         throw new InvalidOperationError();
     }
 }
@@ -343,20 +342,20 @@ export function ragReindex(params, options) {
 async function runRagReindex(params, requestId, options) {
     const { onProgress, ...requestParams } = params;
     const request = {
-        type: "rag",
-        operation: "reindex",
+        type: 'rag',
+        operation: 'reindex',
         ...requestParams,
         withProgress: onProgress ? true : undefined,
-        requestId,
+        requestId
     };
     if (onProgress) {
         for await (const event of stream(request, options)) {
-            if (event.type === "rag:progress" && event.operation === "reindex") {
+            if (event.type === 'rag:progress' && event.operation === 'reindex') {
                 const progress = event;
                 onProgress(progress.stage, progress.current, progress.total);
                 continue;
             }
-            if (event.type === "rag" && event.operation === "reindex") {
+            if (event.type === 'rag' && event.operation === 'reindex') {
                 if (!event.success) {
                     throw new RAGSaveFailedError(event.error);
                 }
@@ -366,13 +365,13 @@ async function runRagReindex(params, requestId, options) {
         throw new StreamEndedError();
     }
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGSaveFailedError(response.error);
     }
-    if (response.operation !== "reindex") {
+    if (response.operation !== 'reindex') {
         throw new InvalidOperationError();
     }
     return response.result;
@@ -397,17 +396,17 @@ async function runRagReindex(params, requestId, options) {
  */
 export async function ragListWorkspaces(options) {
     const request = {
-        type: "rag",
-        operation: "listWorkspaces",
+        type: 'rag',
+        operation: 'listWorkspaces'
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGListWorkspacesFailedError(response.error);
     }
-    if (response.operation !== "listWorkspaces") {
+    if (response.operation !== 'listWorkspaces') {
         throw new InvalidOperationError();
     }
     return response.workspaces;
@@ -437,18 +436,18 @@ export async function ragListWorkspaces(options) {
  */
 export async function ragCloseWorkspace(params, options) {
     const request = {
-        type: "rag",
-        operation: "closeWorkspace",
-        ...params,
+        type: 'rag',
+        operation: 'closeWorkspace',
+        ...params
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGCloseWorkspaceFailedError(response.error);
     }
-    if (response.operation !== "closeWorkspace") {
+    if (response.operation !== 'closeWorkspace') {
         throw new InvalidOperationError();
     }
 }
@@ -469,18 +468,18 @@ export async function ragCloseWorkspace(params, options) {
  */
 export async function ragDeleteWorkspace(params, options) {
     const request = {
-        type: "rag",
-        operation: "deleteWorkspace",
-        ...params,
+        type: 'rag',
+        operation: 'deleteWorkspace',
+        ...params
     };
     const response = await send(request, options);
-    if (response.type !== "rag") {
-        throw new InvalidResponseError("rag");
+    if (response.type !== 'rag') {
+        throw new InvalidResponseError('rag');
     }
     if (!response.success) {
         throw new RAGDeleteFailedError(response.error);
     }
-    if (response.operation !== "deleteWorkspace") {
+    if (response.operation !== 'deleteWorkspace') {
         throw new InvalidOperationError();
     }
 }

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

@@ -1,4 +1,4 @@
-import type { ModelRegistryEntry, ModelRegistryEntryAddon } from "../../schemas/index";
+import type { ModelRegistryEntry, ModelRegistryEntryAddon } from '../../schemas/index';
 export type { ModelRegistryEntry, ModelRegistryEntryAddon };
 export interface ModelRegistrySearchParams {
     filter?: string;

package/dist/client/api/registry.js

@@ -1,8 +1,8 @@
-import { send } from "../rpc/rpc-client.js";
-import { ModelRegistryQueryFailedError } from "../../utils/errors-client.js";
+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");
+        throw new ModelRegistryQueryFailedError(response.error ?? fallbackError ?? 'Unknown registry error');
     }
 }
 /**
@@ -13,7 +13,7 @@ function validateRegistryResponse(response, fallbackError) {
  */
 async function modelRegistryList() {
     const request = {
-        type: "modelRegistryList",
+        type: 'modelRegistryList'
     };
     const response = (await send(request));
     validateRegistryResponse(response);
@@ -34,9 +34,9 @@ async function modelRegistryList() {
 async function modelRegistrySearch(params = {}) {
     const { modelType, ...rest } = params;
     const request = {
-        type: "modelRegistrySearch",
+        type: 'modelRegistrySearch',
         ...rest,
-        addon: modelType ?? rest.addon,
+        addon: modelType ?? rest.addon
     };
     const response = (await send(request));
     validateRegistryResponse(response);
@@ -52,9 +52,9 @@ async function modelRegistrySearch(params = {}) {
  */
 async function modelRegistryGetModel(registryPath, registrySource) {
     const request = {
-        type: "modelRegistryGetModel",
+        type: 'modelRegistryGetModel',
         registryPath,
-        registrySource,
+        registrySource
     };
     const response = (await send(request));
     validateRegistryResponse(response, `Model not found: ${registrySource}/${registryPath}`);

package/dist/client/api/resume.js

@@ -1,5 +1,5 @@
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
+import { send } from '../rpc/rpc-client.js';
+import { InvalidResponseError } from '../../utils/errors-client.js';
 /**
  * Resumes the SDK runtime: restores all suspended Hyperswarm and Corestore
  * resources and releases the lifecycle gate so all SDK operations are allowed
@@ -29,8 +29,8 @@ import { InvalidResponseError } from "../../utils/errors-client.js";
  * console.log(await state()); // "active"
  */
 export async function resume() {
-    const response = await send({ type: "resume" });
-    if (response.type !== "resume") {
-        throw new InvalidResponseError("resume");
+    const response = await send({ type: 'resume' });
+    if (response.type !== 'resume') {
+        throw new InvalidResponseError('resume');
     }
 }

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

@@ -1,4 +1,4 @@
-import type { LifecycleState } from "../../schemas/index";
+import type { LifecycleState } from '../../schemas/index';
 /**
  * Returns the current runtime lifecycle state.
  *

package/dist/client/api/state.js

@@ -1,5 +1,5 @@
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
+import { send } from '../rpc/rpc-client.js';
+import { InvalidResponseError } from '../../utils/errors-client.js';
 /**
  * Returns the current runtime lifecycle state.
  *
@@ -21,9 +21,9 @@ import { InvalidResponseError } from "../../utils/errors-client.js";
  * }
  */
 export async function state() {
-    const response = await send({ type: "state" });
-    if (response.type !== "state") {
-        throw new InvalidResponseError("state");
+    const response = await send({ type: 'state' });
+    if (response.type !== 'state') {
+        throw new InvalidResponseError('state');
     }
     return response.state;
 }

package/dist/client/api/stop-provider.js

@@ -1,6 +1,6 @@
-import {} from "../../schemas/index.js";
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError, ProviderStopFailedError, } from "../../utils/errors-client.js";
+import {} from '../../schemas/index.js';
+import { send } from '../rpc/rpc-client.js';
+import { InvalidResponseError, ProviderStopFailedError } from '../../utils/errors-client.js';
 /**
  * Stops the running provider service.
  *
@@ -18,11 +18,11 @@ import { InvalidResponseError, ProviderStopFailedError, } from "../../utils/erro
  */
 export async function stopQVACProvider() {
     const request = {
-        type: "stopProvide",
+        type: 'stopProvide'
     };
     const response = await send(request);
-    if (response.type !== "stopProvide") {
-        throw new InvalidResponseError("stopProvide");
+    if (response.type !== 'stopProvide') {
+        throw new InvalidResponseError('stopProvide');
     }
     if (response.error) {
         throw new ProviderStopFailedError(response.error);

package/dist/client/api/subscribe-logs.d.ts

@@ -1,4 +1,4 @@
-import type { LoggingStreamResponse } from "../../schemas/logging-stream";
+import type { LoggingStreamResponse } from '../../schemas/logging-stream';
 export type ServerLogHandler = (log: LoggingStreamResponse) => void;
 /**
  * Subscribes to every server-side log through a single stream: SDK server logs,

package/dist/client/api/subscribe-logs.js

@@ -1,5 +1,5 @@
-import { getClientLogger, SDK_ALL_LOG_ID } from "../../logging/index.js";
-import { loggingStream } from "./logging-stream.js";
+import { getClientLogger, SDK_ALL_LOG_ID } from '../../logging/index.js';
+import { loggingStream } from './logging-stream.js';
 const logger = getClientLogger();
 /**
  * Subscribes to every server-side log through a single stream: SDK server logs,
@@ -34,7 +34,7 @@ export function subscribeServerLogs(handler) {
             }
         }
         catch (error) {
-            logger.error("Server log stream error:", error);
+            logger.error('Server log stream error:', error);
         }
     })();
     return () => {

package/dist/client/api/suspend.js

@@ -1,5 +1,5 @@
-import { send } from "../rpc/rpc-client.js";
-import { InvalidResponseError } from "../../utils/errors-client.js";
+import { send } from '../rpc/rpc-client.js';
+import { InvalidResponseError } from '../../utils/errors-client.js';
 /**
  * Suspends the SDK runtime: pauses all registered Hyperswarm and Corestore
  * resources and engages the lifecycle gate so non-lifecycle operations are
@@ -30,8 +30,8 @@ import { InvalidResponseError } from "../../utils/errors-client.js";
  * console.log(await state()); // "suspended"
  */
 export async function suspend() {
-    const response = await send({ type: "suspend" });
-    if (response.type !== "suspend") {
-        throw new InvalidResponseError("suspend");
+    const response = await send({ type: 'suspend' });
+    if (response.type !== 'suspend') {
+        throw new InvalidResponseError('suspend');
     }
 }

package/dist/client/api/text-to-speech.d.ts

@@ -1,4 +1,4 @@
-import { type TtsClientParamsInput, type RPCOptions, type TtsResponse, type TextToSpeechStreamClientParams, type TextToSpeechStreamSession, type TextToSpeechStreamResult } from "../../schemas/index";
+import { type TtsClientParamsInput, type RPCOptions, type TtsResponse, type TextToSpeechStreamClientParams, type TextToSpeechStreamSession, type TextToSpeechStreamResult } from '../../schemas/index';
 /**
  * Fan-out queue that lets multiple consumers iterate the same TTS response
  * stream independently. Items are retained only until every active subscriber