@cyberismo/data-handler 0.0.12 → 0.0.14

package/dist/utils/error-utils.d.ts

@@ -0,0 +1,34 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program 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 Affero General Public License for more details.
+  You should have received a copy of the GNU Affero General Public
+  License along with this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+/**
+ * Returns error message string from an Error object.
+ * @param error Error object
+ * @returns Error message.
+ */
+export declare function errorFunction(error: unknown): string;
+/**
+ * Same as 'errorFunction' but can do automatic replacement of the error message string.
+ * @param message Error message
+ * @param toReplace replacement substring
+ * @param replaceWith string that 'toReplace' is replaced with.
+ * @returns Modified error message.
+ */
+export declare function errorMessage(message: string, toReplace?: string, replaceWith?: string): string;
+/**
+ * Type guard to check if an error object has a code property.
+ * @param error The error object to check
+ * @returns true if the error has a code property
+ */
+export declare function hasCode(error: unknown): error is Error & {
+    code: string;
+};

package/dist/utils/error-utils.js

@@ -0,0 +1,56 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program 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 Affero General Public License for more details.
+  You should have received a copy of the GNU Affero General Public
+  License along with this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+/**
+ * Returns error message string from an Error object.
+ * @param error Error object
+ * @returns Error message.
+ */
+export function errorFunction(error) {
+    if (error instanceof Error) {
+        const err = error;
+        return errorMessage(`${err.message}`);
+    }
+    else if (typeof error === 'string') {
+        return errorMessage(`${error}`);
+    }
+    else {
+        return `errorFunction called without an error object. Actual object is ${JSON.stringify(error)}`;
+    }
+}
+/**
+ * Same as 'errorFunction' but can do automatic replacement of the error message string.
+ * @param message Error message
+ * @param toReplace replacement substring
+ * @param replaceWith string that 'toReplace' is replaced with.
+ * @returns Modified error message.
+ */
+export function errorMessage(message, toReplace, replaceWith) {
+    let errorMessage = message;
+    if (toReplace && replaceWith) {
+        errorMessage = message.replace(toReplace, replaceWith);
+    }
+    return `${errorMessage}`;
+}
+/**
+ * Type guard to check if an error object has a code property.
+ * @param error The error object to check
+ * @returns true if the error has a code property
+ */
+export function hasCode(error) {
+    return (error instanceof Error &&
+        typeof error === 'object' &&
+        error !== null &&
+        'code' in error &&
+        typeof error.code === 'string');
+}
+//# sourceMappingURL=error-utils.js.map

package/dist/utils/error-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-utils.js","sourceRoot":"","sources":["../../src/utils/error-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;EAWE;AAEF;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAU,KAAK,CAAC;QACzB,OAAO,YAAY,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,YAAY,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,kEAAkE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IACnG,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,SAAkB,EAClB,WAAoB;IAEpB,IAAI,YAAY,GAAG,OAAO,CAAC;IAC3B,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QAC7B,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,GAAG,YAAY,EAAE,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,CACL,KAAK,YAAY,KAAK;QACtB,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,MAAM,IAAI,KAAK;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAC;AACJ,CAAC"}

package/dist/utils/log-utils.d.ts

@@ -24,30 +24,3 @@ export declare function getLogger(): Logger;
 export declare function getChildLogger(context: {
     module: string;
 } & Record<string, unknown>, options?: ChildLoggerOptions): Logger;
-/**
- * Returns error message string from an Error object.
- * @param error Error object
- * @returns Error message.
- */
-export declare function errorFunction(error: unknown): string;
-/**
- * Same as 'errorFunction' but can do automatic replacement fof the error message string.
- * @param message Error message
- * @param toReplace replacement substring
- * @param replaceWith string that 'toReplace' is replaced with.
- * @returns Modified error message.
- */
-export declare function errorMessage(message: string, toReplace?: string, replaceWith?: string): string;
-/**
- * Logs error from Error object.
- * @param error potentially an Error object. When exceptions are raised, they are typically Error objects.
- */
-export declare function logError(error: unknown): void;
-/**
- * Log error message in RED. Certain parts of messages can be replaced.
- * This is useful, if including a message from external sources, and want to reduce the verbosity of the message.
- * @param message Error message to log.
- * @param toReplace String to look for.
- * @param replaceWith Replace 'toReplace' with this. Only replaces first instance of 'toReplace'.
- */
-export declare function logErrorMessage(message: string, toReplace?: string, replaceWith?: string): void;

