@smartlyio/oats-koa-adapter 4.0.2 → 4.0.3

package/dist/index.d.ts

@@ -0,0 +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 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>>(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

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bind = void 0;
+const Router = require("koa-router");
+const runtime = require("@smartlyio/oats-runtime");
+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, ...middlewares, async (ctx) => {
+            const files = ctx.request.files;
+            let fileFields = {};
+            if (files) {
+                fileFields = Object.keys(files).reduce((memo, 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.body;
+            let body;
+            if (Array.isArray(requestBody)) {
+                body = { value: requestBody, contentType };
+            }
+            else if (typeof requestBody === 'object') {
+                const bodyWithFileFields = Object.assign(Object.assign({}, 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.params,
+                query: ctx.query,
+                body,
+                requestContext: requestContextCreator(ctx)
+            });
+            ctx.body = result.value.value;
+            ctx.status = result.status;
+            ctx.set(result.headers);
+        });
+    };
+}
+/**
+ * Bind provided handlers for the OpenAPI routes
+ *
+ * Koa's default StateT and CustomT values are selected as defaults
+ * @param opts Named arguments to the function
+ * @param spec Deprecated use the named arguments
+ * @param requestContextCreator Deprecated
+ */
+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();
+    arg.handler(adapter(router, arg.requestContextCreator || (() => ({})), arg.middlewares || []))(arg.spec);
+    return router;
+}
+exports.bind = bind;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"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/dist/render-docs.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/render-docs.js

@@ -0,0 +1,37 @@
+"use strict";
+/* eslint-disable no-console */
+/* eslint-disable @typescript-eslint/no-floating-promises */
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const child = require("child_process");
+const assert = require("assert");
+const util = require("util");
+const md = fs.readFileSync('README.template.md', 'utf8');
+const examples = [];
+fs.writeFileSync('README.md', md.replace(/^>>(.*)/gm, (match, file) => {
+    const m = file.trim();
+    const example = fs.readFileSync('./' + m, 'utf8');
+    const runner = example.split('\n')[0].match(/\/\/(.*)/)[1];
+    assert(runner, 'missing runner command');
+    examples.push(runner.trim());
+    return example;
+}));
+Promise.all(examples.map(async (example) => {
+    console.log('testing ' + example);
+    try {
+        await util.promisify(child.exec)(example);
+        return example + ': ok';
+    }
+    catch (e) {
+        return example + ': error ' + e.message;
+    }
+})).then(results => {
+    const errors = results.filter(result => /: error/.test(result));
+    if (errors.length > 0) {
+        console.error('errors in rendering');
+        errors.map(error => console.error(error));
+        process.exit(1);
+    }
+    results.map(result => console.log(result));
+});
+//# sourceMappingURL=render-docs.js.map

package/dist/render-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-docs.js","sourceRoot":"","sources":["../render-docs.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B,4DAA4D;;AAE5D,yBAAyB;AACzB,uCAAuC;AACvC,iCAAiC;AACjC,6BAA6B;AAE7B,MAAM,EAAE,GAAW,EAAE,CAAC,YAAY,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AACjE,MAAM,QAAQ,GAAa,EAAE,CAAC;AAC9B,EAAE,CAAC,aAAa,CACd,WAAW,EACX,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;IACtC,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACtB,MAAM,OAAO,GAAQ,EAAE,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3D,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7B,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC,CACH,CAAC;AAEF,OAAO,CAAC,GAAG,CACT,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;IAC3B,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,OAAO,CAAC,CAAC;IAClC,IAAI;QACF,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;QAC1C,OAAO,OAAO,GAAG,MAAM,CAAC;KACzB;IAAC,OAAO,CAAM,EAAE;QACf,OAAO,OAAO,GAAG,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC;KACzC;AACH,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;IACf,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartlyio/oats-koa-adapter",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "license": "MIT",
   "description": "Koa adapter for Oats",
   "private": false,
@@ -37,7 +37,7 @@
     "client"
   ],
   "devDependencies": {
-    "@smartlyio/oats-runtime": "^4.0.2",
+    "@smartlyio/oats-runtime": "^4.0.3",
     "@types/koa": "2.13.4",
     "@types/koa-router": "7.4.4",
     "@types/lodash": "4.14.178",
@@ -48,5 +48,5 @@
     "ts-node": "10.4.0",
     "typescript": "4.5.4"
   },
-  "gitHead": "140ea78c4bb8bd34c7959941d4f9d771c289c30c"
+  "gitHead": "5897af3aa6bea0c602978a10816c577a6b051c90"
 }