react-intlayer 1.0.0 → 1.2.0

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

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

package/dist/esm/server/index.mjs

@@ -1,17 +1,17 @@
-import { getLocaleTranslation } from "./getLocaleTranslation.mjs";
-import { useTraduction } from "./useTraduction.mjs";
+import { getLocaleTranslation } from './getLocaleTranslation.mjs';
+import { useTraduction } from './useTraduction.mjs';
 import {
-  LocaleServerContext,
+  IntlayerServerContext,
   locale,
-  LocaleServerContextProvider,
-} from "./LocaleServerContextProvider.mjs";
-import { useIntlayer } from "./useIntlayer.mjs";
+  IntlayerServerProvider
+} from './IntlayerServerProvider.mjs';
+import { useIntlayer } from './useIntlayer.mjs';
 export {
-  LocaleServerContext,
-  LocaleServerContextProvider,
+  IntlayerServerContext as IntlayerServer,
+  IntlayerServerProvider,
   getLocaleTranslation as getLocaleContent,
   locale,
   useIntlayer,
-  useTraduction,
+  useTraduction
 };
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

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,29 +15,21 @@ 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;
+declare const getServerContext: <T>({ _storage, _defaultValue, }: ServerContext<T>) => T | undefined;
 type ServerContext<T> = {
-  Provider: ({
-    children,
-    value,
-  }: {
-    children: React.ReactNode;
-    value: T;
-  }) => React.ReactNode;
-  Consumer: ({
-    children,
-  }: {
-    children: (context: T | undefined) => React.ReactNode;
-  }) => React.ReactNode;
-  _storage: () => {
-    value: T | undefined;
-  };
-  _defaultValue: T | undefined;
+    Provider: ({ children, value, }: {
+        children: React.ReactNode;
+        value: T;
+    }) => React.ReactNode;
+    Consumer: ({ children, }: {
+        children: (context: T | undefined) => React.ReactNode;
+    }) => React.ReactNode;
+    _storage: () => {
+        value: T | undefined;
+    };
+    _defaultValue: T | undefined;
 };
 
 export { createServerContext, getServerContext };

package/dist/esm/server/serverContext.mjs

