feat: add api server

Author: riccardoperra

apps/api/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

apps/api/.gitignore

@@ -0,0 +1,65 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# 0x
+profile-*
+
+# mac files
+.DS_Store
+
+# vim swap files
+*.swp
+
+# webstorm
+.idea
+
+# vscode
+.vscode
+*code-workspace
+
+# clinic
+profile*
+*clinic*
+*flamegraph*
+
+# generated code
+examples/typescript-server.js
+test/types/index.js
+
+# compiled app
+dist

apps/api/.lintstagedrc

@@ -0,0 +1,7 @@
+{
+  "*.{ts,tsx,js,jsx}": [
+    "pnpm lint",
+    "pnpm pre-commit-prettier",
+    "pnpm pre-commit-eslint"
+  ]
+}

apps/api/.taprc

@@ -0,0 +1,4 @@
+test-env: [
+  TS_NODE_FILES=true,
+  TS_NODE_PROJECT=./test/tsconfig.json
+]

apps/api/README.md

@@ -0,0 +1,24 @@
+# Getting Started with [Fastify-CLI](https://www.npmjs.com/package/fastify-cli)
+
+This project was bootstrapped with Fastify-CLI.
+
+## Available Scripts
+
+In the project directory, you can run:
+
+### `pnpm dev`
+
+To start the app in dev mode.\
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+
+### `pnpm start`
+
+For production mode
+
+### `pnpm test`
+
+Run the test cases.
+
+## Learn More
+
+To learn Fastify, check out the [Fastify documentation](https://www.fastify.io/docs/latest/).

apps/api/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@codeimage/api",
+  "version": "0.0.1",
+  "description": "This project was bootstrapped with Fastify-CLI.",
+  "main": "app.ts",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "npm run build:ts && tsc -p test/tsconfig.json && tap --ts \\\"test/**/*.test.ts\\\"",
+    "start": "npm run build:ts && fastify start -l info dist/app.js",
+    "build:ts": "tsc",
+    "watch:ts": "tsc -w",
+    "dev": "npm run build:ts && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"npm:watch:ts\" \"npm:dev:start\"",
+    "dev:start": "fastify start --ignore-watch=.ts$ -w -l info -P dist/app.js"
+  },
+  "keywords": [],
+  "author": "Riccardo Perra",
+  "license": "ISC",
+  "dependencies": {
+    "fastify": "^4.0.0",
+    "fastify-plugin": "^3.0.0",
+    "@fastify/autoload": "^5.0.0",
+    "@fastify/sensible": "^4.1.0",
+    "fastify-cli": "^4.4.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.0.0",
+    "@types/tap": "^15.0.5",
+    "ts-node": "^10.4.0",
+    "concurrently": "^7.0.0",
+    "fastify-tsconfig": "^1.0.1",
+    "tap": "^16.1.0",
+    "typescript": "^4.5.4"
+  }
+}

apps/api/src/app.ts

@@ -0,0 +1,34 @@
+import {join} from 'path';
+import AutoLoad, {AutoloadPluginOptions} from '@fastify/autoload';
+import {FastifyPluginAsync} from 'fastify';
+
+export type AppOptions = {
+  // Place your custom options for app below here.
+} & Partial<AutoloadPluginOptions>;
+
+const app: FastifyPluginAsync<AppOptions> = async (
+  fastify,
+  opts,
+): Promise<void> => {
+  // Place here your custom code!
+
+  // Do not touch the following lines
+
+  // This loads all plugins defined in plugins
+  // those should be support plugins that are reused
+  // through your application
+  void fastify.register(AutoLoad, {
+    dir: join(__dirname, 'plugins'),
+    options: opts,
+  });
+
+  // This loads all plugins defined in routes
+  // define your routes in one of these
+  void fastify.register(AutoLoad, {
+    dir: join(__dirname, 'routes'),
+    options: opts,
+  });
+};
+
+export default app;
+export {app};

apps/api/src/plugins/README.md

