ibm-cloud-sdk-core 3.0.1 → 3.2.0

package/etc/ibm-cloud-sdk-core.api.md

@@ -8,6 +8,7 @@
 
 import { AxiosInstance } from 'axios';
 import type { CookieJar } from 'tough-cookie';
+import { Debugger } from 'debug';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
@@ -64,6 +65,7 @@ export class BaseService {
     enableRetries(retryOptions?: RetryOptions): void;
     getAuthenticator(): any;
     getHttpClient(): AxiosInstance;
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     setEnableGzipCompression(setting: boolean): void;
     setServiceUrl(url: string): void;
 }
@@ -226,6 +228,9 @@ export function getMissingParams(params: {
     [key: string]: any;
 }, requires: string[]): null | Error;
 
+// @public
+export function getNewLogger(moduleName: string): SDKLogger;
+
 // @public
 function getOptions(createRequestMock: any): any;
 
@@ -345,6 +350,20 @@ export function readExternalSources(serviceName: string): any;
 // @public
 export function removeSuffix(str: string, suffix: string): string;
 
+// @public (undocumented)
+export interface SDKLogger {
+    // (undocumented)
+    debug: Debugger;
+    // (undocumented)
+    error: Debugger;
+    // (undocumented)
+    info: Debugger;
+    // (undocumented)
+    verbose: Debugger;
+    // (undocumented)
+    warn: Debugger;
+}
+
 // @public
 export function streamToPromise(stream: Stream): Promise<any>;
 

package/ibm-cloud-sdk-core.d.ts

@@ -2,6 +2,7 @@
 
 import { AxiosInstance } from 'axios';
 import type { CookieJar } from 'tough-cookie';
