@cyberismo/backend 0.0.8 → 0.0.9

package/src/domain/cards/service.ts

@@ -0,0 +1,254 @@
+/**
+  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 Processor from '@asciidoctor/core';
+import {
+  CardLocation,
+  type MetadataContent,
+} from '@cyberismo/data-handler/interfaces/project-interfaces';
+import { type CommandManager, evaluateMacros } from '@cyberismo/data-handler';
+import { getCardDetails } from './lib.js';
+
+export async function getProjectInfo(commands: CommandManager) {
+  const projectResponse = await commands.showCmd.showProject();
+
+  const workflowsResponse = await commands.showCmd.showWorkflowsWithDetails();
+  if (!workflowsResponse) {
+    throw new Error('No workflows found');
+  }
+
+  const cardTypesResponse = await commands.showCmd.showCardTypesWithDetails();
+  if (!cardTypesResponse) {
+    throw new Error('No card types found');
+  }
+
+  return {
+    name: projectResponse.name,
+    prefix: projectResponse.prefix,
+    workflows: workflowsResponse,
+    cardTypes: cardTypesResponse,
+  };
+}
+
+export async function updateCard(
+  commands: CommandManager,
+  key: string,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  body: any,
+) {
+  const errors = [];
+
+  if (body.state) {
+    try {
+      await commands.transitionCmd.cardTransition(key, body.state);
+    } catch (error) {
+      if (error instanceof Error) errors.push(error.message);
+    }
+  }
+
+  if (body.content != null) {
+    try {
+      await commands.editCmd.editCardContent(key, body.content);
+    } catch (error) {
+      if (error instanceof Error) errors.push(error.message);
+    }
+  }
+
+  if (body.metadata) {
+    for (const [metadataKey, metadataValue] of Object.entries(body.metadata)) {
+      const value = metadataValue as MetadataContent;
+
+      try {
+        await commands.editCmd.editCardMetadata(key, metadataKey, value);
+      } catch (error) {
+        if (error instanceof Error) errors.push(error.message);
+      }
+    }
+  }
+
+  if (body.parent) {
+    try {
+      await commands.moveCmd.moveCard(key, body.parent);
+    } catch (error) {
+      if (error instanceof Error) errors.push(error.message);
+    }
+  }
+  if (body.index != null) {
+    try {
+      await commands.moveCmd.rankByIndex(key, body.index);
+    } catch (error) {
+      if (error instanceof Error) errors.push(error.message);
+    }
+  }
+
+  if (errors.length > 0) {
+    throw new Error(errors.join('\n'));
+  }
+
+  return await getCardDetails(commands, key);
+}
+
+export async function deleteCard(commands: CommandManager, key: string) {
+  await commands.removeCmd.remove('card', key);
+}
+
+export async function createCard(
+  commands: CommandManager,
+  template: string,
+  parentKey?: string,
+) {
+  const result = await commands.createCmd.createCard(
+    template,
+    parentKey === 'root' ? undefined : parentKey,
+  );
+
+  if (result.length === 0) {
+    throw new Error('No cards created');
+  }
+  return result;
+}
+
+export async function uploadAttachments(
+  commands: CommandManager,
+  key: string,
+  files: File[],
+) {
+  const succeeded = [];
+  for (const file of files) {
+    if (file instanceof File) {
+      const buffer = await file.arrayBuffer();
+      await commands.createCmd.createAttachment(
+        key,
+        file.name,
+        Buffer.from(buffer),
+      );
+      succeeded.push(file.name);
+    }
+  }
+
+  return {
+    message: 'Attachments uploaded successfully',
+    files: succeeded,
+  };
+}
+
+export async function removeAttachment(
+  commands: CommandManager,
+  key: string,
+  filename: string,
+) {
+  await commands.removeCmd.remove('attachment', key, filename);
+  return { message: 'Attachment removed successfully' };
+}
+
+export async function openAttachment(
+  commands: CommandManager,
+  key: string,
+  filename: string,
+) {
+  await commands.showCmd.openAttachment(key, filename);
+  return { message: 'Attachment opened successfully' };
+}
+
+export async function parseContent(
+  commands: CommandManager,
+  key: string,
+  content: string,
+) {
+  let asciidocContent = '';
+  try {
+    asciidocContent = await evaluateMacros(content, {
+      context: 'localApp',
+      mode: 'inject',
+      project: commands.project,
+      cardKey: key,
+    });
+  } catch (error) {
+    asciidocContent = `Macro error: ${error instanceof Error ? error.message : 'Unknown error'}\n\n${content}`;
+  }
+
+  const processor = Processor();
+  const parsedContent = processor
+    .convert(asciidocContent, {
+      safe: 'safe',
+      attributes: {
+        imagesdir: `/api/cards/${key}/a`,
+        icons: 'font',
+      },
+    })
+    .toString();
+
+  return { parsedContent };
+}
+
+export async function createLink(
+  commands: CommandManager,
+  key: string,
+  toCard: string,
+  linkType: string,
+  description?: string,
+) {
+  await commands.createCmd.createLink(key, toCard, linkType, description);
+  return { message: 'Link created successfully' };
+}
+
+export async function removeLink(
+  commands: CommandManager,
+  key: string,
+  toCard: string,
+  linkType: string,
+  description?: string,
+) {
+  await commands.removeCmd.remove('link', key, toCard, linkType, description);
+  return { message: 'Link removed successfully' };
+}
+
+export async function getAttachment(
+  commands: CommandManager,
+  key: string,
+  filename: string,
+) {
+  const attachmentResponse = await commands.showCmd.showAttachment(
+    key,
+    filename,
+  );
+
+  if (!attachmentResponse) {
+    throw new Error(
+      `No attachment found from card ${key} and filename ${filename}`,
+    );
+  }
+
+  return attachmentResponse;
+}
+
+export async function getAllCards(commands: CommandManager) {
+  const fetchedCards = await commands.showCmd.showCards(
+    CardLocation.projectOnly,
+  );
+  const projectCards = fetchedCards.find(
+    (cardContainer) => cardContainer.type === 'project',
+  );
+  if (!projectCards) {
+    throw new Error('Data handler did not return project cards');
+  }
+  return projectCards.cards;
+}
+
+export async function getAllAttachments(commands: CommandManager) {
+  const attachments = await commands.showCmd.showAttachments();
+  return attachments.map((attachment) => ({
+    key: attachment.card,
+    attachment: attachment.fileName,
+  }));
+}

package/src/domain/fieldTypes/index.ts

@@ -0,0 +1,97 @@
+/**
+  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 { Hono } from 'hono';
+import * as fieldTypeService from './service.js';
+import { createFieldTypeSchema } from './schema.js';
+import { zValidator } from '../../middleware/zvalidator.js';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/fieldTypes:
+ *   get:
+ *     summary: Returns a list of all field types in the defined project.
+ *     description: List of field types includes all field types in the project with all their details
+ *     responses:
+ *       200:
+ *        description: Object containing the project field types. See definitions.ts/FieldTypes for the structure.
+ *       400:
+ *         description: Error in reading project details.
+ *       500:
+ *         description: project_path not set or other internal error
+ */
+router.get('/', async (c) => {
+  const commands = c.get('commands');
+
+  try {
+    const fieldTypes = await fieldTypeService.getFieldTypes(commands);
+    return c.json(fieldTypes);
+  } catch (error) {
+    return c.json(
+      {
+        error: `${error instanceof Error ? error.message : 'Unknown error'} from path ${c.get('projectPath')}`,
+      },
+      500,
+    );
+  }
+});
+
+/**
+ * @swagger
+ * /api/fieldTypes:
+ *   post:
+ *     summary: Create a new field type
+ *     description: Creates a new field type with the specified data type
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               fieldTypeName:
+ *                 type: string
+ *               dataType:
+ *                 type: string
+ *                 enum: [boolean, date, dateTime, enum, integer, list, longText, number, person, shortText]
+ *             required:
+ *               - fieldTypeName
+ *               - dataType
+ *     responses:
+ *       200:
+ *         description: Field type created successfully
+ *       400:
+ *         description: Invalid request body
+ *       500:
+ *         description: Server error
+ */
+router.post('/', zValidator('json', createFieldTypeSchema), async (c) => {
+  const commands = c.get('commands');
+  const { identifier, dataType } = c.req.valid('json');
+
+  try {
+    await fieldTypeService.createFieldType(commands, identifier, dataType);
+    return c.json({ message: 'Field type created successfully' });
+  } catch (error) {
+    return c.json(
+      {
+        error: `${error instanceof Error ? error.message : 'Unknown error'}`,
+      },
+      500,
+    );
+  }
+});
+
+export default router;

