query-keys 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,66 @@
+# query-keys
+
+A fully typed, simple utility for your query keys.
+
+## Installation
+
+```sh
+pnpm add query-keys
+# or
+npm install query-keys
+# or
+bun add query-keys
+# or
+yarn add query-keys
+```
+
+## Usage
+
+Create your query keys object for your whole app, or for a specific part:
+
+```ts
+import { createQueryKeys } from "query-keys";
+
+export const queryKeys = createQueryKeys({
+	todos: {
+		all: null, // ["todos", "all"]
+		id: (id: number) => id, // ["todos", "id", <id>]
+	},
+});
+
+// or:
+
+export const todoQueryKeys = createQueryKeys("todos", {
+	all: null, // ["todos", "all"]
+	id: (id: number) => id, // ["todos", "id", <id>]
+});
+```
+
+Then, use your keys like:
+
+```ts
+const { data: allTodos } = useQuery({
+	queryKey: queryKeys.todos.all, // typed!
+	queryFn: async () => {
+		// ...
+	},
+});
+
+const { data: specificTodo } = useQuery({
+	queryKey: todoQueryKeys.id(todoId), // typed!
+	queryFn: async () => {
+		// ...
+	},
+});
+```
+
+Use `null` to let the object key be the query key. Use a string or a number, or an array of string or numbers to add specific keys to the query key.
+Use a function to get a dynamic query key depending on an external parameter.
+
+## Credit
+
+The API is very inspired by [@lukemorales/query-key-factory](https://npmx.dev/package/@lukemorales/query-key-factory), but with Tanstack Query's [Options API](https://tkdodo.eu/blog/the-query-options-api) I do not see the need for such a powerhouse anymore.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -1,8 +1,11 @@
 //#region src/index.d.ts
 interface NestedKeys {
-  [key: string]: ((...args: never[]) => unknown) | string | number | null | NestedKeys;
+  [key: string]: ((...args: any[]) => unknown) | (string | number)[] | string | number | null | NestedKeys;
 }
-type QueryKeys<Path extends string[], KeysDef extends NestedKeys> = { [K in keyof KeysDef]: KeysDef[K] extends ((...args: infer Args) => infer Return) ? (...args: Args) => [...Path, K, ...(Return extends unknown[] ? Return : [Return])] : KeysDef[K] extends NestedKeys ? K extends string ? QueryKeys<[...Path, K], KeysDef[K]> : never : KeysDef[K] extends string | number ? [...Path, K, KeysDef[K] extends string | number ? KeysDef[K] : never] : KeysDef[K] extends null ? [...Path, K] : never };
-declare function createQueryKeys<Root extends string, KeysDef extends NestedKeys>(root: Root, definition: KeysDef): QueryKeys<Root[], KeysDef>;
+type QueryKeys<Path extends string[] | undefined, KeysDef extends NestedKeys> = (Path extends undefined ? {} : {
+  _def: Path;
+}) & { [K in keyof KeysDef]: KeysDef[K] extends ((...args: infer Args) => infer Return) ? (...args: Args) => [...(Path extends undefined ? [] : Path), K, ...(Return extends unknown[] ? Return : [Return])] : KeysDef[K] extends NestedKeys ? K extends string ? QueryKeys<[...(Path extends undefined ? [] : Path), K], KeysDef[K]> : never : KeysDef[K] extends (string | number)[] ? [...(Path extends undefined ? [] : Path), K, ...KeysDef[K]] : KeysDef[K] extends string | number ? [...(Path extends undefined ? [] : Path), K, KeysDef[K]] : KeysDef[K] extends null ? [...(Path extends undefined ? [] : Path), K] : never };
+declare function createQueryKeys<KeysDef extends NestedKeys>(definition: KeysDef): QueryKeys<undefined, KeysDef>;
+declare function createQueryKeys<Root extends string, KeysDef extends NestedKeys>(root: Root, definition: KeysDef): QueryKeys<[Root], KeysDef>;
 //#endregion
 export { QueryKeys, createQueryKeys };

package/dist/index.mjs

@@ -1,6 +1,6 @@
 //#region src/index.ts
 function recCreateQueryKeys(root, definition) {
-	const result = { _def: root };
+	const result = root.length ? { _def: root } : {};
 	for (const key in definition) {
 		if (!Object.hasOwn(definition, key)) continue;
 		const element = definition[key];
@@ -12,7 +12,7 @@ function recCreateQueryKeys(root, definition) {
 				...Array.isArray(ret) ? ret : [ret]
 			];
 		};
-		else if (typeof element === "object" && element !== null) result[key] = recCreateQueryKeys([...root, key], element);
+		else if (typeof element === "object" && !Array.isArray(element) && element !== null) result[key] = recCreateQueryKeys([...root, key], element);
 		else {
 			const lastKey = Array.isArray(element) ? element : element === null ? [] : [element];
 			result[key] = [
@@ -24,8 +24,11 @@ function recCreateQueryKeys(root, definition) {
 	}
 	return result;
 }
-function createQueryKeys(root, definition) {
-	return recCreateQueryKeys([root], definition);
+function createQueryKeys(rootOrDef, defOrEmpty) {
+	const root = typeof rootOrDef === "string" ? [rootOrDef] : [];
+	const def = typeof rootOrDef === "string" ? defOrEmpty : rootOrDef;
+	if (def === void 0) throw new Error("Query keys definition is required");
+	return recCreateQueryKeys(root, def);
 }
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "query-keys",
 	"type": "module",
-	"version": "0.0.1",
+	"version": "0.1.0",
 	"private": false,
 	"description": "A fully typed, simple utility for your query keys.",
 	"exports": {
@@ -16,12 +16,16 @@
 	],
 	"scripts": {
 		"build": "tsdown",
-		"dev": "tsdown --watch"
+		"dev": "tsdown --watch",
+		"test": "vitest",
+		"ts": "tsc --noEmit",
+		"publish": "pnpm test run && pnpm ts && pnpm build && npm publish"
 	},
 	"devDependencies": {
 		"@arethetypeswrong/core": "^0.18.2",
 		"publint": "^0.3.17",
 		"tsdown": "^0.18.1",
-		"typescript": "^5.9.3"
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.18"
 	}
 }