react-intlayer 1.2.0 → 1.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/dist/cjs/IntlayerProvider.cjs +1 -1
  2. package/dist/cjs/IntlayerProvider.cjs.map +1 -1
  3. package/dist/cjs/cli/react-intlayer.cjs +68 -0
  4. package/dist/cjs/cli/react-intlayer.cjs.map +1 -0
  5. package/dist/cjs/cli/react-intlayer.d.ts +1 -0
  6. package/dist/cjs/client/IntlayerClientProvider.cjs +26 -2
  7. package/dist/cjs/client/IntlayerClientProvider.cjs.map +1 -1
  8. package/dist/cjs/client/IntlayerClientProvider.d.ts +2 -1
  9. package/dist/cjs/client/getBrowserLocale.cjs +170 -0
  10. package/dist/cjs/client/getBrowserLocale.cjs.map +1 -0
  11. package/dist/cjs/client/getBrowserLocale.d.ts +26 -0
  12. package/dist/cjs/client/index.cjs +6 -0
  13. package/dist/cjs/client/index.cjs.map +1 -1
  14. package/dist/cjs/client/index.d.ts +2 -0
  15. package/dist/cjs/client/useContent.cjs +2 -2
  16. package/dist/cjs/client/useContent.cjs.map +1 -1
  17. package/dist/cjs/client/useLocale.cjs +5 -3
  18. package/dist/cjs/client/useLocale.cjs.map +1 -1
  19. package/dist/cjs/client/useLocale.d.ts +1 -0
  20. package/dist/cjs/client/useLocaleBase.cjs +49 -0
  21. package/dist/cjs/client/useLocaleBase.cjs.map +1 -0
  22. package/dist/cjs/client/useLocaleBase.d.ts +14 -0
  23. package/dist/cjs/client/useLocaleCookie.cjs +1 -1
  24. package/dist/cjs/client/useLocaleCookie.cjs.map +1 -1
  25. package/dist/cjs/client/useTraduction.cjs.map +1 -1
  26. package/dist/cjs/client/useTraduction.d.ts +6 -5
  27. package/dist/cjs/craco/craco.config.cjs +32 -0
  28. package/dist/cjs/craco/craco.config.cjs.map +1 -0
  29. package/dist/cjs/craco/craco.config.d.ts +2 -0
  30. package/dist/cjs/craco/intlayerCracoPlugin.cjs +89 -0
  31. package/dist/cjs/craco/intlayerCracoPlugin.cjs.map +1 -0
  32. package/dist/cjs/craco/intlayerCracoPlugin.d.ts +26 -0
  33. package/dist/cjs/getEnumeration.cjs.map +1 -1
  34. package/dist/cjs/getEnumeration.d.ts +8 -5
  35. package/dist/cjs/getTranslation.cjs +1 -1
  36. package/dist/cjs/getTranslation.cjs.map +1 -1
  37. package/dist/cjs/getTranslation.d.ts +3 -2
  38. package/dist/cjs/index.cjs +4 -0
  39. package/dist/cjs/index.cjs.map +1 -1
  40. package/dist/cjs/index.d.ts +2 -0
  41. package/dist/cjs/processDictionary/index.cjs +33 -1
  42. package/dist/cjs/processDictionary/index.cjs.map +1 -1
  43. package/dist/cjs/server/IntlayerServerProvider.cjs +1 -1
  44. package/dist/cjs/server/IntlayerServerProvider.cjs.map +1 -1
  45. package/dist/cjs/server/getLocaleTranslation.cjs +1 -1
  46. package/dist/cjs/server/getLocaleTranslation.cjs.map +1 -1
  47. package/dist/cjs/server/useTraduction.cjs.map +1 -1
  48. package/dist/cjs/server/useTraduction.d.ts +4 -3
  49. package/dist/cjs/vite/intlayerPlugin.cjs +60 -0
  50. package/dist/cjs/vite/intlayerPlugin.cjs.map +1 -0
  51. package/dist/cjs/vite/intlayerPlugin.d.ts +17 -0
  52. package/dist/esm/ContentEditor/ContentEditor.mjs +1 -0
  53. package/dist/esm/ContentEditor/ContentEditor.mjs.map +1 -1
  54. package/dist/esm/ContentEditor/contentRender.mjs +1 -0
  55. package/dist/esm/ContentEditor/contentRender.mjs.map +1 -1
  56. package/dist/esm/IntlayerProvider.mjs +3 -2
  57. package/dist/esm/IntlayerProvider.mjs.map +1 -1
  58. package/dist/esm/chunk-ZNCO4QRF.mjs +9 -0
  59. package/dist/esm/chunk-ZNCO4QRF.mjs.map +1 -0
  60. package/dist/esm/cli/react-intlayer.d.mts +1 -0
  61. package/dist/esm/cli/react-intlayer.mjs +45 -0
  62. package/dist/esm/cli/react-intlayer.mjs.map +1 -0
  63. package/dist/esm/client/IntlayerClientProvider.d.mts +2 -1
  64. package/dist/esm/client/IntlayerClientProvider.mjs +33 -7
  65. package/dist/esm/client/IntlayerClientProvider.mjs.map +1 -1
  66. package/dist/esm/client/getBrowserLocale.d.mts +26 -0
  67. package/dist/esm/client/getBrowserLocale.mjs +146 -0
  68. package/dist/esm/client/getBrowserLocale.mjs.map +1 -0
  69. package/dist/esm/client/index.d.mts +2 -0
  70. package/dist/esm/client/index.mjs +5 -0
  71. package/dist/esm/client/index.mjs.map +1 -1
  72. package/dist/esm/client/useContent.mjs +3 -2
  73. package/dist/esm/client/useContent.mjs.map +1 -1
  74. package/dist/esm/client/useIntlayer.mjs +1 -0
  75. package/dist/esm/client/useIntlayer.mjs.map +1 -1
  76. package/dist/esm/client/useLocale.d.mts +1 -0
  77. package/dist/esm/client/useLocale.mjs +7 -4
  78. package/dist/esm/client/useLocale.mjs.map +1 -1
  79. package/dist/esm/client/useLocaleBase.d.mts +14 -0
  80. package/dist/esm/client/useLocaleBase.mjs +26 -0
  81. package/dist/esm/client/useLocaleBase.mjs.map +1 -0
  82. package/dist/esm/client/useLocaleCookie.mjs +3 -4
  83. package/dist/esm/client/useLocaleCookie.mjs.map +1 -1
  84. package/dist/esm/client/useTraduction.d.mts +6 -5
  85. package/dist/esm/client/useTraduction.mjs +1 -0
  86. package/dist/esm/client/useTraduction.mjs.map +1 -1
  87. package/dist/esm/craco/craco.config.d.mts +2 -0
  88. package/dist/esm/craco/craco.config.mjs +17 -0
  89. package/dist/esm/craco/craco.config.mjs.map +1 -0
  90. package/dist/esm/craco/intlayerCracoPlugin.d.mts +26 -0
  91. package/dist/esm/craco/intlayerCracoPlugin.mjs +54 -0
  92. package/dist/esm/craco/intlayerCracoPlugin.mjs.map +1 -0
  93. package/dist/esm/getEnumeration.d.mts +8 -5
  94. package/dist/esm/getEnumeration.mjs +1 -0
  95. package/dist/esm/getEnumeration.mjs.map +1 -1
  96. package/dist/esm/getTranslation.d.mts +3 -2
  97. package/dist/esm/getTranslation.mjs +3 -4
  98. package/dist/esm/getTranslation.mjs.map +1 -1
  99. package/dist/esm/index.d.mts +2 -0
  100. package/dist/esm/index.mjs +6 -1
  101. package/dist/esm/index.mjs.map +1 -1
  102. package/dist/esm/processDictionary/index.mjs +35 -4
  103. package/dist/esm/processDictionary/index.mjs.map +1 -1
  104. package/dist/esm/server/IntlayerServerProvider.mjs +3 -4
  105. package/dist/esm/server/IntlayerServerProvider.mjs.map +1 -1
  106. package/dist/esm/server/getLocaleTranslation.mjs +3 -2
  107. package/dist/esm/server/getLocaleTranslation.mjs.map +1 -1
  108. package/dist/esm/server/index.mjs +1 -0
  109. package/dist/esm/server/index.mjs.map +1 -1
  110. package/dist/esm/server/serverContext.mjs +1 -0
  111. package/dist/esm/server/serverContext.mjs.map +1 -1
  112. package/dist/esm/server/useIntlayer.mjs +1 -0
  113. package/dist/esm/server/useIntlayer.mjs.map +1 -1
  114. package/dist/esm/server/useTraduction.d.mts +4 -3
  115. package/dist/esm/server/useTraduction.mjs +1 -0
  116. package/dist/esm/server/useTraduction.mjs.map +1 -1
  117. package/dist/esm/useIntlayerBase.mjs +1 -0
  118. package/dist/esm/useIntlayerBase.mjs.map +1 -1
  119. package/dist/esm/vite/intlayerPlugin.d.mts +17 -0
  120. package/dist/esm/vite/intlayerPlugin.mjs +36 -0
  121. package/dist/esm/vite/intlayerPlugin.mjs.map +1 -0
  122. package/package.json +30 -5
  123. package/src/IntlayerProvider.tsx +2 -2
  124. package/src/cli/react-intlayer.ts +60 -0
  125. package/src/client/IntlayerClientProvider.tsx +43 -12
  126. package/src/client/getBrowserLocale.tsx +192 -0
  127. package/src/client/index.ts +2 -0
  128. package/src/client/useContent.ts +2 -2
  129. package/src/client/useLocale.ts +5 -4
  130. package/src/client/useLocaleBase.ts +24 -0
  131. package/src/client/useLocaleCookie.ts +2 -5
  132. package/src/client/useTraduction.ts +6 -5
  133. package/src/craco/craco.config.ts +11 -0
  134. package/src/craco/intlayerCracoPlugin.ts +89 -0
  135. package/src/getEnumeration.ts +8 -5
  136. package/src/getTranslation.ts +5 -7
  137. package/src/index.ts +2 -1
  138. package/src/processDictionary/index.ts +52 -5
  139. package/src/server/IntlayerServerProvider.tsx +2 -5
  140. package/src/server/getLocaleTranslation.ts +2 -2
  141. package/src/server/useTraduction.ts +4 -3
  142. package/src/vite/intlayerPlugin.ts +59 -0
