refactor: update websocket agent support changes to be typed

* upgrade core dependency to v1.0.0-rc2 in preparation for a second release candidate

Author: dpopp07

lib/recognize-stream.ts

@@ -14,6 +14,7 @@
  * limitations under the License
  */
 
+import { RequestOptions } from 'http';
 import { Authenticator, contentType, qs } from 'ibm-cloud-sdk-core';
 import omit = require('object.omit');
 import pick = require('object.pick');
@@ -75,6 +76,7 @@ class RecognizeStream extends Duplex {
    * @param {boolean} [options.readableObjectMode] - Emit `result` objects instead of string Buffers for the `data` events. Does not affect input (which must be binary)
    * @param {boolean} [options.objectMode] - Alias for readableObjectMode
    * @param {boolean} [options.disableSslVerification] - If true, disable SSL verification for the WebSocket connection (default=false)
+   * @param {Agent} [options.agent] - custom http(s) agent, useful for using the sdk behind a proxy (Node only)
    * @param {string} [options.accessToken] - Bearer token to put in query string
    * @param {string} [options.watsonToken] - Valid Watson authentication token (for Cloud Foundry)
    * @param {string} [options.model] - The identifier of the model that is to be used for all recognition requests sent over the connection
@@ -189,7 +191,7 @@ class RecognizeStream extends Duplex {
     // add custom agent in the request options if given by user
     // default request options to null
     const { agent } = options;
-    const requestOptions = agent ? { agent } : null;
+    const requestOptions: RequestOptions = agent ? { agent } : null;
 
     const socket = (this.socket = new w3cWebSocket(
       url,

lib/synthesize-stream.ts

@@ -14,7 +14,7 @@
  * limitations under the License
  */
 
-import { OutgoingHttpHeaders } from 'http';
+import { Agent, OutgoingHttpHeaders, RequestOptions } from 'http';
 import { Authenticator, qs } from 'ibm-cloud-sdk-core';
 import pick = require('object.pick');
 import { Readable, ReadableOptions } from 'stream';
@@ -32,6 +32,7 @@ interface Options extends ReadableOptions {
   url?: string;
   headers?: OutgoingHttpHeaders;
   disableSslVerification?: boolean;
+  agent?: Agent;
 
   /* payload options */
   text: string;
@@ -84,6 +85,7 @@ class SynthesizeStream extends Readable {
    * @param {string} [options.url] - Base url for service (default='wss://stream.watsonplatform.net/speech-to-text/api')
    * @param {OutgoingHttpHeaders} [options.headers] - Only works in Node.js, not in browsers. Allows for custom headers to be set, including an Authorization header (preventing the need for auth tokens)
    * @param {boolean} [options.disableSslVerification] - If true, disable SSL verification for the WebSocket connection (default=false)
+   * @param {Agent} [options.agent] - custom http(s) agent, useful for using the sdk behind a proxy (Node only)
    * @param {string} options.text - The text that us to be synthesized
    * @param {string} options.accept - The requested format (MIME type) of the audio
    * @param {string[]} [options.timings] - An array that specifies whether the service is to return word timing information for all strings of the input text
@@ -127,7 +129,7 @@ class SynthesizeStream extends Readable {
     // add custom agent in the request options if given by user
     // default request options to null
     const { agent } = options;
-    const requestOptions = agent ? { agent } : null;
+    const requestOptions: RequestOptions = agent ? { agent } : null;
 
     const socket = (this.socket = new w3cWebSocket(
       url,

package.json

@@ -85,7 +85,7 @@
     "axios": "^0.18.0",
     "camelcase": "^5.3.1",
     "extend": "~3.0.2",
-    "ibm-cloud-sdk-core": "^1.0.0-rc1",
+    "ibm-cloud-sdk-core": "^1.0.0-rc2",
     "isstream": "~0.1.2",
     "object.pick": "~1.3.0",
     "snyk": "^1.192.4",

speech-to-text/v1.ts

@@ -1,6 +1,6 @@
 import async = require('async');
 import extend = require('extend');
-import { OutgoingHttpHeaders } from 'http';
+import { Agent, OutgoingHttpHeaders } from 'http';
 import isStream = require('isstream');
 import { getSdkHeaders } from '../lib/common';
 import RecognizeStream = require('../lib/recognize-stream');
@@ -138,7 +138,7 @@ class SpeechToTextV1 extends GeneratedSpeechToTextV1 {
 
     // if the user configured a custom https client, use it in the websocket method
     // let httpsAgent take precedence, default to null
-    params.agent = this._options.httpsAgent || this._options.httpAgent || null;
+    params.agent = this.baseOptions.httpsAgent || this.baseOptions.httpAgent || null;
 
     // include analytics headers
     const sdkHeaders = getSdkHeaders('speech_to_text', 'v1', 'recognizeUsingWebSocket');
@@ -264,6 +264,7 @@ namespace SpeechToTextV1 {
     headers?: OutgoingHttpHeaders;
     readableObjectMode?: boolean;
     objectMode?: boolean;
+    agent?: Agent;
 
     /* Query Params*/
     accessToken?: string;

text-to-speech/v1.ts

@@ -79,7 +79,7 @@ class TextToSpeechV1 extends GeneratedTextToSpeechV1 {
 
     // if the user configured a custom https client, use it in the websocket method
     // let httpsAgent take precedence, default to null
-    params.agent = this._options.httpsAgent || this._options.httpAgent || null;
+    params.agent = this.baseOptions.httpsAgent || this.baseOptions.httpAgent || null;
 
     // include analytics headers
     const sdkHeaders = getSdkHeaders('text_to_speech', 'v1', 'synthesizeUsingWebSocket');