@cyberismo/data-handler 0.0.2

package/dist/module-manager.d.ts

@@ -0,0 +1,62 @@
+/**
+  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 { Import } from './commands/index.js';
+import type { ModuleSettingOptions } from './interfaces/project-interfaces.js';
+import { Project } from './containers/project.js';
+/**
+ * Class that handles module updates and imports.
+ */
+export declare class ModuleManager {
+    private project;
+    private importCmd;
+    private modules;
+    private tempModulesDir;
+    constructor(project: Project, importCmd: Import);
+    private addFileContents;
+    private branch;
+    private clone;
+    private collectModulePrefixes;
+    private configuration;
+    private doCollectModulePrefix;
+    private handleFileModule;
+    private handleGitModule;
+    private handleModule;
+    private importFromFolder;
+    private importFromTemp;
+    private isFileModule;
+    private prepare;
+    private protocol;
+    private remove;
+    private removeModuleFiles;
+    private removeProtocolFromLocation;
+    private removeDuplicates;
+    private repositoryName;
+    private validatePrefix;
+    /**
+     * Imports module from local file path.
+     * @param source Path to import from.
+     * @param destination is this really needed???
+     */
+    importFileModule(source: string, destination?: string): Promise<string>;
+    /**
+     * Imports module from gitUrl.
+     * @param source Git URL to import from.
+     * @param options Modules setting options.
+     * @returns module prefix as defined in its CardsConfig.json
+     */
+    importGitModule(source: string, options?: ModuleSettingOptions): Promise<string>;
+    /**
+     * Updates all imported modules.
+     */
+    update(): Promise<void>;
+}

package/dist/module-manager.js

