@intlayer/docs 9.5.4 → 9.5.5

package/docs/pt/packages/astro-intlayer/intlayer.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2026-01-21
+updatedAt: 2026-09-19
+title: Documentação da integração intlayer | astro-intlayer
+description: Veja como configurar e usar a integração Astro intlayer no astro.config.mjs.
+keywords:
+  - intlayer
+  - astro
+  - astro-intlayer
+  - integração
+  - i18n
+  - internacionalização
+  - documentação
+slugs:
+  - doc
+  - packages
+  - astro-intlayer
+  - intlayer
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Atualizada documentação de integração com detalhes de middleware e hooks"
+  - version: 8.0.0
+    date: 2026-01-21
+    changes: "Doc inicial"
+author: aymericzip
+---
+
+# Documentação da integração Astro intlayer
+
+A integração `intlayer` para Astro configura seu projeto para internacionalização (i18n) multilíngue. Ela cuida da preparação de dicionários no momento da compilação, injeção de plugins Vite, registro automático de middleware de requisição e emissão de páginas pré-renderizadas localizadas.
+
+## Utilização
+
+Adicione `intlayer()` ao seu `astro.config.mjs`:
+
+```ts fileName="astro.config.mjs"
+import { defineConfig } from "astro/config";
+import { intlayer } from "astro-intlayer";
+
+export default defineConfig({
+  integrations: [intlayer()],
+});
+```
+
+O codemod do Astro CLI (`astro add astro-intlayer`) também gera uma importação padrão que é suportada:
+
+```ts
+import intlayer from "astro-intlayer";
+```
+
+## Descrição
+
+A integração se conecta ao ciclo de vida de build e execução do Astro:
+
+1. **Configuração inicial (`astro:config:setup`)**:
+   - **Preparação de Dicionários**: Prepara os dicionários do Intlayer e os tipos gerados antes da execução do build.
+   - **Plugins Vite**: Injeta plugins para aliases Vite (permitindo importações diretas de dicionários), proxies de roteamento de locale e poda de compilação.
+   - **Registro de Middleware**: Injeta automaticamente `astro-intlayer/middleware` na cadeia de middleware do seu projeto, preenchendo `Astro.locals.intlayer` em cada requisição recebida.
+2. **Build concluído (`astro:build:done`)**:
+   - **Reescritas de Página**: Inspeciona regras de reescrita de URL localizadas e emite páginas HTML pré-renderizadas em seus caminhos localizados correspondentes.
+
+## O que é fornecido imediatamente
+
+Uma vez configurada, sua aplicação Astro pode usar imediatamente:
+
+- Os hooks `useIntlayer`, `useDictionary` e `useLocale` no frontmatter de componentes `.astro`.
+- O objeto `Astro.locals.intlayer` em endpoints e páginas Astro.
+- Importações no lado do cliente em blocos `<script>` que espelham a mesma API com atualizações reativas.
+- Formatadores integrados em `astro-intlayer/format` (`useDate`, `useNumber`, `useCurrency`, etc.).
+
+## Documentação relacionada
+
+- [Hook `useIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useIntlayer.md)
+- [Hook `useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useLocale.md)
+- [Middleware `onRequest`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/onRequest.md)

