express-intlayer/dist/esm/index.mjs.map

Manage internationalization i18n in a simple way for express application.

{"version":3,"file":"index.mjs","names":["getIntlayerFunction","getDictionaryFunction"],"sources":["../../src/index.ts"],"sourcesContent":["import { getConfiguration } from '@intlayer/config/node';\nimport {\n  getDictionary as getDictionaryFunction,\n  getIntlayer as getIntlayerFunction,\n  getTranslation,\n} from '@intlayer/core/interpreter';\nimport { localeDetector } from '@intlayer/core/localization';\nimport { getLocaleFromStorageServer } from '@intlayer/core/utils';\nimport { prepareIntlayer } from '@intlayer/engine/build';\nimport type { Locale } from '@intlayer/types/allLocales';\nimport type { StrictModeLocaleMap } from '@intlayer/types/module_augmentation';\nimport { createNamespace } from 'cls-hooked';\nimport type { NextFunction, Request, RequestHandler, Response } from 'express';\n\n// Zero-cost fallback, will be updated with console logger in dev mode\nlet debug: (message: string) => void = () => {};\n\nconst configuration = getConfiguration();\nconst { internationalization } = configuration;\n\nif (process.env['NODE_ENV'] === 'development') {\n  debug = (msg: string) => console.debug(msg);\n}\n\n/**\n * Retrieves the locale from storage (cookies, localStorage, sessionStorage).\n */\nconst getStorageLocale = (req: Request): Locale | undefined =>\n  getLocaleFromStorageServer({\n    getCookie: (name: string) => req.cookies?.[name],\n    getHeader: (name: string) => req.headers?.[name] as string | undefined,\n  });\n\nconst appNamespace = createNamespace('app');\n\nprepareIntlayer(configuration);\n\nexport const translateFunction =\n  (_req: Request, res: Response, _next?: NextFunction) =>\n  <T extends string>(\n    content: StrictModeLocaleMap<T> | string,\n    locale?: Locale\n  ): T => {\n    const { locale: currentLocale, defaultLocale } = res.locals as {\n      locale: Locale;\n      defaultLocale: Locale;\n    };\n\n    const targetLocale = locale ?? currentLocale;\n\n    if (typeof content === 'undefined') {\n      return '' as unknown as T;\n    }\n\n    if (typeof content === 'string') {\n      return content as unknown as T;\n    }\n\n    if (\n      typeof content?.[\n        targetLocale as unknown as keyof StrictModeLocaleMap<T>\n      ] === 'undefined'\n    ) {\n      if (\n        typeof content?.[\n          defaultLocale as unknown as keyof StrictModeLocaleMap<T>\n        ] === 'undefined'\n      ) {\n        return content as unknown as T;\n      } else {\n        return getTranslation(content, defaultLocale);\n      }\n    }\n\n    return getTranslation(content, targetLocale);\n  };\n\n/**\n * Express middleware that detects the user's locale and populates `res.locals` with Intlayer data.\n *\n * It performs:\n * 1. Locale detection from cookies, headers, or default settings.\n * 2. Injects `t`, `getIntlayer`, and `getDictionary` functions into `res.locals`.\n * 3. Sets up a `cls-hooked` namespace for accessing these functions anywhere in the request lifecycle.\n *\n * @returns An Express middleware function.\n *\n * @example\n * ```ts\n * import express from 'express';\n * import { intlayer } from 'express-intlayer';\n *\n * const app = express();\n * app.use(intlayer());\n * ```\n */\nexport const intlayer = (): RequestHandler => async (req, res, next) => {\n  // Detect if locale is set by intlayer frontend lib in the headers\n  const localeFromStorage = getStorageLocale(req);\n  // Interpret browser locale\n\n  const negotiatorHeaders: Record<string, string> = {};\n\n  // // Check if req.headers exists and is an object\n  if (req && typeof req.headers === 'object') {\n    // Copy all headers from the request to negotiatorHeaders\n    for (const key in req.headers) {\n      if (typeof req.headers[key] === 'string') {\n        negotiatorHeaders[key] = req.headers[key];\n      }\n    }\n  }\n\n  const localeDetected = localeDetector(\n    negotiatorHeaders,\n    internationalization.locales,\n    internationalization.defaultLocale\n  );\n\n  res.locals.locale_storage = localeFromStorage;\n  res.locals.locale_detected = localeDetected;\n  res.locals.locale = localeFromStorage ?? localeDetected;\n  res.locals.defaultLocale = internationalization.defaultLocale;\n\n  const t = translateFunction(req, res, next);\n\n  const getIntlayer: typeof getIntlayerFunction = (\n    key,\n    localeArg = localeDetected as Parameters<typeof getIntlayerFunction>[1],\n    ...props\n  ) => getIntlayerFunction(key, localeArg, ...props);\n\n  const getDictionary: typeof getDictionaryFunction = (\n    key,\n    localeArg = localeDetected as Parameters<typeof getDictionaryFunction>[1],\n    ...props\n  ) => getDictionaryFunction(key, localeArg, ...props);\n\n  res.locals.t = t;\n  res.locals.getIntlayer = getIntlayer;\n  res.locals.getDictionary = getDictionary;\n\n  appNamespace.run(() => {\n    appNamespace.set('t', t);\n    appNamespace.set('getIntlayer', getIntlayer);\n    appNamespace.set('getDictionary', getDictionary);\n\n    next();\n  });\n};\n\n/**\n * Translation function to retrieve content for the current locale.\n *\n * This function works within the request lifecycle managed by the `intlayer` middleware.\n *\n * @param content - A map of locales to content.\n * @param locale - Optional locale override.\n * @returns The translated content.\n *\n * @example\n * ```ts\n * import { t } from 'express-intlayer';\n *\n * app.get('/', (req, res) => {\n *   const greeting = t({\n *     en: 'Hello',\n *     fr: 'Bonjour',\n *   });\n *   res.send(greeting);\n * });\n * ```\n */\nexport const t = <Content = string>(\n  content: StrictModeLocaleMap<Content>,\n  locale?: Locale\n): Content => {\n  try {\n    if (typeof appNamespace === 'undefined') {\n      throw new Error(\n        'Intlayer is not initialized. Add the `app.use(intlayer());` middleware before using this function.'\n      );\n    }\n\n    if (typeof appNamespace.get('t') !== 'function') {\n      throw new Error(\n        'Using the import { t } from \"express-intlayer\" is not supported in your environment. Use the res.locals.t syntax instead.'\n      );\n    }\n\n    return appNamespace.get('t')(content, locale);\n  } catch (error) {\n    debug((error as Error).message);\n\n    return getTranslation(\n      content,\n      locale ?? internationalization.defaultLocale\n    );\n  }\n};\n\nexport const getIntlayer: typeof getIntlayerFunction = (...args) => {\n  try {\n    if (typeof appNamespace === 'undefined') {\n      throw new Error(\n        'Intlayer is not initialized. Add the `app.use(intlayer());` middleware before using this function.'\n      );\n    }\n\n    if (typeof appNamespace.get('getIntlayer') !== 'function') {\n      throw new Error(\n        'Using the import { t } from \"express-intlayer\" is not supported in your environment. Use the res.locals.t syntax instead.'\n      );\n    }\n\n    return appNamespace.get('getIntlayer')(...args);\n  } catch (error) {\n    debug((error as Error).message);\n\n    return getIntlayerFunction(...args);\n  }\n};\n\nexport const getDictionary: typeof getDictionaryFunction = (...args) => {\n  try {\n    if (typeof appNamespace === 'undefined') {\n      throw new Error(\n        'Intlayer is not initialized. Add the `app.use(intlayer());` middleware before using this function.'\n      );\n    }\n\n    if (typeof appNamespace.get('getDictionary') !== 'function') {\n      throw new Error(\n        'Using the import { t } from \"express-intlayer\" is not supported in your environment. Use the res.locals.t syntax instead.'\n      );\n    }\n\n    return appNamespace.get('getDictionary')(...args);\n  } catch (error) {\n    debug((error as Error).message);\n\n    return getDictionaryFunction(...args);\n  }\n};\n"],"mappings":";;;;;;;;AAeA,IAAI,cAAyC,CAAC;AAE9C,MAAM,gBAAgB,iBAAiB;AACvC,MAAM,EAAE,yBAAyB;AAG/B,SAAS,QAAgB,QAAQ,MAAM,GAAG;;;;AAM5C,MAAM,oBAAoB,QACxB,2BAA2B;CACzB,YAAY,SAAiB,IAAI,UAAU;CAC3C,YAAY,SAAiB,IAAI,UAAU;AAC7C,CAAC;AAEH,MAAM,eAAe,gBAAgB,KAAK;AAE1C,gBAAgB,aAAa;AAE7B,MAAa,qBACV,MAAe,KAAe,WAE7B,SACA,WACM;CACN,MAAM,EAAE,QAAQ,eAAe,kBAAkB,IAAI;CAKrD,MAAM,eAAe,UAAU;CAE/B,IAAI,OAAO,YAAY,aACrB,OAAO;CAGT,IAAI,OAAO,YAAY,UACrB,OAAO;CAGT,IACE,OAAO,UACL,kBACI,aAEN,IACE,OAAO,UACL,mBACI,aAEN,OAAO;MAEP,OAAO,eAAe,SAAS,aAAa;CAIhD,OAAO,eAAe,SAAS,YAAY;AAC7C;;;;;;;;;;;;;;;;;;;;AAqBF,MAAa,iBAAiC,OAAO,KAAK,KAAK,SAAS;CAEtE,MAAM,oBAAoB,iBAAiB,GAAG;CAG9C,MAAM,oBAA4C,CAAC;CAGnD,IAAI,OAAO,OAAO,IAAI,YAAY,UAEhC;OAAK,MAAM,OAAO,IAAI,SACpB,IAAI,OAAO,IAAI,QAAQ,SAAS,UAC9B,kBAAkB,OAAO,IAAI,QAAQ;CAEzC;CAGF,MAAM,iBAAiB,eACrB,mBACA,qBAAqB,SACrB,qBAAqB,aACvB;CAEA,IAAI,OAAO,iBAAiB;CAC5B,IAAI,OAAO,kBAAkB;CAC7B,IAAI,OAAO,SAAS,qBAAqB;CACzC,IAAI,OAAO,gBAAgB,qBAAqB;CAEhD,MAAM,IAAI,kBAAkB,KAAK,KAAK,IAAI;CAE1C,MAAM,eACJ,KACA,YAAY,gBACZ,GAAG,UACAA,cAAoB,KAAK,WAAW,GAAG,KAAK;CAEjD,MAAM,iBACJ,KACA,YAAY,gBACZ,GAAG,UACAC,gBAAsB,KAAK,WAAW,GAAG,KAAK;CAEnD,IAAI,OAAO,IAAI;CACf,IAAI,OAAO,cAAc;CACzB,IAAI,OAAO,gBAAgB;CAE3B,aAAa,UAAU;EACrB,aAAa,IAAI,KAAK,CAAC;EACvB,aAAa,IAAI,eAAe,WAAW;EAC3C,aAAa,IAAI,iBAAiB,aAAa;EAE/C,KAAK;CACP,CAAC;AACH;;;;;;;;;;;;;;;;;;;;;;;AAwBA,MAAa,KACX,SACA,WACY;CACZ,IAAI;EACF,IAAI,OAAO,iBAAiB,aAC1B,MAAM,IAAI,MACR,oGACF;EAGF,IAAI,OAAO,aAAa,IAAI,GAAG,MAAM,YACnC,MAAM,IAAI,MACR,6HACF;EAGF,OAAO,aAAa,IAAI,GAAG,CAAC,CAAC,SAAS,MAAM;CAC9C,SAAS,OAAO;EACd,MAAO,MAAgB,OAAO;EAE9B,OAAO,eACL,SACA,UAAU,qBAAqB,aACjC;CACF;AACF;AAEA,MAAa,eAA2C,GAAG,SAAS;CAClE,IAAI;EACF,IAAI,OAAO,iBAAiB,aAC1B,MAAM,IAAI,MACR,oGACF;EAGF,IAAI,OAAO,aAAa,IAAI,aAAa,MAAM,YAC7C,MAAM,IAAI,MACR,6HACF;EAGF,OAAO,aAAa,IAAI,aAAa,CAAC,CAAC,GAAG,IAAI;CAChD,SAAS,OAAO;EACd,MAAO,MAAgB,OAAO;EAE9B,OAAOD,cAAoB,GAAG,IAAI;CACpC;AACF;AAEA,MAAa,iBAA+C,GAAG,SAAS;CACtE,IAAI;EACF,IAAI,OAAO,iBAAiB,aAC1B,MAAM,IAAI,MACR,oGACF;EAGF,IAAI,OAAO,aAAa,IAAI,eAAe,MAAM,YAC/C,MAAM,IAAI,MACR,6HACF;EAGF,OAAO,aAAa,IAAI,eAAe,CAAC,CAAC,GAAG,IAAI;CAClD,SAAS,OAAO;EACd,MAAO,MAAgB,OAAO;EAE9B,OAAOC,gBAAsB,GAAG,IAAI;CACtC;AACF"}