structured-fw 1.2.3 → 1.3.1

package/Config.ts

@@ -42,5 +42,19 @@ export const config: StructuredConfig = {
         // used by Document.push, can be preload or preconnect
         linkHeaderRel : 'preload'
     },
+    gzip: {
+        enabled: true, // whether to enable response gzip compression
+        // compress only listed types
+        types: [
+            'text/html',
+            'text/xml',
+            'text/plain',
+            'text/css',
+            'application/javascript',
+            'application/json'
+        ],
+        minSize: 10240, // compress only if response is at least minSize bytes
+        compressionLevel: 4, // higher value = greater compression, slower
+    },
     runtime: 'Node.js'
 }

package/build/system/client/Client.js

@@ -1,2 +1,4 @@
 import { ClientApplication } from './ClientApplication.js';
-new ClientApplication();
+window.addEventListener('load', () => {
+    new ClientApplication();
+});

package/build/system/client/ClientComponent.js

@@ -79,9 +79,16 @@ export class ClientComponent extends EventEmitter {
         }
         this.isReady = true;
         if (this.isRoot || isRedrawRoot) {
-            await this.runInitializer(isRedraw);
+            this.on('initializerExecuted', () => {
+                this.emit('ready');
+            });
+            requestAnimationFrame(() => {
+                this.runInitializer(isRedraw);
+            });
+        }
+        else {
+            this.emit('ready');
         }
-        this.emit('ready');
     }
     reset() {
         this.data = {};

package/build/system/server/Request.d.ts

@@ -20,4 +20,5 @@ export declare class Request {
     static queryStringDecode(queryString: string, initialValue?: PostedDataDecoded, trimValues?: boolean): PostedDataDecoded;
     static parseBodyMultipart(bodyRaw: string, boundary: string): PostedDataDecoded;
     static multipartBodyFiles(bodyRaw: string, boundary: string): Record<string, RequestBodyFile>;
+    private sendResponse;
 }

package/build/system/server/Request.js

@@ -3,6 +3,7 @@ import { existsSync, readdirSync, readFileSync, statSync } from "node:fs";
 import path from "node:path";
 import { Buffer } from "node:buffer";
 import { Document } from "./Document.js";
+import zlib from "node:zlib";
 export class Request {
     constructor(app) {
         this.pageNotFoundCallback = async ({ response }) => {
@@ -107,23 +108,21 @@ export class Request {
             cookies: this.app.cookies.parse(request),
             timeStart: new Date().getTime(),
             isAjax: request.headers['x-requested-with'] == 'xmlhttprequest',
-            respondWith: async function (data) {
+            respondWith: async (data) => {
                 if (typeof data === 'string' || Buffer.isBuffer(data)) {
-                    response.write(data);
+                    this.sendResponse(request, response, data, 'text/plain; charset=utf-8');
                 }
                 else if (typeof data === 'number') {
-                    response.write(data.toString());
+                    this.sendResponse(request, response, data.toString(), 'text/plain; charset=utf-8');
                 }
                 else if (data instanceof Document) {
-                    response.setHeader('Content-Type', 'text/html');
-                    response.write(await data.toString());
+                    this.sendResponse(request, response, await data.toString(), 'text/html; charset=utf-8');
                 }
                 else if (data === undefined || data === null) {
-                    response.write('');
+                    this.sendResponse(request, response, '', 'text/plain; charset=utf-8');
                 }
                 else {
-                    response.setHeader('Content-Type', 'application/json');
-                    response.write(JSON.stringify(data, null, 4));
+                    this.sendResponse(request, response, JSON.stringify(data, null, 4), 'application/json; charset=utf-8');
                 }
             },
             redirect: (to, statusCode = 302) => {
@@ -175,13 +174,14 @@ export class Request {
                 if (existsSync(assetPath)) {
                     await this.app.emit('beforeAssetAccess', context);
                     const extension = (context.request.url || '').split('.').pop();
+                    let contentType = 'application/javascript';
                     if (extension) {
-                        const contentType = this.app.contentType(extension);
-                        if (contentType) {
-                            response.setHeader('Content-Type', contentType);
+                        const typeByExtension = this.app.contentType(extension);
+                        if (typeByExtension) {
+                            contentType = typeByExtension;
                         }
                     }
-                    response.write(readFileSync(assetPath));
+                    this.sendResponse(request, response, readFileSync(assetPath), contentType);
                     staticAsset = true;
                     await this.app.emit('afterAssetAccess', context);
                 }
@@ -395,4 +395,29 @@ export class Request {
         });
         return files;
     }
+    sendResponse(request, response, buffer, contentType) {
+        const mimeType = contentType.split(';')[0];
+        const gzipResponse = this.app.config.gzip.enabled &&
+            this.app.config.gzip.types.includes(mimeType) &&
+            request.headers['accept-encoding']?.includes('gzip') &&
+            buffer.length >= this.app.config.gzip.minSize;
+        if (!response.hasHeader('Content-Type')) {
+            response.setHeader('Content-Type', contentType);
+        }
+        if (typeof buffer === 'string') {
+            buffer = Buffer.from(buffer, 'utf-8');
+        }
+        if (gzipResponse) {
+            response.setHeader('Content-Encoding', 'gzip');
+            const compressed = zlib.gzipSync(buffer, {
+                level: this.app.config.gzip.compressionLevel
+            });
+            response.setHeader('Content-Length', compressed.length);
+            response.write(compressed);
+        }
+        else {
+            response.setHeader('Content-Length', buffer.length);
+            response.write(buffer);
+        }
+    }
 }

package/build/system/types/structured.types.d.ts

@@ -24,6 +24,12 @@ export type StructuredConfig = {
         port: number;
         linkHeaderRel: 'preload' | 'preconnect';
     };
+    gzip: {
+        enabled: boolean;
+        types: Array<string>;
+        minSize: number;
+        compressionLevel: number;
+    };
     readonly runtime: 'Node.js' | 'Deno';
 };
 export type StructuredClientConfig = {

package/package.json

@@ -19,7 +19,7 @@
   "license": "MIT",
   "type": "module",
   "main": "build/index",
-  "version": "1.2.3",
+  "version": "1.3.1",
   "scripts": {
     "develop": "tsc --watch",
     "startDev": "cd build && nodemon --watch '../app/**/*' --watch '../build/**/*' -e js,html,hbs,css index.js",