feat: update urls for primaryLocale and includeLocalePrefixForPrimaryLocale

packages/visual-editor/src/utils/getLocationPath.ts

@@ -1,13 +1,21 @@
 import { normalizeSlug } from "./slugifier.ts";
 import { AddressType } from "@yext/pages-components";
 import { StreamDocument } from "./applyTheme.ts";
+import {
+  getIsPrimaryLocale,
+  getLocalePrefix,
+  getPageSetConfig,
+} from "./pageset.ts";
 
 export interface LocationDocument extends StreamDocument {
   id: string;
   slug?: string;
   address?: AddressType;
 }
 
+// Returns the path for a location document, applying locale prefixes as needed.
+// If slug is present, uses slug. Otherwise, constructs path from address or id.
+// Should be used as a fallback when URL templates are not available.
 export const getLocationPath = (
   location: LocationDocument,
   relativePrefixToRoot: string = ""
@@ -16,6 +24,7 @@ export const getLocationPath = (
     throw new Error("Could not resolve location path.");
   }
 
+  // If there's a slug, don't apply locale prefix to it
   if (location.slug) {
     return `${relativePrefixToRoot}${location.slug}`;
   }
@@ -25,14 +34,22 @@ export const getLocationPath = (
     throw new Error("Missing locale for getLocationPath");
   }
 
-  const isPrimaryLocale =
-    location.__?.isPrimaryLocale === true ||
-    (location.__?.isPrimaryLocale === undefined && location.locale === "en");
+  const pageSetConfig = getPageSetConfig(location?._pageset);
+  const isPrimaryLocale = getIsPrimaryLocale({
+    locale,
+    pageSetConfig,
+    fallbackIsPrimaryLocale: location.__?.isPrimaryLocale,
+  });
+  const localePrefix = getLocalePrefix({
+    locale,
+    isPrimaryLocale,
+    includeLocalePrefixForPrimaryLocale:
+      pageSetConfig?.includeLocalePrefixForPrimaryLocale,
+  });
 
-  const localePath = isPrimaryLocale ? "" : `${locale}/`;
   const path = location.address
-    ? `${localePath}${location.address.region}/${location.address.city}/${location.address.line1}`
-    : `${localePath}${location.id}`;
+    ? `${localePrefix}${location.address.region}/${location.address.city}/${location.address.line1}`
+    : `${localePrefix}${location.id}`;
 
   return `${relativePrefixToRoot}${normalizeSlug(path)}`;
 };

packages/visual-editor/src/utils/mergeMeta.ts

@@ -1,21 +1,23 @@
+import { StreamDocument } from "./applyTheme.ts";
+import { getIsPrimaryLocale, getPageSetConfig } from "./pageset.ts";
+
 /**
  * Merges a profile object with meta fields from the streamDocument such as __, _pageset, and locale.
 
  * @param {Object} profile
  * @param {Object} streamDocument
  * @returns {Object}
  */
-export function mergeMeta(profile: any, streamDocument: any): any {
+export function mergeMeta(profile: any, streamDocument: StreamDocument): any {
   const locale: string = profile?.meta?.locale || streamDocument?.locale;
 
-  let isPrimaryLocale: boolean;
-  if (profile?.meta?.isPrimaryLocale === true) {
-    isPrimaryLocale = true;
-  } else if (profile?.meta?.isPrimaryLocale === false) {
-    isPrimaryLocale = false;
-  } else {
-    isPrimaryLocale = locale === "en";
-  }
+  const pageSetConfig = getPageSetConfig(streamDocument?._pageset);
+  const fallbackIsPrimaryLocale = streamDocument.__?.isPrimaryLocale;
+  const isPrimaryLocale = getIsPrimaryLocale({
+    locale,
+    pageSetConfig,
+    fallbackIsPrimaryLocale,
+  });
 
   return {
     locale: locale,

packages/visual-editor/src/utils/pageset.ts

@@ -0,0 +1,53 @@
+// based on Config in https://gerrit.yext.com/plugins/gitiles/alpha/+/refs/heads/master/src/com/yext/publish/pagesets/resource.proto#173
+export type PageSetConfig = {
+  primaryLocale?: string;
+  urlTemplate?: {
+    primary?: string;
+    alternate?: string;
+  };
+  includeLocalePrefixForPrimaryLocale?: boolean;
+  [key: string]: any; // allow any other fields
+};
+
+// Parses _pageset (string or object) and returns the config object.
+export const getPageSetConfig = (pageset: any): PageSetConfig => {
+  const pageSetJson =
+    typeof pageset === "string"
+      ? JSON.parse(pageset || "{}")
+      : (pageset as { config?: PageSetConfig }) || {};
+  return pageSetJson?.config || {};
+};
+
+// Determines if the locale is primary, falling back if needed.
+export const getIsPrimaryLocale = ({
+  locale,
+  pageSetConfig,
+  fallbackIsPrimaryLocale = false,
+}: {
+  locale?: string;
+  pageSetConfig?: PageSetConfig;
+  fallbackIsPrimaryLocale?: boolean;
+}): boolean => {
+  return !!pageSetConfig?.primaryLocale
+    ? locale === pageSetConfig.primaryLocale
+    : fallbackIsPrimaryLocale;
+};
+
+/**
+ * Returns the locale prefix based on pageset locale, isPrimaryLocale, and includeLocalePrefixForPrimaryLocale.
+ * If the locale is not primary, always includes the locale prefix.
+ * If the locale is primary, includes the locale prefix only if includeLocalePrefixForPrimaryLocale is true.
+ */
+export const getLocalePrefix = ({
+  locale,
+  isPrimaryLocale,
+  includeLocalePrefixForPrimaryLocale,
+}: {
+  locale: string;
+  isPrimaryLocale?: boolean;
+  includeLocalePrefixForPrimaryLocale?: boolean;
+}): string => {
+  return !isPrimaryLocale || includeLocalePrefixForPrimaryLocale
+    ? `${locale}/`
+    : "";
+};