@cyberismo/data-handler 0.0.10 → 0.0.12

package/src/macros/xref/index.ts

@@ -27,7 +27,7 @@ export default class XrefMacro extends BaseMacro {
     super(macroMetadata, tasksQueue);
   }
 
-  handleValidate = (input: unknown) => {
+  handleValidate = (_: MacroGenerationContext, input: unknown) => {
     this.validate(input);
   };
 

package/src/project-settings.ts

@@ -13,9 +13,11 @@
 
 import { writeJsonFile as atomicWrite } from 'write-json-file';
 
-import { resolve } from 'path';
+import { resolve } from 'node:path';
+import { URL } from 'node:url';
 
 import type {
+  HubSetting,
   ModuleSetting,
   ProjectSettings,
 } from './interfaces/project-interfaces.js';
@@ -31,6 +33,7 @@ export class ProjectConfiguration implements ProjectSettings {
   name: string;
   cardKeyPrefix: string;
   modules: ModuleSetting[];
+  hubs: HubSetting[];
   private settingPath: string;
 
   constructor(path: string) {
@@ -38,6 +41,7 @@ export class ProjectConfiguration implements ProjectSettings {
     this.settingPath = path;
     this.cardKeyPrefix = '';
     this.modules = [];
+    this.hubs = [];
     this.readSettings();
   }
 
@@ -70,6 +74,7 @@ export class ProjectConfiguration implements ProjectSettings {
       this.cardKeyPrefix = settings.cardKeyPrefix;
       this.name = settings.name;
       this.modules = settings.modules || [];
+      this.hubs = settings.hubs || [];
     } else {
       throw new Error(`Invalid configuration file '${this.settingPath}'`);
     }
@@ -81,9 +86,51 @@ export class ProjectConfiguration implements ProjectSettings {
       cardKeyPrefix: this.cardKeyPrefix,
       name: this.name,
       modules: this.modules,
+      hubs: this.hubs,
     };
   }
 
+  /**
+   * Adds a new hub.
+   * @param hubName URL of the hub to add
+   * @throws if hub is already in the project or URL is invalid
+   */
+  public async addHub(hubName: string) {
+    const trimmedHub = hubName?.trim();
+    if (!trimmedHub) {
+      throw new Error(`Cannot add empty hub to the project`);
+    }
+
+    const exists = this.hubs.find((item) => item.location === trimmedHub);
+    if (exists) {
+      throw new Error(
+        `Hub '${trimmedHub}' already exists as a hub for the project`,
+      );
+    }
+
+    try {
+      const hubUrl = new URL(trimmedHub);
+      if (!['http:', 'https:'].includes(hubUrl.protocol)) {
+        throw new Error(
+          `Invalid URL protocol '${hubUrl.protocol}'. Only HTTP and HTTPS protocols are supported for hubs.`,
+        );
+      }
+      if (!hubUrl.hostname) {
+        throw new Error('Hub URL must have a valid hostname.');
+      }
+    } catch (error) {
+      if (error instanceof TypeError) {
+        throw new Error(
+          `Invalid hub URL '${trimmedHub}'. Please provide a valid HTTP or HTTPS URL.`,
+        );
+      }
+      throw error;
+    }
+
+    this.hubs.push({ location: trimmedHub });
+    return this.save();
+  }
+
   /**
    * Adds new module to imported modules property.
    * @param module Module to add as dependency
@@ -105,6 +152,20 @@ export class ProjectConfiguration implements ProjectSettings {
     return this.save();
   }
 
+  /**
+   * Removes a hub.
+   * @param hubName Name of the hub to remove.
+   * @throws if hub is not part of the project
+   */
+  public async removeHub(hubName: string) {
+    const exists = this.hubs.find((item) => item.location === hubName);
+    if (!exists) {
+      throw new Error(`Hub '${hubName}' not part of the project`);
+    }
+    this.hubs = this.hubs.filter((item) => item.location !== hubName);
+    return this.save();
+  }
+
   /**
    * Removes module from imported modules property.
    * @param moduleName Name of the module to remove.

package/src/resources/field-type-resource.ts

@@ -150,13 +150,13 @@ export class FieldTypeResource extends FileResource {
     const allCards = [...projectCards, ...templateCards];
 
     // Finally, convert values and update the cards.
-    allCards.forEach(async (card) => {
+    for (const card of allCards) {
       const metadata = card.metadata!;
       const fieldName = resourceNameToString(this.resourceName);
       try {
         metadata[fieldName] = this.convertValue(metadata[fieldName]);
         // Either value was already null, or couldn't convert.
-        if (metadata[fieldName] === null) return;
+        if (metadata[fieldName] === null) continue;
 
         await this.project.updateCardMetadata(card, metadata);
       } catch (error) {
@@ -164,7 +164,7 @@ export class FieldTypeResource extends FileResource {
           `In card '${card.key}': ${error instanceof Error ? error.message : String(error)}`,
         );
       }
-    });
+    }
   }
 
   // Checks that enum with 'enumValue' exists.
@@ -305,6 +305,7 @@ export class FieldTypeResource extends FileResource {
   /**
    * Creates a new field type object. Base class writes the object to disk automatically.
    * @param dataType Type for the new field type.
+   * @throws if called with unknown data type
    */
   public async createFieldType(dataType: DataType) {
     if (!FieldTypeResource.fieldDataTypes().includes(dataType)) {
@@ -418,6 +419,10 @@ export class FieldTypeResource extends FileResource {
    * Updates field type resource.
    * @param key Key to modify
    * @param op Operation to perform on 'key'
+   * @throws
+   *  - when called with unknown data type
+   *  - when called with data type conversion that cannot be done
+   *  - when called with unknown property to update
    */
   public async update<Type>(key: string, op: Operation<Type>) {
     const nameChange = key === 'name';

package/src/resources/graph-view-resource.ts

@@ -31,7 +31,9 @@ import type {
   GraphView,
   GraphViewMetadata,
 } from '../interfaces/resource-interfaces.js';
-import { writeFileSafe } from '../utils/file-utils.js';
+
+import { getStaticDirectoryPath } from '@cyberismo/assets';
+import { copyDir } from '../utils/file-utils.js';
 
 /**
  * Graph view resource class.
@@ -73,10 +75,10 @@ export class GraphViewResource extends FolderResource {
     }
 
     await super.create(newContent);
-    const handleBarFile = join(this.internalFolder, 'view.lp.hbs');
-    await writeFileSafe(handleBarFile, '', {
-      flag: 'wx',
-    });
+    await copyDir(
+      join(await getStaticDirectoryPath(), 'defaultGraphView'),
+      this.internalFolder,
+    );
   }
 
   /**

package/src/resources/workflow-resource.ts

@@ -190,12 +190,13 @@ export class WorkflowResource extends FileResource {
   // Update card states when state is changed
   private async updateCardStates(oldState: string, newState: string) {
     const cards = await this.collectCardsUsingWorkflow();
-    cards.forEach(async (card) => {
-      if (card.metadata?.workflowState === oldState) {
-        card.metadata.workflowState = newState;
-        await this.project.updateCardMetadata(card, card.metadata);
-      }
-    });
+    const promises = cards
+      .filter((card) => card.metadata?.workflowState === oldState)
+      .map(async (card) => {
+        card.metadata!.workflowState = newState;
+        await this.project.updateCardMetadata(card, card.metadata!);
+      });
+    await Promise.all(promises);
   }
 
   // Update dependant card types.

package/src/utils/log-utils.ts

@@ -13,7 +13,7 @@ import pino, { type ChildLoggerOptions, type Logger } from 'pino';
 
 // This could be also a more generic interface, but since we use pino and this is an internal package, let's keep it simple
 // silent logger as default
-let _logger: Logger = pino.default({ level: 'silent' });
+let _logger: Logger = pino({ level: 'silent' });
 
 export function setLogger(logger: Logger) {
   _logger = logger;

package/src/utils/report.ts

@@ -62,8 +62,14 @@ export function formatValue(value: unknown): string {
     ) {
       return value.displayValue;
     }
+    if (value != null && 'value' in value && typeof value.value === 'string') {
+      return formatValue(value.value);
+    }
     return JSON.stringify(value, null, 2);
   }
+  if (typeof value === 'boolean') {
+    return value ? 'Yes' : 'No';
+  }
   return value?.toString() ?? '';
 }
 

package/src/utils/resource-utils.ts

@@ -112,6 +112,22 @@ export function resourceNameToPath(
   throw new Error('resourceName does not contain prefix');
 }
 
+/**
+ * Return path to a file in a folder resource
+ * @param project Project
+ * @param resourceName Resource name
+ * @param fileName File name
+ * @returns Path to file in folder resource
+ */
+export function resourceFilePath(
+  project: Project,
+  resourceName: ResourceName,
+  fileName: string,
+): string {
+  const resourcePath = resourceNameToPath(project, resourceName, '');
+  return join(resourcePath, fileName);
+}
+
 /**
  * Resource metadata file path to resource name (e.g. <prefix>/<type>/<name>)
  * @param project Project where resource is in