@wix/himalaya-cli 0.1172.0 → 0.1174.0

package/templates/restaurant-owner/dev/index.ts

@@ -76635,7 +76635,7 @@ const SCREENS = runtimeSetting({
                         "package": "himalaya",
                         "type": "FormField",
                         "props": {
-                          "id": "description",
+                          "id": "descriptionText",
                           "label": "Description",
                           "kind": "text",
                           "text": {
@@ -76648,7 +76648,90 @@ const SCREENS = runtimeSetting({
                         }
                       },
                       "modifiers": {
-                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionProtected"
+                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionFieldHidden"
+                      }
+                    },
+                    {
+                      "id": "product_form.description_slot",
+                      "body": {
+                        "package": "himalaya",
+                        "type": "VStack",
+                        "props": {
+                          "spacing": 6,
+                          "alignment": "leading",
+                          "children": [
+                            {
+                              "id": "",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "Text",
+                                "props": {
+                                  "text": "Description",
+                                  "style": "bodyEmphasis"
+                                }
+                              }
+                            },
+                            {
+                              "id": "product_description_editor",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "RichContentEditor",
+                                "props": {
+                                  "name": "description",
+                                  "documentPath": "$service:himiOwnerLiteProductForm.descriptionJson",
+                                  "placeholder": "Ingredients, allergens, how it’s served",
+                                  "uploadService": "himiOwnerLiteProductFormUploads",
+                                  "onChange": {
+                                    "actionId": "tier5.himiOwnerLiteProductForm.descriptionChanged"
+                                  },
+                                  "minHeight": 200,
+                                  "fallback": {
+                                    "id": "product_form.description_unavailable",
+                                    "body": {
+                                      "package": "himalaya",
+                                      "type": "VStack",
+                                      "props": {
+                                        "spacing": 4,
+                                        "alignment": "leading",
+                                        "children": [
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "Editor unavailable",
+                                                "style": "title3"
+                                              }
+                                            }
+                                          },
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "The description can’t be edited here right now. Name, price and SKU still save, and the description stays as it is.",
+                                                "style": "footnote",
+                                                "color": "textSecondary"
+                                              }
+                                            }
+                                          }
+                                        ]
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "modifiers": {
+                                "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionPending"
+                              }
+                            }
+                          ]
+                        }
+                      },
+                      "modifiers": {
+                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionEditorHidden"
                       }
                     }
                   ],
