@fusion.dev/helix-core 0.183.0 → 0.184.0

package/custom-elements.json

@@ -14159,6 +14159,14 @@
             "package": "#audit-children"
           }
         },
+        {
+          "kind": "js",
+          "name": "auditEntry",
+          "declaration": {
+            "name": "auditEntry",
+            "package": "#audit-children"
+          }
+        },
         {
           "kind": "js",
           "name": "auditName",
@@ -25953,6 +25961,14 @@
           "type": {
             "text": "typeof audit"
           }
+        },
+        {
+          "kind": "function",
+          "name": "auditEntry",
+          "description": "The missing-entry warning in a production build: nothing. See `auditEntry`.",
+          "type": {
+            "text": "typeof entry"
+          }
         }
       ],
       "exports": [
@@ -25963,6 +25979,14 @@
             "name": "auditChildren",
             "module": "src/utils/audit-children/audit-children-off.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "auditEntry",
+          "declaration": {
+            "name": "auditEntry",
+            "module": "src/utils/audit-children/audit-children-off.ts"
+          }
         }
       ]
     },
@@ -26009,6 +26033,48 @@
             }
           ],
           "description": "Reports a child from another family that a container holds and nobody\nregistered, naming the entry to import.\n\n**A container does not register another family's children.** An option\nbelongs to the Option family, and a page writing one inside a Select imports\n`@fusion.dev/helix/option` itself, as it imports the Select. Left out, the\noption is an unknown element: the list reads no choices and nothing throws.\nThis says so, once for each container tag and child tag on the page, with\nthe line to add.\n\nAsked once the page has loaded and painted, so an entry a later module\nimports is not taken for a missing one.\n\n**In a development build only**, as `missing-name` is: every container would\npay for a sentence meant for the person writing the page. Core imports it as\n`#audit-children`, which `package.json` resolves here under the\n`development` condition and to `audit-children-off.ts`, which does nothing,\neverywhere else.\n\n`part` is the child's tag after the tier, such as `option`, and `entry` its\nfamily's entry, such as `option`; the host's `tier` gives the rest of both.\n`consequence` says what the missing child costs, after \"so\". `drawn` is for\nchildren the host draws from data, such as the options of Listbox's `items`:\nthe page wrote none, so an undefined tag is reported without one in the\nhost's light DOM."
+        },
+        {
+          "kind": "function",
+          "name": "auditEntry",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "host",
+              "type": {
+                "text": "HTMLElement"
+              }
+            },
+            {
+              "name": "attribute",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "entry",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "consequence",
+              "type": {
+                "text": "string"
+              }
+            },
+            {
+              "name": "missing",
+              "type": {
+                "text": "() => boolean"
+              }
+            }
+          ],
+          "description": "Reports a property set on a host whose behavior is in an entry of its own\nthat nobody imported, naming the entry.\n\n**The second shape of the same mistake.** Menu's filter is\n`menu/filter`, so a menu that never filters carries none of its code, and a\npage that sets `filterable` and imports only the menu gets a menu with no\nfield and nothing thrown. This says so, once for each host tag and entry on\nthe page, with the line to add.\n\n`attribute` is the one the page set, `entry` the entry after the tier's\npackage, such as `menu/filter`, and `consequence` what the missing entry\ncosts, after \"so\". `missing` is asked once the page has loaded and painted,\nso an entry a later module imports is not taken for a missing one."
         }
       ],
       "exports": [
@@ -26019,6 +26085,14 @@
             "name": "auditChildren",
             "module": "src/utils/audit-children/audit-children.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "auditEntry",
+          "declaration": {
+            "name": "auditEntry",
+            "module": "src/utils/audit-children/audit-children.ts"
+          }
         }
       ]
     },
@@ -35422,7 +35496,7 @@
           "type": {
             "text": "string"
           },
-          "default": "'0.183.0'",
+          "default": "'0.184.0'",
           "description": "The version of the package this file ships in.\n\n**Written by `fusion/scripts/version.mjs`** wherever it writes the package's\n`package.json`, and stamped back into the repository beside it after a\nrelease, so the two never disagree; a spec beside this holds them to it.\nNothing else in the running code knows which release it is."
         }
       ],
@@ -36058,6 +36132,6 @@
   ],
   "helix": {
     "package": "@fusion.dev/helix-core",
-    "version": "0.183.0"
+    "version": "0.184.0"
   }
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { auditChildren } from '@fusion.dev/helix-core/audits/children';
+export { auditChildren, auditEntry } from '@fusion.dev/helix-core/audits/children';
 export { auditName } from '@fusion.dev/helix-core/audits/name';
 export { auditNesting } from '@fusion.dev/helix-core/audits/nesting';
 export { auditServed } from '@fusion.dev/helix-core/audits/served';

package/dist/index.js

@@ -1,4 +1,4 @@
-export { auditChildren } from '@fusion.dev/helix-core/audits/children';
+export { auditChildren, auditEntry } from '@fusion.dev/helix-core/audits/children';
 export { auditName } from '@fusion.dev/helix-core/audits/name';
 export { auditNesting } from '@fusion.dev/helix-core/audits/nesting';
 export { auditServed } from '@fusion.dev/helix-core/audits/served';

