@cyberismo/data-handler 0.0.2

package/dist/resources/file-resource.js

@@ -0,0 +1,301 @@
+/**
+  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/>.
+*/
+// node
+import { basename, join, sep } from 'node:path';
+import { mkdir, rename } from 'node:fs/promises';
+import { readFile } from 'node:fs/promises';
+import { ResourceObject, } from './resource-object.js';
+import { DefaultContent } from './create-defaults.js';
+import { deleteFile, pathExists } from '../utils/file-utils.js';
+import { Project, ResourcesFrom } from '../containers/project.js';
+import { readJsonFile, readJsonFileSync, writeJsonFile, } from '../utils/json.js';
+import { resourceName, resourceNameToPath, resourceNameToString, } from '../utils/resource-utils.js';
+import { sortCards } from '../utils/card-utils.js';
+import { Validate } from '../commands/index.js';
+export { DefaultContent, Project, ResourcesFrom, resourceName, resourceNameToString, sortCards, };
+/**
+ * Base class for file based resources (card types, field types, link types, workflows, ...)
+ */
+export class FileResource extends ResourceObject {
+    type;
+    fileName = '';
+    content = { name: '' };
+    cache;
+    constructor(project, resourceName, type) {
+        super(project, resourceName);
+        this.type = type;
+        this.cache = this.project.resourceCache;
+    }
+    // Type of resource.
+    resourceType() {
+        return this.type;
+    }
+    // Converts resource name to Resource object.
+    resourceObjectToResource(object) {
+        return {
+            name: object.data ? object.data.name : '',
+            path: object.fileName.substring(0, object.fileName.lastIndexOf(sep)),
+        };
+    }
+    toCache() {
+        this.cache.set(resourceNameToString(this.resourceName), this.content);
+    }
+    // Initialize the resource.
+    initialize() {
+        if (this.resourceName.type === '') {
+            this.resourceName.type = this.type;
+        }
+        if (this.resourceName.prefix === '') {
+            this.resourceName.prefix = this.project.projectPrefix;
+        }
+        if (this.type) {
+            this.moduleResource =
+                this.resourceName.prefix !== this.project.projectPrefix;
+            this.resourceFolder = this.moduleResource
+                ? join(this.project.paths.modulesFolder, this.resourceName.prefix, this.resourceName.type)
+                : this.project.paths.resourcePath(this.type);
+            this.fileName = resourceNameToPath(this.project, this.resourceName);
+        }
+        // Read from cache, if entry exists...
+        if (this.cache.has(resourceNameToString(this.resourceName))) {
+            this.content = this.cache.get(resourceNameToString(this.resourceName));
+            return;
+        }
+        //... otherwise read from disk and add to cache
+        try {
+            this.content = readJsonFileSync(this.fileName);
+            this.toCache();
+        }
+        catch {
+            // do nothing, it is possible that file has not been created yet.
+        }
+    }
+    // Creates resource.
+    async create(newContent) {
+        if (pathExists(this.fileName)) {
+            throw new Error(`Resource '${this.resourceName.identifier}' already exists in the project`);
+        }
+        if (this.resourceFolder === '') {
+            this.resourceName = resourceName(`${this.project.projectPrefix}/${this.type}/${this.resourceName.identifier}`);
+            this.resourceFolder = this.project.paths.resourcePath(this.resourceName.type);
+        }
+        const validName = await Validate.getInstance().validResourceName(this.resourceType(), resourceNameToString(this.resourceName), await this.project.projectPrefixes());
+        let validContent = {};
+        if (newContent) {
+            validContent = newContent;
+            validContent.name = validName;
+        }
+        this.content = validContent;
+        await this.write();
+        // Notify project & collector
+        this.project.addResource(this.resourceObjectToResource(this), this.content);
+    }
+    // Calculations that use this resource.
+    async calculations() {
+        const references = [];
+        const resourceName = resourceNameToString(this.resourceName);
+        for (const calculation of await this.project.calculations(ResourcesFrom.all)) {
+            const fileNameWithExtension = calculation.name.endsWith('.lp')
+                ? calculation.name
+                : calculation.name + '.lp';
+            const filename = join(calculation.path, basename(fileNameWithExtension));
+            try {
+                const content = await readFile(filename, 'utf-8');
+                if (content.includes(resourceName)) {
+                    references.push(calculation.name);
+                }
+            }
+            catch (error) {
+                throw new Error(`Failed to process file ${filename}: ${error.message}`);
+            }
+        }
+        return references;
+    }
+    // Cards from project.
+    async cards() {
+        return [
+            ...(await this.project.cards(undefined, {
+                content: true,
+                metadata: true,
+            })),
+            ...(await this.project.allTemplateCards({
+                content: true,
+                metadata: true,
+            })),
+        ];
+    }
+    // Returns memory resident data as JSON.
+    // This is basically same as 'show' but doesn't do any checks; just returns the current content.
+    get data() {
+        return this.content.name !== '' ? this.content : undefined;
+    }
+    // Deletes resource.
+    async delete() {
+        if (this.moduleResource) {
+            throw new Error(`Cannot delete module resources`);
+        }
+        if (!this.fileName.endsWith('.json')) {
+            this.fileName += '.json';
+        }
+        if (!pathExists(this.fileName)) {
+            throw new Error(`Resource '${this.resourceName.identifier}' does not exist in the project`);
+        }
+        const usedIn = await this.usage();
+        if (usedIn.length > 0) {
+            throw new Error(`Cannot delete resource ${resourceNameToString(this.resourceName)}. It is used by: ${usedIn.join(', ')}`);
+        }
+        await deleteFile(this.fileName);
+        this.project.removeResource(this.resourceObjectToResource(this));
+        this.fileName = '';
+    }
+    async validName(newName) {
+        const validName = await Validate.getInstance().validResourceName(this.resourceType(), resourceNameToString(newName), await this.project.projectPrefixes());
+        return validName;
+    }
+    // Called after inherited class has finished 'update' operation.
+    async postUpdate(content, key, op) {
+        function toValue(op) {
+            if (op.name === 'rank')
+                return op.newIndex;
+            if (op.name === 'add')
+                return op.target;
+            if (op.name === 'remove')
+                return op.target;
+            if (op.name === 'change')
+                return op.to;
+        }
+        // Check that new name is valid.
+        if (op.name === 'change' && key === 'name') {
+            const newName = resourceName(op.to);
+            content.name = await this.validName(newName);
+        }
+        // Once changes have been made; validate the content.
+        try {
+            await this.validate(content);
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                const errorValue = typeof op === 'object' ? toValue(op) : op;
+                throw new Error(`Cannot ${op.name} '${key}' --> '${errorValue}'`);
+            }
+        }
+        this.content = content;
+        await this.write();
+    }
+    // Reads content from file to memory.
+    async read() {
+        this.content = await readJsonFile(this.fileName);
+    }
+    // Renames resource.
+    async rename(newName) {
+        this.cache.delete(resourceNameToString(this.resourceName));
+        if (this.moduleResource) {
+            throw new Error(`Cannot rename module resources`);
+        }
+        if (!pathExists(this.fileName)) {
+            throw new Error(`Resource '${this.resourceName.identifier}' does not exist`);
+        }
+        if (newName.prefix !== this.project.projectPrefix) {
+            throw new Error('Can only rename project resources');
+        }
+        if (newName.type !== this.resourceName.type) {
+            throw new Error('Cannot change resource type');
+        }
+        await Validate.getInstance().validResourceName(this.resourceType(), resourceNameToString(newName), await this.project.projectPrefixes());
+        const newFilename = join(this.project.paths.resourcePath(newName.type), newName.identifier + '.json');
+        await rename(this.fileName, newFilename);
+        this.fileName = newFilename;
+        this.content.name = resourceNameToString(newName);
+        this.resourceName = newName;
+        this.toCache();
+    }
+    // Show resource data as JSON.
+    async show() {
+        if (!pathExists(this.fileName)) {
+            const resourceType = `${this.type[0].toUpperCase()}${this.type.slice(1, this.type.length - 1)}`;
+            const name = resourceNameToString(this.resourceName);
+            throw new Error(`${resourceType} '${name}' does not exist in the project`);
+        }
+        return this.content;
+    }
+    // Update resource; the base class makes some checks only.
+    async update(key, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    _op) {
+        const content = this.data;
+        if (!content) {
+            throw new Error(`Resource '${this.fileName}' does not exist`);
+        }
+        if (this.moduleResource) {
+            throw new Error(`Cannot update module resources`);
+        }
+        if (key === '' || key === undefined) {
+            throw new Error(`Cannot update empty key`);
+        }
+    }
+    // Updates resource key to a new prefix
+    updatePrefixInResourceName(name, prefixes) {
+        const { identifier, prefix, type } = resourceName(name);
+        if (this.moduleResource) {
+            return name;
+        }
+        return !prefixes.includes(prefix)
+            ? `${this.project.configuration.cardKeyPrefix}/${type}/${identifier}`
+            : name;
+    }
+    // Check if there are references to the resource in the card content.
+    async usage(cards) {
+        if (!pathExists(this.fileName)) {
+            throw new Error(`Resource '${this.resourceName.identifier}' does not exist in the project`);
+        }
+        const cardArray = cards?.length
+            ? cards
+            : await this.project.cards(undefined, {
+                content: true,
+                metadata: true,
+            });
+        return cardArray
+            .filter((card) => card.content?.includes(resourceNameToString(this.resourceName)))
+            .map((card) => card.key);
+    }
+    // Write the content from memory to disk.
+    async write() {
+        if (this.moduleResource) {
+            throw new Error(`Cannot change module resources`);
+        }
+        // Create folder for resources and add correct .schema file.
+        await mkdir(this.resourceFolder, { recursive: true });
+        await writeJsonFile(join(this.resourceFolder, '.schema'), this.contentSchema, {
+            flag: 'wx',
+        });
+        // Check if "name" has changed. Changing "name" means renaming the file.
+        const nameInContent = resourceName(this.content.name).identifier + '.json';
+        const currentFileName = basename(this.fileName);
+        if (nameInContent !== currentFileName) {
+            const newFileName = join(this.resourceFolder, nameInContent);
+            await rename(this.fileName, newFileName);
+            this.fileName = newFileName;
+        }
+        await writeJsonFile(this.fileName, this.content);
+        this.toCache();
+    }
+    // Validate that current memory-based 'content' is valid.
+    async validate(content) {
+        const invalidJson = Validate.getInstance().validateJson(content ? content : this.content, this.contentSchemaId);
+        if (invalidJson.length) {
+            throw new Error(`Invalid content JSON: ${invalidJson}`);
+        }
+    }
+}
+//# sourceMappingURL=file-resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"file-resource.js","sourceRoot":"","sources":["../../src/resources/file-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO;AACP,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAM5C,OAAO,EAKL,cAAc,GACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,aAAa,GACd,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAEL,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAIL,cAAc,EAEd,OAAO,EAEP,aAAa,EACb,YAAY,EAEZ,oBAAoB,EACpB,SAAS,GACV,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,YAAa,SAAQ,cAAc;IAQlC;IAPL,QAAQ,GAAW,EAAE,CAAC;IACnB,OAAO,GAAyB,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IAC/C,KAAK,CAAoB;IAEjC,YACE,OAAgB,EAChB,YAA0B,EAChB,IAAwB;QAElC,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAFnB,SAAI,GAAJ,IAAI,CAAoB;QAGlC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IAC1C,CAAC;IAED,oBAAoB;IACZ,YAAY;QAClB,OAAO,IAAI,CAAC,IAA0B,CAAC;IACzC,CAAC;IAED,6CAA6C;IACrC,wBAAwB,CAAC,MAAoB;QACnD,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;YACzC,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACrE,CAAC;IACJ,CAAC;IAEO,OAAO;QACb,IAAI,CAAC,KAAK,CAAC,GAAG,CACZ,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,EACvC,IAAI,CAAC,OAA0B,CAChC,CAAC;IACJ,CAAC;IAED,2BAA2B;IACjB,UAAU;QAClB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YAClC,IAAI,CAAC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrC,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;QACxD,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,cAAc;gBACjB,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;YAC1D,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,EAChC,IAAI,CAAC,YAAY,CAAC,MAAM,EACxB,IAAI,CAAC,YAAY,CAAC,IAAI,CACvB;gBACH,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACtE,CAAC;QACD,sCAAsC;QACtC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAC3B,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CACL,CAAC;YACrC,OAAO;QACT,CAAC;QACD,+CAA+C;QAC/C,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/C,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,iEAAiE;QACnE,CAAC;IACH,CAAC;IAED,oBAAoB;IACV,KAAK,CAAC,MAAM,CAAC,UAA4B;QACjD,IAAI,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,aAAa,IAAI,CAAC,YAAY,CAAC,UAAU,iCAAiC,CAC3E,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,KAAK,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAC9B,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAC7E,CAAC;YACF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CACnD,IAAI,CAAC,YAAY,CAAC,IAA0B,CAC7C,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAC9D,IAAI,CAAC,YAAY,EAAE,EACnB,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,EACvC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CACrC,CAAC;QAEF,IAAI,YAAY,GAAG,EAAqB,CAAC;QACzC,IAAI,UAAU,EAAE,CAAC;YACf,YAAY,GAAG,UAAwC,CAAC;YACxD,YAAY,CAAC,IAAI,GAAG,SAAS,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC;QAC5B,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAEnB,6BAA6B;QAC7B,IAAI,CAAC,OAAO,CAAC,WAAW,CACtB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EACnC,IAAI,CAAC,OAA0B,CAChC,CAAC;IACJ,CAAC;IAED,uCAAuC;IAC7B,KAAK,CAAC,YAAY;QAC1B,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7D,KAAK,MAAM,WAAW,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CACvD,aAAa,CAAC,GAAG,CAClB,EAAE,CAAC;YACF,MAAM,qBAAqB,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC5D,CAAC,CAAC,WAAW,CAAC,IAAI;gBAClB,CAAC,CAAC,WAAW,CAAC,IAAI,GAAG,KAAK,CAAC;YAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;YACzE,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,IAAI,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;oBACnC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,0BAA0B,QAAQ,KAAM,KAAe,CAAC,OAAO,EAAE,CAClE,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,sBAAsB;IACZ,KAAK,CAAC,KAAK;QACnB,OAAO;YACL,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE;gBACtC,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YACH,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;gBACtC,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC;IAED,wCAAwC;IACxC,gGAAgG;IAChG,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED,oBAAoB;IACV,KAAK,CAAC,MAAM;QACpB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,IAAI,OAAO,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,aAAa,IAAI,CAAC,YAAY,CAAC,UAAU,iCAAiC,CAC3E,CAAC;QACJ,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,0BAA0B,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACzG,CAAC;QACJ,CAAC;QACD,MAAM,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrB,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAAqB;QAC7C,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAC9D,IAAI,CAAC,YAAY,EAAE,EACnB,oBAAoB,CAAC,OAAO,CAAC,EAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CACrC,CAAC;QACF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,gEAAgE;IACtD,KAAK,CAAC,UAAU,CACxB,OAAwB,EACxB,GAAW,EACX,EAAmB;QAEnB,SAAS,OAAO,CAAC,EAAmB;YAClC,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM;gBAAE,OAAO,EAAE,CAAC,QAAQ,CAAC;YAC3C,IAAI,EAAE,CAAC,IAAI,KAAK,KAAK;gBAAE,OAAO,EAAE,CAAC,MAAM,CAAC;YACxC,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ;gBAAE,OAAO,EAAE,CAAC,MAAM,CAAC;YAC3C,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ;gBAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QACzC,CAAC;QAED,gCAAgC;QAChC,IAAI,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,YAAY,CACzB,EAA8B,CAAC,EAAY,CAC7C,CAAC;YACF,OAAO,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,qDAAqD;QACrD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC3B,MAAM,UAAU,GAAG,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC,IAAI,KAAK,GAAG,UAAU,UAAU,GAAG,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,qCAAqC;IAC3B,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,OAAO,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,oBAAoB;IACV,KAAK,CAAC,MAAM,CAAC,OAAqB;QAC1C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QAC3D,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,aAAa,IAAI,CAAC,YAAY,CAAC,UAAU,kBAAkB,CAC5D,CAAC;QACJ,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,iBAAiB,CAC5C,IAAI,CAAC,YAAY,EAAE,EACnB,oBAAoB,CAAC,OAAO,CAAC,EAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CACrC,CAAC;QACF,MAAM,WAAW,GAAG,IAAI,CACtB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAA0B,CAAC,EACnE,OAAO,CAAC,UAAU,GAAG,OAAO,CAC7B,CAAC;QACF,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEzC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,8BAA8B;IACpB,KAAK,CAAC,IAAI;QAClB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,YAAY,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YAChG,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,IAAI,KAAK,CACb,GAAG,YAAY,KAAK,IAAI,iCAAiC,CAC1D,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,OAA0B,CAAC;IACzC,CAAC;IAED,0DAA0D;IAChD,KAAK,CAAC,MAAM,CACpB,GAAW;IACX,6DAA6D;IAC7D,GAAoB;QAEpB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,QAAQ,kBAAkB,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,uCAAuC;IAC7B,0BAA0B,CAAC,IAAY,EAAE,QAAkB;QACnE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC/B,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,aAAa,IAAI,IAAI,IAAI,UAAU,EAAE;YACrE,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED,qEAAqE;IAC3D,KAAK,CAAC,KAAK,CAAC,KAAc;QAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,aAAa,IAAI,CAAC,YAAY,CAAC,UAAU,iCAAiC,CAC3E,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,EAAE,MAAM;YAC7B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,EAAE;gBAClC,OAAO,EAAE,IAAI;gBACb,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;QAEP,OAAO,SAAS;aACb,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACf,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAChE;aACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,yCAAyC;IAC/B,KAAK,CAAC,KAAK;QACnB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACpD,CAAC;QAED,4DAA4D;QAC5D,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,aAAa,CACjB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,EACpC,IAAI,CAAC,aAAa,EAClB;YACE,IAAI,EAAE,IAAI;SACX,CACF,CAAC;QACF,wEAAwE;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,GAAG,OAAO,CAAC;QAC3E,MAAM,eAAe,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,aAAa,KAAK,eAAe,EAAE,CAAC;YACtC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YAC7D,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACzC,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC9B,CAAC;QAED,MAAM,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED,yDAAyD;IAC/C,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACvC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CACrD,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAChC,IAAI,CAAC,eAAe,CACrB,CAAC;QACF,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,yBAAyB,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;CACF"}

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

