@evergis/api 5.0.34 → 5.0.35

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
@@ -5,7 +5,7 @@ import { QueryTokenAccessService } from './__generated__/QueryTokenAccessService
5
5
  import { SpatialReferencesService } from './__generated__/SpatialReferencesService';
6
6
  import { CatalogService } from './__generated__/CatalogService';
7
7
  import { EventEmitter } from './EventEmitter';
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';
8
+ import { Account, AccountPreview, External, BulkOperations, CatalogShare, ClientSettings, Eql, Feedback, FileUpload, Filters, Geocode, History, Import, Layers, Names, PortalSettings, Projects, RemoteTaskManager, Resources, Security, Statistic, Tables, Tools, VectorTiles } from './services';
9
9
  import { AuthenticateParams, LoginDc } from './__generated__/data-contracts';
10
10
  export type ApiParams = {
11
11
  url: string;
@@ -48,6 +48,8 @@ export declare class Api extends EventEmitter {
48
48
  readonly queryToken: QueryTokenAccessService;
49
49
  readonly dataSource: DataSourceService;
50
50
  readonly remoteTaskManager: RemoteTaskManager;
51
+ readonly catalogShare: CatalogShare;
52
+ readonly history: History;
51
53
  protected readonly http: HttpClient;
52
54
  private readonly urlPath;
53
55
  private refreshingToken;
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { AccessControlListDc, CopyResourceResultDc, CopyResourcesPayload, CreateDirectoryDc, CreateFile1Payload, CreateFilePayload, CreateSymlinkDc, DeleteResourceParams, ExtendedCatalogResourceDc, GetTagsParams, ListResourcesDc, MoveResourceDc, PagedResourcesListDc, PagedTagsListDc, PatchResourceDc, PostGetAllParams, PutTagsPayload, ResourceParentDc, SetPermissionsPayload, ZipExtractRequestDc } from './data-contracts';
2
+ import { AccessControlListDc, CopyResourceResultDc, CopyResourcesPayload, CreateDirectoryDc, CreateFile1Payload, CreateFilePayload, CreateSymlinkDc, DeleteResourceParams, ExtendedCatalogResourceDc, FailedCatalogConfigurationDc, GetTagsParams, ListConfigurationsDc, ListResourcesDc, MoveResourceDc, PagedResourcesListDc, PagedTagsListDc, PatchResourceDc, PostGetAllParams, PutTagsPayload, ResourceParentDc, SetPermissionsPayload, SucceedCatalogConfigurationDc, ZipExtractRequestDc } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -102,6 +102,18 @@ export declare class CatalogService extends Service {
102
102
  * @response `200` OK
103
103
  */
104
104
  deleteResource({ resourceId, ...query }: DeleteResourceParams): Promise<void>;
105
+ /**
106
+ * No description
107
+ *
108
+ * @tags Catalog
109
+ * @name PostListConfigurations
110
+ * @operationId CatalogController_PostListConfigurations
111
+ * @summary Get configurations for resources.
112
+ * @request POST:/resources/configurations
113
+ * @secure
114
+ * @response `200` OK
115
+ */
116
+ postListConfigurations(data: ListConfigurationsDc): Promise<(SucceedCatalogConfigurationDc | FailedCatalogConfigurationDc)[]>;
105
117
  /**
106
118
  * No description
107
119
  *
@@ -186,18 +198,6 @@ export declare class CatalogService extends Service {
186
198
  * @response `200` OK
187
199
  */
188
200
  setPermissions1(resourceId: string, data: AccessControlListDc): Promise<void>;
189
- /**
190
- * No description
191
- *
192
- * @tags Catalog
193
- * @name GetPermissionsV2
194
- * @operationId CatalogController_GetPermissionsV2
195
- * @summary Set permissions to the resource.
196
- * @request GET:/resources/permissions/{resourceId}
197
- * @secure
198
- * @response `200` OK
199
- */
200
- getPermissionsV2(resourceId: string): Promise<AccessControlListDc>;
201
201
  /**
202
202
  * No description
203
203
  *
@@ -210,6 +210,19 @@ export declare class CatalogService extends Service {
210
210
  * @response `200` OK
211
211
  */
212
212
  setPermissions(data: SetPermissionsPayload): Promise<void>;
213
+ /**
214
+ * No description
215
+ *
216
+ * @tags Catalog
217
+ * @name BreakPermissionInheritance
218
+ * @operationId CatalogController_BreakPermissionInheritance
219
+ * @summary Breaks ACL inheritance for the resource: it stops inheriting permissions
220
+ from its parent and keeps its own explicit access control list.
221
+ * @request POST:/resources/permissions/break-inheritance/{resourceId}
222
+ * @secure
223
+ * @response `200` OK
224
+ */
225
+ breakPermissionInheritance(resourceId: string): Promise<void>;
213
226
  /**
214
227
  * No description
215
228
  *
@@ -0,0 +1,74 @@
1
+ import { Service } from './Service';
2
+ import { InvitationIdDc, InvitationViewDc, ListInvitationsDc, ProposeInvitationDc } from './data-contracts';
3
+ /**
4
+ * @title Spatial Processing Gateway API
5
+ * @version 1.5.1.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class CatalogShareService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags CatalogShare
13
+ * @name ListInvitations
14
+ * @operationId CatalogShareController_ListInvitations
15
+ * @summary Returns the current user's invitations filtered by the requested statuses
16
+ (defaults to `Pending` when none are supplied).
17
+ * @request POST:/resources/share-invitations/list
18
+ * @secure
19
+ * @response `200` OK
20
+ */
21
+ listInvitations(data: ListInvitationsDc): Promise<InvitationViewDc[]>;
22
+ /**
23
+ * No description
24
+ *
25
+ * @tags CatalogShare
26
+ * @name ProposeInvitation
27
+ * @operationId CatalogShareController_ProposeInvitation
28
+ * @summary Proposes a share invitation for a resource to another user. No access is
29
+ granted and no alias is created until the grantee accepts.
30
+ * @request POST:/resources/share-invitations/propose
31
+ * @secure
32
+ * @response `200` OK
33
+ */
34
+ proposeInvitation(data: ProposeInvitationDc): Promise<string>;
35
+ /**
36
+ * No description
37
+ *
38
+ * @tags CatalogShare
39
+ * @name AcceptInvitation
40
+ * @operationId CatalogShareController_AcceptInvitation
41
+ * @summary Accepts a pending invitation addressed to the current user: issues the grant
42
+ and creates the alias in the recipient's tree.
43
+ * @request POST:/resources/share-invitations/accept
44
+ * @secure
45
+ * @response `200` OK
46
+ */
47
+ acceptInvitation(data: InvitationIdDc): Promise<void>;
48
+ /**
49
+ * No description
50
+ *
51
+ * @tags CatalogShare
52
+ * @name DeclineInvitation
53
+ * @operationId CatalogShareController_DeclineInvitation
54
+ * @summary Declines a pending invitation addressed to the current user. Leaves no
55
+ grants or nodes behind.
56
+ * @request POST:/resources/share-invitations/decline
57
+ * @secure
58
+ * @response `200` OK
59
+ */
60
+ declineInvitation(data: InvitationIdDc): Promise<void>;
61
+ /**
62
+ * No description
63
+ *
64
+ * @tags CatalogShare
65
+ * @name RevokeInvitation
66
+ * @operationId CatalogShareController_RevokeInvitation
67
+ * @summary Revokes an invitation created by the current user. If it was already accepted,
68
+ the grant is removed and the created alias is deleted.
69
+ * @request POST:/resources/share-invitations/revoke
70
+ * @secure
71
+ * @response `200` OK
72
+ */
73
+ revokeInvitation(data: InvitationIdDc): Promise<void>;
74
+ }
@@ -0,0 +1,21 @@
1
+ import { Service } from './Service';
2
+ import { InitializeParams } from './data-contracts';
3
+ /**
4
+ * @title Spatial Processing Gateway API
5
+ * @version 1.5.1.0
6
+ * @baseUrl /sp
7
+ */
8
+ export declare class HistoryService extends Service {
9
+ /**
10
+ * No description
11
+ *
12
+ * @tags History
13
+ * @name Initialize
14
+ * @operationId HistoryController_Initialize
15
+ * @summary Initialize history module on user namespace schema.
16
+ * @request POST:/history/initialize
17
+ * @secure
18
+ * @response `200` OK
19
+ */
20
+ initialize(query: InitializeParams): Promise<void>;
21
+ }
@@ -1,5 +1,5 @@
1
1
  import { Service } from './Service';
2
- import { CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteTableDataParams, DetailedTableInfoDc, GetTableDataParams, GetTablesInfoParams, MapTableInfoDc, MapTableParams, PagedListFeatureDc, ResourceDependenciesDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
2
+ import { CleanParams, CreateViewFromQueryDc, CreateViewFromQueryLayerDc, DeleteTableDataParams, DetailedTableInfoDc, DisableParams, EnableParams, GetTableDataParams, GetTablesInfoParams, HistoryItemDc, MapTableInfoDc, MapTableParams, PagedListFeatureDc, ResourceDependenciesDc, TableHistoryRequestDc, UpdateTableDataParams, UpdateTableDataPayload, UpdateTableDc, WriteTableDataPayload } from './data-contracts';
3
3
  /**
4
4
  * @title Spatial Processing Gateway API
5
5
  * @version 1.5.1.0
@@ -138,6 +138,54 @@ export declare class TablesService extends Service {
138
138
  * @response `200` OK
139
139
  */
140
140
  unmapTable(name: string): Promise<void>;
141
+ /**
142
+ * No description
143
+ *
144
+ * @tags Tables
145
+ * @name Enable
146
+ * @operationId TablesController_EnableAsync
147
+ * @summary Enable table history.
148
+ * @request POST:/tables/{tableName}/history/enable
149
+ * @secure
150
+ * @response `200` OK
151
+ */
152
+ enable({ tableName, ...query }: EnableParams): Promise<void>;
153
+ /**
154
+ * No description
155
+ *
156
+ * @tags Tables
157
+ * @name Disable
158
+ * @operationId TablesController_DisableAsync
159
+ * @summary Disable table history.
160
+ * @request DELETE:/tables/{tableName}/history/disable
161
+ * @secure
162
+ * @response `200` OK
163
+ */
164
+ disable({ tableName, ...query }: DisableParams): Promise<void>;
165
+ /**
166
+ * No description
167
+ *
168
+ * @tags Tables
169
+ * @name Clean
170
+ * @operationId TablesController_CleanAsync
171
+ * @summary Clean table history.
172
+ * @request DELETE:/tables/{tableName}/history/clean
173
+ * @secure
174
+ * @response `200` OK
175
+ */
176
+ clean({ tableName, ...query }: CleanParams): Promise<void>;
177
+ /**
178
+ * No description
179
+ *
180
+ * @tags Tables
181
+ * @name Get
182
+ * @operationId TablesController_GetAsync
183
+ * @summary Get history data.
184
+ * @request POST:/tables/{tableName}/history
185
+ * @secure
186
+ * @response `200` OK
187
+ */
188
+ get(tableName: string, data: TableHistoryRequestDc): Promise<HistoryItemDc[]>;
141
189
  /**
142
190
  * No description
143
191
  *