@cyberismo/data-handler 0.0.14 → 0.0.16

package/src/resources/template-resource.ts

@@ -11,32 +11,30 @@
   License along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import { basename, dirname, join } from 'node:path';
+import { dirname, join } from 'node:path';
 import { mkdir } from 'node:fs/promises';
 
-import type {
-  Card,
-  Operation,
-  Project,
-  ResourceName,
-} from './folder-resource.js';
-import {
-  DefaultContent,
-  FolderResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
+import { DefaultContent } from './create-defaults.js';
+import { FolderResource } from './folder-resource.js';
+import { resourceNameToString } from '../utils/resource-utils.js';
+import { sortCards } from '../utils/card-utils.js';
+import { Template } from '../containers/template.js';
+import { writeJsonFile } from '../utils/json.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 { ResourceName } from '../utils/resource-utils.js';
 import type {
   TemplateConfiguration,
   TemplateMetadata,
+  UpdateKey,
 } from '../interfaces/resource-interfaces.js';
-import { Template } from '../containers/template.js';
-import { writeJsonFile } from '../utils/json.js';
 
 /**
  * Template resource class.
  */
-export class TemplateResource extends FolderResource {
+export class TemplateResource extends FolderResource<TemplateMetadata, never> {
   private cardContainer: Template;
   private cardsFolder = '';
   private cardsSchema = super.contentSchemaContent('cardBaseSchema');
@@ -47,12 +45,12 @@ export class TemplateResource extends FolderResource {
     this.contentSchemaId = 'templateSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
 
-    this.initialize();
     this.cardsFolder = join(this.internalFolder, 'c');
 
     // Each template resource contains a template card container (with template cards).
+    // todo: Fix Template constructor not to use Resource, but just this filename with path
     this.cardContainer = new Template(this.project, {
-      name: basename(this.fileName),
+      name: resourceNameToString(this.resourceName),
       path: dirname(this.fileName),
     });
   }
@@ -86,17 +84,13 @@ export class TemplateResource extends FolderResource {
     return super.create(newContent);
   }
 
-  /**
-   * Returns content data.
-   */
-  public get data(): TemplateMetadata {
-    return super.data as TemplateMetadata;
-  }
-
   /**
    * Deletes file and folder that this resource is based on.
+   * Also removes template cards from the project's card cache.
    */
   public async delete() {
+    const templateName = resourceNameToString(this.resourceName);
+    this.project.cardsCache.deleteCardsFromTemplate(templateName);
     return super.delete();
   }
 
@@ -114,8 +108,8 @@ export class TemplateResource extends FolderResource {
    * Shows metadata of the resource.
    * @returns template metadata.
    */
-  public async show(): Promise<TemplateConfiguration> {
-    const templateMetadata = (await super.show()) as TemplateMetadata;
+  public show(): TemplateConfiguration {
+    const templateMetadata = super.show();
     const container = this.templateObject();
 
     return {
@@ -124,7 +118,7 @@ export class TemplateResource extends FolderResource {
       displayName: templateMetadata.displayName,
       description: templateMetadata.description,
       path: this.fileName,
-      numberOfCards: (await container.listCards()).length,
+      numberOfCards: container.listCards().length,
     };
   }
 
@@ -138,20 +132,24 @@ export class TemplateResource extends FolderResource {
 
   /**
    * Updates template resource.
-   * @param key Key to modify
+   * @param updateKey Key to modify
    * @param op Operation to perform on 'key'
    * @throws if key is unknown.
    */
-  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;
 
     // Only call super.update for keys that base class supports
     if (key === 'name' || key === 'displayName' || key === 'description') {
-      await super.update(key, op);
+      await super.update(updateKey, op);
     }
 
-    const content = structuredClone(this.content) as TemplateMetadata;
+    const content = structuredClone(this.content);
 
     if (key === 'name') {
       content.name = super.handleScalar(op) as string;
@@ -165,7 +163,7 @@ export class TemplateResource extends FolderResource {
       throw new Error(`Unknown property '${key}' for Template`);
     }
 
-    await super.postUpdate(content, key, op);
+    await super.postUpdate(content, updateKey, op);
 
     // Renaming this template causes that references to its name must be updated.
     if (nameChange) {
@@ -181,7 +179,7 @@ export class TemplateResource 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(),
@@ -189,16 +187,6 @@ export class TemplateResource extends FolderResource {
     return [...relevantCards.sort(sortCards), ...calculations];
   }
 
-  /**
-   * Validates template.
-   * @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 template's cards folder.
    */

package/src/resources/workflow-resource.ts

@@ -13,58 +13,43 @@
 */
 
 import type {
-  CardType,
+  UpdateKey,
   Workflow,
   WorkflowState,
   WorkflowTransition,
 } from '../interfaces/resource-interfaces.js';
-import { CardTypeResource } from './card-type-resource.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 {
-  Card,
   ChangeOperation,
   Operation,
-  Project,
   RemoveOperation,
-  ResourceName,
-} from './file-resource.js';
-import {
-  DefaultContent,
-  FileResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
-import { ResourcesFrom } from '../containers/project.js';
-import { resourceName } from './file-resource.js';
+} from './resource-object.js';
+import type { Project } from '../containers/project.js';
+import type { ResourceName } from '../utils/resource-utils.js';
 
 /**
  * Workflow resource class.
  */
-export class WorkflowResource extends FileResource {
+export class WorkflowResource extends FileResource<Workflow> {
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'workflows');
 
     this.contentSchemaId = 'workflowSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
-
-    this.initialize();
   }
 
   // Collect all cards that use this workflow.
   private async collectCardsUsingWorkflow(): Promise<Card[]> {
-    const cardTypes = await this.project.cardTypes(ResourcesFrom.localOnly);
+    const cardTypes = this.project.resources.cardTypes();
     const promises: Promise<Card[]>[] = [];
     for (const cardType of cardTypes) {
-      const object = new CardTypeResource(
-        this.project,
-        resourceName(cardType.name),
-      );
-      if (
-        object.data &&
-        (object.data as CardType).workflow ===
-          resourceNameToString(this.resourceName)
-      ) {
-        // fetch all cards with card type
-        promises.push(this.collectCards({ metadata: true }, cardType.name));
+      if (cardType.data?.workflow === resourceNameToString(this.resourceName)) {
+        promises.push(this.collectCards(cardType.data.name));
       }
     }
     return (await Promise.all(promises)).flat();
@@ -82,7 +67,7 @@ export class WorkflowResource extends FileResource {
 
   // Handle change of workflow state.
   private async handleStateChange(op: ChangeOperation<WorkflowState>) {
-    const content = structuredClone(this.content) as Workflow;
+    const content = structuredClone(this.content);
     const stateName = this.targetName(op) as string;
     // Check that state can be changed to
     content.transitions = content.transitions.filter(
@@ -107,7 +92,7 @@ export class WorkflowResource extends FileResource {
   // Handle removal of workflow state.
   // State can be removed with or without replacement.
   private async handleStateRemoval(op: RemoveOperation<WorkflowState>) {
-    const content = structuredClone(this.content) as Workflow;
+    const content = structuredClone(this.content);
     const stateName = this.targetName(op) as string;
 
     // If there is no replacement value, remove all transitions "to" and "from" this state.
@@ -153,8 +138,8 @@ export class WorkflowResource extends FileResource {
   }
 
   // Potentially updates the changed transition with current properties.
-  private async transitionObject(op: ChangeOperation<WorkflowTransition>) {
-    const content = structuredClone(this.content) as Workflow;
+  private transitionObject(op: ChangeOperation<WorkflowTransition>) {
+    const content = structuredClone(this.content);
     const targetTransitionName = this.targetName(op);
     const currentTransition = content.transitions.filter(
       (item) => item.name === targetTransitionName,
@@ -201,20 +186,19 @@ export class WorkflowResource extends FileResource {
 
   // Update dependant card types.
   private async updateCardTypes(oldName: string) {
-    const cardTypes = await this.project.cardTypes(ResourcesFrom.localOnly);
+    const cardTypes = this.project.resources.cardTypes();
     const op = {
       name: 'change',
       target: oldName,
       to: this.content.name,
     } as ChangeOperation<string>;
     for (const cardType of cardTypes) {
-      const object = new CardTypeResource(
-        this.project,
-        resourceName(cardType.name),
+      await cardType.update(
+        {
+          key: 'workflow',
+        },
+        op,
       );
-      if (object.data && (object.data as CardType).workflow === oldName) {
-        await object.update('workflow', op);
-      }
     }
   }
 
@@ -234,21 +218,6 @@ export class WorkflowResource extends FileResource {
     return super.create(newContent);
   }
 
-  /**
-   * Returns content data.
-   */
-  public get data(): Workflow {
-    return super.data as Workflow;
-  }
-
-  /**
-   * Deletes file that this object is based on.
-   * If there are card types that depended on this workflow, they are now invalid.
-   */
-  public async delete() {
-    return super.delete();
-  }
-
   /**
    * Renames the object and the file.
    * @param newName New name for the resource.
@@ -259,25 +228,21 @@ export class WorkflowResource extends FileResource {
     return this.handleNameChange(existingName);
   }
 
-  /**
-   * Shows metadata of the resource.
-   * @returns workflow metadata.
-   */
-  public async show(): Promise<Workflow> {
-    return super.show() as Promise<Workflow>;
-  }
-
   /**
    * Updates workflow resource.
-   * @param key Key to modify
+   * @param updateKey Key to modify
    * @param op Operation to perform on 'key'
    * @throws if key is unknown.
    */
-  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 Workflow;
 
@@ -334,7 +299,7 @@ export class WorkflowResource extends FileResource {
       // If workflow state is removed, remove all transitions "to" and "from" this state.
       let removeOp: RemoveOperation<WorkflowState>;
       if (this.isStringOperation(op)) {
-        const toBeRemovedState = (this.content as Workflow).states.find(
+        const toBeRemovedState = this.content.states.find(
           (state) => state.name === op.target,
         );
         removeOp = {
@@ -349,7 +314,7 @@ export class WorkflowResource extends FileResource {
       // If workflow state is renamed, replace all transitions "to" and "from" the old state with new state.
       let changeOp: ChangeOperation<WorkflowState>;
       if (this.isStringOperation(op)) {
-        const toBeChangedState = (this.content as Workflow).states.find(
+        const toBeChangedState = this.content.states.find(
           (state) => state.name === op.target,
         );
         changeOp = {
@@ -363,7 +328,7 @@ export class WorkflowResource extends FileResource {
       await this.handleStateChange(changeOp);
     }
 
-    await super.postUpdate(content, key, op);
+    await super.postUpdate(content, updateKey, op);
 
     // Renaming this workflow causes that references to its name must be updated.
     if (nameChange) {
@@ -381,14 +346,14 @@ export class WorkflowResource extends FileResource {
    */
   public async usage(cards?: Card[]): Promise<string[]> {
     const resourceName = resourceNameToString(this.resourceName);
-    const allCards = cards ?? (await super.cards());
-    const cardTypes = await this.project.cardTypes(ResourcesFrom.all);
-    const cardTypeReferences = await Promise.all(
-      cardTypes.map(async (cardType) => {
-        const metadata = await this.project.resource<CardType>(cardType.name);
-        return metadata?.workflow === resourceName ? cardType.name : null;
-      }),
-    );
+    const allCards = cards ?? super.cards();
+    const cardTypes = this.project.resources.cardTypes();
+    const cardTypeReferences = [];
+    for (const cardType of cardTypes) {
+      if (cardType.data?.workflow === resourceName) {
+        cardTypeReferences.push(cardType.data.name);
+      }
+    }
 
     const [relevantCards, calculations] = await Promise.all([
       super.usage(allCards),
@@ -401,12 +366,4 @@ export class WorkflowResource extends FileResource {
       ...calculations,
     ];
   }
-
-  /**
-   * Validates workflow.
-   * @throws when there are validation errors.
-   */
-  public validate(content?: object): Promise<void> {
-    return super.validate(content);
-  }
 }