@kontent-ai/core-sdk 10.1.1 → 10.2.0

package/dist/cjs/helpers/header.helper.d.ts

@@ -1,13 +1,13 @@
-import { ISDKInfo } from '../models';
-import { IHeader } from '../http/http.models';
-export declare class HeaderHelper {
-    /**
-    * Header name for SDK usage
-    */
-    private readonly sdkVersionHeader;
-    /**
-    * Header identifying SDK type & version for internal purposes of Kontent.ai
-    */
-    getSdkIdHeader(info: ISDKInfo): IHeader;
-}
-export declare const headerHelper: HeaderHelper;
+import { ISDKInfo } from '../models';
+import { IHeader } from '../http/http.models';
+export declare class HeaderHelper {
+    /**
+    * Header name for SDK usage
+    */
+    private readonly sdkVersionHeader;
+    /**
+    * Header identifying SDK type & version for internal purposes of Kontent.ai
+    */
+    getSdkIdHeader(info: ISDKInfo): IHeader;
+}
+export declare const headerHelper: HeaderHelper;

package/dist/cjs/helpers/header.helper.js

@@ -1,23 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.headerHelper = exports.HeaderHelper = void 0;
-class HeaderHelper {
-    constructor() {
-        /**
-        * Header name for SDK usage
-        */
-        this.sdkVersionHeader = 'X-KC-SDKID';
-    }
-    /**
-    * Header identifying SDK type & version for internal purposes of Kontent.ai
-    */
-    getSdkIdHeader(info) {
-        return {
-            header: this.sdkVersionHeader,
-            value: `${info.host};${info.name};${info.version}`
-        };
-    }
-}
-exports.HeaderHelper = HeaderHelper;
-exports.headerHelper = new HeaderHelper();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.headerHelper = exports.HeaderHelper = void 0;
+class HeaderHelper {
+    constructor() {
+        /**
+        * Header name for SDK usage
+        */
+        this.sdkVersionHeader = 'X-KC-SDKID';
+    }
+    /**
+    * Header identifying SDK type & version for internal purposes of Kontent.ai
+    */
+    getSdkIdHeader(info) {
+        return {
+            header: this.sdkVersionHeader,
+            value: `${info.host};${info.name};${info.version}`
+        };
+    }
+}
+exports.HeaderHelper = HeaderHelper;
+exports.headerHelper = new HeaderHelper();
 //# sourceMappingURL=header.helper.js.map

package/dist/cjs/helpers/headers-helper.d.ts

@@ -1,3 +1,3 @@
-import { AxiosResponse } from 'axios';
-import { IHeader } from '../http/http.models';
-export declare function extractHeadersFromAxiosResponse(response: AxiosResponse): IHeader[];
+import { AxiosResponse } from 'axios';
+import { IHeader } from '../http/http.models';
+export declare function extractHeadersFromAxiosResponse(response: AxiosResponse): IHeader[];

package/dist/cjs/helpers/headers-helper.js

@@ -1,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractHeadersFromAxiosResponse = void 0;
-function extractHeadersFromAxiosResponse(response) {
-    const headers = [];
-    for (const headerKey of Object.keys(response.headers)) {
-        headers.push({
-            header: headerKey,
-            value: response.headers[headerKey]
-        });
-    }
-    return headers;
-}
-exports.extractHeadersFromAxiosResponse = extractHeadersFromAxiosResponse;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractHeadersFromAxiosResponse = void 0;
+function extractHeadersFromAxiosResponse(response) {
+    const headers = [];
+    for (const headerKey of Object.keys(response.headers)) {
+        headers.push({
+            header: headerKey,
+            value: response.headers[headerKey]
+        });
+    }
+    return headers;
+}
+exports.extractHeadersFromAxiosResponse = extractHeadersFromAxiosResponse;
 //# sourceMappingURL=headers-helper.js.map

package/dist/cjs/helpers/index.d.ts

@@ -1,5 +1,4 @@
-export * from './url.helper';
-export * from './header.helper';
-export * from './enum.helper';
-export * from './retry-helper';
-export * from './headers-helper';
+export * from './url.helper';
+export * from './header.helper';
+export * from './retry-helper';
+export * from './headers-helper';

package/dist/cjs/helpers/index.js

