@cyberismo/data-handler 0.0.6 → 0.0.8

package/src/project-settings.ts

@@ -13,6 +13,8 @@
 
 import { writeJsonFile as atomicWrite } from 'write-json-file';
 
+import { resolve } from 'path';
+
 import type {
   ModuleSetting,
   ProjectSettings,
@@ -55,18 +57,9 @@ export class ProjectConfiguration implements ProjectSettings {
 
   // Sets configuration values from file.
   private readSettings() {
-    let settings;
-    try {
-      settings = readJsonFileSync(this.settingPath) as ProjectConfiguration;
-    } catch {
-      throw new Error(
-        `Invalid path '${this.settingPath}' to configuration file`,
-      );
-    }
+    const settings = readJsonFileSync(this.settingPath) as ProjectConfiguration;
     if (!settings) {
-      throw new Error(
-        `Invalid path '${this.settingPath}' to configuration file`,
-      );
+      throw new Error(`File at '${this.settingPath}' is not a valid JSON file`);
     }
 
     const valid =
@@ -103,6 +96,11 @@ export class ProjectConfiguration implements ProjectSettings {
     if (exists) {
       throw new Error(`Module '${module.name}' already imported`);
     }
+    // Ensure that module file location is absolute
+    if (module.location && module.location.startsWith('file:')) {
+      const filePath = module.location.substring(5, module.location.length);
+      module.location = `file:${resolve(filePath)}`;
+    }
     this.modules.push(module);
     return this.save();
   }

package/src/resources/array-handler.ts

@@ -83,15 +83,20 @@ export class ArrayHandler<T> {
     if (targetIndex === -1) {
       throw new Error(`Item '${JSON.stringify(target)}' not found`);
     }
+    const actualTarget = array[targetIndex];
     const parsedTo = this.tryParseJSON(to);
 
     if (typeof to === 'string' && (to.startsWith('[') || to.startsWith('{'))) {
       return parsedTo as T[];
     }
 
-    return array.map((item) =>
-      deepCompare(item as object, target as object) ? parsedTo : item,
+    const updatedArray = array.map((item) =>
+      deepCompare(item as object, actualTarget as object) ? parsedTo : item,
     );
+    if (deepCompare(updatedArray, array)) {
+      throw new Error('Cannot change value. Target was not found.');
+    }
+    return updatedArray;
   }
 
   private handleRank(operation: RankOperation<T>, array: T[]): T[] {

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

@@ -1,18 +1,22 @@
 /**
-    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/>.
 */
+
 import type {
   CardType,
   CustomField,
   LinkType,
+  Workflow,
 } from '../interfaces/resource-interfaces.js';
 import { FieldTypeResource } from './field-type-resource.js';
 import {
@@ -31,7 +35,6 @@ import {
   sortCards,
 } from './file-resource.js';
 import { LinkTypeResource } from './link-type-resource.js';
-import { Template } from '../containers/template.js';
 import { Validate } from '../commands/index.js';
 
 /**
@@ -56,49 +59,26 @@ export class CardTypeResource extends FileResource {
       .map((card) => card.key);
   }
 
-  // Collects affected cards.
-  private async collectCards(cardContent: object) {
-    async function filteredCards(
-      cardSource: Promise<Card[]>,
-      cardTypeName: string,
-    ): Promise<Card[]> {
-      const cards = await cardSource;
-      return cards.filter((card) => card.metadata?.cardType === cardTypeName);
-    }
-
-    // Collect both project cards ...
-    const projectCardsPromise = filteredCards(
-      this.project.cards(this.project.paths.cardRootFolder, cardContent),
-      this.content.name,
-    );
-    // ... and cards from each template that would be affected.
-    const templates = await this.project.templates(ResourcesFrom.localOnly);
-    const templateCardsPromises = templates.map((template) => {
-      const templateObject = new Template(this.project, template);
-      return filteredCards(
-        templateObject.cards('', cardContent),
-        this.content.name,
-      );
-    });
-    // Return all affected cards
-    const cards = (
-      await Promise.all([projectCardsPromise, ...templateCardsPromises])
-    ).reduce((accumulator, value) => accumulator.concat(value), []);
-    return cards;
+  // Checks if field type exists in the project.
+  private async fieldTypeExists(field: Partial<CustomField>) {
+    return field && field.name
+      ? this.project.resourceExists('fieldTypes', field.name)
+      : false;
   }
 
   // If custom fields change, cards need to be updated.
   // Rename change changes key names in cards.
   private async handleCustomFieldsChange<Type>(op: Operation<Type>) {
-    const cardContent = {
-      metadata: true,
-      content: true,
-    };
-
     if (op && op.name === 'rank') return;
 
     // Collect both project cards and template cards.
-    const cards = await this.collectCards(cardContent);
+    const cards = await this.collectCards(
+      {
+        metadata: true,
+        content: true,
+      },
+      this.content.name,
+    );
 
     if (op && op.name === 'change') {
       const from = (op as ChangeOperation<string>).target;
@@ -173,6 +153,11 @@ export class CardTypeResource extends FileResource {
     }
   }
 
+  // Checks if field type exists in this card type.
+  private async hasFieldType(field: Partial<CustomField>): Promise<boolean> {
+    return this.data.customFields.some((item) => item.name === field.name);
+  }
+
   // Remove value from array.
   // todo: make it as generic and move to utils
   private removeValue(array: string[], value: string) {
@@ -303,6 +288,33 @@ export class CardTypeResource extends FileResource {
     }
   }
 
+  // Checks that field type exists in the project and is defined in this card type.
+  private async validateFieldType<Type>(
+    key: string,
+    op: Operation<Type>,
+  ): Promise<void> {
+    const field =
+      typeof op.target === 'object'
+        ? (op.target as CustomField)
+        : { name: op.target as string };
+    // Check that field type exists in the project.
+    const exists = await this.fieldTypeExists(field);
+    if (!exists) {
+      throw new Error(
+        `Field type '${field.name}' does not exist in the project`,
+      );
+    }
+    // Check that field type is defined in card type.
+    if (key === 'alwaysVisibleFields' || key === 'optionallyVisibleFields') {
+      const hasField = await this.hasFieldType(field);
+      if (!hasField) {
+        throw new Error(
+          `Field type '${field.name}' is not defined in card type '${this.content.name}'`,
+        );
+      }
+    }
+  }
+
   /**
    * Creates a new card type object. Base class writes the object to disk automatically.
    * @param workflowName Workflow name that this card type uses.
@@ -318,7 +330,7 @@ export class CardTypeResource extends FileResource {
       resourceNameToString(resourceName(workflowName)),
       await this.project.projectPrefixes(),
     );
-    const workflow = await this.project.resource(workflowName);
+    const workflow = await this.project.resource<Workflow>(workflowName);
     if (!workflow) {
       throw new Error(
         `Workflow '${workflowName}' does not exist in the project`,
@@ -378,12 +390,14 @@ export class CardTypeResource extends FileResource {
     if (key === 'name') {
       content.name = super.handleScalar(op) as string;
     } else if (key === 'alwaysVisibleFields') {
+      await this.validateFieldType(key, op);
       content.alwaysVisibleFields = super.handleArray(
         op,
         key,
         content.alwaysVisibleFields as Type[],
       ) as string[];
     } else if (key === 'optionallyVisibleFields') {
+      await this.validateFieldType(key, op);
       content.optionallyVisibleFields = super.handleArray(
         op,
         key,
@@ -392,6 +406,7 @@ export class CardTypeResource extends FileResource {
     } else if (key === 'workflow') {
       content.workflow = super.handleScalar(op) as string;
     } else if (key === 'customFields') {
+      await this.validateFieldType(key, op);
       content.customFields = super.handleArray(
         op,
         key,

package/src/resources/create-defaults.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/>.
 */
 
 import type { Card } from '../interfaces/project-interfaces.js';
@@ -78,6 +79,7 @@ export abstract class DefaultContent {
   static cardType(cardTypeName: string, workflowName: string): CardType {
     return {
       name: cardTypeName,
+      displayName: '',
       workflow: workflowName,
       customFields: [],
       alwaysVisibleFields: [],
@@ -94,6 +96,7 @@ export abstract class DefaultContent {
   static fieldType(fieldTypeName: string, dataType: DataType): FieldType {
     const value = {
       name: fieldTypeName,
+      displayName: '',
       dataType: dataType,
     } as FieldType;
     if (dataType === 'enum') {
@@ -111,7 +114,6 @@ export abstract class DefaultContent {
     return {
       name: graphModelName,
       displayName: '',
-      description: '',
     };
   }
 
@@ -124,7 +126,6 @@ export abstract class DefaultContent {
     return {
       name: graphViewName,
       displayName: '',
-      description: '',
     };
   }
 
@@ -149,6 +150,7 @@ export abstract class DefaultContent {
   static linkType(linkTypeName: string): LinkType {
     return {
       name: linkTypeName,
+      displayName: '',
       outboundDisplayName: linkTypeName,
       inboundDisplayName: linkTypeName,
       sourceCardTypes: [],
@@ -166,7 +168,6 @@ export abstract class DefaultContent {
     return {
       name: reportName,
       displayName: '',
-      description: '',
       category: 'Uncategorised report',
     };
   }
@@ -178,6 +179,7 @@ export abstract class DefaultContent {
   public static template(templateName: string): TemplateMetadata {
     return {
       name: templateName,
+      displayName: '',
     };
   }
 
@@ -189,6 +191,7 @@ export abstract class DefaultContent {
   public static workflow(workflowName: string): Workflow {
     return {
       name: workflowName,
+      displayName: '',
       states: [
         { name: 'Draft', category: WorkflowCategory.initial },
         { name: 'Approved', category: WorkflowCategory.closed },

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

@@ -71,21 +71,6 @@ export class FieldTypeResource extends FileResource {
       .map((card) => card.key);
   }
 
-  // Collects affected cards.
-  private async collectCards(cardContent: object, cardTypeName: string) {
-    async function filteredCards(
-      cardSource: Promise<Card[]>,
-      cardTypeName: string,
-    ): Promise<Card[]> {
-      const cards = await cardSource;
-      return cards.filter((card) => card.metadata?.cardType === cardTypeName);
-    }
-    return filteredCards(
-      this.project.cards(this.project.paths.cardRootFolder, cardContent),
-      cardTypeName,
-    );
-  }
-
   // Converts values.
   // The allowed conversions are:
   // - shortText/longText --> person, if valid email
@@ -477,8 +462,8 @@ export class FieldTypeResource extends FileResource {
         key,
         content.enumValues as Type[],
       ) as EnumDefinition[];
-    } else if (key === 'fieldDescription') {
-      content.fieldDescription = super.handleScalar(op) as string;
+    } else if (key === 'description') {
+      content.description = super.handleScalar(op) as string;
     } else {
       throw new Error(`Unknown property '${key}' for FieldType`);
     }

package/src/resources/file-resource.ts

@@ -1,14 +1,13 @@
 /**
   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
+  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/>.
 */
 
@@ -19,6 +18,7 @@ import { readFile } from 'node:fs/promises';
 
 import type {
   Card,
+  FetchCardDetails,
   ResourceFolderType,
 } from '../interfaces/project-interfaces.js';
 import {
@@ -48,6 +48,7 @@ import {
 } from '../utils/resource-utils.js';
 import type { Resource } from '../interfaces/project-interfaces.js';
 import { sortCards } from '../utils/card-utils.js';
+import { Template } from '../containers/template.js';
 import { Validate } from '../commands/index.js';
 
 export {
@@ -70,7 +71,10 @@ export {
  */
 export class FileResource extends ResourceObject {
   public fileName: string = '';
-  protected content: ResourceBaseMetadata = { name: '' };
+  protected content: ResourceBaseMetadata = {
+    name: '',
+    displayName: '',
+  };
   private cache: Map<string, JSON>;
 
   constructor(
@@ -102,6 +106,37 @@ export class FileResource extends ResourceObject {
     );
   }
 
+  // Collects cards that are using the 'cardTypeName'.
+  protected async collectCards(
+    cardContent: FetchCardDetails,
+    cardTypeName: string,
+  ) {
+    async function filteredCards(
+      cardSource: Promise<Card[]>,
+      cardTypeName: string,
+    ): Promise<Card[]> {
+      const cards = await cardSource;
+      return cards.filter((card) => card.metadata?.cardType === cardTypeName);
+    }
+
+    // Collect both project cards ...
+    const projectCardsPromise = filteredCards(
+      this.project.cards(this.project.paths.cardRootFolder, cardContent),
+      cardTypeName,
+    );
+    // ... and cards from each template that would be affected.
+    const templates = await this.project.templates(ResourcesFrom.localOnly);
+    const templateCardsPromises = templates.map((template) => {
+      const templateObject = new Template(this.project, template);
+      return filteredCards(templateObject.cards('', cardContent), cardTypeName);
+    });
+    // Return all affected cards
+    const cards = (
+      await Promise.all([projectCardsPromise, ...templateCardsPromises])
+    ).reduce((accumulator, value) => accumulator.concat(value), []);
+    return cards;
+  }
+
   // Initialize the resource.
   protected initialize() {
     if (this.resourceName.type === '') {
@@ -163,8 +198,11 @@ export class FileResource extends ResourceObject {
 
     let validContent = {} as ResourceContent;
     if (newContent) {
-      validContent = newContent as unknown as ResourceContent;
+      validContent = newContent;
       validContent.name = validName;
+    } else {
+      validContent.description = '';
+      validContent.displayName = '';
     }
 
     this.content = validContent;

package/src/resources/folder-resource.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/>.
 */
 
 import { basename, join } from 'node:path';
@@ -94,7 +95,7 @@ export class FolderResource extends FileResource {
    * @returns resource type's metadata.
    */
   protected async show(): Promise<ResourceContent> {
-    return super.show() as Promise<ResourceContent>;
+    return super.show();
   }
 
   /**

package/src/resources/report-resource.ts

@@ -1,14 +1,13 @@
 /**
   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
+  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/>.
 */
 
@@ -34,11 +33,13 @@ import type {
   ReportMetadata,
 } from '../interfaces/resource-interfaces.js';
 import type { Schema } from 'jsonschema';
-import { getStaticDirectoryPath } from '@cyberismo/resources';
+import { getStaticDirectoryPath } from '@cyberismo/assets';
+import { Validate } from '../commands/validate.js';
 
 const CARD_CONTENT_HANDLEBAR_FILE = 'index.adoc.hbs';
 const QUERY_HANDLEBAR_FILE = 'query.lp.hbs';
 const REPORT_SCHEMA_FILE = 'parameterSchema.json';
+const PARAMETER_SCHEMA_ID = 'jsonSchema';
 
 const staticDirectoryPath = await getStaticDirectoryPath();
 
@@ -153,6 +154,8 @@ export class ReportResource extends FolderResource {
     const reportMetadata = (await super.show()) as ReportMetadata;
     return {
       name: resourceNameToString(this.resourceName),
+      displayName: reportMetadata.displayName,
+      description: reportMetadata.description,
       metadata: reportMetadata,
       contentTemplate: (
         await readFile(join(this.internalFolder, CARD_CONTENT_HANDLEBAR_FILE))
@@ -219,6 +222,15 @@ export class ReportResource extends FolderResource {
    * @note If content is not provided, base class validation will use resource's current content.
    */
   public async validate(content?: object) {
+    if (this.reportSchema) {
+      const errors = Validate.getInstance().validateJson(
+        this.reportSchema,
+        PARAMETER_SCHEMA_ID,
+      );
+      if (errors.length > 0) {
+        throw new Error(`Invalid parameter schema: ${errors}`);
+      }
+    }
     return super.validate(content);
   }
 }

package/src/resources/template-resource.ts

@@ -1,14 +1,13 @@
 /**
   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
+  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/>.
 */
 
@@ -120,6 +119,8 @@ export class TemplateResource extends FolderResource {
     return {
       metadata: templateMetadata,
       name: resourceNameToString(this.resourceName),
+      displayName: templateMetadata.displayName,
+      description: templateMetadata.description,
       path: this.fileName,
       numberOfCards: (await container.listCards()).length,
     };