@cyberismo/data-handler 0.0.12 → 0.0.14

package/src/resources/resource-object.ts

@@ -16,6 +16,8 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { basename, join } from 'node:path';
 
+import { hasCode } from '../utils/error-utils.js';
+
 import { ArrayHandler } from './array-handler.js';
 import type {
   Card,
@@ -67,6 +69,17 @@ export type Operation<T> =
   | RankOperation<T>
   | RemoveOperation<T>;
 
+// Utility mapping from operation name to its concrete operation type
+export type OperationMap<T> = {
+  add: AddOperation<T>;
+  change: ChangeOperation<T>;
+  rank: RankOperation<T>;
+  remove: RemoveOperation<T>;
+};
+
+// Given an operation name, get the corresponding operation type
+export type OperationFor<T, N extends UpdateOperations> = OperationMap<T>[N];
+
 /**
  * Abstract class for resources.
  */
@@ -211,19 +224,29 @@ export class ResourceObject extends AbstractResource {
           );
         }
 
-        const filename = join(
-          calculation.path,
-          basename(calculation.name) + '.lp',
-        );
+        const base = basename(calculation.name);
+        const fileNameWithExtension = base.endsWith('.lp')
+          ? base
+          : base + '.lp';
+        const filename = join(calculation.path, fileNameWithExtension);
 
         try {
           const content = await readFile(filename, 'utf-8');
           const updatedContent = content.replaceAll(from, to);
           await writeFile(filename, updatedContent);
         } catch (error) {
-          throw new Error(
-            `Failed to process file ${filename}: ${(error as Error).message}`,
-          );
+          if (hasCode(error) && error.code === 'ENOENT') {
+            // Skip files that don't exist (they may have been renamed or deleted)
+            this.getLogger(this.getType).warn(
+              `Skipping non-existent file: ${filename}`,
+            );
+            return;
+          }
+          if (error instanceof Error) {
+            throw new Error(
+              `Failed to process file while updating calculation ${filename}: ${error.message}`,
+            );
+          }
         }
       }),
     );

package/src/resources/template-resource.ts

@@ -57,13 +57,15 @@ export class TemplateResource extends FolderResource {
     });
   }
 
-  // When resource name changes.
-  private async handleNameChange(existingName: string) {
+  /**
+   * Handle name changes for templates
+   * @param existingName The previous name before the change
+   */
+  protected async onNameChange(existingName: string): Promise<void> {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name),
       super.updateCalculations(existingName, this.content.name),
     ]);
-    // Finally, write updated content.
     await this.write();
   }
 
@@ -105,7 +107,7 @@ export class TemplateResource extends FolderResource {
   public async rename(newName: ResourceName) {
     const existingName = this.content.name;
     await super.rename(newName);
-    return this.handleNameChange(existingName);
+    return this.onNameChange(existingName);
   }
 
   /**
@@ -117,8 +119,8 @@ export class TemplateResource extends FolderResource {
     const container = this.templateObject();
 
     return {
-      metadata: templateMetadata,
       name: resourceNameToString(this.resourceName),
+      category: templateMetadata.category,
       displayName: templateMetadata.displayName,
       description: templateMetadata.description,
       path: this.fileName,
@@ -144,7 +146,10 @@ export class TemplateResource extends FolderResource {
     const nameChange = key === 'name';
     const existingName = this.content.name;
 
-    await super.update(key, op);
+    // Only call super.update for keys that base class supports
+    if (key === 'name' || key === 'displayName' || key === 'description') {
+      await super.update(key, op);
+    }
 
     const content = structuredClone(this.content) as TemplateMetadata;
 
@@ -164,7 +169,7 @@ export class TemplateResource extends FolderResource {
 
     // Renaming this template causes that references to its name must be updated.
     if (nameChange) {
-      await this.handleNameChange(existingName);
+      await this.onNameChange(existingName);
     }
   }
 

package/src/resources/workflow-resource.ts

@@ -283,6 +283,10 @@ export class WorkflowResource extends FileResource {
 
     if (key === 'name') {
       content.name = super.handleScalar(op) as string;
+    } else if (key === 'displayName') {
+      content.displayName = super.handleScalar(op) as string;
+    } else if (key === 'description') {
+      content.description = super.handleScalar(op) as string;
     } else if (key === 'states') {
       content.states = super.handleArray(
         op,

package/src/utils/constants.ts

@@ -29,6 +29,7 @@ export const VALID_FOLDER_RESOURCE_FILES = [
   'parameterSchema.json',
   'view.lp.hbs',
   'model.lp',
+  'calculation.lp',
 ];
 
 /**

package/src/utils/error-utils.ts

@@ -0,0 +1,62 @@
+/**
+  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: unknown): string {
+  if (error instanceof Error) {
+    const err: Error = 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: string,
+  toReplace?: string,
+  replaceWith?: string,
+): string {
+  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: unknown): error is Error & { code: string } {
+  return (
+    error instanceof Error &&
+    typeof error === 'object' &&
+    error !== null &&
+    'code' in error &&
+    typeof error.code === 'string'
+  );
+}

package/src/utils/log-utils.ts

@@ -36,71 +36,3 @@ export function getChildLogger(
 ): Logger {
   return _logger.child(context, options);
 }
-/**
- * Returns error message string from an Error object.
- * @param error Error object
- * @returns Error message.
- */
-export function errorFunction(error: unknown): string {
-  if (error instanceof Error) {
-    const err: Error = 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: string,
-  toReplace?: string,
-  replaceWith?: string,
-): string {
-  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: unknown) {
-  if (error instanceof Error) {
-    const err: Error = 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: string,
-  toReplace?: string,
-  replaceWith?: string,
-) {
-  let errorMessage = message;
-  if (toReplace && replaceWith) {
-    errorMessage = message.replace(toReplace, replaceWith);
-  }
-  console.error(`${errorMessage}`);
-}

package/src/utils/user-preferences.ts

@@ -12,6 +12,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';
 
@@ -111,16 +112,19 @@ export class UserPreferences {
         flag: 'wx',
       });
     } catch (error) {
-      if (error instanceof Error) {
-        const err = error as NodeJS.ErrnoException;
+      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}`,
+        );
       }
     }
   }