Fix reusable conditions (#62)

* Fix typing for complex reusable conditions. * add changeset
embellishing · Jul 6, 2024 · 68a6480 · 68a6480
1 parent a17ec2e
commit 68a6480
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 12 deletions.
diff --git a/.changeset/fuzzy-dogs-relate.md b/.changeset/fuzzy-dogs-relate.md
@@ -0,0 +1,6 @@
+---
+"@embellish/core": patch
+"@embellish/react": patch
+---
+
+Fixed typing for complex reusable conditions.
diff --git a/docs/api/react.createconditions.md b/docs/api/react.createconditions.md
@@ -9,7 +9,7 @@ Creates reusable conditions based on the provided hooks, each consisting of eith
 **Signature:**
 
 ```typescript
-export declare function createConditions<AvailableHooks extends Hooks<Selector>, ConditionName extends string, S extends keyof AvailableHooks = AvailableHooks extends Hooks<infer S> ? S : never>(hooks: AvailableHooks, conditions: {
+export declare function createConditions<S extends Selector, ConditionName extends string>(hooks: Hooks<S>, conditions: Record<string, Condition<S>> & {
     [Name in ConditionName]: ValidConditionName<Name> & Condition<S>;
 }): Conditions<ConditionName>;
 ```
@@ -39,7 +39,7 @@ hooks
 
 </td><td>
 
-AvailableHooks
+[Hooks](./react.hooks.md)<!-- -->&lt;S&gt;
 
 
 </td><td>
@@ -55,7 +55,7 @@ conditions
 
 </td><td>
 
-{ \[Name in ConditionName\]: [ValidConditionName](./react.validconditionname.md)<!-- -->&lt;Name&gt; &amp; [Condition](./react.condition.md)<!-- -->&lt;S&gt;; }
+Record&lt;string, [Condition](./react.condition.md)<!-- -->&lt;S&gt;&gt; &amp; { \[Name in ConditionName\]: [ValidConditionName](./react.validconditionname.md)<!-- -->&lt;Name&gt; &amp; [Condition](./react.condition.md)<!-- -->&lt;S&gt;; }
 
 
 </td><td>

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -11,7 +11,8 @@
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "prepare": "tsc"
+    "prepare": "tsc",
+    "test": "tsc --project test"
   },
   "exports": {
     ".": {

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -169,10 +169,9 @@ export type Conditions<ConditionName extends string> = Branded<
  * either a hook id or a logical combination using the `and`, `or`, and `not`
  * operators.
  *
- * @typeParam AvailableHooks - The type of hooks available for use in conditions
- * @typeParam ConditionName - The type of the names of conditions to create
  * @typeParam S - The selector logic of the hooks available for use in
  * conditions
+ * @typeParam ConditionName - The type of the names of conditions to create
  * @param hooks - The hooks available for use in conditions
  * @param conditions - The conditions to create
  *
@@ -181,14 +180,11 @@ export type Conditions<ConditionName extends string> = Branded<
  * @public
  */
 export function createConditions<
-  AvailableHooks extends Hooks<Selector>,
+  S extends Selector,
   ConditionName extends string,
-  S extends keyof AvailableHooks = AvailableHooks extends Hooks<infer S>
-    ? S
-    : never,
 >(
-  hooks: AvailableHooks,
-  conditions: {
+  hooks: Hooks<S>,
+  conditions: Record<string, Condition<S>> & {
     [Name in ConditionName]: ValidConditionName<Name> & Condition<S>;
   },
 ) {

diff --git a/packages/core/test/index.ts b/packages/core/test/index.ts
@@ -0,0 +1,16 @@
+import { createConditions, createHooks } from "../src/index.js";
+
+// type-level tests
+
+() => {
+  // complex reusable conditions
+  const { hooks } = createHooks([
+    "@media (prefers-color-scheme: dark)",
+    "&:hover",
+    "&.active",
+  ]);
+  createConditions(hooks, {
+    dark: "@media (prefers-color-scheme: dark)",
+    hoverUnselected: { and: ["&:hover", { not: "&.active" }] },
+  });
+};
diff --git a/packages/core/test/tsconfig.json b/packages/core/test/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "include": ["."]
+}