@xcitedbs/client 0.2.9 → 0.2.11

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { AccessCheckResult, AppAuthConfig, AppEmailConfig, AppEmailTemplates, AppUser, AppUserTokenPair, EmailTestResponse, ForgotPasswordResponse, SendVerificationResponse, BranchInfo, CommitRecord, DatabaseContext, DiffRef, DiffResult, Flags, ListIdentifierChildrenResult, ListIdentifiersResult, LockInfo, LogEntry, MergeResult, MetaValue, PlatformRegisterResult, PolicySubjectInput, UnqueryResult, UnqueryTemplate, PolicyUpdateResponse, RealtimeEvent, SecurityConfig, SecurityPolicy, StoredTriggerResponse, TriggerDefinition, StoredPolicyResponse, SubscriptionOptions, TagRecord, TextSearchQuery, TextSearchResult, OAuthProvidersResponse, ProjectInfo, PlatformRegistrationConfig, PlatformWorkspacesResponse, TokenPair, UserInfo, ApiKeyInfo, WriteDocumentOptions, CreateTestSessionOptions, XCiteDBClientOptions, XCiteDBJwtClaims, XCiteQuery } from './types';
+import { AccessCheckResult, AppAuthConfig, AppEmailConfig, AppEmailTemplates, AppUser, AppUserTokenPair, EmailTestResponse, ForgotPasswordResponse, SendVerificationResponse, BranchInfo, BookmarkRecord, CheckpointRecord, CommitRecord, CompareRef, CompareResult, DatabaseContext, DiffRef, DiffResult, Flags, ListIdentifierChildrenResult, ListIdentifiersResult, LockInfo, LogEntry, MergeResult, PublishResult, WorkspaceInfo, MetaValue, PlatformRegisterResult, PolicySubjectInput, UnqueryResult, UnqueryTemplate, PolicyUpdateResponse, RealtimeEvent, SecurityConfig, SecurityPolicy, StoredTriggerResponse, TriggerDefinition, StoredPolicyResponse, SubscriptionOptions, TagRecord, TextSearchQuery, TextSearchResult, ProjectSearchSettings, ProjectSearchSettingsUpdate, VectorIndexEstimate, RagQueryOptions, RagQueryResult, RagStreamEvent, OAuthProvidersResponse, ProjectInfo, PlatformRegistrationConfig, PlatformWorkspacesResponse, TokenPair, UserInfo, ApiKeyInfo, WriteDocumentOptions, CreateTestSessionOptions, XCiteDBClientOptions, XCiteDBJwtClaims, XCiteQuery, UserIsolationConfig } from './types';
 import { WebSocketSubscription } from './websocket';
 export declare class XCiteDBClient {
     private baseUrl;
@@ -16,6 +16,8 @@ export declare class XCiteDBClient {
     private onSessionInvalid?;
     private testSessionToken?;
     private testRequireAuth?;
+    private userIsolation?;
+    private cachedAppUserId?;
     constructor(options: XCiteDBClientOptions);
     /**
      * Create an ephemeral isolated database: calls `POST /api/v1/test/sessions` with your API key or Bearer,
@@ -33,6 +35,19 @@ export declare class XCiteDBClient {
      * Use for debugging ABAC (compare `tenant_id` and `groups` to `project:<…>:role` in policies).
      */
     getTokenClaims(): XCiteDBJwtClaims | null;
+    private cacheAppUserIdFromPair;
+    private clearAppUserIdCache;
+    private getAppUserId;
+    private normalizeIsolationNamespaceTemplate;
+    private canonicalId;
+    /** Resolved namespace root, e.g. `/users/abc`, or `null` if isolation is off or no app user id. */
+    private userIsolationNamespace;
+    private allSharedPassthroughPrefixes;
+    private pathMatchesSharedPassthrough;
+    private isoPrefixId;
+    private isoUnprefixId;
+    private isoPrefixQuery;
+    private isoApplyXmlDbIdentifier;
     /** Destroy this test session on the server (`DELETE /api/v1/test/sessions/current`). */
     destroyTestSession(): Promise<{
         message: string;
@@ -57,6 +72,7 @@ export declare class XCiteDBClient {
     private mergeAppTenant;
     private authHeaders;
     private testHeaders;
+    private requestHeaders;
     private request;
     /** Developer Bearer refresh first, then app-user refresh (no API key refresh). */
     private tryRefreshSessionAfter401;
@@ -266,12 +282,45 @@ export declare class XCiteDBClient {
      * ```
      */
     updateSecurityConfig(config: Partial<SecurityConfig>): Promise<void>;
+    /** Per-tenant user data spaces (`GET /api/v1/security/user-isolation`). Requires security admin. */
+    getUserIsolationConfig(): Promise<UserIsolationConfig>;
+    /** Enable or reconfigure user isolation (`PUT /api/v1/security/user-isolation`). */
+    setUserIsolationConfig(config: Partial<UserIsolationConfig>): Promise<UserIsolationConfig>;
+    /** Disable user isolation and remove generated policies (`DELETE /api/v1/security/user-isolation`). */
+    disableUserIsolation(): Promise<void>;
+    /**
+     * Loads server isolation config; when enabled, configures client-side identifier prefixing to match
+     * the server (namespace + shared paths). Does not send `X-Prefix`; identifiers in requests are rewritten.
+     */
+    enableUserIsolation(): Promise<UserIsolationConfig>;
+    createWorkspace(name: string, fromBranch?: string, fromDate?: string): Promise<void>;
+    /** @deprecated Use {@link createWorkspace}. */
     createBranch(name: string, fromBranch?: string, fromDate?: string): Promise<void>;
+    deleteWorkspace(name: string): Promise<void>;
+    /** @deprecated Use {@link deleteWorkspace}. */
     deleteBranch(name: string): Promise<void>;
+    deleteWorkspaceRevision(workspace: string, date: string): Promise<void>;
+    /** @deprecated Use {@link deleteWorkspaceRevision}. */
     deleteRevision(branch: string, date: string): Promise<void>;
+    listWorkspaces(): Promise<WorkspaceInfo[]>;
+    /** @deprecated Use {@link listWorkspaces}. */
     listBranches(): Promise<BranchInfo[]>;
+    getWorkspace(name: string): Promise<WorkspaceInfo>;
+    /** @deprecated Use {@link getWorkspace}. */
     getBranch(name: string): Promise<BranchInfo>;
+    createCheckpoint(message: string, author?: string): Promise<CheckpointRecord>;
+    /** @deprecated Use {@link createCheckpoint}. */
     createCommit(message: string, author?: string): Promise<CommitRecord>;
+    listCheckpoints(options?: {
+        branch?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        checkpoints: CheckpointRecord[];
+        total: number;
+        branch: string;
+    }>;
+    /** @deprecated Use {@link listCheckpoints}. */
     listCommits(options?: {
         branch?: string;
         limit?: number;
@@ -281,13 +330,33 @@ export declare class XCiteDBClient {
         total: number;
         branch: string;
     }>;
+    getCheckpoint(checkpointId: string): Promise<CheckpointRecord>;
+    /** @deprecated Use {@link getCheckpoint}. */
     getCommit(commitId: string): Promise<CommitRecord>;
+    revertToCheckpoint(checkpointId: string, _confirm?: boolean): Promise<{
+        rolled_back_checkpoints: string[];
+        rolled_back_commits?: string[];
+        current_tip: string;
+    }>;
+    /** @deprecated Use {@link revertToCheckpoint}. */
     rollbackToCommit(commitId: string, _confirm?: boolean): Promise<{
         rolled_back_commits: string[];
         current_tip: string;
     }>;
+    applyCheckpoint(checkpointId: string, message?: string, author?: string): Promise<CheckpointRecord>;
+    /** @deprecated Use {@link applyCheckpoint}. */
     cherryPick(commitId: string, message?: string, author?: string): Promise<CommitRecord>;
+    createBookmark(name: string, checkpointId: string, message?: string, author?: string): Promise<BookmarkRecord>;
+    /** @deprecated Use {@link createBookmark}. */
     createTag(name: string, commitId: string, message?: string, author?: string): Promise<TagRecord>;
+    listBookmarks(options?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<{
+        bookmarks: BookmarkRecord[];
+        total: number;
+    }>;
+    /** @deprecated Use {@link listBookmarks}. */
     listTags(options?: {
         limit?: number;
         offset?: number;
@@ -295,23 +364,44 @@ export declare class XCiteDBClient {
         tags: TagRecord[];
         total: number;
     }>;
+    getBookmark(name: string): Promise<BookmarkRecord>;
+    /** @deprecated Use {@link getBookmark}. */
     getTag(name: string): Promise<TagRecord>;
+    deleteBookmark(name: string): Promise<void>;
+    /** @deprecated Use {@link deleteBookmark}. */
     deleteTag(name: string): Promise<void>;
+    compare(from: CompareRef, to: CompareRef, includeContent?: boolean): Promise<CompareResult>;
+    /** @deprecated Use {@link compare}. */
     diff(from: DiffRef, to: DiffRef, includeContent?: boolean): Promise<DiffResult>;
+    publishWorkspace(targetWorkspace: string, sourceWorkspace: string, options?: {
+        message?: string;
+        autoResolve?: 'none' | 'source' | 'target';
+    }): Promise<PublishResult>;
+    /** @deprecated Use {@link publishWorkspace}. */
     mergeBranch(targetBranch: string, sourceBranch: string, options?: {
         message?: string;
         autoResolve?: 'none' | 'source' | 'target';
     }): Promise<MergeResult>;
     /**
-     * Create `branchName` from {@link options.fromBranch} (or current context branch), run `fn` scoped to that branch,
-     * create a commit, then merge back into the parent branch unless {@link options.autoMerge} is `false`.
-     * Restores previous {@link DatabaseContext} afterward.
+     * Create `workspaceName` from {@link options.fromBranch} (or current context), run `fn` scoped to that workspace,
+     * create a checkpoint, then publish back unless {@link options.autoMerge} is `false`.
      */
+    withWorkspace<T>(workspaceName: string, fn: (client: XCiteDBClient) => Promise<T>, options?: {
+        message?: string;
+        /** When true (default), publish `workspaceName` into the parent workspace after checkpoint. */
+        autoMerge?: boolean;
+        /** Workspace to fork from (default: current `context.branch` / `context.workspace`, or `""`). */
+        fromBranch?: string;
+        author?: string;
+    }): Promise<{
+        result: T;
+        checkpoint?: CheckpointRecord;
+        publish?: PublishResult;
+    }>;
+    /** @deprecated Use {@link withWorkspace}. */
     withBranch<T>(branchName: string, fn: (client: XCiteDBClient) => Promise<T>, options?: {
         message?: string;
-        /** When true (default), merge `branchName` into the parent branch after commit. */
         autoMerge?: boolean;
-        /** Branch to fork from (default: current `context.branch`, or `""`). */
         fromBranch?: string;
         author?: string;
     }): Promise<{
@@ -386,6 +476,32 @@ export declare class XCiteDBClient {
         status: string;
         message: string;
     }>;
+    reembedVector(): Promise<{
+        status: string;
+        message: string;
+    }>;
+    /** Project search / FTS / vector / LLM configuration (`GET /api/v1/project/settings/search`). */
+    getProjectSearchSettings(): Promise<ProjectSearchSettings>;
+    /** Update project search settings (`PUT /api/v1/project/settings/search`). Returns the same shape as GET. */
+    updateProjectSearchSettings(patch: ProjectSearchSettingsUpdate): Promise<ProjectSearchSettings>;
+    /** Blocking full DB scan (admin; no calls to embedding API). Prefer {@link postVectorIndexEstimateSession} for UI. */
+    getVectorIndexEstimate(): Promise<VectorIndexEstimate>;
+    /** Start background estimate (202); cancel prior session for this tenant. */
+    postVectorIndexEstimateSession(): Promise<VectorIndexEstimate>;
+    getVectorIndexEstimateSession(sessionId: string): Promise<VectorIndexEstimate>;
+    deleteVectorIndexEstimateSession(sessionId: string): Promise<{
+        status?: string;
+    }>;
+    /**
+     * RAG over indexed documents (`POST /api/v1/rag/query` with JSON body).
+     * Requires LLM completion; embedding required when retrieval uses semantic or hybrid.
+     */
+    ragQuery(options: Omit<RagQueryOptions, 'stream'>): Promise<RagQueryResult>;
+    /**
+     * Streaming RAG (`POST /api/v1/rag/query` with `stream: true`). Parses SSE `data: {...}` lines.
+     * The final event has `done: true` and may include `sources`.
+     */
+    ragQueryStream(options: Omit<RagQueryOptions, 'stream'>, onEvent: (ev: RagStreamEvent) => void): Promise<void>;
     writeJsonDocument(identifier: string, data: unknown): Promise<void>;
     readJsonDocument<T = unknown>(identifier: string): Promise<T>;
     deleteJsonDocument(identifier: string): Promise<void>;