query-keys 0.0.2 → 0.1.1

package/README.md

@@ -16,11 +16,20 @@ yarn add query-keys
 
 ## Usage
 
-Create your query keys object:
+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>]
@@ -31,7 +40,7 @@ Then, use your keys like:
 
 ```ts
 const { data: allTodos } = useQuery({
-	queryKey: todoQueryKeys.all, // typed!
+	queryKey: queryKeys.todos.all, // typed!
 	queryFn: async () => {
 		// ...
 	},
@@ -50,7 +59,7 @@ 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.
+The API is very much 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
 

package/dist/index.d.mts

@@ -1,8 +1,41 @@
 //#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 };
+/**
+ * Creates a structured set of query keys based on the provided definition.
+ *
+ * ```ts
+ *	const keys = createQueryKeys({
+ *		users: {
+ *			all: null,
+ *			byId: (id: string) => id,
+ *		},
+ *	});
+ *
+ * console.log(keys.users.all); // Output: ["users", "all"]
+ * console.log(keys.users.byId("123")); // Output: ["users", "byId", "123"]
+ * ```
+ */
+declare function createQueryKeys<KeysDef extends NestedKeys>(definition: KeysDef): QueryKeys<undefined, KeysDef>;
+/**
+ * Creates a structured set of query keys with a root prefix based on the provided definition.
+ *
+ * ```ts
+ *	const apiKeys = createQueryKeys("api", {
+ *		users: {
+ *			all: null,
+ *			byId: (id: string) => id,
+ *		},
+ *	});
+ *
+ * console.log(apiKeys.users.all); // Output: ["api", "users", "all"]
+ * console.log(apiKeys.users.byId("123")); // Output: ["api", "users", "byId", "123"]
+ * ```
+ */
+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,9 +24,16 @@ 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);
 }
+createQueryKeys("api", { users: {
+	all: "etst",
+	byId: (id) => id
+} });
 
 //#endregion
 export { createQueryKeys };

package/package.json

@@ -1,27 +1,54 @@
 {
 	"name": "query-keys",
-	"type": "module",
-	"version": "0.0.2",
+	"version": "0.1.1",
 	"private": false,
 	"description": "A fully typed, simple utility for your query keys.",
-	"exports": {
-		".": "./dist/index.mjs",
-		"./package.json": "./package.json"
+	"keywords": [
+		"query-keys",
+		"react-query",
+		"tanstack-query",
+		"typescript",
+		"utility"
+	],
+	"homepage": "https://github.com/symsmith/query-keys",
+	"bugs": {
+		"url": "https://github.com/symsmith/query-keys/issues"
+	},
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/symsmith/query-keys.git"
 	},
-	"main": "./dist/index.mjs",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.mts",
 	"files": [
 		"dist"
 	],
+	"type": "module",
+	"main": "./dist/index.mjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.mts",
+	"exports": {
+		".": "./dist/index.mjs",
+		"./package.json": "./package.json"
+	},
 	"scripts": {
 		"build": "tsdown",
-		"dev": "tsdown --watch"
+		"dev": "tsdown --watch",
+		"test": "vitest",
+		"ts": "tsc --noEmit",
+		"fmt": "oxfmt",
+		"fmt:check": "oxfmt --check",
+		"lint": "oxlint --type-aware --report-unused-disable-directives --deny-warnings",
+		"check": "pnpm fmt:check && pnpm lint && pnpm test run && pnpm ts && pnpm build",
+		"npm:publish": "pnpm fmt:check && pnpm lint && pnpm test run && pnpm ts && pnpm build && npm publish"
 	},
 	"devDependencies": {
 		"@arethetypeswrong/core": "^0.18.2",
+		"oxfmt": "^0.28.0",
+		"oxlint": "^1.43.0",
+		"oxlint-tsgolint": "^0.11.5",
 		"publint": "^0.3.17",
 		"tsdown": "^0.18.1",
-		"typescript": "^5.9.3"
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.18"
 	}
 }