feat: api modelling base (#1)

Base design for the intended REST api functions

jest.config.js

@@ -1,4 +1,4 @@
 module.exports = {
   preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+  testEnvironment: 'node'
+};

nodemon.json

@@ -2,4 +2,4 @@
   "watch": ["src"],
   "ext": "ts",
   "exec": "node --inspect -r ts-node/register ./src/server.ts"
-}
+}

readme-typescript-nodejs.md

@@ -1,4 +1,4 @@
-# typescript-nodejs 
+# typescript-nodejs
 
 Requirements: node.js >= 18.15.0 ( LTS )
 
@@ -14,4 +14,4 @@ Template for TypeScript nodejs projects. It includes:
 
 1. Update package.json with your project details
 2. Install dependencies with `npm install`
-3. Start coding!
+3. Start coding!

src/api.ts

@@ -14,7 +14,11 @@ export interface HealthcheckOptions {
   title: string;
 }
 
-const healthcheck: FastifyPluginCallback<HealthcheckOptions> = (fastify, opts, next) => {
+const healthcheck: FastifyPluginCallback<HealthcheckOptions> = (
+  fastify,
+  opts,
+  next
+) => {
   fastify.get<{ Reply: Static<typeof HelloWorld> }>(
     '/',
     {
@@ -62,4 +66,4 @@ export default (opts: ApiOptions) => {
   // register other API routes here
 
   return api;
-}
+};

src/api_productions.ts

@@ -0,0 +1,123 @@
+import { Type } from '@sinclair/typebox';
+import { FastifyPluginCallback, FastifyRequest } from 'fastify';
+import { NewProduction, Production, SdpOffer, SdpAnswer } from './models';
+
+const apiProductions: FastifyPluginCallback = (fastify, opts, next) => {
+  fastify.post<{
+    Body: typeof NewProduction;
+    Reply: typeof Production;
+  }>(
+    '/production',
+    {
+      schema: {
+        description: 'Create a new Production resource.',
+        body: NewProduction,
+        response: {
+          200: Production
+        }
+      }
+    },
+    async (request, reply) => {
+      try {
+        //prod = new Production(name, [line1, line2, line3])
+        //Production construction will make calls to smb and set up each line.
+      } catch (err) {
+        //error handling
+      }
+    }
+  );
+
+  fastify.get<{
+    Params: { id: string };
+    Reply: any;
+  }>(
+    '/production',
+    {
+      schema: {
+        description: 'Retrieves all Production resource.',
+        response: {
+          200: Type.Array(Production)
+        }
+      }
+    },
+    async (request, reply) => {
+      try {
+        //request logic
+      } catch (err) {
+        //error handling
+      }
+    }
+  );
+
+  fastify.get<{
+    Params: { id: string };
+    Reply: any;
+  }>(
+    '/productions/:id',
+    {
+      schema: {
+        description: 'Retrieves a Production resource.',
+        response: {
+          200: Production
+        }
+      }
+    },
+    async (request, reply) => {
+      try {
+        //request logic
+      } catch (err) {
+        //error handling
+      }
+    }
+  );
+
+  fastify.delete<{
+    Params: { id: string };
+    Reply: string;
+  }>(
+    '/productions/:id',
+    {
+      schema: {
+        description: 'Delete a Production resource.',
+        response: {
+          200: Type.Object({
+            message: Type.Literal('removed')
+          })
+        }
+      }
+    },
+    async (request, reply) => {
+      try {
+        //request logic
+      } catch (err) {
+        //error handling
+      }
+    }
+  );
+
+  fastify.post<{
+    Params: { id: string; name: string };
+    Body: typeof SdpOffer;
+    Reply: typeof SdpAnswer;
+  }>(
+    '/productions/:id/lines/:name',
+    {
+      schema: {
+        description: 'Join a Production line.',
+        body: SdpOffer,
+        response: {
+          200: SdpAnswer
+        }
+      }
+    },
+    async (request, reply) => {
+      try {
+        //Generate SDP, and anything other information required to set up a connection.
+      } catch (err) {
+        //error handling
+      }
+    }
+  );
+
+  next();
+};