@feathersjs/koa 5.0.0-pre.9 → 5.0.1

package/src/rest.ts

@@ -1,51 +1,94 @@
-import { Next } from 'koa';
-import { http } from '@feathersjs/transport-commons';
-import { createDebug } from '@feathersjs/commons';
-import { getServiceOptions, defaultServiceMethods, createContext } from '@feathersjs/feathers';
-import { MethodNotAllowed } from '@feathersjs/errors';
-import { FeathersKoaContext } from './declarations';
-
-const debug = createDebug('@feathersjs/koa:rest');
-
-export function rest () {
-  return async (ctx: FeathersKoaContext, next: Next) => {
-    const { app, request } = ctx;
-    const { query: koaQuery, path, body: data, method: httpMethod } = request;
-    const query = { ...koaQuery };
-    const methodOverride = request.headers[http.METHOD_HEADER] ?
-      request.headers[http.METHOD_HEADER] as string : null;
-    const lookup = app.lookup(path);
-
-    if (lookup !== null) {
-      const { service, params: { __id: id = null, ...route } = {} } = lookup;
-      const method = http.getServiceMethod(httpMethod, id, methodOverride);
-      const { methods } = getServiceOptions(service);
-      
-      debug(`Found service for path ${path}, attempting to run '${method}' service method`);
-
-      if (!methods.includes(method) || defaultServiceMethods.includes(methodOverride)) {
-        ctx.response.status = http.statusCodes.methodNotAllowed;
-
-        throw new MethodNotAllowed(`Method \`${method}\` is not supported by this endpoint.`);
-      }
-
-      const createArguments = (http.argumentsFor as any)[method] || http.argumentsFor.default;
-      const params = {
-        ...ctx.feathers,
-        query,
-        route
-      };
-      const args = createArguments({ id, data, params });
-      const hookContext = createContext(service, method);
-
-      ctx.hook = hookContext as any;
-
-      const result = await (service as any)[method](...args, hookContext);
-
-      ctx.response.status = http.getStatusCode(result, {});
-      ctx.body = http.getData(result);
+import compose from 'koa-compose'
+import { http } from '@feathersjs/transport-commons'
+import { createDebug } from '@feathersjs/commons'
+import { getServiceOptions, defaultServiceMethods, createContext } from '@feathersjs/feathers'
+import { MethodNotAllowed } from '@feathersjs/errors'
+
+import { Application, Middleware } from './declarations'
+import { AuthenticationSettings, parseAuthentication } from './authentication'
+
+const debug = createDebug('@feathersjs/koa/rest')
+
+const serviceMiddleware = (): Middleware => {
+  return async (ctx, next) => {
+    const { query, headers, path, body: data, method: httpMethod } = ctx.request
+    const methodOverride = ctx.request.headers[http.METHOD_HEADER] as string | undefined
+
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const { service, params: { __id: id = null, ...route } = {} } = ctx.lookup!
+    const method = http.getServiceMethod(httpMethod, id, methodOverride)
+    const { methods } = getServiceOptions(service)
+
+    debug(`Found service for path ${path}, attempting to run '${method}' service method`)
+
+    if (!methods.includes(method) || defaultServiceMethods.includes(methodOverride)) {
+      const error = new MethodNotAllowed(`Method \`${method}\` is not supported by this endpoint.`)
+      ctx.response.status = error.code
+      throw error
+    }
+
+    const createArguments = http.argumentsFor[method as 'get'] || http.argumentsFor.default
+    const params = { query, headers, route, ...ctx.feathers }
+    const args = createArguments({ id, data, params })
+    const contextBase = createContext(service, method, { http: {} })
+    ctx.hook = contextBase
+
+    const context = await (service as any)[method](...args, contextBase)
+    ctx.hook = context
+
+    const response = http.getResponse(context)
+    ctx.status = response.status
+    ctx.set(response.headers)
+    ctx.body = response.body
+
+    return next()
+  }
+}
+
+const servicesMiddleware = (): Middleware => {
+  return async (ctx, next) => {
+    const app = ctx.app
+    const lookup = app.lookup(ctx.request.path)
+
+    if (!lookup) {
+      return next()
     }
 
-    return next();
-  };
+    ctx.lookup = lookup
+
+    const options = getServiceOptions(lookup.service)
+    const middleware = options.koa.composed
+
+    return middleware(ctx, next)
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+export const formatter: Middleware = (_ctx, _next) => {}
+
+export type RestOptions = {
+  formatter?: Middleware
+  authentication?: AuthenticationSettings
+}
+
+export const rest = (options?: RestOptions | Middleware) => {
+  options = typeof options === 'function' ? { formatter: options } : options || {}
+
+  const formatterMiddleware = options.formatter || formatter
+  const authenticationOptions = options.authentication
+
+  return (app: Application) => {
+    app.use(parseAuthentication(authenticationOptions))
+    app.use(servicesMiddleware())
+
+    app.mixins.push((_service, _path, options) => {
+      const { koa: { before = [], after = [] } = {} } = options
+
+      const middlewares = [].concat(before, serviceMiddleware(), after, formatterMiddleware)
+      const middleware = compose(middlewares)
+
+      options.koa ||= {}
+      options.koa.composed = middleware
+    })
+  }
 }

package/lib/authenticate.d.ts

@@ -1,8 +0,0 @@
-import { Next } from 'koa';
-import { FeathersKoaContext } from './declarations';
-interface MiddlewareSettings {
-    service?: string;
-    strategies?: string[];
-}
-export declare function authentication(settings?: MiddlewareSettings): (ctx: FeathersKoaContext, next: Next) => Promise<any>;
-export {};

package/lib/authenticate.js

@@ -1,38 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.authentication = void 0;
-const commons_1 = require("@feathersjs/commons");
-const debug = commons_1.createDebug('@feathersjs/koa:authentication');
-function authentication(settings = {}) {
-    return (ctx, next) => __awaiter(this, void 0, void 0, function* () {
-        const { app } = ctx;
-        const service = app.defaultAuthentication ? app.defaultAuthentication(settings.service) : null;
-        if (service === null) {
-            return next();
-        }
-        const config = service.configuration;
-        const authStrategies = settings.strategies || config.parseStrategies || config.authStrategies || [];
-        if (authStrategies.length === 0) {
-            debug('No `authStrategies` or `parseStrategies` found in authentication configuration');
-            return next();
-        }
-        const { req, res } = ctx;
-        const authentication = yield service.parse(req, res, ...authStrategies);
-        if (authentication) {
-            debug('Parsed authentication from HTTP header', authentication);
-            ctx.feathers.authentication = authentication;
-        }
-        return next();
-    });
-}
-exports.authentication = authentication;
-//# sourceMappingURL=authenticate.js.map

package/lib/authenticate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"authenticate.js","sourceRoot":"","sources":["../src/authenticate.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,iDAAkD;AAIlD,MAAM,KAAK,GAAG,qBAAW,CAAC,gCAAgC,CAAC,CAAC;AAO5D,SAAgB,cAAc,CAAE,WAA+B,EAAE;IAC/D,OAAO,CAAO,GAAuB,EAAE,IAAU,EAAE,EAAE;QACnD,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;QACpB,MAAM,OAAO,GAAG,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE/F,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;QACrC,MAAM,cAAc,GAAG,QAAQ,CAAC,UAAU,IAAI,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC;QAEpG,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/B,KAAK,CAAC,gFAAgF,CAAC,CAAC;YACxF,OAAO,IAAI,EAAE,CAAC;SACf;QAED,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAU,CAAC;QAChC,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,cAAc,CAAC,CAAC;QAExE,IAAI,cAAc,EAAE;YAClB,KAAK,CAAC,wCAAwC,EAAE,cAAc,CAAC,CAAC;YAChE,GAAG,CAAC,QAAQ,CAAC,cAAc,GAAG,cAAc,CAAC;SAC9C;QAED,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAA,CAAC;AACJ,CAAC;AA3BD,wCA2BC"}

package/lib/error-handler.js

@@ -1,29 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorHandler = void 0;
-const errors_1 = require("@feathersjs/errors");
-const errorHandler = () => (ctx, next) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        yield next();
-        if (ctx.body === undefined) {
-            throw new errors_1.NotFound('Not Found');
-        }
-    }
-    catch (error) {
-        ctx.response.status = error.code || 500;
-        ctx.body = typeof error.toJSON === 'function' ? error.toJSON() : {
-            message: error.message
-        };
-    }
-});
-exports.errorHandler = errorHandler;
-//# sourceMappingURL=error-handler.js.map

package/lib/error-handler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../src/error-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA8C;AAGvC,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,CAAO,GAAuB,EAAE,IAAwB,EAAE,EAAE;IAC5F,IAAI;QACF,MAAM,IAAI,EAAE,CAAC;QAEb,IAAG,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;YACzB,MAAM,IAAI,iBAAQ,CAAC,WAAW,CAAC,CAAC;SACjC;KAEF;IAAC,OAAO,KAAK,EAAE;QACd,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC,IAAI,IAAI,GAAG,CAAC;QACxC,GAAG,CAAC,IAAI,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YAC/D,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC;KACH;AACH,CAAC,CAAA,CAAC;AAdW,QAAA,YAAY,gBAcvB"}

package/src/authenticate.ts

@@ -1,40 +0,0 @@
-import { Next } from 'koa';
-import { createDebug } from '@feathersjs/commons';
-
-import { FeathersKoaContext } from './declarations';
-
-const debug = createDebug('@feathersjs/koa:authentication');
-
-interface MiddlewareSettings {
-  service?: string;
-  strategies?: string[];
-}
-
-export function authentication (settings: MiddlewareSettings = {}) {
-  return async (ctx: FeathersKoaContext, next: Next) => {
-    const { app } = ctx;
-    const service = app.defaultAuthentication ? app.defaultAuthentication(settings.service) : null;
-
-    if (service === null) {
-      return next();
-    }
-
-    const config = service.configuration;
-    const authStrategies = settings.strategies || config.parseStrategies || config.authStrategies || [];
-
-    if (authStrategies.length === 0) {
-      debug('No `authStrategies` or `parseStrategies` found in authentication configuration');
-      return next();
-    }
-
-    const { req, res } = ctx as any;
-    const authentication = await service.parse(req, res, ...authStrategies);
-
-    if (authentication) {
-      debug('Parsed authentication from HTTP header', authentication);
-      ctx.feathers.authentication = authentication;
-    }
-
-    return next();
-  };
-}

package/src/error-handler.ts

@@ -1,18 +0,0 @@
-import { NotFound } from '@feathersjs/errors';
-import { FeathersKoaContext } from './declarations';
-
-export const errorHandler = () => async (ctx: FeathersKoaContext, next: () => Promise<any>) => {
-  try {
-    await next();
-
-    if(ctx.body === undefined) {
-      throw new NotFound('Not Found');
-    }
-    
-  } catch (error) {
-    ctx.response.status = error.code || 500;
-    ctx.body = typeof error.toJSON === 'function' ? error.toJSON() : {
-      message: error.message
-    };
-  }
-};