@cyberismo/data-handler 0.0.21 → 0.0.22

package/dist/commands/export.js

@@ -11,6 +11,40 @@
   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/>.
 */
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
 // node
 import { appendFile, copyFile, mkdir, truncate, writeFile, } from 'node:fs/promises';
 import { dirname, join } from 'node:path';
@@ -19,285 +53,300 @@ import { evaluateMacros } from '../macros/index.js';
 import { generateReportContent } from '../utils/report.js';
 import { getStaticDirectoryPath, pdfReport } from '@cyberismo/assets';
 import { Project } from '../containers/project.js';
+import { read } from '../utils/rw-lock.js';
 import { sortItems } from '../utils/lexorank.js';
 const attachmentFolder = 'a';
 /**
  * Handles all export commands.
  */
-export class Export {
-    project;
-    showCmd;
-    /**
-     * Creates an instance of export.
-     * @param project Project to use
-     * @param showCmd Instance of Export command to use.
-     */
-    constructor(project, showCmd) {
-        this.project = project;
-        this.showCmd = showCmd;
-    }
-    // This file should set the top level items to the adoc.
-    async toAdocFile(path, cards) {
-        await appendFile(path, `:imagesdir: ./${attachmentFolder}/\n`);
-        await this.toAdocFileAsContent(path, cards);
-    }
-    // Format card metadata to an AsciiDoc table.
-    metaToAdoc(card, cardType) {
-        let content = '';
-        if (card.metadata) {
-            content += `[.cyberismo-meta-wrapper]\n`;
-            content += '--\n';
-            content += `[.cyberismo-meta]\n`;
-            content += '[cols="1,1"]\n';
-            content += '[frame=none]\n';
-            content += '[grid=none]\n';
-            content += '|===\n';
-            content += `|Card key|${card.key}\n`;
-            content += `|Status|${card.metadata.workflowState}\n`;
-            content += `|Card type|${card.metadata.cardType}\n`;
-            content += `|Labels|${card.metadata.labels?.join(', ') || ''}`;
-            for (const [key, value] of Object.entries(card.metadata)) {
-                if (cardType?.alwaysVisibleFields.includes(key) ||
-                    cardType?.optionallyVisibleFields?.includes(key)) {
-                    const displayName = cardType?.customFields.find((item) => item.name === key)?.displayName;
-                    let nameToShow = displayName
-                        ? displayName
-                        : key[0].toUpperCase() + key.slice(1);
-                    if (nameToShow === 'WorkflowState') {
-                        nameToShow = 'Workflow state';
-                    }
-                    else if (nameToShow === 'Cardtype') {
-                        nameToShow = 'Card type';
-                    }
-                    // Escape pipe character in cell values
-                    let escapedValue = 'N/A';
-                    if (value) {
-                        escapedValue = value.toString().replaceAll('|', '\\|');
+let Export = (() => {
+    let _instanceExtraInitializers = [];
+    let _exportPdf_decorators;
+    let _exportToADoc_decorators;
+    return class Export {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
+            _exportPdf_decorators = [read];
+            _exportToADoc_decorators = [read];
+            __esDecorate(this, null, _exportPdf_decorators, { kind: "method", name: "exportPdf", static: false, private: false, access: { has: obj => "exportPdf" in obj, get: obj => obj.exportPdf }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(this, null, _exportToADoc_decorators, { kind: "method", name: "exportToADoc", static: false, private: false, access: { has: obj => "exportToADoc" in obj, get: obj => obj.exportToADoc }, metadata: _metadata }, null, _instanceExtraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        project = __runInitializers(this, _instanceExtraInitializers);
+        showCmd;
+        /**
+         * Creates an instance of export.
+         * @param project Project to use
+         * @param showCmd Instance of Export command to use.
+         */
+        constructor(project, showCmd) {
+            this.project = project;
+            this.showCmd = showCmd;
+        }
+        // This file should set the top level items to the adoc.
+        async toAdocFile(path, cards) {
+            await appendFile(path, `:imagesdir: ./${attachmentFolder}/\n`);
+            await this.toAdocFileAsContent(path, cards);
+        }
+        // Format card metadata to an AsciiDoc table.
+        metaToAdoc(card, cardType) {
+            let content = '';
+            if (card.metadata) {
+                content += `[.cyberismo-meta-wrapper]\n`;
+                content += '--\n';
+                content += `[.cyberismo-meta]\n`;
+                content += '[cols="1,1"]\n';
+                content += '[frame=none]\n';
+                content += '[grid=none]\n';
+                content += '|===\n';
+                content += `|Card key|${card.key}\n`;
+                content += `|Status|${card.metadata.workflowState}\n`;
+                content += `|Card type|${card.metadata.cardType}\n`;
+                content += `|Labels|${card.metadata.labels?.join(', ') || ''}`;
+                for (const [key, value] of Object.entries(card.metadata)) {
+                    if (cardType?.alwaysVisibleFields.includes(key) ||
+                        cardType?.optionallyVisibleFields?.includes(key)) {
+                        const displayName = cardType?.customFields.find((item) => item.name === key)?.displayName;
+                        let nameToShow = displayName
+                            ? displayName
+                            : key[0].toUpperCase() + key.slice(1);
+                        if (nameToShow === 'WorkflowState') {
+                            nameToShow = 'Workflow state';
+                        }
+                        else if (nameToShow === 'Cardtype') {
+                            nameToShow = 'Card type';
+                        }
+                        // Escape pipe character in cell values
+                        let escapedValue = 'N/A';
+                        if (value) {
+                            escapedValue = value.toString().replaceAll('|', '\\|');
+                        }
+                        content += `|${nameToShow}|${escapedValue}\n`;
                     }
-                    content += `|${nameToShow}|${escapedValue}\n`;
                 }
+                content += '|===\n';
+                content += '--\n';
             }
-            content += '|===\n';
-            content += '--\n';
+            return content;
         }
-        return content;
-    }
-    // Runs Ascii Doctor converter --> to PDF
-    async runAsciidoctorPdf(content) {
-        const staticRootDir = await getStaticDirectoryPath();
-        const proc = spawn('asciidoctor-pdf', [
-            '-a',
-            'pdf-theme=cyberismo',
-            '-a',
-            `pdf-themesdir=${join(staticRootDir, 'pdf-themes')}`,
-            '-a',
-            `pdf-fontsdir=${join(staticRootDir, 'pdf-themes', 'fonts')};GEM_FONTS_DIR`,
-            '-',
-        ], {
-            timeout: 100000,
-            shell: process.platform === 'win32',
-        });
-        proc.stdin.end(content);
-        const result = await new Promise((resolve, reject) => {
-            const chunks = [];
-            proc.stdout.on('data', (chunk) => {
-                chunks.push(chunk);
-            });
-            proc.stderr.on('data', (chunk) => {
-                process.stderr.write(chunk);
+        // Runs Ascii Doctor converter --> to PDF
+        async runAsciidoctorPdf(content) {
+            const staticRootDir = await getStaticDirectoryPath();
+            const proc = spawn('asciidoctor-pdf', [
+                '-a',
+                'pdf-theme=cyberismo',
+                '-a',
+                `pdf-themesdir=${join(staticRootDir, 'pdf-themes')}`,
+                '-a',
+                `pdf-fontsdir=${join(staticRootDir, 'pdf-themes', 'fonts')};GEM_FONTS_DIR`,
+                '-',
+            ], {
+                timeout: 100000,
+                shell: process.platform === 'win32',
             });
-            proc.on('error', (error) => {
-                if ('code' in error && error.code === 'ENOENT') {
-                    reject(new Error('Asciidoctor-pdf not found. Please install asciidoctor-pdf to use this feature.'));
-                }
-                reject(error);
+            proc.stdin.end(content);
+            const result = await new Promise((resolve, reject) => {
+                const chunks = [];
+                proc.stdout.on('data', (chunk) => {
+                    chunks.push(chunk);
+                });
+                proc.stderr.on('data', (chunk) => {
+                    process.stderr.write(chunk);
+                });
+                proc.on('error', (error) => {
+                    if ('code' in error && error.code === 'ENOENT') {
+                        reject(new Error('Asciidoctor-pdf not found. Please install asciidoctor-pdf to use this feature.'));
+                    }
+                    reject(error);
+                });
+                proc.on('close', (code) => {
+                    if (code === 0) {
+                        resolve(Buffer.concat(chunks));
+                    }
+                    else {
+                        reject(new Error(`Asciidoctor-pdf failed with code ${code}`));
+                    }
+                });
             });
-            proc.on('close', (code) => {
-                if (code === 0) {
-                    resolve(Buffer.concat(chunks));
+            return result;
+        }
+        // Adds cards to an ADOC file as additional content.
+        async toAdocFileAsContent(path, cards) {
+            for (const card of cards) {
+                let fileContent = '';
+                if (card.metadata?.title) {
+                    fileContent += `== ${card.metadata.title}\n\n`;
                 }
                 else {
-                    reject(new Error(`Asciidoctor-pdf failed with code ${code}`));
+                    fileContent += `== ${card.key}\n\n`;
                 }
-            });
-        });
-        return result;
-    }
-    // Adds cards to an ADOC file as additional content.
-    async toAdocFileAsContent(path, cards) {
-        for (const card of cards) {
-            let fileContent = '';
-            if (card.metadata?.title) {
-                fileContent += `== ${card.metadata.title}\n\n`;
-            }
-            else {
-                fileContent += `== ${card.key}\n\n`;
-            }
-            if (card.metadata) {
-                const cardTypeForCard = this.project.resources
-                    .byType(card.metadata?.cardType, 'cardTypes')
-                    .show();
-                const metaDataContent = this.metaToAdoc(card, cardTypeForCard);
-                fileContent += metaDataContent;
-            }
-            if (card.content) {
-                fileContent += card.content;
-            }
-            if (card.attachments) {
-                const promiseContainer = [];
-                for (const attachment of card.attachments) {
-                    const destination = join(dirname(path), attachmentFolder, attachment.fileName);
-                    const source = join(attachment.path, attachment.fileName);
-                    promiseContainer.push(copyFile(source, destination));
+                if (card.metadata) {
+                    const cardTypeForCard = this.project.resources
+                        .byType(card.metadata?.cardType, 'cardTypes')
+                        .show();
+                    const metaDataContent = this.metaToAdoc(card, cardTypeForCard);
+                    fileContent += metaDataContent;
+                }
+                if (card.content) {
+                    fileContent += card.content;
+                }
+                if (card.attachments) {
+                    const promiseContainer = [];
+                    for (const attachment of card.attachments) {
+                        const destination = join(dirname(path), attachmentFolder, attachment.fileName);
+                        const source = join(attachment.path, attachment.fileName);
+                        promiseContainer.push(copyFile(source, destination));
+                    }
+                    await Promise.all(promiseContainer);
+                }
+                // Add separator between cards
+                fileContent += '\n\n';
+                if (fileContent) {
+                    await appendFile(path, fileContent);
+                }
+                if (card.children) {
+                    await this.toAdocFileAsContent(path, this.project.cardKeysToCards(card.children));
                 }
-                await Promise.all(promiseContainer);
-            }
-            // Add separator between cards
-            fileContent += '\n\n';
-            if (fileContent) {
-                await appendFile(path, fileContent);
             }
-            if (card.children) {
-                await this.toAdocFileAsContent(path, this.project.cardKeysToCards(card.children));
+        }
+        /**
+         * Recursively searches for a card with the specified key in the tree hierarchy.
+         * @param treeItems Array of tree query results to search through
+         * @param targetKey The key of the card to find
+         * @returns The found tree item or null if not found
+         */
+        findCardInTree(treeItems, targetKey) {
+            for (const item of treeItems) {
+                if (item.key === targetKey) {
+                    return item;
+                }
+                if (item.children && item.children.length > 0) {
+                    const foundInChildren = this.findCardInTree(item.children, targetKey);
+                    if (foundInChildren) {
+                        return foundInChildren;
+                    }
+                }
             }
+            return null;
         }
-    }
-    /**
-     * Recursively searches for a card with the specified key in the tree hierarchy.
-     * @param treeItems Array of tree query results to search through
-     * @param targetKey The key of the card to find
-     * @returns The found tree item or null if not found
-     */
-    findCardInTree(treeItems, targetKey) {
-        for (const item of treeItems) {
-            if (item.key === targetKey) {
-                return item;
+        /**
+         * Convert treeQueryResult object into a Card object and add content, metadata & attachments
+         * Handles card children recursively
+         * @param treeQueryResult tree query result object
+         * @returns Tree query result as a Card.
+         */
+        async treeQueryResultToCard(treeQueryResult) {
+            const card = {
+                key: treeQueryResult.key,
+                path: '',
+                children: [],
+                attachments: [],
+            };
+            const cardDetailsResponse = await this.showCmd.showCardDetails(card.key, 'adoc');
+            let asciiDocContent = '';
+            const project = this.project;
+            try {
+                const { evaluateMacros } = await import('../macros/index.js');
+                asciiDocContent = await evaluateMacros(cardDetailsResponse.content || '', {
+                    context: 'exportedDocument',
+                    mode: 'static',
+                    project,
+                    cardKey: card.key,
+                });
             }
-            if (item.children && item.children.length > 0) {
-                const foundInChildren = this.findCardInTree(item.children, targetKey);
-                if (foundInChildren) {
-                    return foundInChildren;
-                }
+            catch (error) {
+                asciiDocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${asciiDocContent}`;
             }
+            card.path = cardDetailsResponse.path;
+            card.metadata = cardDetailsResponse.metadata;
+            card.metadata.progress = treeQueryResult.progress;
+            card.content = asciiDocContent;
+            card.attachments = cardDetailsResponse.attachments;
+            for (const result of treeQueryResult.children ?? []) {
+                card.children.push((await this.treeQueryResultToCard(result)).key);
+            }
+            return card;
         }
-        return null;
-    }
-    /**
-     * Convert treeQueryResult object into a Card object and add content, metadata & attachments
-     * Handles card children recursively
-     * @param treeQueryResult tree query result object
-     * @returns Tree query result as a Card.
-     */
-    async treeQueryResultToCard(treeQueryResult) {
-        const card = {
-            key: treeQueryResult.key,
-            path: '',
-            children: [],
-            attachments: [],
-        };
-        const cardDetailsResponse = this.showCmd.showCardDetails(card.key, 'adoc');
-        let asciiDocContent = '';
-        const project = this.project;
-        try {
-            const { evaluateMacros } = await import('../macros/index.js');
-            asciiDocContent = await evaluateMacros(cardDetailsResponse.content || '', {
+        /**
+         * Exports the card(s) to pdf.
+         * @param destination Path to where the resulting file(s) will be created.
+         * @param options Export options.
+         * @returns status message
+         */
+        async exportPdf(destination, options) {
+            const opts = {
+                ...options,
+                date: options.date?.toISOString().split('T')[0],
+                recursive: options.recursive ?? false,
+            };
+            await this.project.calculationEngine.generate();
+            const result = await generateReportContent({
+                calculate: this.project.calculationEngine,
+                contentTemplate: pdfReport.content,
+                queryTemplate: pdfReport.query,
+                context: 'exportedDocument',
+                options: opts,
+            });
+            const evaluated = await evaluateMacros(result, {
                 context: 'exportedDocument',
                 mode: 'static',
-                project,
-                cardKey: card.key,
+                project: this.project,
+                cardKey: '', // top level report does not contain any macros that use cardKey
             });
+            const pdf = await this.runAsciidoctorPdf(evaluated);
+            await writeFile(destination, pdf);
+            return `Content exported as PDF to ${destination}`;
         }
-        catch (error) {
-            asciiDocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${asciiDocContent}`;
-        }
-        card.path = cardDetailsResponse.path;
-        card.metadata = cardDetailsResponse.metadata;
-        card.metadata.progress = treeQueryResult.progress;
-        card.content = asciiDocContent;
-        card.attachments = cardDetailsResponse.attachments;
-        for (const result of treeQueryResult.children ?? []) {
-            card.children.push((await this.treeQueryResultToCard(result)).key);
-        }
-        return card;
-    }
-    /**
-     * Exports the card(s) to pdf.
-     * @param destination Path to where the resulting file(s) will be created.
-     * @param options Export options.
-     * @returns status message
-     */
-    async exportPdf(destination, options) {
-        const opts = {
-            ...options,
-            date: options.date?.toISOString().split('T')[0],
-            recursive: options.recursive ?? false,
-        };
-        await this.project.calculationEngine.generate();
-        const result = await generateReportContent({
-            calculate: this.project.calculationEngine,
-            contentTemplate: pdfReport.content,
-            queryTemplate: pdfReport.query,
-            context: 'exportedDocument',
-            options: opts,
-        });
-        const evaluated = await evaluateMacros(result, {
-            context: 'exportedDocument',
-            mode: 'static',
-            project: this.project,
-            cardKey: '', // top level report does not contain any macros that use cardKey
-        });
-        const pdf = await this.runAsciidoctorPdf(evaluated);
-        await writeFile(destination, pdf);
-        return `Content exported as PDF to ${destination}`;
-    }
-    /**
-     * Exports the card(s) to ascii doc.
-     * @param destination Path to where the resulting file(s) will be created.
-     * @param cardKey If not exporting the whole card tree, card key of parent card.
-     * @returns status message
-     */
-    async exportToADoc(destination, cardKey) {
-        const sourcePath = this.project.paths.cardRootFolder;
-        let cards = [];
-        // If doing a partial tree export, put the parent information as it would have already been gathered.
-        if (cardKey && this.project.findCard(cardKey)) {
-            cards.push({
-                key: cardKey,
-                path: sourcePath,
-                children: [],
-                attachments: [],
+        /**
+         * Exports the card(s) to ascii doc.
+         * @param destination Path to where the resulting file(s) will be created.
+         * @param cardKey If not exporting the whole card tree, card key of parent card.
+         * @returns status message
+         */
+        async exportToADoc(destination, cardKey) {
+            const sourcePath = this.project.paths.cardRootFolder;
+            let cards = [];
+            // If doing a partial tree export, put the parent information as it would have already been gathered.
+            if (cardKey && this.project.findCard(cardKey)) {
+                cards.push({
+                    key: cardKey,
+                    path: sourcePath,
+                    children: [],
+                    attachments: [],
+                });
+            }
+            await this.project.calculationEngine.generate();
+            const tree = await this.project.calculationEngine.runQuery('tree', 'exportedDocument');
+            if (cardKey) {
+                const targetCard = this.findCardInTree(tree, cardKey);
+                if (!targetCard) {
+                    throw new Error(`Cannot find card '${cardKey}' in the tree hierarchy`);
+                }
+                cards = [await this.treeQueryResultToCard(targetCard)];
+            }
+            else {
+                for (const treeQueryResult of tree) {
+                    cards.push(await this.treeQueryResultToCard(treeQueryResult));
+                }
+            }
+            // Sort the cards by rank
+            cards = sortItems(cards, function (card) {
+                return card.metadata?.rank || '1|z';
             });
-        }
-        await this.project.calculationEngine.generate();
-        const tree = await this.project.calculationEngine.runQuery('tree', 'exportedDocument');
-        if (cardKey) {
-            const targetCard = this.findCardInTree(tree, cardKey);
-            if (!targetCard) {
-                throw new Error(`Cannot find card '${cardKey}' in the tree hierarchy`);
+            await mkdir(join(destination, attachmentFolder), { recursive: true });
+            const resultDocumentPath = join(destination, Project.cardContentFile);
+            let message;
+            try {
+                await truncate(resultDocumentPath, 0);
+                message = `Using existing output file '${resultDocumentPath}'`;
             }
-            cards = [await this.treeQueryResultToCard(targetCard)];
-        }
-        else {
-            for (const treeQueryResult of tree) {
-                cards.push(await this.treeQueryResultToCard(treeQueryResult));
+            catch {
+                message = `Creating output file '${resultDocumentPath}'`;
             }
+            await this.toAdocFile(resultDocumentPath, cards);
+            return message;
         }
-        // Sort the cards by rank
-        cards = sortItems(cards, function (card) {
-            return card.metadata?.rank || '1|z';
-        });
-        await mkdir(join(destination, attachmentFolder), { recursive: true });
-        const resultDocumentPath = join(destination, Project.cardContentFile);
-        let message = '';
-        try {
-            await truncate(resultDocumentPath, 0);
-            message = `Using existing output file '${resultDocumentPath}'`;
-        }
-        catch {
-            message = `Creating output file '${resultDocumentPath}'`;
-        }
-        await this.toAdocFile(resultDocumentPath, cards);
-        return message;
-    }
-}
+    };
+})();
+export { Export };
 //# sourceMappingURL=export.js.map