@tanstack/vue-db 0.0.16 → 0.0.18

package/dist/cjs/useLiveQuery.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useLiveQuery.cjs","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import {\n  computed,\n  getCurrentInstance,\n  onUnmounted,\n  reactive,\n  ref,\n  toValue,\n  watchEffect,\n} from \"vue\"\nimport { createLiveQueryCollection } from \"@tanstack/db\"\nimport type {\n  ChangeMessage,\n  Collection,\n  CollectionStatus,\n  Context,\n  GetResult,\n  InitialQueryBuilder,\n  LiveQueryCollectionConfig,\n  QueryBuilder,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\nexport interface UseLiveQueryReturn<T extends object> {\n  state: ComputedRef<Map<string | number, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, string | number, {}>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\nexport interface UseLiveQueryReturnWithCollection<\n  T extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n> {\n  state: ComputedRef<Map<TKey, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, TKey, TUtils>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\n// Overload 1: Accept just the query function\nexport function useLiveQuery<TContext extends Context>(\n  queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n// Overload 2: Accept config object\nexport function useLiveQuery<TContext extends Context>(\n  config: LiveQueryCollectionConfig<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n// Overload 3: Accept pre-created live query collection (can be reactive)\nexport function useLiveQuery<\n  TResult extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n>(\n  liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>\n): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>\n\n// Implementation\nexport function useLiveQuery(\n  configOrQueryOrCollection: any,\n  deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<any> | UseLiveQueryReturnWithCollection<any, any, any> {\n  const collection = computed(() => {\n    // First check if the original parameter might be a ref/getter\n    // by seeing if toValue returns something different than the original\n    let unwrappedParam = configOrQueryOrCollection\n    try {\n      const potentiallyUnwrapped = toValue(configOrQueryOrCollection)\n      if (potentiallyUnwrapped !== configOrQueryOrCollection) {\n        unwrappedParam = potentiallyUnwrapped\n      }\n    } catch {\n      // If toValue fails, use original parameter\n      unwrappedParam = configOrQueryOrCollection\n    }\n\n    // Check if it's already a collection by checking for specific collection methods\n    const isCollection =\n      unwrappedParam &&\n      typeof unwrappedParam === `object` &&\n      typeof unwrappedParam.subscribeChanges === `function` &&\n      typeof unwrappedParam.startSyncImmediate === `function` &&\n      typeof unwrappedParam.id === `string`\n\n    if (isCollection) {\n      // It's already a collection, ensure sync is started for Vue hooks\n      unwrappedParam.startSyncImmediate()\n      return unwrappedParam\n    }\n\n    // Reference deps to make computed reactive to them\n    deps.forEach((dep) => toValue(dep))\n\n    // Ensure we always start sync for Vue hooks\n    if (typeof unwrappedParam === `function`) {\n      return createLiveQueryCollection({\n        query: unwrappedParam,\n        startSync: true,\n      })\n    } else {\n      return createLiveQueryCollection({\n        ...unwrappedParam,\n        startSync: true,\n      })\n    }\n  })\n\n  // Reactive state that gets updated granularly through change events\n  const state = reactive(new Map<string | number, any>())\n\n  // Reactive data array that maintains sorted order\n  const internalData = reactive<Array<any>>([])\n\n  // Computed wrapper for the data to match expected return type\n  const data = computed(() => internalData)\n\n  // Track collection status reactively\n  const status = ref(collection.value.status)\n\n  // Helper to sync data array from collection in correct order\n  const syncDataFromCollection = (\n    currentCollection: Collection<any, any, any>\n  ) => {\n    internalData.length = 0\n    internalData.push(...Array.from(currentCollection.values()))\n  }\n\n  // Track current unsubscribe function\n  let currentUnsubscribe: (() => void) | null = null\n\n  // Watch for collection changes and subscribe to updates\n  watchEffect((onInvalidate) => {\n    const currentCollection = collection.value\n\n    // Update status ref whenever the effect runs\n    status.value = currentCollection.status\n\n    // Clean up previous subscription\n    if (currentUnsubscribe) {\n      currentUnsubscribe()\n    }\n\n    // Initialize state with current collection data\n    state.clear()\n    for (const [key, value] of currentCollection.entries()) {\n      state.set(key, value)\n    }\n\n    // Initialize data array in correct order\n    syncDataFromCollection(currentCollection)\n\n    // Subscribe to collection changes with granular updates\n    currentUnsubscribe = currentCollection.subscribeChanges(\n      (changes: Array<ChangeMessage<any>>) => {\n        // Apply each change individually to the reactive state\n        for (const change of changes) {\n          switch (change.type) {\n            case `insert`:\n            case `update`:\n              state.set(change.key, change.value)\n              break\n            case `delete`:\n              state.delete(change.key)\n              break\n          }\n        }\n\n        // Update the data array to maintain sorted order\n        syncDataFromCollection(currentCollection)\n        // Update status ref on every change\n        status.value = currentCollection.status\n      }\n    )\n\n    // Preload collection data if not already started\n    if (currentCollection.status === `idle`) {\n      currentCollection.preload().catch(console.error)\n    }\n\n    // Cleanup when effect is invalidated\n    onInvalidate(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n        currentUnsubscribe = null\n      }\n    })\n  })\n\n  // Cleanup on unmount (only if we're in a component context)\n  const instance = getCurrentInstance()\n  if (instance) {\n    onUnmounted(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n      }\n    })\n  }\n\n  return {\n    state: computed(() => state),\n    data,\n    collection: computed(() => collection.value),\n    status: computed(() => status.value),\n    isLoading: computed(\n      () => status.value === `loading` || status.value === `initialCommit`\n    ),\n    isReady: computed(() => status.value === `ready`),\n    isIdle: computed(() => status.value === `idle`),\n    isError: computed(() => status.value === `error`),\n    isCleanedUp: computed(() => status.value === `cleaned-up`),\n  }\n}\n"],"names":["computed","toValue","createLiveQueryCollection","reactive","ref","watchEffect","getCurrentInstance","onUnmounted"],"mappings":";;;;AAwEO,SAAS,aACd,2BACA,OAAyC,IACkC;AACrE,QAAA,aAAaA,IAAAA,SAAS,MAAM;AAGhC,QAAI,iBAAiB;AACjB,QAAA;AACI,YAAA,uBAAuBC,YAAQ,yBAAyB;AAC9D,UAAI,yBAAyB,2BAA2B;AACrC,yBAAA;AAAA,MAAA;AAAA,IACnB,QACM;AAEW,uBAAA;AAAA,IAAA;AAInB,UAAM,eACJ,kBACA,OAAO,mBAAmB,YAC1B,OAAO,eAAe,qBAAqB,cAC3C,OAAO,eAAe,uBAAuB,cAC7C,OAAO,eAAe,OAAO;AAE/B,QAAI,cAAc;AAEhB,qBAAe,mBAAmB;AAC3B,aAAA;AAAA,IAAA;AAIT,SAAK,QAAQ,CAAC,QAAQA,IAAA,QAAQ,GAAG,CAAC;AAG9B,QAAA,OAAO,mBAAmB,YAAY;AACxC,aAAOC,6BAA0B;AAAA,QAC/B,OAAO;AAAA,QACP,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA,OACI;AACL,aAAOA,6BAA0B;AAAA,QAC/B,GAAG;AAAA,QACH,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA;AAAA,EACH,CACD;AAGD,QAAM,QAAQC,IAAAA,SAAa,oBAAA,KAA2B;AAGhD,QAAA,eAAeA,IAAqB,SAAA,EAAE;AAGtC,QAAA,OAAOH,aAAS,MAAM,YAAY;AAGxC,QAAM,SAASI,IAAA,IAAI,WAAW,MAAM,MAAM;AAGpC,QAAA,yBAAyB,CAC7B,sBACG;AACH,iBAAa,SAAS;AACtB,iBAAa,KAAK,GAAG,MAAM,KAAK,kBAAkB,OAAA,CAAQ,CAAC;AAAA,EAC7D;AAGA,MAAI,qBAA0C;AAG9CC,MAAA,YAAY,CAAC,iBAAiB;AAC5B,UAAM,oBAAoB,WAAW;AAGrC,WAAO,QAAQ,kBAAkB;AAGjC,QAAI,oBAAoB;AACH,yBAAA;AAAA,IAAA;AAIrB,UAAM,MAAM;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,kBAAkB,WAAW;AAChD,YAAA,IAAI,KAAK,KAAK;AAAA,IAAA;AAItB,2BAAuB,iBAAiB;AAGxC,yBAAqB,kBAAkB;AAAA,MACrC,CAAC,YAAuC;AAEtC,mBAAW,UAAU,SAAS;AAC5B,kBAAQ,OAAO,MAAM;AAAA,YACnB,KAAK;AAAA,YACL,KAAK;AACH,oBAAM,IAAI,OAAO,KAAK,OAAO,KAAK;AAClC;AAAA,YACF,KAAK;AACG,oBAAA,OAAO,OAAO,GAAG;AACvB;AAAA,UAAA;AAAA,QACJ;AAIF,+BAAuB,iBAAiB;AAExC,eAAO,QAAQ,kBAAkB;AAAA,MAAA;AAAA,IAErC;AAGI,QAAA,kBAAkB,WAAW,QAAQ;AACvC,wBAAkB,QAAQ,EAAE,MAAM,QAAQ,KAAK;AAAA,IAAA;AAIjD,iBAAa,MAAM;AACjB,UAAI,oBAAoB;AACH,2BAAA;AACE,6BAAA;AAAA,MAAA;AAAA,IACvB,CACD;AAAA,EAAA,CACF;AAGD,QAAM,WAAWC,IAAAA,mBAAmB;AACpC,MAAI,UAAU;AACZC,QAAAA,YAAY,MAAM;AAChB,UAAI,oBAAoB;AACH,2BAAA;AAAA,MAAA;AAAA,IACrB,CACD;AAAA,EAAA;AAGI,SAAA;AAAA,IACL,OAAOP,IAAAA,SAAS,MAAM,KAAK;AAAA,IAC3B;AAAA,IACA,YAAYA,IAAA,SAAS,MAAM,WAAW,KAAK;AAAA,IAC3C,QAAQA,IAAA,SAAS,MAAM,OAAO,KAAK;AAAA,IACnC,WAAWA,IAAA;AAAA,MACT,MAAM,OAAO,UAAU,aAAa,OAAO,UAAU;AAAA,IACvD;AAAA,IACA,SAASA,IAAA,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,QAAQA,IAAA,SAAS,MAAM,OAAO,UAAU,MAAM;AAAA,IAC9C,SAASA,IAAA,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,aAAaA,IAAAA,SAAS,MAAM,OAAO,UAAU,YAAY;AAAA,EAC3D;AACF;;"}
+{"version":3,"file":"useLiveQuery.cjs","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import {\n  computed,\n  getCurrentInstance,\n  onUnmounted,\n  reactive,\n  ref,\n  toValue,\n  watchEffect,\n} from \"vue\"\nimport { createLiveQueryCollection } from \"@tanstack/db\"\nimport type {\n  ChangeMessage,\n  Collection,\n  CollectionStatus,\n  Context,\n  GetResult,\n  InitialQueryBuilder,\n  LiveQueryCollectionConfig,\n  QueryBuilder,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\n/**\n * Return type for useLiveQuery hook\n * @property state - Reactive Map of query results (key → item)\n * @property data - Reactive array of query results in order\n * @property collection - The underlying query collection instance\n * @property status - Current query status\n * @property isLoading - True while initial query data is loading\n * @property isReady - True when query has received first data and is ready\n * @property isIdle - True when query hasn't started yet\n * @property isError - True when query encountered an error\n * @property isCleanedUp - True when query has been cleaned up\n */\nexport interface UseLiveQueryReturn<T extends object> {\n  state: ComputedRef<Map<string | number, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, string | number, {}>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\nexport interface UseLiveQueryReturnWithCollection<\n  T extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n> {\n  state: ComputedRef<Map<TKey, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, TKey, TUtils>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\n/**\n * Create a live query using a query function\n * @param queryFn - Query function that defines what data to fetch\n * @param deps - Array of reactive dependencies that trigger query re-execution when changed\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Basic query with object syntax\n * const { data, isLoading } = useLiveQuery((q) =>\n *   q.from({ todos: todosCollection })\n *    .where(({ todos }) => eq(todos.completed, false))\n *    .select(({ todos }) => ({ id: todos.id, text: todos.text }))\n * )\n *\n * @example\n * // With reactive dependencies\n * const minPriority = ref(5)\n * const { data, state } = useLiveQuery(\n *   (q) => q.from({ todos: todosCollection })\n *          .where(({ todos }) => gt(todos.priority, minPriority.value)),\n *   [minPriority] // Re-run when minPriority changes\n * )\n *\n * @example\n * // Join pattern\n * const { data } = useLiveQuery((q) =>\n *   q.from({ issues: issueCollection })\n *    .join({ persons: personCollection }, ({ issues, persons }) =>\n *      eq(issues.userId, persons.id)\n *    )\n *    .select(({ issues, persons }) => ({\n *      id: issues.id,\n *      title: issues.title,\n *      userName: persons.name\n *    }))\n * )\n *\n * @example\n * // Handle loading and error states in template\n * const { data, isLoading, isError, status } = useLiveQuery((q) =>\n *   q.from({ todos: todoCollection })\n * )\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Error: {{ status }}</div>\n * // <ul v-else>\n * //   <li v-for=\"todo in data\" :key=\"todo.id\">{{ todo.text }}</li>\n * // </ul>\n */\n// Overload 1: Accept just the query function\nexport function useLiveQuery<TContext extends Context>(\n  queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n/**\n * Create a live query using configuration object\n * @param config - Configuration object with query and options\n * @param deps - Array of reactive dependencies that trigger query re-execution when changed\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Basic config object usage\n * const { data, status } = useLiveQuery({\n *   query: (q) => q.from({ todos: todosCollection }),\n *   gcTime: 60000\n * })\n *\n * @example\n * // With reactive dependencies\n * const filter = ref('active')\n * const { data, isReady } = useLiveQuery({\n *   query: (q) => q.from({ todos: todosCollection })\n *                  .where(({ todos }) => eq(todos.status, filter.value))\n * }, [filter])\n *\n * @example\n * // Handle all states uniformly\n * const { data, isLoading, isReady, isError } = useLiveQuery({\n *   query: (q) => q.from({ items: itemCollection })\n * })\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Something went wrong</div>\n * // <div v-else-if=\"!isReady\">Preparing...</div>\n * // <div v-else>{{ data.length }} items loaded</div>\n */\n// Overload 2: Accept config object\nexport function useLiveQuery<TContext extends Context>(\n  config: LiveQueryCollectionConfig<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n/**\n * Subscribe to an existing query collection (can be reactive)\n * @param liveQueryCollection - Pre-created query collection to subscribe to (can be a ref)\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Using pre-created query collection\n * const myLiveQuery = createLiveQueryCollection((q) =>\n *   q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))\n * )\n * const { data, collection } = useLiveQuery(myLiveQuery)\n *\n * @example\n * // Reactive query collection reference\n * const selectedQuery = ref(todosQuery)\n * const { data, collection } = useLiveQuery(selectedQuery)\n *\n * // Switch queries reactively\n * selectedQuery.value = archiveQuery\n *\n * @example\n * // Access query collection methods directly\n * const { data, collection, isReady } = useLiveQuery(existingQuery)\n *\n * // Use underlying collection for mutations\n * const handleToggle = (id) => {\n *   collection.value.update(id, draft => { draft.completed = !draft.completed })\n * }\n *\n * @example\n * // Handle states consistently\n * const { data, isLoading, isError } = useLiveQuery(sharedQuery)\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Error loading data</div>\n * // <div v-else>\n * //   <Item v-for=\"item in data\" :key=\"item.id\" v-bind=\"item\" />\n * // </div>\n */\n// Overload 3: Accept pre-created live query collection (can be reactive)\nexport function useLiveQuery<\n  TResult extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n>(\n  liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>\n): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>\n\n// Implementation\nexport function useLiveQuery(\n  configOrQueryOrCollection: any,\n  deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<any> | UseLiveQueryReturnWithCollection<any, any, any> {\n  const collection = computed(() => {\n    // First check if the original parameter might be a ref/getter\n    // by seeing if toValue returns something different than the original\n    let unwrappedParam = configOrQueryOrCollection\n    try {\n      const potentiallyUnwrapped = toValue(configOrQueryOrCollection)\n      if (potentiallyUnwrapped !== configOrQueryOrCollection) {\n        unwrappedParam = potentiallyUnwrapped\n      }\n    } catch {\n      // If toValue fails, use original parameter\n      unwrappedParam = configOrQueryOrCollection\n    }\n\n    // Check if it's already a collection by checking for specific collection methods\n    const isCollection =\n      unwrappedParam &&\n      typeof unwrappedParam === `object` &&\n      typeof unwrappedParam.subscribeChanges === `function` &&\n      typeof unwrappedParam.startSyncImmediate === `function` &&\n      typeof unwrappedParam.id === `string`\n\n    if (isCollection) {\n      // It's already a collection, ensure sync is started for Vue hooks\n      unwrappedParam.startSyncImmediate()\n      return unwrappedParam\n    }\n\n    // Reference deps to make computed reactive to them\n    deps.forEach((dep) => toValue(dep))\n\n    // Ensure we always start sync for Vue hooks\n    if (typeof unwrappedParam === `function`) {\n      return createLiveQueryCollection({\n        query: unwrappedParam,\n        startSync: true,\n      })\n    } else {\n      return createLiveQueryCollection({\n        ...unwrappedParam,\n        startSync: true,\n      })\n    }\n  })\n\n  // Reactive state that gets updated granularly through change events\n  const state = reactive(new Map<string | number, any>())\n\n  // Reactive data array that maintains sorted order\n  const internalData = reactive<Array<any>>([])\n\n  // Computed wrapper for the data to match expected return type\n  const data = computed(() => internalData)\n\n  // Track collection status reactively\n  const status = ref(collection.value.status)\n\n  // Helper to sync data array from collection in correct order\n  const syncDataFromCollection = (\n    currentCollection: Collection<any, any, any>\n  ) => {\n    internalData.length = 0\n    internalData.push(...Array.from(currentCollection.values()))\n  }\n\n  // Track current unsubscribe function\n  let currentUnsubscribe: (() => void) | null = null\n\n  // Watch for collection changes and subscribe to updates\n  watchEffect((onInvalidate) => {\n    const currentCollection = collection.value\n\n    // Update status ref whenever the effect runs\n    status.value = currentCollection.status\n\n    // Clean up previous subscription\n    if (currentUnsubscribe) {\n      currentUnsubscribe()\n    }\n\n    // Initialize state with current collection data\n    state.clear()\n    for (const [key, value] of currentCollection.entries()) {\n      state.set(key, value)\n    }\n\n    // Initialize data array in correct order\n    syncDataFromCollection(currentCollection)\n\n    // Subscribe to collection changes with granular updates\n    currentUnsubscribe = currentCollection.subscribeChanges(\n      (changes: Array<ChangeMessage<any>>) => {\n        // Apply each change individually to the reactive state\n        for (const change of changes) {\n          switch (change.type) {\n            case `insert`:\n            case `update`:\n              state.set(change.key, change.value)\n              break\n            case `delete`:\n              state.delete(change.key)\n              break\n          }\n        }\n\n        // Update the data array to maintain sorted order\n        syncDataFromCollection(currentCollection)\n        // Update status ref on every change\n        status.value = currentCollection.status\n      }\n    )\n\n    // Preload collection data if not already started\n    if (currentCollection.status === `idle`) {\n      currentCollection.preload().catch(console.error)\n    }\n\n    // Cleanup when effect is invalidated\n    onInvalidate(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n        currentUnsubscribe = null\n      }\n    })\n  })\n\n  // Cleanup on unmount (only if we're in a component context)\n  const instance = getCurrentInstance()\n  if (instance) {\n    onUnmounted(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n      }\n    })\n  }\n\n  return {\n    state: computed(() => state),\n    data,\n    collection: computed(() => collection.value),\n    status: computed(() => status.value),\n    isLoading: computed(\n      () => status.value === `loading` || status.value === `initialCommit`\n    ),\n    isReady: computed(() => status.value === `ready`),\n    isIdle: computed(() => status.value === `idle`),\n    isError: computed(() => status.value === `error`),\n    isCleanedUp: computed(() => status.value === `cleaned-up`),\n  }\n}\n"],"names":["computed","toValue","createLiveQueryCollection","reactive","ref","watchEffect","getCurrentInstance","onUnmounted"],"mappings":";;;;AA4MO,SAAS,aACd,2BACA,OAAyC,IACkC;AAC3E,QAAM,aAAaA,IAAAA,SAAS,MAAM;AAGhC,QAAI,iBAAiB;AACrB,QAAI;AACF,YAAM,uBAAuBC,IAAAA,QAAQ,yBAAyB;AAC9D,UAAI,yBAAyB,2BAA2B;AACtD,yBAAiB;AAAA,MACnB;AAAA,IACF,QAAQ;AAEN,uBAAiB;AAAA,IACnB;AAGA,UAAM,eACJ,kBACA,OAAO,mBAAmB,YAC1B,OAAO,eAAe,qBAAqB,cAC3C,OAAO,eAAe,uBAAuB,cAC7C,OAAO,eAAe,OAAO;AAE/B,QAAI,cAAc;AAEhB,qBAAe,mBAAA;AACf,aAAO;AAAA,IACT;AAGA,SAAK,QAAQ,CAAC,QAAQA,IAAAA,QAAQ,GAAG,CAAC;AAGlC,QAAI,OAAO,mBAAmB,YAAY;AACxC,aAAOC,6BAA0B;AAAA,QAC/B,OAAO;AAAA,QACP,WAAW;AAAA,MAAA,CACZ;AAAA,IACH,OAAO;AACL,aAAOA,6BAA0B;AAAA,QAC/B,GAAG;AAAA,QACH,WAAW;AAAA,MAAA,CACZ;AAAA,IACH;AAAA,EACF,CAAC;AAGD,QAAM,QAAQC,IAAAA,SAAS,oBAAI,KAA2B;AAGtD,QAAM,eAAeA,IAAAA,SAAqB,EAAE;AAG5C,QAAM,OAAOH,aAAS,MAAM,YAAY;AAGxC,QAAM,SAASI,IAAAA,IAAI,WAAW,MAAM,MAAM;AAG1C,QAAM,yBAAyB,CAC7B,sBACG;AACH,iBAAa,SAAS;AACtB,iBAAa,KAAK,GAAG,MAAM,KAAK,kBAAkB,OAAA,CAAQ,CAAC;AAAA,EAC7D;AAGA,MAAI,qBAA0C;AAG9CC,MAAAA,YAAY,CAAC,iBAAiB;AAC5B,UAAM,oBAAoB,WAAW;AAGrC,WAAO,QAAQ,kBAAkB;AAGjC,QAAI,oBAAoB;AACtB,yBAAA;AAAA,IACF;AAGA,UAAM,MAAA;AACN,eAAW,CAAC,KAAK,KAAK,KAAK,kBAAkB,WAAW;AACtD,YAAM,IAAI,KAAK,KAAK;AAAA,IACtB;AAGA,2BAAuB,iBAAiB;AAGxC,yBAAqB,kBAAkB;AAAA,MACrC,CAAC,YAAuC;AAEtC,mBAAW,UAAU,SAAS;AAC5B,kBAAQ,OAAO,MAAA;AAAA,YACb,KAAK;AAAA,YACL,KAAK;AACH,oBAAM,IAAI,OAAO,KAAK,OAAO,KAAK;AAClC;AAAA,YACF,KAAK;AACH,oBAAM,OAAO,OAAO,GAAG;AACvB;AAAA,UAAA;AAAA,QAEN;AAGA,+BAAuB,iBAAiB;AAExC,eAAO,QAAQ,kBAAkB;AAAA,MACnC;AAAA,IAAA;AAIF,QAAI,kBAAkB,WAAW,QAAQ;AACvC,wBAAkB,QAAA,EAAU,MAAM,QAAQ,KAAK;AAAA,IACjD;AAGA,iBAAa,MAAM;AACjB,UAAI,oBAAoB;AACtB,2BAAA;AACA,6BAAqB;AAAA,MACvB;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAGD,QAAM,WAAWC,IAAAA,mBAAA;AACjB,MAAI,UAAU;AACZC,QAAAA,YAAY,MAAM;AAChB,UAAI,oBAAoB;AACtB,2BAAA;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAOP,IAAAA,SAAS,MAAM,KAAK;AAAA,IAC3B;AAAA,IACA,YAAYA,IAAAA,SAAS,MAAM,WAAW,KAAK;AAAA,IAC3C,QAAQA,IAAAA,SAAS,MAAM,OAAO,KAAK;AAAA,IACnC,WAAWA,IAAAA;AAAAA,MACT,MAAM,OAAO,UAAU,aAAa,OAAO,UAAU;AAAA,IAAA;AAAA,IAEvD,SAASA,IAAAA,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,QAAQA,IAAAA,SAAS,MAAM,OAAO,UAAU,MAAM;AAAA,IAC9C,SAASA,IAAAA,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,aAAaA,IAAAA,SAAS,MAAM,OAAO,UAAU,YAAY;AAAA,EAAA;AAE7D;;"}

