@cyberismo/data-handler 0.0.2

package/dist/commands/show.d.ts

@@ -0,0 +1,124 @@
+/**
+  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 { attachmentPayload } from '../interfaces/request-status-interfaces.js';
+import type { CardAttachment, Card, CardListContainer, ModuleContent, ProjectFetchCardDetails, ProjectMetadata } from '../interfaces/project-interfaces.js';
+import type { CardType, ResourceContent, TemplateConfiguration, Workflow } from '../interfaces/resource-interfaces.js';
+import { Project } from '../containers/project.js';
+/**
+ * Show command.
+ */
+export declare class Show {
+    private project;
+    private resourceFunction;
+    constructor(project: Project);
+    private collectLabels;
+    private getAttachment;
+    private openUsingDefaultApplication;
+    /**
+     * Shows all attachments (either template or project attachments) from a project.
+     * @returns array of card attachments
+     */
+    showAttachments(): Promise<CardAttachment[]>;
+    /**
+     * Returns file buffer and mime type of an attachment. Used by app UI to download attachments.
+     * @param cardKey card key to find
+     * @param filename attachment filename
+     * @returns attachment details
+     */
+    showAttachment(cardKey: string, filename: string): Promise<attachmentPayload>;
+    /**
+     * Opens an attachment using a configured application or the operating system's default application.
+     * @param cardKey card key of the attachment
+     * @param filename attachment filename
+     * @param waitDelay amount of time to wait for the application to open the attachment
+     * @todo: Move away from Show.
+     */
+    openAttachment(cardKey: string, filename: string, waitDelay?: number): Promise<void>;
+    /**
+     * Shows details of a particular card (template card, or project card)
+     * @note Note that parameter 'cardKey' is optional due to technical limitations of class calling this class. It must be defined to get valid results.
+     * @param details card details to show
+     * @param cardKey card key to find
+     * @returns card details
+     */
+    showCardDetails(details: ProjectFetchCardDetails, cardKey?: string): Promise<Card>;
+    /**
+     * Shows all cards (either template or project cards) from a project.
+     * @returns cards list array
+     */
+    showCards(): Promise<CardListContainer[]>;
+    /**
+     * Shows all card types in a project.
+     * @returns array of card type details
+     */
+    showCardTypesWithDetails(): Promise<(CardType | undefined)[]>;
+    /**
+     * Returns all unique labels in a project
+     * @returns labels in a list
+     */
+    showLabels(): Promise<string[]>;
+    /**
+     * Shows details of a module.
+     * @param moduleName name of a module
+     * @returns details of a module.
+     */
+    showModule(moduleName: string): Promise<ModuleContent>;
+    /**
+     * Returns all project cards in the project. Cards don't have content and nor metadata.
+     * @note AppUi uses this method.
+     * @returns array of cards
+     */
+    showProjectCards(): Promise<Card[]>;
+    /**
+     * Shows all modules (if any) in a project.
+     * @returns all modules in a project.
+     */
+    showModules(): Promise<string[]>;
+    /**
+     * Shows details of a particular project.
+     * @returns project information
+     */
+    showProject(): Promise<ProjectMetadata>;
+    /**
+     * Shows report results for a given report name and card key.
+     * @param reportName Name of the report to show
+     * @param cardKey Card key to use for the report
+     * @param parameters Additional parameters for the report
+     * @param outputPath Optional output path for the report
+     * @returns Report results as a string
+     * @throws Error if the report does not exist
+     */
+    showReportResults(reportName: string, cardKey: string, parameters: object, outputPath?: string): Promise<string>;
+    /**
+     * Shows details of certain resource.
+     * @param name Name of resource.
+     * @returns resource metadata as JSON.
+     */
+    showResource(name: string, showUse?: boolean): Promise<ResourceContent | undefined>;
+    /**
+     * Shows all available resources of a given type.
+     * @param type Name of resources to return (in plural form, e.g. 'templates')
+     * @returns sorted array of resources
+     */
+    showResources(type: string): Promise<string[]>;
+    /**
+     * Shows all templates with full details in a project.
+     * @returns all templates in a project.
+     */
+    showTemplatesWithDetails(): Promise<TemplateConfiguration[]>;
+    /**
+     * Shows all workflows with full details in a project.
+     * @returns workflows with full details
+     */
+    showWorkflowsWithDetails(): Promise<(Workflow | undefined)[]>;
+}

