@cyberismo/data-handler 0.0.17 → 0.0.18

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

@@ -102,38 +102,6 @@ export class CardTypeResource extends FileResource<CardType> {
     }
   }
 
-  // When resource name changes.
-  private async handleNameChange(existingName: string) {
-    const current = this.content;
-    const prefixes = this.project.projectPrefixes();
-    if (current.customFields) {
-      current.customFields.map(
-        (field) =>
-          (field.name = this.updatePrefixInResourceName(field.name, prefixes)),
-      );
-    }
-    if (current.alwaysVisibleFields) {
-      current.alwaysVisibleFields = current.alwaysVisibleFields.map((item) =>
-        this.updatePrefixInResourceName(item, prefixes),
-      );
-    }
-    if (current.optionallyVisibleFields) {
-      current.optionallyVisibleFields = current.optionallyVisibleFields.map(
-        (item) => this.updatePrefixInResourceName(item, prefixes),
-      );
-    }
-    current.workflow = this.updatePrefixInResourceName(
-      current.workflow,
-      prefixes,
-    );
-    await Promise.all([
-      super.updateHandleBars(existingName, this.content.name),
-      super.updateCalculations(existingName, this.content.name),
-    ]);
-    // Finally, write updated content.
-    await this.write();
-  }
-
   // When a field is removed, remove it from all affected cards.
   private async handleRemoveField(cards: Card[], item: CustomField) {
     for (const card of cards) {
@@ -189,15 +157,6 @@ export class CardTypeResource extends FileResource<CardType> {
     );
   }
 
-  // Remove value from array.
-  // todo: make it as generic and move to utils
-  private removeValue(array: string[], value: string) {
-    const index = array.findIndex((element) => element === value);
-    if (index !== -1) {
-      array.splice(index, 1);
-    }
-  }
-
   // Return link types that use this card type.
   private relevantLinkTypes(): string[] {
     const resourceName = resourceNameToString(this.resourceName);
@@ -220,6 +179,15 @@ export class CardTypeResource extends FileResource<CardType> {
     return references;
   }
 
+  // Remove value from array.
+  // todo: make it as generic and move to utils
+  private removeValue(array: string[], value: string) {
+    const index = array.findIndex((element) => element === value);
+    if (index !== -1) {
+      array.splice(index, 1);
+    }
+  }
+
   // If value from 'customFields' is removed, remove it also from 'optionallyVisible' and 'alwaysVisible' arrays.
   private removeValueFromOtherArrays<Type>(
     op: Operation<Type>,
@@ -246,21 +214,8 @@ export class CardTypeResource extends FileResource<CardType> {
         if (item.isCalculated === undefined) {
           item.isCalculated = false;
         }
-        // Fetch "displayName" from field type if it is missing.
-        if (item.name && item.displayName === undefined) {
-          const fieldType = this.project.resources.byType(
-            item.name,
-            'fieldTypes',
-          );
-          const fieldTypeContent = fieldType.data;
-          if (fieldTypeContent) {
-            item.displayName = fieldTypeContent.displayName;
-          }
-        } else if (!item.name) {
-          console.error(
-            `Custom field '${item.name}' is missing mandatory 'name' in card type '${content.name}'`,
-          );
-          return undefined;
+        if (!item.name) {
+          continue;
         }
       }
     } else {
@@ -400,6 +355,42 @@ export class CardTypeResource extends FileResource<CardType> {
     }
   }
 
+  /**
+   * 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.customFields) {
+      current.customFields.map(
+        (field) =>
+          (field.name = this.updatePrefixInResourceName(field.name, prefixes)),
+      );
+    }
+    if (current.alwaysVisibleFields) {
+      current.alwaysVisibleFields = current.alwaysVisibleFields.map((item) =>
+        this.updatePrefixInResourceName(item, prefixes),
+      );
+    }
+    if (current.optionallyVisibleFields) {
+      current.optionallyVisibleFields = current.optionallyVisibleFields.map(
+        (item) => this.updatePrefixInResourceName(item, prefixes),
+      );
+    }
+    current.workflow = this.updatePrefixInResourceName(
+      current.workflow,
+      prefixes,
+    );
+    await Promise.all([
+      super.updateHandleBars(existingName, this.content.name),
+      super.updateCalculations(existingName, this.content.name),
+      this.updateLinkTypes(existingName),
+    ]);
+
+    await this.write();
+  }
+
   /**
    * Creates a new card type object. Base class writes the object to disk automatically.
    * @param workflowName Workflow name that this card type uses.
@@ -438,7 +429,7 @@ export class CardTypeResource extends FileResource<CardType> {
   public async rename(newName: ResourceName) {
     const existingName = this.content.name;
     await super.rename(newName);
-    return this.handleNameChange(existingName);
+    return this.onNameChange(existingName);
   }
 
   /**
@@ -451,60 +442,51 @@ export class CardTypeResource extends FileResource<CardType> {
     op: Operation<Type>,
   ) {
     const { key } = updateKey;
-    const nameChange = key === 'name';
-    const customFieldsChange = key === 'customFields';
-    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 === 'alwaysVisibleFields') {
-      await this.validateFieldType(key, op);
-      content.alwaysVisibleFields = super.handleArray(
-        op,
-        key,
-        content.alwaysVisibleFields as Type[],
-      ) as string[];
-    } else if (key === 'optionallyVisibleFields') {
-      await this.validateFieldType(key, op);
-      content.optionallyVisibleFields = super.handleArray(
-        op,
-        key,
-        content.optionallyVisibleFields as Type[],
-      ) as string[];
-    } else if (key === 'workflow') {
-      const changeOp = op as ChangeOperation<string>;
-      const stateMapping = changeOp.mappingTable?.stateMapping || {};
-      content.workflow = super.handleScalar(op) as string;
-      if (Object.keys(stateMapping).length > 0) {
-        await this.handleWorkflowChange(stateMapping, changeOp);
+
+    if (key === 'name' || key === 'description' || key === 'displayName') {
+      await super.update(updateKey, op);
+    } else {
+      const content = structuredClone(this.content);
+      const customFieldsChange = key === 'customFields';
+      if (key === 'alwaysVisibleFields') {
+        await this.validateFieldType(key, op);
+        content.alwaysVisibleFields = super.handleArray(
+          op,
+          key,
+          content.alwaysVisibleFields as Type[],
+        ) as string[];
+      } else if (key === 'optionallyVisibleFields') {
+        await this.validateFieldType(key, op);
+        content.optionallyVisibleFields = super.handleArray(
+          op,
+          key,
+          content.optionallyVisibleFields as Type[],
+        ) as string[];
+      } else if (key === 'workflow') {
+        const changeOp = op as ChangeOperation<string>;
+        const stateMapping = changeOp.mappingTable?.stateMapping || {};
+        content.workflow = super.handleScalar(op) as string;
+        if (Object.keys(stateMapping).length > 0) {
+          await this.handleWorkflowChange(stateMapping, changeOp);
+        }
+      } else if (key === 'customFields') {
+        await this.validateFieldType(key, op);
+        content.customFields = super.handleArray(
+          op,
+          key,
+          content.customFields as Type[],
+        ) as CustomField[];
+        if (op.name === 'remove') {
+          this.removeValueFromOtherArrays(op, content);
+        }
+      } else {
+        throw new Error(`Unknown property '${key}' for CardType`);
       }
-    } else if (key === 'customFields') {
-      await this.validateFieldType(key, op);
-      content.customFields = super.handleArray(
-        op,
-        key,
-        content.customFields as Type[],
-      ) as CustomField[];
-      if (op.name === 'remove') {
-        this.removeValueFromOtherArrays(op, content);
+      await super.postUpdate(content, updateKey, op);
+
+      if (customFieldsChange) {
+        return this.handleCustomFieldsChange(op as ChangeOperation<string>);
       }
-    } else if (key === 'description') {
-      content.description = super.handleScalar(op) as string;
-    } else if (key === 'displayName') {
-      content.displayName = super.handleScalar(op) as string;
-    } else {
-      throw new Error(`Unknown property '${key}' for CardType`);
-    }
-    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);
-      await this.updateLinkTypes(existingName);
-    } else if (customFieldsChange) {
-      return this.handleCustomFieldsChange(op as ChangeOperation<string>);
     }
   }
 

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

@@ -223,15 +223,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 +275,19 @@ 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),
+      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.
@@ -372,7 +376,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 +393,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, ...)
@@ -59,6 +60,13 @@ export abstract class FileResource<
     );
     return cards;
   }
+
+  /**
+   * 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
   protected updatePrefixInResourceName(name: string, prefixes: string[]) {
     const { identifier, prefix, type } = resourceName(name);
@@ -70,6 +78,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/link-type-resource.ts

@@ -32,8 +32,11 @@ export class LinkTypeResource extends FileResource<LinkType> {
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
   }
 
-  // When resource name changes.
-  private async handleNameChange(existingName: string) {
+  /**
+   * 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) {
@@ -76,7 +79,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 +92,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/template-resource.ts

@@ -140,35 +140,15 @@ export class TemplateResource extends FolderResource<TemplateMetadata, never> {
     updateKey: UpdateKey<K>,
     op: Operation<Type>,
   ) {
-    const { key } = updateKey;
-    const nameChange = key === 'name';
-    const existingName = this.content.name;
-
-    // Only call super.update for keys that base class supports
-    if (key === 'name' || key === 'displayName' || key === 'description') {
-      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 if (key === 'category') {
+    if (updateKey.key === 'category') {
+      const content = structuredClone(this.content);
       content.category = super.handleScalar(op) as string;
-    } else {
-      throw new Error(`Unknown property '${key}' for Template`);
-    }
 
-    await super.postUpdate(content, updateKey, op);
-
-    // Renaming this template causes that references to its name must be updated.
-    if (nameChange) {
-      await this.onNameChange(existingName);
+      await super.postUpdate(content, updateKey, op);
+      return;
     }
+
+    await super.update(updateKey, op);
   }
 
   /**