package/dist/cjs/useLiveQuery.d.cts

@@ -1,5 +1,17 @@
 import { Collection, CollectionStatus, Context, GetResult, InitialQueryBuilder, LiveQueryCollectionConfig, QueryBuilder } from '@tanstack/db';
 import { ComputedRef, MaybeRefOrGetter } from 'vue';
+/**
+ * Return type for useLiveQuery hook
+ * @property state - Reactive Map of query results (key → item)
+ * @property data - Reactive array of query results in order
+ * @property collection - The underlying query collection instance
+ * @property status - Current query status
+ * @property isLoading - True while initial query data is loading
+ * @property isReady - True when query has received first data and is ready
+ * @property isIdle - True when query hasn't started yet
+ * @property isError - True when query encountered an error
+ * @property isCleanedUp - True when query has been cleaned up
+ */
 export interface UseLiveQueryReturn<T extends object> {
     state: ComputedRef<Map<string | number, T>>;
     data: ComputedRef<Array<T>>;
@@ -22,6 +34,126 @@ export interface UseLiveQueryReturnWithCollection<T extends object, TKey extends
     isError: ComputedRef<boolean>;
     isCleanedUp: ComputedRef<boolean>;
 }
+/**
+ * Create a live query using a query function
+ * @param queryFn - Query function that defines what data to fetch
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic query with object syntax
+ * const { data, isLoading } = useLiveQuery((q) =>
+ *   q.from({ todos: todosCollection })
+ *    .where(({ todos }) => eq(todos.completed, false))
+ *    .select(({ todos }) => ({ id: todos.id, text: todos.text }))
+ * )
+ *
+ * @example
+ * // With reactive dependencies
+ * const minPriority = ref(5)
+ * const { data, state } = useLiveQuery(
+ *   (q) => q.from({ todos: todosCollection })
+ *          .where(({ todos }) => gt(todos.priority, minPriority.value)),
+ *   [minPriority] // Re-run when minPriority changes
+ * )
+ *
+ * @example
+ * // Join pattern
+ * const { data } = useLiveQuery((q) =>
+ *   q.from({ issues: issueCollection })
+ *    .join({ persons: personCollection }, ({ issues, persons }) =>
+ *      eq(issues.userId, persons.id)
+ *    )
+ *    .select(({ issues, persons }) => ({
+ *      id: issues.id,
+ *      title: issues.title,
+ *      userName: persons.name
+ *    }))
+ * )
+ *
+ * @example
+ * // Handle loading and error states in template
+ * const { data, isLoading, isError, status } = useLiveQuery((q) =>
+ *   q.from({ todos: todoCollection })
+ * )
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error: {{ status }}</div>
+ * // <ul v-else>
+ * //   <li v-for="todo in data" :key="todo.id">{{ todo.text }}</li>
+ * // </ul>
+ */
 export declare function useLiveQuery<TContext extends Context>(queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<GetResult<TContext>>;
+/**
+ * Create a live query using configuration object
+ * @param config - Configuration object with query and options
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic config object usage
+ * const { data, status } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection }),
+ *   gcTime: 60000
+ * })
+ *
+ * @example
+ * // With reactive dependencies
+ * const filter = ref('active')
+ * const { data, isReady } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection })
+ *                  .where(({ todos }) => eq(todos.status, filter.value))
+ * }, [filter])
+ *
+ * @example
+ * // Handle all states uniformly
+ * const { data, isLoading, isReady, isError } = useLiveQuery({
+ *   query: (q) => q.from({ items: itemCollection })
+ * })
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Something went wrong</div>
+ * // <div v-else-if="!isReady">Preparing...</div>
+ * // <div v-else>{{ data.length }} items loaded</div>
+ */
 export declare function useLiveQuery<TContext extends Context>(config: LiveQueryCollectionConfig<TContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<GetResult<TContext>>;
+/**
+ * Subscribe to an existing query collection (can be reactive)
+ * @param liveQueryCollection - Pre-created query collection to subscribe to (can be a ref)
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Using pre-created query collection
+ * const myLiveQuery = createLiveQueryCollection((q) =>
+ *   q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
+ * )
+ * const { data, collection } = useLiveQuery(myLiveQuery)
+ *
+ * @example
+ * // Reactive query collection reference
+ * const selectedQuery = ref(todosQuery)
+ * const { data, collection } = useLiveQuery(selectedQuery)
+ *
+ * // Switch queries reactively
+ * selectedQuery.value = archiveQuery
+ *
+ * @example
+ * // Access query collection methods directly
+ * const { data, collection, isReady } = useLiveQuery(existingQuery)
+ *
+ * // Use underlying collection for mutations
+ * const handleToggle = (id) => {
+ *   collection.value.update(id, draft => { draft.completed = !draft.completed })
+ * }
+ *
+ * @example
+ * // Handle states consistently
+ * const { data, isLoading, isError } = useLiveQuery(sharedQuery)
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error loading data</div>
+ * // <div v-else>
+ * //   <Item v-for="item in data" :key="item.id" v-bind="item" />
+ * // </div>
+ */
 export declare function useLiveQuery<TResult extends object, TKey extends string | number, TUtils extends Record<string, any>>(liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>;

package/dist/esm/useLiveQuery.d.ts

@@ -1,5 +1,17 @@
 import { Collection, CollectionStatus, Context, GetResult, InitialQueryBuilder, LiveQueryCollectionConfig, QueryBuilder } from '@tanstack/db';
 import { ComputedRef, MaybeRefOrGetter } from 'vue';
+/**
+ * Return type for useLiveQuery hook
+ * @property state - Reactive Map of query results (key → item)
+ * @property data - Reactive array of query results in order
+ * @property collection - The underlying query collection instance
+ * @property status - Current query status
+ * @property isLoading - True while initial query data is loading
+ * @property isReady - True when query has received first data and is ready
+ * @property isIdle - True when query hasn't started yet
+ * @property isError - True when query encountered an error
+ * @property isCleanedUp - True when query has been cleaned up
+ */
 export interface UseLiveQueryReturn<T extends object> {
     state: ComputedRef<Map<string | number, T>>;
     data: ComputedRef<Array<T>>;
@@ -22,6 +34,126 @@ export interface UseLiveQueryReturnWithCollection<T extends object, TKey extends
     isError: ComputedRef<boolean>;
     isCleanedUp: ComputedRef<boolean>;
 }
+/**
+ * Create a live query using a query function
+ * @param queryFn - Query function that defines what data to fetch
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic query with object syntax
+ * const { data, isLoading } = useLiveQuery((q) =>
+ *   q.from({ todos: todosCollection })
+ *    .where(({ todos }) => eq(todos.completed, false))
+ *    .select(({ todos }) => ({ id: todos.id, text: todos.text }))
+ * )
+ *
+ * @example
+ * // With reactive dependencies
+ * const minPriority = ref(5)
+ * const { data, state } = useLiveQuery(
+ *   (q) => q.from({ todos: todosCollection })
+ *          .where(({ todos }) => gt(todos.priority, minPriority.value)),
+ *   [minPriority] // Re-run when minPriority changes
+ * )
+ *
+ * @example
+ * // Join pattern
+ * const { data } = useLiveQuery((q) =>
+ *   q.from({ issues: issueCollection })
+ *    .join({ persons: personCollection }, ({ issues, persons }) =>
+ *      eq(issues.userId, persons.id)
+ *    )
+ *    .select(({ issues, persons }) => ({
+ *      id: issues.id,
+ *      title: issues.title,
+ *      userName: persons.name
+ *    }))
+ * )
+ *
+ * @example
+ * // Handle loading and error states in template
+ * const { data, isLoading, isError, status } = useLiveQuery((q) =>
+ *   q.from({ todos: todoCollection })
+ * )
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error: {{ status }}</div>
+ * // <ul v-else>
+ * //   <li v-for="todo in data" :key="todo.id">{{ todo.text }}</li>
+ * // </ul>
+ */
 export declare function useLiveQuery<TContext extends Context>(queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<GetResult<TContext>>;
+/**
+ * Create a live query using configuration object
+ * @param config - Configuration object with query and options
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic config object usage
+ * const { data, status } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection }),
+ *   gcTime: 60000
+ * })
+ *
+ * @example
+ * // With reactive dependencies
+ * const filter = ref('active')
+ * const { data, isReady } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection })
+ *                  .where(({ todos }) => eq(todos.status, filter.value))
+ * }, [filter])
+ *
+ * @example
+ * // Handle all states uniformly
+ * const { data, isLoading, isReady, isError } = useLiveQuery({
+ *   query: (q) => q.from({ items: itemCollection })
+ * })
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Something went wrong</div>
+ * // <div v-else-if="!isReady">Preparing...</div>
+ * // <div v-else>{{ data.length }} items loaded</div>
+ */
 export declare function useLiveQuery<TContext extends Context>(config: LiveQueryCollectionConfig<TContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<GetResult<TContext>>;
+/**
+ * Subscribe to an existing query collection (can be reactive)
+ * @param liveQueryCollection - Pre-created query collection to subscribe to (can be a ref)
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Using pre-created query collection
+ * const myLiveQuery = createLiveQueryCollection((q) =>
+ *   q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
+ * )
+ * const { data, collection } = useLiveQuery(myLiveQuery)
+ *
+ * @example
+ * // Reactive query collection reference
+ * const selectedQuery = ref(todosQuery)
+ * const { data, collection } = useLiveQuery(selectedQuery)
+ *
+ * // Switch queries reactively
+ * selectedQuery.value = archiveQuery
+ *
+ * @example
+ * // Access query collection methods directly
+ * const { data, collection, isReady } = useLiveQuery(existingQuery)
+ *
+ * // Use underlying collection for mutations
+ * const handleToggle = (id) => {
+ *   collection.value.update(id, draft => { draft.completed = !draft.completed })
+ * }
+ *
+ * @example
+ * // Handle states consistently
+ * const { data, isLoading, isError } = useLiveQuery(sharedQuery)
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error loading data</div>
+ * // <div v-else>
+ * //   <Item v-for="item in data" :key="item.id" v-bind="item" />
+ * // </div>
+ */
 export declare function useLiveQuery<TResult extends object, TKey extends string | number, TUtils extends Record<string, any>>(liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>;

package/dist/esm/useLiveQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLiveQuery.js","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import {\n  computed,\n  getCurrentInstance,\n  onUnmounted,\n  reactive,\n  ref,\n  toValue,\n  watchEffect,\n} from \"vue\"\nimport { createLiveQueryCollection } from \"@tanstack/db\"\nimport type {\n  ChangeMessage,\n  Collection,\n  CollectionStatus,\n  Context,\n  GetResult,\n  InitialQueryBuilder,\n  LiveQueryCollectionConfig,\n  QueryBuilder,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\nexport interface UseLiveQueryReturn<T extends object> {\n  state: ComputedRef<Map<string | number, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, string | number, {}>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\nexport interface UseLiveQueryReturnWithCollection<\n  T extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n> {\n  state: ComputedRef<Map<TKey, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, TKey, TUtils>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\n// Overload 1: Accept just the query function\nexport function useLiveQuery<TContext extends Context>(\n  queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n// Overload 2: Accept config object\nexport function useLiveQuery<TContext extends Context>(\n  config: LiveQueryCollectionConfig<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n// Overload 3: Accept pre-created live query collection (can be reactive)\nexport function useLiveQuery<\n  TResult extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n>(\n  liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>\n): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>\n\n// Implementation\nexport function useLiveQuery(\n  configOrQueryOrCollection: any,\n  deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<any> | UseLiveQueryReturnWithCollection<any, any, any> {\n  const collection = computed(() => {\n    // First check if the original parameter might be a ref/getter\n    // by seeing if toValue returns something different than the original\n    let unwrappedParam = configOrQueryOrCollection\n    try {\n      const potentiallyUnwrapped = toValue(configOrQueryOrCollection)\n      if (potentiallyUnwrapped !== configOrQueryOrCollection) {\n        unwrappedParam = potentiallyUnwrapped\n      }\n    } catch {\n      // If toValue fails, use original parameter\n      unwrappedParam = configOrQueryOrCollection\n    }\n\n    // Check if it's already a collection by checking for specific collection methods\n    const isCollection =\n      unwrappedParam &&\n      typeof unwrappedParam === `object` &&\n      typeof unwrappedParam.subscribeChanges === `function` &&\n      typeof unwrappedParam.startSyncImmediate === `function` &&\n      typeof unwrappedParam.id === `string`\n\n    if (isCollection) {\n      // It's already a collection, ensure sync is started for Vue hooks\n      unwrappedParam.startSyncImmediate()\n      return unwrappedParam\n    }\n\n    // Reference deps to make computed reactive to them\n    deps.forEach((dep) => toValue(dep))\n\n    // Ensure we always start sync for Vue hooks\n    if (typeof unwrappedParam === `function`) {\n      return createLiveQueryCollection({\n        query: unwrappedParam,\n        startSync: true,\n      })\n    } else {\n      return createLiveQueryCollection({\n        ...unwrappedParam,\n        startSync: true,\n      })\n    }\n  })\n\n  // Reactive state that gets updated granularly through change events\n  const state = reactive(new Map<string | number, any>())\n\n  // Reactive data array that maintains sorted order\n  const internalData = reactive<Array<any>>([])\n\n  // Computed wrapper for the data to match expected return type\n  const data = computed(() => internalData)\n\n  // Track collection status reactively\n  const status = ref(collection.value.status)\n\n  // Helper to sync data array from collection in correct order\n  const syncDataFromCollection = (\n    currentCollection: Collection<any, any, any>\n  ) => {\n    internalData.length = 0\n    internalData.push(...Array.from(currentCollection.values()))\n  }\n\n  // Track current unsubscribe function\n  let currentUnsubscribe: (() => void) | null = null\n\n  // Watch for collection changes and subscribe to updates\n  watchEffect((onInvalidate) => {\n    const currentCollection = collection.value\n\n    // Update status ref whenever the effect runs\n    status.value = currentCollection.status\n\n    // Clean up previous subscription\n    if (currentUnsubscribe) {\n      currentUnsubscribe()\n    }\n\n    // Initialize state with current collection data\n    state.clear()\n    for (const [key, value] of currentCollection.entries()) {\n      state.set(key, value)\n    }\n\n    // Initialize data array in correct order\n    syncDataFromCollection(currentCollection)\n\n    // Subscribe to collection changes with granular updates\n    currentUnsubscribe = currentCollection.subscribeChanges(\n      (changes: Array<ChangeMessage<any>>) => {\n        // Apply each change individually to the reactive state\n        for (const change of changes) {\n          switch (change.type) {\n            case `insert`:\n            case `update`:\n              state.set(change.key, change.value)\n              break\n            case `delete`:\n              state.delete(change.key)\n              break\n          }\n        }\n\n        // Update the data array to maintain sorted order\n        syncDataFromCollection(currentCollection)\n        // Update status ref on every change\n        status.value = currentCollection.status\n      }\n    )\n\n    // Preload collection data if not already started\n    if (currentCollection.status === `idle`) {\n      currentCollection.preload().catch(console.error)\n    }\n\n    // Cleanup when effect is invalidated\n    onInvalidate(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n        currentUnsubscribe = null\n      }\n    })\n  })\n\n  // Cleanup on unmount (only if we're in a component context)\n  const instance = getCurrentInstance()\n  if (instance) {\n    onUnmounted(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n      }\n    })\n  }\n\n  return {\n    state: computed(() => state),\n    data,\n    collection: computed(() => collection.value),\n    status: computed(() => status.value),\n    isLoading: computed(\n      () => status.value === `loading` || status.value === `initialCommit`\n    ),\n    isReady: computed(() => status.value === `ready`),\n    isIdle: computed(() => status.value === `idle`),\n    isError: computed(() => status.value === `error`),\n    isCleanedUp: computed(() => status.value === `cleaned-up`),\n  }\n}\n"],"names":[],"mappings":";;AAwEO,SAAS,aACd,2BACA,OAAyC,IACkC;AACrE,QAAA,aAAa,SAAS,MAAM;AAGhC,QAAI,iBAAiB;AACjB,QAAA;AACI,YAAA,uBAAuB,QAAQ,yBAAyB;AAC9D,UAAI,yBAAyB,2BAA2B;AACrC,yBAAA;AAAA,MAAA;AAAA,IACnB,QACM;AAEW,uBAAA;AAAA,IAAA;AAInB,UAAM,eACJ,kBACA,OAAO,mBAAmB,YAC1B,OAAO,eAAe,qBAAqB,cAC3C,OAAO,eAAe,uBAAuB,cAC7C,OAAO,eAAe,OAAO;AAE/B,QAAI,cAAc;AAEhB,qBAAe,mBAAmB;AAC3B,aAAA;AAAA,IAAA;AAIT,SAAK,QAAQ,CAAC,QAAQ,QAAQ,GAAG,CAAC;AAG9B,QAAA,OAAO,mBAAmB,YAAY;AACxC,aAAO,0BAA0B;AAAA,QAC/B,OAAO;AAAA,QACP,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA,OACI;AACL,aAAO,0BAA0B;AAAA,QAC/B,GAAG;AAAA,QACH,WAAW;AAAA,MAAA,CACZ;AAAA,IAAA;AAAA,EACH,CACD;AAGD,QAAM,QAAQ,SAAa,oBAAA,KAA2B;AAGhD,QAAA,eAAe,SAAqB,EAAE;AAGtC,QAAA,OAAO,SAAS,MAAM,YAAY;AAGxC,QAAM,SAAS,IAAI,WAAW,MAAM,MAAM;AAGpC,QAAA,yBAAyB,CAC7B,sBACG;AACH,iBAAa,SAAS;AACtB,iBAAa,KAAK,GAAG,MAAM,KAAK,kBAAkB,OAAA,CAAQ,CAAC;AAAA,EAC7D;AAGA,MAAI,qBAA0C;AAG9C,cAAY,CAAC,iBAAiB;AAC5B,UAAM,oBAAoB,WAAW;AAGrC,WAAO,QAAQ,kBAAkB;AAGjC,QAAI,oBAAoB;AACH,yBAAA;AAAA,IAAA;AAIrB,UAAM,MAAM;AACZ,eAAW,CAAC,KAAK,KAAK,KAAK,kBAAkB,WAAW;AAChD,YAAA,IAAI,KAAK,KAAK;AAAA,IAAA;AAItB,2BAAuB,iBAAiB;AAGxC,yBAAqB,kBAAkB;AAAA,MACrC,CAAC,YAAuC;AAEtC,mBAAW,UAAU,SAAS;AAC5B,kBAAQ,OAAO,MAAM;AAAA,YACnB,KAAK;AAAA,YACL,KAAK;AACH,oBAAM,IAAI,OAAO,KAAK,OAAO,KAAK;AAClC;AAAA,YACF,KAAK;AACG,oBAAA,OAAO,OAAO,GAAG;AACvB;AAAA,UAAA;AAAA,QACJ;AAIF,+BAAuB,iBAAiB;AAExC,eAAO,QAAQ,kBAAkB;AAAA,MAAA;AAAA,IAErC;AAGI,QAAA,kBAAkB,WAAW,QAAQ;AACvC,wBAAkB,QAAQ,EAAE,MAAM,QAAQ,KAAK;AAAA,IAAA;AAIjD,iBAAa,MAAM;AACjB,UAAI,oBAAoB;AACH,2BAAA;AACE,6BAAA;AAAA,MAAA;AAAA,IACvB,CACD;AAAA,EAAA,CACF;AAGD,QAAM,WAAW,mBAAmB;AACpC,MAAI,UAAU;AACZ,gBAAY,MAAM;AAChB,UAAI,oBAAoB;AACH,2BAAA;AAAA,MAAA;AAAA,IACrB,CACD;AAAA,EAAA;AAGI,SAAA;AAAA,IACL,OAAO,SAAS,MAAM,KAAK;AAAA,IAC3B;AAAA,IACA,YAAY,SAAS,MAAM,WAAW,KAAK;AAAA,IAC3C,QAAQ,SAAS,MAAM,OAAO,KAAK;AAAA,IACnC,WAAW;AAAA,MACT,MAAM,OAAO,UAAU,aAAa,OAAO,UAAU;AAAA,IACvD;AAAA,IACA,SAAS,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,QAAQ,SAAS,MAAM,OAAO,UAAU,MAAM;AAAA,IAC9C,SAAS,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,aAAa,SAAS,MAAM,OAAO,UAAU,YAAY;AAAA,EAC3D;AACF;"}
+{"version":3,"file":"useLiveQuery.js","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import {\n  computed,\n  getCurrentInstance,\n  onUnmounted,\n  reactive,\n  ref,\n  toValue,\n  watchEffect,\n} from \"vue\"\nimport { createLiveQueryCollection } from \"@tanstack/db\"\nimport type {\n  ChangeMessage,\n  Collection,\n  CollectionStatus,\n  Context,\n  GetResult,\n  InitialQueryBuilder,\n  LiveQueryCollectionConfig,\n  QueryBuilder,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\n/**\n * Return type for useLiveQuery hook\n * @property state - Reactive Map of query results (key → item)\n * @property data - Reactive array of query results in order\n * @property collection - The underlying query collection instance\n * @property status - Current query status\n * @property isLoading - True while initial query data is loading\n * @property isReady - True when query has received first data and is ready\n * @property isIdle - True when query hasn't started yet\n * @property isError - True when query encountered an error\n * @property isCleanedUp - True when query has been cleaned up\n */\nexport interface UseLiveQueryReturn<T extends object> {\n  state: ComputedRef<Map<string | number, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, string | number, {}>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\nexport interface UseLiveQueryReturnWithCollection<\n  T extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n> {\n  state: ComputedRef<Map<TKey, T>>\n  data: ComputedRef<Array<T>>\n  collection: ComputedRef<Collection<T, TKey, TUtils>>\n  status: ComputedRef<CollectionStatus>\n  isLoading: ComputedRef<boolean>\n  isReady: ComputedRef<boolean>\n  isIdle: ComputedRef<boolean>\n  isError: ComputedRef<boolean>\n  isCleanedUp: ComputedRef<boolean>\n}\n\n/**\n * Create a live query using a query function\n * @param queryFn - Query function that defines what data to fetch\n * @param deps - Array of reactive dependencies that trigger query re-execution when changed\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Basic query with object syntax\n * const { data, isLoading } = useLiveQuery((q) =>\n *   q.from({ todos: todosCollection })\n *    .where(({ todos }) => eq(todos.completed, false))\n *    .select(({ todos }) => ({ id: todos.id, text: todos.text }))\n * )\n *\n * @example\n * // With reactive dependencies\n * const minPriority = ref(5)\n * const { data, state } = useLiveQuery(\n *   (q) => q.from({ todos: todosCollection })\n *          .where(({ todos }) => gt(todos.priority, minPriority.value)),\n *   [minPriority] // Re-run when minPriority changes\n * )\n *\n * @example\n * // Join pattern\n * const { data } = useLiveQuery((q) =>\n *   q.from({ issues: issueCollection })\n *    .join({ persons: personCollection }, ({ issues, persons }) =>\n *      eq(issues.userId, persons.id)\n *    )\n *    .select(({ issues, persons }) => ({\n *      id: issues.id,\n *      title: issues.title,\n *      userName: persons.name\n *    }))\n * )\n *\n * @example\n * // Handle loading and error states in template\n * const { data, isLoading, isError, status } = useLiveQuery((q) =>\n *   q.from({ todos: todoCollection })\n * )\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Error: {{ status }}</div>\n * // <ul v-else>\n * //   <li v-for=\"todo in data\" :key=\"todo.id\">{{ todo.text }}</li>\n * // </ul>\n */\n// Overload 1: Accept just the query function\nexport function useLiveQuery<TContext extends Context>(\n  queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n/**\n * Create a live query using configuration object\n * @param config - Configuration object with query and options\n * @param deps - Array of reactive dependencies that trigger query re-execution when changed\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Basic config object usage\n * const { data, status } = useLiveQuery({\n *   query: (q) => q.from({ todos: todosCollection }),\n *   gcTime: 60000\n * })\n *\n * @example\n * // With reactive dependencies\n * const filter = ref('active')\n * const { data, isReady } = useLiveQuery({\n *   query: (q) => q.from({ todos: todosCollection })\n *                  .where(({ todos }) => eq(todos.status, filter.value))\n * }, [filter])\n *\n * @example\n * // Handle all states uniformly\n * const { data, isLoading, isReady, isError } = useLiveQuery({\n *   query: (q) => q.from({ items: itemCollection })\n * })\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Something went wrong</div>\n * // <div v-else-if=\"!isReady\">Preparing...</div>\n * // <div v-else>{{ data.length }} items loaded</div>\n */\n// Overload 2: Accept config object\nexport function useLiveQuery<TContext extends Context>(\n  config: LiveQueryCollectionConfig<TContext>,\n  deps?: Array<MaybeRefOrGetter<unknown>>\n): UseLiveQueryReturn<GetResult<TContext>>\n\n/**\n * Subscribe to an existing query collection (can be reactive)\n * @param liveQueryCollection - Pre-created query collection to subscribe to (can be a ref)\n * @returns Reactive object with query data, state, and status information\n * @example\n * // Using pre-created query collection\n * const myLiveQuery = createLiveQueryCollection((q) =>\n *   q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))\n * )\n * const { data, collection } = useLiveQuery(myLiveQuery)\n *\n * @example\n * // Reactive query collection reference\n * const selectedQuery = ref(todosQuery)\n * const { data, collection } = useLiveQuery(selectedQuery)\n *\n * // Switch queries reactively\n * selectedQuery.value = archiveQuery\n *\n * @example\n * // Access query collection methods directly\n * const { data, collection, isReady } = useLiveQuery(existingQuery)\n *\n * // Use underlying collection for mutations\n * const handleToggle = (id) => {\n *   collection.value.update(id, draft => { draft.completed = !draft.completed })\n * }\n *\n * @example\n * // Handle states consistently\n * const { data, isLoading, isError } = useLiveQuery(sharedQuery)\n *\n * // In template:\n * // <div v-if=\"isLoading\">Loading...</div>\n * // <div v-else-if=\"isError\">Error loading data</div>\n * // <div v-else>\n * //   <Item v-for=\"item in data\" :key=\"item.id\" v-bind=\"item\" />\n * // </div>\n */\n// Overload 3: Accept pre-created live query collection (can be reactive)\nexport function useLiveQuery<\n  TResult extends object,\n  TKey extends string | number,\n  TUtils extends Record<string, any>,\n>(\n  liveQueryCollection: MaybeRefOrGetter<Collection<TResult, TKey, TUtils>>\n): UseLiveQueryReturnWithCollection<TResult, TKey, TUtils>\n\n// Implementation\nexport function useLiveQuery(\n  configOrQueryOrCollection: any,\n  deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<any> | UseLiveQueryReturnWithCollection<any, any, any> {\n  const collection = computed(() => {\n    // First check if the original parameter might be a ref/getter\n    // by seeing if toValue returns something different than the original\n    let unwrappedParam = configOrQueryOrCollection\n    try {\n      const potentiallyUnwrapped = toValue(configOrQueryOrCollection)\n      if (potentiallyUnwrapped !== configOrQueryOrCollection) {\n        unwrappedParam = potentiallyUnwrapped\n      }\n    } catch {\n      // If toValue fails, use original parameter\n      unwrappedParam = configOrQueryOrCollection\n    }\n\n    // Check if it's already a collection by checking for specific collection methods\n    const isCollection =\n      unwrappedParam &&\n      typeof unwrappedParam === `object` &&\n      typeof unwrappedParam.subscribeChanges === `function` &&\n      typeof unwrappedParam.startSyncImmediate === `function` &&\n      typeof unwrappedParam.id === `string`\n\n    if (isCollection) {\n      // It's already a collection, ensure sync is started for Vue hooks\n      unwrappedParam.startSyncImmediate()\n      return unwrappedParam\n    }\n\n    // Reference deps to make computed reactive to them\n    deps.forEach((dep) => toValue(dep))\n\n    // Ensure we always start sync for Vue hooks\n    if (typeof unwrappedParam === `function`) {\n      return createLiveQueryCollection({\n        query: unwrappedParam,\n        startSync: true,\n      })\n    } else {\n      return createLiveQueryCollection({\n        ...unwrappedParam,\n        startSync: true,\n      })\n    }\n  })\n\n  // Reactive state that gets updated granularly through change events\n  const state = reactive(new Map<string | number, any>())\n\n  // Reactive data array that maintains sorted order\n  const internalData = reactive<Array<any>>([])\n\n  // Computed wrapper for the data to match expected return type\n  const data = computed(() => internalData)\n\n  // Track collection status reactively\n  const status = ref(collection.value.status)\n\n  // Helper to sync data array from collection in correct order\n  const syncDataFromCollection = (\n    currentCollection: Collection<any, any, any>\n  ) => {\n    internalData.length = 0\n    internalData.push(...Array.from(currentCollection.values()))\n  }\n\n  // Track current unsubscribe function\n  let currentUnsubscribe: (() => void) | null = null\n\n  // Watch for collection changes and subscribe to updates\n  watchEffect((onInvalidate) => {\n    const currentCollection = collection.value\n\n    // Update status ref whenever the effect runs\n    status.value = currentCollection.status\n\n    // Clean up previous subscription\n    if (currentUnsubscribe) {\n      currentUnsubscribe()\n    }\n\n    // Initialize state with current collection data\n    state.clear()\n    for (const [key, value] of currentCollection.entries()) {\n      state.set(key, value)\n    }\n\n    // Initialize data array in correct order\n    syncDataFromCollection(currentCollection)\n\n    // Subscribe to collection changes with granular updates\n    currentUnsubscribe = currentCollection.subscribeChanges(\n      (changes: Array<ChangeMessage<any>>) => {\n        // Apply each change individually to the reactive state\n        for (const change of changes) {\n          switch (change.type) {\n            case `insert`:\n            case `update`:\n              state.set(change.key, change.value)\n              break\n            case `delete`:\n              state.delete(change.key)\n              break\n          }\n        }\n\n        // Update the data array to maintain sorted order\n        syncDataFromCollection(currentCollection)\n        // Update status ref on every change\n        status.value = currentCollection.status\n      }\n    )\n\n    // Preload collection data if not already started\n    if (currentCollection.status === `idle`) {\n      currentCollection.preload().catch(console.error)\n    }\n\n    // Cleanup when effect is invalidated\n    onInvalidate(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n        currentUnsubscribe = null\n      }\n    })\n  })\n\n  // Cleanup on unmount (only if we're in a component context)\n  const instance = getCurrentInstance()\n  if (instance) {\n    onUnmounted(() => {\n      if (currentUnsubscribe) {\n        currentUnsubscribe()\n      }\n    })\n  }\n\n  return {\n    state: computed(() => state),\n    data,\n    collection: computed(() => collection.value),\n    status: computed(() => status.value),\n    isLoading: computed(\n      () => status.value === `loading` || status.value === `initialCommit`\n    ),\n    isReady: computed(() => status.value === `ready`),\n    isIdle: computed(() => status.value === `idle`),\n    isError: computed(() => status.value === `error`),\n    isCleanedUp: computed(() => status.value === `cleaned-up`),\n  }\n}\n"],"names":[],"mappings":";;AA4MO,SAAS,aACd,2BACA,OAAyC,IACkC;AAC3E,QAAM,aAAa,SAAS,MAAM;AAGhC,QAAI,iBAAiB;AACrB,QAAI;AACF,YAAM,uBAAuB,QAAQ,yBAAyB;AAC9D,UAAI,yBAAyB,2BAA2B;AACtD,yBAAiB;AAAA,MACnB;AAAA,IACF,QAAQ;AAEN,uBAAiB;AAAA,IACnB;AAGA,UAAM,eACJ,kBACA,OAAO,mBAAmB,YAC1B,OAAO,eAAe,qBAAqB,cAC3C,OAAO,eAAe,uBAAuB,cAC7C,OAAO,eAAe,OAAO;AAE/B,QAAI,cAAc;AAEhB,qBAAe,mBAAA;AACf,aAAO;AAAA,IACT;AAGA,SAAK,QAAQ,CAAC,QAAQ,QAAQ,GAAG,CAAC;AAGlC,QAAI,OAAO,mBAAmB,YAAY;AACxC,aAAO,0BAA0B;AAAA,QAC/B,OAAO;AAAA,QACP,WAAW;AAAA,MAAA,CACZ;AAAA,IACH,OAAO;AACL,aAAO,0BAA0B;AAAA,QAC/B,GAAG;AAAA,QACH,WAAW;AAAA,MAAA,CACZ;AAAA,IACH;AAAA,EACF,CAAC;AAGD,QAAM,QAAQ,SAAS,oBAAI,KAA2B;AAGtD,QAAM,eAAe,SAAqB,EAAE;AAG5C,QAAM,OAAO,SAAS,MAAM,YAAY;AAGxC,QAAM,SAAS,IAAI,WAAW,MAAM,MAAM;AAG1C,QAAM,yBAAyB,CAC7B,sBACG;AACH,iBAAa,SAAS;AACtB,iBAAa,KAAK,GAAG,MAAM,KAAK,kBAAkB,OAAA,CAAQ,CAAC;AAAA,EAC7D;AAGA,MAAI,qBAA0C;AAG9C,cAAY,CAAC,iBAAiB;AAC5B,UAAM,oBAAoB,WAAW;AAGrC,WAAO,QAAQ,kBAAkB;AAGjC,QAAI,oBAAoB;AACtB,yBAAA;AAAA,IACF;AAGA,UAAM,MAAA;AACN,eAAW,CAAC,KAAK,KAAK,KAAK,kBAAkB,WAAW;AACtD,YAAM,IAAI,KAAK,KAAK;AAAA,IACtB;AAGA,2BAAuB,iBAAiB;AAGxC,yBAAqB,kBAAkB;AAAA,MACrC,CAAC,YAAuC;AAEtC,mBAAW,UAAU,SAAS;AAC5B,kBAAQ,OAAO,MAAA;AAAA,YACb,KAAK;AAAA,YACL,KAAK;AACH,oBAAM,IAAI,OAAO,KAAK,OAAO,KAAK;AAClC;AAAA,YACF,KAAK;AACH,oBAAM,OAAO,OAAO,GAAG;AACvB;AAAA,UAAA;AAAA,QAEN;AAGA,+BAAuB,iBAAiB;AAExC,eAAO,QAAQ,kBAAkB;AAAA,MACnC;AAAA,IAAA;AAIF,QAAI,kBAAkB,WAAW,QAAQ;AACvC,wBAAkB,QAAA,EAAU,MAAM,QAAQ,KAAK;AAAA,IACjD;AAGA,iBAAa,MAAM;AACjB,UAAI,oBAAoB;AACtB,2BAAA;AACA,6BAAqB;AAAA,MACvB;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAGD,QAAM,WAAW,mBAAA;AACjB,MAAI,UAAU;AACZ,gBAAY,MAAM;AAChB,UAAI,oBAAoB;AACtB,2BAAA;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AAAA,IACL,OAAO,SAAS,MAAM,KAAK;AAAA,IAC3B;AAAA,IACA,YAAY,SAAS,MAAM,WAAW,KAAK;AAAA,IAC3C,QAAQ,SAAS,MAAM,OAAO,KAAK;AAAA,IACnC,WAAW;AAAA,MACT,MAAM,OAAO,UAAU,aAAa,OAAO,UAAU;AAAA,IAAA;AAAA,IAEvD,SAAS,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,QAAQ,SAAS,MAAM,OAAO,UAAU,MAAM;AAAA,IAC9C,SAAS,SAAS,MAAM,OAAO,UAAU,OAAO;AAAA,IAChD,aAAa,SAAS,MAAM,OAAO,UAAU,YAAY;AAAA,EAAA;AAE7D;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/vue-db",
   "description": "Vue integration for @tanstack/db",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "author": "Kyle Mathews",
   "license": "MIT",
   "repository": {
@@ -16,7 +16,7 @@
     "typescript"
   ],
   "dependencies": {
-    "@tanstack/db": "0.0.17"
+    "@tanstack/db": "0.0.19"
   },
   "devDependencies": {
     "@electric-sql/client": "1.0.0",

package/src/useLiveQuery.ts

@@ -20,6 +20,18 @@ import type {
 } from "@tanstack/db"
 import type { ComputedRef, MaybeRefOrGetter } from "vue"
 
+/**
+ * Return type for useLiveQuery hook
+ * @property state - Reactive Map of query results (key → item)
+ * @property data - Reactive array of query results in order
+ * @property collection - The underlying query collection instance
+ * @property status - Current query status
+ * @property isLoading - True while initial query data is loading
+ * @property isReady - True when query has received first data and is ready
+ * @property isIdle - True when query hasn't started yet
+ * @property isError - True when query encountered an error
+ * @property isCleanedUp - True when query has been cleaned up
+ */
 export interface UseLiveQueryReturn<T extends object> {
   state: ComputedRef<Map<string | number, T>>
   data: ComputedRef<Array<T>>
@@ -48,18 +60,138 @@ export interface UseLiveQueryReturnWithCollection<
   isCleanedUp: ComputedRef<boolean>
 }
 
+/**
+ * Create a live query using a query function
+ * @param queryFn - Query function that defines what data to fetch
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic query with object syntax
+ * const { data, isLoading } = useLiveQuery((q) =>
+ *   q.from({ todos: todosCollection })
+ *    .where(({ todos }) => eq(todos.completed, false))
+ *    .select(({ todos }) => ({ id: todos.id, text: todos.text }))
+ * )
+ *
+ * @example
+ * // With reactive dependencies
+ * const minPriority = ref(5)
+ * const { data, state } = useLiveQuery(
+ *   (q) => q.from({ todos: todosCollection })
+ *          .where(({ todos }) => gt(todos.priority, minPriority.value)),
+ *   [minPriority] // Re-run when minPriority changes
+ * )
+ *
+ * @example
+ * // Join pattern
+ * const { data } = useLiveQuery((q) =>
+ *   q.from({ issues: issueCollection })
+ *    .join({ persons: personCollection }, ({ issues, persons }) =>
+ *      eq(issues.userId, persons.id)
+ *    )
+ *    .select(({ issues, persons }) => ({
+ *      id: issues.id,
+ *      title: issues.title,
+ *      userName: persons.name
+ *    }))
+ * )
+ *
+ * @example
+ * // Handle loading and error states in template
+ * const { data, isLoading, isError, status } = useLiveQuery((q) =>
+ *   q.from({ todos: todoCollection })
+ * )
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error: {{ status }}</div>
+ * // <ul v-else>
+ * //   <li v-for="todo in data" :key="todo.id">{{ todo.text }}</li>
+ * // </ul>
+ */
 // Overload 1: Accept just the query function
 export function useLiveQuery<TContext extends Context>(
   queryFn: (q: InitialQueryBuilder) => QueryBuilder<TContext>,
   deps?: Array<MaybeRefOrGetter<unknown>>
 ): UseLiveQueryReturn<GetResult<TContext>>
 
+/**
+ * Create a live query using configuration object
+ * @param config - Configuration object with query and options
+ * @param deps - Array of reactive dependencies that trigger query re-execution when changed
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Basic config object usage
+ * const { data, status } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection }),
+ *   gcTime: 60000
+ * })
+ *
+ * @example
+ * // With reactive dependencies
+ * const filter = ref('active')
+ * const { data, isReady } = useLiveQuery({
+ *   query: (q) => q.from({ todos: todosCollection })
+ *                  .where(({ todos }) => eq(todos.status, filter.value))
+ * }, [filter])
+ *
+ * @example
+ * // Handle all states uniformly
+ * const { data, isLoading, isReady, isError } = useLiveQuery({
+ *   query: (q) => q.from({ items: itemCollection })
+ * })
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Something went wrong</div>
+ * // <div v-else-if="!isReady">Preparing...</div>
+ * // <div v-else>{{ data.length }} items loaded</div>
+ */
 // Overload 2: Accept config object
 export function useLiveQuery<TContext extends Context>(
   config: LiveQueryCollectionConfig<TContext>,
   deps?: Array<MaybeRefOrGetter<unknown>>
 ): UseLiveQueryReturn<GetResult<TContext>>
 
+/**
+ * Subscribe to an existing query collection (can be reactive)
+ * @param liveQueryCollection - Pre-created query collection to subscribe to (can be a ref)
+ * @returns Reactive object with query data, state, and status information
+ * @example
+ * // Using pre-created query collection
+ * const myLiveQuery = createLiveQueryCollection((q) =>
+ *   q.from({ todos: todosCollection }).where(({ todos }) => eq(todos.active, true))
+ * )
+ * const { data, collection } = useLiveQuery(myLiveQuery)
+ *
+ * @example
+ * // Reactive query collection reference
+ * const selectedQuery = ref(todosQuery)
+ * const { data, collection } = useLiveQuery(selectedQuery)
+ *
+ * // Switch queries reactively
+ * selectedQuery.value = archiveQuery
+ *
+ * @example
+ * // Access query collection methods directly
+ * const { data, collection, isReady } = useLiveQuery(existingQuery)
+ *
+ * // Use underlying collection for mutations
+ * const handleToggle = (id) => {
+ *   collection.value.update(id, draft => { draft.completed = !draft.completed })
+ * }
+ *
+ * @example
+ * // Handle states consistently
+ * const { data, isLoading, isError } = useLiveQuery(sharedQuery)
+ *
+ * // In template:
+ * // <div v-if="isLoading">Loading...</div>
+ * // <div v-else-if="isError">Error loading data</div>
+ * // <div v-else>
+ * //   <Item v-for="item in data" :key="item.id" v-bind="item" />
+ * // </div>
+ */
 // Overload 3: Accept pre-created live query collection (can be reactive)
 export function useLiveQuery<
   TResult extends object,