@cyberismo/backend 0.0.14 → 0.0.16

package/src/domain/cards/service.ts

@@ -12,12 +12,10 @@
 */
 
 import Processor from '@asciidoctor/core';
-import {
-  CardLocation,
-  type MetadataContent,
-} from '@cyberismo/data-handler/interfaces/project-interfaces';
+import { type MetadataContent } from '@cyberismo/data-handler/interfaces/project-interfaces';
 import { type CommandManager, evaluateMacros } from '@cyberismo/data-handler';
-import { getCardDetails } from './lib.js';
+import { allCards } from './lib.js';
+import type { TreeOptions } from '../../types.js';
 
 export async function getProjectInfo(commands: CommandManager) {
   const projectResponse = await commands.showCmd.showProject();
@@ -94,8 +92,6 @@ export async function updateCard(
   if (errors.length > 0) {
     throw new Error(errors.join('\n'));
   }
-
-  return await getCardDetails(commands, key);
 }
 
 export async function deleteCard(commands: CommandManager, key: string) {
@@ -213,42 +209,47 @@ export async function removeLink(
   return { message: 'Link removed successfully' };
 }
 
-export async function getAttachment(
+export 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;
+  return commands.showCmd.showAttachment(key, filename);
 }
 
-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;
+/**
+ * Used for exporting cards, thus static mode is assumed
+ * @param commandsthe command manager used for the query
+ * @param options optional tree query options
+ * @returns all cards in a flattened array
+ */
+export async function findAllCards(
+  commands: CommandManager,
+  options?: TreeOptions,
+): ReturnType<typeof allCards> {
+  return allCards(commands, options);
 }
-
-export async function getAllAttachments(commands: CommandManager) {
+/**
+ * Gets all attachments that are required for rendering the wanted cards
+ * @param commands the command manager used for the query
+ * @param options optional tree query options
+ * @returns all attachments for cards returned by the tree query
+ */
+export async function findRelevantAttachments(
+  commands: CommandManager,
+  options?: TreeOptions,
+) {
+  const cards = new Set<string>(
+    (await allCards(commands, options)).map((c) => c.key),
+  );
   const attachments = await commands.showCmd.showAttachments();
-  return attachments.map((attachment) => ({
-    key: attachment.card,
-    attachment: attachment.fileName,
-  }));
+  return attachments
+    .filter(
+      (attachment) =>
+        cards.has(attachment.card) && attachment.mimeType?.startsWith('image/'),
+    )
+    .map((attachment) => ({
+      key: attachment.card,
+      attachment: attachment.fileName,
+    }));
 }

package/src/domain/labels/index.ts

@@ -0,0 +1,36 @@
+/**
+  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 labelsService from './service.js';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/labels:
+ *   get:
+ *     summary: Returns all unique labels defined in the project.
+ *     responses:
+ *       200:
+ *        description: List of label strings.
+ *       500:
+ *         description: Internal server error
+ */
+router.get('/', (c) => {
+  const commands = c.get('commands');
+  const labels = labelsService.getLabels(commands);
+  return c.json(labels);
+});
+
+export default router;

package/src/domain/labels/service.ts

@@ -0,0 +1,23 @@
+/**
+  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';
+
+/**
+ * Returns all unique labels available in the project.
+ * @param commands command manager used for the query
+ * @returns a list of labels
+ */
+export function getLabels(commands: CommandManager): string[] {
+  return commands.showCmd.showLabels().sort();
+}

package/src/domain/resources/index.ts

@@ -13,10 +13,7 @@
 
 import { Hono } from 'hono';
 import * as resourceService from './service.js';
-import type {
-  ResourceFileContentResponse,
-  ResourceValidationResponse,
-} from '../../types.js';
+import type { ResourceValidationResponse } from '../../types.js';
 import { resourceParamsSchema } from '../../common/validationSchemas.js';
 import { zValidator } from '../../middleware/zvalidator.js';
 import {
@@ -118,41 +115,6 @@ router.get(
   },
 );
 
-router.get('/:module/:type/:resource/:file', async (c) => {
-  const commands = c.get('commands');
-  const { module, type, resource, file } = c.req.param();
-  const content = await resourceService.getFileContent(
-    commands,
-    module,
-    type,
-    resource,
-    file,
-  );
-  const response: ResourceFileContentResponse = { content };
-  return c.json(response);
-});
-
-router.put('/:module/:type/:resource/:file', async (c) => {
-  const commands = c.get('commands');
-  const { module, type, resource, file } = c.req.param();
-  const changedContent = await c.req.json();
-  if (
-    changedContent.content === undefined ||
-    typeof changedContent.content !== 'string'
-  ) {
-    return c.json({ error: 'Content is required' }, 400);
-  }
-  await resourceService.updateFile(
-    commands,
-    module,
-    type,
-    resource,
-    file,
-    changedContent.content,
-  );
-  return c.json({ content: changedContent.content });
-});
-
 router.delete(
   '/:prefix/:type/:identifier',
   zValidator('param', resourceParamsSchema),
@@ -173,12 +135,12 @@ router.post(
   async (c) => {
     const commands = c.get('commands');
     const resourceParams = c.req.valid('param');
-    const { key, operation } = c.req.valid('json');
+    const { updateKey, operation } = c.req.valid('json');
 
     await resourceService.updateResourceWithOperation(
       commands,
       resourceParams,
-      { key, operation },
+      { updateKey, operation },
     );
     return c.json({ message: 'Updated' });
   },

package/src/domain/resources/schema.ts

@@ -18,9 +18,21 @@ export type ValidateResourceParams = z.infer<
   typeof validateResourceParamsSchema
 >;
 
+const updateKey = z.union([
+  z.object({
+    key: z.literal('content'),
+    subKey: z.string(),
+  }),
+  z.object({
+    key: z.string().refine((k) => k !== 'content', {
+      message: 'key cannot be "content" here',
+    }),
+  }),
+]);
+
 // Body schema for update operation-based resource update
 export const updateOperationBodySchema = z.object({
-  key: z.string(),
+  updateKey,
   operation: z.discriminatedUnion('name', [
     z.object({
       name: z.literal('add'),

package/src/domain/resources/service.ts

@@ -11,9 +11,10 @@
   License along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
-import type { ResourceContent } from '@cyberismo/data-handler/interfaces/resource-interfaces';
+import type { AnyResourceContent } from '@cyberismo/data-handler/interfaces/resource-interfaces';
 import type {
   Card,
+  CardWithChildrenCards,
   ResourceFolderType,
   RemovableResourceTypes,
 } from '@cyberismo/data-handler/interfaces/project-interfaces';
@@ -137,7 +138,7 @@ async function createResourceNode(
   id: string;
   type: ResourceFolderType;
   name: string;
-  data: ResourceContent | undefined;
+  data: AnyResourceContent | undefined;
   children?: unknown[];
   readOnly?: boolean;
 }> {
@@ -146,7 +147,7 @@ async function createResourceNode(
     id: string;
     type: ResourceFolderType;
     name: string;
-    data: ResourceContent | undefined;
+    data: AnyResourceContent | undefined;
     children?: unknown[];
     readOnly?: boolean;
   } = {
@@ -158,18 +159,26 @@ async function createResourceNode(
   };
 
   // Add file children for folder resources
-  if (isResourceFolderType(resourceType) && resourceType !== 'templates') {
+  if (
+    isResourceFolderType(resourceType) &&
+    resourceType !== 'templates' &&
+    'content' in resourceData!
+  ) {
     try {
-      const fileNames = await commands.showCmd.showFileNames(
-        resourceName(name),
+      const fileNodes = Object.entries(resourceData.content).map(
+        ([fileName, content]) => ({
+          id: `${resourceType}-${name}-${fileName}`,
+          type: 'file',
+          name: `${name}/${fileName}`,
+          resourceName: name,
+          fileName,
+          displayName: fileName,
+          data: {
+            content,
+          },
+          readOnly: resourceName(name).prefix !== projectPrefix,
+        }),
       );
-      const fileNodes = fileNames.map((fileName: string) => ({
-        id: `${resourceType}-${name}-${fileName}`,
-        type: 'file',
-        name: `${name}/${fileName}`,
-        displayName: fileName,
-        readOnly: resourceName(name).prefix !== projectPrefix,
-      }));
 
       node.children = children ? [...children, ...fileNodes] : fileNodes;
     } catch (error) {
@@ -184,12 +193,12 @@ async function createResourceNode(
 
 // Helper function to recursively create card nodes with children
 function createCardNode(
-  card: Card,
+  card: CardWithChildrenCards,
   module: string,
   projectPrefix: string,
 ): unknown {
   // Destructure to separate children from other card data
-  const { children, ...cardData } = card;
+  const { childrenCards, ...cardData } = card;
 
   const cardNode: {
     id: string;
@@ -208,8 +217,8 @@ function createCardNode(
   };
 
   // Recursively process children if they exist
-  if (children && children.length > 0) {
-    cardNode.children = children.map((child) =>
+  if (childrenCards && childrenCards.length > 0) {
+    cardNode.children = childrenCards.map((child) =>
       createCardNode(child, module, projectPrefix),
     );
   }
@@ -368,54 +377,6 @@ export async function deleteResource(
   );
 }
 
-/**
- * Get the content of a file in a resource.
- * @param commands Command manager.
- * @param module Name of the module.
- * @param type Name of the type.
- * @param resource Name of the resource.
- * @param fileName Name of the file.
- * @returns The content of the file.
- */
-export async function getFileContent(
-  commands: CommandManager,
-  module: string,
-  type: string,
-  resource: string,
-  fileName: string,
-) {
-  // TODO: Use resource APIs to fetch resource content; showFile will be removed
-  return commands.showCmd.showFile(
-    resourceName(`${module}/${type}/${resource}`),
-    fileName,
-  );
-}
-
-/**
- * Update a file of a folder resource. Cannot be used to create a new file.
- * @param commands Command manager.
- * @param module Name of the module.
- * @param type Name of the type.
- * @param resource Name of the resource.
- * @param fileName Name of the file.
- * @param changedContent The new content for the file.
- * @returns The updated file content.
- */
-export async function updateFile(
-  commands: CommandManager,
-  module: string,
-  type: string,
-  resource: string,
-  fileName: string,
-  changedContent: string,
-) {
-  return commands.editCmd.editResourceContent(
-    resourceName(`${module}/${type}/${resource}`),
-    fileName,
-    changedContent,
-  );
-}
-
 /**
  * Validate a single resource.
  * @param commands Command manager.
@@ -445,10 +406,10 @@ export async function updateResourceWithOperation(
   resource: ResourceParams,
   body: UpdateOperationBody,
 ) {
-  const { key, operation } = body;
+  const { updateKey, operation } = body;
   await commands.updateCmd.applyResourceOperation(
     resourceNameToString(resource),
-    key,
+    updateKey,
     operation,
   );
 }

package/src/domain/templates/index.ts

@@ -12,10 +12,10 @@
 */
 
 import { Hono } from 'hono';
-import { isSSGContext } from '../../export.js';
 import * as templateService from './service.js';
 import { createTemplateSchema, addTemplateCardSchema } from './schema.js';
 import { zValidator } from '../../middleware/zvalidator.js';
+import { isSSGContext } from 'hono/ssg';
 
 const router = new Hono();
 

package/src/domain/tree/index.ts

@@ -13,7 +13,8 @@
 
 import { Hono } from 'hono';
 import * as treeService from './service.js';
-import { isSSGContext } from '../../export.js';
+import { isSSGContext } from 'hono/ssg';
+import type { AppContext } from '../../types.js';
 
 const router = new Hono();
 
@@ -31,11 +32,17 @@ const router = new Hono();
  *       500:
  *         description: project_path not set or other internal error
  */
-router.get('/', async (c) => {
+router.get('/', async (c: AppContext) => {
   const commands = c.get('commands');
+  const tree = c.get('tree');
 
   try {
-    const response = await treeService.getCardTree(commands, isSSGContext(c));
+    const response = await treeService.getCardTree(
+      commands,
+      isSSGContext(c),
+      tree?.cardKey,
+      tree?.recursive,
+    );
     return c.json(response);
   } catch (error) {
     return c.json(

package/src/domain/tree/service.ts

@@ -13,10 +13,24 @@
 
 import type { CommandManager } from '@cyberismo/data-handler';
 
-export async function getCardTree(commands: CommandManager, isSsg: boolean) {
+/**
+ * Returns the card tree of the project
+ * @param commands command manager used for the query
+ * @param isSsg whether the context is static site generation
+ * @param cardKey optional card key to start the tree from
+ * @param recursive if false, includes only the given card. Otherwise, includes all child cards recursively.
+ * @returns
+ */
+export async function getCardTree(
+  commands: CommandManager,
+  isSsg: boolean,
+  cardKey?: string,
+  recursive?: boolean,
+): ReturnType<typeof commands.calculateCmd.runQuery> {
   await commands.calculateCmd.generate();
   return commands.calculateCmd.runQuery(
     'tree',
     isSsg ? 'exportedSite' : 'localApp',
+    { cardKey, recursive },
   );
 }