feat(api): ✨ Add pathToMessages function for dynamic locale loading

Author: aXenDeveloper

apps/api/src/vitnode.api.config.ts

@@ -13,6 +13,7 @@ export const POSTGRES_URL =
 
 export const vitNodeApiConfig = buildApiConfig({
   plugins: [],
+  pathToMessages: async path => await import(`./locales/${path}`),
   dbProvider: drizzle({
     connection: POSTGRES_URL,
     casing: 'camelCase',

apps/docs/src/vitnode.api.config.ts

@@ -11,6 +11,7 @@ export const POSTGRES_URL =
   process.env.POSTGRES_URL || 'postgresql://root:root@localhost:5432/vitnode';
 
 export const vitNodeApiConfig = buildApiConfig({
+  pathToMessages: async path => await import(`./locales/${path}`),
   captcha: {
     type: 'cloudflare_turnstile',
     siteKey: process.env.CLOUDFLARE_TURNSTILE_SITE_KEY,

packages/create-vitnode-app/copy-of-vitnode-app/api-single-app/src/vitnode.api.config.ts

@@ -6,6 +6,7 @@ export const POSTGRES_URL =
   process.env.POSTGRES_URL || 'postgresql://root:root@localhost:5432/vitnode';
 
 export const vitNodeApiConfig = buildApiConfig({
+  pathToMessages: async path => await import(`./locales/${path}`),
   metadata: {
     title: 'VitNode',
     shortTitle: 'VitNode',

packages/vitnode/scripts/plugin.ts

@@ -254,7 +254,7 @@ export const processPlugin = ({ initMessage }: { initMessage: string }) => {
       // followed by a path separator (or is exactly the sourceDir)
       const normalizedSrcPath = srcPath.replace(/\\/g, '/');
       const normalizedSourceDir = sourceDir.replace(/\\/g, '/');
-      
+
       return (
         normalizedSrcPath === normalizedSourceDir ||
         normalizedSrcPath.startsWith(normalizedSourceDir + '/')

packages/vitnode/src/api/config.ts

@@ -59,6 +59,7 @@ export function VitNodeAPI({
   app.use(
     '*',
     globalMiddleware({
+      pathToMessages: vitNodeApiConfig.pathToMessages,
       email: vitNodeApiConfig.email,
       metadata: vitNodeApiConfig.metadata,
       authorization: vitNodeApiConfig.authorization,

packages/vitnode/src/api/middlewares/global.middleware.ts

@@ -39,7 +39,6 @@ export interface EnvVariablesVitNode {
     };
   };
   core: {
-    plugins: { id: string }[];
     authorization: {
       adminCookieExpires: number;
       adminCookieName: string;
@@ -64,6 +63,8 @@ export interface EnvVariablesVitNode {
       shortTitle?: string;
       title: string;
     };
+    pathToMessages: (path: string) => Promise<{ default: object }>;
+    plugins: { id: string }[];
   };
   db: Pick<VitNodeApiConfig, 'dbProvider'>['dbProvider'];
   email: {
@@ -100,9 +101,15 @@ export const globalMiddleware = ({
   dbProvider,
   captcha,
   plugins,
+  pathToMessages,
 }: Pick<
   VitNodeApiConfig,
-  'authorization' | 'captcha' | 'dbProvider' | 'email' | 'plugins'
+  | 'authorization'
+  | 'captcha'
+  | 'dbProvider'
+  | 'email'
+  | 'pathToMessages'
+  | 'plugins'
 > &
   Pick<VitNodeConfig, 'metadata'>) => {
   return async (c: Context, next: Next) => {
@@ -154,6 +161,7 @@ export const globalMiddleware = ({
     c.set('email', new EmailModel(c));
 
     c.set('core', {
+      pathToMessages,
       metadata,
       email,
       authorization: {

packages/vitnode/src/api/models/email.ts

@@ -6,8 +6,6 @@ import { HTTPException } from 'hono/http-exception';
 
 import DefaultTemplateEmail from '../../emails/default-template';
 import { CONFIG } from '../../lib/config';
-import { join } from 'path';
-import { readFile } from 'fs/promises';
 
 export interface EmailApiPlugin {
   sendEmail: (args: {
@@ -52,16 +50,10 @@ export class EmailModel {
 
     const messagesPromises = pluginIds.map(async pluginId => {
       try {
-        const path = join(
-          process.cwd(),
-          'src',
-          'locales',
-          pluginId,
-          `${locale}.json`,
-        );
-        const messages = await readFile(path, 'utf-8');
+        const path = `${pluginId}/${locale}.json`;
+        const messages = await core.pathToMessages(path);
 
-        return JSON.parse(messages);
+        return messages.default;
       } catch {
         return {};
       }
@@ -71,7 +63,7 @@ export class EmailModel {
     const messages = allMessages.reduce(
       (acc, curr) => ({ ...acc, ...curr }),
       {},
-    );
+    ) as Record<string, string>;
 
     const htmlContent =
       html ??

packages/vitnode/src/emails/default-template.tsx

@@ -19,18 +19,18 @@ import { CONFIG } from '../lib/config';
 interface DefaultTemplateEmailProps {
   children: React.ReactNode;
   head?: React.ReactNode;
+  locale: string;
   logo?: {
     className?: string;
     src: Blob | string;
   };
+  messages: Record<string, string>;
   metadata: {
     shortTitle?: string;
     title: string;
     url: string;
   };
   previewText?: string;
-  messages: Record<string, string>;
-  locale: string;
 }
 
 export default function DefaultTemplateEmail({

packages/vitnode/src/vitnode.config.ts

@@ -54,6 +54,7 @@ export interface VitNodeApiConfig {
     shortTitle?: string;
     title: string;
   };
+  pathToMessages: (path: string) => Promise<{ default: object }>;
   plugins: BuildPluginApiReturn[];
   rateLimiter?: Omit<IRateLimiterOptions, 'keyPrefix'>;
 }