npm - @pyreon/head - Versions diffs - 0.21.0 → 0.23.0 - Mend

@pyreon/head 0.21.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/README.md +146 -28
package/lib/_chunks/use-head-B8n30QMl.js +214 -0
package/lib/analysis/index.js.html +1 -1
package/lib/context.js +62 -0
package/lib/index.js +4 -317
package/lib/provider.js +2 -59
package/lib/ssr.js +2 -59
package/lib/types/context.d.ts +205 -0
package/lib/use-head.js +3 -216
package/package.json +12 -7
package/src/tests/context-identity.test.ts +126 -0
package/lib/analysis/provider.js.html +0 -5406
package/lib/analysis/ssr.js.html +0 -5406
package/lib/analysis/use-head.js.html +0 -5406

package/lib/use-head.js CHANGED Viewed

@@ -1,217 +1,4 @@
-import { createContext, onMount, onUnmount, useContext } from "@pyreon/core";
-import { effect } from "@pyreon/reactivity";
+import "./context.js";
+import { t as useHead } from "./_chunks/use-head-B8n30QMl.js";
-//#region src/context.ts
-const HeadContext = createContext(null);
-//#endregion
-//#region src/dom.ts
-const ATTR = "data-pyreon-head";
-/** Tracks managed elements by key — avoids querySelectorAll on every sync */
-const managedElements = /* @__PURE__ */ new Map();
-/**
-* Sync the resolved head tags to the real DOM <head>.
-* Uses incremental diffing: matches existing elements by key, patches attributes
-* in-place, adds new elements, and removes stale ones.
-* Also syncs htmlAttrs, bodyAttrs, and applies titleTemplate.
-* No-op on the server (typeof document === "undefined").
-*/
-function patchExistingTag(found, tag, kept) {
-	kept.add(found.getAttribute(ATTR));
-	patchAttrs(found, tag.props);
-	const content = String(tag.children);
-	if (found.textContent !== content) found.textContent = content;
-}
-function createNewTag(tag) {
-	if (typeof document === "undefined") return;
-	const el = document.createElement(tag.tag);
-	const key = tag.key;
-	el.setAttribute(ATTR, key);
-	for (const [k, v] of Object.entries(tag.props)) el.setAttribute(k, v);
-	if (tag.children) el.textContent = tag.children;
-	document.head.appendChild(el);
-	managedElements.set(key, el);
-}
-function syncDom(ctx) {
-	if (typeof document === "undefined") return;
-	const tags = ctx.resolve();
-	const titleTemplate = ctx.resolveTitleTemplate();
-	let needsSeed = managedElements.size === 0;
-	if (!needsSeed) {
-		const sample = managedElements.values().next().value;
-		if (sample && !sample.isConnected) {
-			managedElements.clear();
-			needsSeed = true;
-		}
-	}
-	if (needsSeed) {
-		const existing = document.head.querySelectorAll(`[${ATTR}]`);
-		for (const el of existing) managedElements.set(el.getAttribute(ATTR), el);
-	}
-	const kept = /* @__PURE__ */ new Set();
-	for (const tag of tags) {
-		if (tag.tag === "title") {
-			document.title = applyTitleTemplate(String(tag.children), titleTemplate);
-			continue;
-		}
-		const key = tag.key;
-		const found = managedElements.get(key);
-		if (found && found.tagName.toLowerCase() === tag.tag) patchExistingTag(found, tag, kept);
-		else {
-			if (found) {
-				found.remove();
-				managedElements.delete(key);
-			}
-			createNewTag(tag);
-			kept.add(key);
-		}
-	}
-	for (const [key, el] of managedElements) if (!kept.has(key)) {
-		el.remove();
-		managedElements.delete(key);
-	}
-	syncElementAttrs(document.documentElement, ctx.resolveHtmlAttrs());
-	syncElementAttrs(document.body, ctx.resolveBodyAttrs());
-}
-/** Patch an element's attributes to match the desired props. */
-function patchAttrs(el, props) {
-	for (let i = el.attributes.length - 1; i >= 0; i--) {
-		const attr = el.attributes[i];
-		if (!attr || attr.name === ATTR) continue;
-		if (!(attr.name in props)) el.removeAttribute(attr.name);
-	}
-	for (const [k, v] of Object.entries(props)) if (el.getAttribute(k) !== v) el.setAttribute(k, v);
-}
-function applyTitleTemplate(title, template) {
-	if (!template) return title;
-	if (typeof template === "function") return template(title);
-	return template.replace(/%s/g, title);
-}
-/** Sync pyreon-managed attributes on <html> or <body>. */
-function syncElementAttrs(el, attrs) {
-	const managed = el.getAttribute(`${ATTR}-attrs`);
-	if (managed) {
-		for (const name of managed.split(",")) if (name && !(name in attrs)) el.removeAttribute(name);
-	}
-	const keys = [];
-	for (const [k, v] of Object.entries(attrs)) {
-		keys.push(k);
-		if (el.getAttribute(k) !== v) el.setAttribute(k, v);
-	}
-	if (keys.length > 0) el.setAttribute(`${ATTR}-attrs`, keys.join(","));
-	else if (managed) el.removeAttribute(`${ATTR}-attrs`);
-}
-//#endregion
-//#region src/use-head.ts
-/** Cast a strict tag interface to the internal props format, stripping undefined values */
-function toProps(obj) {
-	const result = {};
-	for (const [k, v] of Object.entries(obj)) if (v !== void 0) result[k] = v;
-	return result;
-}
-function buildEntry(o) {
-	const tags = [];
-	if (o.title != null) tags.push({
-		tag: "title",
-		key: "title",
-		children: o.title
-	});
-	o.meta?.forEach((m, i) => {
-		tags.push({
-			tag: "meta",
-			key: m.name ?? m.property ?? `meta-${i}`,
-			props: toProps(m)
-		});
-	});
-	o.link?.forEach((l, i) => {
-		tags.push({
-			tag: "link",
-			key: l.href ? `link-${l.rel || ""}-${l.href}` : l.rel ? `link-${l.rel}` : `link-${i}`,
-			props: toProps(l)
-		});
-	});
-	o.script?.forEach((s, i) => {
-		const { children, ...rest } = s;
-		tags.push({
-			tag: "script",
-			key: s.src ?? `script-${i}`,
-			props: toProps(rest),
-			...children != null ? { children } : {}
-		});
-	});
-	o.style?.forEach((s, i) => {
-		const { children, ...rest } = s;
-		tags.push({
-			tag: "style",
-			key: `style-${i}`,
-			props: toProps(rest),
-			children
-		});
-	});
-	o.noscript?.forEach((ns, i) => {
-		tags.push({
-			tag: "noscript",
-			key: `noscript-${i}`,
-			children: ns.children
-		});
-	});
-	if (o.jsonLd) tags.push({
-		tag: "script",
-		key: "jsonld",
-		props: { type: "application/ld+json" },
-		children: JSON.stringify(o.jsonLd)
-	});
-	if (o.speculationRules) tags.push({
-		tag: "script",
-		key: "speculationrules",
-		props: { type: "speculationrules" },
-		children: JSON.stringify(o.speculationRules)
-	});
-	if (o.base) tags.push({
-		tag: "base",
-		key: "base",
-		props: toProps(o.base)
-	});
-	return {
-		tags,
-		titleTemplate: o.titleTemplate,
-		htmlAttrs: o.htmlAttrs,
-		bodyAttrs: o.bodyAttrs
-	};
-}
-/**
-* Register head tags (title, meta, link, script, style, noscript, base, jsonLd)
-* for the current component.
-*
-* Accepts a static object or a reactive getter:
-*   useHead({ title: "My Page", meta: [{ name: "description", content: "..." }] })
-*   useHead(() => ({ title: `${count()} items` }))  // updates when signal changes
-*
-* Tags are deduplicated by key — innermost component wins.
-* Requires a <HeadProvider> (CSR) or renderWithHead() (SSR) ancestor.
-*/
-function useHead(input) {
-	const ctx = useContext(HeadContext);
-	if (!ctx) return;
-	const id = Symbol();
-	if (typeof input === "function") if (typeof document !== "undefined") effect(() => {
-		ctx.add(id, buildEntry(input()));
-		syncDom(ctx);
-	});
-	else ctx.add(id, buildEntry(input()));
-	else {
-		ctx.add(id, buildEntry(input));
-		onMount(() => {
-			syncDom(ctx);
-		});
-	}
-	onUnmount(() => {
-		ctx.remove(id);
-		syncDom(ctx);
-	});
-}
-//#endregion
-export { useHead };
-//# sourceMappingURL=use-head.js.map
+export { useHead };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@pyreon/head",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "Head tag management for Pyreon — works in SSR and CSR",
   "homepage": "https://github.com/pyreon/pyreon/tree/main/packages/head#readme",
   "bugs": {
@@ -30,6 +30,11 @@
       "import": "./lib/index.js",
       "types": "./lib/types/index.d.ts"
     },
