@ama-sdk/core 10.0.0-next.8 → 11.0.0-next.0

package/esm2015/fwk/errors.js

@@ -138,10 +138,9 @@ function _create_super(Derived) {
     var _super = _create_super(GenericError);
     function GenericError(message, context) {
         _class_call_check(this, GenericError);
-        var _context, _context1;
         var httpRegexp = /^https?:\/\//;
-        var baseUrl = ((_context = context) === null || _context === void 0 ? void 0 : _context.url) ? context.url.replace(httpRegexp, "") : "unknown";
-        var origin = ((_context1 = context) === null || _context1 === void 0 ? void 0 : _context1.origin) ? context.origin.replace(httpRegexp, "") : "unknown";
+        var baseUrl = (context === null || context === void 0 ? void 0 : context.url) ? context.url.replace(httpRegexp, "") : "unknown";
+        var origin = (context === null || context === void 0 ? void 0 : context.origin) ? context.origin.replace(httpRegexp, "") : "unknown";
         return _super.call(this, context ? "[SDK] [apiName: ".concat(context.apiName || "unknown", "] [operationId: ").concat(context.operationId || "unknown", "] [baseUrl: ").concat(baseUrl, "] [origin: ").concat(origin, "] [errorType: SDK] ").concat(message) : "[SDK] ".concat(message));
     }
     return GenericError;

package/esm2015/fwk/index.js

@@ -5,5 +5,6 @@ export * from "./core/index";
 export * from "./date";
 export * from "./errors";
 export * from "./ignore-enum.type";
+export * from "./logger";
 export * from "./mocks/index";
 export * from "./Reviver";

package/esm2015/fwk/logger.js

@@ -0,0 +1,6 @@
+/**
+ * Logger Client interface.
+ *
+ * Duplicate from [@o3r/core]{@link https://github.com/AmadeusITGroup/otter/blob/main/packages/%40o3r/core/src/log/logger.ts}
+ * All modifications should be made in both interfaces
+ */ export { };

package/esm2015/fwk/mocks/alf-mock-adapter.js

@@ -193,7 +193,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
  */ var requestResponseJsonRegexp = RegExp(/(^{.*}$)/m);
 /**
  * Split the logs
- *
  * @param log alf log
  * @returns an array containing one message each
  */ function splitCalls(log) {
@@ -201,7 +200,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
 }
 /**
  * Get AlfCall corresponding to this log if it is a request received by the SI
- *
  * @param log alf log
  * @param corrId correlationId
  * @param operationAdapter operation adapter to bind each request with its operationId
@@ -227,7 +225,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
 }
 /**
  * Returns true if log is detected as a HTTP response
- *
  * @param log alf log
  * @returns true if found
  */ function isResponse(log) {
@@ -236,7 +233,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
 }
 /**
  * Return JSON data found
- *
  * @param log alf log
  * @returns JSON data that can be either the request or the response
  */ function getData(log) {
@@ -247,7 +243,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
  * Retrieve path from logPath and parse it to find all the calls.
  * If the logs file contains more than one entry point this methods will separate them in Steps.
  * First call will represent the request and last call the response.
- *
  * @param log Content of the alf logs
  * @param operationAdapter operation adapter to bind each request/response with its operationId
  * @returns an array of AlfCall found in the logs
@@ -260,10 +255,9 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
     try {
         var _loop = function() {
             var callMatch = _step.value;
-            var _match;
             // we look for corrID to be able to match request and response
             var match = callMatch.match(correlationIdRegex);
-            var corrId = (_match = match) === null || _match === void 0 ? void 0 : _match[1];
+            var corrId = match === null || match === void 0 ? void 0 : match[1];
             if (!corrId) {
                 // without correlationId it will be impossible to match the response with the request
                 return "continue";
@@ -309,7 +303,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
 }
 /**
  * Build the actual mock map corresponding to these alfCalls
- *
  * @param log Content of the alf logs
  * @param operationAdapter operation adapter to bind each request/response with its operationId
  * @returns mock map, key is the operation id, value is an array of the API replies
@@ -332,7 +325,6 @@ import { SequentialMockAdapter } from "./sequential-mock-adapter";
 }
 /**
  * Get the mock adapter corresponding to the logs retrieved from ALF
- *
  * @param binFilePath the path to the file containing the logs downloaded from Alf in .bin format
  * @param operationAdapter an array of PathObject or a function that returns an array of PathObject or a Promise that resolves to an array of PathObject, to map request with their operationId
  * @returns a sequential mock adapter containing each response found in Alf

package/esm2015/fwk/mocks/base-mock-adapter.js

@@ -186,18 +186,6 @@ import { getOperationId, getPath } from "./helpers";
                 return id;
             }
         },
-        {
-            key: "getOperationId",
-            value: /**
-   * @inheritDoc
-   */ function getOperationId(request) {
-                if (typeof this.pathObjects === "function") {
-                    throw new Error("The pathObjects argument must be of type PathObject[]");
-                }
-                var object = getPath(request.basePath, this.pathObjects, request.method);
-                return this.extractOperationIdFromPath(request, object);
-            }
-        },
         {
             key: "retrieveOperationId",
             value: /**

package/esm2015/fwk/mocks/encoded-api-request.js

@@ -1 +1,3 @@
-export { };
+/**
+ * Defines an API request encoded
+ */ export { };

package/esm2015/fwk/mocks/helpers.js

@@ -1,6 +1,5 @@
 /**
  * Gets an operation ID from a path object and HTTP method
- *
  * @param pathObject the path object to check on
  * @param method the HTTP method
  */ export function getOperationId(pathObject, method) {
@@ -15,7 +14,6 @@
 }
 /**
  * Gets a PathObject from a requested URL
- *
  * @param requestUrl the URL string
  * @param pathObjects the list of available path objects
  * @param method the optional HTTP method used in case of several matches

package/esm2015/fwk/mocks/mock-adapter.js

@@ -1 +1 @@
-export { };
+/** Describes an adapter for mocking */ export { };

package/esm2015/fwk/mocks/path-object.js

@@ -1 +1 @@
-export { };
+/** Describes a path on the swagger specification */ export { };

package/esm2015/plugins/additional-params/additional-params.request.js

@@ -88,13 +88,13 @@ function _ts_generator(thisArg, body) {
         trys: [],
         ops: []
     };
-    return(g = {
+    return g = {
         next: verb(0),
         "throw": verb(1),
         "return": verb(2)
     }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
         return this;
-    }), g);
+    }), g;
     function verb(n) {
         return function(v) {
             return step([
@@ -176,7 +176,6 @@ function _ts_generator(thisArg, body) {
 /**
  * Check if the value is a string or undefined.
  * Used to determine the request body type at runtime.
- *
  * @param value
  */ export function isStringOrUndefined(value) {
     var type = typeof value === "undefined" ? "undefined" : _type_of(value);

package/esm2015/plugins/api-configuration-override/api-configuration-override.request.js

@@ -69,13 +69,13 @@ function _ts_generator(thisArg, body) {
         trys: [],
         ops: []
     };
-    return(g = {
+    return g = {
         next: verb(0),
         "throw": verb(1),
         "return": verb(2)
     }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
         return this;
-    }), g);
+    }), g;
     function verb(n) {
         return function(v) {
             return step([
@@ -157,7 +157,6 @@ function _ts_generator(thisArg, body) {
 /**
  *  The purpose of this plugin is to allow to send an encrypted JWT which overrides the configuration used by Digital Commerce.
  *  The plugin takes an already encoded JWT (JWS) and add it in an instance of `ama-client-facts` header.
- *
  *  @note this is the default value for the header name. It can be customized at plugin initialization time.
  */ export var ApiConfigurationOverride = /*#__PURE__*/ function() {
     "use strict";

package/esm2015/plugins/api-key/api-key.request.js

@@ -69,13 +69,13 @@ function _ts_generator(thisArg, body) {
         trys: [],
         ops: []
     };
-    return(g = {
+    return g = {
         next: verb(0),
         "throw": verb(1),
         "return": verb(2)
     }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
         return this;
-    }), g);
+    }), g;
     function verb(n) {
         return function(v) {
             return step([

package/esm2015/plugins/bot-protection-fingerprint/bot-protection-fingerprint.request.js

@@ -69,13 +69,13 @@ function _ts_generator(thisArg, body) {
         trys: [],
         ops: []
     };
-    return(g = {
+    return g = {
         next: verb(0),
         "throw": verb(1),
         "return": verb(2)
     }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
         return this;
-    }), g);
+    }), g;
     function verb(n) {
         return function(v) {
             return step([
@@ -154,29 +154,10 @@ function _ts_generator(thisArg, body) {
         };
     }
 }
-/**
- * Implementation of a retriever based on a cookie.
- * Creates a reused RegExp based on the cookieName and tries to extract its value from document.cookie.
- *
- * @param cookieName Name of the cookie to search for
- * @deprecated Imperva integration should rely on the latest impervaProtectionRetrieverFactory
- */ export function cookieRetrieverFactory(cookieName) {
-    var cookieRegExp = new RegExp("(?:^|;)\\s*".concat(cookieName, "\\s*=\\s*([^;]+)"));
-    return function() {
-        if (typeof document === "undefined") {
-            throw new Error('[SDK][Plug-in][BotProtectionFingerprintRequest] Trying to use cookieRetrieverFactory but "document" is not defined.');
-        }
-        var cookieMatcher = document.cookie && document.cookie.match(cookieRegExp);
-        if (cookieMatcher) {
-            return cookieMatcher[cookieMatcher.length - 1];
-        }
-    };
-}
 /**
  * Implementation based on Imperva's SPA integration feature developed for Amadeus.
  * This relies on a custom window property protectionLoaded that we feed with a callback that Imperva calls when the ABP script is loaded or when the callback is attached.
  * This callback is called with the Protection object used internally by the ABP that exposes a __token()__ function that returns a Promise of the most up-to-date token.
- *
  * @param protectionTimeout How long the retrieve will wait for the onProtectionLoaded event to be fired
  * @param tokenTimeout How long the ABP script will wait for a new token before rejecting the promise
  */ export function impervaProtectionRetrieverFactory(protectionTimeout, tokenTimeout) {
@@ -196,73 +177,77 @@ function _ts_generator(thisArg, body) {
             };
         });
     };
-    return /*#__PURE__*/ _async_to_generator(function() {
-        var e, e1;
-        return _ts_generator(this, function(_state) {
-            switch(_state.label){
-                case 0:
-                    if (!!protection) return [
-                        3,
-                        4
-                    ];
-                    _state.label = 1;
-                case 1:
-                    _state.trys.push([
-                        1,
-                        3,
-                        ,
-                        4
-                    ]);
-                    return [
-                        4,
-                        getProtection()
-                    ];
-                case 2:
-                    protection = _state.sent();
-                    return [
-                        3,
-                        4
-                    ];
-                case 3:
-                    e = _state.sent();
-                    console.warn(e);
-                    return [
-                        2
-                    ];
-                case 4:
-                    _state.trys.push([
-                        4,
-                        6,
-                        ,
-                        7
-                    ]);
-                    return [
-                        4,
-                        protection.token(tokenTimeout)
-                    ];
-                case 5:
-                    return [
-                        2,
-                        _state.sent()
-                    ];
-                case 6:
-                    e1 = _state.sent();
-                    console.warn("[SDK][Plug-in][BotProtectionFingerprintRequest] Timeout: no Token was received in time.");
-                    return [
-                        2
-                    ];
-                case 7:
-                    return [
-                        2
-                    ];
-            }
+    return function() {
+        var _ref = _async_to_generator(function(logger) {
+            var e, e1;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        if (!!protection) return [
+                            3,
+                            4
+                        ];
+                        _state.label = 1;
+                    case 1:
+                        _state.trys.push([
+                            1,
+                            3,
+                            ,
+                            4
+                        ]);
+                        return [
+                            4,
+                            getProtection()
+                        ];
+                    case 2:
+                        protection = _state.sent();
+                        return [
+                            3,
+                            4
+                        ];
+                    case 3:
+                        e = _state.sent();
+                        (logger || console).error(e);
+                        return [
+                            2
+                        ];
+                    case 4:
+                        _state.trys.push([
+                            4,
+                            6,
+                            ,
+                            7
+                        ]);
+                        return [
+                            4,
+                            protection.token(tokenTimeout)
+                        ];
+                    case 5:
+                        return [
+                            2,
+                            _state.sent()
+                        ];
+                    case 6:
+                        e1 = _state.sent();
+                        (logger || console).error("[SDK][Plug-in][BotProtectionFingerprintRequest] Timeout: no Token was received in time.");
+                        return [
+                            2
+                        ];
+                    case 7:
+                        return [
+                            2
+                        ];
+                }
+            });
         });
-    });
+        return function(logger) {
+            return _ref.apply(this, arguments);
+        };
+    }();
 }
 /**
  * Implementation of a retriever for Akamai based on bmak object from window or as parameter.
  * Will return the telemetry, or undefined if bmak object is not found
- *
  * @param bmakOpt BMak object from Akamai. Default to `window.bmak` on browser if not provided.
  */ export function akamaiTelemetryRetrieverFactory(bmakOpt) {
     var bmak = bmakOpt || (typeof window !== "undefined" ? window.bmak : undefined);
@@ -273,37 +258,15 @@ function _ts_generator(thisArg, body) {
         return bmak.get_telemetry();
     };
 }
-/**
- * Implementation of a retriever based on the way Imperva stores the fingerprint information in localStorage.
- * Since it contains the expiry time of the fingerprint we are able to ignore it if it has to be recomputed.
- *
- * @param storageKey The name of the property in local storage where the fingerprint is saved
- * @param ignoreExpired Return the fingerprint even if it is expired. Default: false
- * @deprecated Imperva integration should rely on the latest impervaProtectionRetrieverFactory
- */ export function impervaLocalStorageRetrieverFactory(storageKey) {
-    var ignoreExpired = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : false;
-    return function() {
-        if (typeof localStorage === "undefined") {
-            throw new Error("[SDK][Plug-in][BotProtectionFingerprintRequest] Trying to use localStorageRetrieverFactory but localStorage is not defined.");
-        }
-        var storedFingerprint = localStorage.getItem(storageKey);
-        try {
-            var parsedFingerprint = storedFingerprint && JSON.parse(storedFingerprint);
-            if (parsedFingerprint && (ignoreExpired || parsedFingerprint.renewTime && parsedFingerprint.renewTime >= Date.now())) {
-                return parsedFingerprint.token;
-            }
-        } catch (e) {}
-    };
-}
 /**
  * Plug-in that allows to interact with Anti-Bot protection tools fingerprint like following:
- *   - Wait for the fingerprint to be present in the document before sending any call
- *   - Forward the fingerprint in a chosen request header with all the calls
+ * - Wait for the fingerprint to be present in the document before sending any call
+ * - Forward the fingerprint in a chosen request header with all the calls
  *
  * This plugin is modular and must be instantiated with the logic that retrieves the fingerprint value, also called {@link BotProtectionFingerprintRetriever}.
  * This file exports two factories of {@link BotProtectionFingerprintRetriever} to cover our two most common usecases:
- *  - Imperva ABP
- *  - Akamai telemetry
+ * - Imperva ABP
+ * - Akamai telemetry
  * But you can also provide your own logic.
  *
  * In case this logic is unpredictable or subject to race conditions, you can configure a poller that will retry a maximum of N times every X milliseconds.
@@ -315,9 +278,8 @@ function _ts_generator(thisArg, body) {
  * authentication calls also contain the fingerprint.
  * You can reuse the same instance that you give to the SDK, or create a simpler instance without a poller in case you
  * make sure to load this plug-in before the AmadeusGatewayTokenRequestPlugin.
- *
  * @example Reusing the same instance
- *
+ * ```typescript
  * export function apiFactory(eventTrackService: EventTrackService): ApiManager {
  *   const botProtection = new BotProtectionFingerprintRequest({
  *     destinationHeaderName: 'X-D-Token',
@@ -343,18 +305,22 @@ function _ts_generator(thisArg, body) {
  *     LoggingApi: {basePath: '/api'}
  *   });
  * }
+ * ```
  * @example Using a custom FingerprintRetriever
- *
+ * ```typescript
  * const botProtection = new BotProtectionFingerprintRequest({
  *   destinationHeaderName: 'X-D-Token',
  *   fingerprintRetriever: () => 'test'
  * });
- * @example For akamai
+ * ```
  *
+ * @example For akamai
+ * ```typescript
  * const botProtection = new BotProtectionFingerprintRequest({
  *   destinationHeaderName: 'Akamai-BM-Telemetry',
  *   fingerprintRetriever: akamaiTelemetryRetrieverFactory()
  * });
+ * ```
  */ export var BotProtectionFingerprintRequest = /*#__PURE__*/ function() {
     "use strict";
     function BotProtectionFingerprintRequest(options) {
@@ -375,7 +341,7 @@ function _ts_generator(thisArg, body) {
    * configured in the BotProtectionFingerprintPollerOptions.
    *
    * If pollOnlyOnce is set to true, the poller won't be executed again after it has been fully executed once.
-   */ function waitForFingerprint() {
+   */ function waitForFingerprint(logger) {
                 var _this = this;
                 return _async_to_generator(function() {
                     var pollerOptions, i, fingerprint;
@@ -386,7 +352,7 @@ function _ts_generator(thisArg, body) {
                                 if (pollerOptions === undefined || _this.options.pollOnlyOnce !== false && _this.hasPolled) {
                                     return [
                                         2,
-                                        _this.options.fingerprintRetriever()
+                                        _this.options.fingerprintRetriever(logger)
                                     ];
                                 }
                                 i = pollerOptions.maximumTries - 1;
@@ -398,7 +364,7 @@ function _ts_generator(thisArg, body) {
                                 ];
                                 return [
                                     4,
-                                    _this.options.fingerprintRetriever()
+                                    _this.options.fingerprintRetriever(logger)
                                 ];
                             case 2:
                                 fingerprint = _state.sent();
@@ -440,7 +406,7 @@ function _ts_generator(thisArg, body) {
         },
         {
             key: "load",
-            value: function load() {
+            value: /** @inheritdoc */ function load(context) {
                 var _this = this;
                 return {
                     transform: function() {
@@ -451,7 +417,7 @@ function _ts_generator(thisArg, body) {
                                     case 0:
                                         return [
                                             4,
-                                            _this.waitForFingerprint()
+                                            _this.waitForFingerprint(context === null || context === void 0 ? void 0 : context.logger)
                                         ];
                                     case 1:
                                         fingerprint = _state.sent();