@evergis/api 3.0.142 → 3.0.144

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2020 Kirill Protasov
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ MIT License
2
+
3
+ Copyright (c) 2020 Kirill Protasov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
package/README.md CHANGED
@@ -1,21 +1,21 @@
1
- # @evergis/api
2
-
3
- ```javascript
4
- import { Api } from '@evergis/api';
5
-
6
- const api = new Api({
7
- url: '/',
8
- });
9
- ```
10
-
11
- ## Possible Environment variables
12
-
13
- ```
14
-
15
- NODE_ENV = "development" | "test" | "production"
16
- URL = "string"
17
- LOGIN = "string"
18
- PASSWORD = "string"
19
- WORKSPACE = "string"
20
-
21
- ```
1
+ # @evergis/api
2
+
3
+ ```javascript
4
+ import { Api } from '@evergis/api';
5
+
6
+ const api = new Api({
7
+ url: '/',
8
+ });
9
+ ```
10
+
11
+ ## Possible Environment variables
12
+
13
+ ```
14
+
15
+ NODE_ENV = "development" | "test" | "production"
16
+ URL = "string"
17
+ LOGIN = "string"
18
+ PASSWORD = "string"
19
+ WORKSPACE = "string"
20
+
21
+ ```
package/dist/Api.d.ts CHANGED
@@ -3,6 +3,7 @@ import { HubConnection } from '@microsoft/signalr';
3
3
  import { Options as KyOptions } from 'ky';
4
4
  import { LoginDc } from './__generated__/data-contracts';
5
5
  import { HttpClient } from './__generated__/HttpClient';
6
+ import { UniversalSearchService } from './__generated__/UniversalSearchService';
6
7
  import { Account, AccountPreview, BulkOperations, ClientSettings, External, Feedback, FileUpload, Filters, General, Geocode, IceRouter, Import, Layers, Names, Namespace, Notification, PortalSettings, Projects, ResourceCatalog, Resources, Scheduler, Security, Statistic, Styles, Tables, Tools, VectorTiles } from './services';
7
8
  import { Print } from './services/Print';
