next-intl 4.5.7 → 4.6.0

package/dist/cjs/development/ExtractorCodec-DZKNn0Zq.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+// Essentialls lodash/set, but we avoid this dependency
+function setNestedProperty(obj, keyPath, value) {
+  const keys = keyPath.split('.');
+  let current = obj;
+  for (let i = 0; i < keys.length - 1; i++) {
+    const key = keys[i];
+    if (!(key in current) || typeof current[key] !== 'object' || current[key] === null) {
+      current[key] = {};
+    }
+    current = current[key];
+  }
+  current[keys[keys.length - 1]] = value;
+}
+function getSortedMessages(messages) {
+  return messages.toSorted((messageA, messageB) => {
+    const pathA = messageA.references?.[0]?.path ?? '';
+    const pathB = messageB.references?.[0]?.path ?? '';
+    if (pathA === pathB) {
+      return localeCompare(messageA.id, messageB.id);
+    } else {
+      return localeCompare(pathA, pathB);
+    }
+  });
+}
+function localeCompare(a, b) {
+  return a.localeCompare(b, 'en');
+}
+
+function defineCodec(factory) {
+  return factory;
+}
+
+exports.defineCodec = defineCodec;
+exports.getSortedMessages = getSortedMessages;
+exports.setNestedProperty = setNestedProperty;

package/dist/cjs/development/JSONCodec-Dlcx71xz.cjs

@@ -0,0 +1,41 @@
+'use strict';
+
+var ExtractorCodec = require('./ExtractorCodec-DZKNn0Zq.cjs');
+
+var JSONCodec = ExtractorCodec.defineCodec(() => ({
+  decode(source) {
+    const json = JSON.parse(source);
+    const messages = [];
+    traverseMessages(json, (message, id) => {
+      messages.push({
+        id,
+        message
+      });
+    });
+    return messages;
+  },
+  encode(messages) {
+    const root = {};
+    for (const message of ExtractorCodec.getSortedMessages(messages)) {
+      ExtractorCodec.setNestedProperty(root, message.id, message.message);
+    }
+    return JSON.stringify(root, null, 2) + '\n';
+  },
+  toJSONString(source) {
+    return source;
+  }
+}));
+function traverseMessages(obj, callback, path = '') {
+  const NAMESPACE_SEPARATOR = '.';
+  for (const key of Object.keys(obj)) {
+    const newPath = path ? path + NAMESPACE_SEPARATOR + key : key;
+    const value = obj[key];
+    if (typeof value === 'string') {
+      callback(value, newPath);
+    } else if (typeof value === 'object') {
+      traverseMessages(value, callback, newPath);
+    }
+  }
+}
+
+exports.default = JSONCodec;

package/dist/cjs/development/POCodec-BW-UDNcq.cjs

@@ -0,0 +1,94 @@
+'use strict';
+
+var POParser = require('po-parser');
+var ExtractorCodec = require('./ExtractorCodec-DZKNn0Zq.cjs');
+
+var POCodec = ExtractorCodec.defineCodec(() => {
+  // See also https://www.gnu.org/software/gettext/manual/html_node/Header-Entry.html
+  const DEFAULT_METADATA = {
+    // Recommended by spec
+    'Content-Type': 'text/plain; charset=utf-8',
+    'Content-Transfer-Encoding': '8bit',
+    // Otherwise other tools might set this
+    'X-Generator': 'next-intl',
+    // Crowdin defaults to using msgid as source key
+    'X-Crowdin-SourceKey': 'msgstr'
+  };
+
+  // Move all parts before the last dot to msgctxt
+  const NAMESPACE_SEPARATOR = '.';
+
+  // Metadata is stored so it can be retained when writing
+  const metadataByLocale = new Map();
+  return {
+    decode(content, context) {
+      const catalog = POParser.parse(content);
+      if (catalog.meta) {
+        metadataByLocale.set(context.locale, catalog.meta);
+      }
+      const messages = catalog.messages || [];
+      return messages.map(msg => {
+        const {
+          extractedComments,
+          msgctxt,
+          msgid,
+          msgstr,
+          ...rest
+        } = msg;
+        if (extractedComments && extractedComments.length > 1) {
+          throw new Error(`Multiple extracted comments are not supported. Found ${extractedComments.length} comments for msgid "${msgid}".`);
+        }
+        return {
+          ...rest,
+          id: msgctxt ? [msgctxt, msgid].join(NAMESPACE_SEPARATOR) : msgid,
+          message: msgstr,
+          ...(extractedComments && extractedComments.length > 0 && {
+            description: extractedComments[0]
+          })
+        };
+      });
+    },
+    encode(messages, context) {
+      const encodedMessages = ExtractorCodec.getSortedMessages(messages).map(msg => {
+        const {
+          description,
+          id,
+          message,
+          ...rest
+        } = msg;
+        const lastDotIndex = id.lastIndexOf(NAMESPACE_SEPARATOR);
+        const hasNamespace = id.includes(NAMESPACE_SEPARATOR);
+        const msgid = hasNamespace ? id.slice(lastDotIndex + NAMESPACE_SEPARATOR.length) : id;
+        return {
+          msgid,
+          msgstr: message,
+          ...(description && {
+            extractedComments: [description]
+          }),
+          ...(hasNamespace && {
+            msgctxt: id.slice(0, lastDotIndex)
+          }),
+          ...rest
+        };
+      });
+      return POParser.serialize({
+        meta: {
+          Language: context.locale,
+          ...DEFAULT_METADATA,
+          ...metadataByLocale.get(context.locale)
+        },
+        messages: encodedMessages
+      });
+    },
+    toJSONString(source, context) {
+      const parsed = this.decode(source, context);
+      const messagesObject = {};
+      for (const message of parsed) {
+        ExtractorCodec.setNestedProperty(messagesObject, message.id, message.message);
+      }
+      return JSON.stringify(messagesObject);
+    }
+  };
+});
+
+exports.default = POCodec;