@@ -0,0 +1,350 @@
+/**
+  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 fs from 'node:fs';
+import { join } from 'node:path';
+import { mkdir, readdir, rm } from 'node:fs/promises';
+import git from 'isomorphic-git';
+import http from 'isomorphic-git/http/node/index.js';
+import { copyDir, deleteDir, pathExists } from './utils/file-utils.js';
+import { Project } from './containers/project.js';
+import { ProjectPaths } from './containers/project/project-paths.js';
+import { readJsonFile } from './utils/json.js';
+import { Validate } from './commands/index.js';
+const FILE_PROTOCOL = 'file:';
+// todo: add support for git's default branch.
+const MAIN_BRANCH = 'main';
+/**
+ * Class that handles module updates and imports.
+ */
+export class ModuleManager {
+    project;
+    importCmd;
+    modules = [];
+    tempModulesDir = '';
+    constructor(project, importCmd) {
+        this.project = project;
+        this.importCmd = importCmd;
+        this.tempModulesDir = join(this.project.paths.tempFolder, 'modules');
+    }
+    // Copies module files into project directories.
+    async addFileContents(sourcePath, destinationPath) {
+        // Copy files.
+        await copyDir(sourcePath, destinationPath);
+        // Update the resources.
+        await this.project.collectModuleResources();
+    }
+    // Handles a branch of a repository.
+    async branch(module) {
+        if (module.branch === MAIN_BRANCH || module.branch === '' || !module.branch)
+            return;
+        await git.checkout({
+            fs,
+            dir: join(this.tempModulesDir, module.name),
+            ref: module.branch,
+        });
+        console.error(`... Switched to '${module.branch}' branch for module '${module.name}'`);
+    }
+    // Handles cloning of a repository.
+    async clone(module, verbose = true) {
+        if (!module.name || module.name === '') {
+            module.name = this.repositoryName(module.location);
+        }
+        let repoUrl;
+        try {
+            repoUrl = new URL(module.location);
+        }
+        catch {
+            throw new Error(`Invalid repository URL: ${module.location}`);
+        }
+        if (process.env.CYBERISMO_GIT_USER &&
+            process.env.CYBERISMO_GIT_TOKEN &&
+            module.private) {
+            if (verbose) {
+                console.log(`... Using credentials '${process.env.CYBERISMO_GIT_USER}' for cloning '${module.name}'`);
+            }
+            repoUrl.username = process.env.CYBERISMO_GIT_USER;
+            repoUrl.password = process.env.CYBERISMO_GIT_TOKEN;
+        }
+        await git.clone({
+            fs,
+            http,
+            dir: join(this.tempModulesDir, module.name),
+            url: repoUrl.toString(),
+            depth: 1,
+            onAuth: () => {
+                // Turn credentials 'off' when they are not available
+                if (!process.env.CYBERISMO_GIT_USER ||
+                    !process.env.CYBERISMO_GIT_TOKEN) {
+                    return undefined;
+                }
+                // Turn credentials 'off' for public repos
+                if (!module.private) {
+                    return undefined;
+                }
+                return {
+                    username: process.env.CYBERISMO_GIT_USER,
+                    password: process.env.CYBERISMO_GIT_TOKEN,
+                };
+            },
+        });
+        if (verbose) {
+            console.log(`... Cloned '${module.name}' to a temporary folder`);
+        }
+        return module.name;
+    }
+    // Collects all module prefixes from module hierarchy into 'this.modules'.
+    // Note that collected result can contain duplicates.
+    async collectModulePrefixes(modules) {
+        if (modules) {
+            for (const module of modules) {
+                await this.doCollectModulePrefix(module);
+            }
+        }
+    }
+    // Read project configuration JSON file from 'path'.
+    async configuration(path) {
+        try {
+            const paths = new ProjectPaths(path);
+            return readJsonFile(paths.configurationFile);
+        }
+        catch {
+            throw new Error(`Module not found from '${path}'`);
+        }
+    }
+    // Collects one module's dependency prefixes to 'this.modules'.
+    // Note that there can be duplicate entries.
+    async doCollectModulePrefix(module) {
+        let moduleRoot = '';
+        if (this.isFileModule(module)) {
+            const urlStart = FILE_PROTOCOL.length;
+            // Remove 'file:' from location
+            moduleRoot = module.location.substring(urlStart, module.location.length);
+        }
+        else {
+            await this.clone(module, false);
+            moduleRoot = join(this.tempModulesDir, module.name);
+        }
+        this.modules.push(module);
+        const configuration = await this.configuration(moduleRoot);
+        await this.collectModulePrefixes(configuration.modules);
+    }
+    // Updates one module that is read from local file system.
+    async handleFileModule(module) {
+        this.removeProtocolFromLocation(module);
+        await this.remove(module);
+        await this.importFromFolder(module);
+    }
+    // Updates one module that is received from Git.
+    async handleGitModule(module) {
+        await this.clone(module);
+        await this.branch(module);
+        await this.remove(module);
+        await this.importFromTemp(module);
+    }
+    // Updates one module.
+    async handleModule(module) {
+        return this.isFileModule(module)
+            ? this.handleFileModule(module)
+            : this.handleGitModule(module);
+    }
+    // Handles importing a module from module settings 'location'
+    async importFromFolder(module) {
+        await this.importCmd.updateExistingModule(module.location);
+        console.log(`... Imported module '${module.name}' to '${this.project.configuration.name}'`);
+    }
+    // Handles importing a module from '.temp' folder
+    async importFromTemp(module) {
+        await this.importCmd.updateExistingModule(join(this.tempModulesDir, module.name));
+        console.log(`... Imported module '${module.name}' to '${this.project.configuration.name}'`);
+    }
+    // Returns true if module is imported from file-system.
+    isFileModule(module) {
+        if (!module.location)
+            return false;
+        return module.location.startsWith('file:');
+    }
+    // Prepares '.temp/modules' for cloning
+    async prepare() {
+        await mkdir(this.tempModulesDir, { recursive: true });
+        for (const file of await readdir(this.tempModulesDir)) {
+            await rm(join(this.tempModulesDir, file), {
+                force: true,
+                recursive: true,
+            });
+        }
+    }
+    // Returns whether to use git or file system for handling the module.
+    protocol(module) {
+        return this.isFileModule(module) ? 'file' : 'git';
+    }
+    // Handles removing an imported module.
+    async remove(module) {
+        try {
+            await this.removeModuleFiles(module.name);
+            console.log(`... Removed imported module '${module.name}'`);
+        }
+        catch (error) {
+            if (error instanceof Error)
+                console.error(`... New imported module '${module.name}', skipping remove`);
+        }
+    }
+    // Remove module files.
+    async removeModuleFiles(moduleName) {
+        const module = await this.project.module(moduleName);
+        if (!module) {
+            throw new Error(`Module '${moduleName}' not found`);
+        }
+        await deleteDir(module.path);
+    }
+    // Updates module's 'location' not to have 'protocol:' in the beginning (only for "file:" needed).
+    removeProtocolFromLocation(module) {
+        const protocol = this.protocol(module);
+        module.location = module.location.substring(protocol.length + 1, module.location.length);
+    }
+    // Checks for duplicate ModuleSetting entries and throws an error if modules
+    // with the same name have different branches or locations.
+    // Treats undefined branch, empty string branch, and "main" branch as equivalent.
+    // Returns an array with duplicate entries removed
+    removeDuplicates(modules) {
+        const moduleMap = new Map();
+        // Assume that empty, or missing branch means 'main'
+        const normalizeBranch = (branch) => {
+            if (!branch || branch === '' || branch === MAIN_BRANCH) {
+                return MAIN_BRANCH;
+            }
+            return branch;
+        };
+        for (const module of modules) {
+            const existingModule = moduleMap.get(module.name);
+            if (existingModule) {
+                if (existingModule.private !== module.private) {
+                    throw new Error(`Module conflict: '${module.name}' has different access:\n` +
+                        `  - ${existingModule.private || 'undefined'}\n` +
+                        `  - ${module.private || 'undefined'}`);
+                }
+                if (existingModule.location !== module.location) {
+                    throw new Error(`Module conflict: '${module.name}' has different locations:\n` +
+                        `  - ${existingModule.location}\n` +
+                        `  - ${module.location}`);
+                }
+                const existingBranch = normalizeBranch(existingModule.branch);
+                const newBranch = normalizeBranch(module.branch);
+                if (existingBranch !== newBranch) {
+                    throw new Error(`Module conflict: '${module.name}' has different branches:\n` +
+                        `  - ${existingModule.branch || 'undefined'}\n` +
+                        `  - ${module.branch || 'undefined'}`);
+                }
+            }
+            else {
+                moduleMap.set(module.name, module);
+            }
+        }
+        return Array.from(moduleMap.values());
+    }
+    // Gets repository name from gitUrl
+    repositoryName(gitUrl) {
+        const last = gitUrl.lastIndexOf('/');
+        const repoName = gitUrl.substring(last + 1, gitUrl.length - 4); //remove trailing ".git"
+        return repoName;
+    }
+    // Checks that module prefix is not in use in the project
+    async validatePrefix(modulePrefix) {
+        // Do not allow modules with same prefixes.
+        const currentlyUsedPrefixes = await this.project.projectPrefixes();
+        if (currentlyUsedPrefixes.includes(modulePrefix)) {
+            throw new Error(`Imported project has a prefix '${modulePrefix}' that is already used in the project. Cannot import from module.`);
+        }
+    }
+    /**
+     * Imports module from local file path.
+     * @param source Path to import from.
+     * @param destination is this really needed???
+     */
+    async importFileModule(source, destination) {
+        if (!Validate.validateFolder(source)) {
+            throw new Error(`Input validation error: folder name is invalid '${source}'`);
+        }
+        if (!pathExists(source)) {
+            throw new Error(`Input validation error: cannot find project '${source}'`);
+        }
+        if (destination && !pathExists(destination)) {
+            throw new Error(`Input validation error: destination does not exist '${destination}'`);
+        }
+        const sourceProject = new Project(source);
+        const modulePrefix = sourceProject.projectPrefix;
+        const destinationPath = join(this.project.paths.modulesFolder, modulePrefix);
+        const sourcePath = sourceProject.paths.resourcesFolder;
+        await this.validatePrefix(modulePrefix);
+        // Copy files.
+        await this.addFileContents(sourcePath, destinationPath);
+        return modulePrefix;
+    }
+    /**
+     * Imports module from gitUrl.
+     * @param source Git URL to import from.
+     * @param options Modules setting options.
+     * @returns module prefix as defined in its CardsConfig.json
+     */
+    async importGitModule(source, options) {
+        const repoName = await this.clone({
+            name: '',
+            location: source,
+            ...options,
+        });
+        await this.branch({ name: repoName, location: source, ...options });
+        const clonePath = join(this.project.paths.tempFolder, 'modules', repoName);
+        const modulePrefix = (await this.configuration(clonePath)).cardKeyPrefix;
+        await this.validatePrefix(modulePrefix);
+        const sourcePath = new ProjectPaths(clonePath).resourcesFolder;
+        const destinationPath = join(this.project.paths.modulesFolder, modulePrefix);
+        await this.addFileContents(sourcePath, destinationPath);
+        return modulePrefix;
+    }
+    /**
+     * Updates all imported modules.
+     */
+    async update() {
+        // Prints dots every half second so that user knows that something is ongoing
+        function start() {
+            console.log('... Collecting unique modules. This takes a moment.');
+            return setInterval(() => process.stdout.write(`.`), 500);
+        }
+        // Stops the above, and shows results
+        function finished(interval, modules) {
+            clearInterval(interval);
+            console.log(`\n... Found modules: ${modules.join(', ')}`);
+        }
+        await this.prepare();
+        const modules = this.project.configuration.modules;
+        if (modules.length === 0) {
+            throw new Error(`No modules in the project!`);
+        }
+        const dotInterval = start();
+        // Collect prefixes from project's dependency modules.
+        await this.collectModulePrefixes(modules);
+        let uniqueModules = [];
+        try {
+            uniqueModules = this.removeDuplicates(this.modules);
+        }
+        finally {
+            finished(dotInterval, uniqueModules.map((item) => item.name));
+            // Update modules parallel.
+            const promises = [];
+            uniqueModules.forEach((module) => promises.push(this.handleModule(module)));
+            await Promise.all(promises);
+            await deleteDir(this.tempModulesDir);
+            await this.project.collectModuleResources();
+        }
+    }
+}
+//# sourceMappingURL=module-manager.js.map

