Merge pull request #113 from thefrontside/npx

add bin script to auth0-simulator so it can be started via npx

Author: dagda1

.github/workflows/lint.yml

@@ -15,7 +15,4 @@ jobs:
         run: npm ci
 
       - name: Run linters
-        uses: wearerequired/lint-action@v1
-        with:
-          eslint: true
-          auto_fix: true
+        run: npm run lint

package-lock.json

@@ -28,9 +28,7 @@ This quick start assumes you have your own app with auth0. Check out [`nextjs wi
 Let's start our server.
 
 ```bash
-npm install
-cd ./packages/auth0 # when running from the simulacrum repo
-PORT=4000 npm run start  # this will start a test simulacrum server at http://localhost:4000
+PORT=4000 npx auth0-simulator  # this will start a test simulacrum server at http://localhost:4000
 ```
 
 Open a browser at [http://localhost:4000](http://localhost:4000).
@@ -96,8 +94,14 @@ You now have a running auth0 server!
 
 An auth0 simulator can be created using the `@simulacrum/client` package. This is how you would apply the mutations programmatically.
 
+```bash
+npm install @simulacrum/client
+npm install @simulacrum/auth0-simulator
+```
+
 The following examples are written in Typescript, but using Typescript is not a requirement. The Auth0 simulator creates a server with a graphql interface. This means that your interactions with the server can be written in any language or framework that can communicate over http / graphql.
 
+
 ```ts
 import { main } from "effection";
 import { createSimulationServer, Server } from "@simulacrum/server";

packages/auth0/README.md

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+require('@simulacrum/auth0-simulator/dist/start');

packages/auth0/bin/index.js

@@ -8,14 +8,18 @@
     "test": "NODE_EXTRA_CA_CERTS=\"$(mkcert -CAROOT)/rootCA.pem\" mocha -r ts-node/register --timeout 10000 test/**/*.test.ts",
     "prepack": "tsc --build tsconfig.dist.json && copy \"./src/views/**/*.png\" ./dist/views/",
     "build": "npm run prepack",
-    "lint": "eslint src test",
+    "lint": "eslint src bin test",
     "start": "node dist/start.js",
     "watch": "ts-node -P ./tsconfig.watch.json ./watch.ts"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/thefrontside/simulacrum.git"
   },
+  "files": [
+    "bin/**/*",
+    "dist/**/*"
+  ],
   "keywords": [
     "simulation",
     "emulation",
@@ -35,6 +39,7 @@
     "assert-ts": "^0.3.2",
     "base64-url": "^2.3.3",
     "cookie-session": "^1.4.0",
+    "dedent": "^0.7.0",
     "effection": "^2.0.0-beta.5",
     "html-entities": "^2.3.2",
     "jsesc": "^3.0.2",
@@ -45,8 +50,9 @@
     "@effection/mocha": "^2.0.0-beta.5",
     "@frontside/eslint-config": "^2.0.0",
     "@frontside/tsconfig": "^1.2.0",
-    "@frontside/typescript": "^1.1.1",
+    "@frontside/typescript": "^2.0.0",
     "@simulacrum/client": "0.5.0",
+    "@types/dedent": "^0.7.0",
     "@types/base64-url": "^2.2.0",
     "@types/cookie-session": "^2.0.42",
     "@types/jsesc": "^2.5.1",

packages/auth0/package.json

@@ -1,6 +1,7 @@
 import { main } from 'effection';
 import { createSimulationServer, Server } from '@simulacrum/server';
 import { auth0 } from '.';
+import dedent from 'dedent';
 
 const port = process.env.PORT ? parseInt(process.env.PORT) : undefined;
 
@@ -14,7 +15,34 @@ main(function*() {
 
   let url = `http://localhost:${server.address.port}`;
 
-  console.log(`simulation server running at ${url}`);
+  console.log(dedent`Started Simulacrum simulation server on ${url}. 
+  GraphiQL interface is running on ${url}/graphql.
+  
+  To start auth0 simulator send the following mutation to GraphQL server.
+  
+  mutation CreateSimulation {
+   createSimulation(simulator: "auth0",
+    options: {
+      options:{
+        audience: "[your audience]",
+        scope: "[your scope]",
+        clientId: "[your client-id]"
+      },
+      services:{
+        auth0:{
+          port: 4400
+        }
+      }
+    }) {
+      id
+      status
+      services {
+        url
+        name
+      }
+    }
+  }
+ `);
 
   yield;
 });

packages/auth0/src/start.ts

@@ -19,7 +19,7 @@
   "devDependencies": {
     "@frontside/eslint-config": "^2.0.0",
     "@frontside/tsconfig": "^1.2.0",
-    "@frontside/typescript": "^1.1.1",
+    "@frontside/typescript": "^2.0.0",
     "ts-node": "^9.1.1",
     "typescript": "^4.2.3"
   },

packages/client/package.json

@@ -48,7 +48,7 @@
     "@effection/mocha": "^2.0.0-beta.5",
     "@frontside/eslint-config": "^2.0.0",
     "@frontside/tsconfig": "^1.2.0",
-    "@frontside/typescript": "^1.1.1",
+    "@frontside/typescript": "^2.0.0",
     "@simulacrum/client": "0.5.0",
     "@types/cors": "^2.8.10",
     "@types/express": "^4.17.11",

packages/server/package.json

@@ -29,7 +29,7 @@
   "devDependencies": {
     "@frontside/eslint-config": "^2.0.0",
     "@frontside/tsconfig": "^1.2.0",
-    "@frontside/typescript": "^1.1.1",
+    "@frontside/typescript": "^2.0.0",
     "graphiql": "^1.4.0",
     "parcel": "next",
     "react": "^16.8.0",