@ti-engine/web-framework 1.19.0 → 1.19.1

package/bin/web-server.json

@@ -1,49 +1,49 @@
-{
-  "api": {
-    "endpointEnabled": true,
-    "inventory": {
-      "v1": {
-        "test-1": {
-          "serviceAlias": "service1",
-          "serviceDomainName": "ti-tester-service",
-          "serviceVersion": 1
-        }
-      }
-    },
-    "requestTimeout": 120000
-  },
-  "auth": {
-    "enabledMethods": [
-      "local",
-      "openid-google"
-    ],
-    "admins": [],
-    "oauth2": {
-      "azure": {
-        "tokenEndpointAuthMethod": "client_secret_post",
-        "callbackUrl": "/login/azure-callback",
-        "isPublic": false
-      },
-      "google": {
-        "tokenEndpointAuthMethod": "client_secret_post",
-        "callbackUrl": "/login/google-callback",
-        "discoveryUrl": "https://accounts.google.com/.well-known/openid-configuration",
-        "isPublic": false
-      }
-    }
-  },
-  "cookies": {
-    "path": "/",
-    "httpOnly": true,
-    "sameSite": "lax",
-    "maxAge": 604800
-  },
-  "host": "127.0.0.1",
-  "language": "en",
-  "port": 3000,
-  "publicPath": "bin/static",
-  "requestTimeout": 180000,
-  "tlsCertPath": "bin/tls/localhost+2.pem",
-  "tlsKeyPath": "bin/tls/localhost+2-key.pem",
-  "useTLS": true
+{
+  "api": {
+    "endpointEnabled": true,
+    "inventory": {
+      "v1": {
+        "test-1": {
+          "serviceAlias": "service1",
+          "serviceDomainName": "ti-tester-service",
+          "serviceVersion": 1
+        }
+      }
+    },
+    "requestTimeout": 120000
+  },
+  "auth": {
+    "enabledMethods": [
+      "local",
+      "openid-google"
+    ],
+    "admins": [],
+    "oauth2": {
+      "azure": {
+        "tokenEndpointAuthMethod": "client_secret_post",
+        "callbackUrl": "/login/azure-callback",
+        "isPublic": false
+      },
+      "google": {
+        "tokenEndpointAuthMethod": "client_secret_post",
+        "callbackUrl": "/login/google-callback",
+        "discoveryUrl": "https://accounts.google.com/.well-known/openid-configuration",
+        "isPublic": false
+      }
+    }
+  },
+  "cookies": {
+    "path": "/",
+    "httpOnly": true,
+    "sameSite": "lax",
+    "maxAge": 604800
+  },
+  "host": "127.0.0.1",
+  "language": "en",
+  "port": 3000,
+  "publicPath": "bin/static",
+  "requestTimeout": 180000,
+  "tlsCertPath": "bin/tls/localhost+2.pem",
+  "tlsKeyPath": "bin/tls/localhost+2-key.pem",
+  "useTLS": true
 }

package/components/admin-config-handlers.js

@@ -1,92 +1,92 @@
-/*
- * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
- * Copyright © 2021-2026 Boris Kostadinov <kostadinov.boris@gmail.com>
- * 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 3 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, see <https://www.gnu.org/licenses/>.
-*/
-
-/**
- * Express handler factories for the admin configuration-management API. Each factory takes the {@link ConfigService}
- * to delegate to (injected so the handlers are unit-testable), and returns an Express middleware that responds in the
- * framework's convention — `{ isSuccessful: true, data }` on success — forwarding errors to the error middleware.
- * Validation failures come back as `data` (`{ ok:false, errors }`) so the UI can render field-level messages; a
- * version conflict maps to `409` and an unknown editor/document/change-set to `404`. These routes are gated by the
- * `requireAdmin` guard and inherit the server's global auth + CSRF middleware.
- *
- * @module admin-config-handlers
- */
-
-const exceptions = require( "@ti-engine/core/exceptions" );
-
-function sendData( response, data ) {
-    response.set( "Cache-Control", "no-store" );
-    response.set( "Content-Type", "application/json; charset=utf-8" );
-    response.status( exceptions.httpCode.C_200 ).send( { isSuccessful: true, data: data } );
-}
-
-function forward( next, error ) {
-    const reason = error && error.data && error.data.reason;
-    const raised = exceptions.raise( error );
-    if ( reason === "version-conflict" ) {
-        raised.httpCode = exceptions.httpCode.C_409;
-    } else if ( reason === "unknown-editor" || reason === "unknown-changeset" || reason === "unknown-config" ) {
-        raised.httpCode = exceptions.httpCode.C_404;
-    }
-    next( raised );
-}
-
-function adminID( request ) {
-    return ( request.session && request.session.user ) ? request.session.user.userID : undefined;
-}
-
-/**
- * @param {ConfigService} service
- * @returns {ExpressHandler}
- */
-module.exports.listEditors = ( service ) => ( request, response, next ) => {
-    try {
-        sendData( response, service.listEditors() );
-    } catch ( error ) {
-        forward( next, error );
-    }
-};
-
-module.exports.composeView = ( service ) => ( request, response, next ) => {
-    service.composeView( request.params.editorKey ).then( ( view ) => sendData( response, view ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.saveEditorEdit = ( service ) => ( request, response, next ) => {
-    const body = request.body || {};
-    service.saveEditorEdit( request.params.editorKey, body.edited, { adminID: adminID( request ), note: body.note }, body.expectedVersions ).then( ( result ) => sendData( response, result ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.getCurrent = ( service ) => ( request, response, next ) => {
-    service.getCurrent( request.params.configKey ).then( ( current ) => sendData( response, current ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.getHistory = ( service ) => ( request, response, next ) => {
-    service.getHistory( request.params.configKey ).then( ( history ) => sendData( response, history ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.listChanges = ( service ) => ( request, response, next ) => {
-    service.listChanges().then( ( changes ) => sendData( response, changes ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.getChange = ( service ) => ( request, response, next ) => {
-    service.getChange( request.params.changeSetID ).then( ( change ) => sendData( response, change ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.restoreChangeSet = ( service ) => ( request, response, next ) => {
-    const body = request.body || {};
-    service.restoreChangeSet( request.params.changeSetID, { adminID: adminID( request ), note: body.note } ).then( ( result ) => sendData( response, result ) ).catch( ( error ) => forward( next, error ) );
-};
-
-module.exports.exportBundle = ( service ) => ( request, response, next ) => {
-    service.exportBundle( { adminID: adminID( request ) } ).then( ( bundle ) => {
-        response.set( "Cache-Control", "no-store" );
-        response.set( "Content-Type", "application/json; charset=utf-8" );
-        response.set( "Content-Disposition", "attachment; filename=\"config-export.json\"" );
-        response.status( exceptions.httpCode.C_200 ).send( JSON.stringify( bundle, null, 2 ) );
-    } ).catch( ( error ) => forward( next, error ) );
-};
+/*
+ * The ti-engine is an open source, free to use—both for personal and commercial projects—framework for the creation of microservice-based solutions using node.js.
+ * Copyright © 2021-2026 Boris Kostadinov <kostadinov.boris@gmail.com>
+ * 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 3 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, see <https://www.gnu.org/licenses/>.
+*/
+
+/**
+ * Express handler factories for the admin configuration-management API. Each factory takes the {@link ConfigService}
+ * to delegate to (injected so the handlers are unit-testable), and returns an Express middleware that responds in the
+ * framework's convention — `{ isSuccessful: true, data }` on success — forwarding errors to the error middleware.
+ * Validation failures come back as `data` (`{ ok:false, errors }`) so the UI can render field-level messages; a
+ * version conflict maps to `409` and an unknown editor/document/change-set to `404`. These routes are gated by the
+ * `requireAdmin` guard and inherit the server's global auth + CSRF middleware.
+ *
+ * @module admin-config-handlers
+ */
+
+const exceptions = require( "@ti-engine/core/exceptions" );
+
+function sendData( response, data ) {
+    response.set( "Cache-Control", "no-store" );
+    response.set( "Content-Type", "application/json; charset=utf-8" );
+    response.status( exceptions.httpCode.C_200 ).send( { isSuccessful: true, data: data } );
+}
+
+function forward( next, error ) {
+    const reason = error && error.data && error.data.reason;
+    const raised = exceptions.raise( error );
+    if ( reason === "version-conflict" ) {
+        raised.httpCode = exceptions.httpCode.C_409;
+    } else if ( reason === "unknown-editor" || reason === "unknown-changeset" || reason === "unknown-config" ) {
+        raised.httpCode = exceptions.httpCode.C_404;
+    }
+    next( raised );
+}
+
+function adminID( request ) {
+    return ( request.session && request.session.user ) ? request.session.user.userID : undefined;
+}
+
+/**
+ * @param {ConfigService} service
+ * @returns {ExpressHandler}
+ */
+module.exports.listEditors = ( service ) => ( request, response, next ) => {
+    try {
+        sendData( response, service.listEditors() );
+    } catch ( error ) {
+        forward( next, error );
+    }
+};
+
+module.exports.composeView = ( service ) => ( request, response, next ) => {
+    service.composeView( request.params.editorKey ).then( ( view ) => sendData( response, view ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.saveEditorEdit = ( service ) => ( request, response, next ) => {
+    const body = request.body || {};
+    service.saveEditorEdit( request.params.editorKey, body.edited, { adminID: adminID( request ), note: body.note }, body.expectedVersions ).then( ( result ) => sendData( response, result ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.getCurrent = ( service ) => ( request, response, next ) => {
+    service.getCurrent( request.params.configKey ).then( ( current ) => sendData( response, current ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.getHistory = ( service ) => ( request, response, next ) => {
+    service.getHistory( request.params.configKey ).then( ( history ) => sendData( response, history ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.listChanges = ( service ) => ( request, response, next ) => {
+    service.listChanges().then( ( changes ) => sendData( response, changes ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.getChange = ( service ) => ( request, response, next ) => {
+    service.getChange( request.params.changeSetID ).then( ( change ) => sendData( response, change ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.restoreChangeSet = ( service ) => ( request, response, next ) => {
+    const body = request.body || {};
+    service.restoreChangeSet( request.params.changeSetID, { adminID: adminID( request ), note: body.note } ).then( ( result ) => sendData( response, result ) ).catch( ( error ) => forward( next, error ) );
+};
+
+module.exports.exportBundle = ( service ) => ( request, response, next ) => {
+    service.exportBundle( { adminID: adminID( request ) } ).then( ( bundle ) => {
+        response.set( "Cache-Control", "no-store" );
+        response.set( "Content-Type", "application/json; charset=utf-8" );
+        response.set( "Content-Disposition", "attachment; filename=\"config-export.json\"" );
+        response.status( exceptions.httpCode.C_200 ).send( JSON.stringify( bundle, null, 2 ) );
+    } ).catch( ( error ) => forward( next, error ) );
+};