package/dist/utils/log-utils.js

@@ -31,62 +31,4 @@ export function getLogger() {
 export function getChildLogger(context, options) {
     return _logger.child(context, options);
 }
-/**
- * Returns error message string from an Error object.
- * @param error Error object
- * @returns Error message.
- */
-export function errorFunction(error) {
-    if (error instanceof Error) {
-        const err = error;
-        return errorMessage(`${err.message}`);
-    }
-    else if (typeof error === 'string') {
-        return errorMessage(`${error}`);
-    }
-    else {
-        return `${logError.name} called without an error object. Actual object is ${JSON.stringify(error)}`;
-    }
-}
-/**
- * Same as 'errorFunction' but can do automatic replacement fof the error message string.
- * @param message Error message
- * @param toReplace replacement substring
- * @param replaceWith string that 'toReplace' is replaced with.
- * @returns Modified error message.
- */
-export function errorMessage(message, toReplace, replaceWith) {
-    let errorMessage = message;
-    if (toReplace && replaceWith) {
-        errorMessage = message.replace(toReplace, replaceWith);
-    }
-    return `${errorMessage}`;
-}
-/**
- * Logs error from Error object.
- * @param error potentially an Error object. When exceptions are raised, they are typically Error objects.
- */
-export function logError(error) {
-    if (error instanceof Error) {
-        const err = error;
-        logErrorMessage(`${err.message}`);
-    }
-    else {
-        console.error(`${logError.name} called without an error object. Actual object is ${JSON.stringify(error)}`);
-    }
-}
-/**
- * Log error message in RED. Certain parts of messages can be replaced.
- * This is useful, if including a message from external sources, and want to reduce the verbosity of the message.
- * @param message Error message to log.
- * @param toReplace String to look for.
- * @param replaceWith Replace 'toReplace' with this. Only replaces first instance of 'toReplace'.
- */
-export function logErrorMessage(message, toReplace, replaceWith) {
-    let errorMessage = message;
-    if (toReplace && replaceWith) {
-        errorMessage = message.replace(toReplace, replaceWith);
-    }
-    console.error(`${errorMessage}`);
-}
 //# sourceMappingURL=log-utils.js.map

package/dist/utils/log-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"log-utils.js","sourceRoot":"","sources":["../../src/utils/log-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,IAA8C,MAAM,MAAM,CAAC;AAElE,2HAA2H;AAC3H,2BAA2B;AAC3B,IAAI,OAAO,GAAW,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEhD,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,OAAO,GAAG,MAAM,CAAC;AACnB,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC;AACD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAqD,EACrD,OAA4B;IAE5B,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC;AACD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAU,KAAK,CAAC;QACzB,OAAO,YAAY,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACxC,CAAC;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACrC,OAAO,YAAY,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,QAAQ,CAAC,IAAI,qDAAqD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IACtG,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAe,EACf,SAAkB,EAClB,WAAoB;IAEpB,IAAI,YAAY,GAAG,OAAO,CAAC;IAC3B,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QAC7B,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,GAAG,YAAY,EAAE,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAU,KAAK,CAAC;QACzB,eAAe,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CACX,GAAG,QAAQ,CAAC,IAAI,qDAAqD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAe,EACf,SAAkB,EAClB,WAAoB;IAEpB,IAAI,YAAY,GAAG,OAAO,CAAC;IAC3B,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC;QAC7B,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,GAAG,YAAY,EAAE,CAAC,CAAC;AACnC,CAAC"}
+{"version":3,"file":"log-utils.js","sourceRoot":"","sources":["../../src/utils/log-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,IAA8C,MAAM,MAAM,CAAC;AAElE,2HAA2H;AAC3H,2BAA2B;AAC3B,IAAI,OAAO,GAAW,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAEhD,MAAM,UAAU,SAAS,CAAC,MAAc;IACtC,OAAO,GAAG,MAAM,CAAC;AACnB,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,OAAO,CAAC;AACjB,CAAC;AACD;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAqD,EACrD,OAA4B;IAE5B,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACzC,CAAC"}

package/dist/utils/user-preferences.js

@@ -11,6 +11,7 @@
 */
 import { dirname } from 'node:path';
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { hasCode } from './error-utils.js';
 import { formatJson } from './json.js';
 import { getChildLogger } from '../utils/log-utils.js';
 /**
@@ -93,16 +94,18 @@ export class UserPreferences {
             });
         }
         catch (error) {
-            if (error instanceof Error) {
-                const err = error;
+            if (hasCode(error)) {
                 // If file already exists (EEXIST), that's fine - we'll use the existing file
-                if (err?.code !== 'EEXIST') {
+                if (error.code !== 'EEXIST') {
                     throw new Error(`Error creating preferences file '${this.prefsFilePath}': ${error}`);
                 }
                 else {
                     this.logger.warn('Preferences file already exists');
                 }
             }
+            else {
+                throw new Error(`Error creating preferences file '${this.prefsFilePath}': ${error}`);
+            }
         }
     }
     get logger() {

package/dist/utils/user-preferences.js.map

@@ -1 +1 @@
-{"version":3,"file":"user-preferences.js","sourceRoot":"","sources":["../../src/utils/user-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAgBvD;;;GAGG;AACH,MAAM,OAAO,eAAe;IA8DN;IA7DpB,oDAAoD;IACpD,uBAAuB;IACvB,MAAM,CAAC,QAAQ,GAAG;QAChB,WAAW,EAAE;YACX,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,aAAa;gBACtB,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;SACF;QACD,iBAAiB,EAAE;YACjB,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE,sCAAsC;iBAChD;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,2BAA2B;iBACrC;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,2BAA2B;iBACrC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,YAAY;oBACtB,OAAO,EAAE,gCAAgC;iBAC1C;gBACD;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EACL,gEAAgE;iBACnE;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EACL,gEAAgE;iBACnE;aACF;SACF;KACF,CAAC;IAEF,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACvC,kEAAkE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,IAAI,CAAC;YACH,gCAAgC;YAChC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,CAAC;YAED,iDAAiD;YACjD,mDAAmD;YACnD,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBACtE,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,MAAM,GAAG,GAAG,KAA8B,CAAC;gBAC3C,6EAA6E;gBAC7E,IAAI,GAAG,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACpE,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,cAAc,CAAC;YACpB,MAAM,EAAE,iBAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,sCAAsC;QACtC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACnE,CAAC;QACJ,CAAC;IACH,CAAC"}
+{"version":3,"file":"user-preferences.js","sourceRoot":"","sources":["../../src/utils/user-preferences.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7E,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAgBvD;;;GAGG;AACH,MAAM,OAAO,eAAe;IA8DN;IA7DpB,oDAAoD;IACpD,uBAAuB;IACvB,MAAM,CAAC,QAAQ,GAAG;QAChB,WAAW,EAAE;YACX,MAAM,EAAE;gBACN,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;YACD,KAAK,EAAE;gBACL,OAAO,EAAE,aAAa;gBACtB,IAAI,EAAE,CAAC,qBAAqB,EAAE,kBAAkB,CAAC;aAClD;SACF;QACD,iBAAiB,EAAE;YACjB,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,sCAAsC;iBAChD;gBACD;oBACE,QAAQ,EAAE,iBAAiB;oBAC3B,OAAO,EAAE,sCAAsC;iBAChD;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EAAE,2BAA2B;iBACrC;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EAAE,2BAA2B;iBACrC;aACF;YACD,KAAK,EAAE;gBACL;oBACE,QAAQ,EAAE,YAAY;oBACtB,OAAO,EAAE,gCAAgC;iBAC1C;gBACD;oBACE,QAAQ,EAAE,WAAW;oBACrB,OAAO,EACL,gEAAgE;iBACnE;gBACD;oBACE,QAAQ,EAAE,eAAe;oBACzB,OAAO,EACL,gEAAgE;iBACnE;aACF;SACF;KACF,CAAC;IAEF,YAAoB,aAAqB;QAArB,kBAAa,GAAb,aAAa,CAAQ;QACvC,kEAAkE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,IAAI,CAAC;YACH,gCAAgC;YAChC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1B,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,CAAC;YAED,iDAAiD;YACjD,mDAAmD;YACnD,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;gBACtE,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,6EAA6E;gBAC7E,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACpE,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACpE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,cAAc,CAAC;YACpB,MAAM,EAAE,iBAAiB;SAC1B,CAAC,CAAC;IACL,CAAC;IAEM,cAAc;QACnB,sCAAsC;QACtC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,CAAC,aAAa,MAAM,KAAK,EAAE,CACnE,CAAC;QACJ,CAAC;IACH,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cyberismo/data-handler",
   "description": "Command handler for cards and web service",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "author": "sami.merila@cyberismo.com",
   "license": "AGPL-3.0",
   "homepage": "https://github.com/CyberismoCom/cyberismo",
@@ -27,6 +27,7 @@
   },
   "dependencies": {
     "@asciidoctor/core": "^3.0.4",
+    "@types/mime-types": "^3.0.1",
     "@viz-js/viz": "^3.17.0",
     "async-mutex": "^0.5.0",
     "csv-parse": "^6.1.0",
@@ -34,18 +35,19 @@
     "dompurify": "^3.2.6",
     "email-validator": "^2.0.4",
     "handlebars": "^4.7.8",
-    "jsdom": "^26.1.0",
+    "jsdom": "^27.0.0",
     "json-schema": "^0.4.0",
     "jsonschema": "^1.5.0",
-    "pino": "^9.9.4",
+    "mime-types": "^3.0.1",
+    "pino": "^9.9.5",
     "simple-git": "^3.28.0",
     "string-pixel-width": "^1.11.0",
     "tslib": "^2.6.2",
     "vega": "^6.1.2",
-    "vega-lite": "^6.2.0",
-    "write-json-file": "^6.0.0",
-    "@cyberismo/assets": "0.0.12",
-    "@cyberismo/node-clingo": "1.2.0"
+    "vega-lite": "^6.3.1",
+    "write-json-file": "^7.0.0",
+    "@cyberismo/assets": "0.0.14",
+    "@cyberismo/node-clingo": "1.3.0"
   },
   "type": "module",
   "files": [

package/src/command-handler.ts

@@ -31,6 +31,16 @@ import type {
   DataType,
   ResourceContent,
 } from './interfaces/resource-interfaces.js';
+import type {
+  AddCommandOptions,
+  AllCommandOptions,
+  CalcCommandOptions,
+  ExportCommandOptions,
+  ReportCommandOptions,
+  ShowCommandOptions,
+  StartCommandOptions,
+  UpdateCommandOptions,
+} from './interfaces/command-options.js';
 
 import type { requestStatus } from './interfaces/request-status-interfaces.js';
 
@@ -40,7 +50,7 @@ import type { UpdateOperations } from './resources/resource-object.js';
 import { Project } from './containers/project.js';
 
 import { pathExists, resolveTilde } from './utils/file-utils.js';
-import { errorFunction } from './utils/log-utils.js';
+import { errorFunction } from './utils/error-utils.js';
 import { readJsonFile } from './utils/json.js';
 import { resourceName } from './utils/resource-utils.js';
 
@@ -48,49 +58,30 @@ import { type Level } from 'pino';
 import { type Context } from './interfaces/project-interfaces.js';
 import { type QueryName } from './types/queries.js';
 
-// Generic options interface
-export interface CardsOptions {
-  context?: Context;
-  date?: string;
-  details?: boolean;
-  forceStart?: boolean;
-  logLevel?: Level;
-  mappingFile?: string;
-  name?: string;
-  projectPath?: string;
-  recursive?: boolean;
-  repeat?: number;
-  revremark?: string;
-  showAll?: boolean;
-  showUse?: boolean;
-  skipModuleImport?: boolean;
-  title?: string;
-  version?: string;
-  watchResourceChanges?: boolean;
-}
-
 // Commands that this class supports.
-// todo: Could be inside the `CommandHandler` ?
-export enum Cmd {
-  add = 'add',
-  calc = 'calc',
-  create = 'create',
-  edit = 'edit',
-  export = 'export',
-  fetch = 'fetch',
-  import = 'import',
-  move = 'move',
-  rank = 'rank',
-  remove = 'remove',
-  rename = 'rename',
-  report = 'report',
-  show = 'show',
-  start = 'start',
-  transition = 'transition',
-  update = 'update',
-  updateModules = 'update-modules',
-  validate = 'validate',
-}
+export const Cmd = {
+  add: 'add',
+  calc: 'calc',
+  create: 'create',
+  edit: 'edit',
+  export: 'export',
+  fetch: 'fetch',
+  import: 'import',
+  move: 'move',
+  rank: 'rank',
+  remove: 'remove',
+  rename: 'rename',
+  report: 'report',
+  show: 'show',
+  start: 'start',
+  transition: 'transition',
+  update: 'update',
+  updateModules: 'update-modules',
+  validate: 'validate',
+};
+
+export type CmdKey = keyof typeof Cmd;
+export type CmdValue = (typeof Cmd)[CmdKey];
 
 // To what format the content can be exported to.
 export enum ExportFormats {
@@ -128,9 +119,9 @@ export class Commands {
    * @returns request status; 200 if success; 400 in handled error; 500 in unknown error
    */
   public async command(
-    command: Cmd,
+    command: CmdValue,
     args: string[],
-    options: CardsOptions,
+    options: AllCommandOptions,
     credentials?: Credentials,
   ): Promise<requestStatus> {
     // Set project path and validate it.
@@ -163,7 +154,7 @@ export class Commands {
   }
 
   // Handles initializing the project so that it can be used in the class.
-  private async doSetProject(options: CardsOptions) {
+  private async doSetProject(options: AllCommandOptions) {
     const path = options.projectPath || '';
     this.projectPath = resolveTilde(await this.setProjectPath(path));
     if (!Validate.validateFolder(this.projectPath)) {
@@ -182,7 +173,8 @@ export class Commands {
 
     this.commands = await CommandManager.getInstance(this.projectPath, {
       logLevel: options.logLevel,
-      watchResourceChanges: options.watchResourceChanges,
+      watchResourceChanges: (options as StartCommandOptions)
+        .watchResourceChanges,
     });
     if (!this.commands) {
       throw new Error('Cannot get instance of CommandManager');
@@ -192,16 +184,21 @@ export class Commands {
 
   // Handles actual command. Sets returns values correctly.
   private async doHandleCommand(
-    command: Cmd,
+    command: CmdValue,
     args: string[],
-    options: CardsOptions,
+    options: AllCommandOptions,
     credentials?: Credentials,
   ) {
     try {
       if (command === Cmd.add) {
         const [type, target, cardType, cardKey] = args;
         if (type === 'card') {
-          return await this.addCard(target, cardType, cardKey, options.repeat);
+          return await this.addCard(
+            target,
+            cardType,
+            cardKey,
+            (options as AddCommandOptions).repeat,
+          );
         }
         if (type === 'hub') {
           return await this.addHub(target);
@@ -214,7 +211,10 @@ export class Commands {
             return { statusCode: 400, message: 'File path is missing' };
           }
           await this.generateLogicProgram();
-          return this.runLogicProgram(cardKey, options.context || 'localApp');
+          return this.runLogicProgram(
+            cardKey,
+            (options as CalcCommandOptions).context || 'localApp',
+          );
         }
         if (command === 'generate') {
           const [destination, query] = rest;
@@ -356,11 +356,11 @@ export class Commands {
         const [parameters, outputPath] = args;
         return this.runReport(
           parameters,
-          options.context || 'localApp',
+          (options as ReportCommandOptions).context || 'localApp',
           outputPath,
         );
       } else if (command === Cmd.start) {
-        return this.startApp(options.forceStart);
+        return this.startApp((options as StartCommandOptions).forceStart);
       } else if (command === Cmd.transition) {
         const [cardKey, state] = args;
         await this.commands?.transitionCmd.cardTransition(cardKey, {
@@ -378,13 +378,13 @@ export class Commands {
         // Handle mapping file for workflow changes
         let mappingTable: { stateMapping: Record<string, string> } | undefined;
         if (
-          options.mappingFile &&
+          (options as UpdateCommandOptions).mappingFile &&
           operation === 'change' &&
           key === 'workflow'
         ) {
           try {
             const mappingData = await readJsonFile(
-              resolveTilde(options.mappingFile),
+              resolveTilde((options as UpdateCommandOptions).mappingFile!),
             );
             if (
               mappingData &&
@@ -537,7 +537,7 @@ export class Commands {
     destination: string = 'output',
     format: ExportFormats,
     parentCardKey?: string,
-    pdfOptions?: CardsOptions,
+    pdfOptions?: ExportCommandOptions,
   ): Promise<requestStatus> {
     if (!this.commands) {
       return { statusCode: 500 };
@@ -701,7 +701,7 @@ export class Commands {
   private async show(
     type: ResourceTypes,
     typeDetail: string,
-    options: CardsOptions,
+    options: ShowCommandOptions,
   ): Promise<requestStatus> {
     const detail = typeDetail || '';
     let promise: Promise<
@@ -736,6 +736,7 @@ export class Commands {
       case 'cards':
         promise = this.commands!.showCmd.showCards();
         break;
+      case 'calculation':
       case 'cardType':
       case 'fieldType':
       case 'graphView':
@@ -746,6 +747,7 @@ export class Commands {
       case 'workflow':
         promise = this.commands!.showCmd.showResource(detail, options.showUse);
         break;
+      case 'calculations':
       case 'cardTypes':
       case 'fieldTypes':
       case 'graphModels':
@@ -798,8 +800,15 @@ export class Commands {
     // since current working directory changes, we need to resolve the project path
     const projectPath = resolve(this.projectPath);
 
+    if (!this.commands) {
+      return { statusCode: 500, message: 'Commands not initialized' };
+    }
+
     if (!forceStart) {
-      const validationErrors = await this.validateCmd.validate(projectPath);
+      const validationErrors = await this.validateCmd.validate(
+        projectPath,
+        () => this.commands!.project,
+      );
       if (validationErrors) {
         return { statusCode: 400, message: validationErrors };
       }
@@ -821,7 +830,13 @@ export class Commands {
 
   // Validates that a given path conforms to schema. Validates both file/folder structure and file content.
   private async validate(): Promise<requestStatus> {
-    const result = await this.validateCmd.validate(this.projectPath);
+    if (!this.commands) {
+      return { statusCode: 500, message: 'Commands not initialized' };
+    }
+    const result = await this.validateCmd.validate(
+      this.projectPath,
+      () => this.commands!.project,
+    );
     return {
       statusCode: 200,
       message: result.length ? result : 'Project structure validated',

package/src/commands/create.ts

@@ -20,7 +20,7 @@ import {
   writeFile,
 } from 'node:fs/promises';
 
-import { errorFunction } from '../utils/log-utils.js';
+import { errorFunction } from '../utils/error-utils.js';
 import { Project } from '../containers/project.js';
 import { Validate } from './index.js';
 
@@ -35,6 +35,7 @@ import type { Card, ProjectFile } from '../interfaces/project-interfaces.js';
 import { resourceName, resourceNameToString } from '../utils/resource-utils.js';
 import { writeJsonFile } from '../utils/json.js';
 
+import { CalculationResource } from '../resources/calculation-resource.js';
 import { CardTypeResource } from '../resources/card-type-resource.js';
 import { FieldTypeResource } from '../resources/field-type-resource.js';
 import { GraphModelResource } from '../resources/graph-model-resource.js';
@@ -213,34 +214,15 @@ export class Create {
   }
 
   /**
-   * Creates a calculation file.
-   * @param fileName name for the calculation file (without .lp extension)
+   * Creates a calculation resource.
+   * @param calculationName name for the calculation resource
    */
-  public async createCalculation(fileName: string) {
-    const calculationFolder = this.project.paths.calculationProjectFolder;
-
-    await mkdir(calculationFolder, { recursive: true });
-
-    const calculationFileName = fileName.endsWith('.lp')
-      ? fileName
-      : `${fileName}.lp`;
-    const calculationFilePath = join(calculationFolder, calculationFileName);
-
-    const calculationContent = `% Calculation file: ${calculationFileName}
-% Add your logic programming rules here
-`;
-
-    await writeFile(calculationFilePath, calculationContent, { flag: 'wx' });
-
-    // add to cache manually
-    // TODO: remove once calculations are a proper resource
-    const resourceName = `${this.project.projectPrefix}/calculations/${fileName.replace('.lp', '')}`;
-    const resource = {
-      name: resourceName,
-      path: calculationFolder,
-    };
-
-    this.project.addResource(resource, {} as JSON);
+  public async createCalculation(calculationName: string) {
+    const calculation = new CalculationResource(
+      this.project,
+      resourceName(calculationName),
+    );
+    await calculation.create();
   }
 
   /**