@akc42/app-utils 5.0.10 → 5.0.11

package/README.md

@@ -94,9 +94,9 @@ The response is aysnchronousally returned as an object.  Errors are throw using
   If for any reason you want more info about the keyPress, access
   `this.keys.lastPressed`, and it will return the complete binding object
 
-## calcTextColour
+## utilities
 
-This is a utility function to determine the correct foreground colour (black or white) to use with a background colour
+**calcTextColour** is a utility function to determine the correct foreground colour (black or white) to use with a background colour
 passed as the parameter (as a hex strings with an optional proceeding `#` symbol.). The colour is returned as either `#000000` or `#ffffff`
 
 ## config and related 
@@ -167,6 +167,64 @@ dynamically checks them) are:-
 **Logger** is like Debug (indeed its a wrapper for it) except it doesn't need short date, or immediate parameters as 
 that is what is assumed.
 
+It is called with the following parameters in order:-
+
+- *logid* The `logid` (the primary key) of the message in the database (only used in the message output if the item was
+  a crash).
+- *logtime* This is either a unix timestamp *or* a string with the date and/or time in it.  It should be in the same
+  format as being formatted (see above).
+- *crash* a 0 or 1 dependant on if this message was a crash or not.
+- *shortdate* a 0 or 1 dependant on if this message has a short date or not,
+- *ipaddress* should be a valid ip address or `null`.
+- *topic*
+- *message* Just a single string
+- *colourspec*
+- *gap* Gap in milliseconds (this routine does the conversion to minutes if a `shortdate`).
+
+It returns an Object with 4 properties
+
+- *dayoutput* If the first message of the day, text with the date (only) in it, otherwise a zero length string.
+- *message* The complete formatted message
+- *logid* The `logid` the formatter was called with.
+- *ip* The `ipaddress` the formatter was called with.
+
+**DebugHelper** is a helper function for *Debug* and performs most of its work.   It is called with the same parameters as *Debug* plus an additional one; *writer*.  *writer* should be a callback function that can do something with the message and then return the return object that a debug call does.  In the use by *Debug* this function is the one writes the data to the database, but other writers can be provided. For instance the *Debug* function in this package uses the writer to send the message from the client to the server, whereas in the server (`@akc42/server-utils`) it is the function that writes the message to the database. 
+
+*writer* is called with the following parameters (all described above for *debug*, although in this case they *must* be supplied)
+
+- *logtime* (unix timestamp)
+- *crash* (0 or 1)
+- *shortdate* (0 or 1)
+- *ipaddress* (or `null`)
+- *topic*
+- *colourspec*
+- *gap*
+- *immediate* (`true` or `false`)
+
+**messageFormatter** is the routine that formats the raw message that has been written to the database.
+
+It is called with the following parameters in order:-
+
+- *logid* The `logid` (the primary key) of the message in the database (only used in the message output if the item was
+  a crash).
+- *logtime* This is either a unix timestamp *or* a string with the date and/or time in it.  It should be in the same
+  format as being formatted (see above).
+- *crash* a 0 or 1 dependant on if this message was a crash or not.
+- *shortdate* a 0 or 1 dependant on if this message has a short date or not,
+- *ipaddress* should be a valid ip address or `null`.
+- *topic*
+- *message* Just a single string
+- *colourspec*
+- *gap* Gap in milliseconds (this routine does the conversion to minutes if a `shortdate`).
+
+It returns an Object with 4 properties
+
+- *dayoutput* If the first message of the day, text with the date (only) in it, otherwise a zero length string.
+- *message* The complete formatted message
+- *logid* The `logid` the formatter was called with.
+- *ip* The `ipaddress` the formatter was called with.
+
+
 ## dom-host
 
 The **domHost** function is called with a single parameter (normally `this` inside a custom element)

package/app-keys.js

@@ -171,7 +171,7 @@ const SPACE_KEY = /^space(bar)?/;
 
 const ESC_KEY = /^escape$/;
 
