@l10nmonster/helpers-ios 3.0.0-alpha.9 → 3.0.2

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+## @l10nmonster/helpers-ios [3.0.2](https://public-github/l10nmonster/l10nmonster/compare/@l10nmonster/helpers-ios@3.0.1...@l10nmonster/helpers-ios@3.0.2) (2025-12-23)
+
+
+### Bug Fixes
+
+* Improve type definitions and checks ([826b412](https://public-github/l10nmonster/l10nmonster/commit/826b412f0f7e761d404165a243b0c2b26c416ac1))
+
+
+
+
+
+### Dependencies
+
+* **@l10nmonster/core:** upgraded to 3.1.1
+
+## @l10nmonster/helpers-ios [3.0.1](https://public-github/l10nmonster/l10nmonster/compare/@l10nmonster/helpers-ios@3.0.0...@l10nmonster/helpers-ios@3.0.1) (2025-12-20)
+
+
+### Bug Fixes
+
+* Pluralization improvements ([5964250](https://public-github/l10nmonster/l10nmonster/commit/596425092c425cc8d6c312ef58509c4c3c537431))
+* **server:** Fix cart cleanup ([9bbcab9](https://public-github/l10nmonster/l10nmonster/commit/9bbcab93e1fd20aeb09f59c828665159f091f37c))
+
 # Changelog
 
 All notable changes to this project will be documented in this file.

package/index.js

@@ -1,7 +1,14 @@
 import i18nStringsFiles from '@l10nmonster/i18n-strings-files';
 import { regex } from '@l10nmonster/core';
 
-// filter for iOS .strings file (in utf-8)
+/** @typedef {import('@l10nmonster/core').ResourceFilter} ResourceFilter */
+
+export { StringsdictFilter } from './stringsdict.js';
+
+/**
+ * Filter for iOS .strings files (in utf-8).
+ * @implements {ResourceFilter}
+ */
 export class StringsFilter {
     constructor(params) {
         this.emitComments = params?.emitComments || false;
@@ -43,6 +50,8 @@ const iosControlCharsToDecode = {
     r: '\r',
     f: '\f',
 };
+
+/** @type {import('@l10nmonster/core').DecoderFunction} */
 export const escapesDecoder = regex.decoderMaker(
     'iosEscapesDecoder',
     /(?<node>\\(?<escapedChar>['"\\])|\\(?<escapedControl>[tbnrf])|\\U(?<codePoint>[0-9A-Za-z]{4}))/g, // note that in ios the \U is uppercase!
@@ -54,6 +63,7 @@ export const escapesDecoder = regex.decoderMaker(
     )
 );
 
+/** @type {import('@l10nmonster/core').TextEncoderFunction} */
 export const escapesEncoder = regex.encoderMaker(
     'iosEscapesEncoder',
     // eslint-disable-next-line prefer-named-capture-group
@@ -71,6 +81,7 @@ export const escapesEncoder = regex.encoderMaker(
 // and https://pubs.opengroup.org/onlinepubs/009695399/functions/printf.html
 // loosely based on https://stackoverflow.com/questions/45215648/regex-capture-type-specifiers-in-format-string
 // space and quote tags have been omitted to avoid matching unexpected combinations
+/** @type {import('@l10nmonster/core').DecoderFunction} */
 export const phDecoder = regex.decoderMaker(
     'iosPHDecoder',
     /(?<tag>%(?:\d\$)?[0#+-]?[0-9*]*\.?\d*[hl]{0,2}[jztL]?[diuoxXeEfgGaAcpsSn@])/g,

package/package.json

@@ -1,18 +1,20 @@
 {
     "name": "@l10nmonster/helpers-ios",
-    "version": "3.0.0-alpha.9",
+    "version": "3.0.2",
     "description": "Helpers to deal with iOS file formats",
     "type": "module",
     "main": "index.js",
     "scripts": {
-        "test": "node --test"
+        "test": "node --test",
+        "typecheck": "tsc --noEmit"
     },
     "author": "Diego Lagunas",
     "license": "MIT",
     "dependencies": {
-        "@l10nmonster/i18n-strings-files": "^3.0.0"
+        "@l10nmonster/i18n-strings-files": "^3.0.0",
+        "plist": "^3.1.0"
     },
     "peerDependencies": {
-        "@l10nmonster/core": "^3.0.0-alpha.0"
+        "@l10nmonster/core": "3.1.1"
     }
 }

package/stringsdict.js

@@ -0,0 +1,151 @@
+import plist from 'plist';
+
+/** @typedef {import('@l10nmonster/core').ResourceFilter} ResourceFilter */
+
+/**
+ * Filter for iOS .stringsdict files (plist format for pluralization).
+ * @see https://developer.apple.com/documentation/xcode/localizing-strings-that-contain-plurals
+ * @implements {ResourceFilter}
+ */
+export class StringsdictFilter {
+
+    /**
+     * Create a StringsdictFilter.
+     * @param {Object} [params] - Configuration options for the filter.
+     */
+    constructor(params) {
+        this.emitComments = params?.emitComments || false;
+    }
+
+    /**
+     * Parse a stringsdict file and extract translatable segments.
+     * @param {Object} params - Parameters for parsing the resource.
+     * @param {string} params.resource - The XML/plist content of the stringsdict file.
+     * @param {string[]} [params.sourcePluralForms] - Array of plural forms required in source language.
+     * @param {string[]} [params.targetPluralForms] - Array of plural forms required for target languages.
+     * @returns {Promise<Object>} An object containing the extracted segments.
+     */
+    async parseResource({ resource, sourcePluralForms, targetPluralForms }) {
+        const segments = [];
+        const parsedPlist = plist.parse(resource);
+
+        for (const [key, value] of Object.entries(parsedPlist)) {
+            if (typeof value !== 'object' || !value.NSStringLocalizedFormatKey) {
+                continue;
+            }
+
+            const formatKey = value.NSStringLocalizedFormatKey;
+            // Extract variable names from format key (e.g., "%#@items@" -> "items")
+            const variableMatches = formatKey.matchAll(/%#@(\w+)@/g);
+
+            for (const match of variableMatches) {
+                const varName = match[1];
+                const varConfig = value[varName];
+
+                if (!varConfig ||
+                    varConfig.NSStringFormatSpecTypeKey !== 'NSStringPluralRuleType') {
+                    continue;
+                }
+
+                // stringsdict NSStringPluralRuleType explicitly defines plural rules
+                // Expansion can happen as long as 'other' form is present
+                const otherStr = varConfig.other;
+
+                // Add forms in natural plural order (existing or generated from 'other')
+                for (const form of targetPluralForms) {
+                    const str = varConfig[form] ?? otherStr;
+                    if (str !== undefined) {
+                        segments.push({
+                            sid: `${key}/${varName}_${form}`,
+                            pluralForm: form,
+                            str,
+                        });
+                    }
+                }
+            }
+        }
+
+        return { segments };
+    }
+
+    /**
+     * Translate a stringsdict file using the provided translator function.
+     * @param {Object} params - Parameters for translating the resource.
+     * @param {string} params.resource - The XML/plist content of the stringsdict file.
+     * @param {Function} params.translator - A function that translates a string given its ID and source text.
+     * @param {string[]} [params.sourcePluralForms] - Array of plural forms in the source language.
+     * @param {string[]} [params.targetPluralForms] - Array of plural forms required for the target language.
+     * @returns {Promise<string|null>} The translated stringsdict content, or null if no translations were made.
+     */
+    async translateResource({ resource, translator, sourcePluralForms, targetPluralForms }) {
+        const parsedPlist = plist.parse(resource);
+
+        const translatedPlist = {};
+        let translated = 0;
+
+        for (const [key, value] of Object.entries(parsedPlist)) {
+            if (typeof value !== 'object' || !value.NSStringLocalizedFormatKey) {
+                continue;
+            }
+
+            const formatKey = value.NSStringLocalizedFormatKey;
+            const variableMatches = [...formatKey.matchAll(/%#@(\w+)@/g)];
+
+            const translatedEntry = {
+                NSStringLocalizedFormatKey: formatKey,
+            };
+
+            let entryHasTranslations = true;
+
+            for (const match of variableMatches) {
+                const varName = match[1];
+                const varConfig = value[varName];
+
+                if (!varConfig ||
+                    varConfig.NSStringFormatSpecTypeKey !== 'NSStringPluralRuleType') {
+                    continue;
+                }
+
+                const translatedVarConfig = {
+                    NSStringFormatSpecTypeKey: varConfig.NSStringFormatSpecTypeKey,
+                    NSStringFormatValueTypeKey: varConfig.NSStringFormatValueTypeKey || 'd',
+                };
+
+                // stringsdict NSStringPluralRuleType explicitly defines plural rules
+                // Expansion can happen as long as 'other' form is present
+                const otherStr = varConfig.other;
+
+                // Translate each required target form in CLDR order
+                for (const form of targetPluralForms) {
+                    const sourceText = varConfig[form] ?? otherStr;
+                    if (sourceText === undefined) {
+                        // Can't generate this required form - no source and no fallback
+                        entryHasTranslations = false;
+                        break;
+                    }
+                    const translation = await translator(`${key}/${varName}_${form}`, sourceText);
+                    if (translation === undefined) {
+                        entryHasTranslations = false;
+                        break;
+                    }
+                    translatedVarConfig[form] = translation;
+                }
+
+                if (!entryHasTranslations) break;
+
+                translatedEntry[varName] = translatedVarConfig;
+            }
+
+            if (entryHasTranslations && variableMatches.length > 0) {
+                translatedPlist[key] = translatedEntry;
+                translated++;
+            }
+        }
+
+        if (translated === 0) {
+            return null;
+        }
+
+        return plist.build(translatedPlist);
+    }
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../tsconfig.base.json",
+  "include": [
+    "*.js",
+    "**/*.js"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/node_modules",
+    "test/**",
+    "tests/**",
+    "**/*.test.js",
+    "**/*.spec.js",
+    "dist/**",
+    "ui/**",
+    "types/**"
+  ]
+}

package/.releaserc.json

@@ -1,31 +0,0 @@
-{
-  "branches": [
-    "main",
-    {
-      "name": "next",
-      "prerelease": "alpha"
-    },
-    {
-      "name": "beta",
-      "prerelease": "beta"
-    }
-  ],
-  "tagFormat": "@l10nmonster/helpers-ios@${version}",
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    {
-      "path": "@semantic-release/changelog",
-      "changelogFile": "CHANGELOG.md"
-    },
-    {
-      "path": "@semantic-release/npm",
-      "npmPublish": true
-    },
-    {
-      "path": "@semantic-release/git",
-      "assets": ["CHANGELOG.md", "package.json"],
-      "message": "chore(release): @l10nmonster/helpers-ios@${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-    }
-  ]
-}