@cyberismo/data-handler 0.0.2

package/dist/exceptions/index.js

@@ -0,0 +1,26 @@
+/**
+    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 class DHValidationError extends Error {
+    errors;
+    constructor(message, errors) {
+        super(message);
+        this.name = 'DHValidationError';
+        this.errors = errors;
+    }
+}
+export class SchemaNotFound extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'SchemaNotFound';
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/exceptions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/exceptions/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAIF,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IACnC,MAAM,CAAqB;IAClC,YAAY,OAAe,EAAE,MAA0B;QACrD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,KAAK;IACvC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF"}

package/dist/index.d.ts

@@ -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/>.
+*/
+import { CardsOptions, Cmd, Commands, CommandManager, ExportFormats } from './command-handler.js';
+import { requestStatus } from './interfaces/request-status-interfaces.js';
+import { UpdateOperations } from './resources/resource-object.js';
+import { evaluateMacros } from './macros/index.js';
+export { CardsOptions, Cmd, CommandManager, Commands, ExportFormats, requestStatus, UpdateOperations, evaluateMacros, };

package/dist/index.js

@@ -0,0 +1,15 @@
+/**
+    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 { Cmd, Commands, CommandManager, ExportFormats, } from './command-handler.js';
+import { evaluateMacros } from './macros/index.js';
+export { Cmd, CommandManager, Commands, ExportFormats, evaluateMacros, };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAEL,GAAG,EACH,QAAQ,EACR,cAAc,EACd,aAAa,GACd,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,OAAO,EAEL,GAAG,EACH,cAAc,EACd,QAAQ,EACR,aAAa,EAGb,cAAc,GACf,CAAC"}

package/dist/interfaces/adoc.d.ts

@@ -0,0 +1,12 @@
+/**
+    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 type AdmonitionType = 'NOTE' | 'TIP' | 'IMPORTANT' | 'CAUTION' | 'WARNING';

package/dist/interfaces/adoc.js

@@ -0,0 +1,13 @@
+/**
+    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 {};
+//# sourceMappingURL=adoc.js.map

package/dist/interfaces/adoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adoc.js","sourceRoot":"","sources":["../../src/interfaces/adoc.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE"}

package/dist/interfaces/macros.d.ts

@@ -0,0 +1,45 @@
+/**
+    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 '../macros/common.js';
+type Mode = 'validate' | 'static' | 'inject';
+export interface MacroGenerationContext {
+    projectPath: string;
+    mode: Mode;
+    cardKey: string;
+}
+export interface MacroMetadata {
+    /**
+     * The name of the macro. This is the name that will be used in the content
+     */
+    name: string;
+    /**
+     * The tag name of the macro. This is the name that will be used in the HTML. This is separated for clarity since tags cannot have uppercase letters
+     */
+    tagName: string;
+    /**
+     * The schema of the macro. This is used to validate the data passed to the macro
+     */
+    schema?: string;
+}
+export interface MacroTaskState {
+    globalId: string;
+    localId: number;
+    promise: Promise<void>;
+    placeholder: string;
+    promiseResult: string | null;
+    macro: string;
+}
+export interface HandlebarsOptions {
+    fn: (arg0: unknown) => string;
+}
+export type MacroName = keyof typeof macroMetadata;
+export {};

package/dist/interfaces/macros.js

