@cyberismo/data-handler 0.0.2

package/dist/resources/template-resource.js

@@ -0,0 +1,173 @@
+/**
+  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, dirname, join } from 'node:path';
+import { mkdir } from 'node:fs/promises';
+import { DefaultContent, FolderResource, resourceNameToString, sortCards, } from './folder-resource.js';
+import { Template } from '../containers/template.js';
+import { writeJsonFile } from '../utils/json.js';
+/**
+ * Template resource class.
+ */
+export class TemplateResource extends FolderResource {
+    cardContainer;
+    cardsFolder = '';
+    cardsSchema = super.contentSchemaContent('cardBaseSchema');
+    constructor(project, name) {
+        super(project, name, 'templates');
+        this.contentSchemaId = 'templateSchema';
+        this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
+        this.initialize();
+        this.cardsFolder = join(this.internalFolder, 'c');
+        // Each template resource contains a template card container (with template cards).
+        this.cardContainer = new Template(this.project, {
+            name: basename(this.fileName),
+            path: dirname(this.fileName),
+        });
+    }
+    // When resource name changes.
+    async handleNameChange(existingName) {
+        await Promise.all([
+            super.updateHandleBars(existingName, this.content.name),
+            super.updateCalculations(existingName, this.content.name),
+        ]);
+        // Finally, write updated content.
+        await this.write();
+    }
+    /**
+     * Sets new metadata into the template object.
+     * @param newContent metadata content for the template.
+     * @throws if 'newContent' is not valid.
+     */
+    async create(newContent) {
+        if (!newContent) {
+            newContent = DefaultContent.template(resourceNameToString(this.resourceName));
+        }
+        else {
+            await this.validate(newContent);
+        }
+        return super.create(newContent);
+    }
+    /**
+     * Returns content data.
+     */
+    get data() {
+        return super.data;
+    }
+    /**
+     * Deletes file and folder that this resource is based on.
+     */
+    async delete() {
+        return super.delete();
+    }
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    async rename(newName) {
+        const existingName = this.content.name;
+        await super.rename(newName);
+        return this.handleNameChange(existingName);
+    }
+    /**
+     * Shows metadata of the resource.
+     * @returns template metadata.
+     */
+    async show() {
+        const templateMetadata = (await super.show());
+        const container = this.templateObject();
+        return {
+            metadata: templateMetadata,
+            name: resourceNameToString(this.resourceName),
+            path: this.fileName,
+            numberOfCards: (await container.listCards()).length,
+        };
+    }
+    /**
+     * Returns template card container object.
+     * @returns template container object
+     */
+    templateObject() {
+        return this.cardContainer;
+    }
+    /**
+     * Updates template resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     * @throws if key is unknown.
+     */
+    async update(key, op) {
+        const nameChange = key === 'name';
+        const existingName = this.content.name;
+        await super.update(key, op);
+        const content = { ...this.content };
+        if (key === 'name') {
+            content.name = super.handleScalar(op);
+        }
+        else if (key === 'displayName') {
+            content.displayName = super.handleScalar(op);
+        }
+        else if (key === 'description') {
+            content.description = super.handleScalar(op);
+        }
+        else if (key === 'category') {
+            content.category = super.handleScalar(op);
+        }
+        else {
+            throw new Error(`Unknown property '${key}' for Template`);
+        }
+        await super.postUpdate(content, key, op);
+        // Renaming this template causes that references to its name must be updated.
+        if (nameChange) {
+            await this.handleNameChange(existingName);
+        }
+    }
+    /**
+     * List where template is used.
+     * Always returns card key references first, then calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys, and calculation filenames that refer this resource.
+     */
+    async usage(cards) {
+        const allCards = cards ?? (await super.cards());
+        const [relevantCards, calculations] = await Promise.all([
+            super.usage(allCards),
+            super.calculations(),
+        ]);
+        return [...relevantCards.sort(sortCards), ...calculations];
+    }
+    /**
+     * Validates template.
+     * @throws when there are validation errors.
+     * @param content Content to be validated.
+     * @note If content is not provided, base class validation will use resource's current content.
+     */
+    async validate(content) {
+        return super.validate(content);
+    }
+    /**
+     * Create the template's cards folder.
+     */
+    async write() {
+        await super.write();
+        this.cardsFolder = join(this.internalFolder, 'c');
+        // Create folder for cards and put proper content schema file there
+        const schemaContentFile = join(this.cardsFolder, '.schema');
+        await mkdir(this.cardsFolder, { recursive: true });
+        await writeJsonFile(schemaContentFile, this.cardsSchema, {
+            flag: 'wx',
+        });
+    }
+}
+//# sourceMappingURL=template-resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"template-resource.js","sourceRoot":"","sources":["../../src/resources/template-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAQzC,OAAO,EACL,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,cAAc;IAC1C,aAAa,CAAW;IACxB,WAAW,GAAG,EAAE,CAAC;IACjB,WAAW,GAAG,KAAK,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;IAEnE,YAAY,OAAgB,EAAE,IAAkB;QAC9C,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAElC,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEtE,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAElD,mFAAmF;QACnF,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE;YAC9C,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;YAC7B,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;SAC7B,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IACtB,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QACjD,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACvD,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;SAC1D,CAAC,CAAC;QACH,kCAAkC;QAClC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,UAA6B;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,cAAc,CAAC,QAAQ,CAClC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CACxC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,KAAK,CAAC,IAAwB,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM;QACjB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,OAAqB;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,MAAM,gBAAgB,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,EAAE,CAAqB,CAAC;QAClE,MAAM,SAAS,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAExC,OAAO;YACL,QAAQ,EAAE,gBAAgB;YAC1B,IAAI,EAAE,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC;YAC7C,IAAI,EAAE,IAAI,CAAC,QAAQ;YACnB,aAAa,EAAE,CAAC,MAAM,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC,MAAM;SACpD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAO,GAAW,EAAE,EAAmB;QACxD,MAAM,UAAU,GAAG,GAAG,KAAK,MAAM,CAAC;QAClC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAEvC,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,EAAE,GAAI,IAAI,CAAC,OAA4B,EAAE,CAAC;QAE1D,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QAClD,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACzD,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACzD,CAAC;aAAM,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;YAC9B,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAEzC,6EAA6E;QAC7E,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc;QAC/B,MAAM,QAAQ,GAAG,KAAK,IAAI,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,YAAY,EAAE;SACrB,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,YAAY,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACpC,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QAElD,mEAAmE;QACnE,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC5D,MAAM,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnD,MAAM,aAAa,CAAC,iBAAiB,EAAE,IAAI,CAAC,WAAW,EAAE;YACvD,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,67 @@
+/**
+    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 { Workflow } from '../interfaces/resource-interfaces.js';
+import type { Card, Operation, Project, ResourceName } from './file-resource.js';
+import { FileResource } from './folder-resource.js';
+/**
+ * Workflow resource class.
+ */
+export declare class WorkflowResource extends FileResource {
+    constructor(project: Project, name: ResourceName);
+    private handleNameChange;
+    private updateCardTypes;
+    /**
+     * Sets new metadata into the workflow object.
+     * @param newContent metadata content for the workflow.
+     * @throws if 'newContent' is not valid.
+     */
+    create(newContent?: Workflow): Promise<void>;
+    /**
+     * Returns content data.
+     */
+    get data(): Workflow;
+    /**
+     * Deletes file that this object is based on.
+     * If there are card types that depended on this workflow, they are now invalid.
+     */
+    delete(): Promise<void>;
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    rename(newName: ResourceName): Promise<void>;
+    /**
+     * Shows metadata of the resource.
+     * @returns workflow metadata.
+     */
+    show(): Promise<Workflow>;
+    /**
+     * Updates workflow 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 workflow is used.
+     * Always returns card key references first, then any resource references and finally calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys, resource names and calculation filenames that refer this resource.
+     */
+    usage(cards?: Card[]): Promise<string[]>;
+    /**
+     * Validates workflow.
+     * @throws when there are validation errors.
+     */
+    validate(content?: object): Promise<void>;
+}

