@cyberismo/data-handler 0.0.15 → 0.0.17

package/dist/resources/report-resource.js

@@ -11,40 +11,30 @@
   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 { 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';
-const REPORT_SCHEMA_FILE = 'parameterSchema.json';
 const PARAMETER_SCHEMA_ID = 'jsonSchema';
-const staticDirectoryPath = await getStaticDirectoryPath();
 /**
  * Report resource class.
  */
 export class ReportResource extends FolderResource {
-    reportSchema;
     constructor(project, name) {
         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.
-    defaultReportLocation = join(staticDirectoryPath, 'defaultReport');
-    // Try to read schema file content
-    readSchemaFile(path) {
-        try {
-            const schema = readFileSync(path);
-            return JSON.parse(schema.toString());
-        }
-        catch {
-            return undefined;
-        }
+    async getDefaultReportLocation() {
+        const staticDirectoryPath = await getStaticDirectoryPath();
+        return join(staticDirectoryPath, 'defaultReport');
     }
     /**
      * Handle name changes for reports
@@ -60,14 +50,14 @@ 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.
      */
     async createReport() {
         const defaultContent = DefaultContent.report(resourceNameToString(this.resourceName));
         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();
     }
     /**
      * Returns list of handlebar filenames that this report has.
@@ -126,8 +116,9 @@ export class ReportResource extends FolderResource {
      * @note If content is not provided, base class validation will use resource's current content.
      */
     async validate(content) {
-        if (this.reportSchema) {
-            const errors = Validate.getInstance().validateJson(this.reportSchema, PARAMETER_SCHEMA_ID);
+        const resourceContent = this.contentData();
+        if (resourceContent.schema) {
+            const errors = Validate.getInstance().validateJson(resourceContent.schema, PARAMETER_SCHEMA_ID);
             if (errors.length > 0) {
                 throw new Error(`Invalid parameter schema: ${errors}`);
             }

package/dist/resources/report-resource.js.map

@@ -1 +1 @@
-{"version":3,"file":"report-resource.js","sourceRoot":"","sources":["../../src/resources/report-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAenD,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AAClD,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC,MAAM,mBAAmB,GAAG,MAAM,sBAAsB,EAAE,CAAC;AAE3D;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,cAGnC;IACS,YAAY,CAAS;IAC7B,YAAY,OAAgB,EAAE,IAAkB;QAC9C,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QAEhC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEtE,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACjE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IAED,0BAA0B;IAC1B,gDAAgD;IACxC,qBAAqB,GAAW,IAAI,CAC1C,mBAAmB,EACnB,eAAe,CAChB,CAAC;IAEF,kCAAkC;IAC1B,cAAc,CAAC,IAAY;QACjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,YAAY,CAAC,YAAoB;QAC/C,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,KAAK,CAAC,gBAAgB,CACpB,YAAY,EACZ,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,MAAM,IAAI,CAAC,cAAc,EAAE,CAC5B;YACD,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;SAC1D,CAAC,CAAC;QACH,kCAAkC;QAClC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAC1C,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CACxC,CAAC;QAEF,MAAM,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnC,gDAAgD;QAChD,MAAM,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,OAAO,CACL,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACjC,aAAa,EAAE,IAAI;YACnB,SAAS,EAAE,IAAI;SAChB,CAAC,CACH;aACE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;aACtE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,OAAqB;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CACjB,SAAuB,EACvB,EAAmB;QAEnB,IAAI,SAAS,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;YAEpD,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc;QAC/B,MAAM,QAAQ,GAAG,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QACxC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,YAAY,EAAE;SACrB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAChD,IAAI,CAAC,YAAY,EACjB,mBAAmB,CACpB,CAAC;YACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF"}
+{"version":3,"file":"report-resource.js","sourceRoot":"","sources":["../../src/resources/report-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAYnD,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,cAGnC;IACC,YAAY,OAAgB,EAAE,IAAkB;QAC9C,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;QAEhC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACxE,CAAC;IAED,0BAA0B;IAC1B,gDAAgD;IACxC,KAAK,CAAC,wBAAwB;QACpC,MAAM,mBAAmB,GAAG,MAAM,sBAAsB,EAAE,CAAC;QAC3D,OAAO,IAAI,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,YAAY,CAAC,YAAoB;QAC/C,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,KAAK,CAAC,gBAAgB,CACpB,YAAY,EACZ,IAAI,CAAC,OAAO,CAAC,IAAI,EACjB,MAAM,IAAI,CAAC,cAAc,EAAE,CAC5B;YACD,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;SAC1D,CAAC,CAAC;QACH,kCAAkC;QAClC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAY;QACvB,MAAM,cAAc,GAAG,cAAc,CAAC,MAAM,CAC1C,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CACxC,CAAC;QAEF,MAAM,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEnC,gDAAgD;QAChD,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;QACpE,MAAM,OAAO,CAAC,qBAAqB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1D,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc;QACzB,OAAO,CACL,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE;YACjC,aAAa,EAAE,IAAI;YACnB,SAAS,EAAE,IAAI;SAChB,CAAC,CACH;aACE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;aACtE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,OAAqB;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CACjB,SAAuB,EACvB,EAAmB;QAEnB,IAAI,SAAS,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;YAEpD,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;YAC/C,OAAO;QACT,CAAC;QAED,MAAM,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc;QAC/B,MAAM,QAAQ,GAAG,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QACxC,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,YAAY,EAAE;SACrB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3C,IAAI,eAAe,CAAC,MAAM,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAChD,eAAe,CAAC,MAAM,EACtB,mBAAmB,CACpB,CAAC;YACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,EAAE,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF"}

package/dist/resources/resource-object.d.ts

@@ -9,11 +9,11 @@
     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 ResourceName } from '../utils/resource-utils.js';
 import type { Card, ResourceFolderType } from '../interfaces/project-interfaces.js';
 import type { Logger } from 'pino';
 import type { Project } from '../containers/project.js';
 import type { ResourceBaseMetadata, UpdateKey } from '../interfaces/resource-interfaces.js';
-import { type ResourceName } from '../utils/resource-utils.js';
 export type UpdateOperations = 'add' | 'change' | 'rank' | 'remove';
 type BaseOperation<T> = {
     name: 'add' | 'change' | 'rank' | 'remove';
@@ -57,7 +57,7 @@ export declare abstract class AbstractResource<T extends ResourceBaseMetadata, U
     protected abstract delete(): Promise<void>;
     protected abstract read(): Promise<void>;
     protected abstract rename(newName: ResourceName): Promise<void>;
-    protected abstract show(): Promise<ShowReturnType<T, U>>;
+    protected abstract show(): ShowReturnType<T, U>;
     protected abstract update<Type, K extends string>(updateKey: UpdateKey<K>, operation: Operation<Type>): Promise<void>;
     protected abstract usage(cards?: Card[]): Promise<string[]>;
     protected abstract validate(content?: object): Promise<void>;
@@ -68,7 +68,6 @@ export declare abstract class AbstractResource<T extends ResourceBaseMetadata, U
 export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U> extends AbstractResource<T, U> {
     protected project: Project;
     protected resourceName: ResourceName;
-    private cache;
     private static validateInstancePromise?;
     protected content: T;
     protected moduleResource: boolean;
@@ -81,18 +80,35 @@ export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U>
      * Path to the resource metadata file (the .json file).
      */
     fileName: string;
+    /**
+     * Constructs a ResourceObject instance
+     * @param project Project where this resource is
+     * @param resourceName Name for the resource
+     * @param type Type of resource
+     */
     constructor(project: Project, resourceName: ResourceName, type: ResourceFolderType);
+    private exists;
     private static getValidate;
-    private resourceObjectToResource;
+    private reportHandlerBarFiles;
     private resourceType;
-    private toCache;
     /**
-     * Checks if resource exists
+     * Checks if resource exists.
+     * This should only throw, if someone creates resources directly; ie. not through the cache
      * @throws if resource does not exist
      */
     protected assertResourceExists(): void;
+    /**
+     * Calculate; empty implementation.
+     */
     protected calculate(): Promise<void>;
+    /**
+     * Calculations that use this resource.
+     * @throws if accessing calculations files failed
+     */
     protected calculations(): Promise<string[]>;
+    /**
+     * Cards from project.
+     */
     protected cards(): Card[];
     /**
      * Returns .schema content file.
@@ -100,8 +116,21 @@ export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U>
      * @returns .schema content.
      */
     protected contentSchemaContent(schemaId: string): JSON;
+    /**
+     * Creates resource.
+     * @param newContent Content for resource.
+     * @throws when resource already exists in the project.
+     */
     protected create(newContent?: T): Promise<void>;
+    /**
+     * Gets a logger instance.
+     * @param loggerName
+     * @returns logger instance
+     */
     protected getLogger(loggerName: string): Logger;
+    /**
+     * Returns type of this resource.
+     */
     protected get getType(): string;
     /**
      * Handles operation to an array.
@@ -109,23 +138,61 @@ export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U>
      * @param arrayName Name of the array, for error messages.
      * @param array Array to be updated.
      * @returns Changed array after the operation.
+     * @throws when operation cannot be done.
      */
     protected handleArray<Type>(operation: Operation<Type>, arrayName: string, array: Type[]): Type[];
     /**
      * Updates scalar value. The only accepted operation is 'change'
      * @param operation Operation to perform on scalar.
      * @returns What the scalar should be changed to.
+     * @throws when operation cannot be done
      */
     protected handleScalar<Type>(operation: Operation<Type>): Type;
+    /**
+     * Initialize the resource.
+     */
     protected initialize(): void;
+    protected logResourceOperation<Type>(operationType: 'create' | 'delete' | 'update' | 'rename', op?: Operation<Type>, key?: string): Promise<void>;
+    /**
+     * Called after inherited class has finished 'update' operation.
+     * @param content New content for resource
+     * @param updateKey Which property to change
+     * @param op What kind of operation is performed to updateKey
+     * @throws if validation fails after the update
+     */
     protected postUpdate<Type, K extends string>(content: T, updateKey: UpdateKey<K>, op: Operation<Type>): Promise<void>;
-    protected update<Type, K extends string>(key: UpdateKey<K>, _op: Operation<Type>): Promise<void>;
+    /**
+     * Reads content from file to memory.
+     */
     protected read(): Promise<void>;
+    /**
+     * Renames resource.
+     * @param newName New name for the resource.
+     * @throws if trying to rename module resource, or
+     *         if resource does not exist,
+     *         if trying to rename so that type changes
+     */
     protected rename(newName: ResourceName): Promise<void>;
+    /**
+     * Update resource; the base class makes some checks only.
+     * @template type Resource type
+     * @template K Resource key
+     * @throws if resource does not exist, or
+     *         if trying to update module content, or
+     *         if key is empty
+     */
+    protected update<Type, K extends string>(key: UpdateKey<K>, _op: Operation<Type>): Promise<void>;
+    /**
+     * Validates resource identifier to prevent filesystem operations with invalid names
+     * todo: To Validate?
+     */
+    protected validateResourceIdentifier(): void;
     /**
      * Update calculation files.
      * @param from Resource name to update
      * @param to New name for resource
+     * @throws if 'from' or 'to' is empty string, or
+     *         if there was error accessing calculation files.
      */
     protected updateCalculations(from: string, to: string): Promise<void>;
     /**
@@ -133,10 +200,26 @@ export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U>
      * @param from Resource name to update
      * @param to New name for resource
      * @param handleBarFiles Optional. List of handlebar files. If omitted, affects all handlebar files in the project.
+     * @throws if 'from' or 'to' is empty string
      */
     protected updateHandleBars(from: string, to: string, handleBarFiles?: string[]): Promise<void>;
+    /**
+     * Check if there are references to the resource in the card content.
+     * @note that this needs to be async, since inherited classes need to async operations
+     * @param cards cards to check
+     * @throws if resource does not exist
+     */
     protected usage(cards?: Card[]): Promise<string[]>;
+    /**
+     * Checks if resource name is valid.
+     * @param newName New name for resource.
+     * @returns valid name
+     */
     protected validName(newName: ResourceName): Promise<string>;
+    /**
+     * Write the content from memory to disk.
+     * @throws if trying to write a module resource.
+     */
     protected write(): Promise<void>;
     /**
      * Returns memory resident data as JSON.
@@ -146,12 +229,15 @@ export declare abstract class ResourceObject<T extends ResourceBaseMetadata, U>
     get data(): T | undefined;
     /**
      * Deletes the file and removes the resource from project.
-     * @throws if resource is a module resource or does not exist or is used by other resources.
+     * @throws if resource is a module resource, or
+     *         if resource does not exist, or
+     *         if resource is used by other resources.
      */
     delete(): Promise<void>;
     /**
      * Validates the content of the resource.
      * @param content Content to be validated.
+     * @throws if content is invalid.
      */
     validate(content?: object): Promise<void>;
 }