@@ -0,0 +1,13 @@
+/**
+    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 {};
+//# sourceMappingURL=macros.js.map

package/dist/interfaces/macros.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"macros.js","sourceRoot":"","sources":["../../src/interfaces/macros.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE"}

package/dist/interfaces/project-interfaces.d.ts

@@ -0,0 +1,121 @@
+/**
+    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 { Link, TemplateConfiguration } from './resource-interfaces.js';
+export interface Card {
+    key: string;
+    path: string;
+    content?: string;
+    metadata?: CardMetadata;
+    parent?: string;
+    children: Card[];
+    attachments: CardAttachment[];
+}
+export interface CardAttachment {
+    card: string;
+    path: string;
+    fileName: string;
+    mimeType: string | null;
+}
+export interface CardListContainer {
+    name: string;
+    type: string;
+    cards: string[];
+}
+export interface PredefinedCardMetadata {
+    title: string;
+    cardType: string;
+    workflowState: string;
+    rank: string;
+    lastTransitioned?: string;
+    lastUpdated?: string;
+    templateCardKey?: string;
+}
+export declare enum CardLocation {
+    all = "all",
+    projectOnly = "project",
+    templatesOnly = "local"
+}
+export interface CardMetadata extends PredefinedCardMetadata {
+    labels?: string[];
+    links: Link[];
+    [key: string]: MetadataContent;
+}
+type ContentType = DotSchemaContent | ProjectSettings;
+export type CSVRowRaw = {
+    [key: string]: string;
+};
+export interface DotSchemaItem {
+    id: string;
+    version: number;
+    file?: string;
+}
+export type DotSchemaContent = DotSchemaItem[];
+export interface FetchCardDetails {
+    attachments?: boolean;
+    calculations?: true;
+    children?: boolean;
+    content?: boolean;
+    contentType?: FileContentType;
+    metadata?: boolean;
+    parent?: boolean;
+}
+export interface ProjectFetchCardDetails extends FetchCardDetails {
+    location?: CardLocation;
+}
+export type FileContentType = 'adoc' | 'html';
+export type MetadataContent = bigint | number | boolean | string | string[] | Link[] | null | undefined;
+export interface ModuleContent extends ProjectSettings {
+    path: string;
+    calculations: string[];
+    cardTypes: string[];
+    fieldTypes: string[];
+    graphModels: string[];
+    graphViews: string[];
+    linkTypes: string[];
+    reports: string[];
+    templates: string[];
+    workflows: string[];
+}
+export interface ProjectFile {
+    content: ContentType;
+    path: string;
+    name: string;
+}
+export interface ProjectMetadata {
+    name: string;
+    path: string;
+    prefix: string;
+    modules: string[];
+    numberOfCards: number;
+}
+export interface ProjectSettings {
+    cardKeyPrefix: string;
+    name: string;
+    modules: ModuleSetting[];
+}
+export interface ModuleSetting extends ModuleSettingOptions {
+    name: string;
+    location: string;
+}
+export interface ModuleSettingOptions {
+    branch?: string;
+    private?: boolean;
+}
+export type RemovableResourceTypes = 'attachment' | 'card' | 'cardType' | 'fieldType' | 'graphModel' | 'graphView' | 'link' | 'linkType' | 'module' | 'report' | 'template' | 'workflow' | 'label';
+export interface Resource {
+    name: string;
+    path: string;
+}
+export type ResourceFolderType = 'calculations' | 'cardTypes' | 'fieldTypes' | 'graphModels' | 'graphViews' | 'linkTypes' | 'modules' | 'reports' | 'templates' | 'workflows';
+export type ResourceTypes = RemovableResourceTypes | ResourceFolderType | 'attachments' | 'calculation' | 'cards' | 'label' | 'labels' | 'links' | 'modules' | 'project' | 'projects';
+export { TemplateConfiguration };
+export declare const CardNameRegEx: RegExp;

package/dist/interfaces/project-interfaces.js

@@ -0,0 +1,21 @@
+/**
+    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/>.
+*/
+// todo: do we need in the future separation between module-template-cards and local template-cards
+export var CardLocation;
+(function (CardLocation) {
+    CardLocation["all"] = "all";
+    CardLocation["projectOnly"] = "project";
+    CardLocation["templatesOnly"] = "local";
+})(CardLocation || (CardLocation = {}));
+// Name for a card (consists of prefix and a random 8-character base36 string; e.g. 'test_abcd1234')
+export const CardNameRegEx = new RegExp(/^[a-z]+_[0-9a-z]+$/);
+//# sourceMappingURL=project-interfaces.js.map

package/dist/interfaces/project-interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-interfaces.js","sourceRoot":"","sources":["../../src/interfaces/project-interfaces.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAwCF,mGAAmG;AACnG,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;AACzB,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAuJD,oGAAoG;AACpG,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAC"}

package/dist/interfaces/request-status-interfaces.d.ts

@@ -0,0 +1,28 @@
+/**
+    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/>.
+*/
+declare enum httpStatusCode {
+    Info = 100,
+    OK = 200,
+    BAD = 400,
+    SERVER_ERROR = 500
+}
+export interface requestStatus {
+    statusCode: httpStatusCode;
+    message?: string;
+    affectsCards?: string[];
+    payload?: object | attachmentPayload;
+}
+export interface attachmentPayload {
+    fileBuffer: Buffer;
+    mimeType: string;
+}
+export {};

package/dist/interfaces/request-status-interfaces.js

@@ -0,0 +1,20 @@
+/**
+    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/>.
+*/
+var httpStatusCode;
+(function (httpStatusCode) {
+    httpStatusCode[httpStatusCode["Info"] = 100] = "Info";
+    httpStatusCode[httpStatusCode["OK"] = 200] = "OK";
+    httpStatusCode[httpStatusCode["BAD"] = 400] = "BAD";
+    httpStatusCode[httpStatusCode["SERVER_ERROR"] = 500] = "SERVER_ERROR";
+})(httpStatusCode || (httpStatusCode = {}));
+export {};
+//# sourceMappingURL=request-status-interfaces.js.map

