@akinon/pz-theme 2.0.38-rc.0 → 2.0.38

package/src/chrome/route-slug.ts

@@ -0,0 +1,159 @@
+import { PLACEHOLDER_SLUGS } from './placeholder-slugs';
+
+export type RouteSlugRule = [RegExp, string];
+
+/**
+ * Maps a storefront path to the placeholder slug that composes its body.
+ *
+ * A brand mounts one `ChromeSlot` per *layout* rather than per page — the
+ * account layout alone covers sixteen screens — and a layout only knows the
+ * current path. Resolving here keeps that lookup out of brand code and keeps
+ * the editor's route map and the storefront agreeing on one table.
+ *
+ * Brands rename these paths freely (`/users/orders` on one, `/account/orders`
+ * on the next, `/baskets/basket` on a third), so the defaults accept the
+ * variants that actually ship, and anything else is registered with
+ * `registerRouteSlugRules` instead of forking this file.
+ *
+ * Order matters: the most specific pattern wins, so `/users/orders/123`
+ * resolves to the order detail body and not to the order list.
+ */
+const DEFAULT_RULES: RouteSlugRule[] = [
+  // Account — deepest first
+  [
+    /^\/(account|users)\/orders\/[^/]+/,
+    PLACEHOLDER_SLUGS.accountOrderDetail
+  ],
+  [/^\/(account|users)\/orders\/?$/, PLACEHOLDER_SLUGS.accountOrders],
+  [/^\/account\/address/, PLACEHOLDER_SLUGS.accountAddresses],
+  [/^\/account\/profile/, PLACEHOLDER_SLUGS.accountProfile],
+  [/^\/account\/change-password/, PLACEHOLDER_SLUGS.accountChangePassword],
+  [/^\/account\/change-email/, PLACEHOLDER_SLUGS.accountChangeEmail],
+  [/^\/account\/coupons/, PLACEHOLDER_SLUGS.accountCoupons],
+  [
+    /^\/account\/(favourite-products|favorites|wishlist)/,
+    PLACEHOLDER_SLUGS.accountFavourites
+  ],
+  [
+    /^\/account\/stock-(waiting-products|alerts)/,
+    PLACEHOLDER_SLUGS.accountStockAlerts
+  ],
+  [
+    /^\/account\/notification-settings/,
+    PLACEHOLDER_SLUGS.accountNotifications
+  ],
+  [/^\/account\/faq/, PLACEHOLDER_SLUGS.accountFaq],
+  // Any other account screen composes the shell body, which is what the
+  // account layout mounts for it.
+  [/^\/account(\/|$)/, PLACEHOLDER_SLUGS.accountShell],
+
+  // Auth
+  [/^\/(users\/)?auth\/register/, PLACEHOLDER_SLUGS.register],
+  [/^\/(users\/)?register/, PLACEHOLDER_SLUGS.register],
+  [/^\/(users\/)?auth\/forgot-password/, PLACEHOLDER_SLUGS.forgotPassword],
+  [/^\/users\/password\/reset/, PLACEHOLDER_SLUGS.forgotPassword],
+  [/^\/(users\/)?auth\/guest/, PLACEHOLDER_SLUGS.guestLogin],
+  [/^\/(users\/)?auth/, PLACEHOLDER_SLUGS.auth],
+
+  // Order flow
+  [/^\/orders\/completed/, PLACEHOLDER_SLUGS.orderSuccess],
+  // Checkout is code-owned; the designer composes the zone above the flow
+  // (the zone below shares the page and is added by the editor's scope).
+  [/^\/orders\/checkout/, PLACEHOLDER_SLUGS.checkoutTop],
+  [/^\/anonymous-(orders|tracking)/, PLACEHOLDER_SLUGS.orderTracking],
+
+  // Commerce
+  [/^\/(baskets\/basket|basket|sepet)/, PLACEHOLDER_SLUGS.basket],
+  [/^\/(group-)?product\//, PLACEHOLDER_SLUGS.productDetail],
+  [/^\/category\//, PLACEHOLDER_SLUGS.productListing],
+  [/^\/special-page\//, PLACEHOLDER_SLUGS.productListing],
+  [/^\/list\/?$/, PLACEHOLDER_SLUGS.productListing],
+
+  // Content
+  [/^\/(address\/)?stores/, PLACEHOLDER_SLUGS.stores],
+  [/^\/faq/, PLACEHOLDER_SLUGS.faq],
+  [/^\/sitemap/, PLACEHOLDER_SLUGS.sitemap],
+  [/^\/(markalar|brands)/, PLACEHOLDER_SLUGS.brands],
+  [/^\/flat-page\//, PLACEHOLDER_SLUGS.flatPage],
+  [/^\/?$/, PLACEHOLDER_SLUGS.homepage]
+];
+
+/**
+ * Slugs whose *page* mounts the slot itself, because the blocks there need
+ * commerce data the page already fetched (product, listing, basket, account,
+ * order recap). Everything else can be mounted once in the root layout with
+ * `children` as the fallback — which is also the only way to compose a page
+ * that is a client component, since a slot is an async server component.
+ */
+const PAGE_MOUNTED_SLUGS = new Set<string>([
+  PLACEHOLDER_SLUGS.productDetail,
+  PLACEHOLDER_SLUGS.productListing,
+  PLACEHOLDER_SLUGS.basket,
+  PLACEHOLDER_SLUGS.orderSuccess,
+  PLACEHOLDER_SLUGS.accountShell,
+  PLACEHOLDER_SLUGS.accountMenu,
+  PLACEHOLDER_SLUGS.accountOrders,
+  PLACEHOLDER_SLUGS.accountOrderDetail,
+  PLACEHOLDER_SLUGS.accountAddresses,
+  PLACEHOLDER_SLUGS.accountProfile,
+  PLACEHOLDER_SLUGS.accountChangePassword,
+  PLACEHOLDER_SLUGS.accountChangeEmail,
+  PLACEHOLDER_SLUGS.accountCoupons,
+  PLACEHOLDER_SLUGS.accountFavourites,
+  PLACEHOLDER_SLUGS.accountStockAlerts,
+  PLACEHOLDER_SLUGS.accountNotifications,
+  PLACEHOLDER_SLUGS.accountFaq,
+  PLACEHOLDER_SLUGS.flatPage
+]);
+
+/** True when a deeper page/layout already mounts this slug's slot. */
+export const isPageMountedSlug = (slug: string | null): boolean =>
+  slug !== null && PAGE_MOUNTED_SLUGS.has(slug);
+
+let extraRules: RouteSlugRule[] = [];
+
+/**
+ * Adds brand-specific paths. Registered rules are matched before the
+ * defaults, so a brand can redirect any path to any placeholder.
+ */
+export const registerRouteSlugRules = (rules: RouteSlugRule[]) => {
+  extraRules = [...rules, ...extraRules];
+};
+
+/** Test helper: drops everything `registerRouteSlugRules` added. */
+export const resetRouteSlugRules = () => {
+  extraRules = [];
+};
+
+/** Strips query/hash and any trailing slash, keeping the leading one. */
+export const normalizePath = (pathname: string): string => {
+  const withoutQuery = (pathname || '/').split('?')[0].split('#')[0];
+  const prefixed = withoutQuery.startsWith('/')
+    ? withoutQuery
+    : `/${withoutQuery}`;
+  return prefixed.length > 1 ? prefixed.replace(/\/+$/, '') : '/';
+};
+
+/**
+ * Returns the body placeholder slug for a path, or `null` when the path has
+ * no dedicated placeholder (the brand's own page then renders untouched).
+ */
+export const resolveBodySlug = (pathname: string): string | null => {
+  const path = normalizePath(pathname);
+  const match = [...extraRules, ...DEFAULT_RULES].find(([pattern]) =>
+    pattern.test(path)
+  );
+  return match ? match[1] : null;
+};
+
+/**
+ * Same as `resolveBodySlug` but accepts the full URL a route segment carries
+ * (`params.url` on brands built with commerce/locale/currency segments).
+ */
+export const resolveBodySlugFromUrl = (url: string): string | null => {
+  try {
+    return resolveBodySlug(new URL(decodeURIComponent(url)).pathname);
+  } catch {
+    return resolveBodySlug(url);
+  }
+};

package/src/index.ts

@@ -19,3 +19,23 @@ export { WithDesignerFeatures } from './components/with-designer-features';
 
 export type { Section } from './theme-section';
 export type { Block } from './theme-block';
+
+export { default as ChromeSlot } from './chrome/chrome-slot';
+export { ChromeFallback } from './chrome/chrome-fallback';
+
+export {
+  PLACEHOLDER_SLUGS,
+  customPageSlug,
+  customPageSlugFromPath
+} from './chrome/placeholder-slugs';
+export type { PlaceholderSlug } from './chrome/placeholder-slugs';
+
+export {
+  resolveBodySlug,
+  resolveBodySlugFromUrl,
+  registerRouteSlugRules,
+  resetRouteSlugRules,
+  isPageMountedSlug,
+  normalizePath
+} from './chrome/route-slug';
+export type { RouteSlugRule } from './chrome/route-slug';