jsgui3-server 0.0.129 → 0.0.133

package/README.md

@@ -768,6 +768,33 @@ const server = new Server({
 
 Data models can be shared within a single client instance, enabling synchronized UI controls.
 
+### Publishing functions with `server.publish`
+
+The server can publish plain JavaScript functions as HTTP endpoints. When a function is published, request bodies are parsed and passed to the function, and the function's return value determines the response MIME type. The API base path (for example, `/api`) is prefixed automatically, so only provide the route suffix to `publish()`.
+
+- If the function returns a string, the response is sent as `text/plain; charset=UTF-8`.
+- If the function returns an object (including arrays), it is serialized as JSON with `application/json`.
+- If the function returns a Promise, it is awaited and then handled by the two rules above.
+
+Input payload handling:
+- `Content-Type: application/json` bodies are parsed to an object and passed as the single argument.
+- `Content-Type: text/plain` bodies are passed as a UTF-8 string.
+
+Minimal example:
+
+```javascript
+// Inside your server bootstrap (after constructing Server)
+server.on('ready', () => {
+  // Returns text/plain at GET/POST /api/hello
+  server.publish('hello', name => `Hello ${name || 'world'}`);
+
+  // Returns application/json at GET/POST /api/sum
+  server.publish('sum', ({ a, b }) => ({ sum: a + b }));
+});
+```
+
+This behavior is implemented by the function publisher, which inspects the function result type to choose the correct headers and serialization.
+
 ## CSS Architecture and Styling
 
 ### CSS Definition Patterns

package/examples/box/4) twenty composition selectable square boxes/css flex wrap/server.js

@@ -7,7 +7,7 @@ if (require.main === module) {
     
     const server = new Server({
         Ctrl: Demo_UI,
-        debug: true,
+        //debug: true,
 
 
         //'js_mode': 'debug',

package/examples/controls/1) window/server.js

@@ -1,8 +1,6 @@
 const jsgui = require('./client');
-
-const {Demo_UI} = jsgui.controls;
 const Server = require('../../../server');
-
+const {Demo_UI} = jsgui.controls;
 
 // what would be the (best?) way to include the whole thing in one JS file?
 //  Maybe don't try that right now.

package/examples/json-api/json_server_1.js

@@ -0,0 +1,37 @@
+
+const Server = require('../../server');
+
+
+
+if (require.main === module) {
+
+    const server = new Server({
+        'port': 8088
+        
+    });
+    console.log('server.resource_names', server.resource_names);
+
+    /*
+    server.website.api.publish('time', () => {
+        return new Date().toISOString();
+    });
+    */
+
+    server.publish('time', () => {
+        return new Date().toISOString();
+    });
+
+    server.publish('user', () => {
+        return { id: 1, name: 'John Doe' };
+    });
+
+    server.publish('users', () => {
+        return [
+            { id: 1, name: 'John Doe' },
+            { id: 2, name: 'Jane Doe' }
+        ];
+    });
+
+    server.start(8088);
+    
+}

package/package.json

@@ -3,15 +3,15 @@
   "main": "module.js",
   "license": "MIT",
   "dependencies": {
-    "@babel/core": "^7.27.7",
-    "@babel/generator": "^7.27.5",
-    "@babel/parser": "7.27.7",
+    "@babel/core": "^7.28.3",
+    "@babel/generator": "^7.28.3",
+    "@babel/parser": "^7.28.3",
     "cookies": "^0.9.1",
-    "esbuild": "^0.25.5",
+    "esbuild": "^0.25.9",
     "fnl": "^0.0.36",
     "fnlfs": "^0.0.33",
-    "jsgui3-client": "^0.0.118",
-    "jsgui3-html": "^0.0.164",
+    "jsgui3-client": "^0.0.119",
+    "jsgui3-html": "^0.0.165",
     "jsgui3-webpage": "^0.0.8",
     "jsgui3-website": "^0.0.8",
     "lang-tools": "^0.0.36",
@@ -38,5 +38,5 @@
     "type": "git",
     "url": "https://github.com/metabench/jsgui3-server.git"
   },
-  "version": "0.0.129"
+  "version": "0.0.133"
 }

package/publishers/Publishers.js

@@ -0,0 +1,16 @@
+
+
+const Publishers = {
+    'css': require('./http-css-publisher'),
+    'function': require('./http-function-publisher'),
+    'html_page': require('./http-html-page-publisher'),
+    'html': require('./http-html-publisher'),
+    'jpeg': require('./http-jpeg-publisher'),
+    'js': require('./http-js-publisher'),
+    'observable': require('./http-observable-publisher'),
+    'png': require('./http-png-publisher'),
+    'resource': require('./http-resource-publisher'),
+    'svg': require('./http-svg-publisher')
+}
+
+module.exports = Publishers;

package/publishers/helpers/assigners/static-compressed-response-buffers/Single_Control_Webpage_Server_Static_Compressed_Response_Buffers_Assigner.js

@@ -101,9 +101,6 @@ class Single_Control_Webpage_Server_Static_Compressed_Response_Buffers_Assigner
                 } else {
 
                 }
-
-                
-
                 //console.trace();
                 //throw 'stop';
             }
