@gnar-engine/cli 1.0.3 → 1.0.5

package/bootstrap/services/page/src/controllers/message.controller.js

@@ -0,0 +1,51 @@
+import { commands } from '@gnar-engine/core';
+
+export const messageHandlers = {
+
+    getPage: async (payload) => {
+        let result;
+        if (payload.data?.id) {
+            result = await commands.execute('getSinglePage', {
+                id: payload.data.id
+            });
+        } else if (payload.data?.email) {
+            result = await commands.execute('getSinglePage', {
+                email: payload.data.email
+            });
+        } else {
+            throw new Error('No page ID or email provided');
+        }
+        if (!result) {
+            throw new Error('Page not found');
+        }
+        return { page: result };
+    },
+
+    getManyPages: async (payload) => {
+        const results = await commands.execute('getManyPages', {});
+        return { pages: results };
+    },
+
+    createPage: async (payload) => {
+        const results = await commands.execute('createPages', {
+            pages: [payload.data.page]
+        });
+        return { pages: results };
+    },
+
+    updatePage: async (payload) => {
+        const result = await commands.execute('updatePage', {
+            id: payload.data.id,
+            newPageData: payload.data
+        });
+        return { page: result };
+    },
+
+    deletePage: async (payload) => {
+        await commands.execute('deletePage', {
+            id: payload.data.id
+        });
+        return { message: 'Page deleted' };
+    },
+
+};

package/bootstrap/services/page/src/controllers/page.http.controller.js

@@ -0,0 +1,89 @@
+import { commands } from '@gnar-engine/core';
+import { authorise } from '../policies/page.policy.js';
+
+/**
+ * HTTP controller
+ */
+export const httpController = {
+
+	/**
+	 * Get single page
+	 */
+	getSingle: {
+		method: 'GET',
+		url: '/pages/:id',
+		preHandler: async (request, reply) => authorise.getSingle(request, reply),
+		handler: async (request, reply) => {
+			const params = {
+				id: request.params.id
+			};
+			const result = await commands.execute('getSinglePage', params);
+			reply.code(200).send({ page: result });
+		}
+	},
+
+	/**
+	 * Get multiple pages
+	 */
+	getMany: {
+		method: 'GET',
+		url: '/pages/',
+		preHandler: async (request, reply) => authorise.getMany(request, reply),
+		handler: async (request, reply) => {
+			const params = {};
+			const results = await commands.execute('getManyPages', params);
+			reply.code(200).send({ pages: results });
+		}
+	},
+
+	/**
+	 * Create new page
+	 */
+	create: {
+		method: 'POST',
+		url: '/pages/',
+		preHandler: async (request, reply) => authorise.create(request, reply),
+		handler: async (request, reply) => {
+			const params = {
+				pages: [request.body.page],
+                requestUser: request.user
+			};
+			const results = await commands.execute('createPages', params);
+			reply.code(200).send({ pages: results });
+		},
+	},
+
+	/**
+	 * Update page
+	 */
+	update: {
+		method: 'POST',
+		url: '/pages/:id',
+		preHandler: async (request, reply) => authorise.update(request, reply),
+		handler: async (request, reply) => {
+			const params = {
+				id: request.params.id,
+				newPageData: request.body.page,
+                requestUser: request.user
+			};
+			const result = await commands.execute('updatePage', params);
+			reply.code(200).send({ page: result });
+		},
+	},
+
+	/**
+	 * Delete page
+	 */
+	delete: {
+		method: 'DELETE',
+		url: '/pages/:id',
+		preHandler: async (request, reply) => authorise.delete(request, reply),
+		handler: async (request, reply) => {
+			const params = {
+				id: request.params.id
+			};
+			await commands.execute('deletePage', params);
+			reply.code(200).send({ message: 'Page deleted' });
+		},
+	},
+}

package/bootstrap/services/page/src/policies/block.policy.js

