next-intl 4.5.7 → 4.6.0

package/dist/types/extractor/catalog/SaveScheduler.d.ts

@@ -8,6 +8,7 @@ export default class SaveScheduler<Value> {
     private isSaving;
     private delayMs;
     private pendingResolvers;
+    private nextSaveTask?;
     constructor(delayMs?: number);
     schedule(saveTask: SaveTask<Value>): Promise<Value>;
     private scheduleSave;

package/dist/types/extractor/extractor/MessageExtractor.d.ts

@@ -1,6 +1,6 @@
-import type { ExtractedMessage } from '../types.js';
-type StrictExtractedMessage = ExtractedMessage & {
-    references: NonNullable<ExtractedMessage['references']>;
+import type { ExtractorMessage } from '../types.js';
+type StrictExtractedMessage = ExtractorMessage & {
+    references: NonNullable<ExtractorMessage['references']>;
 };
 export default class MessageExtractor {
     private isDevelopment;
@@ -8,11 +8,11 @@ export default class MessageExtractor {
     private sourceMap;
     private compileCache;
     constructor(opts: {
-        isDevelopment: boolean;
-        projectRoot: string;
+        isDevelopment?: boolean;
+        projectRoot?: string;
         sourceMap?: boolean;
     });
-    processFileContent(absoluteFilePath: string, source: string): Promise<{
+    extract(absoluteFilePath: string, source: string): Promise<{
         messages: Array<StrictExtractedMessage>;
         code: string;
         map?: string;

package/dist/types/extractor/format/ExtractorCodec.d.ts

@@ -0,0 +1,33 @@
+import type { ExtractorMessage, Locale } from '../types.js';
+type ExtractorCodecContext = {
+    locale: Locale;
+};
+export default interface ExtractorCodec {
+    /**
+     * Decode the content of a file into a list of extracted messages. This is used
+     * to load existing messages from disk.
+     */
+    decode(content: string, context: ExtractorCodecContext): Array<ExtractorMessage>;
+    /**
+     * Encode a list of extracted messages into a string that can be written as
+     * file content to the disk.
+     */
+    encode(messages: Array<ExtractorMessage>, context: ExtractorCodecContext & {
+        sourceMessagesById: Map</* ID */ string, ExtractorMessage>;
+    }): string;
+    /**
+     * Turns the content of a file into a JSON string that represents extracted
+     * messages. The returned value will be passed to `JSON.parse`.
+     *
+     * @return E.g. `[{"id":"+YJVTi","message":"Hey!"}]`
+     *
+     * This is used when loading messages into your application, typically via a
+     * dynamic import (e.g. `import(`../messages/${locale}.json`)`).
+     *
+     * If your file content is JSON and should be used as-is, you can set this to
+     * an identity function.
+     */
+    toJSONString(content: string, context: ExtractorCodecContext): string;
+}
+export declare function defineCodec(factory: () => ExtractorCodec): () => ExtractorCodec;
+export {};

package/dist/types/extractor/format/codecs/JSONCodec.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => import("../ExtractorCodec.js").default;
+export default _default;

package/dist/types/extractor/format/codecs/POCodec.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => import("../ExtractorCodec.js").default;
+export default _default;

package/dist/types/extractor/format/codecs/fixtures/JSONCodecStructured.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => import("../../ExtractorCodec.js").default;
+export default _default;

package/dist/types/extractor/format/codecs/fixtures/POCodecSourceMessageKey.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => import("../../ExtractorCodec.js").default;
+export default _default;

package/dist/types/extractor/format/index.d.ts

@@ -0,0 +1,15 @@
+import type ExtractorCodec from './ExtractorCodec.js';
+import type { MessagesFormat } from './types.js';
+declare const formats: {
+    json: {
+        codec: () => Promise<typeof import("./codecs/JSONCodec.js")>;
+        extension: ".json";
+    };
+    po: {
+        codec: () => Promise<typeof import("./codecs/POCodec.js")>;
+        extension: ".po";
+    };
+};
+export default formats;
+export declare function getFormatExtension(format: MessagesFormat): string;
+export declare function resolveCodec(format: MessagesFormat, projectRoot: string): Promise<ExtractorCodec>;

package/dist/types/extractor/format/types.d.ts

@@ -0,0 +1,8 @@
+import type formats from './index.js';
+export type BuiltInMessagesFormat = keyof typeof formats;
+type CustomMessagesFormat = {
+    codec: string;
+    extension: `.${string}`;
+};
+export type MessagesFormat = BuiltInMessagesFormat | CustomMessagesFormat;
+export {};

package/dist/types/extractor/index.d.ts

@@ -1 +1,2 @@
 export { default as unstable_extractMessages } from './extractMessages.js';
+export { defineCodec } from './format/ExtractorCodec.js';

package/dist/types/extractor/source/SourceFileFilter.d.ts

@@ -1,6 +1,6 @@
 export default class SourceFileFilter {
     static readonly EXTENSIONS: string[];
-    private static readonly IGNORED_DIRECTORIES;
+    static readonly IGNORED_DIRECTORIES: string[];
     static isSourceFile(filePath: string): boolean;
     static shouldEnterDirectory(dirPath: string, srcPaths: Array<string>): boolean;
     private static isIgnoredDirectoryExplicitlyIncluded;

package/dist/types/extractor/source/SourceFileScanner.d.ts

@@ -1,4 +1,4 @@
 export default class SourceFileScanner {
     private static walkSourceFiles;
-    static getSourceFiles(srcPaths: Array<string>): Promise<Array<string>>;
+    static getSourceFiles(srcPaths: Array<string>): Promise<Set<string>>;
 }

package/dist/types/extractor/source/SourceFileWatcher.d.ts

@@ -0,0 +1,12 @@
+import { type Event } from '@parcel/watcher';
+type OnChange = (events: Array<Event>) => Promise<void>;
+export default class SourceFileWatcher implements Disposable {
+    private subscriptions;
+    private roots;
+    private onChange;
+    constructor(roots: Array<string>, onChange: OnChange);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    [Symbol.dispose](): void;
+}
+export {};

package/dist/types/extractor/types.d.ts

@@ -1,6 +1,6 @@
-export type MessagesFormat = 'json' | 'po';
+import type { MessagesFormat } from './format/types.js';
 export type Locale = string;
-export type ExtractedMessage = {
+export type ExtractorMessage = {
     id: string;
     message: string;
     description?: string;

package/dist/types/extractor/utils.d.ts

@@ -1,2 +1,5 @@
+import type { ExtractorMessage } from './types.js';
 export declare function setNestedProperty(obj: Record<string, any>, keyPath: string, value: any): void;
+export declare function getSortedMessages(messages: Array<ExtractorMessage>): Array<ExtractorMessage>;
 export declare function localeCompare(a: string, b: string): number;
+export declare function getDefaultProjectRoot(): string;

package/dist/types/plugin/types.d.ts

@@ -1,5 +1,5 @@
 import type { LoaderContext } from 'webpack';
-import type { MessagesFormat } from '../extractor/types.js';
+import type { MessagesFormat } from '../extractor/format/types.js';
 export type PluginConfig = {
     requestConfig?: string;
     experimental?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "4.5.7",
+  "version": "4.6.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "funding": [
@@ -125,11 +125,12 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
+    "@parcel/watcher": "^2.4.1",
     "@swc/core": "^1.15.2",
     "negotiator": "^1.0.0",
-    "next-intl-swc-plugin-extractor": "^4.5.7",
-    "po-parser": "^1.0.2",
-    "use-intl": "^4.5.7"
+    "next-intl-swc-plugin-extractor": "^4.6.0",
+    "po-parser": "^2.0.0",
+    "use-intl": "^4.6.0"
   },
   "peerDependencies": {
     "next": "^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
@@ -141,5 +142,5 @@
       "optional": true
     }
   },
-  "gitHead": "2ccc147b68227b32ea451935718c3eb5e73d6e2f"
+  "gitHead": "70a047daa5cb235fdcadcf6ebf1daed32ad30c85"
 }

package/dist/esm/development/extractor/formatters/Formatter.js

@@ -1,3 +0,0 @@
-class Formatter {}
-
-export { Formatter as default };

package/dist/esm/development/extractor/formatters/JSONFormatter.js

@@ -1,42 +0,0 @@
-import { setNestedProperty } from '../utils.js';
-import Formatter from './Formatter.js';
-import { getSortedMessages } from './utils.js';
-
-class JSONFormatter extends Formatter {
-  static NAMESPACE_SEPARATOR = '.';
-  EXTENSION = '.json';
-  parse(source) {
-    const json = JSON.parse(source);
-    const messages = [];
-    this.traverseMessages(json, (message, id) => {
-      messages.push({
-        id,
-        message
-      });
-    });
-    return messages;
-  }
-  serialize(messages) {
-    const root = {};
-    for (const message of getSortedMessages(messages)) {
-      setNestedProperty(root, message.id, message.message);
-    }
-    return JSON.stringify(root, null, 2);
-  }
-  toJSONString(source) {
-    return source;
-  }
-  traverseMessages(obj, callback, path = '') {
-    for (const key of Object.keys(obj)) {
-      const newPath = path ? path + JSONFormatter.NAMESPACE_SEPARATOR + key : key;
-      const value = obj[key];
-      if (typeof value === 'string') {
-        callback(value, newPath);
-      } else if (typeof value === 'object') {
-        this.traverseMessages(value, callback, newPath);
-      }
-    }
-  }
-}
-
-export { JSONFormatter as default };

package/dist/esm/development/extractor/formatters/POFormatter.js

@@ -1,51 +0,0 @@
-import POParser from 'po-parser';
-import { setNestedProperty } from '../utils.js';
-import Formatter from './Formatter.js';
-import { getSortedMessages } from './utils.js';
-
-class POFormatter extends Formatter {
-  // See also https://www.gnu.org/software/gettext/manual/html_node/Header-Entry.html
-  static 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'
-  };
-  EXTENSION = '.po';
-
-  // Metadata is stored so it can be retained when writing
-  metadataByLocale = (() => new Map())();
-  parse(content, context) {
-    const catalog = POParser.parse(content);
-
-    // Store metadata for this locale
-    if (catalog.meta) {
-      this.metadataByLocale.set(context.locale, catalog.meta);
-    }
-    return catalog.messages || [];
-  }
-  serialize(messages, context) {
-    const meta = {
-      Language: context.locale,
-      ...POFormatter.DEFAULT_METADATA,
-      ...this.metadataByLocale.get(context.locale)
-    };
-    return POParser.serialize({
-      meta,
-      messages: getSortedMessages(messages)
-    });
-  }
-  toJSONString(source, context) {
-    const parsed = this.parse(source, context);
-    const messagesObject = {};
-    for (const message of parsed) {
-      setNestedProperty(messagesObject, message.id, message.message);
-    }
-    return JSON.stringify(messagesObject, null, 2);
-  }
-}
-
-export { POFormatter as default };

package/dist/esm/development/extractor/formatters/index.js

@@ -1,6 +0,0 @@
-const formatters = {
-  json: () => import('./JSONFormatter.js'),
-  po: () => import('./POFormatter.js')
-};
-
-export { formatters as default };

package/dist/esm/development/extractor/formatters/utils.js

@@ -1,15 +0,0 @@
-import { localeCompare } from '../utils.js';
-
-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);
-    }
-  });
-}
-
-export { getSortedMessages };

package/dist/esm/production/extractor/formatters/Formatter.js

@@ -1 +0,0 @@
-class a{}export{a as default};

package/dist/esm/production/extractor/formatters/JSONFormatter.js

@@ -1 +0,0 @@
-import{setNestedProperty as s}from"../utils.js";import e from"./Formatter.js";import{getSortedMessages as t}from"./utils.js";class r extends e{static NAMESPACE_SEPARATOR=".";EXTENSION=".json";parse(s){const e=JSON.parse(s),t=[];return this.traverseMessages(e,((s,e)=>{t.push({id:e,message:s})})),t}serialize(e){const r={};for(const o of t(e))s(r,o.id,o.message);return JSON.stringify(r,null,2)}toJSONString(s){return s}traverseMessages(s,e,t=""){for(const o of Object.keys(s)){const a=t?t+r.NAMESPACE_SEPARATOR+o:o,i=s[o];"string"==typeof i?e(i,a):"object"==typeof i&&this.traverseMessages(i,e,a)}}}export{r as default};

package/dist/esm/production/extractor/formatters/POFormatter.js

@@ -1 +0,0 @@
-import t from"po-parser";import{setNestedProperty as e}from"../utils.js";import a from"./Formatter.js";import{getSortedMessages as s}from"./utils.js";class r extends a{static DEFAULT_METADATA={"Content-Type":"text/plain; charset=utf-8","Content-Transfer-Encoding":"8bit","X-Generator":"next-intl","X-Crowdin-SourceKey":"msgstr"};EXTENSION=".po";metadataByLocale=(()=>new Map)();parse(e,a){const s=t.parse(e);return s.meta&&this.metadataByLocale.set(a.locale,s.meta),s.messages||[]}serialize(e,a){const o={Language:a.locale,...r.DEFAULT_METADATA,...this.metadataByLocale.get(a.locale)};return t.serialize({meta:o,messages:s(e)})}toJSONString(t,a){const s=this.parse(t,a),r={};for(const t of s)e(r,t.id,t.message);return JSON.stringify(r,null,2)}}export{r as default};

package/dist/esm/production/extractor/formatters/index.js

@@ -1 +0,0 @@
-const t={json:()=>import("./JSONFormatter.js"),po:()=>import("./POFormatter.js")};export{t as default};

package/dist/esm/production/extractor/formatters/utils.js

@@ -1 +0,0 @@
-import{localeCompare as e}from"../utils.js";function r(r){return r.toSorted(((r,t)=>{const n=r.references?.[0]?.path??"",o=t.references?.[0]?.path??"";return n===o?e(r.id,t.id):e(n,o)}))}export{r as getSortedMessages};

package/dist/types/extractor/formatters/Formatter.d.ts

@@ -1,10 +0,0 @@
-import type { ExtractedMessage, Locale } from '../types.js';
-export type FormatterContext = {
-    locale: Locale;
-};
-export default abstract class Formatter {
-    abstract readonly EXTENSION: `.${string}`;
-    abstract parse(content: string, context: FormatterContext): Array<ExtractedMessage>;
-    abstract serialize(messages: Array<ExtractedMessage>, context: FormatterContext): string;
-    abstract toJSONString(source: string, context: FormatterContext): string;
-}

package/dist/types/extractor/formatters/JSONFormatter.d.ts

@@ -1,10 +0,0 @@
-import type { ExtractedMessage } from '../types.js';
-import Formatter from './Formatter.js';
-export default class JSONFormatter extends Formatter {
-    static readonly NAMESPACE_SEPARATOR = ".";
-    readonly EXTENSION = ".json";
-    parse(source: string): Array<ExtractedMessage>;
-    serialize(messages: Array<ExtractedMessage>): string;
-    toJSONString(source: string): string;
-    private traverseMessages;
-}

package/dist/types/extractor/formatters/POFormatter.d.ts

@@ -1,10 +0,0 @@
-import type { ExtractedMessage } from '../types.js';
-import Formatter, { type FormatterContext } from './Formatter.js';
-export default class POFormatter extends Formatter {
-    private static readonly DEFAULT_METADATA;
-    readonly EXTENSION = ".po";
-    private metadataByLocale;
-    parse(content: string, context: FormatterContext): Array<ExtractedMessage>;
-    serialize(messages: Array<ExtractedMessage>, context: FormatterContext): string;
-    toJSONString(source: string, context: FormatterContext): string;
-}

package/dist/types/extractor/formatters/index.d.ts

@@ -1,5 +0,0 @@
-declare const formatters: {
-    json: () => Promise<typeof import("./JSONFormatter.js")>;
-    po: () => Promise<typeof import("./POFormatter.js")>;
-};
-export default formatters;

package/dist/types/extractor/formatters/utils.d.ts

@@ -1,2 +0,0 @@
-import type { ExtractedMessage } from '../types.js';
-export declare function getSortedMessages(messages: Array<ExtractedMessage>): Array<ExtractedMessage>;