@cyberismo/data-handler 0.0.2

package/dist/macros/base-macro.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-macro.js","sourceRoot":"","sources":["../../src/macros/base-macro.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAQF,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAG9C,MAAe,SAAS;IAKV;IACO;IALX,QAAQ,CAAS;IACjB,YAAY,GAAW,CAAC,CAAC;IAEjC,YACY,aAA4B,EACrB,KAAgB;QADvB,kBAAa,GAAb,aAAa,CAAe;QACrB,UAAK,GAAL,KAAK,CAAW;QAEjC,wDAAwD;QACxD,IAAI,CAAC,QAAQ,GAAG,GAAG,oBAAoB,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC;IACpD,CAAC;IAcD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEO,gBAAgB,CAAC,KAAa;QACpC,uEAAuE;QACvE,MAAM,iBAAiB,GAAG,wCAAwC,CAAC;QAEnE,MAAM,YAAY,GAAqB,EAAE,CAAC;QAE1C,IAAI,KAAK,CAAC;QACV,OAAO,CAAC,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YACxD,MAAM,CAAC,WAAW,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC;YAE/C,8DAA8D;YAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;YAE9D,IAAI,IAAI,EAAE,CAAC;gBACT,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CACV,yCAAyC,WAAW,eAAe,QAAQ,cAAc,OAAO,GAAG,CACpG,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,mBAAmB;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACpC,OAAO;YACL,OAAO;YACP,WAAW,EAAE,YAAY,IAAI,CAAC,QAAQ,KAAK,OAAO,IAAI;SACvD,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,WAAW,GAAG,CACnB,OAA+B,EAC/B,OAA0B,EAC1B,EAAE;QACF,8CAA8C;QAC9C,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE5D,MAAM,QAAQ,GAAG,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,KAAK,GAAG,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC;QAEjC,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;YACzC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;oBAC3B,MAAM,YAAY,GAAG,cAAc,OAAO,CAAC,OAAO,kCAAkC,KAAK,CAAC,OAAO,wBAAwB,KAAK,EAAE,CAAC;oBACjI,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;gBAChC,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO;QACT,CAAC;QAED,uBAAuB;QACvB,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QAErD,sFAAsF;QACtF,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aAChE,IAAI,CAAC,GAAG,EAAE;YACT,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE,CAAC;gBACtC,KAAK,GAAG,KAAK,CAAC,OAAO,CACnB,UAAU,CAAC,WAAW,EACtB,UAAU,CAAC,aAAa,IAAI,EAAE,CAC/B,CAAC;YACJ,CAAC;YACD,IAAI,MAAM,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,cAAc,CAAC;YACxB,CAAC;YAED,uDAAuD;YACvD,MAAM,cAAc,GAClB,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;YAEpE,6CAA6C;YAC7C,OAAO,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACzC,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CACX,yCAAyC,IAAI,CAAC,QAAQ,CAAC,IAAI,cAAc,OAAO,GAAG,CACpF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACrD,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,aAAa,GAAG,gBAAgB,CACnC,GAAG,EACH,IAAI,CAAC,QAAQ,CAAC,IAAI,EAClB,OAAO,CACR,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,KAAK,CACX,iCAAiC,IAAI,CAAC,QAAQ,CAAC,IAAI,cAAc,OAAO,GAAG,EAC3E,GAAG,CACJ,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;QAEL,iBAAiB;QACjB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YACd,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO;YACP,OAAO;YACP,WAAW;YACX,aAAa,EAAE,IAAI;YACnB,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI;SAC/B,CAAC,CAAC;QACH,yBAAyB;QACzB,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC;CACH;AAED,eAAe,SAAS,CAAC"}

package/dist/macros/common.d.ts

@@ -0,0 +1,17 @@
+/**
+    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/>.
+*/
+export declare const macroMetadata: {
+    createCards: import("../interfaces/macros.js").MacroMetadata;
+    graph: import("../interfaces/macros.js").MacroMetadata;
+    report: import("../interfaces/macros.js").MacroMetadata;
+    scoreCard: import("../interfaces/macros.js").MacroMetadata;
+};

package/dist/macros/common.js

@@ -0,0 +1,23 @@
+/**
+    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/>.
+*/
+// important that this file imports only the metadata
+import createCards from './createCards/metadata.js';
+import graph from './graph/metadata.js';
+import report from './report/metadata.js';
+import scoreCard from './scoreCard/metadata.js';
+export const macroMetadata = {
+    createCards,
+    graph,
+    report,
+    scoreCard,
+};
+//# sourceMappingURL=common.js.map

