@intlayer/docs 9.1.3 → 9.3.0

package/docs/ru/dictionary/nesting.md

@@ -29,199 +29,88 @@ author: aymericzip
 
 Чтобы установить вложение в вашем проекте Intlayer, сначала определите базовый контент, который вы хотите повторно использовать. Затем в отдельном модуле контента используйте функцию `nest` для импорта этого контента.
 
-## Как работает вложенность
+### Базовый словарь
 
-<Tabs group="framework">
-  <Tab label="React" value="react">
+Ниже приведен пример базового словаря для вложения в другой словарь:
 
-To use nested content in a React component, leverage the `useIntlayer` hook from the `react-intlayer` package. This hook retrieves the correct content based on the specified key. Here's an example of how to use it:
-
-```tsx fileName="**/*.tsx" codeFormat={["typescript", "esm"]}
-import type { FC } from "react";
-import { useIntlayer } from "react-intlayer";
-
-const NestComponent: FC = () => {
-  const { fullNestedContent, partialNestedContent } = useIntlayer(
-    "key_of_my_second_dictionary"
-  );
+```typescript fileName="firstDictionary.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
+import { type Dictionary } from "intlayer";
 
-  return (
-    <div>
-      <p>Full Nested Content: {JSON.stringify(fullNestedContent)}</p>
-      <p>Partial Nested Value: {partialNestedContent}</p>
-    </div>
-  );
-};
+const firstDictionary = {
+  key: "key_of_my_first_dictionary",
+  content: {
+    content: "content",
+    subContent: {
+      contentNumber: 0,
+      contentString: "string",
+    },
+  },
+} satisfies Dictionary;
 
-export default NestComponent;
+export default firstDictionary;
 ```
 
-  </Tab>
-  <Tab label="Next.js" value="nextjs">
-
-To use nested content in Next.js Client Components, retrieve it via the `useIntlayer` hook. Here's an example:
-
-```tsx fileName="**/*.tsx" codeFormat={["typescript", "esm"]}
-"use client";
-
-import type { FC } from "react";
-import { useIntlayer } from "next-intlayer";
-
-const NestComponent: FC = () => {
-  const { fullNestedContent, partialNestedContent } = useIntlayer(
-    "key_of_my_second_dictionary"
-  );
-
-  return (
-    <div>
-      <p>Full Nested Content: {JSON.stringify(fullNestedContent)}</p>
-      <p>Partial Nested Value: {partialNestedContent}</p>
-    </div>
-  );
-};
-
-export default NestComponent;
-```
-
-  </Tab>
-  <Tab label="Vue" value="vue">
-
-To use nested content in Vue components, retrieve it via the `useIntlayer` hook. Here's an example:
-
-```vue fileName="**/*.vue"
-<script setup lang="ts">
-import { useIntlayer } from "vue-intlayer";
-
-const { fullNestedContent, partialNestedContent } = useIntlayer(
-  "key_of_my_second_dictionary"
-);
-</script>
-
-<template>
-  <div>
-    <p>Full Nested Content: {{ JSON.stringify(fullNestedContent) }}</p>
-    <p>Partial Nested Value: {{ partialNestedContent }}</p>
-  </div>
-</template>
-```
-
-  </Tab>
-  <Tab label="Svelte" value="svelte">
-
-To use nested content in Svelte components, retrieve it via the `useIntlayer` hook. The store is accessed with `$`. Here's an example:
-
-```svelte fileName="**/*.svelte"
-<script lang="ts">
-import { useIntlayer } from "svelte-intlayer";
-
-const content = useIntlayer("key_of_my_second_dictionary");
-</script>
-
-<div>
-  <p>Full Nested Content: {JSON.stringify($content.fullNestedContent)}</p>
-  <p>Partial Nested Value: {$content.partialNestedContent}</p>
-</div>
-```
-
-  </Tab>
-  <Tab label="Preact" value="preact">
-
-To use nested content in Preact components, retrieve it via the `useIntlayer` hook. Here's an example:
-
-```tsx fileName="**/*.tsx" codeFormat={["typescript", "esm"]}
-import type { FC } from "preact";
-import { useIntlayer } from "preact-intlayer";
-
-const NestComponent: FC = () => {
-  const { fullNestedContent, partialNestedContent } = useIntlayer(
-    "key_of_my_second_dictionary"
-  );
-
-  return (
-    <div>
-      <p>Full Nested Content: {JSON.stringify(fullNestedContent)}</p>
-      <p>Partial Nested Value: {partialNestedContent}</p>
-    </div>
-  );
-};
-
-export default NestComponent;
+```json fileName="firstDictionary.content.json" contentDeclarationFormat="json"
+{
+  "$schema": "https://intlayer.org/schema.json",
+  "key": "key_of_my_first_dictionary",
+  "content": {
+    "content": "content",
+    "subContent": {
+      "contentNumber": 0,
+      "contentString": "string"
+    }
+  }
+}
 ```
 
