next-intlayer 1.0.0 → 1.2.0

package/dist/esm/server/withIntlayer.mjs

@@ -1,40 +1,37 @@
 import { resolve, relative, join } from "path";
 import { getConfiguration, formatEnvVariable } from "@intlayer/config";
-const intlayerConfig = getConfiguration({
-  verbose: true,
-});
-const env = formatEnvVariable("NEXT_PUBLIC_INTLAYER_");
-const { mainDir, baseDir } = intlayerConfig.content;
-const mergeEnvVariable = (nextEnv = {}) => Object.assign({}, nextEnv, env);
-const mergeStats = (nextStats = {}) =>
-  Object.assign({}, nextStats, {
-    warnings: false,
+import { IntLayerPlugin } from "@intlayer/webpack";
+const withIntlayer = (_pluginOptions = {}) => (nextConfig = {}) => {
+  if (typeof nextConfig !== "object")
+    nextConfig = {};
+  const intlayerConfig = getConfiguration();
+  const env = formatEnvVariable("next");
+  const { mainDir, baseDir } = intlayerConfig.content;
+  return Object.assign({}, nextConfig, {
+    env: { ...nextConfig.env, ...env },
+    webpack: (config, { isServer, nextRuntime }) => {
+      const dictionariesPath = join(mainDir, "dictionaries.cjs");
+      const relativeDictionariesPath = relative(baseDir, dictionariesPath);
+      config.resolve.alias["@intlayer/dictionaries-entry"] = resolve(
+        relativeDictionariesPath
+      );
+      config.externals.push({
+        esbuild: "esbuild",
+        module: "module",
+        fs: "fs"
+      });
+      config.module.rules.push({
+        test: /\.node$/,
+        loader: "node-loader"
+      });
+      if (isServer && nextRuntime === "nodejs") {
+        config.plugins.push(new IntLayerPlugin());
+      }
+      return config;
+    }
   });
-const withIntlayer =
-  (_pluginOptions = {}) =>
-  (nextConfig = {}) => {
-    if (typeof nextConfig !== "object") nextConfig = {};
-    return Object.assign({}, nextConfig, {
-      env: mergeEnvVariable(nextConfig.env),
-      stats: mergeStats(nextConfig.stats),
-      webpack: (config) => {
-        const dictionariesPath = join(mainDir, "dictionaries.cjs");
-        const relativeDictionariesPath = relative(baseDir, dictionariesPath);
-        config.externals.push({
-          esbuild: "esbuild",
-          module: "module",
-          fs: "fs",
-        });
-        config.resolve.alias["@intlayer/dictionaries-entry"] = resolve(
-          relativeDictionariesPath
-        );
-        config.module.rules.push({
-          test: /\.node$/,
-          loader: "node-loader",
-        });
-        return config;
-      },
-    });
-  };
-export { withIntlayer };
-//# sourceMappingURL=withIntlayer.mjs.map
+};
+export {
+  withIntlayer
+};
+//# sourceMappingURL=withIntlayer.mjs.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/server/withIntlayer.ts"],"sourcesContent":["import { resolve, relative, join } from 'path';\nimport { getConfiguration, formatEnvVariable } from '@intlayer/config';\nimport type { NextConfig } from 'next';\nimport type { NextJsWebpackConfig } from 'next/dist/server/config-shared';\n\ntype PluginOptions = {\n  // TODO: add options\n};\n\nconst intlayerConfig = getConfiguration({\n  verbose: true,\n});\n\n// Set all configuration values as environment variables\nconst env = formatEnvVariable('NEXT_PUBLIC_INTLAYER_');\nconst { mainDir, baseDir } = intlayerConfig.content;\n\nconst mergeEnvVariable = (\n  nextEnv: Record<string, unknown> | undefined = {}\n): Record<string, string> => Object.assign({}, nextEnv, env);\n\nconst mergeStats = (\n  nextStats: Record<string, unknown> | undefined = {}\n): Record<string, unknown> =>\n  Object.assign({}, nextStats, {\n    warnings: false,\n  });\n\nexport const withIntlayer =\n  (_pluginOptions: PluginOptions = {}) =>\n  (nextConfig: Partial<NextConfig> = {}): Partial<NextConfig> => {\n    if (typeof nextConfig !== 'object') nextConfig = {};\n\n    return Object.assign({}, nextConfig, {\n      env: mergeEnvVariable(nextConfig.env),\n\n      stats: mergeStats(nextConfig.stats),\n\n      webpack: (config: Parameters<NextJsWebpackConfig>['0']) => {\n        const dictionariesPath = join(mainDir, 'dictionaries.cjs');\n        const relativeDictionariesPath = relative(baseDir, dictionariesPath);\n\n        config.externals.push({\n          esbuild: 'esbuild',\n          module: 'module',\n          fs: 'fs',\n        });\n\n        config.resolve.alias['@intlayer/dictionaries-entry'] = resolve(\n          relativeDictionariesPath\n        );\n\n        config.module.rules.push({\n          test: /\\.node$/,\n          loader: 'node-loader',\n        });\n\n        return config;\n      },\n    });\n  };\n"],"mappings":"AAAA,SAAS,SAAS,UAAU,YAAY;AACxC,SAAS,kBAAkB,yBAAyB;AAQpD,MAAM,iBAAiB,iBAAiB;AAAA,EACtC,SAAS;AACX,CAAC;AAGD,MAAM,MAAM,kBAAkB,uBAAuB;AACrD,MAAM,EAAE,SAAS,QAAQ,IAAI,eAAe;AAE5C,MAAM,mBAAmB,CACvB,UAA+C,CAAC,MACrB,OAAO,OAAO,CAAC,GAAG,SAAS,GAAG;AAE3D,MAAM,aAAa,CACjB,YAAiD,CAAC,MAElD,OAAO,OAAO,CAAC,GAAG,WAAW;AAAA,EAC3B,UAAU;AACZ,CAAC;AAEI,MAAM,eACX,CAAC,iBAAgC,CAAC,MAClC,CAAC,aAAkC,CAAC,MAA2B;AAC7D,MAAI,OAAO,eAAe;AAAU,iBAAa,CAAC;AAElD,SAAO,OAAO,OAAO,CAAC,GAAG,YAAY;AAAA,IACnC,KAAK,iBAAiB,WAAW,GAAG;AAAA,IAEpC,OAAO,WAAW,WAAW,KAAK;AAAA,IAElC,SAAS,CAAC,WAAiD;AACzD,YAAM,mBAAmB,KAAK,SAAS,kBAAkB;AACzD,YAAM,2BAA2B,SAAS,SAAS,gBAAgB;AAEnE,aAAO,UAAU,KAAK;AAAA,QACpB,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,IAAI;AAAA,MACN,CAAC;AAED,aAAO,QAAQ,MAAM,8BAA8B,IAAI;AAAA,QACrD;AAAA,MACF;AAEA,aAAO,OAAO,MAAM,KAAK;AAAA,QACvB,MAAM;AAAA,QACN,QAAQ;AAAA,MACV,CAAC;AAED,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../../../src/server/withIntlayer.ts"],"sourcesContent":["import { resolve, relative, join } from 'path';\nimport { getConfiguration, formatEnvVariable } from '@intlayer/config';\nimport { IntLayerPlugin } from '@intlayer/webpack';\nimport type { NextConfig } from 'next';\nimport type { NextJsWebpackConfig } from 'next/dist/server/config-shared';\n\ntype PluginOptions = {\n  // TODO: add options\n};\n\ntype WebpackParams = Parameters<NextJsWebpackConfig>;\n\n/**\n * A Next.js plugin that adds the intlayer configuration to the webpack configuration\n * and sets the environment variables\n *\n * Usage:\n *\n * // next.config.js\n * export default withIntlayer(nextConfig)\n *\n */\nexport const withIntlayer =\n  (_pluginOptions: PluginOptions = {}) =>\n  (nextConfig: Partial<NextConfig> = {}): Partial<NextConfig> => {\n    if (typeof nextConfig !== 'object') nextConfig = {};\n\n    const intlayerConfig = getConfiguration();\n\n    // Set all configuration values as environment variables\n    const env = formatEnvVariable('next');\n\n    const { mainDir, baseDir } = intlayerConfig.content;\n\n    return Object.assign({}, nextConfig, {\n      env: { ...nextConfig.env, ...env },\n\n      webpack: (\n        config: WebpackParams['0'],\n        { isServer, nextRuntime }: WebpackParams[1]\n      ) => {\n        const dictionariesPath = join(mainDir, 'dictionaries.cjs');\n        const relativeDictionariesPath = relative(baseDir, dictionariesPath);\n\n        config.resolve.alias['@intlayer/dictionaries-entry'] = resolve(\n          relativeDictionariesPath\n        );\n\n        config.externals.push({\n          esbuild: 'esbuild',\n          module: 'module',\n          fs: 'fs',\n        });\n        config.module.rules.push({\n          test: /\\.node$/,\n          loader: 'node-loader',\n        });\n\n        // Apply IntLayerPlugin only on the server-side\n        if (isServer && nextRuntime === 'nodejs') {\n          config.plugins.push(new IntLayerPlugin());\n        }\n\n        return config;\n      },\n    });\n  };\n"],"mappings":"AAAA,SAAS,SAAS,UAAU,YAAY;AACxC,SAAS,kBAAkB,yBAAyB;AACpD,SAAS,sBAAsB;AAoBxB,MAAM,eACX,CAAC,iBAAgC,CAAC,MAClC,CAAC,aAAkC,CAAC,MAA2B;AAC7D,MAAI,OAAO,eAAe;AAAU,iBAAa,CAAC;AAElD,QAAM,iBAAiB,iBAAiB;AAGxC,QAAM,MAAM,kBAAkB,MAAM;AAEpC,QAAM,EAAE,SAAS,QAAQ,IAAI,eAAe;AAE5C,SAAO,OAAO,OAAO,CAAC,GAAG,YAAY;AAAA,IACnC,KAAK,EAAE,GAAG,WAAW,KAAK,GAAG,IAAI;AAAA,IAEjC,SAAS,CACP,QACA,EAAE,UAAU,YAAY,MACrB;AACH,YAAM,mBAAmB,KAAK,SAAS,kBAAkB;AACzD,YAAM,2BAA2B,SAAS,SAAS,gBAAgB;AAEnE,aAAO,QAAQ,MAAM,8BAA8B,IAAI;AAAA,QACrD;AAAA,MACF;AAEA,aAAO,UAAU,KAAK;AAAA,QACpB,SAAS;AAAA,QACT,QAAQ;AAAA,QACR,IAAI;AAAA,MACN,CAAC;AACD,aAAO,OAAO,MAAM,KAAK;AAAA,QACvB,MAAM;AAAA,QACN,QAAQ;AAAA,MACV,CAAC;AAGD,UAAI,YAAY,gBAAgB,UAAU;AACxC,eAAO,QAAQ,KAAK,IAAI,eAAe,CAAC;AAAA,MAC1C;AAEA,aAAO;AAAA,IACT;AAAA,EACF,CAAC;AACH;","names":[]}

package/dist/esm/types/NextPage.d.mts

@@ -1,11 +1,11 @@
-import { Locales } from "intlayer";
-import { NextPage } from "next";
-import { PropsWithChildren } from "react";
+import { Locales } from 'intlayer';
+import { NextPage } from 'next';
+import { PropsWithChildren } from 'react';
 
 type LocalParams = {
-  params: {
-    locale: Locales;
-  };
+    params: {
+        locale: Locales;
+    };
 };
 type NextPageIntlayer = NextPage<LocalParams>;
 type NextLayoutIntlayer = NextPage<PropsWithChildren<LocalParams>>;

package/dist/esm/types/NextPage.mjs

@@ -1 +1 @@
-//# sourceMappingURL=NextPage.mjs.map
+//# sourceMappingURL=NextPage.mjs.map

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

@@ -1,4 +1,4 @@
-export { LocalParams, NextPageIntlayer } from "./NextPage.mjs";
-import "intlayer";
-import "next";
-import "react";
+export { LocalParams, NextPageIntlayer } from './NextPage.mjs';
+import 'intlayer';
+import 'next';
+import 'react';

package/dist/esm/types/index.mjs

@@ -1 +1 @@
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intlayer",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "private": false,
   "description": "Webpack configuration for IntLayer using NextJS",
   "keywords": [
@@ -17,7 +17,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": {
@@ -66,22 +66,24 @@
     "negotiator": "^0.6.3",
     "next": "14.1.4",
     "webpack": "^5.91.0",
-    "@intlayer/core": "^1.0.0",
-    "@intlayer/config": "^1.0.0",
-    "intlayer": "^1.0.0",
-    "@intlayer/dictionaries-entry": "^1.0.0",
-    "react-intlayer": "^1.0.0"
+    "@intlayer/chokidar": "^1.2.0",
+    "@intlayer/config": "^1.2.0",
+    "@intlayer/core": "^1.2.0",
+    "@intlayer/dictionaries-entry": "^1.2.0",
+    "@intlayer/webpack": "^1.2.0",
+    "intlayer": "^1.2.0",
+    "react-intlayer": "^1.2.0"
   },
   "devDependencies": {
     "@types/negotiator": "^0.6.3",
-    "@types/node": "^20.11.30",
-    "@types/react": "^18.2.78",
+    "@types/node": "^20.12.7",
+    "@types/react": "^18.2.79",
     "react": "^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/client/index.ts

@@ -1,7 +1,7 @@
 export {
   getTranslation,
-  LocaleClientContextProvider,
-  LocaleClientContext,
+  IntlayerClientProvider,
+  IntlayerClient,
   useIntlayer,
   useTraduction,
   useLocaleCookie,

package/src/client/useLocale.ts

@@ -1,5 +1,7 @@
-import { intlayerMiddlewareConfiguration } from '@intlayer/config/client';
-import type { Locales } from 'intlayer';
+import {
+  type Locales,
+  intlayerMiddlewareConfiguration,
+} from '@intlayer/config/client';
 import { usePathname, useRouter } from 'next/navigation.js';
 import { useLocale as useReactLocale, useLocaleCookie } from 'react-intlayer';
 
@@ -18,7 +20,7 @@ export const useLocale = () => {
   } = reactLocaleHook;
 
   const setLocale = (locale: Locales) => {
-    if (currentLocale === locale) return;
+    if (currentLocale.toString() === locale.toString()) return;
 
     if (!availableLocales.includes(locale)) {
       console.error(`Locale ${locale} is not available`);
@@ -28,7 +30,7 @@ export const useLocale = () => {
     setLocaleCookie(locale);
 
     const pathWithoutLocale =
-      !prefixDefault && currentLocale === defaultLocale
+      !prefixDefault && currentLocale.toString() === defaultLocale.toString()
         ? pathname
         : pathname.slice(`/${currentLocale}`.length) || '/';
 

package/src/index.ts

@@ -1,7 +1,7 @@
 export {
   getTranslation,
-  LocaleClientContextProvider,
-  LocaleClientContext,
+  IntlayerClientProvider,
+  IntlayerClient,
   useIntlayer,
   useTraduction,
   useLocaleCookie,

package/src/middleware/intlayerMiddleware.ts

@@ -13,6 +13,21 @@ const {
   noPrefix,
 } = middleware;
 
+/**
+ * Middleware that handles the internationalization layer
+ *
+ * Usage:
+ *
+ * // ./src/middleware.ts
+ *
+ * export { intlayerMiddleware as middleware } from '@intlayer/next/middleware';
+ *
+ * // applies this middleware only to files in the app directory
+ * export const config = {
+ *   matcher: '/((?!api|static|.*\\..*|_next).*)',
+ * };
+ *
+ */
 export const intlayerMiddleware = (request: NextRequest): NextResponse => {
   const pathname = request.nextUrl.pathname;
   const cookieLocale = getCookieLocale(request);

package/src/middleware/localeDetector.ts

@@ -6,6 +6,11 @@ import type { NextRequest } from 'next/server.js';
 
 const { locales, defaultLocale } = getConfiguration().internationalization;
 
+/**
+ * Detects the locale from the request headers
+ *
+ * Headers are provided by the browser and can be used to determine the user's preferred language
+ */
 export const localeDetector = (request: NextRequest): Locales => {
   const negotiatorHeaders: Record<string, string> = {};
 

package/src/server/index.ts

@@ -1,8 +1,8 @@
 export {
   getLocaleContent,
   useTraduction,
-  LocaleServerContext,
-  LocaleServerContextProvider,
+  IntlayerServer,
+  IntlayerServerProvider,
   locale,
   useIntlayer,
 } from 'react-intlayer/server';

package/src/server/withIntlayer.ts

@@ -1,5 +1,6 @@
 import { resolve, relative, join } from 'path';
 import { getConfiguration, formatEnvVariable } from '@intlayer/config';
+import { IntLayerPlugin } from '@intlayer/webpack';
 import type { NextConfig } from 'next';
 import type { NextJsWebpackConfig } from 'next/dist/server/config-shared';
 
@@ -7,54 +8,59 @@ type PluginOptions = {
   // TODO: add options
 };
 
-const intlayerConfig = getConfiguration({
-  verbose: true,
-});
-
-// Set all configuration values as environment variables
-const env = formatEnvVariable('NEXT_PUBLIC_INTLAYER_');
-const { mainDir, baseDir } = intlayerConfig.content;
-
-const mergeEnvVariable = (
-  nextEnv: Record<string, unknown> | undefined = {}
-): Record<string, string> => Object.assign({}, nextEnv, env);
-
-const mergeStats = (
-  nextStats: Record<string, unknown> | undefined = {}
-): Record<string, unknown> =>
-  Object.assign({}, nextStats, {
-    warnings: false,
-  });
+type WebpackParams = Parameters<NextJsWebpackConfig>;
 
+/**
+ * A Next.js plugin that adds the intlayer configuration to the webpack configuration
+ * and sets the environment variables
+ *
+ * Usage:
+ *
+ * // next.config.js
+ * export default withIntlayer(nextConfig)
+ *
+ */
 export const withIntlayer =
   (_pluginOptions: PluginOptions = {}) =>
   (nextConfig: Partial<NextConfig> = {}): Partial<NextConfig> => {
     if (typeof nextConfig !== 'object') nextConfig = {};
 
-    return Object.assign({}, nextConfig, {
-      env: mergeEnvVariable(nextConfig.env),
+    const intlayerConfig = getConfiguration();
+
+    // Set all configuration values as environment variables
+    const env = formatEnvVariable('next');
 
-      stats: mergeStats(nextConfig.stats),
+    const { mainDir, baseDir } = intlayerConfig.content;
 
-      webpack: (config: Parameters<NextJsWebpackConfig>['0']) => {
+    return Object.assign({}, nextConfig, {
+      env: { ...nextConfig.env, ...env },
+
+      webpack: (
+        config: WebpackParams['0'],
+        { isServer, nextRuntime }: WebpackParams[1]
+      ) => {
         const dictionariesPath = join(mainDir, 'dictionaries.cjs');
         const relativeDictionariesPath = relative(baseDir, dictionariesPath);
 
+        config.resolve.alias['@intlayer/dictionaries-entry'] = resolve(
+          relativeDictionariesPath
+        );
+
         config.externals.push({
           esbuild: 'esbuild',
           module: 'module',
           fs: 'fs',
         });
-
-        config.resolve.alias['@intlayer/dictionaries-entry'] = resolve(
-          relativeDictionariesPath
-        );
-
         config.module.rules.push({
           test: /\.node$/,
           loader: 'node-loader',
         });
 
+        // Apply IntLayerPlugin only on the server-side
+        if (isServer && nextRuntime === 'nodejs') {
+          config.plugins.push(new IntLayerPlugin());
+        }
+
         return config;
       },
     });