Merge branch 'main' into dependabot/npm_and_yarn/ejs-3.1.10

docs/guides/nested.md

@@ -28,10 +28,13 @@ Here is an example of how this looks in your translation files
 ```
 
 ```typescript
+i18n.t('test.PAGE_HOME.TITLE', {args: {} })
+// => Home to this World
+
 i18n.t('test.PAGE_HOME.SUBTITLE', {args: { username: 'Toon' } })
 // => Hello Toon, this is the home page
 ```
 
 :::tip
 The [`formatter`](guides/formatting.md) is applied before doing nested translations. This way you can pass on arguments to your nested translations! 🎉
-:::
+:::

docs/guides/type-safety.md

@@ -102,7 +102,7 @@ For now type safety is optional and need to be enabled. We're planning to make a
 
 You can also use the generated types in your DTOs. This way you can reduce the chance of having a typo in your validation messages.
 
-```typescript title="src/craete-user.dto.ts"
+```typescript title="src/create-user.dto.ts"
 import { I18nTranslations } from './generated/i18n.generated.ts';
 import {
   IsEmail,

docs/quick-start.mdx

@@ -326,11 +326,16 @@ import { I18nContext, I18nService } from 'nestjs-i18n';
 export class AppService {
   constructor(private readonly i18n: I18nService) {}
   getHello(): string {
-    return this.i18n.t('test.HELLO',{ lang:   I18nContext.current().lang });
+    return this.i18n.t('test.HELLO');
+  }
+
+  getHelloInSpecificLanguage(): string {
+    return this.i18n.t('test.HELLO',{ lang: "en" });
   }
 }
 ```
 
