efficient-storefront-blocks 0.0.0 → 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,397 @@
+# Changelog
+
+## 0.11.0 — 2026-10-07
+
+- **Renamed: `efficient-web-builder` is now `efficient-storefront-blocks`.**
+  This package is the website builder assembled with the storefront's own
+  sections and EFFICIENT's backend, built from the storefront repository. The
+  name `efficient-web-builder` goes to the builder alone, published from its
+  own repository (doc/adr/0002, *Names and end state*). Nothing else moved:
+  the entries (`.`, `./contract`, `./links`, `./editor.css`), every export and
+  the `storefront-editor:*` messages are what 0.10.0 published.
+
+  To migrate, install `efficient-storefront-blocks@^0.11.0`, remove
+  `efficient-web-builder`, and change the module name in each import:
+
+  ```diff
+  -import "efficient-web-builder/editor.css";
+  -import { WebsiteEditor, createEditorHost } from "efficient-web-builder";
+  +import "efficient-storefront-blocks/editor.css";
+  +import { WebsiteEditor, createEditorHost } from "efficient-storefront-blocks";
+  ```
+
+  `efficient-web-builder` 0.10.0 and earlier stay on the registry as they
+  were published. Do not alias the old name to this package: a host that later
+  installs the builder itself needs that name free.
+
+- **Needs `efficient-easel` 0.101.0 or later** (peer `^0.101.0`, was
+  `^0.100.0`). Every list in the editor is efficient-easel's one list, which
+  0.101 ships.
+
+## 0.10.0 — 2026-10-07
+
+- **The preview has square corners.** The canvas's desktop frame had a rounded
+  corner where the page meets the toolbar and the panel, and the tablet and
+  phone frames were drawn with a device's rounded edge. All three clipped the
+  corners of the website inside. They are square; the tablet and phone frames
+  are still told apart from the well by their width and outline.
+- **A website that has not set Corners is drawn square.** In Site styles ▸
+  Corners, "Not set" used to leave small built-in rounded corners on inputs,
+  panels and some pictures. The canvas now draws such a site square, as the
+  live storefront does; a site that chose a value keeps it. The Mockup
+  section's address bar and stat chips and the integrations chips, which were
+  pill-shaped on every site, follow the site's Corners too.
+
+- **The part panel takes the final text box.** Clicking a run of text opens
+  efficient-easel's final text box: a two-row toolbar (Bold, Italic, Underline,
+  Strikethrough, Color, Link, Superscript, Subscript, Undo / Left, Center,
+  Right, Justify, lists, Aa AA aa) and six number cells — Font size, Line
+  spacing (%), Letter spacing (px), Paragraph spacing, Padding and Width. The
+  Style section below holds the style card, Font (easel's one dropdown) and a
+  Color row of the section's theme colours plus Any color. The Weight row is
+  gone (B is the bold); a weight already stored still draws. The bundle now also imports
+  `efficient-easel/gold.css` and `efficient-easel/text-styles.css`, which the
+  host's bundler resolves from its own efficient-easel.
+- **Old part settings draw the same.** A stored line or letter nudge is read
+  as the number the published page has always drawn for it and is never
+  rewritten. The editor canvas now draws a nudged part exactly as the live
+  page does.
+
+## 0.9.0 — 2026-10-07
+
+- **The Product Grid title keeps its words in the canvas.** When the head row
+  is crowded (in the editor, an empty supporting line and link draw their
+  placeholders), the supporting line now truncates first, and the title, "View
+  all" and the count stay whole. Before, the title split inside its words at
+  912 wide. Published heads that are not crowded are unchanged.
+
+- **Needs `efficient-easel` 0.100.0 or later** (peer `^0.100.0`, was
+  `^0.99.2`). 0.100 removes the deprecated `Editor…` names, which this package
+  no longer uses. The copy box's bar no longer draws the ◆ Emphasis button
+  (E5a), and the "press the highlighter" hint under four copy rows is gone with
+  it. Saved `==words==` still shows in the theme colour.
+
+- **`backend.media.maxUploadBytes` — the media field's size cap is the
+  backend's.** An optional number on the `media` group: the largest file a
+  media field takes before handing it to the host's panel or picker. Without it
+  the editor refuses no file for its size. It was EFFICIENT's published cap,
+  applied to every host.
+
+- **`backend.social` — the social links join the backend contract.** A new
+  optional group on `WebsiteBackend`: `social.get(scope?)` and
+  `social.update(patch, scope?)` over `SocialLinkSettings` — one address per
+  platform, under the platform's name. The editor's Social links rows read and
+  save through it and no longer call EFFICIENT's client.
+- **`WebsiteBackendError.fields`.** An `invalid` rejection may name the inputs
+  it refused, each with the reason (`{ instagram: "Enter a valid URL." }`); the
+  editor shows it beside that input. `social.update` is the first to use it.
+
+- **`backend.chat` — the live chat joins the backend contract.** A new optional
+  group on `WebsiteBackend`: `chat.get(scope?)` and `chat.update(patch, scope?)`
+  over `ChatSettings` (enabled, title, subtitle, greeting). The editor's Live
+  chat panel reads and saves through it and no longer calls EFFICIENT's client.
+  Under EFFICIENT's backend nothing changes.
+
+- **`backend.pages.linkTargets` — the link picker's pages join the backend
+  contract.** A new optional method on the `pages` group: every page a link
+  may point at, as `LinkTargetPage`s (id, slug, the page's name, and its
+  layout), in one call. The link picker reads it for its "Page" and "Anchor"
+  targets and no longer calls EFFICIENT's client. A host's backend without it
+  still has its pages listed — from `pages.list` — with no section anchors.
+  Under EFFICIENT's backend nothing changes.
+
+- **`backend.blog` — the website's blog joins the backend contract.** A new
+  optional group on `WebsiteBackend`: `blog.posts(scope?)` answers the
+  website's published posts as `BlogPostRow`s (slug, title, excerpt, category,
+  an absolute cover address, the publish date, and the post's own path). The
+  editor reads it in two places — a section's "Blog post source", and the link
+  picker's "Blog post" target — and no longer calls EFFICIENT's client for
+  either. A host that passes its own `backend` with a `blog` gets both; one
+  without gets what it had before: a block already linked to a post says so and
+  can only be unlinked, and the link picker offers no "Blog post". Under
+  EFFICIENT's backend (no `backend` passed, or `createEfficientBackend()`)
+  nothing changes.
+
+- **The Visual sitemap is out of the editor.** The rail's "Visual sitemap"
+  button and the page-card overlay it opened are removed. A host that wants a
+  bird's-eye view of a website's pages draws its own, outside the editor:
+  EFFICIENT's admin shows it as the Sitemap section of its Storefront Console.
+  Nothing else in the rail moves, and no prop or host message changes
+  (`storefront-editor:open-page` and `storefront-editor:new-page` are still
+  sent by the Pages panel).
+
+- **`backend.theme` — a website's appearance joins the backend contract.** A
+  new optional group on `WebsiteBackend`: `theme.get(scope?)` and
+  `theme.update(patch, scope?)` over `SiteThemeRow` — the row behind Site
+  styles, key for key as it is stored. The editor seeds its appearance and
+  saves every Site styles change through it and no longer calls EFFICIENT's
+  client. Site styles is now offered to ANY backend that has the group
+  (`hasSiteTheme` was EFFICIENT-only); one without it is unchanged.
+
+## 0.8.1 — 2026-10-07
+
+- **The held hero frame stays on screen.** A hero slide with a video and no
+  poster holds on the video's first frame (0.8.0). That frame was a paused,
+  never-played `<video>`, and the browser does not always paint one: it could
+  go blank, for example after the editor window was resized, leaving the pale
+  surface under the slide's white words. The frame is now drawn once onto a
+  canvas, and the source video is dropped as soon as it is drawn.
+
+  A patch cut from 0.8.0 with this one fix (branch `release/web-builder-0.8.1`),
+  so it did not carry the 0.9.0 changes above. The fix is on `main` too
+  (#1582), so 0.9.0 has it.
+
+## 0.8.0 — 2026-10-06
+
+- **A hero slide with a video and no poster shows in the canvas.** A hero's
+  video is held in the editor until "Play video" is pressed. A held slide that
+  has no poster drew nothing, so the canvas showed a pale blank under white
+  words where the published page plays the video. It now shows the video's
+  first frame as a still: nothing plays, and only the start of the file is
+  fetched. A slide that has a poster mounts no video while held, as before.
+
+- **`efficient-web-builder/links` — the link rules, for a host's own link picker.**
+  A new light entry (one file, no imports, like `/contract`): the link kinds,
+  each thing's live URL, a saved link read back to its kind, the product
+  listing read off a page's layout, the ONE filter a listing link may carry
+  (any field the listing filters on, in the listing's own query param), the
+  filters and catalogue values a listing link may offer, and the addresses
+  that are refused. Built from the file the editor's own Link field reads, so
+  the admin's menu picker writes links by the same rules. The editor itself is
+  unchanged.
+
+## 0.7.1 — 2026-10-06
+
+- **The Fitment Finder and the gallery builds load in a host's editor.** Their
+  calls to the website's own public routes (`/api/v1/fitment/*`,
+  `/api/v1/gallery-builds`) carried an `X-Portal-Audience` header. Those routes
+  answer a cross-origin caller with open CORS that allows only `Accept` and
+  `Content-Type`, so the browser's preflight refused the call: the Fitment
+  Finder showed "Vehicle list unavailable" and the gallery came back empty.
+  These calls now send no audience; every other call is unchanged.
+
+- **The engine peer is `efficient-easel ^0.99.2`** (it was `^0.99.0`). This
+  package now imports the engine by its Easel names (`createEasel`,
+  `useEasel`, `EaselProvider`, `efficient-easel/easel`), which 0.99.2 added.
+  The engine still exports the old names, so a host's own code does not have
+  to change; a host only needs 0.99.2 or later installed. Nothing an operator
+  sees changes.
+
+- **One media panel head for both editors.** The Media panel's head is
+  efficient-easel's `MediaPanelHead`, the same head the campaign designer
+  draws over the same library (owner ruling 2026-10-06: a part exists once, in
+  efficient-easel). Nothing it says or does changed; the Cancel button's sides
+  are 12px (were 10px), on the spacing scale. Needs the efficient-easel release
+  that ships `MediaPanelHead`.
+
+- **Grid cells fill their height in the canvas.** A block in a Grid cell now
+  stretches to the cell's height in the editor, as it does on the published
+  page. The canvas sheet (built from the storefront's `app/globals.css`) makes
+  the editor's drag wrapper in a Grid a one-column grid, so the block inside it
+  stretches. Published pages are unchanged.
+- **Box rows fill their height in the canvas.** The same fix for a Box laid out
+  in one row and a Slide box set to One row: when the row stretches (Align
+  Stretch, or not set), the drag wrapper is a one-column grid, so the block
+  inside it is the row's height as on the published page. Start, Center and End
+  rows and Stacked boxes are unchanged. Published pages are unchanged.
+
+- **The editor opens a page with its live prices.** Under the EFFICIENT
+  backend, `pages.load` by slug now only finds the page, then reads it by id.
+  Only that read re-prices the wheel copy a linked Product Grid or Product
+  Hero keeps in the page, the same way the published page does. Before, a
+  stale copy (USD 0) drew "Price on request" on cards the live page priced.
+  An embedder's own backend is not affected.
+
+- **The canvas gets the live page's head.** The editor's canvas frame now runs
+  the same fit-words boot the published `<body>` runs (`lib/fit-words.ts`), so
+  a heading word wider than its box shrinks to fit instead of breaking inside
+  the word ("THE UNPAVE / D", "Monoblo / ck"). It runs in the frame's own
+  document; the embedder's page is never touched.
+- **The canvas fonts fall back as the live page's do.** Each `--font-*`
+  variable is bound to next/font's stack (`'Family', 'Family Fallback'`) and
+  the canvas sheet declares next/font's metric-matched `"<Family> Fallback"`
+  faces, so a glyph outside a web font's subset (→, ″) and text drawn before
+  the web font arrives take the widths the live page gives them. The faces are
+  local fonts: an editor over an embedder's own backend (no Google Fonts sheet)
+  gets them too.
+- **The Mobile canvas is 390px wide** (it was 388: the device frame's 1px
+  border sat inside its width), and Tablet is 800 (was 798). The device edge
+  is now an outline that takes no width.
+- **An empty slot no longer covers the picture behind it.** The editor sheet
+  (`dist/editor.css`) no longer paints its own solid fill on efficient-easel's
+  empty-slot cell, so the slot looks as easel 0.99.1 draws it: nothing at
+  rest, so a hero's picture or video shows; the outline and "+ Add block" on
+  hover or focus. Published pages are unchanged.
+
+## 0.7.0 — 2026-10-05
+
+- **Renamed: `efficient-web` is now `efficient-web-builder`.** 0.7.0 is the
+  first release under this name, and `efficient-web` stops at 0.3.0. 0.4.0,
+  0.5.0 and 0.6.0 below were never published under either name, so an embedder
+  moving from `efficient-web` 0.3.0 takes all four sets of changes together.
+- **To migrate:** change the dependency name (`"efficient-web": "^0.3.0"`
+  becomes `"efficient-web-builder": "^0.7.0"`) and the import specifiers:
+  `efficient-web` becomes `efficient-web-builder`, and
+  `efficient-web/editor.css` becomes `efficient-web-builder/editor.css`. An
+  install that lists the package by name (pnpm's `minimumReleaseAgeExclude`)
+  renames that entry too.
+- The messages the package logs or throws now open with
+  `efficient-web-builder:` instead of `efficient-web:`.
+- **A host chooses which blocks its editor offers.** `WebsiteEditor` and
+  `WebsiteSectionEditor` take an optional `blocks`: the `sets` offered
+  (`general`, `commerce`, `service`), an `allow` and a `deny` list, the host's
+  own blocks (`host`, each an `efficient-easel/blocks` `ComponentConfig`), the
+  Add-panel group each stands in (`categories`), and live `metadata` every
+  block receives as `puck.metadata`. See the README.
+- **Without `blocks` nothing changes.** The editor is given the same block
+  registry, the same object, and offers every block it has. An embedder that
+  passes nothing compiles and behaves as in 0.6.0.
+- **Every block has a set.** `general` blocks draw from their own props and
+  what the host hands them; `commerce` blocks are the shop; `service` blocks
+  need one of the EFFICIENT backend's site services (forms, bookings, reviews,
+  the newsletter, the blog, menus). 105 blocks: 53 general, 27 commerce, 25
+  service.
+- **Offered, not registered.** A block a host leaves out is in no Add-panel
+  group, no slot's menu and no drop target, and no section is seeded with it. A
+  page that already holds one still draws it and it can be deleted.
+- **A section is offered only with the blocks it is built from.** A Hero is not
+  offered where its slides are not; a section that is merely wrapped in a Box
+  when it is added lands whole instead.
+- **With a set left out, the controls that need it are not drawn**: a link has
+  no "Blog post" or "Product" target, a section's optional "Blog post source"
+  is hidden, the Form picker is inert, and the pinned Header and Footer are
+  not seeded.
+- **`blocks.metadata` is live.** Change the object and the blocks in the canvas
+  redraw in place; it is never written to the page or the undo history. The
+  rest of `blocks` is read once, when the editor mounts.
+- **A host's own block gets none of the rows the editor adds to its own
+  sections** (padding, width, anchor, theme, animation). It is drawn by its own
+  `render`, edited with the fields it declares, added from the Add panel, and
+  hidden by the Layers tree's eye.
+- **New entry: `efficient-web-builder/contract`.** One small file with no imports, for
+  a host's server: `BLOCK_SETS`, `GENERAL_BLOCKS`, `COMMERCE_BLOCKS`,
+  `SERVICE_BLOCKS`, `blockSetOf(type)` and `blockTypesIn(layout)` — every block
+  type a saved page uses, including inside slots. Hiding a block in the editor
+  is not a security boundary; checking the saved page is.
+- New types: `WebsiteEditorBlocks`, `WebsiteBlockCategory`, `WebsiteBlockSet`.
+  `ComponentConfig` is the engine's (`efficient-easel/blocks`).
+
+## 0.6.0 — 2026-10-05
+
+- **The engine peer is `efficient-easel`.** The engine is called Efficient
+  Easel, and its package was renamed from `efficient-editor` at 0.96.0. This
+  package now imports `efficient-easel/*` and asks for `efficient-easel`
+  `^0.96.0` in place of `efficient-editor` `^0.94.1`. A host moves the two
+  together: install `efficient-easel` and import its sheets from
+  `efficient-easel/*.css`.
+- The engine's sheets inside `efficient-web/editor.css` are 0.96.0's. That
+  release is 0.95.0 under the new name: no class, variable or rendered byte
+  differs, and the `es-` classes keep their names.
+
+## 0.5.0 — 2026-10-04
+
+- **Built on efficient-editor 0.94.1.** The peer range moves from `^0.93.0` to
+  `^0.94.1`, and the engine's sheets inside `efficient-web/editor.css` are
+  0.94.1's. Install the two together: the formatting bar above a copy box is
+  drawn by the engine and styled by this package's sheet, so 0.94's bar on
+  0.93's sheet would not match.
+- The formatting bar's buttons take the engine's 0.94 look: 32px, 6px corners,
+  and a pressed button that stays tinted under the pointer. Their tooltips are
+  the engine's: Strong, Italic, Strikethrough and Emphasis, each with the mark
+  it writes.
+- **Two word styles are renamed on the bar: Emphasis is now Highlight, and
+  Strong is now Bold**, because the engine's own buttons took those two words.
+  The stored keys (`highlight`, `strong`) and the marks (`@@`, `++`) do not move.
+
+## 0.4.0 — 2026-10-04
+
+- **The editor can run on a backend that is not EFFICIENT's.** `WebsiteEditor`
+  and `WebsiteSectionEditor` take an optional `backend`: the embedder's own
+  implementation of `WebsiteBackend` — pages (list, load, save, version,
+  publish, create, remove), the edit lock, the site record, media, section
+  templates, website templates, the Preview link. `pages`, `site.get` and
+  `media.resolve` are required; every other group or method is optional, and
+  the editor draws no control for one that is missing. See the README and
+  `doc/adr/0002`.
+- **Without `backend` nothing changes.** It is `createEfficientBackend()`:
+  `/api/storefront/*`, authorised by the token the host delivers with
+  `storefront-editor:auth`, with `auth-expired` on a 401 — as in 0.3.0. An
+  embedder that passes nothing compiles and behaves as before.
+- **Failures are kinds, not HTTP bodies.** A backend rejects with
+  `WebsiteBackendError` (`unauthorized`, `changed-elsewhere`, `lock-taken`,
+  `not-found`, `invalid`, `unavailable`); a refused save carries who saved, a
+  taken page who holds it.
+- **`PageBundle`** — a page is saved as `{ layout, translations?, seo? }`.
+  0.4.0 edits `layout`; `translations` and `seo` are reserved for per-language
+  content, so a host's storage is shaped once.
+- **Under an embedder's backend the package makes no request of its own**: no
+  token is waited for (`ready` is announced once), its own HTTP client is
+  closed, the canvas loads no remote font sheet, and stored media is resolved
+  by `backend.media.resolve`.
+- **One session per mounted editor.** The token, the website being edited and
+  the editor's caches belong to the mount, so a re-mount for another website
+  starts from nothing (one editor at a time is still the rule).
+- New exports: `createEfficientBackend`, `WebsiteBackendError`, and the types
+  `WebsiteBackend`, `WebsitePages`, `WebsiteEditLock`, `WebsiteSite`,
+  `WebsiteMedia`, `WebsiteSectionTemplates`, `WebsiteTemplates`,
+  `WebsitePreview`, `PageBundle`, `PageDocument`, `PageLayout`, `PageRef`,
+  `SiteScope`, `NewPageInput`, `SaveExpectation`, `EditorPageRow`, `SiteRecord`,
+  `SiteRecordPatch`, `SaveConflict`, `LockHolder`, `SectionNode`,
+  `SectionTemplate`, `SectionTemplateRecord`, `WebsiteBackendErrorKind`,
+  `EfficientBackendOptions`.
+- Not behind the interface yet (unchanged under EFFICIENT's backend, absent
+  under another): site styles, the pinned header and footer, live chat, social
+  links, menus, blog, forms, the catalog, the sitemap panel and "duplicate to
+  page". A Form section's picker (0.3.0) is inert under another backend: no
+  list, no "New form", no `storefront-editor:open-form`.
+
+## 0.3.0 — 2026-10-04
+
+- **Editing a form waits for nothing.** A Form picker's "Edit form" sends
+  `storefront-editor:open-form` with `mode: "edit"` and **no `requestId`**, and
+  does not wait for an answer: the embedder's form builder is a window the
+  merchant works in beside the editor, not a question the picker asked. The
+  picker's buttons are no longer disabled while the builder is open.
+  `requestId` is now optional on the message type.
+- **A block follows a renamed form by id.** When a forms re-read no longer
+  explains a block's stored slug but still holds the form that slug last
+  resolved to, the block is re-pointed at the form's new slug. This replaces
+  following the slug on the reply to an edit request, and also covers a rename
+  made outside the editor. A deleted form is never replaced by another.
+- **"New form" still asks and waits** (`mode: "create"`, with a `requestId`,
+  answered by `form-saved` / `form-closed`). An embedder is expected to answer
+  it quickly, for example with a popup that names and creates the form; one
+  that answers with its whole form builder still works, and the fifteen-minute
+  reply backstop stays for it.
+- An embedder that answered an edit request with `form-closed` keeps working:
+  the reply is for a request nobody is waiting on, and is ignored.
+
+## 0.2.0 — 2026-10-04
+
+- **The media library is a panel of the editor.** `WebsiteEditor` and
+  `WebsiteSectionEditor` take an optional `mediaPanel`: the embedder's media
+  library, as a component the editor draws in its own left panel. The rail's
+  Media button opens it as a view beside Pages, Layers and Site styles, and
+  every image field opens it in pick mode ("Choose image · Background image"),
+  so the field's choice is made in the editor instead of in a second window.
+  New types: `MediaPanelComponent`, `MediaPanelProps`, `MediaPickRequest`.
+- Without `mediaPanel` nothing changes: fields ask the host to open its picker
+  window with `storefront-editor:open-media-picker`, as in 0.1.0.
+- **One head for every side panel, on both sides.** Pages, Layers, Site styles,
+  the Media library, Add, Choose image and the right-hand settings panel all
+  wear the engine's `InspectorHead`: a glyph, the name, what it is about, the
+  panel's own buttons, then **Hide panel**, now on the right panel too. No ✕ in a panel head any
+  more: Add leaves with **Done**, choosing an image with **Cancel**, and Layers'
+  collapse-all glyph no longer reads as a second ✕.
+- **No panel toggles in the top bar.** They duplicated the heads' Hide panel
+  button. A hidden panel leaves a 40px strip at its edge with **Show panel**
+  (the same picture), the way back for both sides.
+
+## 0.1.0 — 2026-10-03
+
+- **First release.** The storefront website editor (page and template editor,
+  standalone section editor) for an app that mounts it in its own page: an
+  in-process host (`createEditorHost`) in place of the shop's postMessage
+  bridge, the shop's sections with Next.js replaced at the module boundary, and
+  the canvas styled from the storefront's own compiled stylesheet inside its
+  frame.

package/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2026 Efficient Pty Ltd. All rights reserved.
+
+This software and its documentation are proprietary to Efficient Pty Ltd and
+are confidential. No licence is granted to use, copy, modify, merge, publish,
+distribute, sublicense or sell this software, in whole or in part, except
+under a written agreement with Efficient Pty Ltd.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.