feat: add urlBlacklist to gatsby-plugin-intl

Author: kleberbaum

gatsby-config.ts

@@ -62,37 +62,33 @@ const config: GatsbyConfig = {
             locale: 'en-US',
             prefix: 'en',
             messages: messagesByLocale['en-US'], // <-- plain object from TS
-            slugs: {},
-            pageBlacklist: ['/cms/', '/cms/pages/', '/cms/media/', '/cms/media/', '/cms/settings/'],
+            slugs: {}
           },
           {
             locale: 'de-AT',
             prefix: 'de',
             messages: messagesByLocale['de-AT'],
-            slugs: {},
-            pageBlacklist: ['/cms/', '/cms/pages/', '/cms/media/', '/cms/media/', '/cms/settings/'],
+            slugs: {}
           },
           {
             locale: 'tr-TR',
             prefix: 'tr',
             messages: messagesByLocale['tr-TR'],
-            slugs: {},
-            pageBlacklist: ['/cms/', '/cms/pages/', '/cms/media/', '/cms/media/', '/cms/settings/'],
+            slugs: {}
           },
           {
             locale: 'ar-EG',
             prefix: 'ar',
             messages: messagesByLocale['ar-EG'],
-            slugs: {},
-            pageBlacklist: ['/cms/', '/cms/pages/', '/cms/media/', '/cms/media/', '/cms/settings/'],
+            slugs: {}
           }
         ],
-        // omit certain path segments (relative directories)
-        pathBlacklist: [
-          '/pages/cms', // /pages/products/gummibears/ becomes /products/gummibears/
-          '/pages/login',
-          '/pages/mailpress',
-        ],
+        // omit certain path and subpaths segments from translation (urls not relative directories)
+        // urlBlacklist: [
+        //   '/cms',
+        //   '/login',
+        //   '/mailpress',
+        // ],
         trailingSlash: 'always'
       }
     }

gatsby-node.ts

@@ -4,6 +4,65 @@ import path from 'path';
 import fs from 'fs';
 import { buildSearchIndex } from './src/utils/search/build-search-index';
 
+/** ----- i18n translation-removal + Jaen recreation config ----- */
+const DEFAULT_LOCALE = 'en-US';
+/** These are the locale URL prefixes you configured in gatsby-plugin-i18n-l10n */
+const LOCALE_PREFIXES = ['en', 'de', 'tr', 'ar'];
+/** Remove *translations* for these URL roots (and all their children) */
+const URL_BLACKLIST = ['/cms/', '/login/', '/mailpress/', '/settings/', '/logout/'];
+
+/** Normalize path to have leading slash, no duplicate slashes */
+const normalizePath = (p: string) => {
+  if (!p) return '/';
+  let s = p.trim();
+  if (!s.startsWith('/')) s = '/' + s;
+  // collapse multiple slashes
+  s = s.replace(/\/{2,}/g, '/');
+  return s;
+};
+
+/** Strip any known locale prefix like /de or /tr from the start of the path */
+const stripLocalePrefix = (p: string) => {
+  const norm = normalizePath(p);
+  // build regex like ^/(en|de|tr|ar)(/|$)
+  const re = new RegExp(`^/(?:${LOCALE_PREFIXES.join('|')})(?=/|$)`, 'i');
+  const stripped = norm.replace(re, '');
+  return stripped || '/';
+};
+
+/** True if path is under any blacklisted URL root (exact or child) */
+const isUnderBlacklistedRoot = (p: string) => {
+  const norm = normalizePath(p);
+  // drop trailing slash for compare
+  const trimmed = norm.replace(/\/+$/, '');
+  return URL_BLACKLIST.some(root => {
+    const r = normalizePath(root).replace(/\/+$/, '');
+    return trimmed === r || trimmed.startsWith(r + '/');
+  });
+};
+
+const detectLocaleFromPath = (p: string): string | undefined => {
+  const norm = normalizePath(p);
+  const seg = norm.split('/')[1]; // first segment after leading slash
+  return LOCALE_PREFIXES.includes(seg) ? seg : undefined;
+};
+
+/** Try to detect locale from page.context or from URL */
+const getPageLocale = (page: any): string | undefined => {
+  const ctx = page?.context ?? {};
+  return (
+    ctx.locale ??
+    ctx.language ??
+    ctx.lang ??
+    ctx?.i18n?.locale ??
+    ctx?.intl?.locale ??
+    ctx?.intl?.language ??
+    detectLocaleFromPath(page.path)
+  );
+};
+
+/** ----------------------------------------------------- */
+
 export const onCreateWebpackConfig: GatsbyNode['onCreateWebpackConfig'] = ({
   actions
 }) => {
@@ -16,6 +75,62 @@ export const onCreateWebpackConfig: GatsbyNode['onCreateWebpackConfig'] = ({
   });
 };
 
+/**
+ * Goal:
+ * - Recreate every *non-blacklisted* page (default + translated) as a Jaen page so metadata is editable per locale.
+ * - For blacklisted URL roots, keep default locale and remove translations.
+ * - Use a per-locale stable Jaen id: `path:<path-without-locale>::<locale>`
+ * - Avoid infinite loops with `__jaenRecreated`.
+ */
+export const onCreatePage: GatsbyNode['onCreatePage'] = async ({ page, actions }) => {
+  const { deletePage, createPage } = actions;
+
+  // Prevent infinite reprocessing
+  if ((page.context as any)?.__jaenRecreated) {
+    return;
+  }
+
+  const locale = getPageLocale(page) || DEFAULT_LOCALE;
+  const isTranslated = locale !== DEFAULT_LOCALE;
+
+  // figure out the effective "base" path without locale prefix
+  const pathNoLocale = stripLocalePrefix(page.path);
+  const matchNoLocale = page.matchPath ? stripLocalePrefix(page.matchPath) : undefined;
+
+  const isBlacklisted =
+    isUnderBlacklistedRoot(pathNoLocale) ||
+    (matchNoLocale && isUnderBlacklistedRoot(matchNoLocale));
+
+  // 1) Blacklisted: keep default, remove translations; don't recreate
+  if (isBlacklisted) {
+    if (isTranslated) {
+      deletePage(page);
+    }
+    return;
+  }
+
+  // 2) Not blacklisted: recreate **every** locale (default + translated) as a Jaen page
+  // Per-locale Jaen id so each locale has its own editable metadata
+  const stableJaenId = `path:${pathNoLocale}::${locale}`;
+
+  // Recreate with augmented context for Jaen
+  deletePage(page);
+  createPage({
+    ...page,
+    context: {
+      ...page.context,
+      __jaenRecreated: true,
+      locale,
+      // Jaen identifiers; keep both keys for compatibility
+      jaenPageId: stableJaenId,
+      jaenId: stableJaenId,
+      // useful helper if you need to map back to base path in components
+      originalPath: pathNoLocale,
+      ...(matchNoLocale ? { matchPathNoLocale: matchNoLocale } : {})
+    }
+  });
+};
+
 export const onPostBuild: GatsbyNode['onPostBuild'] = async ({
   graphql,
   reporter
@@ -82,7 +197,6 @@ export const onPostBuild: GatsbyNode['onPostBuild'] = async ({
     reporter.panicOnBuild(
       `Error while running GraphQL query. ${result.errors}`
     );
-
     return;
   }
 
@@ -121,7 +235,6 @@ async function preparePagesAndBuildSearch(allJaenPage: {
     const originPath = node.buildPath;
 
     let type = node.template;
-
     if (type && path.extname(type)) {
       type = path.basename(type, path.extname(type));
     }