@intlayer/config 1.0.2 → 1.2.0

package/dist/cjs/types/locales.d.ts

@@ -1,236 +1,469 @@
+/** Can be imported from a shared config */
 declare enum Locales {
+    /** Afrikaans language */
     AFRIKAANS = "af",
+    /** Afrikaans language as used in South Africa */
     AFRIKAANS_SOUTH_AFRICA = "af-ZA",
+    /** Arabic language */
     ARABIC = "ar",
+    /** Arabic language as used in the United Arab Emirates */
     ARABIC_UNITED_ARAB_EMIRATES = "ar-AE",
+    /** Arabic language as used in Bahrain */
     ARABIC_BAHRAIN = "ar-BH",
+    /** Arabic language as used in Algeria */
     ARABIC_ALGERIA = "ar-DZ",
+    /** Arabic language as used in Egypt */
     ARABIC_EGYPT = "ar-EG",
+    /** Arabic language as used in Iraq */
     ARABIC_IRAQ = "ar-IQ",
+    /** Arabic language as used in Jordan */
     ARABIC_JORDAN = "ar-JO",
+    /** Arabic language as used in Kuwait */
     ARABIC_KUWAIT = "ar-KW",
+    /** Arabic language as used in Lebanon */
     ARABIC_LEBANON = "ar-LB",
+    /** Arabic language as used in Libya */
     ARABIC_LIBYA = "ar-LY",
+    /** Arabic language as used in Morocco */
     ARABIC_MOROCCO = "ar-MA",
+    /** Arabic language as used in Oman */
     ARABIC_OMAN = "ar-OM",
+    /** Arabic language as used in Qatar */
     ARABIC_QATAR = "ar-QA",
+    /** Arabic language as used in Saudi Arabia */
     ARABIC_SAUDI_ARABIA = "ar-SA",
+    /** Arabic language as used in Syria */
     ARABIC_SYRIA = "ar-SY",
+    /** Arabic language as used in Tunisia */
     ARABIC_TUNISIA = "ar-TN",
+    /** Arabic language as used in Yemen */
     ARABIC_YEMEN = "ar-YE",
+    /** Azeri language (Latin script) */
     AZERI_LATIN = "az",
+    /** Azeri language (Latin script) as used in Azerbaijan */
     AZERI_LATIN_AZERBAIJAN = "az-AZ",
+    /** Belarusian language */
     BELARUSIAN = "be",
+    /** Belarusian language as used in Belarus */
     BELARUSIAN_BELARUS = "be-BY",
+    /** Bulgarian language */
     BULGARIAN = "bg",
+    /** Bulgarian language as used in Bulgaria */
     BULGARIAN_BULGARIA = "bg-BG",
+    /** Bosnian */
     BOSNIAN = "bs",
+    /** Bosnian language as used in Bosnia and Herzegovina */
     BOSNIAN_BOSNIA_AND_HERZEGOVINA = "bs-BA",
+    /** Catalan language */
     CATALAN = "ca",
+    /** Catalan language as used in Spain */
     CATALAN_SPAIN = "ca-ES",
+    /** Czech language */
     CZECH = "cs",
+    /** Czech language as used in Czech Republic */
     CZECH_CZECH_REPUBLIC = "cs-CZ",
+    /** Welsh language */
     WELSH = "cy",
+    /** Welsh language as used in the United Kingdom */
     WELSH_UNITED_KINGDOM = "cy-GB",
+    /** Danish language */
     DANISH = "da",
+    /** Danish language as used in Denmark */
     DANISH_DENMARK = "da-DK",
+    /** German language */
     GERMAN = "de",
+    /** German language as used in Austria */
     GERMAN_AUSTRIA = "de-AT",
+    /** German language as used in Switzerland */
     GERMAN_SWITZERLAND = "de-CH",
+    /** German language as used in Germany */
     GERMAN_GERMANY = "de-DE",
+    /** German language as used in Liechtenstein */
     GERMAN_LIECHTENSTEIN = "de-LI",
+    /** German language as used in Luxembourg */
     GERMAN_LUXEMBOURG = "de-LU",
+    /** Divehi language */
     DIVEHI = "dv",
+    /** Divehi language as used in Maldives */
     DIVEHI_MALDIVES = "dv-MV",
+    /** Greek language */
     GREEK = "el",
+    /** Greek language as used in Greece */
     GREEK_GREECE = "el-GR",
+    /** English language */
     ENGLISH = "en",
+    /** English language as used in Australia */
     ENGLISH_AUSTRALIA = "en-AU",
+    /** English language as used in Belize */
     ENGLISH_BELIZE = "en-BZ",
+    /** English language as used in Canada */
     ENGLISH_CANADA = "en-CA",
+    /** English language as used in Caribbean */
     ENGLISH_CARIBBEAN = "en-CB",
+    /** English language as used in the United Kingdom */
     ENGLISH_UNITED_KINGDOM = "en-GB",
+    /** English language as used in Ireland */
     ENGLISH_IRELAND = "en-IE",
+    /** English language as used in Jamaica */
     ENGLISH_JAMAICA = "en-JM",
+    /** English language as used in New Zealand */
     ENGLISH_NEW_ZEALAND = "en-NZ",
+    /** English language as used in Philippines */
     ENGLISH_PHILIPPINES = "en-PH",
+    /** English language as used in Trinidad and Tobago */
     ENGLISH_TRINIDAD_AND_TOBAGO = "en-TT",
+    /** English language as used in the United States */
     ENGLISH_UNITED_STATES = "en-US",
+    /** English language as used in South Africa */
     ENGLISH_SOUTH_AFRICA = "en-ZA",
+    /** English language as used in Zimbabwe */
     ENGLISH_ZIMBABWE = "en-ZW",
+    /** Esperanto language */
     ESPERANTO = "eo",
+    /** Spanish language */
     SPANISH = "es",
+    /** Spanish language as used in Argentina */
     SPANISH_ARGENTINA = "es-AR",
+    /** Spanish language as used in Bolivia */
     SPANISH_BOLIVIA = "es-BO",
+    /** Spanish language as used in Chile */
     SPANISH_CHILE = "es-CL",
+    /** Spanish language as used in Colombia */
     SPANISH_COLOMBIA = "es-CO",
+    /** Spanish language as used in Costa Rica */
     SPANISH_COSTA_RICA = "es-CR",
+    /** Spanish language as used in Dominican Republic */
     SPANISH_DOMINICAN_REPUBLIC = "es-DO",
+    /** Spanish language as used in Ecuador */
     SPANISH_ECUADOR = "es-EC",
+    /** Spanish language as used in Spain */
     SPANISH_SPAIN = "es-ES",
+    /** Spanish language as used in Guatemala */
     SPANISH_GUATEMALA = "es-GT",
+    /** Spanish language as used in Honduras */
     SPANISH_HONDURAS = "es-HN",
+    /** Spanish language as used in Mexico */
     SPANISH_MEXICO = "es-MX",
+    /** Spanish language as used in Nicaragua */
     SPANISH_NICARAGUA = "es-NI",
+    /** Spanish language as used in Panama */
     SPANISH_PANAMA = "es-PA",
+    /** Spanish language as used in Peru */
     SPANISH_PERU = "es-PE",
+    /** Spanish language as used in Puerto Rico */
     SPANISH_PUERTO_RICO = "es-PR",
+    /** Spanish language as used in Paraguay */
     SPANISH_PARAGUAY = "es-PY",
+    /** Spanish language as used in El Salvador */
     SPANISH_EL_SALVADOR = "es-SV",
+    /** Spanish language as used in Uruguay */
     SPANISH_URUGUAY = "es-UY",
+    /** Spanish language as used in Venezuela */
     SPANISH_VENEZUELA = "es-VE",
+    /** Estonian language */
     ESTONIAN = "et",
+    /** Estonian language as used in Estonia */
     ESTONIAN_ESTONIA = "et-EE",
+    /** Basque language */
     BASQUE = "eu",
+    /** Basque language as used in Spain */
     BASQUE_SPAIN = "eu-ES",
+    /** Farsi language */
     FARSI = "fa",
+    /** Farsi language as used in Iran */
     FARSI_IRAN = "fa-IR",
+    /** Finnish language */
     FINNISH = "fi",
+    /** Finnish language as used in Finland */
     FINNISH_FINLAND = "fi-FI",
+    /** Faroese language */
     FAROESE = "fo",
+    /** Faroese language as used in Faroe Islands */
     FAROESE_FAROE_ISLANDS = "fo-FO",
+    /** French language */
     FRENCH = "fr",
+    /** French language as used in Belgium */
     FRENCH_BELGIUM = "fr-BE",
+    /** French language as used in Canada */
     FRENCH_CANADA = "fr-CA",
+    /** French language as used in Switzerland */
     FRENCH_SWITZERLAND = "fr-CH",
+    /** French language as used in France */
     FRENCH_FRANCE = "fr-FR",
+    /** French language as used in Luxembourg */
     FRENCH_LUXEMBOURG = "fr-LU",
+    /** French language as used in the Principality of Monaco */
     FRENCH_PRINCIPALITY_OF_MONACO = "fr-MC",
+    /** Galician language */
     GALICIAN = "gl",
+    /** Galician language as used in Spain */
     GALICIAN_SPAIN = "gl-ES",
+    /** Gujarati language */
     GUJARATI = "gu",
+    /** Gujarati language as used in India */
     GUJARATI_INDIA = "gu-IN",
+    /** Hebrew language */
     HEBREW = "he",
+    /** Hebrew language as used in Israel */
     HEBREW_ISRAEL = "he-IL",
+    /** Hindi language */
     HINDI = "hi",
+    /** Hindi language as used in India */
     HINDI_INDIA = "hi-IN",
+    /** Croatian language */
     CROATIAN = "hr",
+    /** Croatian language as used in Bosnia and Herzegovina */
     CROATIAN_BOSNIA_AND_HERZEGOVINA = "hr-BA",
+    /** Croatian language as used in Croatia */
     CROATIAN_CROATIA = "hr-HR",
+    /** Hungarian language */
     HUNGARIAN = "hu",
+    /** Hungarian language as used in Hungary */
     HUNGARIAN_HUNGARY = "hu-HU",
+    /** Armenian language */
     ARMENIAN = "hy",
+    /** Armenian language as used in Armenia */
     ARMENIAN_ARMENIA = "hy-AM",
+    /** Indonesian language */
     INDONESIAN = "id",
+    /** Indonesian language as used in Indonesia */
     INDONESIAN_INDONESIA = "id-ID",
+    /** Icelandic language */
     ICELANDIC = "is",
+    /** Icelandic language as used in Iceland */
     ICELANDIC_ICELAND = "is-IS",
+    /** Italian language */
     ITALIAN = "it",
+    /** Italian language as used in Switzerland */
     ITALIAN_SWITZERLAND = "it-CH",
+    /** Italian language as used in Italy */
     ITALIAN_ITALY = "it-IT",
+    /** Japanese language */
     JAPANESE = "ja",
+    /** Japanese language as used in Japan */
     JAPANESE_JAPAN = "ja-JP",
+    /** Georgian language */
     GEORGIAN = "ka",
+    /** Georgian language as used in Georgia */
     GEORGIAN_GEORGIA = "ka-GE",
+    /** Kazakh language */
     KAZAKH = "kk",
+    /** Kazakh language as used in Kazakhstan */
     KAZAKH_KAZAKHSTAN = "kk-KZ",
+    /** Kannada language */
     KANNADA = "kn",
+    /** Kannada language as used in India */
     KANNADA_INDIA = "kn-IN",
+    /** Korean language */
     KOREAN = "ko",
+    /** Korean language as used in Korea */
     KOREAN_KOREA = "ko-KR",
+    /** Konkani language */
     KONKANI = "kok",
+    /** Konkani language as used in India */
     KONKANI_INDIA = "kok-IN",
+    /** Kyrgyz language */
     KYRGYZ = "ky",
+    /** Kyrgyz language as used in Kyrgyzstan */
     KYRGYZ_KYRGYZSTAN = "ky-KG",
+    /** Lithuanian language */
     LITHUANIAN = "lt",
+    /** Lithuanian language as used in Lithuania */
     LITHUANIAN_LITHUANIA = "lt-LT",
+    /** Latvian language */
     LATVIAN = "lv",
+    /** Latvian language as used in Latvia */
     LATVIAN_LATVIA = "lv-LV",
+    /** Maori language */
     MAORI = "mi",
+    /** Maori language as used in New Zealand */
     MAORI_NEW_ZEALAND = "mi-NZ",
+    /** Macedonian language (Former Yugoslav Republic of Macedonia) */
     FYRO_MACEDONIAN = "mk",
+    /** Macedonian language as used in Macedonia */
     FYRO_MACEDONIAN_MACEDONIA = "mk-MK",
+    /** Mongolian language */
     MONGOLIAN = "mn",
+    /** Mongolian language as used in Mongolia */
     MONGOLIAN_MONGOLIA = "mn-MN",
+    /** Marathi language */
     MARATHI = "mr",
+    /** Marathi language as used in India */
     MARATHI_INDIA = "mr-IN",
+    /** Malay language */
     MALAY = "ms",
+    /** Malay language as used in Brunei Darussalam */
     MALAY_BRUNEI_DARUSSALAM = "ms-BN",
+    /** Malay language as used in Malaysia */
     MALAY_MALAYSIA = "ms-MY",
+    /** Maltese language */
     MALTESE = "mt",
+    /** Maltese language as used in Malta */
     MALTESE_MALTA = "mt-MT",
+    /** Norwegian (Bokmål) language */
     NORWEGIAN_BOKMAL = "nb",
+    /** Norwegian (Bokmål) language as used in Norway */
     NORWEGIAN_BOKMAL_NORWAY = "nb-NO",
+    /** Dutch language */
     DUTCH = "nl",
+    /** Dutch language as used in Belgium */
     DUTCH_BELGIUM = "nl-BE",
+    /** Dutch language as used in the Netherlands */
     DUTCH_NETHERLANDS = "nl-NL",
+    /** Norwegian (Nynorsk) language as used in Norway */
     NORWEGIAN_NYNORSK_NORWAY = "nn-NO",
+    /** Northern Sotho language */
     NORTHERN_SOTHO = "ns",
+    /** Northern Sotho language as used in South Africa */
     NORTHERN_SOTHO_SOUTH_AFRICA = "ns-ZA",
+    /** Punjabi language */
     PUNJABI = "pa",
+    /** Punjabi language as used in India */
     PUNJABI_INDIA = "pa-IN",
+    /** Polish language */
     POLISH = "pl",
+    /** Polish language as used in Poland */
     POLISH_POLAND = "pl-PL",
+    /** Pashto language */
     PASHTO = "ps",
+    /** Pashto language as used in Afghanistan */
     PASHTO_AFGHANISTAN = "ps-AR",
+    /** Portuguese language */
     PORTUGUESE = "pt",
+    /** Portuguese language as used in Brazil */
     PORTUGUESE_BRAZIL = "pt-BR",
+    /** Portuguese language as used in Portugal */
     PORTUGUESE_PORTUGAL = "pt-PT",
+    /** Quechua language */
     QUECHUA = "qu",
+    /** Quechua language as used in Bolivia */
     QUECHUA_BOLIVIA = "qu-BO",
+    /** Quechua language as used in Ecuador */
     QUECHUA_ECUADOR = "qu-EC",
+    /** Quechua language as used in Peru */
     QUECHUA_PERU = "qu-PE",
+    /** Romanian language */
     ROMANIAN = "ro",
+    /** Romanian language as used in Romania */
     ROMANIAN_ROMANIA = "ro-RO",
+    /** Russian language */
     RUSSIAN = "ru",
+    /** Russian language as used in Russia */
     RUSSIAN_RUSSIA = "ru-RU",
+    /** Sanskrit language */
     SANSKRIT = "sa",
+    /** Sanskrit language as used in India */
     SANSKRIT_INDIA = "sa-IN",
+    /** Northern Sami language */
     SAMI_NORTHERN = "se",
+    /** Northern Sami language as used in Finland */
     SAMI_NORTHERN_FINLAND = "se-FI",
+    /** Northern Sami language as used in Norway */
     SAMI_NORTHERN_NORWAY = "se-NO",
+    /** Northern Sami language as used in Sweden */
     SAMI_NORTHERN_SWEDEN = "se-SE",
+    /** Slovak language */
     SLOVAK = "sk",
+    /** Slovak language as used in Slovakia */
     SLOVAK_SLOVAKIA = "sk-SK",
+    /** Slovenian language */
     SLOVENIAN = "sl",
+    /** Slovenian language as used in Slovenia */
     SLOVENIAN_SLOVENIA = "sl-SI",
+    /** Albanian language */
     ALBANIAN = "sq",
+    /** Albanian language as used in Albania */
     ALBANIAN_ALBANIA = "sq-AL",
+    /** Servian language (Latin script) */
     SERBIAN_LATIN = "sr",
+    /** Serbian language (Latin script) as used in Bosnia and Herzegovina */
     SERBIAN_LATIN_BOSNIA_AND_HERZEGOVINA = "sr-BA",
+    /** Serbian language (Latin script) as used in Serbia and Montenegro */
     SERBIAN_LATIN_SERBIA_AND_MONTENEGRO = "sr-SP",
+    /** Swedish language */
     SWEDISH = "sv",
+    /** Swedish language as used in Finland */
     SWEDISH_FINLAND = "sv-FI",
+    /** Swedish language as used in Sweden */
     SWEDISH_SWEDEN = "sv-SE",
+    /** Swahili language */
     SWAHILI = "sw",
+    /** Swahili language as used in Kenya */
     SWAHILI_KENYA = "sw-KE",
+    /** Syriac language */
     SYRIAC = "syr",
+    /** Syriac language as used in Syria */
     SYRIAC_SYRIA = "syr-SY",
+    /** Tamil language */
     TAMIL = "ta",
+    /** Tamil language as used in India */
     TAMIL_INDIA = "ta-IN",
+    /** Telugu language */
     TELUGU = "te",
+    /** Telugu language as used in India */
     TELUGU_INDIA = "te-IN",
+    /** Thai language */
     THAI = "th",
+    /** Thai language as used in Thailand */
     THAI_THAILAND = "th-TH",
+    /** Tagalog language */
     TAGALOG = "tl",
+    /** Tagalog language as used in Philippines */
     TAGALOG_PHILIPPINES = "tl-PH",
+    /** Tswana language */
     TSWANA = "tn",
+    /** Tswana language as used in South Africa */
     TSWANA_SOUTH_AFRICA = "tn-ZA",
+    /** Turkish language */
     TURKISH = "tr",
+    /** Turkish language as used in Turkey */
     TURKISH_TURKEY = "tr-TR",
+    /** Tatar language */
     TATAR = "tt",
+    /** Tatar language as used in Russia */
     TATAR_RUSSIA = "tt-RU",
+    /** Tsonga language */
     TSOGA = "ts",
+    /** Ukrainian language */
     UKRAINIAN = "uk",
+    /** Ukrainian language as used in Ukraine */
     UKRAINIAN_UKRAINE = "uk-UA",
+    /** Urdu language */
     URDU = "ur",
+    /** Urdu language as used in Islamic Republic of Pakistan */
     URDU_ISLAMIC_REPUBLIC_OF_PAKISTAN = "ur-PK",
+    /** Uzbek language (Latin script) */
     UZBEK_LATIN = "uz",
+    /** Uzbek language (Latin script) as used in Uzbekistan */
     UZBEK_LATIN_UZBEKISTAN = "uz-UZ",
+    /** Vietnamese language */
     VIETNAMESE = "vi",
+    /** Vietnamese language as used in Viet Nam */
     VIETNAMESE_VIET_NAM = "vi-VN",
+    /** Xhosa language */
     XHOSA = "xh",
+    /** Xhosa language as used in South Africa */
     XHOSA_SOUTH_AFRICA = "xh-ZA",
+    /** Chinese language */
     CHINESE = "zh",
+    /** Chinese language (Simplified script) */
     CHINESE_SIMPLIFIED = "zh-CN",
+    /** Chinese language as used in Hong Kong */
     CHINESE_HONG_KONG = "zh-HK",
+    /** Chinese language as used in Macau */
     CHINESE_MACAU = "zh-MO",
+    /** Chinese language as used in Singapore */
     CHINESE_SINGAPORE = "zh-SG",
+    /** Chinese language (Traditional script) */
     CHINESE_TRADITIONAL = "zh-TW",
+    /** Zulu language */
     ZULU = "zu",
+    /** Zulu language as used in South Africa */
     ZULU_SOUTH_AFRICA = "zu-ZA"
 }
+/** Utility type to extract the values from an enum */
 type ValueOf<T> = T[keyof T];
+/** Define MyType using the ValueOf utility type on Locales */
 type LocalesValues = ValueOf<typeof Locales>;
 
 export { Locales, type LocalesValues };

package/dist/esm/configFile/buildConfigurationFields.d.mts

@@ -2,6 +2,9 @@ import { CustomIntlayerConfig, IntlayerConfig } from '../types/config.mjs';
 import { GetConfigurationOptions } from './getConfiguration.mjs';
 import '../types/locales.mjs';
 
+/**
+ * Build the configuration fields by merging the default values with the custom configuration
+ */
 declare const buildConfigurationFields: (options: GetConfigurationOptions, customConfiguration?: CustomIntlayerConfig) => IntlayerConfig;
 
 export { buildConfigurationFields };