@intlayer/docs 5.5.8

package/es/packages/intlayer/getLocalizedUrl.md

@@ -0,0 +1,221 @@
+# Documentación: Función `getLocalizedUrl` en `intlayer`
+
+## Descripción
+
+La función `getLocalizedUrl` genera una URL localizada al prefijar la URL dada con el locale especificado. Maneja tanto URLs absolutas como relativas, asegurando que se aplique el prefijo de locale correcto basado en la configuración.
+
+---
+
+## Parámetros
+
+- `url: string`
+
+  - **Descripción**: La cadena de URL original a la que se le añadirá un prefijo con un locale.
+  - **Tipo**: `string`
+
+- `currentLocale: Locales`
+
+  - **Descripción**: El locale actual para el cual se está localizando la URL.
+  - **Tipo**: `Locales`
+
+- `locales: Locales[]`
+
+  - **Descripción**: Array opcional de locales soportados. Por defecto, se proporcionan los locales configurados en el proyecto.
+  - **Tipo**: `Locales[]`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/es/configuration.md#middleware)
+
+- `defaultLocale: Locales`
+
+  - **Descripción**: El locale predeterminado para la aplicación. Por defecto, se proporciona el locale predeterminado configurado en el proyecto.
+  - **Tipo**: `Locales`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/es/configuration.md#middleware)
+
+- `prefixDefault: boolean`
+  - **Descripción**: Indica si se debe prefijar la URL para el locale predeterminado. Por defecto, se proporciona el valor configurado en el proyecto.
+  - **Tipo**: `boolean`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/es/configuration.md#middleware)
+
+### Retorna
+
+- **Tipo**: `string`
+- **Descripción**: La URL localizada para el locale especificado.
+
+---
+
+## Ejemplo de Uso
+
+### URLs Relativas
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale predeterminado (inglés)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale predeterminado (inglés)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale predeterminado (inglés)
+```
+
+```javascript codeFormat="commonjs"
+const { getLocalizedUrl, Locales } = require("intlayer");
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale predeterminado (inglés)
+```
+
+### URLs Absolutas
+
+```typescript
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.FRENCH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale Predeterminado
+  false // Prefijar Locale Predeterminado
+); // Salida: "https://example.com/fr/about" para el francés
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale Predeterminado
+  false // Prefijar Locale Predeterminado
+); // Salida: "https://example.com/about" para el inglés
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale Predeterminado
+  true // Prefijar Locale Predeterminado
+); // Salida: "https://example.com/en/about" para el inglés
+```
+
+### Locale No Soportado
+
+```typescript
+getLocalizedUrl(
+  "/about",
+  Locales.ITALIAN, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH // Locale Predeterminado
+); // Salida: "/about" (no se aplica prefijo para locales no soportados)
+```
+
+---
+
+## Casos Especiales
+
+- **Sin Segmento de Locale:**
+
+  - Si la URL no contiene ningún segmento de locale, la función añade de manera segura el prefijo del locale apropiado.
+
+- **Locale Predeterminado:**
+
+  - Cuando `prefixDefault` es `false`, la función no añade prefijo a la URL para el locale predeterminado.
+
+- **Locales No Soportados:**
+  - Para locales no listados en `locales`, la función no aplica ningún prefijo.
+
+---
+
+## Uso en Aplicaciones
+
+En una aplicación multilingüe, configurar los ajustes de internacionalización con `locales` y `defaultLocale` es crítico para asegurar que se muestre el idioma correcto. A continuación, se muestra un ejemplo de cómo usar `getLocalizedUrl` en la configuración de una aplicación:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Configuración para locales soportados y locale predeterminado
+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;
+```
+
+La configuración anterior asegura que la aplicación reconozca `ENGLISH`, `FRENCH` y `SPANISH` como idiomas soportados y use `ENGLISH` como idioma de respaldo.
+
+Usando esta configuración, la función `getLocalizedUrl` puede generar dinámicamente URLs localizadas basadas en la preferencia de idioma del usuario:
+
+```typescript
+getLocalizedUrl("/about", Locales.FRENCH); // Salida: "/fr/about"
+getLocalizedUrl("/about", Locales.SPANISH); // Salida: "/es/about"
+getLocalizedUrl("/about", Locales.ENGLISH); // Salida: "/about"
+```
+
+Al integrar `getLocalizedUrl`, los desarrolladores pueden mantener estructuras de URL consistentes en múltiples idiomas, mejorando tanto la experiencia del usuario como el SEO.