package/dist/utils/audit-children/audit-children-off.d.ts

@@ -1,4 +1,4 @@
-import type { auditChildren as audit } from './audit-children.js';
+import type { auditChildren as audit, auditEntry as entry } from './audit-children.js';
 /**
  * The unregistered-child warning in a production build: nothing.
  *
@@ -8,3 +8,5 @@ import type { auditChildren as audit } from './audit-children.js';
  * builds. See `audit-children.ts`.
  */
 export declare const auditChildren: typeof audit;
+/** The missing-entry warning in a production build: nothing. See `auditEntry`. */
+export declare const auditEntry: typeof entry;

package/dist/utils/audit-children/audit-children-off.js

@@ -1 +1,2 @@
 export const auditChildren = () => { };
+export const auditEntry = () => { };

package/dist/utils/audit-children/audit-children.d.ts

@@ -26,3 +26,19 @@
  * host's light DOM.
  */
 export declare const auditChildren: (host: HTMLElement, part: string, entry: string, consequence: string, drawn?: boolean) => void;
+/**
+ * Reports a property set on a host whose behavior is in an entry of its own
+ * that nobody imported, naming the entry.
+ *
+ * **The second shape of the same mistake.** Menu's filter is
+ * `menu/filter`, so a menu that never filters carries none of its code, and a
+ * page that sets `filterable` and imports only the menu gets a menu with no
+ * field and nothing thrown. This says so, once for each host tag and entry on
+ * the page, with the line to add.
+ *
+ * `attribute` is the one the page set, `entry` the entry after the tier's
+ * package, such as `menu/filter`, and `consequence` what the missing entry
+ * costs, after "so". `missing` is asked once the page has loaded and painted,
+ * so an entry a later module imports is not taken for a missing one.
+ */
+export declare const auditEntry: (host: HTMLElement, attribute: string, entry: string, consequence: string, missing: () => boolean) => void;

package/dist/utils/audit-children/audit-children.js

@@ -1,5 +1,16 @@
 import { reportRuntime } from '../report-runtime/report-runtime.js';
 const reported = new Set();
+const afterPaint = (check) => {
+    const frame = () => {
+        requestAnimationFrame(check);
+    };
+    if (document.readyState === 'complete') {
+        frame();
+    }
+    else {
+        window.addEventListener('load', frame, { once: true });
+    }
+};
 export const auditChildren = (host, part, entry, consequence, drawn = false) => {
     if (typeof window === 'undefined') {
         return;
@@ -25,13 +36,27 @@ export const auditChildren = (host, part, entry, consequence, drawn = false) =>
             tag: host.localName,
         });
     };
-    const frame = () => {
-        requestAnimationFrame(check);
-    };
-    if (document.readyState === 'complete') {
-        frame();
+    afterPaint(check);
+};
+export const auditEntry = (host, attribute, entry, consequence, missing) => {
+    if (typeof window === 'undefined') {
+        return;
     }
-    else {
-        window.addEventListener('load', frame, { once: true });
+    const key = `${host.localName}>${entry}`;
+    if (reported.has(key)) {
+        return;
     }
+    afterPaint(() => {
+        if (reported.has(key) || !host.isConnected || !missing()) {
+            return;
+        }
+        reported.add(key);
+        const tier = host.constructor.tier ?? 'helix-headless-';
+        const pkg = tier === 'helix-' ? '@fusion.dev/helix' : '@fusion.dev/helix-headless';
+        reportRuntime({
+            kind: 'unregistered-part',
+            message: `<${host.localName}> has \`${attribute}\` and its entry is not imported, so ${consequence}. Import '${pkg}/${entry}'.`,
+            tag: host.localName,
+        });
+    });
 };

package/dist/version.d.ts

@@ -6,4 +6,4 @@
  * release, so the two never disagree; a spec beside this holds them to it.
  * Nothing else in the running code knows which release it is.
  */
-export declare const VERSION = "0.183.0";
+export declare const VERSION = "0.184.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = '0.183.0';
+export const VERSION = '0.184.0';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fusion.dev/helix-core",
   "description": "Helix element primitives: base classes, mixins, decorators, utilities.",
-  "version": "0.183.0",
+  "version": "0.184.0",
   "license": "MIT",
   "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
   "repository": {
@@ -74,12 +74,12 @@
   "bugs": "https://github.com/project-fusion/fusion/issues",
   "dependencies": {
     "@floating-ui/dom": "^1.8.0",
-    "@fusion.dev/helix-icons": "0.183.0",
+    "@fusion.dev/helix-icons": "0.184.0",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@fusion.dev/helix-cem": "0.183.0",
-    "@fusion.dev/helix-testing": "0.183.0",
+    "@fusion.dev/helix-cem": "0.184.0",
+    "@fusion.dev/helix-testing": "0.184.0",
     "@lit-labs/ssr": "^4.1.0",
     "lit": "^3.2.1"
   },