@smartlyio/oats-koa-adapter 3.4.0 → 4.0.0

package/README.md

@@ -13,7 +13,7 @@ Oats Koa Adapter is a library that binds server endpoints written with [Oats](ht
 Use `npm` or `yarn` to install `oats-koa-adapter`.
 
 ```bash
-npm install oats-koa-adapter
+npm install @smartlyio/oats-koa-adapter
 ```
 
 ## Usage
@@ -33,8 +33,15 @@ import spec from '<Your Route Definitions>';
 export const router = () => {
   const requestContextCreator = (ctx: any): any => ctx;
 
-  const oatsRouter = koaAdapter.bind(oaserver.createRouter(), spec, requestContextCreator);
-
+  const middlewares = [(_ctx, next) => { return next() }];
+  
+  const oatsRouter = koaAdapter.bind({ 
+    handler: oaserver.createRouter(), 
+    spec, 
+    requestContextCreator,
+    middlewares
+  });
+  
   return new Router().use(oatsRouter.routes())
 };
 

package/README.template.md

@@ -13,7 +13,7 @@ Oats Koa Adapter is a library that binds server endpoints written with [Oats](ht
 Use `npm` or `yarn` to install `oats-koa-adapter`.
 
 ```bash
-npm install oats-koa-adapter
+npm install @smartlyio/oats-koa-adapter
 ```
 
 ## Usage
@@ -33,8 +33,15 @@ import spec from '<Your Route Definitions>';
 export const router = () => {
   const requestContextCreator = (ctx: any): any => ctx;
 
-  const oatsRouter = koaAdapter.bind(oaserver.createRouter(), spec, requestContextCreator);
-
+  const middlewares = [(_ctx, next) => { return next() }];
+  
+  const oatsRouter = koaAdapter.bind({ 
+    handler: oaserver.createRouter(), 
+    spec, 
+    requestContextCreator,
+    middlewares
+  });
+  
   return new Router().use(oatsRouter.routes())
 };
 

package/dist/index.d.ts

@@ -1,12 +1,20 @@
 import * as Router from 'koa-router';
 import { ParameterizedContext } from 'koa';
 import * as runtime from '@smartlyio/oats-runtime';
+import { IMiddleware } from 'koa-router';
+declare type Opts<Spec, StateT, CustomT, RequestContext> = {
+    handler: runtime.server.HandlerFactory<Spec>;
+    spec: Spec;
+    requestContextCreator?: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext;
+    middlewares?: Array<IMiddleware<StateT, CustomT>>;
+};
 /**
  * Bind provided handlers for the OpenAPI routes
  *
  * Koa's default StateT and CustomT values are selected as defaults
- * @param handler
- * @param spec
- * @param requestContextCreator
+ * @param opts Named arguments to the function
+ * @param spec Deprecated use the named arguments
+ * @param requestContextCreator Deprecated
  */
-export declare function bind<Spec, RequestContext = void, StateT = any, CustomT = Record<string, unknown>>(handler: runtime.server.HandlerFactory<Spec>, spec: Spec, requestContextCreator?: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext): Router<StateT, CustomT>;
+export declare function bind<Spec, RequestContext = void, StateT = any, CustomT = Record<string, unknown>>(opts: runtime.server.HandlerFactory<Spec> | Opts<Spec, StateT, CustomT, RequestContext>, spec?: Spec, requestContextCreator?: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext): Router<StateT, CustomT>;
+export {};

package/dist/index.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.bind = void 0;
 const Router = require("koa-router");
 const runtime = require("@smartlyio/oats-runtime");
-function adapter(router, requestContextCreator) {
+const assert = require("assert");
+function adapter(router, requestContextCreator, middlewares) {
     return (path, op, method, handler) => {
         const koaPath = path.replace(/{([^}]+)}/g, (m, param) => ':' + param);
-        router[method](koaPath, async (ctx) => {
+        router[method](koaPath, ...middlewares, async (ctx) => {
             const files = ctx.request.files;
             let fileFields = {};
             if (files) {
@@ -49,13 +50,17 @@ function adapter(router, requestContextCreator) {
  * Bind provided handlers for the OpenAPI routes
  *
  * Koa's default StateT and CustomT values are selected as defaults
- * @param handler
- * @param spec
- * @param requestContextCreator
+ * @param opts Named arguments to the function
+ * @param spec Deprecated use the named arguments
+ * @param requestContextCreator Deprecated
  */
-function bind(handler, spec, requestContextCreator) {
+function bind(opts, spec, requestContextCreator) {
+    const arg = typeof opts === 'function'
+        ? { handler: opts, spec, requestContextCreator, middlewares: [] }
+        : opts;
+    assert(arg.spec, 'Missing spec argument -- please use the named argument version of bind');
     const router = new Router();
-    handler(adapter(router, requestContextCreator || (() => ({}))))(spec);
+    arg.handler(adapter(router, arg.requestContextCreator || (() => ({})), arg.middlewares || []))(arg.spec);
     return router;
 }
 exports.bind = bind;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AAErC,mDAAmD;AAEnD,SAAS,OAAO,CACd,MAA+B,EAC/B,qBAAqF;IAErF,OAAO,CACL,IAAY,EACZ,EAAU,EACV,MAA8B,EAC9B,OAAoC,EACpC,EAAE;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACrE,MAAc,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,GAA0C,EAAE,EAAE;YACpF,MAAM,KAAK,GAAI,GAAW,CAAC,OAAO,CAAC,KAAK,CAAC;YACzC,IAAI,UAAU,GAAG,EAAE,CAAC;YACpB,IAAI,KAAK,EAAE;gBACT,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAS,EAAE,IAAI,EAAE,EAAE;oBACzD,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;oBACzF,OAAO,IAAI,CAAC;gBACd,CAAC,EAAE,EAAE,CAAC,CAAC;aACR;YACD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACrC,MAAM,WAAW,GAAI,GAAG,CAAC,OAAe,CAAC,IAAI,CAAC;YAC9C,IAAI,IAAI,CAAC;YAET,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBAC9B,IAAI,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;aAC5C;iBAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBAC1C,MAAM,kBAAkB,mCAAQ,WAAW,GAAK,UAAU,CAAE,CAAC;gBAC7D,IAAI;oBACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC;wBACxC,CAAC,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE;wBAC5C,CAAC,CAAC,SAAS,CAAC;aACjB;YAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;gBAC3B,IAAI;gBACJ,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC7D,OAAO,EAAE,EAAE;gBACX,EAAE;gBACF,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO;gBAC5B,MAAM,EAAG,GAAW,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,IAAI;gBACJ,cAAc,EAAE,qBAAqB,CAAC,GAAG,CAAC;aAC3C,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC9B,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAClB,OAA4C,EAC5C,IAAU,EACV,qBAAsF;IAEtF,MAAM,MAAM,GAAG,IAAI,MAAM,EAAmB,CAAC;IAC7C,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,qBAAqB,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,oBAQC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AAErC,mDAAmD;AACnD,iCAAiC;AAGjC,SAAS,OAAO,CACd,MAA+B,EAC/B,qBAAqF,EACrF,WAAgD;IAEhD,OAAO,CACL,IAAY,EACZ,EAAU,EACV,MAA8B,EAC9B,OAAoC,EACpC,EAAE;QACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QACrE,MAAc,CAAC,MAAM,CAAC,CACrB,OAAO,EACP,GAAG,WAAW,EACd,KAAK,EAAE,GAA0C,EAAE,EAAE;YACnD,MAAM,KAAK,GAAI,GAAW,CAAC,OAAO,CAAC,KAAK,CAAC;YACzC,IAAI,UAAU,GAAG,EAAE,CAAC;YACpB,IAAI,KAAK,EAAE;gBACT,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAS,EAAE,IAAI,EAAE,EAAE;oBACzD,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAChC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAChB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAChB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CACjB,CAAC;oBACF,OAAO,IAAI,CAAC;gBACd,CAAC,EAAE,EAAE,CAAC,CAAC;aACR;YACD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACrC,MAAM,WAAW,GAAI,GAAG,CAAC,OAAe,CAAC,IAAI,CAAC;YAC9C,IAAI,IAAI,CAAC;YAET,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBAC9B,IAAI,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;aAC5C;iBAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBAC1C,MAAM,kBAAkB,mCAAQ,WAAW,GAAK,UAAU,CAAE,CAAC;gBAC7D,IAAI;oBACF,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC;wBACxC,CAAC,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,WAAW,EAAE;wBAC5C,CAAC,CAAC,SAAS,CAAC;aACjB;YAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;gBAC3B,IAAI;gBACJ,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;gBAC7D,OAAO,EAAE,EAAE;gBACX,EAAE;gBACF,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO;gBAC5B,MAAM,EAAG,GAAW,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,IAAI;gBACJ,cAAc,EAAE,qBAAqB,CAAC,GAAG,CAAC;aAC3C,CAAC,CAAC;YACH,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;YAC9B,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AASD;;;;;;;GAOG;AACH,SAAgB,IAAI,CAClB,IAAuF,EACvF,IAAW,EACX,qBAAsF;IAEtF,MAAM,GAAG,GACP,OAAO,IAAI,KAAK,UAAU;QACxB,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,qBAAqB,EAAE,WAAW,EAAE,EAAE,EAAE;QACjE,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,wEAAwE,CAAC,CAAC;IAC3F,MAAM,MAAM,GAAG,IAAI,MAAM,EAAmB,CAAC;IAC7C,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,qBAAqB,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAC5F,GAAG,CAAC,IAAI,CACT,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,oBAeC"}

package/index.ts

@@ -1,10 +1,13 @@
 import * as Router from 'koa-router';
 import { ParameterizedContext } from 'koa';
 import * as runtime from '@smartlyio/oats-runtime';
+import * as assert from 'assert';
+import { IMiddleware } from 'koa-router';
 
 function adapter<StateT, CustomT, RequestContext>(
   router: Router<StateT, CustomT>,
-  requestContextCreator: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext
+  requestContextCreator: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext,
+  middlewares: Array<IMiddleware<StateT, CustomT>>
 ): runtime.server.ServerAdapter {
   return (
     path: string,
@@ -13,61 +16,83 @@ function adapter<StateT, CustomT, RequestContext>(
     handler: runtime.server.SafeEndpoint
   ) => {
     const koaPath = path.replace(/{([^}]+)}/g, (m, param) => ':' + param);
-    (router as any)[method](koaPath, async (ctx: ParameterizedContext<StateT, CustomT>) => {
-      const files = (ctx as any).request.files;
-      let fileFields = {};
-      if (files) {
-        fileFields = Object.keys(files).reduce((memo: any, name) => {
-          memo[name] = new runtime.make.File(files[name].path, files[name].size, files[name].name);
-          return memo;
-        }, {});
-      }
-      const contentType = ctx.request.type;
-      const requestBody = (ctx.request as any).body;
-      let body;
+    (router as any)[method](
+      koaPath,
+      ...middlewares,
+      async (ctx: ParameterizedContext<StateT, CustomT>) => {
+        const files = (ctx as any).request.files;
+        let fileFields = {};
+        if (files) {
+          fileFields = Object.keys(files).reduce((memo: any, name) => {
+            memo[name] = new runtime.make.File(
+              files[name].path,
+              files[name].size,
+              files[name].name
+            );
+            return memo;
+          }, {});
+        }
+        const contentType = ctx.request.type;
+        const requestBody = (ctx.request as any).body;
+        let body;
 
-      if (Array.isArray(requestBody)) {
-        body = { value: requestBody, contentType };
-      } else if (typeof requestBody === 'object') {
-        const bodyWithFileFields = { ...requestBody, ...fileFields };
-        body =
-          Object.keys(bodyWithFileFields).length > 0
-            ? { value: bodyWithFileFields, contentType }
-            : undefined;
-      }
+        if (Array.isArray(requestBody)) {
+          body = { value: requestBody, contentType };
+        } else if (typeof requestBody === 'object') {
+          const bodyWithFileFields = { ...requestBody, ...fileFields };
+          body =
+            Object.keys(bodyWithFileFields).length > 0
+              ? { value: bodyWithFileFields, contentType }
+              : undefined;
+        }
 
-      const result = await handler({
-        path,
-        method: runtime.server.assertMethod(ctx.method.toLowerCase()),
-        servers: [],
-        op,
-        headers: ctx.request.headers,
-        params: (ctx as any).params,
-        query: ctx.query,
-        body,
-        requestContext: requestContextCreator(ctx)
-      });
-      ctx.body = result.value.value;
-      ctx.status = result.status;
-      ctx.set(result.headers);
-    });
+        const result = await handler({
+          path,
+          method: runtime.server.assertMethod(ctx.method.toLowerCase()),
+          servers: [],
+          op,
+          headers: ctx.request.headers,
+          params: (ctx as any).params,
+          query: ctx.query,
+          body,
+          requestContext: requestContextCreator(ctx)
+        });
+        ctx.body = result.value.value;
+        ctx.status = result.status;
+        ctx.set(result.headers);
+      }
+    );
   };
 }
 
+type Opts<Spec, StateT, CustomT, RequestContext> = {
+  handler: runtime.server.HandlerFactory<Spec>;
+  spec: Spec;
+  requestContextCreator?: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext;
+  middlewares?: Array<IMiddleware<StateT, CustomT>>;
+};
+
 /**
  * Bind provided handlers for the OpenAPI routes
  *
  * Koa's default StateT and CustomT values are selected as defaults
- * @param handler
- * @param spec
- * @param requestContextCreator
+ * @param opts Named arguments to the function
+ * @param spec Deprecated use the named arguments
+ * @param requestContextCreator Deprecated
  */
 export function bind<Spec, RequestContext = void, StateT = any, CustomT = Record<string, unknown>>(
-  handler: runtime.server.HandlerFactory<Spec>,
-  spec: Spec,
+  opts: runtime.server.HandlerFactory<Spec> | Opts<Spec, StateT, CustomT, RequestContext>,
+  spec?: Spec,
   requestContextCreator?: (ctx: ParameterizedContext<StateT, CustomT>) => RequestContext
 ): Router<StateT, CustomT> {
+  const arg =
+    typeof opts === 'function'
+      ? { handler: opts, spec, requestContextCreator, middlewares: [] }
+      : opts;
+  assert(arg.spec, 'Missing spec argument -- please use the named argument version of bind');
   const router = new Router<StateT, CustomT>();
-  handler(adapter(router, requestContextCreator || (() => ({}))))(spec);
+  arg.handler(adapter(router, arg.requestContextCreator || (() => ({})), arg.middlewares || []))(
+    arg.spec
+  );
   return router;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartlyio/oats-koa-adapter",
-  "version": "3.4.0",
+  "version": "4.0.0",
   "license": "MIT",
   "description": "Koa adapter for Oats",
   "private": false,
@@ -37,16 +37,16 @@
     "client"
   ],
   "devDependencies": {
-    "@smartlyio/oats-runtime": "^3.4.0",
+    "@smartlyio/oats-runtime": "^4.0.0",
     "@types/koa": "2.13.4",
     "@types/koa-router": "7.4.4",
-    "@types/lodash": "4.14.176",
-    "@types/node": "14.17.29",
+    "@types/lodash": "4.14.177",
+    "@types/node": "16.11.12",
     "koa": "2.13.4",
     "koa-body": "4.2.0",
     "koa-router": "10.1.1",
     "ts-node": "10.4.0",
-    "typescript": "4.4.4"
+    "typescript": "4.5.2"
   },
-  "gitHead": "b3bdede360d6f5ba6532835a37c19d1a1489e14b"
+  "gitHead": "a03f1e0fa604e6b34fa00a492836d11208cc6870"
 }