@xcitedbs/client 0.2.10 → 0.2.12

package/dist/types.d.ts

@@ -41,12 +41,20 @@ export interface TextSearchQuery {
     branch?: string;
     offset?: number;
     limit?: number;
-    /** Default `fts`. `semantic` / `hybrid` require vector search (and hybrid requires FTS). */
-    mode?: 'fts' | 'semantic' | 'hybrid';
+    /**
+     * Default server behavior when omitted: `auto` (hybrid if FTS+vector enabled, else semantic or FTS).
+     * Explicit `fts` / `semantic` / `hybrid` require the matching capabilities to be enabled.
+     */
+    mode?: 'auto' | 'fts' | 'semantic' | 'hybrid';
     /** Minimum cosine similarity for semantic / hybrid vector leg (default 0.3). */
     min_score?: number;
     /** Hybrid only: weight of semantic vs FTS in weighted RRF (0–1, default 0.5). */
     semantic_weight?: number;
+    /** Point-in-time FTS filter (ISO date string; server maps to internal date key). */
+    at_date?: string;
+    /** Range FTS filter: interval overlap with [date_from, date_to) (ISO dates). */
+    date_from?: string;
+    date_to?: string;
 }
 export interface TextSearchHit {
     identifier: string;
@@ -59,6 +67,9 @@ export interface TextSearchHit {
     score: number;
     /** Present for semantic / hybrid search. */
     source?: 'fts' | 'semantic' | 'both';
+    /** FTS temporal window for this hit (internal 7-char keys), when returned by the server. */
+    valid_from?: string;
+    valid_to?: string;
 }
 export interface TextSearchResult {
     hits: TextSearchHit[];
@@ -153,6 +164,15 @@ export interface ProjectSearchSettingsUpdate {
     llm_base_url?: string | null;
     llm_api_key?: string;
 }
+/** `GET /api/v1/project/settings/doc-conf` (and returned after `PUT` / `DELETE`). */
+export interface ProjectDocConfResponse {
+    has_project_override: boolean;
+    doc_conf_text: string | null;
+}
+/** `GET /api/v1/platform/default-doc-conf` */
+export interface PlatformDefaultDocConfResponse {
+    doc_conf_text: string;
+}
 /** `POST /api/v1/rag/query` (non-streaming: set `stream: false` or omit). */
 export interface RagQueryOptions {
     question: string;
@@ -307,7 +327,18 @@ export interface ApiKeyInfo {
 }
 export type Flags = 'None' | 'FirstMatch' | 'IncludeChildren' | 'NoChildren' | 'KeepIndexNodes' | 'PrevIfDeleted' | string;
 export interface DatabaseContext {
+    /**
+     * Workspace name (isolated editing environment). Empty / unset = main timeline.
+     * Sent as `X-Workspace` (preferred); see also {@link DatabaseContext.branch}.
+     */
+    workspace?: string;
+    /** @deprecated Prefer {@link DatabaseContext.workspace}. Sent as `X-Branch` when `workspace` is unset. */
     branch?: string;
+    /**
+     * As-of revision time, sent as `X-Date`. Accepted forms (whole string must match; trailing spaces ignored):
+     * `mm/dd/yyyy`, `mm/dd/yyyy:HH:MM:SS`, ISO `YYYY-MM-DDTHH:MM:SS` with optional numeric timezone,
+     * `YYYY-MM-DD HH:MM:SS`, and ISO date-only `YYYY-MM-DD`.
+     */
     date?: string;
     prefix?: string;
     /**
@@ -386,6 +417,11 @@ export interface XCiteDBClientOptions {
     testRequireAuth?: boolean;
     /** Auto-prefix identifiers for app-user sessions (see {@link UserIsolationOptions}). */
     userIsolation?: UserIsolationOptions;
+    /**
+     * Per-request timeout in milliseconds for normal REST calls (uses `AbortSignal.timeout` when available).
+     * Omit for no timeout. Streaming RAG (`ragQueryStream`) does not apply this.
+     */
+    requestTimeoutMs?: number;
 }
 /** Options for {@link XCiteDBClient.createTestSession} (provisions via API key or Bearer). */
 export interface CreateTestSessionOptions {
@@ -397,12 +433,17 @@ export interface CreateTestSessionOptions {
     context?: DatabaseContext;
     platformConsole?: boolean;
     projectId?: string;
+    /**
+     * When true, creates an overlay test session: writable ephemeral LMDB with production project data as read-only base.
+     */
+    overlay?: boolean;
     /** Keep `apiKey` / `accessToken` on the client and send `X-Test-Auth: required` on each request. */
     testRequireAuth?: boolean;
     onSessionTokensUpdated?: (pair: TokenPair) => void;
     onAppUserTokensUpdated?: (pair: AppUserTokenPair) => void;
     onSessionInvalid?: () => void;
     userIsolation?: UserIsolationOptions;
+    requestTimeoutMs?: number;
 }
 /** Application user (tenant-scoped), distinct from developer users. */
 export interface AppUser {
@@ -596,83 +637,115 @@ export interface StoredTriggerResponse {
     trigger_id: string;
     trigger: TriggerDefinition;
 }
-/** Version control / commit metadata (git-like layer). */
-export interface CommitRecord {
+/** Named snapshot on a workspace (checkpoint). */
+export interface CheckpointRecord {
     id: string;
+    /** Same as `id` when returned by newer APIs. */
+    checkpoint_id?: string;
     branch: string;
-    /** Internal LMDB date key for this commit snapshot. */
-    date_key: string;
-    date_human?: string;
-    /** Alias for human-readable date (same as date_human when present). */
+    /** Human-readable revision date/time. */
     date?: string;
+    date_human?: string;
+    /** @deprecated Internal key; omitted from newer API responses. */
+    date_key?: string;
     message: string;
     author: string;
     parent_id: string | null;
     merge_source?: {
         branch: string;
-        commit_id: string;
+        checkpoint_id?: string;
+        commit_id?: string;
     };
     cherry_picked_from?: string;
     affected_identifiers: string[];
     status: 'active' | 'rolled_back';
     created_at: number;
 }
-/** Branch row from GET /api/v1/branches (also exposed as BranchListItem). */
-export interface BranchInfo {
+/** @deprecated Use {@link CheckpointRecord}. */
+export type CommitRecord = CheckpointRecord;
+/** Workspace row from `GET /api/v1/workspaces` (legacy: `/api/v1/branches`). */
+export interface WorkspaceInfo {
     name: string;
     from_branch: string;
     from_date: string;
-    /** Internal LMDB fork date key when present. */
-    from_date_key?: string;
-    tip_commit?: CommitRecord;
-}
-export type BranchListItem = BranchInfo;
-export interface TagRecord {
+    tip_checkpoint?: CheckpointRecord;
+    /** @deprecated Alias of {@link WorkspaceInfo.tip_checkpoint}. */
+    tip_commit?: CheckpointRecord;
+}
+/** @deprecated Use {@link WorkspaceInfo}. */
+export type BranchInfo = WorkspaceInfo;
+/** @deprecated Use {@link WorkspaceInfo}. */
+export type BranchListItem = WorkspaceInfo;
+export interface BookmarkRecord {
     name: string;
-    commit_id: string;
+    checkpoint_id: string;
+    /** @deprecated Same as `checkpoint_id`. */
+    commit_id?: string;
     branch: string;
-    date_key: string;
+    date?: string;
+    /** @deprecated */
+    date_key?: string;
     message?: string;
     author?: string;
     created_at: number;
 }
-export interface DiffEntry {
+/** @deprecated Use {@link BookmarkRecord}. */
+export type TagRecord = BookmarkRecord;
+export interface CompareEntry {
     identifier: string;
     action: 'added' | 'modified' | 'deleted';
     from_content?: string;
     to_content?: string;
 }
-export interface DiffRef {
+/** @deprecated Use {@link CompareEntry}. */
+export type DiffEntry = CompareEntry;
+export interface CompareRef {
     branch?: string;
-    /** Internal date key (preferred for exact revision). */
+    /** Human-readable date (preferred). */
+    date?: string;
+    checkpoint_id?: string;
+    /** @deprecated Undocumented fallback. */
     date_key?: string;
+    /** @deprecated Use {@link CompareRef.checkpoint_id}. */
     commit_id?: string;
 }
-export interface DiffResult {
-    changes: DiffEntry[];
+/** @deprecated Use {@link CompareRef}. */
+export type DiffRef = CompareRef;
+export interface CompareResult {
+    changes: CompareEntry[];
     from: {
         branch?: string;
+        date?: string;
         date_key?: string;
     };
     to: {
         branch?: string;
+        date?: string;
         date_key?: string;
     };
     total_changes: number;
 }
-export interface MergeConflict {
+/** @deprecated Use {@link CompareResult}. */
+export type DiffResult = CompareResult;
+export interface PublishConflict {
     identifier: string;
     source_action: string;
     target_action: string;
 }
-export interface MergeResult {
+/** @deprecated Use {@link PublishConflict}. */
+export type MergeConflict = PublishConflict;
+export interface PublishResult {
     status: 'completed' | 'conflicts';
-    commit?: CommitRecord;
+    checkpoint?: CheckpointRecord;
+    /** @deprecated Alias of {@link PublishResult.checkpoint}. */
+    commit?: CheckpointRecord;
     merged_identifiers?: string[];
-    conflicts?: MergeConflict[];
+    conflicts?: PublishConflict[];
     auto_mergeable?: string[];
     message?: string;
 }
+/** @deprecated Use {@link PublishResult}. */
+export type MergeResult = PublishResult;
 export declare class XCiteDBError extends Error {
     readonly status: number;
     readonly body?: unknown | undefined;