@sankhyalabs/core 0.0.0-feat-dev-KB-97809.0 → 0.0.0-feat-dev-KB-97809.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/.docs/classes/LangUtils.md +65 -13
  2. package/dist/utils/LangUtils.d.ts +45 -6
  3. package/dist/utils/LangUtils.js +48 -6
  4. package/dist/utils/LangUtils.js.map +1 -1
  5. package/package.json +1 -1
  6. package/reports/test-report.xml +561 -545
  7. package/src/utils/LangUtils.ts +49 -6
  8. package/test/util/LangUtils.spec.ts +117 -0
package/.docs/classes/LangUtils.md CHANGED
@@ -22,9 +22,11 @@
22
22
 
23
23
  > `static` **ELanguages**: *typeof* `__class`
24
24
 
25
+ Classe estática contendo os códigos de idioma predefinidos.
26
+
25
27
  #### Source
26
28
 
27
- src/utils/LangUtils.ts:2
29
+ src/utils/LangUtils.ts:9
28
30
 
29
31
  ## Methods
30
32
 
@@ -32,15 +34,21 @@ src/utils/LangUtils.ts:2
32
34
 
33
35
  > `static` **applyLanguageFromCookie**(): `void`
34
36
 
35
- Define o atributo lang no <html> com base no cookie, se existir
37
+ Define o atributo `lang` no elemento `<html>` com base no cookie de idioma, se existir.
36
38
 
37
39
  #### Returns
38
40
 
39
41
  `void`
40
42
 
43
+ #### Example
44
+
45
+ ```ts
46
+ LangUtils.applyLanguageFromCookie(); // Aplica o idioma do cookie ao elemento `<html>`
47
+ ```
48
+
41
49
  #### Source
42
50
 
43
- src/utils/LangUtils.ts:65
51
+ src/utils/LangUtils.ts:108
44
52
 
45
53
  ***
46
54
 
@@ -48,17 +56,30 @@ src/utils/LangUtils.ts:65
48
56
 
49
57
  > `static` `private` **convertLanguage**(`lang`): `string`
50
58
 
59
+ Converte o idioma fornecido para um dos códigos predefinidos.
60
+
51
61
  #### Parameters
52
62
 
53
63
  • **lang**: `string`
54
64
 
65
+ O idioma a ser convertido (ex.: "en", "es", "pt-BR").
66
+
55
67
  #### Returns
56
68
 
57
69
  `string`
58
70
 
71
+ O código de idioma correspondente (ex.: "en_US", "es_ES").
72
+
73
+ #### Example
74
+
75
+ ```ts
76
+ LangUtils.convertLanguage("en"); // Retorna "en_US"
77
+ LangUtils.convertLanguage("es-es"); // Retorna "es_ES"
78
+ ```
79
+
59
80
  #### Source
60
81
 
61
- src/utils/LangUtils.ts:8
82
+ src/utils/LangUtils.ts:25
62
83
 
63
84
  ***
64
85
 
@@ -66,15 +87,23 @@ src/utils/LangUtils.ts:8
66
87
 
67
88
  > `static` **getHtmlLanguage**(): `string`
68
89
 
69
- Captura o valor do atributo lang do elemento <html>
90
+ Recupera o valor do atributo `lang` do elemento `<html>`.
70
91
 
71
92
  #### Returns
72
93
 
73
94
  `string`
74
95
 
96
+ O idioma definido no elemento `<html>` ou o padrão.
97
+
98
+ #### Example
99
+
100
+ ```ts
101
+ LangUtils.getHtmlLanguage(); // Retorna "pt_BR" no modo desenvolvimento
102
+ ```
103
+
75
104
  #### Source
76
105
 
77
- src/utils/LangUtils.ts:39
106
+ src/utils/LangUtils.ts:66
78
107
 
79
108
  ***
80
109
 
@@ -82,15 +111,23 @@ src/utils/LangUtils.ts:39
82
111
 
83
112
  > `static` **getLanguage**(): `string`
84
113
 
85
- Captura a lingua definida.
114
+ Captura o idioma atualmente definido.
86
115
 
87
116
  #### Returns
88
117
 
89
118
  `string`
90
119
 
120
+ O idioma definido (ex.: "pt_BR", "en_US").
121
+
122
+ #### Example
123
+
124
+ ```ts
125
+ LangUtils.getLanguage(); // Retorna o idioma atual
126
+ ```
127
+
91
128
  #### Source
92
129
 