@@ -76918,7 +77001,7 @@ const SCREENS = runtimeSetting({
                                   "onChange": {
                                     "actionId": "tier5.himiOwnerLitePostForm.bodyChanged"
                                   },
-                                  "minHeight": 360,
+                                  "minHeight": 240,
                                   "fallback": {
                                     "id": "post_form.body_unavailable",
                                     "body": {
@@ -77375,7 +77458,7 @@ const TEMPLATED: { pattern: string; display: string; liveSeed?: LiveSeed; static
                         "package": "himalaya",
                         "type": "FormField",
                         "props": {
-                          "id": "description",
+                          "id": "descriptionText",
                           "label": "Description",
                           "kind": "text",
                           "text": {
@@ -77388,7 +77471,90 @@ const TEMPLATED: { pattern: string; display: string; liveSeed?: LiveSeed; static
                         }
                       },
                       "modifiers": {
-                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionProtected"
+                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionFieldHidden"
+                      }
+                    },
+                    {
+                      "id": "product_form.description_slot",
+                      "body": {
+                        "package": "himalaya",
+                        "type": "VStack",
+                        "props": {
+                          "spacing": 6,
+                          "alignment": "leading",
+                          "children": [
+                            {
+                              "id": "",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "Text",
+                                "props": {
+                                  "text": "Description",
+                                  "style": "bodyEmphasis"
+                                }
+                              }
+                            },
+                            {
+                              "id": "product_description_editor",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "RichContentEditor",
+                                "props": {
+                                  "name": "description",
+                                  "documentPath": "$service:himiOwnerLiteProductForm.descriptionJson",
+                                  "placeholder": "Ingredients, allergens, how it’s served",
+                                  "uploadService": "himiOwnerLiteProductFormUploads",
+                                  "onChange": {
+                                    "actionId": "tier5.himiOwnerLiteProductForm.descriptionChanged"
+                                  },
+                                  "minHeight": 200,
+                                  "fallback": {
+                                    "id": "product_form.description_unavailable",
+                                    "body": {
+                                      "package": "himalaya",
+                                      "type": "VStack",
+                                      "props": {
+                                        "spacing": 4,
+                                        "alignment": "leading",
+                                        "children": [
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "Editor unavailable",
+                                                "style": "title3"
+                                              }
+                                            }
+                                          },
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "The description can’t be edited here right now. Name, price and SKU still save, and the description stays as it is.",
+                                                "style": "footnote",
+                                                "color": "textSecondary"
+                                              }
+                                            }
+                                          }
+                                        ]
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "modifiers": {
+                                "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionPending"
+                              }
+                            }
+                          ]
+                        }
+                      },
+                      "modifiers": {
+                        "hiddenPath": "$service:himiOwnerLiteProductForm.descriptionEditorHidden"
                       }
                     }
                   ],
@@ -77890,7 +78056,7 @@ const TEMPLATED: { pattern: string; display: string; liveSeed?: LiveSeed; static
                         "package": "himalaya",
                         "type": "FormField",
                         "props": {
-                          "id": "description",
+                          "id": "descriptionText",
                           "label": "Description",
                           "kind": "text",
                           "text": {
@@ -77903,7 +78069,90 @@ const TEMPLATED: { pattern: string; display: string; liveSeed?: LiveSeed; static
                         }
                       },
                       "modifiers": {
-                        "hiddenPath": "$service:himiOwnerLiteEventForm.descriptionProtected"
+                        "hiddenPath": "$service:himiOwnerLiteEventForm.descriptionFieldHidden"
+                      }
+                    },
+                    {
+                      "id": "event_form.description_slot",
+                      "body": {
+                        "package": "himalaya",
+                        "type": "VStack",
+                        "props": {
+                          "spacing": 6,
+                          "alignment": "leading",
+                          "children": [
+                            {
+                              "id": "",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "Text",
+                                "props": {
+                                  "text": "Description",
+                                  "style": "bodyEmphasis"
+                                }
+                              }
+                            },
+                            {
+                              "id": "event_description_editor",
+                              "body": {
+                                "package": "himalaya",
+                                "type": "RichContentEditor",
+                                "props": {
+                                  "name": "description",
+                                  "documentPath": "$service:himiOwnerLiteEventForm.descriptionJson",
+                                  "placeholder": "Optional",
+                                  "uploadService": "himiOwnerLiteEventFormUploads",
+                                  "onChange": {
+                                    "actionId": "tier5.himiOwnerLiteEventForm.descriptionChanged"
+                                  },
+                                  "minHeight": 200,
+                                  "fallback": {
+                                    "id": "event_form.description_unavailable",
+                                    "body": {
+                                      "package": "himalaya",
+                                      "type": "VStack",
+                                      "props": {
+                                        "spacing": 4,
+                                        "alignment": "leading",
+                                        "children": [
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "Editor unavailable",
+                                                "style": "title3"
+                                              }
+                                            }
+                                          },
+                                          {
+                                            "id": "",
+                                            "body": {
+                                              "package": "himalaya",
+                                              "type": "Text",
+                                              "props": {
+                                                "text": "The description can’t be edited here right now. The title still saves, and the description stays as it is.",
+                                                "style": "footnote",
+                                                "color": "textSecondary"
+                                              }
+                                            }
+                                          }
+                                        ]
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "modifiers": {
+                                "hiddenPath": "$service:himiOwnerLiteEventForm.descriptionPending"
+                              }
+                            }
+                          ]
+                        }
+                      },
+                      "modifiers": {
+                        "hiddenPath": "$service:himiOwnerLiteEventForm.descriptionEditorHidden"
                       }
                     }
                   ],
@@ -78176,7 +78425,7 @@ const TEMPLATED: { pattern: string; display: string; liveSeed?: LiveSeed; static
                                   "onChange": {
                                     "actionId": "tier5.himiOwnerLitePostForm.bodyChanged"
                                   },
-                                  "minHeight": 360,
+                                  "minHeight": 240,
                                   "fallback": {
                                     "id": "post_form.body_unavailable",
                                     "body": {

package/templates/restaurant-owner/tier5-src/_shared/owner-editor-value.ts

@@ -8,7 +8,7 @@
 // drops nodes the owner never touched).
 // Inside the platform source this import is a relative path, so node test runs resolve it; an app's
 // copy imports "@himalaya/wix-rich-content".
-import { parseRicosJson, RICH_CONTENT_LIMITS, type RicosDocument } from "@himalaya/wix-rich-content";
+import { parseRicosJson, isPlainRicos, RICH_CONTENT_LIMITS, type RicosDocument } from "@himalaya/wix-rich-content";
 
 export type EditorValue =
   | { kind: "absent" }                                  // leave the stored body untouched
@@ -45,12 +45,78 @@ function overLimits(doc: RicosDocument): boolean {
   return false;
 }
 
-/** `raw` is `values[name]`; `seededJson` is the string the form published as the editor's seed. */
-export function editorValue(raw: unknown, seededJson: string): EditorValue {
-  if (typeof raw !== "string" || raw === "") return { kind: "absent" };
-  if (seededJson !== "" && raw === seededJson) return { kind: "unchanged" };
+const TEXT_ONLY = new Set(["PARAGRAPH", "TEXT", "HEADING", "BULLETED_LIST", "ORDERED_LIST", "LIST_ITEM", "BLOCKQUOTE", "CODE_BLOCK"]);
+/** No visible text and no non-text node (an image, a divider, an embed…): an empty body. */
+export function isEmptyDocument(doc: RicosDocument): boolean {
+  const empty = (nodes: RicosDocument["nodes"] | undefined): boolean => (nodes ?? []).every((n) =>
+    TEXT_ONLY.has(String(n?.type)) && !String(n.textData?.text ?? "").trim() && empty(n.nodes));
+  return empty(doc.nodes);
+}
+
+/** A Ricos JSON string checked as every viewer would: the limits first, then the shape. */
+function checkedDocument(raw: string): EditorValue {
   if (utf8Bytes(raw) > RICH_CONTENT_LIMITS.maxBytes) return { kind: "too_large" };
   const doc = parseRicosJson(raw);
   if (!doc) return { kind: "invalid" };
   return overLimits(doc) ? { kind: "too_large" } : { kind: "doc", doc, json: raw };
 }
+
+/** `raw` is `values[name]`; `seededJson` is the string the form published as the editor's seed. */
+export function editorValue(raw: unknown, seededJson: string): EditorValue {
+  if (typeof raw !== "string" || raw === "") return { kind: "absent" };
+  if (seededJson !== "" && raw === seededJson) return { kind: "unchanged" };
+  const checked = checkedDocument(raw);
+  // An empty editor over no body (a record that had none) writes nothing, rather than an empty document.
+  if (checked.kind === "doc" && seededJson === "" && isEmptyDocument(checked.doc)) return { kind: "unchanged" };
+  return checked;
+}
+
+// ── The per-field editor machinery every owner form shares (post body, event / product description,
+// FAQ answer). Each form keeps `<key>Json` (the seed), `<key>Pending` and `<key>Dirty` in its state.
+
+/** `<key>Pending`: until this run's load lands, the descriptor hides the editor — it seeds ONCE, so a
+ *  provisional editor the owner typed into would keep that text over the real document.
+ *  `<key>Dirty`: the editor's on_change fired since the field was loaded or saved. Once ready the bag
+ *  ALWAYS holds a document — the engine's own re-serialization of the seed, not byte-equal to it — so
+ *  only this says the owner edited the field. Every arm fires a pending on_change before it releases a
+ *  Form submit, so an edit made inside the debounce window is reported before the submit reads it. */
+export interface EditorGate { pending: boolean; dirty: boolean }
+
+/** What a live submit does with `values[name]`: only an edit the editor reported counts. */
+export function editorSubmitValue(raw: unknown, seededJson: string, gate: EditorGate): EditorValue {
+  return gate.pending || !gate.dirty ? { kind: "absent" } : editorValue(raw, seededJson);
+}
+
+/** A queued write's document. A replay runs in a FRESH worker with no editor, so the string is checked
+ *  again (shape and limits); "absent" when the item carries none. Never "unchanged": it was an edit. */
+export function queuedDocument(raw: unknown): EditorValue {
+  return typeof raw === "string" && raw !== "" ? checkedDocument(raw) : { kind: "absent" };
+}
+
+/** The editor's on_change: the field is now edited, and a confirmation of an earlier save is stale.
+ *  No timing window: an arm fires the pending on_change BEFORE it releases a submit, so any on_change
+ *  that arrives after a save carries an edit that save did not write. */
+export function editorChanged<S extends { status: string; savedMessage: string }>(s: S): Pick<S, "status" | "savedMessage"> {
+  return { status: s.status === "saved" ? "idle" : s.status, savedMessage: "" };
+}
+
+/** The offline cache's verdict on the stored body (`<key>Protected`): rich unless KNOWN plain. From the
+ *  document when the form knows it; otherwise plain only when the record was loaded as plain. A bundle
+ *  rolled back past the editor reads this flag to decide whether its plain field may overwrite the body. */
+export function cachedRichVerdict(doc: RicosDocument | null, knownPlain: boolean): "true" | "false" {
+  if (doc) return isPlainRicos(doc) ? "false" : "true";
+  return knownPlain ? "false" : "true";
+}
+
+/** Cold boot: the runtime lays this service's last persisted snapshot over its declared state, so the
+ *  editor's first seed would be the document as it was when the screen last ran — and a Save after
+ *  typing would write it over whatever the record holds now. Blank the hydrated seed and reset the gate
+ *  before anything renders, in place (no action has run yet). `extra` resets further UI state. */
+export function resetHydratedEditor(svc: unknown, keys: { json: string; pending: string; dirty: string }, pendingAtBoot: boolean, extra: Record<string, unknown> = {}): void {
+  const booted = (svc as { getState?: () => Record<string, unknown> | undefined }).getState?.();
+  if (!booted || typeof booted !== "object") return;
+  if (booted[keys.json]) booted[keys.json] = "";
+  booted[keys.pending] = pendingAtBoot;
+  booted[keys.dirty] = false;
+  Object.assign(booted, extra);
+}

package/templates/restaurant-owner/tier5-src/_shared/owner-rich-guard.ts

@@ -2,7 +2,7 @@
 // this file adds the read-only previews the forms show for a locked body, and the FAQ's legacy DraftJS answer.
 // Inside the platform source this import is a relative path, so node test runs resolve it; an app's copy
 // imports "@himalaya/wix-rich-content".
-import { htmlIsTrivial, isPlainRicos } from "@himalaya/wix-rich-content";
+import { htmlIsTrivial } from "@himalaya/wix-rich-content";
 
 export { htmlIsTrivial };
 
@@ -16,14 +16,6 @@ export function htmlPreviewText(html: string | null | undefined): string {
     .split("\n").map((l) => l.replace(/\s+/g, " ").trim()).filter(Boolean).join("\n");
 }
 
-/** True when a plain text field can round-trip this Ricos document: no document styling, and
- *  only paragraphs of undecorated text whose paragraph data is the wire default (Events v3 sends
- *  `{ textStyle: { textAlignment: "AUTO" }, indentation: 0 }` on every paragraph). Anything else —
- *  a heading, list, link, bold run, media node, alignment or indent — is rich, and so is a missing
- *  document (callers decide what an absent body means). */
-export const ricosIsPlain = (doc: { nodes?: unknown; documentStyle?: unknown } | null | undefined): boolean =>
-  !!doc && isPlainRicos(doc);
-
 /** Preview text for a legacy DraftJS document: its `blocks[].text` joined by a blank line, or ""
  *  when the payload is not DraftJS JSON (never a throw). */
 export function draftjsText(raw: string | null | undefined): string {