@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/README.md

@@ -1,3 +1,331 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://intlayer.org" rel="">
+    <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.webp" width="60%" alt="Intlayer Logo" />
+  </a>
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<h1 align="center">
+  <strong>Per-component i18n</strong>
+</h1>
+
+<h2 align="center">
+  <strong>AI-powered translation. Visual Editor. Multilingual CMS.</strong>
+</h2>
+
+<br />
+
+<p align="center">
+  <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
+  <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
+  <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
+  <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
+  <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
+</p>
+<p align="center" style="margin-top:15px;">
+  <a href="https://www.npmjs.com/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/intlayer?style=for-the-badge&labelColor=FFFFFF&color=000000&logoColor=FFFFFF" alt="npm version" height="24"/></a>
+  <a href="https://github.com/aymericzip/intlayer/stargazers" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/stars/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logo=github&logoColor=FFD700" alt="GitHub Stars" height="24"/></a>
+  <a href="https://www.npmjs.org/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="monthly downloads" height="24"/></a>
+  <a href="https://github.com/aymericzip/intlayer/blob/main/LICENSE" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/license/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="license"/></a>
+  <a href="https://github.com/aymericzip/intlayer/commits/main" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/last-commit/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000&cacheSeconds=86400" alt="last commit"/>
+  </a>
+</p>
+
+![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+## What is Intlayer?
+
+Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
+
+Intlayer is a **modern i18n solution** for web and mobile apps.  
+It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
+
+With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
+
+## Keys benefits of Intlayer:
+
+| Feature                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.webp?raw=true" alt="Feature" width="700">                         | **Cross-Frameworks Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more.                                                                                                                                                                                                                                                                                                                                                                          |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.jpg?raw=true" alt="Feature" width="700">       | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content)                                                                                                                                                                                                                                                                                                                                      |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true" alt="Feature" width="700"> | **Per-Locale Content Declaration File**<br><br>Speed up your development by declaring your content once, before auto generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file)                                                                                                                                                                                                                                                                                                                    |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/compiler.webp?raw=true" alt="Feature" width="700">                           | **Compiler**<br><br>The Intlayer Compiler extract automatically the content from the components and generate the dictionary files.<br><br> - [Compiler](https://intlayer.org/doc/compiler)                                                                                                                                                                                                                                                                                                                                                            |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700">                      | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript)                                                                                                                                                                                                                                                                        |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true" alt="Feature" width="700">                         | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalization, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                                                                                                                                                                                |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true" alt="Feature" width="700">                   | **Simplified Content Retrieval**<br><br>No need to call your `t` function for each piece of content. Retrieve all your content directly using a single hook.<br><br> - [React integration](https://intlayer.org/doc/environment/create-react-app)                                                                                                                                                                                                                                                                                                     |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true" alt="Feature" width="700">                    | **Consistent Server Component Implementation**<br><br>Perfectly suited for Next.js server components, use the same implementation for both client and server components, no need to pass your `t` function across each server component. <br><br> - [Server Components](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code)                                                                                                                                                                                              |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true" alt="Feature" width="700">                           | **Organized Codebase**<br><br>Keep your codebase more organized: 1 component = 1 dictionary in the same folder. Translations close to their respective components, enhance maintainability and clarity. <br><br> - [How Intlayer works](https://intlayer.org/doc/concept/how-works-intlayer)                                                                                                                                                                                                                                                          |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true" alt="Feature" width="700">                         | **Enhanced Routing**<br><br>Full support of app routing, adapting seamlessly to complex application structures, for Next.js, React, Vite, Vue.js, etc.<br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                                                                                                                                                                                                           |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true" alt="Feature" width="700">                            | **Markdown Support**<br><br>Import and interpret, locale files and remote Markdown for multilingual content like privacy policies, documentation, etc. Interpret and make Markdown metadata accessible in your code.<br><br> - [Content files](https://intlayer.org/doc/concept/content/file)                                                                                                                                                                                                                                                         |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.webp?raw=true" alt="Feature" width="700">                      | **Free Visual Editor & CMS**<br><br>A free visual editor and CMS are available for content writers, removing the need for a localization platform. Keep your content synchronized using Git, or externalize it totally or partially with the CMS.<br><br> - [Intlayer Editor](https://intlayer.org/doc/concept/editor) <br> - [Intlayer CMS](https://intlayer.org/doc/concept/cms)                                                                                                                                                                    |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.webp?raw=true" alt="Feature" width="700">                             | **Tree-shakable Content**<br><br>Tree-shakable content, reducing the size of the final bundle. Loads content per component, excluding any unused content from your bundle. Supports lazy loading to enhance app loading efficiency. <br><br> - [App build optimization](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization)                                                                                                                                                                                                   |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.webp?raw=true" alt="Feature" width="700">                   | **Static Rendering**<br><br>Doesn't block Static Rendering. <br><br> - [Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                                                                                                                                                                                                                                                                                                             |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true" alt="Feature" width="700">                      | **AI-Powered Translation**<br><br>Transform your website into 231 languages with just one click using Intlayer's advanced AI-powered translation tools using your own AI provider / API key. <br><br> - [CI/CD integration](https://intlayer.org/doc/concept/ci-cd) <br> - [Intlayer CLI](https://intlayer.org/doc/concept/cli) <br> - [Auto fill](https://intlayer.org/doc/concept/auto-fill)                                                                                                                                                        |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true" alt="Feature" width="700">                                 | **MCP Server Integration**<br><br>Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. <br><br> - [MCP Server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)                                                                                                                                                                                                                                      |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.webp?raw=true" alt="Feature" width="700">                   | **VSCode Extension**<br><br>Intlayer provides a VSCode extension to help you manage your content and translations, building your dictionaries, translating your content, and more. <br><br> - [VSCode Extension](https://intlayer.org/doc/vs-code-extension)                                                                                                                                                                                                                                                                                          |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true" alt="Feature" width="700">                    | **Interoperability**<br><br>Allow interoperability with react-i18next, next-i18next, next-intl, react-intl, vue-i18n. <br><br> - [Intlayer and react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer and next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer and next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next) <br> - [Intlayer and vue-i18n](https://intlayer.org/blog/intlayer-with-vue-i18n) <br> - [Intlayer compat adapters](https://intlayer.org/doc/compatibility) |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/benchmark.png?raw=true" alt="Feature" width="700">                           | **Performances & Benchmark**<br><br>Uses advanced tree-shaking and dynamic loading to boost performances and keep the solution as light as possible. <br><br> - [Performances & Benchmark](https://intlayer.org/doc/benchmark)                                                                                                                                                                                                                                                                                                                        |
+
+## 📦 Installation
+
+Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+```bash
+npm install intlayer react-intlayer
+```
+
+⚡ Quick Start (Next.js)
+
+```ts
+// intlayer.config.ts
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```ts
+// app/home.content.ts
+import { t, type Dictionary } from "intlayer";
+
+const content = {
+  key: "home",
+  content: {
+    title: t({
+      en: "Home",
+      fr: "Accueil",
+      es: "Inicio",
+    }),
+  },
+} satisfies Dictionary;
+
+export default content;
+```
+
+```tsx
+// app/page.tsx
+import { useIntlayer } from "react-intlayer";
+
+const HomePage = () => {
+  const { title } = useIntlayer("home");
+
+  return <h1>{title}</h1>;
+};
+```
+
+<a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
+
+## 🎥 Live tutorial on YouTube
+
+[![How to Internationalize your application using Intlayer](https://i.ytimg.com/vi/e_PPG7PTqGU/hqdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLDtyJ4uYotEjl12nZ_gZKZ_kjEgOQ)](https://youtu.be/e_PPG7PTqGU?si=GyU_KpVhr61razRw)
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+## Table of Contents
+
+Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
+  <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
+  <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
+  <li><a href="https://intlayer.org/doc/compiler" rel=''>Compiler</a></li>
+
+  <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
+  <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/concept/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
+    </ul>
+  </li>
+</ul>
+</details>
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 16</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/15" rel=''>Next.js 15</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-page-router" rel=''>Next.js Page Router</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/compiler" rel=''>Next.js using Compiler</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React using Compiler</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react/react-router-v7" rel=''>React-router-v7</a></li>
+  <li><a href="https://intlayer.org/doc/environment/remix-3" rel=''>Remix 3</a></li>
+  <li><a href="https://intlayer.org/doc/environment/tanstack-start" rel=''>Tanstack start</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/tanstack-start/solid" rel=''>Solid</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/astro" rel=''>Astro</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/astro/react" rel=''>React</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/vue" rel=''>Vue</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/svelte" rel=''>Svelte</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/solid" rel=''>Solid</a></li>
+      <li><a href="https://intlayer.org/doc/environment/astro/lit" rel=''>Lit</a></li>
+    </ul>
+  </li>
+
+  <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
+  <li><a href="https://intlayer.org/doc/environment/sveltekit" rel=''>SvelteKit</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
+  <li><a href="https://intlayer.org/doc/environment/nuxt-and-vue" rel=''>Vite + Nuxt</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
+  <li><a href="https://intlayer.org/doc/environment/solid-start" rel=''>Solid Start</a></li>
+  <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
+  <li>
+     <a href="https://intlayer.org/doc/environment/express" rel=''>Backend</a>
+     <ul>
+      <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
+      <li><a href="https://intlayer.org/doc/environment/fastify" rel=''>Fastify</a></li>
+      <li><a href="https://intlayer.org/doc/environment/adonisjs" rel=''>AdonisJS</a></li>
+      <li><a href="https://intlayer.org/doc/environment/hono" rel=''>Hono</a></li>
+      <li><a href="https://intlayer.org/doc/environment/elysia" rel=''>Elysia</a></li>
+    </ul>
+
+  </li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">📊 Benchmark</summary>
+<ul>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/nextjs.md" rel=''>Next.js</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/tanstack.md" rel=''>TanStack Start</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/vue.md" rel=''>Vue</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/solid.md" rel=''>Solid</a></li>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/benchmark/svelte.md" rel=''>Svelte</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
+<ul>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
+  <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
+</ul>
+</details>
+
+## Multilingual content management system
+
+More than an i18n library, Intlayer is a complete **multilingual content management system**. A full CMS is available for free at [app.intlayer.org](https://app.intlayer.org).
+
+Intlayer connects **developers**, **copywriters**, and **AI agents** in one workflow for creating and maintaining multilingual websites effortlessly.Intlayer replaces the following stack in a single solution:
+
+- i18n solutions (e.g. `i18next`, `next-intl`, `vue-i18n`)
+- TMSs (Translation Management Systems) (e.g. Crowdin, Phrase, Lokalise)
+- Feature flags
+- Headless CMSs (e.g. Contentful, Strapi, Sanity)
+
+![CMS Preview](https://github.com/aymericzip/intlayer/blob/main/docs/assets/CMS.webp?raw=true)
+
+## 🌐 Readme in other languages
+
+<p align="center">
+  <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
+</p>
+
+## 🤝 Community
+
+Intlayer is built with and for the community and we’d love your input!
+
+- Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
+- Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
+- Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
+
+You can also follow us on :
+
+  <div>
+    <br/>
+    <p align="center">
+      <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
+         alt="Intlayer Discord" height="30"/></a>
+      <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
+         alt="Intlayer LinkedIn" height="30"/></a>
+      <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
+         alt="Intlayer Instagram" height="30"/></a>
+      <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
+         alt="Intlayer X" height="30"/></a>
+      <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
+         alt="Intlayer YouTube" height="30"/></a>
+      <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
+         alt="Intlayer TikTok" height="30"/></a>
+      <br>
+    </p>
+</div>
+
+### Contribution
+
+For more detailed guidelines on contributing to this project, please refer to the [`CONTRIBUTING.md`](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md) file. It contains essential information on our development process, commit message conventions, and release procedures. Your contributions are valuable to us, and we appreciate your efforts in making this project better!
+
+Contribute on [GitHub](https://github.com/aymericzip/intlayer), [GitLab](https://gitlab.com/ay.pineau/intlayer), or [Bitbucket](https://bitbucket.org/intlayer/intlayer/).
+
+### Thank You for the Support
+
+If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project! [See why GitHub Stars matter](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md#why-github-stars-matter-).
+
+[![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)

package/dist/cjs/ai.cjs

@@ -0,0 +1,267 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+const require_common = require('./common.cjs');
+const require_tag = require('./tag.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/ai.ts
+const aiOptionsSchema = require_common.typedValueSchema(require_common.isJSONObject);
+/** Chat message exchanged with the assistants. */
+const chatCompletionRequestMessageSchema = zod_mini.z.object({
+	role: zod_mini.z.enum([
+		"system",
+		"user",
+		"assistant"
+	]),
+	content: zod_mini.z.string(),
+	/** ISO date-time, parsed to a `Date`. */
+	timestamp: zod_mini.z.optional(zod_mini.z.pipe(zod_mini.z.string(), zod_mini.z.transform((value) => new Date(value))))
+});
+const localeSchema = require_common.typedStringSchema();
+const tokenUsedShape = { tokenUsed: zod_mini.z.number() };
+/** Text result of an AI step (translation, audit, query). */
+const fileContentResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.string(),
+	...tokenUsedShape
+});
+/** Tag fields rewritten by the tag audit (parsed from the model's JSON). */
+const tagAuditResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.looseObject({
+		key: zod_mini.z.optional(zod_mini.z.string()),
+		name: zod_mini.z.optional(zod_mini.z.string()),
+		description: zod_mini.z.optional(zod_mini.z.string()),
+		instructions: zod_mini.z.optional(zod_mini.z.string())
+	}),
+	...tokenUsedShape
+});
+const metadataResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.object({
+		title: zod_mini.z.string(),
+		description: zod_mini.z.string(),
+		tags: zod_mini.z.array(zod_mini.z.string())
+	}),
+	...tokenUsedShape
+});
+/** JSON document translated by the AI. */
+const jsonContentSchema = require_common.typedValueSchema();
+const tokenUsageSchema = zod_mini.z.object({
+	inputTokens: zod_mini.z.number(),
+	outputTokens: zod_mini.z.number(),
+	totalTokens: zod_mini.z.number()
+});
+/** Message stored in a discussion. */
+const discussionMessageSchema = zod_mini.z.object({
+	role: zod_mini.z.enum([
+		"user",
+		"assistant",
+		"system"
+	]),
+	content: zod_mini.z.string(),
+	relatedFiles: zod_mini.z.optional(zod_mini.z.array(zod_mini.z.string())),
+	timestamp: require_common.dateTimeSchema
+});
+/** Saved AI discussion (doc assistant or dashboard chat). */
+const discussionSchema = zod_mini.z.looseObject({
+	id: zod_mini.z.string(),
+	/** Generated by the client before the discussion is saved. */
+	discussionId: zod_mini.z.string(),
+	messages: zod_mini.z.optional(zod_mini.z.array(discussionMessageSchema)),
+	numberOfMessages: zod_mini.z.number(),
+	userId: zod_mini.z.optional(zod_mini.z.string()),
+	projectId: zod_mini.z.optional(zod_mini.z.string()),
+	organizationId: zod_mini.z.optional(zod_mini.z.string()),
+	title: zod_mini.z.optional(zod_mini.z.string()),
+	type: zod_mini.z.optional(zod_mini.z.enum(["doc", "dashboard"])),
+	isArchived: zod_mini.z.boolean(),
+	aiModel: zod_mini.z.optional(zod_mini.z.string()),
+	tokenUsage: zod_mini.z.optional(tokenUsageSchema),
+	createdAt: require_common.dateTimeSchema,
+	updatedAt: require_common.dateTimeSchema
+});
+/** Token usage of the project's dashboard discussions, per model. */
+const aiStatsSchema = zod_mini.z.object({
+	projectId: zod_mini.z.string(),
+	generatedAt: zod_mini.z.number(),
+	totalDiscussions: zod_mini.z.number(),
+	totalInputTokens: zod_mini.z.number(),
+	totalOutputTokens: zod_mini.z.number(),
+	totalTokens: zod_mini.z.number(),
+	modelUsage: zod_mini.z.array(zod_mini.z.object({
+		aiModel: zod_mini.z.string(),
+		discussionCount: zod_mini.z.number(),
+		totalInputTokens: zod_mini.z.number(),
+		totalOutputTokens: zod_mini.z.number(),
+		totalTokens: zod_mini.z.number()
+	}))
+});
+const aiOptionsShape = { aiOptions: zod_mini.z.optional(aiOptionsSchema) };
+const tagsKeysShape = { tagsKeys: zod_mini.z.optional(zod_mini.z.array(zod_mini.z.string())) };
+const conversationSchema = zod_mini.z.object({
+	messages: zod_mini.z.array(chatCompletionRequestMessageSchema),
+	discussionId: zod_mini.z.string()
+});
+/** REST contract of the `/api/ai` routes. */
+const aiContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/ai",
+	tag: "AI",
+	routes: {
+		customQuery: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Run a custom prompt",
+			schemas: {
+				body: zod_mini.z.looseObject({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					/** AI SDK model messages. */
+					messages: require_common.typedValueSchema(Array.isArray),
+					system: zod_mini.z.optional(zod_mini.z.unknown()),
+					applicationContext: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(fileContentResultSchema) }
+			}
+		}),
+		translateJSON: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/translate/json",
+			summary: "Translate a JSON document into a locale",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					entryFileContent: jsonContentSchema,
+					presetOutputContent: jsonContentSchema,
+					dictionaryDescription: zod_mini.z.optional(zod_mini.z.string()),
+					entryLocale: localeSchema,
+					outputLocale: localeSchema,
+					mode: zod_mini.z.enum(["complete", "review"]),
+					applicationContext: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({
+					fileContent: jsonContentSchema,
+					...tokenUsedShape
+				})) }
+			}
+		}),
+		auditContentDeclaration: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary",
+			summary: "Audit and complete a content declaration file",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					locales: zod_mini.z.array(localeSchema),
+					defaultLocale: localeSchema,
+					fileContent: zod_mini.z.string(),
+					filePath: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(metadataResultSchema) }
+			}
+		}),
+		auditContentDeclarationField: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary/field",
+			summary: "Audit a single field of a content declaration",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					locales: zod_mini.z.array(localeSchema),
+					fileContent: zod_mini.z.string(),
+					filePath: zod_mini.z.optional(zod_mini.z.string()),
+					keyPath: zod_mini.z.array(require_common.typedValueSchema())
+				}),
+				response: { 200: require_responseData.responseDataSchema(fileContentResultSchema) }
+			}
+		}),
+		auditContentDeclarationMetadata: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary/metadata",
+			summary: "Suggest title, description and tags of a dictionary",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					fileContent: zod_mini.z.string()
+				}),
+				response: { 200: require_responseData.responseDataSchema(metadataResultSchema) }
+			}
+		}),
+		auditTag: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/tag",
+			summary: "Improve the instructions of a tag",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					tag: require_tag.tagSchema
+				}),
+				response: { 200: require_responseData.responseDataSchema(tagAuditResultSchema) }
+			}
+		}),
+		ask: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/ask",
+			summary: "Ask the documentation assistant (server-sent events stream)",
+			schemas: { body: conversationSchema }
+		}),
+		chat: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/chat",
+			summary: "Chat with the dashboard assistant (server-sent events stream)",
+			schemas: { body: conversationSchema }
+		}),
+		autocomplete: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/autocomplete",
+			summary: "Autocomplete a text being written",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					text: zod_mini.z.string(),
+					contextBefore: zod_mini.z.optional(zod_mini.z.string()),
+					currentLine: zod_mini.z.optional(zod_mini.z.string()),
+					contextAfter: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({ autocompletion: zod_mini.z.string() })) }
+			}
+		}),
+		getDiscussions: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/discussions",
+			summary: "List AI discussions (own ones, all for admins)",
+			schemas: {
+				querystring: zod_mini.z.looseObject({
+					...require_common.paginationQueryShape,
+					includeMessages: zod_mini.z.optional(zod_mini.z.enum(["true", "false"])),
+					ids: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					userId: zod_mini.z.optional(zod_mini.z.string()),
+					userIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					discussionId: zod_mini.z.optional(zod_mini.z.string()),
+					search: zod_mini.z.optional(zod_mini.z.string()),
+					isArchived: zod_mini.z.optional(zod_mini.z.enum(["true", "false"])),
+					sortBy: zod_mini.z.optional(zod_mini.z.string()),
+					sortOrder: zod_mini.z.optional(zod_mini.z.string()),
+					fetchAll: zod_mini.z.optional(zod_mini.z.enum(["true", "false"]))
+				}),
+				response: { 200: require_responseData.paginatedResponseSchema(discussionSchema) }
+			}
+		}),
+		getAIStats: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/stats",
+			summary: "AI token usage of the selected project",
+			schemas: { response: { 200: require_responseData.responseDataSchema(aiStatsSchema) } }
+		})
+	}
+});
+
+//#endregion
+exports.aiContract = aiContract;
+exports.aiOptionsSchema = aiOptionsSchema;
+exports.aiStatsSchema = aiStatsSchema;
+exports.chatCompletionRequestMessageSchema = chatCompletionRequestMessageSchema;
+exports.discussionMessageSchema = discussionMessageSchema;
+exports.discussionSchema = discussionSchema;
+//# sourceMappingURL=ai.cjs.map