@kontent-ai/delivery-sdk 12.3.0 → 12.4.0

package/dist/bundles/kontent-delivery.umd.js

@@ -3741,6 +3741,18 @@ class DeliveryClient {
     element(typeCodename, elementCodename) {
         return new query_1.ElementQuery(this.config, this.queryService, typeCodename, elementCodename);
     }
+    /**
+     * Gets query for initializing sync
+     */
+    initializeSync() {
+        return new query_1.InitializeSyncQuery(this.config, this.queryService);
+    }
+    /**
+     * Gets query fetching delta updates of content items
+     */
+    syncChanges() {
+        return new query_1.SyncChangesQuery(this.config, this.queryService);
+    }
 }
 exports.DeliveryClient = DeliveryClient;
 
@@ -4610,12 +4622,13 @@ class GenericElementMapper {
         if (!response) {
             throw Error(`Invalid response for mapping element`);
         }
+        const element = response.element;
         return {
-            codename: response.codename,
-            name: response.name,
-            type: response.type,
-            options: response.options ? response.options : [],
-            taxonomyGroup: response.taxonomy_group
+            codename: element.codename,
+            name: element.name,
+            type: element.type,
+            options: element.options ? element.options : [],
+            taxonomyGroup: element.taxonomy_group
         };
     }
 }
@@ -4653,6 +4666,7 @@ __exportStar(__webpack_require__(/*! ./taxonomy.mapper */ "./lib/mappers/taxonom
 __exportStar(__webpack_require__(/*! ./type.mapper */ "./lib/mappers/type.mapper.ts"), exports);
 __exportStar(__webpack_require__(/*! ./generic-element.mapper */ "./lib/mappers/generic-element.mapper.ts"), exports);
 __exportStar(__webpack_require__(/*! ./language.mapper */ "./lib/mappers/language.mapper.ts"), exports);
+__exportStar(__webpack_require__(/*! ./sync.mapper */ "./lib/mappers/sync.mapper.ts"), exports);
 
 
 /***/ }),
@@ -4817,6 +4831,34 @@ class LanguageMapper {
 exports.LanguageMapper = LanguageMapper;
 
 
+/***/ }),
+
+/***/ "./lib/mappers/sync.mapper.ts":
+/*!************************************!*\
+  !*** ./lib/mappers/sync.mapper.ts ***!
+  \************************************/
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.SyncMapper = void 0;
+class SyncMapper {
+    mapContentItemDelta(itemDeltaContract) {
+        return {
+            changeType: itemDeltaContract.change_type,
+            codename: itemDeltaContract.codename,
+            collection: itemDeltaContract.collection,
+            id: itemDeltaContract.id,
+            language: itemDeltaContract.language,
+            timestamp: itemDeltaContract.timestamp,
+            type: itemDeltaContract.type
+        };
+    }
+}
+exports.SyncMapper = SyncMapper;
+
+
 /***/ }),
 
 /***/ "./lib/mappers/taxonomy.mapper.ts":
@@ -5603,6 +5645,7 @@ __exportStar(__webpack_require__(/*! ./taxonomy-models */ "./lib/models/taxonomy
 __exportStar(__webpack_require__(/*! ./content-type-models */ "./lib/models/content-type-models.ts"), exports);
 __exportStar(__webpack_require__(/*! ./language-models */ "./lib/models/language-models.ts"), exports);
 __exportStar(__webpack_require__(/*! ./responses */ "./lib/models/responses.ts"), exports);
+__exportStar(__webpack_require__(/*! ./sync-models */ "./lib/models/sync-models.ts"), exports);
 
 
 /***/ }),
@@ -5644,6 +5687,19 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 
 
+/***/ }),
+
+/***/ "./lib/models/sync-models.ts":
+/*!***********************************!*\
+  !*** ./lib/models/sync-models.ts ***!
+  \***********************************/
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+
+
 /***/ }),
 
 /***/ "./lib/models/taxonomy-models.ts":
@@ -6140,19 +6196,19 @@ exports.parserHelper = new ParserHelper();
 
 /***/ }),
 
