@wisemen/vue-core-api-utils 0.0.1-beta.3 → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Wisemen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/{index.d.ts → index.d.mts}

@@ -1,6 +1,6 @@
-import { Result } from "neverthrow";
 import * as vue0 from "vue";
 import { ComputedRef, MaybeRef, Ref, UnwrapRef } from "vue";
+import { Result } from "neverthrow";
 
 //#region src/types/queryKeys.type.d.ts
 interface QueryKeys {}

package/dist/index.mjs

@@ -0,0 +1,233 @@
+import { useInfiniteQuery, useMutation as useMutation$1, useQuery as useQuery$1, useQueryClient } from "@tanstack/vue-query";
+import { computed } from "vue";
+import { err, ok } from "neverthrow";
+
+//#region src/composables/mutation/mutation.composable.ts
+function useMutation(options) {
+	const isDebug = options.isDebug ?? false;
+	const queryClient = useQueryClient();
+	async function onSuccess(responseData, params) {
+		await Promise.all(Object.entries(options.queryKeysToInvalidate).map(async ([queryKey, queryKeyParams]) => {
+			const qkp = queryKeyParams;
+			const paramsWithValues = Object.entries(qkp).reduce((acc, [key, value]) => {
+				acc[key] = value(params, responseData);
+				return acc;
+			}, {});
+			if (isDebug) console.log(`[MUTATION] Invalidating ${queryKey}`, paramsWithValues);
+			await queryClient.invalidateQueries({
+				exact: false,
+				queryKey: [queryKey, paramsWithValues]
+			});
+		}));
+	}
+	const mutation = useMutation$1({
+		mutationFn: options.queryFn,
+		onSuccess: async (data, variables) => {
+			if (variables !== void 0 && "params" in variables) {
+				await onSuccess(data, variables.params);
+				return;
+			}
+			await onSuccess(data, {});
+		}
+	});
+	async function execute(data) {
+		return await mutation.mutateAsync(data);
+	}
+	return {
+		isLoading: computed(() => mutation.isPending.value),
+		data: computed(() => mutation.data.value),
+		execute
+	};
+}
+
+//#endregion
+//#region src/config/config.ts
+const DEFAULT_LIMIT$2 = 20;
+const DEFAULT_PREFETCH_STALE_TIME = 60;
+const QUERY_CONFIG = {
+	prefetchStaleTime: DEFAULT_PREFETCH_STALE_TIME,
+	limit: DEFAULT_LIMIT$2
+};
+function setQueryConfig(config) {
+	if (config.limit != null && config.limit > 0) QUERY_CONFIG.limit = config.limit;
+	if (config.prefetchStaleTime != null && config.prefetchStaleTime > 0) QUERY_CONFIG.prefetchStaleTime = config.prefetchStaleTime;
+}
+
+//#endregion
+//#region src/composables/query/keysetInfiniteQuery.composable.ts
+const DEFAULT_LIMIT$1 = QUERY_CONFIG.limit;
+function useKeysetInfiniteQuery(options) {
+	function getQueryKey() {
+		const [queryKey, params] = Object.entries(options.queryKey)[0];
+		return [queryKey, params];
+	}
+	const infiniteQuery = useInfiniteQuery({
+		staleTime: options.staleTime,
+		enabled: options.isEnabled,
+		getNextPageParam: (lastPage) => {
+			if (lastPage.isErr()) return null;
+			return lastPage.value.meta.next ?? null;
+		},
+		initialPageParam: void 0,
+		placeholderData: (data) => data,
+		queryFn: ({ pageParam }) => options.queryFn({
+			key: pageParam,
+			limit: options.limit ?? DEFAULT_LIMIT$1
+		}),
+		queryKey: getQueryKey()
+	});
+	const hasError = computed(() => {
+		return Boolean(infiniteQuery.data.value?.pages.find((page) => page.isErr()));
+	});
+	const result = computed(() => {
+		const firstError = infiniteQuery.data.value?.pages.find((page) => page.isErr());
+		if (firstError) return err(firstError.error);
+		const data = infiniteQuery.data.value?.pages.filter((page) => page.isOk()).flatMap((page) => page.value.data) ?? [];
+		const firstPage = infiniteQuery.data.value?.pages[0];
+		const meta = firstPage?.isOk() ? firstPage.value.meta : {
+			next: null,
+			total: data.length
+		};
+		return ok({
+			data,
+			meta: { next: infiniteQuery.hasNextPage.value ? meta.next : null }
+		});
+	});
+	function fetchNextPage() {
+		if (!infiniteQuery.hasNextPage.value || infiniteQuery.isFetchingNextPage.value) return;
+		return infiniteQuery.fetchNextPage();
+	}
+	return {
+		hasNextPage: computed(() => infiniteQuery.hasNextPage.value),
+		isError: computed(() => hasError.value),
+		isFetching: computed(() => infiniteQuery.isFetching.value),
+		isFetchingNextPage: computed(() => infiniteQuery.isFetchingNextPage.value),
+		isLoading: computed(() => infiniteQuery.isLoading.value),
+		isSuccess: computed(() => !hasError.value),
+		fetchNextPage: async () => {
+			await fetchNextPage();
+		},
+		refetch: async () => {
+			await infiniteQuery.refetch();
+		},
+		result
+	};
+}
+
+//#endregion
+//#region src/composables/query/offsetInfiniteQuery.composable.ts
+const DEFAULT_LIMIT = QUERY_CONFIG.limit;
+function useOffsetInfiniteQuery(options) {
+	function getQueryKey() {
+		const [first] = Object.entries(options.queryKey);
+		if (!first) return [];
+		const [queryKey, params] = first;
+		return [queryKey, params];
+	}
+	const infiniteQuery = useInfiniteQuery({
+		staleTime: options.staleTime,
+		enabled: options.isEnabled,
+		getNextPageParam: (lastPage) => {
+			if (lastPage.isErr()) return null;
+			const total = lastPage.value.meta.offset + lastPage.value.meta.limit;
+			if (total >= lastPage.value.meta.total) return null;
+			return total;
+		},
+		initialPageParam: 0,
+		placeholderData: (data) => data,
+		queryFn: ({ pageParam }) => options.queryFn({
+			limit: options.limit ?? DEFAULT_LIMIT,
+			offset: pageParam ?? 0
+		}),
+		queryKey: getQueryKey()
+	});
+	const hasError = computed(() => {
+		return Boolean(infiniteQuery.data.value?.pages.find((page) => page.isErr()));
+	});
+	const result = computed(() => {
+		const firstError = infiniteQuery.data.value?.pages.find((page) => page.isErr());
+		if (firstError) return err(firstError.error);
+		const data = infiniteQuery.data.value?.pages.filter((page) => page.isOk()).flatMap((page) => page.value.data) ?? [];
+		const firstPage = infiniteQuery.data.value?.pages[0];
+		const meta = firstPage?.isOk() ? firstPage.value.meta : null;
+		return ok({
+			data,
+			meta: {
+				limit: meta?.limit ?? 0,
+				offset: meta?.offset ?? 0,
+				total: meta?.total ?? data.length
+			}
+		});
+	});
+	function fetchNextPage() {
+		if (!infiniteQuery.hasNextPage.value || infiniteQuery.isFetchingNextPage.value) return;
+		return infiniteQuery.fetchNextPage();
+	}
+	return {
+		hasNextPage: computed(() => infiniteQuery.hasNextPage.value),
+		isError: computed(() => hasError.value),
+		isFetching: computed(() => infiniteQuery.isFetching.value),
+		isFetchingNextPage: computed(() => infiniteQuery.isFetchingNextPage.value),
+		isLoading: computed(() => infiniteQuery.isLoading.value),
+		isSuccess: computed(() => !hasError.value),
+		fetchNextPage: async () => {
+			await fetchNextPage();
+		},
+		refetch: async () => {
+			await infiniteQuery.refetch();
+		},
+		result
+	};
+}
+
+//#endregion
+//#region src/composables/query/prefetchQuery.composable.ts
+function usePrefetchQuery(query) {
+	const queryClient = useQueryClient();
+	function getQueryKey() {
+		const [first] = Object.entries(query.queryKey);
+		if (!first) return [];
+		const [queryKey, params] = first;
+		return [queryKey, params];
+	}
+	async function execute() {
+		await queryClient.prefetchQuery({
+			staleTime: query.staleTime ?? QUERY_CONFIG.prefetchStaleTime,
+			queryFn: query.queryFn,
+			queryKey: getQueryKey()
+		});
+	}
+	return { execute };
+}
+
+//#endregion
+//#region src/composables/query/query.composable.ts
+function useQuery(options) {
+	const isDebug = options.isDebug ?? false;
+	const query = useQuery$1({
+		staleTime: options.staleTime,
+		enabled: options.isEnabled,
+		placeholderData: (data) => data,
+		queryFn: options.queryFn,
+		queryKey: getQueryKey()
+	});
+	function getQueryKey() {
+		const [queryKey, params] = Object.entries(options.queryKey)[0];
+		if (isDebug) console.debug(`Create query with key ${queryKey}`, params);
+		return [queryKey, params];
+	}
+	async function refetch() {
+		await query.refetch();
+	}
+	return {
+		isError: computed(() => query.data.value?.isErr() ?? false),
+		isFetching: computed(() => query.isFetching.value),
+		isLoading: computed(() => query.isLoading.value),
+		isSuccess: computed(() => query.data.value?.isOk() ?? false),
+		refetch,
+		result: computed(() => query.data.value ?? null)
+	};
+}
+
+//#endregion
+export { setQueryConfig, useKeysetInfiniteQuery, useMutation, useOffsetInfiniteQuery, usePrefetchQuery, useQuery };

