@cyberismo/data-handler 0.0.14 → 0.0.16

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

@@ -12,42 +12,38 @@
   License along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import { readdir } from 'node:fs/promises';
 import { extname, join } from 'node:path';
+import { readdir } from 'node:fs/promises';
 
+import { copyDir } from '../utils/file-utils.js';
+import { DefaultContent } from './create-defaults.js';
+import { FolderResource } from './folder-resource.js';
+import { getStaticDirectoryPath } from '@cyberismo/assets';
+import { resourceNameToString } from '../utils/resource-utils.js';
+import { sortCards } from '../utils/card-utils.js';
+
+import type { Card } from '../interfaces/project-interfaces.js';
+import type { GraphViewContent } from '../interfaces/folder-content-interfaces.js';
 import type {
-  Card,
-  Operation,
-  Project,
-  ResourceName,
-} from './folder-resource.js';
-import {
-  DefaultContent,
-  FolderResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
-import type {
-  GraphView,
   GraphViewMetadata,
-  GraphViewUpdateKey,
+  UpdateKey,
 } from '../interfaces/resource-interfaces.js';
-import type { GraphViewContent } from '../interfaces/folder-content-interfaces.js';
-
-import { getStaticDirectoryPath } from '@cyberismo/assets';
-import { copyDir } from '../utils/file-utils.js';
+import type { Operation } from './resource-object.js';
+import type { Project } from '../containers/project.js';
+import type { ResourceName } from '../utils/resource-utils.js';
 
 /**
  * Graph view resource class.
  */
-export class GraphViewResource extends FolderResource {
+export class GraphViewResource extends FolderResource<
+  GraphViewMetadata,
+  GraphViewContent
+> {
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'graphViews');
 
     this.contentSchemaId = 'graphViewSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
-
-    this.initialize();
   }
 
   /**
@@ -83,20 +79,8 @@ export class GraphViewResource extends FolderResource {
       join(await getStaticDirectoryPath(), 'defaultGraphView'),
       this.internalFolder,
     );
-  }
-
-  /**
-   * Returns resource content.
-   */
-  public get data(): GraphView {
-    return super.data as GraphView;
-  }
 
-  /**
-   * Deletes file and folder that this resource is based on.
-   */
-  public async delete() {
-    return super.delete();
+    await this.loadContentFiles();
   }
 
   /**
@@ -125,33 +109,24 @@ export class GraphViewResource extends FolderResource {
     return this.onNameChange(existingName);
   }
 
-  /**
-   * Shows metadata of the resource.
-   * @returns graph view metadata.
-   */
-  public async show(): Promise<GraphView> {
-    const baseData = (await super.show()) as GraphViewMetadata;
-    return {
-      ...baseData,
-      content: (await super.contentData()) as GraphViewContent,
-    };
-  }
-
   /**
    * Updates graph view resource.
-   * @param key Key to modify
+   * @param updateKey Key to modify
    * @param op Operation to perform on 'key'
    */
-  public async update<Type>(key: GraphViewUpdateKey, op: Operation<Type>) {
-    if (key === 'category') {
+  public async update<Type, K extends string>(
+    updateKey: UpdateKey<K>,
+    op: Operation<Type>,
+  ) {
+    if (updateKey.key === 'category') {
       const content = structuredClone(this.content) as GraphViewMetadata;
       content.category = super.handleScalar(op) as string;
 
-      await super.postUpdate(content, key, op);
+      await super.postUpdate(content, updateKey, op);
       return;
     }
 
-    await super.update(key, op);
+    await super.update(updateKey, op);
   }
 
   /**
@@ -162,28 +137,11 @@ export class GraphViewResource extends FolderResource {
    * @returns array of card keys and calculation filenames that refer this resource.
    */
   public async usage(cards?: Card[]): Promise<string[]> {
-    const allCards = cards ?? (await super.cards());
+    const allCards = cards ?? super.cards();
     const [relevantCards, calculations] = await Promise.all([
       super.usage(allCards),
       super.calculations(),
     ]);
     return [...relevantCards.sort(sortCards), ...calculations];
   }
-
-  /**
-   * Validates graph view.
-   * @throws when there are validation errors.
-   * @param content Content to be validated.
-   * @note If content is not provided, base class validation will use resource's current content.
-   */
-  public async validate(content?: object) {
-    return super.validate(content);
-  }
-
-  /**
-   *  Create the graph view's folder and handlebar file.
-   */
-  public async write() {
-    await super.write();
-  }
 }

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

@@ -10,37 +10,32 @@
     License along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
-import type {
-  Card,
-  Operation,
-  Project,
-  ResourceName,
-} from './file-resource.js';
-import {
-  DefaultContent,
-  FileResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
-import type { LinkType } from '../interfaces/resource-interfaces.js';
+import { DefaultContent } from './create-defaults.js';
+import { FileResource } from './file-resource.js';
+import { resourceNameToString } from '../utils/resource-utils.js';
+import { sortCards } from '../utils/card-utils.js';
+
+import type { Card } from '../interfaces/project-interfaces.js';
+import type { LinkType, UpdateKey } from '../interfaces/resource-interfaces.js';
+import type { Operation } from './resource-object.js';
+import type { Project } from '../containers/project.js';
+import type { ResourceName } from '../utils/resource-utils.js';
 
 /**
  * Link Type resource class.
  */
-export class LinkTypeResource extends FileResource {
+export class LinkTypeResource extends FileResource<LinkType> {
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'linkTypes');
 
     this.contentSchemaId = 'linkTypeSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
-
-    this.initialize();
   }
 
   // When resource name changes.
   private async handleNameChange(existingName: string) {
-    const current = this.content as LinkType;
-    const prefixes = await this.project.projectPrefixes();
+    const current = this.content;
+    const prefixes = this.project.projectPrefixes();
     if (current.sourceCardTypes) {
       current.sourceCardTypes = current.sourceCardTypes.map((item) =>
         this.updatePrefixInResourceName(item, prefixes),
@@ -74,20 +69,6 @@ export class LinkTypeResource extends FileResource {
     return super.create(newContent);
   }
 
-  /**
-   * Returns content data.
-   */
-  public get data() {
-    return super.data as LinkType;
-  }
-
-  /**
-   * Deletes file(s) from disk and clears out the memory resident object.
-   */
-  public async delete() {
-    return super.delete();
-  }
-
   /**
    * Renames resource metadata file and renames memory resident object 'name'.
    * @param newName New name for the resource.
@@ -98,26 +79,22 @@ export class LinkTypeResource extends FileResource {
     return this.handleNameChange(existingName);
   }
 
-  /**
-   * Shows metadata of the resource.
-   * @returns link type metadata.
-   */
-  public async show(): Promise<LinkType> {
-    return super.show() as Promise<LinkType>;
-  }
-
   /**
    * Updates link type resource.
-   * @param key Key to modify
+   * @param updateKey Key to modify
    * @param op Operation to perform on 'key'
    */
-  public async update<Type>(key: string, op: Operation<Type>) {
+  public async update<Type, K extends string>(
+    updateKey: UpdateKey<K>,
+    op: Operation<Type>,
+  ) {
+    const { key } = updateKey;
     const nameChange = key === 'name';
     const existingName = this.content.name;
 
-    await super.update(key, op);
+    await super.update(updateKey, op);
 
-    const content = structuredClone(this.content) as LinkType;
+    const content = structuredClone(this.content);
     if (key === 'name') {
       content.name = super.handleScalar(op) as string;
     } else if (key === 'destinationCardTypes') {
@@ -142,7 +119,7 @@ export class LinkTypeResource extends FileResource {
       throw new Error(`Unknown property '${key}' for FieldType`);
     }
 
-    await super.postUpdate(content, key, op);
+    await super.postUpdate(content, updateKey, op);
 
     // Renaming this card type causes that references to its name must be updated.
     if (nameChange) {
@@ -159,7 +136,7 @@ export class LinkTypeResource extends FileResource {
    */
   public async usage(cards?: Card[]): Promise<string[]> {
     const resourceName = resourceNameToString(this.resourceName);
-    const allCards = cards || (await super.cards());
+    const allCards = cards || super.cards();
 
     const cardsThatUseLinkType = allCards
       .filter((card) =>
@@ -181,11 +158,4 @@ export class LinkTypeResource extends FileResource {
     // Using Set to avoid duplicate cards
     return [...new Set([...cardReferences, ...calculations])];
   }
-
-  /**
-   * Validates the resource. If object is invalid, throws.
-   */
-  public async validate(content?: object) {
-    return super.validate(content);
-  }
 }

package/src/resources/report-resource.ts

@@ -12,72 +12,48 @@
   License along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import { readdir } from 'node:fs/promises';
-import { readFileSync } from 'node:fs';
 import { extname, join } from 'node:path';
+import { readdir } from 'node:fs/promises';
 
 import { copyDir } from '../utils/file-utils.js';
-import {
-  DefaultContent,
-  FolderResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
+import { DefaultContent } from './create-defaults.js';
+import { FolderResource } from './folder-resource.js';
 import { getStaticDirectoryPath } from '@cyberismo/assets';
-import { filename } from '../interfaces/folder-content-interfaces.js';
+import { resourceNameToString } from '../utils/resource-utils.js';
+import { sortCards } from '../utils/card-utils.js';
 import { Validate } from '../commands/validate.js';
 
+import type { Card } from '../interfaces/project-interfaces.js';
+import type { Operation } from './resource-object.js';
+import type { Project } from '../containers/project.js';
+import type { ReportContent } from '../interfaces/folder-content-interfaces.js';
 import type {
-  Card,
-  Operation,
-  Project,
-  ResourceName,
-} from './folder-resource.js';
-import type {
-  Report,
   ReportMetadata,
-  ReportUpdateKey,
+  UpdateKey,
 } from '../interfaces/resource-interfaces.js';
-import type { ReportContent } from '../interfaces/folder-content-interfaces.js';
-import type { Schema } from 'jsonschema';
+import type { ResourceName } from '../utils/resource-utils.js';
 
-const REPORT_SCHEMA_FILE = 'parameterSchema.json';
 const PARAMETER_SCHEMA_ID = 'jsonSchema';
 
-const staticDirectoryPath = await getStaticDirectoryPath();
-
 /**
  * Report resource class.
  */
-export class ReportResource extends FolderResource {
-  private reportSchema: Schema;
+export class ReportResource extends FolderResource<
+  ReportMetadata,
+  ReportContent
+> {
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'reports');
 
     this.contentSchemaId = 'reportSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
-
-    this.initialize();
-
-    const schemaPath = join(this.internalFolder, REPORT_SCHEMA_FILE);
-    this.reportSchema = this.readSchemaFile(schemaPath);
   }
 
   // Path to content folder.
   // @todo: create the files' content dynamically.
-  private defaultReportLocation: string = join(
-    staticDirectoryPath,
-    'defaultReport',
-  );
-
-  // Try to read schema file content
-  private readSchemaFile(path: string) {
-    try {
-      const schema = readFileSync(path);
-      return JSON.parse(schema.toString());
-    } catch {
-      return undefined;
-    }
+  private async getDefaultReportLocation(): Promise<string> {
+    const staticDirectoryPath = await getStaticDirectoryPath();
+    return join(staticDirectoryPath, 'defaultReport');
   }
 
   /**
@@ -99,8 +75,6 @@ export class ReportResource extends FolderResource {
 
   /**
    * Sets new metadata into the report object.
-   * @param newContent metadata content for the report.
-   * @throws if 'newContent' is not valid.
    */
   public async createReport() {
     const defaultContent = DefaultContent.report(
@@ -110,21 +84,9 @@ export class ReportResource extends FolderResource {
     await super.create(defaultContent);
 
     // Copy report default structure to destination.
-    await copyDir(this.defaultReportLocation, this.internalFolder);
-  }
-
-  /**
-   * Returns resource content.
-   */
-  public get data(): ReportMetadata {
-    return super.data as ReportMetadata;
-  }
-
-  /**
-   * Deletes file and folder that this resource is based on.
-   */
-  public async delete() {
-    return super.delete();
+    const defaultReportLocation = await this.getDefaultReportLocation();
+    await copyDir(defaultReportLocation, this.internalFolder);
+    await this.loadContentFiles();
   }
 
   /**
@@ -152,49 +114,24 @@ export class ReportResource extends FolderResource {
     return this.onNameChange(existingName);
   }
 
-  /**
-   * Shows metadata of the resource.
-   * @returns report metadata.
-   */
-  public async show(): Promise<Report> {
-    const baseData = (await super.show()) as ReportMetadata;
-    const fileContents = await super.contentData();
-    const content: ReportContent = {
-      contentTemplate: fileContents.contentTemplate as string,
-      queryTemplate: fileContents.queryTemplate as string,
-      schema: fileContents.schema ? (fileContents.schema as Schema) : undefined,
-    };
-    return {
-      ...baseData,
-      content: content,
-    };
-  }
-
   /**
    * Updates report resource.
-   * @param key Key to modify
+   * @param updateKey Key to modify
    * @param op Operation to perform on 'key'
    */
-  public async update<Type>(key: ReportUpdateKey, op: Operation<Type>) {
-    if (
-      typeof key === 'object' &&
-      key.key === 'content' &&
-      key.subKey === 'schema'
-    ) {
-      const fileContent = JSON.stringify(super.handleScalar(op), null, 2);
-      await this.updateFile(filename(key.subKey)!, fileContent);
-      return;
-    }
-
-    if (key === 'category') {
-      const content = structuredClone(this.content) as ReportMetadata;
+  public async update<Type, K extends string>(
+    updateKey: UpdateKey<K>,
+    op: Operation<Type>,
+  ) {
+    if (updateKey.key === 'category') {
+      const content = structuredClone(this.content);
       content.category = super.handleScalar(op) as string;
 
-      await super.postUpdate(content, key, op);
+      await super.postUpdate(content, updateKey, op);
       return;
     }
 
-    await super.update(key, op);
+    await super.update(updateKey, op);
   }
 
   /**
@@ -205,7 +142,7 @@ export class ReportResource extends FolderResource {
    * @returns array of card keys and calculation filenames that refer this resource.
    */
   public async usage(cards?: Card[]): Promise<string[]> {
-    const allCards = cards ?? (await super.cards());
+    const allCards = cards ?? super.cards();
     const [relevantCards, calculations] = await Promise.all([
       super.usage(allCards),
       super.calculations(),
@@ -220,9 +157,10 @@ 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 resourceContent = this.contentData();
+    if (resourceContent.schema) {
       const errors = Validate.getInstance().validateJson(
-        this.reportSchema,
+        resourceContent.schema,
         PARAMETER_SCHEMA_ID,
       );
       if (errors.length > 0) {