@yiiamee/multilinguist 1.5.2 → 1.6.0

package/README.md

@@ -31,7 +31,7 @@ export default defineNuxtConfig({
 })
 ```
 
-Then, create a "locales" directory in root directory of your project.
+Then, create a "locales" directory in /public directory. This is necessary for module to access your languages.
 
 ![directory_structure.png](directory_structure.png)
 
@@ -82,24 +82,6 @@ export default defineNuxtConfig({
 })
 ```
 
-Also, if you want to use a different folder name for your locales' files, or you want to specify other path to the directory, you can set the `localesPath` option in your nuxt.config:
-
-```nuxt.config.ts
-export default defineNuxtConfig({
-    modules: [
-        "@yiiamee/multilinguist",
-    ],
-    multilinguist: {
-        defaultLocale: "en",
-        supportedLanguages: ["en", "es"],
-        logging: false,
-        setBrowserLanguage: false, // by default: true
-        localesPath: "./languages", // by default: "./locales"
-    },
-})
-```
-
-### Important! Keep in mind, that it is not recommended to use "public" folder for your locales' files, as it may lead to rendering, security and other issues.
 
 # Usage
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@yiiamee/multilinguist",
   "configKey": "multilinguist",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "compatibility": {
     "nuxt": "^3.0.0 || ^4.0.0"
   },
@@ -9,8 +9,7 @@
     "logging": true,
     "defaultLocale": "",
     "supportedLanguages": [],
-    "setBrowserLanguage": true,
-    "localesPath": "./locales"
+    "setBrowserLanguage": true
   },
   "builder": {
     "@nuxt/module-builder": "1.0.1",

package/dist/module.mjs

@@ -1,6 +1,6 @@
 import { defineNuxtModule, createResolver, addPlugin, addImportsDir } from '@nuxt/kit';
 import fs from 'fs';
-import path, { resolve } from 'path';
+import path from 'path';
 
 function flattenKeys(obj, prefix = "") {
   return Object.entries(obj).flatMap(([key, value]) => {
@@ -49,9 +49,10 @@ declare module 'vue' {
 }
 `;
 };
-function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath, outPath, logging = true) {
+function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, localesPath, outPath, logging = true) {
   async function generateTypes() {
-    const defaultLocalePath = path.join(absoluteLocalesPath, `${defaultLocaleFromConfig}.json`);
+    const defaultLocalePath = path.join(localesPath, `${defaultLocaleFromConfig}.json`);
+    console.log(defaultLocalePath);
     if (!fs.existsSync(defaultLocalePath)) {
       console?.error(`\u274C Default locale file not found: ${defaultLocalePath}`);
       return;
@@ -71,7 +72,7 @@ function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath,
       await generateTypes();
     },
     async handleHotUpdate(ctx) {
-      if (ctx.file.endsWith(".json") && ctx.file.includes(absoluteLocalesPath)) {
+      if (ctx.file.endsWith(".json") && ctx.file.includes(localesPath)) {
         await generateTypes();
       }
     }
@@ -82,7 +83,7 @@ const module = defineNuxtModule({
   meta: {
     name: "@yiiamee/multilinguist",
     configKey: "multilinguist",
-    version: "1.5.2",
+    version: "1.6.0",
     compatibility: {
       nuxt: "^3.0.0 || ^4.0.0"
     },
@@ -90,32 +91,25 @@ const module = defineNuxtModule({
       logging: true,
       defaultLocale: "",
       supportedLanguages: [],
-      setBrowserLanguage: true,
-      localesPath: "./locales"
+      setBrowserLanguage: true
     }
   },
   setup(moduleOptions, nuxtApp) {
     const resolver = createResolver(import.meta.url);
-    const localesPath = moduleOptions.localesPath || "./locales";
-    const resolvedLocalesPath = resolve(nuxtApp.options.rootDir, localesPath);
     addPlugin(resolver.resolve("runtime/plugin"));
     addImportsDir(resolver.resolve("runtime/composables"));
     nuxtApp.options.runtimeConfig.public.multilinguist = {
       defaultLocale: moduleOptions.defaultLocale,
       supportedLanguages: moduleOptions.supportedLanguages,
       logging: typeof moduleOptions.logging === "boolean" ? moduleOptions.logging : true,
-      setBrowserLanguage: typeof moduleOptions.setBrowserLanguage === "boolean" ? moduleOptions.setBrowserLanguage : true,
-      localesPath
-    };
-    nuxtApp.options.runtimeConfig.multilinguist = {
-      resolvedLocalesPath
+      setBrowserLanguage: typeof moduleOptions.setBrowserLanguage === "boolean" ? moduleOptions.setBrowserLanguage : true
     };
     nuxtApp.hook("vite:extendConfig", (viteConfig) => {
       viteConfig.plugins = viteConfig.plugins || [];
       viteConfig.plugins.push(
         GenerateLocaleKeysPlugin(
           moduleOptions.defaultLocale,
-          resolvedLocalesPath,
+          `${nuxtApp.options.rootDir}/public/locales`,
           resolver.resolve("./runtime/types/generated-locales.d.ts"),
           moduleOptions.logging
         )
@@ -126,17 +120,6 @@ const module = defineNuxtModule({
         path: resolver.resolve("./runtime/types/generated-locales.d.ts")
       });
     });
-    if (!localesPath.includes("public")) {
-      nuxtApp.hook("nitro:config", async (nitroConfig) => {
-        nitroConfig.publicAssets = nitroConfig.publicAssets || [];
-        nitroConfig.publicAssets.push({
-          dir: resolvedLocalesPath,
-          maxAge: 60 * 60 * 24 * 7,
-          // 1 week
-          baseURL: `/${localesPath.replace(/^\.\//, "").replace(/^public\//, "")}`
-        });
-      });
-    }
   }
 });
 

