@cyberismo/data-handler 0.0.15 → 0.0.17

package/src/resources/folder-resource.ts

@@ -15,71 +15,55 @@
 import { basename, dirname, join, normalize } from 'node:path';
 import { mkdir, readdir, readFile, rename, rm } from 'node:fs/promises';
 
-import type { Card, Operation, ResourceName } from './file-resource.js';
-import type { ResourceBaseMetadata } from '../interfaces/resource-interfaces.js';
-import {
-  isContentKey,
-  type UpdateKey,
-} from '../interfaces/resource-interfaces.js';
-import type { ResourceFolderType } from '../interfaces/project-interfaces.js';
-
-import {
-  DefaultContent,
-  FileResource,
-  Project,
-  resourceName,
-  resourceNameToString,
-  sortCards,
-} from './file-resource.js';
-import type { FolderResourceContent } from '../interfaces/folder-content-interfaces.js';
+import { isContentKey } from '../interfaces/resource-interfaces.js';
 import {
   filename,
-  propertyName,
+  contentPropertyName,
 } from '../interfaces/folder-content-interfaces.js';
-import { formatJson, readJsonFile } from '../utils/json.js';
+import { formatJson } from '../utils/json.js';
 import { VALID_FOLDER_RESOURCE_FILES } from '../utils/constants.js';
 import { writeFileSafe } from '../utils/file-utils.js';
-import type { ShowReturnType } from './resource-object.js';
 import { ResourceObject } from './resource-object.js';
+import { resourceName } from '../utils/resource-utils.js';
 