package/dist/resources/workflow-resource.js

@@ -0,0 +1,156 @@
+/**
+    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 { CardTypeResource } from './card-type-resource.js';
+import { DefaultContent, FileResource, resourceNameToString, sortCards, } from './folder-resource.js';
+import { ResourcesFrom } from '../containers/project.js';
+import { resourceName } from './file-resource.js';
+/**
+ * Workflow resource class.
+ */
+export class WorkflowResource extends FileResource {
+    constructor(project, name) {
+        super(project, name, 'workflows');
+        this.contentSchemaId = 'workflowSchema';
+        this.contentSchema = super.contentSchemaContent(this.contentSchemaId);
+        this.initialize();
+    }
+    // When resource name changes.
+    async handleNameChange(existingName) {
+        await Promise.all([
+            super.updateHandleBars(existingName, this.content.name),
+            super.updateCalculations(existingName, this.content.name),
+        ]);
+        // Finally, write updated content.
+        await this.write();
+    }
+    // Update dependant card types.
+    async updateCardTypes(oldName) {
+        const cardTypes = await this.project.cardTypes(ResourcesFrom.localOnly);
+        const op = {
+            name: 'change',
+            target: oldName,
+            to: this.content.name,
+        };
+        for (const cardType of cardTypes) {
+            const object = new CardTypeResource(this.project, resourceName(cardType.name));
+            if (object.data && object.data.workflow === oldName) {
+                await object.update('workflow', op);
+            }
+        }
+    }
+    /**
+     * Sets new metadata into the workflow object.
+     * @param newContent metadata content for the workflow.
+     * @throws if 'newContent' is not valid.
+     */
+    async create(newContent) {
+        if (!newContent) {
+            newContent = DefaultContent.workflow(resourceNameToString(this.resourceName));
+        }
+        else {
+            await this.validate(newContent);
+        }
+        return super.create(newContent);
+    }
+    /**
+     * Returns content data.
+     */
+    get data() {
+        return super.data;
+    }
+    /**
+     * Deletes file that this object is based on.
+     * If there are card types that depended on this workflow, they are now invalid.
+     */
+    async delete() {
+        return super.delete();
+    }
+    /**
+     * Renames the object and the file.
+     * @param newName New name for the resource.
+     */
+    async rename(newName) {
+        const existingName = this.content.name;
+        await super.rename(newName);
+        return this.handleNameChange(existingName);
+    }
+    /**
+     * Shows metadata of the resource.
+     * @returns workflow metadata.
+     */
+    async show() {
+        return super.show();
+    }
+    /**
+     * Updates workflow resource.
+     * @param key Key to modify
+     * @param op Operation to perform on 'key'
+     * @throws if key is unknown.
+     */
+    async update(key, op) {
+        const nameChange = key === 'name';
+        const existingName = this.content.name;
+        await super.update(key, op);
+        const content = { ...this.content };
+        if (key === 'name') {
+            content.name = super.handleScalar(op);
+        }
+        else if (key === 'states') {
+            content.states = super.handleArray(op, key, content.states);
+        }
+        else if (key === 'transitions') {
+            content.transitions = super.handleArray(op, key, content.transitions);
+        }
+        else {
+            throw new Error(`Unknown property '${key}' for Workflow`);
+        }
+        await super.postUpdate(content, key, op);
+        // Renaming this workflow causes that references to its name must be updated.
+        if (nameChange) {
+            await this.handleNameChange(existingName);
+            await this.updateCardTypes(existingName);
+        }
+    }
+    /**
+     * List where workflow is used.
+     * Always returns card key references first, then any resource references and finally calculation references.
+     *
+     * @param cards Optional. Check these cards for usage of this resource. If undefined, will check all cards.
+     * @returns array of card keys, resource names and calculation filenames that refer this resource.
+     */
+    async usage(cards) {
+        const resourceName = resourceNameToString(this.resourceName);
+        const allCards = cards ?? (await super.cards());
+        const cardTypes = await this.project.cardTypes(ResourcesFrom.all);
+        const cardTypeReferences = await Promise.all(cardTypes.map(async (cardType) => {
+            const metadata = await this.project.resource(cardType.name);
+            return metadata?.workflow === resourceName ? cardType.name : null;
+        }));
+        const [relevantCards, calculations] = await Promise.all([
+            super.usage(allCards),
+            super.calculations(),
+        ]);
+        return [
+            ...relevantCards.sort(sortCards),
+            ...cardTypeReferences.filter((name) => name !== null),
+            ...calculations,
+        ];
+    }
+    /**
+     * Validates workflow.
+     * @throws when there are validation errors.
+     */
+    validate(content) {
+        return super.validate(content);
+    }
+}
+//# sourceMappingURL=workflow-resource.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-resource.js","sourceRoot":"","sources":["../../src/resources/workflow-resource.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAQF,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAQ3D,OAAO,EACL,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,SAAS,GACV,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,YAAY,OAAgB,EAAE,IAAkB;QAC9C,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAElC,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAEtE,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,8BAA8B;IACtB,KAAK,CAAC,gBAAgB,CAAC,YAAoB;QACjD,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACvD,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;SAC1D,CAAC,CAAC;QACH,kCAAkC;QAClC,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,+BAA+B;IACvB,KAAK,CAAC,eAAe,CAAC,OAAe;QAC3C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QACxE,MAAM,EAAE,GAAG;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;SACK,CAAC;QAC7B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CACjC,IAAI,CAAC,OAAO,EACZ,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAC5B,CAAC;YACF,IAAI,MAAM,CAAC,IAAI,IAAK,MAAM,CAAC,IAAiB,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAClE,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,UAAqB;QACvC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,cAAc,CAAC,QAAQ,CAClC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CACxC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,KAAK,CAAC,IAAgB,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QACjB,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,OAAqB;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACvC,MAAM,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI;QACf,OAAO,KAAK,CAAC,IAAI,EAAuB,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAO,GAAW,EAAE,EAAmB;QACxD,MAAM,UAAU,GAAG,GAAG,KAAK,MAAM,CAAC;QAClC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAEvC,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAE5B,MAAM,OAAO,GAAG,EAAE,GAAI,IAAI,CAAC,OAAoB,EAAE,CAAC;QAElD,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,YAAY,CAAC,EAAE,CAAW,CAAC;QAClD,CAAC;aAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,WAAW,CAChC,EAAE,EACF,GAAG,EACH,OAAO,CAAC,MAAgB,CACN,CAAC;QACvB,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YACjC,OAAO,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CACrC,EAAE,EACF,GAAG,EACH,OAAO,CAAC,WAA6C,CAC9B,CAAC;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,gBAAgB,CAAC,CAAC;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QAEzC,6EAA6E;QAC7E,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc;QAC/B,MAAM,YAAY,GAAG,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,KAAK,IAAI,CAAC,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;QAChD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAClE,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC1C,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAW,QAAQ,CAAC,IAAI,CAAC,CAAC;YACtE,OAAO,QAAQ,EAAE,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACpE,CAAC,CAAC,CACH,CAAC;QAEF,MAAM,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACtD,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC;YACrB,KAAK,CAAC,YAAY,EAAE;SACrB,CAAC,CAAC;QAEH,OAAO;YACL,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;YAChC,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC;YACrE,GAAG,YAAY;SAChB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,OAAgB;QAC9B,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACF"}

