@tagplus/components 5.0.0 → 5.1.0

package/dist/{tp.umd.min.lang-en-js.js → tp.umd.min.lang-tp-en-js.js}

@@ -1,2 +1,2 @@
-"use strict";(("undefined"!=typeof self?self:this).webpackChunktp=("undefined"!=typeof self?self:this).webpackChunktp||[]).push([[275],{48167:function(e,n,f){f.r(n);var l=f(33088);n.default={...l.default,lingua:"English",tp:{money:{currency:"$"}},locale:{name:"en",prefix:"en-US",number:{decimal:".",thousands:"",prefix:"",suffix:"",precision:2},date:{format:"YYYY-MM-DD"}},common:{placeholder:"placeholder"}}}}]);
-//# sourceMappingURL=tp.umd.min.lang-en-js.js.map
+"use strict";(("undefined"!=typeof self?self:this).webpackChunktp=("undefined"!=typeof self?self:this).webpackChunktp||[]).push([[648],{48167:function(e,n,f){f.r(n);var l=f(33088);n.default={...l.default,lingua:"English",tp:{money:{currency:"$"}},locale:{name:"en",prefix:"en-US",number:{decimal:".",thousands:"",prefix:"",suffix:"",precision:2},date:{format:"YYYY-MM-DD"}},common:{placeholder:"placeholder"}}}}]);
+//# sourceMappingURL=tp.umd.min.lang-tp-en-js.js.map

package/dist/tp.umd.min.lang-tp-en-js.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tp.umd.min.lang-tp-en-js.js","mappings":"oLAEA,cACKA,EAAAA,QACHC,OAAQ,UAERC,GAAI,CACFC,MAAO,CACLC,SAAU,MAIdC,OAAQ,CAENC,KAAM,KAGNC,OAAQ,QAERC,OAAQ,CACNC,QAAS,IACTC,UAAW,GACXH,OAAQ,GACRI,OAAQ,GACRC,UAAW,GAGbC,KAAM,CACJC,OAAQ,eAGZC,OAAQ,CACNC,YAAa,e","sources":["webpack://tp/./src/locale/lang/en.js"],"sourcesContent":["import enLocale from 'element-plus/es/locale/lang/en'\n\nexport default {\n  ...enLocale,\n  lingua: 'English',\n\n  tp: {\n    money: {\n      currency: '$'\n    }\n  },\n\n  locale: {\n    // locale name equals filename reference\n    name: 'en',\n\n    // IANA.ORG convetions according to W3C\n    prefix: 'en-US',\n\n    number: {\n      decimal: '.',\n      thousands: '',\n      prefix: '',\n      suffix: '',\n      precision: 2\n    },\n\n    date: {\n      format: 'YYYY-MM-DD'\n    }\n  },\n  common: {\n    placeholder: 'placeholder'\n  }\n}\n"],"names":["enLocale","lingua","tp","money","currency","locale","name","prefix","number","decimal","thousands","suffix","precision","date","format","common","placeholder"],"sourceRoot":""}

package/package.json

@@ -8,7 +8,7 @@
       "email": "bruno@tagplus.com.br"
     }
   ],