8
9
  export declare type ApiParams = {
@@ -55,6 +56,7 @@ export declare class Api extends EventEmitter {
55
56
  readonly feedback: Feedback;
56
57
  readonly snappingHub: HubConnection | null;
57
58
  readonly vectorTiles: VectorTiles;
59
+ readonly universalSearch: UniversalSearchService;
58
60
  constructor({ url, wsUrl, wsKeepAlive, snappingHubUrl, http, urlPath, httpOptions, }: ApiParams);
59
61
  init({ authParams, connectWs, initScheduler, fetchSettings, fetchUser, }: {
60
62
  authParams?: LoginDc;
@@ -1,4 +1,4 @@
1
- import { ExternalLayerInfoDc, GetDataSchemaParams, GetExternalArcGisLayersParams, GetExternalPbfLayersParams, GetExternalWmsLayersParams, GetRasterAttributesParams, ImportDataSchema, ImportFileFeaturesCountDc, ReadPartParams } from './data-contracts';
1
+ import { ExternalLayerInfoDc, GetDataSchemaParams, GetExternalArcGisLayersParams, GetExternalPbfLayersParams, GetExternalWmsLayersParams, GetRasterAttributesParams, GetRasterMetaParams, ImportDataSchema, ImportFileFeaturesCountDc, NetCdfMetaDc, RasterMetaDc, ReadPartParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -83,4 +83,15 @@ export declare class ImportService extends Service {
83
83
  * @response `200` Success
84
84
  */
85
85
  getRasterAttributes(query: GetRasterAttributesParams): Promise<Record<string, any>>;
86
+ /**
87
+ * No description
88
+ *
89
+ * @tags ImportService
90
+ * @name GetRasterMeta
91
+ * @operationId ImportServiceController_GetRasterMeta
92
+ * @summary Get raster meta data.
93
+ * @request GET:/import/rasterMeta
94
+ * @response `200` Success
95
+ */
96
+ getRasterMeta(query: GetRasterMetaParams): Promise<(RasterMetaDc | NetCdfMetaDc)[]>;
86
97
  }
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkOperationResultDc, ClassifyDc, ClassifyParams, CompositeServiceConfigurationDc, CompositeServiceInfoDc, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FeatureDc, FeatureLayerServiceInfoDc, FeaturesContainsParams, FeatureSelectionDc, FeaturesListDc, FileUploadResponse, GetByGeometryGetParams, GetByGeometryParams, GetByGeometryPostParams, GetByGeometryPostPayload, GetByIdParams, GetFeaturesParams, GetFilteredFeaturesCountParams, GetLayerExtentParams, GetLayerImageParams, GetLayersInfoParams, GetLayersListParams, GetTilesLayerImageParams, LayerUpdateInfo, LayerUpdateInfoDc, LinearServiceConfigurationDc, LocalTileServiceConfigurationDc, PostgresLayerServiceConfigurationDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceConfigurationDc, ProxyServiceInfoDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfo, RemoteTileServiceInfoDc, ResourceDependenciesDc, ResourceInfoDc, RouteFeatureDc, RouteServiceConfigurationDc, SelectFeaturesParams, ServiceInfoDc, SetPermissionsBatchPayload, SetPreviewPayload, StyledLayerServiceConfigurationDc, SubtractParams, SubtractPayload, TileServiceInfoDc, UniteParams, UnitePayload, UpdateFeaturePayload, ValidateExpressionParams } from './data-contracts';
1
+ import { AccessControlListDc, AggregateAttributeParams, AggregationDataResultDc, AttributeDistinctsDc, BulkOperationResultDc, ClassifyDc, ClassifyParams, CompositeServiceConfigurationDc, CompositeServiceInfoDc, CreateFeaturesPayload, DeleteByConditionParams, DeleteFeatureParams, DeleteFeaturesParams, DeleteResourcesParams, DistinctsParams, EditAttributesInfoDc, EnvelopeDc, ExpressionValidationResultDc, FeatureDc, FeatureLayerServiceInfoDc, FeaturesContainsParams, FeatureSelectionDc, FeaturesListDc, FileUploadResponse, GetByGeometryGetParams, GetByGeometryParams, GetByGeometryPostParams, GetByGeometryPostPayload, GetByIdParams, GetFeaturesParams, GetFilteredFeaturesCountParams, GetLayerExtentParams, GetLayerImageParams, GetLayersInfoParams, GetLayersListParams, GetRasterMetaParams7, GetTilesLayerImageParams, LayerUpdateInfo, LayerUpdateInfoDc, LinearServiceConfigurationDc, LocalTileServiceConfigurationDc, NetCdfMetaDc, PostgresLayerServiceConfigurationDc, PostgresTileCatalogServiceConfigurationDc, ProxyServiceConfigurationDc, ProxyServiceInfoDc, RasterMetaDc, RemoteTileServiceConfigurationDc, RemoteTileServiceInfo, RemoteTileServiceInfoDc, ResourceDependenciesDc, ResourceInfoDc, RouteFeatureDc, RouteServiceConfigurationDc, SelectFeaturesParams, ServiceInfoDc, SetPermissionsBatchPayload, SetPreviewPayload, StyledLayerServiceConfigurationDc, SubtractParams, SubtractPayload, TileServiceInfoDc, UniteParams, UnitePayload, UpdateFeaturePayload, ValidateExpressionParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -502,6 +502,17 @@ export declare class LayersService extends Service {
502
502
  * @response `400` Bad Request
503
503
  */
504
504
  validateExpression({ layerName, ...query }: ValidateExpressionParams): Promise<ExpressionValidationResultDc>;
505
+ /**
506
+ * No description
507
+ *
508
+ * @tags Layers
509
+ * @name GetRasterMeta
510
+ * @operationId LayersController_GetRasterMeta
511
+ * @summary Get raster metadata.
512
+ * @request GET:/layers/{name}/{id}/metadata
513
+ * @response `200` Success
514
+ */
515
+ getRasterMeta({ name, id, ...query }: GetRasterMetaParams7): Promise<(RasterMetaDc | NetCdfMetaDc)[]>;
505
516
  /**
506
517
  * No description
507
518
  *
@@ -0,0 +1,20 @@
1
+ import { GetRoutesParams } from './data-contracts';
2
+ import { Service } from './Service';
3
+ /**
4
+ * @title Spatial Processing Core API
5
+ * @version 1.0.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class NavigationService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags Navigation
13
+ * @name GetRoutes
14
+ * @operationId NavigationController_GetRoutes
15
+ * @summary Build routes according coordinates.
16
+ * @request GET:/navigation/routes/{profile}/{coordinates}
17
+ * @response `200` Success
18
+ */
19
+ getRoutes({ profile, coordinates, ...query }: GetRoutesParams): Promise<object>;
20
+ }
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams6, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, FileUploadResponse, GetProjectsInfoParams, GetProjectsListParams, PagedListProjectInfoDc, ResourceDependenciesDc, SetPermissionsBatchBody, SetPreviewBody } from './data-contracts';
1
+ import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams7, ExtendedProjectInfoDc, ExtendedProjectLayersInfo, FileUploadResponse, GetProjectsInfoParams, GetProjectsListParams, PagedListProjectInfoDc, ResourceDependenciesDc, SetPermissionsBatchBody, SetPreviewBody } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -49,7 +49,7 @@ export declare class ProjectsService extends Service {
49
49
  * @request DELETE:/projects
50
50
  * @response `200` Success
51
51
  */
52
- deleteResources(query: DeleteResourcesParams6): Promise<BulkOperationResultDc[]>;
52
+ deleteResources(query: DeleteResourcesParams7): Promise<BulkOperationResultDc[]>;
53
53
  /**
54
54
  * No description
55
55
  *
@@ -1,4 +1,4 @@
1
- import { AggregateTaskParametersDc, AvailabilityAreaTaskDc, BufferTaskParametersDc, CopyTaskParametersDc, EditAttributesTaskParametersDc, FilterCopyTaskParametersDc, GetTaskListParams, OverlayTaskParametersDc, PipelineTaskParametersDc, PrintTaskParametersDc, TaskInfoDc, TaskProgressDc, TaskStatusDataDc, UnionTaskParametersDc, UploadRasterTaskParametersDc } from './data-contracts';
1
+ import { AggregateTaskParametersDc, AvailabilityAreaTaskDc, BufferTaskParametersDc, CopyTaskParametersDc, EditAttributesTaskParametersDc, FilterCopyTaskParametersDc, GetTaskListParams, OverlayTaskParametersDc, PipelineTaskParametersDc, PrintTaskParametersDc, SearchTaskParametersDc, TaskInfoDc, TaskProgressDc, TaskStatusDataDc, UnionTaskParametersDc, UploadNetCdfTaskParametersDc, UploadRasterTaskParametersDc } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -105,6 +105,17 @@ export declare class SchedulerService extends Service {
105
105
  * @response `200` Success
106
106
  */
107
107
  startTilingTask(data: UploadRasterTaskParametersDc): Promise<TaskStatusDataDc>;
108
+ /**
109
+ * No description
110
+ *
111
+ * @tags SchedulerService
112
+ * @name StartNetCdfTask
113
+ * @operationId SchedulerServiceController_StartNetCdfTask
114
+ * @summary Plans the execution of a 'netcdf' server task.
115
+ * @request POST:/scheduler/tasks#type=netcdf
116
+ * @response `200` Success
117
+ */
118
+ startNetCdfTask(data: UploadNetCdfTaskParametersDc): Promise<TaskStatusDataDc>;
108
119
  /**
109
120
  * No description
110
121
  *
@@ -171,4 +182,15 @@ export declare class SchedulerService extends Service {
171
182
  * @response `200` Success
172
183
  */
173
184
  startEditAttributesBatch(data: EditAttributesTaskParametersDc): Promise<TaskStatusDataDc>;
185
+ /**
186
+ * No description
187
+ *
188
+ * @tags SchedulerService
189
+ * @name UniversalSearchTask
190
+ * @operationId SchedulerServiceController_UniversalSearchTask
191
+ * @summary Plans the execution of a 'edit attributes' server task.
192
+ * @request POST:/scheduler/tasks#type=universalSearch
193
+ * @response `200` Success
194
+ */
195
+ universalSearchTask(data: SearchTaskParametersDc): Promise<TaskStatusDataDc>;
174
196
  }
@@ -1,4 +1,4 @@
1
- import { ClassifyDc, ClassifyParams4, StatisticsDbParams, StatisticsDc, SumOfProductParams } from './data-contracts';
1
+ import { ClassifyDc, ClassifyParams9, StatisticsDbParams, StatisticsDc, SumOfProductParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -27,7 +27,7 @@ export declare class StatisticService extends Service {
27
27
  * @request GET:/statistics/classify
28
28
  * @response `200` Success
29
29
  */
30
- classify(query: ClassifyParams4): Promise<ClassifyDc>;
30
+ classify(query: ClassifyParams9): Promise<ClassifyDc>;
31
31
  /**
32
32
  * No description
33
33
  *
@@ -1,4 +1,4 @@
1
- import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams6, DeleteTableDataParams, DetailedTableInfoDc, FileUploadResponse, GetTableDataParams, GetTableListParams, GetTablesInfoParams, GetUniqueDataRowsParams, MapTableInfoDc, MapTableParams, PagedListIEnumerable1, PagedListTableInfoDc, ResourceDependenciesDc, SetPermissionsBatchInput, SetPreviewInput, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
1
+ import { AccessControlListDc, BulkOperationResultDc, DeleteResourcesParams5, DeleteTableDataParams, DetailedTableInfoDc, FileUploadResponse, GetTableDataParams, GetTableListParams, GetTablesInfoParams, GetUniqueDataRowsParams, MapTableInfoDc, MapTableParams, PagedListIEnumerable1, PagedListTableInfoDc, ResourceDependenciesDc, SetPermissionsBatchInput, SetPreviewInput, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -49,7 +49,7 @@ export declare class TablesService extends Service {
49
49
  * @request DELETE:/tables
50
50
  * @response `200` Success
51
51
  */
52
- deleteResources(query: DeleteResourcesParams6): Promise<BulkOperationResultDc[]>;
52
+ deleteResources(query: DeleteResourcesParams5): Promise<BulkOperationResultDc[]>;
53
53
  /**
54
54
  * No description
55
55
  *
@@ -0,0 +1,31 @@
1
+ import { GetSearchResultParams, PagedListSearchResultDc, SearchResultDc } from './data-contracts';
2
+ import { Service } from './Service';
3
+ /**
4
+ * @title Spatial Processing Core API
5
+ * @version 1.0.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class UniversalSearchService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags UniversalSearch
13
+ * @name GetSearchResult
14
+ * @operationId UniversalSearchController_GetSearchResult
15
+ * @summary Returns search result.
16
+ * @request GET:/search/{taskId}/{layerName}
17
+ * @response `200` Success
18
+ */
19
+ getSearchResult({ taskId, layerName, ...query }: GetSearchResultParams): Promise<PagedListSearchResultDc>;
20
+ /**
21
+ * No description
22
+ *
23
+ * @tags UniversalSearch
24
+ * @name GetSearchResult1
25
+ * @operationId UniversalSearchController_GetSearchResult_1
26
+ * @summary Returns search result.
27
+ * @request GET:/search/{taskId}
28
+ * @response `200` Success
29
+ */
30
+ getSearchResult1(taskId: string): Promise<SearchResultDc[]>;
31
+ }
@@ -1,4 +1,4 @@
1
- import { GetCapabilities1Params, GetCapabilitiesParams1, GetFeatureInfoParams, GetLegendGraphicParams, GetMapParams } from './data-contracts';
1
+ import { GetCapabilities1Params, GetCapabilitiesParams3, GetFeatureInfoParams, GetLegendGraphicParams, GetMapParams } from './data-contracts';
2
2
  import { Service } from './Service';
3
3
  /**
4
4
  * @title Spatial Processing Core API
@@ -16,7 +16,7 @@ export declare class WmsServerService extends Service {
16
16
  * @request GET:/wms#REQUEST=GetCapabilities
17
17
  * @response `200` Success
18
18
  */
19
- getCapabilities(query: GetCapabilitiesParams1): Promise<void>;
19
+ getCapabilities(query: GetCapabilitiesParams3): Promise<void>;
20
20
  /**
21
21
  * No description
22
22
  *