package/dist/commands/show.js

@@ -0,0 +1,345 @@
+/**
+  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 { existsSync, readFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { join, resolve } from 'node:path';
+import { spawn } from 'node:child_process';
+import { writeFile } from 'node:fs/promises';
+import mime from 'mime-types';
+import { Project } from '../containers/project.js';
+import { resourceName } from '../utils/resource-utils.js';
+import { TemplateResource } from '../resources/template-resource.js';
+import { UserPreferences } from '../utils/user-preferences.js';
+import ReportMacro from '../macros/report/index.js';
+import TaskQueue from '../macros/task-queue.js';
+/**
+ * Show command.
+ */
+export class Show {
+    project;
+    resourceFunction;
+    constructor(project) {
+        this.project = project;
+        this.resourceFunction = new Map([
+            ['cardTypes', this.project.cardTypes.bind(this.project)],
+            ['fieldTypes', this.project.fieldTypes.bind(this.project)],
+            ['graphModels', this.project.graphModels.bind(this.project)],
+            ['graphViews', this.project.graphViews.bind(this.project)],
+            ['linkTypes', this.project.linkTypes.bind(this.project)],
+            ['reports', this.project.reports.bind(this.project)],
+            ['templates', this.project.templates.bind(this.project)],
+            ['workflows', this.project.workflows.bind(this.project)],
+        ]);
+    }
+    // Collect all labels from cards.
+    collectLabels = (cards) => {
+        return cards.reduce((labels, card) => {
+            // Add the labels from the current card
+            if (card.metadata?.labels) {
+                labels.push(...card.metadata.labels);
+            }
+            // Recursively collect labels from subcards, if they exist
+            if (card.children) {
+                labels.push(...this.collectLabels(card.children));
+            }
+            return labels;
+        }, []);
+    };
+    // Returns attachment details
+    async getAttachment(cardKey, filename) {
+        const details = {
+            content: false,
+            metadata: true,
+            children: false,
+            parent: false,
+            attachments: true,
+        };
+        const card = await this.project.cardDetailsById(cardKey, details);
+        if (card === undefined) {
+            throw new Error(`Card '${cardKey}' does not exist in the project`);
+        }
+        const attachment = card.attachments?.find((a) => a.fileName === filename) ?? undefined;
+        return attachment;
+    }
+    // Opens the given path using the operating system's default application. Doesn't block the main thread.
+    // @todo: Move away from Show.
+    openUsingDefaultApplication(path) {
+        if (process.platform === 'win32') {
+            // This is a workaround to get windows to open the file in foreground
+            spawn(`start`, ['cmd.exe', '/c', 'start', '""', `"${path}"`], {
+                shell: true,
+            });
+        }
+        else if (process.platform === 'darwin') {
+            spawn('open', [path]);
+        }
+        else {
+            spawn('xdg-open', [path]);
+        }
+    }
+    /**
+     * Shows all attachments (either template or project attachments) from a project.
+     * @returns array of card attachments
+     */
+    async showAttachments() {
+        const attachments = await this.project.attachments();
+        const templateAttachments = [];
+        const templates = await this.project.templates();
+        for (const template of templates) {
+            const templateResource = new TemplateResource(this.project, resourceName(template.name));
+            const templateObject = templateResource.templateObject();
+            if (templateObject) {
+                templateAttachments.push(...(await templateObject.attachments()));
+            }
+        }
+        attachments.push(...templateAttachments);
+        return attachments;
+    }
+    /**
+     * Returns file buffer and mime type of an attachment. Used by app UI to download attachments.
+     * @param cardKey card key to find
+     * @param filename attachment filename
+     * @returns attachment details
+     */
+    async showAttachment(cardKey, filename) {
+        if (!cardKey) {
+            throw new Error(`Mandatory parameter 'cardKey' missing`);
+        }
+        const attachment = await this.getAttachment(cardKey, filename);
+        let attachmentPath = '';
+        if (attachment) {
+            attachmentPath = `${attachment.path}/${attachment.fileName}`;
+        }
+        if (!attachment || !existsSync(attachmentPath)) {
+            throw new Error(`Attachment '${filename}' not found for card ${cardKey}`);
+        }
+        else {
+            const fileBuffer = readFileSync(attachmentPath);
+            let mimeType = mime.lookup(attachmentPath);
+            if (mimeType === false) {
+                mimeType = 'application/octet-stream';
+            }
+            const payload = { fileBuffer, mimeType };
+            return payload;
+        }
+    }
+    /**
+     * Opens an attachment using a configured application or the operating system's default application.
+     * @param cardKey card key of the attachment
+     * @param filename attachment filename
+     * @param waitDelay amount of time to wait for the application to open the attachment
+     * @todo: Move away from Show.
+     */
+    async openAttachment(cardKey, filename, waitDelay = 1000) {
+        const attachment = await this.getAttachment(cardKey, filename);
+        if (!attachment) {
+            throw new Error(`Attachment '${filename}' not found for card ${cardKey}`);
+        }
+        // Try to open the attachment using a configured application if one exists
+        const prefs = new UserPreferences(join(homedir(), '.cyberismo', 'cards.prefs.json')).getPreferences();
+        const attachmentEditors = prefs.attachmentEditors && process.platform in prefs.attachmentEditors
+            ? prefs.attachmentEditors[process.platform]
+            : [];
+        const editor = attachmentEditors.find((editor) => editor.mimeType === attachment.mimeType);
+        const path = resolve(attachment.path, attachment.fileName);
+        if (!editor) {
+            this.openUsingDefaultApplication(path);
+            return;
+        }
+        // We can safely assume that the editor command is safe to execute, since it is defined in the preferences file by the user
+        const processHandle = spawn(editor.command.replace('{{attachmentPath}}', path), [], {
+            shell: true,
+        });
+        // wait for the application to open the attachment
+        await new Promise((resolve) => setTimeout(resolve, waitDelay));
+        // If the application exists with a non-zero exit code, open the attachment using the operating system's default application
+        if (processHandle.exitCode !== 0 && processHandle.exitCode !== null) {
+            this.openUsingDefaultApplication(path);
+        }
+    }
+    /**
+     * Shows details of a particular card (template card, or project card)
+     * @note Note that parameter 'cardKey' is optional due to technical limitations of class calling this class. It must be defined to get valid results.
+     * @param details card details to show
+     * @param cardKey card key to find
+     * @returns card details
+     */
+    async showCardDetails(details, cardKey) {
+        if (!cardKey) {
+            throw new Error(`Mandatory parameter 'cardKey' missing`);
+        }
+        const cardDetails = await this.project.cardDetailsById(cardKey, details);
+        if (cardDetails === undefined) {
+            throw new Error(`Card '${cardKey}' does not exist in the project`);
+        }
+        return cardDetails;
+    }
+    /**
+     * Shows all cards (either template or project cards) from a project.
+     * @returns cards list array
+     */
+    async showCards() {
+        return this.project.listCards();
+    }
+    /**
+     * Shows all card types in a project.
+     * @returns array of card type details
+     */
+    async showCardTypesWithDetails() {
+        const promiseContainer = [];
+        for (const cardType of await this.project.cardTypes()) {
+            const cardTypeDetails = await this.project.resource(cardType.name);
+            if (cardTypeDetails) {
+                promiseContainer.push(cardTypeDetails);
+            }
+        }
+        const results = await Promise.all(promiseContainer);
+        return results.filter((item) => item);
+    }
+    /**
+     * Returns all unique labels in a project
+     * @returns labels in a list
+     */
+    async showLabels() {
+        const cards = await this.project.showProjectCards();
+        const templateCards = await this.project.allTemplateCards({
+            metadata: true,
+            children: true,
+        });
+        const labels = this.collectLabels([...cards, ...templateCards]);
+        return Array.from(new Set(labels));
+    }
+    /**
+     * Shows details of a module.
+     * @param moduleName name of a module
+     * @returns details of a module.
+     */
+    async showModule(moduleName) {
+        const moduleDetails = await this.project.module(moduleName);
+        if (!moduleDetails) {
+            throw new Error(`Module '${moduleName}' does not exist in the project`);
+        }
+        return moduleDetails;
+    }
+    /**
+     * Returns all project cards in the project. Cards don't have content and nor metadata.
+     * @note AppUi uses this method.
+     * @returns array of cards
+     */
+    async showProjectCards() {
+        const projectCards = await this.project.showProjectCards();
+        return projectCards;
+    }
+    /**
+     * Shows all modules (if any) in a project.
+     * @returns all modules in a project.
+     */
+    async showModules() {
+        return (await this.project.modules()).map((item) => item.name).sort();
+    }
+    /**
+     * Shows details of a particular project.
+     * @returns project information
+     */
+    async showProject() {
+        return this.project.show();
+    }
+    /**
+     * Shows report results for a given report name and card key.
+     * @param reportName Name of the report to show
+     * @param cardKey Card key to use for the report
+     * @param parameters Additional parameters for the report
+     * @param outputPath Optional output path for the report
+     * @returns Report results as a string
+     * @throws Error if the report does not exist
+     */
+    async showReportResults(reportName, cardKey, parameters, outputPath) {
+        if (!(await this.project.reports()).some((report) => report.name === reportName)) {
+            throw new Error(`Report '${reportName}' does not exist`);
+        }
+        const reportMacro = new ReportMacro(new TaskQueue());
+        const result = await reportMacro.handleInject({
+            projectPath: this.project.basePath,
+            cardKey: cardKey,
+            mode: 'static',
+        }, { name: reportName, ...parameters });
+        // Show the results either in the console or write to a file.
+        if (outputPath) {
+            try {
+                await writeFile(outputPath, result ?? '', 'utf-8');
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    throw new Error(`Failed to write report to ${outputPath}: ${error.message}`);
+                }
+            }
+        }
+        return outputPath ? '' : (result ?? '');
+    }
+    /**
+     * Shows details of certain resource.
+     * @param name Name of resource.
+     * @returns resource metadata as JSON.
+     */
+    async showResource(name, showUse = false) {
+        const strictNameCheck = true;
+        const resource = Project.resourceObject(this.project, resourceName(name, strictNameCheck));
+        const [details, usage] = await Promise.all([
+            resource?.show(),
+            showUse ? resource?.usage() : [],
+        ]);
+        if (showUse) {
+            return {
+                ...details,
+                usedIn: [...usage],
+            };
+        }
+        else {
+            return details;
+        }
+    }
+    /**
+     * Shows all available resources of a given type.
+     * @param type Name of resources to return (in plural form, e.g. 'templates')
+     * @returns sorted array of resources
+     */
+    async showResources(type) {
+        const func = this.resourceFunction.get(type);
+        if (!func)
+            return [];
+        return (await func()).map((item) => item.name).sort();
+    }
+    /**
+     * Shows all templates with full details in a project.
+     * @returns all templates in a project.
+     */
+    async showTemplatesWithDetails() {
+        const promiseContainer = (await this.project.templates()).map((template) => new TemplateResource(this.project, resourceName(template.name)).show());
+        const result = await Promise.all(promiseContainer);
+        return result.filter(Boolean);
+    }
+    /**
+     * Shows all workflows with full details in a project.
+     * @returns workflows with full details
+     */
+    async showWorkflowsWithDetails() {
+        const promiseContainer = [];
+        for (const workflow of await this.project.workflows()) {
+            promiseContainer.push(this.project.resource(workflow.name));
+        }
+        const results = await Promise.all(promiseContainer);
+        return results.filter((item) => item);
+    }
+}
+//# sourceMappingURL=show.js.map