93
- src/utils/LangUtils.ts:26
130
+ src/utils/LangUtils.ts:48
94
131
 
95
132
  ***
96
133
 
@@ -98,15 +135,23 @@ src/utils/LangUtils.ts:26
98
135
 
99
136
  > `static` **getLanguageFromCookie**(): `null` \| `string`
100
137
 
101
- Recupera o valor do cookie de linguagem
138
+ Recupera o valor do cookie de idioma.
102
139
 
103
140
  #### Returns
104
141
 
105
142
  `null` \| `string`
106
143
 
144
+ O valor do cookie de idioma ou `null` se não existir.
145
+
146
+ #### Example
147
+
148
+ ```ts
149
+ LangUtils.getLanguageFromCookie(); // Retorna "pt_BR" se o cookie existir
150
+ ```
151
+
107
152
  #### Source
108
153
 
109
- src/utils/LangUtils.ts:57
154
+ src/utils/LangUtils.ts:97
110
155
 
111
156
  ***
112
157
 
@@ -114,17 +159,24 @@ src/utils/LangUtils.ts:57
114
159
 
115
160
  > `static` **setHtmlLanguage**(`language`): `void`
116
161
 
117
- Altera o valor do atributo lang no elemento <html>
118
- e atualiza o cookie de linguagem
162
+ Define o atributo `lang` no elemento `<html>` e atualiza o cookie de idioma.
119
163
 
120
164
  #### Parameters
121
165
 
122
166
  • **language**: `string`
123
167
 
168
+ O idioma a ser definido (ex.: "pt_BR", "en_US").
169
+
124
170
  #### Returns
125
171
 
126
172
  `void`
127
173
 
174
+ #### Example
175
+
176
+ ```ts
177
+ LangUtils.setHtmlLanguage("en_US"); // Define o idioma como "en_US"
178
+ ```
179
+
128
180
  #### Source
129
181
 
130
- src/utils/LangUtils.ts:49
182
+ src/utils/LangUtils.ts:84
package/dist/utils/LangUtils.d.ts CHANGED
@@ -1,30 +1,69 @@
1
1
  export declare class LangUtils {
2
+ /**
3
+ * Classe estática contendo os códigos de idioma predefinidos.
4
+ *
5
+ * @property PT_BR - Português (Brasil)
6
+ * @property EN_US - Inglês (Estados Unidos)
7
+ * @property ES_ES - Espanhol (Espanha)
8
+ */
2
9
  static ELanguages: {
3
10
  new (): {};
4
11
  PT_BR: string;
5
12
  EN_US: string;
6
13
  ES_ES: string;
7
14
  };
15
+ /**
16
+ * Converte o idioma fornecido para um dos códigos predefinidos.
17
+ *
18
+ * @param lang - O idioma a ser convertido (ex.: "en", "es", "pt-BR").
19
+ * @returns O código de idioma correspondente (ex.: "en_US", "es_ES").
20
+ *
21
+ * @example
22
+ * LangUtils.convertLanguage("en"); // Retorna "en_US"
23
+ * LangUtils.convertLanguage("es-es"); // Retorna "es_ES"
24
+ */
8
25
  private static convertLanguage;
9
26
  /**
10
- * Captura a lingua definida.
27
+ * Captura o idioma atualmente definido.
28
+ *
29
+ * @returns O idioma definido (ex.: "pt_BR", "en_US").
30
+ *
31
+ * @example
32
+ * LangUtils.getLanguage(); // Retorna o idioma atual
11
33
  */
12
34
  static getLanguage(): string;
13
35
  /**
14
- * Captura o valor do atributo lang do elemento <html>
36
+ * Recupera o valor do atributo `lang` do elemento `<html>`.
37
+ *
38
+ * @returns O idioma definido no elemento `<html>` ou o padrão.
39
+ *
40
+ * @example
41
+ * LangUtils.getHtmlLanguage(); // Retorna "pt_BR" no modo desenvolvimento
15
42
  */
16
43
  static getHtmlLanguage(): string;
17
44
  /**
18
- * Altera o valor do atributo lang no elemento <html>
19
- * e atualiza o cookie de linguagem
45
+ * Define o atributo `lang` no elemento `<html>` e atualiza o cookie de idioma.
46
+ *
47
+ * @param language - O idioma a ser definido (ex.: "pt_BR", "en_US").
48
+ *
49
+ * @example
50
+ * LangUtils.setHtmlLanguage("en_US"); // Define o idioma como "en_US"
20
51
  */
21
52
  static setHtmlLanguage(language: string): void;
22
53
  /**
23
- * Recupera o valor do cookie de linguagem
54
+ * Recupera o valor do cookie de idioma.
55
+ *
56
+ * @returns O valor do cookie de idioma ou `null` se não existir.
57
+ *
58
+ * @example
59
+ * LangUtils.getLanguageFromCookie(); // Retorna "pt_BR" se o cookie existir
24
60
  */
25
61
  static getLanguageFromCookie(): string | null;
26
62
  /**
27
- * Define o atributo lang no <html> com base no cookie, se existir
63
+ * Define o atributo `lang` no elemento `<html>` com base no cookie de idioma, se existir.
64
+ *
65
+ * @example
66
+ * LangUtils.applyLanguageFromCookie(); // Aplica o idioma do cookie ao elemento `<html>`
28
67
  */
29
68
  static applyLanguageFromCookie(): void;
30
69
  }
