@wix/himalaya-cli 0.1158.0 → 0.1160.0

package/templates/brandy/dev/index.ts

@@ -5,6 +5,340 @@ import { siteScreens } from "@himalaya/core";
 import config, { site } from "../config.js";
 
 const SCREENS = siteScreens(site);
+
+// The native Notifications screen (a drawer row): whether this app may notify, and the one action
+// that changes it — Turn on (the system prompt when it can still show, otherwise the device
+// settings) or Open settings. It runs on the himi-notification-settings worker in tier5-src/.
+const NOTIFICATIONS = {
+  "screenId": "himi_notification_settings",
+  "renderer": "sdui_intent",
+  "title": "",
+  "schemaVersion": 1,
+  "cacheControl": {
+    "maxAge": 0,
+    "staleWhileRevalidate": 0
+  },
+  "payload": {
+    "id": "himi_notification_settings.root",
+    "body": {
+      "package": "himalaya",
+      "type": "VStack",
+      "props": {
+        "spacing": 16,
+        "alignment": "leading",
+        "children": [
+          {
+            "id": "himi_notification_settings.title",
+            "body": {
+              "package": "himalaya",
+              "type": "Text",
+              "props": {
+                "text": "Notifications",
+                "style": "title1"
+              }
+            }
+          },
+          {
+            "id": "himi_notification_settings.status",
+            "body": {
+              "package": "himalaya",
+              "type": "HStack",
+              "props": {
+                "spacing": 12,
+                "children": [
+                  {
+                    "id": "",
+                    "body": {
+                      "package": "himalaya",
+                      "type": "Icon",
+                      "props": {
+                        "name": "bell",
+                        "size": 24,
+                        "tint": "accentPrimary"
+                      }
+                    },
+                    "modifiers": {
+                      "accessibilityRole": "decorative"
+                    }
+                  },
+                  {
+                    "id": "",
+                    "body": {
+                      "package": "himalaya",
+                      "type": "VStack",
+                      "props": {
+                        "spacing": 4,
+                        "alignment": "leading",
+                        "children": [
+                          {
+                            "id": "himi_notification_settings.status_title",
+                            "body": {
+                              "package": "himalaya",
+                              "type": "Text",
+                              "props": {
+                                "text": "$service:himiNotificationSettings.statusTitle",
+                                "style": "title2"
+                              }
+                            }
+                          },
+                          {
+                            "id": "himi_notification_settings.status_body",
+                            "body": {
+                              "package": "himalaya",
+                              "type": "Text",
+                              "props": {
+                                "text": "$service:himiNotificationSettings.statusBody",
+                                "style": "body",
+                                "color": "textSecondary",
+                                "collapseWhenEmpty": true
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            },
+            "modifiers": {
+              "background": {
+                "token": "surfaceElevated"
+              },
+              "border": {
+                "width": 1,
+                "color": {
+                  "token": "border"
+                }
+              },
+              "cornerRadius": 16,
+              "padding": {
+                "leading": 16,
+                "trailing": 16,
+                "top": 16,
+                "bottom": 16
+              }
+            }
+          },
+          {
+            "id": "himi_notification_settings.turn_on",
+            "body": {
+              "package": "himalaya",
+              "type": "Button",
+              "props": {
+                "title": "Turn on notifications",
+                "style": "primary",
+                "fullWidth": true,
+                "action": {
+                  "actionId": "tier5.himiNotificationSettings.enable"
+                }
+              }
+            },
+            "modifiers": {
+              "hiddenPath": "$service:himiNotificationSettings.hideTurnOn"
+            }
+          },
+          {
+            "id": "himi_notification_settings.open_settings",
+            "body": {
+              "package": "himalaya",
+              "type": "Button",
+              "props": {
+                "title": "Open settings",
+                "style": "secondary",
+                "fullWidth": true,
+                "action": {
+                  "actionId": "tier5.himiNotificationSettings.openSettings"
+                }
+              }
+            },
+            "modifiers": {
+              "hiddenPath": "$service:himiNotificationSettings.hideOpenSettings"
+            }
+          },
+          {
+            "id": "himi_notification_settings.message",
+            "body": {
+              "package": "himalaya",
+              "type": "Text",
+              "props": {
+                "text": "$service:himiNotificationSettings.message",
+                "style": "footnote",
+                "color": "textSecondary",
+                "collapseWhenEmpty": true
+              }
+            }
+          }
+        ]
+      }
+    },
+    "modifiers": {
+      "background": {
+        "token": "surfacePrimary"
+      },
+      "padding": {
+        "leading": 16,
+        "trailing": 16,
+        "top": 18,
+        "bottom": 28
+      },
+      "onAppear": {
+        "actionId": "tier5.himiNotificationSettings.refresh"
+      }
+    }
+  },
+  "logicBundle": {
+    "url": "http://localhost:8190/v1/bundles/himi-notification-settings?integrity=",
+    "integrity": "",
+    "contentType": "application/javascript+ts-bundle",
+    "declaredCapabilities": [
+      "push"
+    ],
+    "minBinaryVersion": "0.2.0",
+    "bundleVersion": "0.0.1"
+  }
+};
+// The offline seed copy has no running worker, so it carries no buttons and no live bindings.
+const NOTIFICATIONS_SEED = {
+  "screenId": "himi_notification_settings",
+  "renderer": "sdui_intent",
+  "title": "",
+  "schemaVersion": 1,
+  "cacheControl": {
+    "maxAge": 0,
+    "staleWhileRevalidate": 0
+  },
+  "payload": {
+    "id": "himi_notification_settings.root",
+    "body": {
+      "package": "himalaya",
+      "type": "VStack",
+      "props": {
+        "spacing": 16,
+        "alignment": "leading",
+        "children": [
+          {
+            "id": "himi_notification_settings.title",
+            "body": {
+              "package": "himalaya",
+              "type": "Text",
+              "props": {
+                "text": "Notifications",
+                "style": "title1"
+              }
+            }
+          },
+          {
+            "id": "himi_notification_settings.status",
+            "body": {
+              "package": "himalaya",
+              "type": "HStack",
+              "props": {
+                "spacing": 12,
+                "children": [
+                  {
+                    "id": "",
+                    "body": {
+                      "package": "himalaya",
+                      "type": "Icon",
+                      "props": {
+                        "name": "bell",
+                        "size": 24,
+                        "tint": "accentPrimary"
+                      }
+                    },
+                    "modifiers": {
+                      "accessibilityRole": "decorative"
+                    }
+                  },
+                  {
+                    "id": "",
+                    "body": {
+                      "package": "himalaya",
+                      "type": "VStack",
+                      "props": {
+                        "spacing": 4,
+                        "alignment": "leading",
+                        "children": [
+                          {
+                            "id": "himi_notification_settings.status_title",
+                            "body": {
+                              "package": "himalaya",
+                              "type": "Text",
+                              "props": {
+                                "text": "Notifications",
+                                "style": "title2"
+                              }
+                            }
+                          },
+                          {
+                            "id": "himi_notification_settings.status_body",
+                            "body": {
+                              "package": "himalaya",
+                              "type": "Text",
+                              "props": {
+                                "text": "Connect to the internet to change notification settings.",
+                                "style": "body",
+                                "color": "textSecondary",
+                                "collapseWhenEmpty": true
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ]
+              }
+            },
+            "modifiers": {
+              "background": {
+                "token": "surfaceElevated"
+              },
+              "border": {
+                "width": 1,
+                "color": {
+                  "token": "border"
+                }
+              },
+              "cornerRadius": 16,
+              "padding": {
+                "leading": 16,
+                "trailing": 16,
+                "top": 16,
+                "bottom": 16
+              }
+            }
+          }
+        ]
+      }
+    },
+    "modifiers": {
+      "background": {
+        "token": "surfacePrimary"
+      },
+      "padding": {
+        "leading": 16,
+        "trailing": 16,
+        "top": 18,
+        "bottom": 28
+      },
+      "onAppear": {
+        "actionId": "tier5.himiNotificationSettings.refresh"
+      }
+    }
+  },
+  "logicBundle": {
+    "url": "http://localhost:8190/v1/bundles/himi-notification-settings?integrity=",
+    "integrity": "",
+    "contentType": "application/javascript+ts-bundle",
+    "declaredCapabilities": [
+      "push"
+    ],
+    "minBinaryVersion": "0.2.0",
+    "bundleVersion": "0.0.1"
+  }
+};
 // The home screen is always the `home` page's: `site_home`. A literal on purpose — `himi init`
 // and the agent tooling read `homeScreenId` from this file as written; config.ts refuses a map
 // whose first tab is anything else, so the literal and the tab bar cannot disagree.
@@ -14,12 +348,15 @@ export default {
   homeScreenId: "site_home",
   screens: {
     // A fresh copy per build: descriptors are pure functions of the site block.
-    exact: Object.fromEntries(Object.keys(SCREENS).map((id) => [id, () => structuredClone(SCREENS[id])])),
+    exact: {
+      ...Object.fromEntries(Object.keys(SCREENS).map((id) => [id, () => structuredClone(SCREENS[id])])),
+      himi_notification_settings: () => structuredClone(NOTIFICATIONS),
+    },
     templated: [],
   },
   actions: [],
   createStore: () => ({}),
   // Every page is seeded, so the whole tab bar and drawer work on a cold offline start (each
   // WebView then shows its own offline state until the network returns).
-  seed: { screens: SCREENS, data: {} },
+  seed: { screens: { ...SCREENS, himi_notification_settings: NOTIFICATIONS_SEED }, data: {} },
 };

package/templates/brandy/tier5-src/_shared/himi-copy.ts

@@ -0,0 +1,56 @@
+// Copy-as-configuration for WORKER-emitted strings (`himi docs designing-himi-screens`,
+// §"Copy is configuration"): a worker never hardcodes user-facing copy — the
+// descriptor bakes the provisioned copy-pack overrides relevant to this worker
+// into its onAppear action params as a `copy` JSON object (key → override
+// string, computed from the app contract at descriptor-build time), and the
+// worker reads every user-facing string through `copyParam(key, fallback)`.
+//
+// STASHED (the stashed appear-params idiom, himi-branded-lite-home): the
+// param-carrying onAppear dispatch updates the stash; later arg-less calls
+// (self-kick refreshes, retry buttons, pull-to-refresh) fall back to it, so
+// resolution order can never drop the pack. With no pack the param is absent
+// and every read returns `fallback` verbatim — routing a worker string through
+// copyParam is byte-for-byte behavior-preserving.
+//
+// Pure + Hermes-safe (no host globals, no Node APIs, no imports): bundled into
+// every worker that emits user-facing copy, and copied verbatim into the
+// generated templates' tier5-src/_shared/.
+
+let stashedCopy: Record<string, string> = {};
+
+/** Absorb the `copy` onAppear param (a JSON object of key → override string)
+ *  from an action arg. Call first in every action that can receive onAppear
+ *  params (load/refresh). Non-copy args and malformed packs are ignored — the
+ *  stock fallbacks keep rendering. */
+export function stashCopy(arg: unknown): void {
+  if (!arg || typeof arg !== "object") return;
+  const raw = (arg as Record<string, unknown>).copy;
+  if (typeof raw !== "string" || !raw) return;
+  try {
+    const parsed = JSON.parse(raw) as unknown;
+    if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return;
+    const next: Record<string, string> = {};
+    for (const [key, value] of Object.entries(parsed as Record<string, unknown>)) {
+      if (typeof value === "string") next[key] = value;
+    }
+    stashedCopy = next;
+  } catch {
+    // Malformed pack param — keep the stock copy rather than dying mid-action.
+  }
+}
+
+/** The provisioned override for `key`, or `fallback` (the stock copy) when no
+ *  pack / no such key reached this worker. */
+export function copyParam(key: string, fallback: string): string {
+  const value = stashedCopy[key];
+  return typeof value === "string" && value !== "" ? value : fallback;
+}
+
+/** Interpolate `{name}` placeholders in a (possibly overridden) template:
+ *  `copyTemplate("plans.joinOnSite", "…join {name}.", { name })`. Unknown
+ *  placeholders resolve to "" so a typo'd override degrades, never crashes. */
+export function copyTemplate(key: string, fallback: string, values: Record<string, string | number>): string {
+  return copyParam(key, fallback).replace(/\{([A-Za-z0-9_]+)\}/g, (_all, name: string) =>
+    name in values ? String(values[name]) : "",
+  );
+}

package/templates/brandy/tier5-src/himi-notification-settings/index.ts

@@ -0,0 +1,130 @@
+// himi-notification-settings — the shared Tier-5 worker behind an app's Notifications
+// settings screen: a native feature an app built on its website needs (App Store guideline 4.2).
+//
+// It shows whether this app may send notifications and offers ONE action:
+//   - off → "Turn on notifications": the OS prompt when the OS can still show it, else the OS
+//     settings. Whether a prompt is still possible is not knowable up front on every platform
+//     (Android reports "denied" both before the first ask and after a second refusal), so the
+//     action asks first and falls through to the settings when the answer is not a grant.
+//   - on → "Open settings", to turn them off there.
+// While the status is loading — or cannot be read at all — neither action shows.
+//
+// The screen must refresh when the user comes BACK from the OS settings, and a worker has
+// no clock. `refresh` (the screen's onAppear) therefore arms a `_poll`: the host suspends it
+// in the background and FIRES IT IMMEDIATELY on foreground, which is exactly the return
+// from Settings; the slow cadence in between is only a backstop. Re-armed on every entry,
+// because restored state arms no timer. A tick that sees notifications newly turned on calls
+// requestPermission(), which (with no prompt, the user has already decided) registers the
+// push token for this session.
+//
+// Copy is overridable through an optional `copy` param on the onAppear action (stashCopy /
+// copyParam), like the account worker; a descriptor that passes none gets the English
+// defaults. Declares the "push" capability.
+
+import { defineService, type PollDirective } from "@himalaya/state";
+import { getPermissionStatus, openSettings, requestPermission, type PushPermission } from "@himalaya/push";
+import { stashCopy, copyParam } from "../_shared/himi-copy.js";
+
+type Status = PushPermission | "loading" | "error";
+
+interface S {
+  status: Status;
+  statusTitle: string;
+  statusBody: string;
+  /** Hide flags, true until the status is known (and in the error state), so the live
+   *  screen shows no action while loading. NOTE an unresolved `$service:` hidden path fails
+   *  OPEN on every renderer — a descriptor with no running worker would show both — which is
+   *  why a seeded, worker-less copy of the screen must not carry the buttons at all. */
+  hideTurnOn: boolean;
+  hideOpenSettings: boolean;
+  /** A one-line note after an action (e.g. settings could not be opened here). */
+  message: string;
+}
+
+const POLL: PollDirective = {
+  id: "himi-notification-settings",
+  intervalMs: 60_000,
+  action: "himiNotificationSettings.check",
+  immediate: false,
+};
+
+/** The whole view for a status. Pure, so the test pins every branch. */
+export function viewFor(status: Status): Omit<S, "message"> {
+  const on = status === "granted";
+  const off = status === "denied" || status === "undetermined";
+  const statusTitle = on
+    ? copyParam("notificationSettings.onTitle", "Notifications are on")
+    : off
+      ? copyParam("notificationSettings.offTitle", "Notifications are off")
+      : copyParam("notificationSettings.loadingTitle", "Notifications");
+  const statusBody = on
+    ? copyParam("notificationSettings.onBody", "You'll get updates from this app. You can turn them off in your device settings.")
+    : off
+      ? copyParam("notificationSettings.offBody", "Turn them on to get updates from this app.")
+      : status === "error"
+        ? copyParam("notificationSettings.unavailableBody", "Notification settings aren't available here.")
+        : "";
+  return { status, statusTitle, statusBody, hideTurnOn: !off, hideOpenSettings: !on };
+}
+
+async function readStatus(): Promise<Status> {
+  try {
+    return await getPermissionStatus();
+  } catch {
+    // A missing or failing push capability is not "undetermined": offering Turn on would
+    // lead nowhere. Say it is unavailable and offer nothing.
+    return "error";
+  }
+}
+
+async function open(): Promise<boolean> {
+  try {
+    return await openSettings();
+  } catch {
+    return false;
+  }
+}
+
+const OPEN_FAILED = () => copyParam("notificationSettings.openFailed", "Change notifications for this app in your device or browser settings.");
+
+const svc = defineService<S, {
+  refresh: (s: S, arg?: unknown) => Promise<S & { _poll: PollDirective }>;
+  check: (s: S) => Promise<S>;
+  enable: (s: S) => Promise<S>;
+  openSettings: (s: S) => Promise<S>;
+}>("himiNotificationSettings", {
+  state: { ...viewFor("loading"), message: "" },
+  actions: {
+    // onAppear: read the status and (re-)arm the foreground-refresh poll.
+    refresh: async (s, arg) => {
+      stashCopy(arg);
+      return { ...s, ...viewFor(await readStatus()), message: "", _poll: POLL };
+    },
+    // One poll tick: idempotent — the status is just re-read.
+    check: async (s) => {
+      const status = await readStatus();
+      if (status === s.status) return s;
+      // Turned on in the OS settings while away: register the token for this session.
+      if (status === "granted") await requestPermission().catch(() => "granted");
+      return { ...s, ...viewFor(status), message: "" };
+    },
+    // Ask if the OS can still prompt; anything but a grant goes to the OS settings.
+    enable: async (s) => {
+      let status: Status;
+      try {
+        status = await requestPermission();
+      } catch {
+        status = await readStatus();
+      }
+      if (status === "granted") return { ...s, ...viewFor(status), message: "" };
+      const opened = await open();
+      return { ...s, ...viewFor(status), message: opened ? "" : OPEN_FAILED() };
+    },
+    openSettings: async (s) => {
+      // Coming back fires the poll, which repaints the status; nothing to do on success.
+      return { ...s, message: (await open()) ? "" : OPEN_FAILED() };
+    },
+  },
+});
+
+export { svc };

package/templates/brandy/tokens.json

@@ -109,11 +109,21 @@
       "weight": 700,
       "line": 1.2
     },
+    "title2": {
+      "size": 22,
+      "weight": 700,
+      "line": 1.22
+    },
     "body": {
       "size": 16,
       "weight": 400,
       "line": 1.5
     },
+    "footnote": {
+      "size": 14,
+      "weight": 500,
+      "line": 1.35
+    },
     "caption": {
       "size": 13,
       "weight": 400,

package/templates/community-club/tier5-src/_shared/himi-copy.ts

@@ -1,4 +1,4 @@
-// Copy-as-configuration for WORKER-emitted strings (docs/designing-himi-screens.md
+// Copy-as-configuration for WORKER-emitted strings (`himi docs designing-himi-screens`,
 // §"Copy is configuration"): a worker never hardcodes user-facing copy — the
 // descriptor bakes the provisioned copy-pack overrides relevant to this worker
 // into its onAppear action params as a `copy` JSON object (key → override