@wix/himalaya-cli 0.1101.0 → 0.1102.0

package/guides/component-reference.json

@@ -2,7 +2,7 @@
   "_comment": "GENERATED by core/web-embed/authoring/gen-reference.mjs from core/ts/src/schema.ts — do not hand-edit. The schema is the source of truth; regenerate on schema changes.",
   "schemaSource": "core/ts/src/schema.ts",
   "bindingGrammar": "$service:<service>.<path> (worker state) · $item.<field> (list row) · $flag:<key> (feature flag) · $env:<key> (client environment — #1056). Bindings resolve in the text/value props marked 'binding-aware' below — INCLUDING Modifiers token refs — but only `background` and `border.color`, which are the two whose token a binding actually fills: a worker can drive per-item theming (e.g. a game board's per-square color), not just text. `shadow` is NOT binding-aware on any renderer, and a gradient is driven by its own `backgroundGradientPath` prop resolving to a gradient token NAME, not by a binding inside a token ref — so `shadow: { token: \"$item.x\" }` and `backgroundGradient: { token: \"$item.x\" }` keep the sentinel and silently lose the per-item styling. Colour slots split by LEVEL, not by component: inside modifiers a colour is a TokenRef OBJECT ({ token: \"…\" }), inside props it is a bare TokenName STRING — there is no modifiers.color or modifiers.tint (see the 'Token slots' section in component-reference.md). A few input props render the LITERAL and are NOT binding-aware — notably SearchField.placeholder and Chip.label; SearchField.value is live and binding-aware like other content props. Bindings also CANNOT target strict-enum fields (style, size, alignment, severity, presentation, contentMode, …) — those fail at render, not validation. $env: is client-resolved (no worker) and valid in modifiers.hiddenPath and FragmentSlot.casePath ONLY — keys reduceMotion/colorScheme/sizeClass/isRTL, e.g. hiddenPath:\"$env:reduceMotion\" or hiddenPath:\"$env:colorScheme==light\", casePath:\"$env:colorScheme\"; unknown key fails open (shown / defaultCase).",
-  "componentCount": 83,
+  "componentCount": 84,
   "notImplementedComponents": [
     "FieldError",
     "Picker",
@@ -990,6 +990,34 @@
       ],
       "propsSource": "export interface RichContentProps {\n  /** `$service:<svc>.<path>` or `$item.<field>` → the UTF-8 JSON of `{ nodes, metadata?, documentStyle? }`. */\n  documentJsonPath?: string;\n  /** Literal document JSON (seed / offline). */\n  documentJson?: string;\n  /** Dispatched on a link, button or card tap with `args.url`. Absent ⇒ http(s) opens the in-app browser. */\n  onLink?: Action;\n  /** Rendered when the document is rejected (over budget / invalid). Absent ⇒ nothing. */\n  fallback?: Component;\n}"
     },
