npm - @cyberismo/backend - Versions diffs - 0.0.23 → 0.0.24 - Mend

@cyberismo/backend 0.0.23 → 0.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (129) hide show

package/dist/public/index.html CHANGED Viewed

@@ -11,7 +11,36 @@
       name="msapplication-TileImage"
       content="/cropped-favicon-270x270.png"
     />
-    <script type="module" crossorigin src="/assets/index-Cdn_jRWy.js"></script>
+    <script type="module" crossorigin src="/assets/index-oVbUFngg.js"></script>
+    <link rel="modulepreload" crossorigin href="/assets/chunk-CFjPhJqf.js">
+    <link rel="modulepreload" crossorigin href="/assets/src-ps-3oTnY.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-ICPOFSXX-6-ABzkfw.js">
+    <link rel="modulepreload" crossorigin href="/assets/dist-C6vvxvVV.js">
+    <link rel="modulepreload" crossorigin href="/assets/identity-nF-8qK2-.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-5PVQY5BW-D46cRkay.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-U2HBQHQK-C6yvwOAo.js">
+    <link rel="modulepreload" crossorigin href="/assets/defaultLocale-B6dPnyNg.js">
+    <link rel="modulepreload" crossorigin href="/assets/init-B9nbfZCT.js">
+    <link rel="modulepreload" crossorigin href="/assets/linear-C8MDrvxz.js">
+    <link rel="modulepreload" crossorigin href="/assets/time-Bgnk7ODM.js">
+    <link rel="modulepreload" crossorigin href="/assets/range-DuD7Go1R.js">
+    <link rel="modulepreload" crossorigin href="/assets/treemap-DK8fitek.js">
+    <link rel="modulepreload" crossorigin href="/assets/path-C7Bv0Qdk.js">
+    <link rel="modulepreload" crossorigin href="/assets/colors-DZGTowqM.js">
+    <link rel="modulepreload" crossorigin href="/assets/ordinal-BXaEVJbT.js">
+    <link rel="modulepreload" crossorigin href="/assets/arc-DFTvTCxD.js">
+    <link rel="modulepreload" crossorigin href="/assets/array-xS8TccZC.js">
+    <link rel="modulepreload" crossorigin href="/assets/line-DrKJYWGi.js">
+    <link rel="modulepreload" crossorigin href="/assets/isEmpty-Di-NpihJ.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-X2U36JSP-D1C3tOED.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-ZZ45TVLE-DrCjtkdu.js">
+    <link rel="modulepreload" crossorigin href="/assets/rough.esm-DE7XMpOC.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-5FUZZQ4R-D7L4hZzZ.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-BSJP7CBP-BQPMRa-Q.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-ENJZ2VHE-BrjxYY_T.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-336JU56O-CVDEj5x8.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-426QAEUC-CIWkCWTf.js">
+    <link rel="modulepreload" crossorigin href="/assets/chunk-XPW4576I-BH37LuuF.js">
     <link rel="stylesheet" crossorigin href="/assets/index-ypsafPwV.css">
   </head>
   <body>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@cyberismo/backend",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "description": "Express backend for Cyberismo",
   "main": "dist/index.js",
   "keywords": [],
@@ -14,17 +14,17 @@
   "bugs": "https://github.com/CyberismoCom/cyberismo/issues",
   "dependencies": {
     "@asciidoctor/core": "^3.0.4",
-    "@modelcontextprotocol/sdk": "^1.27.1",
-    "@hono/node-server": "^1.19.10",
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "@hono/node-server": "^1.19.13",
     "@hono/zod-validator": "^0.7.6",
     "@types/mime-types": "^3.0.1",
     "dotenv": "^17.3.1",
-    "hono": "^4.12.7",
-    "jose": "^6.1.3",
+    "hono": "^4.12.14",
+    "jose": "^6.2.3",
     "mime-types": "^3.0.2",
     "zod": "^4.3.6",
-    "@cyberismo/mcp": "0.0.23",
-    "@cyberismo/data-handler": "0.0.23"
+    "@cyberismo/data-handler": "0.0.24",
+    "@cyberismo/mcp": "0.0.24"
   },
   "devDependencies": {
     "@cyberismo/app": "0.0.2"

package/src/domain/cards/index.ts CHANGED Viewed

@@ -26,6 +26,8 @@ import {
   createLinkSchema,
   removeLinkSchema,
   updateLinkSchema,
+  exportCardPdfSchema,
+  type ExportCardPdfRequestBody,
 } from './schema.js';
 const router = new Hono();
@@ -58,6 +60,77 @@ router.get('/', requireRole(UserRole.Reader), async (c) => {
   }
 });
