i18next-http-middleware 3.1.6 → 3.2.0

package/README.md

@@ -5,11 +5,14 @@
 [![Travis](https://img.shields.io/travis/i18next/i18next-http-middleware/master.svg?style=flat-square)](https://travis-ci.org/i18next/i18next-http-middleware)
 [![npm version](https://img.shields.io/npm/v/i18next-http-middleware.svg?style=flat-square)](https://www.npmjs.com/package/i18next-http-middleware)
 
-
 This is a middleware to be used with Node.js web frameworks like express or Fastify and also for Deno.
 
 It's based on the deprecated [i18next-express-middleware](https://github.com/i18next/i18next-express-middleware) and can be used as a drop-in replacement.
-*It's not bound to a specific http framework anymore.*
+_It's not bound to a specific http framework anymore._
+
+## Advice:
+
+To get started with server side internationalization, you may also have a look at [this blog post](https://dev.to/adrai/how-does-server-side-internationalization-i18n-look-like-5f4c) also using [using i18next-http-middleware](https://dev.to/adrai/how-does-server-side-internationalization-i18n-look-like-5f4c#ssr).
 
 # Getting started
 
@@ -52,6 +55,7 @@ div = t('myKey')
 ```
 
 ### Fastify usage
+
 ```js
 var i18next = require('i18next')
 var middleware = require('i18next-http-middleware')
@@ -83,6 +87,46 @@ app.get('myRoute', (request, reply) => {
 })
 ```
 
+### Hapi usage
+
+```js
+const i18next = require('i18next')
+const middleware = require('i18next-http-middleware')
+const Hapi = require('@hapi/hapi')
+
+i18next.use(middleware.LanguageDetector).init({
+  preload: ['en', 'de', 'it'],
+  ...otherOptions
+})
+
+const server = Hapi.server({
+  port: port,
+  host: '0.0.0.0',
+
+await server.register({
+  plugin: i18nextMiddleware.hapiPlugin,
+  options: {
+    i18next,
+    ignoreRoutes: ['/foo'] // or function(req, res, options, i18next) { /* return true to ignore
+  }
+})
+
+// in your request handler
+server.route({
+  method: 'GET',
+  path: '/myRoute',
+  handler: (request, h) => {
+    var lng = request.language // 'de-CH'
+    var lngs = v.languages // ['de-CH', 'de', 'en']
+    request.i18n.changeLanguage('en') // will not load that!!! assert it was preloaded
+
+    var exists = request.i18n.exists('myKey')
+    var translation = request.t('myKey')
+  }
+})
+
+```
+
 ### Deno usage
 
 #### abc
@@ -92,7 +136,7 @@ import i18next from 'https://deno.land/x/i18next/index.js'
 import Backend from 'https://cdn.jsdelivr.net/gh/i18next/i18next-fs-backend/index.js'
 import i18nextMiddleware from 'https://deno.land/x/i18next_http_middleware/index.js'
 import { Application } from 'https://deno.land/x/abc/mod.ts'
-import { config } from "https://deno.land/x/dotenv/dotenv.ts";
+import { config } from 'https://deno.land/x/dotenv/dotenv.ts'
 
 i18next
   .use(Backend)
@@ -112,12 +156,10 @@ i18next
 const port = config.PORT || 8080
 const app = new Application()
 const handle = i18nextMiddleware.handle(i18next)
-app.use((next) =>
-  (c) => {
-    handle(c.request, c.response, () => {})
-    return next(c)
-  }
-)
+app.use((next) => (c) => {
+  handle(c.request, c.response, () => {})
+  return next(c)
+})
 app.get('/', (c) => c.request.t('home.title'))
 await app.start({ port })
 ```
@@ -129,7 +171,7 @@ import i18next from 'https://deno.land/x/i18next/index.js'
 import Backend from 'https://cdn.jsdelivr.net/gh/i18next/i18next-fs-backend/index.js'
 import i18nextMiddleware from 'https://deno.land/x/i18next_http_middleware/index.js'
 import { createApp } from 'https://servestjs.org/@v1.0.0-rc2/mod.ts'
-import { config } from "https://deno.land/x/dotenv/dotenv.ts";
+import { config } from 'https://deno.land/x/dotenv/dotenv.ts'
 
 i18next
   .use(Backend)
@@ -153,7 +195,7 @@ app.get('/', async (req) => {
   await req.respond({
     status: 200,
     headers: new Headers({
-      'content-type': 'text/plain',
+      'content-type': 'text/plain'
     }),
     body: req.t('home.title')
   })
@@ -249,7 +291,7 @@ Define your own functions to handle your custom request or response
 middleware.handle(i18next, {
   getPath: (req) => req.path,
   getUrl: (req) => req.url,
-  setUrl: (req, url) => req.url = url,
+  setUrl: (req, url) => (req.url = url),
   getQuery: (req) => req.query,
   getParams: (req) => req.params,
   getBody: (req) => req.body,
@@ -270,6 +312,8 @@ Detects user language from current request. Comes with support for:
 - querystring
 - session
 
+Based on the i18next language detection handling: https://www.i18next.com/misc/creating-own-plugins#languagedetector
+
 Wiring up:
 
 ```js
@@ -297,7 +341,7 @@ As with all modules you can either pass the constructor function (class) to the
   lookupPath: 'lng',
   lookupFromPathIndex: 0,
 
-  // cache user language
+  // cache user language, you can define if an how the detected language should be "saved" => 'cookie' and/or 'session'
   caches: false, // ['cookie']
 
   ignoreCase: true, // ignore case of detected language
@@ -348,15 +392,14 @@ lngDetector.init(options)
 module.exports = {
   name: 'myDetectorsName',
 
-  lookup: function(req, res, options) {
+  lookup: function (req, res, options) {
     // options -> are passed in options
     return 'en'
   },
 
-  cacheUserLanguage: function(req, res, lng, options) {
+  cacheUserLanguage: function (req, res, lng, options) {
     // options -> are passed in options
     // lng -> current language, will be called after init and on changeLanguage
-
     // store it
   }
 }

package/cjs/httpFunctions.js

@@ -15,6 +15,7 @@ var getPath = function getPath(req) {
 exports.getPath = getPath;
 
 var getUrl = function getUrl(req) {
+  if (req.url && req.url.href) return req.url.href;
   if (req.url) return req.url;
   if (req.raw && req.raw.url) return req.raw.url;
   console.log('no possibility found to get url');
@@ -42,8 +43,12 @@ 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' && typeof req.query[Symbol.iterator] === '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.searchParams) return req.searchParams;
   if (req.raw && req.raw.query) return req.raw.query;
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams;
   var url = req.url || req.raw && req.raw.url;
@@ -90,10 +95,14 @@ var getCookies = function getCookies(req) {
 exports.getCookies = getCookies;
 
 var getBody = function getBody(req) {
-  if (req.ctx && typeof req.ctx.body === 'function') 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;
+  if (req.payload) return req.payload;
   console.log('no possibility found to get body');
   return {};
 };
@@ -114,8 +123,15 @@ var setHeader = function setHeader(res, name, value) {
   if (res._headerSent || res.headersSent) return;
   if (typeof res.setHeader === 'function') return res.setHeader(name, value);
   if (typeof res.header === 'function') return res.header(name, value);
-  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') return res.responseHeaders.set(name, value);
-  if (res.headers && typeof res.headers.set === 'function') return res.headers.set(name, value);
+
+  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') {
+    return res.responseHeaders.set(name, value);
+  }
+
+  if (res.headers && typeof res.headers.set === 'function') {
+    return res.headers.set(name, value);
+  }
+
   console.log('no possibility found to set header');
 };
 

package/cjs/index.js

@@ -10,6 +10,7 @@ exports.addRoute = addRoute;
 exports.default = void 0;
 exports.getResourcesHandler = getResourcesHandler;
 exports.handle = handle;
+exports.hapiPlugin = void 0;
 exports.missingKeyHandler = missingKeyHandler;
 exports.plugin = plugin;
 
@@ -25,6 +26,12 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 var LanguageDetector = _LanguageDetector.default;
 exports.LanguageDetector = LanguageDetector;
 
@@ -92,7 +99,11 @@ function handle(i18next) {
       }
     });
     var lng = req.lng;
-    if (!lng && i18next.services.languageDetector) lng = i18next.services.languageDetector.detect(req, res);
+
+    if (!lng && i18next.services.languageDetector) {
+      lng = i18next.services.languageDetector.detect(req, res);
+    }
+
     req.language = req.locale = req.lng = lng;
 
     if (lng && options.getHeader(res, 'Content-Language') !== lng) {
@@ -120,7 +131,10 @@ function handle(i18next) {
       res.locals.languageDir = i18next.dir(lng);
     }
 
-    if (i18next.services.languageDetector) i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
+    if (i18next.services.languageDetector) {
+      i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
+    }
+
     if (!req.lng) return next();
     i18next.loadLanguages(req.lng, function () {
       return next();
@@ -137,6 +151,21 @@ function plugin(instance, options, next) {
   return next();
 }
 
+var hapiPlugin = {
+  name: 'i18next-http-middleware',
+  version: '1',
+  register: function register(server, options) {
+    options.attachLocals = true;
+    var middleware = handle(options.i18next, _objectSpread({}, options));
+    server.ext('onPreHandler', function (request, h) {
+      middleware(request, request.raw.res || h.response() || request.Response, function () {
+        return h.continue;
+      });
+      return h.continue;
+    });
+  }
+};
+exports.hapiPlugin = hapiPlugin;
 plugin[Symbol.for('skip-override')] = true;
 
 function getResourcesHandler(i18next) {
@@ -167,7 +196,9 @@ function getResourcesHandler(i18next) {
     var languages = options.getQuery(req)[options.lngParam || 'lng'] ? options.getQuery(req)[options.lngParam || 'lng'].split(' ') : [];
     var namespaces = options.getQuery(req)[options.nsParam || 'ns'] ? options.getQuery(req)[options.nsParam || 'ns'].split(' ') : [];
     namespaces.forEach(function (ns) {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) i18next.options.ns.push(ns);
+      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+        i18next.options.ns.push(ns);
+      }
     });
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(function (lng) {
@@ -255,6 +286,7 @@ function addRoute(i18next, route, lngs, app, verb, fc) {
 
 var _default = {
   plugin: plugin,
+  hapiPlugin: hapiPlugin,
   handle: handle,
   getResourcesHandler: getResourcesHandler,
   missingKeyHandler: missingKeyHandler,

package/esm/httpFunctions.js

@@ -5,6 +5,7 @@ export var getPath = function getPath(req) {
   console.log('no possibility found to get path');
 };
 export var getUrl = function getUrl(req) {
+  if (req.url && req.url.href) return req.url.href;
   if (req.url) return req.url;
   if (req.raw && req.raw.url) return req.raw.url;
   console.log('no possibility found to get url');
@@ -23,8 +24,12 @@ 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' && typeof req.query[Symbol.iterator] === '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.searchParams) return req.searchParams;
   if (req.raw && req.raw.query) return req.raw.query;
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams;
   var url = req.url || req.raw && req.raw.url;
@@ -59,10 +64,14 @@ export var getCookies = function getCookies(req) {
   console.log('no possibility found to get cookies');
 };
 export var getBody = function getBody(req) {
-  if (req.ctx && typeof req.ctx.body === 'function') 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;
+  if (req.payload) return req.payload;
   console.log('no possibility found to get body');
   return {};
 };
@@ -77,8 +86,15 @@ export var setHeader = function setHeader(res, name, value) {
   if (res._headerSent || res.headersSent) return;
   if (typeof res.setHeader === 'function') return res.setHeader(name, value);
   if (typeof res.header === 'function') return res.header(name, value);
-  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') return res.responseHeaders.set(name, value);
-  if (res.headers && typeof res.headers.set === 'function') return res.headers.set(name, value);
+
+  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') {
+    return res.responseHeaders.set(name, value);
+  }
+
+  if (res.headers && typeof res.headers.set === 'function') {
+    return res.headers.set(name, value);
+  }
+
   console.log('no possibility found to set header');
 };
 export var setContentType = function setContentType(res, type) {

package/esm/index.js

@@ -1,3 +1,9 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
 import * as utils from './utils.js';
 import LD from './LanguageDetector.js';
 import { extendOptionsWithDefaults } from './httpFunctions.js';
@@ -67,7 +73,11 @@ export function handle(i18next) {
       }
     });
     var lng = req.lng;
-    if (!lng && i18next.services.languageDetector) lng = i18next.services.languageDetector.detect(req, res);
+
+    if (!lng && i18next.services.languageDetector) {
+      lng = i18next.services.languageDetector.detect(req, res);
+    }
+
     req.language = req.locale = req.lng = lng;
 
     if (lng && options.getHeader(res, 'Content-Language') !== lng) {
@@ -95,7 +105,10 @@ export function handle(i18next) {
       res.locals.languageDir = i18next.dir(lng);
     }
 
-    if (i18next.services.languageDetector) i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
+    if (i18next.services.languageDetector) {
+      i18next.services.languageDetector.cacheUserLanguage(req, res, lng);
+    }
+
     if (!req.lng) return next();
     i18next.loadLanguages(req.lng, function () {
       return next();
@@ -110,6 +123,20 @@ export function plugin(instance, options, next) {
   });
   return next();
 }
+export var hapiPlugin = {
+  name: 'i18next-http-middleware',
+  version: '1',
+  register: function register(server, options) {
+    options.attachLocals = true;
+    var middleware = handle(options.i18next, _objectSpread({}, options));
+    server.ext('onPreHandler', function (request, h) {
+      middleware(request, request.raw.res || h.response() || request.Response, function () {
+        return h.continue;
+      });
+      return h.continue;
+    });
+  }
+};
 plugin[Symbol.for('skip-override')] = true;
 export function getResourcesHandler(i18next) {
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -139,7 +166,9 @@ export function getResourcesHandler(i18next) {
     var languages = options.getQuery(req)[options.lngParam || 'lng'] ? options.getQuery(req)[options.lngParam || 'lng'].split(' ') : [];
     var namespaces = options.getQuery(req)[options.nsParam || 'ns'] ? options.getQuery(req)[options.nsParam || 'ns'].split(' ') : [];
     namespaces.forEach(function (ns) {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) i18next.options.ns.push(ns);
+      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+        i18next.options.ns.push(ns);
+      }
     });
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(function (lng) {
@@ -224,6 +253,7 @@ export function addRoute(i18next, route, lngs, app, verb, fc) {
 }
 export default {
   plugin: plugin,
+  hapiPlugin: hapiPlugin,
   handle: handle,
   getResourcesHandler: getResourcesHandler,
   missingKeyHandler: missingKeyHandler,

package/lib/httpFunctions.js

@@ -5,6 +5,7 @@ export const getPath = (req) => {
   console.log('no possibility found to get path')
 }
 export const getUrl = (req) => {
+  if (req.url && req.url.href) return req.url.href
   if (req.url) return req.url
   if (req.raw && req.raw.url) return req.raw.url
   console.log('no possibility found to get url')
@@ -22,8 +23,16 @@ export const getOriginalUrl = (req) => {
   return getUrl(req)
 }
 export const getQuery = (req) => {
-  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 &&
+    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.searchParams) return req.searchParams
   if (req.raw && req.raw.query) return req.raw.query
   if (req.ctx && req.ctx.queryParams) return req.ctx.queryParams
   const url = req.url || (req.raw && req.raw.url)
@@ -47,19 +56,23 @@ export const getCookies = (req) => {
   if (getHeaders(req)) {
     const list = {}
     const rc = getHeaders(req).cookie
-    rc && rc.split(';').forEach((cookie) => {
-      const parts = cookie.split('=')
-      list[parts.shift().trim()] = decodeURI(encodeURI(parts.join('=')))
-    })
+    rc &&
+      rc.split(';').forEach((cookie) => {
+        const parts = cookie.split('=')
+        list[parts.shift().trim()] = decodeURI(encodeURI(parts.join('=')))
+      })
     return list
   }
   console.log('no possibility found to get cookies')
 }
 export const getBody = (req) => {
-  if (req.ctx && typeof req.ctx.body === 'function') 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
+  if (req.payload) return req.payload
   console.log('no possibility found to get body')
   return {}
 }
@@ -74,8 +87,12 @@ export const setHeader = (res, name, value) => {
   if (res._headerSent || res.headersSent) return
   if (typeof res.setHeader === 'function') return res.setHeader(name, value)
   if (typeof res.header === 'function') return res.header(name, value)
-  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') return res.responseHeaders.set(name, value)
-  if (res.headers && typeof res.headers.set === 'function') return res.headers.set(name, value)
+  if (res.responseHeaders && typeof res.responseHeaders.set === 'function') {
+    return res.responseHeaders.set(name, value)
+  }
+  if (res.headers && typeof res.headers.set === 'function') {
+    return res.headers.set(name, value)
+  }
   console.log('no possibility found to set header')
 }
 export const setContentType = (res, type) => {
@@ -86,7 +103,7 @@ export const setContentType = (res, type) => {
 export const setStatus = (res, code) => {
   if (typeof res.status === 'function') return res.status(code)
   // eslint-disable-next-line no-return-assign
-  if (res.status) return res.status = code
+  if (res.status) return (res.status = code)
   console.log('no possibility found to set status')
 }
 export const send = (res, body) => {

package/lib/index.js

@@ -30,14 +30,16 @@ export function handle (i18next, options = {}) {
         return next()
       }
     } else {
-      const ignores = (options.ignoreRoutes instanceof Array && options.ignoreRoutes) || []
+      const ignores =
+        (options.ignoreRoutes instanceof Array && options.ignoreRoutes) || []
       for (let i = 0; i < ignores.length; i++) {
         if (options.getPath(req).indexOf(ignores[i]) > -1) return next()
       }
     }
 
     const i18n = i18next.cloneInstance({ initImmediate: false })
-    i18n.on('languageChanged', (lng) => { // Keep language in sync
+    i18n.on('languageChanged', lng => {
+      // Keep language in sync
       req.language = req.locale = req.lng = lng
 
       if (options.attachLocals) res.locals = res.locals || {}
@@ -58,7 +60,9 @@ export function handle (i18next, options = {}) {
     })
 
     let lng = req.lng
-    if (!lng && i18next.services.languageDetector) lng = i18next.services.languageDetector.detect(req, res)
+    if (!lng && i18next.services.languageDetector) {
+      lng = i18next.services.languageDetector.detect(req, res)
+    }
 
     // set locale
     req.language = req.locale = req.lng = lng
@@ -71,7 +75,13 @@ export function handle (i18next, options = {}) {
     i18n.changeLanguage(lng || i18next.options.fallbackLng[0])
 
     if (req.i18nextLookupName === 'path' && options.removeLngFromUrl) {
-      options.setUrl(req, utils.removeLngFromUrl(options.getUrl(req), i18next.services.languageDetector.options.lookupFromPathIndex))
+      options.setUrl(
+        req,
+        utils.removeLngFromUrl(
+          options.getUrl(req),
+          i18next.services.languageDetector.options.lookupFromPathIndex
+        )
+      )
     }
 
     const t = i18n.t.bind(i18n)
@@ -91,7 +101,9 @@ export function handle (i18next, options = {}) {
       res.locals.languageDir = i18next.dir(lng)
     }
 
-    if (i18next.services.languageDetector) i18next.services.languageDetector.cacheUserLanguage(req, res, lng)
+    if (i18next.services.languageDetector) {
+      i18next.services.languageDetector.cacheUserLanguage(req, res, lng)
+    }
     // load resources
     if (!req.lng) return next()
     i18next.loadLanguages(req.lng, () => next())
@@ -101,9 +113,31 @@ 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))
+  instance.addHook('preHandler', (request, reply, next) =>
+    middleware(request, reply, next)
+  )
   return next()
 }
+
+export const hapiPlugin = {
+  name: 'i18next-http-middleware',
+  version: '1',
+  register: (server, options) => {
+    options.attachLocals = true
+    const middleware = handle(options.i18next, {
+      ...options
+    })
+    server.ext('onPreHandler', (request, h) => {
+      middleware(
+        request,
+        request.raw.res || h.response() || request.Response,
+        () => h.continue
+      )
+      return h.continue
+    })
+  }
+}
+
 plugin[Symbol.for('skip-override')] = true
 
 export function getResourcesHandler (i18next, options = {}) {
@@ -115,32 +149,55 @@ export function getResourcesHandler (i18next, options = {}) {
 
     if (!i18next.services.backendConnector) {
       options.setStatus(res, 404)
-      return options.send(res, 'i18next-express-middleware:: no backend configured')
+      return options.send(
+        res,
+        'i18next-express-middleware:: no backend configured'
+      )
     }
 
     const resources = {}
 
     options.setContentType(res, 'application/json')
-    if (options.cache !== undefined ? options.cache : typeof process !== 'undefined' && process.env && process.env.NODE_ENV === 'production') {
+    if (
+      options.cache !== undefined
+        ? options.cache
+        : typeof process !== 'undefined' &&
+          process.env &&
+          process.env.NODE_ENV === 'production'
+    ) {
       options.setHeader(res, 'Cache-Control', 'public, max-age=' + maxAge)
-      options.setHeader(res, 'Expires', (new Date(new Date().getTime() + maxAge * 1000)).toUTCString())
+      options.setHeader(
+        res,
+        'Expires',
+        new Date(new Date().getTime() + maxAge * 1000).toUTCString()
+      )
     } else {
       options.setHeader(res, 'Pragma', 'no-cache')
       options.setHeader(res, 'Cache-Control', 'no-cache')
     }
 
-    const languages = options.getQuery(req)[options.lngParam || 'lng'] ? options.getQuery(req)[options.lngParam || 'lng'].split(' ') : []
-    const namespaces = options.getQuery(req)[options.nsParam || 'ns'] ? options.getQuery(req)[options.nsParam || 'ns'].split(' ') : []
+    const languages = options.getQuery(req)[options.lngParam || 'lng']
+      ? options.getQuery(req)[options.lngParam || 'lng'].split(' ')
+      : []
+    const namespaces = options.getQuery(req)[options.nsParam || 'ns']
+      ? options.getQuery(req)[options.nsParam || 'ns'].split(' ')
+      : []
 
     // extend ns
     namespaces.forEach(ns => {
-      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) i18next.options.ns.push(ns)
+      if (i18next.options.ns && i18next.options.ns.indexOf(ns) < 0) {
+        i18next.options.ns.push(ns)
+      }
     })
 
     i18next.services.backendConnector.load(languages, namespaces, function () {
       languages.forEach(lng => {
         namespaces.forEach(ns => {
-          utils.setPath(resources, [lng, ns], i18next.getResourceBundle(lng, ns))
+          utils.setPath(
+            resources,
+            [lng, ns],
+            i18next.getResourceBundle(lng, ns)
+          )
         })
       })
     })
@@ -160,7 +217,10 @@ export function missingKeyHandler (i18next, options = {}) {
 
     if (!i18next.services.backendConnector) {
       options.setStatus(res, 404)
-      return options.send(res, 'i18next-express-middleware:: no backend configured')
+      return options.send(
+        res,
+        'i18next-express-middleware:: no backend configured'
+      )
     }
 
     const body = options.getBody(req)
@@ -168,8 +228,8 @@ export function missingKeyHandler (i18next, options = {}) {
     if (typeof body === 'function') {
       const promise = body()
       if (promise && typeof promise.then === 'function') {
-        return new Promise((resolve) => {
-          promise.then((b) => {
+        return new Promise(resolve => {
+          promise.then(b => {
             for (const m in b) {
               i18next.services.backendConnector.saveMissing([lng], ns, m, b[m])
             }
@@ -219,6 +279,7 @@ export function addRoute (i18next, route, lngs, app, verb, fc) {
 
 export default {
   plugin,
+  hapiPlugin,
   handle,
   getResourcesHandler,
   missingKeyHandler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "i18next-http-middleware",
-  "version": "3.1.6",
+  "version": "3.2.0",
   "private": false,
   "type": "module",
   "main": "./cjs/index.js",
@@ -24,6 +24,7 @@
     "@babel/cli": "7.16.0",
     "@babel/core": "7.16.5",
     "@babel/preset-env": "7.16.5",
+    "@hapi/hapi": "^20.2.1",
     "@types/express-serve-static-core": "^4.17.27",
     "babel-plugin-add-module-exports": "1.0.4",
     "eslint": "7.29.0",

package/CHANGELOG.md

@@ -1,55 +0,0 @@
-## [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)
-
-## [v3.1.1](https://github.com/i18next/i18next-http-middleware/compare/v3.1.0...v3.1.1)
-- make sure no undefined language is detected
-
-## [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
-
-## [v3.0.2](https://github.com/i18next/i18next-http-middleware/compare/v3.0.1...v3.0.2)
-- transpile also esm
-
-## [v3.0.1](https://github.com/i18next/i18next-http-middleware/compare/v3.0.0...v3.0.1)
-- introduce lookupHeaderRegex option
-
-## [v3.0.0](https://github.com/i18next/i18next-http-middleware/compare/v2.1.2...v3.0.0)
-- **BREAKING** needs i18next >= 19.5.0
-- let i18next figure out which detected lng is best match
-
-## [v2.1.2](https://github.com/i18next/i18next-http-middleware/compare/v2.1.1...v2.1.2)
-- fix: get whitelist from correct property
-
-## [v2.1.1](https://github.com/i18next/i18next-http-middleware/compare/v2.1.0...v2.1.1)
-- extend httpFunctions getQuery to handle some edge cases
-
-## [v2.1.0](https://github.com/i18next/i18next-http-middleware/compare/v2.0.0...v2.1.0)
-- LanguageDetector: cookie, new option: cookiePath
-
-## [v2.0.0](https://github.com/i18next/i18next-http-middleware/compare/v1.3.1...v2.0.0)
-- potentially BREAKING: change cookie defaults: cookieSameSite: 'strict'