@akc42/server-utils 4.0.1 → 4.0.3

package/README.md

@@ -1,7 +1,7 @@
 # server-utils
 A Set of Utilities that I generally use on SPA projects for the server side of the project
 
-It consists of 4 separate packages 8 entry points.
+It consists of 4 separate packages 5 entry points.
 
 The packages are:-
 
@@ -40,41 +40,6 @@ This `debug` instance also remembers the time between calls and this time is log
 
 **Logger** is a function that is a wrapper for *Debug* where `shortdate` and `immediate` are both true. 
 
-**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.
-
-**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 is the `@akc42/app-utils` package uses the writer to send the message from the client to the server.
-
-*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`)
 
 ## Responder
 

package/debug.js

@@ -20,8 +20,7 @@ import { EventEmitter } from 'node:events';
 import { setTimeout } from 'node:timers/promises';
 import chalk from "chalk";
 import {openDatabase} from '@akc42/sqlite-db';
-import { messageFormatter, COLOURS } from './message-formatter.js';
-import { DebugHelper} from './debug-helper.js';
+import { messageFormatter, COLOURS, DebugHelper } from '@akc42/app-utils';
 
 class DebugLogEvents extends EventEmitter {}
 /*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akc42/server-utils",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "type": "module",
   "description": "A Set of Utilities to use on the Server Side of a Project",
   "main": "./server-utils.js",
@@ -22,7 +22,8 @@
   },
   "homepage": "https://github.com/akc42/server-utils#readme",
   "dependencies": {
-    "@akc42/sqlite-db": "3.0.6",
-    "chalk": "^5.6.2"
+    "@akc42/sqlite-db": "3.0.7",
+    "@akc42/app-utils": "5.0.11",
+    "chalk":"^5.6.2"
   }
 }

package/server-utils.js

@@ -22,17 +22,12 @@
 
 import {getVersion}from './version.js';
 import {Responder} from './responder.js';
-import { messageFormatter, COLOURS } from './message-formatter.js';
-import { DebugHelper } from './debug-helper.js';
 import { Debug, Logger} from './debug.js';
 import { nullif0len } from './utils.js';
 export {
-  COLOURS,
   Debug,
-  DebugHelper,
   getVersion,
   Logger,
-  messageFormatter,
   nullif0len,
   Responder
 };

package/debug-helper.js

@@ -1,60 +0,0 @@
-/**
-    @licence
-    Copyright (c) 2025 Alan Chandler, all rights reserved
-
-    This file is part of PASv5, an implementation of the Patient Administration
-    System used to support Accuvision's Laser Eye Clinics.
-
-    PASv5 is licenced to Accuvision (and its successors in interest) free of royality payments
-    and in perpetuity 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. Accuvision
-    may modify, or employ an outside party to modify, any of the software provided that
-    this modified software is only used as part of Accuvision's internal business processes.
-
-    The software may be run on either Accuvision's own computers or on external computing
-    facilities provided by a third party, provided that the software remains soley for use
-    by Accuvision (or by potential or existing customers in interacting with Accuvision).
-*/
-
-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/message-formatter.js

@@ -1,84 +0,0 @@
-/**
-@licence
-    Copyright (c) 2026 Alan Chandler, all rights reserved
-
-    This file is part of Server Utils.
-
-    Server 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.
-
-    Server 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 Server 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
-  }
-};