@cyberismo/data-handler 0.0.2

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

@@ -0,0 +1,77 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program is distributed in the hope that it
+  will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Affero General Public License for more details.
+  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 { Card, Operation, Project, ResourceName } from './folder-resource.js';
+import { FolderResource } from './folder-resource.js';
+import type { Report, ReportMetadata } from '../interfaces/resource-interfaces.js';
+/**
+ * Report resource class.
+ */
+export declare class ReportResource extends FolderResource {
+    private reportSchema;
+    constructor(project: Project, name: ResourceName);
+    private defaultReportLocation;
+    private handleNameChange;
+    private readSchemaFile;
+    /**
+     * Sets new metadata into the report object.
+     * @param newContent metadata content for the report.
+     * @throws if 'newContent' is not valid.
+     */
+    createReport(): Promise<void>;
+    /**
+     * Returns resource content.
+     */
+    get data(): ReportMetadata;
+    /**
+     * Deletes file and folder that this resource is based on.
+     */
+    delete(): Promise<void>;
+    /**
+     * Returns list of handlebar filenames that this report has.
+     * @returns list of handlebar filenames that this report has.
+     */
+    handleBarFiles(): Promise<string[]>;
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    rename(newName: ResourceName): Promise<void>;
+    /**
+     * Shows metadata of the resource.
+     * @returns report metadata.
+     */
+    show(): Promise<Report>;
+    /**
+     * Updates report resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     * @throws if key is unknown.
+     */
+    update<Type>(key: string, op: Operation<Type>): Promise<void>;
+    /**
+     * List where this resource is used.
+     * Always returns card key references first, then calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys and calculation filenames that refer this resource.
+     */
+    usage(cards?: Card[]): Promise<string[]>;
+    /**
+     * Validates report.
+     * @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.
+     */
+    validate(content?: object): Promise<void>;
+}

package/dist/resources/report-resource.js

