@intlayer/sync-po-plugin 8.9.4

package/dist/types/loadJSON.d.ts

@@ -0,0 +1,81 @@
+import { Locale } from "@intlayer/types/allLocales";
+import { DictionaryFormat } from "@intlayer/types/dictionary";
+import { FilePathPattern } from "@intlayer/types/filePathPattern";
+import { Plugin } from "@intlayer/types/plugin";
+
+//#region src/loadJSON.d.ts
+type LoadJSONPluginOptions = {
+  /**
+   * The source of the plugin.
+   * Is a function to build the source from the key and locale.
+   *
+   * @example
+   * ```ts
+   * loadJSON({
+   *   source: ({ key }) => `blog/${'**'}/${key}.i18n.json`,
+   * })
+   * ```
+   */
+  source: FilePathPattern;
+  /**
+   * Locale
+   *
+   * If not provided, the plugin will consider the default locale.
+   *
+   * @example
+   * ```ts
+   * loadJSON({
+   *   source: ({ key }) => `blog/${'**'}/${key}.i18n.json`,
+   *   locale: Locales.ENGLISH,
+   * })
+   * ```
+   */
+  locale?: Locale;
+  /**
+   * Because Intlayer transform the JSON files into Dictionary, we need to identify the plugin in the dictionary.
+   * Used to identify the plugin in the dictionary.
+   *
+   * In the case you have multiple plugins, you can use this to identify the plugin in the dictionary.
+   *
+   * @example
+   * ```ts
+   * const config = {
+   *   plugins: [
+   *     loadJSON({
+   *       source: ({ key }) => `./resources/${key}.json`,
+   *       location: 'plugin-i18next',
+   *     }),
+   *     loadJSON({
+   *       source: ({ key }) => `./messages/${key}.json`,
+   *       location: 'plugin-next-intl',
+   *     }),
+   *   ]
+   * }
+   * ```
+   */
+  location?: string;
+  /**
+   * The priority of the dictionaries created by the plugin.
+   *
+   * In the case of conflicts with remote dictionaries, or .content files, the dictionary with the highest priority will override the other dictionaries.
+   *
+   * Default is -1. (.content file priority is 0)
+   *
+   */
+  priority?: number;
+  /**
+   * The format of the dictionary content.
+   *
+   * @example
+   * ```ts
+   * loadJSON({
+   *   format: 'icu',
+   * })
+   * ```
+   */
+  format?: DictionaryFormat;
+};
+declare const loadJSON: (options: LoadJSONPluginOptions) => Plugin;
+//#endregion
+export { loadJSON };
+//# sourceMappingURL=loadJSON.d.ts.map

package/dist/types/loadJSON.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadJSON.d.ts","names":[],"sources":["../../src/loadJSON.ts"],"mappings":";;;;;;KAgJK,qBAAA;;AAlIgD;;;;;;;;;;EA8InD,MAAA,EAAQ,eAAA;EAeC;;;;;;;AAiDX;;;;;;EAjDE,MAAA,GAAS,MAAA;EAqGV;;;;;;;;;;;;;;;;;;;;;;EA7EC,QAAA;;;;;;;;;EAUA,QAAA;;;;;;;;;;;EAYA,MAAA,GAAS,gBAAA;AAAA;AAAA,cAGE,QAAA,GAAY,OAAA,EAAS,qBAAA,KAAwB,MAAA"}

package/dist/types/loadPO.d.ts