-/***/ "./lib/query/common/base-listing-query.class.ts":
-/*!******************************************************!*\
-  !*** ./lib/query/common/base-listing-query.class.ts ***!
-  \******************************************************/
+/***/ "./lib/query/common/base-item-listing-query.class.ts":
+/*!***********************************************************!*\
+  !*** ./lib/query/common/base-item-listing-query.class.ts ***!
+  \***********************************************************/
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.BaseListingQuery = void 0;
+exports.BaseItemListingQuery = void 0;
 const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
-const base_query_class_1 = __webpack_require__(/*! ./base-query.class */ "./lib/query/common/base-query.class.ts");
-class BaseListingQuery extends base_query_class_1.BaseQuery {
+const base_listing_query_class_1 = __webpack_require__(/*! ./base-listing-query.class */ "./lib/query/common/base-listing-query.class.ts");
+class BaseItemListingQuery extends base_listing_query_class_1.BaseListingQuery {
     constructor(config, queryService) {
         super(config, queryService);
         this.config = config;
@@ -6322,6 +6378,30 @@ class BaseListingQuery extends base_query_class_1.BaseQuery {
         this.parameters.push(new models_1.Parameters.SkipParameter(skip));
         return this;
     }
+}
+exports.BaseItemListingQuery = BaseItemListingQuery;
+
+
+/***/ }),
+
+/***/ "./lib/query/common/base-listing-query.class.ts":
+/*!******************************************************!*\
+  !*** ./lib/query/common/base-listing-query.class.ts ***!
+  \******************************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.BaseListingQuery = void 0;
+const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
+const base_query_class_1 = __webpack_require__(/*! ./base-query.class */ "./lib/query/common/base-query.class.ts");
+class BaseListingQuery extends base_query_class_1.BaseQuery {
+    constructor(config, queryService) {
+        super(config, queryService);
+        this.config = config;
+        this.queryService = queryService;
+    }
     /**
      * Sets continuation token header
      */
@@ -6329,7 +6409,7 @@ class BaseListingQuery extends base_query_class_1.BaseQuery {
         var _a;
         // remove previous continuation token if there is any
         let queryHeaders = (_a = this._queryConfig.customHeaders) !== null && _a !== void 0 ? _a : [];
-        queryHeaders = queryHeaders.filter(m => m.header !== models_1.continuationTokenHeaderName);
+        queryHeaders = queryHeaders.filter((m) => m.header !== models_1.continuationTokenHeaderName);
         this._queryConfig.customHeaders = queryHeaders;
         this.withHeaders([
             {
@@ -6517,8 +6597,7 @@ class ElementQuery extends base_query_class_1.BaseQuery {
         return this.queryService.getElementAsync(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
     }
     getUrl() {
-        const action = '/types/' + this.typeCodename + '/elements/' + this.elementCodename;
-        return super.resolveUrlInternal(action);
+        return super.resolveUrlInternal(`/types/${this.typeCodename}/elements/${this.elementCodename}`);
     }
     map(json) {
         return this.queryService.mappingService.viewContentTypeElementResponse(json);
@@ -6562,6 +6641,8 @@ __exportStar(__webpack_require__(/*! ./type/multiple-type-query.class */ "./lib/
 __exportStar(__webpack_require__(/*! ./type/single-type-query.class */ "./lib/query/type/single-type-query.class.ts"), exports);
 __exportStar(__webpack_require__(/*! ./items-feed/items-feed-query.class */ "./lib/query/items-feed/items-feed-query.class.ts"), exports);
 __exportStar(__webpack_require__(/*! ./language/languages-query.class */ "./lib/query/language/languages-query.class.ts"), exports);
+__exportStar(__webpack_require__(/*! ./sync/initialize-sync-query.class */ "./lib/query/sync/initialize-sync-query.class.ts"), exports);
+__exportStar(__webpack_require__(/*! ./sync/sync-changes-query.class */ "./lib/query/sync/sync-changes-query.class.ts"), exports);
 
 
 /***/ }),
@@ -6577,8 +6658,8 @@ __exportStar(__webpack_require__(/*! ./language/languages-query.class */ "./lib/
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.MultipleItemsQuery = void 0;
 const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
-const base_listing_query_class_1 = __webpack_require__(/*! ../common/base-listing-query.class */ "./lib/query/common/base-listing-query.class.ts");
-class MultipleItemsQuery extends base_listing_query_class_1.BaseListingQuery {
+const base_item_listing_query_class_1 = __webpack_require__(/*! ../common/base-item-listing-query.class */ "./lib/query/common/base-item-listing-query.class.ts");
+class MultipleItemsQuery extends base_item_listing_query_class_1.BaseItemListingQuery {
     constructor(config, queryService) {
         super(config, queryService);
         this.config = config;
@@ -6762,8 +6843,8 @@ exports.SingleItemQuery = SingleItemQuery;
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.ItemsFeedQuery = void 0;
 const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
-const base_listing_query_class_1 = __webpack_require__(/*! ../common/base-listing-query.class */ "./lib/query/common/base-listing-query.class.ts");
-class ItemsFeedQuery extends base_listing_query_class_1.BaseListingQuery {
+const base_item_listing_query_class_1 = __webpack_require__(/*! ../common/base-item-listing-query.class */ "./lib/query/common/base-item-listing-query.class.ts");
+class ItemsFeedQuery extends base_item_listing_query_class_1.BaseItemListingQuery {
     constructor(config, queryService) {
         super(config, queryService);
         this.config = config;
@@ -6826,7 +6907,7 @@ class ItemsFeedQuery extends base_listing_query_class_1.BaseListingQuery {
     }
     getUrl() {
         const action = '/items-feed';
-        // add default language is necessry
+        // add default language is necessary
         this.processDefaultLanguageParameter();
         return super.resolveUrlInternal(action);
     }
@@ -6892,21 +6973,84 @@ class LanguagesQuery extends base_listing_query_class_1.BaseListingQuery {
         this.parameters.push(new models_1.Parameters.SkipParameter(skip));
         return this;
     }
+    toPromise() {
+        var _a;
+        return this.queryService.getLanguages(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
+    }
+    getUrl() {
+        const action = '/' + this.endpoint;
+        return super.resolveUrlInternal(action);
+    }
     /**
-     * Sets continuation token header
+     * Used to configure query
+     * @param queryConfig Query configuration
      */
-    withContinuationToken(token) {
-        this.withHeaders([
-            {
-                header: models_1.continuationTokenHeaderName,
-                value: token
-            }
-        ]);
+    queryConfig(queryConfig) {
+        this._queryConfig = queryConfig;
+        return this;
+    }
+    map(json) {
+        return this.queryService.mappingService.listLanguagesResponse(json);
+    }
+    allResponseFactory(items, responses) {
+        return {
+            items: items,
+            responses: responses
+        };
+    }
+}
+exports.LanguagesQuery = LanguagesQuery;
+
+
+/***/ }),
+
+/***/ "./lib/query/sync/initialize-sync-query.class.ts":
+/*!*******************************************************!*\
+  !*** ./lib/query/sync/initialize-sync-query.class.ts ***!
+  \*******************************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.InitializeSyncQuery = void 0;
+const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
+const base_query_class_1 = __webpack_require__(/*! ../common/base-query.class */ "./lib/query/common/base-query.class.ts");
+class InitializeSyncQuery extends base_query_class_1.BaseQuery {
+    constructor(config, queryService) {
+        super(config, queryService);
+        this.config = config;
+        this.queryService = queryService;
+        this.endpoint = 'sync/init';
+        this._queryConfig = {};
+    }
+    /**
+     * Gets only item of given type
+     * @param type Codename of type to get
+     */
+    type(type) {
+        this.parameters.push(new models_1.Filters.TypeFilter(type));
+        return this;
+    }
+    /**
+     * Gets only item from given collection
+     * @param collection Codename of collection to get
+     */
+    collection(collection) {
+        this.parameters.push(new models_1.Filters.CollectionFilter(collection));
+        return this;
+    }
+    /**
+     * Language codename
+     * @param languageCodename Codename of the language
+     */
+    languageParameter(languageCodename) {
+        this.parameters.push(new models_1.Parameters.LanguageParameter(languageCodename));
         return this;
     }
     toPromise() {
         var _a;
-        return this.queryService.getLanguages(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
+        return this.queryService.initializeSync(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
     }
     getUrl() {
         const action = '/' + this.endpoint;
@@ -6921,7 +7065,50 @@ class LanguagesQuery extends base_listing_query_class_1.BaseListingQuery {
         return this;
     }
     map(json) {
-        return this.queryService.mappingService.listLanguagesResponse(json);
+        return this.queryService.mappingService.initializeContentSync(json);
+    }
+}
+exports.InitializeSyncQuery = InitializeSyncQuery;
+
+
+/***/ }),
+
+/***/ "./lib/query/sync/sync-changes-query.class.ts":
+/*!****************************************************!*\
+  !*** ./lib/query/sync/sync-changes-query.class.ts ***!
+  \****************************************************/
+/***/ ((__unused_webpack_module, exports, __webpack_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.SyncChangesQuery = void 0;
+const base_listing_query_class_1 = __webpack_require__(/*! ../common/base-listing-query.class */ "./lib/query/common/base-listing-query.class.ts");
+class SyncChangesQuery extends base_listing_query_class_1.BaseListingQuery {
+    constructor(config, queryService) {
+        super(config, queryService);
+        this.config = config;
+        this.queryService = queryService;
+        this._queryConfig = {};
+        this.action = '/sync';
+    }
+    toPromise() {
+        var _a;
+        return this.queryService.syncChanges(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
+    }
+    getUrl() {
+        return super.resolveUrlInternal(this.action);
+    }
+    /**
+     * Used to configure query
+     * @param queryConfig Query configuration
+     */
+    queryConfig(queryConfig) {
+        this._queryConfig = queryConfig;
+        return this;
+    }
+    map(json) {
+        return this.queryService.mappingService.syncChanges(json);
     }
     allResponseFactory(items, responses) {
         return {
@@ -6930,7 +7117,7 @@ class LanguagesQuery extends base_listing_query_class_1.BaseListingQuery {
         };
     }
 }
-exports.LanguagesQuery = LanguagesQuery;
+exports.SyncChangesQuery = SyncChangesQuery;
 
 
 /***/ }),
@@ -6978,18 +7165,6 @@ class TaxonomiesQuery extends base_listing_query_class_1.BaseListingQuery {
         var _a;
         return this.queryService.getTaxonomies(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
     }
-    /**
-     * Sets continuation token header
-     */
-    withContinuationToken(token) {
-        this.withHeaders([
-            {
-                header: models_1.continuationTokenHeaderName,
-                value: token
-            }
-        ]);
-        return this;
-    }
     getUrl() {
         const action = '/' + this.taxonomiesEndpoint;
         return super.resolveUrlInternal(action);
@@ -7062,6 +7237,7 @@ exports.TaxonomyQuery = TaxonomyQuery;
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.MultipleTypeQuery = void 0;
+const models_1 = __webpack_require__(/*! ../../models */ "./lib/models/index.ts");
 const base_listing_query_class_1 = __webpack_require__(/*! ../common/base-listing-query.class */ "./lib/query/common/base-listing-query.class.ts");
 class MultipleTypeQuery extends base_listing_query_class_1.BaseListingQuery {
     constructor(config, queryService) {
@@ -7070,6 +7246,30 @@ class MultipleTypeQuery extends base_listing_query_class_1.BaseListingQuery {
         this.queryService = queryService;
         this._queryConfig = {};
     }
+    /**
+     * Used to limit the number of elements returned by query.
+     * @param elementCodenames Array of element codenames to fetch
+     */
+    elementsParameter(elementCodenames) {
+        this.parameters.push(new models_1.Parameters.ElementsParameter(elementCodenames));
+        return this;
+    }
+    /**
+     * Limits the number of taxonomies returned by query
+     * @param limit Number of taxonomies to load
+     */
+    limitParameter(limit) {
+        this.parameters.push(new models_1.Parameters.LimitParameter(limit));
+        return this;
+    }
+    /**
+     * Skips the selected number of taxonomies
+     * @param skip Number of taxonomies to skip
+     */
+    skipParameter(skip) {
+        this.parameters.push(new models_1.Parameters.SkipParameter(skip));
+        return this;
+    }
     toPromise() {
         var _a;
         return this.queryService.getMultipleTypes(this.getUrl(), (_a = this._queryConfig) !== null && _a !== void 0 ? _a : {});
@@ -7714,7 +7914,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.sdkInfo = void 0;
 exports.sdkInfo = {
     host: 'npmjs.com',
-    version: '12.3.0',
+    version: '12.4.0',
     name: '@kontent-ai/delivery-sdk'
 };
 
@@ -7830,6 +8030,35 @@ class BaseDeliveryQueryService {
         }
         return headers;
     }
+    /**
+     * Http POST response
+     * @param url Url of request
+     * @param queryConfig Query config configuration
+     */
+    postResponseAsync(url, body, queryConfig, serviceConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!queryConfig) {
+                queryConfig = {};
+            }
+            if (!serviceConfig) {
+                serviceConfig = {};
+            }
+            try {
+                return yield this.httpService.postAsync({
+                    url: url,
+                    body: body
+                }, {
+                    cancelToken: queryConfig === null || queryConfig === void 0 ? void 0 : queryConfig.cancelToken,
+                    responseType: 'json',
+                    retryStrategy: this.config.retryStrategy,
+                    headers: this.getHeaders(queryConfig, serviceConfig.headers ? serviceConfig.headers : [])
+                });
+            }
+            catch (error) {
+                throw this.mapDeliveryError(error);
+            }
+        });
+    }
     /**
      * Http GET response
      * @param url Url of request
@@ -8092,6 +8321,31 @@ class QueryService extends base_delivery_query_service_1.BaseDeliveryQueryServic
             return this.mapNetworkResponse(this.mappingService.listContentTypesResponse(response.data), response);
         });
     }
+    /**
+     * Initializes synchronization of changes in content items based on the specified parameters. After the initialization,
+     * you'll get an X-Continuation token in the response.
+     * Use the token to synchronize changes in the content items matching the initialization criteria.
+     * @param url Url
+     * @param queryConfig Query configuration
+     */
+    initializeSync(url, queryConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postResponseAsync(url, queryConfig);
+            return this.mapNetworkResponse(this.mappingService.initializeContentSync(response.data), response);
+        });
+    }
+    /**
+     * Retrieve a list of delta updates to recently changed content items in the specified project.
+     * The types of items you get is determined by the X-Continuation token you use.
+     * @param url Url used to get multiple types
+     * @param queryConfig Query configuration
+     */
+    syncChanges(url, queryConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResponseAsync(url, queryConfig);
+            return this.mapNetworkResponse(this.mappingService.syncChanges(response.data), response);
+        });
+    }
     /**
      * Gets languages
      * @param url Url
@@ -8242,6 +8496,7 @@ class MappingService {
         this.itemMapper = new mappers_1.ItemMapper(config);
         this.taxonomyMapper = new mappers_1.TaxonomyMapper();
         this.genericElementMapper = new mappers_1.GenericElementMapper();
+        this.syncMapper = new mappers_1.SyncMapper();
     }
     /**
      * Gets response for list of languages
@@ -8336,6 +8591,16 @@ class MappingService {
             element: this.genericElementMapper.mapElement(data)
         };
     }
+    initializeContentSync(data) {
+        return {
+            items: data.items.map((m) => this.syncMapper.mapContentItemDelta(m))
+        };
+    }
+    syncChanges(data) {
+        return {
+            items: data.items.map((m) => this.syncMapper.mapContentItemDelta(m))
+        };
+    }
     mapPagination(paginationContract) {
         var _a;
         return {