@tthr/vue 0.0.1

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.
Files changed (5) hide show
  1. package/dist/index.d.ts +84 -0
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +132 -0
  4. package/dist/index.js.map +1 -0
  5. package/package.json +31 -0
package/dist/index.d.ts ADDED
@@ -0,0 +1,84 @@
1
+ /**
2
+ * @tthr/vue - Tether Vue/Nuxt SDK
3
+ *
4
+ * Reactive data fetching and mutations for Vue and Nuxt applications.
5
+ */
6
+ import { type Ref, type App } from 'vue';
7
+ import { TetherClient, type TetherClientOptions } from '@tthr/client';
8
+ /**
9
+ * Tether plugin for Vue/Nuxt
10
+ */
11
+ export declare const TetherPlugin: {
12
+ install(app: App, options: TetherClientOptions): void;
13
+ configure(options: TetherClientOptions): void;
14
+ };
15
+ /**
16
+ * Get the Tether client instance
17
+ */
18
+ export declare function useTether(): TetherClient;
19
+ /**
20
+ * Query state returned by useQuery
21
+ */
22
+ export interface QueryState<T> {
23
+ data: Ref<T | undefined>;
24
+ error: Ref<Error | null>;
25
+ isLoading: Ref<boolean>;
26
+ refetch: () => Promise<void>;
27
+ }
28
+ /**
29
+ * Query function reference
30
+ */
31
+ export interface QueryFunction<TArgs = void, TResult = unknown> {
32
+ _name: string;
33
+ _args?: TArgs;
34
+ _result?: TResult;
35
+ }
36
+ /**
37
+ * Reactive query composable
38
+ *
39
+ * @example
40
+ * ```vue
41
+ * <script setup>
42
+ * import { useQuery } from '@tthr/vue';
43
+ * import { api } from '../_generated/api';
44
+ *
45
+ * const posts = useQuery(api.posts.list);
46
+ * </script>
47
+ * ```
48
+ */
49
+ export declare function useQuery<TArgs, TResult>(query: QueryFunction<TArgs, TResult>, args?: TArgs): QueryState<TResult>;
50
+ /**
51
+ * Mutation state returned by useMutation
52
+ */
53
+ export interface MutationState<TArgs, TResult> {
54
+ data: Ref<TResult | undefined>;
55
+ error: Ref<Error | null>;
56
+ isPending: Ref<boolean>;
57
+ mutate: (args: TArgs) => Promise<TResult>;
58
+ reset: () => void;
59
+ }
60
+ /**
61
+ * Mutation function reference
62
+ */
63
+ export interface MutationFunction<TArgs = void, TResult = unknown> {
64
+ _name: string;
65
+ _args?: TArgs;
66
+ _result?: TResult;
67
+ }
68
+ /**
69
+ * Mutation composable
70
+ *
71
+ * @example
72
+ * ```vue
73
+ * <script setup>
74
+ * import { useMutation } from '@tthr/vue';
75
+ * import { api } from '../_generated/api';
76
+ *
77
+ * const createPost = useMutation(api.posts.create);
78
+ * await createPost.mutate({ title: 'Hello', content: '...' });
79
+ * </script>
80
+ * ```
81
+ */
82
+ export declare function useMutation<TArgs, TResult>(mutation: MutationFunction<TArgs, TResult>): MutationState<TArgs, TResult>;
83
+ export type { TetherClientOptions } from '@tthr/client';
84
+ //# sourceMappingURL=index.d.ts.map
package/dist/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAA+B,KAAK,GAAG,EAAE,KAAK,GAAG,EAAE,MAAM,KAAK,CAAC;AACtE,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAKtE;;GAEG;AACH,eAAO,MAAM,YAAY;iBACV,GAAG,WAAW,mBAAmB;uBAK3B,mBAAmB;CAGvC,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAKxC;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IACzB,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IACzB,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,KAAK,GAAG,IAAI,EAAE,OAAO,GAAG,OAAO;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,EACrC,KAAK,EAAE,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,EACpC,IAAI,CAAC,EAAE,KAAK,GACX,UAAU,CAAC,OAAO,CAAC,CA4CrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,KAAK,EAAE,OAAO;IAC3C,IAAI,EAAE,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAC/B,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IACzB,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1C,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,KAAK,GAAG,IAAI,EAAE,OAAO,GAAG,OAAO;IAC/D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EACxC,QAAQ,EAAE,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,GACzC,aAAa,CAAC,KAAK,EAAE,OAAO,CAAC,CAmC/B;AAGD,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,132 @@
1
+ /**
2
+ * @tthr/vue - Tether Vue/Nuxt SDK
3
+ *
4
+ * Reactive data fetching and mutations for Vue and Nuxt applications.
5
+ */
6
+ import { ref, onMounted, onUnmounted } from 'vue';
7
+ import { TetherClient } from '@tthr/client';
8
+ // Global client instance
9
+ let globalClient = null;
10
+ /**
11
+ * Tether plugin for Vue/Nuxt
12
+ */
13
+ export const TetherPlugin = {
14
+ install(app, options) {
15
+ globalClient = new TetherClient(options);
16
+ app.provide('tether', globalClient);
17
+ },
18
+ configure(options) {
19
+ globalClient = new TetherClient(options);
20
+ },
21
+ };
22
+ /**
23
+ * Get the Tether client instance
24
+ */
25
+ export function useTether() {
26
+ if (!globalClient) {
27
+ throw new Error('Tether client not initialised. Call TetherPlugin.configure() first.');
28
+ }
29
+ return globalClient;
30
+ }
31
+ /**
32
+ * Reactive query composable
33
+ *
34
+ * @example
35
+ * ```vue
36
+ * <script setup>
37
+ * import { useQuery } from '@tthr/vue';
38
+ * import { api } from '../_generated/api';
39
+ *
40
+ * const posts = useQuery(api.posts.list);
41
+ * </script>
42
+ * ```
43
+ */
44
+ export function useQuery(query, args) {
45
+ const data = ref();
46
+ const error = ref(null);
47
+ const isLoading = ref(true);
48
+ let unsubscribe = null;
49
+ const fetchData = async () => {
50
+ try {
51
+ isLoading.value = true;
52
+ error.value = null;
53
+ const client = useTether();
54
+ const result = await client.query(query._name, args);
55
+ data.value = result;
56
+ }
57
+ catch (e) {
58
+ error.value = e instanceof Error ? e : new Error(String(e));
59
+ }
60
+ finally {
61
+ isLoading.value = false;
62
+ }
63
+ };
64
+ onMounted(async () => {
65
+ await fetchData();
66
+ // Subscribe to updates
67
+ const client = useTether();
68
+ unsubscribe = client.subscribe(query._name, args, (newData) => {
69
+ data.value = newData;
70
+ });
71
+ });
72
+ onUnmounted(() => {
73
+ if (unsubscribe) {
74
+ unsubscribe();
75
+ }
76
+ });
77
+ return {
78
+ data: data,
79
+ error,
80
+ isLoading,
81
+ refetch: fetchData,
82
+ };
83
+ }
84
+ /**
85
+ * Mutation composable
86
+ *
87
+ * @example
88
+ * ```vue
89
+ * <script setup>
90
+ * import { useMutation } from '@tthr/vue';
91
+ * import { api } from '../_generated/api';
92
+ *
93
+ * const createPost = useMutation(api.posts.create);
94
+ * await createPost.mutate({ title: 'Hello', content: '...' });
95
+ * </script>
96
+ * ```
97
+ */
98
+ export function useMutation(mutation) {
99
+ const data = ref();
100
+ const error = ref(null);
101
+ const isPending = ref(false);
102
+ const mutate = async (args) => {
103
+ try {
104
+ isPending.value = true;
105
+ error.value = null;
106
+ const client = useTether();
107
+ const result = await client.mutation(mutation._name, args);
108
+ data.value = result;
109
+ return result;
110
+ }
111
+ catch (e) {
112
+ error.value = e instanceof Error ? e : new Error(String(e));
113
+ throw e;
114
+ }
115
+ finally {
116
+ isPending.value = false;
117
+ }
118
+ };
119
+ const reset = () => {
120
+ data.value = undefined;
121
+ error.value = null;
122
+ isPending.value = false;
123
+ };
124
+ return {
125
+ data: data,
126
+ error,
127
+ isPending,
128
+ mutate,
129
+ reset,
130
+ };
131
+ }
132
+ //# sourceMappingURL=index.js.map
package/dist/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,WAAW,EAAsB,MAAM,KAAK,CAAC;AACtE,OAAO,EAAE,YAAY,EAA4B,MAAM,cAAc,CAAC;AAEtE,yBAAyB;AACzB,IAAI,YAAY,GAAwB,IAAI,CAAC;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,CAAC,GAAQ,EAAE,OAA4B;QAC5C,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;QACzC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IACtC,CAAC;IAED,SAAS,CAAC,OAA4B;QACpC,YAAY,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,SAAS;IACvB,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IACzF,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAqBD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAoC,EACpC,IAAY;IAEZ,MAAM,IAAI,GAAG,GAAG,EAAW,CAAC;IAC5B,MAAM,KAAK,GAAG,GAAG,CAAe,IAAI,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IAE5B,IAAI,WAAW,GAAwB,IAAI,CAAC;IAE5C,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE;QAC3B,IAAI,CAAC;YACH,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC;YACvB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;YAEnB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACrD,IAAI,CAAC,KAAK,GAAG,MAAiB,CAAC;QACjC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,KAAK,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,CAAC;gBAAS,CAAC;YACT,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC,CAAC;IAEF,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,MAAM,SAAS,EAAE,CAAC;QAElB,uBAAuB;QACvB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;QAC3B,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE;YAC5D,IAAI,CAAC,KAAK,GAAG,OAAkB,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,WAAW,CAAC,GAAG,EAAE;QACf,IAAI,WAAW,EAAE,CAAC;YAChB,WAAW,EAAE,CAAC;QAChB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,IAAgC;QACtC,KAAK;QACL,SAAS;QACT,OAAO,EAAE,SAAS;KACnB,CAAC;AACJ,CAAC;AAsBD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CACzB,QAA0C;IAE1C,MAAM,IAAI,GAAG,GAAG,EAAW,CAAC;IAC5B,MAAM,KAAK,GAAG,GAAG,CAAe,IAAI,CAAC,CAAC;IACtC,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;IAE7B,MAAM,MAAM,GAAG,KAAK,EAAE,IAAW,EAAoB,EAAE;QACrD,IAAI,CAAC;YACH,SAAS,CAAC,KAAK,GAAG,IAAI,CAAC;YACvB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;YAEnB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,KAAK,GAAG,MAAiB,CAAC;YAC/B,OAAO,MAAiB,CAAC;QAC3B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,KAAK,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,MAAM,CAAC,CAAC;QACV,CAAC;gBAAS,CAAC;YACT,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;QAC1B,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,GAAG,EAAE;QACjB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACvB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;QACnB,SAAS,CAAC,KAAK,GAAG,KAAK,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO;QACL,IAAI,EAAE,IAAgC;QACtC,KAAK;QACL,SAAS;QACT,MAAM;QACN,KAAK;KACN,CAAC;AACJ,CAAC"}
package/package.json ADDED
@@ -0,0 +1,31 @@
1
+ {
2
+ "name": "@tthr/vue",
3
+ "version": "0.0.1",
4
+ "description": "Tether Vue/Nuxt SDK",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ }
13
+ },
14
+ "files": [
15
+ "dist"
16
+ ],
17
+ "scripts": {
18
+ "build": "tsc",
19
+ "dev": "tsc --watch",
20
+ "typecheck": "tsc --noEmit"
21
+ },
22
+ "dependencies": {
23
+ "@tthr/client": "*"
24
+ },
25
+ "devDependencies": {
26
+ "typescript": "^5.7.2"
27
+ },
28
+ "peerDependencies": {
29
+ "vue": "^3.5.0"
30
+ }
31
+ }