-  </Tab>
-  <Tab label="Solid" value="solid">
+### Ссылка с Nest
 
-To use nested content in SolidJS components, retrieve it via the `useIntlayer` hook. Here's an example:
+Теперь создайте еще один модуль содержимого, который использует функцию `nest` для ссылки на приведенное выше содержимое. Вы можете ссылаться на все содержимое или на конкретное вложенное значение:
 
-```tsx fileName="**/*.tsx" codeFormat={["typescript", "esm"]}
-import type { Component } from "solid-js";
-import { useIntlayer } from "solid-intlayer";
+```typescript fileName="secondDictionary.content.ts" contentDeclarationFormat={["typescript", "esm", "commonjs"]}
+import { nest, type Dictionary } from "intlayer";
 
-const NestComponent: Component = () => {
-  const { fullNestedContent, partialNestedContent } = useIntlayer(
-    "key_of_my_second_dictionary"
-  );
+const myNestingContent = {
+  key: "key_of_my_second_dictionary",
+  content: {
+    // Ссылается на весь словарь:
+    fullNestedContent: nest("key_of_my_first_dictionary"),
+    // Ссылается на конкретное вложенное значение:
+    partialNestedContent: nest(
+      "key_of_my_first_dictionary",
+      "subContent.contentNumber"
+    ),
+  },
+} satisfies Dictionary;
 
-  return (
-    <div>
-      <p>Full Nested Content: {JSON.stringify(fullNestedContent)}</p>
-      <p>Partial Nested Value: {partialNestedContent}</p>
-    </div>
-  );
-};
-
-export default NestComponent;
+export default myNestingContent;
 ```
 
-  </Tab>
-  <Tab label="Angular" value="angular">
-
-To use nested content in Angular components, retrieve it via the `useIntlayer` hook. Here's an example:
-
-```typescript fileName="app.component.ts" codeFormat="typescript"
-import { Component } from "@angular/core";
-import { useIntlayer } from "angular-intlayer";
-
-@Component({
-  selector: "app-nest",
-  template: `
-    <div>
-      <p>
-        Full Nested Content: {{ JSON.stringify(content().fullNestedContent) }}
-      </p>
-      <p>Partial Nested Value: {{ content().partialNestedContent }}</p>
-    </div>
-  `,
-})
-export class NestComponent {
-  content = useIntlayer("key_of_my_second_dictionary");
-  JSON = JSON;
+```json fileName="secondDictionary.content.json" contentDeclarationFormat="json"
+{
+  "$schema": "https://intlayer.org/schema.json",
+  "key": "key_of_my_second_dictionary",
+  "content": {
+    "fullNestedContent": {
+      "nodeType": "nested",
+      "nested": {
+        "dictionaryKey": "key_of_my_first_dictionary"
+      }
+    },
+    "partialNestedContent": {
+      "nodeType": "nested",
+      "nested": {
+        "dictionaryKey": "key_of_my_first_dictionary",
+        "path": "subContent.contentNumber"
+      }
+    }
+  }
 }
 ```
 
-  </Tab>
-  <Tab label="Vanilla JS" value="vanilla">
-
-To use nested content with `vanilla-intlayer`, retrieve it via the `useIntlayer` hook. Here's an example:
-
-```typescript fileName="**/*.ts" codeFormat={["typescript", "esm"]}
-import { installIntlayer, useIntlayer } from "vanilla-intlayer";
-
-installIntlayer();
+Как второй параметр можно указать путь к вложенному значению внутри этого содержимого. Если путь не предоставлен, будет возвращено все содержимое из указанного словаря.
 
-const content = useIntlayer("key_of_my_second_dictionary").onChange(
-  (newContent) => {
-    document.getElementById("nested")!.textContent =
-      newContent.partialNestedContent;
-  }
-);
-
-// Initial render
-document.getElementById("nested")!.textContent = content.partialNestedContent;
-```
-
-  </Tab>
-</Tabs>
 ## Настройка вложенности
 
 <Tabs group="framework">
@@ -416,36 +305,6 @@ document.getElementById("nested")!.textContent = content.partialNestedContent;
   </Tab>
 </Tabs>
 
-## Использование вложенности с React Intlayer
-
-Чтобы использовать вложенный контент в React-компоненте, используйте хук `useIntlayer` из пакета `react-intlayer`. Этот хук извлекает правильный контент на основе указанного ключа. Вот пример его использования:
-
-```tsx fileName="**/*.tsx" codeFormat={["typescript", "esm"]}
-import type { FC } from "react";
-import { useIntlayer } from "react-intlayer";
-
-const NestComponent: FC = () => {
-  const { fullNestedContent, partialNestedContent } = useIntlayer(
-    "key_of_my_second_dictionary"
-  );
-
-  return (
-    <div>
-      <p>
-        Полный вложенный контент: {JSON.stringify(fullNestedContent)}
-        {/* Вывод: {"content": "content", "subContent": {"contentNumber": 0, "contentString": "string"}} */}
-      </p>
-      <p>
-        Частичное вложенное значение: {partialNestedContent}
-        {/* Вывод: 0 */}
-      </p>
-    </div>
-  );
-};
-
-export default NestComponent;
-```
-
 ## Дополнительные ресурсы
 
 Для получения более подробной информации о настройке и использовании обратитесь к следующим ресурсам:

package/docs/ru/formatters.md

@@ -46,34 +46,6 @@ author: aymericzip
 
 Intlayer предоставляет набор лёгких помощников, построенных поверх нативных API `Intl`, а также кешированный обёртку `Intl`, чтобы избежать многократного создания тяжёлых форматтеров. Эти утилиты полностью учитывают локаль и могут использоваться из основного пакета `intlayer`.
 
-### Импорт
-
-```ts
-import {
-  Intl,
-  number,
-  percentage,
-  currency,
-  date,
-  relativeTime,
-  units,
-  compact,
-  list,
-  getLocaleName,
-  getLocaleLang,
-  getLocaleFromPath,
-  getPathWithoutLocale,
-  getLocalizedUrl,
-  getHTMLTextDir,
-  getContent,
-  getTranslation,
-  getIntlayer,
-  getIntlayerAsync,
-} from "intlayer";
-```
-
-Если вы используете React, хуки также доступны; смотрите `react-intlayer/format`.
-
 ## Кешированный Intl
 
 Экспортируемый `Intl`, это тонкая кешированная обёртка вокруг глобального `Intl`. Он мемоизирует экземпляры `NumberFormat`, `DateTimeFormat`, `RelativeTimeFormat`, `ListFormat`, `DisplayNames`, `Collator` и `PluralRules`, что позволяет избежать повторного создания одного и того же форматтера.
@@ -110,9 +82,7 @@ pluralRules.select(1); // "one"
 pluralRules.select(2); // "other"
 ```
 
-## Дополнительные утилиты Intl
-
-Помимо помощников для форматтеров, вы также можете использовать кешированную обёртку Intl напрямую для других возможностей Intl:
+## React Formatters
 
 ### `Intl.DisplayNames`
 
@@ -128,6 +98,22 @@ const regionNames = new Intl.DisplayNames("fr", { type: "region" });
 regionNames.of("US"); // "États-Unis"
 ```
 
+### Доступные Hooks
+
+Все hooks автоматически используют локаль из `IntlayerProvider` или `IntlayerServerProvider`.
+
+| Hook                | Description                                 | Example Output                |
+| ------------------- | ------------------------------------------- | ----------------------------- |
+| `useNumber()`       | Форматирование чисел с разделением          | `"123,456.789"`               |
+| `useCurrency()`     | Форматирование значений валют               | `"€1,234.50"`                 |
+| `usePercentage()`   | Форматирование процентов                    | `"25%"`                       |
+| `useDate()`         | Форматирование дат и времени                | `"Aug 2, 2025"`               |
+| `useRelativeTime()` | Форматирование относительного времени       | `"in 3 days"`                 |
+| `useUnit()`         | Форматирование значений с единицами         | `"5 kilometers"`              |
+| `useCompact()`      | Форматирование чисел в сокращенной форме    | `"1.2K"`                      |
+| `useList()`         | Форматирование массивов как списки          | `"apple, banana, and orange"` |
+| `useIntl()`         | Получить привязанный к локали объект `Intl` | Full `Intl` API access        |
+
 ### `Intl.Collator`
 
 Для локализованного сравнения и сортировки строк:
@@ -286,127 +272,111 @@ getLocaleLang("de"); // "de"
 
 ### Функции форматирования
 
-### `getLocaleFromPath(inputUrl)`
+#### `number(value, options?)`
 
-Извлекает сегмент локали из URL или пути:
+Форматирует числовое значение с учётом локали, используя локализованные разделители групп и десятичные разделители.
 
-```ts
-import { getLocaleFromPath } from "intlayer";
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
 
-getLocaleFromPath("/en/dashboard"); // "en"
-getLocaleFromPath("/fr/dashboard"); // "fr"
-getLocaleFromPath("/dashboard"); // "en" (локаль по умолчанию)
-getLocaleFromPath("https://example.com/es/about"); // "es"
+```ts
+number(123456.789); // "123,456.789" (в en-US)
+number("1000000", { locale: "fr" }); // "1 000 000"
+number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
 ```
 
-- **inputUrl**: Полная строка URL или путь для обработки
-- **returns**: Обнаруженная локаль или локаль по умолчанию, если локаль не найдена
+#### `percentage(value, options?)`
 
-### `getPathWithoutLocale(inputUrl, locales?)`
+Форматирует число как строку процента. Значения больше 1 нормализуются (например, `25` → `25%`, `0.25` → `25%`).
 
-Удаляет сегмент локали из URL или пути:
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
 
 ```ts
-import { getPathWithoutLocale } from "intlayer";
-
-getPathWithoutLocale("/en/dashboard"); // "/dashboard"
-getPathWithoutLocale("/fr/dashboard"); // "/dashboard"
-getPathWithoutLocale("https://example.com/en/about"); // "https://example.com/about"
+percentage(0.25); // "25%"
+percentage(25); // "25%"
+percentage(0.237, { minimumFractionDigits: 1 }); // "23.7%"
 ```
 
-- **inputUrl**: Полная строка URL или путь для обработки
-- **locales**: Необязательный массив поддерживаемых локалей (по умолчанию используется настроенный список локалей)
-- **returns**: URL без сегмента локали
+#### `currency(value, options?)`
 
-### `getLocalizedUrl(url, currentLocale, locales?, defaultLocale?, prefixDefault?)`
+Форматирует значение как локализованную валюту. По умолчанию `USD`.
 
-Генерирует локализованный URL для текущей локали:
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+  - Common: `currency`, `currencyDisplay` (`"symbol" | "code" | "name"`)
 
 ```ts
-import { getLocalizedUrl } from "intlayer";
-
-getLocalizedUrl("/about", "fr", ["en", "fr"], "en", false); // "/fr/about"
-getLocalizedUrl("/about", "en", ["en", "fr"], "en", false); // "/about"
-getLocalizedUrl("https://example.com/about", "fr", ["en", "fr"], "en", true); // "https://example.com/fr/about"
+currency(1234.5, { currency: "EUR" }); // "€1,234.50"
+currency("5000", { locale: "fr", currency: "CAD", currencyDisplay: "code" }); // "5 000,00 CAD"
 ```
 
-- **url**: Исходный URL для локализации
-- **currentLocale**: Текущая локаль
-- **locales**: Необязательный массив поддерживаемых локалей (по умолчанию используется настроенный список локалей)
-- **defaultLocale**: Необязательная локаль по умолчанию (по умолчанию используется настроенная локаль по умолчанию)
-- **prefixDefault**: Добавлять ли префикс для локали по умолчанию (по умолчанию используется настроенное значение)
+#### `date(date, optionsOrPreset?)`
 
-### `getHTMLTextDir(locale?)`
+Форматирует значение даты/времени.
 
-Возвращает направление текста для локали:
+- **date**: `Date | string | number`
+- **optionsOrPreset**: `Intl.DateTimeFormatOptions & { locale?: LocalesValues }` или preset: `"short" | "long" | "dateOnly" | "timeOnly" | "full"`
 
 ```ts
-import { getHTMLTextDir } from "intlayer";
-
-getHTMLTextDir("en-US"); // "ltr"
-getHTMLTextDir("ar"); // "rtl"
-getHTMLTextDir("he"); // "rtl"
+date(new Date(), "short"); // например, "08/02/25, 14:30"
+date("2025-08-02T14:30:00Z", { locale: "fr", month: "long", day: "numeric" }); // "2 août"
 ```
 
-- **locale**: Локаль, для которой нужно получить направление текста (по умолчанию текущая локаль)
-- **returns**: `"ltr"`, `"rtl"` или `"auto"`
+#### `relativeTime(from, to?, options?)`
 
-## Утилиты для обработки контента
+Форматирует относительное время между двумя моментами.
 
-### `getContent(node, nodeProps, locale?)`
-
-Преобразует узел контента со всеми доступными плагинами (перевод, перечисление, вставка и т.д.):
+- **from**: `Date | string | number`
+- **to**: `Date | string | number` (по умолчанию `new Date()`)
+- **options**: `{ locale?, unit?, numeric?, style? }`
 
 ```ts
-import { getContent } from "intlayer";
+const now = new Date();
+const in3Days = new Date(now.getTime() + 3 * 864e5);
+relativeTime(now, in3Days, { unit: "day" }); // "через 3 дня"
 
-const content = getContent(
-  contentNode,
-  { dictionaryKey: "common", dictionaryPath: "/path/to/dict" },
-  "fr"
-);
+const twoHoursAgo = new Date(now.getTime() - 2 * 3600e3);
+relativeTime(now, twoHoursAgo, { unit: "hour", numeric: "auto" }); // "2 часа назад"
 ```
 
-- **node**: Узел контента для преобразования
-- **nodeProps**: Свойства для контекста преобразования
-- **locale**: Необязательная локаль (по умолчанию используется настроенная локаль по умолчанию)
+#### `units(value, options?)`
 
-### `getTranslation(languageContent, locale?, fallback?)`
+Форматирует числовое значение с единицей измерения.
 
-Извлекает контент для конкретной локали из объекта с языковым содержимым:
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+  - Common: `unit` (например, `"kilometer"`, `"byte"`), `unitDisplay` (`"short" | "narrow" | "long"`)
 
 ```ts
-import { getTranslation } from "intlayer";
-
-const content = getTranslation(
-  {
-    en: "Hello",
-    fr: "Bonjour",
-    de: "Hallo",
-  },
-  "fr",
-  true
-); // "Bonjour"
+units(5, { unit: "kilometer", unitDisplay: "long", locale: "en-GB" }); // "5 kilometers"
+units(1024, { unit: "byte", unitDisplay: "narrow" }); // "1,024B"
 ```
 
-- **languageContent**: Объект, сопоставляющий локали с контентом
-- **locale**: Целевая локаль (по умолчанию используется настроенная локаль по умолчанию)
-- **fallback**: Использовать ли резервный вариант с локалью по умолчанию (по умолчанию true)
+#### `compact(value, options?)`
 
-### `getIntlayer(dictionaryKey, locale?, plugins?)`
+Форматирует число с использованием компактной нотации.
 
-Получает и преобразует контент из словаря по ключу:
+- **value**: `number | string`
+- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
 
 ```ts
-import { getIntlayer } from "intlayer";
-
-const content = getIntlayer("common", "fr");
-const nestedContent = getIntlayer("common", "fr", customPlugins);
+compact(1200); // "1.2K"
+compact("1000000", { locale: "fr", compactDisplay: "long" }); // "1 million"
 ```
 
-- **dictionaryKey**: Ключ словаря для получения
-- **locale**: Необязательная локаль (по умолчанию используется настроенная локаль по умолчанию)
-- **plugins**: Необязательный массив пользовательских плагинов трансформации
+#### `list(values, options?)`
+
+Форматирует массив в локализованную строку списка.
+
+- **values**: `(string | number)[]`
+- **options**: `Intl.ListFormatOptions & { locale?: LocalesValues }`
+  - Common: `type` (`"conjunction" | "disjunction" | "unit"`), `style` (`"long" | "short" | "narrow"`)
+
+```ts
+list(["apple", "banana", "orange"]); // "apple, banana, and orange"
+list(["red", "green", "blue"], { locale: "fr", type: "disjunction" }); // "rouge, vert ou bleu"
+```
 
 ## Cached Intl
 
@@ -438,39 +408,49 @@ pluralRules.select(2); // "other"
 
 ### Дополнительные возможности Intl
 
-### `getIntlayerAsync(dictionaryKey, locale?, plugins?)`
+#### `Intl.DisplayNames`
 
-Асинхронно получает контент из удалённого словаря:
+Для локализованных названий языков, регионов, валют и письменностей:
 
 ```ts
-import { getIntlayerAsync } from "intlayer";
+import { Intl } from "intlayer";
 
-const content = await getIntlayerAsync("common", "fr");
+const languageNames = new Intl.DisplayNames("en", { type: "language" });
+languageNames.of("fr"); // "French"
+
+const regionNames = new Intl.DisplayNames("fr", { type: "region" });
+regionNames.of("US"); // "États-Unis"
 ```
 
-- **dictionaryKey**: Ключ словаря для получения
-- **locale**: Необязательная локаль (по умолчанию используется настроенная локаль по умолчанию)
-- **plugins**: Необязательный массив пользовательских плагинов трансформации
+#### `Intl.Collator`
 
-## Форматтеры
+Для локализованного сравнения и сортировки строк:
 
-Все ниже перечисленные помощники экспортируются из `intlayer`.
+```ts
+import { Intl } from "intlayer";
 
-### `number(value, options?)`
+const collator = new Intl.Collator("de", {
+  sensitivity: "base",
+  numeric: true,
+});
 
-Форматирует числовое значение с учетом локали, группировки и десятичных знаков.
+const words = ["äpfel", "zebra", "100", "20"];
+words.sort(collator.compare); // ["20", "100", "äpfel", "zebra"]
+```
 
-- **value**: `number | string`
-- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
+#### `Intl.PluralRules`
 
-Примеры:
+Для определения форм множественного числа в разных локалях:
 
 ```ts
-import { number } from "intlayer";
+import { Intl } from "intlayer";
 
-number(123456.789); // "123,456.789" (в en-US)
-number("1000000", { locale: "fr" }); // "1 000 000"
-number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
+const pluralRules = new Intl.PluralRules("ar");
+pluralRules.select(0); // "zero"
+pluralRules.select(1); // "one"
+pluralRules.select(2); // "two"
+pluralRules.select(3); // "few"
+pluralRules.select(11); // "many"
 ```
 
 ## Утилиты Локализации