@cyberismo/data-handler 0.0.16 → 0.0.18

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/resource-object.ts

@@ -44,6 +44,11 @@ import type {
 } from '../interfaces/resource-interfaces.js';
 import type { Validate } from '../commands/validate.js';
 
+import {
+  ConfigurationLogger,
+  ConfigurationOperation,
+} from '../utils/configuration-logger.js';
+
 // Possible operations to perform when doing "update"
 export type UpdateOperations = 'add' | 'change' | 'rank' | 'remove';
 
@@ -308,6 +313,9 @@ export abstract class ResourceObject<
 
     const resourceString = resourceNameToString(this.resourceName);
     this.project.resources.add(resourceString, this);
+
+    // Log resource creation to migration log
+    await this.logResourceOperation('create');
   }
 
   /**
@@ -408,6 +416,56 @@ export abstract class ResourceObject<
     }
   }
 
+  // Log details
+  protected async logResourceOperation<Type>(
+    operationType: 'create' | 'delete' | 'update' | 'rename',
+    op?: Operation<Type>,
+    key?: string,
+  ): Promise<void> {
+    let configOperation: ConfigurationOperation;
+    const target = resourceNameToString(this.resourceName);
+    const parameters: Record<string, unknown> = { type: this.type };
+
+    switch (operationType) {
+      case 'create':
+        configOperation = ConfigurationOperation.RESOURCE_CREATE;
+        break;
+      case 'delete':
+        configOperation = ConfigurationOperation.RESOURCE_DELETE;
+        break;
+      case 'update':
+        configOperation = ConfigurationOperation.RESOURCE_UPDATE;
+        if (op) {
+          parameters.operation = op.name;
+        }
+        if (key) {
+          parameters.key = key;
+        }
+        break;
+      case 'rename':
+        configOperation = ConfigurationOperation.RESOURCE_RENAME;
+        if (op && op.name === 'change') {
+          const changeOp = op as ChangeOperation<string>;
+          parameters.oldName = changeOp.target;
+          parameters.newName = changeOp.to;
+        }
+        break;
+      default:
+        throw new Error(`Unknown operation type: ${operationType}`);
+    }
+
+    await ConfigurationLogger.log(
+      this.project.basePath,
+      configOperation,
+      target,
+      {
+        parameters,
+      },
+    );
+
+    this.logger.info(`Configuration: ${configOperation} - ${target}`);
+  }
+
   /**
    * Called after inherited class has finished 'update' operation.
    * @param content New content for resource
@@ -449,6 +507,9 @@ export abstract class ResourceObject<
 
     this.content = content;
     await this.write();
+
+    // Log resource update to migration log
+    await this.logResourceOperation('update', op, updateKey.key);
   }
 
   /**
@@ -496,9 +557,17 @@ export abstract class ResourceObject<
 
     this.fileName = newFilename;
     this.content.name = resourceNameToString(newName);
+    const newNameString = this.content.name;
     this.resourceName = newName;
 
-    this.project.resources.rename(oldName, this.content.name);
+    this.project.resources.rename(oldName, newNameString);
+
+    // Log resource rename to migration log
+    await this.logResourceOperation('rename', {
+      name: 'change',
+      target: oldName,
+      to: newNameString,
+    } as ChangeOperation<string>);
   }
 
   /**
@@ -712,6 +781,9 @@ export abstract class ResourceObject<
     await deleteFile(this.fileName);
     this.project.resources.remove(resourceNameToString(this.resourceName));
     this.fileName = '';
+
+    // Log resource deletion to migration log
+    await this.logResourceOperation('delete');
   }
 
   /**

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

package/src/resources/workflow-resource.ts

@@ -56,10 +56,11 @@ export class WorkflowResource extends FileResource<Workflow> {
   }
 
   // When resource name changes.
-  private async handleNameChange(existingName: string) {
+  protected async onNameChange(existingName: string) {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name),
       super.updateCalculations(existingName, this.content.name),
+      this.updateCardTypes(existingName),
     ]);
     // Finally, write updated content.
     await this.write();
@@ -193,12 +194,15 @@ export class WorkflowResource extends FileResource<Workflow> {
       to: this.content.name,
     } as ChangeOperation<string>;
     for (const cardType of cardTypes) {
-      await cardType.update(
-        {
-          key: 'workflow',
-        },
-        op,
-      );
+      // Only update card types that use this workflow
+      if (cardType.data?.workflow === oldName) {
+        await cardType.update(
+          {
+            key: 'workflow',
+          },
+          op,
+        );
+      }
     }
   }
 
@@ -225,7 +229,7 @@ export class WorkflowResource extends FileResource<Workflow> {
   public async rename(newName: ResourceName) {
     const existingName = this.content.name;
     await super.rename(newName);
-    return this.handleNameChange(existingName);
+    return this.onNameChange(existingName);
   }
 
   /**
@@ -239,101 +243,106 @@ export class WorkflowResource extends FileResource<Workflow> {
     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) as Workflow;
-
-    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,
-        key,
-        content.states as Type[],
-      ) as WorkflowState[];
-    } else if (key === 'transitions') {
-      content.transitions = super.handleArray(
-        op,
-        key,
-        content.transitions as WorkflowTransition[] as Type[],
-      ) as WorkflowTransition[];
+    if (key === 'name' || key === 'displayName' || key === 'description') {
+      await super.update(updateKey, op);
     } else {
-      throw new Error(`Unknown property '${key}' for Workflow`);
-    }
-
-    // If workflow transition is removed, then above call to 'handleArray' is all that is needed.
-
-    if (key === 'transitions' && op.name === 'change') {
-      // If workflow transition is changed, update to full object and change the content.
-      let changeOp: ChangeOperation<WorkflowTransition>;
-      if (this.isStringOperation(op)) {
-        const targetTransition = (this.content as Workflow).transitions.find(
-          (transition) => transition.name === op.target,
-        )!;
-        changeOp = {
-          name: 'change',
-          target: targetTransition as WorkflowTransition,
-          to: {
-            name: op.to,
-            toState: targetTransition.toState,
-            fromState: targetTransition.fromState,
-          },
-        };
-      } else {
-        changeOp = op as ChangeOperation<WorkflowTransition>;
+      const content = structuredClone(this.content) as Workflow;
+
+      // Validate state change operations before processing
+      if (key === 'states' && op.name === 'change') {
+        const changeOp = op as ChangeOperation<WorkflowState>;
+        if (
+          changeOp.to.name === undefined ||
+          changeOp.to.category === undefined
+        ) {
+          const stateName =
+            changeOp.target['name' as keyof typeof changeOp.target] ||
+            changeOp.target;
+          throw new Error(
+            `Cannot change state '${stateName}' for workflow '${this.content.name}'.
+         Updated state must have 'name' and 'category' properties.`,
+          );
+        }
       }
-      const newTransition = await this.transitionObject(changeOp);
-      content.transitions = content.transitions.map((item) =>
-        item.name == newTransition.name ? newTransition : item,
-      );
-    }
 
-    if (key === 'states' && op.name === 'remove') {
-      // If workflow state is removed, remove all transitions "to" and "from" this state.
-      let removeOp: RemoveOperation<WorkflowState>;
-      if (this.isStringOperation(op)) {
-        const toBeRemovedState = this.content.states.find(
-          (state) => state.name === op.target,
-        );
-        removeOp = {
-          name: 'remove',
-          target: toBeRemovedState as WorkflowState,
-        };
+      if (key === 'states') {
+        content.states = super.handleArray(
+          op,
+          key,
+          content.states as Type[],
+        ) as WorkflowState[];
+      } else if (key === 'transitions') {
+        content.transitions = super.handleArray(
+          op,
+          key,
+          content.transitions as WorkflowTransition[] as Type[],
+        ) as WorkflowTransition[];
       } else {
-        removeOp = op as RemoveOperation<WorkflowState>;
+        throw new Error(`Unknown property '${key}' for Workflow`);
       }
-      await this.handleStateRemoval(removeOp);
-    } else if (key === 'states' && op.name === 'change') {
-      // If workflow state is renamed, replace all transitions "to" and "from" the old state with new state.
-      let changeOp: ChangeOperation<WorkflowState>;
-      if (this.isStringOperation(op)) {
-        const toBeChangedState = this.content.states.find(
-          (state) => state.name === op.target,
+
+      // If workflow transition is removed, then above call to 'handleArray' is all that is needed.
+
+      if (key === 'transitions' && op.name === 'change') {
+        // If workflow transition is changed, update to full object and change the content.
+        let changeOp: ChangeOperation<WorkflowTransition>;
+        if (this.isStringOperation(op)) {
+          const targetTransition = (this.content as Workflow).transitions.find(
+            (transition) => transition.name === op.target,
+          )!;
+          changeOp = {
+            name: 'change',
+            target: targetTransition as WorkflowTransition,
+            to: {
+              name: op.to,
+              toState: targetTransition.toState,
+              fromState: targetTransition.fromState,
+            },
+          };
+        } else {
+          changeOp = op as ChangeOperation<WorkflowTransition>;
+        }
+        const newTransition = await this.transitionObject(changeOp);
+        content.transitions = content.transitions.map((item) =>
+          item.name == newTransition.name ? newTransition : item,
         );
-        changeOp = {
-          name: 'change',
-          target: toBeChangedState as WorkflowState,
-          to: { name: op.to },
-        };
-      } else {
-        changeOp = op as ChangeOperation<WorkflowState>;
       }
-      await this.handleStateChange(changeOp);
-    }
 
-    await super.postUpdate(content, updateKey, op);
+      if (key === 'states' && op.name === 'remove') {
+        // If workflow state is removed, remove all transitions "to" and "from" this state.
+        let removeOp: RemoveOperation<WorkflowState>;
+        if (this.isStringOperation(op)) {
+          const toBeRemovedState = this.content.states.find(
+            (state) => state.name === op.target,
+          );
+          removeOp = {
+            name: 'remove',
+            target: toBeRemovedState as WorkflowState,
+          };
+        } else {
+          removeOp = op as RemoveOperation<WorkflowState>;
+        }
+        await this.handleStateRemoval(removeOp);
+      } else if (key === 'states' && op.name === 'change') {
+        // If workflow state is renamed, replace all transitions "to" and "from" the old state with new state.
+        let changeOp: ChangeOperation<WorkflowState>;
+        if (this.isStringOperation(op)) {
+          const toBeChangedState = this.content.states.find(
+            (state) => state.name === op.target,
+          );
+          changeOp = {
+            name: 'change',
+            target: toBeChangedState as WorkflowState,
+            to: { name: op.to },
+          };
+        } else {
+          changeOp = op as ChangeOperation<WorkflowState>;
+        }
+        await this.handleStateChange(changeOp);
+      }
 
-    // Renaming this workflow causes that references to its name must be updated.
-    if (nameChange) {
-      await this.handleNameChange(existingName);
-      await this.updateCardTypes(existingName);
+      await super.postUpdate(content, updateKey, op);
     }
   }