@@ -0,0 +1,64 @@
+import { Locale } from "@intlayer/types/allLocales";
+import { FilePathPattern } from "@intlayer/types/filePathPattern";
+import { Plugin } from "@intlayer/types/plugin";
+
+//#region src/loadPO.d.ts
+type LoadPOPluginOptions = {
+  /**
+   * The source of the plugin.
+   * Is a function to build the source from the key and locale.
+   *
+   * @example
+   * ```ts
+   * loadPO({
+   *   source: ({ key }) => `blog/${'**'}/${key}.i18n.po`,
+   * })
+   * ```
+   */
+  source: FilePathPattern;
+  /**
+   * Locale
+   *
+   * If not provided, the plugin will consider the default locale.
+   *
+   * @example
+   * ```ts
+   * loadPO({
+   *   source: ({ key }) => `blog/${'**'}/${key}.i18n.po`,
+   *   locale: Locales.ENGLISH,
+   * })
+   * ```
+   */
+  locale?: Locale;
+  /**
+   * Because Intlayer transforms PO files into Dictionary, we need to identify the plugin in the dictionary.
+   * Used to identify the plugin in the dictionary.
+   *
+   * In the case you have multiple plugins, you can use this to identify the plugin in the dictionary.
+   *
+   * @example
+   * ```ts
+   * const config = {
+   *   plugins: [
+   *     loadPO({
+   *       source: ({ key }) => `./resources/${key}.po`,
+   *       location: 'plugin-i18next-po',
+   *     }),
+   *   ]
+   * }
+   * ```
+   */
+  location?: string;
+  /**
+   * The priority of the dictionaries created by the plugin.
+   *
+   * In the case of conflicts with remote dictionaries, or .content files, the dictionary with the highest priority will override the other dictionaries.
+   *
+   * Default is 0.
+   */
+  priority?: number;
+};
+declare const loadPO: (options: LoadPOPluginOptions) => Plugin;
+//#endregion
+export { loadPO };
+//# sourceMappingURL=loadPO.d.ts.map

package/dist/types/loadPO.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadPO.d.ts","names":[],"sources":["../../src/loadPO.ts"],"mappings":";;;;;KAuIK,mBAAA;;AA7HgD;;;;;;;;;;EAyInD,MAAA,EAAQ,eAAA;EA4CA;AAGV;;;;;;;;;;;;EAhCE,MAAA,GAAS,MAAA;;;;;;;;;;;;;;;;;;;EAoBT,QAAA;;;;;;;;EASA,QAAA;AAAA;AAAA,cAGW,MAAA,GAAU,OAAA,EAAS,mBAAA,KAAsB,MAAA"}

package/dist/types/syncJSON.d.ts

@@ -0,0 +1,67 @@
+import { Locale } from "@intlayer/types/allLocales";
+import { DictionaryFormat, DictionaryLocation } from "@intlayer/types/dictionary";
+import { FilePathPattern } from "@intlayer/types/filePathPattern";
+import { Plugin } from "@intlayer/types/plugin";
+
+//#region src/syncJSON.d.ts
+declare const extractKeyAndLocaleFromPath: (filePath: string, maskPattern: string, locales: Locale[], defaultLocale: Locale) => {
+  key: string;
+  locale: Locale;
+} | null;
+type SyncJSONPluginOptions = {
+  /**
+   * The source of the plugin.
+   * Is a function to build the source from the key and locale.
+   *
+   * ```ts
+   * syncJSON({
+   * source: ({ key, locale }) => `./messages/${locale}/${key}.json`
+   * })
+   * ```
+   */
+  source: FilePathPattern;
+  /**
+   * Because Intlayer transform the JSON files into Dictionary, we need to identify the plugin in the dictionary.
+   * Used to identify the plugin in the dictionary.
+   *
+   * In the case you have multiple plugins, you can use this to identify the plugin in the dictionary.
+   *
+   * ```ts
+   * // Example usage:
+   * const config = {
+   *   plugins: [
+   *     syncJSON({
+   *       source: ({ key, locale }) => `./resources/${locale}/${key}.json`,
+   *       location: 'plugin-i18next',
+   *     }),
+   *     syncJSON({
+   *       source: ({ key, locale }) => `./messages/${locale}/${key}.json`,
+   *       location: 'plugin-next-intl',
+   *     }),
+   *   ]
+   * }
+   * ```
+   */
+  location?: DictionaryLocation | (string & {});
+  /**
+   * The priority of the dictionaries created by the plugin.
+   *
+   * In the case of conflicts with remote dictionaries, or .content files, the dictionary with the highest priority will override the other dictionaries.
+   *
+   * Default is -1. (.content file priority is 0)
+   *
+   */
+  priority?: number;
+  /**
+   * The format of the dictionaries created by the plugin.
+   *
+   * Default: 'intlayer'
+   *
+   * The format of the dictionaries created by the plugin.
+   */
+  format?: DictionaryFormat;
+};
+declare const syncJSON: (options: SyncJSONPluginOptions) => Promise<Plugin>;
+//#endregion
+export { extractKeyAndLocaleFromPath, syncJSON };
+//# sourceMappingURL=syncJSON.d.ts.map