-  "version": "5.0.0",
+  "version": "5.1.0",
   "main": "./dist/tp.common.js",
   "directories": {
     "lib": "src/lib"

package/src/locale/i18n.js

@@ -2,57 +2,73 @@ import { createI18n } from 'vue-i18n'
 import { reactive } from 'vue'
 
 let i18n
-/**
- * Eventos que podem ser observados com watch
- */
-const hooks = reactive({
-  onLanguageChanged: ''
-})
 
 const loadedLanguages = []
 
+let importLangFile = false
+const i18nHelper = {
+  /**
+   * Eventos que podem ser observados com watch
+   */
+  hooks: reactive({
+    onLanguageChanged: ''
+  })
+}
+
 /**
- * Função padrão para importar arquivos de language
+ * Assincronamente importa e mescla arquivos de lang do vue components e do projeto em que essa lib é importada
+ * na lingaguem escolhida
  * caminho padrão src/locale/lang/*.js
- * @param {String} filename
- * @returns {Promise}
+ * @param {String} filename - The name of the language file to import.
+ * @returns {Promise} - A promise that resolves to an object containing merged custom and local language messages.
  */
-let importLangFile = (filename) => {
-  return import(/* webpackChunkName: "lang-[request]" */ `@src/locale/lang/${filename}.js`)
+const importLangFiles = async function (filename) {
+  let langsCustom = {}
+  const langsLocais = await import(/* webpackChunkName: "lang-tp-[request]" */ `@src/locale/lang/${filename}.js`)
+  if (importLangFile && typeof importLangFile === 'function') {
+    langsCustom = await importLangFile(filename)
+  }
+  return { ...langsCustom, ...langsLocais }
 }
 
 /**
- * Executa após trocar a lang, pode ser usado para salvar nos cookies ou session
- * @param {String} locale
+ * Essa função deve ser impementada no i18nHelper para executar ações após trocar a linguagem,
+ * como salvar nos cookies ou session a linguagem atual
+ *
+ * @param {String} locale - The locale string representing the language to be set.
+ * @throws {Error} Throws an error if the onLanguageSet function is not implemented.
+ * @returns {void}
  */
-let onLanguageSet = (locale) => {
-
+i18nHelper.onLanguageSet = function (locale) {
+  throw new Error('Implemente a função onLanguageSet na definição do plugin i18n')
 }
 
 /**
- * Seta a linguagem atual
- * @param {String} locale 'pt-br', 'en'
- * @returns {String} locale
+ * Sets the current language and updates the i18n instance accordingly.
+ * Triggers the onLanguageChanged hook and calls the onLanguageSet function.
+ * @param {String} locale - The locale string representing the language to be set. EX: 'pt-br', 'en'
+ * @returns {String} - The updated locale string.
  */
-export function setI18nLanguage (locale) {
+i18nHelper.setI18nLanguage = function (locale) {
   if (i18n.mode === 'legacy') {
     i18n.global.locale = locale
   } else {
     i18n.global.locale.value = locale
   }
 
-  hooks.onLanguageChanged = locale
+  i18nHelper.hooks.onLanguageChanged = locale
   document.querySelector('html').setAttribute('lang', locale)
-  onLanguageSet(locale)
+  i18nHelper.onLanguageSet(locale)
   return locale
 }
 
 /**
- *
- * @param {String} locale 'pt-br', 'en'
- * @returns {String} locale
+ * Asynchronously loads and sets the current language for the i18n instance.
+ * If the language is already loaded, it returns immediately.
+ * @param {String} locale - The locale string representing the language to be set. EX: 'pt-br', 'en'
+ * @returns {Promise}
  */
-export async function loadLanguageAsync (locale) {
+i18nHelper.loadLanguageAsync = async function (locale) {
   if (i18n.global.locale === locale) {
     return locale
   }
@@ -63,7 +79,7 @@ export async function loadLanguageAsync (locale) {
   }
 
   // load locale messages with dynamic import
-  const messages = await importLangFile(locale)
+  const messages = await importLangFiles(locale)
   // set locale and locale message
   i18n.global.setLocaleMessage(locale, messages.default)
   loadedLanguages.push(locale)
@@ -71,12 +87,16 @@ export async function loadLanguageAsync (locale) {
 }
 
 /**
- * Essa função cria a instância do i18n
- * Exporta isso para poder importar do projeto nuxt sem ter que reimplementar toda a lib
- * @param {Object} options
- * @returns
+ * Asynchronously sets up and initializes the i18n instance with the provided options.
+ * If the i18n instance is already created, it returns the existing instance.
+ *
+ * @param {Object} [options={}] - An optional object containing configuration options for the i18n instance.
+ * @param {String} [options.locale='pt-br'] - The default locale for the i18n instance.
+ * @param {Object} [options.i18nOptions] - Additional options to be passed to the createI18n function.
+ *
+ * @returns {Promise<I18n>} - A promise that resolves to the initialized i18n instance.
  */
-export async function setupI18n (options = {}) {
+async function setupI18n (options = {}) {
   if (!i18n) {
     const locale = options.locale || 'pt-br'
 
@@ -89,26 +109,54 @@ export async function setupI18n (options = {}) {
       ...options
     })
 
-    await loadLanguageAsync(locale)
-    setI18nLanguage(locale)
+    await i18nHelper.loadLanguageAsync(locale)
+    i18nHelper.setI18nLanguage(locale)
   }
   return i18n
 }
 
-export default (options) => {
-  // Sobrescreve a função de importar arquivos
-  if (typeof options.importLangFile === 'function') {
-    importLangFile = options.importLangFile
+/**
+ * A plugin for Vue.js that initializes and configures the i18n instance with customizable options.
+ * It also provides a helper object for managing language settings and loading language files asynchronously.
+ *
+ * @param {Object} options - An object containing configuration options for the plugin.
+ * @param {Object} options.i18nHelper - An object containing custom functions for managing language settings.
+ * @param {Function} [options.i18nHelper.importLangFile] - A function for asynchronously importing custom language files.
+ * @param {Function} [options.i18nHelper.onLanguageSet] - A function to be called after setting the language.
+ * @param {Object} [options.i18nOptions] - Additional options to be passed to the createI18n function.
+ *
+ * @returns {Object} - An object with an install function for Vue.js plugins.
+ */
+export default async (options) => {
+  // Override the importLangFile function if provided in options
+  if (typeof options.i18nHelper.importLangFile === 'function') {
+    i18nHelper.importLangFile = options.i18nHelper.importLangFile
+  }
+
+  // Override the onLanguageSet function if provided in options
+  if (typeof options.i18nHelper.onLanguageSet === 'function') {
+    i18nHelper.onLanguageSet = options.i18nHelper.onLanguageSet
   }
 
-  if (typeof options.onLanguageSet === 'function') {
-    onLanguageSet = options.onLanguageSet
+  let i18nOptions = {}
+  // Use provided i18nOptions if available
+  if (options.i18nOptions && typeof options.i18nOptions === 'object') {
+    i18nOptions = options.i18nOptions
   }
 
+  // Initialize the i18n instance with the provided options
+  i18n = await setupI18n(i18nOptions)
+
   return {
-    setupI18n,
-    loadLanguageAsync,
-    setI18nLanguage,
-    hooks
+    install: (app, opts) => {
+      // Install the original i18n instance
+      i18n.install(app, i18nOptions)
+
+      /**
+       * Override project-specific functions and provide the $i18nHelper
+       * in the Vue.js app's global properties.
+       **/
+      app.config.globalProperties.$i18nHelper = i18nHelper
+    }
   }
 }

package/src/main.js

@@ -1,7 +1,6 @@
 // import 'element-plus/dist/index.css'
 import * as components from '@src/components'
 import Currency from '@src/plugins/currency.js'
-import i18nLib from '@src/locale/i18n.js'
 
 const install = function (app) {
   app.use(Currency)
@@ -18,4 +17,4 @@ if (typeof window !== 'undefined' && window.Vue) {
 }
 
 export default { ...components, install }
-export { i18nLib }
+export * as i18n from '@src/locale/i18n.js'

package/dist/tp.common.lang-en-js.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tp.common.lang-en-js.js","mappings":"sNAEA,cACKA,EAAAA,QACHC,OAAQ,UAERC,GAAI,CACFC,MAAO,CACLC,SAAU,MAIdC,OAAQ,CAENC,KAAM,KAGNC,OAAQ,QAERC,OAAQ,CACNC,QAAS,IACTC,UAAW,GACXH,OAAQ,GACRI,OAAQ,GACRC,UAAW,GAGbC,KAAM,CACJC,OAAQ,eAGZC,OAAQ,CACNC,YAAa,e","sources":["webpack://@tagplus/components/./src/locale/lang/en.js"],"sourcesContent":["import enLocale from 'element-plus/es/locale/lang/en'\n\nexport default {\n  ...enLocale,\n  lingua: 'English',\n\n  tp: {\n    money: {\n      currency: '$'\n    }\n  },\n\n  locale: {\n    // locale name equals filename reference\n    name: 'en',\n\n    // IANA.ORG convetions according to W3C\n    prefix: 'en-US',\n\n    number: {\n      decimal: '.',\n      thousands: '',\n      prefix: '',\n      suffix: '',\n      precision: 2\n    },\n\n    date: {\n      format: 'YYYY-MM-DD'\n    }\n  },\n  common: {\n    placeholder: 'placeholder'\n  }\n}\n"],"names":["enLocale","lingua","tp","money","currency","locale","name","prefix","number","decimal","thousands","suffix","precision","date","format","common","placeholder"],"sourceRoot":""}

package/dist/tp.umd.lang-en-js.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tp.umd.lang-en-js.js","mappings":"oLAEA,cACKA,EAAAA,QACHC,OAAQ,UAERC,GAAI,CACFC,MAAO,CACLC,SAAU,MAIdC,OAAQ,CAENC,KAAM,KAGNC,OAAQ,QAERC,OAAQ,CACNC,QAAS,IACTC,UAAW,GACXH,OAAQ,GACRI,OAAQ,GACRC,UAAW,GAGbC,KAAM,CACJC,OAAQ,eAGZC,OAAQ,CACNC,YAAa,e","sources":["webpack://tp/./src/locale/lang/en.js"],"sourcesContent":["import enLocale from 'element-plus/es/locale/lang/en'\n\nexport default {\n  ...enLocale,\n  lingua: 'English',\n\n  tp: {\n    money: {\n      currency: '$'\n    }\n  },\n\n  locale: {\n    // locale name equals filename reference\n    name: 'en',\n\n    // IANA.ORG convetions according to W3C\n    prefix: 'en-US',\n\n    number: {\n      decimal: '.',\n      thousands: '',\n      prefix: '',\n      suffix: '',\n      precision: 2\n    },\n\n    date: {\n      format: 'YYYY-MM-DD'\n    }\n  },\n  common: {\n    placeholder: 'placeholder'\n  }\n}\n"],"names":["enLocale","lingua","tp","money","currency","locale","name","prefix","number","decimal","thousands","suffix","precision","date","format","common","placeholder"],"sourceRoot":""}

package/dist/tp.umd.min.lang-en-js.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tp.umd.min.lang-en-js.js","mappings":"oLAEA,cACKA,EAAAA,QACHC,OAAQ,UAERC,GAAI,CACFC,MAAO,CACLC,SAAU,MAIdC,OAAQ,CAENC,KAAM,KAGNC,OAAQ,QAERC,OAAQ,CACNC,QAAS,IACTC,UAAW,GACXH,OAAQ,GACRI,OAAQ,GACRC,UAAW,GAGbC,KAAM,CACJC,OAAQ,eAGZC,OAAQ,CACNC,YAAa,e","sources":["webpack://tp/./src/locale/lang/en.js"],"sourcesContent":["import enLocale from 'element-plus/es/locale/lang/en'\n\nexport default {\n  ...enLocale,\n  lingua: 'English',\n\n  tp: {\n    money: {\n      currency: '$'\n    }\n  },\n\n  locale: {\n    // locale name equals filename reference\n    name: 'en',\n\n    // IANA.ORG convetions according to W3C\n    prefix: 'en-US',\n\n    number: {\n      decimal: '.',\n      thousands: '',\n      prefix: '',\n      suffix: '',\n      precision: 2\n    },\n\n    date: {\n      format: 'YYYY-MM-DD'\n    }\n  },\n  common: {\n    placeholder: 'placeholder'\n  }\n}\n"],"names":["enLocale","lingua","tp","money","currency","locale","name","prefix","number","decimal","thousands","suffix","precision","date","format","common","placeholder"],"sourceRoot":""}