@nextgis/ngw-connector 1.9.2 → 1.11.2
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/README.md +125 -120
- package/lib/index.d.ts +77 -5
- package/lib/ngw-connector.cjs.js +124 -44
- package/lib/ngw-connector.cjs.js.map +1 -1
- package/lib/ngw-connector.cjs.prod.js +1 -1
- package/lib/ngw-connector.cjs.prod.js.map +1 -1
- package/lib/ngw-connector.esm-browser.js +189 -47
- package/lib/ngw-connector.esm-browser.js.map +1 -1
- package/lib/ngw-connector.esm-browser.prod.js +1 -1
- package/lib/ngw-connector.esm-browser.prod.js.map +1 -1
- package/lib/ngw-connector.esm-bundler.js +72 -26
- package/lib/ngw-connector.esm-bundler.js.map +1 -1
- package/lib/ngw-connector.esm-bundler.prod.js +1 -1
- package/lib/ngw-connector.esm-bundler.prod.js.map +1 -1
- package/lib/ngw-connector.global.js +259 -56
- package/lib/ngw-connector.global.js.map +1 -1
- package/lib/ngw-connector.global.prod.js +1 -1
- package/lib/ngw-connector.global.prod.js.map +1 -1
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -95,126 +95,131 @@ ngwConnector.get(request_name, request_options, arguments);
|
|
|
95
95
|
|
|
96
96
|
[request_options](https://code-api.nextgis.com/interfaces/ngw_connector.RequestOptions.html)
|
|
97
97
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
| auth.
|
|
104
|
-
| auth.group.
|
|
105
|
-
| auth.group.
|
|
106
|
-
| auth.
|
|
107
|
-
| auth.
|
|
108
|
-
| auth.
|
|
109
|
-
| auth.
|
|
110
|
-
| auth.
|
|
111
|
-
| auth.
|
|
112
|
-
| auth.
|
|
113
|
-
| auth.user.
|
|
114
|
-
| auth.user.
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
| collector.
|
|
119
|
-
| collector.
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
| feature_attachment.
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
| feature_layer.feature.
|
|
128
|
-
| feature_layer.feature.
|
|
129
|
-
| feature_layer.feature.
|
|
130
|
-
| feature_layer.feature.
|
|
131
|
-
| feature_layer.
|
|
132
|
-
| feature_layer.
|
|
133
|
-
| feature_layer.
|
|
134
|
-
| feature_layer.
|
|
135
|
-
| feature_layer.
|
|
136
|
-
| feature_layer.
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
141
|
-
|
|
|
142
|
-
|
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
|
|
|
147
|
-
| pyramid.
|
|
148
|
-
| pyramid.
|
|
149
|
-
| pyramid.
|
|
150
|
-
| pyramid.
|
|
151
|
-
| pyramid.
|
|
152
|
-
| pyramid.
|
|
153
|
-
| pyramid.
|
|
154
|
-
| pyramid.
|
|
155
|
-
| pyramid.
|
|
156
|
-
| pyramid.
|
|
157
|
-
| pyramid.
|
|
158
|
-
| pyramid.
|
|
159
|
-
| pyramid.
|
|
160
|
-
| pyramid.
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
| render.
|
|
166
|
-
|
|
|
167
|
-
|
|
|
168
|
-
|
|
|
169
|
-
| resource.
|
|
170
|
-
| resource.
|
|
171
|
-
| resource.
|
|
172
|
-
| resource.
|
|
173
|
-
| resource.
|
|
174
|
-
| resource.
|
|
175
|
-
| resource.
|
|
176
|
-
| resource.
|
|
177
|
-
| resource.
|
|
178
|
-
| resource.
|
|
179
|
-
| resource.
|
|
180
|
-
| resource.
|
|
181
|
-
| resource.
|
|
182
|
-
| resource.
|
|
183
|
-
| resource.
|
|
184
|
-
| resource.
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
| spatial_ref_sys.
|
|
189
|
-
| spatial_ref_sys.
|
|
190
|
-
| spatial_ref_sys.
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
|
195
|
-
|
|
|
196
|
-
|
|
|
197
|
-
|
|
|
198
|
-
| tracker.
|
|
199
|
-
| tracker.
|
|
200
|
-
| tracker.
|
|
201
|
-
| tracker.
|
|
202
|
-
| tracker.
|
|
203
|
-
| tracker.
|
|
204
|
-
| tracker.
|
|
205
|
-
| tracker.
|
|
206
|
-
| tracker.
|
|
207
|
-
| tracker.
|
|
208
|
-
| tracker.
|
|
209
|
-
| tracker.
|
|
210
|
-
|
|
|
211
|
-
|
|
|
212
|
-
|
|
|
213
|
-
|
|
|
214
|
-
| webmap.
|
|
215
|
-
| webmap.
|
|
216
|
-
|
|
|
217
|
-
|
|
|
98
|
+
<details>
|
|
99
|
+
<summary>API request names</summary>
|
|
100
|
+
|
|
101
|
+
| request name | url | arguments |
|
|
102
|
+
| --------------------------------- | ----------------------------------------------------- | ---------------- |
|
|
103
|
+
| auth.current_user | /api/component/auth/current_user | |
|
|
104
|
+
| auth.group.collection | /api/component/auth/group/ | |
|
|
105
|
+
| auth.group.create | /auth/group/create | |
|
|
106
|
+
| auth.group.delete | /auth/group/{0}/delete | id |
|
|
107
|
+
| auth.group.edit | /auth/group/{0}/edit | id |
|
|
108
|
+
| auth.group.item | /api/component/auth/group/{0} | id |
|
|
109
|
+
| auth.login_cookies | /api/component/auth/login | |
|
|
110
|
+
| auth.logout_cookies | /api/component/auth/logout | |
|
|
111
|
+
| auth.profile | /api/component/auth/profile | |
|
|
112
|
+
| auth.register | /api/component/auth/register | |
|
|
113
|
+
| auth.user.collection | /api/component/auth/user/ | |
|
|
114
|
+
| auth.user.create | /auth/user/create | |
|
|
115
|
+
| auth.user.delete | /auth/user/{0}/delete | id |
|
|
116
|
+
| auth.user.edit | /auth/user/{0}/edit | id |
|
|
117
|
+
| auth.user.item | /api/component/auth/user/{0} | id |
|
|
118
|
+
| collector.resource.read | /collector/resource/{0}/read | id |
|
|
119
|
+
| collector.resource.users | /collector/resource/{0}/users | id |
|
|
120
|
+
| collector.settings | /api/component/collector/settings | |
|
|
121
|
+
| collector.settings.users | /collector/user | |
|
|
122
|
+
| collector.user | /collector/user/{0} | user_id |
|
|
123
|
+
| feature_attachment.collection | /api/resource/{0}/feature/{1}/attachment/ | id,fid |
|
|
124
|
+
| feature_attachment.download | /api/resource/{0}/feature/{1}/attachment/{2}/download | id,fid,aid |
|
|
125
|
+
| feature_attachment.image | /api/resource/{0}/feature/{1}/attachment/{2}/image | id,fid,aid |
|
|
126
|
+
| feature_attachment.item | /api/resource/{0}/feature/{1}/attachment/{2} | id,fid,aid |
|
|
127
|
+
| feature_layer.feature.browse | /resource/{0}/feature/ | id |
|
|
128
|
+
| feature_layer.feature.collection | /api/resource/{0}/feature/ | id |
|
|
129
|
+
| feature_layer.feature.count | /api/resource/{0}/feature_count | id |
|
|
130
|
+
| feature_layer.feature.item | /api/resource/{0}/feature/{1} | id,fid |
|
|
131
|
+
| feature_layer.feature.item_extent | /api/resource/{0}/feature/{1}/extent | id,fid |
|
|
132
|
+
| feature_layer.feature.show | /resource/{0}/feature/{1} | id,feature_id |
|
|
133
|
+
| feature_layer.feature.update | /resource/{0}/feature/{1}/update | id,feature_id |
|
|
134
|
+
| feature_layer.field | /resource/{0}/field/ | id |
|
|
135
|
+
| feature_layer.geojson | /api/resource/{0}/geojson | id |
|
|
136
|
+
| feature_layer.identify | /api/feature_layer/identify | |
|
|
137
|
+
| feature_layer.mvt | /api/component/feature_layer/mvt | |
|
|
138
|
+
| feature_layer.store | /api/resource/{0}/store/ | id |
|
|
139
|
+
| feature_layer.store.item | /resource/{0}/store/{1} | id,feature_id |
|
|
140
|
+
| file_upload.collection | /api/component/file_upload/ | |
|
|
141
|
+
| file_upload.item | /api/component/file_upload/{0} | id |
|
|
142
|
+
| file_upload.upload | /api/component/file_upload/upload | |
|
|
143
|
+
| formbuilder.formbuilder_form_ngfp | /api/resource/{0}/ngfp | id |
|
|
144
|
+
| layer.extent | /api/resource/{0}/extent | id |
|
|
145
|
+
| postgis.connection.inspect | /api/resource/{0}/inspect/ | id |
|
|
146
|
+
| postgis.connection.inspect.table | /api/resource/{0}/inspect/{1}/ | id,table_name |
|
|
147
|
+
| pyramid.company_logo | /api/component/pyramid/company_logo | |
|
|
148
|
+
| pyramid.control_panel | /control-panel | |
|
|
149
|
+
| pyramid.control_panel.sysinfo | /control-panel/sysinfo | |
|
|
150
|
+
| pyramid.cors | /api/component/pyramid/cors | |
|
|
151
|
+
| pyramid.custom_css | /api/component/pyramid/custom_css | |
|
|
152
|
+
| pyramid.estimate_storage | /api/component/pyramid/estimate_storage | |
|
|
153
|
+
| pyramid.healthcheck | /api/component/pyramid/healthcheck | |
|
|
154
|
+
| pyramid.home_path | /api/component/pyramid/home_path | |
|
|
155
|
+
| pyramid.kind_of_data | /api/component/pyramid/kind_of_data | |
|
|
156
|
+
| pyramid.locdata | /api/component/pyramid/locdata/{0}/{1} | component,locale |
|
|
157
|
+
| pyramid.logo | /api/component/pyramid/logo | |
|
|
158
|
+
| pyramid.pkg_version | /api/component/pyramid/pkg_version | |
|
|
159
|
+
| pyramid.route | /api/component/pyramid/route | |
|
|
160
|
+
| pyramid.settings | /api/component/pyramid/settings | |
|
|
161
|
+
| pyramid.statistics | /api/component/pyramid/statistics | |
|
|
162
|
+
| pyramid.storage | /api/component/pyramid/storage | |
|
|
163
|
+
| pyramid.system_name | /api/component/pyramid/system_name | |
|
|
164
|
+
| qgis.style_qml | /api/resource/{0}/qml | id |
|
|
165
|
+
| render.image | /api/component/render/image | |
|
|
166
|
+
| render.legend | /api/resource/{0}/legend | id |
|
|
167
|
+
| render.tile | /api/component/render/tile | |
|
|
168
|
+
| render.tile_cache.seed_status | /api/resource/{0}/tile_cache/seed_status | id |
|
|
169
|
+
| resource.collection | /api/resource/ | |
|
|
170
|
+
| resource.create | /resource/{0}/create | id |
|
|
171
|
+
| resource.delete | /resource/{0}/delete | id |
|
|
172
|
+
| resource.export | /api/resource/{0}/export | id |
|
|
173
|
+
| resource.file_download | /api/resource/{0}/file/{1} | id,name |
|
|
174
|
+
| resource.item | /api/resource/{0} | id |
|
|
175
|
+
| resource.json | /resource/{0}/json | id |
|
|
176
|
+
| resource.permission | /api/resource/{0}/permission | id |
|
|
177
|
+
| resource.permission.explain | /api/resource/{0}/permission/explain | id |
|
|
178
|
+
| resource.preview | /api/resource/{0}/preview.png | id |
|
|
179
|
+
| resource.quota | /api/resource/quota | |
|
|
180
|
+
| resource.resource_export | /api/component/resource/resource_export | |
|
|
181
|
+
| resource.schema | /resource/schema | |
|
|
182
|
+
| resource.search | /api/resource/search/ | |
|
|
183
|
+
| resource.show | /resource/{0} | id |
|
|
184
|
+
| resource.tree | /resource/{0}/tree | id |
|
|
185
|
+
| resource.update | /resource/{0}/update | id |
|
|
186
|
+
| resource.volume | /api/resource/{0}/volume | id |
|
|
187
|
+
| resource.widget | /resource/widget | |
|
|
188
|
+
| spatial_ref_sys.collection | /api/component/spatial_ref_sys/ | |
|
|
189
|
+
| spatial_ref_sys.convert | /api/component/spatial_ref_sys/convert | |
|
|
190
|
+
| spatial_ref_sys.geom_area | /api/component/spatial_ref_sys/{0}/geom_area | id |
|
|
191
|
+
| spatial_ref_sys.geom_length | /api/component/spatial_ref_sys/{0}/geom_length | id |
|
|
192
|
+
| spatial_ref_sys.geom_transform | /api/component/spatial_ref_sys/{0}/geom_transform | id |
|
|
193
|
+
| spatial_ref_sys.get | /api/component/spatial_ref_sys/{0} | id |
|
|
194
|
+
| srs.create | /srs/create | |
|
|
195
|
+
| srs.delete | /srs/{0}/delete | id |
|
|
196
|
+
| srs.edit | /srs/{0}/edit | id |
|
|
197
|
+
| tmsclient.connection.layers | /api/component/tmsclient/{0}/layers/ | id |
|
|
198
|
+
| tracker.export_to_gpx | /tracker/gpx | |
|
|
199
|
+
| tracker.get.stops | /tracker/stops | |
|
|
200
|
+
| tracker.get_amd_static_url | /tracker/amd/static/url/ | |
|
|
201
|
+
| tracker.get_device_types | /tracker/device_types | |
|
|
202
|
+
| tracker.get_full_tracks | /tracker/tracks/full | |
|
|
203
|
+
| tracker.get_last_activity_tracker | /tracker/activity/last | |
|
|
204
|
+
| tracker.get_short_tracks | /tracker/tracks/short | |
|
|
205
|
+
| tracker.get_tracker_last_points | /tracker/last/points | |
|
|
206
|
+
| tracker.get_tracker_lines | /tracker/lines | |
|
|
207
|
+
| tracker.get_tracker_points | /tracker/points | |
|
|
208
|
+
| tracker.get_trackers | /tracker/trackers/tree | |
|
|
209
|
+
| tracker.receive_packet | /tracker/{0}/receive | unique_id |
|
|
210
|
+
| tracker.reports | /tracker/reports/ | |
|
|
211
|
+
| tracker.reports.build | /tracker/report/build/ | |
|
|
212
|
+
| tracker.settings | /api/component/tracker/settings | |
|
|
213
|
+
| vector_layer.dataset | /api/component/vector_layer/dataset | |
|
|
214
|
+
| webmap.annotation.collection | /api/resource/{0}/annotation/ | id |
|
|
215
|
+
| webmap.annotation.item | /api/resource/{0}/annotation/{1} | id,annotation_id |
|
|
216
|
+
| webmap.display | /resource/{0}/display | id |
|
|
217
|
+
| webmap.display.tiny | /resource/{0}/display/tiny | id |
|
|
218
|
+
| webmap.settings | /api/component/webmap/settings | |
|
|
219
|
+
| wfsserver.wfs | /api/resource/{0}/wfs | id |
|
|
220
|
+
| wmsserver.wms | /api/resource/{0}/wms | id |
|
|
221
|
+
|
|
222
|
+
</details>
|
|
218
223
|
|
|
219
224
|
## Commercial support
|
|
220
225
|
|
package/lib/index.d.ts
CHANGED
|
@@ -86,7 +86,7 @@ export declare interface FeatureLayerCount {
|
|
|
86
86
|
}
|
|
87
87
|
|
|
88
88
|
export declare interface FeatureLayerField {
|
|
89
|
-
datatype:
|
|
89
|
+
datatype: VectorFieldDatatype;
|
|
90
90
|
display_name: string;
|
|
91
91
|
grid_visibility: boolean;
|
|
92
92
|
id: number;
|
|
@@ -299,7 +299,7 @@ declare class NgwConnector {
|
|
|
299
299
|
* @param params - Query params
|
|
300
300
|
* @param options - Request options
|
|
301
301
|
*/
|
|
302
|
-
makeQuery(url: string, params?: Params, options?: RequestOptions): CancelablePromise<
|
|
302
|
+
makeQuery<R = unknown>(url: string, params?: Params | null, options?: RequestOptions): CancelablePromise<R>;
|
|
303
303
|
/**
|
|
304
304
|
* {@inheritDoc ResourcesControl.getOne}
|
|
305
305
|
*/
|
|
@@ -440,7 +440,7 @@ export declare interface PutRequestItemsResponseMap extends RequestItemKeys {
|
|
|
440
440
|
}
|
|
441
441
|
|
|
442
442
|
export declare interface PyramidRoute {
|
|
443
|
-
[requestItemName: string]: string[];
|
|
443
|
+
[requestItemName: string]: [url: string, ...params: string[]];
|
|
444
444
|
}
|
|
445
445
|
|
|
446
446
|
export declare type PyramidSettings = PyramidSettingsPyramid | Record<string, any>;
|
|
@@ -724,9 +724,13 @@ export declare interface ResourceItem extends ResourceItemMain {
|
|
|
724
724
|
basemap_webmap?: BasemapWebmap;
|
|
725
725
|
lookup_table?: LookupTableResource;
|
|
726
726
|
file_bucket?: FileBucket;
|
|
727
|
+
wmsserver_service?: WmsServerService;
|
|
728
|
+
wmsclient_layer?: WmsClientLayer;
|
|
729
|
+
wmsclient_connection?: WmsClientConnection;
|
|
727
730
|
}
|
|
728
731
|
|
|
729
|
-
|
|
732
|
+
/** @deprecated - use {@link VectorFieldDatatype} instead */
|
|
733
|
+
export declare type ResourceItemDatatype = VectorFieldDatatype;
|
|
730
734
|
|
|
731
735
|
export declare interface ResourceItemMain {
|
|
732
736
|
resource: Resource;
|
|
@@ -747,7 +751,7 @@ declare class ResourceNotFoundError extends NgwError {
|
|
|
747
751
|
declare class ResourcesControl {
|
|
748
752
|
private connector;
|
|
749
753
|
cache: Cache_2<CancelablePromise<ResourceItem | undefined>, {
|
|
750
|
-
id?: number | undefined;
|
|
754
|
+
id?: string | number | undefined;
|
|
751
755
|
}>;
|
|
752
756
|
constructor(connector: NgwConnector);
|
|
753
757
|
/**
|
|
@@ -788,6 +792,7 @@ declare class ResourcesControl {
|
|
|
788
792
|
* @param resource - Resource definition
|
|
789
793
|
*/
|
|
790
794
|
delete(resource: ResourceDefinition): CancelablePromise<void>;
|
|
795
|
+
private _cleanResourceItemCache;
|
|
791
796
|
private _fetchResourceById;
|
|
792
797
|
private _fetchResourceBy;
|
|
793
798
|
private _resourceCacheFilter;
|
|
@@ -845,10 +850,13 @@ export declare interface TreeLayer extends TreeItem {
|
|
|
845
850
|
export declare interface UserInfo {
|
|
846
851
|
display_name: string;
|
|
847
852
|
id: number;
|
|
853
|
+
/** @defaultValue 'guest' */
|
|
848
854
|
keyname: 'guest' | string;
|
|
849
855
|
clientId?: string;
|
|
850
856
|
}
|
|
851
857
|
|
|
858
|
+
export declare type VectorFieldDatatype = 'STRING' | 'REAL' | 'DATE' | 'TIME' | 'DATETIME' | 'BIGINT' | 'INTEGER' | 'BOOLEAN';
|
|
859
|
+
|
|
852
860
|
export declare interface VectorLayer {
|
|
853
861
|
srs: {
|
|
854
862
|
id: number;
|
|
@@ -866,9 +874,73 @@ export declare interface WebmapResource {
|
|
|
866
874
|
extent_right: number;
|
|
867
875
|
extent_bottom: number;
|
|
868
876
|
extent_top: number;
|
|
877
|
+
extent_constrained: boolean;
|
|
869
878
|
draw_order_enabled: boolean;
|
|
870
879
|
bookmark_resource: ResourceHierarchy;
|
|
871
880
|
root_item: TreeGroup;
|
|
872
881
|
}
|
|
873
882
|
|
|
883
|
+
export declare interface WmsClientConnection {
|
|
884
|
+
/** WMS service url */
|
|
885
|
+
url: string;
|
|
886
|
+
/** User name to connect to service */
|
|
887
|
+
username?: string;
|
|
888
|
+
/** Password to connect to service */
|
|
889
|
+
password?: string;
|
|
890
|
+
/** WMS version */
|
|
891
|
+
version?: string;
|
|
892
|
+
/** If equal query - query capabilities from service */
|
|
893
|
+
capcache?: string;
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
export declare interface WmsClientLayer {
|
|
897
|
+
/** WMS connection. */
|
|
898
|
+
connection: {
|
|
899
|
+
id: number;
|
|
900
|
+
};
|
|
901
|
+
srs: {
|
|
902
|
+
id: number;
|
|
903
|
+
};
|
|
904
|
+
/**
|
|
905
|
+
* Image format. Available values can fetched from WMS connection ('image/png').
|
|
906
|
+
*/
|
|
907
|
+
imgformat: string;
|
|
908
|
+
/**
|
|
909
|
+
* String with layer identifiers separated with comma. Available layers can fetched from WMS connection.
|
|
910
|
+
*/
|
|
911
|
+
wmslayers: string;
|
|
912
|
+
/** Additional parameters added to each request. This is key and value list. */
|
|
913
|
+
vendor_params: Record<string, string>;
|
|
914
|
+
}
|
|
915
|
+
|
|
916
|
+
export declare interface WmsServerService {
|
|
917
|
+
/**
|
|
918
|
+
* Array or WMS service layers. keyname, display_name and resource_id are mandatory.
|
|
919
|
+
*/
|
|
920
|
+
layers: WmsServerServiceLayer[];
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
export declare interface WmsServerServiceLayer {
|
|
924
|
+
/**
|
|
925
|
+
* Key name for WMS service item. Name may be only ASCII symbols without spaces.
|
|
926
|
+
* */
|
|
927
|
+
keyname: string;
|
|
928
|
+
/**
|
|
929
|
+
* Service item name.
|
|
930
|
+
* */
|
|
931
|
+
display_name: string;
|
|
932
|
+
/**
|
|
933
|
+
* Resource identifier which will be WMS layer datasource. Supported types are: vector layer style, raster style, WMS layer.
|
|
934
|
+
* */
|
|
935
|
+
resource_id: number;
|
|
936
|
+
/**
|
|
937
|
+
* Minimum scale to show WMS layer. String in form of `1 : 100000`.
|
|
938
|
+
*/
|
|
939
|
+
min_scale_denom?: string | null;
|
|
940
|
+
/**
|
|
941
|
+
* Maximum scale to show WMS layer. String in form of `1 : 100000`.
|
|
942
|
+
*/
|
|
943
|
+
max_scale_denom?: string | null;
|
|
944
|
+
}
|
|
945
|
+
|
|
874
946
|
export { }
|