@cyberismo/data-handler 0.0.14 → 0.0.15

package/src/commands/edit.ts

@@ -17,19 +17,10 @@ import { homedir } from 'node:os';
 import { spawnSync } from 'node:child_process';
 
 import { ActionGuard } from '../permissions/action-guard.js';
-import { CalculationResource } from '../resources/calculation-resource.js';
-import { FolderResource } from '../resources/folder-resource.js';
 import { Project } from '../containers/project.js';
-import { propertyName } from '../interfaces/folder-content-interfaces.js';
-import { resourceNameToString } from '../utils/resource-utils.js';
 import { UserPreferences } from '../utils/user-preferences.js';
 
-import type { ContentPropertyName } from '../interfaces/folder-content-interfaces.js';
-import type {
-  MetadataContent,
-  ResourceFolderType,
-} from '../interfaces/project-interfaces.js';
-import type { ResourceName } from '../utils/resource-utils.js';
+import type { MetadataContent } from '../interfaces/project-interfaces.js';
 
 export class Edit {
   private project: Project;
@@ -38,60 +29,12 @@ export class Edit {
     this.project = project;
   }
 
-  /**
-   * Updates a calculation file.
-   * @param resourceName The name of the resource to update.
-   * @param changedContent The new content for the calculation.
-   */
-  public async editCalculation(
-    resourceName: ResourceName,
-    changedContent: string,
-  ) {
-    if (resourceName.prefix !== this.project.projectPrefix) {
-      throw new Error(
-        `Resource '${resourceName.identifier}' is not a local resource`,
-      );
-    }
-    const resourceNameString = resourceNameToString(resourceName);
-    if (
-      !(await this.project.resourceExists(
-        resourceName.type as ResourceFolderType,
-        resourceNameString,
-      ))
-    ) {
-      throw new Error(
-        `Resource '${resourceNameString}' does not exist in the project`,
-      );
-    }
-    const calculationResource = new CalculationResource(
-      this.project,
-      resourceName,
-    );
-    const contentUpdateKey = {
-      key: 'content',
-      subKey: 'calculation',
-    };
-    await calculationResource.update(
-      // TODO: Let's fix this while we get rid of updating filenames directly a bit later.
-      contentUpdateKey as unknown as ContentPropertyName,
-      {
-        name: 'change',
-        target: resourceNameString,
-        to: changedContent,
-      },
-    );
-  }
-
   /**
    * Opens the content and metadata files for a card in the code editor
    * @param cardKey - The key of the card to open. Required.
    */
-  public async editCard(cardKey: string) {
-    // Determine the card path
-    const cardPath = this.project.pathToCard(cardKey);
-    if (!cardPath) {
-      throw new Error(`Card '${cardKey}' does not exist in the project`);
-    }
+  public editCard(cardKey: string) {
+    const card = this.project.findCard(cardKey);
 
     // Read the user preferences
     const prefs = new UserPreferences(
@@ -99,9 +42,8 @@ export class Edit {
     ).getPreferences();
 
     // Construct paths for the card components (json and adoc)
-    const cardDirPath = join(this.project.paths.cardRootFolder, cardPath);
-    const cardContentPath = join(cardDirPath, Project.cardContentFile);
-    const cardJsonPath = join(cardDirPath, Project.cardMetadataFile);
+    const cardContentPath = join(card.path, Project.cardContentFile);
+    const cardJsonPath = join(card.path, Project.cardMetadataFile);
 
     // Extract the editor settings from the preferences.
     const editorPrefs = prefs.editCommand[process.platform];
@@ -112,7 +54,7 @@ export class Edit {
     const editorArgs = editorArgPrefs.map((arg) => {
       arg = arg.replace(/\{\{\s*cardContentPath\s*\}\}/, cardContentPath);
       arg = arg.replace(/\{\{\s*cardJsonPath\s*\}\}/, cardJsonPath);
-      arg = arg.replace(/\{\{\s*cardDirPath\s*\}\}/, cardDirPath);
+      arg = arg.replace(/\{\{\s*cardDirPath\s*\}\}/, card.path);
 
       return arg;
     });
@@ -135,19 +77,14 @@ export class Edit {
    * @param changedContent New content for the card.
    */
   public async editCardContent(cardKey: string, changedContent: string) {
-    const isTemplateCard = await this.project.isTemplateCard(cardKey);
-    if (isTemplateCard) {
+    if (this.project.hasTemplateCard(cardKey)) {
       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`);
+    if (this.project.findCard(cardKey)) {
+      const actionGuard = new ActionGuard(this.project.calculationEngine);
+      await actionGuard.checkPermission('editContent', cardKey);
+      await this.project.updateCardContent(cardKey, changedContent);
     }
-
-    const actionGuard = new ActionGuard(this.project.calculationEngine);
-    await actionGuard.checkPermission('editContent', cardKey);
-
-    await this.project.updateCardContent(cardKey, changedContent);
   }
 
   /**
@@ -164,68 +101,15 @@ export class Edit {
     if (!changedKey) {
       throw new Error(`Changed key cannot be empty`);
     }
-    const isTemplateCard = await this.project.isTemplateCard(cardKey);
-    if (isTemplateCard) {
+    if (this.project.hasTemplateCard(cardKey)) {
       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`);
-    }
-
     // check for editing rights
-    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 resourceNameString = resourceNameToString(resourceName);
-    if (
-      !(await this.project.resourceExists(
-        resourceName.type as ResourceFolderType,
-        resourceNameString,
-      ))
-    ) {
-      throw new Error(
-        `Resource '${resourceNameString}' does not exist in the project`,
-      );
+    if (this.project.findCard(cardKey)) {
+      const actionGuard = new ActionGuard(this.project.calculationEngine);
+      await actionGuard.checkPermission('editField', cardKey, changedKey);
+      await this.project.updateCardMetadataKey(cardKey, changedKey, newValue);
     }
-    const resource = Project.resourceObject(this.project, resourceName);
-    if (!(resource instanceof FolderResource)) {
-      throw new Error(
-        `Resource '${resourceNameString}' is not a folder resource`,
-      );
-    }
-
-    // TODO: The caller should not pass filename, but content type
-    // Once that is in place, this check can be removed
-    const propName: ContentPropertyName | undefined = propertyName(fileName);
-    if (!propName) {
-      throw new Error(`File '${fileName}' is not allowed`);
-    }
-
-    const contentUpdateKey = {
-      key: 'content',
-      subKey: propName,
-    };
-    // TODO: Let's fix this while we get rid of updating filenames directly a bit later.
-    return resource.update(contentUpdateKey as unknown as ContentPropertyName, {
-      name: 'change',
-      target: '',
-      to: changedContent,
-    });
   }
 }

package/src/commands/export.ts

@@ -23,10 +23,7 @@ import {
 import { dirname, join } from 'node:path';
 import { spawn } from 'node:child_process';
 
-import type {
-  Card,
-  FetchCardDetails,
-} from '../interfaces/project-interfaces.js';
+import type { Card } from '../interfaces/project-interfaces.js';
 import type { CardType } from '../interfaces/resource-interfaces.js';
 import { evaluateMacros } from '../macros/index.js';
 import type { ExportPdfOptions } from '../interfaces/project-interfaces.js';
@@ -144,7 +141,10 @@ export class Export {
       }
 
       if (card.children) {
-        await this.toAdocFileAsContent(path, card.children);
+        await this.toAdocFileAsContent(
+          path,
+          this.project.cardKeysToCards(card.children),
+        );
       }
     }
   }
@@ -187,22 +187,7 @@ export class Export {
       children: [],
       attachments: [],
     };
-
-    // Get content and attachments separately, not included in queries
-    const fetchCardDetails: FetchCardDetails = {
-      attachments: true,
-      children: false,
-      content: true,
-      contentType: 'adoc',
-      metadata: true,
-      parent: false,
-    };
-
-    const cardDetailsResponse = await this.showCmd.showCardDetails(
-      fetchCardDetails,
-      card.key,
-    );
-
+    const cardDetailsResponse = this.showCmd.showCardDetails(card.key, 'adoc');
     let asciiDocContent = '';
     const project = this.project;
     try {
@@ -227,7 +212,7 @@ export class Export {
     card.attachments = cardDetailsResponse.attachments;
 
     for (const result of treeQueryResult.children ?? []) {
-      card.children!.push(await this.treeQueryResultToCard(result));
+      card.children!.push((await this.treeQueryResultToCard(result)).key);
     }
 
     return card;
@@ -332,13 +317,7 @@ export class Export {
     let cards: Card[] = [];
 
     // If doing a partial tree export, put the parent information as it would have already been gathered.
-    if (cardKey) {
-      const card = await this.project.findSpecificCard(cardKey);
-      if (!card) {
-        throw new Error(
-          `Input validation error: cannot find card '${cardKey}'`,
-        );
-      }
+    if (cardKey && this.project.findCard(cardKey)) {
       cards.push({
         key: cardKey,
         path: sourcePath,

package/src/commands/import.ts

@@ -62,7 +62,7 @@ export class Import {
         throw new Error(`Template '${template}' not found`);
       }
 
-      const templateCards = await templateObject.cards();
+      const templateCards = templateObject.cards();
       if (templateCards.length !== 1) {
         console.warn(
           `Template '${template}' for card '${title}' does not have exactly one card. Skipping row.`,
@@ -77,11 +77,9 @@ export class Import {
         throw new Error('Card not created');
       }
       const cardKey = cards[0].key;
-      const card = await this.project.findSpecificCard(cardKey, {
-        metadata: true,
-      });
-      const cardType = await this.project.resource<CardType>(
-        card?.metadata?.cardType || '',
+      const card = this.project.findCard(cardKey);
+      const cardType = this.project.resource<CardType>(
+        card.metadata?.cardType || '',
       );
 
       if (!cardType) {