i18next-http-middleware 3.0.3 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [v3.1.0](https://github.com/i18next/i18next-http-middleware/compare/v3.0.6...v3.1.0)
+- added types
+
+## [v3.0.6](https://github.com/i18next/i18next-http-middleware/compare/v3.0.5...v3.0.6)
+- ignoreCase option true by default
+
+## [v3.0.5](https://github.com/i18next/i18next-http-middleware/compare/v3.0.4...v3.0.5)
+- introduce ignoreCase option
+
+## [v3.0.4](https://github.com/i18next/i18next-http-middleware/compare/v3.0.3...v3.0.4)
+- fix language detection algorithm to handle fallbackLng correctly
+
 ## [v3.0.3](https://github.com/i18next/i18next-http-middleware/compare/v3.0.2...v3.0.3)
 - prevent URIError with cookie language detector
 

package/README.md

@@ -296,6 +296,8 @@ As with all modules you can either pass the constructor function (class) to the
   // cache user language
   caches: false, // ['cookie']
 
+  ignoreCase: true, // ignore case of detected language
+
   // optional expire and domain for set cookie
   cookieExpirationDate: new Date(),
   cookieDomain: 'myDomain',

package/cjs/LanguageDetector.js

@@ -41,7 +41,8 @@ function getDefaults() {
     lookupSession: 'lng',
     lookupFromPathIndex: 0,
     caches: false,
-    cookieSameSite: 'strict'
+    cookieSameSite: 'strict',
+    ignoreCase: true
   });
 }
 