package/dist/macros/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/macros/common.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,qDAAqD;AACrD,OAAO,WAAW,MAAM,2BAA2B,CAAC;AACpD,OAAO,KAAK,MAAM,qBAAqB,CAAC;AACxC,OAAO,MAAM,MAAM,sBAAsB,CAAC;AAC1C,OAAO,SAAS,MAAM,yBAAyB,CAAC;AAEhD,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,WAAW;IACX,KAAK;IACL,MAAM;IACN,SAAS;CACV,CAAC"}

package/dist/macros/createCards/index.d.ts

@@ -0,0 +1,36 @@
+/**
+    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 { MacroOptions } from '../index.js';
+import type { MacroGenerationContext } from '../../interfaces/macros.js';
+import BaseMacro from '../base-macro.js';
+import type TaskQueue from '../task-queue.js';
+export interface CreateCardsOptions extends MacroOptions {
+    buttonLabel: string;
+    template: string;
+    cardKey?: string;
+    link?: {
+        linkType: string;
+        direction: string;
+        cardKey: string;
+    };
+    [key: string]: string | undefined | {
+        [key: string]: string | undefined;
+    };
+}
+declare class CreateCardsMacro extends BaseMacro {
+    constructor(tasksQueue: TaskQueue);
+    handleValidate: (input: unknown) => void;
+    handleStatic(): Promise<string>;
+    handleInject: (_: MacroGenerationContext, input: unknown) => Promise<string>;
+    private validate;
+}
+export default CreateCardsMacro;

package/dist/macros/createCards/index.js

@@ -0,0 +1,35 @@
+/**
+    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 { createHtmlPlaceholder, validateMacroContent } from '../index.js';
+import macroMetadata from './metadata.js';
+import BaseMacro from '../base-macro.js';
+class CreateCardsMacro extends BaseMacro {
+    constructor(tasksQueue) {
+        super(macroMetadata, tasksQueue);
+    }
+    handleValidate = (input) => {
+        this.validate(input);
+    };
+    async handleStatic() {
+        // Buttons aren't supported in static mode
+        return '';
+    }
+    handleInject = async (_, input) => {
+        const options = this.validate(input);
+        return createHtmlPlaceholder(this.metadata, options);
+    };
+    validate(input) {
+        return validateMacroContent(this.metadata, input);
+    }
+}
+export default CreateCardsMacro;
+//# sourceMappingURL=index.js.map

package/dist/macros/createCards/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/macros/createCards/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAGF,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAG1E,OAAO,aAAa,MAAM,eAAe,CAAC;AAC1C,OAAO,SAAS,MAAM,kBAAkB,CAAC;AAezC,MAAM,gBAAiB,SAAQ,SAAS;IACtC,YAAY,UAAqB;QAC/B,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACnC,CAAC;IAED,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QAClC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,KAAK,CAAC,YAAY;QAChB,0CAA0C;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,YAAY,GAAG,KAAK,EAAE,CAAyB,EAAE,KAAc,EAAE,EAAE;QACjE,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC,CAAC;IAEM,QAAQ,CAAC,KAAc;QAC7B,OAAO,oBAAoB,CAAqB,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;CACF;AAED,eAAe,gBAAgB,CAAC"}

package/dist/macros/createCards/metadata.d.ts

@@ -0,0 +1,14 @@
+/**
+    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 { MacroMetadata } from '../../interfaces/macros.js';
+declare const macroMetadata: MacroMetadata;
+export default macroMetadata;

package/dist/macros/createCards/metadata.js

@@ -0,0 +1,18 @@
+/**
+    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/>.
+*/
+const macroMetadata = {
+    name: 'createCards',
+    tagName: 'create-cards',
+    schema: 'createCardsMacroSchema',
+};
+export default macroMetadata;
+//# sourceMappingURL=metadata.js.map

package/dist/macros/createCards/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/macros/createCards/metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAIF,MAAM,aAAa,GAAkB;IACnC,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,cAAc;IACvB,MAAM,EAAE,wBAAwB;CACjC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/macros/graph/index.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 BaseMacro from '../base-macro.js';
+import type { MacroOptions } from '../index.js';
+import type { MacroGenerationContext } from '../../interfaces/macros.js';
+import type TaskQueue from '../task-queue.js';
+export interface GraphOptions extends MacroOptions {
+    model: string;
+    view: string;
+}
+declare class ReportMacro extends BaseMacro {
+    constructor(tasksQueue: TaskQueue);
+    handleValidate: (input: unknown) => void;
+    handleStatic: (context: MacroGenerationContext, input: unknown) => Promise<string>;
+    handleInject: (context: MacroGenerationContext, input: unknown) => Promise<string>;
+    private parseOptions;
+}
+export default ReportMacro;

package/dist/macros/graph/index.js

