@barefootjs/shared 0.13.0 → 0.15.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { BF_SCOPE, BF_SLOT, BF_HOST, BF_AT, BF_ROOT, BF_PROPS, BF_COND, BF_ITEM, BF_PORTAL_OWNER, BF_PORTAL_ID, BF_PORTAL_PLACEHOLDER, BF_PARENT_OWNED_PREFIX, BF_SCOPE_COMMENT_PREFIX, BF_LOOP_START, BF_LOOP_END, BF_LOOP_ITEM, loopItemMarker, loopStartMarker, loopEndMarker, BF_KEY, BF_KEY_PREFIX, BF_PLACEHOLDER, BF_ASYNC, BF_ASYNC_RESOLVE, BF_PARENT_SCOPE_PLACEHOLDER, } from './markers.ts';
+export { BF_SCOPE, BF_SLOT, BF_HOST, BF_AT, BF_ROOT, BF_PROPS, BF_COND, BF_ITEM, BF_PORTAL_OWNER, BF_PORTAL_ID, BF_PORTAL_PLACEHOLDER, BF_PARENT_OWNED_PREFIX, BF_SCOPE_COMMENT_PREFIX, BF_LOOP_START, BF_LOOP_END, BF_LOOP_ITEM, loopItemMarker, loopStartMarker, loopEndMarker, BF_KEY, BF_KEY_PREFIX, BF_PLACEHOLDER, BF_ASYNC, BF_ASYNC_RESOLVE, BF_REGION, BF_PARENT_SCOPE_PLACEHOLDER, BF_SEAM_HYDRATE, BF_SEAM_HYDRATE_WITHIN, BF_SEAM_DISPOSE_WITHIN, BF_SEAM_PUSH_SEARCH, } from './markers.ts';
 export { classifyDOMProp, toHTMLAttrName, toHTMLAttrNameRuntime, isBooleanAttr, isEventProp, BOOLEAN_ATTRS, } from './dom-prop.ts';
 export type { DOMPropKind, DOMPropClassification } from './dom-prop.ts';
 export type { ProfilerEvent, ProfilerEventType, ProfilerSubscriberKind, } from './profiler-events.ts';

package/dist/index.js

@@ -29,7 +29,12 @@ var BF_KEY_PREFIX = "data-key-";
 var BF_PLACEHOLDER = "data-bf-ph";
 var BF_ASYNC = "bf-async";
 var BF_ASYNC_RESOLVE = "bf-async-resolve";
+var BF_REGION = "bf-region";
 var BF_PARENT_SCOPE_PLACEHOLDER = "__BF_PARENT_SCOPE__";
