@cyberismo/backend 0.0.3

package/dist/routes/fieldTypes.js

@@ -0,0 +1,40 @@
+/**
+    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 { Hono } from 'hono';
+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');
+    const response = await commands.showCmd.showResources('fieldTypes');
+    if (response) {
+        const fieldTypes = await Promise.all(response.map((fieldType) => commands.showCmd.showResource(fieldType)));
+        return c.json(fieldTypes);
+    }
+    else {
+        return c.text(`No field types found from path ${c.get('projectPath')}`, 500);
+    }
+});
+export default router;
+//# sourceMappingURL=fieldTypes.js.map

package/dist/routes/fieldTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldTypes.js","sourceRoot":"","sources":["../../src/routes/fieldTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;AAE1B;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IACpE,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,GAAG,CAClC,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAiB,EAAE,EAAE,CACjC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CACzC,CACF,CAAC;QAEF,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC,IAAI,CACX,kCAAkC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,EACxD,GAAG,CACJ,CAAC;IACJ,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,MAAM,CAAC"}

package/dist/routes/linkTypes.js

@@ -0,0 +1,40 @@
+/**
+    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 { Hono } from 'hono';
+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.
+ *       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');
+    const response = await commands.showCmd.showResources('linkTypes');
+    if (response) {
+        const linkTypes = await Promise.all(response.map((linkType) => commands.showCmd.showResource(linkType)));
+        return c.json(linkTypes);
+    }
+    else {
+        return c.text(`No link types found from path ${c.get('projectPath')}`, 500);
+    }
+});
+export default router;
+//# sourceMappingURL=linkTypes.js.map

package/dist/routes/linkTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linkTypes.js","sourceRoot":"","sources":["../../src/routes/linkTypes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;AAE1B;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IACnE,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CACjC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAgB,EAAE,EAAE,CAChC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CACxC,CACF,CAAC;QAEF,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,MAAM,CAAC"}

package/dist/routes/templates.js

@@ -0,0 +1,39 @@
+/**
+    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 { Hono } from 'hono';
+const router = new Hono();
+/**
+ * @swagger
+ * /api/templates:
+ *   get:
+ *     summary: Returns a list of all templates in the defined project.
+ *     description: List of templates includes only the names of the templates in the project.
+ *     responses:
+ *       200:
+ *        description: Array containing the names of the project templates.
+ *       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');
+    const response = await commands.showCmd.showTemplatesWithDetails();
+    if (response) {
+        return c.json(response);
+    }
+    else {
+        return c.text(`No templates found from path ${c.get('projectPath')}`, 500);
+    }
+});
+export default router;
+//# sourceMappingURL=templates.js.map

package/dist/routes/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/routes/templates.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;AAE1B;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAEnC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;IACnE,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,MAAM,CAAC"}

package/dist/routes/tree.js

@@ -0,0 +1,38 @@
+/**
+    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 { Hono } from 'hono';
+const router = new Hono();
+/**
+ * @swagger
+ * /api/tree
+ *   get:
+ *     summary: Returns everything required by treeview
+ *     description: Returns the query result
+ *     responses:
+ *       200:
+ *        description: Object containing the query result
+ *       500:
+ *         description: project_path not set or other internal error
+ */
+router.get('/', async (c) => {
+    const commands = c.get('commands');
+    try {
+        await commands.calculateCmd.generate();
+        const tree = await commands.calculateCmd.runQuery('tree');
+        return c.json(tree);
+    }
+    catch (e) {
+        return c.text((e instanceof Error && e.message) || '', 500);
+    }
+});
+export default router;
+//# sourceMappingURL=tree.js.map