@@ -0,0 +1,171 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program is distributed in the hope that it
+  will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Affero General Public License for more details.
+  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, readFile } from 'node:fs/promises';
+import { readFileSync } from 'node:fs';
+import { extname, join } from 'node:path';
+import { copyDir } from '../utils/file-utils.js';
+import { DefaultContent, FolderResource, resourceNameToString, sortCards, } from './folder-resource.js';
+import { getStaticDirectoryPath } from '@cyberismocom/resources';
+const CARD_CONTENT_HANDLEBAR_FILE = 'index.adoc.hbs';
+const QUERY_HANDLEBAR_FILE = 'query.lp.hbs';
+const REPORT_SCHEMA_FILE = 'parameterSchema.json';
+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);
+        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.
+    defaultReportLocation = join(staticDirectoryPath, 'defaultReport');
+    // When resource name changes.
+    async handleNameChange(existingName) {
+        await Promise.all([
+            super.updateHandleBars(existingName, this.content.name, await this.handleBarFiles()),
+            super.updateCalculations(existingName, this.content.name),
+        ]);
+        // Finally, write updated content.
+        await this.write();
+    }
+    // Try to read schema file content
+    readSchemaFile(path) {
+        try {
+            const schema = readFileSync(path);
+            return JSON.parse(schema.toString());
+        }
+        catch {
+            return undefined;
+        }
+    }
+    /**
+     * 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);
+    }
+    /**
+     * Returns resource content.
+     */
+    get data() {
+        return super.data;
+    }
+    /**
+     * Deletes file and folder that this resource is based on.
+     */
+    async delete() {
+        return super.delete();
+    }
+    /**
+     * Returns list of handlebar filenames that this report has.
+     * @returns list of handlebar filenames that this report has.
+     */
+    async handleBarFiles() {
+        return (await readdir(this.internalFolder, {
+            withFileTypes: true,
+            recursive: true,
+        }))
+            .filter((dirent) => dirent.isFile() && extname(dirent.name) === '.hbs')
+            .map((item) => join(item.parentPath, item.name));
+    }
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    async rename(newName) {
+        const existingName = this.content.name;
+        await super.rename(newName);
+        return this.handleNameChange(existingName);
+    }
+    /**
+     * Shows metadata of the resource.
+     * @returns report metadata.
+     */
+    async show() {
+        const reportMetadata = (await super.show());
+        return {
+            name: resourceNameToString(this.resourceName),
+            metadata: reportMetadata,
+            contentTemplate: (await readFile(join(this.internalFolder, CARD_CONTENT_HANDLEBAR_FILE))).toString(),
+            queryTemplate: (await readFile(join(this.internalFolder, QUERY_HANDLEBAR_FILE))).toString(),
+            schema: this.reportSchema,
+        };
+    }
+    /**
+     * Updates report resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     * @throws if key is unknown.
+     */
+    async update(key, op) {
+        const nameChange = key === 'name';
+        const existingName = this.content.name;
+        await super.update(key, op);
+        const content = { ...this.content };
+        if (key === 'name') {
+            content.name = super.handleScalar(op);
+        }
+        else if (key === 'displayName') {
+            content.displayName = super.handleScalar(op);
+        }
+        else if (key === 'description') {
+            content.description = super.handleScalar(op);
+        }
+        else if (key === 'category') {
+            content.category = super.handleScalar(op);
+        }
+        await super.postUpdate(content, key, op);
+        // Renaming this report causes that references to its name must be updated.
+        if (nameChange) {
+            await this.handleNameChange(existingName);
+        }
+    }
+    /**
+     * List where this resource is used.
+     * Always returns card key references first, then calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys and calculation filenames that refer this resource.
+     */
+    async usage(cards) {
+        const allCards = cards ?? (await super.cards());
+        const [relevantCards, calculations] = await Promise.all([
+            super.usage(allCards),
+            super.calculations(),
+        ]);
+        return [...relevantCards.sort(sortCards), ...calculations];
+    }
+    /**
+     * Validates report.
+     * @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.
+     */
+    async validate(content) {
+        return super.validate(content);
+    }
+}
+//# sourceMappingURL=report-resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"report-resource.js","sourceRoot":"","sources":["../../src/resources/report-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACrD,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;AAOjD,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,sBAAsB,CAAC;AAM9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,MAAM,2BAA2B,GAAG,gBAAgB,CAAC;AACrD,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAC5C,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AAElD,MAAM,mBAAmB,GAAG,MAAM,sBAAsB,EAAE,CAAC;AAE3D;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,cAAc;IACxC,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,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,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,8BAA8B;IACtB,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QACjD,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,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;;;;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;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,KAAK,CAAC,IAAsB,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,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,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,cAAc,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,EAAE,CAAmB,CAAC;QAC9D,OAAO;YACL,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7C,QAAQ,EAAE,cAAc;YACxB,eAAe,EAAE,CACf,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC,CACvE,CAAC,QAAQ,EAAE;YACZ,aAAa,EAAE,CACb,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC,CAChE,CAAC,QAAQ,EAAE;YACZ,MAAM,EAAE,IAAI,CAAC,YAAY;SAC1B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAO,GAAW,EAAE,EAAmB;QACxD,MAAM,UAAU,GAAG,GAAG,KAAK,MAAM,CAAC;QAClC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAEvC,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,EAAE,GAAI,IAAI,CAAC,OAA0B,EAAE,CAAC;QAExD,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QAClD,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACzD,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACzD,CAAC;aAAM,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YAC9B,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACtD,CAAC;QAED,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAEzC,2EAA2E;QAC3E,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc;QAC/B,MAAM,QAAQ,GAAG,KAAK,IAAI,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAChD,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,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF"}

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