package/dist/commands/show.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"show.js","sourceRoot":"","sources":["../../src/commands/show.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;EAWE;AAEF,OAAO;AACP,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,IAAI,MAAM,YAAY,CAAC;AAkB9B,OAAO,EAAE,OAAO,EAAsB,MAAM,0BAA0B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,OAAO,WAAW,MAAM,2BAA2B,CAAC;AACpD,OAAO,SAAS,MAAM,yBAAyB,CAAC;AAEhD;;GAEG;AACH,MAAM,OAAO,IAAI;IAKK;IAJZ,gBAAgB,CAGtB;IACF,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;QAClC,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,CAAC;YAC9B,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5D,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC1D,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxD,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACzD,CAAC,CAAC;IACL,CAAC;IAED,iCAAiC;IACzB,aAAa,GAAG,CAAC,KAAa,EAAY,EAAE;QAClD,OAAO,KAAK,CAAC,MAAM,CAAW,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;YAC7C,uCAAuC;YACvC,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC;YACD,0DAA0D;YAC1D,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC,CAAC;IAEF,6BAA6B;IACrB,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,QAAgB;QAC3D,MAAM,OAAO,GAAG;YACd,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,IAAI;SAClB,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAClE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,iCAAiC,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,UAAU,GACd,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,IAAI,SAAS,CAAC;QACtE,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,wGAAwG;IACxG,8BAA8B;IACtB,2BAA2B,CAAC,IAAY;QAC9C,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjC,qEAAqE;YACrE,KAAK,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,GAAG,CAAC,EAAE;gBAC5D,KAAK,EAAE,IAAI;aACZ,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACzC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe;QAC1B,MAAM,WAAW,GAAqB,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACvE,MAAM,mBAAmB,GAAqB,EAAE,CAAC;QACjD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACjD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAC3C,IAAI,CAAC,OAAO,EACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAC5B,CAAC;YACF,MAAM,cAAc,GAAG,gBAAgB,CAAC,cAAc,EAAE,CAAC;YACzD,IAAI,cAAc,EAAE,CAAC;gBACnB,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAC;QACzC,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,QAAgB;QAEhB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE/D,IAAI,cAAc,GAAW,EAAE,CAAC;QAChC,IAAI,UAAU,EAAE,CAAC;YACf,cAAc,GAAG,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC/D,CAAC;QAED,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,wBAAwB,OAAO,EAAE,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,MAAM,UAAU,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;YAChD,IAAI,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAC3C,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;gBACvB,QAAQ,GAAG,0BAA0B,CAAC;YACxC,CAAC;YACD,MAAM,OAAO,GAAsB,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;YAC5D,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,QAAgB,EAChB,YAAoB,IAAI;QAExB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE/D,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,eAAe,QAAQ,wBAAwB,OAAO,EAAE,CAAC,CAAC;QAC5E,CAAC;QAED,0EAA0E;QAC1E,MAAM,KAAK,GAAG,IAAI,eAAe,CAC/B,IAAI,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAClD,CAAC,cAAc,EAAE,CAAC;QACnB,MAAM,iBAAiB,GACrB,KAAK,CAAC,iBAAiB,IAAI,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC,iBAAiB;YACpE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC3C,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,CACnC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,UAAU,CAAC,QAAQ,CACpD,CAAC;QAEF,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE3D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO;QACT,CAAC;QAED,2HAA2H;QAC3H,MAAM,aAAa,GAAG,KAAK,CACzB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAClD,EAAE,EACF;YACE,KAAK,EAAE,IAAI;SACZ,CACF,CAAC;QAEF,kDAAkD;QAClD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QAE/D,4HAA4H;QAC5H,IAAI,aAAa,CAAC,QAAQ,KAAK,CAAC,IAAI,aAAa,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpE,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAC1B,OAAgC,EAChC,OAAgB;QAEhB,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACzE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,SAAS,OAAO,iCAAiC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,QAAQ,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;YACtD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACjD,QAAQ,CAAC,IAAI,CACd,CAAC;YACF,IAAI,eAAe,EAAE,CAAC;gBACpB,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACpD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC;YACxD,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,KAAK,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC;QAChE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,UAAkB;QACxC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,iCAAiC,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC3B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAC3D,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW;QACtB,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,iBAAiB,CAC5B,UAAkB,EAClB,OAAe,EACf,UAAkB,EAClB,UAAmB;QAEnB,IACE,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAClC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CACvC,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,kBAAkB,CAAC,CAAC;QAC3D,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC;QACrD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,YAAY,CAC3C;YACE,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAClC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,QAAQ;SACf,EACD,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CACpC,CAAC;QAEF,6DAA6D;QAC7D,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,SAAS,CAAC,UAAU,EAAE,MAAM,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;YACrD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CACb,6BAA6B,UAAU,KAAK,KAAK,CAAC,OAAO,EAAE,CAC5D,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,IAAY,EACZ,UAAmB,KAAK;QAExB,MAAM,eAAe,GAAG,IAAI,CAAC;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CACrC,IAAI,CAAC,OAAO,EACZ,YAAY,CAAC,IAAI,EAAE,eAAe,CAAC,CACpC,CAAC;QACF,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACzC,QAAQ,EAAE,IAAI,EAAE;YAChB,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;SACjC,CAAC,CAAC;QACH,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO;gBACL,GAAG,OAAO;gBACV,MAAM,EAAE,CAAC,GAAG,KAAK,CAAC;aACnB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,OAAO,CAAC;QACjB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,IAAY;QACrC,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QACrB,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,MAAM,gBAAgB,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACzE,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CACvE,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAA4B,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,wBAAwB;QACnC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,QAAQ,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;YACtD,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAW,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACF"}

