@raisindb/client 0.1.5 → 0.1.17

package/dist/vue.d.mts

@@ -0,0 +1,197 @@
+import { I as IdentityUser, C as ConnectionState, a as ConversationStoreSnapshot, b as ChatMessage, T as ToolCallInfo, P as PlanProjection, c as ConversationStore, d as ConversationListItem, e as ConversationListStore, R as RaisinClient, D as Database, S as SubscriptionFilters, E as EventMessage, f as ConversationStoreOptions, g as ConversationListStoreOptions } from './conversation-list-store-CNcVagmw.mjs';
+import { S as SqlAdapterOptions } from './svelte-sql-CgT-Ij-P.mjs';
+import 'events';
+import 'fs/promises';
+
+/** Minimal mutable ref shape (structural subset of Vue's `Ref<T>`) */
+interface VueRef<T> {
+    value: T;
+}
+/**
+ * Minimal read-only ref shape (structural subset of Vue's `ComputedRef<T>`).
+ *
+ * At runtime these ARE real `vue.computed()` refs (created via the module you
+ * pass to `createRaisinVue`), but the declared type is structural — it lacks
+ * Vue's branded `ComputedRefSymbol`, so TypeScript will not accept it as a
+ * `watch()` / `watchEffect()` source directly. Wrap it in a getter instead:
+ *
+ * ```ts
+ * const { data } = useSql(db, sql);
+ * watch(() => data.value, (rows) => { ... });   // ✅ typechecks
+ * watch(data, (rows) => { ... });               // ❌ TS2345 (works at runtime)
+ * ```
+ */
+interface VueComputedRef<T> {
+    readonly value: T;
+}
+/**
+ * Minimal subset of the Vue 3 API needed by the composables.
+ *
+ * The SDK follows the same "bring your own framework" pattern as the React
+ * integration (`createRaisinReact(React)`): instead of importing from `vue`
+ * (which would make Vue a dependency of the SDK), you pass the Vue module —
+ * or any object with compatible `ref` / `computed` / `onUnmounted` — to
+ * `createRaisinVue()`.
+ *
+ * The signatures are intentionally loose (`any`-based `ref`) so the real
+ * `import * as vue from 'vue'` module is structurally assignable despite
+ * Vue's `UnwrapRef` generics. Composables re-narrow the types internally.
+ */
+interface VueLike {
+    /** Vue's `ref()` (or `shallowRef()`); snapshots are replaced wholesale. */
+    ref(value: any): {
+        value: any;
+    };
+    /** Vue's `computed()` */
+    computed<T>(getter: () => T): VueComputedRef<T>;
+    /** Vue's `onUnmounted()` lifecycle hook */
+    onUnmounted(fn: () => void): void;
+}
+/** Return type for useAuth() */
+interface UseAuthReturn {
+    user: VueComputedRef<IdentityUser | null>;
+    isAuthenticated: VueComputedRef<boolean>;
+    isLoading: VueComputedRef<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: VueComputedRef<ConnectionState>;
+    isConnected: VueComputedRef<boolean>;
+    isReady: VueComputedRef<boolean>;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+}
+/** Return type for useSql<T>() */
+interface UseSqlReturn<T> {
+    data: VueComputedRef<T[] | null>;
+    isLoading: VueComputedRef<boolean>;
+    error: VueComputedRef<Error | null>;
+    refetch: () => Promise<void>;
+}
+/** Handle returned by useSubscription() */
+interface UseSubscriptionReturn {
+    /** Stop receiving events (also called automatically on unmount) */
+    unsubscribe: () => void;
+}
+/** Return type for useConversation() */
+interface UseConversationReturn {
+    conversation: VueComputedRef<ConversationStoreSnapshot['conversation']>;
+    messages: VueComputedRef<ChatMessage[]>;
+    isStreaming: VueComputedRef<boolean>;
+    isWaiting: VueComputedRef<boolean>;
+    streamingText: VueComputedRef<string>;
+    error: VueComputedRef<string | null>;
+    activeToolCalls: VueComputedRef<ToolCallInfo[]>;
+    plans: VueComputedRef<PlanProjection[]>;
+    isLoading: VueComputedRef<boolean>;
+    conversationPath: VueComputedRef<string | null>;
+    sendMessage: (content: string) => Promise<void>;
+    approvePlan: (planPath: string) => Promise<void>;
+    rejectPlan: (planPath: string, feedback?: string) => Promise<void>;
+    stop: () => void;
+    loadMessages: () => Promise<ChatMessage[]>;
+    /** The underlying store, for advanced use */
+    store: ConversationStore;
+}
+/** Return type for useConversationList() */
+interface UseConversationListReturn {
+    conversations: VueComputedRef<ConversationListItem[]>;
+    totalUnreadCount: VueComputedRef<number>;
+    isLoading: VueComputedRef<boolean>;
+    error: VueComputedRef<string | null>;
+    createConversation: (options: {
+        participant: string;
+        subject?: string;
+        input?: Record<string, unknown>;
+    }) => Promise<ConversationListItem>;
+    deleteConversation: (conversationPath: string) => Promise<void>;
+    markAsRead: (conversationPath: string) => Promise<void>;
+    /** Reload the list from the server */
+    refresh: () => Promise<void>;
+    /** The underlying store, for advanced use */
+    store: ConversationListStore;
+}
+
+/**
+ * Vue 3 integration layer for RaisinDB.
+ *
+ * Provides a `createRaisinVue(vue)` factory that returns composables for
+ * auth, connection, SQL queries, node-event subscriptions, and the
+ * conversation stores.
+ *
+ * Uses the same "bring your own framework" pattern as the React integration
+ * (`createRaisinReact(React)`): the SDK never imports `vue`, so Vue stays
+ * out of the SDK's dependency graph and the main `.` bundle. You pass the
+ * Vue module (its `ref`, `computed`, and `onUnmounted` are all that is
+ * needed) once at setup time.
+ *
+ * Each composable creates its underlying store/adapter when called and
+ * destroys it automatically in `onUnmounted`, so call them from
+ * `setup()` / `<script setup>`.
+ *
+ * @example
+ * ```ts
+ * // lib/raisin-vue.ts
+ * import * as vue from 'vue';
+ * import { RaisinClient, LocalStorageTokenStorage } from '@raisindb/client';
+ * import { createRaisinVue } from '@raisindb/client/vue';
+ *
+ * export const client = new RaisinClient('ws://localhost:8081/sys/default/myrepo', {
+ *   tokenStorage: new LocalStorageTokenStorage('myapp'),
+ * });
+ * export const db = client.database('myrepo');
+ *
+ * export const {
+ *   useAuth, useConnection, useSql, useSubscription,
+ *   useConversation, useConversationList,
+ * } = createRaisinVue(vue);
+ * ```
+ *
+ * @example In a component:
+ * ```vue
+ * <script setup lang="ts">
+ * import { client, db, useConversation } from '@/lib/raisin-vue';
+ *
+ * const chat = useConversation({
+ *   database: db,
+ *   createOptions: { participant: '/agents/support' },
+ * });
+ * </script>
+ *
+ * <template>
+ *   <div v-for="(m, i) in chat.messages.value" :key="i">{{ m.content }}</div>
+ *   <p v-if="chat.isStreaming.value">{{ chat.streamingText.value }}</p>
+ * </template>
+ * ```
+ */
+
+interface RaisinVue {
+    /** Reactive auth state + login/register/logout/initSession actions */
+    useAuth: (client: RaisinClient) => UseAuthReturn;
+    /** Reactive connection state (state / isConnected / isReady) */
+    useConnection: (client: RaisinClient) => UseConnectionReturn;
+    /** Run a SQL query with reactive data/isLoading/error + optional realtime refetch */
+    useSql: <T = Record<string, unknown>>(database: Database, sql: string, params?: unknown[], options?: SqlAdapterOptions) => UseSqlReturn<T>;
+    /** Subscribe to node events; unsubscribes automatically on unmount */
+    useSubscription: (database: Database, filters: SubscriptionFilters, callback: (event: EventMessage) => void) => UseSubscriptionReturn;
+    /** Bind a ConversationStore (chat: messages, streaming, tool calls, plans) */
+    useConversation: (options: ConversationStoreOptions) => UseConversationReturn;
+    /** Bind a ConversationListStore (inbox-style conversation list) */
+    useConversationList: (options: ConversationListStoreOptions) => UseConversationListReturn;
+}
+/**
+ * Create the full Vue 3 integration for RaisinDB.
+ *
+ * @param vue - The Vue module (or any object providing `ref`, `computed`, `onUnmounted`)
+ * @returns The set of composables
+ */
+declare function createRaisinVue(vue: VueLike): RaisinVue;
+
+export { type RaisinVue, type UseAuthReturn, type UseConnectionReturn, type UseConversationListReturn, type UseConversationReturn, SqlAdapterOptions as UseSqlOptions, type UseSqlReturn, type UseSubscriptionReturn, type VueComputedRef, type VueLike, type VueRef, createRaisinVue };

