@evergis/api 3.0.77 → 3.0.80
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 +20 -20
- package/README.md +21 -21
- package/dist/Api.d.ts +7 -2
- package/dist/__generated__/ImportService.d.ts +6 -28
- package/dist/__generated__/LayersService.d.ts +22 -23
- package/dist/__generated__/ProjectsService.d.ts +13 -35
- package/dist/__generated__/StatisticService.d.ts +2 -2
- package/dist/__generated__/TablesService.d.ts +2 -2
- package/dist/__generated__/WmsServerService.d.ts +2 -2
- package/dist/__generated__/data-contracts.d.ts +348 -320
- package/dist/api.cjs.development.js +86 -140
- package/dist/api.cjs.development.js.map +1 -1
- package/dist/api.cjs.production.min.js +1 -1
- package/dist/api.cjs.production.min.js.map +1 -1
- package/dist/api.esm.js +176 -226
- package/dist/api.esm.js.map +1 -1
- package/package.json +3 -2
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
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { HubConnection } from '@microsoft/signalr';
|
|
1
2
|
import { Options as KyOptions } from 'ky';
|
|
2
3
|
import { EventEmitter } from '@evergis/event-emitter';
|
|
3
4
|
import { Account, External, ClientSettings, PortalSettings, FileUpload, General, Geocode, Import, Layers, Names, Namespace, Notification, Projects, ResourceCatalog, Resources, Scheduler, Security, Styles, Tables, Tools, AccountPreview, BulkOperations, IceRouter, Statistic, Feedback } from './services';
|
|
@@ -7,6 +8,7 @@ import { LoginDc } from './__generated__/data-contracts';
|
|
|
7
8
|
export declare type ApiParams = {
|
|
8
9
|
url: string;
|
|
9
10
|
wsUrl?: string;
|
|
11
|
+
snappingHubUrl?: string;
|
|
10
12
|
http?: HttpClient;
|
|
11
13
|
httpOptions?: KyOptions;
|
|
12
14
|
urlPath?: string;
|
|
@@ -49,10 +51,12 @@ export declare class Api extends EventEmitter {
|
|
|
49
51
|
readonly iceRouter: IceRouter;
|
|
50
52
|
readonly statistic: Statistic;
|
|
51
53
|
readonly feedback: Feedback;
|
|
52
|
-
|
|
53
|
-
|
|
54
|
+
readonly snappingHub: HubConnection | null;
|
|
55
|
+
constructor({ url, wsUrl, snappingHubUrl, http, urlPath, httpOptions }: ApiParams);
|
|
56
|
+
init({ authParams, connectWs, connectSignalR, initScheduler, fetchSettings, fetchUser, }: {
|
|
54
57
|
authParams?: LoginDc;
|
|
55
58
|
connectWs?: boolean;
|
|
59
|
+
connectSignalR?: boolean;
|
|
56
60
|
initScheduler?: boolean;
|
|
57
61
|
fetchSettings?: boolean;
|
|
58
62
|
fetchUser?: boolean;
|
|
@@ -60,6 +64,7 @@ export declare class Api extends EventEmitter {
|
|
|
60
64
|
isAcceptedNetwork(network: string): network is SocAuthNetwork;
|
|
61
65
|
socAuthLogin(network: SocAuthNetwork): Promise<void>;
|
|
62
66
|
connectWs(): Promise<void>;
|
|
67
|
+
connectSignalR(): Promise<void>;
|
|
63
68
|
logout(): Promise<void>;
|
|
64
69
|
initScheduler(): Promise<void>;
|
|
65
70
|
private defineUrlPath;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { GetDataSchemaParams, GetFeaturesCountPayload, GetRasterAttributesParams, ImportDataSchema } from './data-contracts';
|
|
2
2
|
import { Service } from './Service';
|
|
3
3
|
/**
|
|
4
4
|
* @title Spatial Processing Core API
|
|
@@ -21,35 +21,13 @@ export declare class ImportService extends Service {
|
|
|
21
21
|
* No description
|
|
22
22
|
*
|
|
23
23
|
* @tags ImportService
|
|
24
|
-
* @name
|
|
25
|
-
* @operationId
|
|
26
|
-
* @summary
|
|
27
|
-
* @request
|
|
24
|
+
* @name GetFeaturesCount
|
|
25
|
+
* @operationId ImportServiceController_GetFeaturesCount
|
|
26
|
+
* @summary Returns the features count of the given file in temporary static storage.
|
|
27
|
+
* @request POST:/import/count
|
|
28
28
|
* @response `200` Success
|
|
29
29
|
*/
|
|
30
|
-
|
|
31
|
-
/**
|
|
32
|
-
* No description
|
|
33
|
-
*
|
|
34
|
-
* @tags ImportService
|
|
35
|
-
* @name GetCsvDataSchema
|
|
36
|
-
* @operationId ImportServiceController_GetCsvDataSchema
|
|
37
|
-
* @summary Using a file uploaded to the file upload service, reads the headers of the csv file and returns the information about data schema of all layers in that file, available for import.
|
|
38
|
-
* @request GET:/import/csvDataSchema
|
|
39
|
-
* @response `200` Success
|
|
40
|
-
*/
|
|
41
|
-
getCsvDataSchema(query: GetCsvDataSchemaParams): Promise<ImportDataSchema>;
|
|
42
|
-
/**
|
|
43
|
-
* No description
|
|
44
|
-
*
|
|
45
|
-
* @tags ImportService
|
|
46
|
-
* @name GetKmlDataSchema
|
|
47
|
-
* @operationId ImportServiceController_GetKmlDataSchema
|
|
48
|
-
* @summary Using a file uploaded to the file upload service, reads the kml file and returns the information about data schema of all layers in that file, available for import.
|
|
49
|
-
* @request GET:/import/kmlDataSchema
|
|
50
|
-
* @response `200` Success
|
|
51
|
-
*/
|
|
52
|
-
getKmlDataSchema(query: GetKmlDataSchemaParams): Promise<ImportDataSchema>;
|
|
30
|
+
getFeaturesCount(data: GetFeaturesCountPayload): Promise<number>;
|
|
53
31
|
/**
|
|
54
32
|
* No description
|
|
55
33
|
*
|
|
@@ -6,29 +6,6 @@ import { Service } from './Service';
|
|
|
6
6
|
* @baseUrl /sp
|
|
7
7
|
*/
|
|
8
8
|
export declare class LayersService extends Service {
|
|
9
|
-
/**
|
|
10
|
-
* No description
|
|
11
|
-
*
|
|
12
|
-
* @tags Layers
|
|
13
|
-
* @name GetLayerInfo
|
|
14
|
-
* @operationId LayersController_GetLayerInfoAsync
|
|
15
|
-
* @summary Returns the layer information.
|
|
16
|
-
* @request GET:/layers/{name}
|
|
17
|
-
* @response `200` Success
|
|
18
|
-
* @response `default` Error
|
|
19
|
-
*/
|
|
20
|
-
getLayerInfo(name: string): Promise<ServiceInfoDc | ResourceInfoDc>;
|
|
21
|
-
/**
|
|
22
|
-
* No description
|
|
23
|
-
*
|
|
24
|
-
* @tags Layers
|
|
25
|
-
* @name DeleteResource
|
|
26
|
-
* @operationId LayersController_DeleteResource
|
|
27
|
-
* @summary Deletes resource.
|
|
28
|
-
* @request DELETE:/layers/{name}
|
|
29
|
-
* @response `200` Success
|
|
30
|
-
*/
|
|
31
|
-
deleteResource(name: string): Promise<void>;
|
|
32
9
|
/**
|
|
33
10
|
* No description
|
|
34
11
|
*
|
|
@@ -62,6 +39,28 @@ export declare class LayersService extends Service {
|
|
|
62
39
|
* @response `200` Success
|
|
63
40
|
*/
|
|
64
41
|
deleteResources(query: DeleteResourcesParams): Promise<BulkOperationResultDc[]>;
|
|
42
|
+
/**
|
|
43
|
+
* No description
|
|
44
|
+
*
|
|
45
|
+
* @tags Layers
|
|
46
|
+
* @name GetLayerInfo
|
|
47
|
+
* @operationId LayersController_GetLayerInfoAsync
|
|
48
|
+
* @summary Returns the layer information.
|
|
49
|
+
* @request GET:/layers/{name}
|
|
50
|
+
* @response `200` Success
|
|
51
|
+
*/
|
|
52
|
+
getLayerInfo(name: string): Promise<ServiceInfoDc | ResourceInfoDc>;
|
|
53
|
+
/**
|
|
54
|
+
* No description
|
|
55
|
+
*
|
|
56
|
+
* @tags Layers
|
|
57
|
+
* @name DeleteResource
|
|
58
|
+
* @operationId LayersController_DeleteResource
|
|
59
|
+
* @summary Deletes resource.
|
|
60
|
+
* @request DELETE:/layers/{name}
|
|
61
|
+
* @response `200` Success
|
|
62
|
+
*/
|
|
63
|
+
deleteResource(name: string): Promise<void>;
|
|
65
64
|
/**
|
|
66
65
|
* No description
|
|
67
66
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccessControlListDc, AddPermissionsBody, BulkOperationResultDc,
|
|
1
|
+
import { AccessControlListDc, AddPermissionsBody, BulkOperationResultDc, CreateProjectPayload, DeleteResourcesParams4, ExtendedProjectLayersInfo, FileUploadResponse, GetProjectsListParams, IListResponse, ListResponseProjectInfoDc, ResourceDependenciesDc, SetPermissionsBatchBody, SetPermissionsBody, SetPreviewBody, UpdateProjectPayload } from './data-contracts';
|
|
2
2
|
import { Service } from './Service';
|
|
3
3
|
/**
|
|
4
4
|
* @title Spatial Processing Core API
|
|
@@ -6,39 +6,6 @@ import { Service } from './Service';
|
|
|
6
6
|
* @baseUrl /sp
|
|
7
7
|
*/
|
|
8
8
|
export declare class ProjectsService extends Service {
|
|
9
|
-
/**
|
|
10
|
-
* No description
|
|
11
|
-
*
|
|
12
|
-
* @tags Projects
|
|
13
|
-
* @name GetProjectLayersExtendedInfo
|
|
14
|
-
* @operationId ProjectsController_GetProjectLayersExtendedInfo
|
|
15
|
-
* @summary Gets extended project info with layers info.
|
|
16
|
-
* @request GET:/projects/{name}/extended-info
|
|
17
|
-
* @response `200` Success
|
|
18
|
-
*/
|
|
19
|
-
getProjectLayersExtendedInfo(name: string): Promise<ExtendedProjectLayersInfo>;
|
|
20
|
-
/**
|
|
21
|
-
* No description
|
|
22
|
-
*
|
|
23
|
-
* @tags Projects
|
|
24
|
-
* @name CreateShareProject
|
|
25
|
-
* @operationId ProjectsController_CreateShareProject
|
|
26
|
-
* @summary Create shared project.
|
|
27
|
-
* @request POST:/projects/{name}/share
|
|
28
|
-
* @response `200` Success
|
|
29
|
-
*/
|
|
30
|
-
createShareProject(name: string, data: CreateShareProjectPayload): Promise<SharedProjectInfoDc | ResourceInfoDc | ServiceInfoDc | CompositeServiceInfoDc>;
|
|
31
|
-
/**
|
|
32
|
-
* No description
|
|
33
|
-
*
|
|
34
|
-
* @tags Projects
|
|
35
|
-
* @name RemoveShareProject
|
|
36
|
-
* @operationId ProjectsController_RemoveShareProject
|
|
37
|
-
* @summary Delete shared project.
|
|
38
|
-
* @request DELETE:/projects/{name}/share
|
|
39
|
-
* @response `200` Success
|
|
40
|
-
*/
|
|
41
|
-
removeShareProject(name: string): Promise<void>;
|
|
42
9
|
/**
|
|
43
10
|
* No description
|
|
44
11
|
*
|
|
@@ -82,7 +49,7 @@ export declare class ProjectsService extends Service {
|
|
|
82
49
|
* @request DELETE:/projects
|
|
83
50
|
* @response `200` Success
|
|
84
51
|
*/
|
|
85
|
-
deleteResources(query:
|
|
52
|
+
deleteResources(query: DeleteResourcesParams4): Promise<BulkOperationResultDc[]>;
|
|
86
53
|
/**
|
|
87
54
|
* No description
|
|
88
55
|
*
|
|
@@ -116,6 +83,17 @@ export declare class ProjectsService extends Service {
|
|
|
116
83
|
* @response `200` Success
|
|
117
84
|
*/
|
|
118
85
|
deleteResource(name: string): Promise<void>;
|
|
86
|
+
/**
|
|
87
|
+
* No description
|
|
88
|
+
*
|
|
89
|
+
* @tags Projects
|
|
90
|
+
* @name GetProjectLayersExtendedInfo
|
|
91
|
+
* @operationId ProjectsController_GetProjectLayersExtendedInfo
|
|
92
|
+
* @summary Gets extended project info with layers info.
|
|
93
|
+
* @request GET:/projects/{name}/extended-info
|
|
94
|
+
* @response `200` Success
|
|
95
|
+
*/
|
|
96
|
+
getProjectLayersExtendedInfo(name: string): Promise<ExtendedProjectLayersInfo>;
|
|
119
97
|
/**
|
|
120
98
|
* No description
|
|
121
99
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ClassifyDc,
|
|
1
|
+
import { ClassifyDc, ClassifyParams2, 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:
|
|
30
|
+
classify(query: ClassifyParams2): Promise<ClassifyDc>;
|
|
31
31
|
/**
|
|
32
32
|
* No description
|
|
33
33
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AccessControlListDc, AddPermissionsInput, BulkOperationResultDc, CreateTablePayload,
|
|
1
|
+
import { AccessControlListDc, AddPermissionsInput, BulkOperationResultDc, CreateTablePayload, DeleteResourcesParams10, DeleteTableDataParams, FileUploadResponse, GetTableDataParams, GetTableListParams, GetUniqueDataRowsParams, IListResponse, ListResponseIEnumerable1, MapRemoteTableParams, MapRemoteTablePayload, MapTableParams, MapTablePayload, MapViewParams, MapViewPayload, ResourceDependenciesDc, SetPermissionsBatchInput, SetPermissionsInput, SetPreviewInput, TableListDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTablePayload, 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:
|
|
52
|
+
deleteResources(query: DeleteResourcesParams10): Promise<BulkOperationResultDc[]>;
|
|
53
53
|
/**
|
|
54
54
|
* No description
|
|
55
55
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GetCapabilities1Params,
|
|
1
|
+
import { GetCapabilities1Params, GetCapabilitiesParams2, 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:
|
|
19
|
+
getCapabilities(query: GetCapabilitiesParams2): Promise<void>;
|
|
20
20
|
/**
|
|
21
21
|
* No description
|
|
22
22
|
*
|