@noy-db/in-tanstack-query 0.2.0-pre.9 → 0.3.0-pre.2

package/README.md

@@ -26,7 +26,7 @@ See the [main repository](https://github.com/vLannaAi/noy-db#readme) for setup,
 
 - Source — [`packages/in-tanstack-query`](https://github.com/vLannaAi/noy-db/tree/main/packages/in-tanstack-query)
 - Issues — [github.com/vLannaAi/noy-db/issues](https://github.com/vLannaAi/noy-db/issues)
-- Spec — [`SPEC.md`](https://github.com/vLannaAi/noy-db/blob/main/SPEC.md)
+- Spec — [`SPEC.md`](https://github.com/vLannaAi/noy-db-docs/blob/main/SPEC.md)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noy-db/in-tanstack-query",
-  "version": "0.2.0-pre.9",
+  "version": "0.3.0-pre.2",
   "description": "TanStack Query adapter for noy-db — queryFn + mutationFn helpers that speak the Collection API, plus automatic invalidation from noy-db change events. Framework-agnostic (React / Vue / Solid / Svelte).",
   "license": "MIT",
   "author": "vLannaAi <vicio@lanna.ai>",
@@ -17,17 +17,10 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
-  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -36,15 +29,15 @@
     "LICENSE"
   ],
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=22.0.0"
   },
   "peerDependencies": {
     "@tanstack/query-core": "^5.0.0",
-    "@noy-db/hub": "0.2.0-pre.9"
+    "@noy-db/hub": "0.3.0-pre.2"
   },
   "devDependencies": {
     "@tanstack/query-core": "^5.59.0",
-    "@noy-db/hub": "0.2.0-pre.9"
+    "@noy-db/hub": "0.3.0-pre.2"
   },
   "keywords": [
     "noy-db",

package/dist/index.cjs

@@ -1,95 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  bindInvalidation: () => bindInvalidation,
-  collectionDeleteOptions: () => collectionDeleteOptions,
-  collectionGetOptions: () => collectionGetOptions,
-  collectionListOptions: () => collectionListOptions,
-  collectionPutOptions: () => collectionPutOptions,
-  collectionQueryKey: () => collectionQueryKey,
-  collectionQueryOptions: () => collectionQueryOptions
-});
-module.exports = __toCommonJS(index_exports);
-function collectionQueryKey(vault, collection, ...extra) {
-  return ["noy-db", vault, collection, ...extra];
-}
-function collectionListOptions(vault, collectionName, getCollection) {
-  return {
-    queryKey: collectionQueryKey(vault, collectionName, "list"),
-    queryFn: async () => {
-      const coll = getCollection();
-      return coll.list();
-    }
-  };
-}
-function collectionGetOptions(vault, collectionName, id, getCollection) {
-  return {
-    queryKey: collectionQueryKey(vault, collectionName, "get", id),
-    queryFn: async () => {
-      const coll = getCollection();
-      return coll.get(id);
-    }
-  };
-}
-function collectionQueryOptions(vault, collectionName, getCollection, builder, keyTag = "query") {
-  return {
-    queryKey: collectionQueryKey(vault, collectionName, keyTag),
-    queryFn: async () => {
-      const coll = getCollection();
-      return Promise.resolve(builder(coll.query()));
-    }
-  };
-}
-function collectionPutOptions(getCollection) {
-  return {
-    mutationFn: async ({ id, record }) => {
-      const coll = getCollection();
-      await coll.put(id, record);
-    }
-  };
-}
-function collectionDeleteOptions(getCollection) {
-  return {
-    mutationFn: async ({ id }) => {
-      const coll = getCollection();
-      await coll.delete(id);
-    }
-  };
-}
-function bindInvalidation(queryClient, vault, collectionName, collection) {
-  return collection.subscribe(() => {
-    void queryClient.invalidateQueries({
-      queryKey: collectionQueryKey(vault, collectionName)
-    });
-  });
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  bindInvalidation,
-  collectionDeleteOptions,
-  collectionGetOptions,
-  collectionListOptions,
-  collectionPutOptions,
-  collectionQueryKey,
-  collectionQueryOptions
-});
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * **@noy-db/in-tanstack-query** — TanStack Query adapter for noy-db.\n *\n * Three framework-agnostic pieces:\n *\n *   1. **{@link collectionQueryOptions}** — returns a\n *      `{ queryKey, queryFn }` pair ready to hand to `useQuery()` in\n *      any TanStack-supported framework (React, Vue, Solid, Svelte).\n *\n *   2. **{@link collectionMutationOptions}** — same shape for\n *      `useMutation()`, with `put`/`delete` actions against a\n *      `Collection`.\n *\n *   3. **{@link bindInvalidation}** — subscribes to a `Collection`'s\n *      change stream and invalidates the matching query keys on every\n *      mutation. Drop-in replacement for ad-hoc `invalidateQueries`\n *      calls scattered through mutation callbacks.\n *\n * Keeping these as option-factories (not custom hooks) means the\n * same code works across every TanStack framework binding — no\n * framework-specific exports needed.\n *\n * @packageDocumentation\n */\n\nimport type { Collection, Query } from '@noy-db/hub'\nimport type { QueryClient } from '@tanstack/query-core'\n\n/** The canonical TanStack queryKey shape for a collection scope. */\nexport type CollectionQueryKey =\n  | readonly ['noy-db', string, string]\n  | readonly ['noy-db', string, string, string]\n  | readonly ['noy-db', string, string, ...unknown[]]\n\nexport function collectionQueryKey(vault: string, collection: string, ...extra: unknown[]): CollectionQueryKey {\n  return ['noy-db', vault, collection, ...extra] as CollectionQueryKey\n}\n\n/**\n * Build `{ queryKey, queryFn }` for a Collection list query. Pass the\n * returned object directly into `useQuery(options)` — works across\n * every TanStack framework binding.\n */\nexport function collectionListOptions<T>(\n  vault: string,\n  collectionName: string,\n  getCollection: () => Collection<T>,\n): { queryKey: CollectionQueryKey; queryFn: () => Promise<T[]> } {\n  return {\n    queryKey: collectionQueryKey(vault, collectionName, 'list'),\n    queryFn: async () => {\n      const coll = getCollection()\n      return coll.list()\n    },\n  }\n}\n\n/**\n * Build `{ queryKey, queryFn }` for a single-record query. Returns\n * `null` when the record is absent.\n */\nexport function collectionGetOptions<T>(\n  vault: string,\n  collectionName: string,\n  id: string,\n  getCollection: () => Collection<T>,\n): { queryKey: CollectionQueryKey; queryFn: () => Promise<T | null> } {\n  return {\n    queryKey: collectionQueryKey(vault, collectionName, 'get', id),\n    queryFn: async () => {\n      const coll = getCollection()\n      return coll.get(id)\n    },\n  }\n}\n\n/**\n * Build `{ queryKey, queryFn }` for an arbitrary query builder. The\n * builder receives the collection's `query()` chain and returns a\n * terminal result (`.toArray()`, `.count()`, `.aggregate({...})`, …).\n */\nexport function collectionQueryOptions<T, R>(\n  vault: string,\n  collectionName: string,\n  getCollection: () => Collection<T>,\n  builder: (q: Query<T>) => Promise<R> | R,\n  keyTag: string = 'query',\n): { queryKey: CollectionQueryKey; queryFn: () => Promise<R> } {\n  return {\n    queryKey: collectionQueryKey(vault, collectionName, keyTag),\n    queryFn: async () => {\n      const coll = getCollection()\n      return Promise.resolve(builder(coll.query() as unknown as Query<T>))\n    },\n  }\n}\n\n/**\n * Build `{ mutationFn }` for a record put. Caller's `onSuccess` is\n * where you'd usually call `invalidateQueries(collectionQueryKey(...))`\n * — or let {@link bindInvalidation} do it automatically.\n */\nexport function collectionPutOptions<T>(\n  getCollection: () => Collection<T>,\n): { mutationFn: (args: { id: string; record: T }) => Promise<void> } {\n  return {\n    mutationFn: async ({ id, record }) => {\n      const coll = getCollection()\n      await coll.put(id, record)\n    },\n  }\n}\n\n/** Build `{ mutationFn }` for a record delete. */\nexport function collectionDeleteOptions<T>(\n  getCollection: () => Collection<T>,\n): { mutationFn: (args: { id: string }) => Promise<void> } {\n  return {\n    mutationFn: async ({ id }) => {\n      const coll = getCollection()\n      await coll.delete(id)\n    },\n  }\n}\n\n/**\n * Subscribe to a Collection's change stream and invalidate the\n * corresponding query scope on every mutation. Returns an unsubscribe\n * function — call on cleanup (framework-specific).\n *\n * ```ts\n * const stop = bindInvalidation(queryClient, 'acme', 'invoices', invoices)\n * // … later, e.g. in React's useEffect cleanup:\n * stop()\n * ```\n */\nexport function bindInvalidation<T>(\n  queryClient: QueryClient,\n  vault: string,\n  collectionName: string,\n  collection: Collection<T>,\n): () => void {\n  return collection.subscribe(() => {\n    void queryClient.invalidateQueries({\n      queryKey: collectionQueryKey(vault, collectionName),\n    })\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkCO,SAAS,mBAAmB,OAAe,eAAuB,OAAsC;AAC7G,SAAO,CAAC,UAAU,OAAO,YAAY,GAAG,KAAK;AAC/C;AAOO,SAAS,sBACd,OACA,gBACA,eAC+D;AAC/D,SAAO;AAAA,IACL,UAAU,mBAAmB,OAAO,gBAAgB,MAAM;AAAA,IAC1D,SAAS,YAAY;AACnB,YAAM,OAAO,cAAc;AAC3B,aAAO,KAAK,KAAK;AAAA,IACnB;AAAA,EACF;AACF;AAMO,SAAS,qBACd,OACA,gBACA,IACA,eACoE;AACpE,SAAO;AAAA,IACL,UAAU,mBAAmB,OAAO,gBAAgB,OAAO,EAAE;AAAA,IAC7D,SAAS,YAAY;AACnB,YAAM,OAAO,cAAc;AAC3B,aAAO,KAAK,IAAI,EAAE;AAAA,IACpB;AAAA,EACF;AACF;AAOO,SAAS,uBACd,OACA,gBACA,eACA,SACA,SAAiB,SAC4C;AAC7D,SAAO;AAAA,IACL,UAAU,mBAAmB,OAAO,gBAAgB,MAAM;AAAA,IAC1D,SAAS,YAAY;AACnB,YAAM,OAAO,cAAc;AAC3B,aAAO,QAAQ,QAAQ,QAAQ,KAAK,MAAM,CAAwB,CAAC;AAAA,IACrE;AAAA,EACF;AACF;AAOO,SAAS,qBACd,eACoE;AACpE,SAAO;AAAA,IACL,YAAY,OAAO,EAAE,IAAI,OAAO,MAAM;AACpC,YAAM,OAAO,cAAc;AAC3B,YAAM,KAAK,IAAI,IAAI,MAAM;AAAA,IAC3B;AAAA,EACF;AACF;AAGO,SAAS,wBACd,eACyD;AACzD,SAAO;AAAA,IACL,YAAY,OAAO,EAAE,GAAG,MAAM;AAC5B,YAAM,OAAO,cAAc;AAC3B,YAAM,KAAK,OAAO,EAAE;AAAA,IACtB;AAAA,EACF;AACF;AAaO,SAAS,iBACd,aACA,OACA,gBACA,YACY;AACZ,SAAO,WAAW,UAAU,MAAM;AAChC,SAAK,YAAY,kBAAkB;AAAA,MACjC,UAAU,mBAAmB,OAAO,cAAc;AAAA,IACpD,CAAC;AAAA,EACH,CAAC;AACH;","names":[]}

package/dist/index.d.cts

@@ -1,88 +0,0 @@
-import { Collection, Query } from '@noy-db/hub';
-import { QueryClient } from '@tanstack/query-core';
-
-/**
- * **@noy-db/in-tanstack-query** — TanStack Query adapter for noy-db.
- *
- * Three framework-agnostic pieces:
- *
- *   1. **{@link collectionQueryOptions}** — returns a
- *      `{ queryKey, queryFn }` pair ready to hand to `useQuery()` in
- *      any TanStack-supported framework (React, Vue, Solid, Svelte).
- *
- *   2. **{@link collectionMutationOptions}** — same shape for
- *      `useMutation()`, with `put`/`delete` actions against a
- *      `Collection`.
- *
- *   3. **{@link bindInvalidation}** — subscribes to a `Collection`'s
- *      change stream and invalidates the matching query keys on every
- *      mutation. Drop-in replacement for ad-hoc `invalidateQueries`
- *      calls scattered through mutation callbacks.
- *
- * Keeping these as option-factories (not custom hooks) means the
- * same code works across every TanStack framework binding — no
- * framework-specific exports needed.
- *
- * @packageDocumentation
- */
-
-/** The canonical TanStack queryKey shape for a collection scope. */
-type CollectionQueryKey = readonly ['noy-db', string, string] | readonly ['noy-db', string, string, string] | readonly ['noy-db', string, string, ...unknown[]];
-declare function collectionQueryKey(vault: string, collection: string, ...extra: unknown[]): CollectionQueryKey;
-/**
- * Build `{ queryKey, queryFn }` for a Collection list query. Pass the
- * returned object directly into `useQuery(options)` — works across
- * every TanStack framework binding.
- */
-declare function collectionListOptions<T>(vault: string, collectionName: string, getCollection: () => Collection<T>): {
-    queryKey: CollectionQueryKey;
-    queryFn: () => Promise<T[]>;
-};
-/**
- * Build `{ queryKey, queryFn }` for a single-record query. Returns
- * `null` when the record is absent.
- */
-declare function collectionGetOptions<T>(vault: string, collectionName: string, id: string, getCollection: () => Collection<T>): {
-    queryKey: CollectionQueryKey;
-    queryFn: () => Promise<T | null>;
-};
-/**
- * Build `{ queryKey, queryFn }` for an arbitrary query builder. The
- * builder receives the collection's `query()` chain and returns a
- * terminal result (`.toArray()`, `.count()`, `.aggregate({...})`, …).
- */
-declare function collectionQueryOptions<T, R>(vault: string, collectionName: string, getCollection: () => Collection<T>, builder: (q: Query<T>) => Promise<R> | R, keyTag?: string): {
-    queryKey: CollectionQueryKey;
-    queryFn: () => Promise<R>;
-};
-/**
- * Build `{ mutationFn }` for a record put. Caller's `onSuccess` is
- * where you'd usually call `invalidateQueries(collectionQueryKey(...))`
- * — or let {@link bindInvalidation} do it automatically.
- */
-declare function collectionPutOptions<T>(getCollection: () => Collection<T>): {
-    mutationFn: (args: {
-        id: string;
-        record: T;
-    }) => Promise<void>;
-};
-/** Build `{ mutationFn }` for a record delete. */
-declare function collectionDeleteOptions<T>(getCollection: () => Collection<T>): {
-    mutationFn: (args: {
-        id: string;
-    }) => Promise<void>;
-};
-/**
- * Subscribe to a Collection's change stream and invalidate the
- * corresponding query scope on every mutation. Returns an unsubscribe
- * function — call on cleanup (framework-specific).
- *
- * ```ts
- * const stop = bindInvalidation(queryClient, 'acme', 'invoices', invoices)
- * // … later, e.g. in React's useEffect cleanup:
- * stop()
- * ```
- */
-declare function bindInvalidation<T>(queryClient: QueryClient, vault: string, collectionName: string, collection: Collection<T>): () => void;
-
-export { type CollectionQueryKey, bindInvalidation, collectionDeleteOptions, collectionGetOptions, collectionListOptions, collectionPutOptions, collectionQueryKey, collectionQueryOptions };