feat(asr): add Spokestack ASR

Author: timmywil

.eslintignore

@@ -1,3 +1,3 @@
-dist/**
-docs/**
-examples/**
+dist
+docs
+.next

.prettierignore

@@ -10,17 +10,19 @@ This package is a work in progress.
 $ npm install spokestack --save
 ```
 
-## Requirements
+## Setup
 
-1. Go to [spokestack.io](https://spokestack.io) and create an account. Create a token at [spokestack.io/account/settings#api](https://spokestack.io/account/settings#api). Note that you'll only be able to see the token secret once. If you accidentally leave the page, create another token. Once you have a token, set the following environment variables in your `.bash_profile` or `.zshenv`:
+Go to [spokestack.io](https://spokestack.io) and create an account. Create a token at [spokestack.io/account/settings#api](https://spokestack.io/account/settings#api). Note that you'll only be able to see the token secret once. If you accidentally leave the page, create another token. Once you have a token, set the following environment variables in your `.bash_profile` or `.zshenv`:
 
 ```bash
 export SS_API_URL=https://api.spokestack.io
 export SS_API_CLIENT_ID=#"Identity" field from Spokestack API token
 export SS_API_CLIENT_SECRET=#"Secret key" field from Spokestack API token
 ```
 
-2. [Set up Google Cloud Speech](https://github.com/googleapis/nodejs-speech#before-you-begin). Ensure `GOOGLE_APPLICATION_CREDENTIALS` is set in your environment.
+## Using Google ASR instead of Spokestack ASR
+
+If you'd prefer to use Google ASR, follow these [instructions for setting up Google Cloud Speech](https://github.com/googleapis/nodejs-speech#before-you-begin). Ensure `GOOGLE_APPLICATION_CREDENTIALS` is set in your environment.
 
 ---
 

README.md

@@ -0,0 +1 @@
+export * from './dist/client'

client.d.ts

@@ -0,0 +1 @@
+module.exports = require('./dist/client')

client.js

@@ -1,12 +1,14 @@
 # with-next
 
-This example is built on [next.js](https://github.com/zeit/next.js).
+This example is built on [Next.js](https://github.com/zeit/next.js).
 
 It is a proof-of-concept using [Spokestack](../../) to demonstrate
 searching a database with voice using ASR and reading off the first result with text-to-speech.
 
 ## Usage
 
+See `server/index.ts` for example code using [Next.js][next] and [Express][express].
+
 ```bash
 $ git clone [email protected]:spokestack/node-spokestack.git
 $ cd node-spokestack/examples/with-next
@@ -17,3 +19,18 @@ $ npm run dev
 Then visit http://localhost:3000 in your browser.
 
 Visit http://localhost:3000/\_\_graphiql to view introspection docs on the Spokestack GraphQL API for synthesizing text to speech.
+
+### Run example using Google ASR instead of Spokestack ASR
+
+This command will run the server and use [Google Cloud Speech][google] instead of [Spokestack ASR][spokestack]
+
+```bash
+$ ASR_SERVICE=google npm run dev
+```
+
+Then visit http://localhost:3000 in your browser.
+
+[next]: https://github.com/zeit/next.js
+[express]: https://expressjs.com/
+[google]: https://cloud.google.com/speech-to-text/
+[spokestack]: https://www.spokestack.io/docs/concepts/asr

examples/with-next/.eslintignore

@@ -1,17 +1,4 @@
-const path = require('path')
-const pak = require('../../package.json')
-
 module.exports = {
   presets: ['next/babel'],
-  plugins: [
-    'transform-optional-chaining',
-    [
-      'module-resolver',
-      {
-        alias: {
-          [pak.name]: path.join(__dirname, '..', '..', pak.source)
-        }
-      }
-    ]
-  ]
+  plugins: ['transform-optional-chaining']
 }

examples/with-next/README.md

@@ -1,3 +1,3 @@
-const withTM = require('next-transpile-modules')(['graphiql', 'spokestack'])
+const withTM = require('next-transpile-modules')(['graphiql'])
 
 module.exports = withTM()

examples/with-next/babel.config.js

@@ -1,5 +1,5 @@
 {
-  "watch": ["server"],
+  "watch": ["server", "../../src"],
   "exec": "ts-node --project tsconfig.server.json server/index.ts",
   "ext": "js ts"
 }