Rename base service version property to serviceVersion (watson-developer-cloud#628)

* Rename base service version property to serviceVersion

* Better implementation of munging the service options (per German)

Author: Mike Kistler

authorization/v1.ts

@@ -20,7 +20,7 @@ import url = require('url');
 
 class AuthorizationV1 extends BaseService {
   name;
-  version;
+  serviceVersion;
   static URL: string = 'https://stream.watsonplatform.net/authorization/api';
 
   /**
@@ -73,6 +73,6 @@ class AuthorizationV1 extends BaseService {
 }
 
 AuthorizationV1.prototype.name = 'authorization';
-AuthorizationV1.prototype.version = 'v1';
+AuthorizationV1.prototype.serviceVersion = 'v1';
 
 export = AuthorizationV1;

conversation/v1-generated.ts

@@ -27,7 +27,7 @@ import { BaseService } from '../lib/base_service';
 
 class ConversationV1 extends BaseService {
   name: string; // set by prototype to 'conversation'
-  version: string; // set by prototype to 'v1'
+  serviceVersion: string; // set by prototype to 'v1'
 
   static URL: string = 'https://gateway.watsonplatform.net/conversation/api';
 
@@ -2231,7 +2231,7 @@ class ConversationV1 extends BaseService {
 }
 
 ConversationV1.prototype.name = 'conversation';
-ConversationV1.prototype.version = 'v1';
+ConversationV1.prototype.serviceVersion = 'v1';
 
 /*************************
  * interfaces

dialog/v1.ts

@@ -25,7 +25,7 @@ import { FileObject } from '../lib/helper';
 
 class DialogV1 extends BaseService {
   static URL: string = 'https://gateway.watsonplatform.net/dialog/api';
-  
+
   /**
    * Construct a DialogV1 object.
    *
@@ -298,7 +298,7 @@ class DialogV1 extends BaseService {
 }
 
 DialogV1.prototype.name = 'dialog';
-DialogV1.prototype.version = 'v1';
+DialogV1.prototype.serviceVersion = 'v1';
 
 namespace DialogV1 {
   /** Options for the `DialogV1` constructor. **/

discovery/v1-generated.ts

@@ -27,7 +27,7 @@ import { FileObject } from '../lib/helper';
 
 class DiscoveryV1 extends BaseService {
   name: string; // set by prototype to 'discovery'
-  version: string; // set by prototype to 'v1'
+  serviceVersion: string; // set by prototype to 'v1'
 
   static URL: string = 'https://gateway.watsonplatform.net/discovery/api';
 
@@ -1993,7 +1993,7 @@ class DiscoveryV1 extends BaseService {
 }
 
 DiscoveryV1.prototype.name = 'discovery';
-DiscoveryV1.prototype.version = 'v1';
+DiscoveryV1.prototype.serviceVersion = 'v1';
 
 /*************************
  * interfaces

index.ts

@@ -52,7 +52,7 @@ const servicesByVersion = {};
 Object.keys(exports).forEach(key => {
   const Service = exports[key];
   const name = Service.prototype.name;
-  const version = Service.prototype.version;
+  const version = Service.prototype.serviceVersion;
   servicesByVersion[name] = servicesByVersion[name] || {};
   servicesByVersion[name][version] = Service;
 });
@@ -63,6 +63,15 @@ Object.keys(servicesByVersion).forEach(serviceName => {
     configurable: true,
     writable: true,
     value: function(options) {
+
+      // eslint-disable-next-line no-console
+      console.warn(
+        'WARNING: This method of instantiating the Watson services has been deprecated ' +
+            'beginning with Version 3.0.0 of the Node SDK.  Please refer to the Node SDK ' +
+            'documentation for information on how to instantiate Watson services.  This ' +
+            'form of service instantiaion will be removed in a future release of the SDK.'
+      );
+
       options = options || {};
 
       // previously, AlchemyAPI did not require a version to be specified
@@ -78,7 +87,11 @@ Object.keys(servicesByVersion).forEach(serviceName => {
         );
       }
 
-      return new Service(options);
+      return new Service({
+        ...options,
+        serviceVersion: options.version,
+        version: options.version_date,
+      });
     }
   });
 });

language-translator/v2-generated.ts

@@ -27,7 +27,7 @@ import { FileObject } from '../lib/helper';
 
 class LanguageTranslatorV2 extends BaseService {
   name: string; // set by prototype to 'language_translator'
-  version: string; // set by prototype to 'v2'
+  serviceVersion: string; // set by prototype to 'v2'
 
   static URL: string = 'https://gateway.watsonplatform.net/language-translator/api';
 
@@ -364,7 +364,7 @@ class LanguageTranslatorV2 extends BaseService {
 }
 
 LanguageTranslatorV2.prototype.name = 'language_translator';
-LanguageTranslatorV2.prototype.version = 'v2';
+LanguageTranslatorV2.prototype.serviceVersion = 'v2';
 
 /*************************
  * interfaces

lib/base_service.ts

@@ -71,7 +71,7 @@ export class BaseService {
   protected serviceDefaults: object;
   static URL: string;
   name: string;
-  version: string;
+  serviceVersion: string;
   /**
    * Internal base class that other services inherit from
    * @param {UserOptions} options
@@ -143,7 +143,7 @@ export class BaseService {
             .replace(
               /_/g,
               ' '
-            )} ${this.version.toUpperCase()} unless use_unauthenticated is set`
+            )} ${this.serviceVersion.toUpperCase()} unless use_unauthenticated is set`
         );
       } else if (!hasCredentials(_options)) {
         throw new Error(
@@ -152,7 +152,7 @@ export class BaseService {
             .replace(
               /_/g,
               ' '
-            )} ${this.version.toUpperCase()} unless use_unauthenticated is set`
+            )} ${this.serviceVersion.toUpperCase()} unless use_unauthenticated is set`
         );
       }
       if (hasBasicCredentials(_options)) {
@@ -213,7 +213,7 @@ export class BaseService {
   }
   /**
    * Retrieve this service's credentials - useful for passing to the authorization service
-   * 
+   *
    * Only returns a URL when token auth is used.
    *
    * @returns {Credentials}

natural-language-classifier/v1-generated.ts

@@ -27,7 +27,7 @@ import { FileObject } from '../lib/helper';
 
 class NaturalLanguageClassifierV1 extends BaseService {
   name: string; // set by prototype to 'natural_language_classifier'
-  version: string; // set by prototype to 'v1'
+  serviceVersion: string; // set by prototype to 'v1'
 
   static URL: string = 'https://gateway.watsonplatform.net/natural-language-classifier/api';
 
@@ -270,7 +270,7 @@ class NaturalLanguageClassifierV1 extends BaseService {
 }
 
 NaturalLanguageClassifierV1.prototype.name = 'natural_language_classifier';
-NaturalLanguageClassifierV1.prototype.version = 'v1';
+NaturalLanguageClassifierV1.prototype.serviceVersion = 'v1';
 
 /*************************
  * interfaces

personality-insights/v2.ts

@@ -105,7 +105,7 @@ class PersonalityInsightsV2 extends BaseService {
 }
 
 PersonalityInsightsV2.prototype.name = 'personality_insights';
-PersonalityInsightsV2.prototype.version = 'v2';
+PersonalityInsightsV2.prototype.serviceVersion = 'v2';
 
 namespace PersonalityInsightsV2 {
   export type Callback = (

personality-insights/v3-generated.ts

@@ -26,7 +26,7 @@ import { BaseService } from '../lib/base_service';
 
 class PersonalityInsightsV3 extends BaseService {
   name: string; // set by prototype to 'personality_insights'
-  version: string; // set by prototype to 'v3'
+  serviceVersion: string; // set by prototype to 'v3'
 
   static URL: string = 'https://gateway.watsonplatform.net/personality-insights/api';
 
@@ -111,7 +111,7 @@ class PersonalityInsightsV3 extends BaseService {
 }
 
 PersonalityInsightsV3.prototype.name = 'personality_insights';
-PersonalityInsightsV3.prototype.version = 'v3';
+PersonalityInsightsV3.prototype.serviceVersion = 'v3';
 
 /*************************
  * interfaces

speech-to-text/v1-generated.ts

@@ -28,7 +28,7 @@ import { FileObject } from '../lib/helper';
 
 class SpeechToTextV1 extends BaseService {
   name: string; // set by prototype to 'speech_to_text'
-  version: string; // set by prototype to 'v1'
+  serviceVersion: string; // set by prototype to 'v1'
 
   static URL: string = 'https://stream.watsonplatform.net/speech-to-text/api';
 
@@ -255,7 +255,7 @@ class SpeechToTextV1 extends BaseService {
     };
     return createRequest(parameters, _callback);
   }
-  
+
   /*************************
    * asynchronous
    ************************/
@@ -1700,7 +1700,7 @@ class SpeechToTextV1 extends BaseService {
 }
 
 SpeechToTextV1.prototype.name = 'speech_to_text';
-SpeechToTextV1.prototype.version = 'v1';
+SpeechToTextV1.prototype.serviceVersion = 'v1';
 
 /*************************
  * interfaces

text-to-speech/v1-generated.ts

@@ -26,7 +26,7 @@ import { BaseService } from '../lib/base_service';
 
 class TextToSpeechV1 extends BaseService {
   name: string; // set by prototype to 'text_to_speech'
-  version: string; // set by prototype to 'v1'
+  serviceVersion: string; // set by prototype to 'v1'
 
   static URL: string = 'https://stream.watsonplatform.net/text-to-speech/api';
 
@@ -663,7 +663,7 @@ class TextToSpeechV1 extends BaseService {
 }
 
 TextToSpeechV1.prototype.name = 'text_to_speech';
-TextToSpeechV1.prototype.version = 'v1';
+TextToSpeechV1.prototype.serviceVersion = 'v1';
 
 /*************************
  * interfaces

tone-analyzer/v3-generated.ts

@@ -26,7 +26,7 @@ import { BaseService } from '../lib/base_service';
 
 class ToneAnalyzerV3 extends BaseService {
   name: string; // set by prototype to 'tone_analyzer'
-  version: string; // set by prototype to 'v3'
+  serviceVersion: string; // set by prototype to 'v3'
 
   static URL: string = 'https://gateway.watsonplatform.net/tone-analyzer/api';
 
@@ -154,7 +154,7 @@ class ToneAnalyzerV3 extends BaseService {
 }
 
 ToneAnalyzerV3.prototype.name = 'tone_analyzer';
-ToneAnalyzerV3.prototype.version = 'v3';
+ToneAnalyzerV3.prototype.serviceVersion = 'v3';
 
 /*************************
  * interfaces

visual-recognition/v3-generated.ts

@@ -27,7 +27,7 @@ import { FileObject } from '../lib/helper';
 
 class VisualRecognitionV3 extends BaseService {
   name: string; // set by prototype to 'visual_recognition'
-  version: string; // set by prototype to 'v3'
+  serviceVersion: string; // set by prototype to 'v3'
 
   static URL: string = 'https://gateway-a.watsonplatform.net/visual-recognition/api';
 
@@ -386,7 +386,7 @@ class VisualRecognitionV3 extends BaseService {
 }
 
 VisualRecognitionV3.prototype.name = 'visual_recognition';
-VisualRecognitionV3.prototype.version = 'v3';
+VisualRecognitionV3.prototype.serviceVersion = 'v3';
 
 /*************************
  * interfaces