@@ -0,0 +1,108 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    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 { Card, ResourceFolderType } from '../interfaces/project-interfaces.js';
+import { type Project } from '../containers/project.js';
+import type { ResourceContent } 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';
+    target: T;
+};
+export type AddOperation<T> = BaseOperation<T> & {
+    name: 'add';
+};
+export type ChangeOperation<T> = BaseOperation<T> & {
+    name: 'change';
+    to: T;
+};
+export type RankOperation<T> = BaseOperation<T> & {
+    name: 'rank';
+    newIndex: number;
+};
+export type RemoveOperation<T> = BaseOperation<T> & {
+    name: 'remove';
+    replacementValue?: T;
+};
+export type Operation<T> = AddOperation<T> | ChangeOperation<T> | RankOperation<T> | RemoveOperation<T>;
+/**
+ * Abstract class for resources.
+ */
+export declare abstract class AbstractResource {
+    protected abstract calculate(): Promise<void>;
+    protected abstract create(content?: ResourceContent): Promise<void>;
+    protected abstract delete(): Promise<void>;
+    protected abstract read(): Promise<void>;
+    protected abstract rename(newName: ResourceName): Promise<void>;
+    protected abstract show(): Promise<ResourceContent>;
+    protected abstract update<Type>(key: string, operation: Operation<Type>): Promise<void>;
+    protected abstract usage(cards?: Card[]): Promise<string[]>;
+    protected abstract validate(content?: object): Promise<void>;
+    protected abstract write(): Promise<void>;
+}
+/**
+ * Base class for all resources.
+ */
+export declare class ResourceObject extends AbstractResource {
+    protected project: Project;
+    protected resourceName: ResourceName;
+    protected moduleResource: boolean;
+    protected contentSchema: JSON;
+    protected contentSchemaId: string;
+    protected type: ResourceFolderType;
+    protected resourceFolder: string;
+    constructor(project: Project, resourceName: ResourceName);
+    protected calculate(): Promise<void>;
+    protected create(_content?: ResourceContent): Promise<void>;
+    protected delete(): Promise<void>;
+    protected read(): Promise<void>;
+    protected rename(_name: ResourceName): Promise<void>;
+    protected show(): Promise<ResourceContent>;
+    protected update<Type>(_key: string, _op: Operation<Type>): Promise<void>;
+    protected usage(_cards?: Card[]): Promise<string[]>;
+    protected validate(_content?: object): Promise<void>;
+    protected write(): Promise<void>;
+    /**
+     * Returns .schema content file.
+     * @param schemaId schema id
+     * @returns .schema content.
+     */
+    protected contentSchemaContent(schemaId: string): JSON;
+    /**
+     * Handles operation to an array.
+     * @param operation Operation to perform on array.
+     * @param arrayName Name of the array, for error messages.
+     * @param array Array to be updated.
+     * @returns Changed array after the operation.
+     */
+    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.
+     */
+    protected handleScalar<Type>(operation: Operation<Type>): Type;
+    /**
+     * Update calculation files.
+     * @param from Resource name to update
+     * @param to New name for resource
+     */
+    protected updateCalculations(from: string, to: string): Promise<void>;
+    /**
+     * Update references in handlebars.
+     * @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.
+     */
+    protected updateHandleBars(from: string, to: string, handleBarFiles?: string[]): Promise<void>;
+}
+export {};

package/dist/resources/resource-object.js