@@ -0,0 +1,16 @@
+# Plugins Folder
+
+Plugins define behavior that is common to all the routes in your
+application. Authentication, caching, templates, and all the other cross
+cutting concerns should be handled by plugins placed in this folder.
+
+Files in this folder are typically defined through the
+[`fastify-plugin`](https://github.com/fastify/fastify-plugin) module,
+making them non-encapsulated. They can define decorators and set hooks
+that will then be used in the rest of your application.
+
+Check out:
+
+- [The hitchhiker's guide to plugins](https://www.fastify.io/docs/latest/Guides/Plugins-Guide/)
+- [Fastify decorators](https://www.fastify.io/docs/latest/Reference/Decorators/).
+- [Fastify lifecycle](https://www.fastify.io/docs/latest/Reference/Lifecycle/).

apps/api/src/plugins/sensible.ts

@@ -0,0 +1,13 @@
+import fp from 'fastify-plugin';
+import sensible, {SensibleOptions} from '@fastify/sensible';
+
+/**
+ * This plugins adds some utilities to handle http errors
+ *
+ * @see https://github.com/fastify/fastify-sensible
+ */
+export default fp<SensibleOptions>(async (fastify, opts) => {
+  fastify.register(sensible, {
+    errorHandler: false,
+  });
+});

apps/api/src/plugins/support.ts

@@ -0,0 +1,20 @@
+import fp from 'fastify-plugin';
+
+export interface SupportPluginOptions {
+  // Specify Support plugin options here
+}
+
+// The use of fastify-plugin is required to be able
+// to export the decorators to the outer scope
+export default fp<SupportPluginOptions>(async (fastify, opts) => {
+  fastify.decorate('someSupport', function () {
+    return 'hugs';
+  });
+});
+
+// When using .decorate you have to specify added properties for Typescript
+declare module 'fastify' {
+  export interface FastifyInstance {
+    someSupport(): string;
+  }
+}

apps/api/src/routes/README.md

@@ -0,0 +1,24 @@
+# Routes Folder
+
+Routes define endpoints within your application. Fastify provides an
+easy path to a microservice architecture, in the future you might want
+to independently deploy some of those.
+
+In this folder you should define all the routes that define the endpoints
+of your web application.
+Each service is a [Fastify
+plugin](https://www.fastify.io/docs/latest/Reference/Plugins/), it is
+encapsulated (it can have its own independent plugins) and it is
+typically stored in a file; be careful to group your routes logically,
+e.g. all `/users` routes in a `users.js` file. We have added
+a `root.js` file for you with a '/' root added.
+
+If a single file become too large, create a folder and add a `index.js` file there:
+this file must be a Fastify plugin, and it will be loaded automatically
+by the application. You can now add as many files as you want inside that folder.
+In this way you can create complex routes within a single monolith,
+and eventually extract them.
+
+If you need to share functionality between routes, place that
+functionality into the `plugins` folder, and share it via
+[decorators](https://www.fastify.io/docs/latest/Reference/Decorators/).

apps/api/src/routes/example/index.ts

@@ -0,0 +1,9 @@
+import {FastifyPluginAsync} from 'fastify';
+
+const example: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
+  fastify.get('/', async function (request, reply) {
+    return 'this is an example';
+  });
+};
+
+export default example;

apps/api/src/routes/root.ts

@@ -0,0 +1,9 @@
+import {FastifyPluginAsync} from 'fastify';
+
+const root: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
+  fastify.get('/', async function (request, reply) {
+    return {root: true};
+  });
+};
+
+export default root;

apps/api/test/helper.ts

@@ -0,0 +1,32 @@
+// This file contains code that we reuse between our tests.
+import Fastify from 'fastify';
+import fp from 'fastify-plugin';
+import App from '../src/app';
+import * as tap from 'tap';
+
+export type Test = typeof tap['Test']['prototype'];
+
+// Fill in this config with all the configurations
+// needed for testing the application
+async function config() {
+  return {};
+}
+
+// Automatically build and tear down our instance
+async function build(t: Test) {
+  const app = Fastify();
+
+  // fastify-plugin ensures that all decorators
+  // are exposed for testing purposes, this is
+  // different from the production setup
+  void app.register(fp(App), await config());
+
+  await app.ready();
+
+  // Tear down our app after we are done
+  t.teardown(() => void app.close());
+
+  return app;
+}
+
+export {config, build};

apps/api/test/plugins/support.test.ts

@@ -0,0 +1,11 @@
+import {test} from 'tap';
+import Fastify from 'fastify';
+import Support from '../../src/plugins/support';
+
+test('support works standalone', async t => {
+  const fastify = Fastify();
+  void fastify.register(Support);
+  await fastify.ready();
+
+  t.equal(fastify.someSupport(), 'hugs');
+});

apps/api/test/routes/example.test.ts

@@ -0,0 +1,12 @@
+import {test} from 'tap';
+import {build} from '../helper';
+
+test('example is loaded', async t => {
+  const app = await build(t);
+
+  const res = await app.inject({
+    url: '/example',
+  });
+
+  t.equal(res.payload, 'this is an example');
+});

apps/api/test/routes/root.test.ts

@@ -0,0 +1,11 @@
+import {test} from 'tap';
+import {build} from '../helper';
+
+test('default root route', async t => {
+  const app = await build(t);
+
+  const res = await app.inject({
+    url: '/',
+  });
+  t.same(JSON.parse(res.payload), {root: true});
+});

apps/api/test/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": "./",
+    "noEmit": true
+  },
+  "include": ["../src/**/*.ts", "**/*.ts"]
+}

apps/api/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "fastify-tsconfig",
+  "compilerOptions": {
+    "outDir": "dist",
+    "sourceMap": true
+  },
+  "include": ["src/**/*.ts"]
+}