@@ -0,0 +1,91 @@
+/**
+  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 BaseMacro from '../base-macro.js';
+import { Calculate } from '../../commands/index.js';
+import { createImage, validateMacroContent } from '../index.js';
+import Handlebars from 'handlebars';
+import { join } from 'node:path';
+import { logger } from '../../utils/log-utils.js';
+import macroMetadata from './metadata.js';
+import { pathExists } from '../../utils/file-utils.js';
+import { Project } from '../../containers/project.js';
+import { readFile } from 'node:fs/promises';
+import { resourceName } from '../../utils/resource-utils.js';
+import { validateJson } from '../../utils/validate.js';
+class ReportMacro extends BaseMacro {
+    constructor(tasksQueue) {
+        super(macroMetadata, tasksQueue);
+    }
+    handleValidate = (input) => {
+        this.parseOptions(input);
+    };
+    handleStatic = async (context, input) => {
+        return this.handleInject(context, input);
+    };
+    handleInject = async (context, input) => {
+        const project = new Project(context.projectPath);
+        const calculate = new Calculate(project);
+        const resourceNameToPath = (name, fileName) => {
+            const { identifier, prefix, type } = resourceName(name);
+            if (prefix === project.projectPrefix) {
+                return join(project.paths.resourcesFolder, type, identifier, fileName);
+            }
+            return join(project.paths.modulesFolder, prefix, type, identifier, fileName);
+        };
+        const options = this.parseOptions(input);
+        let schema = null;
+        try {
+            schema = JSON.parse(await readFile(resourceNameToPath(options.view, 'parameterSchema.json'), { encoding: 'utf-8' }));
+        }
+        catch (err) {
+            logger.trace(err, 'Graph schema not found or failed to read, skipping validation');
+        }
+        if (schema) {
+            validateJson(options, {
+                schema,
+            });
+        }
+        const modelLocation = resourceNameToPath(options.model, 'model.lp');
+        const viewLocation = resourceNameToPath(options.view, 'view.lp.hbs');
+        if (!pathExists(modelLocation)) {
+            throw new Error(`Graph: Model ${options.model} does not exist`);
+        }
+        let viewContent = '';
+        try {
+            viewContent = await readFile(viewLocation, { encoding: 'utf-8' });
+        }
+        catch {
+            throw new Error(`Graph: View ${options.view} does not exist`);
+        }
+        const handlebarsContext = {
+            cardKey: context.cardKey,
+            ...options,
+        };
+        const handlebars = Handlebars.create();
+        const view = handlebars.compile(viewContent)(handlebarsContext);
+        const modelContent = await readFile(modelLocation, { encoding: 'utf-8' });
+        const result = await calculate.runGraph({
+            query: view + '\n' + modelContent,
+        });
+        if (typeof result !== 'string') {
+            throw new Error('Graph macro expected a string from clingo, but received an object');
+        }
+        return createImage(result);
+    };
+    parseOptions(input) {
+        return validateMacroContent(this.metadata, input);
+    }
+}
+export default ReportMacro;
+//# sourceMappingURL=index.js.map

package/dist/macros/graph/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/macros/graph/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;EAYE;AAEF,OAAO,SAAS,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD,OAAO,aAAa,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAQvD,MAAM,WAAY,SAAQ,SAAS;IACjC,YAAY,UAAqB;QAC/B,KAAK,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IACnC,CAAC;IAED,cAAc,GAAG,CAAC,KAAc,EAAE,EAAE;QAClC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,KAAc,EAAE,EAAE;QACvE,OAAO,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC;IAEF,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAE,KAAc,EAAE,EAAE;QACvE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;QAEzC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,EAAE;YAC5D,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YACxD,IAAI,MAAM,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC;gBACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,IAAI,CACT,OAAO,CAAC,KAAK,CAAC,aAAa,EAC3B,MAAM,EACN,IAAI,EACJ,UAAU,EACV,QAAQ,CACT,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAEzC,IAAI,MAAM,GAAkB,IAAI,CAAC;QACjC,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CACjB,MAAM,QAAQ,CACZ,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,sBAAsB,CAAC,EACxD,EAAE,QAAQ,EAAE,OAAO,EAAE,CACtB,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CACV,GAAG,EACH,+DAA+D,CAChE,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,EAAE,CAAC;YACX,YAAY,CAAC,OAAO,EAAE;gBACpB,MAAM;aACP,CAAC,CAAC;QACL,CAAC;QAED,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QACpE,MAAM,YAAY,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAErE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,gBAAgB,OAAO,CAAC,KAAK,iBAAiB,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC;YACH,WAAW,GAAG,MAAM,QAAQ,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QACpE,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,eAAe,OAAO,CAAC,IAAI,iBAAiB,CAAC,CAAC;QAChE,CAAC;QACD,MAAM,iBAAiB,GAAG;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,GAAG,OAAO;SACX,CAAC;QAEF,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,iBAAiB,CAAC,CAAC;QAEhE,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,aAAa,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC;YACtC,KAAK,EAAE,IAAI,GAAG,IAAI,GAAG,YAAY;SAClC,CAAC,CAAC;QAEH,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QACD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC;IAEM,YAAY,CAAC,KAAc;QACjC,OAAO,oBAAoB,CAAe,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}

package/dist/macros/graph/metadata.d.ts

@@ -0,0 +1,14 @@
+/**
+    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 { MacroMetadata } from '../../interfaces/macros.js';
+declare const macroMetadata: MacroMetadata;
+export default macroMetadata;

package/dist/macros/graph/metadata.js

@@ -0,0 +1,18 @@
+/**
+    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/>.
+*/
+const macroMetadata = {
+    name: 'graph',
+    tagName: 'graph',
+    schema: 'graphMacroBaseSchema',
+};
+export default macroMetadata;
+//# sourceMappingURL=metadata.js.map