@@ -4,7 +4,7 @@ const createServerContext = (defaultValue) => {
   throwInClient();
   const cache = react.cache ?? cacheFallback;
   const getCache = cache(() => ({
-    value: void 0,
+    value: void 0
   }));
   return {
     Provider: ({ children, value }) => {
@@ -16,12 +16,16 @@ const createServerContext = (defaultValue) => {
       return children(store ? store.value : defaultValue);
     },
     _storage: getCache,
-    _defaultValue: defaultValue,
+    _defaultValue: defaultValue
   };
 };
-const getServerContext = ({ _storage, _defaultValue }) => {
+const getServerContext = ({
+  _storage,
+  _defaultValue
+}) => {
   const store = _storage();
-  if (!store) return _defaultValue;
+  if (!store)
+    return _defaultValue;
   return store.value;
 };
 const throwInClient = () => {
@@ -29,5 +33,8 @@ const throwInClient = () => {
     throw new Error(`createServerContext only works in Server Components`);
   }
 };
-export { createServerContext, getServerContext };
-//# sourceMappingURL=serverContext.mjs.map
+export {
+  createServerContext,
+  getServerContext
+};
+//# sourceMappingURL=serverContext.mjs.map

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

@@ -1,7 +1,12 @@
-import { UseIntlayer } from "../useIntlayerBase.mjs";
-import "@intlayer/config/client";
-import "intlayer";
+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,9 +1,13 @@
-import { useIntlayerBase } from "../useIntlayerBase.mjs";
-import { LocaleServerContext } from "./LocaleServerContextProvider.mjs";
-import { getServerContext } from "./serverContext.mjs";
+import {
+  useIntlayerBase
+} from '../useIntlayerBase.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 { useIntlayer };
-//# sourceMappingURL=useIntlayer.mjs.map
+export {
+  useIntlayer
+};
+//# sourceMappingURL=useIntlayer.mjs.map

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,7 +1,25 @@
-import { LanguageContent } from "@intlayer/core";
+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,9 +1,11 @@
-import { getTranslation } from "../getTranslation.mjs";
-import { LocaleServerContext } from "./LocaleServerContextProvider.mjs";
-import { getServerContext } from "./serverContext.mjs";
+import { getTranslation } from '../getTranslation.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 { useTraduction };
-//# sourceMappingURL=useTraduction.mjs.map
+export {
+  useTraduction
+};
+//# sourceMappingURL=useTraduction.mjs.map

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,23 +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.
- */
+import { Locales } from '@intlayer/config/client';
+import { IntlayerDictionaryTypesConnector } from 'intlayer';
 
 type StringFallback<T> = T extends never ? string : T;
 type DictionaryKeys = StringFallback<keyof IntlayerDictionaryTypesConnector>;
-type UseIntlayer = <T extends DictionaryKeys>(
-  id: T,
-  locale?: Locales
-) => IntlayerDictionaryTypesConnector[T];
+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,
-};
+export { type DictionaryKeys, type StringFallback, type UseIntlayer, useIntlayerBase };

package/dist/esm/useIntlayerBase.mjs

@@ -1,8 +1,13 @@
 import dictionaries from "@intlayer/dictionaries-entry";
-import { processDictionary } from "./processDictionary/index.mjs";
+import { processDictionary } from './processDictionary/index.mjs';
 const useIntlayerBase = (id, locale) => {
   const dictionary = dictionaries[id];
-  return processDictionary(dictionary, locale);
+  return processDictionary(
+    dictionary,
+    locale
+  );
 };
-export { useIntlayerBase };
-//# sourceMappingURL=useIntlayerBase.mjs.map
+export {
+  useIntlayerBase
+};
+//# sourceMappingURL=useIntlayerBase.mjs.map

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.0",
+  "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": [
@@ -19,7 +19,7 @@
   "homepage": "https://github.com/aypineau/intlayer",
   "repository": {
     "type": "git",
-    "url": "https://github.com/aypineau/intlayer"
+    "url": "git+https://github.com/aypineau/intlayer.git"
   },
   "license": "MIT",
   "author": {
@@ -55,22 +55,22 @@
   "dependencies": {
     "js-cookie": "^3.0.5",
     "react-cookie": "^7.1.4",
-    "@intlayer/config": "^1.0.0",
-    "@intlayer/core": "^1.0.0",
-    "@intlayer/dictionaries-entry": "^1.0.0",
-    "intlayer": "^1.0.0"
+    "@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",
-    "@utils/eslint-config": "^1.0.0",
-    "@utils/ts-config": "^1.0.0"
+    "typescript": "^5.4.5",
+    "@utils/eslint-config": "^1.0.1",
+    "@utils/ts-config": "^1.0.1"
   },
   "peerDependencies": {
     "react": "^18.2.0",

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);
 };

package/src/getEnumeration.ts

@@ -1,6 +1,31 @@
 import { type QuantityContent, getEnumerationContent } from '@intlayer/core';
 import { contentRender } from './ContentEditor/contentRender';
 
+/**
+ * Allow to pick a content based on a quantity.
+ *
+ * Return either the content editor, or the content itself depending on the configuration.
+ *
+ * Usage:
+ *
+ * const content = getEnumeration({
+ *  '<=-2.3': 'You have less than -2.3',
+ *  '<1': 'You have less than one',
+ *  '2': 'You have two',
+ *  '>=3': 'You have three or more',
+ * },
+ * 2);
+ * // 'You have two'
+ *
+ * The order of the keys will define the priority of the content.
+ *
+ * const content = getEnumeration({
+ * '<4': 'You have less than four',
+ * '2': 'You have two',
+ * });
+ * // 'You have less than four'
+ *
+ */
 export const getEnumeration = <Content>(
   enumerationContent: QuantityContent<Content>,
   quantity: number