@cyberismo/data-handler 0.0.6 → 0.0.7

package/dist/commands/export-site.js

@@ -1,301 +0,0 @@
-/**
-  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 fs from 'node:fs';
-import { platform, tmpdir } from 'node:os';
-import { appendFile, copyFile, mkdir, writeFile } from 'node:fs/promises';
-import { mkdtempSync, writeFileSync } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { spawnSync } from 'node:child_process';
-import { fileURLToPath } from 'node:url';
-import git from 'isomorphic-git';
-import { dump } from 'js-yaml';
-import { Export } from './export.js';
-import { errorFunction } from '../utils/log-utils.js';
-import { sortItems } from '../utils/lexorank.js';
-import { getStaticDirectoryPath } from '@cyberismo/resources';
-export class ExportSite extends Export {
-    tmpDir = '';
-    moduleDir = '';
-    pagesDir = '';
-    imagesDir = '';
-    playbookDir = '';
-    playbookFile = '';
-    navFile = '';
-    options;
-    constructor(project, calculateCmd, showCmd) {
-        super(project, calculateCmd, showCmd);
-    }
-    // Writes index.html file into cards folder that just redirects to the first card.
-    createCardsIndex(destination, cardKey) {
-        const indexFile = join(destination, 'cards', 'index.html');
-        const indexContent = `<meta http-equiv="refresh" content="0; url=${cardKey}.html">`;
-        try {
-            fs.writeFileSync(indexFile, indexContent);
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-    }
-    // todo: change this so that split temp folder creation to its own method.
-    // then parallelize this and export() as much as you can.
-    async initDirectories() {
-        // Create temporary adoc output directory
-        try {
-            this.tmpDir = mkdtempSync(join(tmpdir(), 'cards-'));
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-        // Antora requires the content directory to be a Git repository
-        await this.initRepo();
-        // Create the pages and images directories
-        this.moduleDir = join(this.tmpDir, 'modules', 'ROOT');
-        this.pagesDir = join(this.moduleDir, 'pages');
-        this.imagesDir = join(this.moduleDir, 'assets', 'images');
-        this.navFile = join(this.moduleDir, 'nav.adoc');
-        const promiseContainer = [];
-        promiseContainer.push(mkdir(this.pagesDir, { recursive: true }));
-        promiseContainer.push(mkdir(this.imagesDir, { recursive: true }));
-        await Promise.all(promiseContainer);
-        // Create the playbook directory
-        this.playbookDir = mkdtempSync(join(tmpdir(), 'cards-playbook-'));
-    }
-    // Generate the site from the source files using Antora.
-    generate(outputPath) {
-        const __filename = fileURLToPath(import.meta.url);
-        const __dirname = dirname(__filename);
-        const absoluteOutputPath = resolve(process.cwd(), outputPath);
-        const additionalArguments = [
-            '--to-dir',
-            absoluteOutputPath,
-            this.playbookFile,
-        ];
-        if (this.options && this.options?.silent) {
-            additionalArguments.unshift('--silent');
-        }
-        // Use spawnsync to npx execute the program "antora"
-        try {
-            // Allthough we use pnpm as the package manager, we rather use npx at runtime, because it is shipped with node
-            spawnSync('npx', ['antora', ...additionalArguments], {
-                stdio: 'inherit',
-                shell: platform() === 'win32',
-                cwd: __dirname,
-            });
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-    }
-    // Create the Antora playbook.
-    async createPlaybook(cards) {
-        let startPage = '';
-        if (cards[0]) {
-            startPage = cards[0].key + '.adoc';
-        }
-        else {
-            throw new Error('Cannot create a playbook for an empty card set');
-        }
-        const playbook = {
-            site: {
-                title: this.project.configuration.name,
-                start_page: `cards:ROOT:${startPage}`,
-            },
-            content: {
-                sources: [
-                    {
-                        url: this.tmpDir,
-                        branches: 'HEAD',
-                    },
-                ],
-            },
-            urls: {
-                html_extension_style: 'default',
-            },
-            ui: {
-                bundle: {
-                    url: join(await getStaticDirectoryPath(), 'ui-bundle'),
-                    snapshot: true,
-                },
-            },
-        };
-        this.playbookFile = join(this.playbookDir, 'antora-playbook.yml');
-        writeFileSync(this.playbookFile, dump(playbook));
-    }
-    // Create the Antora site descriptor.
-    createDescriptor() {
-        const projectName = this.project.configuration.name;
-        const descriptor = {
-            name: 'cards',
-            title: projectName,
-            version: null,
-            nav: ['modules/ROOT/nav.adoc'],
-        };
-        const descriptorPath = join(this.tmpDir, 'antora.yml');
-        try {
-            writeFileSync(descriptorPath, dump(descriptor));
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-    }
-    // Initialise the temporary directory as a temporary Git repository.
-    async initRepo() {
-        try {
-            await git.init({ fs, dir: this.tmpDir });
-            writeFileSync(join(this.tmpDir, '.gitkeep'), '');
-            await git.add({ fs, dir: this.tmpDir, filepath: '.gitkeep' });
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-        try {
-            await git.commit({
-                fs,
-                dir: this.tmpDir,
-                author: {
-                    name: 'Cyberismo Cards',
-                    email: 'info@cyberismo.com',
-                },
-                message: 'Add .gitkeep',
-            });
-        }
-        catch (error) {
-            throw new Error(errorFunction(error));
-        }
-    }
-    // Write cards as Antora-compatible AsciiDoc to the given location
-    // @param path Directory where the cards should be written
-    // @param cards Array of Cards
-    // @param depth Navigation depth - this is used in recursion to format the hierarchical menu
-    async toAdocDirectoryAsContent(path, cards, depth) {
-        depth++;
-        // Sort the cards by rank
-        cards = sortItems(cards, function (card) {
-            return card.metadata?.rank || '1|z';
-        });
-        // Ensure the target path exists
-        await mkdir(path, { recursive: true });
-        for (const card of cards) {
-            // Construct path for individual card file
-            const cardPath = join(path, card.key + '.adoc');
-            const cardXRef = cardPath.slice(this.pagesDir.length);
-            let navFileContent = '';
-            if (card.metadata?.progress) {
-                navFileContent =
-                    '*'.repeat(depth) +
-                        ` xref:${cardXRef}[${card.metadata?.title} (${card.metadata?.progress}%)]\n`;
-            }
-            else {
-                navFileContent =
-                    '*'.repeat(depth) + ` xref:${cardXRef}[${card.metadata?.title}]\n`;
-            }
-            await appendFile(this.navFile, navFileContent);
-            let tempContent = '';
-            if (card.metadata) {
-                const cardTypeForCard = await this.project.resource(card.metadata?.cardType);
-                tempContent = '\n= ';
-                tempContent += card.metadata?.title
-                    ? `${card.metadata.title}\n\n`
-                    : 'Untitled\n\n';
-                tempContent += super.metaToAdoc(card, cardTypeForCard);
-            }
-            if (card.content) {
-                tempContent += '\n' + card.content;
-            }
-            if (tempContent !== '') {
-                await writeFile(cardPath, tempContent);
-            }
-            if (card.children && card.children.length > 0) {
-                // Recurse into the child cards
-                await this.toAdocDirectoryAsContent(path, card.children, depth);
-            }
-            if (card.attachments) {
-                const promiseContainer = [];
-                for (const attachment of card.attachments) {
-                    const source = join(attachment.path, attachment.fileName);
-                    const destination = join(this.imagesDir, `${attachment.fileName}`);
-                    promiseContainer.push(copyFile(source, destination));
-                }
-                await Promise.all(promiseContainer);
-            }
-        }
-        --depth;
-    }
-    // Export the cards to the temporary directory as a full HTML site generated by Antora.
-    async export(destination, cards) {
-        await this.initDirectories();
-        this.createDescriptor();
-        await this.toAdocDirectoryAsContent(this.pagesDir, cards, 0);
-        await this.createPlaybook(cards);
-        this.generate(destination);
-    }
-    /**
-     * Export the card tree as an Antora site
-     * @param destination Path where the site is generated
-     * @param cardKey Optional; If defined exports the card tree from underneath this card.
-     */
-    async exportToSite(destination, cardKey, options) {
-        this.options = options;
-        const sourcePath = cardKey
-            ? join(this.project.paths.cardRootFolder, this.project.pathToCard(cardKey))
-            : 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) {
-            const card = await this.project.findSpecificCard(cardKey);
-            if (!card) {
-                throw new Error(`Input validation error: cannot find card '${cardKey}'`);
-            }
-            cards.push({
-                key: cardKey,
-                path: sourcePath,
-                children: [],
-                attachments: [],
-            });
-        }
-        await this.calculateCmd.generate();
-        const tree = await this.calculateCmd.runQuery('tree');
-        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));
-            }
-        }
-        if (!cards.length) {
-            throw new Error('No cards found');
-        }
-        if (cards.length > 3000) {
-            throw new Error(`There are ${cards.length} cards in the project. Exporting to a site only supports maximum of 3000 cards.`);
-        }
-        if (cards.length > 1000 && cards.length < 3000) {
-            console.warn(`Warning: There are ${cards.length} cards in the project. There is a hard limit of 3000 cards that can be exported as a site.`);
-        }
-        await this.export(destination, cards);
-        if (cards.length > 0 && cards.at(0)) {
-            const firstCard = cards.at(0);
-            if (firstCard && firstCard.key) {
-                this.createCardsIndex(destination, firstCard.key);
-            }
-        }
-        return '';
-    }
-}
-//# sourceMappingURL=export-site.js.map

