Merge pull request #4 from saddamarbaa/refactor/migrate-to-typeScript

refactor: migrate to typescript and add api docs

Author: saddamarbaa

.gitignore

@@ -1,3 +1,77 @@
-node_modules
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
-.env
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# 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
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
+dist
+
+.DS_Store

__mocks__/index.ts

@@ -0,0 +1,3 @@
+
+// @ts-ignore
+// Todo mocking test

__tests__/api.test.ts

@@ -0,0 +1,25 @@
+import request from 'supertest';
+
+import app from '@src/app';
+
+describe('GET /api/v1', () => {
+  it('responds with a json message', (done) => {
+    request(app).get('/api/v1').set('Accept', 'application/json').expect('Content-Type', /json/).expect(
+      200,
+      {
+        message: 'API - 👋🌎🌍🌏',
+      },
+      done
+    );
+  });
+});
+
+describe('GET /api/v1/emojis', () => {
+  it('responds with a json message', (done) => {
+    request(app)
+      .get('/api/v1/emojis')
+      .set('Accept', 'application/json')
+      .expect('Content-Type', /json/)
+      .expect(200, ['😀', '😳', '🙄'], done);
+  });
+});

__tests__/app.test.ts

@@ -0,0 +1,25 @@
+import request from 'supertest';
+
+import app from '@src/app';
+
+describe('app', () => {
+  it('responds with a not found message', (done) => {
+    request(app)
+      .get('/what-is-this-even')
+      .set('Accept', 'application/json')
+      .expect('Content-Type', /json/)
+      .expect(404, done);
+  });
+});
+
+describe('GET /', () => {
+  it('responds with a json message', (done) => {
+    request(app).get('/').set('Accept', 'application/json').expect('Content-Type', /json/).expect(
+      200,
+      {
+        message: '🦄🌈✨👋🌎🌍🌏✨🌈🦄',
+      },
+      done
+    );
+  });
+});