-export {
-  type Card,
-  DefaultContent,
-  FileResource,
-  type Operation,
-  Project,
-  ResourceName,
-  resourceNameToString,
-  sortCards,
-};
+import type { UpdateKey } from '../interfaces/resource-interfaces.js';
+import type { FolderResourceContent } from '../interfaces/folder-content-interfaces.js';
+import type { Operation } from './resource-object.js';
+import type { Project } from '../containers/project.js';
+import type { ResourceFolderType } from '../interfaces/project-interfaces.js';
+import type { ResourceBaseMetadata } from '../interfaces/resource-interfaces.js';
+import type { ResourceName } from '../utils/resource-utils.js';
+import type { ShowReturnType } from './resource-object.js';
 
 /**
- * Folder type resource class. These are resources that have their own folders for content.
+ * Folder type resource class.
+ * These are resources that have their own folders for content.
  */
 export abstract class FolderResource<
   T extends ResourceBaseMetadata,
   U extends FolderResourceContent,
 > extends ResourceObject<T, U> {
   protected internalFolder: string = '';
+  private resourceContent: U = {} as U;
 
-  // Cache for content files to avoid repeated filesystem operations. Content is stored as string.
-  private contentFilesCache = new Map<string, string>();
-
+  /**
+   * Constructs a FolderResource object.
+   * @param project Project in which this resource exists.
+   * @param name Name for the resource.
+   * @param type Type for this resource.
+   */
   constructor(project: Project, name: ResourceName, type: ResourceFolderType) {
     super(project, name, type);
     this.initialize();
   }
 
-  // Clears the content files cache.
-  private clearContentCache() {
-    this.contentFilesCache.clear();
-  }
-
   /**
    * Creates a new folder type object. Base class writes the object to disk automatically.
    * @param newContent Content for the type.
    */
   protected async create(newContent?: T) {
+    // Validate resource identifier before creating on disk
+    this.validateResourceIdentifier();
     await super.create(newContent);
     await mkdir(this.internalFolder, { recursive: true });
   }
@@ -103,65 +87,36 @@ export abstract class FolderResource<
   protected abstract onNameChange?(previousName: string): Promise<void>;
 
   /**
-   * Renames resource metadata file and renames memory resident object 'name'.
-   * @param newName New name for the resource.
+   * Set content files. Should not be called by others than resource cache.
    */
-  protected async rename(newName: ResourceName) {
-    return super.rename(newName);
-  }
+  public setContentFiles(contentFiles: Map<string, string>) {
+    const content = {} as Record<string, unknown>;
 
-  /**
-   * Shows the content of a file in the resource.
-   * @param fileName Name of the file to show.
-   * @param json Content is JSON file.
-   * @returns the content of the file.
-   */
-  protected async showFile(
-    fileName: string,
-    json: boolean = false,
-  ): Promise<string> {
-    // Always first check cache...
-    if (this.contentFilesCache.has(fileName)) {
-      const cached = this.contentFilesCache.get(fileName)!;
-      return json ? JSON.parse(cached) : cached;
+    for (const [fileName, fileContent] of contentFiles.entries()) {
+      const key = contentPropertyName(fileName);
+      if (key) {
+        const isJson = key === 'schema';
+        content[key] = isJson ? JSON.parse(fileContent) : fileContent;
+      }
     }
 
-    // ...cache miss, read from filesystem
-    const filePath = join(this.internalFolder, fileName);
-    const content = json
-      ? await readJsonFile(filePath)
-      : await readFile(filePath, 'utf8');
-
-    // Update cache
-    const contentStr =
-      typeof content === 'string' ? content : formatJson(content);
-    this.contentFilesCache.set(fileName, contentStr);
-
-    return json ? content : contentStr;
+    this.resourceContent = content as U;
   }
 
   /**
-   * Shows all file names in the resource.
-   * @returns all file names in the resource.
+   * Load all content files from the internal folder and set them.
    */
-  protected async showFileNames(): Promise<string[]> {
-    // Always first check cache...
-    if (this.contentFilesCache.size > 0) {
-      return Array.from(this.contentFilesCache.keys());
-    }
-
-    // ...cache miss, read from filesystem and populate cache
-    const files = await readdir(this.internalFolder);
-    const validFiles = files.filter((file) =>
-      VALID_FOLDER_RESOURCE_FILES.includes(file),
-    );
-
-    // Update cache by reading all files. Each method call updates specific cache item.
-    for (const fileName of validFiles) {
-      await this.showFile(fileName);
+  protected async loadContentFiles() {
+    const contentFiles = new Map<string, string>();
+    const files = await readdir(this.internalFolder, { withFileTypes: true });
+    for (const file of files) {
+      if (file.isFile() && VALID_FOLDER_RESOURCE_FILES.includes(file.name)) {
+        const filePath = join(this.internalFolder, file.name);
+        const content = await readFile(filePath, 'utf-8');
+        contentFiles.set(file.name, content);
+      }
     }
-
-    return validFiles;
+    this.setContentFiles(contentFiles);
   }
 
   /**
@@ -169,7 +124,7 @@ export abstract class FolderResource<
    * @param fileName The name of the file to update.
    * @param changedContent The new content for the file.
    */
-  protected async updateFile(fileName: string, changedContent: string) {
+  public async updateFile(fileName: string, changedContent: string) {
     const filePath = join(this.internalFolder, fileName);
 
     // Do not allow updating file in other directories
@@ -190,8 +145,14 @@ export abstract class FolderResource<
 
     await writeFileSafe(filePath, changedContent, { flag: 'w' });
 
-    // Update cache with new content
-    this.contentFilesCache.set(fileName, changedContent);
+    // Update this resource's content
+    const key = contentPropertyName(fileName);
+    if (key) {
+      const isJson = key === 'schema';
+      (this.resourceContent as Record<string, unknown>)[key] = isJson
+        ? JSON.parse(changedContent)
+        : changedContent;
+    }
   }
 
   /**
@@ -214,32 +175,33 @@ export abstract class FolderResource<
    * Gets content of all files to properties.
    * @returns object with property names as keys and file contents as values.
    */
-  public async contentData(): Promise<U> {
-    const fileNames = await this.showFileNames();
-    const content = {} as Record<string, unknown>;
-
-    for (const fileName of fileNames) {
-      const name = propertyName(fileName);
-      if (name) {
-        const JSONFile = name === 'schema';
-        content[name] = await this.showFile(fileName, JSONFile);
-      }
-    }
-
+  public contentData(): U {
     // TODO: Instead of casting, validate that content matches U
     // This requires a runtime schema for U to be defined(via an abstract variable)
 
-    return content as U;
+    return this.resourceContent;
   }
 
   /**
    * Deletes file and content folder from disk and clears out the memory resident object.
-   * @throws if resource is a module resource or does not exist or is used by other resources.
    */
   public async delete() {
     await super.delete();
     await rm(this.internalFolder, { recursive: true, force: true });
-    this.clearContentCache();
+  }
+
+  /**
+   * Shows metadata of the resource and content of the resource.
+   * @template T Resource type
+   * @template U Resource content
+   * @returns resource type's metadata and content.
+   */
+  public show(): ShowReturnType<T, U> {
+    this.assertResourceExists();
+    return {
+      ...this.content,
+      content: this.contentData(),
+    };
   }
 
   /**
@@ -286,17 +248,4 @@ export abstract class FolderResource<
       await this.onNameChange?.(existingName);
     }
   }
-
-  /**
-   * Shows metadata of the resource and content of the resource.
-   * @returns resource type's metadata and content.
-   * @throws if resource does not exist.
-   */
-  public async show(): Promise<ShowReturnType<T, U>> {
-    this.assertResourceExists();
-    return {
-      ...this.content,
-      content: await this.contentData(),
-    };
-  }
 }

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

@@ -14,24 +14,22 @@
 
 import { join } from 'node:path';
 
-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 { writeFileSafe } from '../utils/file-utils.js';
+import { CONTENT_FILES } from '../interfaces/folder-content-interfaces.js';
+
+import type { Card } from '../interfaces/project-interfaces.js';
 import type {
   GraphModelMetadata,
   UpdateKey,
 } from '../interfaces/resource-interfaces.js';
 import type { GraphModelContent } from '../interfaces/folder-content-interfaces.js';
-import { writeFileSafe } 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 model resource class.
@@ -54,7 +52,7 @@ export class GraphModelResource extends FolderResource<
   protected async onNameChange(existingName: string): Promise<void> {
     await Promise.all([
       super.updateHandleBars(existingName, this.content.name, [
-        join(this.internalFolder, 'model.lp'),
+        join(this.internalFolder, CONTENT_FILES.model),
       ]),
       super.updateCalculations(existingName, this.content.name),
     ]);
@@ -79,14 +77,14 @@ export class GraphModelResource extends FolderResource<
     await super.create(newContent);
 
     // Create the internal folder in 'create', instead of 'write'.
-    const calculationsFile = join(this.internalFolder, 'model.lp');
-    await writeFileSafe(
-      calculationsFile,
-      `% add your calculations here for '${this.resourceName.identifier}'`,
-      {
-        flag: 'wx',
-      },
-    );
+    const modelContent = `% add your calculations here for '${this.resourceName.identifier}'`;
+    const modelFile = CONTENT_FILES.model;
+    const calculationsFile = join(this.internalFolder, modelFile);
+    await writeFileSafe(calculationsFile, modelContent, {
+      flag: 'wx',
+    });
+
+    await this.loadContentFiles();
   }
 
   /**

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

@@ -12,29 +12,25 @@
   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 type {
-  Card,
-  Operation,
-  Project,
-  ResourceName,
-} from './folder-resource.js';
-import {
-  DefaultContent,
-  FolderResource,
-  resourceNameToString,
-  sortCards,
-} from './folder-resource.js';
+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 {
   GraphViewMetadata,
   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.
@@ -83,6 +79,8 @@ export class GraphViewResource extends FolderResource<
       join(await getStaticDirectoryPath(), 'defaultGraphView'),
       this.internalFolder,
     );
+
+    await this.loadContentFiles();
   }
 
   /**

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

@@ -10,19 +10,16 @@
     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 { 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.
@@ -38,7 +35,7 @@ export class LinkTypeResource extends FileResource<LinkType> {
   // When resource name changes.
   private async handleNameChange(existingName: string) {
     const current = this.content;
-    const prefixes = await this.project.projectPrefixes();
+    const prefixes = this.project.projectPrefixes();
     if (current.sourceCardTypes) {
       current.sourceCardTypes = current.sourceCardTypes.map((item) =>
         this.updatePrefixInResourceName(item, prefixes),

package/src/resources/report-resource.ts

@@ -12,38 +12,29 @@
   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 { 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 ReportMetadata,
-  type UpdateKey,
+  ReportMetadata,
+  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.
  */
@@ -51,32 +42,18 @@ export class ReportResource extends FolderResource<
   ReportMetadata,
   ReportContent
 > {
-  private reportSchema: Schema;
   constructor(project: Project, name: ResourceName) {
     super(project, name, 'reports');
 
     this.contentSchemaId = 'reportSchema';
     this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
-
-    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');
   }
 
   /**
@@ -98,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(
@@ -109,7 +84,9 @@ export class ReportResource extends FolderResource<
     await super.create(defaultContent);
 
     // Copy report default structure to destination.
-    await copyDir(this.defaultReportLocation, this.internalFolder);
+    const defaultReportLocation = await this.getDefaultReportLocation();
+    await copyDir(defaultReportLocation, this.internalFolder);
+    await this.loadContentFiles();
   }
 
   /**
@@ -180,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) {