package/dist/commands/export-site.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"export-site.js","sourceRoot":"","sources":["../../src/commands/export-site.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO;AACP,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,GAAG,MAAM,gBAAgB,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAG/B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAM9D,MAAM,OAAO,UAAW,SAAQ,MAAM;IAC5B,MAAM,GAAW,EAAE,CAAC;IACpB,SAAS,GAAW,EAAE,CAAC;IACvB,QAAQ,GAAW,EAAE,CAAC;IACtB,SAAS,GAAW,EAAE,CAAC;IACvB,WAAW,GAAW,EAAE,CAAC;IACzB,YAAY,GAAW,EAAE,CAAC;IAC1B,OAAO,GAAW,EAAE,CAAC;IACrB,OAAO,CAA4B;IAE3C,YAAY,OAAgB,EAAE,YAAuB,EAAE,OAAa;QAClE,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAED,kFAAkF;IAC1E,gBAAgB,CAAC,WAAmB,EAAE,OAAe;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC;QAC3D,MAAM,YAAY,GAAG,8CAA8C,OAAO,SAAS,CAAC;QACpF,IAAI,CAAC;YACH,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,yDAAyD;IACjD,KAAK,CAAC,eAAe;QAC3B,yCAAyC;QACzC,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;QAED,+DAA+D;QAC/D,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAEtB,0CAA0C;QAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAEhD,MAAM,gBAAgB,GAAkC,EAAE,CAAC;QAC3D,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACjE,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAClE,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEpC,gCAAgC;QAChC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,wDAAwD;IAChD,QAAQ,CAAC,UAAkB;QACjC,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;QAEtC,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QAE9D,MAAM,mBAAmB,GAAG;YAC1B,UAAU;YACV,kBAAkB;YAClB,IAAI,CAAC,YAAY;SAClB,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACzC,mBAAmB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC;QACD,oDAAoD;QACpD,IAAI,CAAC;YACH,8GAA8G;YAC9G,SAAS,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,GAAG,mBAAmB,CAAC,EAAE;gBACnD,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE,QAAQ,EAAE,KAAK,OAAO;gBAC7B,GAAG,EAAE,SAAS;aACf,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,8BAA8B;IACtB,KAAK,CAAC,cAAc,CAAC,KAAa;QACxC,IAAI,SAAS,GAAW,EAAE,CAAC;QAE3B,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACb,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,QAAQ,GAAG;YACf,IAAI,EAAE;gBACJ,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI;gBACtC,UAAU,EAAE,cAAc,SAAS,EAAE;aACtC;YACD,OAAO,EAAE;gBACP,OAAO,EAAE;oBACP;wBACE,GAAG,EAAE,IAAI,CAAC,MAAM;wBAChB,QAAQ,EAAE,MAAM;qBACjB;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,oBAAoB,EAAE,SAAS;aAChC;YACD,EAAE,EAAE;gBACF,MAAM,EAAE;oBACN,GAAG,EAAE,IAAI,CAAC,MAAM,sBAAsB,EAAE,EAAE,WAAW,CAAC;oBACtD,QAAQ,EAAE,IAAI;iBACf;aACF;SACF,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CAAC;QAClE,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,qCAAqC;IAC7B,gBAAgB;QACtB,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC;QACpD,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,CAAC,uBAAuB,CAAC;SAC/B,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,aAAa,CAAC,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,oEAAoE;IAC5D,KAAK,CAAC,QAAQ;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YACzC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;YACjD,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,GAAG,CAAC,MAAM,CAAC;gBACf,EAAE;gBACF,GAAG,EAAE,IAAI,CAAC,MAAM;gBAChB,MAAM,EAAE;oBACN,IAAI,EAAE,iBAAiB;oBACvB,KAAK,EAAE,oBAAoB;iBAC5B;gBACD,OAAO,EAAE,cAAc;aACxB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED,kEAAkE;IAClE,0DAA0D;IAC1D,8BAA8B;IAC9B,4FAA4F;IACpF,KAAK,CAAC,wBAAwB,CACpC,IAAY,EACZ,KAAa,EACb,KAAa;QAEb,KAAK,EAAE,CAAC;QAER,yBAAyB;QACzB,KAAK,GAAG,SAAS,CAAC,KAAK,EAAE,UAAU,IAAI;YACrC,OAAO,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,KAAK,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,gCAAgC;QAChC,MAAM,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,0CAA0C;YAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC;YAChD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,cAAc,GAAG,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC;gBAC5B,cAAc;oBACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;wBACjB,SAAS,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,KAAK,IAAI,CAAC,QAAQ,EAAE,QAAQ,OAAO,CAAC;YACjF,CAAC;iBAAM,CAAC;gBACN,cAAc;oBACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,KAAK,CAAC;YACvE,CAAC;YAED,MAAM,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAE/C,IAAI,WAAW,GAAW,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CACjD,IAAI,CAAC,QAAQ,EAAE,QAAQ,CACxB,CAAC;gBACF,WAAW,GAAG,MAAM,CAAC;gBACrB,WAAW,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK;oBACjC,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,MAAM;oBAC9B,CAAC,CAAC,cAAc,CAAC;gBACnB,WAAW,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;YACzD,CAAC;YAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACjB,WAAW,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;YACrC,CAAC;YACD,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;gBACvB,MAAM,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACzC,CAAC;YAED,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9C,+BAA+B;gBAC/B,MAAM,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAClE,CAAC;YAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,gBAAgB,GAAG,EAAE,CAAC;gBAC5B,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;oBAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACnE,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;gBACvD,CAAC;gBACD,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,EAAE,KAAK,CAAC;IACV,CAAC;IAED,uFAAuF;IAC/E,KAAK,CAAC,MAAM,CAAC,WAAmB,EAAE,KAAa;QACrD,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC7B,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC7D,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CACvB,WAAmB,EACnB,OAAgB,EAChB,OAAuB;QAEvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,MAAM,UAAU,GAAW,OAAO;YAChC,CAAC,CAAC,IAAI,CACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,EACjC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CACjC;YACH,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC;QACtC,IAAI,KAAK,GAAW,EAAE,CAAC;QAEvB,qGAAqG;QACrG,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC1D,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CACb,6CAA6C,OAAO,GAAG,CACxD,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,IAAI,CAAC;gBACT,GAAG,EAAE,OAAO;gBACZ,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,EAAE;gBACZ,WAAW,EAAE,EAAE;aAChB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAEtD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YACtD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,qBAAqB,OAAO,yBAAyB,CAAC,CAAC;YACzE,CAAC;YACD,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,eAAe,IAAI,IAAI,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,aAAa,KAAK,CAAC,MAAM,iFAAiF,CAC3G,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YAC/C,OAAO,CAAC,IAAI,CACV,sBAAsB,KAAK,CAAC,MAAM,4FAA4F,CAC/H,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF"}

