@wix/himalaya-cli 0.1321.0 → 0.1322.0

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

@@ -28,6 +28,10 @@ export interface PageCapabilityResponse {
         code?: string;
     };
 }
+/** `call("himalaya", "capabilities")` answers `{ v: 1, capabilities: { <id>: [<method>…] } }`:
+ *  exactly the allowlist this worker was given. Reserved, so no real capability can take it. */
+export declare const PAGE_HANDSHAKE_CAPABILITY = "himalaya";
+export declare const PAGE_HANDSHAKE_METHOD = "capabilities";
 export interface ExposedPageCapability {
     module: Record<string, unknown>;
     methods: readonly string[];

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

@@ -18,8 +18,23 @@ export interface WebViewPageResponse {
     result?: unknown;
     error?: WebViewPageError;
 }
-/** Invoke one method through the companion worker. Primarily useful to generated bindings. */
+/** Invoke one method through the companion worker. Primarily useful to generated bindings.
+ *  A call that shows native UI (a permission prompt, the share sheet) answers only when the user
+ *  is done with it: pass a long `timeoutMs` (e.g. 120_000) rather than the 30-second default. */
 export declare function call<T>(capability: string, method: string, args?: unknown[], timeoutMs?: number): Promise<T>;
+/**
+ * The capabilities and methods this page's companion worker answers, as `{ <id>: [<method>…] }`;
+ * `null` outside the app, when the app is older than the handshake, or nothing answered in
+ * `timeoutMs`. A list is remembered (and returned at once, whatever `timeoutMs`); a miss is not,
+ * because a worker that is still booting drops the first messages.
+ */
+export declare function enabledCapabilities(timeoutMs?: number): Promise<Record<string, string[]> | null>;
+/** Whether the companion worker lets this page call `capability.method`, read from
+ *  enabledCapabilities() — nothing is called. `false` when there is no list. */
+export declare function isEnabled(capability: string, method: string, timeoutMs?: number): Promise<boolean>;
+/** For an app older than the handshake: CALL `capability.method` and report whether it answered
+ *  (even with an error). It runs the method, so pass only a read-only one. */
+export declare function probe(capability: string, method: string, args?: unknown[], timeoutMs?: number): Promise<boolean>;
 /**
  * Typed SDK proxy for every request/response capability in CAPABILITY_REGISTRY.
  * A namespace is usable only when this screen's companion worker explicitly imported and

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/stores-v1/src/display.d.ts

@@ -106,11 +106,32 @@ export interface StoreProductSearch {
     query?: string;
     sort?: 'default' | 'az' | 'za';
     ids?: string[];
+    /**
+     * Only products in this category (V3) / collection (V1) — a category screen's
+     * "products in X". ANDed with `ids` when both are given.
+     *
+     * V3 matches `allCategoriesInfo.categories`, so a parent category also lists its
+     * subcategories' products, as the site does. Only Search Products can filter by
+     * category — Query Products answers `not declared as filterable` — so a
+     * `categoryId` always routes the V3 read to `/products/search`. V1 matches
+     * `collections.id`.
+     */
+    categoryId?: string;
     limit?: number;
     cursor?: string;
     /** Extra v3 fieldsets. Additive — widens the default, never replaces it. */
     fields?: readonly string[];
 }
+/**
+ * Search, sort, and filter products on whichever catalog this site runs — the read
+ * behind a shop list, a saved-products list, and a category screen.
+ *
+ * `categoryId` narrows to one category's products (V3 `allCategoriesInfo`, so a parent
+ * category includes its subcategories; V1 `collections.id`), ANDed with `ids`. An
+ * empty `ids` array resolves to an empty page WITHOUT a request. Paging is one
+ * contract on both catalogs: pass back `pagingMetadata.cursors.next` as `cursor`.
+ * A non-catalog failure (401/403, offline) rejects; it is never retried on V1.
+ */
 export declare function searchStoreProducts(options?: StoreProductSearch): Promise<StoreProductsResponse>;
 /** Read one product from whichever catalog this site runs. `fields` is additive —
  *  it WIDENS the default v3 display fieldset rather than replacing it. */

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