package/src/domain/fieldTypes/schema.ts

@@ -0,0 +1,30 @@
+/**
+  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 { z } from 'zod';
+import { identifierSchema } from '../../common/validationSchemas.js';
+
+export const createFieldTypeSchema = z.object({
+  dataType: z.enum([
+    'boolean',
+    'date',
+    'dateTime',
+    'enum',
+    'integer',
+    'list',
+    'longText',
+    'number',
+    'person',
+    'shortText',
+  ]),
+  identifier: identifierSchema,
+});

package/src/domain/fieldTypes/service.ts

@@ -0,0 +1,38 @@
+/**
+  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 { CommandManager } from '@cyberismo/data-handler';
+import type { DataType } from '@cyberismo/data-handler/interfaces/resource-interfaces';
+
+export async function getFieldTypes(commands: CommandManager) {
+  const response = await commands.showCmd.showResources('fieldTypes');
+  if (!response) {
+    throw new Error('No field types found');
+  }
+
+  const fieldTypes = await Promise.all(
+    response.map((fieldType: string) =>
+      commands.showCmd.showResource(fieldType),
+    ),
+  );
+
+  return fieldTypes;
+}
+
+export async function createFieldType(
+  commands: CommandManager,
+  identifier: string,
+  dataType: DataType,
+) {
+  await commands.createCmd.createFieldType(identifier, dataType);
+}

package/src/domain/graphModels/index.ts

@@ -0,0 +1,54 @@
+/**
+  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 { Hono } from 'hono';
+import * as graphModelService from './service.js';
+import { createGraphModelSchema } from './schema.js';
+import { zValidator } from '../../middleware/zvalidator.js';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/graphModels:
+ *   post:
+ *     summary: Create a new graph model
+ *     description: Creates a new graph model with the specified identifier
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               identifier:
+ *                 type: string
+ *             required:
+ *               - identifier
+ *     responses:
+ *       200:
+ *         description: Graph model created successfully
+ *       400:
+ *         description: Invalid request body
+ *       500:
+ *         description: Server error
+ */
+router.post('/', zValidator('json', createGraphModelSchema), async (c) => {
+  const commands = c.get('commands');
+  const { identifier } = c.req.valid('json');
+
+  await graphModelService.createGraphModel(commands, identifier);
+  return c.json({ message: 'Graph model created successfully' });
+});
+
+export default router;