package/dist/interfaces/request-status-interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-status-interfaces.js","sourceRoot":"","sources":["../../src/interfaces/request-status-interfaces.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,IAAK,cAKJ;AALD,WAAK,cAAc;IACjB,qDAAU,CAAA;IACV,iDAAQ,CAAA;IACR,mDAAS,CAAA;IACT,qEAAkB,CAAA;AACpB,CAAC,EALI,cAAc,KAAd,cAAc,QAKlB"}

package/dist/interfaces/resource-interfaces.d.ts

@@ -0,0 +1,117 @@
+/**
+    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 { Schema } from 'jsonschema';
+/**
+ * Each resource represents a file (or a folder in some cases) with metadata stored
+ * in JSON file. Name of the file is the name of the resource. Each resource is expected to be
+ * in a correct place in folder structure.
+ */
+export type CalculationMetadata = ResourceBaseMetadata;
+export interface CardType extends ResourceBaseMetadata {
+    workflow: string;
+    customFields: CustomField[];
+    alwaysVisibleFields: string[];
+    optionallyVisibleFields: string[];
+}
+export interface CustomField {
+    name: string;
+    description?: string;
+    displayName?: string;
+    isCalculated: boolean;
+}
+export type DataType = 'boolean' | 'date' | 'dateTime' | 'enum' | 'integer' | 'list' | 'longText' | 'number' | 'person' | 'shortText';
+export interface EnumDefinition {
+    enumValue: string;
+    enumDisplayValue?: string;
+    enumDescription?: string;
+}
+export interface FieldType extends ResourceBaseMetadata {
+    displayName?: string;
+    fieldDescription?: string;
+    dataType: DataType;
+    enumValues?: Array<EnumDefinition>;
+}
+export interface GraphModelMetadata extends ResourceBaseMetadata {
+    category?: string;
+    description?: string;
+    displayName: string;
+}
+export interface GraphModel extends GraphModelMetadata {
+    calculationFile: string;
+}
+export interface GraphViewMetadata extends ResourceBaseMetadata {
+    category?: string;
+    description?: string;
+    displayName: string;
+}
+export interface GraphView extends GraphViewMetadata {
+    handleBarFile: string;
+}
+export interface Link {
+    linkType: string;
+    cardKey: string;
+    linkDescription?: string;
+}
+export interface LinkType extends ResourceBaseMetadata {
+    outboundDisplayName: string;
+    inboundDisplayName: string;
+    sourceCardTypes: string[];
+    destinationCardTypes: string[];
+    enableLinkDescription: boolean;
+}
+export interface Report {
+    name: string;
+    metadata: ReportMetadata;
+    contentTemplate: string;
+    queryTemplate: string;
+    schema?: Schema;
+}
+export interface ReportMetadata extends ResourceBaseMetadata {
+    displayName: string;
+    description: string;
+    category: string;
+}
+export interface ResourceBaseMetadata {
+    name: string;
+    usedIn?: string[];
+}
+export type ResourceContent = CardType | FieldType | GraphModel | GraphView | LinkType | ReportMetadata | TemplateMetadata | Workflow;
+export interface TemplateConfiguration {
+    name: string;
+    path: string;
+    numberOfCards: number;
+    metadata: TemplateMetadata;
+}
+export interface TemplateMetadata extends ResourceBaseMetadata {
+    displayName?: string;
+    description?: string;
+    category?: string;
+}
+export interface Workflow extends ResourceBaseMetadata {
+    states: WorkflowState[];
+    transitions: WorkflowTransition[];
+}
+export declare enum WorkflowCategory {
+    initial = "initial",
+    active = "active",
+    closed = "closed",
+    none = "none"
+}
+export interface WorkflowState {
+    name: string;
+    category?: WorkflowCategory;
+}
+export interface WorkflowTransition {
+    name: string;
+    fromState: string[];
+    toState: string;
+}

package/dist/interfaces/resource-interfaces.js

@@ -0,0 +1,20 @@
+/**
+    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/>.
+*/
+// Workflow state categories.
+export var WorkflowCategory;
+(function (WorkflowCategory) {
+    WorkflowCategory["initial"] = "initial";
+    WorkflowCategory["active"] = "active";
+    WorkflowCategory["closed"] = "closed";
+    WorkflowCategory["none"] = "none";
+})(WorkflowCategory || (WorkflowCategory = {}));
+//# sourceMappingURL=resource-interfaces.js.map

package/dist/interfaces/resource-interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-interfaces.js","sourceRoot":"","sources":["../../src/interfaces/resource-interfaces.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAqJF,6BAA6B;AAC7B,MAAM,CAAN,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,iCAAa,CAAA;AACf,CAAC,EALW,gBAAgB,KAAhB,gBAAgB,QAK3B"}

package/dist/macros/base-macro.d.ts