@@ -1,13 +1,11 @@
1
1
  /* eslint-disable @typescript-eslint/no-explicit-any */
2
- import {
3
- type Locales,
4
- intlayerIntlConfiguration,
5
- } from '@intlayer/config/client';
2
+ import { type Locales, getConfiguration } from '@intlayer/config/client';
6
3
  import {
7
4
  NodeType,
8
5
  type QuantityContent,
9
6
  type LanguageContent,
10
7
  } from '@intlayer/core';
8
+ import { type ReactElement, createElement, type ReactNode } from 'react';
11
9
  import { getEnumeration } from '../getEnumeration';
12
10
  import { getTranslation } from '../getTranslation';
13
11
  import type {
@@ -17,7 +15,7 @@ import type {
17
15
  TransformedContentValue,
18
16
  } from './contentDictionary';
19
17
 
20
- const defaultLocale = intlayerIntlConfiguration.defaultLocale;
18
+ const { defaultLocale } = getConfiguration().internationalization;
21
19
 
22
20
  const processTranslation = (
23
21
  languageContent: LanguageContent<ContentValue>,
@@ -46,6 +44,9 @@ const processEnumeration = (
46
44
  };
47
45
  };
48
46
 
47
+ const isReactNode = (node: Record<string, unknown>): boolean =>
48
+ typeof node?.key !== 'undefined' && typeof node?.props !== 'undefined';
49
+
49
50
  export const processNode = (
50
51
  field: ContentValue | undefined,
51
52
  locale: Locales
@@ -72,6 +73,45 @@ export const processNode = (
72
73
  return field as TransformedContentValue;
73
74
  };
74
75
 
76
+ // This function recursively creates React elements from a given JSON-like structure
77
+ const createReactElement = (element: ReactElement) => {
78
+ if (typeof element === 'string') {
79
+ // If it's a string, simply return it (used for text content)
80
+ return element;
81
+ }
82
+
83
+ // Destructure the component properties
84
+
85
+ const convertChildrenAsArray = (element: ReactElement): ReactElement => {
86
+ if (element?.props && typeof element.props.children === 'object') {
87
+ const childrenResult: ReactNode[] = [];
88
+ const { children } = element.props;
89
+
90
+ // Create the children elements recursively, if any
91
+ Object.keys(children).forEach((key) => {
92
+ childrenResult.push(createReactElement(children[key]));
93
+ });
94
+
95
+ return {
96
+ ...element,
97
+ props: { ...element.props, children: childrenResult },
98
+ };
99
+ }
100
+
101
+ return {
102
+ ...element,
103
+ props: { ...element.props, children: element.props.children },
104
+ };
105
+ };
106
+
107
+ const fixedElement = convertChildrenAsArray(element);
108
+
109
+ const { type, props } = fixedElement;
110
+
111
+ // Create and return the React element
112
+ return createElement(type ?? 'div', props, ...props.children);
113
+ };
114
+
75
115
  /**
76
116
  * Function that process a dictionary and return the result to be used in the application.
77
117
  */
@@ -79,6 +119,13 @@ export const processDictionary = (
79
119
  content: Content,
80
120
  locale: Locales = defaultLocale
81
121
  ): TransformedContent => {
122
+ // If it's a React element, render it
123
+ if (isReactNode(content)) {
124
+ return createReactElement(
125
+ content as unknown as ReactElement
126
+ ) as unknown as TransformedContent;
127
+ }
128
+
82
129
  if (content && typeof content === 'object') {
83
130
  const result: TransformedContent = {};
84
131
 
@@ -1,7 +1,4 @@
1
- import {
2
- type Locales,
3
- intlayerIntlConfiguration,
4
- } from '@intlayer/config/client';
1
+ import { type Locales, getConfiguration } from '@intlayer/config/client';
5
2
  import type { FC, PropsWithChildren } from 'react';
6
3
  import { createServerContext, getServerContext } from './serverContext';
7
4
 
@@ -9,7 +6,7 @@ import { createServerContext, getServerContext } from './serverContext';
9
6
  * Context that store the current locale on the server side
10
7
  */
11
8
  export const IntlayerServerContext = createServerContext<Locales>(
12
- intlayerIntlConfiguration.defaultLocale
9
+ getConfiguration().internationalization.defaultLocale
13
10
  );
14
11
 
15
12
  /**
@@ -1,4 +1,4 @@
1
- import { intlayerIntlConfiguration } from '@intlayer/config/client';
1
+ import { getConfiguration } from '@intlayer/config/client';
2
2
  import { type LanguageContent, getTranslationContent } from '@intlayer/core';
3
3
  import { IntlayerServerContext } from './IntlayerServerProvider';
4
4
  import { getServerContext } from './serverContext';
@@ -12,7 +12,7 @@ export const getLocaleTranslation = <Content>(
12
12
  const locale = getServerContext(IntlayerServerContext);
13
13
  const content = getTranslationContent<Content>(
14
14
  languageContent,
15
- locale ?? intlayerIntlConfiguration.defaultLocale
15
+ locale ?? getConfiguration().internationalization.defaultLocale
16
16
  );
17
17
 
18
18
  return {
@@ -13,12 +13,13 @@ import { getServerContext } from './serverContext';
13
13
  *
14
14
  * Usage:
15
15
  *
16
- * const content = getTranslation<string>({
16
+ * ```ts
17
+ * const content = useTraduction<string>({
17
18
  * en: 'Hello',
18
19
  * fr: 'Bonjour',
19
- * },
20
- * 'fr');
20
+ * }, 'fr');
21
21
  * // 'Bonjour'
22
+ * ```
22
23
  *
23
24
  * Using TypeScript:
24
25
  * - this function will require each locale to be defined if defined in the project configuration.
@@ -0,0 +1,59 @@
1
+ import { join, relative, resolve } from 'path';
2
+ import { watch } from '@intlayer/chokidar';
3
+ import { getConfiguration, formatEnvVariable } from '@intlayer/config';
4
+ import { loadEnv, type Plugin } from 'vite';
5
+
6
+ // Plugin options type definition
7
+ type PluginOptions = {
8
+ // Custom options for your plugin, if any
9
+ };
10
+
11
+ /**
12
+ *
13
+ * A Vite plugin that integrates IntLayer configuration into the build process
14
+ *
15
+ * ```ts
16
+ * // Example usage of the plugin in a Vite configuration
17
+ * export default defineConfig({
18
+ * plugins: [ intLayerPlugin() ],
19
+ * });
20
+ * ```
21
+ * */
22
+ export const intLayerPlugin = (_pluginOptions: PluginOptions = {}): Plugin => ({
23
+ name: 'vite-intlayer-plugin',
24
+
25
+ config: (config, { mode }) => {
26
+ const intlayerConfig = getConfiguration();
27
+
28
+ // Set all configuration values as environment variables
29
+ const env = formatEnvVariable('vite');
30
+
31
+ process.env = { ...process.env, ...loadEnv(mode, process.cwd()), ...env };
32
+
33
+ const { mainDir, baseDir } = intlayerConfig.content;
34
+ const dictionariesPath = join(mainDir, 'dictionaries.mjs');
35
+ const relativeDictionariesPath = relative(baseDir, dictionariesPath);
36
+
37
+ // Update Vite's resolve alias
38
+ config.resolve = {
39
+ ...config.resolve,
40
+ alias: {
41
+ ...config.resolve?.alias,
42
+ '@intlayer/dictionaries-entry': resolve(relativeDictionariesPath),
43
+ },
44
+ };
45
+
46
+ return config;
47
+ },
48
+
49
+ buildStart: () => {
50
+ // Code to run when Vite build starts
51
+ watch({
52
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
53
+ persistent: (import.meta as any).env === 'development',
54
+ });
55
+ },
56
+ configureServer: (server) => {
57
+ // Custom server configuration, if needed
58
+ },
59
+ });