package/dist/cjs/development/plugin.cjs

@@ -105,6 +105,27 @@ export default messages;`;
   fs.writeFileSync(declarationPath, createDeclaration(content));
 }
 
+const formats = {
+  json: {
+    codec: () => Promise.resolve().then(function () { return require('./JSONCodec-Dlcx71xz.cjs'); }),
+    extension: '.json'
+  },
+  po: {
+    codec: () => Promise.resolve().then(function () { return require('./POCodec-BW-UDNcq.cjs'); }),
+    extension: '.po'
+  }
+};
+function isBuiltInFormat(format) {
+  return typeof format === 'string' && format in formats;
+}
+function getFormatExtension(format) {
+  if (isBuiltInFormat(format)) {
+    return formats[format].extension;
+  } else {
+    return format.extension;
+  }
+}
+
 class SourceFileFilter {
   static EXTENSIONS = ['ts', 'tsx', 'js', 'jsx'];
 
@@ -198,7 +219,7 @@ function getNextConfig(pluginConfig, nextConfig) {
   const nextIntlConfig = {};
   function getExtractMessagesLoaderConfig() {
     const experimental = pluginConfig.experimental;
-    if (!experimental.srcPath || !experimental.messages) {
+    if (!experimental.srcPath || !pluginConfig.experimental?.messages) {
       throwError('`srcPath` and `messages` are required when using `extractor`.');
     }
     return {
@@ -206,7 +227,7 @@ function getNextConfig(pluginConfig, nextConfig) {
       options: {
         srcPath: experimental.srcPath,
         sourceLocale: experimental.extract.sourceLocale,
-        messages: experimental.messages
+        messages: pluginConfig.experimental.messages
       }
     };
   }
@@ -274,7 +295,8 @@ function getNextConfig(pluginConfig, nextConfig) {
         throwError('Message catalog loading requires Next.js 16 or higher.');
       }
       rules ??= getTurboRules();
-      addTurboRule(rules, `*.${pluginConfig.experimental.messages.format}`, {
+      const extension = getFormatExtension(pluginConfig.experimental.messages.format);
+      addTurboRule(rules, `*${extension}`, {
         loaders: [getCatalogLoaderConfig()],
         condition: {
           path: `${pluginConfig.experimental.messages.path}/**/*`
@@ -338,8 +360,9 @@ function getNextConfig(pluginConfig, nextConfig) {
       if (pluginConfig.experimental?.messages) {
         if (!config.module) config.module = {};
         if (!config.module.rules) config.module.rules = [];
+        const extension = getFormatExtension(pluginConfig.experimental.messages.format);
         config.module.rules.push({
-          test: new RegExp(`\\.${pluginConfig.experimental.messages.format}$`),
+          test: new RegExp(`${extension.replace(/\./g, '\\.')}$`),
           include: path.resolve(config.context, pluginConfig.experimental.messages.path),
           use: [getCatalogLoaderConfig()],
           type: 'javascript/auto'
@@ -364,7 +387,7 @@ function getNextConfig(pluginConfig, nextConfig) {
 
 function initPlugin(pluginConfig, nextConfig) {
   if (nextConfig?.i18n != null) {
-    warn("\n[next-intl] An `i18n` property was found in your Next.js config. This likely causes conflicts and should therefore be removed if you use the App Router.\n\nIf you're in progress of migrating from the Pages Router, you can refer to this example: https://next-intl.dev/examples#app-router-migration\n");
+    warn("An `i18n` property was found in your Next.js config. This likely causes conflicts and should therefore be removed if you use the App Router.\n\nIf you're in progress of migrating from the Pages Router, you can refer to this example: https://next-intl.dev/examples#app-router-migration\n");
   }
   const messagesPathOrPaths = pluginConfig.experimental?.createMessagesDeclaration;
   if (messagesPathOrPaths) {

package/dist/esm/development/extractor/ExtractionCompiler.js

@@ -1,41 +1,38 @@
 import CatalogManager from './catalog/CatalogManager.js';
+import MessageExtractor from './extractor/MessageExtractor.js';
 
 class ExtractionCompiler {
-  isDevelopment = false;
   constructor(config, opts = {}) {
-    this.manager = new CatalogManager(config, opts);
-    this.isDevelopment = opts.isDevelopment ?? false;
-
-    // Kick off the initial scan as early as possible,
-    // while awaiting it in `compile`. This also ensures
-    // we're only scanning once.
-    this.initialScanPromise = this.performInitialScan();
-  }
-  async compile(resourcePath, source) {
-    if (this.initialScanPromise) {
-      await this.initialScanPromise;
-      this.initialScanPromise = undefined;
-    }
-    const result = await this.manager.extractFileMessages(resourcePath, source);
-    if (this.isDevelopment && result.changed) {
-      // While we await the AST modification, we
-      // don't need to await the persistence
-      void this.manager.save();
-    }
-    return result;
+    const extractor = opts.extractor ?? new MessageExtractor(opts);
+    this.manager = new CatalogManager(config, {
+      ...opts,
+      extractor
+    });
+    this[Symbol.dispose] = this[Symbol.dispose].bind(this);
+    this.installExitHandlers();
   }
-  async performInitialScan() {
+  async extractAll() {
     // We can't rely on all files being compiled (e.g. due to persistent
     // caching), so loading the messages initially is necessary.
     await this.manager.loadMessages();
     await this.manager.save();
   }
-  async extract() {
-    await this.initialScanPromise;
-  }
   [Symbol.dispose]() {
+    this.uninstallExitHandlers();
     this.manager.destroy();
   }
+  installExitHandlers() {
+    const cleanup = this[Symbol.dispose];
+    process.on('exit', cleanup);
+    process.on('SIGINT', cleanup);
+    process.on('SIGTERM', cleanup);
+  }
+  uninstallExitHandlers() {
+    const cleanup = this[Symbol.dispose];
+    process.off('exit', cleanup);
+    process.off('SIGINT', cleanup);
+    process.off('SIGTERM', cleanup);
+  }
 }
 
 export { ExtractionCompiler as default };

package/dist/esm/development/extractor/catalog/CatalogLocales.js

@@ -3,7 +3,6 @@ import fs from 'fs/promises';
 import path from 'path';
 
 class CatalogLocales {
-  cleanupHandlers = [];
   onChangeCallbacks = (() => new Set())();
   constructor(params) {
     this.messagesDir = params.messagesDir;
@@ -58,17 +57,12 @@ class CatalogLocales {
         void this.onChange();
       }
     });
-    this.setupCleanupHandlers();
   }
   stopWatcher() {
     if (this.watcher) {
       this.watcher.close();
       this.watcher = undefined;
     }
-    for (const handler of this.cleanupHandlers) {
-      handler();
-    }
-    this.cleanupHandlers = [];
   }
   async onChange() {
     const oldLocales = new Set(this.targetLocales || []);
@@ -85,33 +79,6 @@ class CatalogLocales {
       }
     }
   }
-  setupCleanupHandlers() {
-    const cleanup = () => {
-      if (this.watcher) {
-        this.watcher.close();
-        this.watcher = undefined;
-      }
-    };
-    function exitHandler() {
-      cleanup();
-    }
-    function sigintHandler() {
-      cleanup();
-      process.exit(0);
-    }
-    function sigtermHandler() {
-      cleanup();
-      process.exit(0);
-    }
-    process.once('exit', exitHandler);
-    process.once('SIGINT', sigintHandler);
-    process.once('SIGTERM', sigtermHandler);
-    this.cleanupHandlers.push(() => {
-      process.removeListener('exit', exitHandler);
-      process.removeListener('SIGINT', sigintHandler);
-      process.removeListener('SIGTERM', sigtermHandler);
-    });
-  }
 }
 
 export { CatalogLocales as default };