@uniweb/build 1.6.2 → 1.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniweb/build",
-  "version": "1.6.2",
+  "version": "1.7.0",
   "description": "Build tooling for the Uniweb Component Web Platform",
   "type": "module",
   "exports": {
@@ -56,15 +56,15 @@
     "js-yaml": "^4.1.0",
     "sharp": "^0.35.3",
     "yaml": "^2.5.0",
-    "@uniweb/semantic-parser": "~1.12.2",
     "@uniweb/content-reader": "~1.5.4",
-    "@uniweb/theming": "~1.2.0",
-    "@uniweb/schemas": "~1.5.2",
     "@uniweb/content-writer": "~1.3.0",
-    "@uniweb/projections": "~1.1.5"
+    "@uniweb/projections": "~1.1.6",
+    "@uniweb/schemas": "~1.6.0",
+    "@uniweb/semantic-parser": "~1.12.2",
+    "@uniweb/theming": "~1.2.0"
   },
   "optionalDependencies": {
-    "@uniweb/runtime": "~1.1.12"
+    "@uniweb/runtime": "~1.1.13"
   },
   "peerDependencies": {
     "vite": "^5.0.0 || ^6.0.0 || ^7.0.0",
@@ -73,8 +73,8 @@
     "@tailwindcss/vite": "^4.0.0",
     "@vitejs/plugin-react": "^4.0.0 || ^5.0.0",
     "vite-plugin-svgr": "^4.0.0",
-    "@uniweb/core": "~1.3.2",
-    "@uniweb/runtime": "~1.1.12"
+    "@uniweb/core": "~1.4.0",
+    "@uniweb/runtime": "~1.1.13"
   },
   "peerDependenciesMeta": {
     "vite": {

package/src/runtime-schema.js

@@ -5,6 +5,7 @@
  * reads to render, and nothing else:
  *
  * - background: 'self' when component handles its own background
+ * - sticky: { default, top? } — whether the section stays in view unless its author says
  * - data: { <key>: <schema ref> | { schema, single?, whole? } | null } — every `content.data`
  *     key the component declares, in order, with its schema ref and the flags set on it (null for
  *     an inline shape)
@@ -37,6 +38,35 @@
 import { lowerData } from '@uniweb/schemas/content'
 import { schemaDeclarationOf } from '@uniweb/schemas/foundation'
 
+/**
+ * A section type's `sticky`, checked: `true` or `false`, or `{ default, top }`. `top` is how far
+ * below the top the section stays — one CSS value, `4rem` or `var(--header-height)` — and is
+ * written into the style of the box that sticks, so a declaration (`;`, a brace) is refused.
+ *
+ * @param {*} declared - `meta.js`'s `sticky`
+ * @returns {{ default: boolean, top?: string }}
+ * @throws {Error} for any other shape
+ */
+export function stickyDeclaration(declared) {
+  if (typeof declared === 'boolean') return { default: declared }
+  if (!declared || typeof declared !== 'object' || Array.isArray(declared)) {
+    throw new Error(`[uniweb] Invalid 'sticky': write true, false or { default, top } — got ${JSON.stringify(declared)}`)
+  }
+  const unknown = Object.keys(declared).filter((key) => key !== 'default' && key !== 'top')
+  if (unknown.length) throw new Error(`[uniweb] Invalid 'sticky': ${unknown.join(', ')} — it takes default and top`)
+  if (declared.default !== undefined && typeof declared.default !== 'boolean') {
+    throw new Error(`[uniweb] Invalid 'sticky.default': write true or false`)
+  }
+  const out = { default: declared.default === true }
+  if (declared.top !== undefined) {
+    if (typeof declared.top !== 'string' || !declared.top.trim() || /[;{}]/.test(declared.top)) {
+      throw new Error(`[uniweb] Invalid 'sticky.top': one CSS length, such as '4rem' or 'var(--header-height)'`)
+    }
+    out.top = declared.top.trim()
+  }
+  return out
+}
+
 /**
  * A `data:` entry as the runtime reads it: its schema ref, with the flags set on it — or null for an
  * inline shape, which names no schema and is filled only under its own key.
@@ -132,6 +162,12 @@ export function extractRuntimeSchema(fullMeta) {
     runtime.background = fullMeta.background
   }
 
+  // Whether the section stays in view by default: core reads it, and the author's
+  // `sticky:` wins (`Block#initComponent`). The runtime makes sticky the box that can.
+  if (fullMeta.sticky !== undefined) {
+    runtime.sticky = stickyDeclaration(fullMeta.sticky)
+  }
+
   // Data. `data:` is the single declaration surface for a section's structured
   // data: it maps each `content.data` key to its schema. A value is a named ref
   // (`'@/member'`), an inline field map, or an inline rich-form (`{ fields: [...] }`,

package/src/schema.js

@@ -22,6 +22,7 @@ import { describeContent, lowerData } from '@uniweb/schemas/content'
 import { normalizeData, schemaDeclarationOf } from '@uniweb/schemas/foundation'
 import { rootListSection } from '@uniweb/schemas/conform'
 import { SECTION_PARAMS, SECTION_KEYS } from '@uniweb/schemas/section'
+import { stickyDeclaration } from './runtime-schema.js'
 import { collectSchemaRefs, buildDataSchemaMap, ownSchemaRefs } from './resolve-data-schema.js'
 import {
   composeSupports,
@@ -652,12 +653,29 @@ function buildComponentEntry(name, relativePath, meta) {
 
   if (meta.data !== undefined) entry.data = lowerData(meta.data)
   refuseDataDeclarations(`${name} (meta.js)`, entry.data)
+  refuseStickyDeclaration(`${name} (meta.js)`, meta.sticky)
 
   const problems = [...content.problems, ...describeChildren(meta).problems]
   if (problems.length > 0) loweringProblems.set(entry, problems)
   return entry
 }
 
+/**
+ * Refuse a `sticky` that is not `true`, `false` or `{ default, top }` (`stickyDeclaration`), naming
+ * the component — the lean runtime schema checks it too, without the name.
+ *
+ * @param {string} owner - who declares it, for the message
+ * @param {*} sticky - `meta.js`'s `sticky`
+ */
+function refuseStickyDeclaration(owner, sticky) {
+  if (sticky === undefined) return
+  try {
+    stickyDeclaration(sticky)
+  } catch (err) {
+    throw new Error(`[uniweb] ${owner}: ${err.message.replace(/^\[uniweb\] /, '')}`)
+  }
+}
+
 /**
  * Refuse a `data:` key typed by a schema that is not written as one: the retired `/*` suffix, a
  * property of the long form other than `schema`, `single` and `whole`, or a flag that is not a