@cyberismo/data-handler 0.0.8 → 0.0.9

package/src/commands/edit.ts

@@ -16,18 +16,23 @@ import { homedir } from 'node:os';
 import { spawnSync } from 'node:child_process';
 
 import { ActionGuard } from '../permissions/action-guard.js';
-import type { Calculate } from './index.js';
-import type { MetadataContent } from '../interfaces/project-interfaces.js';
+import type {
+  MetadataContent,
+  ResourceFolderType,
+} from '../interfaces/project-interfaces.js';
 import { Project } from '../containers/project.js';
 import { UserPreferences } from '../utils/user-preferences.js';
+import {
+  type ResourceName,
+  resourceNameToString,
+} from '../utils/resource-utils.js';
+import { FolderResource } from '../resources/folder-resource.js';
 
 export class Edit {
   private project: Project;
-  private calculateCmd: Calculate;
 
-  constructor(project: Project, calculateCmd: Calculate) {
+  constructor(project: Project) {
     this.project = project;
-    this.calculateCmd = calculateCmd;
   }
 
   /**
@@ -83,13 +88,16 @@ export class Edit {
    * @param changedContent New content for the card.
    */
   public async editCardContent(cardKey: string, changedContent: string) {
-    // Determine the card path
+    const isTemplateCard = await this.project.isTemplateCard(cardKey);
+    if (isTemplateCard) {
+      return this.project.updateCardContent(cardKey, changedContent);
+    }
     const cardPath = this.project.pathToCard(cardKey);
     if (!cardPath) {
       throw new Error(`Card '${cardKey}' does not exist in the project`);
     }
 
-    const actionGuard = new ActionGuard(this.calculateCmd);
+    const actionGuard = new ActionGuard(this.project.calculationEngine);
     await actionGuard.checkPermission('editContent', cardKey);
 
     await this.project.updateCardContent(cardKey, changedContent);
@@ -106,18 +114,52 @@ export class Edit {
     changedKey: string,
     newValue: MetadataContent,
   ) {
+    if (!changedKey) {
+      throw new Error(`Changed key cannot be empty`);
+    }
+    const isTemplateCard = await this.project.isTemplateCard(cardKey);
+    if (isTemplateCard) {
+      return this.project.updateCardMetadataKey(cardKey, changedKey, newValue);
+    }
+
     // Determine the card path
     const cardPath = this.project.pathToCard(cardKey);
     if (!cardPath) {
       throw new Error(`Card '${cardKey}' does not exist in the project`);
     }
-    if (!changedKey) {
-      throw new Error(`Changed key cannot be empty`);
-    }
 
     // check for editing rights
-    const actionGuard = new ActionGuard(this.calculateCmd);
+    const actionGuard = new ActionGuard(this.project.calculationEngine);
     await actionGuard.checkPermission('editField', cardKey, changedKey);
     await this.project.updateCardMetadataKey(cardKey, changedKey, newValue);
   }
+
+  /**
+   * Update a file of a folder resource. Cannot be used to create a new file.
+   * @param resourceName The name of the resource to update.
+   * @param fileName The name of the file to update.
+   * @param changedContent The new content for the file.
+   */
+  public async editResourceContent(
+    resourceName: ResourceName,
+    fileName: string,
+    changedContent: string,
+  ) {
+    const resourceNameStr = resourceNameToString(resourceName);
+    if (
+      !(await this.project.resourceExists(
+        resourceName.type as ResourceFolderType,
+        resourceNameStr,
+      ))
+    ) {
+      throw new Error(
+        `Resource '${resourceNameStr}' does not exist in the project`,
+      );
+    }
+    const resource = Project.resourceObject(this.project, resourceName);
+    if (!(resource instanceof FolderResource)) {
+      throw new Error(`Resource '${resourceNameStr}' is not a folder resource`);
+    }
+    return resource.updateFile(fileName, changedContent);
+  }
 }

package/src/commands/export.ts

@@ -13,27 +13,36 @@
 */
 
 // node
-import { appendFile, copyFile, mkdir, truncate } from 'node:fs/promises';
+import {
+  appendFile,
+  copyFile,
+  mkdir,
+  truncate,
+  writeFile,
+} from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 
-// asciidoctor
-import Processor from '@asciidoctor/core';
-import type { Calculate, Show } from './index.js';
+import { Project } from '../containers/project.js';
+import { sortItems } from '../utils/lexorank.js';
+
 import type {
   Card,
   FetchCardDetails,
 } from '../interfaces/project-interfaces.js';
-import type { CardType } from '../interfaces/resource-interfaces.js';
-import { Project } from '../containers/project.js';
 import type { QueryResult } from '../types/queries.js';
-import { sortItems } from '../utils/lexorank.js';
+import type { CardType } from '../interfaces/resource-interfaces.js';
+import type { Show } from './index.js';
+import { generateReportContent } from '../utils/report.js';
+import { getStaticDirectoryPath, pdfReport } from '@cyberismo/assets';
+import { spawn } from 'node:child_process';
+import { evaluateMacros } from '../macros/index.js';
+import type { ExportPdfOptions } from '../interfaces/project-interfaces.js';
 
 const attachmentFolder: string = 'a';
 
 export class Export {
   constructor(
     protected project: Project,
-    protected calculateCmd: Calculate,
     protected showCmd: Show,
   ) {}
 
@@ -202,11 +211,11 @@ export class Export {
       asciiDocContent = await evaluateMacros(
         cardDetailsResponse.content || '',
         {
+          context: 'exportedDocument',
           mode: 'static',
           project,
           cardKey: card.key,
         },
-        this.calculateCmd,
       );
     } catch (error) {
       asciiDocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${asciiDocContent}`;
@@ -225,6 +234,91 @@ export class Export {
     return card;
   }
 
+  private async runAsciidoctorPdf(content: string): Promise<Buffer> {
+    const staticRootDir = await getStaticDirectoryPath();
+    const proc = spawn(
+      'asciidoctor-pdf',
+      [
+        '-a',
+        'pdf-theme=cyberismo',
+        '-a',
+        `pdf-themesdir=${join(staticRootDir, 'pdf-themes')}`,
+        '-a',
+        `pdf-fontsdir=${join(staticRootDir, 'pdf-themes', 'fonts')};GEM_FONTS_DIR`,
+        '-',
+      ],
+      {
+        timeout: 100000,
+        shell: process.platform === 'win32',
+      },
+    );
+    proc.stdin.end(content);
+    const result = await new Promise<Buffer>((resolve, reject) => {
+      const chunks: Buffer[] = [];
+      proc.stdout.on('data', (chunk) => {
+        chunks.push(chunk);
+      });
+      proc.stderr.on('data', (chunk) => {
+        process.stderr.write(chunk);
+      });
+      proc.on('error', (error) => {
+        if ('code' in error && error.code === 'ENOENT') {
+          reject(
+            new Error(
+              'Asciidoctor-pdf not found. Please install asciidoctor-pdf to use this feature.',
+            ),
+          );
+        }
+        reject(error);
+      });
+      proc.on('close', (code) => {
+        if (code === 0) {
+          resolve(Buffer.concat(chunks));
+        } else {
+          reject(new Error(`Asciidoctor-pdf failed with code ${code}`));
+        }
+      });
+    });
+    return result;
+  }
+
+  /**
+   * Exports the card(s) to pdf.
+   * @param destination Path to where the resulting file(s) will be created.
+   * @param options Export options.
+   * @returns status message
+   */
+  public async exportPdf(
+    destination: string,
+    options: ExportPdfOptions,
+  ): Promise<string> {
+    const opts = {
+      ...options,
+      date: options.date?.toISOString().split('T')[0],
+      recursive: options.recursive ?? false,
+    };
+
+    await this.project.calculationEngine.generate();
+
+    const result = await generateReportContent({
+      calculate: this.project.calculationEngine,
+      contentTemplate: pdfReport.content,
+      queryTemplate: pdfReport.query,
+      context: 'exportedDocument',
+      options: opts,
+    });
+
+    const evaluated = await evaluateMacros(result, {
+      context: 'exportedDocument',
+      mode: 'static',
+      project: this.project,
+      cardKey: '', // top level report does not contain any macros that use cardKey
+    });
+    const pdf = await this.runAsciidoctorPdf(evaluated);
+    await writeFile(destination, pdf);
+    return `Content exported as PDF to ${destination}`;
+  }
+
   /**
    * Exports the card(s) to ascii doc.
    * @param destination Path to where the resulting file(s) will be created.
@@ -254,8 +348,11 @@ export class Export {
       });
     }
 
-    await this.calculateCmd.generate();
-    const tree = await this.calculateCmd.runQuery('tree');
+    await this.project.calculationEngine.generate();
+    const tree = await this.project.calculationEngine.runQuery(
+      'tree',
+      'exportedDocument',
+    );
 
     if (cardKey) {
       const targetCard = this.findCardInTree(tree, cardKey);
@@ -290,27 +387,4 @@ export class Export {
     await this.toAdocFile(resultDocumentPath, cards);
     return message;
   }
-
-  /**
-   * Exports the card(s) to HTML and opens the browser.
-   * @param destination Path to where the resulting file(s) will be created.
-   * @param cardKey Optional; If not exporting the whole card tree, card key of parent card.
-   */
-  public async exportToHTML(
-    destination: string,
-    cardKey?: string,
-  ): Promise<string> {
-    let message = '';
-    await this.exportToADoc(destination, cardKey).then((msg) => {
-      message = msg;
-      const asciiDocProcessor = Processor();
-      const adocFile = join(destination, Project.cardContentFile);
-      asciiDocProcessor.convertFile(adocFile, {
-        safe: 'safe',
-        base_dir: '/',
-        standalone: true,
-      });
-    });
-    return message;
-  }
 }

package/src/commands/import.ts

@@ -172,6 +172,22 @@ export class Import {
     }
   }
 
+  /**
+   * Updates a specific imported module.
+   * @param moduleName Name (prefix) of module to update.
+   * @param credentials Optional credentials for a private module.
+   * @throws if module is not part of the project
+   */
+  public async updateModule(moduleName: string, credentials?: Credentials) {
+    const module = this.project.configuration.modules.find(
+      (item) => item.name === moduleName,
+    );
+    if (!module) {
+      throw new Error(`Module '${moduleName}' is not part of the project`);
+    }
+    return this.moduleManager.updateModule(module, credentials);
+  }
+
   /**
    * Updates all imported modules.
    * @param credentials Optional credentials for private modules.

package/src/commands/move.ts

@@ -1,13 +1,14 @@
 /**
-    Cyberismo
-    Copyright © Cyberismo Ltd and contributors 2024
-
-    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/>.
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+  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/>.
 */
 
 // node
@@ -15,7 +16,6 @@ import { join, sep } from 'node:path';
 
 import { ActionGuard } from '../permissions/action-guard.js';
 import { copyDir, deleteDir } from '../utils/file-utils.js';
-import type { Calculate } from './index.js';
 import type {
   Card,
   FetchCardDetails,
@@ -37,10 +37,7 @@ import { TemplateResource } from '../resources/template-resource.js';
 const ROOT: string = 'root';
 
 export class Move {
-  constructor(
-    private project: Project,
-    private calculateCmd: Calculate,
-  ) {}
+  constructor(private project: Project) {}
 
   // Fetches a card (either template or project card).
   private async getCard(cardKey: string, options: FetchCardDetails) {
@@ -192,7 +189,7 @@ export class Move {
     }
 
     // if both are project cards, make sure source card can be moved
-    const actionGuard = new ActionGuard(this.calculateCmd);
+    const actionGuard = new ActionGuard(this.project.calculationEngine);
     await actionGuard.checkPermission('move', source);
 
     // rerank the card in the new location

package/src/commands/remove.ts

@@ -15,7 +15,6 @@
 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';
@@ -29,10 +28,7 @@ const MODULES_PATH = `${sep}modules${sep}`;
  */
 export class Remove {
   private moduleManager: ModuleManager;
-  constructor(
-    private project: Project,
-    private calculateCmd: Calculate,
-  ) {
+  constructor(private project: Project) {
     this.moduleManager = new ModuleManager(this.project);
   }
 
@@ -87,7 +83,7 @@ export class Remove {
 
     // Make sure card can be removed if it's a project card
     if (!(await this.project.isTemplateCard(cardKey))) {
-      const actionGuard = new ActionGuard(this.calculateCmd);
+      const actionGuard = new ActionGuard(this.project.calculationEngine);
       await actionGuard.checkPermission('delete', cardKey);
     }
 
@@ -115,10 +111,10 @@ export class Remove {
       content: false,
       parent: false,
     });
+    await deleteDir(cardFolder);
     if (card) {
-      await this.calculateCmd.handleDeleteCard(card);
+      await this.project.handleDeleteCard(card);
     }
-    await deleteDir(cardFolder);
   }
 
   // removes label from project

package/src/commands/rename.ts

@@ -16,7 +16,6 @@ import { assert } from 'node:console';
 import { join } from 'node:path';
 import { rename, readdir, readFile, writeFile } from 'node:fs/promises';
 
-import type { Calculate } from './index.js';
 import type { Card } from '../interfaces/project-interfaces.js';
 import { isTemplateCard } from '../utils/card-utils.js';
 import { type Project, ResourcesFrom } from '../containers/project.js';
@@ -41,10 +40,7 @@ export class Rename {
   private from: string = '';
   private to: string = '';
 
-  constructor(
-    private project: Project,
-    private calculateCmd: Calculate,
-  ) {}
+  constructor(private project: Project) {}
 
   // Renames a card and all of its attachments (if it is a project card).
   private async renameCard(re: RegExp, card: Card): Promise<void> {
@@ -110,12 +106,7 @@ export class Rename {
             join(attachment.path, attachment.fileName),
             join(attachment.path, newAttachmentFileName),
           );
-
-          const attachmentRe = new RegExp(`image::${attachment.fileName}`, 'g');
-          card.content = card.content?.replace(
-            attachmentRe,
-            `image::${newAttachmentFileName}`,
-          );
+          // NOTE: content is renamed by updateFiles method
         }),
       );
     }
@@ -373,6 +364,6 @@ export class Rename {
     this.project.collectLocalResources();
     console.info('Collected renamed resources');
 
-    return this.calculateCmd.generate();
+    return this.project.calculationEngine.generate();
   }
 }

package/src/commands/show.ts

@@ -30,6 +30,8 @@ import type {
   ProjectMetadata,
   Resource,
   CardLocation,
+  Context,
+  ResourceFolderType,
 } from '../interfaces/project-interfaces.js';
 import type {
   CardType,
@@ -38,13 +40,18 @@ import type {
   Workflow,
 } from '../interfaces/resource-interfaces.js';
 import { Project, type ResourcesFrom } from '../containers/project.js';
-import { resourceName } from '../utils/resource-utils.js';
+import {
+  type ResourceName,
+  resourceName,
+  resourceNameToString,
+} from '../utils/resource-utils.js';
 import { TemplateResource } from '../resources/template-resource.js';
 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';
+import { evaluateMacros } from '../macros/index.js';
+import { FolderResource } from '../resources/folder-resource.js';
 
 /**
  * Show command.
@@ -54,11 +61,9 @@ export class Show {
     string,
     (from?: ResourcesFrom) => Promise<Resource[]>
   >;
-  constructor(
-    private project: Project,
-    private calculate: Calculate,
-  ) {
+  constructor(private project: Project) {
     this.resourceFunction = new Map([
+      ['calculations', this.project.calculations.bind(this.project)],
       ['cardTypes', this.project.cardTypes.bind(this.project)],
       ['fieldTypes', this.project.fieldTypes.bind(this.project)],
       ['graphModels', this.project.graphModels.bind(this.project)],
@@ -119,6 +124,27 @@ export class Show {
     }
   }
 
+  /**
+   * Shows all template cards in a project.
+   * @returns all template cards in a project.
+   */
+  public async showAllTemplateCards(): Promise<
+    { name: string; cards: Card[] }[]
+  > {
+    return Promise.all(
+      (await this.project.templates()).map(async (template) => {
+        const templateResource = new TemplateResource(
+          this.project,
+          resourceName(template.name),
+        );
+        return {
+          name: template.name,
+          cards: await templateResource.templateObject().showTemplateCards(),
+        };
+      }),
+    );
+  }
+
   /**
    * Shows all attachments (either template or project attachments) from a project.
    * @returns array of card attachments
@@ -264,6 +290,15 @@ export class Show {
     return this.project.listCards(cardsFrom);
   }
 
+  /**
+   * Shows the content of a logic program.
+   * @param cardKey The key of the card.
+   * @returns the content of the logic program.
+   */
+  public async showCardLogicProgram(cardKey: string) {
+    return this.project.calculationEngine.cardLogicProgram(cardKey);
+  }
+
   /**
    * Shows all card types in a project.
    * @returns array of card type details
@@ -282,6 +317,57 @@ export class Show {
     return results.filter((item) => item);
   }
 
+  /**
+   * Shows the content of a file in a resource.
+   * @param resourceName Name of the resource.
+   * @param fileName Name of the file to show.
+   * @returns the content of the file.
+   */
+  public async showFile(
+    resourceName: ResourceName,
+    fileName: string,
+  ): Promise<string> {
+    const resourceNameStr = resourceNameToString(resourceName);
+    if (
+      !(await this.project.resourceExists(
+        resourceName.type as ResourceFolderType,
+        resourceNameStr,
+      ))
+    ) {
+      throw new Error(
+        `Resource '${resourceNameStr}' does not exist in the project`,
+      );
+    }
+    const resource = Project.resourceObject(this.project, resourceName);
+    if (!(resource instanceof FolderResource)) {
+      throw new Error(`Resource '${resourceNameStr}' is not a folder resource`);
+    }
+    return resource.showFile(fileName);
+  }
+
+  /**
+   * Shows all file names in a folder resource.
+   * @param resourceName Name of the resource.
+   * @returns all file names in the resource.
+   */
+  public async showFileNames(resourceName: ResourceName): Promise<string[]> {
+    const resourceNameStr = resourceNameToString(resourceName);
+    if (
+      !(await this.project.resourceExists(
+        resourceName.type as ResourceFolderType,
+        resourceNameStr,
+      ))
+    ) {
+      throw new Error(
+        `Resource '${resourceNameStr}' does not exist in the project`,
+      );
+    }
+    const resource = Project.resourceObject(this.project, resourceName);
+    if (!(resource instanceof FolderResource)) {
+      throw new Error(`Resource '${resourceNameStr}' is not a folder resource`);
+    }
+    return resource.showFileNames();
+  }
   /**
    * Returns all unique labels in a project
    * @returns labels in a list
@@ -297,6 +383,15 @@ export class Show {
     return Array.from(new Set(labels));
   }
 
+  /**
+   * Shows the content of a logic program.
+   * @param resource Name of the resource.
+   * @returns the content of the logic program.
+   */
+  public async showLogicProgram(resource: ResourceName) {
+    return this.project.calculationEngine.resourceLogicProgram(resource);
+  }
+
   /**
    * Shows details of a module.
    * @param moduleName name of a module
@@ -349,6 +444,7 @@ export class Show {
     reportName: string,
     cardKey: string,
     parameters: object,
+    context: Context,
     outputPath?: string,
   ): Promise<string> {
     if (
@@ -359,16 +455,25 @@ export class Show {
       throw new Error(`Report '${reportName}' does not exist`);
     }
 
-    const reportMacro = new ReportMacro(new TaskQueue(), this.calculate);
-    const result = await reportMacro.handleInject(
+    await this.project.calculationEngine.generate();
+    const reportMacro = new ReportMacro(new TaskQueue());
+    let result = await reportMacro.handleInject(
       {
         project: this.project,
         cardKey: cardKey,
         mode: 'static',
+        context,
       },
       { name: reportName, ...parameters },
     );
 
+    result = await evaluateMacros(result, {
+      project: this.project,
+      cardKey: cardKey,
+      mode: 'static',
+      context,
+    });
+
     // Show the results either in the console or write to a file.
     if (outputPath) {
       try {
@@ -393,6 +498,14 @@ export class Show {
     name: string,
     showUse: boolean = false,
   ): Promise<ResourceContent | undefined> {
+    // TODO: remove this workaround once calculations are implemented as a resource class
+    if (resourceName(name).type === 'calculations') {
+      return {
+        name,
+        displayName: resourceName(name).identifier,
+      };
+    }
+
     const strictNameCheck = true;
     const resource = Project.resourceObject(
       this.project,