@@ -51,6 +51,81 @@ function call(capability, method, args = [], timeoutMs = 3e4) {
     }
   });
 }
+var manifest;
+function currentBridge() {
+  try {
+    return workerBridge();
+  } catch {
+    return void 0;
+  }
+}
+function timedOut(error) {
+  return error instanceof Error && error.message.startsWith("Himalaya capability call timed out");
+}
+var asking;
+function askShared(target, budget) {
+  const until = Date.now() + budget;
+  if (asking?.on === target) {
+    asking.until = Math.max(asking.until, until);
+    return asking.answer;
+  }
+  const state = { on: target, until, answer: Promise.resolve(null) };
+  asking = state;
+  state.answer = new Promise((resolve) => {
+    let done = false;
+    const finish = (list) => {
+      if (done) return;
+      done = true;
+      clearInterval(again);
+      if (asking === state) asking = void 0;
+      if (list) manifest = { on: target, list };
+      resolve(list);
+    };
+    const ask = () => {
+      if (done) return;
+      const left = state.until - Date.now();
+      if (left <= 0 || currentBridge() !== target) return finish(null);
+      call("himalaya", "capabilities", [], Math.max(1, Math.min(2e3, left))).then(
+        (reply) => finish(reply?.capabilities ?? null),
+        // A timed-out question is not an answer; the deadline decides. Anything else is final.
+        (error) => {
+          if (!timedOut(error)) finish(null);
+        }
+      );
+    };
+    const again = setInterval(ask, 500);
+    ask();
+  });
+  return state.answer;
+}
+async function enabledCapabilities(timeoutMs = 3e3) {
+  const bridge = currentBridge();
+  if (!bridge) return null;
+  if (manifest?.on === bridge) return manifest.list;
+  if (!(timeoutMs > 0)) return null;
+  const budget = Math.min(timeoutMs, 2147483647);
+  const answer = askShared(bridge, budget);
+  return new Promise((resolve) => {
+    const stop = setTimeout(() => resolve(manifest?.on === bridge ? manifest.list : null), budget);
+    void answer.then((list) => {
+      clearTimeout(stop);
+      resolve(list);
+    });
+  });
+}
+async function isEnabled(capability, method, timeoutMs = 3e3) {
+  const enabled = await enabledCapabilities(timeoutMs);
+  return enabled?.[capability]?.includes(method) ?? false;
+}
+async function probe(capability, method, args = [], timeoutMs = 3e3) {
+  if (!currentBridge()) return false;
+  try {
+    await call(capability, method, args, timeoutMs);
+    return true;
+  } catch (error) {
+    return !(timedOut(error) || /refused the request/.test(error.message));
+  }
+}
 var members = /* @__PURE__ */ new Map();
 function pageMember(capability, path) {
   const key = `${capability}:${path.join(".")}`;
@@ -81,8 +156,11 @@ var health = himalaya.health;
 var version = 1;
 export {
   call,
+  enabledCapabilities,
   health,
   himalaya,
+  isEnabled,
+  probe,
   version
 };
 //# sourceMappingURL=webview-page.mjs.map

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

@@ -14,6 +14,8 @@ function postToPage(msg) {
 function onPageMessage(cb) {
   runtime().onPageMessage(cb);
 }
+var PAGE_HANDSHAKE_CAPABILITY = "himalaya";
+var PAGE_HANDSHAKE_METHOD = "capabilities";
 function pageRequest(value) {
   if (!value || typeof value !== "object") return null;
   const request = value;
@@ -29,15 +31,27 @@ function pageError(value) {
   };
 }
 function exposeCapabilitiesToPage(capabilities) {
+  if (Object.prototype.hasOwnProperty.call(capabilities, PAGE_HANDSHAKE_CAPABILITY)) {
+    throw new Error(`"${PAGE_HANDSHAKE_CAPABILITY}" is reserved for the page handshake and cannot be exposed`);
+  }
   const allowed = new Map(
     Object.entries(capabilities).map(([id, entry]) => [id, {
       module: entry.module,
       methods: new Set(entry.methods)
     }])
   );
+  const manifest = Object.fromEntries(
+    [...allowed].map(([id, entry]) => [id, [...entry.methods].sort()])
+  );
   onPageMessage((message) => {
     const request = pageRequest(message);
     if (!request) return;
+    if (request.capability === PAGE_HANDSHAKE_CAPABILITY) {
+      if (request.method === PAGE_HANDSHAKE_METHOD) {
+        postToPage({ v: 1, id: request.id, ok: true, result: { v: 1, capabilities: manifest } });
+      }
+      return;
+    }
     const capability = allowed.get(request.capability);
     let candidate = capability?.module;
     let receiver = void 0;
@@ -58,6 +72,8 @@ function exposeCapabilitiesToPage(capabilities) {
 }
 var version = 1;
 export {
+  PAGE_HANDSHAKE_CAPABILITY,
+  PAGE_HANDSHAKE_METHOD,
   exposeCapabilitiesToPage,
   onPageMessage,
   postToPage,

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

@@ -369,21 +369,30 @@ async function searchStoreProducts(options = {}) {
   const limit = Math.max(1, Math.min(100, Math.floor(options.limit ?? 50) || 50));
   const ids = options.ids === void 0 ? void 0 : [...new Set(options.ids.filter((id) => typeof id === "string" && !!id))].slice(0, 500);
   if (ids && !ids.length) return { products: [], pagingMetadata: { total: 0, count: 0, cursors: { next: null }, hasNext: false } };
+  const categoryId = typeof options.categoryId === "string" ? options.categoryId.trim() : "";
   const ascending = options.sort === "az", sorted = ascending || options.sort === "za";
   return readWithCatalogFallback((version) => {
     if (version === "v1") {
       const offset = v1Offset(options.cursor);
-      const filter = { ...query ? { name: { $contains: query } } : {}, ...ids ? { id: { $hasSome: ids } } : {} };
+      const filter2 = {
+        ...query ? { name: { $contains: query } } : {},
+        ...ids ? { id: { $hasSome: ids } } : {},
+        ...categoryId ? { "collections.id": { $hasSome: [categoryId] } } : {}
+      };
       return wixCall("POST", "/stores/v1/products/query", { query: {
         paging: { limit, offset },
-        ...Object.keys(filter).length ? { filter: JSON.stringify(filter) } : {},
+        ...Object.keys(filter2).length ? { filter: JSON.stringify(filter2) } : {},
         ...sorted ? { sort: JSON.stringify([{ name: ascending ? "asc" : "desc" }]) } : {}
       } }).then((res) => fromV1(res, offset));
     }
-    const search = !!query || sorted;
+    const filter = {
+      ...ids ? { id: { $in: ids } } : {},
+      ...categoryId ? { "allCategoriesInfo.categories": { $matchItems: [{ id: categoryId }] } } : {}
+    };
+    const search = !!query || sorted || !!categoryId;
     const criteria = {
       cursorPaging: { limit, ...options.cursor ? { cursor: options.cursor } : {} },
-      ...ids ? { filter: { id: { $in: ids } } } : {},
+      ...Object.keys(filter).length ? { filter } : {},
       ...query ? { search: { expression: query, fields: ["name"] } } : {},
       ...sorted ? { sort: [{ fieldName: "name", order: ascending ? "ASC" : "DESC" }] } : {}
     };

package/dist/cli.mjs

@@ -149133,6 +149133,7 @@ __export(nav_lint_exports, {
   NAV_KINDS: () => NAV_KINDS,
   SERVED_ONLY_NAV_KEYS: () => SERVED_ONLY_NAV_KEYS,
   navIssues: () => navIssues,
+  navSharedIdErrors: () => navSharedIdErrors,
   pushRouteAdvisories: () => pushRouteAdvisories
 });
 async function navIssues(dir, strict) {
@@ -149209,6 +149210,7 @@ async function navIssues(dir, strict) {
   for (const message of navConfigPathErrors({ ...nav, homeScreenId: servedHome })) {
     error("nav-path-malformed", `navigation.${message}`);
   }
+  for (const message of navSharedIdErrors(nav)) error("nav-row-id-shadows-tab", `navigation.${message}`);
   const navKind = nav.navKind;
   const effectiveBottomTabs = navKind === void 0 || navKind === "bottomTabs" || typeof navKind !== "string" || !NAV_KINDS.has(navKind);
   const declaresOtherChrome = itemCount(nav.drawer) > 0 || itemCount(nav.sidebar) > 0;
@@ -149316,6 +149318,29 @@ function unmappedAdvisory({ destination, vertical, reason, screenId, paramKey })
   }
   return `push-route-unmapped: the site has ${vertical}, but no screen opens "${destination}" notifications. Name that screen "${canonical4}", or map it: push.screens: { "${destination}": "<screenId>" }.`;
 }
+function navSharedIdErrors(nav) {
+  const items = (key2) => {
+    const block = nav[key2];
+    const list = isPlainObject2(block) ? block.items : void 0;
+    return Array.isArray(list) ? list.flatMap((x2, i2) => isPlainObject2(x2) ? [[x2, i2]] : []) : [];
+  };
+  const tabScreens = /* @__PURE__ */ new Map();
+  for (const [tab] of items("tabBar")) if (typeof tab.id === "string" && !tabScreens.has(tab.id)) tabScreens.set(tab.id, tab.screenId);
+  const out2 = [];
+  for (const key2 of ["drawer", "sidebar"]) {
+    for (const [row, i2] of items(key2)) {
+      if (typeof row.id !== "string" || !tabScreens.has(row.id)) continue;
+      const tabScreen = tabScreens.get(row.id);
+      if (typeof tabScreen !== "string") continue;
+      if (key2 === "drawer" && (row.role === "section" || row.role === "note")) continue;
+      if (typeof row.screenId !== "string" || row.screenId === "" || row.screenId === tabScreen) continue;
+      out2.push(
+        `${key2}.items[${i2}] "${row.id}": a tab has this id but opens ${JSON.stringify(tabScreen)}, not "${row.screenId}" \u2014 every shell hands its host one id and the host resolves tabs first, so this row would open the tab's screen. Give the row its own id.`
+      );
+    }
+  }
+  return out2;
+}
 var NAVIGATION_KEYS, NAV_KINDS, ITEMS_BLOCKS, SERVED_ONLY_NAV_KEYS, MISPLACED_TOP_LEVEL_KEYS, isPlainObject2, itemCount;
 var init_nav_lint = __esm({
   "src/nav-lint.ts"() {

package/guides/sdk-reference.json

@@ -4188,6 +4188,18 @@
         "jsdoc": "",
         "decl": "export interface PageCapabilityResponse {\n  v: 1;\n  id: string;\n  ok: boolean;\n  result?: unknown;\n  error?: { message: string; code?: string };\n}"
       },
+      {
+        "name": "PAGE_HANDSHAKE_CAPABILITY",
+        "kind": "const",
+        "jsdoc": "/** `call(\"himalaya\", \"capabilities\")` answers `{ v: 1, capabilities: { <id>: [<method>…] } }`:\n *  exactly the allowlist this worker was given. Reserved, so no real capability can take it. */",
+        "decl": "export const PAGE_HANDSHAKE_CAPABILITY = \"himalaya\";"
+      },
+      {
+        "name": "PAGE_HANDSHAKE_METHOD",
+        "kind": "const",
+        "jsdoc": "",
+        "decl": "export const PAGE_HANDSHAKE_METHOD = \"capabilities\";"
+      },
       {
         "name": "ExposedPageCapability",
         "kind": "interface",
@@ -4240,9 +4252,27 @@
       {
         "name": "call",
         "kind": "function",
-        "jsdoc": "/** Invoke one method through the companion worker. Primarily useful to generated bindings. */",
+        "jsdoc": "/** Invoke one method through the companion worker. Primarily useful to generated bindings.\n *  A call that shows native UI (a permission prompt, the share sheet) answers only when the user\n *  is done with it: pass a long `timeoutMs` (e.g. 120_000) rather than the 30-second default. */",
         "decl": "export function call<T>(\n  capability: string,\n  method: string,\n  args: unknown[] = [],\n  timeoutMs = 30_000,\n): Promise<T>;"
       },
+      {
+        "name": "enabledCapabilities",
+        "kind": "function",
+        "jsdoc": "/**\n * The capabilities and methods this page's companion worker answers, as `{ <id>: [<method>…] }`;\n * `null` outside the app, when the app is older than the handshake, or nothing answered in\n * `timeoutMs`. A list is remembered (and returned at once, whatever `timeoutMs`); a miss is not,\n * because a worker that is still booting drops the first messages.\n */",
+        "decl": "export async function enabledCapabilities(timeoutMs = 3_000): Promise<Record<string, string[]> | null>;"
+      },
+      {
+        "name": "isEnabled",
+        "kind": "function",
+        "jsdoc": "/** Whether the companion worker lets this page call `capability.method`, read from\n *  enabledCapabilities() — nothing is called. `false` when there is no list. */",
+        "decl": "export async function isEnabled(capability: string, method: string, timeoutMs = 3_000): Promise<boolean>;"
+      },
+      {
+        "name": "probe",
+        "kind": "function",
+        "jsdoc": "/** For an app older than the handshake: CALL `capability.method` and report whether it answered\n *  (even with an error). It runs the method, so pass only a read-only one. */",
+        "decl": "export async function probe(capability: string, method: string, args: unknown[] = [], timeoutMs = 3_000): Promise<boolean>;"
+      },
       {
         "name": "himalaya",
         "kind": "const",
@@ -23108,12 +23138,12 @@
         "name": "StoreProductSearch",
         "kind": "interface",
         "jsdoc": "/** User-facing product discovery. V3 name search/sorting belong to Search\n * Products; Query Products deliberately does not support the name field.\n * V1 uses its documented JSON-string filter/sort dialect. */",
-        "decl": "export interface StoreProductSearch {\n  query?: string;\n  sort?: 'default' | 'az' | 'za';\n  ids?: string[];\n  limit?: number;\n  cursor?: string;\n  /** Extra v3 fieldsets. Additive — widens the default, never replaces it. */\n  fields?: readonly string[];\n}"
+        "decl": "export interface StoreProductSearch {\n  query?: string;\n  sort?: 'default' | 'az' | 'za';\n  ids?: string[];\n  /**\n   * Only products in this category (V3) / collection (V1) — a category screen's\n   * \"products in X\". ANDed with `ids` when both are given.\n   *\n   * V3 matches `allCategoriesInfo.categories`, so a parent category also lists its\n   * subcategories' products, as the site does. Only Search Products can filter by\n   * category — Query Products answers `not declared as filterable` — so a\n   * `categoryId` always routes the V3 read to `/products/search`. V1 matches\n   * `collections.id`.\n   */\n  categoryId?: string;\n  limit?: number;\n  cursor?: string;\n  /** Extra v3 fieldsets. Additive — widens the default, never replaces it. */\n  fields?: readonly string[];\n}"
       },
       {
         "name": "searchStoreProducts",
         "kind": "function",
-        "jsdoc": "",
+        "jsdoc": "/**\n * Search, sort, and filter products on whichever catalog this site runs — the read\n * behind a shop list, a saved-products list, and a category screen.\n *\n * `categoryId` narrows to one category's products (V3 `allCategoriesInfo`, so a parent\n * category includes its subcategories; V1 `collections.id`), ANDed with `ids`. An\n * empty `ids` array resolves to an empty page WITHOUT a request. Paging is one\n * contract on both catalogs: pass back `pagingMetadata.cursors.next` as `cursor`.\n * A non-catalog failure (401/403, offline) rejects; it is never retried on V1.\n */",
         "decl": "export async function searchStoreProducts(options: StoreProductSearch = {}): Promise<StoreProductsResponse>;",
         "http": "POST /stores/v1/products/query"
       },