package/dist/module-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-manager.js","sourceRoot":"","sources":["../src/module-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;EAWE;AAEF,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,GAAG,MAAM,gBAAgB,CAAC;AACjC,OAAO,IAAI,MAAM,mCAAmC,CAAC;AAErD,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAMvE,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,MAAM,aAAa,GAAG,OAAO,CAAC;AAC9B,8CAA8C;AAC9C,MAAM,WAAW,GAAG,MAAM,CAAC;AAE3B;;GAEG;AACH,MAAM,OAAO,aAAa;IAId;IACA;IAJF,OAAO,GAAoB,EAAE,CAAC;IAC9B,cAAc,GAAW,EAAE,CAAC;IACpC,YACU,OAAgB,EAChB,SAAiB;QADjB,YAAO,GAAP,OAAO,CAAS;QAChB,cAAS,GAAT,SAAS,CAAQ;QAEzB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC;IAED,gDAAgD;IACxC,KAAK,CAAC,eAAe,CAAC,UAAkB,EAAE,eAAuB;QACvE,cAAc;QACd,MAAM,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QAE3C,wBAAwB;QACxB,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAC9C,CAAC;IAED,oCAAoC;IAC5B,KAAK,CAAC,MAAM,CAAC,MAAqB;QACxC,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YACzE,OAAO;QAET,MAAM,GAAG,CAAC,QAAQ,CAAC;YACjB,EAAE;YACF,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC;YAC3C,GAAG,EAAE,MAAM,CAAC,MAAM;SACnB,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,CACX,oBAAoB,MAAM,CAAC,MAAM,wBAAwB,MAAM,CAAC,IAAI,GAAG,CACxE,CAAC;IACJ,CAAC;IAED,mCAAmC;IAC3B,KAAK,CAAC,KAAK,CACjB,MAAqB,EACrB,UAAmB,IAAI;QAEvB,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,OAAY,CAAC;QACjB,IAAI,CAAC;YACH,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,IACE,OAAO,CAAC,GAAG,CAAC,kBAAkB;YAC9B,OAAO,CAAC,GAAG,CAAC,mBAAmB;YAC/B,MAAM,CAAC,OAAO,EACd,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO,CAAC,GAAG,CACT,0BAA0B,OAAO,CAAC,GAAG,CAAC,kBAAkB,kBAAkB,MAAM,CAAC,IAAI,GAAG,CACzF,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;YAClD,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACrD,CAAC;QACD,MAAM,GAAG,CAAC,KAAK,CAAC;YACd,EAAE;YACF,IAAI;YACJ,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC;YAC3C,GAAG,EAAE,OAAO,CAAC,QAAQ,EAAE;YACvB,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,GAAG,EAAE;gBACX,qDAAqD;gBACrD,IACE,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB;oBAC/B,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAChC,CAAC;oBACD,OAAO,SAAS,CAAC;gBACnB,CAAC;gBACD,0CAA0C;gBAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,OAAO,SAAS,CAAC;gBACnB,CAAC;gBACD,OAAO;oBACL,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB;oBACxC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB;iBAC1C,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CAAC,eAAe,MAAM,CAAC,IAAI,yBAAyB,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IAED,0EAA0E;IAC1E,qDAAqD;IAC7C,KAAK,CAAC,qBAAqB,CAAC,OAAwB;QAC1D,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,oDAAoD;IAC5C,KAAK,CAAC,aAAa,CAAC,IAAY;QACtC,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;YACrC,OAAO,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC/C,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,0BAA0B,IAAI,GAAG,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAED,+DAA+D;IAC/D,4CAA4C;IACpC,KAAK,CAAC,qBAAqB,CAAC,MAAqB;QACvD,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC;YACtC,+BAA+B;YAC/B,UAAU,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC3E,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAChC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,0DAA0D;IAClD,KAAK,CAAC,gBAAgB,CAAC,MAAqB;QAClD,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,gDAAgD;IACxC,KAAK,CAAC,eAAe,CAAC,MAAqB;QACjD,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC;IAED,sBAAsB;IACd,KAAK,CAAC,YAAY,CAAC,MAAqB;QAC9C,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YAC9B,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;YAC/B,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,6DAA6D;IACrD,KAAK,CAAC,gBAAgB,CAAC,MAAqB;QAClD,MAAM,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3D,OAAO,CAAC,GAAG,CACT,wBAAwB,MAAM,CAAC,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,GAAG,CAC/E,CAAC;IACJ,CAAC;IAED,iDAAiD;IACzC,KAAK,CAAC,cAAc,CAAC,MAAqB;QAChD,MAAM,IAAI,CAAC,SAAS,CAAC,oBAAoB,CACvC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,CACvC,CAAC;QACF,OAAO,CAAC,GAAG,CACT,wBAAwB,MAAM,CAAC,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,GAAG,CAC/E,CAAC;IACJ,CAAC;IAED,uDAAuD;IAC/C,YAAY,CAAC,MAAqB;QACxC,IAAI,CAAC,MAAM,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAC;QACnC,OAAO,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,uCAAuC;IAC/B,KAAK,CAAC,OAAO;QACnB,MAAM,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC;YACtD,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE;gBACxC,KAAK,EAAE,IAAI;gBACX,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,qEAAqE;IAC7D,QAAQ,CAAC,MAAqB;QACpC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;IACpD,CAAC;IAED,uCAAuC;IAC/B,KAAK,CAAC,MAAM,CAAC,MAAqB;QACxC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,gCAAgC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK;gBACxB,OAAO,CAAC,KAAK,CACX,4BAA4B,MAAM,CAAC,IAAI,oBAAoB,CAC5D,CAAC;QACN,CAAC;IACH,CAAC;IAED,uBAAuB;IACf,KAAK,CAAC,iBAAiB,CAAC,UAAkB;QAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,aAAa,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,kGAAkG;IAC1F,0BAA0B,CAAC,MAAqB;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,SAAS,CACzC,QAAQ,CAAC,MAAM,GAAG,CAAC,EACnB,MAAM,CAAC,QAAQ,CAAC,MAAM,CACvB,CAAC;IACJ,CAAC;IAED,4EAA4E;IAC5E,2DAA2D;IAC3D,iFAAiF;IACjF,kDAAkD;IAC1C,gBAAgB,CAAC,OAAwB;QAC/C,MAAM,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;QAEnD,oDAAoD;QACpD,MAAM,eAAe,GAAG,CAAC,MAA0B,EAAU,EAAE;YAC7D,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;gBACvD,OAAO,WAAW,CAAC;YACrB,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,cAAc,GAAG,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAClD,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,cAAc,CAAC,OAAO,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;oBAC9C,MAAM,IAAI,KAAK,CACb,qBAAqB,MAAM,CAAC,IAAI,2BAA2B;wBACzD,OAAO,cAAc,CAAC,OAAO,IAAI,WAAW,IAAI;wBAChD,OAAO,MAAM,CAAC,OAAO,IAAI,WAAW,EAAE,CACzC,CAAC;gBACJ,CAAC;gBACD,IAAI,cAAc,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;oBAChD,MAAM,IAAI,KAAK,CACb,qBAAqB,MAAM,CAAC,IAAI,8BAA8B;wBAC5D,OAAO,cAAc,CAAC,QAAQ,IAAI;wBAClC,OAAO,MAAM,CAAC,QAAQ,EAAE,CAC3B,CAAC;gBACJ,CAAC;gBACD,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC9D,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAEjD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;oBACjC,MAAM,IAAI,KAAK,CACb,qBAAqB,MAAM,CAAC,IAAI,6BAA6B;wBAC3D,OAAO,cAAc,CAAC,MAAM,IAAI,WAAW,IAAI;wBAC/C,OAAO,MAAM,CAAC,MAAM,IAAI,WAAW,EAAE,CACxC,CAAC;gBACJ,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,mCAAmC;IAC3B,cAAc,CAAC,MAAc;QACnC,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,wBAAwB;QACxF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,yDAAyD;IACjD,KAAK,CAAC,cAAc,CAAC,YAAoB;QAC/C,2CAA2C;QAC3C,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QACnE,IAAI,qBAAqB,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,KAAK,CACb,kCAAkC,YAAY,mEAAmE,CAClH,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,WAAoB;QAChE,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,GAAG,CAC7D,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,gDAAgD,MAAM,GAAG,CAC1D,CAAC;QACJ,CAAC;QACD,IAAI,WAAW,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CACb,uDAAuD,WAAW,GAAG,CACtE,CAAC;QACJ,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1C,MAAM,YAAY,GAAG,aAAa,CAAC,aAAa,CAAC;QACjD,MAAM,eAAe,GAAG,IAAI,CAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,EAChC,YAAY,CACb,CAAC;QACF,MAAM,UAAU,GAAG,aAAa,CAAC,KAAK,CAAC,eAAe,CAAC;QAEvD,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAExC,cAAc;QACd,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACxD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAAC,MAAc,EAAE,OAA8B;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;YAChC,IAAI,EAAE,EAAE;YACR,QAAQ,EAAE,MAAM;YAChB,GAAG,OAAO;SACX,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3E,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC;QACzE,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAExC,MAAM,UAAU,GAAG,IAAI,YAAY,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC;QAC/D,MAAM,eAAe,GAAG,IAAI,CAC1B,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,EAChC,YAAY,CACb,CAAC;QACF,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACxD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,6EAA6E;QAC7E,SAAS,KAAK;YACZ,OAAO,CAAC,GAAG,CAAC,qDAAqD,CAAC,CAAC;YACnE,OAAO,WAAW,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;QAC3D,CAAC;QAED,qCAAqC;QACrC,SAAS,QAAQ,CAAC,QAAwB,EAAE,OAAiB;YAC3D,aAAa,CAAC,QAAQ,CAAC,CAAC;YACxB,OAAO,CAAC,GAAG,CAAC,wBAAwB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAErB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;QACnD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,WAAW,GAAG,KAAK,EAAE,CAAC;QAE5B,sDAAsD;QACtD,MAAM,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAE1C,IAAI,aAAa,GAAoB,EAAE,CAAC;QACxC,IAAI,CAAC;YACH,aAAa,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;gBAAS,CAAC;YACT,QAAQ,CACN,WAAW,EACX,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CACvC,CAAC;YAEF,2BAA2B;YAC3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;YACrC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAC/B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CACzC,CAAC;YACF,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE5B,MAAM,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACrC,MAAM,IAAI,CAAC,OAAO,CAAC,sBAAsB,EAAE,CAAC;QAC9C,CAAC;IACH,CAAC;CACF"}

