@ontos-ai/knowhere-sdk 0.8.0 → 0.10.0

package/README.md

@@ -252,16 +252,22 @@ const updateJob = await client.jobs.create({
   documentId,
 });
 
-const documents = await client.documents.list({ namespace: 'support-center' });
+const documents = await client.documents.list({
+  namespace: 'support-center',
+  page: 1,
+  pageSize: 50,
+});
 const document = await client.documents.get(documentId);
 const chunks = await client.documents.listChunks(documentId, {
   page: 1,
   pageSize: 50,
-  chunkType: 'text',
+  chunkType: 'image',
+  includeAssetUrls: true,
 });
 const archived = await client.documents.archive(documentId);
 
 console.log(documents.documents.length);
+console.log(documents.pagination.totalPages);
 console.log(document.status);
 console.log(chunks.pagination.total);
 if (chunks.chunks[0]) {
@@ -269,6 +275,7 @@ if (chunks.chunks[0]) {
     includeAssetUrls: true,
   });
   console.log(chunk.chunk.content);
+  console.log(chunk.chunk.assetUrl);
 }
 console.log(archived.status);
 ```
@@ -313,6 +320,30 @@ console.log(serverSearch.references);
 Local grep and reads use the cached parse result, not server-side chunk scans.
 Search uses the Knowhere API retrieval query; local document IDs only help map
 returned server document IDs back to local cache IDs when available.
+If a search result only has a published `documentId`, or an async parse flow only
+has a completed `jobId`, read-oriented helpers can accept that remote identifier
+directly and will sync the result into the local cache before reading. For a
+`documentId`, the SDK resolves the document's current published `jobId` and then
+downloads the parser result ZIP through the same `cacheJobResult(...)` path:
+
+```typescript
+const remoteRead = await client.knowledge.readChunks({
+  documentId: 'doc_123',
+  sectionPath: 'Overview',
+  limit: 5,
+});
+
+const remoteOutline = await client.knowledge.getDocumentOutline({
+  documentId: 'doc_123',
+});
+
+const jobRead = await client.knowledge.readChunks({
+  jobId: jobResult.jobId,
+  localDocumentId: 'manual-v1',
+  limit: 5,
+});
+```
+
 The MCP package is a wrapper over this SDK interface; install it only when an
 agent host needs an MCP server. See the MCP package README for Codex, Claude
 Code, Claude Desktop, and generic stdio MCP host configuration examples.

package/dist/index.d.mts

@@ -799,6 +799,30 @@ interface Document {
     /** Archive timestamp, when archived */
     archivedAt?: Date;
 }
+/**
+ * Pagination metadata returned by document list endpoints.
+ */
+interface DocumentListPagination {
+    /** Current page number */
+    page: number;
+    /** Number of items requested per page */
+    pageSize: number;
+    /** Total matching documents */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+/**
+ * Query parameters for GET /v1/documents.
+ */
+interface DocumentListParams {
+    /** Retrieval namespace */
+    namespace?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 50, maximum: 200) */
+    pageSize?: number;
+}
 /**
  * Response from GET /v1/documents.
  */
@@ -807,6 +831,8 @@ interface DocumentListResponse {
     namespace: string;
     /** Documents visible in the namespace */
     documents: Document[];
+    /** Pagination metadata */
+    pagination: DocumentListPagination;
 }
 /**
  * Document chunk types supported by document chunk endpoints.
@@ -835,14 +861,14 @@ interface DocumentChunkListParams {
     pageSize?: number;
     /** Optional chunk type filter */
     chunkType?: DocumentChunkType;
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
  * Query parameters for GET /v1/documents/{document_id}/chunks/{document_chunk_id}.
  */
 interface DocumentChunkGetParams {
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
@@ -869,7 +895,7 @@ interface DocumentChunk {
     sortOrder: number;
     /** Chunk metadata returned by the API */
     metadata: Record<string, unknown>;
-    /** Generated asset URL when requested and available */
+    /** 7-day asset URL for media chunks when available */
     assetUrl?: string | null;
     /** Chunk creation timestamp */
     createdAt?: Date;
@@ -914,9 +940,7 @@ declare class Documents extends BaseResource {
     /**
      * List canonical documents in a namespace.
      */
-    list(params?: {
-        namespace?: string;
-    }): Promise<DocumentListResponse>;
+    list(params?: DocumentListParams): Promise<DocumentListResponse>;
     /**
      * Get one canonical document by ID.
      */
@@ -933,6 +957,8 @@ declare class Documents extends BaseResource {
      * Archive one canonical document by ID.
      */
     archive(documentId: string): Promise<Document>;
+    private createDocumentListRequestConfig;
+    private normalizeDocumentListResponse;
     private createChunkListRequestConfig;
     private createChunkGetRequestConfig;
 }
@@ -996,6 +1022,20 @@ interface KnowledgeCacheJobResultParams {
     localDocumentId?: string;
     verifyChecksum?: boolean;
 }
+interface KnowledgeCacheDocumentParams {
+    /** Canonical Knowhere document identifier from published retrieval results. */
+    documentId: string;
+    /** Optional local cache identifier to use for the localized document copy. */
+    localDocumentId?: string;
+}
+interface KnowledgeDocumentReference {
+    /** Stable local identifier used by cached outline/read/grep methods. */
+    localDocumentId?: string;
+    /** Canonical Knowhere document identifier from published retrieval results. */
+    documentId?: string;
+    /** Server parse job identifier whose completed result should be cached before reading. */
+    jobId?: string;
+}
 interface KnowledgeSection {
     sectionPath: string;
     sectionTitle: string;
@@ -1014,8 +1054,7 @@ interface KnowledgeOutline {
     sections: KnowledgeSection[];
     sectionTree: KnowledgeSection[];
 }
-interface KnowledgeReadParams {
-    localDocumentId: string;
+interface KnowledgeReadParams extends KnowledgeDocumentReference {
     sectionPath?: string;
     startChunk?: number;
     endChunk?: number;
@@ -1038,8 +1077,7 @@ interface KnowledgeReadResponse {
     chunks: KnowledgeReadChunk[];
     nextChunk?: number;
 }
-interface KnowledgeGrepParams {
-    localDocumentId: string;
+interface KnowledgeGrepParams extends KnowledgeDocumentReference {
     pattern: string;
     isRegex?: boolean;
     isCaseSensitive?: boolean;
@@ -1111,13 +1149,17 @@ declare class Knowledge {
     getJobStatus(jobId: string): Promise<KnowledgeAsyncJobStatusResponse>;
     recoverPendingAsyncParseJobs(): Promise<KnowledgeStartupRecoveryResponse>;
     cacheJobResult(params: KnowledgeCacheJobResultParams): Promise<LocalKnowledgeParseResponse>;
+    cacheDocument(params: KnowledgeCacheDocumentParams): Promise<LocalKnowledgeParseResponse>;
     private resolveAsyncCache;
     listDocuments(): Promise<LocalKnowledgeDocument[]>;
-    getDocumentOutline(localDocumentId: string): Promise<KnowledgeOutline>;
+    getDocumentOutline(reference: string | KnowledgeDocumentReference): Promise<KnowledgeOutline>;
     readChunks(params: KnowledgeReadParams): Promise<KnowledgeReadResponse>;
     grepChunks(params: KnowledgeGrepParams): Promise<KnowledgeGrepResponse>;
     search(params: KnowledgeSearchParams): Promise<KnowledgeSearchResponse>;
     private resolveSearchDocuments;
+    private loadReadableResult;
+    private findLocalDocumentByRemoteId;
+    private getPublishedDocumentJobId;
 }
 
 interface StoredAsyncParseJob {
@@ -1342,4 +1384,4 @@ declare class JobFailedError extends KnowhereError {
     constructor(message: string, code: string, jobResult: JobResult);
 }
 
-export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };
+export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };

package/dist/index.d.ts

@@ -799,6 +799,30 @@ interface Document {
     /** Archive timestamp, when archived */
     archivedAt?: Date;
 }
+/**
+ * Pagination metadata returned by document list endpoints.
+ */
+interface DocumentListPagination {
+    /** Current page number */
+    page: number;
+    /** Number of items requested per page */
+    pageSize: number;
+    /** Total matching documents */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+/**
+ * Query parameters for GET /v1/documents.
+ */
+interface DocumentListParams {
+    /** Retrieval namespace */
+    namespace?: string;
+    /** Page number (default: 1) */
+    page?: number;
+    /** Items per page (default: 50, maximum: 200) */
+    pageSize?: number;
+}
 /**
  * Response from GET /v1/documents.
  */
@@ -807,6 +831,8 @@ interface DocumentListResponse {
     namespace: string;
     /** Documents visible in the namespace */
     documents: Document[];
+    /** Pagination metadata */
+    pagination: DocumentListPagination;
 }
 /**
  * Document chunk types supported by document chunk endpoints.
@@ -835,14 +861,14 @@ interface DocumentChunkListParams {
     pageSize?: number;
     /** Optional chunk type filter */
     chunkType?: DocumentChunkType;
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
  * Query parameters for GET /v1/documents/{document_id}/chunks/{document_chunk_id}.
  */
 interface DocumentChunkGetParams {
-    /** Generate asset URLs for media chunks (default: false) */
+    /** Set true to include 7-day asset URLs for media chunks */
     includeAssetUrls?: boolean;
 }
 /**
@@ -869,7 +895,7 @@ interface DocumentChunk {
     sortOrder: number;
     /** Chunk metadata returned by the API */
     metadata: Record<string, unknown>;
-    /** Generated asset URL when requested and available */
+    /** 7-day asset URL for media chunks when available */
     assetUrl?: string | null;
     /** Chunk creation timestamp */
     createdAt?: Date;
@@ -914,9 +940,7 @@ declare class Documents extends BaseResource {
     /**
      * List canonical documents in a namespace.
      */
-    list(params?: {
-        namespace?: string;
-    }): Promise<DocumentListResponse>;
+    list(params?: DocumentListParams): Promise<DocumentListResponse>;
     /**
      * Get one canonical document by ID.
      */
@@ -933,6 +957,8 @@ declare class Documents extends BaseResource {
      * Archive one canonical document by ID.
      */
     archive(documentId: string): Promise<Document>;
+    private createDocumentListRequestConfig;
+    private normalizeDocumentListResponse;
     private createChunkListRequestConfig;
     private createChunkGetRequestConfig;
 }
@@ -996,6 +1022,20 @@ interface KnowledgeCacheJobResultParams {
     localDocumentId?: string;
     verifyChecksum?: boolean;
 }
+interface KnowledgeCacheDocumentParams {
+    /** Canonical Knowhere document identifier from published retrieval results. */
+    documentId: string;
+    /** Optional local cache identifier to use for the localized document copy. */
+    localDocumentId?: string;
+}
+interface KnowledgeDocumentReference {
+    /** Stable local identifier used by cached outline/read/grep methods. */
+    localDocumentId?: string;
+    /** Canonical Knowhere document identifier from published retrieval results. */
+    documentId?: string;
+    /** Server parse job identifier whose completed result should be cached before reading. */
+    jobId?: string;
+}
 interface KnowledgeSection {
     sectionPath: string;
     sectionTitle: string;
@@ -1014,8 +1054,7 @@ interface KnowledgeOutline {
     sections: KnowledgeSection[];
     sectionTree: KnowledgeSection[];
 }
-interface KnowledgeReadParams {
-    localDocumentId: string;
+interface KnowledgeReadParams extends KnowledgeDocumentReference {
     sectionPath?: string;
     startChunk?: number;
     endChunk?: number;
@@ -1038,8 +1077,7 @@ interface KnowledgeReadResponse {
     chunks: KnowledgeReadChunk[];
     nextChunk?: number;
 }
-interface KnowledgeGrepParams {
-    localDocumentId: string;
+interface KnowledgeGrepParams extends KnowledgeDocumentReference {
     pattern: string;
     isRegex?: boolean;
     isCaseSensitive?: boolean;
@@ -1111,13 +1149,17 @@ declare class Knowledge {
     getJobStatus(jobId: string): Promise<KnowledgeAsyncJobStatusResponse>;
     recoverPendingAsyncParseJobs(): Promise<KnowledgeStartupRecoveryResponse>;
     cacheJobResult(params: KnowledgeCacheJobResultParams): Promise<LocalKnowledgeParseResponse>;
+    cacheDocument(params: KnowledgeCacheDocumentParams): Promise<LocalKnowledgeParseResponse>;
     private resolveAsyncCache;
     listDocuments(): Promise<LocalKnowledgeDocument[]>;
-    getDocumentOutline(localDocumentId: string): Promise<KnowledgeOutline>;
+    getDocumentOutline(reference: string | KnowledgeDocumentReference): Promise<KnowledgeOutline>;
     readChunks(params: KnowledgeReadParams): Promise<KnowledgeReadResponse>;
     grepChunks(params: KnowledgeGrepParams): Promise<KnowledgeGrepResponse>;
     search(params: KnowledgeSearchParams): Promise<KnowledgeSearchResponse>;
     private resolveSearchDocuments;
+    private loadReadableResult;
+    private findLocalDocumentByRemoteId;
+    private getPublishedDocumentJobId;
 }
 
 interface StoredAsyncParseJob {
@@ -1342,4 +1384,4 @@ declare class JobFailedError extends KnowhereError {
     constructor(message: string, code: string, jobResult: JobResult);
 }
 
-export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };
+export { APIError, type AuthTokenProvider, AuthenticationError, BadRequestError, type BaseChunk, ChecksumError, type Chunk, ConflictError, type CreateJobParams, type DocType, type Document, type DocumentChunk, type DocumentChunkGetParams, type DocumentChunkListParams, type DocumentChunkListResponse, type DocumentChunkPagination, type DocumentChunkResponse, type DocumentChunkType, type DocumentListPagination, type DocumentListParams, type DocumentListResponse, type DocumentMetadata, Documents, type FileIndex, GatewayTimeoutError, type ImageChunk, InternalServerError, InvalidStateError, type Job, type JobError, JobFailedError, type JobResult, type JobStatus, Jobs, Knowhere, KnowhereError, type KnowhereOptions, Knowledge, type KnowledgeAsyncJobStatusResponse, type KnowledgeAsyncParseParams, type KnowledgeAsyncParseResponse, type KnowledgeCacheDocumentParams, type KnowledgeCacheJobResultParams, type KnowledgeChunkType, type KnowledgeDocumentReference, type KnowledgeGrepMatch, type KnowledgeGrepParams, type KnowledgeGrepResponse, type KnowledgeOutline, type KnowledgeParseParams, type KnowledgeReadChunk, type KnowledgeReadParams, type KnowledgeReadResponse, type KnowledgeSearchParams, type KnowledgeSearchReference, type KnowledgeSearchResponse, type KnowledgeSearchResult, type KnowledgeSection, type KnowledgeStartupRecoveryResponse, type LoadOptions, type LocalKnowledgeDocument, type LocalKnowledgeParseResponse, LocalKnowledgeStore, type Manifest, NetworkError, NotFoundError, type ParseParams, type ParseResult, type ParsingModel, type ParsingParams, PaymentRequiredError, PermissionDeniedError, type PollProgress, PollingTimeoutError, RateLimitError, Retrieval, type RetrievalChannel, type RetrievalFilterMode, type RetrievalQueryParams, type RetrievalQueryResponse, type RetrievalReferencedChunk, type RetrievalResult, type RetrievalSectionExclusion, type RetrievalSource, ServiceUnavailableError, type Statistics, type TableChunk, type TextChunk, TimeoutError, type UploadParams, type UploadProgress, VERSION, ValidationError, type WaitOptions, type WebhookConfig, Knowhere as default };

package/dist/index.js

@@ -1438,12 +1438,11 @@ var Documents = class extends BaseResource {
    * List canonical documents in a namespace.
    */
   async list(params) {
-    const requestConfig = params?.namespace ? {
-      params: {
-        namespace: params.namespace
-      }
-    } : void 0;
-    return this.httpClient.get("/v1/documents", requestConfig);
+    const response = await this.httpClient.get(
+      "/v1/documents",
+      this.createDocumentListRequestConfig(params)
+    );
+    return this.normalizeDocumentListResponse(response);
   }
   /**
    * Get one canonical document by ID.
@@ -1475,6 +1474,38 @@ var Documents = class extends BaseResource {
   async archive(documentId) {
     return this.httpClient.post(`/v1/documents/${documentId}/archive`);
   }
+  createDocumentListRequestConfig(params) {
+    if (!params) {
+      return void 0;
+    }
+    const queryParams = {};
+    if (params.namespace !== void 0) {
+      queryParams.namespace = params.namespace;
+    }
+    if (params.page !== void 0) {
+      queryParams.page = params.page;
+    }
+    if (params.pageSize !== void 0) {
+      queryParams.page_size = params.pageSize;
+    }
+    return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
+  }
+  normalizeDocumentListResponse(response) {
+    const maybePaginatedResponse = response;
+    if (maybePaginatedResponse.pagination) {
+      return response;
+    }
+    const total = response.documents.length;
+    return {
+      ...response,
+      pagination: {
+        page: 1,
+        pageSize: total,
+        total,
+        totalPages: total > 0 ? 1 : 0
+      }
+    };
+  }
   createChunkListRequestConfig(params) {
     if (!params) {
       return void 0;
@@ -1489,23 +1520,26 @@ var Documents = class extends BaseResource {
     if (params.chunkType !== void 0) {
       queryParams.chunk_type = params.chunkType;
     }
-    if (params.includeAssetUrls === true) {
-      queryParams.include_asset_urls = true;
+    if (params.includeAssetUrls !== void 0) {
+      queryParams.include_asset_urls = params.includeAssetUrls;
     }
     return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
   }
   createChunkGetRequestConfig(params) {
-    if (params?.includeAssetUrls !== true) {
+    if (params?.includeAssetUrls === void 0) {
       return void 0;
     }
     return {
       params: {
-        include_asset_urls: true
+        include_asset_urls: params.includeAssetUrls
       }
     };
   }
 };
 
+// src/knowledge/knowledge.ts
+var import_crypto2 = require("crypto");
+
 // src/knowledge/local-store.ts
 var import_crypto = require("crypto");
 var import_os = __toESM(require("os"));
@@ -1734,6 +1768,8 @@ var MAX_READ_LIMIT = 40;
 var DEFAULT_GREP_LIMIT = 20;
 var MAX_GREP_LIMIT = 50;
 var DEFAULT_CONTEXT_CHARS = 80;
+var SAFE_LOCAL_DOCUMENT_ID_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
+var REMOTE_DOCUMENT_ID_PATTERN = /^doc[_-]/;
 var Knowledge = class _Knowledge {
   client;
   store;
@@ -1789,6 +1825,19 @@ var Knowledge = class _Knowledge {
     });
     return { document, result };
   }
+  async cacheDocument(params) {
+    if (!params.documentId) {
+      throw new ValidationError("documentId is required");
+    }
+    const existing = await this.findLocalDocumentByRemoteId(
+      params.documentId
+    );
+    const jobId = await this.getPublishedDocumentJobId(params.documentId);
+    return this.cacheJobResult({
+      jobId,
+      localDocumentId: params.localDocumentId ?? existing?.localDocumentId ?? createLocalDocumentIdForRemote(params.documentId)
+    });
+  }
   async resolveAsyncCache(jobId, isDone, isFailed) {
     const trackedJob = await this.store.getAsyncParseJob(jobId);
     if (!trackedJob) {
@@ -1845,8 +1894,8 @@ var Knowledge = class _Knowledge {
   async listDocuments() {
     return this.store.listDocuments();
   }
-  async getDocumentOutline(localDocumentId) {
-    const { document, result } = await this.store.loadResult(localDocumentId);
+  async getDocumentOutline(reference) {
+    const { document, result } = await this.loadReadableResult(reference);
     const chunks = indexChunks(result);
     const sections = buildFlatSections(result, chunks);
     const sectionTree = result.docNav?.sections && result.docNav.sections.length > 0 ? result.docNav.sections.map(
@@ -1861,7 +1910,7 @@ var Knowledge = class _Knowledge {
     };
   }
   async readChunks(params) {
-    const { document, result } = await this.store.loadResult(params.localDocumentId);
+    const { document, result } = await this.loadReadableResult(params);
     const limit = clampLimit(params.limit, DEFAULT_READ_LIMIT, MAX_READ_LIMIT);
     const chunks = indexChunks(result).filter((chunk) => matchesReadScope(chunk, params));
     const selected = selectReadWindow(chunks, params, limit);
@@ -1877,7 +1926,7 @@ var Knowledge = class _Knowledge {
     if (!params.pattern) {
       throw new ValidationError("pattern is required");
     }
-    const { document, result } = await this.store.loadResult(params.localDocumentId);
+    const { document, result } = await this.loadReadableResult(params);
     const maxResults = clampLimit(params.maxResults, DEFAULT_GREP_LIMIT, MAX_GREP_LIMIT);
     const contextChars = params.contextChars ?? DEFAULT_CONTEXT_CHARS;
     const matcher = createMatcher(params);
@@ -1947,7 +1996,68 @@ var Knowledge = class _Knowledge {
     const requested = new Set(localDocumentIds);
     return documents.filter((document) => requested.has(document.localDocumentId));
   }
+  async loadReadableResult(reference) {
+    const normalized = normalizeDocumentReference(reference);
+    if (normalized.documentId) {
+      return this.cacheDocument({
+        documentId: normalized.documentId,
+        localDocumentId: normalized.localDocumentId
+      });
+    }
+    if (normalized.jobId) {
+      return this.cacheJobResult({
+        jobId: normalized.jobId,
+        localDocumentId: normalized.localDocumentId
+      });
+    }
+    if (!normalized.localDocumentId) {
+      throw new ValidationError("localDocumentId, documentId, or jobId is required");
+    }
+    const document = await this.store.getDocument(normalized.localDocumentId);
+    if (document) {
+      return this.store.loadResult(normalized.localDocumentId);
+    }
+    if (looksLikeRemoteDocumentId(normalized.localDocumentId)) {
+      return this.cacheDocument({
+        documentId: normalized.localDocumentId,
+        localDocumentId: createLocalDocumentIdForRemote(normalized.localDocumentId)
+      });
+    }
+    throw new Error(`Local Knowhere document not found: ${normalized.localDocumentId}`);
+  }
+  async findLocalDocumentByRemoteId(documentId) {
+    const documents = await this.store.listDocuments();
+    return documents.find((document) => document.documentId === documentId);
+  }
+  async getPublishedDocumentJobId(documentId) {
+    const response = await this.client.documents.listChunks(documentId, {
+      page: 1,
+      pageSize: 1
+    });
+    if (!response.jobId) {
+      throw new Error(
+        `Cannot sync server document ${documentId}: current published job id was not returned.`
+      );
+    }
+    return response.jobId;
+  }
 };
+function normalizeDocumentReference(reference) {
+  if (typeof reference === "string") {
+    return { localDocumentId: reference };
+  }
+  return reference;
+}
+function looksLikeRemoteDocumentId(value) {
+  return REMOTE_DOCUMENT_ID_PATTERN.test(value);
+}
+function createLocalDocumentIdForRemote(documentId) {
+  if (SAFE_LOCAL_DOCUMENT_ID_PATTERN.test(documentId) && !documentId.includes("..") && !documentId.includes("/") && !documentId.includes("\\")) {
+    return documentId;
+  }
+  const hash = (0, import_crypto2.createHash)("sha256").update(documentId).digest("hex").slice(0, 16);
+  return `remote_${hash}`;
+}
 function indexChunks(result) {
   return result.chunks.map((chunk, index) => {
     const filePath = getChunkFilePath2(chunk);

package/dist/index.mjs

@@ -1378,12 +1378,11 @@ var Documents = class extends BaseResource {
    * List canonical documents in a namespace.
    */
   async list(params) {
-    const requestConfig = params?.namespace ? {
-      params: {
-        namespace: params.namespace
-      }
-    } : void 0;
-    return this.httpClient.get("/v1/documents", requestConfig);
+    const response = await this.httpClient.get(
+      "/v1/documents",
+      this.createDocumentListRequestConfig(params)
+    );
+    return this.normalizeDocumentListResponse(response);
   }
   /**
    * Get one canonical document by ID.
@@ -1415,6 +1414,38 @@ var Documents = class extends BaseResource {
   async archive(documentId) {
     return this.httpClient.post(`/v1/documents/${documentId}/archive`);
   }
+  createDocumentListRequestConfig(params) {
+    if (!params) {
+      return void 0;
+    }
+    const queryParams = {};
+    if (params.namespace !== void 0) {
+      queryParams.namespace = params.namespace;
+    }
+    if (params.page !== void 0) {
+      queryParams.page = params.page;
+    }
+    if (params.pageSize !== void 0) {
+      queryParams.page_size = params.pageSize;
+    }
+    return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
+  }
+  normalizeDocumentListResponse(response) {
+    const maybePaginatedResponse = response;
+    if (maybePaginatedResponse.pagination) {
+      return response;
+    }
+    const total = response.documents.length;
+    return {
+      ...response,
+      pagination: {
+        page: 1,
+        pageSize: total,
+        total,
+        totalPages: total > 0 ? 1 : 0
+      }
+    };
+  }
   createChunkListRequestConfig(params) {
     if (!params) {
       return void 0;
@@ -1429,23 +1460,26 @@ var Documents = class extends BaseResource {
     if (params.chunkType !== void 0) {
       queryParams.chunk_type = params.chunkType;
     }
-    if (params.includeAssetUrls === true) {
-      queryParams.include_asset_urls = true;
+    if (params.includeAssetUrls !== void 0) {
+      queryParams.include_asset_urls = params.includeAssetUrls;
     }
     return Object.keys(queryParams).length > 0 ? { params: queryParams } : void 0;
   }
   createChunkGetRequestConfig(params) {
-    if (params?.includeAssetUrls !== true) {
+    if (params?.includeAssetUrls === void 0) {
       return void 0;
     }
     return {
       params: {
-        include_asset_urls: true
+        include_asset_urls: params.includeAssetUrls
       }
     };
   }
 };
 
+// src/knowledge/knowledge.ts
+import { createHash as createHash2 } from "crypto";
+
 // src/knowledge/local-store.ts
 import { createHash } from "crypto";
 import os from "os";
@@ -1674,6 +1708,8 @@ var MAX_READ_LIMIT = 40;
 var DEFAULT_GREP_LIMIT = 20;
 var MAX_GREP_LIMIT = 50;
 var DEFAULT_CONTEXT_CHARS = 80;
+var SAFE_LOCAL_DOCUMENT_ID_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
+var REMOTE_DOCUMENT_ID_PATTERN = /^doc[_-]/;
 var Knowledge = class _Knowledge {
   client;
   store;
@@ -1729,6 +1765,19 @@ var Knowledge = class _Knowledge {
     });
     return { document, result };
   }
+  async cacheDocument(params) {
+    if (!params.documentId) {
+      throw new ValidationError("documentId is required");
+    }
+    const existing = await this.findLocalDocumentByRemoteId(
+      params.documentId
+    );
+    const jobId = await this.getPublishedDocumentJobId(params.documentId);
+    return this.cacheJobResult({
+      jobId,
+      localDocumentId: params.localDocumentId ?? existing?.localDocumentId ?? createLocalDocumentIdForRemote(params.documentId)
+    });
+  }
   async resolveAsyncCache(jobId, isDone, isFailed) {
     const trackedJob = await this.store.getAsyncParseJob(jobId);
     if (!trackedJob) {
@@ -1785,8 +1834,8 @@ var Knowledge = class _Knowledge {
   async listDocuments() {
     return this.store.listDocuments();
   }
-  async getDocumentOutline(localDocumentId) {
-    const { document, result } = await this.store.loadResult(localDocumentId);
+  async getDocumentOutline(reference) {
+    const { document, result } = await this.loadReadableResult(reference);
     const chunks = indexChunks(result);
     const sections = buildFlatSections(result, chunks);
     const sectionTree = result.docNav?.sections && result.docNav.sections.length > 0 ? result.docNav.sections.map(
@@ -1801,7 +1850,7 @@ var Knowledge = class _Knowledge {
     };
   }
   async readChunks(params) {
-    const { document, result } = await this.store.loadResult(params.localDocumentId);
+    const { document, result } = await this.loadReadableResult(params);
     const limit = clampLimit(params.limit, DEFAULT_READ_LIMIT, MAX_READ_LIMIT);
     const chunks = indexChunks(result).filter((chunk) => matchesReadScope(chunk, params));
     const selected = selectReadWindow(chunks, params, limit);
@@ -1817,7 +1866,7 @@ var Knowledge = class _Knowledge {
     if (!params.pattern) {
       throw new ValidationError("pattern is required");
     }
-    const { document, result } = await this.store.loadResult(params.localDocumentId);
+    const { document, result } = await this.loadReadableResult(params);
     const maxResults = clampLimit(params.maxResults, DEFAULT_GREP_LIMIT, MAX_GREP_LIMIT);
     const contextChars = params.contextChars ?? DEFAULT_CONTEXT_CHARS;
     const matcher = createMatcher(params);
@@ -1887,7 +1936,68 @@ var Knowledge = class _Knowledge {
     const requested = new Set(localDocumentIds);
     return documents.filter((document) => requested.has(document.localDocumentId));
   }
+  async loadReadableResult(reference) {
+    const normalized = normalizeDocumentReference(reference);
+    if (normalized.documentId) {
+      return this.cacheDocument({
+        documentId: normalized.documentId,
+        localDocumentId: normalized.localDocumentId
+      });
+    }
+    if (normalized.jobId) {
+      return this.cacheJobResult({
+        jobId: normalized.jobId,
+        localDocumentId: normalized.localDocumentId
+      });
+    }
+    if (!normalized.localDocumentId) {
+      throw new ValidationError("localDocumentId, documentId, or jobId is required");
+    }
+    const document = await this.store.getDocument(normalized.localDocumentId);
+    if (document) {
+      return this.store.loadResult(normalized.localDocumentId);
+    }
+    if (looksLikeRemoteDocumentId(normalized.localDocumentId)) {
+      return this.cacheDocument({
+        documentId: normalized.localDocumentId,
+        localDocumentId: createLocalDocumentIdForRemote(normalized.localDocumentId)
+      });
+    }
+    throw new Error(`Local Knowhere document not found: ${normalized.localDocumentId}`);
+  }
+  async findLocalDocumentByRemoteId(documentId) {
+    const documents = await this.store.listDocuments();
+    return documents.find((document) => document.documentId === documentId);
+  }
+  async getPublishedDocumentJobId(documentId) {
+    const response = await this.client.documents.listChunks(documentId, {
+      page: 1,
+      pageSize: 1
+    });
+    if (!response.jobId) {
+      throw new Error(
+        `Cannot sync server document ${documentId}: current published job id was not returned.`
+      );
+    }
+    return response.jobId;
+  }
 };
+function normalizeDocumentReference(reference) {
+  if (typeof reference === "string") {
+    return { localDocumentId: reference };
+  }
+  return reference;
+}
+function looksLikeRemoteDocumentId(value) {
+  return REMOTE_DOCUMENT_ID_PATTERN.test(value);
+}
+function createLocalDocumentIdForRemote(documentId) {
+  if (SAFE_LOCAL_DOCUMENT_ID_PATTERN.test(documentId) && !documentId.includes("..") && !documentId.includes("/") && !documentId.includes("\\")) {
+    return documentId;
+  }
+  const hash = createHash2("sha256").update(documentId).digest("hex").slice(0, 16);
+  return `remote_${hash}`;
+}
 function indexChunks(result) {
   return result.chunks.map((chunk, index) => {
     const filePath = getChunkFilePath2(chunk);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ontos-ai/knowhere-sdk",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Official Node.js SDK for Knowhere document parsing API",
   "keywords": [
     "knowhere",