@cyberismo/backend 1.1.2 → 1.3.0

package/src/domain/cards/lib.ts

@@ -1,188 +1,24 @@
-/**
-  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/>.
-*/
+// SPDX-FileCopyrightText: Cyberismo Ltd and contributors
+// SPDX-License-Identifier: AGPL-3.0-only
 
-import { convert } from '@asciidoctor/core';
-import type { Card } from '@cyberismo/data-handler/interfaces/project-interfaces';
-import { type CommandManager, evaluateMacros } from '@cyberismo/data-handler';
-import { preprocessMermaidBlocksForHtml } from '@cyberismo/data-handler/utils/mermaid-renderer';
-import { rewriteAsciidocCardXrefs } from '@cyberismo/data-handler/utils/asciidoc-xref';
-import { getCardQueryResult } from '../../export.js';
+import type { QueryResult } from '@cyberismo/model';
+import type { Workspace } from '@cyberismo/data-handler';
 import type { TreeOptions } from '../../types.js';
-import type { QueryResult } from '@cyberismo/data-handler/types/queries';
-
-interface result {
-  status: number;
-  message?: string;
-  data?: object;
-}
-
-export async function getCardDetails(
-  commands: CommandManager,
-  key: string,
-  staticMode: boolean,
-  raw: boolean,
-): Promise<result> {
-  return commands.consistent(async () => {
-    let cardDetailsResponse: Card;
-    try {
-      cardDetailsResponse = await commands.showCmd.showCardDetails(key);
-    } catch {
-      return { status: 400, message: `Card ${key} not found from project` };
-    }
-
-    if (!cardDetailsResponse) {
-      return { status: 400, message: `Card ${key} not found from project` };
-    }
-
-    let asciidocContent = '';
-    try {
-      asciidocContent = await evaluateMacros(
-        cardDetailsResponse.content || '',
-        {
-          context: staticMode ? 'exportedSite' : 'localApp',
-          mode: staticMode ? 'staticSite' : 'inject',
-          project: commands.project,
-          cardKey: key,
-        },
-      );
-    } catch (error) {
-      asciidocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${asciidocContent}`;
-    }
-
-    // Convert [mermaid] AsciiDoc blocks to passthrough HTML before asciidoctor processes them
-    asciidocContent = preprocessMermaidBlocksForHtml(asciidocContent);
-
-    // Rewrite native AsciiDoc xrefs that target other cards into
-    // /projects/<prefix>/cards/<key> links.
-    asciidocContent = rewriteAsciidocCardXrefs(
-      asciidocContent,
-      commands.project,
-      staticMode ? 'staticSite' : 'inject',
-    );
 
-    const projectPrefix = commands.project.projectPrefix;
-    const htmlContent = (
-      await convert(asciidocContent, {
-        safe: 'safe',
-        attributes: {
-          imagesdir: `/api/projects/${projectPrefix}/cards/${key}/a`,
-          icons: 'font',
-        },
-      })
-    ).toString();
+/** Routes exported per card: data, content and source. */
+export const CARD_ROUTES_PER_KEY = 3;
 
-    if (raw) {
-      if (!cardDetailsResponse.metadata) {
-        throw new Error('Card has no metadata');
-      }
-      const cardType = await commands.showCmd.showResource(
-        cardDetailsResponse.metadata.cardType,
-        'cardTypes',
-      );
-
-      const fields = [];
-      let i = 0;
-      for (const customField of cardType.customFields) {
-        const fieldType = await commands.showCmd.showResource(
-          customField.name,
-          'fieldTypes',
-        );
-        fields.push({
-          key: customField.name,
-          visibility: 'always',
-          index: i++,
-          fieldDisplayName: fieldType.displayName,
-          fieldDescription: fieldType.description,
-          dataType: fieldType.dataType,
-          isCalculated: customField.isCalculated,
-          isOverridable: !!(
-            customField.isCalculated && customField.enableOverride
-          ),
-          overrideValue:
-            customField.isCalculated && customField.enableOverride
-              ? cardDetailsResponse.metadata[customField.name]
-              : undefined,
-          value: cardDetailsResponse.metadata[customField.name],
-          enumValues: fieldType.enumValues ?? [],
-        });
-      }
-      return {
-        status: 200,
-        data: {
-          key: cardDetailsResponse.key,
-          rank: cardDetailsResponse.metadata?.rank,
-          title: cardDetailsResponse.metadata?.title || '',
-          cardType: cardDetailsResponse.metadata?.cardType || '',
-          cardTypeDisplayName: cardDetailsResponse.metadata.cardType,
-          workflowState: '',
-          lastUpdated: cardDetailsResponse.metadata.lastUpdated,
-          createdAt: cardDetailsResponse.metadata.createdAt,
-          fields,
-          labels: cardDetailsResponse.metadata?.labels || [],
-          links: [],
-          notifications: [],
-          policyChecks: {
-            successes: [],
-            failures: [],
-          },
-          deniedOperations: {
-            transition: [],
-            move: [],
-            delete: [],
-            editField: [],
-            editContent: [],
-          },
-          rawContent: cardDetailsResponse.content || '',
-          parsedContent: htmlContent,
-          attachments: cardDetailsResponse.attachments,
-          path: cardDetailsResponse.path,
-        },
-      };
-    }
-
-    const card = staticMode
-      ? await getCardQueryResult(commands, key)
-      : await commands.calculateCmd.runQuery('card', 'localApp', {
-          cardKey: key,
-        });
-
-    if (card.length !== 1) {
-      throw new Error('Query failed. Check card-query syntax');
-    }
-
-    return {
-      status: 200,
-      data: {
-        ...card[0],
-        rawContent: cardDetailsResponse.content || '',
-        parsedContent: htmlContent,
-        attachments: cardDetailsResponse.attachments,
-        path: cardDetailsResponse.path,
-      },
-    };
-  });
-}
 /**
  * Returns all cards from a tree query, flattened.
- * @param commands the command manager used for the query
+ * @param ws the command manager used for the query
  * @param options optional tree query options
  * @returns a promise that resolves to an array of all cards
  */
 export async function allCards(
-  commands: CommandManager,
+  ws: Workspace,
   options?: TreeOptions,
 ): Promise<QueryResult<'tree'>[]> {
-  const fetchedCards = await commands.calculateCmd.runQuery(
+  const fetchedCards = await ws.queries.runQuery(
     'tree',
     'exportedSite',
     options || {},

package/src/domain/cards/mermaid.ts

@@ -0,0 +1,25 @@
+// SPDX-FileCopyrightText: Cyberismo Ltd and contributors
+// SPDX-License-Identifier: AGPL-3.0-only
+
+/**
+ * Regex that matches standard AsciiDoc mermaid diagram blocks.
+ * Supports [mermaid], [mermaid,id], [mermaid,id,format=svg], etc.
+ * Matches both literal blocks (....) and listing blocks (----).
+ * Supports both LF and CRLF line endings.
+ */
+const MERMAID_BLOCK_REGEX =
+  /\[mermaid[^\]]*\]\r?\n(\.{4,}|-{4,})\r?\n([\s\S]*?)\r?\n\1/g;
+
+/**
+ * Pre-processes AsciiDoc content to convert [mermaid] blocks into passthrough HTML
+ * that can be detected and rendered by the frontend.
+ * This must run BEFORE asciidoctor.js converts the AsciiDoc to HTML.
+ * @param content - Raw AsciiDoc content
+ * @returns AsciiDoc content with mermaid blocks replaced by passthrough HTML divs
+ */
+export function preprocessMermaidBlocksForHtml(content: string): string {
+  return content.replace(MERMAID_BLOCK_REGEX, (_match, _delim, code) => {
+    const encoded = Buffer.from(code, 'utf-8').toString('base64');
+    return `++++\n<div class="mermaid-block" data-mermaid-code="${encoded}"></div>\n++++`;
+  });
+}

package/src/domain/cards/schema.ts

@@ -1,18 +1,10 @@
-/**
-  Cyberismo
-  Copyright © Cyberismo Ltd and contributors 2026
-  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/>.
-*/
+// SPDX-FileCopyrightText: Cyberismo Ltd and contributors
+// SPDX-License-Identifier: AGPL-3.0-only
 
 import { z } from 'zod';
 
+export const cardKeyParamSchema = z.object({ key: z.string().min(1) });
+
 const linkDirection = z.enum(['outbound', 'inbound']);
 
 export const createLinkSchema = z.object({
@@ -39,12 +31,24 @@ export const updateLinkSchema = z.object({
   previousDirection: linkDirection,
   previousDescription: z.string().optional(),
 });
+
+// Interpolated into the exported document's AsciiDoc header, where a line break
+// starts a new attribute entry.
+const headerValue = z
+  .string()
+  .min(1)
+  .regex(/^[^\r\n]*$/, 'must not contain line breaks');
+
 export const exportCardPdfSchema = z.object({
-  title: z.string().min(1),
-  name: z.string().min(1),
+  title: headerValue,
+  name: headerValue,
   cardKey: z.string(),
   exportChildCards: z.boolean(),
-  version: z.string().min(1).optional(),
+  version: headerValue.optional(),
 });
 
 export type ExportCardPdfRequestBody = z.infer<typeof exportCardPdfSchema>;
+
+export const cardBatchSchema = z.object({
+  keys: z.array(z.string()).min(1).max(100),
+});