@karpeleslab/klbfw 0.1.12 → 0.2.0

package/fw-wrapper.js

@@ -1,26 +1,221 @@
-module.exports.getPrefix = () => (typeof FW !== "undefined") ? FW.prefix : "";
-module.exports.getSettings = () => (typeof FW !== "undefined") ? FW.settings : {};
-module.exports.getRealm = () => (typeof FW !== "undefined") ? FW.Realm : {};
-module.exports.getLocale = () => (typeof FW !== "undefined") ? FW.Locale : "en-US";
-module.exports.getPath = () => (typeof FW !== "undefined") ? FW.path : window.location.pathname;
-module.exports.getHostname = () => (typeof FW !== "undefined") ? FW.hostname : window.location.hostname;
-module.exports.getCurrency = () => (typeof FW !== "undefined") ? FW.Context.c : "USD";
-module.exports.getContext = () => (typeof FW !== "undefined") ? Object.assign({}, FW.Context) : {};
-module.exports.setContext = (k, v) => { if (typeof FW !== "undefined") FW.Context[k] = v; };
-module.exports.getToken = () => (typeof FW !== "undefined") ? FW.token : undefined;
-module.exports.getRegistry = () => (typeof FW !== "undefined") ? FW.Registry : undefined;
-module.exports.getUrl = () => (typeof FW !== "undefined") ? FW.URL : {path: window.location.pathname, full: window.location.href};
-module.exports.getSiteStatic = () => (typeof FW !== "undefined") ? FW.site_static : true;
-module.exports.getCallUrlPrefix = () => (typeof FW !== "undefined") ? FW.call_url_prefix : "https://hub.atonline.com";
-module.exports.getUuid = () => (typeof FW !== "undefined") ? FW.uuid : undefined;
-module.exports.getInitialState = () => (typeof FW !== "undefined") ? FW.initial : undefined;
-module.exports.supported = () => true;
-module.exports.GET = (typeof FW !== "undefined") ? FW.GET : {};
-module.exports.Get = (key) => {
-    if(key===undefined)
-        return (typeof FW !== "undefined") ? FW.GET : undefined;
-
-    return (typeof FW !== "undefined") ? FW.GET[key] : undefined;
-}
-module.exports.flushGet = () => { if (typeof FW !== "undefined") FW.GET = {}; };
-module.exports.getMode = () => (typeof FW !== "undefined") ? FW.mode : "offline";
+'use strict';
+/**
+ * @fileoverview Framework wrapper for KLB Frontend Framework
+ * 
+ * This module provides a wrapper around the global FW object,
+ * providing safe access to its properties with fallbacks for
+ * environments where FW is not available.
+ */
+
+/**
+ * Gets a property from the global FW object with fallback
+ * @private
+ * @param {string} property - FW property to retrieve
+ * @param {*} fallback - Fallback value if property is not available
+ * @returns {*} The property value or fallback
+ */
+const getFWProperty = (property, fallback) => {
+    if (typeof FW === "undefined") return fallback;
+    
+    // Handle nested properties (e.g., "Context.c")
+    if (property.includes('.')) {
+        const parts = property.split('.');
+        let obj = FW;
+        
+        for (const part of parts) {
+            if (obj === undefined || obj === null) return fallback;
+            obj = obj[part];
+        }
+        
+        return obj !== undefined ? obj : fallback;
+    }
+    
+    return FW[property] !== undefined ? FW[property] : fallback;
+};
+
+/**
+ * Gets the site prefix
+ * @returns {string} Site prefix
+ */
+const getPrefix = () => getFWProperty('prefix', '');
+
+/**
+ * Gets site settings
+ * @returns {Object} Site settings
+ */
+const getSettings = () => getFWProperty('settings', {});
+
+/**
+ * Gets realm information
+ * @returns {Object} Realm information
+ */
+const getRealm = () => getFWProperty('Realm', {});
+
+/**
+ * Gets the current locale
+ * @returns {string} Current locale
+ */
+const getLocale = () => getFWProperty('Locale', 'en-US');
+
+/**
+ * Gets the current path
+ * @returns {string} Current path
+ */
+const getPath = () => {
+    if (typeof FW !== "undefined") return FW.path;
+    if (typeof window !== "undefined") return window.location.pathname;
+    return '/';
+};
+
+/**
+ * Gets the current hostname
+ * @returns {string} Current hostname
+ */
+const getHostname = () => {
+    if (typeof FW !== "undefined") return FW.hostname;
+    if (typeof window !== "undefined") return window.location.hostname;
+    return '';
+};
+
+/**
+ * Gets the current currency
+ * @returns {string} Current currency code
+ */
+const getCurrency = () => getFWProperty('Context.c', 'USD');
+
+/**
+ * Gets a copy of the current context
+ * @returns {Object} Current context
+ */
+const getContext = () => {
+    if (typeof FW !== "undefined" && FW.Context) {
+        return Object.assign({}, FW.Context);
+    }
+    return {};
+};
+
+/**
+ * Sets a value in the context
+ * @param {string} key - Context key
+ * @param {*} value - Value to set
+ */
+const setContext = (key, value) => {
+    if (typeof FW !== "undefined" && FW.Context) {
+        FW.Context[key] = value;
+    }
+};
+
+/**
+ * Gets the current authentication token
+ * @returns {string|undefined} Authentication token
+ */
+const getToken = () => getFWProperty('token', undefined);
+
+/**
+ * Gets the registry
+ * @returns {Object|undefined} Registry object
+ */
+const getRegistry = () => getFWProperty('Registry', undefined);
+
+/**
+ * Gets URL information
+ * @returns {Object} URL information
+ */
+const getUrl = () => {
+    if (typeof FW !== "undefined") return FW.URL;
+    if (typeof window !== "undefined") {
+        return {
+            path: window.location.pathname,
+            full: window.location.href
+        };
+    }
+    return { path: '/', full: '/' };
+};
+
+/**
+ * Gets site static flag
+ * @returns {boolean} Whether site is static
+ */
+const getSiteStatic = () => getFWProperty('site_static', true);
+
+/**
+ * Gets the API call URL prefix
+ * @returns {string} API call URL prefix
+ */
+const getCallUrlPrefix = () => getFWProperty('call_url_prefix', 'https://hub.atonline.com');
+
+/**
+ * Gets the site UUID
+ * @returns {string|undefined} Site UUID
+ */
+const getUuid = () => getFWProperty('uuid', undefined);
+
+/**
+ * Gets the initial state
+ * @returns {Object|undefined} Initial state
+ */
+const getInitialState = () => getFWProperty('initial', undefined);
+
+/**
+ * Checks if the framework is supported
+ * @returns {boolean} Whether the framework is supported
+ */
+const supported = () => true;
+
+/**
+ * Gets the current GET parameters
+ * @returns {Object} GET parameters
+ */
+const getGET = () => getFWProperty('GET', {});
+
+/**
+ * Gets a specific GET parameter
+ * @param {string} key - Parameter key
+ * @returns {string|undefined} Parameter value
+ */
+const getParam = (key) => {
+    if (key === undefined) {
+        return getGET();
+    }
+    
+    const params = getGET();
+    return params[key];
+};
+
+/**
+ * Flushes GET parameters
+ */
+const flushGet = () => {
+    if (typeof FW !== "undefined") {
+        FW.GET = {};
+    }
+};
+
+/**
+ * Gets the current mode
+ * @returns {string} Current mode
+ */
+const getMode = () => getFWProperty('mode', 'offline');
+
+// Export functions
+module.exports.getPrefix = getPrefix;
+module.exports.getSettings = getSettings;
+module.exports.getRealm = getRealm;
+module.exports.getLocale = getLocale;
+module.exports.getPath = getPath;
+module.exports.getHostname = getHostname;
+module.exports.getCurrency = getCurrency;
+module.exports.getContext = getContext;
+module.exports.setContext = setContext;
+module.exports.getToken = getToken;
+module.exports.getRegistry = getRegistry;
+module.exports.getUrl = getUrl;
+module.exports.getSiteStatic = getSiteStatic;
+module.exports.getCallUrlPrefix = getCallUrlPrefix;
+module.exports.getUuid = getUuid;
+module.exports.getInitialState = getInitialState;
+module.exports.supported = supported;
+module.exports.GET = getGET();
+module.exports.Get = getParam;
+module.exports.flushGet = flushGet;
+module.exports.getMode = getMode;

