ibm-cloud-sdk-core 3.2.2-beta-1 → 3.2.2-beta-3

package/es/lib/cookie-support.d.ts

@@ -0,0 +1,23 @@
+/**
+ * (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 { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { CookieJar } from 'tough-cookie';
+export declare class CookieInterceptor {
+    private readonly cookieJar;
+    constructor(cookieJar: CookieJar | boolean);
+    requestInterceptor(config: AxiosRequestConfig): Promise<AxiosRequestConfig<any>>;
+    responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
+}

package/es/lib/cookie-support.js

@@ -0,0 +1,87 @@
+/**
+ * (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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import extend from 'extend';
+import { CookieJar } from 'tough-cookie';
+import logger from './logger';
+export class CookieInterceptor {
+    constructor(cookieJar) {
+        if (cookieJar) {
+            if (cookieJar === true) {
+                logger.debug('CookieInterceptor: creating new CookieJar');
+                this.cookieJar = new CookieJar();
+            }
+            else {
+                logger.debug('CookieInterceptor: using supplied CookieJar');
+                this.cookieJar = cookieJar;
+            }
+        }
+        else {
+            throw new Error('Must supply a cookie jar or true.');
+        }
+    }
+    requestInterceptor(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug('CookieInterceptor: intercepting request');
+            if (config && config.url) {
+                logger.debug(`CookieInterceptor: getting cookies for: ${config.url}`);
+                const cookieHeaderValue = yield this.cookieJar.getCookieString(config.url);
+                if (cookieHeaderValue) {
+                    logger.debug('CookieInterceptor: setting cookie header');
+                    const cookieHeader = { cookie: cookieHeaderValue };
+                    config.headers = extend(true, {}, config.headers, cookieHeader);
+                }
+                else {
+                    logger.debug(`CookieInterceptor: no cookies for: ${config.url}`);
+                }
+            }
+            else {
+                logger.debug('CookieInterceptor: no request URL.');
+            }
+            return config;
+        });
+    }
+    responseInterceptor(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            logger.debug('CookieInterceptor: intercepting response.');
+            if (response && response.headers) {
+                logger.debug('CookieInterceptor: checking for set-cookie headers.');
+                const cookies = response.headers['set-cookie'];
+                if (cookies) {
+                    logger.debug('CookieInterceptor: setting cookies in jar.');
+                    cookies.forEach((cookie) => __awaiter(this, void 0, void 0, function* () {
+                        yield this.cookieJar.setCookie(cookie, response.request.url);
+                    }));
+                }
+                else {
+                    logger.debug('CookieInterceptor: no set-cookie headers.');
+                }
+            }
+            else {
+                logger.debug('CookieInterceptor: no response headers.');
+            }
+            return response;
+        });
+    }
+}

package/es/lib/request-wrapper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/es/lib/request-wrapper.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,17 +25,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
  */
 import axios from 'axios';
 import * as rax from 'retry-axios';
-import { wrapper as axiosCookieJarSupport } from 'axios-cookiejar-support';
 import extend from 'extend';
 import FormData from 'form-data';
 import { Agent } from 'https';
 import isStream from 'isstream';
 import { stringify } from 'querystring';
 import { gzipSync } from 'zlib';
-import { CookieJar } from 'tough-cookie';
 import { buildRequestFileObject, isEmptyObject, isFileData, isFileWithMetadata, stripTrailingSlash, } from './helper';
 import logger from './logger';
 import { streamToPromise } from './stream-to-promise';
