@intlayer/docs 8.0.0 → 8.0.1-canary.0

package/docs/ja/packages/adonis-intlayer/exports.md

@@ -0,0 +1,50 @@
+---
+createdAt: 2026-01-30
+updatedAt: 2026-01-30
+title: adonis-intlayer パッケージドキュメント
+description: Intlayer 用の AdonisJS ミドルウェア。翻訳機能とロケール検出を提供します。
+keywords:
+  - adonis-intlayer
+  - adonisjs
+  - middleware
+  - 国際化
+  - i18n
+slugs:
+  - doc
+  - packages
+  - adonis-intlayer
+  - exports
+history:
+  - version: 8.0.0
+    date: 2026-01-30
+    changes: 初期ドキュメント
+---
+
+# adonis-intlayer パッケージ
+
+`adonis-intlayer` パッケージは、国際化を処理するための AdonisJS アプリケーション用ミドルウェアを提供します。ユーザーのロケールを検出し、翻訳機能を提供します。
+
+## インストール
+
+```bash
+npm install adonis-intlayer
+```
+
+## エクスポート
+
+### ミドルウェア
+
+このパッケージは、国際化を処理するための AdonisJS ミドルウェアを提供します。
+
+| 関数                 | 説明                                                                                                                                                                                                                                                             | 関連ドキュメント                                                                                               |
+| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `IntlayerMiddleware` | ユーザーのロケールを検出し、リクエストコンテキストに Intlayer データを入力する AdonisJS ミドルウェア。また、リクエストライフサイクルアクセス用の CLS（Async Local Storage）ネームスペースを設定し、`t`、`getIntlayer` などのグローバル関数の使用を可能にします。 | [intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/packages/adonis-intlayer/intlayer.md) |
+
+### 関数
+
+| 関数            | 説明                                                                                                                                                                                                        | 関連ドキュメント                                                                                       |
+| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `t`             | 現在のロケールのコンテンツを取得する翻訳関数。`intlayer` ミドルウェアによって管理されるリクエストライフサイクル内で動作します。CLS（Async Local Storage）を使用してリクエストコンテキストにアクセスします。 | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/translation.md) |
+| `getIntlayer`   | 生成された宣言からキーによって辞书を取得し、指定されたロケールのコンテンツを返します。`getDictionary` の最適化バージョン。CLS を使用してリクエストコンテキストにアクセスします。                            | -                                                                                                      |
+| `getDictionary` | 辞書オブジェクトを処理し、指定されたロケールのコンテンツを返します。`t()` 翻訳、列挙、markdown、HTML などを処理します。CLS を使用してリクエストコンテキストにアクセスします。                               | -                                                                                                      |
+| `getLocale`     | CLS を使用してリクエストコンテキストから現在のロケールを取得します。                                                                                                                                        | -                                                                                                      |

package/docs/ja/packages/adonis-intlayer/intlayer.md

@@ -0,0 +1,54 @@
+---
+createdAt: 2026-01-30
+updatedAt: 2026-01-30
+title: intlayer AdonisJS ミドルウェアドキュメント | adonis-intlayer
+description: adonis-intlayer パッケージの intlayer ミドルウェアの使用方法を確認してください
+keywords:
+  - intlayer
+  - adonisjs
+  - middleware
+  - Intlayer
+  - 国際化
+  - ドキュメント
+slugs:
+  - doc
+  - packages
+  - adonis-intlayer
+  - intlayer
+history:
+  - version: 8.0.0
+    date: 2026-01-30
+    changes: 初期ドキュメント
+---
+
+# intlayer AdonisJS ミドルウェアドキュメント
+
+AdonisJS 用の `intlayer` ミドルウェアは、ユーザーのロケールを検出し、リクエストコンテキストを通じて翻訳機能を提供します。また、リクエストフロー内でのグローバルな翻訳関数の使用を可能にします。
+
+## 使用方法
+
+```ts fileName="start/kernel.ts"
+router.use([() => import("adonis-intlayer/middleware")]);
+```
+
+```ts fileName="start/routes.ts"
+import router from "@adonisjs/core/services/router";
+import { t } from "adonis-intlayer";
+
+router.get("/", async () => {
+  return t({
+    en: "Hello",
+    fr: "Bonjour",
+  });
+});
+```
+
+## 説明
+
+ミドルウェアは以下のタスクを実行します：
+
+1. **ロケール検出**: リクエスト（ヘッダー、クッキーなど）を分析して、ユーザーの優先ロケールを決定します。
+2. **コンテキスト設定**: リクエストコンテキストにロケール情報を設定します。
+3. **Async Local Storage**: `cls-hooked`（または同等の仕組み）を使用して非同期コンテキストを管理し、`t`、`getIntlayer`、`getDictionary` などのグローバルな Intlayer 関数が、手動で渡すことなくリクエスト固有のロケールにアクセスできるようにします。
+
+> 注: ロケール検出にクッキーを使用するには、`@adonisjs/cookie` が構成され、アプリケーションで使用されていることを確認してください。