+
 ## Translate options
 
 ```typescript

package.json

@@ -1,12 +1,12 @@
 {
   "name": "nestjs-i18n",
-  "version": "10.4.5",
+  "version": "10.4.7",
   "homepage": "https://nestjs-i18n.com",
   "description": "The i18n module for Nest.",
   "author": "Toon van Strijp",
   "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "keywords": [
     "nestjs",

src/filters/i18n-validation-exception.filter.ts

@@ -90,18 +90,18 @@ export class I18nValidationExceptionFilter implements ExceptionFilter {
   protected buildResponseBody(
     host: ArgumentsHost,
     exc: I18nValidationException,
-    errors: string[] | I18nValidationError[] | object,
+    error: string[] | I18nValidationError[] | object,
   ) {
     if ('responseBodyFormatter' in this.options) {
-      return this.options.responseBodyFormatter(host, exc, errors);
+      return this.options.responseBodyFormatter(host, exc, error);
     } else {
       return {
         statusCode:
           this.options.errorHttpStatusCode === undefined
             ? exc.getStatus()
             : this.options.errorHttpStatusCode,
-        message: exc.getResponse(),
-        errors,
+        message: error,
+        error: exc.getResponse(),
       };
     }
   }

src/i18n.context.ts

@@ -1,6 +1,6 @@
 import { ArgumentsHost } from '@nestjs/common';
 import { AsyncLocalStorage } from 'async_hooks';
-import { I18nTranslator, I18nValidationError } from './interfaces';
+import { I18nOptions, I18nTranslator, I18nValidationError } from './interfaces';
 import { I18nService, TranslateOptions } from './services/i18n.service';
 import { Path, PathValue } from './types';
 import { getContextObject } from './utils';
@@ -16,7 +16,7 @@ export class I18nContext<K = Record<string, unknown>>
     return this;
   }
 
-  constructor(readonly lang: string, readonly service: I18nService<K>) {}
+  constructor(readonly lang: string, readonly service: I18nService<K>, readonly i18nOptions: I18nOptions,) {}
 
   public translate<P extends Path<K> = any, R = PathValue<K, P>>(
     key: P,
@@ -64,7 +64,7 @@ export class I18nContext<K = Record<string, unknown>>
     const i18n = this.storage.getStore() as I18nContext<K> | undefined;
 
     if (!i18n && !!context) {
-      return getContextObject(context)?.i18nContext;
+      return getContextObject(i18n.i18nOptions,context)?.i18nContext;
     }
 
     return i18n;

src/interceptors/i18n-language.interceptor.ts

@@ -37,7 +37,7 @@ export class I18nLanguageInterceptor implements NestInterceptor {
     const i18nContext = I18nContext.current();
     let language = null;
 
-    const ctx = getContextObject(context);
+    const ctx = getContextObject(this.i18nOptions,context);
 
     // Skip interceptor if language is already resolved (in case of http middleware) or when ctx is undefined (unsupported context)
     if (ctx === undefined || !!ctx.i18nLang) {
@@ -68,7 +68,7 @@ export class I18nLanguageInterceptor implements NestInterceptor {
     }
 
     if (!i18nContext) {
-      ctx.i18nContext = new I18nContext(ctx.i18nLang, this.i18nService);
+      ctx.i18nContext = new I18nContext(ctx.i18nLang, this.i18nService, this.i18nOptions);
 
       if (!this.i18nOptions.skipAsyncHook) {
         return new Observable((observer) => {

src/middlewares/i18n.middleware.ts

@@ -66,7 +66,7 @@ export class I18nMiddleware implements NestMiddleware {
       req.app.locals.i18nLang = req.i18nLang;
     }
 
-    req.i18nContext = new I18nContext(req.i18nLang, this.i18nService);
+    req.i18nContext = new I18nContext(req.i18nLang, this.i18nService, this.i18nOptions);
 
     if (this.i18nOptions.skipAsyncHook) {
       next();
@@ -92,7 +92,11 @@ export class I18nMiddleware implements NestMiddleware {
 class MiddlewareHttpContext
   implements ExecutionContext, ArgumentsHost, HttpArgumentsHost
 {
-  constructor(private req: any, private res: any, private next: any) {}
+  constructor(
+    private req: any,
+    private res: any,
+    private next: any,
+  ) {}
 
   getClass<T = any>(): Type<T> {
     throw ExecutionContextMethodNotImplemented;

src/services/i18n.service.ts

@@ -8,7 +8,12 @@ import {
   take,
   takeUntil,
 } from 'rxjs';
-import { I18nOptions, I18nTranslation, I18nValidationError } from '..';
+import {
+  I18nContext,
+  I18nOptions,
+  I18nTranslation,
+  I18nValidationError,
+} from '..';
 import {
   I18N_LANGUAGES,
   I18N_LANGUAGES_SUBJECT,
@@ -75,7 +80,7 @@ export class I18nService<K = Record<string, unknown>>
     options?: TranslateOptions,
   ): IfAnyOrNever<R, string, R> {
     options = {
-      lang: this.i18nOptions.fallbackLanguage,
+      lang: I18nContext.current()?.lang || this.i18nOptions.fallbackLanguage,
       ...options,
     };
 

src/utils/context.ts

@@ -1,8 +1,10 @@
 import { ArgumentsHost, ExecutionContext, Logger } from '@nestjs/common';
+import { I18nOptions } from '..';
 
 const logger = new Logger('I18nService');
 
 export function getContextObject(
+  i18nOptions: I18nOptions,
   context?: ExecutionContext | ArgumentsHost,
 ): any {
   const contextType = context?.getType<string>() ?? 'undefined';
@@ -17,6 +19,8 @@ export function getContextObject(
     case 'rmq':
       return context.getArgs()[1];
     default:
-      logger.warn(`context type: ${contextType} not supported`);
+      if(i18nOptions.logging){
+        logger.warn(`context type: ${contextType} not supported`);
+      }
   }
 }

src/utils/typescript.ts

@@ -42,7 +42,7 @@ export const convertObjectToTypeDefinition = async (
   return [];
 };
 
-const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed, });
+const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
 
 export const createTypesFile = async (object: any) => {
   const sourceFile = ts.createSourceFile(

tests/app/cats/cat.resolver.ts

@@ -39,6 +39,14 @@ export class CatResolver {
     return cat;
   }
 
+  @Query('catUsingService')
+  async getCatUsingService(@Args('id') id: number) {
+    const cat = await this.catService.findById(id);
+    // we manually overwrite this property to indicate a value that is translated!
+    cat.description = this.i18nService.translate('test.cat');
+    return cat;
+  }
+
   @Mutation('createCat')
   async create(@Args('createCatInput') args: CreateCatInput): Promise<any> {
     await this.pubSub.publish('catAdded', { catAdded: args.name });

tests/app/cats/cat.types.graphql

@@ -9,6 +9,7 @@ type Query {
   cats: [Cat]
   cat(id: Int!): Cat
   catUsingContext(id: Int!): Cat
+  catUsingService(id: Int!): Cat
 }
 
 type Mutation {
@@ -23,4 +24,4 @@ type Subscription {
 input CreateCatInput {
   name: String
   age: Int
-}
+}

tests/app/controllers/hello.controller.ts

@@ -22,7 +22,10 @@ import { CreateUserDto } from '../dto/create-user.dto';
 import { TestException, TestExceptionFilter } from '../filter/test.filter';
 import { TestGuard } from '../guards/test.guard';
 import { Hero, HeroById } from '../interfaces/hero.interface';
-import { exampleErrorFormatter, exampleResponseBodyFormatter } from '../examples/example.functions';
+import {
+  exampleErrorFormatter,
+  exampleResponseBodyFormatter,
+} from '../examples/example.functions';
 import { TestInterceptor } from '../interceptors/test.interceptor';
 
 @Controller('hello')
@@ -35,6 +38,11 @@ export class HelloController {
     return this.i18n.translate('test.HELLO', { lang });
   }
 
+  @Get('/no-lang-for-service')
+  helloNoLangForService(): any {
+    return this.i18n.translate('test.HELLO');
+  }
+
   @Get('/typed')
   helloTyped(@I18nLang() lang: string): string {
     return this.i18n.translate('test.HELLO', { lang });
@@ -59,6 +67,11 @@ export class HelloController {
     return this.i18n.t('test.HELLO', { lang });
   }
 
+  @Get('/short/no-lang-for-service')
+  helloShortNoLangForService(): any {
+    return this.i18n.t('test.HELLO');
+  }
+
   @Get('/short/typed')
   helloShortTyped(@I18nLang() lang: string): string {
     return this.i18n.t('test.HELLO', { lang });
@@ -228,4 +241,18 @@ export class HelloController {
     ];
     return items.find(({ id }) => id === data.id);
   }
+
+  @GrpcMethod('HeroesService', 'FindOneTranslatedWithService')
+  findOneTranslatedWithService(@Payload() data: HeroById): Hero {
+    const items = [
+      {
+        id: 1,
+        name: this.i18n.t('test.set-up-password.heading', {
+          args: { username: 'John' },
+        }),
+      },
+      { id: 2, name: 'Doe' },
+    ];
+    return items.find(({ id }) => id === data.id);
+  }
 }

tests/app/hero.proto

@@ -4,6 +4,7 @@ package hero;
 
 service HeroesService {
   rpc FindOne (HeroById) returns (Hero) {}
+  rpc FindOneTranslatedWithService (HeroById) returns (Hero) {}
 }
 
 message HeroById {

tests/app/interfaces/hero.interface.ts

@@ -12,4 +12,8 @@ export interface HeroById {
 
 export interface HeroService {
   findOne(data: HeroById, metadata: Metadata): Observable<Hero>;
+  findOneTranslatedWithService(
+    data: HeroById,
+    metadata: Metadata,
+  ): Observable<Hero>;
 }