package/dist/types/syncJSON.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncJSON.d.ts","names":[],"sources":["../../src/syncJSON.ts"],"mappings":";;;;;;cA2Ba,2BAAA,GACX,QAAA,UACA,WAAA,UACA,OAAA,EAAS,MAAA,IACT,aAAA,EAAe,MAAA;EACZ,GAAA;EAAa,MAAA,EAAQ,MAAA;AAAA;AAAA,KA0MrB,qBAAA;EA5MM;;;;;;;;;;EAuNT,MAAA,EAAQ,eAAA;EArNL;;;;;AAkDH;;;;;;;;;;;;;;;;;EA2LA,QAAA,GAAW,kBAAA;EAqLZ;;;;;;;;EA3KC,QAAA;EAcC;;;;;;;EALD,MAAA,GAAS,gBAAA;AAAA;AAAA,cAGE,QAAA,GACX,OAAA,EAAS,qBAAA,KACR,OAAA,CAAQ,MAAA"}

package/dist/types/syncPO.d.ts

@@ -0,0 +1,64 @@
+import { Locale } from "@intlayer/types/allLocales";
+import { FilePathPattern } from "@intlayer/types/filePathPattern";
+import { Plugin } from "@intlayer/types/plugin";
+import { DictionaryLocation } from "@intlayer/types/dictionary";
+
+//#region src/syncPO.d.ts
+declare const extractKeyAndLocaleFromPath: (filePath: string, maskPattern: string, locales: Locale[], defaultLocale: Locale) => {
+  key: string;
+  locale: Locale;
+} | null;
+/**
+ * Parse a PO file string into a flat msgid → msgstr record.
+ * Skips the PO header (msgid ""), comment lines, and plural/context keywords.
+ */
+declare const parsePO: (fileContent: string) => Record<string, string>;
+/**
+ * Serialize a flat key → value record to PO file format.
+ * Non-string values are silently skipped.
+ */
+declare const serializePO: (content: Record<string, unknown>, locale?: string) => string;
+type SyncPOPluginOptions = {
+  /**
+   * The source of the plugin.
+   * Is a function to build the source from the key and locale.
+   *
+   * ```ts
+   * syncPO({
+   *   source: ({ key, locale }) => `./messages/${locale}/${key}.po`
+   * })
+   * ```
+   */
+  source: FilePathPattern;
+  /**
+   * Because Intlayer transforms PO files into Dictionary, we need to identify the plugin in the dictionary.
+   * Used to identify the plugin in the dictionary.
+   *
+   * In the case you have multiple plugins, you can use this to identify the plugin in the dictionary.
+   *
+   * ```ts
+   * // Example usage:
+   * const config = {
+   *   plugins: [
+   *     syncPO({
+   *       source: ({ key, locale }) => `./resources/${locale}/${key}.po`,
+   *       location: 'plugin-i18next-po',
+   *     }),
+   *   ]
+   * }
+   * ```
+   */
+  location?: DictionaryLocation | (string & {});
+  /**
+   * The priority of the dictionaries created by the plugin.
+   *
+   * In the case of conflicts with remote dictionaries, or .content files, the dictionary with the highest priority will override the other dictionaries.
+   *
+   * Default is 0.
+   */
+  priority?: number;
+};
+declare const syncPO: (options: SyncPOPluginOptions) => Promise<Plugin>;
+//#endregion
+export { extractKeyAndLocaleFromPath, parsePO, serializePO, syncPO };
+//# sourceMappingURL=syncPO.d.ts.map

