i18next-http-middleware 3.1.2 → 3.1.6

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [v3.1.6](https://github.com/i18next/i18next-http-middleware/compare/v3.1.5...v3.1.6)
+- add Fastify type support [#47](https://github.com/i18next/i18next-http-middleware/pull/47)
+
+## [v3.1.5](https://github.com/i18next/i18next-http-middleware/compare/v3.1.4...v3.1.5)
+- fallbackLng option can also be a function
+
+## [v3.1.4](https://github.com/i18next/i18next-http-middleware/compare/v3.1.3...v3.1.4)
+- fix for [point-of-view](https://github.com/fastify/point-of-view)
+- update all dependencies
+
+## [v3.1.3](https://github.com/i18next/i18next-http-middleware/compare/v3.1.2...v3.1.3)
+- optimize getQuery() function to check if req.query is iterable
+
 ## [v3.1.2](https://github.com/i18next/i18next-http-middleware/compare/v3.1.1...v3.1.2)
 - fix the type of the lookup method [#37](https://github.com/i18next/i18next-http-middleware/pull/37)
 

package/README.md

@@ -169,6 +169,10 @@ app.post('/locales/add/:lng/:ns', middleware.missingKeyHandler(i18next))
 
 // multiload backend route
 app.get('/locales/resources.json', middleware.getResourcesHandler(i18next))
+// can be used like:
+// GET /locales/resources.json
+// GET /locales/resources.json?lng=en
+// GET /locales/resources.json?lng=en&ns=translation
 ```
 
 ## add localized routes

package/cjs/LanguageDetector.js

@@ -1,6 +1,6 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 Object.defineProperty(exports, "__esModule", {
   value: true
@@ -23,15 +23,15 @@ var _httpFunctions = require("./httpFunctions.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
 function getDefaults() {
   return (0, _httpFunctions.extendOptionsWithDefaults)({
@@ -117,6 +117,7 @@ var LanguageDetector = function () {
 
       if (!found) {
         var fallbacks = this.allOptions.fallbackLng;
+        if (typeof fallbacks === 'function') fallbacks = fallbacks();
         if (typeof fallbacks === 'string') fallbacks = [fallbacks];
         if (!fallbacks) fallbacks = [];
 

package/cjs/httpFunctions.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.extendOptionsWithDefaults = exports.getSession = exports.send = exports.setStatus = exports.setContentType = exports.setHeader = exports.getHeader = exports.getBody = exports.getCookies = exports.getHeaders = exports.getParams = exports.getQuery = exports.getOriginalUrl = exports.setUrl = exports.getUrl = exports.getPath = void 0;
+exports.setUrl = exports.setStatus = exports.setHeader = exports.setContentType = exports.send = exports.getUrl = exports.getSession = exports.getQuery = exports.getPath = exports.getParams = exports.getOriginalUrl = exports.getHeaders = exports.getHeader = exports.getCookies = exports.getBody = exports.extendOptionsWithDefaults = void 0;
 
 var getPath = function getPath(req) {
   if (req.path) return req.path;
@@ -42,7 +42,7 @@ var getOriginalUrl = function getOriginalUrl(req) {
 exports.getOriginalUrl = getOriginalUrl;
 
 var getQuery = function getQuery(req) {
-  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function') return Object.fromEntries(req.query);
+  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function' && typeof req.query[Symbol.iterator] === 'function') return Object.fromEntries(req.query);
   if (req.query) return req.query;
   if (req.raw && req.raw.query) return req.raw.query;
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams;

package/cjs/index.js

@@ -1,16 +1,17 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.handle = handle;
-exports.plugin = plugin;
+exports.LanguageDetector = void 0;
+exports.addRoute = addRoute;
+exports.default = void 0;
 exports.getResourcesHandler = getResourcesHandler;
+exports.handle = handle;
 exports.missingKeyHandler = missingKeyHandler;
-exports.addRoute = addRoute;
-exports.default = exports.LanguageDetector = void 0;
+exports.plugin = plugin;
 
 var utils = _interopRequireWildcard(require("./utils.js"));
 
@@ -20,9 +21,9 @@ var _httpFunctions = require("./httpFunctions.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 var LanguageDetector = _LanguageDetector.default;
 exports.LanguageDetector = LanguageDetector;
@@ -73,6 +74,7 @@ function handle(i18next) {
     });
     i18n.on('languageChanged', function (lng) {
       req.language = req.locale = req.lng = lng;
+      if (options.attachLocals) res.locals = res.locals || {};
 
       if (res.locals) {
         res.locals.language = lng;
@@ -108,6 +110,7 @@ function handle(i18next) {
     var exists = i18n.exists.bind(i18n);
     req.i18n = i18n;
     req.t = t;
+    if (options.attachLocals) res.locals = res.locals || {};
 
     if (res.locals) {
       res.locals.t = t;
@@ -126,6 +129,7 @@ function handle(i18next) {
 }
 
 function plugin(instance, options, next) {
+  options.attachLocals = true;
   var middleware = handle(options.i18next, options);
   instance.addHook('preHandler', function (request, reply, next) {
     return middleware(request, reply, next);

package/cjs/languageLookups/session.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 var _default = {
   name: 'session',

package/cjs/utils.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.setPath = setPath;
 exports.defaults = defaults;
 exports.extend = extend;
 exports.removeLngFromUrl = removeLngFromUrl;
+exports.setPath = setPath;
 
 function setPath(object, path, newValue) {
   var stack;

package/esm/LanguageDetector.js

@@ -2,7 +2,7 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
 
 function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
 
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
 
 import * as utils from './utils.js';
 import cookieLookup from './languageLookups/cookie.js';
@@ -96,6 +96,7 @@ var LanguageDetector = function () {
 
       if (!found) {
         var fallbacks = this.allOptions.fallbackLng;
+        if (typeof fallbacks === 'function') fallbacks = fallbacks();
         if (typeof fallbacks === 'string') fallbacks = [fallbacks];
         if (!fallbacks) fallbacks = [];
 

package/esm/httpFunctions.js

@@ -23,7 +23,7 @@ export var getOriginalUrl = function getOriginalUrl(req) {
   return getUrl(req);
 };
 export var getQuery = function getQuery(req) {
-  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function') return Object.fromEntries(req.query);
+  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function' && typeof req.query[Symbol.iterator] === 'function') return Object.fromEntries(req.query);
   if (req.query) return req.query;
   if (req.raw && req.raw.query) return req.raw.query;
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams;

package/esm/index.js

@@ -49,6 +49,7 @@ export function handle(i18next) {
     });
     i18n.on('languageChanged', function (lng) {
       req.language = req.locale = req.lng = lng;
+      if (options.attachLocals) res.locals = res.locals || {};
 
       if (res.locals) {
         res.locals.language = lng;
@@ -84,6 +85,7 @@ export function handle(i18next) {
     var exists = i18n.exists.bind(i18n);
     req.i18n = i18n;
     req.t = t;
+    if (options.attachLocals) res.locals = res.locals || {};
 
     if (res.locals) {
       res.locals.t = t;
@@ -101,6 +103,7 @@ export function handle(i18next) {
   };
 }
 export function plugin(instance, options, next) {
+  options.attachLocals = true;
   var middleware = handle(options.i18next, options);
   instance.addHook('preHandler', function (request, reply, next) {
     return middleware(request, reply, next);

package/esm/languageLookups/session.js

@@ -1,4 +1,4 @@
-function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 
 export default {
   name: 'session',

package/index.d.ts

@@ -27,6 +27,10 @@ declare global {
   }
 }
 
+declare module 'fastify' {
+  interface FastifyRequest extends I18NextRequest {}
+}
+
 interface ExtendedOptions extends Object {
   getPath?: (req: Request) => string;
   getOriginalUrl?: (req: Request) => string;

package/lib/LanguageDetector.js

@@ -79,9 +79,9 @@ class LanguageDetector {
 
     if (!found) {
       let fallbacks = this.allOptions.fallbackLng
+      if (typeof fallbacks === 'function') fallbacks = fallbacks()
       if (typeof fallbacks === 'string') fallbacks = [fallbacks]
       if (!fallbacks) fallbacks = []
-
       if (Object.prototype.toString.apply(fallbacks) === '[object Array]') {
         found = fallbacks[0]
       } else {

package/lib/httpFunctions.js

@@ -22,7 +22,7 @@ export const getOriginalUrl = (req) => {
   return getUrl(req)
 }
 export const getQuery = (req) => {
-  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function') return Object.fromEntries(req.query)
+  if (req.query && typeof req.query.entries === 'function' && typeof Object.fromEntries === 'function' && typeof req.query[Symbol.iterator] === 'function') return Object.fromEntries(req.query)
   if (req.query) return req.query
   if (req.raw && req.raw.query) return req.raw.query
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams

package/lib/index.js

@@ -40,6 +40,7 @@ export function handle (i18next, options = {}) {
     i18n.on('languageChanged', (lng) => { // Keep language in sync
       req.language = req.locale = req.lng = lng
 
+      if (options.attachLocals) res.locals = res.locals || {}
       if (res.locals) {
         res.locals.language = lng
         res.locals.languageDir = i18next.dir(lng)
@@ -81,6 +82,7 @@ export function handle (i18next, options = {}) {
     req.t = t
 
     // assert for res -> template
+    if (options.attachLocals) res.locals = res.locals || {}
     if (res.locals) {
       res.locals.t = t
       res.locals.exists = exists
@@ -97,6 +99,7 @@ export function handle (i18next, options = {}) {
 }
 
 export function plugin (instance, options, next) {
+  options.attachLocals = true
   const middleware = handle(options.i18next, options)
   instance.addHook('preHandler', (request, reply, next) => middleware(request, reply, next))
   return next()

package/licence

@@ -1,4 +1,4 @@
-Copyright (c) 2020 i18next
+Copyright (c) 2022 i18next
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18next-http-middleware",
-  "version": "3.1.2",
+  "version": "3.1.6",
   "private": false,
   "type": "module",
   "main": "./cjs/index.js",
@@ -21,26 +21,26 @@
   "module": "./esm/index.js",
   "dependencies": {},
   "devDependencies": {
-    "@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/cli": "7.16.0",
+    "@babel/core": "7.16.5",
+    "@babel/preset-env": "7.16.5",
+    "@types/express-serve-static-core": "^4.17.27",
     "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": "7.29.0",
+    "eslint-config-standard": "16.0.3",
+    "eslint-plugin-import": "2.25.3",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "4.2.1",
+    "eslint-plugin-promise": "5.1.0",
     "eslint-plugin-require-path-exists": "1.1.9",
     "eslint-plugin-standard": "5.0.0",
     "expect.js": "0.3.1",
-    "express": "4.17.1",
-    "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"
+    "express": "4.17.2",
+    "fastify": "3.25.2",
+    "i18next": "21.6.3",
+    "mocha": "9.1.3",
+    "supertest": "6.1.6",
+    "tsd": "0.19.0",
+    "uglify-js": "3.14.5"
   },
   "description": "i18next-http-middleware is a middleware to be used with Node.js web frameworks like express or Fastify and also for Deno.",
   "keywords": [
@@ -57,12 +57,7 @@
   "bugs": {
     "url": "https://github.com/i18next/i18next-http-middleware/issues"
   },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://raw.github.com/i18next/i18next-http-middleware/master/licence"
-    }
-  ],
+  "license": "MIT",
   "scripts": {
     "lint": "eslint .",
     "compile:esm": "rm -rf esm && mkdir esm && BABEL_ENV=esm babel lib -d esm",