+    {
+      "name": "RichContentEditor",
+      "category": "Rich content editor",
+      "propsType": "RichContentEditorProps",
+      "bindings": [
+        "documentPath"
+      ],
+      "dispatches": [
+        {
+          "callback": "onChange",
+          "key": "dirty",
+          "encoding": "string",
+          "note": "Always the string \"true\", debounced ≥ 500 ms after a change that moved the document. Never the document itself: that rides the Form bag under `name`, so the submit action receives it as `values[name]`.",
+          "divergences": [
+            {
+              "arms": [
+                "ios",
+                "android"
+              ],
+              "kind": "no-payload",
+              "actual": "renders `fallback` only — no editor exists yet, so nothing dispatches on_change.",
+              "reason": "The editor has not reached these renderers yet, so they show the descriptor's `fallback`; the editor runs on the web and in React Native hosts that register its adapter."
+            }
+          ]
+        }
+      ],
+      "propsSource": "export interface RichContentEditorProps {\n  /** Form-bag key. Required inside a Form (validator). */\n  name?: string;\n  /** `$service:<svc>.<path>` → the document JSON string. Seeds ONCE (the first non-empty value). */\n  documentPath?: string;\n  /** Literal seed document JSON. At most one of documentPath / documentJson. */\n  documentJson?: string;\n  placeholder?: string;\n  /** Empty ⇒ all, minus \"image\" unless uploadService is set. \"image\" requires uploadService. */\n  tools?: RichContentEditorTool[];\n  /** Debounced ≥ 500 ms; args = { dirty: \"true\" } — never the document. */\n  onChange?: Action;\n  /** Worker service made by `ricosUploadService` (@himalaya/wix-rich-content-editor). Enables \"image\". */\n  uploadService?: string;\n  /** Take the remaining height of a bounded parent; else `minHeight`. */\n  fillAvailable?: boolean;\n  /** Default 240. */\n  minHeight?: number;\n  /** Rendered when the engine page is unavailable (not bundled / missing / failed / 15 s timeout). */\n  fallback?: Component;\n}"
+    },
     {
       "name": "VoiceNote",
       "category": "Recorded-audio bubble (messenger design G4)",
@@ -1263,6 +1291,7 @@
     "PickerOption": "export interface PickerOption {\n  id: string;\n  label: string;\n}",
     "GaugeRing": "export interface GaugeRing {\n  /** Fraction 0..1 for this ring. */\n  value?: number;\n  /** `$service:`/`$item.` binding → a live number (overrides `value`). */\n  valuePath?: string;\n  tint?: TokenName;\n}",
     "WidgetTimeRef": "export interface WidgetTimeRef {\n  /** Epoch seconds the style counts from/to. */\n  at: number;\n  /** SwiftUI `Text.DateStyle` / Android time style (default \"timer\"). */\n  style?: \"timer\" | \"relative\" | \"date\" | \"time\" | \"offset\";\n}",
+    "RichContentEditorTool": "export type RichContentEditorTool = \"bold\" | \"italic\" | \"underline\" | \"heading\" | \"bullet\" | \"ordered\" | \"quote\" | \"link\" | \"image\" | \"divider\" | \"undo\" | \"redo\";",
     "Border": "export interface Border {\n  width: number;\n  color: TokenRef;\n}"
   }
 }

package/guides/component-reference.md

@@ -3,7 +3,7 @@
 > GENERATED from `core/ts/src/schema.ts` by `core/web-embed/authoring/gen-reference.mjs`.
 > The schema is the source of truth — regenerate on schema changes; do not hand-edit.
 
