@evergis/api 5.0.29 → 5.0.30

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) 2025 Everpoint
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
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Everpoint
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
+ SOFTWARE.
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
- # @evergis/api
2
-
3
- Библиотека API.
4
-
5
- ### Генерирование API
6
-
7
- ```shell
8
- $ yarn generate
9
- ```
10
-
11
- ***ВАЖНО!!!***: Никогда и ни при каких обстоятельствах нельзя вручную править файлы,
12
- размещенные в директории `src/__generated__`!
1
+ # @evergis/api
2
+
3
+ Библиотека API.
4
+
5
+ ### Генерирование API
6
+
7
+ ```shell
8
+ $ yarn generate
9
+ ```
10
+
11
+ ***ВАЖНО!!!***: Никогда и ни при каких обстоятельствах нельзя вручную править файлы,
12
+ размещенные в директории `src/__generated__`!
package/dist/Api.d.ts CHANGED
@@ -1,18 +1,14 @@
1
1
  import { Options as KyOptions } from 'ky';
2
- import { HubConnection } from '@microsoft/signalr';
3
2
  import { HttpClient } from './__generated__/HttpClient';
4
3
  import { DataSourceService } from './__generated__/DataSourceService';
5
4
  import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService';
6
5
  import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
7
6
  import { CatalogService } from './__generated__/CatalogService';
8
7
  import { EventEmitter } from './EventEmitter';