@@ -0,0 +1,147 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    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/>.
+*/
+/* eslint-disable @typescript-eslint/no-unused-vars */
+// node
+import { readFile, writeFile } from 'node:fs/promises';
+import { basename, join } from 'node:path';
+import { ArrayHandler } from './array-handler.js';
+import { ResourcesFrom } from '../containers/project.js';
+/**
+ * Abstract class for resources.
+ */
+export class AbstractResource {
+}
+/**
+ * Base class for all resources.
+ */
+export class ResourceObject extends AbstractResource {
+    project;
+    resourceName;
+    moduleResource;
+    contentSchema = {};
+    contentSchemaId = '';
+    type = '';
+    resourceFolder = '';
+    constructor(project, resourceName) {
+        super();
+        this.project = project;
+        this.resourceName = resourceName;
+        this.moduleResource =
+            this.resourceName.prefix !== this.project.projectPrefix;
+    }
+    async calculate() { }
+    async create(_content) { }
+    async delete() { }
+    async read() { }
+    async rename(_name) { }
+    async show() {
+        return {};
+    }
+    async update(_key, _op) { }
+    async usage(_cards) {
+        return [];
+    }
+    async validate(_content) { }
+    async write() { }
+    /**
+     * Returns .schema content file.
+     * @param schemaId schema id
+     * @returns .schema content.
+     */
+    contentSchemaContent(schemaId) {
+        return [
+            {
+                id: schemaId,
+                version: 1,
+            },
+        ];
+    }
+    /**
+     * Handles operation to an array.
+     * @param operation Operation to perform on array.
+     * @param arrayName Name of the array, for error messages.
+     * @param array Array to be updated.
+     * @returns Changed array after the operation.
+     */
+    handleArray(operation, arrayName, array) {
+        const handler = new ArrayHandler();
+        let result = [];
+        try {
+            result = handler.handleArray(operation, array);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                throw new Error(`Cannot perform operation on '${arrayName}'. ${error.message}`);
+            }
+        }
+        return result;
+    }
+    /**
+     * Updates scalar value. The only accepted operation is 'change'
+     * @param operation Operation to perform on scalar.
+     * @returns What the scalar should be changed to.
+     */
+    handleScalar(operation) {
+        if (operation.name === 'add' ||
+            operation.name === 'rank' ||
+            operation.name === 'remove') {
+            throw new Error(`Cannot do operation ${operation.name} on scalar value`);
+        }
+        return operation.to;
+    }
+    /**
+     * Update calculation files.
+     * @param from Resource name to update
+     * @param to New name for resource
+     */
+    async updateCalculations(from, to) {
+        if (!from.trim() || !to.trim()) {
+            throw new Error('updateCalculations: "from" and "to" parameters must not be empty');
+        }
+        const calculations = await this.project.calculations(ResourcesFrom.localOnly);
+        await Promise.all(calculations.map(async (calculation) => {
+            if (!calculation.path) {
+                throw new Error(`Calculation file's '${calculation.name}' path is not defined`);
+            }
+            const filename = join(calculation.path, basename(calculation.name));
+            try {
+                const content = await readFile(filename, 'utf-8');
+                const updatedContent = content.replaceAll(from, to);
+                await writeFile(filename, updatedContent);
+            }
+            catch (error) {
+                throw new Error(`Failed to process file ${filename}: ${error.message}`);
+            }
+        }));
+    }
+    /**
+     * Update references in handlebars.
+     * @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.
+     */
+    async updateHandleBars(from, to, handleBarFiles) {
+        if (!from.trim() || !to.trim()) {
+            throw new Error('updateHandleBars: "from" and "to" parameters must not be empty');
+        }
+        if (!handleBarFiles) {
+            handleBarFiles = await this.project.reportHandlerBarFiles(ResourcesFrom.localOnly);
+        }
+        // Process all files in parallel.
+        await Promise.all(handleBarFiles.map(async (handleBarFile) => {
+            const content = await readFile(handleBarFile);
+            const updatedContent = content.toString().replaceAll(from, to);
+            await writeFile(handleBarFile, Buffer.from(updatedContent));
+        }));
+    }
+}
+//# sourceMappingURL=resource-object.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resource-object.js","sourceRoot":"","sources":["../../src/resources/resource-object.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,sDAAsD;AAEtD,OAAO;AACP,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAKlD,OAAO,EAAgB,aAAa,EAAE,MAAM,0BAA0B,CAAC;AA2CvE;;GAEG;AACH,MAAM,OAAgB,gBAAgB;CAcrC;AAED;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,gBAAgB;IAQtC;IACA;IARF,cAAc,CAAU;IACxB,aAAa,GAAS,EAAU,CAAC;IACjC,eAAe,GAAW,EAAE,CAAC;IAC7B,IAAI,GAAuB,EAAwB,CAAC;IACpD,cAAc,GAAW,EAAE,CAAC;IAEtC,YACY,OAAgB,EAChB,YAA0B;QAEpC,KAAK,EAAE,CAAC;QAHE,YAAO,GAAP,OAAO,CAAS;QAChB,iBAAY,GAAZ,YAAY,CAAc;QAGpC,IAAI,CAAC,cAAc;YACjB,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IAC5D,CAAC;IAES,KAAK,CAAC,SAAS,KAAI,CAAC;IACpB,KAAK,CAAC,MAAM,CAAC,QAA0B,IAAG,CAAC;IAC3C,KAAK,CAAC,MAAM,KAAI,CAAC;IACjB,KAAK,CAAC,IAAI,KAAI,CAAC;IACf,KAAK,CAAC,MAAM,CAAC,KAAmB,IAAG,CAAC;IACpC,KAAK,CAAC,IAAI;QAClB,OAAO,EAAqB,CAAC;IAC/B,CAAC;IACS,KAAK,CAAC,MAAM,CAAO,IAAY,EAAE,GAAoB,IAAG,CAAC;IACzD,KAAK,CAAC,KAAK,CAAC,MAAe;QACnC,OAAO,EAAE,CAAC;IACZ,CAAC;IACS,KAAK,CAAC,QAAQ,CAAC,QAAiB,IAAG,CAAC;IACpC,KAAK,CAAC,KAAK,KAAI,CAAC;IAE1B;;;;OAIG;IACO,oBAAoB,CAAC,QAAgB;QAC7C,OAAO;YACL;gBACE,EAAE,EAAE,QAAQ;gBACZ,OAAO,EAAE,CAAC;aACX;SACiB,CAAC;IACvB,CAAC;IAED;;;;;;OAMG;IACO,WAAW,CACnB,SAA0B,EAC1B,SAAiB,EACjB,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,YAAY,EAAQ,CAAC;QACzC,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,IAAI,CAAC;YACH,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CACb,gCAAgC,SAAS,MAAM,KAAK,CAAC,OAAO,EAAE,CAC/D,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACO,YAAY,CAAO,SAA0B;QACrD,IACE,SAAS,CAAC,IAAI,KAAK,KAAK;YACxB,SAAS,CAAC,IAAI,KAAK,MAAM;YACzB,SAAS,CAAC,IAAI,KAAK,QAAQ,EAC3B,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,uBAAuB,SAAS,CAAC,IAAI,kBAAkB,CAAC,CAAC;QAC3E,CAAC;QACD,OAAQ,SAAmC,CAAC,EAAE,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,kBAAkB,CAAC,IAAY,EAAE,EAAU;QACzD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,kEAAkE,CACnE,CAAC;QACJ,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAClD,aAAa,CAAC,SAAS,CACxB,CAAC;QAEF,MAAM,OAAO,CAAC,GAAG,CACf,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;YACrC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CACb,uBAAuB,WAAW,CAAC,IAAI,uBAAuB,CAC/D,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACpD,MAAM,SAAS,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC5C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,KAAM,KAAe,CAAC,OAAO,EAAE,CAClE,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,gBAAgB,CAC9B,IAAY,EACZ,EAAU,EACV,cAAyB;QAEzB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,cAAc,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,qBAAqB,CACvD,aAAa,CAAC,SAAS,CACxB,CAAC;QACJ,CAAC;QAED,iCAAiC;QACjC,MAAM,OAAO,CAAC,GAAG,CACf,cAAc,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE;YACzC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC/D,MAAM,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;QAC9D,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,82 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation. This program is distributed in the hope that it
+  will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+  See the GNU Affero General Public License for more details.
+  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 { Card, Operation, Project, ResourceName } from './folder-resource.js';
+import { FolderResource } from './folder-resource.js';
+import type { TemplateConfiguration, TemplateMetadata } from '../interfaces/resource-interfaces.js';
+import { Template } from '../containers/template.js';
+/**
+ * Template resource class.
+ */
+export declare class TemplateResource extends FolderResource {
+    private cardContainer;
+    private cardsFolder;
+    private cardsSchema;
+    constructor(project: Project, name: ResourceName);
+    private handleNameChange;
+    /**
+     * Sets new metadata into the template object.
+     * @param newContent metadata content for the template.
+     * @throws if 'newContent' is not valid.
+     */
+    create(newContent?: TemplateMetadata): Promise<void>;
+    /**
+     * Returns content data.
+     */
+    get data(): TemplateMetadata;
+    /**
+     * Deletes file and folder that this resource is based on.
+     */
+    delete(): Promise<void>;
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    rename(newName: ResourceName): Promise<void>;
+    /**
+     * Shows metadata of the resource.
+     * @returns template metadata.
+     */
+    show(): Promise<TemplateConfiguration>;
+    /**
+     * Returns template card container object.
+     * @returns template container object
+     */
+    templateObject(): Template;
+    /**
+     * Updates template resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     * @throws if key is unknown.
+     */
+    update<Type>(key: string, op: Operation<Type>): Promise<void>;
+    /**
+     * List where template is used.
+     * Always returns card key references first, then calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys, and calculation filenames that refer this resource.
+     */
+    usage(cards?: Card[]): Promise<string[]>;
+    /**
+     * 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.
+     */
+    validate(content?: object): Promise<void>;
+    /**
+     * Create the template's cards folder.
+     */
+    write(): Promise<void>;
+}