New version

.eslintignore

@@ -1 +1,3 @@
-**/*.test.ts
+**/*.test.ts
+src/old/*
+src/types/*

.eslintrc.json

@@ -19,6 +19,8 @@
     ],
     "rules": {
         "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-implicit-any": "off",
         "accessor-pairs": "error",
         "array-bracket-newline": "error",
         "array-bracket-spacing": "error",
@@ -36,14 +38,14 @@
         "comma-dangle": "error",
         "comma-spacing": "error",
         "comma-style": "error",
-        "complexity": "error",
+        "complexity": "warn",
         "computed-property-spacing": "error",
         "consistent-return": "error",
         "consistent-this": "error",
         "curly": "error",
         "default-case": "error",
         "default-case-last": "error",
-        "default-param-last": "error",
+        "default-param-last": "off",
         "dot-location": "error",
         "dot-notation": "error",
         "eol-last": "error",
@@ -96,7 +98,7 @@
         "no-div-regex": "error",
         "no-duplicate-imports": "error",
         "no-else-return": "error",
-        "no-empty-function": "error",
+        "no-empty-function": "off",
         "no-eq-null": "error",
         "no-eval": "error",
         "no-extend-native": "error",
@@ -130,7 +132,7 @@
         "no-new-wrappers": "error",
         "no-nonoctal-decimal-escape": "error",
         "no-octal-escape": "error",
-        "no-param-reassign": "error",
+        "no-param-reassign": "off",
         "no-plusplus": "error",
         "no-promise-executor-return": "error",
         "no-proto": "error",
@@ -147,12 +149,12 @@
         "no-shadow": "error",
         "no-tabs": "error",
         "no-template-curly-in-string": "error",
-        "no-ternary": "error",
+        "no-ternary": "off",
         "no-throw-literal": "error",
         "no-trailing-spaces": "error",
         "no-undef-init": "error",
         "no-undefined": "error",
-        "no-underscore-dangle": "error",
+        "no-underscore-dangle": ["error", { "allowAfterThis": true }],
         "no-unmodified-loop-condition": "error",
         "no-unneeded-ternary": "error",
         "no-unreachable-loop": "error",
@@ -183,27 +185,27 @@
         "padding-line-between-statements": "error",
         "prefer-arrow-callback": "error",
         "prefer-const": "error",
-        "prefer-destructuring": "error",
+        "prefer-destructuring": "off",
         "prefer-exponentiation-operator": "error",
-        "prefer-named-capture-group": "error",
+        "prefer-named-capture-group": "off",
         "prefer-numeric-literals": "error",
         "prefer-object-spread": "error",
         "prefer-promise-reject-errors": "error",
         "prefer-regex-literals": "error",
         "prefer-rest-params": "error",
-        "prefer-spread": "error",
+        "prefer-spread": "off",
         "prefer-template": "error",
         "quote-props": "error",
         "quotes": "error",
         "radix": "error",
         "require-atomic-updates": "error",
         "require-await": "error",
-        "require-unicode-regexp": "error",
+        "require-unicode-regexp": "off",
         "rest-spread-spacing": "error",
         "semi": "error",
         "semi-spacing": "error",
         "semi-style": "error",
-        "sort-imports": "error",
+        "sort-imports": "off",
         "sort-keys": "error",
         "sort-vars": "error",
         "space-before-blocks": "error",

.github/workflows/validate-build.yaml

@@ -0,0 +1,28 @@
+name: Validate build
+
+on: push
+
+jobs:
+  validate_build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.x]
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Run tests
+        run: npm run test

.gitignore

@@ -5,6 +5,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+examples
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

README.md

@@ -214,7 +214,7 @@ const connectionConfig = {
 	const stream = await symbl.createStream(connectionConfig);
 
 	// Send the start request
-	await stream.start(stream);
+	await symbl.start(stream);
 })();
 
 ```
@@ -260,7 +260,7 @@ const connectionConfig = {
 	const stream = await symbl.createStream(connectionConfig);
 
 	// Send the start request
-	await stream.start(stream);
+	await symbl.start(stream);
 })();
 ```
 
@@ -282,7 +282,7 @@ As a simple test of the Streaming API you can simply setup a live microphone and
 
 Initialize the SDK and connect via the built-in websocket connector. This will output the live transcription to the console.
 
-NOTE: The `symbl.startRealtimeRequest` function creates a new AudioContext, so the call must be made on user interaction, such as a button click.
+NOTE: The `symbl.createStream` function creates a new AudioContext, so the call must be made on user interaction, such as a button click.
 
 ```js
 symbl.init({
@@ -343,7 +343,8 @@ const connectionConfig = {
 };
 
 (async () => {
-	const connection = await symbl.startRealtimeRequest(connectionConfig);
+	const stream = await symbl.createStream(connectionConfig);
+	await symbl.start(stream);
 })();
 ```
 
@@ -357,8 +358,8 @@ A quick snippet on how to use the mute method.
 
 ```js
 (async () => {
-	const connection = await symbl.startRealtimeRequest(connectionConfig);
-	await symbl.mute(connection);
+	const stream = await symbl.createStream(connectionConfig);
+	await symbl.mute(stream);
 })();
 
 ```
@@ -369,8 +370,8 @@ A quick snippet on how to use the unmute method.
 
 ```js
 (async () => {
-	const connection = await symbl.startRealtimeRequest(connectionConfig);
-	await symbl.unmute(connection);
+	const stream = await symbl.createStream(connectionConfig);
+	await symbl.unmute(stream);
 })();
 
 ```
@@ -431,7 +432,8 @@ const connectionConfig = {
 };
 
 (async () => {
-	const connection = await symbl.startRealtimeRequest(connectionConfig);
+	const stream = await symbl.createStream(connectionConfig);
+	await symbl.start(stream);
 })();
 ```
 

jest.config.ts

@@ -1,9 +1,9 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
+import type {Config} from '@jest/types';
+
+// Sync object
+const config: Config.InitialOptions = {
+  verbose: true,
 
-export default {
   // All imported modules in your tests should be mocked automatically
   // automock: false,
 
@@ -60,7 +60,13 @@ export default {
   // globalTeardown: undefined,
 
   // A set of global variables that need to be available in all test environments
-  // globals: {},
+  // globals: {
+  //   'ts-jest': {
+  //     diagnostics: {
+  //       ignoreCodes: [2304],
+  //     },
+  //   },
+  // },
 
   // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
   // maxWorkers: "50%",
@@ -93,7 +99,7 @@ export default {
   // notifyMode: "failure-change",
 
   // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
+  preset: 'ts-jest',
 
   // Run tests from one or more projects
   // projects: undefined,
@@ -125,7 +131,7 @@ export default {
   // runner: "jest-runner",
 
   // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
+  setupFiles: ["./tests/setupTests.ts"],
 
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
   // setupFilesAfterEnv: [],
@@ -192,3 +198,4 @@ export default {
   // Whether to use watchman for file crawling
   // watchman: true,
 };
+export default config;