package/src/commands/export-site.ts

@@ -1,356 +0,0 @@
-/**
-  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 fs from 'node:fs';
-import { platform, tmpdir } from 'node:os';
-import { appendFile, copyFile, mkdir, writeFile } from 'node:fs/promises';
-import { mkdtempSync, writeFileSync } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { spawnSync } from 'node:child_process';
-import { fileURLToPath } from 'node:url';
-
-import git from 'isomorphic-git';
-import { dump } from 'js-yaml';
-
-import { type Calculate, type Show } from './index.js';
-import { Export } from './export.js';
-import type { Card } from '../interfaces/project-interfaces.js';
-import type { CardType } from '../interfaces/resource-interfaces.js';
-import { errorFunction } from '../utils/log-utils.js';
-import type { Project } from '../containers/project.js';
-import { sortItems } from '../utils/lexorank.js';
-import { getStaticDirectoryPath } from '@cyberismo/resources';
-
-interface ExportOptions {
-  silent: boolean;
-}
-
-export class ExportSite extends Export {
-  private tmpDir: string = '';
-  private moduleDir: string = '';
-  private pagesDir: string = '';
-  private imagesDir: string = '';
-  private playbookDir: string = '';
-  private playbookFile: string = '';
-  private navFile: string = '';
-  private options: ExportOptions | undefined;
-
-  constructor(project: Project, calculateCmd: Calculate, showCmd: Show) {
-    super(project, calculateCmd, showCmd);
-  }
-
-  // Writes index.html file into cards folder that just redirects to the first card.
-  private createCardsIndex(destination: string, cardKey: string) {
-    const indexFile = join(destination, 'cards', 'index.html');
-    const indexContent = `<meta http-equiv="refresh" content="0; url=${cardKey}.html">`;
-    try {
-      fs.writeFileSync(indexFile, indexContent);
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-  }
-
-  // todo: change this so that split temp folder creation to its own method.
-  // then parallelize this and export() as much as you can.
-  private async initDirectories() {
-    // Create temporary adoc output directory
-    try {
-      this.tmpDir = mkdtempSync(join(tmpdir(), 'cards-'));
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-
-    // Antora requires the content directory to be a Git repository
-    await this.initRepo();
-
-    // Create the pages and images directories
-    this.moduleDir = join(this.tmpDir, 'modules', 'ROOT');
-    this.pagesDir = join(this.moduleDir, 'pages');
-    this.imagesDir = join(this.moduleDir, 'assets', 'images');
-    this.navFile = join(this.moduleDir, 'nav.adoc');
-
-    const promiseContainer: Promise<string | undefined>[] = [];
-    promiseContainer.push(mkdir(this.pagesDir, { recursive: true }));
-    promiseContainer.push(mkdir(this.imagesDir, { recursive: true }));
-    await Promise.all(promiseContainer);
-
-    // Create the playbook directory
-    this.playbookDir = mkdtempSync(join(tmpdir(), 'cards-playbook-'));
-  }
-
-  // Generate the site from the source files using Antora.
-  private generate(outputPath: string) {
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = dirname(__filename);
-
-    const absoluteOutputPath = resolve(process.cwd(), outputPath);
-
-    const additionalArguments = [
-      '--to-dir',
-      absoluteOutputPath,
-      this.playbookFile,
-    ];
-    if (this.options && this.options?.silent) {
-      additionalArguments.unshift('--silent');
-    }
-    // Use spawnsync to npx execute the program "antora"
-    try {
-      // Allthough we use pnpm as the package manager, we rather use npx at runtime, because it is shipped with node
-      spawnSync('npx', ['antora', ...additionalArguments], {
-        stdio: 'inherit',
-        shell: platform() === 'win32',
-        cwd: __dirname,
-      });
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-  }
-
-  // Create the Antora playbook.
-  private async createPlaybook(cards: Card[]) {
-    let startPage: string = '';
-
-    if (cards[0]) {
-      startPage = cards[0].key + '.adoc';
-    } else {
-      throw new Error('Cannot create a playbook for an empty card set');
-    }
-
-    const playbook = {
-      site: {
-        title: this.project.configuration.name,
-        start_page: `cards:ROOT:${startPage}`,
-      },
-      content: {
-        sources: [
-          {
-            url: this.tmpDir,
-            branches: 'HEAD',
-          },
-        ],
-      },
-      urls: {
-        html_extension_style: 'default',
-      },
-      ui: {
-        bundle: {
-          url: join(await getStaticDirectoryPath(), 'ui-bundle'),
-          snapshot: true,
-        },
-      },
-    };
-
-    this.playbookFile = join(this.playbookDir, 'antora-playbook.yml');
-    writeFileSync(this.playbookFile, dump(playbook));
-  }
-
-  // Create the Antora site descriptor.
-  private createDescriptor() {
-    const projectName = this.project.configuration.name;
-    const descriptor = {
-      name: 'cards',
-      title: projectName,
-      version: null,
-      nav: ['modules/ROOT/nav.adoc'],
-    };
-
-    const descriptorPath = join(this.tmpDir, 'antora.yml');
-    try {
-      writeFileSync(descriptorPath, dump(descriptor));
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-  }
-
-  // Initialise the temporary directory as a temporary Git repository.
-  private async initRepo() {
-    try {
-      await git.init({ fs, dir: this.tmpDir });
-      writeFileSync(join(this.tmpDir, '.gitkeep'), '');
-      await git.add({ fs, dir: this.tmpDir, filepath: '.gitkeep' });
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-
-    try {
-      await git.commit({
-        fs,
-        dir: this.tmpDir,
-        author: {
-          name: 'Cyberismo Cards',
-          email: 'info@cyberismo.com',
-        },
-        message: 'Add .gitkeep',
-      });
-    } catch (error) {
-      throw new Error(errorFunction(error));
-    }
-  }
-
-  // Write cards as Antora-compatible AsciiDoc to the given location
-  // @param path Directory where the cards should be written
-  // @param cards Array of Cards
-  // @param depth Navigation depth - this is used in recursion to format the hierarchical menu
-  private async toAdocDirectoryAsContent(
-    path: string,
-    cards: Card[],
-    depth: number,
-  ) {
-    depth++;
-
-    // Sort the cards by rank
-    cards = sortItems(cards, function (card) {
-      return card.metadata?.rank || '1|z';
-    });
-
-    // Ensure the target path exists
-    await mkdir(path, { recursive: true });
-    for (const card of cards) {
-      // Construct path for individual card file
-      const cardPath = join(path, card.key + '.adoc');
-      const cardXRef = cardPath.slice(this.pagesDir.length);
-      let navFileContent = '';
-      if (card.metadata?.progress) {
-        navFileContent =
-          '*'.repeat(depth) +
-          ` xref:${cardXRef}[${card.metadata?.title} (${card.metadata?.progress}%)]\n`;
-      } else {
-        navFileContent =
-          '*'.repeat(depth) + ` xref:${cardXRef}[${card.metadata?.title}]\n`;
-      }
-
-      await appendFile(this.navFile, navFileContent);
-
-      let tempContent: string = '';
-      if (card.metadata) {
-        const cardTypeForCard = await this.project.resource<CardType>(
-          card.metadata?.cardType,
-        );
-        tempContent = '\n= ';
-        tempContent += card.metadata?.title
-          ? `${card.metadata.title}\n\n`
-          : 'Untitled\n\n';
-        tempContent += super.metaToAdoc(card, cardTypeForCard);
-      }
-
-      if (card.content) {
-        tempContent += '\n' + card.content;
-      }
-      if (tempContent !== '') {
-        await writeFile(cardPath, tempContent);
-      }
-
-      if (card.children && card.children.length > 0) {
-        // Recurse into the child cards
-        await this.toAdocDirectoryAsContent(path, card.children, depth);
-      }
-
-      if (card.attachments) {
-        const promiseContainer = [];
-        for (const attachment of card.attachments) {
-          const source = join(attachment.path, attachment.fileName);
-          const destination = join(this.imagesDir, `${attachment.fileName}`);
-          promiseContainer.push(copyFile(source, destination));
-        }
-        await Promise.all(promiseContainer);
-      }
-    }
-
-    --depth;
-  }
-
-  // Export the cards to the temporary directory as a full HTML site generated by Antora.
-  private async export(destination: string, cards: Card[]) {
-    await this.initDirectories();
-    this.createDescriptor();
-    await this.toAdocDirectoryAsContent(this.pagesDir, cards, 0);
-    await this.createPlaybook(cards);
-    this.generate(destination);
-  }
-
-  /**
-   * Export the card tree as an Antora site
-   * @param destination Path where the site is generated
-   * @param cardKey Optional; If defined exports the card tree from underneath this card.
-   */
-  public async exportToSite(
-    destination: string,
-    cardKey?: string,
-    options?: ExportOptions,
-  ): Promise<string> {
-    this.options = options;
-    const sourcePath: string = cardKey
-      ? join(
-          this.project.paths.cardRootFolder,
-          this.project.pathToCard(cardKey),
-        )
-      : this.project.paths.cardRootFolder;
-    let cards: Card[] = [];
-
-    // If doing a partial tree export, put the parent information as it would have already been gathered.
-    if (cardKey) {
-      const card = await this.project.findSpecificCard(cardKey);
-      if (!card) {
-        throw new Error(
-          `Input validation error: cannot find card '${cardKey}'`,
-        );
-      }
-      cards.push({
-        key: cardKey,
-        path: sourcePath,
-        children: [],
-        attachments: [],
-      });
-    }
-
-    await this.calculateCmd.generate();
-    const tree = await this.calculateCmd.runQuery('tree');
-
-    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));
-      }
-    }
-
-    if (!cards.length) {
-      throw new Error('No cards found');
-    }
-    if (cards.length > 3000) {
-      throw new Error(
-        `There are ${cards.length} cards in the project. Exporting to a site only supports maximum of 3000 cards.`,
-      );
-    }
-    if (cards.length > 1000 && cards.length < 3000) {
-      console.warn(
-        `Warning: There are ${cards.length} cards in the project. There is a hard limit of 3000 cards that can be exported as a site.`,
-      );
-    }
-
-    await this.export(destination, cards);
-    if (cards.length > 0 && cards.at(0)) {
-      const firstCard = cards.at(0);
-      if (firstCard && firstCard.key) {
-        this.createCardsIndex(destination, firstCard.key);
-      }
-    }
-    return '';
-  }
-}