@@ -94,6 +95,17 @@ var LanguageDetector = function () {
 
         if (_this.services.languageUtils.getBestMatchFromCodes) {
           found = _this.services.languageUtils.getBestMatchFromCodes(detections);
+
+          if (found) {
+            if (_this.options.ignoreCase) {
+              if (detections.map(function (d) {
+                return d.toLowerCase();
+              }).indexOf(found.toLowerCase()) < 0) found = undefined;
+            } else {
+              if (detections.indexOf(found) < 0) found = undefined;
+            }
+          }
+
           if (found) req.i18nextLookupName = detectorName;
         } else {
           found = detections.length > 0 ? detections[0] : null;

package/cjs/httpFunctions.js

@@ -90,7 +90,8 @@ var getCookies = function getCookies(req) {
 exports.getCookies = getCookies;
 
 var getBody = function getBody(req) {
-  if (req.ctx && req.ctx.body) return req.ctx.body.bind(req.ctx);
+  if (req.ctx && typeof req.ctx.body === 'function') return req.ctx.body.bind(req.ctx);
+  if (req.ctx && req.ctx.body) return req.ctx.body;
   if (req.json) return req.json;
   if (req.body) return req.body;
   console.log('no possibility found to get body');

package/cjs/languageLookups/cookie.js

@@ -80,7 +80,7 @@ var _default = {
 
     if (options.lookupCookie && typeof req !== 'undefined') {
       var cookies = options.getCookies(req);
-      found = cookies[options.lookupCookie];
+      if (cookies) found = cookies[options.lookupCookie];
     }
 
     return found;

package/esm/LanguageDetector.js

@@ -20,7 +20,8 @@ function getDefaults() {
     lookupSession: 'lng',
     lookupFromPathIndex: 0,
     caches: false,
-    cookieSameSite: 'strict'
+    cookieSameSite: 'strict',
+    ignoreCase: true
   });
 }
 
@@ -73,6 +74,17 @@ var LanguageDetector = function () {
 
         if (_this.services.languageUtils.getBestMatchFromCodes) {
           found = _this.services.languageUtils.getBestMatchFromCodes(detections);
+
+          if (found) {
+            if (_this.options.ignoreCase) {
+              if (detections.map(function (d) {
+                return d.toLowerCase();
+              }).indexOf(found.toLowerCase()) < 0) found = undefined;
+            } else {
+              if (detections.indexOf(found) < 0) found = undefined;
+            }
+          }
+
           if (found) req.i18nextLookupName = detectorName;
         } else {
           found = detections.length > 0 ? detections[0] : null;

package/esm/httpFunctions.js

@@ -59,7 +59,8 @@ export var getCookies = function getCookies(req) {
   console.log('no possibility found to get cookies');
 };
 export var getBody = function getBody(req) {
-  if (req.ctx && req.ctx.body) return req.ctx.body.bind(req.ctx);
+  if (req.ctx && typeof req.ctx.body === 'function') return req.ctx.body.bind(req.ctx);
+  if (req.ctx && req.ctx.body) return req.ctx.body;
   if (req.json) return req.json;
   if (req.body) return req.body;
   console.log('no possibility found to get body');

package/esm/languageLookups/cookie.js

@@ -74,7 +74,7 @@ export default {
 
     if (options.lookupCookie && typeof req !== 'undefined') {
       var cookies = options.getCookies(req);
-      found = cookies[options.lookupCookie];
+      if (cookies) found = cookies[options.lookupCookie];
     }
 
     return found;

package/index.d.ts

@@ -0,0 +1,175 @@
+import {
+  Application,
+  Handler,
+  NextFunction,
+  Request,
+  RequestHandler,
+  Response,
+  Router,
+} from "express-serve-static-core";
+import * as i18next from "i18next";
+
+/// <reference types="express-serve-static-core" />
+
+type I18next = i18next.i18n;
+type App = Application | Router;
+
+type I18NextRequest = {
+  language: string;
+  languages: string[];
+  i18n: i18next.i18n;
+  t: i18next.TFunction;
+};
+
+declare global {
+  namespace Express {
+    interface Request extends I18NextRequest {}
+  }
+}
+
+interface ExtendedOptions extends Object {
+  getPath?: (req: Request) => string;
+  getOriginalUrl?: (req: Request) => string;
+  getUrl?: (req: Request) => string;
+  setUrl?: (req: Request, url: string) => void;
+  getParams?: (req: Request) => Object;
+  getSession?: (req: Request) => Object;
+  getQuery?: (req: Request) => Object;
+  getCookies?: (req: Request) => Object;
+  getBody?: (req: Request) => Object;
+  getHeaders?: (req: Request) => Object;
+  getHeader?: (res: Response, name: string) => Object;
+  setHeader?: (res: Response, name: string, value: string) => void;
+  setContentType?: (res: Response, type: string) => void;
+  setStatus?: (res: Response, code: number) => void;
+  send?: (res: Response, body: any) => void;
+}
+
+interface HandleOptions extends ExtendedOptions {
+  ignoreRoutes?: string[] | IgnoreRoutesFunction;
+  removeLngFromUrl?: boolean;
+}
+
+interface GetResourcesHandlerOptions extends ExtendedOptions {
+  maxAge?: number;
+  cache?: boolean;
+  lngParam?: string;
+  nsParam?: string;
+}
+
+interface MissingKeyHandlerOptions extends ExtendedOptions {
+  lngParam?: string;
+  nsParam?: string;
+}
+
+type IgnoreRoutesFunction = (
+  req: Request,
+  res: Response,
+  options: HandleOptions,
+  i18next: I18next
+) => boolean;
+
+export function handle(i18next: I18next, options?: HandleOptions): Handler;
+
+export function plugin(
+  instance: any,
+  options: HandleOptions & { i18next?: I18next },
+  next: NextFunction
+): Handler;
+
+export function getResourcesHandler(
+  i18next: I18next,
+  options?: GetResourcesHandlerOptions
+): Handler;
+
+export function missingKeyHandler(
+  i18next: I18next,
+  options?: MissingKeyHandlerOptions
+): Handler;
+
+export function addRoute(
+  i18next: I18next,
+  route: string,
+  lngs: string[],
+  app: App,
+  verb: string,
+  fc: RequestHandler
+): void;
+
+// LanguageDetector
+type LanguageDetectorServices = any;
+type LanguageDetectorOrder = string[];
+type LanguageDetectorCaches = boolean | string[];
+interface LanguageDetectorOptions {
+  order?: LanguageDetectorOrder;
+  lookupQuerystring?: string;
+  lookupCookie?: string;
+  lookupSession?: string;
+  lookupFromPathIndex?: number;
+  caches?: LanguageDetectorCaches;
+  cookieExpirationDate?: Date;
+  cookieDomain?: string;
+}
+interface LanguageDetectorAllOptions {
+  fallbackLng: boolean | string | string[];
+}
+interface LanguageDetectorInterfaceOptions {
+  [name: string]: any;
+}
+interface LanguageDetectorInterface {
+  name: string;
+
+  lookup: (
+    req: Request,
+    res: Response,
+    options?: LanguageDetectorInterfaceOptions
+  ) => string | string[];
+
+  cacheUserLanguage?: (
+    req: Request,
+    res: Response,
+    lng: string,
+    options?: Object
+  ) => void;
+}
+
+export class LanguageDetector implements i18next.Module {
+  type: "languageDetector";
+
+  constructor(
+    services: LanguageDetectorServices,
+    options?: LanguageDetectorOptions,
+    allOptions?: LanguageDetectorAllOptions
+  );
+
+  constructor(
+    options?: LanguageDetectorOptions,
+    allOptions?: LanguageDetectorAllOptions
+  );
+
+  init(
+    services: LanguageDetectorServices,
+    options?: LanguageDetectorOptions,
+    allOptions?: LanguageDetectorAllOptions
+  ): void;
+
+  init(
+    options?: LanguageDetectorOptions,
+    allOptions?: LanguageDetectorAllOptions
+  ): void;
+
+  addDetector(detector: LanguageDetectorInterface): void;
+
+  detect(
+    req: Request,
+    res: Response,
+    detectionOrder: LanguageDetectorOrder
+  ): void;
+
+  cacheUserLanguage(
+    req: Request,
+    res: Response,
+    lng: string,
+    caches: LanguageDetectorCaches
+  ): void;
+}

package/index.js

@@ -1,2 +1,3 @@
+// // @deno-types='./index.d.ts'
 import mod from './lib/index.js'
 export default mod

package/lib/LanguageDetector.js

@@ -19,7 +19,8 @@ function getDefaults () {
     // cookieExpirationDate: new Date(),
     // cookieDomain: 'myDomain'
     // cookiePath: '/my/path'
-    cookieSameSite: 'strict'
+    cookieSameSite: 'strict',
+    ignoreCase: true
   })
 }
 
@@ -61,6 +62,13 @@ class LanguageDetector {
 
       if (this.services.languageUtils.getBestMatchFromCodes) { // new i18next v19.5.0
         found = this.services.languageUtils.getBestMatchFromCodes(detections)
+        if (found) {
+          if (this.options.ignoreCase) {
+            if (detections.map(d => d.toLowerCase()).indexOf(found.toLowerCase()) < 0) found = undefined
+          } else {
+            if (detections.indexOf(found) < 0) found = undefined
+          }
+        }
         if (found) req.i18nextLookupName = detectorName
       } else {
         found = detections.length > 0 ? detections[0] : null // a little backward compatibility

package/lib/httpFunctions.js

@@ -56,7 +56,8 @@ export const getCookies = (req) => {
   console.log('no possibility found to get cookies')
 }
 export const getBody = (req) => {
-  if (req.ctx && req.ctx.body) return req.ctx.body.bind(req.ctx)
+  if (req.ctx && typeof req.ctx.body === 'function') return req.ctx.body.bind(req.ctx)
+  if (req.ctx && req.ctx.body) return req.ctx.body
   if (req.json) return req.json
   if (req.body) return req.body
   console.log('no possibility found to get body')

package/lib/index.js

@@ -31,7 +31,7 @@ export function handle (i18next, options = {}) {
       }
     } else {
       const ignores = (options.ignoreRoutes instanceof Array && options.ignoreRoutes) || []
-      for (var i = 0; i < ignores.length; i++) {
+      for (let i = 0; i < ignores.length; i++) {
         if (options.getPath(req).indexOf(ignores[i]) > -1) return next()
       }
     }
@@ -167,7 +167,7 @@ export function missingKeyHandler (i18next, options = {}) {
       if (promise && typeof promise.then === 'function') {
         return new Promise((resolve) => {
           promise.then((b) => {
-            for (var m in b) {
+            for (const m in b) {
               i18next.services.backendConnector.saveMissing([lng], ns, m, b[m])
             }
             resolve(options.send(res, 'ok'))
@@ -176,7 +176,7 @@ export function missingKeyHandler (i18next, options = {}) {
       }
     }
 
-    for (var m in body) {
+    for (const m in body) {
       i18next.services.backendConnector.saveMissing([lng], ns, m, body[m])
     }
 

package/lib/languageLookups/cookie.js

@@ -61,7 +61,7 @@ export default {
 
     if (options.lookupCookie && typeof req !== 'undefined') {
       const cookies = options.getCookies(req)
-      found = cookies[options.lookupCookie]
+      if (cookies) found = cookies[options.lookupCookie]
     }
 
     return found

package/lib/utils.js

@@ -22,7 +22,7 @@ const slice = arr.slice
 export function defaults (obj) {
   each.call(slice.call(arguments, 1), function (source) {
     if (source) {
-      for (var prop in source) {
+      for (const prop in source) {
         if (obj[prop] === undefined) obj[prop] = source[prop]
       }
     }
@@ -33,7 +33,7 @@ export function defaults (obj) {
 export function extend (obj) {
   each.call(slice.call(arguments, 1), function (source) {
     if (source) {
-      for (var prop in source) {
+      for (const prop in source) {
         obj[prop] = source[prop]
       }
     }

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "i18next-http-middleware",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "private": false,
   "type": "module",
   "main": "./cjs/index.js",
+  "types": "./index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -20,24 +21,26 @@
   "module": "./esm/index.js",
   "dependencies": {},
   "devDependencies": {
-    "@babel/cli": "7.10.5",
-    "@babel/core": "7.11.4",
-    "@babel/preset-env": "7.11.0",
-    "babel-plugin-add-module-exports": "1.0.2",
-    "eslint": "7.7.0",
-    "eslint-config-standard": "14.1.1",
-    "eslint-plugin-import": "2.22.0",
+    "@babel/cli": "7.12.10",
+    "@babel/core": "7.12.10",
+    "@babel/preset-env": "7.12.11",
+    "@types/express-serve-static-core": "^4.17.18",
+    "babel-plugin-add-module-exports": "1.0.4",
+    "eslint": "7.17.0",
+    "eslint-config-standard": "16.0.2",
+    "eslint-plugin-import": "2.22.1",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "4.2.1",
     "eslint-plugin-require-path-exists": "1.1.9",
-    "eslint-plugin-standard": "4.0.1",
+    "eslint-plugin-standard": "5.0.0",
     "expect.js": "0.3.1",
     "express": "4.17.1",
-    "fastify": "3.3.0",
-    "i18next": "19.7.0",
-    "mocha": "8.1.3",
-    "supertest": "4.0.2",
-    "uglify-js": "3.10.3"
+    "fastify": "3.9.2",
+    "i18next": "19.8.4",
+    "mocha": "8.2.1",
+    "supertest": "6.0.1",
+    "tsd": "0.14.0",
+    "uglify-js": "3.12.4"
   },
   "description": "i18next-http-middleware is a middleware to be used with Node.js web frameworks like express or Fastify and also for Deno.",
   "keywords": [
@@ -66,9 +69,13 @@
     "compile:cjs": "rm -rf cjs && mkdir cjs && BABEL_ENV=cjs babel lib -d cjs && echo '{\"type\":\"commonjs\"}' > cjs/package.json",
     "compile": "npm run compile:esm && npm run compile:cjs",
     "build": "npm run compile",
-    "test": "npm run lint && npm run build && mocha test -R spec --exit --experimental-modules",
-    "test:deno": "deno test test/deno/*.js --allow-net --no-check",
+    "test": "npm run lint && npm run build && mocha test -R spec --exit --experimental-modules && npm run test:types",
+    "test:deno": "deno test --allow-net test/deno/*.js",
+    "test:types": "tsd",
     "preversion": "npm run test && npm run build && git push",
     "postversion": "git push && git push --tags"
+  },
+  "tsd": {
+    "directory": "test/types"
   }
 }