package/docs/ja/packages/adonis-intlayer/t.md

@@ -0,0 +1,149 @@
+---
+createdAt: 2026-01-30
+updatedAt: 2026-01-30
+title: t 関数ドキュメント | adonis-intlayer
+description: adonis-intlayer パッケージでの t 関数の使用方法を確認してください
+keywords:
+  - t
+  - 翻訳
+  - Intlayer
+  - 国際化
+  - ドキュメント
+  - AdonisJS
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - adonis-intlayer
+  - t
+history:
+  - version: 8.0.0
+    date: 2026-01-30
+    changes: 初期ドキュメント
+---
+
+# ドキュメント: `adonis-intlayer` の `t` 関数
+
+`adonis-intlayer` パッケージの `t` 関数は、AdonisJS アプリケーションでローカライズされたレスポンスを提供するためのコアユーティリティです。ユーザーの優先言語に基づいてコンテンツを動的に選択することで、国際化（i18n）を簡素化します。
+
+---
+
+## 概要
+
+`t` 関数は、特定の言語セットの翻訳を定義および取得するために使用されます。クライアントのリクエスト設定（`Accept-Language` ヘッダーなど）に基づいて、返すべき適切な言語を自動的に決定します。優先言語が利用できない場合は、構成で指定されたデフォルトのロケールに適切にフォールバックします。
+
+---
+
+## 主な機能
+
+- **動的なローカライズ**: クライアントに最も適切な翻訳を自動的に選択します。
+- **デフォルトロケールへのフォールバック**: クライアントの優先言語が利用できない場合、デフォルトのロケールにフォールバックし、ユーザー体験の継続性を確保します。
+- **非同期コンテキスト**: Async Local Storage を使用して、AdonisJS のリクエストライフサイクル内でシームレスに動作します。
+- **TypeScript サポート**: 翻訳の型安全性を強制します。
+
+---
+
+## 関数シグネチャ
+
+```typescript
+t(translations: Record<string, any>): any;
+```
+
+### パラメータ
+
+- `translations`: キーがロケールコード（例: `en`、`fr`、`es`）で、値が対応する翻訳コンテンツであるオブジェクト。
+
+### 戻り値
+
+- クライアントの優先言語を表すコンテンツ。
+
+---
+
+## ミドルウェアのロード
+
+`t` 関数が正しく動作するようにするには、AdonisJS アプリケーションに `intlayer` ミドルウェアを登録する**必要があります**。
+
+```typescript fileName="start/kernel.ts"
+router.use([() => import("adonis-intlayer/middleware")]);
+```
+
+---
+
+## 使用例
+
+### 基本的な例
+
+```typescript fileName="start/routes.ts"
+import router from "@adonisjs/core/services/router";
+import { t } from "adonis-intlayer";
+
+router.get("/", async () => {
+  return t({
+    en: "Welcome!",
+    fr: "Bienvenue!",
+    es: "¡Bienvenido!",
+  });
+});
+```
+
+### コントローラーでの使用
+
+```typescript fileName="app/controllers/example_controller.ts"
+import type { HttpContext } from "@adonisjs/core/http";
+import { t } from "adonis-intlayer";
+
+export default class ExampleController {
+  async index({ response }: HttpContext) {
+    return response.send(
+      t({
+        en: "Hello from controller",
+        fr: "Bonjour depuis le contrôleur",
+      })
+    );
+  }
+}
+```
+
+---
+
+## 高度なトピック
+
+### フォールバックメカニズム
+
+優先ロケールが利用できない場合、`t` 関数は `intlayer.config.ts` で定義されたデフォルトロケールにフォールバックします。
+
+```typescript
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [
+      Locales.ENGLISH,
+      Locales.RUSSIAN,
+      Locales.JAPANESE,
+      Locales.FRENCH,
+      Locales.KOREAN,
+      Locales.CHINESE,
+      Locales.SPANISH,
+      Locales.GERMAN,
+      Locales.ARABIC,
+      Locales.ITALIAN,
+      Locales.ENGLISH_UNITED_KINGDOM,
+      Locales.PORTUGUESE,
+      Locales.HINDI,
+      Locales.TURKISH,
+      Locales.POLISH,
+      Locales.INDONESIAN,
+      Locales.VIETNAMESE,
+      Locales.UKRAINIAN,
+    ],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+### TypeScript 統合
+
+`t` 関数は、定義された辞書と一緒に使用する場合に型安全です。詳細については、[TypeScript ドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/configuration.md)を参照してください。

package/docs/ja/packages/hono-intlayer/exports.md

@@ -0,0 +1,59 @@
+---
+createdAt: 2026-01-29
+updatedAt: 2026-01-29
+title: hono-intlayer パッケージ ドキュメント
+description: 翻訳関数とロケール検出を提供する Intlayer 用の Hono ミドルウェア。
+keywords:
+  - hono-intlayer
+  - hono
+  - ミドルウェア
+  - 国際化
+  - i18n
+slugs:
+  - doc
+  - packages
+  - hono-intlayer
+  - exports
+history:
+  - version: 8.0.0
+    date: 2026-01-29
+    changes: すべてのエクスポートのドキュメントを統合
+---
+
+# hono-intlayer パッケージ
+
+`hono-intlayer` パッケージは、国際化を処理するための Hono アプリケーション用ミドルウェアを提供します。ユーザーのロケールを検出し、コンテキスト オブジェクトに入力します。
+
+## インストール
+
+```bash
+npm install hono-intlayer
+```
+
+## エクスポート
+
+### ミドルウェア
+
+インポート:
+
+```tsx
+import { intlayer } from "hono-intlayer";
+```
+
+| 関数       | 説明                                                                                                                                                                                                                                                                             | 関連ドキュメント                                                                                             |
+| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| `intlayer` | Intlayer を Hono アプリケーションに統合する Hono ミドルウェア。ストレージ (クッキー、ヘッダー) からのロケール検出を処理し、`t`、`getIntlayer`、`getDictionary` をコンテキストに入力し、リクエスト ライフサイクル中のプログラム アクセスのために CLS ネームスペースを設定します。 | [intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/packages/hono-intlayer/intlayer.md) |
+
+### 関数
+
+インポート:
+
+```tsx
+import { t, getIntlayer, getDictionary } from "hono-intlayer";
+```
+
+| 関数            | 説明                                                                                                                                                                                                                                  | 関連ドキュメント                                                                                       |
+| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `t`             | Hono の現在のロケールのコンテンツを取得するグローバル翻訳関数。CLS (Async Local Storage) を利用し、`intlayer` ミドルウェアによって管理されるリクエスト コンテキスト内で使用する必要があります。コンテキスト経由でもアクセスできます。 | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/dictionary/translation.md) |
+| `getIntlayer`   | 生成された宣言からキーによって辞書を取得し、指定されたロケールのコンテンツを返します。`getDictionary` の最適化バージョン。リクエスト コンテキストへのアクセスに CLS を使用します。コンテキスト経由でもアクセスできます。              | -                                                                                                      |
+| `getDictionary` | 辞書オブジェクトを処理し、指定されたロケールのコンテンツを返します。`t()` 翻訳、列挙、markdown、HTML などを処理します。リクエスト コンテキストへのアクセスに CLS を使用します。コンテキスト経由でもアクセスできます。                 | -                                                                                                      |

package/docs/ja/packages/hono-intlayer/intlayer.md

@@ -0,0 +1,60 @@
+---
+createdAt: 2026-01-29
+updatedAt: 2026-01-29
+title: intlayer Hono ミドルウェア ドキュメント | hono-intlayer
+description: hono-intlayer パッケージでの intlayer ミドルウェアの使用方法を確認する
+keywords:
+  - intlayer
+  - hono
+  - ミドルウェア
+  - Intlayer
+  - 国際化
+  - ドキュメント
+slugs:
+  - doc
+  - packages
+  - hono-intlayer
+  - intlayer
+history:
+  - version: 8.0.0
+    date: 2026-01-29
+    changes: ドキュメントの初期化
+---
+
+# intlayer Hono ミドルウェア ドキュメント
+
+Hono 用の `intlayer` ミドルウェアは、ユーザーのロケールを検出し、コンテキスト オブジェクトに Intlayer 関数を入力します。また、リクエスト コンテキスト内でのグローバル翻訳関数の使用を可能にします。
+
+## 使用方法
+
+```ts
+import { Hono } from "hono";
+import { intlayer } from "hono-intlayer";
+
+const app = new Hono();
+
+app.use("*", intlayer());
+
+app.get("/", async (c) => {
+  const t = c.get("t");
+  const content = t({
+    en: "Hello",
+    fr: "Bonjour",
+    ja: "こんにちは",
+  });
+
+  return c.text(content);
+});
+```
+
+## 説明
+
+このミドルウェアは次のタスクを実行します。
+
+1. **ロケール検出**: リクエスト (ヘッダー、クッキーなど) を分析して、ユーザーの優先ロケールを決定します。
+2. **コンテキスト入力**: `c.get()` を介してアクセス可能な Hono コンテキストに Intlayer データを追加します。これには以下が含まれます。
+   - `locale`: 検出されたロケール。
+   - `t`: 翻訳関数。
+   - `getIntlayer`: 辞書を取得するための関数。
+   - `getDictionary`: 辞書オブジェクトを処理するための関数。
+3. **コンテキスト管理**: `cls-hooked` を使用して非同期コンテキストを管理し、グローバルな Intlayer 関数 (`t`、`getIntlayer`、`getDictionary`) がコンテキスト オブジェクトを渡すことなくリクエスト固有のロケールにアクセスできるようにします。

package/docs/ja/packages/hono-intlayer/t.md

@@ -0,0 +1,268 @@
+---
+createdAt: 2024-12-02
+updatedAt: 2025-06-29
+title: t 関数ドキュメント | hono-intlayer
+description: hono-intlayer パッケージでの t 関数の使用方法を確認する
+keywords:
+  - t
+  - 翻訳
+  - Intlayer
+  - 国際化
+  - ドキュメント
+  - Hono
+  - JavaScript
+slugs:
+  - doc
+  - packages
+  - hono-intlayer
+  - t
+history:
+  - version: 5.5.10
+    date: 2025-06-29
+    changes: 履歴の初期化
+---
+
+# ドキュメント: `hono-intlayer` における `t` 関数
+
+`hono-intlayer` パッケージの `t` 関数は、Hono アプリケーションでローカライズされたレスポンスを提供するためのコア ユーティリティです。ユーザーの優先言語に基づいてコンテンツを動的に選択することで、国際化 (i18n) を簡素化します。
+
+---
+
+## 概要
+
+`t` 関数は、特定の言語セットに対する翻訳を定義し、取得するために使用されます。`Accept-Language` ヘッダーなどのクライアントのリクエスト設定に基づいて、返すべき適切な言語を自動的に決定します。優先言語が利用できない場合は、設定で指定されたデフォルトのロケールに適切にフォールバックします。
+
+---
+
+## 主な機能
+
+- **動的なローカリゼーション**: クライアントにとって最も適切な翻訳を自動的に選択します。
+- **デフォルト ロケールへのフォールバック**: クライアントの優先言語が利用できない場合、デフォルトのロケールにフォールバックし、ユーザー エクスペリエンスの継続性を確保します。
+- **軽量で高速**: 高パフォーマンスなアプリケーション向けに設計されており、オーバーヘッドを最小限に抑えます。
+- **厳格モードのサポート**: 信頼性の高い動作のために、宣言されたロケールの厳守を強制します。
+
+---
+
+## 関数のシグネチャ
+
+```typescript
+t(translations: Record<string, string>): string;
+```
+
+### パラメータ
+
+- `translations`: キーがロケール コード (例: `en`、`fr`、`ja`) で、値が対応する翻訳文字列であるオブジェクト。
+
+### 戻り値
+
+- クライアントの優先言語でのコンテンツを表す文字列。
+
+---
+
+## 国際化リクエスト ハンドラのロード
+
+`hono-intlayer` が提供する国際化機能が正しく動作するようにするには、Hono アプリケーションの最初に国際化ミドルウェアをロードする**必要があります**。これにより `t` 関数が有効になり、ロケール検出と翻訳が適切に処理されます。
+
+アプリケーションの**すべてのルートの前に** `app.use("*", intlayer())` ミドルウェアを配置し、すべてのルートが国際化の恩恵を受けられるようにしてください。
+
+```typescript {6} fileName="src/index.ts" codeFormat="typescript"
+import { Hono } from "hono";
+import { intlayer } from "hono-intlayer";
+
+const app = new Hono();
+
+// 国際化リクエスト ハンドラをロード
+app.use("*", intlayer());
+
+// ミドルウェアのロード後にルートを定義
+app.get("/", (c) => {
+  return c.text(
+    t({
+      en: "Hello, World!",
+      fr: "Bonjour le monde!",
+      es: "¡Hola, Mundo!",
+      ja: "こんにちは、世界！",
+    })
+  );
+});
+```
+
+```javascript {6} fileName="src/index.mjs" codeFormat="esm"
+import { Hono } from "hono";
+import { intlayer } from "hono-intlayer";
+
+const app = new Hono();
+
+// 国際化リクエスト ハンドラをロード
+app.use("*", intlayer());
+
+// ミドルウェアのロード後にルートを定義
+app.get("/", (c) => {
+  return c.text(
+    t({
+      en: "Hello, World!",
+      fr: "Bonjour le monde!",
+      es: "¡Hola, Mundo!",
+      ja: "こんにちは、世界！",
+    })
+  );
+});
+```
+
+```javascript {6} fileName="src/index.cjs" codeFormat="commonjs"
+const { Hono } = require("hono");
+const { intlayer, t } = require("hono-intlayer");
+
+const app = new Hono();
+
+// 国際化リクエスト ハンドラをロード
+app.use("*", intlayer());
+
+// ミドルウェアのロード後にルートを定義
+app.get("/", (c) => {
+  return c.text(
+    t({
+      en: "Hello, World!",
+      fr: "Bonjour le monde!",
+      es: "¡Hola, Mundo!",
+      ja: "こんにちは、世界！",
+    })
+  );
+});
+```
+
+### これが必要な理由
+
+- **ロケール検出**: `intlayer` ミドルウェアは、ヘッダー、クッキー、またはその他の構成された方法に基づいてユーザーの優先ロケールを検出するために、着信リクエストを処理します。
+- **翻訳コンテキスト**: `t` 関数が正しく動作するために必要なコンテキストを設定し、翻訳が正しい言語で返されるようにします。
+- **エラー防止**: このミドルウェアがないと、必要なロケール情報が利用できないため、`t` 関数を使用するとランタイム エラーが発生します。
+
+---
+
+## 使用例
+
+### 基本的な例
+
+異なる言語でローカライズされたコンテンツを提供します。
+
+```typescript fileName="src/index.ts" codeFormat="typescript"
+app.get("/", (c) => {
+  return c.text(
+    t({
+      en: "Welcome!",
+      fr: "Bienvenue!",
+      ja: "ようこそ！",
+    })
+  );
+});
+```
+
+**クライアント リクエスト:**
+
+- `Accept-Language: fr` のクライアントは `Bienvenue!` を受け取ります。
+- `Accept-Language: ja` のクライアントは `ようこそ！` を受け取ります。
+- `Accept-Language: de` のクライアントは `Welcome!` (デフォルト ロケール) を受け取ります。
+
+### エラー処理
+
+複数の言語でエラー メッセージを提供します。
+
+```typescript fileName="src/index.ts" codeFormat="typescript"
+app.get("/error", (c) => {
+  return c.text(
+    t({
+      en: "An unexpected error occurred.",
+      fr: "Une erreur inattendue s'est produite.",
+      ja: "予期しないエラーが発生しました。",
+    }),
+    500
+  );
+});
+```
+
+---
+
+### ロケール バリアントの使用
+
+ロケール固有のバリアントに対する翻訳を指定します。
+
+```typescript fileName="src/index.ts" codeFormat="typescript"
+app.get("/greet", (c) => {
+  return c.text(
+    t({
+      en: "Hello!",
+      "en-GB": "Hello, mate!",
+      fr: "Bonjour!",
+      ja: "こんにちは！",
+    })
+  );
+});
+```
+
+---
+
+## 高度なトピック
+
+### フォールバック メカニズム
+
+優先ロケールが利用できない場合、`t` 関数は設定で定義されたデフォルト ロケールにフォールバックします。
+
+```typescript {5-6} fileName="intlayer.config.ts" codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.JAPANESE],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+---
+
+### 厳格モードの強制
+
+宣言されたロケールの厳守を強制するように `t` 関数を構成します。
+
+| モード      | 動作                                                                                               |
+| ----------- | -------------------------------------------------------------------------------------------------- |
+| `strict`    | 宣言されたすべてのロケールに翻訳を提供する必要があります。不足している場合はエラーをスローします。 |
+| `inclusive` | 宣言されたロケールには翻訳が必要です。不足している場合は警告を発しますが、受け入れられます。       |
+| `loose`     | 宣言されていなくても、既存のロケールはすべて受け入れられます。                                     |
+
+---
+
+### TypeScript の統合
+
+TypeScript と一緒に使用すると、`t` 関数は型安全になります。型安全な翻訳オブジェクトを定義します。
+
+```typescript fileName="src/index.ts" codeFormat="typescript"
+import { type LanguageContent } from "hono-intlayer";
+
+const translations: LanguageContent<string> = {
+  en: "Good morning!",
+  fr: "Bonjour!",
+  ja: "おはようございます！",
+};
+
+app.get("/morning", (c) => {
+  return c.text(t(translations));
+});
+```
+
+---
+
+### よくあるエラーとトラブルシューティング
+
+| 問題                 | 原因                                   | 解決策                                                                           |
+| -------------------- | -------------------------------------- | -------------------------------------------------------------------------------- |
+| `t` 関数が動作しない | ミドルウェアがロードされていない       | ルートの前に `app.use("*", intlayer())` が追加されていることを確認してください。 |
+| 翻訳不足エラー       | すべてのロケールなしで厳格モードが有効 | 必要なすべての翻訳を提供してください。                                           |
+
+---
+
+## 結論
+
+`t` 関数は、バックエンドの国際化のための強力なツールです。これを効果的に使用することで、グローバルな視聴者にとってより包括的でユーザーフレンドリーなアプリケーションを作成できます。高度な使用法と詳細な構成オプションについては、[ドキュメント](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/configuration.md)を参照してください。