@cyberismo/data-handler 0.0.13 → 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.13",
+  "version": "0.0.14",
   "author": "sami.merila@cyberismo.com",
   "license": "AGPL-3.0",
   "homepage": "https://github.com/CyberismoCom/cyberismo",
@@ -46,7 +46,7 @@
     "vega": "^6.1.2",
     "vega-lite": "^6.3.1",
     "write-json-file": "^7.0.0",
-    "@cyberismo/assets": "0.0.13",
+    "@cyberismo/assets": "0.0.14",
     "@cyberismo/node-clingo": "1.3.0"
   },
   "type": "module",

package/src/command-handler.ts

@@ -50,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';
 
@@ -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':

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();
   }
 
   /**

package/src/commands/edit.ts

@@ -1,13 +1,14 @@
 /**
-    Cyberismo
-    Copyright © Cyberismo Ltd and contributors 2024
-
-    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/>.
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+  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/>.
 */
 
 // node
@@ -16,18 +17,19 @@ import { homedir } from 'node:os';
 import { spawnSync } from 'node:child_process';
 
 import { ActionGuard } from '../permissions/action-guard.js';
+import { CalculationResource } from '../resources/calculation-resource.js';
+import { FolderResource } from '../resources/folder-resource.js';
+import { Project } from '../containers/project.js';
+import { propertyName } from '../interfaces/folder-content-interfaces.js';
+import { resourceNameToString } from '../utils/resource-utils.js';
+import { UserPreferences } from '../utils/user-preferences.js';
+
+import type { ContentPropertyName } from '../interfaces/folder-content-interfaces.js';
 import type {
   MetadataContent,
   ResourceFolderType,
 } from '../interfaces/project-interfaces.js';
-import { Project } from '../containers/project.js';
-import { UserPreferences } from '../utils/user-preferences.js';
-import {
-  type ResourceName,
-  resourceNameToString,
-} from '../utils/resource-utils.js';
-import { FolderResource } from '../resources/folder-resource.js';
-import { writeFile } from 'node:fs/promises';
+import type { ResourceName } from '../utils/resource-utils.js';
 
 export class Edit {
   private project: Project;
@@ -61,15 +63,21 @@ export class Edit {
         `Resource '${resourceNameString}' does not exist in the project`,
       );
     }
-    await writeFile(
-      join(
-        this.project.paths.calculationProjectFolder,
-        resourceName.identifier + '.lp',
-      ),
-      changedContent,
+    const calculationResource = new CalculationResource(
+      this.project,
+      resourceName,
+    );
+    const contentUpdateKey = {
+      key: 'content',
+      subKey: 'calculation',
+    };
+    await calculationResource.update(
+      // TODO: Let's fix this while we get rid of updating filenames directly a bit later.
+      contentUpdateKey as unknown as ContentPropertyName,
       {
-        encoding: 'utf-8',
-        flag: 'r+',
+        name: 'change',
+        target: resourceNameString,
+        to: changedContent,
       },
     );
   }
@@ -201,6 +209,23 @@ export class Edit {
         `Resource '${resourceNameString}' is not a folder resource`,
       );
     }
-    return resource.updateFile(fileName, changedContent);
+
+    // TODO: The caller should not pass filename, but content type
+    // Once that is in place, this check can be removed
+    const propName: ContentPropertyName | undefined = propertyName(fileName);
+    if (!propName) {
+      throw new Error(`File '${fileName}' is not allowed`);
+    }
+
+    const contentUpdateKey = {
+      key: 'content',
+      subKey: propName,
+    };
+    // TODO: Let's fix this while we get rid of updating filenames directly a bit later.
+    return resource.update(contentUpdateKey as unknown as ContentPropertyName, {
+      name: 'change',
+      target: '',
+      to: changedContent,
+    });
   }
 }

package/src/commands/fetch.ts