9
- import { Account, AccountPreview, External, BulkOperations, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, Notification, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
8
+ import { Account, AccountPreview, External, BulkOperations, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, Import, Layers, Names, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
10
9
  import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
11
10
  export type ApiParams = {
12
11
  url: string;
13
- wsUrl?: string;
14
- wsKeepAlive?: boolean;
15
- snappingHubUrl?: string;
16
12
  http?: HttpClient;
17
13
  httpOptions?: KyOptions;
18
14
  urlPath?: string;
@@ -30,7 +26,6 @@ export declare class Api extends EventEmitter {
30
26
  readonly tables: Tables;
31
27
  readonly projects: Projects;
32
28
  readonly security: Security;
33
- readonly notification: Notification;
34
29
  readonly file: FileUpload;
35
30
  readonly filters: Filters;
36
31
  readonly import: Import;
@@ -46,7 +41,6 @@ export declare class Api extends EventEmitter {
46
41
  readonly bulk: BulkOperations;
47
42
  readonly statistic: Statistic;
48
43
  readonly feedback: Feedback;
49
- readonly snappingHub: HubConnection | null;
50
44
  readonly vectorTiles: VectorTiles;
51
45
  readonly spatialReference: SpatialReferencesService;
52
46
  readonly eql: Eql;
@@ -55,25 +49,20 @@ export declare class Api extends EventEmitter {
55
49
  readonly dataSource: DataSourceService;
56
50
  readonly remoteTaskManager: RemoteTaskManager;
57
51
  protected readonly http: HttpClient;
58
- private readonly wsUrl;
59
52
  private readonly urlPath;
60
53
  private refreshingToken;
61
- constructor({ url, wsUrl, wsKeepAlive, snappingHubUrl, http, urlPath, httpOptions, }: ApiParams);
54
+ constructor({ url, http, urlPath, httpOptions, }: ApiParams);
62
55
  get isShared(): boolean;
63
56
  get isPresentation(): boolean;
64
- init({ authParams, authQueryParams, connectWs, fetchSettings, fetchUser, useJwt, }: {
57
+ init({ authParams, authQueryParams, fetchSettings, fetchUser, useJwt, }: {
65
58
  authParams?: LoginDc;
66
59
  authQueryParams?: AuthenticateParams;
67
- connectWs?: boolean;
68
- connectSignalR?: boolean;
69
60
  fetchSettings?: boolean;
70
61
  fetchUser?: boolean;
71
62
  useJwt?: boolean;
72
63
  }): Promise<void>;
73
64
  isAcceptedNetwork(network: string): network is SocAuthNetwork;
74
65
  socAuthLogin(network: SocAuthNetwork): Promise<void>;
75
- connectWs(): Promise<void>;
76
- connectSignalR(): Promise<void>;
77
66
  logout(): Promise<void>;
78
67
  private defineUrlPath;
79
68
  }
@@ -1,18 +1,30 @@
1
1
  import { Service } from './Service';
2
- import { ArcGisDataSourceDc, ArcGisDataSourceInfoDc, GetDataSourcesListParams, MosRuDataSourceDc, MosRuDataSourceInfoDc, PagedListDataSourceInfoDc, PostgresDataSourceDc, PostgresDataSourceInfoDc, S3DataSourceDc, S3DataSourceInfoDc, SparkDataSourceDc, SparkDataSourceInfoDc, TestConnectionInfoDc, WmsDataSourceDc } from './data-contracts';
2
+ import { ArcGisDataSourceDc, ArcGisDataSourceInfoDc, GetDataSourcesListParams, MosRuDataSourceDc, MosRuDataSourceInfoDc, PagedListDataSourceInfoDc, PostgresDataSourceDc, PostgresDataSourceInfoDc, S3DataSourceDc, S3DataSourceInfoDc, SparkDataSourceDc, SparkDataSourceInfoDc, WmsDataSourceDc } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
6
6
  * @baseUrl /sp
7
7
  */
8
8
  export declare class DataSourceService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags DataSource
13
+ * @name TestConnection
14
+ * @operationId DataSourceController_TestConnection
15
+ * @summary Test ArcGIS data source connection.
16
+ * @request POST:/ds/arcgis/test-connection
17
+ * @secure
18
+ * @response `200` OK
19
+ */
20
+ testConnection(data: ArcGisDataSourceDc): Promise<void>;
9
21
  /**
10
22
  * No description
11
23
  *
12
24
  * @tags DataSource
13
25
  * @name CreateArcGisDataSource
14
26
  * @operationId DataSourceController_CreateArcGisDataSource
15
- * @summary Create S3 data source.
27
+ * @summary Create ArcGIS data source.
16
28
  * @request POST:/ds/arcgis
17
29
  * @secure
18
30
  * @response `200` OK
@@ -24,7 +36,7 @@ export declare class DataSourceService extends Service {
24
36
  * @tags DataSource
25
37
  * @name UpdateArcGisDataSource
26
38
  * @operationId DataSourceController_UpdateArcGisDataSource
27
- * @summary Update arcgis data source.
39
+ * @summary Update ArcGIS data source.
28
40
  * @request PATCH:/ds/arcgis
29
41
  * @secure
30
42
  * @response `200` OK
@@ -94,14 +106,14 @@ export declare class DataSourceService extends Service {
94
106
  * No description
95
107
  *
96
108
  * @tags DataSource
97
- * @name TestConnection
98
- * @operationId DataSourceController_TestConnection
99
- * @summary Test ds connection.
100
- * @request POST:/ds/testConnection
109
+ * @name TestConnection1
110
+ * @operationId DataSourceController_TestConnection_1
111
+ * @summary Test data.mos.ru data source connection.
112
+ * @request POST:/ds/dataMosRu/test-connection
101
113
  * @secure
102
114
  * @response `200` OK
103
115
  */
104
- testConnection(data: PostgresDataSourceDc): Promise<TestConnectionInfoDc>;
116
+ testConnection1(data: MosRuDataSourceDc): Promise<void>;
105
117
  /**
106
118
  * No description
107
119
  *
@@ -126,6 +138,30 @@ export declare class DataSourceService extends Service {
126
138
  * @response `200` OK
127
139
  */
128
140
  updateMosRuDataSource(data: MosRuDataSourceDc): Promise<void>;
141
+ /**
142
+ * No description
143
+ *
144
+ * @tags DataSource
145
+ * @name TestConnection2
146
+ * @operationId DataSourceController_TestConnection_2
147
+ * @summary Test PostgreSQL data source connection.
148
+ * @request POST:/ds/test-connection
149
+ * @secure
150
+ * @response `200` OK
151
+ */
152
+ testConnection2(data: PostgresDataSourceDc): Promise<void>;
153
+ /**
154
+ * No description
155
+ *
156
+ * @tags DataSource
157
+ * @name TestConnection3
158
+ * @operationId DataSourceController_TestConnection_3
159
+ * @summary Test S3 data source connection.
160
+ * @request POST:/ds/s3/test-connection
161
+ * @secure
162
+ * @response `200` OK
163
+ */
164
+ testConnection3(data: S3DataSourceDc): Promise<void>;
129
165
  /**
130
166
  * No description
131
167
  *
@@ -144,7 +180,7 @@ export declare class DataSourceService extends Service {
144
180
  * @tags DataSource
145
181
  * @name UpdateS3DataSource
146
182
  * @operationId DataSourceController_UpdateS3DataSource
147
- * @summary Create S3 data source.
183
+ * @summary Update S3 data source.
148
184
  * @request PATCH:/ds/s3
149
185
  * @secure
150
186
  * @response `200` OK
@@ -138,12 +138,6 @@ export interface AttributeConfigurationDc {
138
138
  * @default true
139
139
  */
140
140
  isDisplayed?: boolean;
141
- /** If false, the attribute must have non-null value. */
142
- isNullable?: boolean;
143
- /** Ensures that the data in the attribute is unique across all rows in a table. */
144
- isUnique?: boolean;
145
- /** Whether the value of the attribute is autoincremented in table. */
146
- isAutoincrement?: boolean;
147
141
  /** Client data storage. Storage isn't used by server. */
148
142
  clientData?: any;
149
143
  /** Id of table given attribute is referenced. */
@@ -312,7 +306,7 @@ export interface AttributesConfigurationDc {
312
306
  /** Configuration of the attributes of the layer. */
313
307
  attributes?: (AttributeConfigurationDc | CalculatedAttributeConfigurationDc | GeometryAttributeConfigurationDc | StringAttributeConfigurationDc)[];
314
308
  /** Configuration of layer references. Isn't used by server. */
315
- layerReferences?: LayerReferenceConfigurationDc[];
309
+ layerReferences?: any;
316
310
  }
317
311
  export declare enum AuthorizationGrant {
318
312
  AuthorizationCode = "authorization_code",
@@ -518,20 +512,11 @@ export interface ColumnDescriptionDc {
518
512
  * @format int32
519
513
  */
520
514
  maxLength?: number;
521
- /**
522
- * Allows column contains null values.
523
- * @default true
524
- */
525
- isNullable?: boolean;
526
- /** Allows column with type Int32 or Int64 be autoincrement (SERIAL, BIGSERIAL). */
527
- isAutoincrement?: boolean;
528
515
  /**
529
516
  * Spatial reference identifier type in geometry type column.
530
517
  * @format int32
531
518
  */
532
519
  srId?: number;
533
- /** Ensures that the data in the column is unique across all rows in a table. */
534
- isUnique?: boolean;
535
520
  /** If sets true, index will be configured. */
536
521
  hasIndex?: boolean;
537
522
  }
@@ -1541,21 +1526,6 @@ export interface IncreaseResourcesLimitDc {
1541
1526
  /** Request justification. */
1542
1527
  justification?: string;
1543
1528
  }
1544
- /**
1545
- * Layer reference configuration. Isn't used by server.
1546
- */
1547
- export interface LayerReferenceConfigurationDc {
1548
- /** Name of the layer. */
1549
- layerName?: string;
1550
- /** Condition to apply. */
1551
- condition?: string;
1552
- /** Attribute name in base layer. */
1553
- referenceAttribute?: string;
1554
- /** Attribute name in target layer. */
1555
- targetAttribute?: string;
1556
- /** Id of the reference. */
1557
- referenceId?: string;
1558
- }
1559
1529
  /**
1560
1530
  * Specifies the available types of layer services that can be used within the application.
1561
1531
  */
@@ -3650,15 +3620,6 @@ export interface TaskReturnType {
3650
3620
  /** Name. */
3651
3621
  nullable?: boolean;
3652
3622
  }
3653
- /**
3654
- * Test connection data contract.
3655
- */
3656
- export interface TestConnectionInfoDc {
3657
- /** Check if connection succeed. */
3658
- isSuccess?: boolean;
3659
- /** Message. */
3660
- message?: string;
3661
- }
3662
3623
  /**
3663
3624
  * Service info for a tile catalog layer service.
3664
3625
  */
@@ -4724,13 +4685,11 @@ export interface GetFeatures1Params {
4724
4685
  /**
4725
4686
  * Features count have to skip.
4726
4687
  * @format int32
4727
- * @default 0
4728
4688
  */
4729
4689
  offset?: number;
4730
4690
  /**
4731
4691
  * Features limit per response.
4732
4692
  * @format int32
4733
- * @default 0
4734
4693
  */
4735
4694
  limit?: number;
4736
4695
  /**
@@ -4975,16 +4934,6 @@ export interface GetRasterMetaParams2 {
4975
4934
  */
4976
4935
  id: number;
4977
4936
  }
4978
- export interface SubscribeOperationParams {
4979
- /** Notification tag. */
4980
- tag?: string;
4981
- }
4982
- export interface UnsubscribeOperationParams {
4983
- /** Notification tag. */
4984
- tag?: string;
4985
- }
4986
- export type SubscribeListOperationPayload = string[];
4987
- export type UnsubscribeListOperationPayload = string[];
4988
4937
  export interface DeleteResourcesParams2 {
4989
4938
  /** Resource names. */
4990
4939
  names?: string[];