@cyberismo/data-handler 0.0.18 → 0.0.19

package/src/resources/link-type-resource.ts

@@ -25,6 +25,11 @@ import type { ResourceName } from '../utils/resource-utils.js';
  * Link Type resource class.
  */
 export class LinkTypeResource extends FileResource<LinkType> {
+  /**
+   * Creates instance of LinkTypeResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'linkTypes');
 
@@ -32,6 +37,33 @@ export class LinkTypeResource extends FileResource<LinkType> {
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
   }
 
+  // Update card metadata links when link type is renamed
+  private async updateCardLinks(from: string, to: string) {
+    const cards = await this.collectCards(
+      from,
+      (card, linkTypeName) =>
+        card.metadata?.links?.some((link) => link.linkType === linkTypeName) ??
+        false,
+    );
+    if (cards.length === 0) {
+      return;
+    }
+
+    await Promise.all(
+      cards.map(async (card) => {
+        if (card.metadata?.links) {
+          card.metadata.links = card.metadata.links.map((link) => {
+            if (link.linkType === from) {
+              return { ...link, linkType: to };
+            }
+            return link;
+          });
+          await this.project.updateCardMetadata(card, card.metadata);
+        }
+      }),
+    );
+  }
+
   /**
    * When resource name changes.
    * @param existingName Current resource name.
@@ -52,6 +84,8 @@ export class LinkTypeResource extends FileResource<LinkType> {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
+      this.updateCardLinks(existingName, this.content.name),
     ]);
     // Finally, write updated content.
     await this.write();

package/src/resources/report-resource.ts

@@ -42,6 +42,11 @@ export class ReportResource extends FolderResource<
   ReportMetadata,
   ReportContent
 > {
+  /**
+   * Creates instance of ReportResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'reports');
 
@@ -68,6 +73,7 @@ export class ReportResource extends FolderResource<
         await this.handleBarFiles(),
       ),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
     ]);
     // Finally, write updated content.
     await this.write();
@@ -152,9 +158,9 @@ export class ReportResource extends FolderResource<
 
   /**
    * Validates report.
-   * @throws when there are validation errors.
    * @param content Content to be validated.
    * @note If content is not provided, base class validation will use resource's current content.
+   * @throws when there are validation errors.
    */
   public async validate(content?: object) {
     const resourceContent = this.contentData();

package/src/resources/resource-object.ts

@@ -416,7 +416,13 @@ export abstract class ResourceObject<
     }
   }
 
-  // Log details
+  /**
+   * Log to migration log resource change
+   * @param operationType Operation type
+   * @param op Details of operation
+   * @param key Which property has been changed
+   * @throws when operation type is unknown
+   */
   protected async logResourceOperation<Type>(
     operationType: 'create' | 'delete' | 'update' | 'rename',
     op?: Operation<Type>,
@@ -596,27 +602,11 @@ export abstract class ResourceObject<
     }
   }
 
-  /**
-   * Validates resource identifier to prevent filesystem operations with invalid names
-   * todo: To Validate?
-   */
-  protected validateResourceIdentifier() {
-    if (!this.moduleResource && this.resourceName.identifier) {
-      const identifier = this.resourceName.identifier;
-      if (!/^[a-zA-Z0-9._-]+$/.test(identifier)) {
-        throw new Error(
-          `Resource identifier must follow naming rules. Identifier '${identifier}' is invalid`,
-        );
-      }
-    }
-  }
-
   /**
    * Update calculation files.
    * @param from Resource name to update
    * @param to New name for resource
-   * @throws if 'from' or 'to' is empty string, or
-   *         if there was error accessing calculation files.
+   * @throws if 'from' or 'to' is empty string
    */
   protected async updateCalculations(from: string, to: string) {
     if (!from.trim() || !to.trim()) {
@@ -674,6 +664,39 @@ export abstract class ResourceObject<
     );
   }
 