@@ -18,7 +18,8 @@ import type { Project } from '../containers/project.js';
 import { writeJsonFile } from '../utils/json.js';
 import { validateJson } from '../utils/validate.js';
 import { type ModuleSetting } from '../interfaces/project-interfaces.js';
-import { errorFunction, getChildLogger } from '../utils/log-utils.js';
+import { errorFunction } from '../utils/error-utils.js';
+import { getChildLogger } from '../utils/log-utils.js';
 
 const FETCH_TIMEOUT = 30000; // 30s timeout for fetching a hub file.
 const MAX_RESPONSE_SIZE = 1024 * 1024; // 1MB limit for safety

package/src/commands/remove.ts

@@ -35,6 +35,7 @@ export class Remove {
   // True, if resource is a project resource
   private projectResource(type: RemovableResourceTypes): boolean {
     return (
+      type === 'calculation' ||
       type === 'cardType' ||
       type === 'fieldType' ||
       type === 'graphModel' ||
@@ -229,12 +230,12 @@ export class Remove {
       if (type === 'attachment')
         return this.removeAttachment(targetName, rest[0]);
       else if (type === 'card') return this.removeCard(targetName);
+      else if (type === 'hub') return this.removeHubLocation(targetName);
+      else if (type === 'label') return this.removeLabel(targetName, rest[0]);
       else if (type === 'link')
         return this.removeLink(targetName, rest[0], rest[1], rest.at(2));
       else if (type === 'module')
         return this.moduleManager.removeModule(targetName);
-      else if (type === 'label') return this.removeLabel(targetName, rest[0]);
-      else if (type === 'hub') return this.removeHubLocation(targetName);
     }
     throw new Error(`Unknown resource type '${type}'`);
   }

package/src/commands/rename.ts

@@ -22,6 +22,7 @@ import { type Project, ResourcesFrom } from '../containers/project.js';
 import { resourceName } from '../utils/resource-utils.js';
 import { Template } from '../containers/template.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';
@@ -192,6 +193,17 @@ export class Rename {
     return cardType.rename(resourceName(this.updateResourceName(cardTypeName)));
   }
 
+  // Rename calculations.
+  private async updateCalculation(calculationName: string) {
+    const calculation = new CalculationResource(
+      this.project,
+      resourceName(calculationName),
+    );
+    return calculation.rename(
+      resourceName(this.updateResourceName(calculationName)),
+    );
+  }
+
   // Updates field type's metadata.
   private async updateFieldTypeMetadata(fieldTypeName: string) {
     const fieldType = new FieldTypeResource(
@@ -341,6 +353,14 @@ export class Rename {
     }
     console.info('Updated templates');
 
+    const calculations = await this.project.calculations(
+      ResourcesFrom.localOnly,
+    );
+    for (const calculation of calculations) {
+      await this.updateCalculation(calculation.name);
+    }
+    console.info('Updated calculations');
+
     // Rename all local template cards.
     templates = await this.project.templates(ResourcesFrom.localOnly);
     for (const template of templates) {

package/src/commands/show.ts

@@ -16,7 +16,7 @@ import { existsSync, readFileSync } from 'node:fs';
 import { homedir } from 'node:os';
 import { join, resolve } from 'node:path';
 import { spawn } from 'node:child_process';
-import { readFile, writeFile } from 'node:fs/promises';
+import { writeFile } from 'node:fs/promises';
 
 import { MODULE_LIST_FULL_PATH } from './fetch.js';
 
@@ -47,7 +47,6 @@ import { Project, type ResourcesFrom } from '../containers/project.js';
 import {
   type ResourceName,
   resourceName,
-  resourceNameToPath,
   resourceNameToString,
 } from '../utils/resource-utils.js';
 import { TemplateResource } from '../resources/template-resource.js';
@@ -571,17 +570,6 @@ export class Show {
     name: string,
     showUse: boolean = false,
   ): Promise<ResourceContent | undefined> {
-    // TODO: remove this workaround once calculations are implemented as a resource class
-    if (resourceName(name).type === 'calculations') {
-      const nameObj = resourceName(name);
-      const path = resourceNameToPath(this.project, nameObj, '.lp');
-      return {
-        name,
-        displayName: nameObj.identifier,
-        calculation: await readFile(path, 'utf-8'),
-      };
-    }
-
     const strictNameCheck = true;
     const resource = Project.resourceObject(
       this.project,

package/src/commands/validate.ts

@@ -36,7 +36,7 @@ import type {
   ResourceContent,
   Workflow,
 } from '../interfaces/resource-interfaces.js';
-import { errorFunction } from '../utils/log-utils.js';
+import { errorFunction } from '../utils/error-utils.js';
 import { isTemplateCard } from '../utils/card-utils.js';
 import { pathExists } from '../utils/file-utils.js';
 import { Project } from '../containers/project.js';

package/src/containers/project/calculation-engine.ts

@@ -12,8 +12,7 @@
 */
 
 // node
-import { basename, join, resolve } from 'node:path';
-import { readFile, writeFile } from 'node:fs/promises';
+import { writeFile } from 'node:fs/promises';
 
 import { sanitizeSvgBase64 } from '../../utils/sanitize-svg.js';
 import { instance } from '@viz-js/viz';
@@ -26,7 +25,6 @@ import type {
 } from '../../types/queries.js';
 import type { Card, Context } from '../../interfaces/project-interfaces.js';
 import ClingoParser from '../../utils/clingo-parser.js';
-import { pathExists } from '../../utils/file-utils.js';
 import { Mutex } from 'async-mutex';
 import Handlebars from 'handlebars';
 import { type Project, ResourcesFrom } from '../../containers/project.js';
@@ -52,6 +50,7 @@ import type {
   TemplateMetadata,
   Workflow,
 } from '../../interfaces/resource-interfaces.js';
+import { CalculationResource } from '../../resources/calculation-resource.js';
 import {
   removeAllPrograms,
   solve,
@@ -62,6 +61,7 @@ import {
 import { generateReportContent } from '../../utils/report.js';
 import { lpFiles, graphvizReport } from '@cyberismo/assets';
 import {
+  resourceName,
   type ResourceName,
   resourceNameToString,
 } from '../../utils/resource-utils.js';
@@ -123,7 +123,7 @@ export class CalculationEngine {
     query?: QueryName,
   ) {
     let logicProgram = query ? this.queryContent(query) : '';
-    logicProgram += await buildProgram('', programs);
+    logicProgram += buildProgram('', programs);
     await writeFile(destination, logicProgram);
   }
 
@@ -259,26 +259,28 @@ export class CalculationEngine {
     const calculations = await this.project.calculations(ResourcesFrom.all);
 
     for (const calculationFile of calculations) {
-      if (calculationFile.path) {
-        const moduleLogicFile = resolve(
-          join(calculationFile.path, basename(calculationFile.name)),
+      try {
+        const calculationResource = new CalculationResource(
+          this.project,
+          resourceName(calculationFile.name),
         );
-
-        const filePath = moduleLogicFile.endsWith('.lp')
-          ? moduleLogicFile
-          : moduleLogicFile + '.lp';
-
-        if (pathExists(filePath)) {
-          try {
-            const moduleContent = await readFile(filePath, 'utf-8');
-            setProgram(calculationFile.name, moduleContent, [ALL_CATEGORY]);
-          } catch (error) {
-            this.logger.warn(
-              error,
-              `Failed to read calculation ${calculationFile.name}`,
+        if (calculationResource) {
+          const resource = await calculationResource.show();
+          if (!resource?.content.calculation) {
+            this.logger.info(
+              `Calculation resource '${resource.name}' does not have calculation file`,
             );
+            continue;
           }
+          setProgram(calculationFile.name, resource.content.calculation, [
+            ALL_CATEGORY,
+          ]);
         }
+      } catch (error) {
+        this.logger.warn(
+          error,
+          `Failed to read calculation ${calculationFile.name}`,
+        );
       }
     }
   }