@cyberismo/data-handler 0.0.6 → 0.0.8

package/src/commands/create.ts

@@ -72,15 +72,20 @@ export class Create {
     },
   ];
 
-  static gitIgnoreContent: string = `.calc\n
-        .asciidoctor\n
-        .vscode\n
-        *.html\n
-        *.pdf\n
-        *.puml\n
-        **/.DS_Store\n
-        *-debug.log\n
-        *-error.log\n`;
+  static gitIgnoreContent: string[] = [
+    '.calc',
+    '.asciidoctor',
+    '.vscode',
+    '*.html',
+    '*.pdf',
+    '*.puml',
+    '**/.DS_Store',
+    '*-debug.log',
+    '*-error.log',
+    '.temp',
+    '.logs',
+    '.cache',
+  ];
 
   /**
    * Adds new cards to a template.
@@ -510,7 +515,10 @@ export class Create {
     });
 
     try {
-      await writeFile(join(projectPath, '.gitignore'), this.gitIgnoreContent);
+      await writeFile(
+        join(projectPath, '.gitignore'),
+        this.gitIgnoreContent.join('\n') + '\n',
+      );
     } catch {
       console.error('Failed to create project');
     }

package/src/commands/export.ts

@@ -196,16 +196,17 @@ export class Export {
     );
 
     let asciiDocContent = '';
-    const projectPath = this.project.basePath;
+    const project = this.project;
     try {
       const { evaluateMacros } = await import('../macros/index.js');
       asciiDocContent = await evaluateMacros(
         cardDetailsResponse.content || '',
         {
           mode: 'static',
-          projectPath,
+          project,
           cardKey: card.key,
         },
+        this.calculateCmd,
       );
     } catch (error) {
       asciiDocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${asciiDocContent}`;

package/src/commands/import.ts

@@ -14,7 +14,10 @@
 import type { CardType } from '../interfaces/resource-interfaces.js';
 import { type Create, Validate } from './index.js';
 import { ModuleManager } from '../module-manager.js';
-import type { ModuleSettingOptions } from '../interfaces/project-interfaces.js';
+import type {
+  Credentials,
+  ModuleSettingOptions,
+} from '../interfaces/project-interfaces.js';
 import type { Project } from '../containers/project.js';
 import { readCsvFile } from '../utils/csv.js';
 import { resourceName } from '../utils/resource-utils.js';
@@ -26,7 +29,7 @@ export class Import {
     private project: Project,
     private createCmd: Create,
   ) {
-    this.moduleManager = new ModuleManager(this.project, this);
+    this.moduleManager = new ModuleManager(this.project);
   }
 
   /**
@@ -131,7 +134,10 @@ export class Import {
     destination?: string,
     options?: ModuleSettingOptions,
   ) {
-    const gitModule = source.startsWith('https');
+    const beforeImportValidateErrors = await Validate.getInstance().validate(
+      this.project.basePath,
+    );
+    const gitModule = source.startsWith('https') || source.startsWith('git@');
     const modulePrefix = gitModule
       ? await this.moduleManager.importGitModule(source, options)
       : await this.moduleManager.importFileModule(source, destination);
@@ -142,28 +148,35 @@ export class Import {
       );
     }
 
-    // Add module as a dependency.
-    return this.project.importModule({
+    const moduleSettings = {
       name: modulePrefix,
       branch: options ? options.branch : undefined,
       private: options ? options.private : undefined,
       location: gitModule ? source : `file:${source}`,
-    });
-  }
+    };
 
-  /**
-   * Updates all imported modules.
-   */
-  public async updateAllModules() {
-    return this.moduleManager.update();
+    // Fetch module dependencies.
+    await this.moduleManager.updateModule(moduleSettings, options?.credentials);
+
+    // Add module as a dependency.
+    await this.project.importModule(moduleSettings);
+
+    // Validate the project after module has been imported
+    const afterImportValidateErrors = await Validate.getInstance().validate(
+      this.project.basePath,
+    );
+    if (afterImportValidateErrors.length > beforeImportValidateErrors.length) {
+      console.error(
+        `There are new validations errors after importing the module. Check the project`,
+      );
+    }
   }
 
   /**
-   * Updates 'moduleName' module from its source.
-   * Modules using gitUrl, are first copied to .temp
-   * @param moduleName module name (prefix) to update
+   * Updates all imported modules.
+   * @param credentials Optional credentials for private modules.
    */