package/dist/commands/transition.d.ts

@@ -0,0 +1,27 @@
+/**
+  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 './calculate.js';
+import type { WorkflowState } from '../interfaces/resource-interfaces.js';
+import type { Project } from '../containers/project.js';
+export declare class Transition {
+    private project;
+    private calculateCmd;
+    constructor(project: Project, calculateCmd: Calculate);
+    /**
+     * Transitions a card from its current state to a new state.
+     * @param cardKey card key
+     * @param transition which transition to do
+     */
+    cardTransition(cardKey: string, transition: WorkflowState): Promise<void>;
+    private transitionChangesQuery;
+}

package/dist/commands/transition.js

@@ -0,0 +1,92 @@
+/**
+  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 { ActionGuard } from '../permissions/action-guard.js';
+import { CardMetadataUpdater } from '../card-metadata-updater.js';
+export class Transition {
+    project;
+    calculateCmd;
+    constructor(project, calculateCmd) {
+        this.project = project;
+        this.calculateCmd = calculateCmd;
+    }
+    /**
+     * Transitions a card from its current state to a new state.
+     * @param cardKey card key
+     * @param transition which transition to do
+     */
+    async cardTransition(cardKey, transition) {
+        // Card details
+        const details = await this.project.cardDetailsById(cardKey, {
+            metadata: true,
+        });
+        if (!details || !details.metadata) {
+            throw new Error(`Card ${cardKey} does not exist in the project`);
+        }
+        // Card type
+        const cardType = await this.project.resource(details.metadata?.cardType);
+        if (cardType === undefined) {
+            throw new Error(`Card's card type '${details.metadata?.cardType}' does not exist in the project`);
+        }
+        // Workflow
+        const workflow = await this.project.resource(cardType.workflow);
+        if (workflow === undefined) {
+            throw new Error(`Card's workflow '${cardType.workflow}' does not exist in the project`);
+        }
+        // Check that the state transition can be made "from".
+        const foundFrom = workflow.transitions.find((item) => (details.metadata &&
+            item.fromState.includes(details.metadata?.workflowState)) ||
+            item.fromState.includes('*'));
+        if (!foundFrom) {
+            throw new Error(`Card's workflow '${cardType.workflow}' does not contain transition from card's current state '${details.metadata?.workflowState}'`);
+        }
+        // Check that the state transition can be made "to".
+        const found = workflow.transitions.find((item) => item.name === transition.name);
+        if (!found) {
+            const transitionNames = workflow.transitions.map((item) => item.name);
+            throw new Error(`Card's workflow '${cardType.workflow}' does not contain state transition '${transition.name}'.
+                          \nThe available transitions are: ${transitionNames.join(', ')}`);
+        }
+        if (!(found.fromState.includes(details.metadata?.workflowState) ||
+            found.fromState.includes('*'))) {
+            throw new Error(`Card's workflow '${cardType.workflow}' does not contain state transition from state '${details.metadata?.workflowState}' for '${transition.name}`);
+        }
+        const actionGuard = new ActionGuard(this.calculateCmd);
+        await actionGuard.checkPermission('transition', cardKey, transition.name);
+        details.metadata.workflowState = found.toState;
+        details.metadata.lastUpdated = new Date().toISOString();
+        details.metadata.lastTransitioned = new Date().toISOString();
+        return this.project
+            .updateCardMetadata(details, details.metadata)
+            .then(async () => this.transitionChangesQuery(cardKey, transition.name))
+            .then(async (queryResult) => {
+            if (!queryResult ||
+                queryResult.at(0) === undefined ||
+                queryResult.at(0)?.updateFields === undefined) {
+                return;
+            }
+            const fieldsToUpdate = queryResult.at(0).updateFields;
+            return CardMetadataUpdater.apply(this.project, fieldsToUpdate);
+        })
+            .catch((error) => console.error(error));
+    }
+    // Wrapper to run onTransition query.
+    async transitionChangesQuery(cardKey, transition) {
+        if (!cardKey || !transition)
+            return undefined;
+        return this.calculateCmd.runQuery('onTransition', {
+            cardKey,
+            transition,
+        });
+    }
+}
+//# sourceMappingURL=transition.js.map

