@itrocks/framework 0.6.3 → 0.6.5

package/README.md

@@ -74,6 +74,28 @@ import { beforeFrameworkRun } from '@itrocks/framework'
 beforeFrameworkRun(() => import('./src/dependencies'))
 ```
 
+### Request languages
+
+The framework can select one translation catalog for each request without sharing language state between concurrent
+requests. Templates and translation keys are written in English. Configure the supported languages in the application
+configuration:
+
+```yaml
+translate:
+  defaultLanguage: fr-FR
+  supportedLanguages:
+    - en-US
+    - fr-FR
+```
+
+The language stored in `request.session.language` takes precedence. Otherwise, the framework negotiates the
+`Accept-Language` header, matching an exact locale first and then its base language. Unsupported values fall back to
+`defaultLanguage`. The framework loads each `<language>.csv` catalog directly; English needs no catalog because it is
+the source language. Every response includes `Content-Language` and varies on `Accept-Language`.
+
+Catalog rows contain lowercase, context-free fragments. Sentence periods stay in templates so the translation engine
+can translate each sentence independently and restore contextual capitalization.
+
 ### Using framework reflection helpers
 
 `ReflectClass` and `ReflectProperty` behave like their counterparts from

package/cjs/dependencies.js

@@ -45,9 +45,11 @@ const transformer_1 = require("@itrocks/transformer");
 const transformer_2 = require("@itrocks/transformer");
 const transformer_3 = require("@itrocks/transformer");
 const translate_1 = require("@itrocks/translate");
+const translate_2 = require("@itrocks/translate");
 const date_fns_1 = require("date-fns");
 const node_path_1 = require("node:path");
 const node_path_2 = require("node:path");
+const language_1 = require("./language");
 const sql_join_dependencies_1 = require("./sql-join-dependencies");
 const sql_join_dependencies_2 = require("./sql-join-dependencies");
 const sql_join_dependencies_3 = require("./sql-join-dependencies");
@@ -60,7 +62,7 @@ async function propertyOutput(object, property) {
     return (0, transformer_1.applyTransformer)(await object[property], object, property, transformer_2.HTML, transformer_3.OUTPUT);
 }
 function bind() {
-    (0, class_view_1.classViewDependsOn)({ propertyOutput, requiredOf: required_1.requiredOf, tr: translate_1.tr });
+    (0, class_view_1.classViewDependsOn)({ propertyOutput, requiredOf: required_1.requiredOf, tr: translate_2.tr });
     if (config_1.config.dataSource) {
         (0, storage_1.createDataSource)(config_1.config.dataSource);
     }
@@ -69,13 +71,13 @@ function bind() {
         displayOf: property_view_1.displayOf,
         fieldIdOf: rename_2.toCssId,
         fieldNameOf: rename_2.toField,
-        formatDate: date => (0, date_fns_1.format)(date, (0, translate_1.tr)('dd/MM/yyyy', { ucFirst: false })),
+        formatDate: date => (0, date_fns_1.format)(date, (0, translate_2.tr)('dd/MM/yyyy', { ucFirst: false })),
         ignoreTransformedValue: transformer_2.IGNORE,
-        parseDate: date => (0, date_fns_1.parse)(date, (0, translate_1.tr)('dd/MM/yyyy', { ucFirst: false }), new Date),
+        parseDate: date => (0, date_fns_1.parse)(date, (0, translate_2.tr)('dd/MM/yyyy', { ucFirst: false }), new Date),
         propertyOutput,
         representativeValueOf: class_view_2.representativeValueOf,
         routeOf: route_2.routeOf,
-        tr: translate_1.tr
+        tr: translate_2.tr
     });
     (0, file_1.initFileTransformers)();
     (0, list_properties_1.initListProperties)();
@@ -141,10 +143,7 @@ function bind() {
             ? (await require('@itrocks/class-view').representativeValueOf(data))
             : '' + data
     });
-    (0, translate_1.trInit)('fr-FR');
-    (0, translate_1.trLoad)((0, node_path_1.join)(__dirname, '..', 'fr-FR.csv')).catch();
-    (0, translate_1.trLoad)((0, node_path_1.join)(app_dir_1.appDir, 'app', 'fr-FR.csv')).catch();
-    (0, translate_1.trLoad)((0, node_path_1.join)(app_dir_1.appDir, 'fr-FR.csv')).catch();
+    (0, language_1.configureLanguages)();
     action_1.Action.prototype.htmlTemplateResponse = async function (data, request, templateFile, statusCode = 200, headers = {}) {
         const containerData = Object.assign(defaultContainerData(request), this);
         const contained = !request.request.headers['xhr-info'] && config_1.config.container?.file;
@@ -171,6 +170,7 @@ function defaultContainerData(request) {
     return Object.assign({
         action: request.action,
         favicon: config_1.config.container?.favicon ?? (0, node_path_2.normalize)((0, node_path_1.join)(__dirname, '../favicon.ico')),
+        language: (0, translate_1.lang)(),
         manifest: config_1.config.container?.manifest ? [config_1.config.container.manifest] : [],
         request,
         scripts: config_1.config.container?.scripts,

package/cjs/language.d.ts

@@ -0,0 +1,5 @@
+import { Request } from '@itrocks/request-response';
+export declare function configureLanguages(): void;
+export declare function languageFromHeader(header: string | undefined, supportedLanguages?: string[], defaultLanguage?: string): string;
+export declare function languageOf(request: Request): string;
+export declare function withRequestLanguage<T>(request: Request, callback: () => T | Promise<T>): Promise<T>;

package/cjs/language.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureLanguages = configureLanguages;
+exports.languageFromHeader = languageFromHeader;
+exports.languageOf = languageOf;
+exports.withRequestLanguage = withRequestLanguage;
+const app_dir_1 = require("@itrocks/app-dir");
+const config_1 = require("@itrocks/config");
+const translate_1 = require("@itrocks/translate");
+const translate_2 = require("@itrocks/translate");
+const translate_3 = require("@itrocks/translate");
+const node_path_1 = require("node:path");
+let configuration = {
+    defaultLanguage: 'fr-FR',
+    supportedLanguages: ['fr-FR']
+};
+let loading = Promise.resolve(undefined);
+function canonicalLanguage(value) {
+    try {
+        return Intl.getCanonicalLocales(value)[0];
+    }
+    catch {
+        return;
+    }
+}
+function configureLanguages() {
+    const options = (config_1.config.translate ?? {});
+    const defaultLanguage = canonicalLanguage(options.defaultLanguage) ?? 'fr-FR';
+    const supportedLanguages = options.supportedLanguages
+        .map(language => canonicalLanguage(language))
+        .filter((language) => !!language);
+    if (!supportedLanguages.includes(defaultLanguage)) {
+        supportedLanguages.push(defaultLanguage);
+    }
+    configuration = { defaultLanguage, supportedLanguages: [...new Set(supportedLanguages)] };
+    (0, translate_1.trInit)(defaultLanguage);
+    loading = (async () => {
+        // TODO search language files everywhere in application modules, not only into app
+        const directories = [(0, node_path_1.join)(__dirname, '..'), (0, node_path_1.join)(app_dir_1.appDir, 'app'), app_dir_1.appDir];
+        for (const language of configuration.supportedLanguages) {
+            for (const directory of directories) {
+                const file = (0, node_path_1.join)(directory, language + '.csv');
+                await (0, translate_2.trLoad)(file, language);
+            }
+        }
+    })();
+}
+function languageFromHeader(header, supportedLanguages = configuration.supportedLanguages, defaultLanguage = configuration.defaultLanguage) {
+    const preferences = (header ?? '').split(',').map((item, index) => {
+        const [range, ...parameters] = item.trim().split(';');
+        const qualityParameter = parameters.find(parameter => parameter.trim().startsWith('q='));
+        const quality = qualityParameter ? Number(qualityParameter.trim().slice(2)) : 1;
+        return { index, quality: Number.isFinite(quality) ? quality : 0, range };
+    }).filter(preference => preference.range && (preference.quality > 0))
+        .sort((left, right) => right.quality - left.quality || left.index - right.index);
+    for (const preference of preferences) {
+        if (preference.range === '*')
+            return defaultLanguage;
+        const requested = canonicalLanguage(preference.range);
+        if (!requested)
+            continue;
+        const exact = supportedLanguages.find(language => language.toLowerCase() === requested.toLowerCase());
+        if (exact)
+            return exact;
+        const base = requested.split('-')[0].toLowerCase();
+        const compatible = supportedLanguages.find(language => language.split('-')[0].toLowerCase() === base);
+        if (compatible)
+            return compatible;
+    }
+    return defaultLanguage;
+}
+function languageOf(request) {
+    const preferred = canonicalLanguage(request.session.language);
+    if (preferred) {
+        const supported = configuration.supportedLanguages.find(language => language.toLowerCase() === preferred.toLowerCase());
+        if (supported)
+            return supported;
+    }
+    return languageFromHeader(request.headers['accept-language']);
+}
+async function withRequestLanguage(request, callback) {
+    await loading;
+    return (0, translate_3.trWithLanguage)(languageOf(request), callback);
+}
+//# sourceMappingURL=language.js.map

package/cjs/main.js

@@ -15,12 +15,27 @@ const route_1 = require("@itrocks/route");
 const session_1 = require("@itrocks/session");
 const store_1 = require("@itrocks/store");
 const template_1 = require("@itrocks/template");
+const translate_1 = require("@itrocks/translate");
 const node_crypto_1 = require("node:crypto");
 const node_path_1 = require("node:path");
 const node_path_2 = require("node:path");
+const language_1 = require("./language");
 const servers_1 = require("./servers");
 const ephemeralSessionSecret = (0, node_crypto_1.randomBytes)(32).toString('base64url');
 template_1.frontScripts.push('/lib/air-datepicker/locale/en.js', '/lib/air-datepicker/locale/fr.js');
+function appendVary(headers, value) {
+    const name = Object.keys(headers).find(name => (name.toLowerCase() === 'vary')) ?? 'Vary';
+    const values = (headers[name] ?? '').split(',').map(value => value.trim()).filter(Boolean);
+    if (!values.some(current => (current.toLowerCase() === value.toLowerCase()))) {
+        values.push(value);
+    }
+    headers[name] = values.join(', ');
+}
+function defaultHeader(headers, name, value) {
+    if (!Object.keys(headers).some(current => (current.toLowerCase() === name.toLowerCase()))) {
+        headers[name] = value;
+    }
+}
 async function execute(request) {
     // Access control
     if ((config_1.config.access?.free !== '*')
@@ -69,7 +84,12 @@ async function run() {
     const server = new fastify_1.FastifyServer({
         assetPath: app_dir_1.appDir,
         cookie: config_1.config.session.cookie,
-        execute: request => execute(new action_request_2.Request(request)),
+        execute: request => (0, language_1.withRequestLanguage)(request, async () => {
+            const response = await execute(new action_request_2.Request(request));
+            appendVary(response.headers, 'Accept-Language');
+            defaultHeader(response.headers, 'Content-Language', (0, translate_1.lang)());
+            return response;
+        }),
         favicon: config_1.config.container?.favicon ?? (0, node_path_2.normalize)((0, node_path_1.join)(__dirname, '../favicon.png')),
         fileSize: config_1.config.server.fileSize,
         frontScripts: template_1.frontScripts,

package/package.json

@@ -103,5 +103,5 @@
 		"build:front": "tsc -p src/front/tsconfig.json && node -e \"const fs=require('node:fs');for(const file of fs.readdirSync('.').filter(file=>file.endsWith('.js')||file.endsWith('.d.ts')))fs.writeFileSync(file,fs.readFileSync(file,'utf8').replaceAll('../../',''))\"",
 		"test": "npm run build && node --test test/*.test.js"
 	},
-	"version": "0.6.3"
+	"version": "0.6.5"
 }