counterfact 0.10.2 → 0.10.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # counterfact
 
+## 0.10.3
+
+### Patch Changes
+
+- f1360ba: made the generated code a bit cleaner
+
 ## 0.10.2
 
 ### Patch Changes

package/README.md

@@ -1,44 +1,99 @@
+
+<div align="right">
+
+[![Coverage Status](https://coveralls.io/repos/github/pmcelhaney/counterfact/badge.svg)](https://coveralls.io/github/pmcelhaney/counterfact) [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fpmcelhaney%2Fcounterfact%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/pmcelhaney/counterfact/main) ![MIT License](https://img.shields.io/badge/license-MIT-blue) 
+
+
+</div>
+
+<div align="center">
+
 # Counterfact
 
-[![Coverage Status](https://coveralls.io/repos/github/pmcelhaney/counterfact/badge.svg)](https://coveralls.io/github/pmcelhaney/counterfact)
+_Front end development without back end headaches_
+
+
+
+
+[Watch Demo](#watch-demo) | [Quick Start](#quick-start) |  [Documentation](#documentation) | [Support](#support)
+
+
+
+</div>
+
+
+
+<div align="center">
+Counterfact is a stand-in REST server powered by Node, TypeScript, and OpenAPI.<br>It simulates complex, stateful back end behavior without running the whole stack.
+</div>
+
+<br>
+
+<table align="center" cols="2">
+
+<tr>
+<td>
+
+💪 build the UI before the API or build both in parallel<br>
+🏎️ quickly and cheaply prototype UX workflows<br>
+🎉 turn OpenAPI docs into functional code
+
+</td>
+
+<td>
+
+⛓️ write fast, repeatable UI integration tests<br>
+🧑‍🔬 test UI code against hard-to-recreate edge cases<br>
+🔌 plug into your existing toolchain
+
+</td>
+
+</tr>
+
+</table>
+
+
+<div id="watch-demo" align="center">
 
-[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fpmcelhaney%2Fcounterfact%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/pmcelhaney/counterfact/main)
+```
 
-> This project is a work in progress. As of September 18, 2022, most of the plumbing is in place but the [APIs are still solidifying](https://github.com/pmcelhaney/counterfact/issues/204) and it's not quite ready for day-to-day use. See the [Version 1.0](https://github.com/pmcelhaney/counterfact/milestone/3) and [Future](https://github.com/pmcelhaney/counterfact/milestone/5) milestones.
 
 
-## What is Counterfact?
 
-Counterfact automatically builds a reference implementation of your [OpenAPI](https://www.openapis.org/) document. It uses metadata from the OpenAPI document to generate random, valid responses. 
 
-## Okay, tools already exist that can do that. Why build another?
+     video will go here
 
-Counterfact generates **TypeScript** code that you can **edit** to replace the random responses with real implementations. 
 
-## What do you mean "real" implementation?
 
-That's up to you! You can build a fully functional back-end if you like. Connect to a MongoDB, call other APIs, etc. 
 
-While it may be tempting to do so because it's so easy, we don't recommend using Counterfact for production. It's designed for building a **fake back end** so  you can **test your front end**. 
+```
+</div>
 
-## What do you mean by "fake" implementation? 
 
-For example, say you want to make sure the UI behaves properly if the server returns a `503 Service Unavailable` response to a particular endpoint. That can be quite a hassle when production code. With Counterfact, it's a matter of changing the `POST()` function in `./paths/path/to/endpoint.ts` to `return {status: 503}`. Run your test and then back out the change. It doesn't take much longer than it took you to read this paragraph. _This can all be done without restarting the server._
+## Quick Start
 
-Say you want to implement just enough of `POST` and `GET` so that after the front end posts an item, it can get the same item. But you don't want to go to the trouble of building a database for testing. Counterfact has APIs that makes building a simple in-memory implementation easy. 
+Try it now with one command. The only prequisite is Node 16+. 
 
-## You said TypeScript. Does it use the OpenAPI data to generate types? 
+```sh copy
+npx counterfact@latest https://petstore3.swagger.io/api/v3/openapi.json api --open
+```
 
-It sure does! 
+### What does it do?
 
-## Can I use those types in my front end?
+1. installs the `@latest` version of `counterfact`
+2. reads an [OpenAPI 3](https://oai.github.io/Documentation/) document (`https://petstore3.swagger.io/api/v3/openapi.json`)
+3. generates TypeScript files in the `api` directory
+4. starts a server which implements the API
+5. opens your browser to [Swagger UI](https://swagger.io/tools/swagger-ui/) (`--open`)
 
-You sure can!
+You can use Swagger to try out the auto-generated API. Out of the box, it returns random responses using metadata from the OpenAPI document. You can edit the files under `./api/paths` to add more realistic behavior. There's no need to restart the server.
 
-## What else does it do!
 
-So much more! We've barely scratched the surface. Stay tuned for detailed documentation and screen casts. 
+## Documentation
 
+Coming soon!
 
 
+## Support
 
+Counterfact is brand new as of October 3, 2022. Please send feedback / questions to pmcelhaney@gmail.com or [create a new issue](https://github.com/pmcelhaney/counterfact/issues/new). If you like what you see, please give this project a star! 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.10.2",
+  "version": "0.10.3",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/counterfact.js",

package/src/typescript-generator/operation-coder.js

@@ -23,8 +23,8 @@ export class OperationCoder extends Coder {
       return "() => { /* no response content specified in the OpenAPI document */ }";
     }
 
-    return `({ response}) => {
-      return response[${
+    return `($) => {
+      return $.response[${
         firstStatusCode === "default" ? 200 : firstStatusCode
       }].random();
     }`;

package/src/typescript-generator/script.js

@@ -181,9 +181,10 @@ export class Script {
 
   contents() {
     return [
-      ...this.externalImportsStatements(),
-      ...this.importStatements(),
-      ...this.exportStatements(),
-    ].join("\n");
+      this.externalImportsStatements().join("\n"),
+      this.importStatements().join("\n"),
+      "\n\n",
+      this.exportStatements().join("\n\n"),
+    ].join("");
   }
 }

package/test/typescript-generator/__snapshots__/end-to-end.test.js.snap

@@ -11,8 +11,8 @@ Map {
     },
     "exports": Map {
       "POST" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet/post",
@@ -23,8 +23,8 @@ Map {
         "typeDeclaration": "HTTP_POST",
       },
       "PUT" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet/put",
@@ -926,8 +926,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet~1findByStatus/get",
@@ -1350,8 +1350,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet~1findByTags/get",
@@ -1778,8 +1778,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet~1{petId}/get",
@@ -3118,8 +3118,8 @@ Map {
     },
     "exports": Map {
       "POST" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1pet~1{petId}~1uploadImage/post",
@@ -3380,8 +3380,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1store~1inventory/get",
@@ -3580,8 +3580,8 @@ Map {
     },
     "exports": Map {
       "POST" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1store~1order/post",
@@ -3864,8 +3864,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1store~1order~1{orderId}/get",
@@ -4540,8 +4540,8 @@ Map {
     },
     "exports": Map {
       "POST" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1user/post",
@@ -4814,8 +4814,8 @@ Map {
     },
     "exports": Map {
       "POST" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1user~1createWithList/post",
@@ -5112,8 +5112,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1user~1login/get",
@@ -5546,8 +5546,8 @@ Map {
     },
     "exports": Map {
       "GET" => Object {
-        "code": "({ response}) => {
-      return response[200].random();
+        "code": "($) => {
+      return $.response[200].random();
     }",
         "done": true,
         "id": "OperationCoder@petstore.yaml#/paths/~1user~1{username}/get",

package/test/typescript-generator/__snapshots__/operation-coder.test.js.snap

@@ -1,15 +1,15 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`an OperationCoder generates a complex get operation 1`] = `
-"({ response }) => {
-  return response[200].random();
+"($) => {
+  return $.response[200].random();
 };
 "
 `;
 
 exports[`an OperationCoder generates a simple post operation 1`] = `
-"({ response }) => {
-  return response[200].random();
+"($) => {
+  return $.response[200].random();
 };
 "
 `;

package/test/typescript-generator/integration.test.js

@@ -47,10 +47,10 @@ describe("integration Test", () => {
     await account.finished();
 
     expect(account.contents()).toBe(
-      "export const HTTP_GET = () => {};\nexport const HTTP_POST = () => {};"
+      "\n\nexport const HTTP_GET = () => {};\n\nexport const HTTP_POST = () => {};"
     );
     expect(accountId.contents()).toBe(
-      "export const HTTP_GET = () => {};\nexport const HTTP_PUT = () => {};"
+      "\n\nexport const HTTP_GET = () => {};\n\nexport const HTTP_PUT = () => {};"
     );
   });
 });

package/test/typescript-generator/script.test.js

@@ -147,7 +147,7 @@ describe("a Script", () => {
     ];
 
     expect(script.contents()).toBe(
-      'import { foo } from \'./foo.js;\nexport const bar = "Bar";\nexport default class {};'
+      'import { foo } from \'./foo.js;\n\nexport const bar = "Bar";\n\nexport default class {};'
     );
   });
 });