@@ -0,0 +1,50 @@
+import { config } from '../config.js';
+
+export const authorise = {
+
+    /**
+     * Authorise get single block
+     */
+    getSingle: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise get many blocks
+     */
+    getMany: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise create blocks
+     */
+    create: async (request, reply) => {
+        console.log('request user', request.user);
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise update block
+     */
+    update: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise delete block
+     */
+    delete: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    }
+}

package/bootstrap/services/page/src/policies/page.policy.js

@@ -0,0 +1,49 @@
+import { config } from '../config.js';
+
+export const authorise = {
+
+    /**
+     * Authorise get single page
+     */
+    getSingle: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise get many pages
+     */
+    getMany: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise create pages
+     */
+    create: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise update page
+     */
+    update: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    },
+
+    /**
+     * Authorise delete page
+     */
+    delete: async (request, reply) => {
+        if (!request.user || request.user.role !== 'service_admin') {
+            reply.code(403).send({error: 'not authorised'});
+        }
+    }
+}

package/bootstrap/services/page/src/schema/page.schema.js

@@ -0,0 +1,139 @@
+import { schema } from '@gnar-engine/core';
+import { config } from '../config.js';
+
+export const pageSchema = {
+    schemaName: 'pageService.pageSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            name: { type: 'string' },
+            key: { type: 'string' },
+            blocks: {
+                type: 'array',
+                items: { $ref: 'pageService.blockSchema' }
+            }
+        },
+        required: ['name', 'key'],
+        additionalProperties: false
+    }
+};
+
+export const blockSchema  = {
+    $id: 'pageService.blockSchema',
+    schemaName: 'pageService.blockSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            name: { type: 'string' },
+            key: { type: 'string' },
+            blocks: {
+                type: 'array',
+                items: { $ref: 'pageService.blockSchema' }
+            },
+            fields: {
+                type: 'array',
+                items: { 
+                    oneOf: [
+                        { $ref: 'pageService.textInputSchema' },
+                        { $ref: 'pageService.richTextSchema' },
+                        { $ref: 'pageService.imageSchema' },
+                        { $ref: 'pageService.blockSchema' },
+                        { $ref: 'pageService.repeaterSchema' }
+                    ]
+                }
+            },
+            type: { type: 'string', enum: ['block'] },
+            instanceId: { type: 'string' }
+        },
+        required: ['name', 'key'],
+        additionalProperties: false
+    }
+}
+
+export const textInputSchema = {
+    $id: 'pageService.textInputSchema',
+    schemaName: 'pageService.textInputSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            key: { type: 'string' },
+            name: { type: 'string' },
+            type: { type: 'string', enum: ['text'] },
+            value: { type: 'string' }
+        },
+        required: ['key', 'type'],
+        additionalProperties: false
+    }
+}
+
+export const richTextSchema = {
+    $id: 'pageService.richTextSchema',
+    schemaName: 'pageService.richTextSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            key: { type: 'string' },
+            name: { type: 'string' },
+            type: { type: 'string', enum: ['richtext'] },
+            value: { type: 'string' }
+        },
+        required: ['key', 'type'],
+        additionalProperties: false
+    }
+}
+
+export const imageSchema = {
+    $id: 'pageService.imageSchema',
+    schemaName: 'pageService.imageSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            key: { type: 'string' },
+            name: { type: 'string' },
+            type: { type: 'string', enum: ['image'] },
+            value: {
+                type: 'object',
+                properties: {
+                    file: { type: 'string' },
+                    mimeType: { type: 'string' },
+                    fileName: { type: 'string' },
+                    url: { type: 'string' }
+                }
+            },
+            altText: { type: 'string' }
+        },
+        required: ['key', 'type'],
+        additionalProperties: false
+    }
+}
+
+export const repeaterSchema = {
+    $id: 'pageService.repeaterSchema',
+    schemaName: 'pageService.repeaterSchema',
+    schema: {
+        type: 'object',
+        properties: {
+            key: { type: 'string' },
+            name: { type: 'string' },
+            type: { type: 'string', enum: ['repeater'] },
+            repeaterType: { type: 'string' },
+            value: { 
+                type: 'array',
+                items: {
+                    $ref: 'pageService.blockSchema'
+                },
+            }
+        },
+        required: ['key', 'type', 'repeaterType'],
+        additionalProperties: false
+    }
+}
+
+schema.addSchema(blockSchema);
+schema.addSchema(textInputSchema);
+schema.addSchema(richTextSchema);
+schema.addSchema(imageSchema);
+schema.addSchema(repeaterSchema);
+
+export const validatePage = schema.compile(pageSchema);
+export const validateBlock = schema.compile(blockSchema);

