chore: add type checked testing to ensure we do not have regressions …

…- coverage via integration tests (#28)

.github/workflows/ci.yml

@@ -25,6 +25,8 @@ jobs:
 
       - run: yarn
 
+      - run: yarn typecheck
+
       - run: yarn test
 
   publish-gpr:

.npmignore

@@ -7,6 +7,7 @@ __tests__
 assets
 examples
 src
+!dist/src
 tmp
 
 # Ignored file types

README.md

@@ -62,7 +62,7 @@ export const OpenAPISpecification = {
   },
   openapi: '3.1.0',
   paths: {
-    'v1//version': {
+    'v1/version': {
       get: {
         responses: {
           '200': {
@@ -78,6 +78,7 @@ export const OpenAPISpecification = {
     },
   },
 };
+
 ```
 
 With compeller you can compile this into a typed request and response handler like:

__tests__/integration/aws/index.test.ts

@@ -1,4 +1,31 @@
-import { handler } from '../fixtures';
+import { OpenAPISpecification } from '../fixtures/openapi/spec';
+import { APIGatewayV1Responder, compeller } from '../../../src';
+
+const API = compeller(OpenAPISpecification, {
+  responder: APIGatewayV1Responder,
+});
+const { response, request } = API('/pets', 'post');
+
+export const handler = (data: Record<string, unknown>) => {
+  let body = data;
+
+  if (request.validator(body)) {
+    console.info('Type-safe object destructured from post request', {
+      name: body.name,
+    });
+
+    return response('201', {});
+  } else {
+    const { errors } = request.validator;
+
+    if (errors) {
+      return response('422', {
+        title: 'Schema validation failure for request body',
+        details: errors,
+      });
+    }
+  }
+};
 
 describe('integration tests', () => {
   it('with missing data', () => {

examples/openapi/api-gateway.ts → examples/api-gateway.ts

@@ -1,5 +1,5 @@
-import { APIGatewayV1Responder, compeller } from '../../src';
-import { OpenAPISpecification } from './spec';
+import { APIGatewayV1Responder, compeller } from '../src';
+import { OpenAPISpecification } from './openapi/spec';
 
 const apiGatewayV1Compeller = compeller(OpenAPISpecification, {
   responder: APIGatewayV1Responder,

examples/openapi/custom.ts → examples/custom.ts

@@ -1,5 +1,5 @@
-import { compeller } from '../../src';
-import { OpenAPISpecification } from './spec';
+import { compeller } from '../src';
+import { OpenAPISpecification } from './openapi/spec';
 
 const customerCompeller = compeller(OpenAPISpecification, {
   responder: (statusCode, body) => {

examples/openapi/default.ts → examples/default.ts

@@ -1,5 +1,5 @@
-import { compeller } from '../../src';
-import { OpenAPISpecification } from './spec';
+import { compeller } from '../src';
+import { OpenAPISpecification } from './openapi/spec';
 
 const defaultCompeller = compeller(OpenAPISpecification);
 

package.json

@@ -43,7 +43,8 @@
   "license": "ISC",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc --build",
+    "typecheck": "tsc",
+    "build": "tsc --project tsconfig.production.json",
     "clean": "rimraf ./dist",
     "embed": "embedme ./README.md",
     "example": "hygen compeller new --directory example",

src/compeller/index.ts

@@ -123,17 +123,19 @@ export const compeller = <
         } = {},
       } = spec.paths[path][method];
 
-      const unsafeSchema = schema as JSONSchemaType<FromSchema<SC>>;
+      // TODO: We need to handle the request not a requestBody
+      //
+      // Some users might abstract the functional components into a generic
+      // wrapper, therefore gets might hit the validator path
+      //
+      // We don't want to loose type safety
+      const unsafeSchema = (schema || {}) as JSONSchemaType<FromSchema<SC>>;
 
       const ajv = new Ajv({
         allErrors: true,
       });
 
-      if (unsafeSchema) {
-        return ajv.compile(unsafeSchema);
-      } else {
-        return ajv.compile({});
-      }
+      return ajv.compile<FromSchema<SC>>(unsafeSchema);
     };
 
     const validator = validateRequestBody();

tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "@tsconfig/node14",
-  "include": ["src/**/*.ts"],
+  "include": ["src/**/*.ts", "__tests__/**/*.ts"],
   "compilerOptions": {
     "outDir": "./dist",
     "declaration": true,

tsconfig.production.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["__tests__/**/*.ts"]
+}