package/dist/types/syncPO.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"syncPO.d.ts","names":[],"sources":["../../src/syncPO.ts"],"mappings":";;;;;;cAuBa,2BAAA,GACX,QAAA,UACA,WAAA,UACA,OAAA,EAAS,MAAA,IACT,aAAA,EAAe,MAAA;EACZ,GAAA;EAAa,MAAA,EAAQ,MAAA;AAAA;;;;;cAuEb,OAAA,GAAW,WAAA,aAAsB,MAAA;;;;;cAsEjC,WAAA,GACX,OAAA,EAAS,MAAA,mBACT,MAAA;AAAA,KAoLG,mBAAA;EApUH;;;;;;AAwEF;;;;EAuQE,MAAA,EAAQ,eAAA;EAjMG;;;;;;;;;AA0BX;;;;;;;;;EA2LA,QAAA,GAAW,kBAAA;EASH;AAGV;;;;;;EAHE,QAAA;AAAA;AAAA,cAGW,MAAA,GAAgB,OAAA,EAAS,mBAAA,KAAsB,OAAA,CAAQ,MAAA"}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@intlayer/sync-po-plugin",
+  "version": "8.9.4",
+  "private": false,
+  "description": "A plugin for Intlayer that syncs Portable Object (.po) files to dictionaries.",
+  "keywords": [
+    "intlayer",
+    "po",
+    "gettext",
+    "plugin",
+    "sync"
+  ],
+  "homepage": "https://intlayer.org",
+  "bugs": {
+    "url": "https://github.com/aymericzip/intlayer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aymericzip/intlayer.git"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Aymeric PINEAU",
+    "url": "https://github.com/aymericzip"
+  },
+  "contributors": [
+    {
+      "name": "Aymeric Pineau",
+      "email": "ay.pineau@gmail.com",
+      "url": "https://github.com/aymericzip"
+    }
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/esm/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "./package.json"
+      ]
+    }
+  },
+  "files": [
+    "./dist",
+    "./package.json"
+  ],
+  "scripts": {
+    "build": "tsdown --config tsdown.config.ts",
+    "build:ci": "tsdown --config tsdown.config.ts",
+    "clean": "bun --bun rimraf ./dist .turbo",
+    "dev": "tsdown --config tsdown.config.ts --watch",
+    "format": "bun --bun biome format . --check",
+    "format:fix": "bun --bun biome format --write .",
+    "lint": "bun --bun biome lint .",
+    "lint:fix": "bun --bun biome lint --write .",
+    "process-files": "ts-node src/transpiler/processFilesCLI.ts --dir $npm_config_dir --extension $npm_config_extension --no-node-snapshot",
+    "prepublish": "cp -f ../../README.md ./README.md",
+    "publish": "bun publish || true",
+    "publish:canary": "bun publish --access public --tag canary || true",
+    "publish:latest": "bun publish --access public --tag latest || true",
+    "test": "bun --bun vitest run",
+    "test:watch": "bun --bun vitest",
+    "typecheck": "tsc --noEmit --project tsconfig.types.json"
+  },
+  "dependencies": {
+    "@intlayer/chokidar": "8.9.4",
+    "@intlayer/config": "8.9.4",
+    "@intlayer/core": "8.9.4",
+    "@intlayer/types": "8.9.4",
+    "fast-glob": "3.3.3"
+  },
+  "devDependencies": {
+    "@types/node": "25.6.2",
+    "@utils/ts-config": "1.0.4",
+    "@utils/ts-config-types": "1.0.4",
+    "@utils/tsdown-config": "1.0.4",
+    "rimraf": "6.1.3",
+    "tsdown": "0.22.00",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
+  },
+  "engines": {
+    "node": ">=14.18"
+  },
+  "bug": {
+    "url": "https://github.com/aymericzip/intlayer/issues"
+  }
+}