-**83 core component types.** Every component body is `{ "package": "himalaya", "type": "<Type>", "props": { … } }`.
+**84 core component types.** Every component body is `{ "package": "himalaya", "type": "<Type>", "props": { … } }`.
 Binding grammar: `$service:<service>.<path>` (worker state) · `$item.<field>` (list row template) · `$flag:<key>` (feature flag) · `$env:<key>` (client environment — #1056).
 Bindings resolve in the text/value props marked **binding-aware** below — **including two `Modifiers` token refs**, `background` and `border.color`, which are the only two whose token a binding actually fills: a worker can drive per-item **theming** (e.g. a game board's per-square color, `background: { token: "$item.bg" }`), not just text content. `shadow` and `backgroundGradient` are `TokenRef`s but are **not** binding-aware on any renderer — `shadow: { token: "$item.x" }` keeps the sentinel as a literal token name and silently loses the per-item styling, and a gradient is driven by its own `backgroundGradientPath` prop resolving to a gradient token NAME, not by a binding inside a token ref.
 `$env:` is **client-resolved** (no worker) and valid in `modifiers.hiddenPath` and `FragmentSlot.casePath` **only** — keys `reduceMotion` / `colorScheme` / `sizeClass` / `isRTL`, with an optional `==`/`!=` comparison (e.g. `hiddenPath: "$env:reduceMotion"`, `hiddenPath: "$env:colorScheme==light"`, `casePath: "$env:colorScheme"`). An unknown key fails open (shown / `defaultCase`).
@@ -93,6 +93,7 @@ See also **[Modifiers](#modifiers)** (the `modifiers` block) and **[Actions](#ac
 | `Legend` | Analytics data-viz | `itemsPath` |
 | `DataTable` | Analytics data-viz | `rowsPath`, `totalsPath` |
 | `RichContent` | Rich content | `documentJsonPath` |
+| `RichContentEditor` | Rich content editor | `documentPath` |
 | `VoiceNote` | Recorded-audio bubble (messenger design G4) | `waveformPath`, `durationMsPath`, `positionMsPath`, `statePath`, `deliveryPath`, `ratePath` |
 | `Marquee` | Recorded-audio bubble (messenger design G4) | — |
 | `Timeline` | Recorded-audio bubble (messenger design G4) | `entriesPath` |
@@ -115,7 +116,7 @@ See also **[Modifiers](#modifiers)** (the `modifiers` block) and **[Actions](#ac
 
 These props are accepted by the schema and pass validation, but the named platform's renderer never reads them — they silently do nothing (no warning, no log). Prefer a prop NOT listed here, or drive the behaviour from a worker.
 
-**Scope: 14 of 83 components, all of them ios-only** — every other component/platform pair reads every prop it decodes. The list splits in two, and the halves mean different things:
+**Scope: 14 of 84 components, all of them ios-only** — every other component/platform pair reads every prop it decodes. The list splits in two, and the halves mean different things:
 
 - **`category` (4: `BottomSheet`, `Menu`, `Tooltip`, `Popover`)** — the prop changes the component's *kind*. These genuinely are **not implemented**: an overlay renders always-visible inline, so the component does not do the job its name implies. Check the row's note for a working alternative — for a dismissible sheet it is `presentation: "sheet"` on the navigating `Action`, not `BottomSheet`.
 - **`styling` (10: `FieldError`, `Picker`, `DatePicker`, `Tabs`, `Snackbar`, `Slider`, `ActivityIndicator`, `ChipsInput`, `OtpInput`, `Video`)** — the component itself **works**; only the listed prop is inert. `Slider` on iOS is a working slider whose `debounceMs` does not throttle — not a broken `Slider`. Use the component; just do not depend on that one prop.
@@ -1615,6 +1616,44 @@ export interface RichContentProps {
 }
 ```
 
+### Rich content editor
+
+#### RichContentEditor
+
+```ts
+export interface RichContentEditorProps {
+  /** Form-bag key. Required inside a Form (validator). */
+  name?: string;
+  /** `$service:<svc>.<path>` → the document JSON string. Seeds ONCE (the first non-empty value). */
+  documentPath?: string;
+  /** Literal seed document JSON. At most one of documentPath / documentJson. */
+  documentJson?: string;
+  placeholder?: string;
+  /** Empty ⇒ all, minus "image" unless uploadService is set. "image" requires uploadService. */
+  tools?: RichContentEditorTool[];
+  /** Debounced ≥ 500 ms; args = { dirty: "true" } — never the document. */
+  onChange?: Action;
+  /** Worker service made by `ricosUploadService` (@himalaya/wix-rich-content-editor). Enables "image". */
+  uploadService?: string;
+  /** Take the remaining height of a bounded parent; else `minHeight`. */
+  fillAvailable?: boolean;
+  /** Default 240. */
+  minHeight?: number;
+  /** Rendered when the engine page is unavailable (not bundled / missing / failed / 15 s timeout). */
+  fallback?: Component;
+}
+```
+
+**Dispatches** — see [What a control sends](#what-a-control-sends-action-payloads):
+
+| callback | key | type |
+|---|---|---|
+| `onChange` | `dirty` | string |
+
+> `onChange` — Always the string "true", debounced ≥ 500 ms after a change that moved the document. Never the document itself: that rides the Form bag under `name`, so the submit action receives it as `values[name]`.
+
+> ⚠️ **`onChange` on ios + android — DIVERGES:** renders `fallback` only — no editor exists yet, so nothing dispatches on_change. The editor has not reached these renderers yet, so they show the descriptor's `fallback`; the editor runs on the web and in React Native hosts that register its adapter.
+
 ### Recorded-audio bubble (messenger design G4)
 
 #### VoiceNote
@@ -2201,7 +2240,8 @@ export interface LogicBundleRef {
 A few props take a typed **object** rather than nested components. Some are arrays of them:
 `FilterChips.chips` is a `FilterChip[]`, `SegmentedControl.options` / `Tabs.tabs` are a
 `TabItem[]`, `Picker.options` / `WheelPicker.options` are a `PickerOption[]`, and
-`Gauge.rings` is a `GaugeRing[]` (concentric rings, drawn outer→inner).
+`Gauge.rings` is a `GaugeRing[]` (concentric rings, drawn outer→inner), and
+`RichContentEditor.tools` is a `RichContentEditorTool[]` (a fixed list of toolbar buttons).
 One is a single object: `Text.timeRef` is a `WidgetTimeRef`, the widget-safe live clock —
 note its `at` is REQUIRED and is in epoch SECONDS. The prop blocks above name these types;
 here are the interfaces themselves (for the arrays, each item's own fields — `id` is what an
@@ -2240,6 +2280,8 @@ export interface WidgetTimeRef {
   /** SwiftUI `Text.DateStyle` / Android time style (default "timer"). */
   style?: "timer" | "relative" | "date" | "time" | "offset";
 }
+
+export type RichContentEditorTool = "bold" | "italic" | "underline" | "heading" | "bullet" | "ordered" | "quote" | "link" | "image" | "divider" | "undo" | "redo";
 ```
 
 ## Modifiers

package/guides/importable-sdks.md

@@ -112,6 +112,7 @@ direction the platform is heading — recommended, not required). Usage is unifo
 - `@himalaya/wix-restaurants` — Restaurants — menus and orders
 - `@himalaya/wix-reviews` — Product and site reviews
 - `@himalaya/wix-rich-content` — Ricos rich content — encode a post body for the RichContent viewer; plain-text helpers
+- `@himalaya/wix-rich-content-editor` — RichContentEditor image uploads — ricosUploadService mints the signed Wix Media URL
 - `@himalaya/wix-seo` — Wix seo — typed REST client
 - `@himalaya/wix-site-list` — The user's Wix sites
 - `@himalaya/wix-site-media` — Wix site media — typed REST client

package/guides/index.json

@@ -1,7 +1,7 @@
 {
   "_comment": "AUTO-GENERATED by tools/authoring-kit/bundle.mjs — DO NOT EDIT. Regenerate with: npm run authoring:gen",
   "schemaStamp": {
-    "componentCount": 83,
+    "componentCount": 84,
     "schemaSource": "core/ts/src/schema.ts"
   },
   "portalUrl": "https://apps.wix.com/_api/himi-serve/docs",

package/guides/sdk-reference.json

@@ -5362,7 +5362,7 @@
         "name": "getAutomationRevision",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function getAutomationRevision(\n  automationId: string,\n  opts?: WixCallOptions,\n): Promise<WixGetAutomationRevisionResponse>;",
+        "decl": "export function getAutomationRevision(\n  automationId: string,\n  req?: Omit<WixGetAutomationRevisionRequest, \"automationId\">,\n  opts?: WixCallOptions,\n): Promise<WixGetAutomationRevisionResponse>;",
         "http": "GET /automations/v1/automation-revisions/{…}"
       },
       {
@@ -5530,7 +5530,7 @@
         "name": "deletePreinstalledAutomation",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function deletePreinstalledAutomation(\n  componentId: string,\n  opts?: WixCallOptions,\n): Promise<WixDeletePreinstalledAutomationResponse>;",
+        "decl": "export function deletePreinstalledAutomation(\n  componentId: string,\n  req?: Omit<WixDeletePreinstalledAutomationRequest, \"componentId\">,\n  opts?: WixCallOptions,\n): Promise<WixDeletePreinstalledAutomationResponse>;",
         "http": "DELETE /automations/v2/preinstalled-automation/{…}"
       },
       {
@@ -5949,7 +5949,7 @@
         "name": "unassignBadge",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function unassignBadge(\n  id: string,\n  opts?: WixCallOptions,\n): Promise<WixUnassignBadgeResponse>;",
+        "decl": "export function unassignBadge(\n  id: string,\n  req?: Omit<WixUnassignBadgeRequest, \"id\">,\n  opts?: WixCallOptions,\n): Promise<WixUnassignBadgeResponse>;",
         "http": "DELETE /badges/v4/badges/{…}/members"
       },
       {
@@ -10162,7 +10162,7 @@
         "name": "getCommentThread",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function getCommentThread(\n  commentId: string,\n  opts?: WixCallOptions,\n): Promise<WixGetCommentThreadResponse>;",
+        "decl": "export function getCommentThread(\n  commentId: string,\n  req?: Omit<WixGetCommentThreadRequest, \"commentId\">,\n  opts?: WixCallOptions,\n): Promise<WixGetCommentThreadResponse>;",
         "http": "GET /comments/v1/comments/{…}/thread"
       },
       {
@@ -12688,7 +12688,7 @@
         "name": "getDataCollection",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function getDataCollection(\n  dataCollectionId: string,\n  opts?: WixCallOptions,\n): Promise<WixGetDataCollectionResponse>;",
+        "decl": "export function getDataCollection(\n  dataCollectionId: string,\n  req?: Omit<WixGetDataCollectionRequest, \"dataCollectionId\">,\n  opts?: WixCallOptions,\n): Promise<WixGetDataCollectionResponse>;",
         "http": "GET /data/v2/collections/{…}"
       },
       {
@@ -14904,7 +14904,7 @@
         "name": "listRecipients",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function listRecipients(\n  campaignId: string,\n  opts?: WixCallOptions,\n): Promise<WixListRecipientsResponse>;",
+        "decl": "export function listRecipients(\n  campaignId: string,\n  req?: Omit<WixListRecipientsRequest, \"campaignId\">,\n  opts?: WixCallOptions,\n): Promise<WixListRecipientsResponse>;",
         "http": "GET /email-marketing/v1/campaigns/{…}/statistics/recipients"
       },
       {
@@ -14983,7 +14983,7 @@
         "name": "getCampaign",
         "kind": "function",
         "jsdoc": "/**\n * Retrieves information about an email campaign.\n *\n * Wix permissions: shoutout.manage.\n *\n * @scope owner — requires an owner / business identity — a visitor session gets 403.\n *\n * GET /email-marketing/v1/campaigns/{campaignId}\n */",
-        "decl": "export function getCampaign(\n  campaignId: string,\n  opts?: WixCallOptions,\n): Promise<WixGetCampaignResponse>;",
+        "decl": "export function getCampaign(\n  campaignId: string,\n  req?: Omit<WixGetCampaignRequest, \"campaignId\">,\n  opts?: WixCallOptions,\n): Promise<WixGetCampaignResponse>;",
         "http": "GET /email-marketing/v1/campaigns/{…}",
         "scope": "owner"
       },
@@ -21318,6 +21318,43 @@
       }
     ]
   },