@@ -0,0 +1,31 @@
+/**
+    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 { HandlebarsOptions, MacroGenerationContext, MacroMetadata } from '../interfaces/macros.js';
+import type TaskQueue from './task-queue.js';
+declare abstract class BaseMacro {
+    protected macroMetadata: MacroMetadata;
+    private readonly tasks;
+    private globalId;
+    private localCounter;
+    constructor(macroMetadata: MacroMetadata, tasks: TaskQueue);
+    protected abstract handleInject(context: MacroGenerationContext, input: unknown): Promise<string>;
+    protected abstract handleStatic(context: MacroGenerationContext, input: unknown): Promise<string>;
+    protected abstract handleValidate(input: unknown): void;
+    get metadata(): MacroMetadata;
+    private findDependencies;
+    private generatePlaceholder;
+    /**
+     * Function responsible for starting the promise and storing it along with its localId.
+     */
+    invokeMacro: (context: MacroGenerationContext, options: HandlebarsOptions) => string | undefined;
+}
+export default BaseMacro;

package/dist/macros/base-macro.js

@@ -0,0 +1,126 @@
+/**
+    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 { generateRandomString } from '../utils/random.js';
+import { handleMacroError } from './index.js';
+class BaseMacro {
+    macroMetadata;
+    tasks;
+    globalId;
+    localCounter = 0;
+    constructor(macroMetadata, tasks) {
+        this.macroMetadata = macroMetadata;
+        this.tasks = tasks;
+        // Set a unique global id for each instance of the macro
+        this.globalId = `${generateRandomString(36, 10)}`;
+    }
+    get metadata() {
+        return this.macroMetadata;
+    }
+    findDependencies(input) {
+        // Define a regex pattern to identify dependencies in the input string.
+        const dependencyPattern = /<<macro::([a-zA-Z0-9_-]+)::([0-9]+)>>/g;
+        const dependencies = [];
+        let match;
+        while ((match = dependencyPattern.exec(input)) !== null) {
+            const [placeholder, globalId, localId] = match;
+            // Retrieve the task corresponding to the globalId and localId
+            const task = this.tasks.find(globalId, parseInt(localId, 10));
+            if (task) {
+                dependencies.push(task);
+            }
+            else {
+                console.warn(`Dependency not found for placeholder: ${placeholder} (globalId: ${globalId}, localId: ${localId})`);
+            }
+        }
+        return dependencies;
+    }
+    generatePlaceholder() {
+        const localId = this.localCounter++;
+        return {
+            localId,
+            placeholder: `<<macro::${this.globalId}::${localId}>>`,
+        };
+    }
+    /**
+     * Function responsible for starting the promise and storing it along with its localId.
+     */
+    invokeMacro = (context, options) => {
+        // Create a unique localId for each invocation
+        const { placeholder, localId } = this.generatePlaceholder();
+        const rawInput = options.fn(this);
+        let input = '{' + rawInput + '}';
+        if (context.mode === 'validate') {
+            try {
+                this.handleValidate(JSON.parse(input));
+            }
+            catch (error) {
+                if (error instanceof Error) {
+                    const errorMessage = `From card '${context.cardKey}' a macro validation error:\n\n${error.message}.\n\nCard content:\n ${input}`;
+                    throw new Error(errorMessage);
+                }
+                throw error;
+            }
+            return;
+        }
+        // Extract dependencies
+        const dependencies = this.findDependencies(rawInput);
+        // Create a promise to resolve dependencies, execute the macro, and handle the results
+        const promise = Promise.all(dependencies.map((dep) => dep.promise))
+            .then(() => {
+            for (const dependency of dependencies) {
+                input = input.replace(dependency.placeholder, dependency.promiseResult || '');
+            }
+            let parsed;
+            try {
+                parsed = JSON.parse(input);
+            }
+            catch {
+                return 'Invalid JSON';
+            }
+            // Select the function to execute based on context mode
+            const functionToCall = context.mode === 'inject' ? this.handleInject : this.handleStatic;
+            // Execute the function and handle its result
+            return functionToCall(context, parsed);
+        })
+            .then((result) => {
+            const task = this.tasks.find(this.globalId, localId);
+            if (task) {
+                task.promiseResult = result;
+            }
+            else {
+                console.error(`Task not found after execution: macro ${this.metadata.name}, local id ${localId}.`);
+            }
+        })
+            .catch((err) => {
+            const task = this.tasks.find(this.globalId, localId);
+            if (task) {
+                task.promiseResult = handleMacroError(err, this.metadata.name, context);
+            }
+            else {
+                console.error(`Error handling task for macro ${this.metadata.name}, local id ${localId}:`, err);
+            }
+        });
+        // Store the task
+        this.tasks.push({
+            globalId: this.globalId,
+            localId,
+            promise,
+            placeholder,
+            promiseResult: null,
+            macro: this.macroMetadata.name,
+        });
+        // Return the placeholder
+        return placeholder;
+    };
+}
+export default BaseMacro;
+//# sourceMappingURL=base-macro.js.map