package/bootstrap/services/page/src/services/block.service.js

@@ -0,0 +1,83 @@
+import { db, logger } from '@gnar-engine/core';
+import { ObjectId } from 'mongodb';
+
+export const block = {
+
+    // Get all blocks
+    getAll: async () => {
+        try {
+            const items = await db.collection('blocks').find().toArray();
+            return items.map(mappings);
+        } catch (error) {
+            logger.error("Error fetching blocks:", error);
+            throw error;
+        }
+    },
+
+    // Create a block
+    create: async (data) => {
+        try {
+            const collection = db.collection('blocks');
+            const result = await collection.insertOne(data);
+            const insterted = await collection.findOne({ _id: result.insertedId });
+            return mappings(insterted);
+        } catch (error) {
+            logger.error("Error creating block:", error);
+            throw error;
+        }
+    },
+
+    // Get a block by ID
+    getById: async ({ id }) => {
+        try {
+            const collection = db.collection('blocks');
+            const objectId = new ObjectId(id);
+            const item = await collection.findOne({ _id: objectId });
+            return mappings(item);
+        } catch (error) {
+            logger.error("Error fetching block:", error);
+            throw error;
+        }
+    },
+
+    // Update a block
+    update: async ({ id, updatedData }) => {
+        try {
+            const collection = db.collection('blocks');
+            const objectId = new ObjectId(id);
+            const result = await collection.updateOne(
+                { _id: objectId },
+                { $set: updatedData }
+            );
+            return result.modifiedCount > 0;
+        } catch (error) {
+            logger.error("Error updating block:", error);
+            throw error;
+        }
+    },
+
+    // Delete a block
+    delete: async ({ id }) => {
+        try {
+            const collection = db.collection('blocks');
+            const objectId = new ObjectId(id);
+            const result = await collection.deleteOne({ _id: objectId });
+            return result.deletedCount > 0;
+        } catch (error) {
+            logger.error("Error deleting block:", error);
+            throw error;
+        }
+    }
+};
+
+const mappings = (item) => {
+    if (!item) {
+        return item;
+    }
+
+    // _id -> id
+    const { _id, ...rest } = item;
+    item = { id: _id.toString(), ...rest };
+    
+    return item;
+}

package/bootstrap/services/page/src/services/page.service.js

