Move Types to the separate header.

Relates-To: OLPEDGE-957

Signed-off-by: Mykhailo Kuchma <[email protected]>

Author: mykhailo-kuchma

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/CatalogClient.h

@@ -23,17 +23,12 @@
 #include <memory>
 
 #include <olp/core/cache/CacheSettings.h>
-#include <olp/core/client/ApiError.h>
-#include <olp/core/client/ApiResponse.h>
 #include <olp/core/client/OlpClientSettings.h>
 #include <olp/core/geo/tiling/TileKey.h>
 #include <olp/core/porting/deprecated.h>
 #include "DataServiceReadApi.h"
 #include "olp/dataservice/read/PrefetchTileResult.h"
-#include "olp/dataservice/read/model/Catalog.h"
-#include "olp/dataservice/read/model/Data.h"
-#include "olp/dataservice/read/model/Partitions.h"
-#include "olp/dataservice/read/model/VersionResponse.h"
+#include "olp/dataservice/read/Types.h"
 
 namespace olp {
 
@@ -44,51 +39,13 @@ class HRN;
 namespace dataservice {
 namespace read {
 
-class PrefetchTilesRequest;
-
-namespace model {
-class Partition;
-}  // namespace model
+class CatalogClientImpl;
 
 class CatalogRequest;
-using CatalogResult = model::Catalog;
-using CatalogResponse = client::ApiResponse<CatalogResult, client::ApiError>;
-using CatalogResponseCallback = std::function<void(CatalogResponse response)>;
-
 class CatalogVersionRequest;
-using CatalogVersionResult = model::VersionResponse;
-using CatalogVersionResponse =
-    client::ApiResponse<CatalogVersionResult, client::ApiError>;
-using CatalogVersionCallback =
-    std::function<void(CatalogVersionResponse response)>;
-
-class PartitionsRequest;
-using PartitionsResult = model::Partitions;
-using PartitionsResponse =
-    client::ApiResponse<PartitionsResult, client::ApiError>;
-using PartitionsResponseCallback =
-    std::function<void(PartitionsResponse response)>;
-
 class DataRequest;
-using DataResult = model::Data;
-using DataResponse = client::ApiResponse<DataResult, client::ApiError>;
-using DataResponseCallback = std::function<void(DataResponse response)>;
-
-/**
- * @brief The PrefetchTilesResponse class encapsulates the result of a prefetch
- * operation
- */
-using PrefetchTilesResult = std::vector<std::shared_ptr<PrefetchTileResult>>;
-using PrefetchTilesResponse =
-    client::ApiResponse<PrefetchTilesResult, client::ApiError>;
-
-/**
- * @brief Prefetch completion callback
- */
-using PrefetchTilesResponseCallback =
-    std::function<void(const PrefetchTilesResponse& response)>;
-
-class CatalogClientImpl;
+class PartitionsRequest;
+class PrefetchTilesRequest;
 
 /**
  * @brief The CatalogClient class. Marshals Requests and their Results.
@@ -241,7 +198,5 @@ class DATASERVICE_READ_API CatalogClient final {
 };
 
 }  // namespace read
-
 }  // namespace dataservice
-
 }  // namespace olp

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/Types.h

@@ -0,0 +1,83 @@
+/*
+ * Copyright (C) 2019 HERE Europe B.V.
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+#pragma once
+
+#include <memory>
+
+#include <olp/core/client/ApiError.h>
+#include <olp/core/client/ApiResponse.h>
+
+#include <olp/dataservice/read/model/Catalog.h>
+#include <olp/dataservice/read/model/Data.h>
+#include <olp/dataservice/read/model/Partitions.h>
+#include <olp/dataservice/read/model/VersionResponse.h>
+
+namespace olp {
+namespace dataservice {
+namespace read {
+
+class PrefetchTileResult;
+
+/// Response template type
+template <typename ResultType>
+using Response = client::ApiResponse<ResultType, client::ApiError>;
+
+/// Callback template type
+template <typename ResultType>
+using Callback = std::function<void(Response<ResultType>)>;
+
+/// Catalog configuration alias type
+using CatalogResult = model::Catalog;
+/// Catalog configuration response type
+using CatalogResponse = Response<CatalogResult>;
+/// Catalog configuration response callback type
+using CatalogResponseCallback = Callback<CatalogResult>;
+
+/// Catalog version result alias type
+using CatalogVersionResult = model::VersionResponse;
+/// Catalog version response type
+using CatalogVersionResponse = Response<CatalogVersionResult>;
+/// Catalog version response callback type
+using CatalogVersionCallback = Callback<CatalogVersionResult>;
+
+/// Partition metadata result alias type
+using PartitionsResult = model::Partitions;
+/// Partition metadata response type
+using PartitionsResponse = Response<PartitionsResult>;
+/// Partition metadata response callback type
+using PartitionsResponseCallback = Callback<PartitionsResult>;
+
+/// Data alias type
+using DataResult = model::Data;
+/// Data response alias
+using DataResponse = Response<DataResult>;
+/// Data response callback type
+using DataResponseCallback = Callback<DataResult>;
+
+/// Prefetch tiles result alias
+using PrefetchTilesResult = std::vector<std::shared_ptr<PrefetchTileResult>>;
+/// Prefetch tiles response type
+using PrefetchTilesResponse = Response<PrefetchTilesResult>;
+/// Prefetch completion callback type
+using PrefetchTilesResponseCallback = Callback<PrefetchTilesResult>;
+
+}  // namespace read
+}  // namespace dataservice
+}  // namespace olp

olp-cpp-sdk-dataservice-read/include/olp/dataservice/read/VersionedLayerClient.h

@@ -32,6 +32,7 @@
 #include <olp/dataservice/read/PartitionsRequest.h>
 #include <olp/dataservice/read/PrefetchTileResult.h>
 #include <olp/dataservice/read/PrefetchTilesRequest.h>
+#include <olp/dataservice/read/Types.h>
 #include <olp/dataservice/read/model/Data.h>
 #include <olp/dataservice/read/model/Partitions.h>
 

olp-cpp-sdk-dataservice-read/src/repositories/CatalogRepository.h

@@ -19,17 +19,23 @@
 
 #pragma once
 
+#include <olp/core/cache/KeyValueCache.h>
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/CancellationToken.h>
 #include <olp/core/client/HRN.h>
-#include "generated/api/MetadataApi.h"
+#include <olp/core/client/OlpClientSettings.h>
 #include "MultiRequestContext.h"
-#include "olp/dataservice/read/CatalogClient.h"
+#include "generated/api/MetadataApi.h"
 #include "olp/dataservice/read/DataRequest.h"
+#include "olp/dataservice/read/Types.h"
 
 namespace olp {
 namespace dataservice {
 namespace read {
+
+class CatalogRequest;
+class CatalogVersionRequest;
+
 namespace repository {
 class ApiRepository;
 class CatalogCacheRepository;
@@ -53,8 +59,7 @@ class CatalogRepository final {
   static MetadataApi::CatalogVersionResponse GetLatestVersion(
       const client::HRN& catalog,
       client::CancellationContext cancellation_context,
-      const DataRequest& data_request,
-      client::OlpClientSettings settings);
+      const DataRequest& data_request, client::OlpClientSettings settings);
 
  private:
   client::HRN hrn_;

olp-cpp-sdk-dataservice-read/src/repositories/DataRepository.cpp

@@ -330,7 +330,7 @@ void DataRepository::GetData(
                   *cache_);
 }
 
-DataRepository::DataResponse DataRepository::GetVersionedData(
+DataResponse DataRepository::GetVersionedData(
     const client::HRN& catalog, const std::string& layer_id,
     DataRequest request, client::CancellationContext context,
     client::OlpClientSettings settings) {
@@ -374,7 +374,7 @@ DataRepository::DataResponse DataRepository::GetVersionedData(
       catalog, layer_id, kBlobService, request, context, settings);
 }
 
-DataRepository::DataResponse DataRepository::GetBlobData(
+DataResponse DataRepository::GetBlobData(
     const client::HRN& catalog, const std::string& layer,
     const std::string& service, const DataRequest& data_request,
     client::CancellationContext cancellation_context,
@@ -483,7 +483,7 @@ DataRepository::DataResponse DataRepository::GetBlobData(
   return blob_response;
 }
 
-DataRepository::DataResponse DataRepository::GetVolatileData(
+DataResponse DataRepository::GetVolatileData(
     const client::HRN& catalog, const std::string& layer_id,
     DataRequest request, client::CancellationContext context,
     client::OlpClientSettings settings) {

olp-cpp-sdk-dataservice-read/src/repositories/DataRepository.h

@@ -22,13 +22,15 @@
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/CancellationToken.h>
 #include <olp/core/client/HRN.h>
+#include <olp/core/client/OlpClientSettings.h>
 #include "MultiRequestContext.h"
 #include "generated/api/BlobApi.h"
-#include "olp/dataservice/read/CatalogClient.h"
+#include "olp/dataservice/read/Types.h"
 
 namespace olp {
 namespace dataservice {
 namespace read {
+class DataRequest;
 namespace repository {
 class ApiRepository;
 class CatalogRepository;
@@ -38,8 +40,6 @@ class DataCacheRepository;
 
 class DataRepository final {
  public:
-  using DataResponse = client::ApiResponse<model::Data, client::ApiError>;
-
   DataRepository(const client::HRN& hrn, std::shared_ptr<ApiRepository> apiRepo,
                  std::shared_ptr<CatalogRepository> catalogRepo,
                  std::shared_ptr<PartitionsRepository> partitionsRepo,

olp-cpp-sdk-dataservice-read/src/repositories/PartitionsRepository.h

@@ -25,14 +25,17 @@
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/CancellationToken.h>
 #include <olp/core/client/HRN.h>
+#include <olp/core/client/OlpClientSettings.h>
 #include "MultiRequestContext.h"
 #include "generated/api/QueryApi.h"
-#include "olp/dataservice/read/CatalogClient.h"
+#include "olp/dataservice/read/Types.h"
 
 namespace olp {
 namespace dataservice {
 namespace read {
 class DataRequest;
+class PartitionsRequest;
+
 namespace repository {
 class ApiRepository;
 class CatalogRepository;

olp-cpp-sdk-dataservice-read/tests/DataRepositoryTest.cpp

@@ -21,6 +21,7 @@
 
 #include <matchers/NetworkUrlMatchers.h>
 #include <mocks/NetworkMock.h>
+#include <olp/core/cache/CacheSettings.h>
 #include <olp/core/cache/KeyValueCache.h>
 #include <olp/core/client/OlpClientFactory.h>
 #include <olp/core/client/OlpClientSettings.h>