+import { CookieInterceptor } from './cookie-support';
 export class RequestWrapper {
     constructor(axiosOptions) {
         axiosOptions = axiosOptions || {};
@@ -73,16 +72,9 @@ export class RequestWrapper {
         });
         // if a cookie jar is provided, wrap the axios instance and update defaults
         if (axiosOptions.jar) {
-            axiosCookieJarSupport(this.axiosInstance);
-            // axios-cookiejar-support < 2.x accepted a boolean
-            // some SDKs might be using that, so create a default
-            // CookieJar if detecting true.
-            if (axiosOptions.jar === true) {
-                this.axiosInstance.defaults.jar = new CookieJar();
-            }
-            else {
-                this.axiosInstance.defaults.jar = axiosOptions.jar;
-            }
+            const cookieInterceptor = new CookieInterceptor(axiosOptions.jar);
+            this.axiosInstance.interceptors.request.use((config) => cookieInterceptor.requestInterceptor(config));
+            this.axiosInstance.interceptors.response.use((response) => cookieInterceptor.responseInterceptor(response));
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {

package/lib/cookie-support.d.ts

@@ -0,0 +1,23 @@
+/**
+ * (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 { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { CookieJar } from 'tough-cookie';
+export declare class CookieInterceptor {
+    private readonly cookieJar;
+    constructor(cookieJar: CookieJar | boolean);
+    requestInterceptor(config: AxiosRequestConfig): Promise<AxiosRequestConfig<any>>;
+    responseInterceptor(response: AxiosResponse): Promise<AxiosResponse<any, any>>;
+}

package/lib/cookie-support.js

@@ -0,0 +1,141 @@
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CookieInterceptor = void 0;
+var extend_1 = __importDefault(require("extend"));
+var tough_cookie_1 = require("tough-cookie");
+var logger_1 = __importDefault(require("./logger"));
+var CookieInterceptor = /** @class */ (function () {
+    function CookieInterceptor(cookieJar) {
+        if (cookieJar) {
+            if (cookieJar === true) {
+                logger_1.default.debug('CookieInterceptor: creating new CookieJar');
+                this.cookieJar = new tough_cookie_1.CookieJar();
+            }
+            else {
+                logger_1.default.debug('CookieInterceptor: using supplied CookieJar');
+                this.cookieJar = cookieJar;
+            }
+        }
+        else {
+            throw new Error('Must supply a cookie jar or true.');
+        }
+    }
+    CookieInterceptor.prototype.requestInterceptor = function (config) {
+        return __awaiter(this, void 0, void 0, function () {
+            var cookieHeaderValue, cookieHeader;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        logger_1.default.debug('CookieInterceptor: intercepting request');
+                        if (!(config && config.url)) return [3 /*break*/, 2];
+                        logger_1.default.debug("CookieInterceptor: getting cookies for: ".concat(config.url));
+                        return [4 /*yield*/, this.cookieJar.getCookieString(config.url)];
+                    case 1:
+                        cookieHeaderValue = _a.sent();
+                        if (cookieHeaderValue) {
+                            logger_1.default.debug('CookieInterceptor: setting cookie header');
+                            cookieHeader = { cookie: cookieHeaderValue };
+                            config.headers = (0, extend_1.default)(true, {}, config.headers, cookieHeader);
+                        }
+                        else {
+                            logger_1.default.debug("CookieInterceptor: no cookies for: ".concat(config.url));
+                        }
+                        return [3 /*break*/, 3];
+                    case 2:
+                        logger_1.default.debug('CookieInterceptor: no request URL.');
+                        _a.label = 3;
+                    case 3: return [2 /*return*/, config];
+                }
+            });
+        });
+    };
+    CookieInterceptor.prototype.responseInterceptor = function (response) {
+        return __awaiter(this, void 0, void 0, function () {
+            var cookies;
+            var _this = this;
+            return __generator(this, function (_a) {
+                logger_1.default.debug('CookieInterceptor: intercepting response.');
+                if (response && response.headers) {
+                    logger_1.default.debug('CookieInterceptor: checking for set-cookie headers.');
+                    cookies = response.headers['set-cookie'];
+                    if (cookies) {
+                        logger_1.default.debug('CookieInterceptor: setting cookies in jar.');
+                        cookies.forEach(function (cookie) { return __awaiter(_this, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, this.cookieJar.setCookie(cookie, response.request.url)];
+                                    case 1:
+                                        _a.sent();
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); });
+                    }
+                    else {
+                        logger_1.default.debug('CookieInterceptor: no set-cookie headers.');
+                    }
+                }
+                else {
+                    logger_1.default.debug('CookieInterceptor: no response headers.');
+                }
+                return [2 /*return*/, response];
+            });
+        });
+    };
+    return CookieInterceptor;
+}());
+exports.CookieInterceptor = CookieInterceptor;

package/lib/request-wrapper.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/lib/request-wrapper.js

@@ -76,7 +76,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestWrapper = void 0;
 /**
- * (C) Copyright IBM Corp. 2014, 2021.
+ * (C) Copyright IBM Corp. 2014, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -92,17 +92,16 @@ exports.RequestWrapper = void 0;
  */
 var axios_1 = __importDefault(require("axios"));
 var rax = __importStar(require("retry-axios"));
-var axios_cookiejar_support_1 = require("axios-cookiejar-support");
 var extend_1 = __importDefault(require("extend"));
 var form_data_1 = __importDefault(require("form-data"));
 var https_1 = require("https");
 var isstream_1 = __importDefault(require("isstream"));
 var querystring_1 = require("querystring");
 var zlib_1 = require("zlib");
-var tough_cookie_1 = require("tough-cookie");
 var helper_1 = require("./helper");
 var logger_1 = __importDefault(require("./logger"));
 var stream_to_promise_1 = require("./stream-to-promise");
+var cookie_support_1 = require("./cookie-support");
 var RequestWrapper = /** @class */ (function () {
     function RequestWrapper(axiosOptions) {
         var _this = this;
@@ -141,16 +140,13 @@ var RequestWrapper = /** @class */ (function () {
         });
         // if a cookie jar is provided, wrap the axios instance and update defaults
         if (axiosOptions.jar) {
-            (0, axios_cookiejar_support_1.wrapper)(this.axiosInstance);
-            // axios-cookiejar-support < 2.x accepted a boolean
-            // some SDKs might be using that, so create a default
-            // CookieJar if detecting true.
-            if (axiosOptions.jar === true) {
-                this.axiosInstance.defaults.jar = new tough_cookie_1.CookieJar();
-            }
-            else {
-                this.axiosInstance.defaults.jar = axiosOptions.jar;
-            }
+            var cookieInterceptor_1 = new cookie_support_1.CookieInterceptor(axiosOptions.jar);
+            this.axiosInstance.interceptors.request.use(function (config) {
+                return cookieInterceptor_1.requestInterceptor(config);
+            });
+            this.axiosInstance.interceptors.response.use(function (response) {
+                return cookieInterceptor_1.responseInterceptor(response);
+            });
         }
         // get retry config properties and conditionally enable retries
         if (axiosOptions.enableRetries) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "3.2.2-beta-1",
+  "version": "3.2.2-beta-3",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "./index.js",
   "typings": "./es/index.d.ts",
@@ -77,7 +77,6 @@
     "@types/node": "~10.14.19",
     "@types/tough-cookie": "^4.0.0",
     "axios": "1.2.0",
-    "axios-cookiejar-support": "4.0.3",
     "camelcase": "^5.3.1",
     "debug": "^4.1.1",
     "dotenv": "^6.2.0",