package/src/domain/graphModels/schema.ts

@@ -0,0 +1,18 @@
+/**
+  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 { z } from 'zod';
+import { identifierSchema } from '../../common/validationSchemas.js';
+
+export const createGraphModelSchema = z.object({
+  identifier: identifierSchema,
+});

package/src/domain/graphModels/service.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 { CommandManager } from '@cyberismo/data-handler';
+
+export async function createGraphModel(
+  commands: CommandManager,
+  graphModelName: string,
+) {
+  await commands.createCmd.createGraphModel(graphModelName);
+}

package/src/domain/graphViews/index.ts

@@ -0,0 +1,53 @@
+/**
+  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 { Hono } from 'hono';
+import * as graphViewService from './service.js';
+import { createGraphViewSchema } from './schema.js';
+import { zValidator } from '../../middleware/zvalidator.js';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/graphViews:
+ *   post:
+ *     summary: Create a new graph view
+ *     description: Creates a new graph view with the specified identifier
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               identifier:
+ *                 type: string
+ *             required:
+ *               - identifier
+ *     responses:
+ *       200:
+ *         description: Graph view created successfully
+ *       400:
+ *         description: Invalid request body
+ *       500:
+ *         description: Server error
+ */
+router.post('/', zValidator('json', createGraphViewSchema), async (c) => {
+  const commands = c.get('commands');
+  const { identifier } = c.req.valid('json');
+  await graphViewService.createGraphView(commands, identifier);
+  return c.json({ message: 'Graph view created successfully' });
+});
+
+export default router;

package/src/domain/graphViews/schema.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { identifierSchema } from '../../common/validationSchemas.js';
+
+export const createGraphViewSchema = z.object({
+  identifier: identifierSchema,
+});

package/src/domain/graphViews/service.ts

@@ -0,0 +1,20 @@
+/**
+  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 { CommandManager } from '@cyberismo/data-handler';
+export async function createGraphView(
+  commands: CommandManager,
+  graphViewName: string,
+) {
+  await commands.createCmd.createGraphView(graphViewName);
+}

package/src/domain/linkTypes/index.ts

@@ -0,0 +1,84 @@
+/**
+  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 { Hono } from 'hono';
+import * as linkTypeService from './service.js';
+import { createLinkTypeSchema } from './schema.js';
+import { zValidator } from '../../middleware/zvalidator.js';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/linkTypes:
+ *   get:
+ *     summary: Returns a list of all link types in the defined project.
+ *     description: List of link types includes all link types in the project with all their details
+ *     responses:
+ *       200:
+ *        description: Object containing the project link types. See definitions.ts/LinkTypes for the structure.
+ *       400:
+ *         description: Error in reading project details.
+ *       500:
+ *         description: project_path not set or other internal error
+ */
+router.get('/', async (c) => {
+  const commands = c.get('commands');
+
+  try {
+    const linkTypes = await linkTypeService.getLinkTypes(commands);
+    return c.json(linkTypes);
+  } catch (error) {
+    return c.json(
+      {
+        error: `${error instanceof Error ? error.message : 'Unknown error'} from path ${c.get('projectPath')}`,
+      },
+      500,
+    );
+  }
+});
+
+/**
+ * @swagger
+ * /api/linkTypes:
+ *   post:
+ *     summary: Create a new link type
+ *     description: Creates a new link type with the specified identifier
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               identifier:
+ *                 type: string
+ *             required:
+ *               - identifier
+ *     responses:
+ *       200:
+ *         description: Link type created successfully
+ *       400:
+ *         description: Invalid request body
+ *       500:
+ *         description: Server error
+ */
+router.post('/', zValidator('json', createLinkTypeSchema), async (c) => {
+  const commands = c.get('commands');
+  const { identifier } = c.req.valid('json');
+
+  await linkTypeService.createLinkType(commands, identifier);
+  return c.json({ message: 'Link type created successfully' });
+});
+
+export default router;