@tanstack/vue-db 0.0.0 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Kyle Mathews
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const useOptimisticMutation = require("./useOptimisticMutation.cjs");
4
+ const useLiveQuery = require("./useLiveQuery.cjs");
5
+ const db = require("@tanstack/db");
6
+ exports.useOptimisticMutation = useOptimisticMutation.useOptimisticMutation;
7
+ exports.useLiveQuery = useLiveQuery.useLiveQuery;
8
+ Object.defineProperty(exports, "Collection", {
9
+ enumerable: true,
10
+ get: () => db.Collection
11
+ });
12
+ Object.defineProperty(exports, "createTransaction", {
13
+ enumerable: true,
14
+ get: () => db.createTransaction
15
+ });
16
+ Object.keys(db).forEach((k) => {
17
+ if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
18
+ enumerable: true,
19
+ get: () => db[k]
20
+ });
21
+ });
22
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;"}
@@ -0,0 +1,5 @@
1
+ export * from './useOptimisticMutation.cjs';
2
+ export * from './useLiveQuery.cjs';
3
+ export * from '@tanstack/db';
4
+ export { Collection } from '@tanstack/db';
5
+ export { createTransaction } from '@tanstack/db';
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const vue = require("vue");
4
+ const vueStore = require("@tanstack/vue-store");
5
+ const db = require("@tanstack/db");
6
+ function useLiveQuery(queryFn, deps = []) {
7
+ const compiledQuery = vue.computed(() => {
8
+ deps.forEach((dep) => vue.toValue(dep));
9
+ const query = queryFn(db.queryBuilder());
10
+ const compiled = db.compileQuery(query);
11
+ compiled.start();
12
+ return compiled;
13
+ });
14
+ const state = vue.computed(() => {
15
+ return vueStore.useStore(compiledQuery.value.results.derivedState).value;
16
+ });
17
+ const data = vue.computed(() => {
18
+ return vueStore.useStore(compiledQuery.value.results.derivedArray).value;
19
+ });
20
+ vue.watch(compiledQuery, (newQuery, oldQuery, onInvalidate) => {
21
+ if (newQuery.state === `stopped`) {
22
+ newQuery.start();
23
+ }
24
+ onInvalidate(() => {
25
+ oldQuery.stop();
26
+ });
27
+ });
28
+ return {
29
+ state,
30
+ data,
31
+ collection: vue.computed(() => compiledQuery.value.results)
32
+ };
33
+ }
34
+ exports.useLiveQuery = useLiveQuery;
35
+ //# sourceMappingURL=useLiveQuery.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useLiveQuery.cjs","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import { computed, toValue, watch } from \"vue\"\nimport { useStore } from \"@tanstack/vue-store\"\nimport { compileQuery, queryBuilder } from \"@tanstack/db\"\nimport type {\n Collection,\n Context,\n InitialQueryBuilder,\n QueryBuilder,\n ResultsFromContext,\n Schema,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\nexport interface UseLiveQueryReturn<T extends object> {\n state: ComputedRef<Map<string, T>>\n data: ComputedRef<Array<T>>\n collection: ComputedRef<Collection<T>>\n}\n\nexport function useLiveQuery<\n TResultContext extends Context<Schema> = Context<Schema>,\n>(\n queryFn: (\n q: InitialQueryBuilder<Context<Schema>>\n ) => QueryBuilder<TResultContext>,\n deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<ResultsFromContext<TResultContext>> {\n const compiledQuery = computed(() => {\n // Just reference deps to make computed reactive to them\n deps.forEach((dep) => toValue(dep))\n\n const query = queryFn(queryBuilder())\n const compiled = compileQuery(query)\n compiled.start()\n return compiled\n })\n\n const state = computed(() => {\n return useStore(compiledQuery.value.results.derivedState).value\n })\n const data = computed(() => {\n return useStore(compiledQuery.value.results.derivedArray).value\n })\n\n watch(compiledQuery, (newQuery, oldQuery, onInvalidate) => {\n if (newQuery.state === `stopped`) {\n newQuery.start()\n }\n\n onInvalidate(() => {\n oldQuery.stop()\n })\n })\n\n return {\n state,\n data,\n collection: computed(() => compiledQuery.value.results),\n }\n}\n"],"names":["computed","toValue","queryBuilder","compileQuery","useStore","watch"],"mappings":";;;;;AAmBO,SAAS,aAGd,SAGA,OAAyC,IACe;AAClD,QAAA,gBAAgBA,IAAAA,SAAS,MAAM;AAEnC,SAAK,QAAQ,CAAC,QAAQC,IAAA,QAAQ,GAAG,CAAC;AAE5B,UAAA,QAAQ,QAAQC,GAAAA,cAAc;AAC9B,UAAA,WAAWC,gBAAa,KAAK;AACnC,aAAS,MAAM;AACR,WAAA;AAAA,EAAA,CACR;AAEK,QAAA,QAAQH,IAAAA,SAAS,MAAM;AAC3B,WAAOI,SAAAA,SAAS,cAAc,MAAM,QAAQ,YAAY,EAAE;AAAA,EAAA,CAC3D;AACK,QAAA,OAAOJ,IAAAA,SAAS,MAAM;AAC1B,WAAOI,SAAAA,SAAS,cAAc,MAAM,QAAQ,YAAY,EAAE;AAAA,EAAA,CAC3D;AAEDC,MAAAA,MAAM,eAAe,CAAC,UAAU,UAAU,iBAAiB;AACrD,QAAA,SAAS,UAAU,WAAW;AAChC,eAAS,MAAM;AAAA,IAAA;AAGjB,iBAAa,MAAM;AACjB,eAAS,KAAK;AAAA,IAAA,CACf;AAAA,EAAA,CACF;AAEM,SAAA;AAAA,IACL;AAAA,IACA;AAAA,IACA,YAAYL,IAAA,SAAS,MAAM,cAAc,MAAM,OAAO;AAAA,EACxD;AACF;;"}
@@ -0,0 +1,8 @@
1
+ import { Collection, Context, InitialQueryBuilder, QueryBuilder, ResultsFromContext, Schema } from '@tanstack/db';
2
+ import { ComputedRef, MaybeRefOrGetter } from 'vue';
3
+ export interface UseLiveQueryReturn<T extends object> {
4
+ state: ComputedRef<Map<string, T>>;
5
+ data: ComputedRef<Array<T>>;
6
+ collection: ComputedRef<Collection<T>>;
7
+ }
8
+ export declare function useLiveQuery<TResultContext extends Context<Schema> = Context<Schema>>(queryFn: (q: InitialQueryBuilder<Context<Schema>>) => QueryBuilder<TResultContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<ResultsFromContext<TResultContext>>;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
+ const db = require("@tanstack/db");
4
+ function useOptimisticMutation(config) {
5
+ return {
6
+ mutate: (callback) => {
7
+ const transaction = db.createTransaction(config);
8
+ transaction.mutate(callback);
9
+ return transaction;
10
+ },
11
+ createTransaction: () => {
12
+ return db.createTransaction({ ...config, autoCommit: false });
13
+ }
14
+ };
15
+ }
16
+ exports.useOptimisticMutation = useOptimisticMutation;
17
+ //# sourceMappingURL=useOptimisticMutation.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useOptimisticMutation.cjs","sources":["../../src/useOptimisticMutation.ts"],"sourcesContent":["import { createTransaction } from \"@tanstack/db\"\nimport type { Transaction, TransactionConfig } from \"@tanstack/db\"\n\nexport function useOptimisticMutation(config: TransactionConfig) {\n return {\n mutate: (callback: () => void): Transaction => {\n const transaction = createTransaction(config)\n transaction.mutate(callback)\n return transaction\n },\n createTransaction: (): Transaction => {\n return createTransaction({ ...config, autoCommit: false })\n },\n }\n}\n"],"names":["createTransaction"],"mappings":";;;AAGO,SAAS,sBAAsB,QAA2B;AACxD,SAAA;AAAA,IACL,QAAQ,CAAC,aAAsC;AACvC,YAAA,cAAcA,qBAAkB,MAAM;AAC5C,kBAAY,OAAO,QAAQ;AACpB,aAAA;AAAA,IACT;AAAA,IACA,mBAAmB,MAAmB;AACpC,aAAOA,qBAAkB,EAAE,GAAG,QAAQ,YAAY,OAAO;AAAA,IAAA;AAAA,EAE7D;AACF;;"}
@@ -0,0 +1,5 @@
1
+ import { Transaction, TransactionConfig } from '@tanstack/db';
2
+ export declare function useOptimisticMutation(config: TransactionConfig): {
3
+ mutate: (callback: () => void) => Transaction;
4
+ createTransaction: () => Transaction;
5
+ };
@@ -0,0 +1,5 @@
1
+ export * from './useOptimisticMutation.js';
2
+ export * from './useLiveQuery.js';
3
+ export * from '@tanstack/db';
4
+ export { Collection } from '@tanstack/db';
5
+ export { createTransaction } from '@tanstack/db';
@@ -0,0 +1,11 @@
1
+ import { useOptimisticMutation } from "./useOptimisticMutation.js";
2
+ import { useLiveQuery } from "./useLiveQuery.js";
3
+ export * from "@tanstack/db";
4
+ import { Collection, createTransaction } from "@tanstack/db";
5
+ export {
6
+ Collection,
7
+ createTransaction,
8
+ useLiveQuery,
9
+ useOptimisticMutation
10
+ };
11
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}
@@ -0,0 +1,8 @@
1
+ import { Collection, Context, InitialQueryBuilder, QueryBuilder, ResultsFromContext, Schema } from '@tanstack/db';
2
+ import { ComputedRef, MaybeRefOrGetter } from 'vue';
3
+ export interface UseLiveQueryReturn<T extends object> {
4
+ state: ComputedRef<Map<string, T>>;
5
+ data: ComputedRef<Array<T>>;
6
+ collection: ComputedRef<Collection<T>>;
7
+ }
8
+ export declare function useLiveQuery<TResultContext extends Context<Schema> = Context<Schema>>(queryFn: (q: InitialQueryBuilder<Context<Schema>>) => QueryBuilder<TResultContext>, deps?: Array<MaybeRefOrGetter<unknown>>): UseLiveQueryReturn<ResultsFromContext<TResultContext>>;
@@ -0,0 +1,35 @@
1
+ import { computed, toValue, watch } from "vue";
2
+ import { useStore } from "@tanstack/vue-store";
3
+ import { queryBuilder, compileQuery } from "@tanstack/db";
4
+ function useLiveQuery(queryFn, deps = []) {
5
+ const compiledQuery = computed(() => {
6
+ deps.forEach((dep) => toValue(dep));
7
+ const query = queryFn(queryBuilder());
8
+ const compiled = compileQuery(query);
9
+ compiled.start();
10
+ return compiled;
11
+ });
12
+ const state = computed(() => {
13
+ return useStore(compiledQuery.value.results.derivedState).value;
14
+ });
15
+ const data = computed(() => {
16
+ return useStore(compiledQuery.value.results.derivedArray).value;
17
+ });
18
+ watch(compiledQuery, (newQuery, oldQuery, onInvalidate) => {
19
+ if (newQuery.state === `stopped`) {
20
+ newQuery.start();
21
+ }
22
+ onInvalidate(() => {
23
+ oldQuery.stop();
24
+ });
25
+ });
26
+ return {
27
+ state,
28
+ data,
29
+ collection: computed(() => compiledQuery.value.results)
30
+ };
31
+ }
32
+ export {
33
+ useLiveQuery
34
+ };
35
+ //# sourceMappingURL=useLiveQuery.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useLiveQuery.js","sources":["../../src/useLiveQuery.ts"],"sourcesContent":["import { computed, toValue, watch } from \"vue\"\nimport { useStore } from \"@tanstack/vue-store\"\nimport { compileQuery, queryBuilder } from \"@tanstack/db\"\nimport type {\n Collection,\n Context,\n InitialQueryBuilder,\n QueryBuilder,\n ResultsFromContext,\n Schema,\n} from \"@tanstack/db\"\nimport type { ComputedRef, MaybeRefOrGetter } from \"vue\"\n\nexport interface UseLiveQueryReturn<T extends object> {\n state: ComputedRef<Map<string, T>>\n data: ComputedRef<Array<T>>\n collection: ComputedRef<Collection<T>>\n}\n\nexport function useLiveQuery<\n TResultContext extends Context<Schema> = Context<Schema>,\n>(\n queryFn: (\n q: InitialQueryBuilder<Context<Schema>>\n ) => QueryBuilder<TResultContext>,\n deps: Array<MaybeRefOrGetter<unknown>> = []\n): UseLiveQueryReturn<ResultsFromContext<TResultContext>> {\n const compiledQuery = computed(() => {\n // Just reference deps to make computed reactive to them\n deps.forEach((dep) => toValue(dep))\n\n const query = queryFn(queryBuilder())\n const compiled = compileQuery(query)\n compiled.start()\n return compiled\n })\n\n const state = computed(() => {\n return useStore(compiledQuery.value.results.derivedState).value\n })\n const data = computed(() => {\n return useStore(compiledQuery.value.results.derivedArray).value\n })\n\n watch(compiledQuery, (newQuery, oldQuery, onInvalidate) => {\n if (newQuery.state === `stopped`) {\n newQuery.start()\n }\n\n onInvalidate(() => {\n oldQuery.stop()\n })\n })\n\n return {\n state,\n data,\n collection: computed(() => compiledQuery.value.results),\n }\n}\n"],"names":[],"mappings":";;;AAmBO,SAAS,aAGd,SAGA,OAAyC,IACe;AAClD,QAAA,gBAAgB,SAAS,MAAM;AAEnC,SAAK,QAAQ,CAAC,QAAQ,QAAQ,GAAG,CAAC;AAE5B,UAAA,QAAQ,QAAQ,cAAc;AAC9B,UAAA,WAAW,aAAa,KAAK;AACnC,aAAS,MAAM;AACR,WAAA;AAAA,EAAA,CACR;AAEK,QAAA,QAAQ,SAAS,MAAM;AAC3B,WAAO,SAAS,cAAc,MAAM,QAAQ,YAAY,EAAE;AAAA,EAAA,CAC3D;AACK,QAAA,OAAO,SAAS,MAAM;AAC1B,WAAO,SAAS,cAAc,MAAM,QAAQ,YAAY,EAAE;AAAA,EAAA,CAC3D;AAED,QAAM,eAAe,CAAC,UAAU,UAAU,iBAAiB;AACrD,QAAA,SAAS,UAAU,WAAW;AAChC,eAAS,MAAM;AAAA,IAAA;AAGjB,iBAAa,MAAM;AACjB,eAAS,KAAK;AAAA,IAAA,CACf;AAAA,EAAA,CACF;AAEM,SAAA;AAAA,IACL;AAAA,IACA;AAAA,IACA,YAAY,SAAS,MAAM,cAAc,MAAM,OAAO;AAAA,EACxD;AACF;"}
@@ -0,0 +1,5 @@
1
+ import { Transaction, TransactionConfig } from '@tanstack/db';
2
+ export declare function useOptimisticMutation(config: TransactionConfig): {
3
+ mutate: (callback: () => void) => Transaction;
4
+ createTransaction: () => Transaction;
5
+ };
@@ -0,0 +1,17 @@
1
+ import { createTransaction } from "@tanstack/db";
2
+ function useOptimisticMutation(config) {
3
+ return {
4
+ mutate: (callback) => {
5
+ const transaction = createTransaction(config);
6
+ transaction.mutate(callback);
7
+ return transaction;
8
+ },
9
+ createTransaction: () => {
10
+ return createTransaction({ ...config, autoCommit: false });
11
+ }
12
+ };
13
+ }
14
+ export {
15
+ useOptimisticMutation
16
+ };
17
+ //# sourceMappingURL=useOptimisticMutation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useOptimisticMutation.js","sources":["../../src/useOptimisticMutation.ts"],"sourcesContent":["import { createTransaction } from \"@tanstack/db\"\nimport type { Transaction, TransactionConfig } from \"@tanstack/db\"\n\nexport function useOptimisticMutation(config: TransactionConfig) {\n return {\n mutate: (callback: () => void): Transaction => {\n const transaction = createTransaction(config)\n transaction.mutate(callback)\n return transaction\n },\n createTransaction: (): Transaction => {\n return createTransaction({ ...config, autoCommit: false })\n },\n }\n}\n"],"names":[],"mappings":";AAGO,SAAS,sBAAsB,QAA2B;AACxD,SAAA;AAAA,IACL,QAAQ,CAAC,aAAsC;AACvC,YAAA,cAAc,kBAAkB,MAAM;AAC5C,kBAAY,OAAO,QAAQ;AACpB,aAAA;AAAA,IACT;AAAA,IACA,mBAAmB,MAAmB;AACpC,aAAO,kBAAkB,EAAE,GAAG,QAAQ,YAAY,OAAO;AAAA,IAAA;AAAA,EAE7D;AACF;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@tanstack/vue-db",
3
3
  "description": "Vue integration for @tanstack/db",
4
- "version": "0.0.0",
4
+ "version": "0.0.2",
5
5
  "author": "Kyle Mathews",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -15,10 +15,9 @@
15
15
  "vue",
16
16
  "typescript"
17
17
  ],
18
- "packageManager": "pnpm@10.5.2",
19
18
  "dependencies": {
20
- "@tanstack/db": "workspace:*",
21
- "@tanstack/vue-store": "^0.7.0"
19
+ "@tanstack/vue-store": "^0.7.0",
20
+ "@tanstack/db": "0.0.3"
22
21
  },
23
22
  "devDependencies": {
24
23
  "@electric-sql/client": "1.0.0",
@@ -48,13 +47,13 @@
48
47
  "peerDependencies": {
49
48
  "vue": ">=3.3.0"
50
49
  },
50
+ "sideEffects": false,
51
+ "type": "module",
52
+ "types": "dist/esm/index.d.ts",
51
53
  "scripts": {
52
54
  "build": "vite build",
53
55
  "dev": "vite build --watch",
54
56
  "test": "npx vitest --run",
55
57
  "lint": "eslint . --fix"
56
- },
57
- "sideEffects": false,
58
- "type": "module",
59
- "types": "dist/esm/index.d.ts"
60
- }
58
+ }
59
+ }