@wix/himalaya-cli 0.1168.0 → 0.1169.0

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

@@ -36,6 +36,16 @@ export interface SiteChrome {
      *  without a new binary, because the flag rides the OTA descriptor. */
     hideWixAds?: boolean;
 }
+/** Which native chrome frames the site. Rides the served `navigation.navKind`, so changing it is
+ *  an OTA config change, never a new binary.
+ *  - `auto` (default): bottom tabs on a phone and a sidebar rail on a regular size class
+ *    (`responsive`) — or, when the site has at most one tab, no tab bar at all (`single`: one
+ *    stack, the drawer lists every page). A bar holding a single tab is chrome with no choice in it.
+ *  - `tabs`: bottom tabs on every size class. `sidebar`: the rail on every size class.
+ *  - `drawer`: no tab bar; the drawer is the primary navigation and re-roots on each pick.
+ *  - `single`: no tab bar; one stack, and drawer picks push onto it. */
+export type SiteLayout = "auto" | "tabs" | "drawer" | "sidebar" | "single";
+export declare const SITE_LAYOUTS: readonly SiteLayout[];
 /** The whole site as a shell sees it. Mirrors the `site` block of a site-shell app's
  *  `provisioning.json`. */
 export interface SiteShellConfig {
@@ -45,6 +55,8 @@ export interface SiteShellConfig {
     kind: SiteKind;
     pages: readonly SitePage[];
     chrome?: SiteChrome;
+    /** Absent ⇒ `"auto"`. See {@link SiteLayout}. */
+    layout?: SiteLayout;
 }
 /** At most four site tabs; the rest belong in the drawer. Four, not the usual phone-bar five,
  *  because every tab keeps its WebView warm (`keepAlive`) and the native keep-alive stores
@@ -140,6 +152,12 @@ export interface SiteLinkTarget {
  * `<user>.wixsite.com` host `/my-site/../other` is somebody else's site.
  */
 export declare function resolveSiteLink(url: string, site: SiteNavConfig | undefined): SiteLinkTarget | null;
+/** The `navigation.navKind` a site's {@link SiteLayout} asks for. */
+export declare function siteNavKind(site: SiteShellConfig): "responsive" | "single" | "bottomTabs" | "drawer" | "sidebar";
+/** Sidebar-rail items for a site: EVERY page the drawer lists, under its tab id. The native rail
+ *  otherwise derives from the (at most four) tabs and suppresses the drawer, so a `drawer`
+ *  page would be unreachable on a tablet and under `layout: "sidebar"`. */
+export declare function siteSidebar(site: SiteShellConfig): NavTabItem[];
 /** Tab-bar and drawer items for a site. Pages beyond {@link SITE_SHELL_MAX_TABS} that
  *  asked for a tab fall into the drawer rather than disappearing. */
 export declare function siteNav(site: SiteShellConfig): {

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

@@ -13088,6 +13088,7 @@ var AppRegistryClient = class {
 };
 
 // ../../core/ts/src/site-shell.ts
+var SITE_LAYOUTS = ["auto", "tabs", "drawer", "sidebar", "single"];
 var SITE_SHELL_MAX_TABS = 4;
 var SITE_SCREEN_PREFIX = "site_";
 var SITE_PAGE_SCREEN_ID = "site_page";
@@ -13300,6 +13301,27 @@ function resolveSiteLink(url, site) {
   const screenId = best?.screenId || site.fallbackScreenId || (site.routes ?? []).find((route) => route?.screenId && pathSegments(siteRoutePath(route.path ?? "")).length === 0)?.screenId;
   return screenId ? { screenId, url: url.trim() } : null;
 }
+function siteNavKind(site) {
+  const layout = site.layout ?? "auto";
+  switch (layout) {
+    case "auto":
+      return siteNav(site).tabs.length <= 1 ? "single" : "responsive";
+    case "tabs":
+      return "bottomTabs";
+    case "drawer":
+      return "drawer";
+    case "sidebar":
+      return "sidebar";
+    case "single":
+      return "single";
+    default:
+      throw new Error(`site layout ${JSON.stringify(layout)} must be one of ${SITE_LAYOUTS.join(", ")}`);
+  }
+}
+function siteSidebar(site) {
+  assertSiteShellConfig(site);
+  return site.pages.filter((page) => (page.placement ?? "tab") !== "overflow").map((page) => ({ id: page.id, screenId: siteScreenId(page), label: page.title, icon: page.icon ?? "globe" }));
+}
 function siteNav(site) {
   assertSiteShellConfig(site);
   const tabs = [];
@@ -13320,6 +13342,9 @@ function assertSitePage(page) {
   if (!page || typeof page.id !== "string" || !PAGE_ID.test(page.id)) {
     throw new Error(`site page id ${JSON.stringify(page?.id)} must match ${PAGE_ID}`);
   }
+  if (page.id.startsWith("drawer_")) {
+    throw new Error(`site page id ${JSON.stringify(page.id)} must not start with "drawer_" (reserved for drawer and native rows)`);
+  }
   if (siteScreenId(page) === SITE_PAGE_SCREEN_ID) {
     throw new Error(`site page id "page" is reserved for the ${SITE_PAGE_SCREEN_ID} fallback screen`);
   }
@@ -13342,6 +13367,9 @@ function assertSiteShellConfig(site) {
     seen.add(page.id);
     sitePageUrl(site.origin, page.path);
   }
+  if (site.layout !== void 0 && !SITE_LAYOUTS.includes(site.layout)) {
+    throw new Error(`site layout ${JSON.stringify(site.layout)} must be one of ${SITE_LAYOUTS.join(", ")}`);
+  }
   if (!site.pages.some((page) => (page.placement ?? "tab") === "tab")) {
     throw new Error('a site shell needs at least one page with placement "tab"');
   }
@@ -13380,6 +13408,7 @@ export {
   PROJECTION_SNAPSHOT_SIZE,
   RICH_CONTENT_EDITOR_TOOLS,
   RTL_LOCALES,
+  SITE_LAYOUTS,
   SITE_PAGE_SCREEN_ID,
   SITE_SCREEN_PREFIX,
   SITE_SHELL_MAX_TABS,
@@ -13471,9 +13500,11 @@ export {
   siteLinkableScreens,
   siteNav,
   siteNavConfig,
+  siteNavKind,
   sitePageUrl,
   siteScreenId,
   siteScreens,
+  siteSidebar,
   siteWebViewPreset,
   stripOriginParams,
   summarize,