@researchdatabox/redbox-core 0.0.0-bootstrap.0

package/dist/services/TemplateService.d.ts

@@ -0,0 +1,65 @@
+import { Services as services } from '../CoreService';
+import { Expression } from "jsonata";
+import { TemplateDelegate as HandlebarsTemplateDelegate } from "handlebars";
+import { TemplateCompileItem, TemplateCompileInput, TemplateCompileKey } from "@researchdatabox/sails-ng-common";
+export declare namespace Services {
+    class Template extends services.Core.Service {
+        private helpersRegistered;
+        /**
+         * Ensure shared Handlebars helpers are registered on the server.
+         */
+        private ensureHelpersRegistered;
+        /**
+         * Compile one or more inputs into an output mapping.
+         *
+         * The mapping provides a function 'evaluate(key, context)'.
+         * Provide the key for the template, and the context to apply to the template.
+         * @param inputs
+         */
+        buildClientMapping(inputs: TemplateCompileInput[]): TemplateCompileItem[];
+        /**
+         * Compile a JSONata expression to a form that is ready to be executed on the client.
+         *
+         * The expression will be normalised and have some transformations applied.
+         *
+         * @param expression The JSONata expression to compile.
+         */
+        buildClientJsonata(expression: string): string | null;
+        /**
+         * Compile a JSONata expression to a form that is ready to be executed on the server.
+         *
+         * The expression will be normalised and have some transformations applied.
+         *
+         * @param expression The JSONata expression to compile.
+         */
+        buildServerJsonata(expression: string): Expression | null;
+        /**
+         * Compile a Handlebars template to a form that is ready to be executed on the client.
+         *
+         * The template will be normalised and have some transformations applied.
+         *
+         * @param template
+         */
+        buildClientHandlebars(template: string): string | null;
+        /**
+         * Compile a Handlebars template to a form that is ready to be executed on the server.
+         *
+         * The template will be normalised and have some transformations applied.
+         *
+         * @param template
+         */
+        buildServerHandlebars(template: string): HandlebarsTemplateDelegate | null;
+        buildKeyString(key: TemplateCompileKey): string;
+        private buildSharedJsonata;
+        /**
+         * Normalise a string to reduce the potential variations in how characters are specified.
+         *
+         * @param value The string to normalise.
+         */
+        private normalise;
+    }
+}
+declare global {
+    let TemplateService: Services.Template;
+}
+//# sourceMappingURL=TemplateService.d.ts.map

package/dist/services/TemplateService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateService.d.ts","sourceRoot":"","sources":["../../src/services/TemplateService.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAgB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAmB,EAAE,gBAAgB,IAAI,0BAA0B,EAAE,MAAM,YAAY,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,kBAAkB,EAAwE,MAAM,kCAAkC,CAAC;AAIvL,yBAAiB,QAAQ,CAAC;IAEtB,MACa,QAAS,SAAQ,QAAQ,CAAC,IAAI,CAAC,OAAO;QAE/C,OAAO,CAAC,iBAAiB,CAAkB;QAE3C;;WAEG;QACH,OAAO,CAAC,uBAAuB;QAQ/B;;;;;;WAMG;QACI,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,mBAAmB,EAAE;QAqChF;;;;;;WAMG;QACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAe5D;;;;;;WAMG;QACI,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI;QAYhE;;;;;;WAMG;QACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;QAc7D;;;;;;WAMG;QACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,0BAA0B,GAAG,IAAI;QAa1E,cAAc,CAAC,GAAG,EAAE,kBAAkB,GAAG,MAAM;QAItD,OAAO,CAAC,kBAAkB;QAe1B;;;;WAIG;QACH,OAAO,CAAC,SAAS;KAYpB;CACJ;AAED,OAAO,CAAC,MAAM,CAAC;IACX,IAAI,eAAe,EAAE,QAAQ,CAAC,QAAQ,CAAC;CAC1C"}

package/dist/services/TemplateService.js