package/docs/pt/packages/astro-intlayer/onRequest.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2026-09-19
+updatedAt: 2026-09-19
+title: Documentação do middleware onRequest | astro-intlayer
+description: Veja como usar o middleware onRequest em aplicações Astro para resolver o locale da requisição e preencher Astro.locals.intlayer.
+keywords:
+  - onRequest
+  - middleware
+  - astro
+  - astro-intlayer
+  - Astro.locals
+  - internacionalização
+  - documentação
+slugs:
+  - doc
+  - packages
+  - astro-intlayer
+  - onRequest
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Doc inicial"
+author: aymericzip
+---
+
+# Documentação do middleware Astro onRequest
+
+O middleware `onRequest` de `astro-intlayer/middleware` resolve o locale de cada requisição HTTP recebida e preenche `Astro.locals.intlayer`.
+
+Quando você registra a integração `intlayer()` em `astro.config.mjs`, esse middleware é injetado automaticamente. Você só precisa importá-lo diretamente se estiver compondo manualmente o middleware Astro usando `sequence(...)`.
+
+## Utilização
+
+```ts fileName="src/middleware.ts"
+import { onRequest as intlayer } from "astro-intlayer/middleware";
+import { sequence } from "astro:middleware";
+
+export const onRequest = sequence(intlayer, async (context, next) => {
+  // Acesse o locale resolvido em seu middleware personalizado
+  const { locale } = context.locals.intlayer;
+  console.log(`Manipulando requisição para o locale: ${locale}`);
+
+  return next();
+});
+```
+
+## Descrição
+
+O middleware realiza as seguintes tarefas:
+
+1. **Detecção de Locale**:
+   - **URL**: Analisa o prefixo do caminho da URL ou o parâmetro de busca `?locale=` (a menos que `routing.mode` esteja configurado como `no-prefix`).
+   - **Cookies / Cabeçalhos**: Verifica cookies de locale persistidos ou valores de cabeçalho personalizados.
+   - **Accept-Language**: Utiliza a negociação de idioma preferencial do navegador como fallback.
+   - Para páginas pré-renderizadas (`context.isPrerendered`), o locale é extraído estritamente da URL para evitar avisos de compilação do Astro.
+2. **Preenchimento de Contexto**: Preenche `Astro.locals.intlayer` com:
+   - `locale`: O locale resolvido.
+   - `defaultLocale`: O locale de fallback padrão.
+   - `availableLocales`: O array de locales configurados.
+3. **Escopo AsyncLocalStorage**: Envolve o processamento subsequente da requisição dentro de um escopo `AsyncLocalStorage`, permitindo que `useIntlayer()`, `useDictionary()` e `useLocale()` acessem o estado da requisição sem passar argumentos.
+
+## Tipo `IntlayerLocals`
+
+```ts
+export type IntlayerLocals = {
+  locale: DeclaredLocales;
+  defaultLocale: DeclaredLocales;
+  availableLocales: DeclaredLocales[];
+};
+```
+
+## Documentação relacionada
+
+- [Integração `intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/intlayer.md)
+- [Hook `useIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useIntlayer.md)
+- [Hook `useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useLocale.md)

package/docs/pt/packages/astro-intlayer/useDictionary.md

@@ -0,0 +1,95 @@
+---
+createdAt: 2026-09-19
+updatedAt: 2026-09-19
+title: Documentação do hook useDictionary | astro-intlayer
+description: Veja como usar o hook useDictionary em componentes e scripts Astro para resolver objetos de dicionário.
+keywords:
+  - useDictionary
+  - dictionary
+  - astro
+  - astro-intlayer
+  - Intlayer
+  - intlayer
+  - internacionalização
+  - documentação
+slugs:
+  - doc
+  - packages
+  - astro-intlayer
+  - useDictionary
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Doc inicial"
+author: aymericzip
+---
+
+# Documentação do hook useDictionary
+
+O hook `useDictionary` resolve um objeto de dicionário importado ou em linha e retorna seu conteúdo para o locale atual em aplicações Astro.
+
+Diferente do `useIntlayer`, que busca dicionários por chave a partir do registro global de dicionários, o `useDictionary` trabalha diretamente com um objeto de dicionário.
+
+## Utilização
+
+```astro fileName="src/pages/index.astro"
+---
+import { useDictionary } from "astro-intlayer";
+import homeContent from "../content/home.content";
+
+const content = useDictionary(homeContent);
+---
+
+<main>
+  <h1>{content.title}</h1>
+  <p>{content.description}</p>
+</main>
+```
+
+Você também pode passar dicionários em linha definidos com `t()`:
+
+```astro fileName="src/components/Footer.astro"
+---
+import { useDictionary } from "astro-intlayer";
+import { t } from "intlayer";
+
+const footer = useDictionary({
+  key: "footer",
+  content: {
+    copyright: t({
+      pt: "Todos os direitos reservados.",
+      en: "All rights reserved.",
+      fr: "Tous droits réservés.",
+      es: "Todos los derechos reservados.",
+    }),
+  },
+});
+---
+
+<footer>
+  <p>{footer.copyright}</p>
+</footer>
+```
+
+## Parâmetros
+
+```ts
+useDictionary(dictionary, localeOrSelector?)
+```
+
+1. **`dictionary`**: Um objeto de dicionário ou grupo de dicionários qualificado.
+2. **`localeOrSelector`** (opcional): Um locale específico ou objeto seletor (`{ item }`, `{ variant }`, opcionalmente com `locale`).
+
+## Descrição
+
+O hook realiza as seguintes tarefas:
+
+1. **Detecção de Locale**: No servidor, obtém o locale de `Astro.locals.intlayer`. No navegador, utiliza o locale da store do cliente.
+2. **Processamento de Conteúdo**: Resolve traduções (`t()`), enumerações, condições e estruturas aninhadas de acordo com o locale resolvido.
+3. **Seletores**: Aplica quaisquer seletores de item ou variante fornecidos nos argumentos.
+
+## Documentação relacionada
+
+- [Integração `intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/intlayer.md)
+- [Hook `useIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useIntlayer.md)
+- [Hook `useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useLocale.md)

