@cyberismo/data-handler 0.0.7 → 0.0.9

package/src/macros/vega/index.ts

@@ -0,0 +1,55 @@
+/**
+  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 { MacroGenerationContext } from '../../interfaces/macros.js';
+import BaseMacro from '../base-macro.js';
+import macroMetadata from './metadata.js';
+import type TaskQueue from '../task-queue.js';
+import {
+  createHtmlPlaceholder,
+  createImage,
+  validateMacroContent,
+} from '../index.js';
+import * as vega from 'vega';
+
+export interface VegaMacroInput {
+  spec: vega.Spec;
+}
+
+class VegaMacro extends BaseMacro {
+  constructor(tasksQueue: TaskQueue) {
+    super(macroMetadata, tasksQueue);
+  }
+
+  handleValidate = (input: unknown) => {
+    this.validate(input);
+  };
+
+  handleStatic = async (_: MacroGenerationContext, input: unknown) => {
+    const options = this.validate(input) as VegaMacroInput;
+    const view = new vega.View(vega.parse(options.spec), { renderer: 'none' });
+    const svg = await view.toSVG();
+    return createImage(Buffer.from(svg).toString('base64'), false);
+  };
+
+  handleInject = async (_: MacroGenerationContext, input: unknown) => {
+    const options = this.validate(input) as VegaMacroInput;
+    return createHtmlPlaceholder(this.metadata, options);
+  };
+
+  private validate(input: unknown): VegaMacroInput {
+    return validateMacroContent<VegaMacroInput>(this.metadata, input);
+  }
+}
+
+export default VegaMacro;

package/src/macros/vega/metadata.ts

@@ -0,0 +1,21 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  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';
+
+const macroMetadata: MacroMetadata = {
+  name: 'vega',
+  tagName: 'vega',
+  schema: 'vegaMacroSchema',
+};
+
+export default macroMetadata;

package/src/macros/vegalite/index.ts

@@ -0,0 +1,50 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  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 { MacroGenerationContext } from '../../interfaces/macros.js';
+import BaseMacro from '../base-macro.js';
+import macroMetadata from './metadata.js';
+import type TaskQueue from '../task-queue.js';
+import * as vegaLite from 'vega-lite';
+import { createMacro, validateMacroContent } from '../index.js';
+
+export interface VegaLiteMacroInput {
+  spec: vegaLite.TopLevelSpec;
+}
+
+class VegaLiteMacro extends BaseMacro {
+  constructor(tasksQueue: TaskQueue) {
+    super(macroMetadata, tasksQueue);
+  }
+
+  handleValidate = (input: unknown) => {
+    this.validate(input);
+  };
+
+  handleStatic = async (_: MacroGenerationContext, input: unknown) => {
+    const options = this.validate(input) as VegaLiteMacroInput;
+    const compiled = vegaLite.compile(options.spec).spec;
+    return createMacro('vega', {
+      spec: compiled,
+    });
+  };
+
+  handleInject = async (context: MacroGenerationContext, input: unknown) => {
+    return this.handleStatic(context, input);
+  };
+
+  private validate(input: unknown): VegaLiteMacroInput {
+    return validateMacroContent<VegaLiteMacroInput>(this.metadata, input);
+  }
+}
+
+export default VegaLiteMacro;

package/src/macros/vegalite/metadata.ts

@@ -0,0 +1,21 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  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';
+
+const macroMetadata: MacroMetadata = {
+  name: 'vegaLite',
+  tagName: 'vegaLite',
+  schema: 'vegaLiteMacroSchema',
+};
+
+export default macroMetadata;

package/src/macros/xref/index.ts

@@ -0,0 +1,73 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  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 { validateMacroContent } from '../index.js';
+
+import type { MacroGenerationContext } from '../../interfaces/macros.js';
+import macroMetadata from './metadata.js';
+import BaseMacro from '../base-macro.js';
+import type TaskQueue from '../task-queue.js';
+
+export interface XrefMacroOptions {
+  cardKey: string;
+}
+
+export default class XrefMacro extends BaseMacro {
+  constructor(tasksQueue: TaskQueue) {
+    super(macroMetadata, tasksQueue);
+  }
+
+  handleValidate = (input: unknown) => {
+    this.validate(input);
+  };
+
+  handleStatic = async (
+    context: MacroGenerationContext,
+    input: unknown,
+  ): Promise<string> => {
+    const options = this.validate(input);
+    const card = await this.getCard(options.cardKey, context);
+
+    if (!card || !card.metadata) {
+      throw new Error(`Card key ${options.cardKey} not found`);
+    }
+
+    // in static mode we need to use internal references
+    return `<<${options.cardKey}>>`;
+  };
+
+  handleInject = async (context: MacroGenerationContext, input: unknown) => {
+    const options = this.validate(input);
+    const card = await this.getCard(options.cardKey, context);
+
+    if (!card || !card.metadata) {
+      throw new Error(`Card key ${options.cardKey} not found`);
+    }
+
+    return `xref:${options.cardKey}.adoc[${card.metadata.title}]`;
+  };
+
+  private async getCard(cardKey: string, context: MacroGenerationContext) {
+    const card = await context.project.cardDetailsById(cardKey, {
+      metadata: true,
+    });
+    if (!card || !card.metadata) {
+      throw new Error(`Card key ${cardKey} not found`);
+    }
+    return card;
+  }
+
+  private validate(input: unknown): XrefMacroOptions {
+    return validateMacroContent<XrefMacroOptions>(this.metadata, input);
+  }
+}

package/src/macros/xref/metadata.ts

@@ -0,0 +1,22 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2025
+  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';
+
+const macroMetadata: MacroMetadata = {
+  name: 'xref',
+  tagName: 'xref',
+  schema: 'xrefMacroSchema',
+};
+
+export default macroMetadata;