package/dist/macros/graph/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../../src/macros/graph/metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAIF,MAAM,aAAa,GAAkB;IACnC,IAAI,EAAE,OAAO;IACb,OAAO,EAAE,OAAO;IAChB,MAAM,EAAE,sBAAsB;CAC/B,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/macros/index.d.ts

@@ -0,0 +1,93 @@
+/**
+    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 Handlebars from 'handlebars';
+import type { AdmonitionType } from '../interfaces/adoc.js';
+import type { Validator } from 'jsonschema';
+import type { MacroGenerationContext, MacroMetadata, MacroName } from '../interfaces/macros.js';
+import type BaseMacro from './base-macro.js';
+import TaskQueue from './task-queue.js';
+export interface MacroConstructor {
+    new (tasks: TaskQueue): BaseMacro;
+}
+export declare const macros: {
+    [K in MacroName]: MacroConstructor;
+};
+export declare function validateMacroContent<T>(macro: MacroMetadata, data: unknown, validator?: Validator): T;
+/**
+ * Registers the macros with Handlebars
+ * @param {Mode} mode - The mode to register the macros in
+ */
+export declare function registerMacros(instance: typeof Handlebars, context: MacroGenerationContext, tasks: TaskQueue): BaseMacro[];
+/**
+ * Calculate amount of handlebars templates inside a string
+ * @param input
+ */
+export declare function macroCount(input: string): number;
+/**
+ * Registers macros as handlebars helpers, which just leaves the macros in the content
+ * Can be used when your macro uses handlebars and handles content that might contain macros
+ * The handleMacros function will handle recursive macros so do not execute them inside your macro
+ * @param instance handlebars instance
+ */
+export declare function registerEmptyMacros(instance: typeof Handlebars): void;
+/**
+ * Handle the macros in the content
+ * @param content - The content to handle the macros in
+ * @param mode - The mode to handle the macros in. Inject mode will generate injectable placeholders for the macros while static mode will generate valid adoc. Validate mode will only validate the macros syntax and throw errors in case of issues.
+ */
+export declare function evaluateMacros(content: string, context: MacroGenerationContext, maxTries?: number): Promise<string>;
+/**
+ * This function assumes that tasks, which were started by macros, are complete.
+ * It replaces the placeholders of the tasks with the actual results
+ * @param input Adoc content, which might have macro placeholders
+ * @param tasks The taskqueue, which was used to run the macros
+ * @param context General context for the macro evaluation process
+ * @returns Adoc, where placeholders have been replaced with the results.
+ * Note that the results might include new macros.
+ */
+export declare function applyMacroResults(input: string, tasks: TaskQueue, context: MacroGenerationContext): string;
+/**
+ * Handles errors that come when handling macros
+ * @param error - The error that was thrown
+ * @param macro - The macro that caused the error
+ * @returns The error message that is valid adoc
+ */
+export declare function handleMacroError(error: unknown, macro: string, context: MacroGenerationContext): string;
+type Value = string | number | boolean | undefined;
+/**
+ * Macro options can be a flat object or a nested object
+ * The nested object will be flattened into dot notation attributes
+ */
+export type MacroOptions = {
+    [key: string]: Value | MacroOptions;
+};
+/**
+ * Creates an injectable placeholder for a macro
+ * @param macro - The macro to create the placeholder for
+ * @param options - Options will be passed to the html element as attributes
+ */
+export declare function createHtmlPlaceholder(macro: MacroMetadata, options: MacroOptions): string;
+/**
+ * Creates an adoc admonition
+ * @param type - The type of admonition
+ * @param label - The label of the admonition
+ * @param content - The content of the admonition
+ * @returns The adoc admonition as a string
+ */
+export declare function createAdmonition(type: AdmonitionType, label: string, content: string): string;
+/**
+ * Helper function for including base64 encoded images for now
+ * @param image base64 encoded image
+ * @returns valid asciidoc with the image
+ */
+export declare function createImage(image: string): string;
+export {};