package/docs/pt/packages/astro-intlayer/useIntlayer.md

@@ -0,0 +1,98 @@
+---
+createdAt: 2026-09-19
+updatedAt: 2026-09-19
+title: Documentação do hook useIntlayer | astro-intlayer
+description: Veja como usar o hook useIntlayer em componentes e scripts de cliente Astro para acessar conteúdo localizado.
+keywords:
+  - useIntlayer
+  - dictionary
+  - astro
+  - astro-intlayer
+  - Intlayer
+  - intlayer
+  - internacionalização
+  - documentação
+slugs:
+  - doc
+  - packages
+  - astro-intlayer
+  - useIntlayer
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Doc inicial"
+author: aymericzip
+---
+
+# Documentação do hook useIntlayer
+
+O hook `useIntlayer` permite recuperar conteúdo de dicionário localizado por chave em aplicações Astro.
+
+Ele pode ser chamado em dois contextos distintos usando o mesmo caminho de importação:
+
+1. **Servidor / Frontmatter**: Dentro de arquivos `.astro`, ele resolve automaticamente o conteúdo usando o locale da requisição armazenado em `Astro.locals.intlayer`.
+2. **Navegador / Tag `<script>` do cliente**: Em scripts do cliente ou componentes de frameworks de interface, ele resolve para a implementação de store do lado do cliente (`vanilla-intlayer`).
+
+## Utilização
+
+### No Frontmatter de componentes Astro
+
+```astro fileName="src/pages/index.astro"
+---
+import { useIntlayer } from "astro-intlayer";
+
+const content = useIntlayer("home");
+---
+
+<main>
+  <h1>{content.title}</h1>
+  <p>{content.description}</p>
+</main>
+```
+
+### Em blocos `<script>` do cliente
+
+```astro fileName="src/components/InteractiveWidget.astro"
+---
+import { useIntlayer } from "astro-intlayer";
+
+const content = useIntlayer("home");
+---
+
+<button id="alert-btn">{content.buttonText}</button>
+
+<script>
+  import { useIntlayer } from "astro-intlayer";
+
+  const content = useIntlayer("home");
+
+  document.getElementById("alert-btn")?.addEventListener("click", () => {
+    alert(content.buttonText);
+  });
+</script>
+```
+
+## Parâmetros
+
+```ts
+useIntlayer(key, localeOrSelector?)
+```
+
+1. **`key`**: A chave única do dicionário (conforme definida em seus arquivos de declaração `.content.ts`).
+2. **`localeOrSelector`** (opcional): Um locale específico ou objeto seletor (`{ item }`, `{ variant }`, opcionalmente com `locale`). Quando fornecido, substitui o locale detectado do contexto da requisição ou store do cliente.
+
+## Descrição
+
+O hook realiza as seguintes tarefas:
+
+1. **Resolução de Locale**:
+   - No servidor, lê o locale ativo de `Astro.locals.intlayer` por meio de um escopo `AsyncLocalStorage` inicializado por `astro-intlayer/middleware`.
+   - No navegador, lê o locale ativo do armazenamento/store do cliente.
+2. **Recuperação de Dicionário**: Injeta o conteúdo do dicionário correspondente à chave especificada.
+3. **Processamento de Tradução**: Resolve traduções (`t()`), enumerações, condições e markdown em conteúdo pronto para renderização.
+
+## Documentação relacionada
+
+- [Integração `intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/intlayer.md)
+- [Hook `useDictionary`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useDictionary.md)
+- [Hook `useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useLocale.md)

