Merge pull request #113 from TaloDev/develop

Release 0.16.0

Author: tudddorrr

_templates/service/new/api-service.ejs.t

@@ -1,21 +1,17 @@
 ---
 to: "<%= (typeof api !== 'undefined') ? `src/services/api/${name}-api.service.ts` : null %>"
 ---
-import { HasPermission, Request, Response } from 'koa-clay'
+import { HasPermission, Request, Response, ForwardTo, forwardRequest } from 'koa-clay'
 import <%= h.changeCase.pascal(name) %>APIPolicy from '../../policies/api/<%= name %>-api.policy'
-import <%= h.changeCase.pascal(name) %>Service from '../<%= name %>.service'
 import APIService from './api-service'
 import APIKey from '../../entities/api-key'
 
-export default class <%= h.changeCase.pascal(name) %>APIService extends APIService<<%= h.changeCase.pascal(name) %>Service> {
-  constructor() {
-    super('<%= name %>s')
-  }
-
+export default class <%= h.changeCase.pascal(name) %>APIService extends APIService {
   @HasPermission(<%= h.changeCase.pascal(name) %>APIPolicy, 'post')
+  @ForwardTo(<%= h.changeCase.dot(name) %>, 'post')
   async post(req: Request): Promise<Response> {
     const key: APIKey = await this.getAPIKey(req.ctx)
-    return await this.forwardRequest('post', req, {
+    return await forwardRequest(req, {
       body: {
         gameId: key.game.id
       }

_templates/service/new/protected-route.ejs.t

@@ -3,4 +3,4 @@ inject: true
 to: src/config/protected-routes.ts
 before: app\.use\(service
 ---
-  app.use(service('/<%= name %>s', new <%= h.changeCase.pascal(name) %>Service()))
+  app.use(service('/<%= name %>s', new <%= h.changeCase.pascal(name) %>Service(), serviceOpts))

_templates/service/new/service.ejs.t

@@ -6,7 +6,7 @@ import { HasPermission, Service, Request, Response, Validate } from 'koa-clay'
 import <%= h.changeCase.pascal(name) %> from '../entities/<%= name %>'
 import <%= h.changeCase.pascal(name) %>Policy from '../policies/<%= name %>.policy'
 
-export default class <%= h.changeCase.pascal(name) %>Service implements Service {
+export default class <%= h.changeCase.pascal(name) %>Service extends Service {
   @Validate({
     query: ['<%= h.changeCase.camel(name) %>Id']
   })

package.json

@@ -1,6 +1,6 @@
 {
   "name": "game-services",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "",
   "main": "src/index.ts",
   "scripts": {
@@ -68,13 +68,12 @@
     "jsonwebtoken": "^8.5.1",
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
-    "koa-clay": "^5.3.0",
+    "koa-clay": "^6.1.1",
     "koa-helmet": "^6.1.0",
     "koa-jwt": "^4.0.3",
     "koa-logger": "^3.2.1",
     "lodash.get": "^4.4.2",
     "lodash.groupby": "^4.6.0",
-    "lodash.merge": "^4.6.2",
     "lodash.uniqwith": "^4.5.0",
     "otplib": "^12.0.1",
     "qrcode": "^1.5.0",

src/config/protected-routes.ts

@@ -1,5 +1,5 @@
 import Koa, { Context, Next } from 'koa'
-import { service } from 'koa-clay'
+import { service, ServiceOpts } from 'koa-clay'
 import OrganisationService from '../services/organisation.service'
 import InviteService from '../services/invite.service'
 import GameStatService from '../services/game-stat.service'
@@ -23,17 +23,23 @@ export default (app: Koa) => {
     await next()
   })
 
-  app.use(service('/billing', new BillingService()))
-  app.use(service('/organisations', new OrganisationService()))
-  app.use(service('/invites', new InviteService()))
-  app.use(service('/game-stats', new GameStatService()))
-  app.use(service('/game-activities', new GameActivityService()))
-  app.use(service('/leaderboards', new LeaderboardService()))
-  app.use(service('/data-exports', new DataExportService()))
-  app.use(service('/api-keys', new APIKeyService()))
-  app.use(service('/events', new EventService()))
-  app.use(service('/players', new PlayerService()))
-  app.use(service('/games', new GameService()))
-  app.use(service('/users', new UserService()))
-  app.use(service('/headlines', new HeadlineService()))
+  const serviceOpts: ServiceOpts = {
+    docs: {
+      hidden: true
+    }
+  }
+
+  app.use(service('/billing', new BillingService(), serviceOpts))
+  app.use(service('/organisations', new OrganisationService(), serviceOpts))
+  app.use(service('/invites', new InviteService(), serviceOpts))
+  app.use(service('/game-stats', new GameStatService(), serviceOpts))
+  app.use(service('/game-activities', new GameActivityService(), serviceOpts))
+  app.use(service('/leaderboards', new LeaderboardService(), serviceOpts))
+  app.use(service('/data-exports', new DataExportService(), serviceOpts))
+  app.use(service('/api-keys', new APIKeyService(), serviceOpts))
+  app.use(service('/events', new EventService(), serviceOpts))
+  app.use(service('/players', new PlayerService(), serviceOpts))
+  app.use(service('/games', new GameService(), serviceOpts))
+  app.use(service('/users', new UserService(), serviceOpts))
+  app.use(service('/headlines', new HeadlineService(), serviceOpts))
 }

src/config/public-routes.ts

@@ -1,13 +1,21 @@
 import Koa from 'koa'
-import { service } from 'koa-clay'
+import { service, ServiceOpts } from 'koa-clay'
 import DemoService from '../services/public/demo.service'
+import DocumentationService from '../services/public/documentation.service'
 import InvitePublicService from '../services/public/invite-public.service'
 import UserPublicService from '../services/public/user-public.service'
 import WebhookService from '../services/public/webhook.service'
 
 export default (app: Koa) => {
-  app.use(service('/public/webhooks', new WebhookService()))
-  app.use(service('/public/invites', new InvitePublicService()))
-  app.use(service('/public/users', new UserPublicService()))
-  app.use(service('/public/demo', new DemoService()))
+  const serviceOpts: ServiceOpts = {
+    docs: {
+      hidden: true
+    }
+  }
+
+  app.use(service('/public/docs', new DocumentationService(), serviceOpts))
+  app.use(service('/public/webhooks', new WebhookService(), serviceOpts))
+  app.use(service('/public/invites', new InvitePublicService(), serviceOpts))
+  app.use(service('/public/users', new UserPublicService(), serviceOpts))
+  app.use(service('/public/demo', new DemoService(), serviceOpts))
 }

src/config/redis.config.ts

@@ -1,4 +1,4 @@
 export default {
-  host: 'redis',
+  host: process.env.REDIS_HOST ?? 'redis',
   password: process.env.REDIS_PASSWORD
 }

src/services/api-key.service.ts

@@ -35,7 +35,7 @@ export async function createToken(apiKey: APIKey, payloadParams?: ExtraTokenPayl
     method: 'DELETE'
   }
 ])
-export default class APIKeyService implements Service {
+export default class APIKeyService extends Service {
   @Validate({
     body: ['gameId', 'scopes']
   })

src/services/api/api-service.ts

@@ -1,31 +1,11 @@
-import { Service, Request, Response } from 'koa-clay'
+import { Service } from 'koa-clay'
 import { Context } from 'koa'
 import APIKey from '../../entities/api-key'
 import { EntityManager } from '@mikro-orm/core'
-import merge from 'lodash.merge'
-
-export default class APIService<T> implements Service {
-  serviceName: string
-
-  constructor(serviceName: string) {
-    this.serviceName = serviceName
-  }
 
+export default class APIService extends Service {
   async getAPIKey(ctx: Context): Promise<APIKey> {
     const key = await (<EntityManager>ctx.em).getRepository(APIKey).findOne(ctx.state.user.sub)
     return key
   }
-
-  getService(ctx: Context): T {
-    return ctx.state.services[this.serviceName]
-  }
-
-  forwardRequest(funcName: string, req: Request, extra?: Partial<Request>): Promise<Response> {
-    const newRequest: Request = Object.assign({}, req)
-    merge(newRequest, extra)
-
-    const service = this.getService(newRequest.ctx)
-    const func = service[funcName]
-    return func.call(service, newRequest)
-  }
 }

src/services/api/event-api.service.ts

@@ -1,18 +1,13 @@
 import { EntityManager } from '@mikro-orm/core'
-import { HasPermission, Request, Response, Validate, ValidationCondition } from 'koa-clay'
+import { forwardRequest, ForwardTo, HasPermission, Request, Response, Validate, ValidationCondition } from 'koa-clay'
 import Event from '../../entities/event'
 import EventAPIPolicy from '../../policies/api/event-api.policy'
-import EventService from '../event.service'
 import APIService from './api-service'
 import APIKey from '../../entities/api-key'
 import PlayerAlias from '../../entities/player-alias'
 import groupBy from 'lodash.groupby'
 
-export default class EventAPIService extends APIService<EventService> {
-  constructor() {
-    super('events')
-  }
-
+export default class EventAPIService extends APIService {
   @Validate({
     body: {
       events: {
@@ -88,9 +83,10 @@ export default class EventAPIService extends APIService<EventService> {
   }
 
   @HasPermission(EventAPIPolicy, 'index')
+  @ForwardTo('events', 'index')
   async index(req: Request): Promise<Response> {
     const key: APIKey = await this.getAPIKey(req.ctx)
-    return await this.forwardRequest('index', req, {
+    return await forwardRequest(req, {
       query: {
         gameId: key.game.id.toString()
       }