package/index.js

@@ -1,10 +1,18 @@
 'use strict';
+/**
+ * @fileoverview Main entry point for KLB Frontend Framework
+ * 
+ * This module exports all public API functions from the framework's
+ * individual modules.
+ */
+
 const internalFW = require('./fw-wrapper');
 const rest = require('./rest');
 const upload = require('./upload');
 const util = require('./util');
 const cookies = require('./cookies');
 
+// Framework wrapper exports
 module.exports.GET = internalFW.GET;
 module.exports.Get = internalFW.Get;
 module.exports.flushGet = internalFW.flushGet;
@@ -24,14 +32,20 @@ module.exports.getUrl = internalFW.getUrl;
 module.exports.getPath = internalFW.getPath;
 module.exports.getUuid = internalFW.getUuid;
 module.exports.getInitialState = internalFW.getInitialState;
+
+// Cookie handling exports
 module.exports.getCookie = cookies.getCookie;
 module.exports.hasCookie = cookies.hasCookie;
 module.exports.setCookie = cookies.setCookie;
 
+// REST API exports
 module.exports.rest = rest.rest;
-module.exports.rest_get = rest.rest_get;
+module.exports.rest_get = rest.rest_get; // Backward compatibility
+module.exports.restGet = rest.restGet;   // New camelCase name
 
