@cyberismo/data-handler 0.0.14 → 0.0.16

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';
@@ -34,12 +31,20 @@ import { generateReportContent } from '../utils/report.js';
 import { getStaticDirectoryPath, pdfReport } from '@cyberismo/assets';
 import { Project } from '../containers/project.js';
 import type { QueryResult } from '../types/queries.js';
-import type { Show } from './index.js';
+import type { Show } from './show.js';
 import { sortItems } from '../utils/lexorank.js';
 
 const attachmentFolder: string = 'a';
 
+/**
+ * Handles all export commands.
+ */
 export class Export {
+  /**
+   * Creates an instance of export.
+   * @param project Project to use
+   * @param showCmd Instance of Export command to use.
+   */
   constructor(
     protected project: Project,
     protected showCmd: Show,
@@ -100,6 +105,56 @@ export class Export {
     return content;
   }
 
+  // Runs Ascii Doctor converter --> to PDF
+  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;
+  }
+
+  // Adds cards to an ADOC file as additional content.
   private async toAdocFileAsContent(path: string, cards: Card[]) {
     for (const card of cards) {
       let fileContent = '';
@@ -111,9 +166,9 @@ export class Export {
       }
 
       if (card.metadata) {
-        const cardTypeForCard = await this.project.resource<CardType>(
-          card.metadata?.cardType,
-        );
+        const cardTypeForCard = this.project.resources
+          .byType(card.metadata?.cardType, 'cardTypes')
+          .show();
         const metaDataContent = this.metaToAdoc(card, cardTypeForCard);
         fileContent += metaDataContent;
       }
@@ -144,7 +199,10 @@ export class Export {
       }
 
       if (card.children) {
-        await this.toAdocFileAsContent(path, card.children);
+        await this.toAdocFileAsContent(
+          path,
+          this.project.cardKeysToCards(card.children),
+        );
       }
     }
   }
@@ -177,6 +235,7 @@ export class Export {
    * Convert treeQueryResult object into a Card object and add content, metadata & attachments
    * Handles card children recursively
    * @param treeQueryResult tree query result object
+   * @returns Tree query result as a Card.
    */
   protected async treeQueryResultToCard(
     treeQueryResult: QueryResult<'tree'>,
@@ -187,22 +246,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,60 +271,12 @@ 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;
   }
 
-  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.
@@ -332,13 +328,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

@@ -11,20 +11,28 @@
   License along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import type { CardType } from '../interfaces/resource-interfaces.js';
-import { type Create, Validate } from './index.js';
 import { ModuleManager } from '../module-manager.js';
+import { readCsvFile } from '../utils/csv.js';
+import { Validate } from './validate.js';
+
+import type { Create } from './create.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';
-import { TemplateResource } from '../resources/template-resource.js';
 
+/**
+ * Handles all import commands.
+ */
 export class Import {
   private moduleManager: ModuleManager;
+
+  /**
+   * Creates an instance of Import.
+   * @param project Project to use.
+   * @param createCmd Instance of Create to use.
+   */
   constructor(
     private project: Project,
     private createCmd: Create,
@@ -53,16 +61,16 @@ export class Import {
 
     for (const row of csv) {
       const { title, template, description, labels, ...customFields } = row;
-      const templateResource = new TemplateResource(
-        this.project,
-        resourceName(template),
+      const templateResource = this.project.resources.byType(
+        template,
+        'templates',
       );
       const templateObject = templateResource.templateObject();
       if (!templateObject) {
         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,16 +85,13 @@ 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 || '',
-      );
-
-      if (!cardType) {
+      const card = this.project.findCard(cardKey);
+      if (!card.metadata?.cardType) {
         throw new Error(`Card type not found for card ${cardKey}`);
       }
+      const cardType = this.project.resources
+        .byType(card.metadata?.cardType, 'cardTypes')
+        .show();
 
       if (description) {
         await this.project.updateCardContent(cardKey, description);
@@ -157,7 +162,10 @@ export class Import {
     };
 
     // Fetch module dependencies.
-    await this.moduleManager.updateModule(moduleSettings, options?.credentials);
+    await this.moduleManager.updateDependencies(
+      moduleSettings,
+      options?.credentials,
+    );
 
     // Add module as a dependency.
     await this.project.importModule(moduleSettings);