package/es/packages/intlayer/getMultilingualUrls.md

@@ -0,0 +1,198 @@
+# Documentación: Función `getMultilingualUrls` en `intlayer`
+
+## Descripción
+
+La función `getMultilingualUrls` genera un mapeo de URLs multilingües al prefijar la URL proporcionada con cada localización soportada. Puede manejar tanto URLs absolutas como relativas, aplicando el prefijo de localización apropiado basado en la configuración proporcionada o los valores predeterminados.
+
+---
+
+## Parámetros
+
+- `url: string`
+
+  - **Descripción**: La URL original en formato de cadena que será prefijada con localizaciones.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+
+  - **Descripción**: Array opcional de localizaciones soportadas. Por defecto, utiliza las localizaciones configuradas en el proyecto.
+  - **Tipo**: `Locales[]`
+  - **Predeterminado**: `localesDefault`
+
+- `defaultLocale: Locales`
+
+  - **Descripción**: La localización predeterminada para la aplicación. Por defecto, utiliza la localización predeterminada configurada en el proyecto.
+  - **Tipo**: `Locales`
+  - **Predeterminado**: `defaultLocaleDefault`
+
+- `prefixDefault: boolean`
+  - **Descripción**: Indica si se debe prefijar la localización predeterminada. Por defecto, utiliza el valor configurado en el proyecto.
+  - **Tipo**: `boolean`
+  - **Predeterminado**: `prefixDefaultDefault`
+
+### Retorna
+
+- **Tipo**: `IConfigLocales<string>`
+- **Descripción**: Un objeto que mapea cada localización a su correspondiente URL multilingüe.
+
+---
+
+## Ejemplo de Uso
+
+### URLs Relativas
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### URLs Absolutas
+
+```typescript
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  true
+);
+// Salida: {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard"
+// }
+```
+
+---
+
+## Casos Especiales
+
+- **Sin Segmento de Localización:**
+
+  - La función elimina cualquier segmento de localización existente de la URL antes de generar los mapeos multilingües.
+
+- **Localización Predeterminada:**
+
+  - Cuando `prefixDefault` es `false`, la función no prefija la URL para la localización predeterminada.
+
+- **Localizaciones No Soportadas:**
+  - Solo se consideran las localizaciones proporcionadas en el array `locales` para generar las URLs.
+
+---
+
+## Uso en Aplicaciones
+
+En una aplicación multilingüe, configurar los ajustes de internacionalización con `locales` y `defaultLocale` es crítico para garantizar que se muestre el idioma correcto. A continuación, se muestra un ejemplo de cómo se puede usar `getMultilingualUrls` en la configuración de una aplicación:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Configuración para localizaciones soportadas y localización predeterminada
+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;
+```
+
+La configuración anterior asegura que la aplicación reconozca `ENGLISH`, `FRENCH` y `SPANISH` como idiomas soportados y utilice `ENGLISH` como idioma de respaldo.
+
+Usando esta configuración, la función `getMultilingualUrls` puede generar dinámicamente mapeos de URLs multilingües basados en las localizaciones soportadas por la aplicación:
+
+```typescript
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH
+);
+// Salida:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH,
+  true
+);
+// Salida:
+// {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard",
+//   es: "https://example.com/es/dashboard"
+// }
+```
+
+Al integrar `getMultilingualUrls`, los desarrolladores pueden mantener estructuras de URLs consistentes en múltiples idiomas, mejorando tanto la experiencia del usuario como el SEO.

package/es/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,50 @@
+# Documentación: Funciones `getPathWithoutLocale` en `intlayer`
+
+## Descripción
+
+Elimina el segmento de la configuración regional del URL o ruta proporcionada si está presente. Funciona con URLs absolutas y rutas relativas.
+
+## Parámetros
+
+- `inputUrl: string`
+
+  - **Descripción**: La cadena completa del URL o ruta a procesar.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+  - **Descripción**: Matriz opcional de configuraciones regionales compatibles. Por defecto, utiliza las configuraciones regionales configuradas en el proyecto.
+  - **Tipo**: `Locales[]`
+
+## Retorna
+
+- **Tipo**: `string`
+- **Descripción**: La cadena del URL o ruta sin el segmento de configuración regional.
+
+## Ejemplo de Uso
+
+```typescript codeFormat="typescript"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="esm"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="commonjs"
+const { getPathWithoutLocale } = require("intlayer");
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```

package/es/packages/intlayer/getTranslation.md

@@ -0,0 +1,166 @@
+# Documentación: Función `getTranslationContent` en `intlayer`
+
+## Descripción
+
+La función `getTranslationContent` recupera el contenido correspondiente a un locale específico de un conjunto de contenido de idioma personalizable. Si no se encuentra el locale especificado, por defecto devuelve el contenido del locale predeterminado configurado en el proyecto.
+
+## Parámetros
+
+- `languageContent: CustomizableLanguageContent<Content>`
+
+  - **Descripción**: Un objeto que contiene traducciones para varios locales. Cada clave representa un locale y su valor es el contenido correspondiente.
+  - **Tipo**: `CustomizableLanguageContent<Content>`
+    - `Content` puede ser de cualquier tipo, por defecto es `string`.
+
+- `locale: Locales`
+
+  - **Descripción**: El locale para el cual se debe recuperar el contenido.
+  - **Tipo**: `Locales`
+
+## Retornos
+
+- **Tipo**: `Content`
+- **Descripción**: El contenido correspondiente al locale especificado. Si no se encuentra el locale, se devuelve el contenido del locale predeterminado.
+
+## Ejemplo de Uso
+
+### Uso Básico
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Salida: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Salida: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.ENGLISH
+);
+
+console.log(content); // Salida: "Bonjour"
+```
+
+### Locale Faltante:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Salida: "Hello" (contenido del locale predeterminado)
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Salida: "Hello" (contenido del locale predeterminado)
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const content = getTranslationContent(
+  {
+    en: "Hello",
+    fr: "Bonjour",
+  },
+  Locales.SPANISH
+);
+
+console.log(content); // Salida: "Hello" (contenido del locale predeterminado)
+```
+
+### Usando Tipos de Contenido Personalizados:
+
+```typescript codeFormat="typescript"
+import { getTranslationContent, Locales } from "intlayer";
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Salida: "Bonjour"
+```
+
+```javascript codeFormat="esm"
+import { getTranslationContent, Locales } from "intlayer";
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Salida: "Bonjour"
+```
+
+```javascript codeFormat="commonjs"
+const { getTranslationContent, Locales } = require("intlayer");
+
+const customContent = getTranslationContent<Record<string, string>>(
+  {
+    en: { greeting: "Hello" },
+    fr: { greeting: "Bonjour" },
+  },
+  Locales.FRENCH
+);
+
+console.log(customContent.greeting); // Salida: "Bonjour"
+```
+
+## Casos Especiales
+
+- **Locale No Encontrado:**
+  - Cuando el `locale` no se encuentra en el `languageContent`, la función devuelve el contenido del locale predeterminado.
+- **Contenido de Idioma Incompleto:**
+  - Si un locale está definido parcialmente, la función no combina contenidos. Recupera estrictamente el valor del locale especificado o recurre al predeterminado.
+- **Aplicación de TypeScript:**
+  - Si los locales en `languageContent` no coinciden con la configuración del proyecto, TypeScript aplicará que todos los locales requeridos estén definidos, asegurando que el contenido sea completo y seguro en cuanto a tipos.