+/**
+ * @swagger
+ * /api/cards/export-pdf:
+ *   post:
+ *     summary: Export a card as a PDF
+ *     description: Exports the specified card as a PDF
+ *     parameters:
+ *       - name: key
+ *         in: path
+ *         required: true
+ *         description: Card key (string)
+ *    requestBody:
+ *      content:
+ *       application/json:
+ *        schema:
+ *        type: object
+ *       properties:
+ *        title:
+ *         type: string
+ *       description: Title of the exported PDF
+ *       name:
+ *         type: string
+ *       description: Name of the exported PDF
+ *       exportChildCards:
+ *         type: boolean
+ *       description: Whether to export child cards
+ *       version:
+ *         type: string
+ *       description: Version of the exported PDF (optional)
+ *     responses:
+ *       200:
+ *         description: Card exported successfully
+ *       400:
+ *         description: Missing or invalid parameters.
+ *       500:
+ *         description: project_path not set
+ */
+router.post(
+  '/export-pdf',
+  requireRole(UserRole.Reader),
+  zValidator('json', exportCardPdfSchema),
+  async (c) => {
+    const commands = c.get('commands');
+    const body = (await c.req.json()) as ExportCardPdfRequestBody;
+    try {
+      const result = await cardService.exportCard(commands, {
+        cardKey: body.cardKey,
+        title: body.title,
+        name: body.name,
+        recursive: body.exportChildCards,
+        version: body.version,
+      });
+      return new Response(result, {
+        status: 200,
+        headers: {
+          'Content-Type': 'application/pdf',
+          'Cache-Control': 'no-store',
+        },
+      });
+    } catch (error) {
+      return c.json(
+        {
+          error:
+            error instanceof Error ? error.message : 'Failed to export card',
+        },
+        500,
+      );
+    }
+  },
+);
 /**
  * @swagger
  * /api/cards/{key}:

package/src/domain/cards/lib.ts CHANGED Viewed

@@ -14,6 +14,7 @@
 import Processor 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 { getCardQueryResult } from '../../export.js';
 import type { TreeOptions } from '../../types.js';
 import type { QueryResult } from '@cyberismo/data-handler/types/queries';
@@ -57,6 +58,9 @@ export async function getCardDetails(
       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);
     const htmlContent = Processor()
       .convert(asciidocContent, {
         safe: 'safe',

package/src/domain/cards/schema.ts CHANGED Viewed

@@ -39,3 +39,12 @@ export const updateLinkSchema = z.object({
   previousDirection: linkDirection,
   previousDescription: z.string().optional(),
 });
+export const exportCardPdfSchema = z.object({
+  title: z.string().min(1),
+  name: z.string().min(1),
+  cardKey: z.string(),
+  exportChildCards: z.boolean(),
+  version: z.string().min(1).optional(),
+});
+export type ExportCardPdfRequestBody = z.infer<typeof exportCardPdfSchema>;

package/src/domain/cards/service.ts CHANGED Viewed

@@ -12,9 +12,13 @@
 */
 import Processor from '@asciidoctor/core';
-import { type MetadataContent } from '@cyberismo/data-handler/interfaces/project-interfaces';
+import type {
+  ExportPdfOptions,
+  MetadataContent,
+} from '@cyberismo/data-handler/interfaces/project-interfaces';
 import type { attachmentPayload } from '@cyberismo/data-handler/interfaces/request-status-interfaces';
 import { type CommandManager, evaluateMacros } from '@cyberismo/data-handler';
+import { preprocessMermaidBlocksForHtml } from '@cyberismo/data-handler/utils/mermaid-renderer';
 import { allCards } from './lib.js';
 import type { TreeOptions } from '../../types.js';