package/dist/permissions/action-guard.d.ts

@@ -0,0 +1,28 @@
+/**
+    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 { Calculate } from '../commands/index.js';
+import type { DeniedOperationCollection } from '../types/queries.js';
+export type Action = keyof DeniedOperationCollection;
+/**
+ * This class is used to guard actions from being used without permissions
+ */
+export declare class ActionGuard {
+    private calculate;
+    constructor(calculate: Calculate);
+    /**
+     * Checks whether an action can be done
+     * @param action Action that will be done
+     * @param cardKey Key of the card being targeted
+     * @param param  Required or not used param depending on the action
+     */
+    checkPermission(action: Action, cardKey: string, param?: string): Promise<void>;
+}

package/dist/permissions/action-guard.js

@@ -0,0 +1,61 @@
+/**
+    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/>.
+*/
+function checkOperation(data) {
+    if (data.length > 0) {
+        throw new Error(data.map((value) => value.errorMessage).join('; '));
+    }
+}
+/**
+ * This class is used to guard actions from being used without permissions
+ */
+export class ActionGuard {
+    calculate;
+    constructor(calculate) {
+        this.calculate = calculate;
+    }
+    /**
+     * Checks whether an action can be done
+     * @param action Action that will be done
+     * @param cardKey Key of the card being targeted
+     * @param param  Required or not used param depending on the action
+     */
+    async checkPermission(action, cardKey, param) {
+        await this.calculate.generate();
+        const cards = await this.calculate.runQuery('card', {
+            cardKey,
+        });
+        if (cards.length === 0) {
+            throw new Error("Card query didn't return results");
+        }
+        if (cards.length !== 1) {
+            throw new Error('Card query returned multiple cards');
+        }
+        const res = cards[0];
+        if (action === 'editContent') {
+            return checkOperation(res.deniedOperations.editContent);
+        }
+        if (action === 'transition') {
+            return checkOperation(res.deniedOperations.transition.filter((value) => value.transitionName === param));
+        }
+        if (action === 'delete') {
+            return checkOperation(res.deniedOperations.delete);
+        }
+        if (action === 'editField') {
+            return checkOperation(res.deniedOperations.editField.filter((value) => value.fieldName === param));
+        }
+        if (action === 'move') {
+            return checkOperation(res.deniedOperations.move);
+        }
+        throw new Error(`Action: ${action} does not support checking permissions`);
+    }
+}
+//# sourceMappingURL=action-guard.js.map