-class AppKeys {
+export class AppKeys {
   constructor(target, keys, stop) {
     this.stop = stop; //marker to say stop propagation;
     if (!(target instanceof HTMLElement)) throw new Error('AppKeys required an HTML Element as target');
@@ -291,4 +291,4 @@ class AppKeys {
     }
   }
 }
-export default AppKeys;
+

package/app-utils.js

@@ -1,37 +1,22 @@
 import {api, ApiError} from './api.js';
-import AppKeys from './app-keys.js';
-import calcTextColor from './colour.js';
+import {AppKeys} from './app-keys.js';
+import {calcTextColor, capitalise} from './utils.js';
 import config, {setConfig, reReadConfig}from './config.js'
-import csv from './csv.js';
+import {csv} from './csv.js';
 import {Debug,Logger} from './debug.js';
-import domHost from './dom-host.js';
+import {domHost} from './dom-host.js';
 import { connectUrl, disconnectUrl} from './location.js';
 import getMasterTabPromise from './master-tab-promise.js';
 import {partMap} from './partMap.js';
-import pdf from './pdf.js';
-import Route from './route.js';
-import submit from './submit-function.js';
+import {pdf} from './pdf.js';
+import {Route} from './route.js';
+import {submit} from './submit-function.js';
 import {switchPath, generateUri, navigate} from './switch-path.js';
 import { minToTime,timeToMin,strToUrlDate,urlDateToStr } from './date-utils.js';
+import { DebugHelper, messageFormatter, COLOURS } from './debug-utils.js';
 
-function capitalise(name) {
-  if (name.length > 0 ) {
-    let words = name.split(' ');
-    for(let i = 0; i < words.length; i++) {
-      if (i > 0 && ( words[i].toLowerCase() === 'de' || words[i].toLowerCase() === 'la')) {
-        words[i] = words[i].toLowerCase();
-      } else if (words[i].length > 2 && words[i].toUpperCase().substring(0,2) === `O'` ) {
-        const newword = capitalise(words[i].substring(2))
-        words[i] = words[i].substring(0,2).toUpperCase() + newword;
-      } else {
-        words[i] = words[i].charAt(0).toUpperCase() + words[i].substring(1).toLowerCase();
-      }
-    }
-    return words.join(' ');
-  }
-  return '';
-};
 
-export {api,ApiError,AppKeys,calcTextColor,capitalise, config, connectUrl, csv, Debug, disconnectUrl, domHost, generateUri,
-  getMasterTabPromise, Logger, minToTime, navigate, partMap, pdf, reReadConfig, Route,setConfig, strToUrlDate, submit, 
+
+export {api,ApiError,AppKeys,calcTextColor,capitalise, COLOURS, config, connectUrl, csv, Debug, DebugHelper, disconnectUrl, domHost, generateUri,
+  getMasterTabPromise, Logger, messageFormatter, minToTime, navigate, partMap, pdf, reReadConfig, Route,setConfig, strToUrlDate, submit, 
   switchPath, timeToMin, urlDateToStr };

package/csv.js

@@ -22,7 +22,7 @@ import {generateUri} from './switch-path.js';
 const link = document.createElement('a');
 link.setAttribute('download', null);
 
-const csv = (url, params) => {
+export const csv = (url, params) => {
   let href;
   if (typeof url == 'string') {
     href = generateUri(`/api/csv/${url}`, params ?? {});
@@ -34,4 +34,3 @@ const csv = (url, params) => {
   link.click();
 };
 
-export default csv;

package/debug-utils.js

@@ -0,0 +1,128 @@
+/**
+@licence
+    Copyright (c) 2026 Alan Chandler, all rights reserved
+
+    This file is part of @akc42/app-utils.
+
+    @akc42/app-utils 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.
+
+    @akc42/app-utils 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 @akc42/app-utils.  If not, see <http://www.gnu.org/licenses/>.
+*/
+import chalk from "chalk";
+
+export const COLOURS = {
+  hexmatch: /^#(?:[0-9a-fA-F]{3}){1,2}$/,
+  rgbmatch: /^(\d{1,3}), ?(\d{1,3}), ?(\d{1,3})$/,
+  COLOURS: {
+    app: chalk.rgb(255, 136, 0).bold, //orange,
+    db: chalk.greenBright,
+    api: chalk.magentaBright,
+    client: chalk.redBright,
+    log: chalk.hex('#ff651d'),
+    mail: chalk.cyanBright,
+    //error like have backGround colouring
+    auth: chalk.whiteBright.bgBlue,
+    error: chalk.whiteBright.bgHex('#ff1165')
+  }
+ };
+const ipmatch = /^((25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(\.|$)){4}$/;
+const datematch =/^(\d{4})-([01]\d)-([0-3]\d) ([0-2]\d):([0-5]\d)(:([0-5]\d)(\.(\d{1,3}))?)?$/;  
+let lastdate = '';
+
+export function messageFormatter(logid,logtime, crash, shortdate, ipaddress, topic, message, colourspec, gap) {
+  let matches;
+  if (typeof logtime === 'string') {
+    matches = logtime.match(datematch);
+  } else {
+    matches = [logtime];
+  }
+  const logdate = new Date(matches[0]);
+  logdate.setMinutes(logdate.getMinutes() + logdate.getTimezoneOffset());
+  const displaydate = `${logdate.getFullYear()}-${(logdate.getMonth() + 1).toString().padStart(2,'0')}-${logdate.getDate().toString().padStart(2,'0')}`;
+  const displaytime = `${logdate.getHours().toString().padStart(2,'0')}:${logdate.getMinutes().toString().padStart(2,'0')}:${
+    logdate.getSeconds().toString().padStart(2,'0')}.${
+    (typeof logtime === 'string')? (matches[9]??'').toString().padStart(3,'0') : logdate.getMilliseconds().toString().padStart(3,'0')}`;
+  const d = chalk.blueBright(`${displaydate} ${shortdate === 1? displaytime.slice(0,-7): displaytime}`);
+  const ip = ipmatch.test(ipaddress)? chalk.red(` [${ipaddress}]`) : '';
+  const t = chalk.greenBright(`(${topic})`);
+  let m;
+  let l = '';
+  if (crash === 1) {
+    l = chalk.whiteBright(` ${logid}`)
+    m = chalk.white.bgRed(message);
+  } else if (colourspec in COLOURS.COLOURS) {
+    m  = COLOURS.COLOURS[colourspec](message);
+  } else if (COLOURS.hexmatch.test(colourspec)) {
+    m = chalk.hex(colourspec)(message);
+  } else if (COLOURS.rgbmatch.test(colourspec)) {
+    const matches = COLOURS.rgbmatch.exec(colourspec);
+    m = chalk.rgb(matches[1], matches[2], matches[3])(message);
+  } else {
+    m = chalk.cyan(message)
+  }
+  const g = Number.isInteger(gap)?chalk.whiteBright(` gap: ${shortdate? Math.round(gap/60000) + ' mins': gap + 'ms'}`):'';
+  let dayoutput = '';
+  if (lastdate !== displaydate) {
+    dayoutput = `${chalk.whiteBright(displaydate)}:\n`
+    lastdate = displaydate;
+  }
+
+  return {
+    dayoutput: dayoutput,
+    message:`${d}${l}${ip} ${t} ${m}${g}`,
+    logid: logid,
+    ip: ipaddress
+  }
+};
+
+export function DebugHelper(topic, colourspec, shortdate, immediate, writer) {
+  const t = topic;
+  const cs = (colourspec in COLOURS.COLOURS) || COLOURS.hexmatch.test(colourspec) || COLOURS.rgbmatch.test(colourspec) ? colourspec : null;
+  const sd = shortdate? 1:0;
+  let timestamp = Date.now();
+  const i = immediate;
+  return function (c, logtime ,ip, ...args) {
+    let crash = 1;
+    if (c !== 'crash') {
+      if (ip !== undefined) {
+        if (Array.isArray(ip)) args = ip.concat(args); else args.unshift(ip);        
+      }
+      ip = logtime;
+      logtime = c;
+      crash = 0;
+    }
+
+    const fromDate = new Date(); //logtime is only possible if later than midnight last night.
+    const from = fromDate.setHours(0,0,0,0)
+    if (!(Number.isInteger(logtime) && logtime > from)) {
+      if (ip !== undefined) {
+        if (Array.isArray(ip)) args = ip.concat(args); else args.unshift(ip);        
+      }
+      ip = logtime;
+      logtime = Date.now();
+    } 
+    if (!ipmatch.test(ip)) {
+      if (ip !== undefined){
+        if (Array.isArray(ip)) args = ip.concat(args); else args.unshift(ip);        
+      }
+      ip = null
+    }
+    const now = Date.now();
+    const gap = now - timestamp;
+    timestamp = now;
+    const message = args.reduce((cum, arg) => {
+      if (arg === undefined) return cum;
+      return `${cum} ${arg}`.trim();
+    },'');
+    return writer(logtime, crash, sd, ip, t, message, cs, gap,i)
+  }
+};

package/debug.js

@@ -1,6 +1,6 @@
 /**
 @licence
-    Copyright (c) 2021 Alan Chandler, all rights reserved
+    Copyright (c) 2026 Alan Chandler, all rights reserved
 
     This file is part of @akc42/app-utils.
 
@@ -50,7 +50,7 @@
   It doesn't need short date, or immediate parameters as thats whats assumed
 
 */
-import {DebugHelper, messageFormatter} from '@akc42/server-utils';
+import {DebugHelper, messageFormatter} from './debug-utils.js';
 
 export function Logger(topic, colourspec) {
   const debug = Debug(topic, colourspec, 1,1);

package/dom-host.js

@@ -20,12 +20,11 @@
 
 
 
-function domHost(self) {
+export function domHost(self) {
   let parent = self.parentNode;
   while (parent && parent.nodeType !== 11) {
     parent = parent.parentNode;  //work up the hierarchy
   }
 
   return parent ? parent.host : self;
-}
-export default domHost;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akc42/app-utils",
-  "version": "5.0.10",
+  "version": "5.0.11",
   "description": "General Utilities for SPAs",
   "mains": "app-utils.js",
   "scripts": {
@@ -20,7 +20,6 @@
   },
   "homepage": "https://github.com/akc42/app-utils#readme",
   "dependencies": {
-    "@akc42/server-utils": "^4.0.2",
     "lit": "^3.3.1"
   }
 }

package/pdf.js

@@ -18,6 +18,6 @@
     along with @akc42/app-utils.  If not, see <http://www.gnu.org/licenses/>.
 */
 import {api} from './api.js';
-export default (url,params) => {
+export function pdf (url,params) {
   api(`pdf/${url}`,params,true);
 }

package/route.js

@@ -18,7 +18,7 @@
     along with Distributed Router.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-export default class Route  {
+export class Route  {
   constructor(match = '', ifmatched = '') {
     //set default values
     this.preroute = {active: false, segment: 0, path: '', params: {}, query: {}};

package/submit-function.js

@@ -64,7 +64,7 @@ function checkLevel(target, params) {
   return Array.prototype.filter.call(target.children, n => n.nodeType === Node.ELEMENT_NODE).reduce((acc, node) => checkNode(node, params) && acc, true);
 }
 
-export default function submit(e) {
+export function submit(e) {
   let target;
   if (e.currentTarget) {
     e.stopPropagation();

package/{colour.js → utils.js}

@@ -23,12 +23,29 @@
   proceeded by #
 */
 
-function calcTextColor(backgroundColor) {
+export function calcTextColor(backgroundColor) {
   const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(backgroundColor);
   if (result) {
     const luminance = (0.2126 * parseInt(result[1], 16) + 0.7152 * parseInt(result[2], 16) + 0.0722 * parseInt(result[3], 16));
     return (luminance < 140) ? "#ffffff" : "#000000";
   }
   return "#000000"
-}
-export default calcTextColor;
+};
+
+export function capitalise(name) {
+  if (name.length > 0 ) {
+    let words = name.split(' ');
+    for(let i = 0; i < words.length; i++) {
+      if (i > 0 && ( words[i].toLowerCase() === 'de' || words[i].toLowerCase() === 'la')) {
+        words[i] = words[i].toLowerCase();
+      } else if (words[i].length > 2 && words[i].toUpperCase().substring(0,2) === `O'` ) {
+        const newword = capitalise(words[i].substring(2))
+        words[i] = words[i].substring(0,2).toUpperCase() + newword;
+      } else {
+        words[i] = words[i].charAt(0).toUpperCase() + words[i].substring(1).toLowerCase();
+      }
+    }
+    return words.join(' ');
+  }
+  return '';
+};