package/dist/vue.d.ts

@@ -0,0 +1,197 @@
+import { I as IdentityUser, C as ConnectionState, a as ConversationStoreSnapshot, b as ChatMessage, T as ToolCallInfo, P as PlanProjection, c as ConversationStore, d as ConversationListItem, e as ConversationListStore, R as RaisinClient, D as Database, S as SubscriptionFilters, E as EventMessage, f as ConversationStoreOptions, g as ConversationListStoreOptions } from './conversation-list-store-CNcVagmw.js';
+import { S as SqlAdapterOptions } from './svelte-sql-62EaYoeM.js';
+import 'events';
+import 'fs/promises';
+
+/** Minimal mutable ref shape (structural subset of Vue's `Ref<T>`) */
+interface VueRef<T> {
+    value: T;
+}
+/**
+ * Minimal read-only ref shape (structural subset of Vue's `ComputedRef<T>`).
+ *
+ * At runtime these ARE real `vue.computed()` refs (created via the module you
+ * pass to `createRaisinVue`), but the declared type is structural — it lacks
+ * Vue's branded `ComputedRefSymbol`, so TypeScript will not accept it as a
+ * `watch()` / `watchEffect()` source directly. Wrap it in a getter instead:
+ *
+ * ```ts
+ * const { data } = useSql(db, sql);
+ * watch(() => data.value, (rows) => { ... });   // ✅ typechecks
+ * watch(data, (rows) => { ... });               // ❌ TS2345 (works at runtime)
+ * ```
+ */
+interface VueComputedRef<T> {
+    readonly value: T;
+}
+/**
+ * Minimal subset of the Vue 3 API needed by the composables.
+ *
+ * The SDK follows the same "bring your own framework" pattern as the React
+ * integration (`createRaisinReact(React)`): instead of importing from `vue`
+ * (which would make Vue a dependency of the SDK), you pass the Vue module —
+ * or any object with compatible `ref` / `computed` / `onUnmounted` — to
+ * `createRaisinVue()`.
+ *
+ * The signatures are intentionally loose (`any`-based `ref`) so the real
+ * `import * as vue from 'vue'` module is structurally assignable despite
+ * Vue's `UnwrapRef` generics. Composables re-narrow the types internally.
+ */
+interface VueLike {
+    /** Vue's `ref()` (or `shallowRef()`); snapshots are replaced wholesale. */
+    ref(value: any): {
+        value: any;
+    };
+    /** Vue's `computed()` */
+    computed<T>(getter: () => T): VueComputedRef<T>;
+    /** Vue's `onUnmounted()` lifecycle hook */
+    onUnmounted(fn: () => void): void;
+}
+/** Return type for useAuth() */
+interface UseAuthReturn {
+    user: VueComputedRef<IdentityUser | null>;
+    isAuthenticated: VueComputedRef<boolean>;
+    isLoading: VueComputedRef<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: VueComputedRef<ConnectionState>;
+    isConnected: VueComputedRef<boolean>;
+    isReady: VueComputedRef<boolean>;
+    connect: () => Promise<void>;
+    disconnect: () => void;
+}
+/** Return type for useSql<T>() */
+interface UseSqlReturn<T> {
+    data: VueComputedRef<T[] | null>;
+    isLoading: VueComputedRef<boolean>;
+    error: VueComputedRef<Error | null>;
+    refetch: () => Promise<void>;
+}
+/** Handle returned by useSubscription() */
+interface UseSubscriptionReturn {
+    /** Stop receiving events (also called automatically on unmount) */
+    unsubscribe: () => void;
+}
+/** Return type for useConversation() */
+interface UseConversationReturn {
+    conversation: VueComputedRef<ConversationStoreSnapshot['conversation']>;
+    messages: VueComputedRef<ChatMessage[]>;
+    isStreaming: VueComputedRef<boolean>;
+    isWaiting: VueComputedRef<boolean>;
+    streamingText: VueComputedRef<string>;
+    error: VueComputedRef<string | null>;
+    activeToolCalls: VueComputedRef<ToolCallInfo[]>;
+    plans: VueComputedRef<PlanProjection[]>;
+    isLoading: VueComputedRef<boolean>;
+    conversationPath: VueComputedRef<string | null>;
+    sendMessage: (content: string) => Promise<void>;
+    approvePlan: (planPath: string) => Promise<void>;
+    rejectPlan: (planPath: string, feedback?: string) => Promise<void>;
+    stop: () => void;
+    loadMessages: () => Promise<ChatMessage[]>;
+    /** The underlying store, for advanced use */
+    store: ConversationStore;
+}
+/** Return type for useConversationList() */
+interface UseConversationListReturn {
+    conversations: VueComputedRef<ConversationListItem[]>;
+    totalUnreadCount: VueComputedRef<number>;
+    isLoading: VueComputedRef<boolean>;
+    error: VueComputedRef<string | null>;
+    createConversation: (options: {
+        participant: string;
+        subject?: string;
+        input?: Record<string, unknown>;
+    }) => Promise<ConversationListItem>;
+    deleteConversation: (conversationPath: string) => Promise<void>;
+    markAsRead: (conversationPath: string) => Promise<void>;
+    /** Reload the list from the server */
+    refresh: () => Promise<void>;
+    /** The underlying store, for advanced use */
+    store: ConversationListStore;
+}
+
+/**
+ * Vue 3 integration layer for RaisinDB.
+ *
+ * Provides a `createRaisinVue(vue)` factory that returns composables for
+ * auth, connection, SQL queries, node-event subscriptions, and the
+ * conversation stores.
+ *
+ * Uses the same "bring your own framework" pattern as the React integration
+ * (`createRaisinReact(React)`): the SDK never imports `vue`, so Vue stays
+ * out of the SDK's dependency graph and the main `.` bundle. You pass the
+ * Vue module (its `ref`, `computed`, and `onUnmounted` are all that is
+ * needed) once at setup time.
+ *
+ * Each composable creates its underlying store/adapter when called and
+ * destroys it automatically in `onUnmounted`, so call them from
+ * `setup()` / `<script setup>`.
+ *
+ * @example
+ * ```ts
+ * // lib/raisin-vue.ts
+ * import * as vue from 'vue';
+ * import { RaisinClient, LocalStorageTokenStorage } from '@raisindb/client';
+ * import { createRaisinVue } from '@raisindb/client/vue';
+ *
+ * export const client = new RaisinClient('ws://localhost:8081/sys/default/myrepo', {
+ *   tokenStorage: new LocalStorageTokenStorage('myapp'),
+ * });
+ * export const db = client.database('myrepo');
+ *
+ * export const {
+ *   useAuth, useConnection, useSql, useSubscription,
+ *   useConversation, useConversationList,
+ * } = createRaisinVue(vue);
+ * ```
+ *
+ * @example In a component:
+ * ```vue
+ * <script setup lang="ts">
+ * import { client, db, useConversation } from '@/lib/raisin-vue';
+ *
+ * const chat = useConversation({
+ *   database: db,
+ *   createOptions: { participant: '/agents/support' },
+ * });
+ * </script>
+ *
+ * <template>
+ *   <div v-for="(m, i) in chat.messages.value" :key="i">{{ m.content }}</div>
+ *   <p v-if="chat.isStreaming.value">{{ chat.streamingText.value }}</p>
+ * </template>
+ * ```
+ */
+
+interface RaisinVue {
+    /** Reactive auth state + login/register/logout/initSession actions */
+    useAuth: (client: RaisinClient) => UseAuthReturn;
+    /** Reactive connection state (state / isConnected / isReady) */
+    useConnection: (client: RaisinClient) => UseConnectionReturn;
+    /** Run a SQL query with reactive data/isLoading/error + optional realtime refetch */
+    useSql: <T = Record<string, unknown>>(database: Database, sql: string, params?: unknown[], options?: SqlAdapterOptions) => UseSqlReturn<T>;
+    /** Subscribe to node events; unsubscribes automatically on unmount */
+    useSubscription: (database: Database, filters: SubscriptionFilters, callback: (event: EventMessage) => void) => UseSubscriptionReturn;
+    /** Bind a ConversationStore (chat: messages, streaming, tool calls, plans) */
+    useConversation: (options: ConversationStoreOptions) => UseConversationReturn;
+    /** Bind a ConversationListStore (inbox-style conversation list) */
+    useConversationList: (options: ConversationListStoreOptions) => UseConversationListReturn;
+}
+/**
+ * Create the full Vue 3 integration for RaisinDB.
+ *
+ * @param vue - The Vue module (or any object providing `ref`, `computed`, `onUnmounted`)
+ * @returns The set of composables
+ */
+declare function createRaisinVue(vue: VueLike): RaisinVue;
+
+export { type RaisinVue, type UseAuthReturn, type UseConnectionReturn, type UseConversationListReturn, type UseConversationReturn, SqlAdapterOptions as UseSqlOptions, type UseSqlReturn, type UseSubscriptionReturn, type VueComputedRef, type VueLike, type VueRef, createRaisinVue };