+import { Debugger } from 'debug';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
@@ -158,6 +159,12 @@ export declare class BaseService {
       * @param {string} url The base URL for the service.
       */
      setServiceUrl(url: string): void;
+     /**
+      * Set the HTTP headers to be sent in every request.
+      *
+      * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+      */
+     setDefaultHeaders(headers: OutgoingHttpHeaders): void;
      /**
       * Turn request body compression on or off.
       *
@@ -713,6 +720,23 @@ export declare class BaseService {
                         [key: string]: any;
                     }, requires: string[]): null | Error;
 
+                    /**
+                     * Return a new logger, formatted with a particular name. The logging functions, in
+                     * order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.
+                     *
+                     * The logger will be an instance of the `debug` package and utilizes its support for
+                     * configuration with environment variables.
+                     *
+                     * Additionally, the logger will be turned on automatically if the "NODE_DEBUG"
+                     * environment variable is set to "axios".
+                     *
+                     * @param {string} moduleName - the namespace for the logger. The name will appear in
+                     * the logs and it will be the name used for configuring the log level.
+                     *
+                     * @returns {SDKLogger} the new logger
+                     */
+                    export declare function getNewLogger(moduleName: string): SDKLogger;
+
                     /**
                      * This method extracts the `options` property from the object passed into `createRequest`. This property is
                      * an object containing all of the SDK method-specific information (like `path` and `body`) used to build a request.
@@ -1228,6 +1252,14 @@ export declare class BaseService {
                                             maxRetryInterval?: number;
                                         }
 
+                                        export declare interface SDKLogger {
+                                            error: Debugger;
+                                            warn: Debugger;
+                                            info: Debugger;
+                                            verbose: Debugger;
+                                            debug: Debugger;
+                                        }
+
                                         /**
                                          * Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer
                                          * or array of text chunks

package/index.d.ts

@@ -24,3 +24,4 @@ export { default as qs } from './lib/querystring';
 export { default as contentType } from './lib/content-type';
 export * from './lib/stream-to-promise';
 export { unitTestUtils };
+export { getNewLogger, SDKLogger } from './lib/get-new-logger';

package/index.js

@@ -39,3 +39,5 @@ exports.qs = querystring_1.default;
 var content_type_1 = require("./lib/content-type");
 exports.contentType = content_type_1.default;
 __export(require("./lib/stream-to-promise"));
+var get_new_logger_1 = require("./lib/get-new-logger");
+exports.getNewLogger = get_new_logger_1.getNewLogger;

package/lib/base-service.d.ts

@@ -87,6 +87,12 @@ export declare class BaseService {
      * @param {string} url The base URL for the service.
      */
     setServiceUrl(url: string): void;
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     /**
      * Turn request body compression on or off.
      *

package/lib/base-service.js

@@ -106,6 +106,18 @@ var BaseService = /** @class */ (function () {
             this.baseOptions.serviceUrl = helper_1.stripTrailingSlash(url);
         }
     };
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    BaseService.prototype.setDefaultHeaders = function (headers) {
+        if (typeof headers !== 'object') {
+            // do nothing, for now
+            return;
+        }
+        this.baseOptions.headers = headers;
+    };
     /**
      * Turn request body compression on or off.
      *

package/lib/get-new-logger.d.ts

@@ -0,0 +1,39 @@
+/**
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Debugger } from 'debug';
+export interface SDKLogger {
+    error: Debugger;
+    warn: Debugger;
+    info: Debugger;
+    verbose: Debugger;
+    debug: Debugger;
+}
+/**
+ * Return a new logger, formatted with a particular name. The logging functions, in
+ * order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.
+ *
+ * The logger will be an instance of the `debug` package and utilizes its support for
+ * configuration with environment variables.
+ *
+ * Additionally, the logger will be turned on automatically if the "NODE_DEBUG"
+ * environment variable is set to "axios".
+ *
+ * @param {string} moduleName - the namespace for the logger. The name will appear in
+ * the logs and it will be the name used for configuring the log level.
+ *
+ * @returns {SDKLogger} the new logger
+ */
+export declare function getNewLogger(moduleName: string): SDKLogger;

package/lib/get-new-logger.js

@@ -0,0 +1,68 @@
+"use strict";
+/**
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var debug_1 = __importDefault(require("debug"));
+/**
+ * Return a new logger, formatted with a particular name. The logging functions, in
+ * order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.
+ *
+ * The logger will be an instance of the `debug` package and utilizes its support for
+ * configuration with environment variables.
+ *
+ * Additionally, the logger will be turned on automatically if the "NODE_DEBUG"
+ * environment variable is set to "axios".
+ *
+ * @param {string} moduleName - the namespace for the logger. The name will appear in
+ * the logs and it will be the name used for configuring the log level.
+ *
+ * @returns {SDKLogger} the new logger
+ */
+function getNewLogger(moduleName) {
+    var debug = debug_1.default(moduleName + ":debug");
+    var error = debug_1.default(moduleName + ":error");
+    var info = debug_1.default(moduleName + ":info");
+    var verbose = debug_1.default(moduleName + ":verbose");
+    var warn = debug_1.default(moduleName + ":warning");
+    // enable loggers if axios flag is set & mimic log levels severity
+    if (process.env.NODE_DEBUG === 'axios') {
+        debug.enabled = true;
+    }
+    if (debug.enabled) {
+        verbose.enabled = true;
+    }
+    if (verbose.enabled) {
+        info.enabled = true;
+    }
+    if (info.enabled) {
+        warn.enabled = true;
+    }
+    if (warn.enabled) {
+        error.enabled = true;
+    }
+    var newLogger = {
+        debug: debug,
+        error: error,
+        info: info,
+        verbose: verbose,
+        warn: warn,
+    };
+    return newLogger;
+}
+exports.getNewLogger = getNewLogger;

package/lib/logger.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,12 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import logger from 'debug';
-declare const _default: {
-    debug: logger.Debugger;
-    error: logger.Debugger;
-    info: logger.Debugger;
-    verbose: logger.Debugger;
-    warn: logger.Debugger;
-};
+declare const _default: import("./get-new-logger").SDKLogger;
 export default _default;

package/lib/logger.js

@@ -1,6 +1,6 @@
 "use strict";
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,37 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-var debug_1 = __importDefault(require("debug"));
-var debug = debug_1.default('ibm-cloud-sdk-core:debug');
-var error = debug_1.default('ibm-cloud-sdk-core:error');
-var info = debug_1.default('ibm-cloud-sdk-core:info');
-var verbose = debug_1.default('ibm-cloud-sdk-core:verbose');
-var warn = debug_1.default('ibm-cloud-sdk-core:warning');
-// enable loggers if axios flag is set & mimic log levels severity
-if (process.env.NODE_DEBUG === 'axios') {
-    debug.enabled = true;
-}
-if (debug.enabled) {
-    verbose.enabled = true;
-}
-if (verbose.enabled) {
-    info.enabled = true;
-}
-if (info.enabled) {
-    warn.enabled = true;
-}
-if (warn.enabled) {
-    error.enabled = true;
-}
-// export loggers;
-exports.default = {
-    debug: debug,
-    error: error,
-    info: info,
-    verbose: verbose,
-    warn: warn,
-};
+var get_new_logger_1 = require("./get-new-logger");
+exports.default = get_new_logger_1.getNewLogger('ibm-cloud-sdk-core');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "3.0.1",
+  "version": "3.2.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",

package/temp/ibm-cloud-sdk-core.api.json

@@ -1088,6 +1088,53 @@
               "parameters": [],
               "name": "getHttpClient"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
+              "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - The map of headers to include in requests.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDefaultHeaders(headers: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutgoingHttpHeaders",
+                  "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "headers",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setDefaultHeaders"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#setEnableGzipCompression:member(1)",
@@ -3355,6 +3402,51 @@
           ],
           "name": "getMissingParams"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "ibm-cloud-sdk-core!getNewLogger:function(1)",