+    "./context": {
+      "bun": "./src/context.ts",
+      "import": "./lib/context.js",
+      "types": "./lib/types/context.d.ts"
+    },
     "./provider": {
       "bun": "./src/provider.ts",
       "import": "./lib/provider.js",
@@ -59,16 +64,16 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@pyreon/core": "^0.21.0",
-    "@pyreon/reactivity": "^0.21.0",
-    "@pyreon/runtime-server": "^0.21.0"
+    "@pyreon/core": "^0.23.0",
+    "@pyreon/reactivity": "^0.23.0",
+    "@pyreon/runtime-server": "^0.23.0"
   },
   "devDependencies": {
     "@happy-dom/global-registrator": "^20.8.9",
     "@pyreon/manifest": "0.13.1",
-    "@pyreon/runtime-dom": "^0.21.0",
-    "@pyreon/runtime-server": "^0.21.0",
-    "@pyreon/test-utils": "^0.13.8",
+    "@pyreon/runtime-dom": "^0.23.0",
+    "@pyreon/runtime-server": "^0.23.0",
+    "@pyreon/test-utils": "^0.13.10",
     "@vitest/browser-playwright": "^4.1.4"
   },
   "peerDependenciesMeta": {

package/src/tests/context-identity.test.ts ADDED Viewed

@@ -0,0 +1,126 @@
+/**
+ * Bundle-level regression: `HeadContext` is constructed in EXACTLY ONE
+ * place across the published `lib/` artifacts.
+ *
+ * The bug this test exists to catch: `@pyreon/head@0.21.0` shipped four
+ * sub-entries (`lib/{index,provider,use-head,ssr}.js`) and the shared
+ * `@vitus-labs/tools-rolldown` (< 2.4.0) invoked rolldown ONCE PER
+ * SUB-ENTRY (no cross-entry shared chunks). Result: every sub-bundle
+ * independently inlined `context.ts` and ran its own `createContext(null)`
+ * at module init — each call minted a unique `Symbol.for(...).id`, so a
+ * `useContext(HeadContext)` lookup in one bundle (e.g. the app's
+ * `useHead` from `lib/use-head.js`) silently MISSED a
+ * `provide(HeadContext)` from another (e.g. `renderWithHead` from
+ * `lib/ssr.js`). The bug was invisible in dev / source-mode tests because
+ * Vite's `bun` condition resolves to a single shared `src/context.ts`
+ * (ESM single-evaluation guarantee), but SSG output silently dropped
+ * every `useHead()`-registered tag — bad for SEO, social scrapers,
+ * accessibility, no-JS.
+ *
+ * The durable fix lives upstream in `@vitus-labs/tools-rolldown >= 2.4.0`:
+ * the build tool now creates SHARED CHUNKS across sub-entries, so the
+ * shared `context.ts` gets hoisted into a single chunk (`lib/context.js`)
+ * that every other sub-entry imports via relative-path `./context.js`.
+ * `createContext(null)` runs exactly once at runtime; `HeadContext` is
+ * one Symbol across every sub-entry's bundle. No per-package
+ * externalization / self-package-import workaround needed.
+ *
+ * Structural assertions (the BUG-CLASS-LOCK — same intent, cleaner shape):
+ *   1. `lib/context.js` is the ONLY bundle that calls `createContext(`.
+ *   2. EVERY other published JS file under `lib/` (including
+ *      `lib/_chunks/*.js` shared chunks the tool emits) has ZERO
+ *      `createContext` references — they all import `HeadContext` from
+ *      `./context.js`, sharing the single Symbol identity.
+ *
+ * Together these invariants make the bug class structurally impossible
+ * to re-introduce silently — any future regression (e.g. downgrade of
+ * the build tool below 2.4.0, or a build-config change that re-enables
+ * per-entry inlining) flips one of the per-bundle counters and trips
+ * the assertion. Bisect-verified by reverting the
+ * `@vitus-labs/tools-rolldown` bump: every non-context sub-bundle gets
+ * its own inlined `createContext(null)` call (2 occurrences each), and
+ * the second assertion fails on the first non-context bundle.
+ */
+import { existsSync, readdirSync, readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
+import { describe, expect, it } from 'vitest'
+const PKG_ROOT = resolve(__dirname, '..', '..')
+const LIB_DIR = resolve(PKG_ROOT, 'lib')
+const libExists = existsSync(resolve(LIB_DIR, 'index.js'))
+const read = (rel: string) => readFileSync(resolve(LIB_DIR, rel), 'utf8')
+/** Every published JS file under lib/ (incl. _chunks/), excluding source maps. */
+function publishedJsFiles(): string[] {
+  const out: string[] = []
+  for (const entry of readdirSync(LIB_DIR, { withFileTypes: true })) {
+    if (entry.isFile() && entry.name.endsWith('.js')) out.push(entry.name)
+    else if (entry.isDirectory() && entry.name === '_chunks') {
+      for (const sub of readdirSync(resolve(LIB_DIR, entry.name))) {
+        if (sub.endsWith('.js')) out.push(`_chunks/${sub}`)
+      }
+    }
+  }
+  return out
+}
+/**
+ * The bundle gate runs only when `lib/` has been built — `bun install`'s
+ * postinstall bootstrap rebuilds whenever sources are newer than lib, so
+ * in a normal dev session lib is always present. CI installs run the
+ * same bootstrap. The `skip` is a defensive escape so the suite doesn't
+ * false-fail in a partial worktree state where the user manually
+ * deleted lib/.
+ */
+describe.skipIf(!libExists)(
+  '@pyreon/head bundle-level HeadContext identity (regression for the SSG-Meta-dropped bug)',
+  () => {
+    // ── Invariant 1: ONE createContext call across all bundles ───────
+    //
+    // `lib/context.js` is the canonical single chunk. Every other
+    // sub-bundle / shared chunk should import `HeadContext` from it,
+    // NOT inline a fresh `createContext(null)` call.
+    it('lib/context.js is the SINGLE bundle that calls createContext()', () => {
+      const src = read('context.js')
+      // 2 occurrences = the `import { createContext }` line + the actual
+      // `createContext(null)` call at module init. This is the SOURCE OF
+      // TRUTH for HeadContext's Symbol identity.
+      expect(src.match(/createContext/g)?.length ?? 0).toBe(2)
+      expect(src).toContain('createContext(null)')
+    })
+    // ── Invariant 2: ZERO createContext references in EVERY other JS ──
+    //
+    // Covers both the top-level sub-entries AND the `_chunks/*.js` files
+    // the build tool now emits — any file that contains `createContext`
+    // would be running it at module-init and minting its own Symbol.
+    it('NO other lib/*.js (or lib/_chunks/*.js) calls createContext()', () => {
+      const offenders: Array<{ file: string; count: number }> = []
+      for (const rel of publishedJsFiles()) {
+        if (rel === 'context.js') continue
+        const count = read(rel).match(/createContext/g)?.length ?? 0
+        if (count > 0) offenders.push({ file: rel, count })
+      }
+      expect(offenders).toEqual([])
+    })
+    // ── Invariant 3: the package.json wiring that enables it ─────────
+    //
+    // The `./context` sub-export gives `HeadContext` a stable public
+    // address. Locking it here means a future revert immediately fails
+    // the test.
+    it('package.json declares the ./context sub-export', () => {
+      const pkg = JSON.parse(read('../package.json')) as {
+        exports: Record<string, { bun?: string; import?: string; types?: string }>
+      }
+      expect(pkg.exports['./context']).toBeDefined()
+      expect(pkg.exports['./context']?.import).toBe('./lib/context.js')
+      expect(pkg.exports['./context']?.bun).toBe('./src/context.ts')
+    })
+  },
+)