package/dist/types/queries.d.ts

@@ -0,0 +1,142 @@
+/**
+    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/>.
+*/
+/**
+ * Types for query result
+ */
+import type { DataType, WorkflowCategory } from '../interfaces/resource-interfaces.js';
+export type LinkDirection = 'inbound' | 'outbound';
+export type StatusIndicator = WorkflowCategory | 'error';
+export interface CalculationLink {
+    displayName: string;
+    key: string;
+    linkType: string;
+    title: string;
+    linkDescription?: string;
+    direction: LinkDirection;
+    linkSource: 'user' | 'calculated';
+}
+export interface Notification {
+    key: string;
+    category: string;
+    title: string;
+    message: string;
+}
+export interface PolicyCheckCollection {
+    successes: {
+        category: string;
+        title: string;
+    }[];
+    failures: {
+        category: string;
+        title: string;
+        errorMessage: string;
+        fieldName?: string;
+    }[];
+}
+export interface DeniedOperationCollection {
+    transition: {
+        transitionName: string;
+        errorMessage: string;
+    }[];
+    move: {
+        errorMessage: string;
+    }[];
+    delete: {
+        errorMessage: string;
+    }[];
+    editField: {
+        fieldName: string;
+        errorMessage: string;
+    }[];
+    editContent: {
+        errorMessage: string;
+    }[];
+}
+export interface BaseResult extends Record<string, unknown> {
+    key: string;
+    labels: string[];
+    links: CalculationLink[];
+    notifications: Notification[];
+    policyChecks: PolicyCheckCollection;
+    deniedOperations: DeniedOperationCollection;
+}
+export interface ParseResult<T extends BaseResult> {
+    results: T[];
+    error: string | null;
+}
+/**
+ * Generic types for named queries
+ */
+export declare const queries: readonly ["card", "onCreation", "onTransition", "tree"];
+export type QueryName = (typeof queries)[number];
+export type QueryMap = {
+    card: CardQueryResult;
+    onCreation: FieldsToUpdateQueryResult;
+    onTransition: FieldsToUpdateQueryResult;
+    tree: TreeQueryResult;
+};
+export type QueryResult<T extends QueryName> = QueryMap[T];
+/**
+ * Define all the queries below
+ */
+interface CardQueryResult extends BaseResult {
+    progress?: string;
+    rank: string;
+    title: string;
+    cardType: string;
+    workflowState: string;
+    lastUpdated: string;
+    fields?: CardQueryField[];
+}
+interface FieldsToUpdateQueryResult extends BaseResult {
+    updateFields: UpdateField[];
+}
+interface TreeQueryResult extends BaseResult {
+    progress?: string;
+    rank: string;
+    title: string;
+    cardType: string;
+    statusIndicator?: StatusIndicator;
+    children?: TreeQueryResult[];
+}
+export interface UpdateField {
+    card: string;
+    field: string;
+    newValue: string;
+}
+interface EnumValue {
+    index?: number;
+    displayValue?: string;
+    value: string;
+}
+interface ListValueItem {
+    index?: number;
+    displayValue?: string;
+    value: string;
+}
+interface CardQueryField extends BaseResult {
+    visibility: 'always' | 'optional';
+    index: number;
+    fieldDisplayName: string;
+    fieldDescription: string;
+    dataType: DataType;
+    isCalculated: boolean;
+    value: string | number | boolean | null | EnumValue | ListValueItem[];
+    enumValues: EnumDefinition[];
+}
+export interface EnumDefinition extends BaseResult {
+    index: number;
+    enumDisplayValue: string;
+    enumDescription: string;
+    enumValue: string;
+}
+export {};

