@wix/himalaya-cli 0.1613.0 → 0.1615.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/sdk/ui/src/index.d.ts

@@ -39,37 +39,77 @@ export declare function alert(options: AlertOptions): Promise<AlertResult>;
  *  `warning`, `danger`). Use `danger` for errors; the hosts also accept `error` as an alias of it. */
 export type SnackbarTone = "info" | "success" | "warning" | "danger";
 export interface SnackbarOptions {
+    /** At most two lines on screen; a longer message is ellipsised. */
     message: string;
     /** Default "info". */
     tone?: SnackbarTone;
-    /** Auto-dismiss delay in ms, on every host. Default 3000; 0 or less also means 3000. */
+    /** Auto-dismiss delay in ms, clamped on every host to {@link SNACKBAR_LIMITS} (2–10 s, at least
+     *  4 s with an `action` so it can be reached by VoiceOver / TalkBack before it goes). Absent, 0 or
+     *  less: the default, 3000 (4000 with an `action`). */
     durationMs?: number;
-    /** One action button ("Undo", "View"). Tapping it runs `actionId` with `args`, then dismisses the
-     *  snackbar. The id must be a worker action:
+    /** A thumbnail of the thing the toast is about: a 40 pt square at the leading edge. `https:` on
+     *  every host; a local `file:` URL on iOS and macOS only, whose image pipeline already reads local
+     *  files. Any other URL is ignored (the toast shows without it), and an image that fails to load
+     *  just hides. */
+    imageUrl?: string;
+    /** One action button ("Undo", "View"). Tapping it dismisses the snackbar and resolves the call
+     *  `{ actionTapped: true }`. With an `actionId` the tap also runs that action with `args`. The id
+     *  must be a worker action:
      *  - one of this bundle's own `tier5.<svc>.<action>` ids — run on THIS worker, never another
      *    screen's or the app-level worker's;
      *  - an app service's `app.<svc>.<action>` — needs `app_services` and an exported action (an app
      *    service's own id needs neither). The web host refuses it until it hosts app services.
      *  Any other id (`capability.*`, `himi.*`, a registered handler) is refused when the snackbar is
      *  requested: the call rejects and nothing is shown. A host that cannot tell which worker asked
-     *  (React Native, an embedded web region) refuses every `action` the same way. */
+     *  (React Native, an embedded web region) refuses every `action` the same way. An APP SERVICE
+     *  must name an `actionId`: an awaited result carries no gesture credit (RFC 0074 §7), so its
+     *  View has to run as an action of its own. */
     action?: SnackbarAction;
 }
 export interface SnackbarAction {
-    /** The button's text — also its VoiceOver / TalkBack / screen-reader label. */
+    /** The button's text — also its VoiceOver / TalkBack / screen-reader label. At most 24
+     *  characters; a longer label is ellipsised. */
     label: string;
-    /** What the tap runs: one of this bundle's own `tier5.<svc>.<action>` ids, or `app.<svc>.<action>`. */
-    actionId: string;
+    /** What the tap runs, if anything: one of this bundle's own `tier5.<svc>.<action>` ids, or
+     *  `app.<svc>.<action>`. A screen worker may leave it out and branch on `actionTapped` instead
+     *  ("Undo"); an app service may not. */
+    actionId?: string;
     /** The action's arguments, which the reducer receives as typed JSON. */
     args?: Record<string, unknown>;
 }
