@karpeleslab/klbfw 0.2.12 → 0.2.14

package/index.d.ts

@@ -32,6 +32,7 @@ declare function setCookie(name: string, value: string, expires?: Date | number,
 declare function rest(name: string, verb: string, params?: Record<string, any>, context?: Record<string, any>): Promise<any>;
 declare function rest_get(name: string, params?: Record<string, any>): Promise<any>; // Backward compatibility
 declare function restGet(name: string, params?: Record<string, any>): Promise<any>;
+declare function restSSE(name: string, method: 'GET', params?: Record<string, any>, context?: Record<string, any>): EventSource;
 
 // Upload module types
 interface UploadOptions {
@@ -75,6 +76,7 @@ export {
   rest,
   rest_get,
   restGet,
+  restSSE,
   upload,
   getI18N,
   trimPrefix

package/index.js

@@ -42,6 +42,7 @@ module.exports.setCookie = cookies.setCookie;
 module.exports.rest = rest.rest;
 module.exports.rest_get = rest.rest_get; // Backward compatibility
 module.exports.restGet = rest.restGet;   // New camelCase name
+module.exports.restSSE = rest.restSSE;
 
 // Upload module exports
 module.exports.upload = upload.upload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karpeleslab/klbfw",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "description": "Frontend Framework",
   "main": "index.js",
   "types": "index.d.ts",

package/rest.js

@@ -153,9 +153,70 @@ const restGet = (name, params) => {
     });
 };
 
+/**
+ * Creates a Server-Sent Events (SSE) connection to a REST API endpoint
+ * @param {string} name - API endpoint name
+ * @param {string} method - HTTP method (must be GET)
+ * @param {Object} params - Request parameters
+ * @param {Object} context - Context object with additional parameters
+ * @returns {EventSource} EventSource instance for the SSE connection
+ */
+const restSSE = (name, method, params, context) => {
+    // EventSource only supports GET requests
+    if (method !== 'GET') {
+        throw new Error('EventSource only supports GET method');
+    }
+
+    // EventSource only works in browsers
+    if (typeof EventSource === 'undefined') {
+        throw new Error('EventSource is not supported in this environment');
+    }
+
+    if (!internal.checkSupport()) {
+        throw new Error('Environment not supported');
+    }
+
+    params = params || {};
+    context = context || {};
+
+    // Add timezone data if in browser
+    if (typeof window !== 'undefined') {
+        context['t'] = internal.getTimezoneData();
+    }
+
+    // Build URL with authentication and context
+    let callUrl = internal.buildRestUrl(name, true, context);
+
+    // Add params to the URL
+    if (params) {
+        const glue = callUrl.indexOf('?') === -1 ? '?' : '&';
+        if (typeof params === 'string') {
+            callUrl += glue + '_=' + encodeURIComponent(params);
+        } else {
+            callUrl += glue + '_=' + encodeURIComponent(JSON.stringify(params));
+        }
+    }
+
+    // Create and return EventSource instance
+    // Note: EventSource doesn't support custom headers directly,
+    // but authentication is handled via URL parameters or cookies
+    const eventSource = new EventSource(callUrl, {
+        withCredentials: true
+    });
+
+    // Handle errors and server-side closures
+    eventSource.onerror = (error) => {
+        console.error('EventSource error:', error);
+        eventSource.close();
+    };
+
+    return eventSource;
+};
+
 // Export new camelCase API
 module.exports.rest = rest;
 module.exports.restGet = restGet;
+module.exports.restSSE = restSSE;
 
 // Backward compatibility
 module.exports.rest_get = restGet;