@cyberismo/data-handler 0.0.17 → 0.0.19

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

@@ -50,6 +50,11 @@ export class FieldTypeResource extends FileResource<FieldType> {
   private fromType: DataType = 'integer';
   private toType: DataType = 'integer';
 
+  /**
+   * Creates an instance of FieldTypeResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'fieldTypes');
 
@@ -206,7 +211,12 @@ export class FieldTypeResource extends FileResource<FieldType> {
     const removedValue = (op.target as EnumDefinition).enumValue;
     const cardTypes = this.relevantCardTypes();
     const allCards = await Promise.all(
-      cardTypes.map((cardType) => this.collectCards(cardType)),
+      cardTypes.map((cardType) =>
+        this.collectCards(
+          cardType,
+          (card, cardTypeName) => card.metadata?.cardType === cardTypeName,
+        ),
+      ),
     );
     const cardsToUpdate = allCards
       .flat()
@@ -223,15 +233,6 @@ export class FieldTypeResource extends FileResource<FieldType> {
     );
   }
 
-  // When resource name changes.
-  private async handleNameChange(existingName: string) {
-    await Promise.all([
-      super.updateHandleBars(existingName, this.content.name),
-      super.updateCalculations(existingName, this.content.name),
-    ]);
-    await this.write();
-  }
-
   // Checks if value 'from' can be converted 'to' value.
   private isConversionValid(from: DataType, to: DataType) {
     // Set helpers to avoid dragging 'Operation' object everywhere.
@@ -284,6 +285,20 @@ export class FieldTypeResource extends FileResource<FieldType> {
     }
   }
 
+  /**
+   * When resource name changes.
+   * @param existingName Current resource name.
+   */
+  protected async onNameChange(existingName: string) {
+    await Promise.all([
+      super.updateHandleBars(existingName, this.content.name),
+      super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
+      this.updateCardTypes(existingName),
+    ]);
+    await this.write();
+  }
+
   /**
    * Creates a new field type object. Base class writes the object to disk automatically.
    * @param dataType Type for the new field type.
@@ -310,16 +325,16 @@ export class FieldTypeResource extends FileResource<FieldType> {
    */
   public static fieldDataTypes(): DataType[] {
     return [
-      'shortText',
-      'longText',
-      'number',
-      'integer',
       'boolean',
-      'enum',
-      'list',
       'date',
       'dateTime',
+      'enum',
+      'integer',
+      'list',
+      'longText',
+      'number',
       'person',
+      'shortText',
     ];
   }
 
@@ -372,7 +387,7 @@ export class FieldTypeResource extends FileResource<FieldType> {
   public async rename(newName: ResourceName) {
     const existingName = this.content.name;
     await super.rename(newName);
-    return this.handleNameChange(existingName);
+    return this.onNameChange(existingName);
   }
 
   /**
@@ -389,64 +404,56 @@ export class FieldTypeResource extends FileResource<FieldType> {
     op: Operation<Type>,
   ) {
     const { key } = updateKey;
-    const nameChange = key === 'name';
-    const typeChange = key === 'dataType';
-    const enumChange = key === 'enumValues';
-    const existingName = this.content.name;
-    const existingType = this.content.dataType;
-
-    await super.update(updateKey, op);
 
-    const content = structuredClone(this.content);
-    if (key === 'name') {
-      content.name = super.handleScalar(op) as string;
-    } else if (key === 'dataType') {
-      const toType = op as ChangeOperation<DataType>;
-      if (!FieldTypeResource.fieldDataTypes().includes(toType.to)) {
-        throw new Error(
-          `Cannot change '${key}' to unknown type '${toType.to}'`,
-        );
-      }
-      if (existingType === toType.to) {
-        throw new Error(`'${key}' is already '${toType.to}'`);
-      }
-      if (!this.isConversionValid(content.dataType, toType.to)) {
-        throw new Error(
-          `Cannot change data type from '${content.dataType}' to '${toType.to}'`,
-        );
-      }
-      content.dataType = super.handleScalar(op) as DataType;
-    } else if (key === 'displayName') {
-      content.displayName = super.handleScalar(op) as string;
-    } else if (key === 'enumValues') {
-      if (op.name === 'add' || op.name === 'change' || op.name === 'remove') {
-        const existingValue = this.enumValueExists<EnumDefinition>(
-          op as Operation<EnumDefinition>,
-          content.enumValues as EnumDefinition[],
-        ) as Type;
-        op.target = existingValue ?? op.target;
-      }
-      content.enumValues = super.handleArray(
-        op,
-        key,
-        content.enumValues as Type[],
-      ) as EnumDefinition[];
-    } else if (key === 'description') {
-      content.description = super.handleScalar(op) as string;
+    if (key === 'name' || key === 'description' || key === 'displayName') {
+      await super.update(updateKey, op);
     } else {
-      throw new Error(`Unknown property '${key}' for FieldType`);
-    }
+      const content = structuredClone(this.content);
+      const typeChange = key === 'dataType';
+      const enumChange = key === 'enumValues';
+      const existingType = this.content.dataType;
+      if (key === 'name') {
+        content.name = super.handleScalar(op) as string;
+      } else if (key === 'dataType') {
+        const toType = op as ChangeOperation<DataType>;
+        if (!FieldTypeResource.fieldDataTypes().includes(toType.to)) {
+          throw new Error(
+            `Cannot change '${key}' to unknown type '${toType.to}'`,
+          );
+        }
+        if (existingType === toType.to) {
+          throw new Error(`'${key}' is already '${toType.to}'`);
+        }
+        if (!this.isConversionValid(content.dataType, toType.to)) {
+          throw new Error(
+            `Cannot change data type from '${content.dataType}' to '${toType.to}'`,
+          );
+        }
+        content.dataType = super.handleScalar(op) as DataType;
+      } else if (key === 'enumValues') {
+        if (op.name === 'add' || op.name === 'change' || op.name === 'remove') {
+          const existingValue = this.enumValueExists<EnumDefinition>(
+            op as Operation<EnumDefinition>,
+            content.enumValues as EnumDefinition[],
+          ) as Type;
+          op.target = existingValue ?? op.target;
+        }
+        content.enumValues = super.handleArray(
+          op,
+          key,
+          content.enumValues as Type[],
+        ) as EnumDefinition[];
+      } else {
+        throw new Error(`Unknown property '${key}' for FieldType`);
+      }
 
-    await super.postUpdate(content, updateKey, op);
+      await super.postUpdate(content, updateKey, op);
 
-    if (nameChange) {
-      // Renaming this field type causes that references to its name must be updated.
-      await this.handleNameChange(existingName);
-      await this.updateCardTypes(existingName);
-    } else if (typeChange) {
-      await this.dataTypeChanged();
-    } else if (enumChange && op.name === 'remove') {
-      await this.handleEnumValueReplacements(op);
+      if (typeChange) {
+        await this.dataTypeChanged();
+      } else if (enumChange && op.name === 'remove') {
+        await this.handleEnumValueReplacements(op);
+      }
     }
   }
 

package/src/resources/file-resource.ts

@@ -22,7 +22,8 @@ import type {
 import type { Project } from '../containers/project.js';
 import type { ResourceBaseMetadata } from '../interfaces/resource-interfaces.js';
 import type { ResourceName } from '../utils/resource-utils.js';
-import type { ShowReturnType } from './resource-object.js';
+import type { Operation, ShowReturnType } from './resource-object.js';
+import type { UpdateKey } from '../interfaces/resource-interfaces.js';
 
 /**
  * Base class for file based resources (card types, field types, link types, workflows, ...)
@@ -34,23 +35,35 @@ export abstract class FileResource<
     super(project, name, type);
     this.initialize();
   }
-  // Collects cards that are using the 'cardTypeName'.
-  protected async collectCards(cardTypeName: string) {
-    function filteredCards(cardSource: Card[], cardTypeName: string): Card[] {
-      const cards = cardSource;
-      return cards.filter((card) => card.metadata?.cardType === cardTypeName);
+  /**
+   * Collects cards that match the given filter function.
+   * @param resourceName The resource name to filter by
+   * @param filterFn Function that returns true for cards to include
+   * @returns Array of cards that match the filter
+   */
+  protected async collectCards(
+    resourceName: string,
+    filterFn: (card: Card, resourceName: string) => boolean,
+  ): Promise<Card[]> {
+    function filteredCards(
+      cardSource: Card[],
+      resourceName: string,
+      filterFn: (card: Card, resourceName: string) => boolean,
+    ): Card[] {
+      return cardSource.filter((card) => filterFn(card, resourceName));
     }
 
     // Collect both project cards ...
     const projectCards = filteredCards(
       this.project.cards(this.project.paths.cardRootFolder),
-      cardTypeName,
+      resourceName,
+      filterFn,
     );
     // ... and cards from each template that would be affected.
     const templates = this.project.resources.templates(ResourcesFrom.localOnly);
     const templateCards = templates.map((template) => {
       const templateObject = template.templateObject();
-      return filteredCards(templateObject.cards(), cardTypeName);
+      return filteredCards(templateObject.cards(), resourceName, filterFn);
     });
     // Return all affected cards
     const cards = [projectCards, ...templateCards].reduce(
@@ -59,7 +72,19 @@ export abstract class FileResource<
     );
     return cards;
   }
-  // Updates resource key to a new prefix
+
+  /**
+   * For handling name changes.
+   * @param previousName The previous name before the change
+   */
+  protected abstract onNameChange?(previousName: string): Promise<void>;
+
+  /**
+   * Updates resource key to a new prefix
+   * @param name Resource name
+   * @param prefixes list of prefixes in the project
+   * @returns updated resource name
+   */
   protected updatePrefixInResourceName(name: string, prefixes: string[]) {
     const { identifier, prefix, type } = resourceName(name);
     if (this.moduleResource) {
@@ -70,6 +95,40 @@ export abstract class FileResource<
       : name;
   }
 
+  /**
+   * Updates resource.
+   * @param updateKey Key to modify
+   * @param op Operation to perform on 'key'
+   * @throws if key is unknown.
+   */
+  public async update<Type, K extends string>(
+    updateKey: UpdateKey<K>,
+    op: Operation<Type>,
+  ) {
+    const { key } = updateKey;
+
+    const nameChange = key === 'name';
+    const existingName = this.content.name;
+    await super.update(updateKey, op);
+    const content = structuredClone(this.content);
+
+    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 {
+      throw new Error(`Unknown property '${key}' for folder resource`);
+    }
+
+    await super.postUpdate(content, updateKey, op);
+
+    if (nameChange) {
+      await this.onNameChange?.(existingName);
+    }
+  }
+
   /**
    * Returns the resource metadata content.
    * @returns metadata content

package/src/resources/graph-model-resource.ts

@@ -38,6 +38,11 @@ export class GraphModelResource extends FolderResource<
   GraphModelMetadata,
   GraphModelContent
 > {
+  /**
+   * Creates an instance of GraphModelResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'graphModels');
 
@@ -55,6 +60,7 @@ export class GraphModelResource extends FolderResource<
         join(this.internalFolder, CONTENT_FILES.model),
       ]),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
     ]);
     // Finally, write updated content.
     await this.write();

package/src/resources/graph-view-resource.ts

@@ -39,6 +39,11 @@ export class GraphViewResource extends FolderResource<
   GraphViewMetadata,
   GraphViewContent
 > {
+  /**
+   * Creates instance of GraphViewResource
+   * @param project Project to use
+   * @param name Resource name
+   */
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'graphViews');
 
@@ -56,6 +61,7 @@ export class GraphViewResource extends FolderResource<
         await this.handleBarFile(),
       ]),
       super.updateCalculations(existingName, this.content.name),
