@cyberismo/data-handler 0.0.14 → 0.0.15

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

@@ -22,24 +22,22 @@ import {
   resourceNameToString,
   sortCards,
 } from './folder-resource.js';
-import type { LinkType } from '../interfaces/resource-interfaces.js';
+import type { LinkType, UpdateKey } from '../interfaces/resource-interfaces.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 current = this.content;
     const prefixes = await this.project.projectPrefixes();
     if (current.sourceCardTypes) {
       current.sourceCardTypes = current.sourceCardTypes.map((item) =>
@@ -74,20 +72,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 +82,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 +122,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 +139,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 +161,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

@@ -24,7 +24,6 @@ import {
   sortCards,
 } from './folder-resource.js';
 import { getStaticDirectoryPath } from '@cyberismo/assets';
-import { filename } from '../interfaces/folder-content-interfaces.js';
 import { Validate } from '../commands/validate.js';
 
 import type {
@@ -33,10 +32,9 @@ import type {
   Project,
   ResourceName,
 } from './folder-resource.js';
-import type {
-  Report,
-  ReportMetadata,
-  ReportUpdateKey,
+import {
+  type ReportMetadata,
+  type UpdateKey,
 } from '../interfaces/resource-interfaces.js';
 import type { ReportContent } from '../interfaces/folder-content-interfaces.js';
 import type { Schema } from 'jsonschema';
@@ -49,7 +47,10 @@ const staticDirectoryPath = await getStaticDirectoryPath();
 /**
  * Report resource class.
  */
-export class ReportResource extends FolderResource {
+export class ReportResource extends FolderResource<
+  ReportMetadata,
+  ReportContent
+> {
   private reportSchema: Schema;
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'reports');
@@ -57,8 +58,6 @@ export class ReportResource extends FolderResource {
     this.contentSchemaId = 'reportSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
 
-    this.initialize();
-
     const schemaPath = join(this.internalFolder, REPORT_SCHEMA_FILE);
     this.reportSchema = this.readSchemaFile(schemaPath);
   }
@@ -113,20 +112,6 @@ export class ReportResource extends FolderResource {
     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();
-  }
-
   /**
    * Returns list of handlebar filenames that this report has.
    * @returns list of handlebar filenames that this report has.
@@ -152,49 +137,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 +165,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(),