+  {
+    "name": "@himalaya/wix-rich-content-editor",
+    "source": "stdlib/wix-sdk/rich-content-editor/src/index.ts",
+    "description": "RichContentEditor image uploads — ricosUploadService mints the signed Wix Media URL",
+    "api": [
+      {
+        "name": "DEFAULT_MAX_UPLOAD_BYTES",
+        "kind": "const",
+        "jsdoc": "",
+        "decl": "export const DEFAULT_MAX_UPLOAD_BYTES = 25 * 1024 * 1024;"
+      },
+      {
+        "name": "RicosUploadError",
+        "kind": "type",
+        "jsdoc": "",
+        "decl": "export type RicosUploadError = \"bad_request\" | \"unsupported_type\" | \"too_large\" | \"upload_url_failed\";"
+      },
+      {
+        "name": "RicosUploadEntry",
+        "kind": "type",
+        "jsdoc": "",
+        "decl": "export type RicosUploadEntry = { status: \"ready\"; uploadUrl: string } | { status: \"error\"; error: RicosUploadError };"
+      },
+      {
+        "name": "RicosUploadState",
+        "kind": "interface",
+        "jsdoc": "",
+        "decl": "export interface RicosUploadState { uploads: Record<string, RicosUploadEntry>; maxBytes: number }"
+      },
+      {
+        "name": "ricosUploadService",
+        "kind": "function",
+        "jsdoc": "/** A worker service named `name` with two actions the RichContentEditor arm dispatches:\n *  `genUpload({requestId, mimeType, fileName, sizeBytes?})` → `state.uploads[requestId]`, and\n *  `clearUpload({requestId})`. Errors are reason codes, never server messages. */",
+        "decl": "export function ricosUploadService(name: string, opts: { maxBytes?: number } = {});"
+      }
+    ]
+  },
   {
     "name": "@himalaya/wix-seo",
     "source": "stdlib/wix-sdk/seo-v1/src/index.ts",
@@ -22591,7 +22628,7 @@
         "name": "getWorkflow",
         "kind": "function",
         "jsdoc": "",
-        "decl": "export function getWorkflow(\n  id: string,\n  opts?: WixCallOptions,\n): Promise<WixGetWorkflowResponse>;",
+        "decl": "export function getWorkflow(\n  id: string,\n  req?: Omit<WixGetWorkflowRequest, \"id\">,\n  opts?: WixCallOptions,\n): Promise<WixGetWorkflowResponse>;",
         "http": "GET /workflows/v1/workflows/{…}"
       },
       {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/himalaya-cli",
-  "version": "0.1101.0",
+  "version": "0.1102.0",
   "type": "module",
   "description": "himi — the Himalaya authoring CLI. Build a Tier-5 content package on your own machine, push it to the production serve as a draft, preview it on web + Himi Player, and read worker logs back — the remote dev loop. Wraps @himalaya/serve-cli for transport.",
   "keywords": [
@@ -67,5 +67,5 @@
       "artifactId": "himalaya-cli"
     }
   },
-  "falconPackageHash": "2618ea0b06031d403b767c776f5a991ef20f8a4b7878493bbd8bee92"
+  "falconPackageHash": "49e51090f4e4f0dc82b4398a9f06fb4f52e4055be047ff22734a8d41"
 }