@intlayer/docs 5.5.8

package/pt/packages/intlayer/getMultilingualUrls.md

@@ -0,0 +1,198 @@
+# Documentação: Função `getMultilingualUrls` em `intlayer`
+
+## Descrição
+
+A função `getMultilingualUrls` gera um mapeamento de URLs multilíngues prefixando a URL fornecida com cada localidade suportada. Ela pode lidar com URLs absolutas e relativas, aplicando o prefixo de localidade apropriado com base na configuração fornecida ou nos padrões.
+
+---
+
+## Parâmetros
+
+- `url: string`
+
+  - **Descrição**: A URL original a ser prefixada com localidades.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+
+  - **Descrição**: Array opcional de localidades suportadas. Padrão para as localidades configuradas no projeto.
+  - **Tipo**: `Locales[]`
+  - **Padrão**: `localesDefault`
+
+- `defaultLocale: Locales`
+
+  - **Descrição**: A localidade padrão para a aplicação. Padrão para a localidade padrão configurada no projeto.
+  - **Tipo**: `Locales`
+  - **Padrão**: `defaultLocaleDefault`
+
+- `prefixDefault: boolean`
+  - **Descrição**: Indica se deve prefixar a localidade padrão. Padrão para o valor configurado no projeto.
+  - **Tipo**: `boolean`
+  - **Padrão**: `prefixDefaultDefault`
+
+### Retornos
+
+- **Tipo**: `IConfigLocales<string>`
+- **Descrição**: Um objeto mapeando cada localidade para sua correspondente URL multilíngue.
+
+---
+
+## Exemplo de Uso
+
+### URLs Relativas
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Saída: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Saída: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Saída: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### URLs Absolutas
+
+```typescript
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  true
+);
+// Saída: {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard"
+// }
+```
+
+---
+
+## Casos de Borda
+
+- **Sem Segmento de Localidade:**
+
+  - A função remove qualquer segmento de localidade existente na URL antes de gerar os mapeamentos multilíngues.
+
+- **Localidade Padrão:**
+
+  - Quando `prefixDefault` é `false`, a função não prefixa a URL para a localidade padrão.
+
+- **Localidades Não Suportadas:**
+  - Apenas as localidades fornecidas no array `locales` são consideradas para gerar as URLs.
+
+---
+
+## Uso em Aplicações
+
+Em uma aplicação multilíngue, configurar as definições de internacionalização com `locales` e `defaultLocale` é fundamental para garantir que o idioma correto seja exibido. Abaixo está um exemplo de como a função `getMultilingualUrls` pode ser usada na configuração de uma aplicação:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Configuração para localidades suportadas e localidade padrão
+export default {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+```javascript codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+A configuração acima garante que a aplicação reconheça `ENGLISH`, `FRENCH` e `SPANISH` como idiomas suportados e use `ENGLISH` como idioma de fallback.
+
+Usando essa configuração, a função `getMultilingualUrls` pode gerar dinamicamente mapeamentos de URLs multilíngues com base nas localidades suportadas pela aplicação:
+
+```typescript
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH
+);
+// Saída:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH,
+  true
+);
+// Saída:
+// {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard",
+//   es: "https://example.com/es/dashboard"
+// }
+```
+
+Ao integrar `getMultilingualUrls`, os desenvolvedores podem manter estruturas de URLs consistentes em vários idiomas, melhorando tanto a experiência do usuário quanto o SEO.

package/pt/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,50 @@
+# Documentação: Funções `getPathWithoutLocale` em `intlayer`
+
+## Descrição
+
+Remove o segmento de localidade da URL ou caminho fornecido, se presente. Funciona com URLs absolutas e caminhos relativos.
+
+## Parâmetros
+
+- `inputUrl: string`
+
+  - **Descrição**: A string completa da URL ou caminho a ser processada.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+  - **Descrição**: Array opcional de localidades suportadas. Por padrão, utiliza as localidades configuradas no projeto.
+  - **Tipo**: `Locales[]`
+
+## Retorno
+
+- **Tipo**: `string`
+- **Descrição**: A string da URL ou caminho sem o segmento de localidade.
+
+## Exemplo de Uso
+
+```typescript codeFormat="typescript"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/pt/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/pt/dashboard")); // Saída: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="esm"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/pt/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/pt/dashboard")); // Saída: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="commonjs"
+const { getPathWithoutLocale } = require("intlayer");
+
+console.log(getPathWithoutLocale("/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/pt/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Saída: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/pt/dashboard")); // Saída: "https://example.com/dashboard"
+```

package/pt/packages/intlayer/getTranslation.md

@@ -0,0 +1,175 @@
+# Documentação: Função `getTranslationContent` em `intlayer`
+
+## Descrição
+
+A função `getTranslationContent` recupera o conteúdo correspondente a um local específico de um conjunto de conteúdos de idioma personalizáveis. Se o local especificado não for encontrado, ela retorna por padrão o conteúdo do local padrão configurado no projeto.
+
+## Parâmetros
+
+- `languageContent: CustomizableLanguageContent<Content>`
+
+  - **Descrição**: Um objeto contendo traduções para vários locais. Cada chave representa um local, e seu valor é o conteúdo correspondente.
+  - **Tipo**: `CustomizableLanguageContent<Content>`
+    - `Content` pode ser de qualquer tipo, com padrão como `string`.
+
+- `locale: Locales`
+
+  - **Descrição**: O local para o qual o conteúdo deve ser recuperado.
+  - **Tipo**: `Locales`
+
+## Retornos
+
+- **Tipo**: `Content`
+- **Descrição**: O conteúdo correspondente ao local especificado. Se o local não for encontrado, o conteúdo do local padrão será retornado.
+
+## Exemplo de Uso
+
+### Uso Básico
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+### Local Ausente:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do local padrão)
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do local padrão)
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do local padrão)
+```
+
+### Usando Tipos de Conteúdo Personalizados:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+## Casos de Borda
+
+- **Local Não Encontrado:**
+  - Quando o `locale` não é encontrado no `languageContent`, a função retorna o conteúdo do local padrão.
+- **Conteúdo de Idioma Incompleto:**
+  - Se um local estiver parcialmente definido, a função não mescla conteúdos. Ela recupera estritamente o valor do local especificado ou retorna ao padrão.
+- **Aplicação do TypeScript:**
+  - Se os locais em `languageContent` não corresponderem à configuração do projeto, o TypeScript exigirá que todos os locais necessários sejam definidos, garantindo que o conteúdo seja completo e seguro em termos de tipo.

