@raisindb/client 0.1.5 → 0.1.17

package/dist/index-DQjE-4Oj.d.ts

@@ -0,0 +1,301 @@
+import { f as ConversationStoreOptions, a as ConversationStoreSnapshot, b as ChatMessage, g as ConversationListStoreOptions, h as ConversationListSnapshot, d as ConversationListItem, R as RaisinClient, I as IdentityUser, C as ConnectionState, S as SubscriptionFilters, D as Database, A as AuthManager, F as FlowClientOptions, i as FlowsApi, j as FlowExecutionEvent, E as EventMessage } from './conversation-list-store-CNcVagmw.js';
+
+/**
+ * React adapters for the RaisinDB conversation stores.
+ *
+ * Since the SDK does not depend on React, the hooks accept React as a
+ * parameter to avoid a hard dependency while providing full type safety.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useConversation, useConversationList } from '@raisindb/client';
+ *
+ * function Chat() {
+ *   const chat = useConversation(React, {
+ *     database: db,
+ *     conversationPath: '/...',
+ *   });
+ *   return (
+ *     <div>
+ *       {chat.messages.map((m, i) => <div key={i}>{m.content}</div>)}
+ *       {chat.isStreaming && <p>{chat.streamingText}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+
+/** Minimal subset of the React API needed by the hooks */
+interface ReactLike {
+    useState<T>(initial: T | (() => T)): [T, (value: T | ((prev: T) => T)) => void];
+    useEffect(effect: () => void | (() => void), deps?: unknown[]): void;
+    useRef<T>(initial: T): {
+        current: T;
+    };
+    useCallback<T extends (...args: never[]) => unknown>(fn: T, deps: unknown[]): T;
+}
+interface UseConversationReturn extends ConversationStoreSnapshot {
+    sendMessage: (content: string) => Promise<void>;
+    approvePlan: (planPath: string) => Promise<void>;
+    rejectPlan: (planPath: string, feedback?: string) => Promise<void>;
+    stop: () => void;
+    loadMessages: () => Promise<ChatMessage[]>;
+}
+declare function useConversation(react: ReactLike, options: ConversationStoreOptions): UseConversationReturn;
+interface UseConversationListReturn extends ConversationListSnapshot {
+    createConversation: (options: {
+        participant: string;
+        subject?: string;
+    }) => Promise<ConversationListItem>;
+    deleteConversation: (conversationPath: string) => Promise<void>;
+    markAsRead: (conversationPath: string) => Promise<void>;
+}
+declare function useConversationList(react: ReactLike, options: ConversationListStoreOptions): UseConversationListReturn;
+
+/**
+ * Extended React-like interface that includes context and rendering APIs
+ * needed by the Provider and context-consuming hooks.
+ */
+interface ReactLikeWithContext extends ReactLike {
+    createContext<T>(defaultValue: T): ReactContext<T>;
+    useContext<T>(context: ReactContext<T>): T;
+    useMemo<T>(factory: () => T, deps: unknown[]): T;
+    createElement(type: unknown, props: unknown, ...children: unknown[]): any;
+}
+/** Minimal React context interface */
+interface ReactContext<T> {
+    Provider: unknown;
+    Consumer?: unknown;
+    displayName?: string;
+    /** Default value (used internally by React) */
+    _currentValue?: T;
+}
+/** Props for the RaisinProvider component */
+interface RaisinProviderProps {
+    client: RaisinClient;
+    repository?: string;
+    children?: unknown;
+}
+/** Value stored in the Raisin context */
+interface RaisinContextValue {
+    client: RaisinClient;
+    repository?: string;
+}
+/** Return type for useAuth() */
+interface UseAuthReturn {
+    user: IdentityUser | null;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    login: (email: string, password: string, repository: string) => Promise<IdentityUser>;
+    register: (email: string, password: string, repository: string, displayName?: string) => Promise<IdentityUser>;
+    logout: (options?: {
+        disconnect?: boolean;
+        reconnect?: boolean;
+    }) => Promise<void>;
+    initSession: (repository: string) => Promise<IdentityUser | null>;
+}
+/** Return type for useConnection() */
+interface UseConnectionReturn {
+    state: ConnectionState;
+    isConnected: boolean;
+    isReady: boolean;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+}
+/** Options for useSql() */
+interface UseSqlOptions {
+    enabled?: boolean;
+    repository?: string;
+    refetchOnReconnect?: boolean;
+    realtime?: {
+        workspace: string;
+        eventTypes?: string[];
+        path?: string;
+        nodeType?: string;
+    };
+}
+/** Return type for useSql<T>() */
+interface UseSqlReturn<T> {
+    data: T[] | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/** Options for useSubscription() */
+interface UseSubscriptionOptions extends SubscriptionFilters {
+    enabled?: boolean;
+}
+
+/**
+ * React flow adapter for RaisinDB.
+ *
+ * Provides a `useFlow` hook that wraps the FlowClient for executing
+ * and monitoring RaisinDB flows in React applications. Returns reactive
+ * state tracking flow events, status, and providing control actions.
+ *
+ * Since this SDK package does not depend on React, the hook accepts
+ * React as a parameter via the `ReactLike` interface.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useFlow } from '@raisindb/client';
+ *
+ * function OrderProcessor() {
+ *   const flow = useFlow(React, {
+ *     baseUrl: 'http://localhost:8081',
+ *     repository: 'my-repo',
+ *     authManager,
+ *   });
+ *
+ *   const handleRun = async () => {
+ *     await flow.run('/flows/process-order', { orderId: 'ord-123' });
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleRun} disabled={flow.isRunning}>Run</button>
+ *       <p>Status: {flow.status}</p>
+ *       {flow.events.map((e, i) => <div key={i}>{e.type}</div>)}
+ *       {flow.error && <p className="error">{flow.error}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+
+/** Options for creating the FlowClient within useFlow */
+interface UseFlowOptions {
+    /**
+     * Pre-configured Database instance (from `client.database()`).
+     * When provided, `baseUrl`, `repository`, `authManager`, and `flowsApi` are derived
+     * automatically — no manual wiring needed.
+     */
+    database?: Database;
+    /** Base HTTP URL of the RaisinDB server */
+    baseUrl?: string;
+    /** Repository name */
+    repository?: string;
+    /** Auth manager for token access */
+    authManager?: AuthManager;
+    /** Additional FlowClient options */
+    clientOptions?: FlowClientOptions;
+    /** Optional FlowsApi for WebSocket-based flow operations */
+    flowsApi?: FlowsApi;
+}
+/** Flow execution status */
+type FlowStatus = 'idle' | 'running' | 'waiting' | 'completed' | 'failed';
+/** Return value from the useFlow hook */
+interface UseFlowReturn {
+    /** Collected flow execution events */
+    events: FlowExecutionEvent[];
+    /** Current flow status */
+    status: FlowStatus;
+    /** Whether a flow is currently running */
+    isRunning: boolean;
+    /** Current error, if any */
+    error: string | null;
+    /** Output from the completed flow */
+    output: unknown | null;
+    /** Current flow instance ID, if running */
+    instanceId: string | null;
+    /** Run a flow by path with optional input data */
+    run: (flowPath: string, input?: Record<string, unknown>) => Promise<void>;
+    /** Resume a waiting flow with data */
+    resume: (data: unknown) => Promise<void>;
+    /** Reset the hook state (clear events, status, error) */
+    reset: () => void;
+}
+/**
+ * React hook for executing and monitoring RaisinDB flows.
+ *
+ * Manages the full lifecycle: starting a flow, streaming events,
+ * resuming waiting flows, and tracking completion status.
+ * Auto-cleans up on component unmount.
+ *
+ * @param react - The React instance (pass `React` or `{ useState, useEffect, useRef, useCallback }`)
+ * @param options - Flow client options (baseUrl, repository, authManager, etc.)
+ * @returns Reactive flow state and action functions
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useFlow } from '@raisindb/client';
+ *
+ * function DataPipeline() {
+ *   const flow = useFlow(React, {
+ *     baseUrl: 'http://localhost:8081',
+ *     repository: 'my-repo',
+ *     authManager,
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => flow.run('/flows/etl', { source: 'api' })}>
+ *         Start Pipeline
+ *       </button>
+ *       <p>Status: {flow.status}</p>
+ *       <p>Events: {flow.events.length}</p>
+ *       {flow.status === 'waiting' && (
+ *         <button onClick={() => flow.resume({ approved: true })}>
+ *           Approve
+ *         </button>
+ *       )}
+ *       {flow.output && <pre>{JSON.stringify(flow.output, null, 2)}</pre>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useFlow(react: ReactLike, options: UseFlowOptions): UseFlowReturn;
+
+/**
+ * React integration layer for RaisinDB.
+ *
+ * Provides a `createRaisinReact(React)` factory that returns a Provider
+ * component and hooks for auth, connection, queries, and subscriptions.
+ *
+ * Uses the "bring your own React" pattern to avoid a peer dependency.
+ *
+ * @example
+ * ```ts
+ * import React from 'react';
+ * import { RaisinClient, LocalStorageTokenStorage, createRaisinReact } from '@raisindb/client';
+ *
+ * const client = new RaisinClient('wss://localhost:8443/sys/default/myrepo', {
+ *   tokenStorage: new LocalStorageTokenStorage('myrepo'),
+ * });
+ *
+ * export const {
+ *   RaisinProvider, useAuth, useConnection, useDatabase,
+ *   useSql, useSubscription, useConversation, useFlow,
+ * } = createRaisinReact(React);
+ * ```
+ */
+
+interface RaisinReact {
+    RaisinProvider: (props: RaisinProviderProps) => any;
+    useRaisinClient: () => RaisinClient;
+    useDatabase: (repository?: string) => Database;
+    useAuth: () => UseAuthReturn;
+    useConnection: () => UseConnectionReturn;
+    useSql: <T = Record<string, unknown>>(sql: string, params?: unknown[], options?: UseSqlOptions) => UseSqlReturn<T>;
+    useSubscription: (options: UseSubscriptionOptions, callback: (event: EventMessage) => void) => void;
+    useConversation: (options: ConversationStoreOptions) => UseConversationReturn;
+    useConversationList: (options: ConversationListStoreOptions) => UseConversationListReturn;
+    useFlow: (options: UseFlowOptions) => UseFlowReturn;
+}
+/**
+ * Create the full React integration for RaisinDB.
+ *
+ * Accepts a React instance and returns a Provider component plus hooks.
+ * The React instance must include `createContext`, `useContext`, `useMemo`,
+ * and `createElement` in addition to the base `ReactLike` interface.
+ *
+ * @param react - The React instance
+ * @returns Provider component and hooks
+ */
+declare function createRaisinReact(react: ReactLikeWithContext): RaisinReact;
+
+export { type FlowStatus as F, type ReactLike as R, type UseConversationReturn as U, useConversationList as a, type UseConversationListReturn as b, useFlow as c, type UseFlowOptions as d, type UseFlowReturn as e, createRaisinReact as f, type RaisinReact as g, type ReactLikeWithContext as h, type RaisinProviderProps as i, type RaisinContextValue as j, type UseAuthReturn as k, type UseConnectionReturn as l, type UseSqlOptions as m, type UseSqlReturn as n, type UseSubscriptionOptions as o, useConversation as u };

package/dist/index-FkFH4HHQ.d.mts

@@ -0,0 +1,301 @@
+import { f as ConversationStoreOptions, a as ConversationStoreSnapshot, b as ChatMessage, g as ConversationListStoreOptions, h as ConversationListSnapshot, d as ConversationListItem, R as RaisinClient, I as IdentityUser, C as ConnectionState, S as SubscriptionFilters, D as Database, A as AuthManager, F as FlowClientOptions, i as FlowsApi, j as FlowExecutionEvent, E as EventMessage } from './conversation-list-store-CNcVagmw.mjs';
+
+/**
+ * React adapters for the RaisinDB conversation stores.
+ *
+ * Since the SDK does not depend on React, the hooks accept React as a
+ * parameter to avoid a hard dependency while providing full type safety.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useConversation, useConversationList } from '@raisindb/client';
+ *
+ * function Chat() {
+ *   const chat = useConversation(React, {
+ *     database: db,
+ *     conversationPath: '/...',
+ *   });
+ *   return (
+ *     <div>
+ *       {chat.messages.map((m, i) => <div key={i}>{m.content}</div>)}
+ *       {chat.isStreaming && <p>{chat.streamingText}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+
+/** Minimal subset of the React API needed by the hooks */
+interface ReactLike {
+    useState<T>(initial: T | (() => T)): [T, (value: T | ((prev: T) => T)) => void];
+    useEffect(effect: () => void | (() => void), deps?: unknown[]): void;
+    useRef<T>(initial: T): {
+        current: T;
+    };
+    useCallback<T extends (...args: never[]) => unknown>(fn: T, deps: unknown[]): T;
+}
+interface UseConversationReturn extends ConversationStoreSnapshot {
+    sendMessage: (content: string) => Promise<void>;
+    approvePlan: (planPath: string) => Promise<void>;
+    rejectPlan: (planPath: string, feedback?: string) => Promise<void>;
+    stop: () => void;
+    loadMessages: () => Promise<ChatMessage[]>;
+}
+declare function useConversation(react: ReactLike, options: ConversationStoreOptions): UseConversationReturn;
+interface UseConversationListReturn extends ConversationListSnapshot {
+    createConversation: (options: {
+        participant: string;
+        subject?: string;
+    }) => Promise<ConversationListItem>;
+    deleteConversation: (conversationPath: string) => Promise<void>;
+    markAsRead: (conversationPath: string) => Promise<void>;
+}
+declare function useConversationList(react: ReactLike, options: ConversationListStoreOptions): UseConversationListReturn;
+
+/**
+ * Extended React-like interface that includes context and rendering APIs
+ * needed by the Provider and context-consuming hooks.
+ */
+interface ReactLikeWithContext extends ReactLike {
+    createContext<T>(defaultValue: T): ReactContext<T>;
+    useContext<T>(context: ReactContext<T>): T;
+    useMemo<T>(factory: () => T, deps: unknown[]): T;
+    createElement(type: unknown, props: unknown, ...children: unknown[]): any;
+}
+/** Minimal React context interface */
+interface ReactContext<T> {
+    Provider: unknown;
+    Consumer?: unknown;
+    displayName?: string;
+    /** Default value (used internally by React) */
+    _currentValue?: T;
+}
+/** Props for the RaisinProvider component */
+interface RaisinProviderProps {
+    client: RaisinClient;
+    repository?: string;
+    children?: unknown;
+}
+/** Value stored in the Raisin context */
+interface RaisinContextValue {
+    client: RaisinClient;
+    repository?: string;
+}
+/** Return type for useAuth() */
+interface UseAuthReturn {
+    user: IdentityUser | null;
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    login: (email: string, password: string, repository: string) => Promise<IdentityUser>;
+    register: (email: string, password: string, repository: string, displayName?: string) => Promise<IdentityUser>;
+    logout: (options?: {
+        disconnect?: boolean;
+        reconnect?: boolean;
+    }) => Promise<void>;
+    initSession: (repository: string) => Promise<IdentityUser | null>;
+}
+/** Return type for useConnection() */
+interface UseConnectionReturn {
+    state: ConnectionState;
+    isConnected: boolean;
+    isReady: boolean;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+}
+/** Options for useSql() */
+interface UseSqlOptions {
+    enabled?: boolean;
+    repository?: string;
+    refetchOnReconnect?: boolean;
+    realtime?: {
+        workspace: string;
+        eventTypes?: string[];
+        path?: string;
+        nodeType?: string;
+    };
+}
+/** Return type for useSql<T>() */
+interface UseSqlReturn<T> {
+    data: T[] | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+/** Options for useSubscription() */
+interface UseSubscriptionOptions extends SubscriptionFilters {
+    enabled?: boolean;
+}
+
+/**
+ * React flow adapter for RaisinDB.
+ *
+ * Provides a `useFlow` hook that wraps the FlowClient for executing
+ * and monitoring RaisinDB flows in React applications. Returns reactive
+ * state tracking flow events, status, and providing control actions.
+ *
+ * Since this SDK package does not depend on React, the hook accepts
+ * React as a parameter via the `ReactLike` interface.
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useFlow } from '@raisindb/client';
+ *
+ * function OrderProcessor() {
+ *   const flow = useFlow(React, {
+ *     baseUrl: 'http://localhost:8081',
+ *     repository: 'my-repo',
+ *     authManager,
+ *   });
+ *
+ *   const handleRun = async () => {
+ *     await flow.run('/flows/process-order', { orderId: 'ord-123' });
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={handleRun} disabled={flow.isRunning}>Run</button>
+ *       <p>Status: {flow.status}</p>
+ *       {flow.events.map((e, i) => <div key={i}>{e.type}</div>)}
+ *       {flow.error && <p className="error">{flow.error}</p>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+
+/** Options for creating the FlowClient within useFlow */
+interface UseFlowOptions {
+    /**
+     * Pre-configured Database instance (from `client.database()`).
+     * When provided, `baseUrl`, `repository`, `authManager`, and `flowsApi` are derived
+     * automatically — no manual wiring needed.
+     */
+    database?: Database;
+    /** Base HTTP URL of the RaisinDB server */
+    baseUrl?: string;
+    /** Repository name */
+    repository?: string;
+    /** Auth manager for token access */
+    authManager?: AuthManager;
+    /** Additional FlowClient options */
+    clientOptions?: FlowClientOptions;
+    /** Optional FlowsApi for WebSocket-based flow operations */
+    flowsApi?: FlowsApi;
+}
+/** Flow execution status */
+type FlowStatus = 'idle' | 'running' | 'waiting' | 'completed' | 'failed';
+/** Return value from the useFlow hook */
+interface UseFlowReturn {
+    /** Collected flow execution events */
+    events: FlowExecutionEvent[];
+    /** Current flow status */
+    status: FlowStatus;
+    /** Whether a flow is currently running */
+    isRunning: boolean;
+    /** Current error, if any */
+    error: string | null;
+    /** Output from the completed flow */
+    output: unknown | null;
+    /** Current flow instance ID, if running */
+    instanceId: string | null;
+    /** Run a flow by path with optional input data */
+    run: (flowPath: string, input?: Record<string, unknown>) => Promise<void>;
+    /** Resume a waiting flow with data */
+    resume: (data: unknown) => Promise<void>;
+    /** Reset the hook state (clear events, status, error) */
+    reset: () => void;
+}
+/**
+ * React hook for executing and monitoring RaisinDB flows.
+ *
+ * Manages the full lifecycle: starting a flow, streaming events,
+ * resuming waiting flows, and tracking completion status.
+ * Auto-cleans up on component unmount.
+ *
+ * @param react - The React instance (pass `React` or `{ useState, useEffect, useRef, useCallback }`)
+ * @param options - Flow client options (baseUrl, repository, authManager, etc.)
+ * @returns Reactive flow state and action functions
+ *
+ * @example
+ * ```tsx
+ * import React from 'react';
+ * import { useFlow } from '@raisindb/client';
+ *
+ * function DataPipeline() {
+ *   const flow = useFlow(React, {
+ *     baseUrl: 'http://localhost:8081',
+ *     repository: 'my-repo',
+ *     authManager,
+ *   });
+ *
+ *   return (
+ *     <div>
+ *       <button onClick={() => flow.run('/flows/etl', { source: 'api' })}>
+ *         Start Pipeline
+ *       </button>
+ *       <p>Status: {flow.status}</p>
+ *       <p>Events: {flow.events.length}</p>
+ *       {flow.status === 'waiting' && (
+ *         <button onClick={() => flow.resume({ approved: true })}>
+ *           Approve
+ *         </button>
+ *       )}
+ *       {flow.output && <pre>{JSON.stringify(flow.output, null, 2)}</pre>}
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+declare function useFlow(react: ReactLike, options: UseFlowOptions): UseFlowReturn;
+
+/**
+ * React integration layer for RaisinDB.
+ *
+ * Provides a `createRaisinReact(React)` factory that returns a Provider
+ * component and hooks for auth, connection, queries, and subscriptions.
+ *
+ * Uses the "bring your own React" pattern to avoid a peer dependency.
+ *
+ * @example
+ * ```ts
+ * import React from 'react';
+ * import { RaisinClient, LocalStorageTokenStorage, createRaisinReact } from '@raisindb/client';
+ *
+ * const client = new RaisinClient('wss://localhost:8443/sys/default/myrepo', {
+ *   tokenStorage: new LocalStorageTokenStorage('myrepo'),
+ * });
+ *
+ * export const {
+ *   RaisinProvider, useAuth, useConnection, useDatabase,
+ *   useSql, useSubscription, useConversation, useFlow,
+ * } = createRaisinReact(React);
+ * ```
+ */
+
+interface RaisinReact {
+    RaisinProvider: (props: RaisinProviderProps) => any;
+    useRaisinClient: () => RaisinClient;
+    useDatabase: (repository?: string) => Database;
+    useAuth: () => UseAuthReturn;
+    useConnection: () => UseConnectionReturn;
+    useSql: <T = Record<string, unknown>>(sql: string, params?: unknown[], options?: UseSqlOptions) => UseSqlReturn<T>;
+    useSubscription: (options: UseSubscriptionOptions, callback: (event: EventMessage) => void) => void;
+    useConversation: (options: ConversationStoreOptions) => UseConversationReturn;
+    useConversationList: (options: ConversationListStoreOptions) => UseConversationListReturn;
+    useFlow: (options: UseFlowOptions) => UseFlowReturn;
+}
+/**
+ * Create the full React integration for RaisinDB.
+ *
+ * Accepts a React instance and returns a Provider component plus hooks.
+ * The React instance must include `createContext`, `useContext`, `useMemo`,
+ * and `createElement` in addition to the base `ReactLike` interface.
+ *
+ * @param react - The React instance
+ * @returns Provider component and hooks
+ */
+declare function createRaisinReact(react: ReactLikeWithContext): RaisinReact;
+
+export { type FlowStatus as F, type ReactLike as R, type UseConversationReturn as U, useConversationList as a, type UseConversationListReturn as b, useFlow as c, type UseFlowOptions as d, type UseFlowReturn as e, createRaisinReact as f, type RaisinReact as g, type ReactLikeWithContext as h, type RaisinProviderProps as i, type RaisinContextValue as j, type UseAuthReturn as k, type UseConnectionReturn as l, type UseSqlOptions as m, type UseSqlReturn as n, type UseSubscriptionOptions as o, useConversation as u };