@cyberismo/data-handler 0.0.16 → 0.0.18

package/src/containers/project.ts

@@ -21,6 +21,7 @@ import {
   unlink,
   writeFile,
 } from 'node:fs/promises';
+import { readdirSync } from 'node:fs';
 
 // base class
 import { CardContainer } from './card-container.js';
@@ -59,6 +60,11 @@ import type { Template } from './template.js';
 
 import { ROOT } from '../utils/constants.js';
 
+import {
+  ConfigurationLogger,
+  ConfigurationOperation,
+} from '../utils/configuration-logger.js';
+
 // Re-export this, so that classes that use Project do not need to have separate import.
 export { ResourcesFrom };
 
@@ -83,6 +89,7 @@ export class Project extends CardContainer {
   private resourceWatcher: ContentWatcher | undefined;
   private settings: ProjectConfiguration;
   private validator: Validate;
+  private cachedAllModulePrefixes: string[] = [];
 
   constructor(
     path: string,
@@ -95,7 +102,7 @@ export class Project extends CardContainer {
       join(path, '.cards', 'local', Project.projectConfigFileName),
       options.autoSave ?? true,
     );
-    super(path, settings.cardKeyPrefix, '');
+    super(path, settings.cardKeyPrefix);
     this.settings = settings;
 
     this.logger.info({ path }, 'Initializing project');
@@ -103,16 +110,16 @@ export class Project extends CardContainer {
     this.calculationEngine = new CalculationEngine(this);
     this.projectPaths = new ProjectPaths(path);
     this.resourceHandler = new ResourceHandler(this);
-
-    this.containerName = this.settings.name;
     // todo: implement project validation
     this.validator = Validate.getInstance();
 
     this.logger.info(
-      { name: this.containerName },
+      { name: this.settings.name },
       'Project initialization complete',
     );
 
+    this.refreshAllModulePrefixes();
+
     const ignoreRenameFileChanges = true;
 
     // Watch changes in .cards if there are multiple instances of Project being
@@ -217,12 +224,34 @@ export class Project extends CardContainer {
     }
   }
 
+  // Refreshes the cached list of all module prefixes.
+  // This includes both direct and transient module dependencies.
+  private refreshAllModulePrefixes(): void {
+    const prefixes: string[] = [this.projectPrefix];
+
+    try {
+      const modules = readdirSync(this.paths.modulesFolder, {
+        withFileTypes: true,
+      })
+        .filter((item) => item.isDirectory())
+        .map((item) => item.name);
+
+      prefixes.push(...modules);
+    } catch {
+      // If modules folder doesn't exist, fall back to configuration modules only
+      const moduleNames = this.configuration.modules.map((item) => item.name);
+      prefixes.push(...moduleNames);
+    }
+
+    this.cachedAllModulePrefixes = prefixes;
+  }
+
   // Validates that card's data is valid.
   private async validateCard(card: Card): Promise<string> {
     const invalidCustomData = await this.validator.validateCustomFields(
       this,
       card,
-      this.projectPrefixes(),
+      this.allModulePrefixes(),
     );
     const invalidWorkFlow = await this.validator.validateWorkflowState(
       this,
@@ -256,7 +285,7 @@ export class Project extends CardContainer {
   protected async populateTemplateCards(): Promise<void> {
     try {
       const templateResources = this.resources.templates();
-      const prefixes = this.projectPrefixes();
+      const prefixes = this.allModulePrefixes();
       const loadPromises = templateResources.map(async (template) => {
         try {
           this.validator.validResourceName(
@@ -609,12 +638,30 @@ export class Project extends CardContainer {
   /**
    * Adds a module from project.
    * @param module Module to add
+   * @param skipMigrationLog If true, skip logging to migration log. Used during project creation.
    */
-  public async importModule(module: ModuleSetting) {
+  public async importModule(module: ModuleSetting, skipMigrationLog = false) {
     // Add module as a dependency.
     await this.configuration.addModule(module);
     this.resources.changedModules();
+    this.refreshAllModulePrefixes();
     await this.populateTemplateCards();
+
+    // Log configuration change
+    if (!skipMigrationLog) {
+      await ConfigurationLogger.log(
+        this.basePath,
+        ConfigurationOperation.MODULE_ADD,
+        module.name,
+        {
+          parameters: {
+            location: module.location,
+            branch: module.branch,
+            private: module.private,
+          },
+        },
+      );
+    }
     this.logger.info(`Imported module '${module.name}'`);
   }
 
@@ -831,9 +878,18 @@ export class Project extends CardContainer {
   }
 
   /**
-   * Returns all prefixes used in the project (project's own plus all from imported modules).
+   * Returns all prefixes used in the project.
+   * This includes both direct dependencies and transient dependencies.
    * @returns all prefixes used in the project.
    */
+  public allModulePrefixes(): string[] {
+    return this.cachedAllModulePrefixes;
+  }
+
+  /**
+   * Returns prefixes for direct module dependencies only (from cardsConfig.json).
+   * @returns prefixes for direct module dependencies.
+   */
   public projectPrefixes(): string[] {
     const prefixes: string[] = [this.projectPrefix];
     const moduleNames = this.configuration.modules.map((item) => item.name);
@@ -892,6 +948,17 @@ export class Project extends CardContainer {
     // Finally, remove module from project configuration
     await this.configuration.removeModule(moduleName);
 
+    // Refresh cached module prefixes after removal
+    this.refreshAllModulePrefixes();
+
+    // Log configuration change
+    await ConfigurationLogger.log(
+      this.basePath,
+      ConfigurationOperation.MODULE_REMOVE,
+      moduleName,
+      {},
+    );
+
     this.logger.info(`Removed module '${moduleName}'`);
   }
 
@@ -909,7 +976,7 @@ export class Project extends CardContainer {
    */
   public async show(): Promise<ProjectMetadata> {
     return {
-      name: this.containerName,
+      name: this.settings.name,
       path: this.basePath,
       prefix: this.projectPrefix,
       hubs: this.configuration.hubs,

package/src/containers/template.ts

@@ -65,7 +65,7 @@ export class Template extends CardContainer {
   constructor(project: Project, template: Resource) {
     // Templates might come from modules. Remove module name from template name.
     const templateName = stripExtension(basename(template.name));
-    super(template.path, project.projectPrefix, templateName);
+    super(template.path, project.projectPrefix);
     this.templateName = templateName;
     this.fullTemplateName = template.name;
 
@@ -399,7 +399,7 @@ export class Template extends CardContainer {
     try {
       // todo: to use cache instead of file access
       if (!pathExists(this.templateFolder())) {
-        throw new Error(`Template '${this.containerName}' does not exist`);
+        throw new Error(`Template '${this.templateName}' does not exist`);
       }
       const cardType = this.project.resources
         .byType(cardTypeName, 'cardTypes')
@@ -407,7 +407,7 @@ export class Template extends CardContainer {
 
       if (parentCard && !this.hasTemplateCard(parentCard.key)) {
         throw new Error(
-          `Card '${parentCard.key}' does not exist in template '${this.containerName}'`,
+          `Card '${parentCard.key}' does not exist in template '${this.templateName}'`,
         );
       }
 
@@ -496,7 +496,7 @@ export class Template extends CardContainer {
     const cards = this.cards();
     if (cards.length === 0) {
       throw new Error(
-        `No cards in template '${this.containerName}'. Please add template cards with 'add' command first.`,
+        `No cards in template '${this.templateName}'. Please add template cards with 'add' command first.`,
       );
     }
     return this.doCreateCards(cards, parentCard);

package/src/interfaces/command-options.ts

@@ -56,7 +56,9 @@ export interface ExportCommandOptions extends BaseCommandOptions {
 export type FetchCommandOptions = BaseCommandOptions;
 
 // Options for 'import' command
-export type ImportCommandOptions = BaseCommandOptions;
+export interface ImportCommandOptions extends BaseCommandOptions {
+  skipMigrationLog?: boolean;
+}
 
 // Options for 'move' command
 export type MoveCommandOptions = BaseCommandOptions;

package/src/interfaces/project-interfaces.ts

@@ -47,13 +47,15 @@ export interface CardListContainer {
 }
 // Remember to add all these keys to utils/constants.ts
 export interface PredefinedCardMetadata {
-  title: string;
   cardType: string;
-  workflowState: string;
-  rank: string;
+  labels?: string[];
   lastTransitioned?: string;
   lastUpdated?: string;
+  links: Link[];
+  rank: string;
   templateCardKey?: string;
+  title: string;
+  workflowState: string;
 }
 
 // todo: do we need in the future separation between module-template-cards and local template-cards
@@ -65,8 +67,6 @@ export enum CardLocation {
 
 // Card's index.json file content.
 export interface CardMetadata extends PredefinedCardMetadata {
-  labels?: string[];
-  links: Link[];
   [key: string]: MetadataContent;
 }
 

package/src/project-settings.ts

@@ -265,4 +265,17 @@ export class ProjectConfiguration implements ProjectSettings {
       `Prefix '${newPrefix}' is not valid prefix. Prefix should be in lowercase and contain letters from a to z (max length 10).`,
     );
   }
+
+  /**
+   * Changes project name.
+   * @param newName New project name
+   */
+  public async setProjectName(newName: string) {
+    const isValid = Validate.isValidProjectName(newName);
+    if (isValid) {
+      this.name = newName;
+      return this.save();
+    }
+    throw new Error(`Project name '${newName}' is not valid.`);
+  }
 }

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);
+      }
     }
   }