package/dist/permissions/action-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action-guard.js","sourceRoot":"","sources":["../../src/permissions/action-guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAOF,SAAS,cAAc,CAAqC,IAAc;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtE,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IACF;IAApB,YAAoB,SAAoB;QAApB,cAAS,GAAT,SAAS,CAAW;IAAG,CAAC;IAE5C;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAC1B,MAAc,EACd,OAAe,EACf,KAAc;QAEd,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;YAClD,OAAO;SACR,CAAC,CAAC;QACH,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,MAAM,KAAK,aAAa,EAAE,CAAC;YAC7B,OAAO,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,MAAM,KAAK,YAAY,EAAE,CAAC;YAC5B,OAAO,cAAc,CACnB,GAAG,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CACpC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,KAAK,KAAK,CAC1C,CACF,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxB,OAAO,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACrD,CAAC;QACD,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;YAC3B,OAAO,cAAc,CACnB,GAAG,CAAC,gBAAgB,CAAC,SAAS,CAAC,MAAM,CACnC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,KAAK,KAAK,CACrC,CACF,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACtB,OAAO,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,WAAW,MAAM,wCAAwC,CAAC,CAAC;IAC7E,CAAC;CACF"}

package/dist/project-settings.d.ts

@@ -0,0 +1,42 @@
+/**
+  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 { ModuleSetting, ProjectSettings } from './interfaces/project-interfaces.js';
+/**
+ * Represents Project's cardsConfig.json file.
+ */
+export declare class ProjectConfiguration implements ProjectSettings {
+    private static instance;
+    name: string;
+    cardKeyPrefix: string;
+    modules: ModuleSetting[];
+    private settingPath;
+    constructor(path: string);
+    save(): Promise<void>;
+    private readSettings;
+    private toJSON;
+    /**
+     * Adds new module to imported modules property.
+     * @param module Module to add as dependency
+     */
+    addModule(module: ModuleSetting): Promise<void>;
+    /**
+     * Removes module from imported modules property.
+     * @param moduleName Name of the module to remove.
+     */
+    removeModule(moduleName: string): Promise<void>;
+    /**
+     * Changes project prefix.
+     * @param newPrefix New prefix to use in the project
+     */
+    setCardPrefix(newPrefix: string): Promise<void>;
+}