package/dist/routes/tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../src/routes/tree.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;AAE1B;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;IAC1B,MAAM,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACvC,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC,CAAC,CAAC;AAEH,eAAe,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@cyberismo/backend",
+  "version": "0.0.3",
+  "description": "Express backend for Cyberismo",
+  "main": "dist/index.js",
+  "keywords": [],
+  "author": "",
+  "license": "AGPL-3.0",
+  "dependencies": {
+    "@asciidoctor/core": "^3.0.4",
+    "@hono/node-server": "^1.14.1",
+    "dotenv": "^16.5.0",
+    "hono": "^4.7.5",
+    "@cyberismo/data-handler": "0.0.3"
+  },
+  "devDependencies": {
+    "@cyberismo/app": "0.0.2"
+  },
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "start": "node dist/main.js",
+    "dev": "tsx watch src/main.ts",
+    "build": "tsc -p tsconfig.build.json && shx rm -rf ./dist/public && shx cp -r ../app/dist ./dist/public",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1,121 @@
+import { serve } from '@hono/node-server';
+import { Hono } from 'hono';
+import { cors } from 'hono/cors';
+import { serveStatic } from '@hono/node-server/serve-static';
+import path from 'node:path';
+import { createServer } from 'node:net';
+
+import { attachCommandManager } from './middleware/commandManager.js';
+
+// Import routes
+import cardsRouter from './routes/cards.js';
+import cardTypesRouter from './routes/cardTypes.js';
+import fieldTypesRouter from './routes/fieldTypes.js';
+import linkTypesRouter from './routes/linkTypes.js';
+import templatesRouter from './routes/templates.js';
+import treeRouter from './routes/tree.js';
+
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+
+const filename = fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+
+export function createApp(projectPath?: string) {
+  const app = new Hono();
+
+  app.use('/api', cors());
+
+  app.use(
+    '*',
+    serveStatic({
+      root: path.relative(process.cwd(), path.resolve(dirname, 'public')),
+    }),
+  );
+
+  // Attach CommandManager to all requests
+  app.use(attachCommandManager(projectPath));
+
+  // Wire up routes
+  app.route('/api/cards', cardsRouter);
+  app.route('/api/cardTypes', cardTypesRouter);
+  app.route('/api/fieldTypes', fieldTypesRouter);
+  app.route('/api/linkTypes', linkTypesRouter);
+  app.route('/api/templates', templatesRouter);
+  app.route('/api/tree', treeRouter);
+
+  // serve index.html for all other routes
+  app.notFound(async (c) => {
+    if (c.req.path.startsWith('/api')) {
+      return c.text('Not Found', 400);
+    }
+    const file = await readFile(path.join(dirname, 'public', 'index.html'));
+    return c.html(file.toString());
+  });
+  // Error handling
+  app.onError((err, c) => {
+    console.error(err.stack);
+    return c.text('Internal Server Error', 500);
+  });
+
+  return app;
+}
+
+export async function startServer(
+  projectPath?: string,
+  findPort: boolean = true,
+) {
+  let port = parseInt(process.env.PORT || '3000', 10);
+
+  if (findPort) {
+    port = await findFreePort(port);
+  }
+
+  const app = createApp(projectPath);
+  // Start server
+  serve(
+    {
+      fetch: app.fetch,
+      port: Number(port),
+    },
+    (info) => {
+      console.log(`Running Cyberismo app on http://localhost:${info.port}`);
+      console.log('Press Control+C to stop.');
+    },
+  );
+}
+
+async function findFreePort(
+  port: number,
+  maxAttempts: number = 100,
+): Promise<number> {
+  for (let i = port; i < port + maxAttempts; i++) {
+    try {
+      await testPort(i);
+      return i;
+    } catch (err) {
+      if (err instanceof Error && err.message.includes('EADDRINUSE')) {
+        console.log(`Port ${i} is already in use, trying next port...`);
+      } else {
+        throw err;
+      }
+    }
+  }
+  throw new Error('Failed to find free port');
+}
+
+function testPort(port: number) {
+  return new Promise((resolve, reject) => {
+    const server = createServer();
+    server.listen(port, () => {
+      server.close();
+      resolve(true);
+    });
+    server.on('error', (err) => {
+      reject(err);
+    });
+    setTimeout(() => {
+      reject(new Error('Timed out waiting for port to be free'));
+    }, 2000);
+  });
+}

package/src/main.ts

@@ -0,0 +1,7 @@
+import { startServer } from './index.js';
+import dotenv from 'dotenv';
+
+// Load environment variables from .env file
+dotenv.config();
+
+startServer(process.env.npm_config_project_path);

package/src/middleware/commandManager.ts

@@ -0,0 +1,43 @@
+/**
+    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 { Context, MiddlewareHandler } from 'hono';
+import { CommandManager } from '@cyberismo/data-handler';
+
+// Extend Hono Context type to include our custom properties
+declare module 'hono' {
+  interface ContextVariableMap {
+    commands: CommandManager;
+    projectPath: string;
+  }
+}
+
+export const attachCommandManager = (
+  projectPath?: string,
+): MiddlewareHandler => {
+  return async (c: Context, next) => {
+    if (!projectPath) {
+      return c.text('project_path environment variable not set.', 500);
+    }
+
+    try {
+      c.set('commands', await CommandManager.getInstance(projectPath));
+      c.set('projectPath', projectPath);
+      await next();
+    } catch (error) {
+      return c.text(
+        `Failed to initialize CommandManager: ${error instanceof Error ? error.message : 'Unknown error'}`,
+        500,
+      );
+    }
+  };
+};

package/src/routes/cardTypes.ts

@@ -0,0 +1,54 @@
+/**
+    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 { Hono } from 'hono';
+
+const router = new Hono();
+
+/**
+ * @swagger
+ * /api/cardTypes:
+ *   get:
+ *     summary: Returns the full content of a specific card type.
+ *     description: The key parameter is the unique identifier ("cardType") of the card type. The response includes the card type details.
+ *     parameters:
+ *       - name: name
+ *         in: query
+ *         required: true
+ *         description: name of card type, including path (such as /project/cardTypes/page)
+ *     responses:
+ *       200:
+ *        description: Object containing card type details. See definitions.ts/CardType 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');
+
+  // Card type name delivered in url parameter 'name' because it usually contains a path
+  const cardType = c.req.query('name');
+  if (!cardType) {
+    return c.text('No card type', 400);
+  }
+
+  const detailsResponse = await commands.showCmd.showResource(cardType);
+
+  if (detailsResponse) {
+    return c.json(detailsResponse);
+  } else {
+    return c.text(`No card type details found for ${cardType}`, 500);
+  }
+});
+
+export default router;