+// Upload module exports
 module.exports.upload = upload.upload;
 
+// Utility exports
 module.exports.getI18N = util.getI18N;
-module.exports.trimPrefix = util.trimPrefix;
+module.exports.trimPrefix = util.trimPrefix;

package/internal.js

@@ -1,88 +1,166 @@
 'use strict';
-const fwWrapper = require('./fw-wrapper');
+/**
+ * @fileoverview Internal helpers for the KLB Frontend Framework
+ * 
+ * This module provides internal utility functions for REST API interactions,
+ * timezone handling, and response parsing.
+ */
 
-// vim: et:ts=4:sw=4
+const fwWrapper = require('./fw-wrapper');
 
-function get_tz_pad(number, length) {
-    var str = "" + number;
-    while (str.length < length)
+/**
+ * Pads a number with leading zeros
+ * @param {number} number - The number to pad
+ * @param {number} length - The desired length of the result
+ * @returns {string} The padded number
+ */
+const padNumber = (number, length) => {
+    let str = String(number);
+    while (str.length < length) {
         str = '0' + str;
+    }
     return str;
-}
-
-function get_timezone_data() {
-    // grab current offset value & built string
-    var offset = new Date().getTimezoneOffset();
-    offset = ((offset < 0 ? '+' : '-') + // Note the reversed sign!
-        get_tz_pad(parseInt(Math.abs(offset / 60)), 2) +
-        get_tz_pad(Math.abs(offset % 60), 2));
-
-    // check if we have intl info
-
-    if (typeof Intl != 'undefined' && (Intl.DateTimeFormat != undefined)) {
-        return Intl.DateTimeFormat().resolvedOptions().timeZone + ";" + offset;
+};
+
+/**
+ * Gets timezone data in a format suitable for API calls
+ * @returns {string} Formatted timezone string
+ */
+const getTimezoneData = () => {
+    // Grab current offset value & build string
+    const offset = new Date().getTimezoneOffset();
+    const sign = offset < 0 ? '+' : '-'; // Note the reversed sign!
+    const formattedOffset = sign + 
+        padNumber(parseInt(Math.abs(offset / 60)), 2) +
+        padNumber(Math.abs(offset % 60), 2);
+
+    // Check if we have Intl info
+    if (typeof Intl !== 'undefined' && Intl.DateTimeFormat !== undefined) {
+        return Intl.DateTimeFormat().resolvedOptions().timeZone + ";" + formattedOffset;
     }
 
-    return offset;
-}
-
-function rest_url(path, with_token, context) {
-    if (!with_token) {
-        if (fwWrapper.getCallUrlPrefix()) return fwWrapper.getCallUrlPrefix() + "/_special/rest/" + path;
-        return "/_special/rest/" + path;
+    return formattedOffset;
+};
+
+/**
+ * Constructs a REST API URL
+ * @param {string} path - API endpoint path
+ * @param {boolean} withToken - Whether to include authentication token
+ * @param {Object} context - Context object with additional parameters
+ * @returns {string} Constructed URL
+ */
+const buildRestUrl = (path, withToken, context) => {
+    if (!withToken) {
+        if (fwWrapper.getCallUrlPrefix()) return fwWrapper.getCallUrlPrefix() + "/_rest/" + path;
+        return "/_rest/" + path;
     }
+    
     context = context || {};
-    var glue = '?';
-
+    let glue = '?';
+    
+    let callUrl;
     if (fwWrapper.getSiteStatic()) {
-        var call_url = "/_special/rest/" + path + "?static";
+        callUrl = "/_rest/" + path + "?static";
         glue = '&';
     } else {
-        var call_url = "/_special/rest/" + path;
+        callUrl = "/_rest/" + path;
+    }
+    
+    if (fwWrapper.getCallUrlPrefix()) {
+        callUrl = fwWrapper.getCallUrlPrefix() + callUrl;
     }
-    if (fwWrapper.getCallUrlPrefix()) call_url = fwWrapper.getCallUrlPrefix() + call_url;
 
-    // copy context, proceed with overload then add to url
-    var ctx_final = fwWrapper.getContext();
-    for (var i in context) ctx_final[i] = context[i];
-    for (var i in ctx_final) {
-        if (i == "_") continue;
-        call_url = call_url + glue + "_ctx[" + i + "]=" + encodeURIComponent(ctx_final[i]);
+    // Copy context, proceed with overload then add to url
+    const ctxFinal = fwWrapper.getContext();
+    for (const key in context) {
+        ctxFinal[key] = context[key];
+    }
+    
+    for (const key in ctxFinal) {
+        if (key === "_") continue;
+        callUrl = callUrl + glue + "_ctx[" + key + "]=" + encodeURIComponent(ctxFinal[key]);
         glue = '&';
     }
-    return call_url;
-}
+    
+    return callUrl;
+};
+
+/**
+ * Checks if the environment supports required features
+ * @returns {boolean} Whether the environment is supported
+ */
+const checkSupport = () => {
+    const missingFeatures = [];
+    
+    if (typeof fetch === "undefined") {
+        missingFeatures.push("fetch API");
+    }
 
-function internal_rest(name, verb, params, context) {
+    if (!fwWrapper.supported()) {
+        missingFeatures.push("Framework wrapper");
+    }
+    
+    if (missingFeatures.length > 0) {
+        console.error("Missing required features: " + missingFeatures.join(", "));
+        return false;
+    }
+    
+    return true;
+};
+
+/**
+ * Makes an internal REST API call
+ * @param {string} name - API endpoint name
+ * @param {string} verb - HTTP method (GET, POST, etc.)
+ * @param {Object|string} params - Request parameters
+ * @param {Object} context - Context object with additional parameters
+ * @returns {Promise} Fetch promise
+ */
+const internalRest = (name, verb, params, context) => {
     verb = verb || "GET";
     params = params || {};
     context = context || {};
 
     if (typeof window !== "undefined") {
-        context['t'] = get_timezone_data();
+        context['t'] = getTimezoneData();
     }
-    var call_url = rest_url(name, true, context);
-
-    var headers = {};
-    if (fwWrapper.getToken() != '') {
-        headers['Authorization'] = 'Session '+fwWrapper.getToken();
+    
+    const callUrl = buildRestUrl(name, true, context);
+    const headers = {};
+    
+    if (fwWrapper.getToken() !== '') {
+        headers['Authorization'] = 'Session ' + fwWrapper.getToken();
     }
 
-    if (verb == "GET") {
+    // Handle GET requests
+    if (verb === "GET") {
         if (params) {
-            // check if params is a json string, or if it needs encoding
+            // Check if params is a JSON string, or if it needs encoding
             if (typeof params === "string") {
-                call_url += "&_=" + encodeURIComponent(params);
+                return fetch(callUrl + "&_=" + encodeURIComponent(params), {
+                    method: verb, 
+                    credentials: 'include', 
+                    headers: headers
+                });
             } else {
-                call_url += "&_=" + encodeURIComponent(JSON.stringify(params));
+                return fetch(callUrl + "&_=" + encodeURIComponent(JSON.stringify(params)), {
+                    method: verb, 
+                    credentials: 'include', 
+                    headers: headers
+                });
             }
         }
-
-        return fetch(call_url, {method: verb, credentials: 'include', headers: headers});
+        
+        return fetch(callUrl, {
+            method: verb, 
+            credentials: 'include', 
+            headers: headers
+        });
     }
 
-    if ((FormData != undefined) && (params instanceof FormData)) {
-        return fetch(call_url, {
+    // Handle FormData
+    if (typeof FormData !== "undefined" && (params instanceof FormData)) {
+        return fetch(callUrl, {
             method: verb,
             credentials: 'include',
             body: params,
@@ -90,70 +168,76 @@ function internal_rest(name, verb, params, context) {
         });
     }
 
+    // Handle JSON requests
     headers['Content-Type'] = 'application/json; charset=utf-8';
-
-    return fetch(call_url, {
+    
+    return fetch(callUrl, {
         method: verb,
         credentials: 'include',
         body: JSON.stringify(params),
         headers: headers
     });
-}
-
-function checkSupport() {
-    var ok = true;
-    if (!fetch) {
-        console.error("Fetch unsupported");
-        ok = false;
-    }
-
-    if (!fwWrapper.supported()) {
-        console.error("FW not found");
-        ok = false;
+};
+
+/**
+ * Parses API response and resolves/rejects accordingly
+ * @param {Response} response - Fetch Response object
+ * @param {Function} resolve - Promise resolve function
+ * @param {Function} reject - Promise reject function
+ */
+const responseParse = (response, resolve, reject) => {
+    // Check if response is ok (status 200-299)
+    if (!response.ok) {
+        reject({
+            message: `HTTP Error: ${response.status} ${response.statusText}`,
+            status: response.status, 
+            headers: response.headers
+        });
+        return;
     }
-
-    return ok;
-}
-
-function responseParse(response, resolve, reject) {
-    var contentType = response.headers.get("content-type");
-    if (!contentType || contentType.indexOf("application/json") == -1) {
-        response.text().then(
-            function (text) {
-                reject({message: "Not JSON", body: text, headers: response.headers});
-            },
-            reject
-        ).catch(reject);
-
+    
+    const contentType = response.headers.get("content-type");
+    if (!contentType || contentType.indexOf("application/json") === -1) {
+        response.text()
+            .then(text => {
+                reject({
+                    message: "Not JSON", 
+                    body: text, 
+                    headers: response.headers
+                });
+            })
+            .catch(error => reject(error));
         return;
     }
 
-    response.json().then(
-        function (json) {
-            // check for gtag
-            if ((json.gtag) && (typeof window !== "undefined") && (window.gtag)) {
-                json.gtag.map(function (item) { window.gtag.apply(null, item); });
+    response.json()
+        .then(json => {
+            // Check for gtag
+            if (json.gtag && typeof window !== "undefined" && window.gtag) {
+                json.gtag.map(item => window.gtag.apply(null, item));
             }
-            // check for result
-            if (json.result != "success" && json.result != "redirect") {
+            
+            // Check for result
+            if (json.result !== "success" && json.result !== "redirect") {
                 json.headers = response.headers;
                 reject(json);
             } else {
                 resolve(json);
             }
-        },
-        reject
-    ).catch(reject)
-}
-
-module.exports.get_tz_pad = get_tz_pad;
-
-module.exports.get_timezone_data = get_timezone_data;
-
-module.exports.rest_url = rest_url;
-
-module.exports.internal_rest = internal_rest;
-
+        })
+        .catch(error => reject(error));
+};
+
+// Backward compatibility aliases
+module.exports.get_tz_pad = padNumber;
+module.exports.get_timezone_data = getTimezoneData;
+module.exports.rest_url = buildRestUrl;
+module.exports.internal_rest = internalRest;
 module.exports.checkSupport = checkSupport;
-
 module.exports.responseParse = responseParse;
+
+// New exports with camelCase naming
+module.exports.padNumber = padNumber;
+module.exports.getTimezoneData = getTimezoneData;
+module.exports.buildRestUrl = buildRestUrl;
+module.exports.internalRest = internalRest;

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@karpeleslab/klbfw",
-  "version": "0.1.12",
+  "version": "0.2.0",
   "description": "Frontend Framework",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:integration": "RUN_INTEGRATION_TESTS=true jest test/integration.test.js --env=node",
+    "test:coverage": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -17,6 +20,21 @@
   },
   "homepage": "https://github.com/KarpelesLab/klbfw#readme",
   "dependencies": {
-    "js-sha256": "^0.9.0"
+    "js-sha256": "^0.11.0"
+  },
+  "optionalDependencies": {
+    "node-fetch": "^2.7.0",
+    "xmldom": "^0.6.0"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "node-fetch": "^2.7.0",
+    "xmldom": "^0.6.0"
+  },
+  "jest": {
+    "testEnvironment": "jsdom",
+    "collectCoverage": true,
+    "coverageDirectory": "coverage"
   }
 }