@@ -120,11 +124,19 @@ export async function uploadAttachments(
   };
 }
+function validateAttachmentFileName(filename: string): void {
+  const decoded = decodeURIComponent(filename);
+  if (/(^|[/\\])\.\.([/\\]|$)/.test(decoded)) {
+    throw new Error('Invalid attachment filename');
+  }
+}
 export async function removeAttachment(
   commands: CommandManager,
   key: string,
   filename: string,
 ) {
+  validateAttachmentFileName(filename);
   await commands.removeCmd.remove('attachment', key, filename);
   return { message: 'Attachment removed successfully' };
 }
@@ -134,6 +146,7 @@ export async function openAttachment(
   key: string,
   filename: string,
 ) {
+  validateAttachmentFileName(filename);
   await commands.showCmd.openAttachment(key, filename);
   return { message: 'Attachment opened successfully' };
 }
@@ -156,6 +169,9 @@ export async function parseContent(
       asciidocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${content}`;
     }
+    // Convert [mermaid] AsciiDoc blocks to passthrough HTML before asciidoctor processes them
+    asciidocContent = preprocessMermaidBlocksForHtml(asciidocContent);
     const processor = Processor();
     const parsedContent = processor
       .convert(asciidocContent, {
@@ -259,6 +275,7 @@ export async function getAttachment(
   key: string,
   filename: string,
 ): Promise<attachmentPayload> {
+  validateAttachmentFileName(filename);
   return commands.showCmd.showAttachment(key, filename);
 }
@@ -298,3 +315,11 @@ export async function findRelevantAttachments(
       attachment: attachment.fileName,
     }));
 }
+export async function exportCard(
+  commands: CommandManager,
+  options: ExportPdfOptions,
+): Promise<Buffer> {
+  const result = await commands.exportCmd.exportPdfBuffer(options);
+  return result;
+}

package/src/domain/project/service.ts CHANGED Viewed

@@ -57,7 +57,7 @@ export async function getProject(
     const project = await commands.showCmd.showProject();
     const modules = await commands.showCmd.showModules();
     const moduleDetails = await Promise.all(
-      modules.map((mod) => toModuleInfo(commands, mod)),
+      modules.map((mod) => toModuleInfo(commands, mod.name)),
     );
     return {

package/src/domain/resources/index.ts CHANGED Viewed

@@ -20,6 +20,8 @@ import { zValidator } from '../../middleware/zvalidator.js';
 import {
   validateResourceParamsSchema,
   updateOperationBodySchema,
+  workflowGraphParamsSchema,
+  workflowGraphQuerySchema,
 } from './schema.js';
 import { requireRole } from '../../middleware/auth.js';
@@ -132,6 +134,78 @@ router.delete(
   },
 );
+/**
+ * @swagger
+ * /api/resources/{prefix}/workflows/{identifier}/graph:
+ *   get:
+ *     summary: Render the state-machine graph for a workflow
+ *     description: Returns a base64-encoded sanitized SVG of the workflow's
+ *                  state-machine diagram, rendered with the built-in
+ *                  workflow graph model and view. When the optional `card`
+ *                  query parameter is provided, the diagram highlights
+ *                  that card's current workflowState.
+ *     parameters:
+ *       - in: path
+ *         name: prefix
+ *         required: true
+ *         schema:
+ *           type: string
+ *       - in: path
+ *         name: identifier
+ *         required: true
+ *         schema:
+ *           type: string
+ *       - in: query
+ *         name: card
+ *         required: false
+ *         schema:
+ *           type: string
+ *         description: Card key whose current workflowState should be
+ *                      highlighted in the rendered diagram.
+ *     responses:
+ *       200:
+ *         description: Rendered diagram
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 svg:
+ *                   type: string
+ *                   description: Base64-encoded SVG document.
+ *       400:
+ *         description: Invalid path parameters
+ *       404:
+ *         description: Workflow or card not found
+ *       500:
+ *         description: Server error
+ */
+router.get(
+  '/:prefix/workflows/:identifier/graph',
+  requireRole(UserRole.Reader),
+  zValidator('param', workflowGraphParamsSchema),
+  zValidator('query', workflowGraphQuerySchema),
+  async (c) => {
+    const commands = c.get('commands');
+    const { prefix, identifier } = c.req.valid('param');
+    const { card } = c.req.valid('query');
+    const workflowName = `${prefix}/workflows/${identifier}`;
+    try {
+      const svg = await resourceService.getWorkflowGraph(
+        commands,
+        workflowName,
+        card,
+      );
+      return c.json({ svg });
+    } catch (error) {
+      if (error instanceof Error && error.message.includes('not found')) {
+        return c.json({ error: error.message }, 404);
+      }
+      throw error;
+    }
+  },
+);
 router.post(
   '/:prefix/:type/:identifier/operation',
   requireRole(UserRole.Admin),

package/src/domain/resources/schema.ts CHANGED Viewed

@@ -1,9 +1,23 @@
 import { z } from 'zod';
 import {
+  identifierSchema,
   resourceParamsSchema,
   resourceTypes,
 } from '../../common/validationSchemas.js';
+export const workflowGraphParamsSchema = z.object({
+  prefix: z.string(),
+  identifier: identifierSchema,
+});
+export type WorkflowGraphParams = z.infer<typeof workflowGraphParamsSchema>;
+export const workflowGraphQuerySchema = z.object({
+  card: z.string().optional(),
+});
+export type WorkflowGraphQuery = z.infer<typeof workflowGraphQuerySchema>;
 export const resourceFileParamsSchema = resourceParamsSchema.extend({
   file: z.string(),
 });

package/src/domain/resources/service.ts CHANGED Viewed

@@ -42,14 +42,14 @@ const resourceTypes: ResourceFolderType[] = [
 async function getModules(commands: CommandManager) {
   try {
-    const moduleNames = await commands.showCmd.showModules();
+    const modules = await commands.showCmd.showModules();
     return Promise.all(
-      moduleNames.map(async (moduleName) => {
+      modules.map(async (mod) => {
         try {
-          const module = await commands.showCmd.showModule(moduleName);
+          const module = await commands.showCmd.showModule(mod.name);
           return { name: module.name, cardKeyPrefix: module.cardKeyPrefix };
         } catch {
-          return { name: moduleName, cardKeyPrefix: moduleName };
+          return { name: mod.name, cardKeyPrefix: mod.name };
         }
       }),
     );
@@ -467,6 +467,52 @@ export async function validateResource(
   };
 }
+/**
+ * Renders the built-in state-machine graph for a single workflow.
+ * When `cardKey` is provided, the card's current workflowState is
+ * highlighted in the diagram. The workflow lookup, card lookup and
+ * graph rendering all run inside the same consistency window so the
+ * highlighted state matches the diagram even if the card is being
+ * transitioned concurrently.
+ * @returns base64-encoded sanitized SVG.
+ * @throws Error with 'not found' in the message when the workflow or
+ *   card cannot be resolved.
+ */
+export async function getWorkflowGraph(
+  commands: CommandManager,
+  workflowName: string,
+  cardKey?: string,
+): Promise<string> {
+  return commands.consistent(async () => {
+    try {
+      await commands.showCmd.showResource(workflowName, 'workflows');
+    } catch (error) {
+      if (error instanceof Error && error.message.includes('does not exist')) {
+        throw new Error(`Workflow '${workflowName}' not found`, {
+          cause: error,
+        });
+      }
+      throw error;
+    }
+    let currentState: string | undefined;
+    if (cardKey) {
+      let card;
+      try {
+        card = await commands.showCmd.showCardDetails(cardKey);
+      } catch (error) {
+        throw new Error(`Card '${cardKey}' not found`, { cause: error });
+      }
+      if (!card?.metadata) {
+        throw new Error(`Card '${cardKey}' not found`);
+      }
+      currentState = card.metadata.workflowState;
+    }
+    return commands.calculateCmd.runWorkflowGraph(workflowName, {
+      currentState,
+    });
+  });
+}
 /**
  * Perform an updateOperation on a resource key.
  * This delegates to data-handler Update.applyResourceOperation.