@@ -0,0 +1,83 @@
+import { db, logger } from '@gnar-engine/core';
+import { ObjectId } from 'mongodb';
+
+export const page = {
+
+    // Get all pages
+    getAll: async () => {
+        try {
+            const items = await db.collection('pages').find().toArray();
+            return items.map(mappings);
+        } catch (error) {
+            logger.error("Error fetching pages:", error);
+            throw error;
+        }
+    },
+
+    // Create a page
+    create: async (data) => {
+        try {
+            const collection = db.collection('pages');
+            const result = await collection.insertOne(data);
+            const insterted = await collection.findOne({ _id: result.insertedId });
+            return mappings(insterted);
+        } catch (error) {
+            logger.error("Error creating page:", error);
+            throw error;
+        }
+    },
+
+    // Get a page by ID
+    getById: async ({ id }) => {
+        try {
+            const collection = db.collection('pages');
+            const objectId = new ObjectId(id);
+            const item = await collection.findOne({ _id: objectId });
+            return mappings(item);
+        } catch (error) {
+            logger.error("Error fetching page:", error);
+            throw error;
+        }
+    },
+
+    // Update a page
+    update: async ({ id, updatedData }) => {
+        try {
+            const collection = db.collection('pages');
+            const objectId = new ObjectId(id);
+            const result = await collection.updateOne(
+                { _id: objectId },
+                { $set: updatedData }
+            );
+            return result.modifiedCount > 0;
+        } catch (error) {
+            logger.error("Error updating page:", error);
+            throw error;
+        }
+    },
+
+    // Delete a page
+    delete: async ({ id }) => {
+        try {
+            const collection = db.collection('pages');
+            const objectId = new ObjectId(id);
+            const result = await collection.deleteOne({ _id: objectId });
+            return result.deletedCount > 0;
+        } catch (error) {
+            logger.error("Error deleting page:", error);
+            throw error;
+        }
+    }
+};
+
+const mappings = (item) => {
+    if (!item) {
+        return item;
+    }
+
+    // _id -> id
+    const { _id, ...rest } = item;
+    item = { id: _id.toString(), ...rest };
+    
+    return item;
+}

package/bootstrap/services/portal/Dockerfile

@@ -1,23 +1,20 @@
-# Dockerfile for Portal Service
+# Dockerfile for Control Service
 FROM node:20-alpine
 
 # Set the working directory
 WORKDIR /usr/gnar_engine/app
 
-# Copy package.json and package-lock.json
-COPY ./services/portal/package*.json ./
-
-# Copy public directory
-COPY ./services/portal/public ./public
+# Define a global env var
+ENV GLOBAL_SERVICE_BASE_DIR=/usr/gnar_engine/app/src/
 
-# Copy local Lib packages
-COPY ./Lib ./Lib
+# Copy package.json and package-lock.json
+COPY ./services/portal/ ./
 
 # Install app dependencies
 RUN npm install
 
 # Expose the port the service will run on
-EXPOSE 3000
+EXPOSE 5173
 
 # Start the application
-CMD ["npm", "run", "start"]
+CMD ["npm", "run", "start:dev"]

package/bootstrap/services/portal/README.md

@@ -1,22 +1,73 @@
-# School Consultancy Programme - Front End
+# React + TypeScript + Vite
 
-React application for student tracking.
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
 
-### Deploy
+Currently, two official plugins are available:
 
-Build application locally and deploy with scp. Production server SSH access required.
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
 
-``` bash
-    # Checkout local production branch
-    git branch checkout production
+## React Compiler
 
-    # Build
-    npm run build-style
-    npm run build
+The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
 
-    # Deploy
-    npm run deploy
+## Expanding the ESLint configuration
 
-    # Clear production caches
-    
-``` 
+If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+
+```js
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+
+      // Remove tseslint.configs.recommended and replace with this
+      tseslint.configs.recommendedTypeChecked,
+      // Alternatively, use this for stricter rules
+      tseslint.configs.strictTypeChecked,
+      // Optionally, add this for stylistic rules
+      tseslint.configs.stylisticTypeChecked,
+
+      // Other configs...
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```
+
+You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+
+```js
+// eslint.config.js
+import reactX from 'eslint-plugin-react-x'
+import reactDom from 'eslint-plugin-react-dom'
+
+export default defineConfig([
+  globalIgnores(['dist']),
+  {
+    files: ['**/*.{ts,tsx}'],
+    extends: [
+      // Other configs...
+      // Enable lint rules for React
+      reactX.configs['recommended-typescript'],
+      // Enable lint rules for React DOM
+      reactDom.configs.recommended,
+    ],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.node.json', './tsconfig.app.json'],
+        tsconfigRootDir: import.meta.dirname,
+      },
+      // other options...
+    },
+  },
+])
+```

package/bootstrap/services/portal/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>portal</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>