Merge pull request #619 from watson-developer-cloud/update-typescript

Update typescript

Author: germanattanasio

.gitignore

@@ -31,4 +31,5 @@ authorization/*.js
 index.js
 .nyc_output
 **/*.d.ts
+!*/blob.d.ts
 **/*.js.map

.npmignore

@@ -23,7 +23,6 @@ transform.js
 scripts/
 # this is created in the build on travis ci when it updates the docs in the gh-pages branch
 gh-pages/
-tsconfig.json
 tslint.json
 typings.json
 typings
@@ -34,4 +33,6 @@ typings
 .eslintcache
 .eslintignore
 .gitattributes
-watson-developer-cloud-*.tgz
+*.ts
+!*.d.ts
+watson-developer-cloud-*.tgz

conversation/v1-generated.ts

@@ -62,7 +62,7 @@ class DialogV1 extends BaseService {
   getProfile(
     params: DialogV1.GetProfileParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -85,7 +85,7 @@ class DialogV1 extends BaseService {
   updateProfile(
     params: DialogV1.UpdateProfileParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -108,7 +108,7 @@ class DialogV1 extends BaseService {
   getConversation(
     params: DialogV1.GetConversationParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -132,7 +132,7 @@ class DialogV1 extends BaseService {
   conversation(
     params: DialogV1.ConversationParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -155,7 +155,7 @@ class DialogV1 extends BaseService {
   updateContent(
     params: DialogV1.UpdateContentParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -182,7 +182,7 @@ class DialogV1 extends BaseService {
   getContent(
     params: DialogV1.GetContentParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     const parameters = {
       options: {
@@ -204,7 +204,7 @@ class DialogV1 extends BaseService {
   createDialog(
     params: DialogV1.CreateDialogParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     if (!_params['file']) {
       callback(new Error('Missing required parameters: file'));
@@ -233,7 +233,7 @@ class DialogV1 extends BaseService {
   getDialogs(
     params: DialogV1.GetDialogsParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const parameters = {
       options: {
         url: '/v1/dialogs',
@@ -251,7 +251,7 @@ class DialogV1 extends BaseService {
   deleteDialog(
     params: DialogV1.DeleteDialogParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const parameters = {
       options: {
         url: '/v1/dialogs/{dialog_id}',
@@ -272,7 +272,7 @@ class DialogV1 extends BaseService {
   updateDialog(
     params: DialogV1.UpdateDialogParams,
     callback: DialogV1.Callback
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = params || {};
     if (!_params['file']) {
       callback(new Error('Missing required parameters: file'));

dialog/v1.ts

@@ -61,14 +61,14 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {string} [params.source] - Used in combination with target as an alternative way to select the model for translation. When target and source are set, and model_id is not set, the system chooses a default model with the right language pair to translate (usually the model based on the news domain).
    * @param {string} [params.target] - Used in combination with source as an alternative way to select the model for translation. When target and source are set, and model_id is not set, the system chooses a default model with the right language pair to translate (usually the model based on the news domain).
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   translate(
     params: LanguageTranslatorV2.TranslateParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.TranslationResult
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = extend({}, params);
     const _callback = callback ? callback : () => {};
     const requiredParams = ['text'];
@@ -109,14 +109,14 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.text - Input text in UTF-8 format.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   identify(
     params: LanguageTranslatorV2.IdentifyParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.IdentifiedLanguages
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = extend({}, params);
     const _callback = callback ? callback : () => {};
     const requiredParams = ['text'];
@@ -149,14 +149,14 @@ class LanguageTranslatorV2 extends BaseService {
    *
    * @param {Object} [params] - The parameters to send to the service.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   listIdentifiableLanguages(
     params?: LanguageTranslatorV2.ListIdentifiableLanguagesParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.IdentifiableLanguages
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params =
       typeof params === 'function' && !callback ? {} : extend({}, params);
     const _callback =
@@ -187,18 +187,18 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.base_model_id - Specifies the domain model that is used as the base for the training. To see current supported domain models, use the GET /v2/models parameter.
    * @param {string} [params.name] - The model name. Valid characters are letters, numbers, -, and _. No spaces.
-   * @param {ReadableStream|FileObject|Buffer} [params.forced_glossary] - A TMX file with your customizations. The customizations in the file completely overwrite the domain data translation, including high frequency or high confidence phrase translations. You can upload only one glossary with a file size less than 10 MB per call.
-   * @param {ReadableStream|FileObject|Buffer} [params.parallel_corpus] - A TMX file that contains entries that are treated as a parallel corpus instead of a glossary.
-   * @param {ReadableStream|FileObject|Buffer} [params.monolingual_corpus] - A UTF-8 encoded plain text file that is used to customize the target language model.
+   * @param {NodeJS.ReadableStream|FileObject|Buffer} [params.forced_glossary] - A TMX file with your customizations. The customizations in the file completely overwrite the domain data translation, including high frequency or high confidence phrase translations. You can upload only one glossary with a file size less than 10 MB per call.
+   * @param {NodeJS.ReadableStream|FileObject|Buffer} [params.parallel_corpus] - A TMX file that contains entries that are treated as a parallel corpus instead of a glossary.
+   * @param {NodeJS.ReadableStream|FileObject|Buffer} [params.monolingual_corpus] - A UTF-8 encoded plain text file that is used to customize the target language model.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   createModel(
     params: LanguageTranslatorV2.CreateModelParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.TranslationModel
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = extend({}, params);
     const _callback = callback ? callback : () => {};
     const requiredParams = ['base_model_id'];
@@ -247,14 +247,14 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.model_id - The model identifier.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   deleteModel(
     params: LanguageTranslatorV2.DeleteModelParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.DeleteModelResult
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = extend({}, params);
     const _callback = callback ? callback : () => {};
     const requiredParams = ['model_id'];
@@ -286,14 +286,14 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {Object} params - The parameters to send to the service.
    * @param {string} params.model_id - Model ID to use.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   getModel(
     params: LanguageTranslatorV2.GetModelParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.TranslationModel
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params = extend({}, params);
     const _callback = callback ? callback : () => {};
     const requiredParams = ['model_id'];
@@ -327,14 +327,14 @@ class LanguageTranslatorV2 extends BaseService {
    * @param {string} [params.target] - Filter models by target language.
    * @param {boolean} [params.default_models] - Valid values are leaving it unset, `true`, and `false`. When `true`, it filters models to return the default_models model or models. When `false`, it returns the non-default_models model or models. If not set, it returns all models, default_models and non-default_models.
    * @param {Function} [callback] - The callback that handles the response.
-   * @returns {ReadableStream|void}
+   * @returns {NodeJS.ReadableStream|void}
    */
   listModels(
     params?: LanguageTranslatorV2.ListModelsParams,
     callback?: LanguageTranslatorV2.Callback<
       LanguageTranslatorV2.TranslationModels
     >
-  ): ReadableStream | void {
+  ): NodeJS.ReadableStream | void {
     const _params =
       typeof params === 'function' && !callback ? {} : extend({}, params);
     const _callback =
@@ -422,11 +422,11 @@ namespace LanguageTranslatorV2 {
     /** The model name. Valid characters are letters, numbers, -, and _. No spaces. **/
     name?: string;
     /** A TMX file with your customizations. The customizations in the file completely overwrite the domain data translation, including high frequency or high confidence phrase translations. You can upload only one glossary with a file size less than 10 MB per call. **/
-    forced_glossary?: ReadableStream | FileObject | Buffer;
+    forced_glossary?: NodeJS.ReadableStream | FileObject | Buffer;
     /** A TMX file that contains entries that are treated as a parallel corpus instead of a glossary. **/
-    parallel_corpus?: ReadableStream | FileObject | Buffer;
+    parallel_corpus?: NodeJS.ReadableStream | FileObject | Buffer;
     /** A UTF-8 encoded plain text file that is used to customize the target language model. **/
-    monolingual_corpus?: ReadableStream | FileObject | Buffer;
+    monolingual_corpus?: NodeJS.ReadableStream | FileObject | Buffer;
   }
 
   /** Parameters for the `deleteModel` operation. **/

discovery/v1-generated.ts

@@ -0,0 +1,17 @@
+interface Blob {
+    readonly size: number;
+    readonly type: string;
+    msClose(): void;
+    msDetachStream(): any;
+    slice(start?: number, end?: number, contentType?: string): Blob;
+}
+
+declare var Blob: {
+    prototype: Blob;
+    new (blobParts?: any[], options?: BlobPropertyBag): Blob;
+};
+
+interface BlobPropertyBag {
+    type?: string;
+    endings?: string;
+}

language-translator/v2-generated.ts

@@ -1,5 +1,7 @@
 import { extname } from 'path';
 
+/// <reference path="blob.d.ts" />
+
 // This module attempts to identify common content-types based on the filename or header
 // It is not exhaustive, and for best results, you should always manually specify the content-type option.
 // See the complete list of supported content-types at

lib/blob.d.ts

@@ -22,7 +22,7 @@ import { isReadable } from 'isstream';
 
 // exported interfaces
 export interface FileObject {
-  value: ReadableStream | Buffer | string;
+  value: NodeJS.ReadableStream | Buffer | string;
   options?: FileOptions;
 }
 
@@ -33,11 +33,11 @@ export interface FileOptions {
 }
 
 export interface FileParamAttributes {
-  data: ReadableStream | Buffer | FileObject;
+  data: NodeJS.ReadableStream | Buffer | FileObject;
   contentType: string;
 }
 
-export interface FileStream extends ReadableStream {
+export interface FileStream extends NodeJS.ReadableStream {
   path: string | Buffer;
 }
 
@@ -63,15 +63,15 @@ export function isEmptyObject(obj: any): boolean {
 
 /**
  * This function retrieves the content type of the input.
- * @param {ReadableStream|Buffer|string} inputData - The data to retrieve content type for.
+ * @param {NodeJS.ReadableStream|Buffer|string} inputData - The data to retrieve content type for.
  * @returns {string} the content type of the input.
  */
 export function getContentType(
-  inputData: ReadableStream | Buffer | string
+  inputData: NodeJS.ReadableStream | Buffer | string
 ): string {
   let contentType = null;
   if (isFileStream(inputData)) {
-    // if the inputData is a ReadableStream
+    // if the inputData is a NodeJS.ReadableStream
     const mimeType = lookup(inputData.path);
     contentType = { mime: mimeType || null };
   } else if (Buffer.isBuffer(inputData)) {
@@ -156,7 +156,7 @@ export function getFormat(
 /**
  * this function builds a `form-data` object for each file parameter
  * @param {FileParamAttributes} fileParams - the file parameter attributes
- * @param {ReadableStream|Buffer|FileObject} fileParams.data - the data content of the file
+ * @param {NodeJS.ReadableStream|Buffer|FileObject} fileParams.data - the data content of the file
  * @param {string} fileParams.contentType - the content type of the file
  * @returns {FileObject}
  */
@@ -208,7 +208,7 @@ export function buildRequestFileObject(
   }
 
   // build value
-  let value: ReadableStream | Buffer | string = isFileObject(fileParams.data)
+  let value: NodeJS.ReadableStream | Buffer | string = isFileObject(fileParams.data)
     ? fileParams.data.value
     : fileParams.data;
   if (typeof value === 'string') {