package/dist/commands/transition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transition.js","sourceRoot":"","sources":["../../src/commands/transition.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;EAWE;AAEF,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAO7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAGlE,MAAM,OAAO,UAAU;IAEX;IACA;IAFV,YACU,OAAgB,EAChB,YAAuB;QADvB,YAAO,GAAP,OAAO,CAAS;QAChB,iBAAY,GAAZ,YAAY,CAAW;IAC9B,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,OAAe,EAAE,UAAyB;QACpE,eAAe;QACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE;YAC1D,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,QAAQ,OAAO,gCAAgC,CAAC,CAAC;QACnE,CAAC;QAED,YAAY;QACZ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAC1C,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAC3B,CAAC;QACF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,qBAAqB,OAAO,CAAC,QAAQ,EAAE,QAAQ,iCAAiC,CACjF,CAAC;QACJ,CAAC;QAED,WAAW;QACX,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAW,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,QAAQ,iCAAiC,CACvE,CAAC;QACJ,CAAC;QAED,sDAAsD;QACtD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CACzC,CAAC,IAAI,EAAE,EAAE,CACP,CAAC,OAAO,CAAC,QAAQ;YACf,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YAC3D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC/B,CAAC;QACF,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,QAAQ,4DAA4D,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,CACpI,CAAC;QACJ,CAAC;QAED,oDAAoD;QACpD,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CACrC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CACxC,CAAC;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,eAAe,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,CAAC,QAAQ,wCAAwC,UAAU,CAAC,IAAI;6DACrD,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvF,CAAC;QAED,IACE,CAAC,CACC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC;YACzD,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC9B,EACD,CAAC;YACD,MAAM,IAAI,KAAK,CACb,oBAAoB,QAAQ,CAAC,QAAQ,mDAAmD,OAAO,CAAC,QAAQ,EAAE,aAAa,UAAU,UAAU,CAAC,IAAI,EAAE,CACnJ,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACvD,MAAM,WAAW,CAAC,eAAe,CAAC,YAAY,EAAE,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;QAE1E,OAAO,CAAC,QAAQ,CAAC,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC;QAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACxD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO;aAChB,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC;aAC7C,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;aACvE,IAAI,CAAC,KAAK,EAAE,WAAW,EAAE,EAAE;YAC1B,IACE,CAAC,WAAW;gBACZ,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS;gBAC/B,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,KAAK,SAAS,EAC7C,CAAC;gBACD,OAAO;YACT,CAAC;YACD,MAAM,cAAc,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC,YAAY,CAAC;YACvD,OAAO,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACjE,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,qCAAqC;IAC7B,KAAK,CAAC,sBAAsB,CAAC,OAAe,EAAE,UAAkB;QACtE,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU;YAAE,OAAO,SAAS,CAAC;QAC9C,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,cAAc,EAAE;YAChD,OAAO;YACP,UAAU;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/commands/update.d.ts

@@ -0,0 +1,29 @@
+/**
+    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 { UpdateOperations } from '../resources/resource-object.js';
+import { Project } from '../containers/project.js';
+/**
+ * Class that handles 'update' commands.
+ */
+export declare class Update {
+    private project;
+    constructor(project: Project);
+    /**
+     * Updates single resource property.
+     * @param name Name of the resource to operate on.
+     * @param operation Operation to perform ('add', 'remove', 'change', 'rank')
+     * @param key Property to change in resource JSON
+     * @param value Value for 'key'
+     * @param optionalDetail Additional detail needed for some operations. For example, 'update' needs a new value.
+     */
+    updateValue<Type>(name: string, operation: UpdateOperations, key: string, value: Type, optionalDetail?: Type): Promise<void>;
+}