@@ -0,0 +1,208 @@
+"use strict";
+// Copyright (c) 2025 Queensland Cyber Infrastructure Foundation (http://www.qcif.edu.au/)
+//
+// GNU GENERAL PUBLIC LICENSE
+//    Version 2, June 1991
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Services = void 0;
+const PopulateExportedMethods_decorator_1 = require("../decorator/PopulateExportedMethods.decorator");
+const CoreService_1 = require("../CoreService");
+const jsonata_1 = __importDefault(require("jsonata"));
+const handlebars_1 = __importDefault(require("handlebars"));
+const sails_ng_common_1 = require("@researchdatabox/sails-ng-common");
+var Services;
+(function (Services) {
+    let Template = class Template extends CoreService_1.Services.Core.Service {
+        helpersRegistered = false;
+        /**
+         * Ensure shared Handlebars helpers are registered on the server.
+         */
+        ensureHelpersRegistered() {
+            if (!this.helpersRegistered) {
+                (0, sails_ng_common_1.registerSharedHandlebarsHelpers)(handlebars_1.default);
+                this.helpersRegistered = true;
+                sails.log.verbose('TemplateService: Registered shared Handlebars helpers');
+            }
+        }
+        /**
+         * Compile one or more inputs into an output mapping.
+         *
+         * The mapping provides a function 'evaluate(key, context)'.
+         * Provide the key for the template, and the context to apply to the template.
+         * @param inputs
+         */
+        buildClientMapping(inputs) {
+            const keys = inputs.map(i => (0, sails_ng_common_1.buildKeyString)(i.key));
+            const keysUnique = new Set(keys);
+            if (keysUnique.size != keys.length) {
+                const duplicates = keys.filter((item, index) => keys.indexOf(item) != index);
+                const duplicatesUnique = Array.from(new Set(duplicates)).sort();
+                throw new Error(`Keys must be unique: '${duplicatesUnique.join(', ')}'`);
+            }
+            const result = [];
+            for (const input of inputs) {
+                // The key is stored as a string array (composite key).
+                // The duplicate check above uses the flattened, normalized string form (buildKeyString)
+                // to ensure uniqueness across the composite keys.
+                switch (input.kind) {
+                    case "jsonata":
+                        const jsonataExpr = this.buildClientJsonata(input.value);
+                        if (jsonataExpr) {
+                            result.push({
+                                key: input.key,
+                                value: `jsonata(${JSON.stringify(jsonataExpr)}).evaluate(context)`,
+                            });
+                        }
+                        break;
+                    case "handlebars":
+                        result.push({
+                            key: input.key,
+                            value: `Handlebars.template(${this.buildClientHandlebars(input.value)?.toString()})(context)`,
+                        });
+                        break;
+                    default:
+                        throw new Error(`Unknown input kind '${input.kind}' expected one of: '${sails_ng_common_1.templateCompileKind.join(', ')}'`);
+                }
+            }
+            return result;
+        }
+        /**
+         * Compile a JSONata expression to a form that is ready to be executed on the client.
+         *
+         * The expression will be normalised and have some transformations applied.
+         *
+         * @param expression The JSONata expression to compile.
+         */
+        buildClientJsonata(expression) {
+            try {
+                expression = this.normalise(expression);
+                // Validate the expression by compiling it
+                const compiled = this.buildSharedJsonata(expression);
+                sails.log.verbose(`Validated client JSONata expression '${expression}'`, compiled);
+                // Return the expression string for client-side compilation
+                // The client will call jsonata(expression).evaluate(context)
+                return expression;
+            }
+            catch (error) {
+                sails.log.error(`Could not compile client JSONata expression '${expression}'`, error);
+                return null;
+            }
+        }
+        /**
+         * Compile a JSONata expression to a form that is ready to be executed on the server.
+         *
+         * The expression will be normalised and have some transformations applied.
+         *
+         * @param expression The JSONata expression to compile.
+         */
+        buildServerJsonata(expression) {
+            try {
+                expression = this.normalise(expression);
+                const result = this.buildSharedJsonata(expression);
+                sails.log.verbose(`Built server JSONata expression '${expression}'`);
+                return result;
+            }
+            catch (error) {
+                sails.log.error(`Could not build server JSONata expression '${expression}'`, error);
+                return null;
+            }
+        }
+        /**
+         * Compile a Handlebars template to a form that is ready to be executed on the client.
+         *
+         * The template will be normalised and have some transformations applied.
+         *
+         * @param template
+         */
+        buildClientHandlebars(template) {
+            try {
+                this.ensureHelpersRegistered();
+                template = this.normalise(template);
+                // handlebars pre-compiled output is already a string
+                const result = handlebars_1.default.precompile(template)?.toString();
+                sails.log.verbose(`Built client Handlebars template '${template}'`);
+                return result;
+            }
+            catch (error) {
+                sails.log.error(`Could not build client Handlebars template '${template}'`, error);
+                return null;
+            }
+        }
+        /**
+         * Compile a Handlebars template to a form that is ready to be executed on the server.
+         *
+         * The template will be normalised and have some transformations applied.
+         *
+         * @param template
+         */
+        buildServerHandlebars(template) {
+            try {
+                this.ensureHelpersRegistered();
+                template = this.normalise(template);
+                const result = handlebars_1.default.compile(template);
+                sails.log.verbose(`Built server Handlebars template '${template}'`);
+                return result;
+            }
+            catch (error) {
+                sails.log.error(`Could not build server Handlebars template '${template}'`, error);
+                return null;
+            }
+        }
+        buildKeyString(key) {
+            return (0, sails_ng_common_1.buildKeyString)(key);
+        }
+        buildSharedJsonata(expression) {
+            const compiled = (0, jsonata_1.default)(expression);
+            // override the built-in JSONata 'eval' function
+            // TODO: check this actually overrides the 'eval' function
+            compiled.registerFunction("eval", () => undefined);
+            // TODO: register a function for obtaining translations
+            // TODO: register a function for formatting date time values
+            // TODO: register a function / context state holder that provides model data
+            // TODO: replace regex with google's re2?
+            return compiled;
+        }
+        /**
+         * Normalise a string to reduce the potential variations in how characters are specified.
+         *
+         * @param value The string to normalise.
+         */
+        normalise(value) {
+            value = value?.toString() ?? "";
+            // Use NFKC: Compatibility Decomposition, followed by Canonical Composition.
+            // For Identifiers matching: Canonical form, no visual variants
+            const normForm = "NFKC";
+            const norm = value.normalize(normForm);
+            // TODO: other normalisations?
+            return norm;
+        }
+    };
+    Template = __decorate([
+        PopulateExportedMethods_decorator_1.PopulateExportedMethods
+    ], Template);
+    Services.Template = Template;
+})(Services || (exports.Services = Services = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVGVtcGxhdGVTZXJ2aWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3NlcnZpY2VzL1RlbXBsYXRlU2VydmljZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEZBQTBGO0FBQzFGLEVBQUU7QUFDRiw2QkFBNkI7QUFDN0IsMEJBQTBCO0FBQzFCLEVBQUU7QUFDRix1RUFBdUU7QUFDdkUsdUVBQXVFO0FBQ3ZFLG9FQUFvRTtBQUNwRSxzQ0FBc0M7QUFDdEMsRUFBRTtBQUNGLGtFQUFrRTtBQUNsRSxpRUFBaUU7QUFDakUsZ0VBQWdFO0FBQ2hFLCtDQUErQztBQUMvQyxFQUFFO0FBQ0YsMEVBQTBFO0FBQzFFLDBFQUEwRTtBQUMxRSw4REFBOEQ7Ozs7Ozs7Ozs7OztBQUU5RCxzR0FBeUY7QUFDekYsZ0RBQXNEO0FBQ3RELHNEQUE4QztBQUM5Qyw0REFBd0Y7QUFDeEYsc0VBQXVMO0FBSXZMLElBQWlCLFFBQVEsQ0FxTHhCO0FBckxELFdBQWlCLFFBQVE7SUFHckIsSUFBYSxRQUFRLEdBQXJCLE1BQWEsUUFBUyxTQUFRLHNCQUFRLENBQUMsSUFBSSxDQUFDLE9BQU87UUFFdkMsaUJBQWlCLEdBQVksS0FBSyxDQUFDO1FBRTNDOztXQUVHO1FBQ0ssdUJBQXVCO1lBQzNCLElBQUksQ0FBQyxJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQztnQkFDMUIsSUFBQSxpREFBK0IsRUFBQyxvQkFBVSxDQUFDLENBQUM7Z0JBQzVDLElBQUksQ0FBQyxpQkFBaUIsR0FBRyxJQUFJLENBQUM7Z0JBQzlCLEtBQUssQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLHVEQUF1RCxDQUFDLENBQUM7WUFDL0UsQ0FBQztRQUNMLENBQUM7UUFFRDs7Ozs7O1dBTUc7UUFDSSxrQkFBa0IsQ0FBQyxNQUE4QjtZQUNwRCxNQUFNLElBQUksR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBQSxnQ0FBYyxFQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1lBQ3BELE1BQU0sVUFBVSxHQUFHLElBQUksR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO1lBQ2pDLElBQUksVUFBVSxDQUFDLElBQUksSUFBSSxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7Z0JBQ2pDLE1BQU0sVUFBVSxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLEtBQUssQ0FBQyxDQUFDO2dCQUM3RSxNQUFNLGdCQUFnQixHQUFHLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztnQkFDaEUsTUFBTSxJQUFJLEtBQUssQ0FBQyx5QkFBeUIsZ0JBQWdCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUM3RSxDQUFDO1lBRUQsTUFBTSxNQUFNLEdBQTBCLEVBQUUsQ0FBQztZQUN6QyxLQUFLLE1BQU0sS0FBSyxJQUFJLE1BQU0sRUFBRSxDQUFDO2dCQUN6Qix1REFBdUQ7Z0JBQ3ZELHdGQUF3RjtnQkFDeEYsa0RBQWtEO2dCQUNsRCxRQUFRLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQztvQkFDakIsS0FBSyxTQUFTO3dCQUNWLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLENBQUM7d0JBQ3pELElBQUksV0FBVyxFQUFFLENBQUM7NEJBQ2QsTUFBTSxDQUFDLElBQUksQ0FBQztnQ0FDUixHQUFHLEVBQUUsS0FBSyxDQUFDLEdBQUc7Z0NBQ2QsS0FBSyxFQUFFLFdBQVcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxXQUFXLENBQUMscUJBQXFCOzZCQUNyRSxDQUFDLENBQUM7d0JBQ1AsQ0FBQzt3QkFDRCxNQUFNO29CQUNWLEtBQUssWUFBWTt3QkFDYixNQUFNLENBQUMsSUFBSSxDQUFDOzRCQUNSLEdBQUcsRUFBRSxLQUFLLENBQUMsR0FBRzs0QkFDZCxLQUFLLEVBQUUsdUJBQXVCLElBQUksQ0FBQyxxQkFBcUIsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLEVBQUUsUUFBUSxFQUFFLFlBQVk7eUJBQ2hHLENBQUMsQ0FBQzt3QkFDSCxNQUFNO29CQUNWO3dCQUNJLE1BQU0sSUFBSSxLQUFLLENBQUMsdUJBQXVCLEtBQUssQ0FBQyxJQUFJLHVCQUF1QixxQ0FBbUIsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUNuSCxDQUFDO1lBQ0wsQ0FBQztZQUNELE9BQU8sTUFBTSxDQUFDO1FBQ2xCLENBQUM7UUFFRDs7Ozs7O1dBTUc7UUFDSSxrQkFBa0IsQ0FBQyxVQUFrQjtZQUN4QyxJQUFJLENBQUM7Z0JBQ0QsVUFBVSxHQUFHLElBQUksQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLENBQUM7Z0JBQ3hDLDBDQUEwQztnQkFDMUMsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLGtCQUFrQixDQUFDLFVBQVUsQ0FBQyxDQUFDO2dCQUNyRCxLQUFLLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyx3Q0FBd0MsVUFBVSxHQUFHLEVBQUUsUUFBUSxDQUFDLENBQUM7Z0JBQ25GLDJEQUEyRDtnQkFDM0QsNkRBQTZEO2dCQUM3RCxPQUFPLFVBQVUsQ0FBQztZQUN0QixDQUFDO1lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztnQkFDYixLQUFLLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxnREFBZ0QsVUFBVSxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7Z0JBQ3RGLE9BQU8sSUFBSSxDQUFDO1lBQ2hCLENBQUM7UUFDTCxDQUFDO1FBRUQ7Ozs7OztXQU1HO1FBQ0ksa0JBQWtCLENBQUMsVUFBa0I7WUFDeEMsSUFBSSxDQUFDO2dCQUNELFVBQVUsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FBQyxDQUFDO2dCQUN4QyxNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsa0JBQWtCLENBQUMsVUFBVSxDQUFDLENBQUM7Z0JBQ25ELEtBQUssQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLG9DQUFvQyxVQUFVLEdBQUcsQ0FBQyxDQUFDO2dCQUNyRSxPQUFPLE1BQU0sQ0FBQztZQUNsQixDQUFDO1lBQUMsT0FBTyxLQUFLLEVBQUUsQ0FBQztnQkFDYixLQUFLLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyw4Q0FBOEMsVUFBVSxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUM7Z0JBQ3BGLE9BQU8sSUFBSSxDQUFDO1lBQ2hCLENBQUM7UUFDTCxDQUFDO1FBRUQ7Ozs7OztXQU1HO1FBQ0kscUJBQXFCLENBQUMsUUFBZ0I7WUFDekMsSUFBSSxDQUFDO2dCQUNELElBQUksQ0FBQyx1QkFBdUIsRUFBRSxDQUFDO2dCQUMvQixRQUFRLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsQ0FBQztnQkFDcEMscURBQXFEO2dCQUNyRCxNQUFNLE1BQU0sR0FBRyxvQkFBVSxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsRUFBRSxRQUFRLEVBQUUsQ0FBQztnQkFDM0QsS0FBSyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMscUNBQXFDLFFBQVEsR0FBRyxDQUFDLENBQUM7Z0JBQ3BFLE9BQU8sTUFBTSxDQUFDO1lBQ2xCLENBQUM7WUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO2dCQUNiLEtBQUssQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLCtDQUErQyxRQUFRLEdBQUcsRUFBRSxLQUFLLENBQUMsQ0FBQztnQkFDbkYsT0FBTyxJQUFJLENBQUM7WUFDaEIsQ0FBQztRQUNMLENBQUM7UUFFRDs7Ozs7O1dBTUc7UUFDSSxxQkFBcUIsQ0FBQyxRQUFnQjtZQUN6QyxJQUFJLENBQUM7Z0JBQ0QsSUFBSSxDQUFDLHVCQUF1QixFQUFFLENBQUM7Z0JBQy9CLFFBQVEsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxDQUFDO2dCQUNwQyxNQUFNLE1BQU0sR0FBRyxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUMsQ0FBQztnQkFDNUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxPQUFPLENBQUMscUNBQXFDLFFBQVEsR0FBRyxDQUFDLENBQUM7Z0JBQ3BFLE9BQU8sTUFBTSxDQUFDO1lBQ2xCLENBQUM7WUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO2dCQUNiLEtBQUssQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLCtDQUErQyxRQUFRLEdBQUcsRUFBRSxLQUFLLENBQUMsQ0FBQztnQkFDbkYsT0FBTyxJQUFJLENBQUM7WUFDaEIsQ0FBQztRQUNMLENBQUM7UUFFTSxjQUFjLENBQUMsR0FBdUI7WUFDekMsT0FBTyxJQUFBLGdDQUFjLEVBQUMsR0FBRyxDQUFDLENBQUM7UUFDL0IsQ0FBQztRQUVPLGtCQUFrQixDQUFDLFVBQWtCO1lBQ3pDLE1BQU0sUUFBUSxHQUFHLElBQUEsaUJBQU8sRUFBQyxVQUFVLENBQUMsQ0FBQztZQUVyQyxnREFBZ0Q7WUFDaEQsMERBQTBEO1lBQzFELFFBQVEsQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFNLEVBQUUsR0FBRyxFQUFFLENBQUMsU0FBUyxDQUFDLENBQUM7WUFFbkQsdURBQXVEO1lBQ3ZELDREQUE0RDtZQUM1RCw0RUFBNEU7WUFDNUUseUNBQXlDO1lBRXpDLE9BQU8sUUFBUSxDQUFDO1FBQ3BCLENBQUM7UUFFRDs7OztXQUlHO1FBQ0ssU0FBUyxDQUFDLEtBQWE7WUFDM0IsS0FBSyxHQUFHLEtBQUssRUFBRSxRQUFRLEVBQUUsSUFBSSxFQUFFLENBQUM7WUFFaEMsNEVBQTRFO1lBQzVFLCtEQUErRDtZQUMvRCxNQUFNLFFBQVEsR0FBRyxNQUFNLENBQUM7WUFDeEIsTUFBTSxJQUFJLEdBQUcsS0FBSyxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsQ0FBQztZQUV2Qyw4QkFBOEI7WUFFOUIsT0FBTyxJQUFJLENBQUM7UUFDaEIsQ0FBQztLQUNKLENBQUE7SUFqTFksUUFBUTtRQURwQiwyREFBdUI7T0FDWCxRQUFRLENBaUxwQjtJQWpMWSxpQkFBUSxXQWlMcEIsQ0FBQTtBQUNMLENBQUMsRUFyTGdCLFFBQVEsd0JBQVIsUUFBUSxRQXFMeEIifQ==

package/dist/services/TranslationService.d.ts

@@ -0,0 +1,38 @@
+import { BrandingModel } from '../model/storage/BrandingModel';
+import { Services as services } from '../CoreService';
+type NextFunction = () => void;
+export declare namespace Services {
+    /**
+     * Translation services...
+     *
+     *
+     * Author: <a href='https://github.com/shilob' target='_blank'>Shilo Banihit</a>
+     *
+     */
+    class Translation extends services.Core.Service {
+        private i18nextInstances;
+        /**
+         * Get or create an i18next instance for a specific branding
+         */
+        private getI18nextForBranding;
+        /**
+         * Clear and reinitialize i18next instances (useful for config changes)
+         */
+        clearInstances(brandingId?: string): Promise<void>;
+        bootstrap(): Promise<void>;
+        private _fetchResourcesFromDb;
+        t(key: string, context?: Record<string, unknown> | undefined, langCode?: string, brandingName?: string): string;
+        tInter(key: string, context?: Record<string, unknown> | null, langCode?: string): string;
+        reloadResources(brandingId?: string): Promise<void>;
+        /**
+         * Get available languages for a specific branding from DB
+         */
+        getAvailableLanguagesForBranding(branding: BrandingModel | null): Promise<string[]>;
+        handle(req: Sails.Req, res: Sails.Res, next: NextFunction): Promise<void>;
+    }
+}
+declare global {
+    let TranslationService: Services.Translation;
+}
+export {};
+//# sourceMappingURL=TranslationService.d.ts.map

package/dist/services/TranslationService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TranslationService.d.ts","sourceRoot":"","sources":["../../src/services/TranslationService.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAE/D,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAKtD,KAAK,YAAY,GAAG,MAAM,IAAI,CAAC;AAS/B,yBAAiB,QAAQ,CAAC;IACxB;;;;;;OAMG;IACH,MACa,WAAY,SAAQ,QAAQ,CAAC,IAAI,CAAC,OAAO;QAGpD,OAAO,CAAC,gBAAgB,CAAoC;QAG5D;;WAEG;gBACW,qBAAqB;QA+GnC;;WAEG;QACU,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM;QAUlC,SAAS;gBAiBR,qBAAqB;QAyC5B,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAqB,EAAE,QAAQ,GAAE,MAAa,EAAE,YAAY,GAAE,MAAkB;QAgBlI,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAW,EAAE,QAAQ,GAAE,MAAa;QAIrF,eAAe,CAAC,UAAU,CAAC,EAAE,MAAM;QAgBhD;;WAEG;QACU,gCAAgC,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QA6CnF,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,YAAY;KA0DvE;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,kBAAkB,EAAE,QAAQ,CAAC,WAAW,CAAC;CAC9C"}