+/** What a snackbar call resolves with. */
+export interface SnackbarResult {
+    /** The user tapped the action. Always false for a snackbar without one (resolved on
+     *  presentation); with one, false when it was dismissed any other way — timed out, swiped, closed,
+     *  or replaced by a newer snackbar. */
+    actionTapped: boolean;
+}
+/** #4661 — the constraints that keep a snackbar a toast, enforced here and again by every host. */
+export declare const SNACKBAR_LIMITS: {
+    readonly messageLines: 2;
+    readonly labelChars: 24;
+    readonly minDurationMs: 2000;
+    /** The floor with an action: long enough to reach it with a screen reader. */
+    readonly minActionDurationMs: 4000;
+    readonly maxDurationMs: 10000;
+    /** The thumbnail's side, in pt / dp / CSS px. */
+    readonly imageSize: 40;
+};
+/** The duration a host shows a snackbar for: absent / non-finite / 0 or less → undefined (the host
+ *  default applies), else clamped to {@link SNACKBAR_LIMITS}. */
+export declare function snackbarDurationMs(durationMs: number | undefined, hasAction: boolean): number | undefined;
+/** An action label as every host draws it: at most {@link SNACKBAR_LIMITS}.labelChars characters
+ *  (by code point, so an emoji is never cut in half), the last one an ellipsis when it was cut. */
+export declare function snackbarLabel(label: string): string;
 /** Show a transient snackbar toast: it floats above the tab bar, slides and fades in and out
- *  (fades only under reduced motion), queues behind one that is already showing, and is read
- *  by VoiceOver / TalkBack. Resolves once it is PRESENTED (not after it auto-dismisses).
+ *  (fades only under reduced motion), queues behind one that is already showing, and is announced
+ *  by VoiceOver / TalkBack / the screen reader. Without an `action` it resolves
+ *  `{ actionTapped: false }` once it is queued, as before; with one it resolves when the snackbar
+ *  goes, `{ actionTapped: true }` only if the action was tapped (see {@link SnackbarResult}).
  *  Rejects with `no_ui_host` if no presenter is attached; with an `action`, also with
- *  `invalid_action` (empty label or id), `action_not_allowed` (not one of this bundle's
- *  actions), or, for an `app.*` id, `undeclared` (no `app_services`), `not_exported`, `no_service`,
- *  `no_action`, `not_booted` or `unavailable`. */
-export declare function snackbar(options: SnackbarOptions): Promise<void>;
+ *  `invalid_action` (empty label), `action_id_required` (an app service with no `actionId`),
+ *  `action_not_allowed` (not one of this bundle's actions), or, for an `app.*` id, `undeclared` (no
+ *  `app_services`), `not_exported`, `no_service`, `no_action`, `not_booted` or `unavailable`. */
+export declare function snackbar(options: SnackbarOptions): Promise<SnackbarResult>;
 /** Capability version, for bundles that gate on min binary version. */
 export declare const version = 1;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/core/ts/src/schema.d.ts

@@ -1332,6 +1332,9 @@ export interface SnackbarProps {
     severity?: Severity;
     /** #1059 — action label; overridable for localized hosts. Default "Take action". */
     actionLabel?: string;
+    /** #4661 — a 40 pt/dp thumbnail at the leading edge (`https:` or a local file/asset URL; any
+     *  other is ignored), drawn by the same presenter as a worker's `ui.snackbar({ imageUrl })`. */
+    imageUrl?: string;
 }
 export interface AlertDialogProps {
     title: string;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/ui.mjs

@@ -28,22 +28,48 @@ async function alert(options) {
   const r = await dispatch("capability.ui.alert", params);
   return { confirmed: r?.confirmed === true || r?.confirmed === "true" };
 }
+var SNACKBAR_LIMITS = {
+  messageLines: 2,
+  labelChars: 24,
+  minDurationMs: 2e3,
+  /** The floor with an action: long enough to reach it with a screen reader. */
+  minActionDurationMs: 4e3,
+  maxDurationMs: 1e4,
+  /** The thumbnail's side, in pt / dp / CSS px. */
+  imageSize: 40
+};
+function snackbarDurationMs(durationMs, hasAction) {
+  if (typeof durationMs !== "number" || !Number.isFinite(durationMs) || durationMs <= 0) return void 0;
+  const min = hasAction ? SNACKBAR_LIMITS.minActionDurationMs : SNACKBAR_LIMITS.minDurationMs;
+  return Math.min(SNACKBAR_LIMITS.maxDurationMs, Math.max(min, Math.trunc(durationMs)));
+}
+function snackbarLabel(label) {
+  const chars = Array.from(label ?? "");
+  return chars.length <= SNACKBAR_LIMITS.labelChars ? chars.join("") : `${chars.slice(0, SNACKBAR_LIMITS.labelChars - 1).join("")}\u2026`;
+}
 async function snackbar(options) {
   const params = { message: options.message ?? "" };
   if (options.tone) params.tone = options.tone;
-  if (typeof options.durationMs === "number" && Number.isFinite(options.durationMs)) {
-    params.durationMs = Math.min(2147483647, Math.max(0, Math.trunc(options.durationMs)));
-  }
+  const durationMs = snackbarDurationMs(options.durationMs, !!options.action);
+  if (durationMs !== void 0) params.durationMs = durationMs;
+  if (typeof options.imageUrl === "string" && options.imageUrl.trim()) params.imageUrl = options.imageUrl.trim();
   if (options.action) {
     const { label, actionId, args } = options.action;
-    params.action = JSON.stringify(args === void 0 ? { label, actionId } : { label, actionId, args });
+    const action = { label: snackbarLabel(label) };
+    if (actionId) action.actionId = actionId;
+    if (args !== void 0) action.args = args;
+    params.action = JSON.stringify(action);
   }
-  await dispatch("capability.ui.snackbar", params);
+  const r = await dispatch("capability.ui.snackbar", params);
+  return { actionTapped: r?.actionTapped === true || r?.actionTapped === "true" };
 }
 var version = 1;
 export {
+  SNACKBAR_LIMITS,
   alert,
   snackbar,
+  snackbarDurationMs,
+  snackbarLabel,
   version
 };
 //# sourceMappingURL=ui.mjs.map