package/package.json

@@ -4,37 +4,38 @@
     "access": "public"
   },
   "type": "module",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1",
   "license": "MIT",
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.umd.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "typings": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "typings": "./dist/index.d.mts",
   "files": [
     "./dist"
   ],
   "peerDependencies": {
-    "@tanstack/vue-query": "5.90.2",
-    "neverthrow": "^8.2.0"
+    "@tanstack/vue-query": ">=5.90.5",
+    "neverthrow": ">=8.2.0",
+    "vue": ">=3.5.22"
   },
   "devDependencies": {
-    "@types/node": "24.5.2",
-    "@wisemen/eslint-config-vue": "1.7.3",
-    "eslint": "9.36.0",
-    "tsdown": "0.15.4",
-    "typescript": "5.9.2",
-    "vitest": "3.2.4",
-    "vue": "3.5.21"
+    "@types/node": "24.8.1",
+    "eslint": "9.39.2",
+    "tsdown": "0.18.4",
+    "typescript": "5.9.3",
+    "vitest": "4.0.17",
+    "@wisemen/eslint-config-vue": "2.0.0"
   },
   "scripts": {
     "build": "tsdown",
+    "dev": "tsdown --watch",
     "pub:release": "pnpm publish --access public",
     "pub:beta": "pnpm publish --no-git-checks --access public --tag beta",
     "pub:next": "pnpm publish --no-git-checks --access public --tag next",