package/pt/packages/intlayer/getTranslationContent.md

@@ -0,0 +1,177 @@
+# Documentação: Função `getTranslation` em `intlayer`
+
+## Descrição
+
+A função `getTranslation` recupera o conteúdo correspondente a um locale específico a partir de um conjunto de conteúdos de idioma personalizáveis. Se o locale especificado não for encontrado, ela retorna o conteúdo do locale padrão configurado no projeto.
+
+## Parâmetros
+
+- `languageContent: CustomizableLanguageContent<Content>`
+
+  - **Descrição**: Um objeto contendo traduções para vários locales. Cada chave representa um locale, e seu valor é o conteúdo correspondente.
+  - **Tipo**: `CustomizableLanguageContent<Content>`
+    - `Content` pode ser de qualquer tipo, sendo `string` o padrão.
+
+- `locale: Locales`
+
+  - **Descrição**: O locale para o qual o conteúdo deve ser recuperado.
+  - **Tipo**: `Locales`
+
+## Retornos
+
+- **Tipo**: `Content`
+- **Descrição**: O conteúdo correspondente ao locale especificado. Se o locale não for encontrado, o conteúdo do locale padrão será retornado.
+
+## Exemplo de Uso
+
+### Uso Básico
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Saída: "Bonjour"
+```
+
+### Locale Ausente:
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do locale padrão)
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do locale padrão)
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const content = getTranslation(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+    pt: "Olá",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Saída: "Hello" (conteúdo do locale padrão)
+```
+
+### Usando Tipos de Conteúdo Personalizados:
+
+```typescript codeFormat="typescript"
+import { getTranslation, Locales } from "intlayer";
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslation, Locales } from "intlayer";
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslation, Locales } = require("intlayer");
+
+const customContent = getTranslation<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+    pt: { greeting: "Olá" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Saída: "Bonjour"
+```
+
+## Casos de Borda
+
+- **Locale Não Encontrado:**
+  - Quando o `locale` não é encontrado em `languageContent`, a função retorna o conteúdo do locale padrão.
+- **Conteúdo de Idioma Incompleto:**
+  - Se um locale estiver parcialmente definido, a função não mescla conteúdos. Ela recupera estritamente o valor do locale especificado ou retorna ao padrão.
+- **Enforcement do TypeScript:**
+  - Se os locales em `languageContent` não corresponderem à configuração do projeto, o TypeScript exigirá que todos os locales necessários sejam definidos, garantindo que o conteúdo seja completo e seguro em termos de tipo.
+
+[Documentação em Português](https://github.com/aymericzip/intlayer/blob/main/docs/pt/**/*.md)