react-intlayer 1.0.1 → 1.2.0

package/dist/esm/index.d.mts

@@ -1,5 +1,5 @@
 export { getTranslation } from './getTranslation.mjs';
-export { LocaleClientContext, LocaleClientContextProvider, LocaleClientContextProviderProps, useLocaleContext } from './client/LocaleClientContextProvider.mjs';
+export { IntlayerClientContext as IntlayerClient, IntlayerClientProvider, IntlayerClientProviderProps } from './client/IntlayerClientProvider.mjs';
 export { useIntlayer } from './client/useIntlayer.mjs';
 export { useLocale } from './client/useLocale.mjs';
 export { useTraduction } from './client/useTraduction.mjs';

package/dist/esm/index.mjs

@@ -1,8 +1,7 @@
 import { getTranslation } from './getTranslation.mjs';
 import {
-  LocaleClientContextProvider,
-  LocaleClientContext,
-  useLocaleContext,
+  IntlayerClientProvider,
+  IntlayerClient,
   useIntlayer,
   useLocale,
   useTraduction,
@@ -11,14 +10,13 @@ import {
   setLocaleCookie
 } from './client/index.mjs';
 export {
-  LocaleClientContext,
-  LocaleClientContextProvider,
+  IntlayerClient,
+  IntlayerClientProvider,
   getTranslation,
   localeCookie,
   setLocaleCookie,
   useIntlayer,
   useLocale,
-  useLocaleContext,
   useLocaleCookie,
   useTraduction
 };

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export { getTranslation } from './getTranslation';\nexport {\n  LocaleClientContextProvider,\n  type LocaleClientContextProviderProps,\n  LocaleClientContext,\n  useLocaleContext,\n  useIntlayer,\n  useLocale,\n  useTraduction,\n  useLocaleCookie,\n  localeCookie,\n  setLocaleCookie,\n} from './client/index';\nexport {} from './client/useLocaleCookie';\n"],"mappings":"AAAA,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":[]}
+{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export { getTranslation } from './getTranslation';\nexport {\n  IntlayerClientProvider,\n  type IntlayerClientProviderProps,\n  IntlayerClient,\n  useIntlayer,\n  useLocale,\n  useTraduction,\n  useLocaleCookie,\n  localeCookie,\n  setLocaleCookie,\n} from './client/index';\nexport {} from './client/useLocaleCookie';\n"],"mappings":"AAAA,SAAS,sBAAsB;AAC/B;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;","names":[]}

package/dist/esm/processDictionary/index.d.mts

@@ -4,7 +4,7 @@ import '@intlayer/core';
 
 declare const processNode: (field: ContentValue | undefined, locale: Locales) => TransformedContentValue;
 /**
- * Function to replace the multi lingual content with content in the current locale
+ * Function that process a dictionary and return the result to be used in the application.
  */
 declare const processDictionary: (content: Content, locale?: Locales) => TransformedContent;
 

package/dist/esm/processDictionary/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/processDictionary/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport {\n  NodeType,\n  type QuantityContent,\n  type LanguageContent,\n} from '@intlayer/core';\nimport { getEnumeration } from '../getEnumeration';\nimport { getTranslation } from '../getTranslation';\nimport type {\n  Content,\n  ContentValue,\n  TransformedContent,\n  TransformedContentValue,\n} from './contentDictionary';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\nconst processTranslation = (\n  languageContent: LanguageContent<ContentValue>,\n  locale: Locales\n): TransformedContent => {\n  const translationResult: ContentValue = getTranslation<ContentValue>(\n    languageContent,\n    locale\n  );\n\n  return processDictionary(translationResult as Content, locale);\n};\n\nconst processEnumeration = (\n  enumerationContent: QuantityContent<ContentValue>,\n  locale: Locales\n): TransformedContentValue => {\n  return (quantity: number): TransformedContentValue => {\n    const enumerationResult: ContentValue = getEnumeration<ContentValue>(\n      enumerationContent,\n      quantity\n    );\n\n    //\n    return processDictionary(enumerationResult as Content, locale);\n  };\n};\n\nexport const processNode = (\n  field: ContentValue | undefined,\n  locale: Locales\n): TransformedContentValue => {\n  if (typeof field !== 'object' || field === null) {\n    return field;\n  }\n\n  if (field.nodeType === NodeType.Translation) {\n    return processTranslation(field as LanguageContent<ContentValue>, locale);\n  }\n\n  if (field.nodeType === NodeType.Enumeration) {\n    return processEnumeration(\n      field satisfies QuantityContent<ContentValue>,\n      locale\n    );\n  }\n\n  if (typeof (field as any).type === 'undefined') {\n    return processDictionary(field as Content, locale);\n  }\n\n  return field as TransformedContentValue;\n};\n\n/**\n * Function to replace the multi lingual content with content in the current locale\n */\nexport const processDictionary = (\n  content: Content,\n  locale: Locales = defaultLocale\n): TransformedContent => {\n  if (content && typeof content === 'object') {\n    const result: TransformedContent = {};\n\n    // List each key in the content and process it\n    for (const key of Object.keys(content)) {\n      const field = content[key];\n\n      result[key] = processNode(field, locale);\n    }\n\n    return result;\n  }\n\n  // If it's a string, number, or function, return it\n  return content;\n};\n"],"mappings":"AACA;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EACE;AAAA,OAGK;AACP,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAQ/B,MAAM,gBAAgB,0BAA0B;AAEhD,MAAM,qBAAqB,CACzB,iBACA,WACuB;AACvB,QAAM,oBAAkC;AAAA,IACtC;AAAA,IACA;AAAA,EACF;AAEA,SAAO,kBAAkB,mBAA8B,MAAM;AAC/D;AAEA,MAAM,qBAAqB,CACzB,oBACA,WAC4B;AAC5B,SAAO,CAAC,aAA8C;AACpD,UAAM,oBAAkC;AAAA,MACtC;AAAA,MACA;AAAA,IACF;AAGA,WAAO,kBAAkB,mBAA8B,MAAM;AAAA,EAC/D;AACF;AAEO,MAAM,cAAc,CACzB,OACA,WAC4B;AAC5B,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,aAAa,SAAS,aAAa;AAC3C,WAAO,mBAAmB,OAAwC,MAAM;AAAA,EAC1E;AAEA,MAAI,MAAM,aAAa,SAAS,aAAa;AAC3C,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,MAAI,OAAQ,MAAc,SAAS,aAAa;AAC9C,WAAO,kBAAkB,OAAkB,MAAM;AAAA,EACnD;AAEA,SAAO;AACT;AAKO,MAAM,oBAAoB,CAC/B,SACA,SAAkB,kBACK;AACvB,MAAI,WAAW,OAAO,YAAY,UAAU;AAC1C,UAAM,SAA6B,CAAC;AAGpC,eAAW,OAAO,OAAO,KAAK,OAAO,GAAG;AACtC,YAAM,QAAQ,QAAQ,GAAG;AAEzB,aAAO,GAAG,IAAI,YAAY,OAAO,MAAM;AAAA,IACzC;AAEA,WAAO;AAAA,EACT;AAGA,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../../src/processDictionary/index.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport {\n  NodeType,\n  type QuantityContent,\n  type LanguageContent,\n} from '@intlayer/core';\nimport { getEnumeration } from '../getEnumeration';\nimport { getTranslation } from '../getTranslation';\nimport type {\n  Content,\n  ContentValue,\n  TransformedContent,\n  TransformedContentValue,\n} from './contentDictionary';\n\nconst defaultLocale = intlayerIntlConfiguration.defaultLocale;\n\nconst processTranslation = (\n  languageContent: LanguageContent<ContentValue>,\n  locale: Locales\n): TransformedContent => {\n  const translationResult: ContentValue = getTranslation<ContentValue>(\n    languageContent,\n    locale\n  );\n\n  return processDictionary(translationResult as Content, locale);\n};\n\nconst processEnumeration = (\n  enumerationContent: QuantityContent<ContentValue>,\n  locale: Locales\n): TransformedContentValue => {\n  return (quantity: number): TransformedContentValue => {\n    const enumerationResult: ContentValue = getEnumeration<ContentValue>(\n      enumerationContent,\n      quantity\n    );\n\n    //\n    return processDictionary(enumerationResult as Content, locale);\n  };\n};\n\nexport const processNode = (\n  field: ContentValue | undefined,\n  locale: Locales\n): TransformedContentValue => {\n  if (typeof field !== 'object' || field === null) {\n    return field;\n  }\n\n  if (field.nodeType === NodeType.Translation) {\n    return processTranslation(field as LanguageContent<ContentValue>, locale);\n  }\n\n  if (field.nodeType === NodeType.Enumeration) {\n    return processEnumeration(\n      field satisfies QuantityContent<ContentValue>,\n      locale\n    );\n  }\n\n  if (typeof (field as any).type === 'undefined') {\n    return processDictionary(field as Content, locale);\n  }\n\n  return field as TransformedContentValue;\n};\n\n/**\n * Function that process a dictionary and return the result to be used in the application.\n */\nexport const processDictionary = (\n  content: Content,\n  locale: Locales = defaultLocale\n): TransformedContent => {\n  if (content && typeof content === 'object') {\n    const result: TransformedContent = {};\n\n    // List each key in the content and process it\n    for (const key of Object.keys(content)) {\n      const field = content[key];\n\n      result[key] = processNode(field, locale);\n    }\n\n    return result;\n  }\n\n  // If it's a string, number, or function, return it\n  return content;\n};\n"],"mappings":"AACA;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EACE;AAAA,OAGK;AACP,SAAS,sBAAsB;AAC/B,SAAS,sBAAsB;AAQ/B,MAAM,gBAAgB,0BAA0B;AAEhD,MAAM,qBAAqB,CACzB,iBACA,WACuB;AACvB,QAAM,oBAAkC;AAAA,IACtC;AAAA,IACA;AAAA,EACF;AAEA,SAAO,kBAAkB,mBAA8B,MAAM;AAC/D;AAEA,MAAM,qBAAqB,CACzB,oBACA,WAC4B;AAC5B,SAAO,CAAC,aAA8C;AACpD,UAAM,oBAAkC;AAAA,MACtC;AAAA,MACA;AAAA,IACF;AAGA,WAAO,kBAAkB,mBAA8B,MAAM;AAAA,EAC/D;AACF;AAEO,MAAM,cAAc,CACzB,OACA,WAC4B;AAC5B,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,WAAO;AAAA,EACT;AAEA,MAAI,MAAM,aAAa,SAAS,aAAa;AAC3C,WAAO,mBAAmB,OAAwC,MAAM;AAAA,EAC1E;AAEA,MAAI,MAAM,aAAa,SAAS,aAAa;AAC3C,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,MAAI,OAAQ,MAAc,SAAS,aAAa;AAC9C,WAAO,kBAAkB,OAAkB,MAAM;AAAA,EACnD;AAEA,SAAO;AACT;AAKO,MAAM,oBAAoB,CAC/B,SACA,SAAkB,kBACK;AACvB,MAAI,WAAW,OAAO,YAAY,UAAU;AAC1C,UAAM,SAA6B,CAAC;AAGpC,eAAW,OAAO,OAAO,KAAK,OAAO,GAAG;AACtC,YAAM,QAAQ,QAAQ,GAAG;AAEzB,aAAO,GAAG,IAAI,YAAY,OAAO,MAAM;AAAA,IACzC;AAEA,WAAO;AAAA,EACT;AAGA,SAAO;AACT;","names":[]}

package/dist/{cjs/server/LocaleServerContextProvider.d.ts → esm/server/IntlayerServerProvider.d.mts}

@@ -2,7 +2,10 @@ import * as react from 'react';
 import { PropsWithChildren, FC } from 'react';
 import { Locales } from '@intlayer/config/client';
 
-declare const LocaleServerContext: {
+/**
+ * Context that store the current locale on the server side
+ */
+declare const IntlayerServerContext: {
     Provider: ({ children, value, }: {
         children: react.ReactNode;
         value: Locales;
@@ -15,10 +18,20 @@ declare const LocaleServerContext: {
     };
     _defaultValue: Locales | undefined;
 };
+/**
+ * Hook that provides the current locale
+ */
+declare const useIntlayer: () => Locales | undefined;
+/**
+ * Get the current locale
+ */
 declare const locale: Locales | undefined;
-type LocaleServerContextProviderProps = PropsWithChildren & {
+type IntlayerServerProviderProps = PropsWithChildren & {
     locale: Locales;
 };
-declare const LocaleServerContextProvider: FC<LocaleServerContextProviderProps>;
+/**
+ * Provider that store the current locale on the server side
+ */
+declare const IntlayerServerProvider: FC<IntlayerServerProviderProps>;
 
-export { LocaleServerContext, LocaleServerContextProvider, type LocaleServerContextProviderProps, locale };
+export { IntlayerServerContext, IntlayerServerProvider, type IntlayerServerProviderProps, locale, useIntlayer };

package/dist/esm/server/IntlayerServerProvider.mjs

@@ -0,0 +1,21 @@
+import { jsx } from "react/jsx-runtime";
+import {
+  intlayerIntlConfiguration
+} from "@intlayer/config/client";
+import { createServerContext, getServerContext } from './serverContext.mjs';
+const IntlayerServerContext = createServerContext(
+  intlayerIntlConfiguration.defaultLocale
+);
+const useIntlayer = () => getServerContext(IntlayerServerContext);
+const locale = getServerContext(IntlayerServerContext);
+const IntlayerServerProvider = ({
+  children,
+  locale: locale2
+}) => /* @__PURE__ */ jsx(IntlayerServerContext.Provider, { value: locale2, children });
+export {
+  IntlayerServerContext,
+  IntlayerServerProvider,
+  locale,
+  useIntlayer
+};
+//# sourceMappingURL=IntlayerServerProvider.mjs.map

package/dist/esm/server/IntlayerServerProvider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/server/IntlayerServerProvider.tsx"],"sourcesContent":["import {\n  type Locales,\n  intlayerIntlConfiguration,\n} from '@intlayer/config/client';\nimport type { FC, PropsWithChildren } from 'react';\nimport { createServerContext, getServerContext } from './serverContext';\n\n/**\n * Context that store the current locale on the server side\n */\nexport const IntlayerServerContext = createServerContext<Locales>(\n  intlayerIntlConfiguration.defaultLocale\n);\n\n/**\n * Hook that provides the current locale\n */\nexport const useIntlayer = () => getServerContext(IntlayerServerContext);\n\n/**\n * Get the current locale\n */\nexport const locale = getServerContext(IntlayerServerContext);\n\nexport type IntlayerServerProviderProps = PropsWithChildren & {\n  locale: Locales;\n};\n\n/**\n * Provider that store the current locale on the server side\n */\nexport const IntlayerServerProvider: FC<IntlayerServerProviderProps> = ({\n  children,\n  locale,\n}) => (\n  <IntlayerServerContext.Provider value={locale}>\n    {children}\n  </IntlayerServerContext.Provider>\n);\n"],"mappings":"AAmCE;AAnCF;AAAA,EAEE;AAAA,OACK;AAEP,SAAS,qBAAqB,wBAAwB;AAK/C,MAAM,wBAAwB;AAAA,EACnC,0BAA0B;AAC5B;AAKO,MAAM,cAAc,MAAM,iBAAiB,qBAAqB;AAKhE,MAAM,SAAS,iBAAiB,qBAAqB;AASrD,MAAM,yBAA0D,CAAC;AAAA,EACtE;AAAA,EACA,QAAAA;AACF,MACE,oBAAC,sBAAsB,UAAtB,EAA+B,OAAOA,SACpC,UACH;","names":["locale"]}

package/dist/esm/server/getLocaleTranslation.d.mts

@@ -1,6 +1,9 @@
 import * as _intlayer_config_client from '@intlayer/config/client';
 import { LanguageContent } from '@intlayer/core';
 
+/**
+ * On the server side, get the translation content based on the locale
+ */
 declare const getLocaleTranslation: <Content>(languageContent: LanguageContent<Content>) => {
     locale: _intlayer_config_client.Locales | undefined;
     content: Content;

package/dist/esm/server/getLocaleTranslation.mjs

@@ -1,9 +1,9 @@
 import { intlayerIntlConfiguration } from "@intlayer/config/client";
 import { getTranslationContent } from "@intlayer/core";
-import { LocaleServerContext } from './LocaleServerContextProvider.mjs';
+import { IntlayerServerContext } from './IntlayerServerProvider.mjs';
 import { getServerContext } from './serverContext.mjs';
 const getLocaleTranslation = (languageContent) => {
-  const locale = getServerContext(LocaleServerContext);
+  const locale = getServerContext(IntlayerServerContext);
   const content = getTranslationContent(
     languageContent,
     locale ?? intlayerIntlConfiguration.defaultLocale

package/dist/esm/server/getLocaleTranslation.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/getLocaleTranslation.ts"],"sourcesContent":["import { intlayerIntlConfiguration } from '@intlayer/config/client';\nimport { type LanguageContent, getTranslationContent } from '@intlayer/core';\nimport { LocaleServerContext } from './LocaleServerContextProvider';\nimport { getServerContext } from './serverContext';\n\nexport const getLocaleTranslation = <Content>(\n  languageContent: LanguageContent<Content>\n) => {\n  const locale = getServerContext(LocaleServerContext);\n  const content = getTranslationContent<Content>(\n    languageContent,\n    locale ?? intlayerIntlConfiguration.defaultLocale\n  );\n\n  return {\n    locale,\n    content,\n  };\n};\n"],"mappings":"AAAA,SAAS,iCAAiC;AAC1C,SAA+B,6BAA6B;AAC5D,SAAS,2BAA2B;AACpC,SAAS,wBAAwB;AAE1B,MAAM,uBAAuB,CAClC,oBACG;AACH,QAAM,SAAS,iBAAiB,mBAAmB;AACnD,QAAM,UAAU;AAAA,IACd;AAAA,IACA,UAAU,0BAA0B;AAAA,EACtC;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../../src/server/getLocaleTranslation.ts"],"sourcesContent":["import { intlayerIntlConfiguration } from '@intlayer/config/client';\nimport { type LanguageContent, getTranslationContent } from '@intlayer/core';\nimport { IntlayerServerContext } from './IntlayerServerProvider';\nimport { getServerContext } from './serverContext';\n\n/**\n * On the server side, get the translation content based on the locale\n */\nexport const getLocaleTranslation = <Content>(\n  languageContent: LanguageContent<Content>\n) => {\n  const locale = getServerContext(IntlayerServerContext);\n  const content = getTranslationContent<Content>(\n    languageContent,\n    locale ?? intlayerIntlConfiguration.defaultLocale\n  );\n\n  return {\n    locale,\n    content,\n  };\n};\n"],"mappings":"AAAA,SAAS,iCAAiC;AAC1C,SAA+B,6BAA6B;AAC5D,SAAS,6BAA6B;AACtC,SAAS,wBAAwB;AAK1B,MAAM,uBAAuB,CAClC,oBACG;AACH,QAAM,SAAS,iBAAiB,qBAAqB;AACrD,QAAM,UAAU;AAAA,IACd;AAAA,IACA,UAAU,0BAA0B;AAAA,EACtC;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/dist/esm/server/index.d.mts

@@ -1,6 +1,6 @@
 export { getLocaleTranslation as getLocaleContent } from './getLocaleTranslation.mjs';
 export { useTraduction } from './useTraduction.mjs';
-export { LocaleServerContext, LocaleServerContextProvider, locale } from './LocaleServerContextProvider.mjs';
+export { IntlayerServerContext as IntlayerServer, IntlayerServerProvider, locale } from './IntlayerServerProvider.mjs';
 export { useIntlayer } from './useIntlayer.mjs';
 import '@intlayer/config/client';
 import '@intlayer/core';

package/dist/esm/server/index.mjs

@@ -1,14 +1,14 @@
 import { getLocaleTranslation } from './getLocaleTranslation.mjs';
 import { useTraduction } from './useTraduction.mjs';
 import {
-  LocaleServerContext,
+  IntlayerServerContext,
   locale,
-  LocaleServerContextProvider
-} from './LocaleServerContextProvider.mjs';
+  IntlayerServerProvider
+} from './IntlayerServerProvider.mjs';
 import { useIntlayer } from './useIntlayer.mjs';
 export {
-  LocaleServerContext,
-  LocaleServerContextProvider,
+  IntlayerServerContext as IntlayerServer,
+  IntlayerServerProvider,
   getLocaleTranslation as getLocaleContent,
   locale,
   useIntlayer,

package/dist/esm/server/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/index.ts"],"sourcesContent":["export { getLocaleTranslation as getLocaleContent } from './getLocaleTranslation';\nexport { useTraduction } from './useTraduction';\nexport {\n  LocaleServerContext,\n  locale,\n  LocaleServerContextProvider,\n} from './LocaleServerContextProvider';\nexport { useIntlayer } from './useIntlayer';\n"],"mappings":"AAAA,SAAiC,4BAAwB;AACzD,SAAS,qBAAqB;AAC9B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,mBAAmB;","names":[]}
+{"version":3,"sources":["../../../src/server/index.ts"],"sourcesContent":["export { getLocaleTranslation as getLocaleContent } from './getLocaleTranslation';\nexport { useTraduction } from './useTraduction';\nexport {\n  IntlayerServerContext as IntlayerServer,\n  locale,\n  IntlayerServerProvider,\n} from './IntlayerServerProvider';\nexport { useIntlayer } from './useIntlayer';\n"],"mappings":"AAAA,SAAiC,4BAAwB;AACzD,SAAS,qBAAqB;AAC9B;AAAA,EAC2B;AAAA,EACzB;AAAA,EACA;AAAA,OACK;AACP,SAAS,mBAAmB;","names":[]}

package/dist/esm/server/serverContext.d.mts

@@ -3,11 +3,11 @@
  * Attempts to closely mimic the `createContext` API.
  *
  * @example
- * const LocaleServerContext = createServerContext<string | null>(null);
+ * const IntlayerServer = createServerContext<string | null>(null);
  *
- * <LocaleServerContext.Provider value={locale}>
+ * <IntlayerServer.Provider value={locale}>
  *      {children}
- * </LocaleServerContext.Provider>
+ * </IntlayerServer.Provider>
  */
 declare const createServerContext: <T>(defaultValue?: T) => ServerContext<T>;
 /**
@@ -15,7 +15,7 @@ declare const createServerContext: <T>(defaultValue?: T) => ServerContext<T>;
  * Attempts to closely mimic the `useContext` API.
  *
  * @example
- * getServerContext(LocaleServerContext);
+ * getServerContext(IntlayerServer);
  */
 declare const getServerContext: <T>({ _storage, _defaultValue, }: ServerContext<T>) => T | undefined;
 type ServerContext<T> = {

package/dist/esm/server/serverContext.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/serverContext.ts"],"sourcesContent":["/**\n * Creates a new datastore for a given server context.\n * Attempts to closely mimic the `createContext` API.\n *\n * @example\n * const LocaleServerContext = createServerContext<string | null>(null);\n *\n * <LocaleServerContext.Provider value={locale}>\n *      {children}\n * </LocaleServerContext.Provider>\n */\n\nimport react from 'react';\n\ntype CacheType<T> = () => { value: T | undefined };\n\nconst cacheFallback = () => () => ({ value: undefined });\n\nexport const createServerContext = <T>(defaultValue?: T): ServerContext<T> => {\n  throwInClient();\n\n  const cache = react.cache<CacheType<T>> ?? cacheFallback;\n\n  const getCache = cache(() => ({\n    value: undefined,\n  }));\n\n  return {\n    Provider: ({ children, value }) => {\n      getCache().value = value;\n      return children;\n    },\n    Consumer: ({ children }) => {\n      const store = getCache();\n      return children(store ? store.value : defaultValue);\n    },\n    _storage: getCache,\n    _defaultValue: defaultValue,\n  };\n};\n\n/**\n * Fetches a value present in a given server context.\n * Attempts to closely mimic the `useContext` API.\n *\n * @example\n * getServerContext(LocaleServerContext);\n */\nexport const getServerContext = <T>({\n  _storage,\n  _defaultValue,\n}: ServerContext<T>) => {\n  // throwInClient();\n  const store = _storage();\n  if (!store) return _defaultValue;\n  return store.value;\n};\n\ntype ServerContext<T> = {\n  Provider: ({\n    children,\n    value,\n  }: {\n    children: React.ReactNode;\n    value: T;\n  }) => React.ReactNode;\n  Consumer: ({\n    children,\n  }: {\n    children: (context: T | undefined) => React.ReactNode;\n  }) => React.ReactNode;\n  _storage: () => { value: T | undefined };\n  _defaultValue: T | undefined;\n};\n\n/**\n * Throws if called within a client component environment.\n * Useful to help prevent mistakes.\n */\nconst throwInClient = (): void | never => {\n  // If window.document is defined we're in a client component\n  if (typeof window !== 'undefined') {\n    throw new Error(`createServerContext only works in Server Components`);\n  }\n};\n"],"mappings":"AAYA,OAAO,WAAW;AAIlB,MAAM,gBAAgB,MAAM,OAAO,EAAE,OAAO,OAAU;AAE/C,MAAM,sBAAsB,CAAI,iBAAuC;AAC5E,gBAAc;AAEd,QAAM,QAAQ,MAAM,SAAuB;AAE3C,QAAM,WAAW,MAAM,OAAO;AAAA,IAC5B,OAAO;AAAA,EACT,EAAE;AAEF,SAAO;AAAA,IACL,UAAU,CAAC,EAAE,UAAU,MAAM,MAAM;AACjC,eAAS,EAAE,QAAQ;AACnB,aAAO;AAAA,IACT;AAAA,IACA,UAAU,CAAC,EAAE,SAAS,MAAM;AAC1B,YAAM,QAAQ,SAAS;AACvB,aAAO,SAAS,QAAQ,MAAM,QAAQ,YAAY;AAAA,IACpD;AAAA,IACA,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AACF;AASO,MAAM,mBAAmB,CAAI;AAAA,EAClC;AAAA,EACA;AACF,MAAwB;AAEtB,QAAM,QAAQ,SAAS;AACvB,MAAI,CAAC;AAAO,WAAO;AACnB,SAAO,MAAM;AACf;AAuBA,MAAM,gBAAgB,MAAoB;AAExC,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACF;","names":[]}
+{"version":3,"sources":["../../../src/server/serverContext.ts"],"sourcesContent":["/**\n * Creates a new datastore for a given server context.\n * Attempts to closely mimic the `createContext` API.\n *\n * @example\n * const IntlayerServer = createServerContext<string | null>(null);\n *\n * <IntlayerServer.Provider value={locale}>\n *      {children}\n * </IntlayerServer.Provider>\n */\n\nimport react from 'react';\n\ntype CacheType<T> = () => { value: T | undefined };\n\nconst cacheFallback = () => () => ({ value: undefined });\n\nexport const createServerContext = <T>(defaultValue?: T): ServerContext<T> => {\n  throwInClient();\n\n  const cache = react.cache<CacheType<T>> ?? cacheFallback;\n\n  const getCache = cache(() => ({\n    value: undefined,\n  }));\n\n  return {\n    Provider: ({ children, value }) => {\n      getCache().value = value;\n      return children;\n    },\n    Consumer: ({ children }) => {\n      const store = getCache();\n      return children(store ? store.value : defaultValue);\n    },\n    _storage: getCache,\n    _defaultValue: defaultValue,\n  };\n};\n\n/**\n * Fetches a value present in a given server context.\n * Attempts to closely mimic the `useContext` API.\n *\n * @example\n * getServerContext(IntlayerServer);\n */\nexport const getServerContext = <T>({\n  _storage,\n  _defaultValue,\n}: ServerContext<T>) => {\n  // throwInClient();\n  const store = _storage();\n  if (!store) return _defaultValue;\n  return store.value;\n};\n\ntype ServerContext<T> = {\n  Provider: ({\n    children,\n    value,\n  }: {\n    children: React.ReactNode;\n    value: T;\n  }) => React.ReactNode;\n  Consumer: ({\n    children,\n  }: {\n    children: (context: T | undefined) => React.ReactNode;\n  }) => React.ReactNode;\n  _storage: () => { value: T | undefined };\n  _defaultValue: T | undefined;\n};\n\n/**\n * Throws if called within a client component environment.\n * Useful to help prevent mistakes.\n */\nconst throwInClient = (): void | never => {\n  // If window.document is defined we're in a client component\n  if (typeof window !== 'undefined') {\n    throw new Error(`createServerContext only works in Server Components`);\n  }\n};\n"],"mappings":"AAYA,OAAO,WAAW;AAIlB,MAAM,gBAAgB,MAAM,OAAO,EAAE,OAAO,OAAU;AAE/C,MAAM,sBAAsB,CAAI,iBAAuC;AAC5E,gBAAc;AAEd,QAAM,QAAQ,MAAM,SAAuB;AAE3C,QAAM,WAAW,MAAM,OAAO;AAAA,IAC5B,OAAO;AAAA,EACT,EAAE;AAEF,SAAO;AAAA,IACL,UAAU,CAAC,EAAE,UAAU,MAAM,MAAM;AACjC,eAAS,EAAE,QAAQ;AACnB,aAAO;AAAA,IACT;AAAA,IACA,UAAU,CAAC,EAAE,SAAS,MAAM;AAC1B,YAAM,QAAQ,SAAS;AACvB,aAAO,SAAS,QAAQ,MAAM,QAAQ,YAAY;AAAA,IACpD;AAAA,IACA,UAAU;AAAA,IACV,eAAe;AAAA,EACjB;AACF;AASO,MAAM,mBAAmB,CAAI;AAAA,EAClC;AAAA,EACA;AACF,MAAwB;AAEtB,QAAM,QAAQ,SAAS;AACvB,MAAI,CAAC;AAAO,WAAO;AACnB,SAAO,MAAM;AACf;AAuBA,MAAM,gBAAgB,MAAoB;AAExC,MAAI,OAAO,WAAW,aAAa;AACjC,UAAM,IAAI,MAAM,qDAAqD;AAAA,EACvE;AACF;","names":[]}

package/dist/esm/server/useIntlayer.d.mts

@@ -2,6 +2,11 @@ import { UseIntlayer } from '../useIntlayerBase.mjs';
 import '@intlayer/config/client';
 import 'intlayer';
 
+/**
+ * On the server side, Hook that picking one dictionary by its id and return the content
+ *
+ * If the locale is not provided, it will use the locale from the server context
+ */
 declare const useIntlayer: UseIntlayer;
 
 export { useIntlayer };

package/dist/esm/server/useIntlayer.mjs

@@ -1,10 +1,10 @@
 import {
   useIntlayerBase
 } from '../useIntlayerBase.mjs';
-import { LocaleServerContext } from './LocaleServerContextProvider.mjs';
+import { IntlayerServerContext } from './IntlayerServerProvider.mjs';
 import { getServerContext } from './serverContext.mjs';
 const useIntlayer = (id, locale) => {
-  const localeTarget = locale ?? getServerContext(LocaleServerContext);
+  const localeTarget = locale ?? getServerContext(IntlayerServerContext);
   return useIntlayerBase(id, localeTarget);
 };
 export {

package/dist/esm/server/useIntlayer.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/useIntlayer.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport {\n  type DictionaryKeys,\n  useIntlayerBase,\n  type UseIntlayer,\n} from '../useIntlayerBase';\nimport { LocaleServerContext } from './LocaleServerContextProvider';\nimport { getServerContext } from './serverContext';\n\nexport const useIntlayer: UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => {\n  const localeTarget = locale ?? getServerContext<Locales>(LocaleServerContext);\n\n  return useIntlayerBase(id, localeTarget);\n};\n"],"mappings":"AACA;AAAA,EAEE;AAAA,OAEK;AACP,SAAS,2BAA2B;AACpC,SAAS,wBAAwB;AAE1B,MAAM,cAA2B,CACtC,IACA,WACG;AACH,QAAM,eAAe,UAAU,iBAA0B,mBAAmB;AAE5E,SAAO,gBAAgB,IAAI,YAAY;AACzC;","names":[]}
+{"version":3,"sources":["../../../src/server/useIntlayer.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport {\n  type DictionaryKeys,\n  useIntlayerBase,\n  type UseIntlayer,\n} from '../useIntlayerBase';\nimport { IntlayerServerContext } from './IntlayerServerProvider';\nimport { getServerContext } from './serverContext';\n\n/**\n * On the server side, Hook that picking one dictionary by its id and return the content\n *\n * If the locale is not provided, it will use the locale from the server context\n */\nexport const useIntlayer: UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => {\n  const localeTarget =\n    locale ?? getServerContext<Locales>(IntlayerServerContext);\n\n  return useIntlayerBase(id, localeTarget);\n};\n"],"mappings":"AACA;AAAA,EAEE;AAAA,OAEK;AACP,SAAS,6BAA6B;AACtC,SAAS,wBAAwB;AAO1B,MAAM,cAA2B,CACtC,IACA,WACG;AACH,QAAM,eACJ,UAAU,iBAA0B,qBAAqB;AAE3D,SAAO,gBAAgB,IAAI,YAAY;AACzC;","names":[]}

package/dist/esm/server/useTraduction.d.mts

@@ -1,5 +1,25 @@
 import { LanguageContent } from '@intlayer/core';
 
-declare const useTraduction: <Content>(languageContent: LanguageContent<Content>) => Content;
+/**
+ * On the server side, hook to get the translation content based on the locale
+ *
+ * If not locale found, it will return the content related to the default locale.
+ *
+ * Return either the content editor, or the content itself depending on the configuration.
+ *
+ * Usage:
+ *
+ * const content = getTranslation<string>({
+ * en: 'Hello',
+ * fr: 'Bonjour',
+ * },
+ * 'fr');
+ * // 'Bonjour'
+ *
+ * Using TypeScript:
+ * - this function will require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
+ */
+declare const useTraduction: <Content = string>(languageContent: LanguageContent<Content>) => Content;
 
 export { useTraduction };

package/dist/esm/server/useTraduction.mjs

@@ -1,8 +1,8 @@
 import { getTranslation } from '../getTranslation.mjs';
-import { LocaleServerContext } from './LocaleServerContextProvider.mjs';
+import { IntlayerServerContext } from './IntlayerServerProvider.mjs';
 import { getServerContext } from './serverContext.mjs';
 const useTraduction = (languageContent) => {
-  const locale = getServerContext(LocaleServerContext);
+  const locale = getServerContext(IntlayerServerContext);
   return getTranslation(languageContent, locale);
 };
 export {

package/dist/esm/server/useTraduction.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/useTraduction.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport type { LanguageContent } from '@intlayer/core';\nimport { getTranslation } from '../getTranslation';\nimport { LocaleServerContext } from './LocaleServerContextProvider';\nimport { getServerContext } from './serverContext';\n\nexport const useTraduction = <Content>(\n  languageContent: LanguageContent<Content>\n) => {\n  const locale = getServerContext<Locales>(LocaleServerContext);\n\n  return getTranslation(languageContent, locale);\n};\n"],"mappings":"AAEA,SAAS,sBAAsB;AAC/B,SAAS,2BAA2B;AACpC,SAAS,wBAAwB;AAE1B,MAAM,gBAAgB,CAC3B,oBACG;AACH,QAAM,SAAS,iBAA0B,mBAAmB;AAE5D,SAAO,eAAe,iBAAiB,MAAM;AAC/C;","names":[]}
+{"version":3,"sources":["../../../src/server/useTraduction.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\nimport type { LanguageContent } from '@intlayer/core';\nimport { getTranslation } from '../getTranslation';\nimport { IntlayerServerContext } from './IntlayerServerProvider';\nimport { getServerContext } from './serverContext';\n\n/**\n * On the server side, hook to get the translation content based on the locale\n *\n * If not locale found, it will return the content related to the default locale.\n *\n * Return either the content editor, or the content itself depending on the configuration.\n *\n * Usage:\n *\n * const content = getTranslation<string>({\n * en: 'Hello',\n * fr: 'Bonjour',\n * },\n * 'fr');\n * // 'Bonjour'\n *\n * Using TypeScript:\n * - this function will require each locale to be defined if defined in the project configuration.\n * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.\n */\nexport const useTraduction = <Content = string>(\n  languageContent: LanguageContent<Content>\n) => {\n  const locale = getServerContext<Locales>(IntlayerServerContext);\n\n  return getTranslation(languageContent, locale);\n};\n"],"mappings":"AAEA,SAAS,sBAAsB;AAC/B,SAAS,6BAA6B;AACtC,SAAS,wBAAwB;AAsB1B,MAAM,gBAAgB,CAC3B,oBACG;AACH,QAAM,SAAS,iBAA0B,qBAAqB;AAE9D,SAAO,eAAe,iBAAiB,MAAM;AAC/C;","names":[]}

package/dist/esm/useIntlayerBase.d.mts

@@ -1,15 +1,12 @@
 import { Locales } from '@intlayer/config/client';
 import { IntlayerDictionaryTypesConnector } from 'intlayer';
 
-/**
- * @intlayer/dictionaries-entry is a package that only returns the dictionary entry path.
- * Using an external package allow to alias it in the bundle configuration (such as webpack).
- * The alias allow hot reload the app (such as nextjs) on any dictionary change.
- */
-
 type StringFallback<T> = T extends never ? string : T;
 type DictionaryKeys = StringFallback<keyof IntlayerDictionaryTypesConnector>;
 type UseIntlayer = <T extends DictionaryKeys>(id: T, locale?: Locales) => IntlayerDictionaryTypesConnector[T];
+/**
+ * Hook that picking one dictionary by its id and return the content.
+ */
 declare const useIntlayerBase: UseIntlayer;
 
 export { type DictionaryKeys, type StringFallback, type UseIntlayer, useIntlayerBase };

package/dist/esm/useIntlayerBase.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/useIntlayerBase.ts"],"sourcesContent":["/**\n * @intlayer/dictionaries-entry is a package that only returns the dictionary entry path.\n * Using an external package allow to alias it in the bundle configuration (such as webpack).\n * The alias allow hot reload the app (such as nextjs) on any dictionary change.\n */\nimport type { Locales } from '@intlayer/config/client';\nimport dictionaries from '@intlayer/dictionaries-entry';\nimport type { IntlayerDictionaryTypesConnector } from 'intlayer';\nimport type { Content } from './processDictionary/contentDictionary';\nimport { processDictionary } from './processDictionary/index';\n\nexport type StringFallback<T> = T extends never ? string : T; // If no keys are found, return string to disable error, and accept any string as dictionary key\nexport type DictionaryKeys = StringFallback<\n  keyof IntlayerDictionaryTypesConnector\n>;\n\nexport type UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => IntlayerDictionaryTypesConnector[T];\n\nexport const useIntlayerBase: UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => {\n  const dictionary: Content = dictionaries[id];\n\n  return processDictionary(\n    dictionary,\n    locale\n  ) as IntlayerDictionaryTypesConnector[T];\n};\n"],"mappings":"AAMA,OAAO,kBAAkB;AAGzB,SAAS,yBAAyB;AAY3B,MAAM,kBAA+B,CAC1C,IACA,WACG;AACH,QAAM,aAAsB,aAAa,EAAE;AAE3C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../../src/useIntlayerBase.ts"],"sourcesContent":["import type { Locales } from '@intlayer/config/client';\n/**\n * @intlayer/dictionaries-entry is a package that only returns the dictionary entry path.\n * Using an external package allow to alias it in the bundle configuration (such as webpack).\n * The alias allow hot reload the app (such as nextjs) on any dictionary change.\n */\nimport dictionaries from '@intlayer/dictionaries-entry';\nimport type { IntlayerDictionaryTypesConnector } from 'intlayer';\nimport type { Content } from './processDictionary/contentDictionary';\nimport { processDictionary } from './processDictionary/index';\n\nexport type StringFallback<T> = T extends never ? string : T; // If no keys are found, return string to disable error, and accept any string as dictionary key\nexport type DictionaryKeys = StringFallback<\n  keyof IntlayerDictionaryTypesConnector\n>;\n\nexport type UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => IntlayerDictionaryTypesConnector[T];\n\n/**\n * Hook that picking one dictionary by its id and return the content.\n */\nexport const useIntlayerBase: UseIntlayer = <T extends DictionaryKeys>(\n  id: T,\n  locale?: Locales\n) => {\n  const dictionary: Content = dictionaries[id];\n\n  return processDictionary(\n    dictionary,\n    locale\n  ) as IntlayerDictionaryTypesConnector[T];\n};\n"],"mappings":"AAMA,OAAO,kBAAkB;AAGzB,SAAS,yBAAyB;AAe3B,MAAM,kBAA+B,CAC1C,IACA,WACG;AACH,QAAM,aAAsB,aAAa,EAAE;AAE3C,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-intlayer",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "private": false,
   "description": "Internationalization layer for React applications - Layer of abstraction between the business logic and the data access layer. Manage internationalization in a simple way, through TypeScript, JavaScript or JSON declaration file.",
   "keywords": [
@@ -55,20 +55,20 @@
   "dependencies": {
     "js-cookie": "^3.0.5",
     "react-cookie": "^7.1.4",
-    "@intlayer/config": "^1.0.1",
-    "@intlayer/core": "^1.0.1",
-    "@intlayer/dictionaries-entry": "^1.0.1",
-    "intlayer": "^1.0.1"
+    "@intlayer/config": "^1.2.0",
+    "@intlayer/core": "^1.2.0",
+    "@intlayer/dictionaries-entry": "^1.2.0",
+    "intlayer": "^1.2.0"
   },
   "devDependencies": {
     "@types/js-cookie": "^3.0.6",
     "@types/node": "^20.12.7",
-    "@types/react": "^18.2.78",
+    "@types/react": "^18.2.79",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "rimraf": "5.0.5",
     "tsup": "^8.0.2",
-    "typescript": "^5.4.3",
+    "typescript": "^5.4.5",
     "@utils/eslint-config": "^1.0.1",
     "@utils/ts-config": "^1.0.1"
   },

package/src/IntlayerProvider.tsx

@@ -0,0 +1,24 @@
+import { intlayerIntlConfiguration } from '@intlayer/config/client';
+import type { FC } from 'react';
+import {
+  IntlayerClientProvider,
+  type IntlayerClientProviderProps,
+} from './client/IntlayerClientProvider';
+import {
+  IntlayerServerProvider,
+  type IntlayerServerProviderProps,
+} from './server/IntlayerServerProvider';
+
+const defaultLocale = intlayerIntlConfiguration.defaultLocale;
+
+type IntlayerProviderProps = IntlayerClientProviderProps &
+  IntlayerServerProviderProps;
+
+export const IntlayerProvider: FC<IntlayerProviderProps> = ({
+  children,
+  locale = defaultLocale,
+}) => (
+  <IntlayerServerProvider locale={locale}>
+    <IntlayerClientProvider locale={locale}>{children}</IntlayerClientProvider>
+  </IntlayerServerProvider>
+);

package/src/client/IntlayerClientProvider.tsx

@@ -0,0 +1,45 @@
+'use client';
+
+import {
+  intlayerIntlConfiguration,
+  type Locales,
+} from '@intlayer/config/client';
+import {
+  type PropsWithChildren,
+  createContext,
+  useContext,
+  type FC,
+} from 'react';
+import { localeCookie } from './useLocaleCookie';
+
+type IntlayerValue = {
+  locale: Locales;
+};
+
+/**
+ * Context that store the current locale on the client side
+ */
+export const IntlayerClientContext = createContext<IntlayerValue>({
+  locale: localeCookie ?? intlayerIntlConfiguration.defaultLocale,
+});
+
+/**
+ * Hook that provides the current locale
+ */
+export const useIntlayerContext = () => useContext(IntlayerClientContext);
+
+export type IntlayerClientProviderProps = PropsWithChildren & {
+  locale: Locales;
+};
+
+/**
+ * Provider that store the current locale on the client side
+ */
+export const IntlayerClientProvider: FC<IntlayerClientProviderProps> = ({
+  locale,
+  children,
+}) => (
+  <IntlayerClientContext.Provider value={{ locale }}>
+    {children}
+  </IntlayerClientContext.Provider>
+);

package/src/client/index.ts

@@ -1,9 +1,9 @@
-export type { LocaleClientContextProviderProps } from './LocaleClientContextProvider';
+export type { IntlayerClientProviderProps } from './IntlayerClientProvider';
 export {
-  LocaleClientContext,
-  useLocaleContext,
-  LocaleClientContextProvider,
-} from './LocaleClientContextProvider';
+  IntlayerClientContext as IntlayerClient,
+  useIntlayerContext,
+  IntlayerClientProvider,
+} from './IntlayerClientProvider';
 export { useIntlayer } from './useIntlayer';
 export { useLocale } from './useLocale';
 export { useTraduction } from './useTraduction';

package/src/client/useContent.ts

@@ -2,6 +2,9 @@ import type { LanguageContent } from '@intlayer/core';
 import { useLocale } from './useLocale';
 import { useTraduction } from './useTraduction';
 
+/**
+ * On the client side, hook to get the translation content based on the locale
+ */
 export const useContent = <Content>(
   languageContent: LanguageContent<Content>
 ) => {

package/src/client/useIntlayer.ts

@@ -7,13 +7,18 @@ import {
   useIntlayerBase,
   type UseIntlayer,
 } from '../useIntlayerBase';
-import { LocaleClientContext } from './LocaleClientContextProvider';
+import { IntlayerClientContext } from './IntlayerClientProvider';
 
+/**
+ * On the client side, Hook that picking one dictionary by its id and return the content
+ *
+ * If the locale is not provided, it will use the locale from the client context
+ */
 export const useIntlayer: UseIntlayer = <T extends DictionaryKeys>(
   id: T,
   locale?: Locales
 ) => {
-  const { locale: currentLocale } = useContext(LocaleClientContext);
+  const { locale: currentLocale } = useContext(IntlayerClientContext);
   const localeTarget = locale ?? currentLocale;
 
   return useIntlayerBase(id, localeTarget);

package/src/client/useLocale.ts

@@ -3,12 +3,15 @@
 import { intlayerIntlConfiguration } from '@intlayer/config/client';
 import { localeList } from '@intlayer/core';
 import { useContext } from 'react';
-import { LocaleClientContext } from './LocaleClientContextProvider';
+import { IntlayerClientContext } from './IntlayerClientProvider';
 
 const { defaultLocale, locales: availableLocales } = intlayerIntlConfiguration;
 
+/**
+ * On the client side, hook to get the current locale and all related fields
+ */
 export const useLocale = () => {
-  const { locale } = useContext(LocaleClientContext);
+  const { locale } = useContext(IntlayerClientContext);
 
   return {
     locale, // Current locale

package/src/client/useLocaleCookie.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-redundant-type-constituents */
 import {
   type Locales,
   intlayerMiddlewareConfiguration,
@@ -15,12 +14,21 @@ const cookieAttributes: Cookies.CookieAttributes = {
   sameSite: 'strict',
 };
 
+/**
+ * Get the locale cookie
+ */
 export const localeCookie = Cookies.get(cookieName) as Locales | undefined;
 
+/**
+ * Set the locale cookie
+ */
 export const setLocaleCookie = (locale: Locales) => {
   Cookies.set(cookieName, locale, cookieAttributes);
 };
 
+/**
+ * Hook that provides the locale cookie and a function to set it
+ */
 export const useLocaleCookie = () => ({
   localeCookie,
   setLocaleCookie,

package/src/client/useTraduction.ts

@@ -1,12 +1,32 @@
 import type { LanguageContent } from '@intlayer/core';
 import { useContext } from 'react';
 import { getTranslation } from '../getTranslation';
-import { LocaleClientContext } from './LocaleClientContextProvider';
+import { IntlayerClientContext } from './IntlayerClientProvider';
 
-export const useTraduction = <Content>(
+/**
+ * On the client side, Hook that picking one dictionary by its id and return the content.
+ *
+ * If not locale found, it will return the content related to the default locale.
+ *
+ * Return either the content editor, or the content itself depending on the configuration.
+ *
+ * Usage:
+ *
+ * const content = getTranslation<string>({
+ * en: 'Hello',
+ * fr: 'Bonjour',
+ * },
+ * 'fr');
+ * // 'Bonjour'
+ *
+ * Using TypeScript:
+ * - this function will require each locale to be defined if defined in the project configuration.
+ * - If a locale is missing, it will make each existing locale optional and raise an error if the locale is not found.
+ */
+export const useTraduction = <Content = string>(
   languageContent: LanguageContent<Content>
 ): Content => {
-  const { locale } = useContext(LocaleClientContext);
+  const { locale } = useContext(IntlayerClientContext);
 
   return getTranslation(languageContent, locale);
 };