+          "docComment": "/**\n * Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`, `warn`, `info`, `verbose`, and `debug`.\n *\n * The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.\n *\n * Additionally, the logger will be turned on automatically if the \"NODE_DEBUG\" environment variable is set to \"axios\".\n *\n * @param moduleName - the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.\n *\n * @returns {SDKLogger} the new logger\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getNewLogger(moduleName: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "SDKLogger",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "moduleName",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "getNewLogger"
+        },
         {
           "kind": "Function",
           "canonicalReference": "ibm-cloud-sdk-core!getQueryParam:function(1)",
@@ -5196,6 +5288,157 @@
           ],
           "name": "removeSuffix"
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "ibm-cloud-sdk-core!SDKLogger:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface SDKLogger "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "SDKLogger",
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#debug:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "debug: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Debugger",
+                  "canonicalReference": "@types/debug!~debug.Debugger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "debug",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#error:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "error: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Debugger",
+                  "canonicalReference": "@types/debug!~debug.Debugger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "error",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#info:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "info: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Debugger",
+                  "canonicalReference": "@types/debug!~debug.Debugger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "info",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#verbose:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "verbose: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Debugger",
+                  "canonicalReference": "@types/debug!~debug.Debugger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "verbose",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "ibm-cloud-sdk-core!SDKLogger#warn:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "warn: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Debugger",
+                  "canonicalReference": "@types/debug!~debug.Debugger:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "warn",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Function",
           "canonicalReference": "ibm-cloud-sdk-core!streamToPromise:function(1)",

package/temp/ibm-cloud-sdk-core.api.md

@@ -8,6 +8,7 @@
 
 import { AxiosInstance } from 'axios';
 import type { CookieJar } from 'tough-cookie';
+import { Debugger } from 'debug';
 import { OutgoingHttpHeaders } from 'http';
 import { Stream } from 'stream';
 
@@ -64,6 +65,7 @@ export class BaseService {
     enableRetries(retryOptions?: RetryOptions): void;
     getAuthenticator(): any;
     getHttpClient(): AxiosInstance;
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     setEnableGzipCompression(setting: boolean): void;
     setServiceUrl(url: string): void;
 }
@@ -226,6 +228,9 @@ export function getMissingParams(params: {
     [key: string]: any;
 }, requires: string[]): null | Error;
 
+// @public
+export function getNewLogger(moduleName: string): SDKLogger;
+
 // @public
 function getOptions(createRequestMock: any): any;
 
@@ -345,6 +350,20 @@ export function readExternalSources(serviceName: string): any;
 // @public
 export function removeSuffix(str: string, suffix: string): string;
 
+// @public (undocumented)
+export interface SDKLogger {
+    // (undocumented)
+    debug: Debugger;
+    // (undocumented)
+    error: Debugger;
+    // (undocumented)
+    info: Debugger;
+    // (undocumented)
+    verbose: Debugger;
+    // (undocumented)
+    warn: Debugger;
+}
+
 // @public
 export function streamToPromise(stream: Stream): Promise<any>;