@@ -1,22 +1,21 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./url.helper"), exports);
-__exportStar(require("./header.helper"), exports);
-__exportStar(require("./enum.helper"), exports);
-__exportStar(require("./retry-helper"), exports);
-__exportStar(require("./headers-helper"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./url.helper"), exports);
+__exportStar(require("./header.helper"), exports);
+__exportStar(require("./retry-helper"), exports);
+__exportStar(require("./headers-helper"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/helpers/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,kDAAgC;AAChC,gDAA8B;AAC9B,iDAA+B;AAC/B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/helpers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,kDAAgC;AAChC,iDAA+B;AAC/B,mDAAiC"}

package/dist/cjs/helpers/retry-helper.d.ts

@@ -1,37 +1,37 @@
-import { IRetryStrategyOptions } from '../http/http.models';
-export declare class RetryHelper {
-    readonly requestCancelledMessagePrefix: string;
-    readonly retryAfterHeaderName: string;
-    readonly defaultRetryStatusCodes: number[];
-    readonly defaultRetryStrategy: {
-        addJitter: boolean;
-        deltaBackoffMs: number;
-        maxAttempts: number;
-        canRetryError: (error: any) => boolean;
-    };
-    getRetryErrorResult(data: {
-        retryAttempt: number;
-        error: any;
-        retryStrategy: IRetryStrategyOptions;
-    }): {
-        retryInMs: number;
-        canRetry: boolean;
-        maxRetries: number;
-    };
-    getRetryStrategyFromStrategyOptions(retryOptions?: IRetryStrategyOptions): IRetryStrategyOptions;
-    canRetryInTime(startTime: Date, maxCumulativeWaitTimeMs: number): {
-        canRetry: boolean;
-        differenceInMs: number;
-    };
-    private getNextWaitTimeMs;
-    private canRetryErrorDefault;
-    private tryGetRetryAfterInMsFromError;
-    private canRetryStatusCode;
-    private getStatusCodeFromError;
-    private tryGetAxiosError;
-    /**
-     * min and max included
-     */
-    private randomNumberFromInterval;
-}
-export declare const retryHelper: RetryHelper;
+import { IRetryStrategyOptions } from '../http/http.models';
+export declare class RetryHelper {
+    readonly requestCancelledMessagePrefix: string;
+    readonly retryAfterHeaderName: string;
+    readonly defaultRetryStatusCodes: number[];
+    readonly defaultRetryStrategy: {
+        addJitter: boolean;
+        deltaBackoffMs: number;
+        maxAttempts: number;
+        canRetryError: (error: any) => boolean;
+    };
+    getRetryErrorResult(data: {
+        retryAttempt: number;
+        error: any;
+        retryStrategy: IRetryStrategyOptions;
+    }): {
+        retryInMs: number;
+        canRetry: boolean;
+        maxRetries: number;
+    };
+    getRetryStrategyFromStrategyOptions(retryOptions?: IRetryStrategyOptions): IRetryStrategyOptions;
+    canRetryInTime(startTime: Date, maxCumulativeWaitTimeMs: number): {
+        canRetry: boolean;
+        differenceInMs: number;
+    };
+    private getNextWaitTimeMs;
+    private canRetryErrorDefault;
+    private tryGetRetryAfterInMsFromError;
+    private canRetryStatusCode;
+    private getStatusCodeFromError;
+    private tryGetAxiosError;
+    /**
+     * min and max included
+     */
+    private randomNumberFromInterval;
+}
+export declare const retryHelper: RetryHelper;

package/dist/cjs/helpers/retry-helper.js

@@ -1,149 +1,149 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.retryHelper = exports.RetryHelper = void 0;
-const headers_helper_1 = require("./headers-helper");
-class RetryHelper {
-    constructor() {
-        this.requestCancelledMessagePrefix = 'Request cancelled';
-        this.retryAfterHeaderName = 'Retry-After';
-        this.defaultRetryStatusCodes = [408, 429, 500, 502, 503, 504];
-        this.defaultRetryStrategy = {
-            addJitter: true,
-            deltaBackoffMs: 1000,
-            maxAttempts: 5,
-            canRetryError: (error) => this.canRetryErrorDefault(error)
-        };
-    }
-    getRetryErrorResult(data) {
-        var _a, _b, _c;
-        if (data.error && data.error.message) {
-            if (data.error.message.startsWith(this.requestCancelledMessagePrefix)) {
-                // request was cancelled by user, do not retry it
-                return {
-                    canRetry: false,
-                    retryInMs: 0,
-                    maxRetries: 0
-                };
-            }
-        }
-        const canRetryError = data.retryStrategy.canRetryError
-            ? data.retryStrategy.canRetryError(data.error)
-            : this.defaultRetryStrategy.canRetryError(data.error);
-        if (!canRetryError) {
-            // request cannot be retried
-            return {
-                canRetry: false,
-                retryInMs: 0,
-                maxRetries: 0
-            };
-        }
-        const maxRetries = ((_a = data.retryStrategy.maxAttempts) !== null && _a !== void 0 ? _a : this.defaultRetryStrategy.maxAttempts);
-        const maxRetriesReached = data.retryAttempt >= maxRetries;
-        if (maxRetriesReached) {
-            // request cannot be retried anymore due to maximum attempts
-            return {
-                canRetry: false,
-                retryInMs: 0,
-                maxRetries: maxRetries
-            };
-        }
-        // get wait time
-        const retryResult = this.tryGetRetryAfterInMsFromError(data.error);
-        if (retryResult) {
-            // retry after header was provided
-            return {
-                canRetry: true,
-                retryInMs: retryResult,
-                maxRetries: maxRetries
-            };
-        }
-        // wait time was not provided in header
-        const waitTimeMs = this.getNextWaitTimeMs((_b = data.retryStrategy.addJitter) !== null && _b !== void 0 ? _b : this.defaultRetryStrategy.addJitter, (_c = data.retryStrategy.deltaBackoffMs) !== null && _c !== void 0 ? _c : this.defaultRetryStrategy.deltaBackoffMs, data.retryAttempt);
-        return {
-            canRetry: true,
-            retryInMs: waitTimeMs,
-            maxRetries: maxRetries
-        };
-    }
-    getRetryStrategyFromStrategyOptions(retryOptions) {
-        if (!retryOptions) {
-            return this.defaultRetryStrategy;
-        }
-        return retryOptions;
-    }
-    canRetryInTime(startTime, maxCumulativeWaitTimeMs) {
-        const start = startTime.getTime();
-        const now = new Date().getTime();
-        const differenceInMs = now - start;
-        return {
-            canRetry: differenceInMs < maxCumulativeWaitTimeMs,
-            differenceInMs: differenceInMs
-        };
-    }
-    getNextWaitTimeMs(addJitter, deltaBackoffMs, retryAttempts) {
-        if (!addJitter) {
-            return deltaBackoffMs * Math.pow(2, retryAttempts);
-        }
-        const from = 0.8 * deltaBackoffMs;
-        const to = 1.2 * deltaBackoffMs * Math.pow(2, retryAttempts);
-        return this.randomNumberFromInterval(from, to);
-    }
-    canRetryErrorDefault(error) {
-        const axiosError = this.tryGetAxiosError(error);
-        if (!axiosError) {
-            // by default non-axios errors are not retried
-            return false;
-        }
-        const statusCode = this.getStatusCodeFromError(error);
-        const canRetryStatusCode = this.canRetryStatusCode(statusCode, this.defaultRetryStatusCodes);
-        if (canRetryStatusCode) {
-            return true;
-        }
-        return false;
-    }
-    tryGetRetryAfterInMsFromError(error) {
-        const axiosError = this.tryGetAxiosError(error);
-        if (!axiosError || !axiosError.response) {
-            return undefined;
-        }
-        const headers = (0, headers_helper_1.extractHeadersFromAxiosResponse)(axiosError.response);
-        const retryValueHeader = headers.find((m) => m.header.toLowerCase() === this.retryAfterHeaderName.toLowerCase());
-        if (!retryValueHeader) {
-            return undefined;
-        }
-        const retryInSeconds = +retryValueHeader.value;
-        return retryInSeconds * 1000;
-    }
-    canRetryStatusCode(statusCode, useRetryForResponseCodes) {
-        return useRetryForResponseCodes.includes(statusCode);
-    }
-    getStatusCodeFromError(error) {
-        const axiosError = this.tryGetAxiosError(error);
-        if (!axiosError || !axiosError.response) {
-            return 0;
-        }
-        return axiosError.response.status;
-    }
-    tryGetAxiosError(error) {
-        if (!error) {
-            return undefined;
-        }
-        if (error.isAxiosError) {
-            return error;
-        }
-        const originalError = error.originalError;
-        if (originalError && originalError.isAxiosError) {
-            return originalError;
-        }
-        return undefined;
-    }
-    /**
-     * min and max included
-     */
-    randomNumberFromInterval(min, max) {
-        return Math.floor(Math.random() * (max - min + 1) + min);
-    }
-}
-exports.RetryHelper = RetryHelper;
-exports.retryHelper = new RetryHelper();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.retryHelper = exports.RetryHelper = void 0;
+const headers_helper_1 = require("./headers-helper");
+class RetryHelper {
+    constructor() {
+        this.requestCancelledMessagePrefix = 'Request cancelled';
+        this.retryAfterHeaderName = 'Retry-After';
+        this.defaultRetryStatusCodes = [408, 429, 500, 502, 503, 504];
+        this.defaultRetryStrategy = {
+            addJitter: true,
+            deltaBackoffMs: 1000,
+            maxAttempts: 5,
+            canRetryError: (error) => this.canRetryErrorDefault(error)
+        };
+    }
+    getRetryErrorResult(data) {
+        var _a, _b, _c;
+        if (data.error && data.error.message) {
+            if (data.error.message.startsWith(this.requestCancelledMessagePrefix)) {
+                // request was cancelled by user, do not retry it
+                return {
+                    canRetry: false,
+                    retryInMs: 0,
+                    maxRetries: 0
+                };
+            }
+        }
+        const canRetryError = data.retryStrategy.canRetryError
+            ? data.retryStrategy.canRetryError(data.error)
+            : this.defaultRetryStrategy.canRetryError(data.error);
+        if (!canRetryError) {
+            // request cannot be retried
+            return {
+                canRetry: false,
+                retryInMs: 0,
+                maxRetries: 0
+            };
+        }
+        const maxRetries = ((_a = data.retryStrategy.maxAttempts) !== null && _a !== void 0 ? _a : this.defaultRetryStrategy.maxAttempts);
+        const maxRetriesReached = data.retryAttempt >= maxRetries;
+        if (maxRetriesReached) {
+            // request cannot be retried anymore due to maximum attempts
+            return {
+                canRetry: false,
+                retryInMs: 0,
+                maxRetries: maxRetries
+            };
+        }
+        // get wait time
+        const retryResult = this.tryGetRetryAfterInMsFromError(data.error);
+        if (retryResult) {
+            // retry after header was provided
+            return {
+                canRetry: true,
+                retryInMs: retryResult,
+                maxRetries: maxRetries
+            };
+        }
+        // wait time was not provided in header
+        const waitTimeMs = this.getNextWaitTimeMs((_b = data.retryStrategy.addJitter) !== null && _b !== void 0 ? _b : this.defaultRetryStrategy.addJitter, (_c = data.retryStrategy.deltaBackoffMs) !== null && _c !== void 0 ? _c : this.defaultRetryStrategy.deltaBackoffMs, data.retryAttempt);
+        return {
+            canRetry: true,
+            retryInMs: waitTimeMs,
+            maxRetries: maxRetries
+        };
+    }
+    getRetryStrategyFromStrategyOptions(retryOptions) {
+        if (!retryOptions) {
+            return this.defaultRetryStrategy;
+        }
+        return retryOptions;
+    }
+    canRetryInTime(startTime, maxCumulativeWaitTimeMs) {
+        const start = startTime.getTime();
+        const now = new Date().getTime();
+        const differenceInMs = now - start;
+        return {
+            canRetry: differenceInMs < maxCumulativeWaitTimeMs,
+            differenceInMs: differenceInMs
+        };
+    }
+    getNextWaitTimeMs(addJitter, deltaBackoffMs, retryAttempts) {
+        if (!addJitter) {
+            return deltaBackoffMs * Math.pow(2, retryAttempts);
+        }
+        const from = 0.8 * deltaBackoffMs;
+        const to = 1.2 * deltaBackoffMs * Math.pow(2, retryAttempts);
+        return this.randomNumberFromInterval(from, to);
+    }
+    canRetryErrorDefault(error) {
+        const axiosError = this.tryGetAxiosError(error);
+        if (!axiosError) {
+            // by default non-axios errors are not retried
+            return false;
+        }
+        const statusCode = this.getStatusCodeFromError(error);
+        const canRetryStatusCode = this.canRetryStatusCode(statusCode, this.defaultRetryStatusCodes);
+        if (canRetryStatusCode) {
+            return true;
+        }
+        return false;
+    }
+    tryGetRetryAfterInMsFromError(error) {
+        const axiosError = this.tryGetAxiosError(error);
+        if (!axiosError || !axiosError.response) {
+            return undefined;
+        }
+        const headers = (0, headers_helper_1.extractHeadersFromAxiosResponse)(axiosError.response);
+        const retryValueHeader = headers.find((m) => m.header.toLowerCase() === this.retryAfterHeaderName.toLowerCase());
+        if (!retryValueHeader) {
+            return undefined;
+        }
+        const retryInSeconds = +retryValueHeader.value;
+        return retryInSeconds * 1000;
+    }
+    canRetryStatusCode(statusCode, useRetryForResponseCodes) {
+        return useRetryForResponseCodes.includes(statusCode);
+    }
+    getStatusCodeFromError(error) {
+        const axiosError = this.tryGetAxiosError(error);
+        if (!axiosError || !axiosError.response) {
+            return 0;
+        }
+        return axiosError.response.status;
+    }
+    tryGetAxiosError(error) {
+        if (!error) {
+            return undefined;
+        }
+        if (error.isAxiosError) {
+            return error;
+        }
+        const originalError = error.originalError;
+        if (originalError && originalError.isAxiosError) {
+            return originalError;
+        }
+        return undefined;
+    }
+    /**
+     * min and max included
+     */
+    randomNumberFromInterval(min, max) {
+        return Math.floor(Math.random() * (max - min + 1) + min);
+    }
+}
+exports.RetryHelper = RetryHelper;
+exports.retryHelper = new RetryHelper();
 //# sourceMappingURL=retry-helper.js.map

package/dist/cjs/helpers/url.helper.d.ts

@@ -1,10 +1,10 @@
-import { IQueryParameter } from '../models';
-export declare class UrlHelper {
-    /**
-   * Adds query parameters to given url
-   * @param url Url to which options will be added
-   * @param options Query parameters to add
-   */
-    addOptionsToUrl(url: string, options?: IQueryParameter[]): string;
-}
-export declare const urlHelper: UrlHelper;
+import { IQueryParameter } from '../models';
+export declare class UrlHelper {
+    /**
+   * Adds query parameters to given url
+   * @param url Url to which options will be added
+   * @param options Query parameters to add
+   */
+    addOptionsToUrl(url: string, options?: IQueryParameter[]): string;
+}
+export declare const urlHelper: UrlHelper;

package/dist/cjs/helpers/url.helper.js

@@ -1,27 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.urlHelper = exports.UrlHelper = void 0;
-class UrlHelper {
-    /**
-   * Adds query parameters to given url
-   * @param url Url to which options will be added
-   * @param options Query parameters to add
-   */
-    addOptionsToUrl(url, options) {
-        if (options) {
-            options.forEach(filter => {
-                if (url.indexOf('?') > -1) {
-                    url += '&';
-                }
-                else {
-                    url += '?';
-                }
-                url += filter.getParam();
-            });
-        }
-        return url;
-    }
-}
-exports.UrlHelper = UrlHelper;
-exports.urlHelper = new UrlHelper();
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlHelper = exports.UrlHelper = void 0;
+class UrlHelper {
+    /**
+   * Adds query parameters to given url
+   * @param url Url to which options will be added
+   * @param options Query parameters to add
+   */
+    addOptionsToUrl(url, options) {
+        if (options) {
+            options.forEach(filter => {
+                if (url.indexOf('?') > -1) {
+                    url += '&';
+                }
+                else {
+                    url += '?';
+                }
+                url += filter.getParam();
+            });
+        }
+        return url;
+    }
+}
+exports.UrlHelper = UrlHelper;
+exports.urlHelper = new UrlHelper();
 //# sourceMappingURL=url.helper.js.map

package/dist/cjs/http/http.debugger.d.ts

@@ -1,6 +1,6 @@
-export declare class HttpDebugger {
-    debugStartHttpRequest(): void;
-    debugSuccessHttpRequest(): void;
-    debugRetryHttpRequest(): void;
-}
-export declare const httpDebugger: HttpDebugger;
+export declare class HttpDebugger {
+    debugStartHttpRequest(): void;
+    debugSuccessHttpRequest(): void;
+    debugRetryHttpRequest(): void;
+}
+export declare const httpDebugger: HttpDebugger;