package/dist/runtime/composables/useLocalization.js

@@ -1,38 +1,26 @@
 import useLocale from "../composables/useLocale.js";
-import { useCookie, useState, useRuntimeConfig } from "nuxt/app";
+import { useCookie, useState } from "nuxt/app";
 import { computed, watch } from "vue";
 export default function useLocalization(supportedLanguages, defaultLocale, setBrowserLanguage = true) {
   const { locale: userBrowserLocale } = useLocale(supportedLanguages, defaultLocale);
-  const config = useRuntimeConfig();
   const userSelectedLocale = useCookie("multilinguist-locale", {
     default: () => supportedLanguages.includes(userBrowserLocale.value) && setBrowserLanguage ? userBrowserLocale.value : defaultLocale
   });
+  const localeFiles = import.meta.glob("@@/public/locales/*.json", { eager: true });
   const loadedLanguages = useState("loaded-languages", () => ({}));
   const loadLocaleMessages = async (locale2) => {
     if (!loadedLanguages.value[locale2]) {
-      try {
-        const localesPath = config.public.multilinguist.localesPath || "./locales";
-        const normalizedPath = localesPath.startsWith("./") ? localesPath.slice(2) : localesPath.startsWith("/") ? localesPath.slice(1) : localesPath;
-        let messages;
-        if (import.meta.server) {
-          const { readFileSync, existsSync } = await import("fs");
-          const { join } = await import("path");
-          const resolvedPath = config.multilinguist?.resolvedLocalesPath;
-          const filePath = join(resolvedPath, `${locale2}.json`);
-          if (!existsSync(filePath)) {
-            throw new Error(`Locale file not found: ${filePath}`);
-          }
-          const fileContent = readFileSync(filePath, "utf-8");
-          messages = JSON.parse(fileContent);
+      const fileKeyVersion4 = `../public/locales/${locale2}.json`;
+      const fileKeyVersion3 = `/public/locales/${locale2}.json`;
+      const messages = localeFiles[fileKeyVersion4] || localeFiles[fileKeyVersion3];
+      if (messages) {
+        loadedLanguages.value[locale2] = messages?.default;
+      } else {
+        if (!localeFiles[fileKeyVersion4]) {
+          throw new Error(`Locale file ${localeFiles[fileKeyVersion4]} not found`);
         } else {
-          const url = `/${normalizedPath}/${locale2}.json`;
-          const response = await $fetch(url);
-          messages = response;
+          throw new Error(`Locale file ${localeFiles[fileKeyVersion3]} not found`);
         }
-        loadedLanguages.value[locale2] = messages;
-      } catch (error) {
-        console.error(`Failed to load locale '${locale2}':`, error);
-        throw new Error(`Locale file for '${locale2}' not found at configured path`);
       }
     }
   };

package/dist/runtime/types/locale-imports.d.ts

@@ -1,30 +1,8 @@
 export declare const localeFiles: {
     "/locales/en.json": {
-        default: {
-            "Hello, World": string;
-            "Switch Locale": string;
-            "Paste your variable here": string;
-            nested: {
-                "Nested key": string;
-                Language: string;
-                "nested second level": {
-                    "nested second level language": string;
-                };
-            };
-        };
+        default: any;
     };
     "/locales/es.json": {
-        default: {
-            "Hello, World": string;
-            "Switch Locale": string;
-            "Paste your variable here": string;
-            nested: {
-                "Nested key": string;
-                Language: string;
-                "nested second level": {
-                    "nested second level language": string;
-                };
-            };
-        };
+        default: any;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yiiamee/multilinguist",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Nuxt Multilinguist module for localizations",
   "repository": "yiiameeMich/multilinguist",
   "license": "MIT",
@@ -65,7 +65,7 @@
     "@types/node": "latest",
     "changelogen": "^0.6.1",
     "eslint": "^9.27.0",
-    "nuxt": "^4.0.1",
+    "nuxt": "^4.0.3",
     "typescript": "~5.8.3",
     "vitest": "^3.1.4",
     "vue-tsc": "^2.2.10"