-  public async updateExistingModule(moduleName: string) {
-    await this.moduleManager.importFileModule(moduleName);
+  public async updateAllModules(credentials?: Credentials) {
+    return this.moduleManager.updateModules(credentials);
   }
 }

package/src/commands/index.ts

@@ -15,7 +15,6 @@ import { Calculate } from './calculate.js';
 import { Create } from './create.js';
 import { Edit } from './edit.js';
 import { Export } from './export.js';
-import { ExportSite } from './export-site.js';
 import { Import } from './import.js';
 import { Move } from './move.js';
 import { Remove } from './remove.js';
@@ -30,7 +29,6 @@ export {
   Create,
   Edit,
   Export,
-  ExportSite,
   Import,
   Move,
   Remove,

package/src/commands/remove.ts

@@ -17,6 +17,7 @@ import { join, sep } from 'node:path';
 import { ActionGuard } from '../permissions/action-guard.js';
 import type { Calculate } from './index.js';
 import { deleteDir, deleteFile } from '../utils/file-utils.js';
+import { ModuleManager } from '../module-manager.js';
 import { Project } from '../containers/project.js';
 import type { RemovableResourceTypes } from '../interfaces/project-interfaces.js';
 import { resourceName } from '../utils/resource-utils.js';
@@ -27,10 +28,13 @@ const MODULES_PATH = `${sep}modules${sep}`;
  * Remove command.
  */
 export class Remove {
+  private moduleManager: ModuleManager;
   constructor(
     private project: Project,
     private calculateCmd: Calculate,
-  ) {}
+  ) {
+    this.moduleManager = new ModuleManager(this.project);
+  }
 
   // True, if resource is a project resource
   private projectResource(type: RemovableResourceTypes): boolean {
@@ -182,16 +186,6 @@ export class Remove {
     await this.project.updateCardMetadataKey(sourceCardKey, 'links', newLinks);
   }
 
-  // Removes modules from project
-  private async removeModule(moduleName: string) {
-    const module = await this.project.module(moduleName);
-    if (!module) {
-      throw new Error(`Module '${moduleName}' not found`);
-    }
-    await deleteDir(module.path);
-    await this.project.removeModule(moduleName);
-  }
-
   /**
    * Removes either attachment, card, imported module, link or resource from project.
    * @param type Type of resource
@@ -236,7 +230,8 @@ export class Remove {
       else if (type == 'card') return this.removeCard(targetName);
       else if (type == 'link')
         return this.removeLink(targetName, rest[0], rest[1], rest.at(2));
-      else if (type == 'module') return this.removeModule(targetName);
+      else if (type == 'module')
+        return this.moduleManager.removeModule(targetName);
       else if (type == 'label') return this.removeLabel(targetName, rest[0]);
     }
     throw new Error(`Unknown resource type '${type}'`);

package/src/commands/show.ts

@@ -29,6 +29,7 @@ import type {
   ProjectFetchCardDetails,
   ProjectMetadata,
   Resource,
+  CardLocation,
 } from '../interfaces/project-interfaces.js';
 import type {
   CardType,
@@ -43,6 +44,7 @@ import { UserPreferences } from '../utils/user-preferences.js';
 
 import ReportMacro from '../macros/report/index.js';
 import TaskQueue from '../macros/task-queue.js';
+import type { Calculate } from './calculate.js';
 
 /**
  * Show command.
@@ -52,7 +54,10 @@ export class Show {
     string,
     (from?: ResourcesFrom) => Promise<Resource[]>
   >;
-  constructor(private project: Project) {
+  constructor(
+    private project: Project,
+    private calculate: Calculate,
+  ) {
     this.resourceFunction = new Map([
       ['cardTypes', this.project.cardTypes.bind(this.project)],
       ['fieldTypes', this.project.fieldTypes.bind(this.project)],
@@ -250,10 +255,13 @@ export class Show {
 
   /**
    * Shows all cards (either template or project cards) from a project.
+   * @param cardsFrom - The location from which to look for cards. Either from the project, templates or both.
    * @returns cards list array
    */
-  public async showCards(): Promise<CardListContainer[]> {
-    return this.project.listCards();
+  public async showCards(
+    cardsFrom?: CardLocation,
+  ): Promise<CardListContainer[]> {
+    return this.project.listCards(cardsFrom);
   }
 
   /**
@@ -351,10 +359,10 @@ export class Show {
       throw new Error(`Report '${reportName}' does not exist`);
     }
 
-    const reportMacro = new ReportMacro(new TaskQueue());
+    const reportMacro = new ReportMacro(new TaskQueue(), this.calculate);
     const result = await reportMacro.handleInject(
       {
-        projectPath: this.project.basePath,
+        project: this.project,
         cardKey: cardKey,
         mode: 'static',
       },

package/src/commands/validate.ts

@@ -20,7 +20,7 @@ import { readdir } from 'node:fs/promises';
 // dependencies
 import { Validator as JSONValidator, type Schema } from 'jsonschema';
 import { Validator as DirectoryValidator } from 'directory-schema-validator';
-import { parentSchema, schemas } from '@cyberismo/resources';
+import { parentSchema, schemas } from '@cyberismo/assets';
 
 // data-handler
 import type {
@@ -52,7 +52,7 @@ const SHORT_TEXT_MAX_LENGTH = 80;
 
 import * as EmailValidator from 'email-validator';
 import { evaluateMacros } from '../macros/index.js';
-
+import { Calculate } from './calculate.js';
 const baseDir = dirname(fileURLToPath(import.meta.url));
 const subFoldersToValidate = ['.cards', 'cardRoot'];
 
@@ -111,7 +111,7 @@ export class Validate {
   // Loads child schemas to validator.
   private addChildSchemas() {
     schemas.forEach((schema) => {
-      this.validator.addSchema(schema, schema.$id);
+      this.validator.addSchema(schema as Schema, schema.$id);
     });
   }
 
@@ -355,7 +355,7 @@ export class Validate {
       }
       const result = this.validator.validate(content, schema);
       for (const error of result.errors) {
-        const msg = `Validation error from '${fullPath}': ${error.message}.`;
+        const msg = `Validation error from '${fullPath}': ${error.property} ${error.message}.`;
         messages.push(msg);
       }
     }
@@ -547,6 +547,7 @@ export class Validate {
       } else {
         const errorMsg: string[] = [];
         const project = new Project(projectPath);
+        const calculate = new Calculate(project);
 
         // Then, validate that each 'contentSchema' children as well.
         const result = await this.readAndValidateContentFiles(
@@ -590,11 +591,15 @@ export class Validate {
 
           // Validate macros in content
           if (card.content) {
-            await evaluateMacros(card.content, {
-              mode: 'validate',
-              projectPath,
-              cardKey: card.key,
-            });
+            await evaluateMacros(
+              card.content,
+              {
+                mode: 'validate',
+                project,
+                cardKey: card.key,
+              },
+              calculate,
+            );
           }
         }
         if (errorMsg.length) {
@@ -699,41 +704,6 @@ export class Validate {
     return contentValidated && lengthValidated;
   }
 
-  /**
-   * Validate schema that matches schemaId from path.
-   * @param projectPath path to schema
-   * @param schemaId schema's id
-   * @returns string containing all validation errors
-   * @todo - unused; remove?
-   */
-  public async validateSchema(
-    projectPath: string,
-    schemaId: string,
-  ): Promise<string> {
-    const validationErrors: string[] = [];
-    if (!schemaId.startsWith('/')) {
-      schemaId = '/' + schemaId;
-    }
-    const activeJsonSchema = this.validator.schemas[schemaId];
-    if (activeJsonSchema === undefined) {
-      throw new Error(`Unknown schema '${schemaId}'`);
-    } else {
-      let contentFile = '';
-      try {
-        contentFile = await readJsonFile(projectPath);
-      } catch {
-        throw new Error(`Path is not valid ${projectPath}`);
-      }
-
-      const result = this.validator.validate(contentFile, activeJsonSchema);
-      for (const error of result.errors) {
-        const msg = `Schema '${schemaId}' validation Error: ${error.message}\n`;
-        validationErrors.push(msg);
-      }
-    }
-    return validationErrors.join('\n');
-  }
-
   /**
    * Validates that card's custom fields are according to schema and have correct data in them.
    * @param project currently used Project

package/src/containers/project/project-content-watcher.ts

@@ -0,0 +1,65 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program is distributed in the hope that it
+  will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Affero General Public License for more details.
+  You should have received a copy of the GNU Affero General Public
+  License along with this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+
+import { watch } from 'node:fs';
+
+import { getChildLogger } from '../../utils/log-utils.js';
+
+/**
+ * Class that starts watching certain path for changes.
+ * Generally we are not interested for file renames, as they are handled
+ * through rename command, thus there is an option to ignore those.
+ */
+export class ContentWatcher {
+  private watcher;
+  private abortController = new AbortController();
+
+  constructor(
+    ignoreRenames: boolean,
+    private watchPath: string,
+    callback: (fileName: string) => void,
+  ) {
+    this.watcher = watch(
+      this.watchPath,
+      {
+        persistent: true,
+        recursive: true,
+        signal: this.abortController.signal,
+      },
+      (eventType, filename) => {
+        if ((ignoreRenames && eventType === 'rename') || !filename) {
+          return;
+        }
+        callback(filename);
+      },
+    ).on('error', (error) => {
+      ContentWatcher.logger.error(error, 'Watch error');
+      this.close();
+    });
+    this.watcher.unref();
+  }
+
+  // Returns instance of logger.
+  private static get logger() {
+    return getChildLogger({
+      module: 'contentWatcher',
+    });
+  }
+
+  /**
+   * Close content watcher. Removes watcher.
+   */
+  public close() {
+    this.abortController.abort();
+  }
+}

package/src/containers/project/project-paths.ts

@@ -81,7 +81,7 @@ export class ProjectPaths {
   }
 
   public get logPath(): string {
-    return join(this.resourcesFolder, 'dh.log');
+    return join(this.path, '.logs', 'cyberismo_data-handler.log');
   }
 
   public get modulesFolder(): string {

package/src/containers/project/resource-collector.ts

@@ -55,17 +55,31 @@ class ResourceCollection {
    * @param type Resource array type to return.
    * @returns resource array of a give type.
    */
-  public resourceArray(type: ResourceFolderType): Resource[] {
-    if (type === 'calculations') return this.calculations;
-    if (type === 'cardTypes') return this.cardTypes;
-    if (type === 'fieldTypes') return this.fieldTypes;
-    if (type === 'graphViews') return this.graphViews;
-    if (type === 'graphModels') return this.graphModels;
-    if (type === 'linkTypes') return this.linkTypes;
-    if (type === 'reports') return this.reports;
-    if (type === 'templates') return this.templates;
-    if (type === 'workflows') return this.workflows;
-    throw new Error(`Unknown resource type '${type}'`);
+  public resourceArray(
+    type: ResourceFolderType,
+    moduleName?: string,
+  ): Resource[] {
+    let resources: Resource[] = [];
+
+    if (type === 'calculations') resources = this.calculations;
+    else if (type === 'cardTypes') resources = this.cardTypes;
+    else if (type === 'fieldTypes') resources = this.fieldTypes;
+    else if (type === 'graphViews') resources = this.graphViews;
+    else if (type === 'graphModels') resources = this.graphModels;
+    else if (type === 'linkTypes') resources = this.linkTypes;
+    else if (type === 'reports') resources = this.reports;
+    else if (type === 'templates') resources = this.templates;
+    else if (type === 'workflows') resources = this.workflows;
+    else throw new Error(`Unknown resource type '${type}'`);
+
+    if (moduleName) {
+      resources = resources.filter((item) => {
+        const { prefix } = resourceName(item.name);
+        return moduleName === prefix;
+      });
+    }
+
+    return resources;
   }
 }
 
@@ -162,6 +176,7 @@ export class ResourceCollector {
   // Adds a resource type from all modules.
   private async addResourcesFromModules(
     type: ResourceFolderType,
+    moduleName?: string,
   ): Promise<Resource[]> {
     try {
       // 'modules' is a bit special; it is collected separately from actual resources.
@@ -174,7 +189,7 @@ export class ResourceCollector {
       }
 
       await this.addModuleResources();
-      return this.modules.resourceArray(type);
+      return this.modules.resourceArray(type, moduleName);
     } catch {
       return [];
     }
@@ -261,10 +276,14 @@ export class ResourceCollector {
   /**
    * Collect specific resource from modules.
    * @param type Type of resource (e.g. 'templates').
+   * @param moduleName Name of the module to collect resources from
    * @returns array of collected items.
    */
-  public async collectResourcesFromModules(type: ResourceFolderType) {
-    return (await this.addResourcesFromModules(type)).map((item) =>
+  public async collectResourcesFromModules(
+    type: ResourceFolderType,
+    moduleName?: string,
+  ) {
+    return (await this.addResourcesFromModules(type, moduleName)).map((item) =>
       stripExtension(item.name),
     );
   }