@@ -112,13 +109,7 @@ class Single_Control_Webpage_Server_Static_Compressed_Response_Buffers_Assigner
             console.trace();
             throw 'stop';
         }
-
-
-
-
     }
-
-
 }
 
 

package/publishers/helpers/assigners/static-uncompressed-response-buffers/Single_Control_Webpage_Server_Static_Uncompressed_Response_Buffers_Assigner.js

@@ -41,35 +41,9 @@ class Single_Control_Webpage_Server_Static_Uncompressed_Response_Buffers_Assigne
     // assign to (bundle) items in array.
 
     async assign(arr_bundled_items) {
-        // go through them....
-
-        // Maybe check that the correct items are in the bundle.
-
-        // Perhaps check for 1 of each js, css, html
-        //   And could use a specific other class to assign these.
-
-        //   Should be OK to make classes for really specific things.
-        //     At this part of the system / API, it's not necessary / important to limit complexity in that way.
-
-        // The goal is to provide a very simple high level interface. Powerful too.
-
-        // Could assign a static_route property to the items in the bundles.
-
-
-
-
-
         if (is_array(arr_bundled_items)) {
-
             for (const item of arr_bundled_items) {
-                //console.log('item', item);
-
                 const {type} = item;
-
-                // And need to create the uncompressed response buffer.
-
-                // // response_buffers.identity I think....
-
                 if (item.text) {
                     const buf_identity_response = Buffer.from(item.text, 'utf-8');
 
@@ -78,11 +52,6 @@ class Single_Control_Webpage_Server_Static_Uncompressed_Response_Buffers_Assigne
                 } else {
 
                 }
-
-                
-
-                //console.trace();
-                //throw 'stop';
             }
 
         } else {

package/publishers/http-function-publisher.js

@@ -40,6 +40,7 @@ class Function_Publisher extends HTTP_Publisher {
             fn = spec;
         } else {
             fn = spec.fn;
+            this.name = spec.name;
             if (spec.schema) {
                 this.schema = spec.schema;
             } else {
@@ -50,6 +51,7 @@ class Function_Publisher extends HTTP_Publisher {
         //let fn = spec;
         //console.log('Function_Publisher constructor fn', fn);
         //console.log('Function_Publisher constructor fn', fn.toString());
+        // But will need to route to the function publisher.
 
         this.handle_http = (req, res) => {
             // need to handle observable http request.
@@ -64,8 +66,8 @@ class Function_Publisher extends HTTP_Publisher {
 
             const {method, headers} = req;
 
-            console.log('Function Publisher handle_http method', method);
-            console.log('headers', headers);
+            //console.log('Function Publisher handle_http method', method);
+            //console.log('headers', headers);
 
             // Need to get the incoming parameters.
             // Need to use formidable or whatever else...?
@@ -88,12 +90,21 @@ class Function_Publisher extends HTTP_Publisher {
 
             req.on('end', () => {
                 const buf_input = Buffer.concat(chunks);
-                console.log('buf_input', buf_input);
+                //console.log('buf_input', buf_input);
 
                 // then interpret it according to the content_type
                 let obj_input;
+                //console.log('content_type', content_type);
+                if (!content_type) {
+                    console.log('buf_input.length', buf_input.length);
+                    if (buf_input.length === 0) {
 
-                if (content_type.startsWith('text/plain')) {
+                    } else {
+                        console.trace();
+                        throw 'NYI';
+                    }
+                } else {
+                    if (content_type.startsWith('text/plain')) {
                     obj_input = buf_input.toString();
 
                 } else {
@@ -106,6 +117,9 @@ class Function_Publisher extends HTTP_Publisher {
                     }
                     // decode / parse JSON.
                 }
+                }
+
+                
 
 
                 const output_all = (call_res) => {
@@ -129,8 +143,9 @@ class Function_Publisher extends HTTP_Publisher {
 
                 const fn_res = fn(obj_input);
                 const tfr = tf(fn_res);
+                //console.log('fn_res', fn_res);
                 
-                //console.log('tfr', tfr);
+                //
 
                 if (tfr === 'p') {
                     // promise
@@ -145,8 +160,36 @@ class Function_Publisher extends HTTP_Publisher {
                     });
 
 
-                } else {
+                } else if (tfr === 's') {
+                    // Just write it as a string for the moment I think?
+                    //   Or always encode as JSON?
+
+                    // text/plain;charset=UTF-8
+
+                    res.writeHead(200, {
+                        'Content-Type': 'text/plain;charset=UTF-8'//,
+                        //'Transfer-Encoding': 'chunked',
+                        //'Trailer': 'Content-MD5'
+                    });
+                    res.end(fn_res);
 
+
+                } else if (tfr === 'o' || tfr === 'a') {
+                    // Just write it as a string for the moment I think?
+                    //   Or always encode as JSON?
+
+                    // text/plain;charset=UTF-8
+
+                    res.writeHead(200, {
+                        'Content-Type': 'application/json'//,
+                        //'Transfer-Encoding': 'chunked',
+                        //'Trailer': 'Content-MD5'
+                    });
+                    res.end(JSON.stringify(fn_res));
+
+
+                } else {
+                    console.log('tfr', tfr);
                     console.trace();
                     throw 'NYI';
                 }
@@ -173,10 +216,6 @@ class Function_Publisher extends HTTP_Publisher {
 
 
 
-
-
-
-
             });
 
 

package/publishers/http-png-publisher.js

@@ -0,0 +1,46 @@
+const fs = require('fs');
+const HTTP_Publisher = require('./http-publisher');
+
+class PNG_Publisher extends HTTP_Publisher {
+  constructor(spec) {
+    super(spec);
+    this.filePath = spec.filePath;
+    this.resource = spec.resource;
+  }
+
+  handle_http(req, res) {
+    if (req.method !== 'GET') {
+      res.writeHead(405, { 'Allow': 'GET' });
+      return res.end('Method Not Allowed');
+    }
+
+    const sendBuffer = buf => {
+      res.setHeader('Content-Type', 'image/png');
+      res.setHeader('Content-Length', buf.length);
+      res.setHeader('Cache-Control', 'public, max-age=31536000');
+      res.end(buf);
+    };
+
+    if (this.resource && typeof this.resource.getPNG === 'function') {
+      Promise.resolve(this.resource.getPNG())
+        .then(buf => sendBuffer(buf))
+        .catch(() => {
+          res.writeHead(500);
+          res.end('Internal Server Error');
+        });
+    } else if (this.filePath) {
+      fs.readFile(this.filePath, (err, buf) => {
+        if (err) {
+          res.writeHead(404);
+          return res.end('Not Found');
+        }
+        sendBuffer(buf);
+      });
+    } else {
+      res.writeHead(500);
+      res.end('No PNG resource configured');
+    }
+  }
+}
+
+module.exports = PNG_Publisher;

package/publishers/http-website-publisher.js

@@ -207,9 +207,11 @@ class HTTP_Website_Publisher extends HTTP_Webpageorsite_Publisher {
 
         // Will probably insert new bundling code here - but refer to advanced classes that handle the details.
 
+        /*
         console.log('\n\nskipping __old__setup_website_publishing');
         console.trace();
         console.log('\n\n');
+        */
 
 
         const __old__setup_website_publishing = (website) => {
@@ -491,10 +493,11 @@ class HTTP_Website_Publisher extends HTTP_Webpageorsite_Publisher {
         if (website) {
 
 
-            console.trace();
+            //console.trace();
 
-            throw 'NYI - HTTP_Website_Publisher needs to publish specified website';
+            //throw 'NYI - HTTP_Website_Publisher needs to publish specified website';
 
+            console.log('Possibly missing website publishing code.')
 
             // Website_Bundle class would help.
 

package/server.js

@@ -22,9 +22,11 @@ const Website = require('./website/website');
 const HTTP_Website_Publisher = require('./publishers/http-website-publisher');
 const Webpage = require('./website/webpage');
 const HTTP_Webpage_Publisher = require('./publishers/http-webpage-publisher');
+const HTTP_Function_Publisher = require('./publishers/http-function-publisher');
 
 const Static_Route_HTTP_Responder = require('./http/responders/static/Static_Route_HTTP_Responder');
 
+const Publishers = require('./publishers/Publishers');
 
 class JSGUI_Single_Process_Server extends Evented_Class {
 	constructor(spec = {
@@ -146,7 +148,7 @@ class JSGUI_Single_Process_Server extends Evented_Class {
 			//   See about making use of relevant shared abstractions.
 
 
-			const ws_app = this.app = new Website(opts_website);
+			const ws_app = this.app = this.website = new Website(opts_website);
 			// Be able to treat Webpage as an app?
 
 			const opts_ws_publisher = {
@@ -156,6 +158,7 @@ class JSGUI_Single_Process_Server extends Evented_Class {
 				opts_ws_publisher.disk_path_client_js = disk_path_client_js;
 			}
 			const ws_publisher = new HTTP_Website_Publisher(opts_ws_publisher);
+			this._ws_publisher = ws_publisher;
 			ws_publisher.on('ready', () => {
 				console.log('ws publisher is ready');
 				const ws_resource = new Website_Resource({
@@ -172,11 +175,27 @@ class JSGUI_Single_Process_Server extends Evented_Class {
 		
 		Object.defineProperty(this, 'router', { get: () => server_router })
 	}
+
+	publish(name, fn) {
+		// Get the function publisher.
+		//   Possibly ensure it exists.
+		//const fn_publisher = this.function_publisher;
+		//fn_publisher.add(name, fn);
+		const fpub = new HTTP_Function_Publisher({name, fn});
+
+		this.function_publishers = this.function_publishers || [];
+		this.function_publishers.push(fpub);
+
+		this.server_router.set_route('/api/' + name, fpub, fpub.handle_http);
+	}
+
+
 	get resource_names() {
 		return this.resource_pool.resource_names;
 	}
 	'start' (port, callback, fnProcessRequest) {
 		if (tof(port) !== 'number') {
+			console.log('Invalid port:', port);
 			console.trace();
 			throw 'stop';
 		}
@@ -279,6 +298,7 @@ JSGUI_Single_Process_Server.Resource = Resource;
 JSGUI_Single_Process_Server.Page_Context = Server_Page_Context;
 JSGUI_Single_Process_Server.Server_Page_Context = Server_Page_Context;
 JSGUI_Single_Process_Server.Website_Resource = Website_Resource;
+JSGUI_Single_Process_Server.Publishers = Publishers;
 module.exports = JSGUI_Single_Process_Server;