@@ -0,0 +1,66 @@
+/**
+    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 { ResourceFolderType } from '../interfaces/project-interfaces.js';
+import { type Card, DefaultContent, FileResource, type Operation, Project, type ResourceName, resourceNameToString, sortCards } from './file-resource.js';
+import type { ResourceContent } from '../interfaces/resource-interfaces.js';
+export { type Card, DefaultContent, FileResource, type Operation, Project, ResourceName, resourceNameToString, sortCards, };
+/**
+ * Folder type resource class. These are resources that have their own folders for content.
+ */
+export declare class FolderResource extends FileResource {
+    protected internalFolder: string;
+    constructor(project: Project, name: ResourceName, type: ResourceFolderType);
+    /**
+     * Creates a new folder type object. Base class writes the object to disk automatically.
+     * @param newContent Content for the type.
+     */
+    protected create(newContent?: ResourceContent): Promise<void>;
+    /**
+     * Returns content data.
+     */
+    get data(): import("../interfaces/resource-interfaces.js").ResourceBaseMetadata | undefined;
+    /**
+     * Deletes file(s) from disk and clears out the memory resident object.
+     */
+    protected delete(): Promise<void>;
+    protected initialize(): void;
+    /**
+     * Renames resource metadata file and renames memory resident object 'name'.
+     * @param newName New name for the resource.
+     */
+    protected rename(newName: ResourceName): Promise<void>;
+    /**
+     * Shows metadata of the resource.
+     * @returns resource type's metadata.
+     */
+    protected show(): Promise<ResourceContent>;
+    /**
+     * Updates resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     */
+    protected update<Type>(key: string, op: Operation<Type>): Promise<void>;
+    /**
+     * Returns an array of card keys, and/or resource names where this resource is used.
+     * @param cards Optional. If defined, only these cards are checked.
+     * @returns an array of card keys, and/or resource names where this resource is used.
+     */
+    protected usage(cards?: Card[]): Promise<string[]>;
+    /**
+     * Writes resource content to disk.
+     */
+    protected write(): Promise<void>;
+    /**
+     * Validates the resource. If object is invalid, throws.
+     */
+    protected validate(content?: object): Promise<void>;
+}