+  /**
+   * Update references in card content.
+   * Searches through all card content in the cache and replaces references to the old resource name.
+   * @param from Resource name to update
+   * @param to New name for resource
+   * @throws if 'from' or 'to' is empty string
+   */
+  protected async updateCardContentReferences(from: string, to: string) {
+    if (!from.trim() || !to.trim()) {
+      throw new Error(
+        'updateCardContentReferences: "from" and "to" parameters must not be empty',
+      );
+    }
+
+    const allCards = this.cards();
+    const cardsToUpdate = allCards.filter(
+      (card) => card.content && card.content.includes(from),
+    );
+
+    if (cardsToUpdate.length === 0) {
+      return;
+    }
+
+    await Promise.all(
+      cardsToUpdate.map(async (card) => {
+        if (card.content) {
+          const updatedContent = card.content.replaceAll(from, to);
+          await this.project.updateCardContent(card.key, updatedContent);
+        }
+      }),
+    );
+  }
+
   /**
    * Check if there are references to the resource in the card content.
    * @note that this needs to be async, since inherited classes need to async operations
@@ -695,6 +718,22 @@ export abstract class ResourceObject<
       .map((card) => card.key);
   }
 
+  /**
+   * Validates resource identifier to prevent filesystem operations with invalid names
+   * todo: move to Validate?
+   * @throws if identifier is incorrect
+   */
+  protected validateResourceIdentifier() {
+    if (!this.moduleResource && this.resourceName.identifier) {
+      const identifier = this.resourceName.identifier;
+      if (!/^[a-zA-Z0-9._-]+$/.test(identifier)) {
+        throw new Error(
+          `Resource identifier must follow naming rules. Identifier '${identifier}' is invalid`,
+        );
+      }
+    }
+  }
+
   /**
    * Checks if resource name is valid.
    * @param newName New name for resource.

package/src/resources/template-resource.ts

@@ -39,6 +39,11 @@ export class TemplateResource extends FolderResource<TemplateMetadata, never> {
   private cardsFolder = '';
   private cardsSchema = super.contentSchemaContent('cardBaseSchema');
 
+  /**
+   * Creates an instance of TemplateResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'templates');
 
@@ -63,6 +68,7 @@ export class TemplateResource extends FolderResource<TemplateMetadata, never> {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
     ]);
     await this.write();
   }
@@ -70,7 +76,6 @@ export class TemplateResource extends FolderResource<TemplateMetadata, never> {
   /**
    * Sets new metadata into the template object.
    * @param newContent metadata content for the template.
-   * @throws if 'newContent' is not valid.
    */
   public async create(newContent?: TemplateMetadata) {
     if (!newContent) {

package/src/resources/workflow-resource.ts

@@ -36,6 +36,11 @@ import type { ResourceName } from '../utils/resource-utils.js';
  * Workflow resource class.
  */
 export class WorkflowResource extends FileResource<Workflow> {
+  /**
+   * Creates an instance of WorkflowResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'workflows');
 
@@ -49,7 +54,12 @@ export class WorkflowResource extends FileResource<Workflow> {
     const promises: Promise<Card[]>[] = [];
     for (const cardType of cardTypes) {
       if (cardType.data?.workflow === resourceNameToString(this.resourceName)) {
-        promises.push(this.collectCards(cardType.data.name));
+        promises.push(
+          this.collectCards(
+            cardType.data.name,
+            (card, cardTypeName) => card.metadata?.cardType === cardTypeName,
+          ),
+        );
       }
     }
     return (await Promise.all(promises)).flat();
@@ -60,6 +70,7 @@ export class WorkflowResource extends FileResource<Workflow> {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
       this.updateCardTypes(existingName),
     ]);
     // Finally, write updated content.
@@ -132,6 +143,11 @@ export class WorkflowResource extends FileResource<Workflow> {
     }
   }
 
+  // Check if operation is a string operation.
+  private isStringOperation(op: Operation<unknown>): op is Operation<string> {
+    return typeof op.target === 'string';
+  }
+
   // Returns target name irregardless of the type
   private targetName(op: Operation<WorkflowState | WorkflowTransition>) {
     const name = op.target.name ? op.target.name : op.target;
@@ -168,11 +184,6 @@ export class WorkflowResource extends FileResource<Workflow> {
     return op.to;
   }
 
-  // Check if operation is a string operation.
-  private isStringOperation(op: Operation<unknown>): op is Operation<string> {
-    return typeof op.target === 'string';
-  }
-
   // Update card states when state is changed
   private async updateCardStates(oldState: string, newState: string) {
     const cards = await this.collectCardsUsingWorkflow();
@@ -209,7 +220,6 @@ export class WorkflowResource extends FileResource<Workflow> {
   /**
    * Sets new metadata into the workflow object.
    * @param newContent metadata content for the workflow.
-   * @throws if 'newContent' is not valid.
    */
   public async create(newContent?: Workflow) {
     if (!newContent) {

package/src/utils/common-utils.ts

@@ -52,3 +52,18 @@ export function isBigInt(value: string): boolean {
     return false;
   }
 }
+
+/**
+ * Removes the first occurrence of a value from an array.
+ * Modifies the array in place.
+ * @param array The array to modify
+ * @param value The value to remove
+ * @returns The modified array (same reference as input)
+ */
+export function removeValue<T>(array: T[], value: T): T[] {
+  const index = array.findIndex((element) => element === value);
+  if (index !== -1) {
+    array.splice(index, 1);
+  }
+  return array;
+}

package/src/utils/file-utils.ts

@@ -17,6 +17,8 @@ import {
   mkdir,
   readdir,
   rm,
+  stat,
+  statfs,
   unlink,
   writeFile,
 } from 'node:fs/promises';
@@ -25,19 +27,17 @@ import { dirname, join, sep } from 'node:path';
 import { homedir } from 'node:os';
 
 /**
- * Works like the writeFile method, but ensures that the directory exists
- * There is only one difference: This method only supports a string as the filePath
+ * Get available disk space for a given path.
+ * @param path Path to check
+ * @returns Available space in bytes
  */
-export async function writeFileSafe(
-  filePath: string,
-  data: Parameters<typeof writeFile>[1],
-  options?: Parameters<typeof writeFile>[2],
-) {
-  const dir = dirname(filePath);
-  await mkdir(dir, {
-    recursive: true,
-  });
-  return writeFile(filePath, data, options);
+export async function availableSpace(path: string): Promise<number> {
+  try {
+    const stats = await statfs(path);
+    return stats.bavail * stats.bsize;
+  } catch (error) {
+    throw new Error(`Failed to check available disk space: ${error}`);
+  }
 }
 
 /**
@@ -87,6 +87,34 @@ export async function deleteFile(path: string): Promise<boolean> {
   return true;
 }
 
+/**
+ * Calculate the total size of a directory recursively.
+ * @param dirPath Path to directory
+ * @returns Size in bytes
+ */
+export async function folderSize(dirPath: string): Promise<number> {
+  let size = 0;
+
+  try {
+    const entries = await readdir(dirPath, { withFileTypes: true });
+
+    for (const entry of entries) {
+      const fullPath = join(dirPath, entry.name);
+
+      if (entry.isDirectory()) {
+        size += await folderSize(fullPath);
+      } else if (entry.isFile()) {
+        const stats = await stat(fullPath);
+        size += stats.size;
+      }
+    }
+  } catch {
+    // Ignore permission errors or missing directories
+  }
+
+  return size;
+}
+
 /**
  * Removes extension from filename.
  * @param filename Filename
@@ -180,3 +208,19 @@ export function resolveTilde(filePath: string): string {
  * Path separator RE.
  */
 export const sepRegex = /[/\\]/;
+
+/**
+ * Works like the writeFile method, but ensures that the directory exists
+ * There is only one difference: This method only supports a string as the filePath
+ */
+export async function writeFileSafe(
+  filePath: string,
+  data: Parameters<typeof writeFile>[1],
+  options?: Parameters<typeof writeFile>[2],
+) {
+  const dir = dirname(filePath);
+  await mkdir(dir, {
+    recursive: true,
+  });
+  return writeFile(filePath, data, options);
+}

package/src/utils/json.ts

@@ -28,9 +28,7 @@ export function readJsonFileSync(file: string) {
     return returnValue;
   } catch (error) {
     if (error instanceof Error) {
-      throw new Error(
-        `Error while handling JSON file '${file}' : ${error.message}`,
-      );
+      throw new Error(`Invalid JSON in file '${file}': ${error.message}`);
     }
   }
 }
@@ -47,9 +45,7 @@ export async function readJsonFile(file: string) {
     return JSON.parse(raw);
   } catch (error) {
     if (error instanceof Error) {
-      throw new Error(
-        `Error while handling JSON file '${file}' : ${error.message}`,
-      );
+      throw new Error(`Invalid JSON in file '${file}': ${error.message}`);
     }
   }
 }