package/dist/utils/LangUtils.js CHANGED
@@ -1,5 +1,15 @@
1
1
  var _a;
2
2
  export class LangUtils {
3
+ /**
4
+ * Converte o idioma fornecido para um dos códigos predefinidos.
5
+ *
6
+ * @param lang - O idioma a ser convertido (ex.: "en", "es", "pt-BR").
7
+ * @returns O código de idioma correspondente (ex.: "en_US", "es_ES").
8
+ *
9
+ * @example
10
+ * LangUtils.convertLanguage("en"); // Retorna "en_US"
11
+ * LangUtils.convertLanguage("es-es"); // Retorna "es_ES"
12
+ */
3
13
  static convertLanguage(lang) {
4
14
  switch (lang.toLocaleLowerCase()) {
5
15
  case "en":
@@ -15,7 +25,12 @@ export class LangUtils {
15
25
  }
16
26
  }
17
27
  /**
18
- * Captura a lingua definida.
28
+ * Captura o idioma atualmente definido.
29
+ *
30
+ * @returns O idioma definido (ex.: "pt_BR", "en_US").
31
+ *
32
+ * @example
33
+ * LangUtils.getLanguage(); // Retorna o idioma atual
19
34
  */
20
35
  static getLanguage() {
21
36
  const cookieLanguage = this.getLanguageFromCookie();
@@ -25,29 +40,49 @@ export class LangUtils {
25
40
  return this.getHtmlLanguage();
26
41
  }
27
42
  /**
28
- * Captura o valor do atributo lang do elemento <html>
43
+ * Recupera o valor do atributo `lang` do elemento `<html>`.
44
+ *
45
+ * @returns O idioma definido no elemento `<html>` ou o padrão.
46
+ *
47
+ * @example
48
+ * LangUtils.getHtmlLanguage(); // Retorna "pt_BR" no modo desenvolvimento
29
49
  */
30
50
  static getHtmlLanguage() {
51
+ if (process.env.NODE_ENV === 'development') {
52
+ return LangUtils.ELanguages.PT_BR;
53
+ }
31
54
  const lang = document.documentElement.lang || navigator.language || "pt-BR";
32
55
  return this.convertLanguage(lang);
33
56
  }
34
57
  /**
35
- * Altera o valor do atributo lang no elemento <html>
36
- * e atualiza o cookie de linguagem
58
+ * Define o atributo `lang` no elemento `<html>` e atualiza o cookie de idioma.
59
+ *
60
+ * @param language - O idioma a ser definido (ex.: "pt_BR", "en_US").
61
+ *
62
+ * @example
63
+ * LangUtils.setHtmlLanguage("en_US"); // Define o idioma como "en_US"
37
64
  */
38
65
  static setHtmlLanguage(language) {
39
66
  document.documentElement.lang = language;
40
67
  document.cookie = `lang=${language}; path=/;`;
41
68
  }
42
69
  /**
43
- * Recupera o valor do cookie de linguagem
70
+ * Recupera o valor do cookie de idioma.
71
+ *
72
+ * @returns O valor do cookie de idioma ou `null` se não existir.
73
+ *
74
+ * @example
75
+ * LangUtils.getLanguageFromCookie(); // Retorna "pt_BR" se o cookie existir
44
76
  */
45
77
  static getLanguageFromCookie() {
46
78
  const match = document.cookie.match(new RegExp('(^| )lang=([^;]+)'));
47
79
  return match ? match[2] : null;
48
80
  }
49
81
  /**
50
- * Define o atributo lang no <html> com base no cookie, se existir
82
+ * Define o atributo `lang` no elemento `<html>` com base no cookie de idioma, se existir.
83
+ *
84
+ * @example
85
+ * LangUtils.applyLanguageFromCookie(); // Aplica o idioma do cookie ao elemento `<html>`
51
86
  */
52
87
  static applyLanguageFromCookie() {
53
88
  const langFromCookie = this.getLanguageFromCookie();
@@ -56,6 +91,13 @@ export class LangUtils {
56
91
  }
57
92
  }
58
93
  }
94
+ /**
95
+ * Classe estática contendo os códigos de idioma predefinidos.
96
+ *
97
+ * @property PT_BR - Português (Brasil)
98
+ * @property EN_US - Inglês (Estados Unidos)
99
+ * @property ES_ES - Espanhol (Espanha)
100
+ */
59
101
  LangUtils.ELanguages = (_a = class {
60
102
  },
61
103
  _a.PT_BR = "pt_BR",
package/dist/utils/LangUtils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"LangUtils.js","sourceRoot":"","sources":["../../src/utils/LangUtils.ts"],"names":[],"mappings":";AAAA,MAAM,OAAO,SAAS;IAOV,MAAM,CAAC,eAAe,CAAC,IAAY;QACvC,QAAQ,IAAI,CAAC,iBAAiB,EAAE,EAAE;YAC9B,KAAK,IAAI,CAAC;YACV,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACR,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;YACtC,KAAK,IAAI,CAAC;YACV,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACR,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;YACtC;gBACI,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;SACzC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,WAAW;QACrB,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAEpD,IAAI,cAAc,EAAE;YAChB,OAAO,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;SAC/C;QAED,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAe;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC,IAAI,IAAI,SAAS,CAAC,QAAQ,IAAI,OAAO,CAAC;QAE5E,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,eAAe,CAAC,QAAgB;QAC1C,QAAQ,CAAC,eAAe,CAAC,IAAI,GAAG,QAAQ,CAAC;QACzC,QAAQ,CAAC,MAAM,GAAG,QAAQ,QAAQ,WAAW,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,qBAAqB;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACrE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,uBAAuB;QACjC,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACpD,IAAI,cAAc,EAAE;YAChB,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;SACxC;IACL,CAAC;;AApEa,oBAAU,SAAG;KAI1B;IAHU,QAAK,GAAG,OAAQ;IAChB,QAAK,GAAG,OAAQ;IAChB,QAAK,GAAG,OAAQ;QACzB"}
1
+ {"version":3,"file":"LangUtils.js","sourceRoot":"","sources":["../../src/utils/LangUtils.ts"],"names":[],"mappings":";AAAA,MAAM,OAAO,SAAS;IAclB;;;;;;;;;OASG;IACK,MAAM,CAAC,eAAe,CAAC,IAAY;QACvC,QAAQ,IAAI,CAAC,iBAAiB,EAAE,EAAE;YAC9B,KAAK,IAAI,CAAC;YACV,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACR,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;YACtC,KAAK,IAAI,CAAC;YACV,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACR,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;YACtC;gBACI,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;SACzC;IACL,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,WAAW;QACrB,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAEpD,IAAI,cAAc,EAAE;YAChB,OAAO,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;SAC/C;QAED,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe;QACzB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE;YACxC,OAAO,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC;SACrC;QAED,MAAM,IAAI,GAAG,QAAQ,CAAC,eAAe,CAAC,IAAI,IAAI,SAAS,CAAC,QAAQ,IAAI,OAAO,CAAC;QAE5E,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CAAC,QAAgB;QAC1C,QAAQ,CAAC,eAAe,CAAC,IAAI,GAAG,QAAQ,CAAC;QACzC,QAAQ,CAAC,MAAM,GAAG,QAAQ,QAAQ,WAAW,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB;QAC/B,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC;QACrE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,uBAAuB;QACjC,MAAM,cAAc,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACpD,IAAI,cAAc,EAAE;YAChB,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;SACxC;IACL,CAAC;;AA/GD;;;;;;GAMG;AACW,oBAAU,SAAG;KAI1B;IAHU,QAAK,GAAG,OAAQ;IAChB,QAAK,GAAG,OAAQ;IAChB,QAAK,GAAG,OAAQ;QACzB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core",
3
- "version": "0.0.0-feat-dev-KB-97809.0",
3
+ "version": "0.0.0-feat-dev-KB-97809.2",
4
4
  "description": "Modulo core JavaScript da Sankhya.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",