package/docs/pt/packages/astro-intlayer/useLocale.md

@@ -0,0 +1,126 @@
+---
+createdAt: 2026-09-19
+updatedAt: 2026-09-19
+title: Documentação do hook useLocale | astro-intlayer
+description: Veja como usar o hook useLocale em aplicações Astro para acessar e gerenciar o locale atual.
+keywords:
+  - useLocale
+  - locale
+  - astro
+  - astro-intlayer
+  - Intlayer
+  - intlayer
+  - internacionalização
+  - documentação
+slugs:
+  - doc
+  - packages
+  - astro-intlayer
+  - useLocale
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Doc inicial"
+author: aymericzip
+---
+
+# Documentação do hook useLocale
+
+O hook `useLocale` de `astro-intlayer` fornece acesso ao locale da requisição atual, ao locale padrão configurado e a todos os locales disponíveis em aplicações Astro.
+
+Ele se comporta de maneira consistente no frontmatter `.astro` renderizado no servidor e em blocos `<script>` do lado do cliente.
+
+## Utilização
+
+### No Frontmatter de componentes (Renderizado no Servidor)
+
+```astro fileName="src/layouts/Layout.astro"
+---
+import { useLocale } from "astro-intlayer";
+import { getLocalizedUrl, getPathWithoutLocale } from "intlayer";
+
+const { locale, defaultLocale, availableLocales } = useLocale();
+const pathWithoutLocale = getPathWithoutLocale(Astro.url.pathname);
+---
+
+<!DOCTYPE html>
+<html lang={locale}>
+  <head>
+    <meta charset="utf-8" />
+    <title>Astro + Intlayer</title>
+  </head>
+  <body>
+    <header>
+      <span>Atual: {locale}</span>
+      <span>Padrão: {defaultLocale}</span>
+      <nav>
+        <ul>
+          {availableLocales.map((localeItem) => (
+            <li key={localeItem} className="p-1">
+              <a
+                href={getLocalizedUrl(pathWithoutLocale, localeItem)}
+                aria-current={localeItem === locale ? "page" : undefined}
+              >
+                {localeItem.toUpperCase()}
+              </a>
+            </li>
+          ))}
+        </ul>
+      </nav>
+    </header>
+    <slot />
+  </body>
+</html>
+```
+
+### Em `<script>` do cliente (Interativo)
+
+```astro fileName="src/components/LocaleSwitcher.astro"
+---
+import { useLocale } from "astro-intlayer";
+
+const { locale, availableLocales } = useLocale();
+---
+
+<select id="locale-select">
+  {availableLocales.map((loc) => (
+    <option value={loc} selected={loc === locale}>
+      {loc.toUpperCase()}
+    </option>
+  ))}
+</select>
+
+<script>
+  import { useLocale, setLocaleInStorage } from "astro-intlayer";
+
+  const { setLocale } = useLocale();
+
+  document.getElementById("locale-select")?.addEventListener("change", (e) => {
+    const target = e.target as HTMLSelectElement;
+    setLocale(target.value);
+  });
+</script>
+```
+
+## Valores de retorno
+
+O hook retorna um objeto do tipo `UseLocaleResult`:
+
+| Propriedade        | Tipo                                   | Descrição                                                                      |
+| ------------------ | -------------------------------------- | ------------------------------------------------------------------------------ |
+| `locale`           | `DeclaredLocales`                      | O locale ativo.                                                                |
+| `defaultLocale`    | `DeclaredLocales`                      | O locale de fallback padrão configurado em `intlayer.config.ts`.               |
+| `availableLocales` | `DeclaredLocales[]`                    | Array de todos os locales suportados configurados para o projeto.              |
+| `setLocale`        | `(locale: LocalesValues) => void`      | Função para atualizar o locale. (Interativa no `<script>`, avisa durante SSR). |
+| `subscribe`        | `(callback: () => void) => () => void` | Inscreve-se nas alterações de locale no lado do cliente.                       |
+
+## Comportamento Servidor vs Cliente
+
+- **Durante SSR / Renderização no Servidor**: Uma requisição é renderizada uma vez com parâmetros fixos. Chamar `setLocale()` durante a renderização no servidor não tem efeito e emite um aviso; a alteração de locale deve ser feita no cliente ou navegando para a URL do locale desejado.
+- **Em scripts do cliente**: `setLocale` atualiza a store do cliente e atualiza cookies persistidos ou o armazenamento local de acordo com sua configuração do Intlayer.
+
+## Documentação relacionada
+
+- [Integração `intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/intlayer.md)
+- [Hook `useIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useIntlayer.md)
+- [Hook `useDictionary`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/astro-intlayer/useDictionary.md)