+      super.updateCardContentReferences(existingName, this.content.name),
     ]);
     await this.write();
   }

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,8 +37,38 @@ export class LinkTypeResource extends FileResource<LinkType> {
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
   }
 
-  // When resource name changes.
-  private async handleNameChange(existingName: string) {
+  // 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.
+   */
+  protected async onNameChange(existingName: string) {
     const current = this.content;
     const prefixes = this.project.projectPrefixes();
     if (current.sourceCardTypes) {
@@ -49,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();
@@ -76,7 +113,7 @@ export class LinkTypeResource extends FileResource<LinkType> {
   public async rename(newName: ResourceName) {
     const existingName = this.content.name;
     await super.rename(newName);
-    return this.handleNameChange(existingName);
+    return this.onNameChange(existingName);
   }
 
   /**
@@ -89,41 +126,34 @@ export class LinkTypeResource extends FileResource<LinkType> {
     op: Operation<Type>,
   ) {
     const { key } = updateKey;
-    const nameChange = key === 'name';
-    const existingName = this.content.name;
 
-    await super.update(updateKey, op);
-
-    const content = structuredClone(this.content);
-    if (key === 'name') {
-      content.name = super.handleScalar(op) as string;
-    } else if (key === 'destinationCardTypes') {
-      content.destinationCardTypes = super.handleArray(
-        op,
-        key,
-        content.destinationCardTypes as Type[],
-      ) as string[];
-    } else if (key === 'enableLinkDescription') {
-      content.enableLinkDescription = super.handleScalar(op) as boolean;
-    } else if (key === 'inboundDisplayName') {
-      content.inboundDisplayName = super.handleScalar(op) as string;
-    } else if (key === 'outboundDisplayName') {
-      content.outboundDisplayName = super.handleScalar(op) as string;
-    } else if (key === 'sourceCardTypes') {
-      content.sourceCardTypes = super.handleArray(
-        op,
-        key,
-        content.sourceCardTypes as Type[],
-      ) as string[];
+    if (key === 'name' || key === 'displayName' || key === 'description') {
+      await super.update(updateKey, op);
     } else {
-      throw new Error(`Unknown property '${key}' for FieldType`);
-    }
-
-    await super.postUpdate(content, updateKey, op);
-
-    // Renaming this card type causes that references to its name must be updated.
-    if (nameChange) {
-      await this.handleNameChange(existingName);
+      const content = structuredClone(this.content);
+      if (key === 'destinationCardTypes') {
+        content.destinationCardTypes = super.handleArray(
+          op,
+          key,
+          content.destinationCardTypes as Type[],
+        ) as string[];
+      } else if (key === 'enableLinkDescription') {
+        content.enableLinkDescription = super.handleScalar(op) as boolean;
+      } else if (key === 'inboundDisplayName') {
+        content.inboundDisplayName = super.handleScalar(op) as string;
+      } else if (key === 'outboundDisplayName') {
+        content.outboundDisplayName = super.handleScalar(op) as string;
+      } else if (key === 'sourceCardTypes') {
+        content.sourceCardTypes = super.handleArray(
+          op,
+          key,
+          content.sourceCardTypes as Type[],
+        ) as string[];
+      } else {
+        throw new Error(`Unknown property '${key}' for LinkType`);
+      }
+
+      await super.postUpdate(content, updateKey, op);
     }
   }
 

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.