package/dist/resources/folder-resource.js

@@ -0,0 +1,100 @@
+/**
+    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 { basename, join } from 'node:path';
+import { mkdir, rename, rm } from 'node:fs/promises';
+import { DefaultContent, FileResource, Project, resourceName, resourceNameToString, sortCards, } from './file-resource.js';
+export { DefaultContent, FileResource, Project, resourceNameToString, sortCards, };
+/**
+ * Folder type resource class. These are resources that have their own folders for content.
+ */
+export class FolderResource extends FileResource {
+    internalFolder = '';
+    constructor(project, name, type) {
+        super(project, name, type);
+    }
+    /**
+     * Creates a new folder type object. Base class writes the object to disk automatically.
+     * @param newContent Content for the type.
+     */
+    async create(newContent) {
+        await super.create(newContent);
+        await mkdir(this.internalFolder, { recursive: true });
+    }
+    /**
+     * Returns content data.
+     */
+    get data() {
+        return super.data;
+    }
+    /**
+     * Deletes file(s) from disk and clears out the memory resident object.
+     */
+    async delete() {
+        await super.delete();
+        await rm(this.internalFolder, { recursive: true, force: true });
+    }
+    initialize() {
+        super.initialize();
+        this.internalFolder = join(this.resourceFolder, this.resourceName.identifier);
+    }
+    /**
+     * Renames resource metadata file and renames memory resident object 'name'.
+     * @param newName New name for the resource.
+     */
+    async rename(newName) {
+        return super.rename(newName);
+    }
+    /**
+     * Shows metadata of the resource.
+     * @returns resource type's metadata.
+     */
+    async show() {
+        return super.show();
+    }
+    /**
+     * Updates resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     */
+    async update(key, op) {
+        return super.update(key, op);
+    }
+    /**
+     * Returns an array of card keys, and/or resource names where this resource is used.
+     * @param cards Optional. If defined, only these cards are checked.
+     * @returns an array of card keys, and/or resource names where this resource is used.
+     */
+    async usage(cards) {
+        return super.usage(cards);
+    }
+    /**
+     * Writes resource content to disk.
+     */
+    async write() {
+        const folderName = basename(this.internalFolder);
+        // Check if "name" has changed. Changing "name" means renaming the file.
+        const nameInContent = resourceName(this.content.name).identifier;
+        if (folderName !== nameInContent) {
+            const newFolderName = join(this.resourceFolder, nameInContent);
+            await rename(this.internalFolder, newFolderName);
+            this.internalFolder = newFolderName;
+        }
+        return super.write();
+    }
+    /**
+     * Validates the resource. If object is invalid, throws.
+     */
+    async validate(content) {
+        return super.validate(content);
+    }
+}
+//# sourceMappingURL=folder-resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"folder-resource.js","sourceRoot":"","sources":["../../src/resources/folder-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAGrD,OAAO,EAEL,cAAc,EACd,YAAY,EAEZ,OAAO,EACP,YAAY,EAEZ,oBAAoB,EACpB,SAAS,GACV,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAEL,cAAc,EACd,YAAY,EAEZ,OAAO,EAEP,oBAAoB,EACpB,SAAS,GACV,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,YAAY;IACpC,cAAc,GAAW,EAAE,CAAC;IAEtC,YAAY,OAAgB,EAAE,IAAkB,EAAE,IAAwB;QACxE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,MAAM,CAAC,UAA4B;QACjD,MAAM,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC/B,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,KAAK,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,MAAM;QACpB,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;QACrB,MAAM,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAES,UAAU;QAClB,KAAK,CAAC,UAAU,EAAE,CAAC;QAEnB,IAAI,CAAC,cAAc,GAAG,IAAI,CACxB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,CAAC,UAAU,CAC7B,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,MAAM,CAAC,OAAqB;QAC1C,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,IAAI;QAClB,OAAO,KAAK,CAAC,IAAI,EAA8B,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,MAAM,CAAO,GAAW,EAAE,EAAmB;QAC3D,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,KAAK,CAAC,KAAc;QAClC,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,KAAK;QACnB,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAEjD,wEAAwE;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;QACjE,IAAI,UAAU,KAAK,aAAa,EAAE,CAAC;YACjC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YAC/D,MAAM,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;YACjD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACtC,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACvC,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF"}

package/dist/resources/graph-model-resource.d.ts

@@ -0,0 +1,78 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+
+  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 { GraphModel, GraphModelMetadata } from '../interfaces/resource-interfaces.js';
+/**
+ * Graph model resource class.
+ */
+export declare class GraphModelResource extends FolderResource {
+    constructor(project: Project, name: ResourceName);
+    private handleNameChange;
+    /**
+     * Sets new metadata into the graph model object graph model.
+     * @param newContent metadata content for the graph model.
+     * @throws if 'newContent' is not valid.
+     */
+    create(newContent?: GraphModelMetadata): Promise<void>;
+    /**
+     * Returns resource content.
+     */
+    get data(): GraphModel;
+    /**
+     * Deletes file and folder that this resource is based on.
+     */
+    delete(): Promise<void>;
+    /**
+     * Returns calculation file that this graph model has.
+     * @returns calculation file name that this graph model has.
+     */
+    calculationFile(nameOnly?: boolean): 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 graph model metadata.
+     */
+    show(): Promise<GraphModel>;
+    /**
+     * Updates graph model 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 graphModel.
+     * @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 graph model's folder and calculation file.
+     */
+    write(): Promise<void>;
+}