+var BF_SEAM_HYDRATE = "__bf_hydrate";
+var BF_SEAM_HYDRATE_WITHIN = "__bf_hydrate_within";
+var BF_SEAM_DISPOSE_WITHIN = "__bf_dispose_within";
+var BF_SEAM_PUSH_SEARCH = "__bf_pushSearch";
 // src/dom-prop.ts
 var BOOLEAN_ATTRS = new Set([
   "checked",
@@ -206,9 +211,14 @@ export {
   classifyDOMProp,
   BOOLEAN_ATTRS,
   BF_SLOT,
+  BF_SEAM_PUSH_SEARCH,
+  BF_SEAM_HYDRATE_WITHIN,
+  BF_SEAM_HYDRATE,
+  BF_SEAM_DISPOSE_WITHIN,
   BF_SCOPE_COMMENT_PREFIX,
   BF_SCOPE,
   BF_ROOT,
+  BF_REGION,
   BF_PROPS,
   BF_PORTAL_PLACEHOLDER,
   BF_PORTAL_OWNER,

package/dist/markers.d.ts

@@ -109,6 +109,17 @@ export declare const BF_PLACEHOLDER = "data-bf-ph";
 export declare const BF_ASYNC = "bf-async";
 /** Async resolve template: `<template bf-async-resolve="a0">` */
 export declare const BF_ASYNC_RESOLVE = "bf-async-resolve";
+/**
+ * Page-lifecycle boundary emitted for an authored `<Region>`:
+ *   `bf-region="<file scope>:<index>"`
+ *
+ * Everything outside a `[bf-region]` persists across a client navigation;
+ * everything inside is the unit the router disposes, re-loads, and
+ * re-hydrates. The value is deterministic (the layout file's `computeFileScope`
+ * hash + a per-file index), so a layout that compiles to one shared partial
+ * emits the *same* id across every page — which is what the router matches on.
+ */
+export declare const BF_REGION = "bf-region";
 /**
  * Sentinel value embedded by the compiler on hoisted JSX children that
  * need a `bf-s` scope marker. The runtime `renderChild` substitutes the
@@ -126,3 +137,11 @@ export declare const BF_ASYNC_RESOLVE = "bf-async-resolve";
  *   - CSR conformance harness (`@barefootjs/adapter-tests/src/csr-render.ts`)
  */
 export declare const BF_PARENT_SCOPE_PLACEHOLDER = "__BF_PARENT_SCOPE__";
+/** Re-hydrate the whole document. `window[BF_SEAM_HYDRATE]()`. */
+export declare const BF_SEAM_HYDRATE = "__bf_hydrate";
+/** Re-hydrate only a swapped subtree. `window[BF_SEAM_HYDRATE_WITHIN](root)`. */
+export declare const BF_SEAM_HYDRATE_WITHIN = "__bf_hydrate_within";
+/** Dispose the islands in a subtree. `window[BF_SEAM_DISPOSE_WITHIN](root)`. */
+export declare const BF_SEAM_DISPOSE_WITHIN = "__bf_dispose_within";
+/** Push a new query string into the `searchParams()` env signal. `window[BF_SEAM_PUSH_SEARCH](search)`. */
+export declare const BF_SEAM_PUSH_SEARCH = "__bf_pushSearch";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barefootjs/shared",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "description": "Shared constants for BarefootJS compiler and runtime",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -23,7 +23,12 @@ export {
   BF_PLACEHOLDER,
   BF_ASYNC,
   BF_ASYNC_RESOLVE,
+  BF_REGION,
   BF_PARENT_SCOPE_PLACEHOLDER,
+  BF_SEAM_HYDRATE,
+  BF_SEAM_HYDRATE_WITHIN,
+  BF_SEAM_DISPOSE_WITHIN,
+  BF_SEAM_PUSH_SEARCH,
 } from './markers.ts'
 
 export {

package/src/markers.ts

@@ -168,6 +168,22 @@ export const BF_ASYNC = 'bf-async'
 /** Async resolve template: `<template bf-async-resolve="a0">` */
 export const BF_ASYNC_RESOLVE = 'bf-async-resolve'
 
+// ---------------------------------------------------------------------------
+// Region (page-lifecycle boundary, spec/router.md)
+// ---------------------------------------------------------------------------
+
+/**
+ * Page-lifecycle boundary emitted for an authored `<Region>`:
+ *   `bf-region="<file scope>:<index>"`
+ *
+ * Everything outside a `[bf-region]` persists across a client navigation;
+ * everything inside is the unit the router disposes, re-loads, and
+ * re-hydrates. The value is deterministic (the layout file's `computeFileScope`
+ * hash + a per-file index), so a layout that compiles to one shared partial
+ * emits the *same* id across every page — which is what the router matches on.
+ */
+export const BF_REGION = 'bf-region'
+
 // ---------------------------------------------------------------------------
 // Hoisted-children scope placeholder (#1320)
 // ---------------------------------------------------------------------------
@@ -189,3 +205,25 @@ export const BF_ASYNC_RESOLVE = 'bf-async-resolve'
  *   - CSR conformance harness (`@barefootjs/adapter-tests/src/csr-render.ts`)
  */
 export const BF_PARENT_SCOPE_PLACEHOLDER = '__BF_PARENT_SCOPE__'
+
+// ---------------------------------------------------------------------------
+// Client-runtime seam names (router ↔ client `window` bridge)
+// ---------------------------------------------------------------------------
+//
+// The optional client router (`@barefootjs/router`) reaches the client runtime
+// through a few `window.__bf_*` function properties. The runtime *installs*
+// them (`@barefootjs/client/runtime/streaming.ts`, `@barefootjs/client`'s
+// `searchParams`) and the router *reads* them (`@barefootjs/router/seams.ts`),
+// in different packages — so the names live here as the single source of truth.
+// A rename is then a compile error on both sides instead of a silently-broken
+// seam (the router would otherwise fall back to a dynamic import and mask the
+// mismatch).
+
+/** Re-hydrate the whole document. `window[BF_SEAM_HYDRATE]()`. */
+export const BF_SEAM_HYDRATE = '__bf_hydrate'
+/** Re-hydrate only a swapped subtree. `window[BF_SEAM_HYDRATE_WITHIN](root)`. */
+export const BF_SEAM_HYDRATE_WITHIN = '__bf_hydrate_within'
+/** Dispose the islands in a subtree. `window[BF_SEAM_DISPOSE_WITHIN](root)`. */
+export const BF_SEAM_DISPOSE_WITHIN = '__bf_dispose_within'
+/** Push a new query string into the `searchParams()` env signal. `window[BF_SEAM_PUSH_SEARCH](search)`. */
+export const BF_SEAM_PUSH_SEARCH = '__bf_pushSearch'