{"_id":"@arpadroid/i18n","_rev":"3-7cde910653f699278c655c202ee79f86","name":"@arpadroid/i18n","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@arpadroid/i18n","version":"1.0.0","description":"Internationalization module","exports":"./dist/index.js","type":"module","scripts":{"prepublish":"npm run build","generate-docs":"jsdoc2md src/services/i18n.js > README.md","build":"webpack --mode production","build:run":"npm run build && npm run dev","dev":"webpack serve --mode development","test":"jest","test:coverage":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/arpadroid/i18n.git"},"keywords":["i18n","internationalization","l10n","localization"],"author":{"name":"Andres Vaquero @arpadroid","email":"web.andresvaquero@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/arpadroid/i18n/issues"},"homepage":"https://github.com/arpadroid/i18n#readme","devDependencies":{"@babel/core":"^7.23.9","@babel/plugin-syntax-import-assertions":"^7.23.3","@babel/preset-env":"^7.23.9","babel-jest":"^29.7.0","babel-loader":"^9.1.3","copy-webpack-plugin":"^12.0.2","html-webpack-plugin":"^5.6.0","jest":"^29.7.0","jest-environment-jsdom":"^29.7.0","jest-junit":"^16.0.0","jsdoc-to-markdown":"^8.0.1","jsdom":"^24.0.0","webpack":"^5.90.3","webpack-cli":"^5.1.4","webpack-dev-server":"^5.0.2"},"dependencies":{"@arpadroid/tools":"^0.0.13"},"gitHead":"a0f0a6fc8809d7b6d85bc3f1778768dab25bfb95","_id":"@arpadroid/i18n@1.0.0","_nodeVersion":"20.0.0","_npmVersion":"9.6.5","dist":{"integrity":"sha512-j94TTU4dnepFgcESI7VFP3Sp2X2glrcf+jYgOmfFSXlMm/hPfXZK58wBU5FfzQIoG2v4XDEzm5/h5CB0sD77PQ==","shasum":"966254a37e692498d20bd80fc6a23c54e4dc6987","tarball":"https://registry.npmjs.org/@arpadroid/i18n/-/i18n-1.0.0.tgz","fileCount":20,"unpackedSize":63332,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCGU/qvzM5lPdogh4KUdJDOzk+Wmbm4VITE6uwayny8PAIgbJg8jKs5FR+SPMWOxI8AcrQDlo4yDDp+uXV59kAcYag="}]},"_npmUser":{"name":"arpadroid","email":"web.andresvaquero@gmail.com"},"directories":{},"maintainers":[{"name":"arpadroid","email":"web.andresvaquero@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/i18n_1.0.0_1708863388508_0.16095861892965058"},"_hasShrinkwrap":false},"1.0.1":{"name":"@arpadroid/i18n","version":"1.0.1","description":"Internationalization module","exports":"./dist/index.js","type":"module","scripts":{"prepublish":"npm run build","generate-docs":"jsdoc2md src/services/*.js src/components/*/*.js > README.md","build":"webpack --mode production","build:run":"npm run build && npm run dev","dev":"webpack serve --mode development","test":"jest","test:coverage":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/arpadroid/i18n.git"},"keywords":["i18n","internationalization","l10n","localization"],"author":{"name":"Andres Vaquero @arpadroid","email":"web.andresvaquero@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/arpadroid/i18n/issues"},"homepage":"https://github.com/arpadroid/i18n#readme","devDependencies":{"@babel/core":"^7.23.9","@babel/plugin-syntax-import-assertions":"^7.23.3","@babel/preset-env":"^7.23.9","babel-jest":"^29.7.0","babel-loader":"^9.1.3","copy-webpack-plugin":"^12.0.2","html-webpack-plugin":"^5.6.0","jest":"^29.7.0","jest-environment-jsdom":"^29.7.0","jest-junit":"^16.0.0","jsdoc-to-markdown":"^8.0.1","jsdom":"^24.0.0","webpack":"^5.90.3","webpack-cli":"^5.1.4","webpack-dev-server":"^5.0.2"},"dependencies":{"@arpadroid/tools":"^0.0.13"},"gitHead":"b2ae9f7569f4bd2aecb9a080ced688a9aa18f781","_id":"@arpadroid/i18n@1.0.1","_nodeVersion":"20.0.0","_npmVersion":"9.6.5","dist":{"integrity":"sha512-gRCp18Y4sOIkhBgBogdkBCKKUWuitiQ0LfDTym6NpSIej62J33F3Yg+/MLPq7yjeMqBB+alZYV1IYYvZL91yUA==","shasum":"5d0ed230c80be4daa33b9bef5f64c129b17dca36","tarball":"https://registry.npmjs.org/@arpadroid/i18n/-/i18n-1.0.1.tgz","fileCount":20,"unpackedSize":65439,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDXEpiolIYGwS3fiAMPzwyC8lkB6Re2XKoQhD+S9F5c3AIhAOJ0APy4N/EGKO3euvWN+8CEIVUCvsPx1ANj7JpuRLnv"}]},"_npmUser":{"name":"arpadroid","email":"web.andresvaquero@gmail.com"},"directories":{},"maintainers":[{"name":"arpadroid","email":"web.andresvaquero@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/i18n_1.0.1_1708865223941_0.8433960956013002"},"_hasShrinkwrap":false},"1.0.2":{"name":"@arpadroid/i18n","version":"1.0.2","description":"Internationalization module","exports":"./dist/index.js","module":"./dist/index.js","type":"module","scripts":{"prepublish":"npm run build","generate-docs":"jsdoc2md src/services/*.js src/components/*/*.js > README.md","build":"webpack --mode production","build:run":"npm run build && npm run dev","dev":"webpack serve --mode development","test":"jest","test:coverage":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/arpadroid/i18n.git"},"keywords":["i18n","internationalization","l10n","localization"],"author":{"name":"Andres Vaquero @arpadroid","email":"web.andresvaquero@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/arpadroid/i18n/issues"},"homepage":"https://github.com/arpadroid/i18n#readme","devDependencies":{"@babel/core":"^7.23.9","@babel/plugin-syntax-import-assertions":"^7.23.3","@babel/preset-env":"^7.23.9","babel-jest":"^29.7.0","babel-loader":"^9.1.3","copy-webpack-plugin":"^12.0.2","html-webpack-plugin":"^5.6.0","jest":"^29.7.0","jest-environment-jsdom":"^29.7.0","jest-junit":"^16.0.0","jsdoc-to-markdown":"^8.0.1","jsdom":"^24.0.0","webpack":"^5.90.3","webpack-cli":"^5.1.4","webpack-dev-server":"^5.0.2"},"dependencies":{"@arpadroid/tools":"^0.0.13"},"gitHead":"95dfe8dc9a42ad8b4666c926a369f2b765225140","_id":"@arpadroid/i18n@1.0.2","_nodeVersion":"20.0.0","_npmVersion":"9.6.5","dist":{"integrity":"sha512-FXAvgYTFGWxidQaRwdGFF20YyhUZHVa1nRmHNA6ACOMmROP4Sai1FzFsX/vmy3bKu2aU6W/USs9mxNprjkydRw==","shasum":"e048a39a0900ab3c5f4992fbdb00b01ae2b9fe12","tarball":"https://registry.npmjs.org/@arpadroid/i18n/-/i18n-1.0.2.tgz","fileCount":20,"unpackedSize":65125,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEMq9AOeS8LQCoDQV2ZPhCDGklbj2ZZ3HJ3oJHf2mGK4AiEA/+bOLdKlfmsQ7r5AMd+hk9ku04bKVed/UzfxP2No6xU="}]},"_npmUser":{"name":"arpadroid","email":"web.andresvaquero@gmail.com"},"directories":{},"maintainers":[{"name":"arpadroid","email":"web.andresvaquero@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/i18n_1.0.2_1708894346998_0.606474470105915"},"_hasShrinkwrap":false},"1.0.3":{"name":"@arpadroid/i18n","version":"1.0.3","description":"Internationalization module","exports":"./dist/arpadroid-i18n.js","module":"./dist/arpadroid-i18n.js","type":"module","scripts":{"prepublish":"npm run build","generate-docs":"jsdoc2md src/services/*.js src/components/*/*.js > README.md","build":"webpack --mode production","build:run":"npm run build && npm run dev","dev":"webpack serve --mode development","test":"jest","test:coverage":"jest --coverage"},"repository":{"type":"git","url":"git+https://github.com/arpadroid/i18n.git"},"keywords":["i18n","internationalization","l10n","localization"],"author":{"name":"Andres Vaquero @arpadroid","email":"web.andresvaquero@gmail.com"},"license":"MIT","bugs":{"url":"https://github.com/arpadroid/i18n/issues"},"homepage":"https://github.com/arpadroid/i18n#readme","devDependencies":{"@babel/core":"^7.23.9","@babel/plugin-syntax-import-assertions":"^7.23.3","@babel/preset-env":"^7.23.9","babel-jest":"^29.7.0","babel-loader":"^9.1.3","copy-webpack-plugin":"^12.0.2","html-webpack-plugin":"^5.6.0","jest":"^29.7.0","jest-environment-jsdom":"^29.7.0","jest-junit":"^16.0.0","jsdoc-to-markdown":"^8.0.1","jsdom":"^24.0.0","webpack":"^5.90.3","webpack-cli":"^5.1.4","webpack-dev-server":"^5.0.2"},"dependencies":{"@arpadroid/tools":"^0.0.13"},"gitHead":"b590a01bb94591e431050e73251efd4b8898b0a4","_id":"@arpadroid/i18n@1.0.3","_nodeVersion":"20.0.0","_npmVersion":"9.6.5","dist":{"integrity":"sha512-UQYM3dkxe0xCYhhYo4Hq7lZzbBBtL26sZhhEXvVwFMRMWbjBsnfTIR4XyvXBvU7win3JxfegjNxnFCY6s30www==","shasum":"0de64475a2104410cf9039f6179886132db24ff7","tarball":"https://registry.npmjs.org/@arpadroid/i18n/-/i18n-1.0.3.tgz","fileCount":20,"unpackedSize":65143,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA/2rwqpZnVjZt0RTGCx3l8wgaXZdYXwBUeXPTk+wzToAiEA2hh22RCHLryvyWTe7SmL06WrrSs2G03rttgp3tN6sJU="}]},"_npmUser":{"name":"arpadroid","email":"web.andresvaquero@gmail.com"},"directories":{},"maintainers":[{"name":"arpadroid","email":"web.andresvaquero@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/i18n_1.0.3_1708896003949_0.3344093087499349"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-25T12:16:28.399Z","1.0.0":"2024-02-25T12:16:28.734Z","modified":"2024-02-25T21:20:04.777Z","1.0.1":"2024-02-25T12:47:04.109Z","1.0.2":"2024-02-25T20:52:27.217Z","1.0.3":"2024-02-25T21:20:04.137Z"},"maintainers":[{"name":"arpadroid","email":"web.andresvaquero@gmail.com"}],"description":"Internationalization module","homepage":"https://github.com/arpadroid/i18n#readme","keywords":["i18n","internationalization","l10n","localization"],"repository":{"type":"git","url":"git+https://github.com/arpadroid/i18n.git"},"author":{"name":"Andres Vaquero @arpadroid","email":"web.andresvaquero@gmail.com"},"bugs":{"url":"https://github.com/arpadroid/i18n/issues"},"license":"MIT","readme":"## Classes\n\n
\n
I18n
\n

The I18n service class is responsible for managing the application locale.\nIt is used to fetch, store and switch the language.\nIt should be used as a singleton.

\n
\n
I18nText
\n

Custom element for displaying internationalized text.

\n
\n
\n\n## Functions\n\n
\n
signal - Emits a signal.(signalName, payload)
\n
\n
listen - Listens for a signal.(signalName, callback)
\n
\n
\n\n## Typedefs\n\n
\n
LocaleOptionInterface : object
\n

Locale Option interface for the language selection.

\n
\n
i18nInterface : object
\n

The I18n instance configuration.

\n
\n
\n\n\n\n## I18n\nThe I18n service class is responsible for managing the application locale.\nIt is used to fetch, store and switch the language.\nIt should be used as a singleton.\n\n**Kind**: global class \n\n* [I18n](#I18n)\n * [new I18n(config)](#new_I18n_new)\n * _instance_\n * [._defaultConfig](#I18n+_defaultConfig)\n * [.defaultLocale](#I18n+defaultLocale)\n * [._config](#I18n+_config) : [i18nInterface](#i18nInterface)\n * [.setConfig(config)](#I18n+setConfig)\n * [.initialize()](#I18n+initialize) ⇒ Promise.<unknown>\n * [.getLocaleOptions()](#I18n+getLocaleOptions) ⇒ Record.<string, LocaleOptionInterface>\n * [.getLocale()](#I18n+getLocale) ⇒ string\n * [.getURLocale()](#I18n+getURLocale) ⇒ string\n * [.preprocessLocale(locale)](#I18n+preprocessLocale) ⇒ string\n * [.setLocale(locale)](#I18n+setLocale) ⇒ Promise.<Response>\n * [.fetchLanguage(locale)](#I18n+fetchLanguage) ⇒ Promise.<Response>\n * [.handleFetchPayload(locale, payload)](#I18n+handleFetchPayload)\n * [.changeLocale(locale)](#I18n+changeLocale) ⇒ Promise.<Response>\n * [.setDefaultLocale()](#I18n+setDefaultLocale)\n * [.storeLocale(locale)](#I18n+storeLocale)\n * [.getStoredLocale()](#I18n+getStoredLocale) ⇒ string\n * [.supportsLocale(locale, options)](#I18n+supportsLocale) ⇒ boolean\n * _static_\n * [.getInstance()](#I18n.getInstance) ⇒ [I18n](#I18n)\n * [.get(path, includeCommon)](#I18n.get) ⇒ Record.<string, unknown>\n * [.getPayload(path, payload)](#I18n.getPayload) ⇒ Record.<string, unknown>\n * [.getDefaultPayload(path, payload)](#I18n.getDefaultPayload) ⇒ Record.<string, unknown>\n * [.addCommonPayload(payload, path)](#I18n.addCommonPayload)\n\n\n\n### new I18n(config)\nSet the configuration for the service.\n\n\n| Param | Type |\n| --- | --- |\n| config | [i18nInterface](#i18nInterface) | \n\n\n\n### i18n.\\_defaultConfig\n**Kind**: instance property of [I18n](#I18n) \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| _defaultConfig | [i18nInterface](#i18nInterface) | The default config. |\n\n\n\n### i18n.defaultLocale\n**Kind**: instance property of [I18n](#I18n) \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| defaultLocale | string | The default application locale. |\n\n\n\n### i18n.\\_config : [i18nInterface](#i18nInterface)\n**Kind**: instance property of [I18n](#I18n) \n\n\n### i18n.setConfig(config)\nSet the configuration for the service.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| config | [i18nInterface](#i18nInterface) | \n\n\n\n### i18n.initialize() ⇒ Promise.<unknown>\nInitializes the service.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.getLocaleOptions() ⇒ Record.<string, LocaleOptionInterface>\nReturns the locale options.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.getLocale() ⇒ string\nReturns the locale String.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.getURLocale() ⇒ string\nReturns the locale value in the URL query string.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.preprocessLocale(locale) ⇒ string\nNormalizes a locale string.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n\n\n\n### i18n.setLocale(locale) ⇒ Promise.<Response>\nSets the locale.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n\n\n\n### i18n.fetchLanguage(locale) ⇒ Promise.<Response>\nFetches the language payload from the server.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n\n\n\n### i18n.handleFetchPayload(locale, payload)\nHandles receipt of the language payload from the server.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n| payload | Record.<string, any> | \n\n\n\n### i18n.changeLocale(locale) ⇒ Promise.<Response>\nUser action for changing locale.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | \\* | \n\n\n\n### i18n.setDefaultLocale()\nSets the locale to the defaultLocale.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.storeLocale(locale)\nSaves the language in the local storage.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n\n\n\n### i18n.getStoredLocale() ⇒ string\nReturns the language from local storage.\n\n**Kind**: instance method of [I18n](#I18n) \n\n\n### i18n.supportsLocale(locale, options) ⇒ boolean\nChecks if the given locale is supported by checking against localeOptions.\n\n**Kind**: instance method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| locale | string | \n| options | [Array.<LocaleOptionInterface>](#LocaleOptionInterface) | \n\n\n\n### I18n.getInstance() ⇒ [I18n](#I18n)\nReturns the instance of the I18n service.\n\n**Kind**: static method of [I18n](#I18n) \n\n\n### I18n.get(path, includeCommon) ⇒ Record.<string, unknown>\nGets an entry from the current language payload given a path.\n\n**Kind**: static method of [I18n](#I18n) \n\n| Param | Type | Default |\n| --- | --- | --- |\n| path | string | | \n| includeCommon | boolean | true | \n\n\n\n### I18n.getPayload(path, payload) ⇒ Record.<string, unknown>\nGets the locale payload given a path.\n\n**Kind**: static method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| path | string | \n| payload | Record.<string, unknown> | \n\n\n\n### I18n.getDefaultPayload(path, payload) ⇒ Record.<string, unknown>\nThe default locale payload.\n\n**Kind**: static method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| path | string | \n| payload | Record.<string, unknown> | \n\n\n\n### I18n.addCommonPayload(payload, path)\nAdds the 'common' payload to the requested item payload.\n\n**Kind**: static method of [I18n](#I18n) \n\n| Param | Type |\n| --- | --- |\n| payload | Record.<string, unknown> | \n| path | string | \n\n\n\n## I18nText\nCustom element for displaying internationalized text.\n\n**Kind**: global class \n\n* [I18nText](#I18nText)\n * _instance_\n * [.i18n](#I18nText+i18n) : [I18n](#I18n)\n * [.render()](#I18nText+render)\n * [.getReplacements()](#I18nText+getReplacements) ⇒ Array\n * [.doReplacements(text, replacements)](#I18nText+doReplacements) ⇒ string\n * _static_\n * [.observedAttributes](#I18nText.observedAttributes) ⇒ Array.<string>\n\n\n\n### i18nText.i18n : [I18n](#I18n)\n**Kind**: instance property of [I18nText](#I18nText) \n\n\n### i18nText.render()\nRenders the text.\n\n**Kind**: instance method of [I18nText](#I18nText) \n\n\n### i18nText.getReplacements() ⇒ Array\nRetrieves the replacements from the 'replacements' attribute.\n\n**Kind**: instance method of [I18nText](#I18nText) \n**Returns**: Array - Array of replacement key-value pairs. \n\n\n### i18nText.doReplacements(text, replacements) ⇒ string\nReplaces the placeholders in the text with the given replacements.\n\n**Kind**: instance method of [I18nText](#I18nText) \n**Returns**: string - The text with the replacements. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| text | string | The text to replace the placeholders in. |\n| replacements | Array | Array of replacement key-value pairs. |\n\n\n\n### I18nText.observedAttributes ⇒ Array.<string>\nDefines the observed attributes for the element.\n\n**Kind**: static property of [I18nText](#I18nText) \n**Returns**: Array.<string> - Array of observed attribute names. \n\n\n## signal - Emits a signal.(signalName, payload)\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| signalName | string | |\n| payload | unknown | The payload to send with the signal. |\n\n\n\n## listen - Listens for a signal.(signalName, callback)\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| signalName | string | The signal to listen for. |\n| callback | function | The callback function. |\n\n\n\n## LocaleOptionInterface : object\nLocale Option interface for the language selection.\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| label | string | The label for the language. |\n| value | string | The value for the language. |\n| [flag] | string | The flag for the language. |\n| [icon] | string | The icon for the language. |\n| [country] | string | The country for the language. |\n| [language] | string | The language for the language. |\n| [file] | string | The file for the language. |\n\n\n\n## i18nInterface : object\nThe I18n instance configuration.\n\n**Kind**: global typedef \n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| [payload] | Record.<string, unknown> | The language payload. |\n| [locale] | string | The currently selected language code. |\n| [defaultLocale] | string | The default language code. |\n| [path] | string | The path to the language files. |\n| localeOptions | Record.<string, LocaleOptionInterface> | Default locale list for user selection. |\n| [urlParam] | string | The URL parameter for the language. |\n\n","readmeFilename":"README.md"}