package/docs/pt/packages/remix-intlayer/Intlayer.md

@@ -0,0 +1,77 @@
+---
+createdAt: 2026-09-19
+updatedAt: 2026-09-19
+title: Documentação do contexto Intlayer | remix-intlayer
+description: Veja como usar a chave e a propriedade de contexto de requisição Intlayer em aplicações Remix 3.
+keywords:
+  - Intlayer
+  - remix
+  - remix-3
+  - contexto
+  - RequestContext
+  - Internacionalização
+  - Documentação
+slugs:
+  - doc
+  - packages
+  - remix-intlayer
+  - Intlayer
+history:
+  - version: 9.5.5
+    date: 2026-09-19
+    changes: "Init doc"
+author: aymericzip
+---
+
+# Documentação do contexto Intlayer
+
+No `remix-intlayer`, `Intlayer` é a chave de `RequestContext` usada para acessar o estado de internacionalização dentro dos manipuladores de requisição do Remix 3.
+
+## Uso
+
+Quando o middleware `intlayer()` é executado, ele armazena um objeto `IntlayerState` no contexto da requisição sob a chave `Intlayer`. Você pode recuperá-lo dentro de qualquer manipulador de rota:
+
+```ts fileName="src/server.ts"
+import { createRouter } from "remix/router";
+import { intlayer, Intlayer } from "remix-intlayer";
+
+const router = createRouter({
+  middleware: [intlayer()],
+});
+
+router.get("/api/profile", (context) => {
+  // Acesso via context.get(Intlayer)
+  const { locale, defaultLocale, availableLocales } = context.get(Intlayer);
+
+  return Response.json({
+    locale,
+    defaultLocale,
+    availableLocales,
+  });
+});
+```
+
+Você também pode acessar utilizando o atalho de propriedade direta `context.intlayer`:
+
+```ts
+router.get("/api/status", (context) => {
+  const currentLocale = context.intlayer.locale;
+  return Response.json({ status: "ok", locale: currentLocale });
+});
+```
+
+## Estrutura do `IntlayerState`
+
+O objeto `IntlayerState` contém:
+
+| Propriedade        | Tipo                | Descrição                                                           |
+| ------------------ | ------------------- | ------------------------------------------------------------------- |
+| `locale`           | `DeclaredLocales`   | A locale resolvida para a requisição atual.                         |
+| `defaultLocale`    | `DeclaredLocales`   | A locale de fallback padrão configurada em `intlayer.config.ts`.    |
+| `availableLocales` | `DeclaredLocales[]` | A lista de todas as locales suportadas configuradas para o projeto. |
+
+## Documentação relacionada
+
+- [Middleware `intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/remix-intlayer/intlayerMiddleware.md)
+- [Hook `useLocale`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/remix-intlayer/useLocale.md)
+- [Hook `useIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/packages/remix-intlayer/useIntlayer.md)