package/dist/types/queries.js

@@ -0,0 +1,16 @@
+/**
+    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/>.
+*/
+/**
+ * Generic types for named queries
+ */
+export const queries = ['card', 'onCreation', 'onTransition', 'tree'];
+//# sourceMappingURL=queries.js.map

package/dist/types/queries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queries.js","sourceRoot":"","sources":["../../src/types/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAgEF;;GAEG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,CAAU,CAAC"}

package/dist/utils/card-utils.d.ts

@@ -0,0 +1,34 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import type { Card } from '../interfaces/project-interfaces.js';
+export declare const findParentPath: (cardPath: string) => string | null;
+/**
+ * Flattens card tree so that children are shown on same level regardless of nesting level.
+ * @param array card tree
+ * @returns flattened card tree.
+ */
+export declare const flattenCardArray: (array: Card[]) => Card[];
+/**
+ * Checks if given card is in some template.
+ * @param card card object to check
+ * @returns true if card exists in a template; false otherwise
+ */
+export declare const isTemplateCard: (card: Card) => boolean;
+/**
+ * Sorts array of cards first using prefix and then using ID.
+ * Prefixes are returned in alphabetical order, and then in numeric order within same prefix.
+ * For example, test_za1, test_aa7 and demo_aaa are sorted to: demo_aaa, test_aa7, test_za1.
+ * @param a First card to be sorted
+ * @param b Second card to be sorted
+ * @returns Cards ordered; first by prefixes, then by ID.
+ */
+export declare const sortCards: (a: string, b: string) => 0 | 1 | -1;