@nextgis/ngw-connector 3.0.0-alpha.13 → 3.0.0-alpha.16

package/lib/index.d.ts

@@ -3,12 +3,8 @@ import Cache from '@nextgis/cache';
 import { EventEmitter } from 'events';
 import { FeatureProperties, DeepPartial } from '@nextgis/utils';
 import { LegendSymbol } from '@nextgisweb/render/type/api';
-import { ResourceCls as ResourceCls$1, ResourceRead, CompositeRead } from '@nextgisweb/resource/type/api';
+import { ResourceRead, CompositeRead } from '@nextgisweb/resource/type/api';
 import { GeoJsonObject, Geometry } from 'geojson';
-import { BasemapWebMapItemRead, BasemapWebMapRead } from '@nextgisweb/basemap/type/api';
-import { FeatureLayerRead } from '@nextgisweb/feature-layer/type/api';
-import { VectorLayerRead } from '@nextgisweb/vector-layer/type/api';
-import { WebMapRead } from '@nextgisweb/webmap/type/api';
 
 declare class LunkwillParam {
     static VALUES: (string | null)[];
@@ -594,7 +590,7 @@ interface Permission {
     propagate: boolean;
 }
 /** @deprecated use  ResourceCls from '@nextgisweb/resource/type/api' instead */
-type ResourceCls = ResourceCls$1;
+type ResourceCls = 'resource_group' | 'postgis_layer' | 'wmsserver_service' | 'basemap_layer' | 'postgis_connection' | 'webmap' | 'wfsserver_service' | 'vector_layer' | 'raster_layer' | 'mapserver_style' | 'qgis_vector_style' | 'qgis_raster_style' | 'raster_style' | 'file_bucket' | 'lookup_table' | 'wmsclient_layer' | 'wmsclient_connection' | 'formbuilder_form' | 'file_bucket' | 'svg_marker_library' | 'ogcfserver_service' | 'tmsclient_connection' | 'tileset' | 'collector_project' | 'demo_project' | 'trackers_group' | 'tracker' | 'terrain_provider' | 'model_3d' | 'tmsclient_layer';
 interface ResourceHierarchy {
     id: number;
     parent: {
@@ -602,7 +598,23 @@ interface ResourceHierarchy {
     };
 }
 /** @deprecated use  ResourceRead from '@nextgisweb/resource/type/api' instead */
-type Resource = ResourceRead;
+interface Resource {
+    cls: ResourceCls;
+    id: number;
+    parent: {
+        id: number;
+    };
+    owner_user: {
+        id: number;
+    };
+    permissions: Permission[];
+    keyname?: string | null;
+    display_name: string;
+    description?: string | null;
+    children: boolean;
+    interfaces: any[];
+    scopes: string[];
+}
 interface BookmarkProperties {
     name: string;
     place: string;
@@ -619,7 +631,16 @@ interface NgwTimeFormat {
 }
 type NgwDateTimeFormat = NgwDateFormat & NgwTimeFormat;
 /** @deprecated use  WebMapRead from '@nextgisweb/resource/type/api' instead */
-type WebmapResource = WebMapRead;
+interface WebmapResource {
+    extent_left: number;
+    extent_right: number;
+    extent_bottom: number;
+    extent_top: number;
+    extent_constrained: boolean;
+    draw_order_enabled: boolean;
+    bookmark_resource: ResourceHierarchy;
+    root_item: TreeGroup;
+}
 interface BasemapResource {
     url: string;
     /**
@@ -628,9 +649,17 @@ interface BasemapResource {
     qms: string;
 }
 /** @deprecated use  BasemapWebMapItemRead from '@nextgisweb/resource/type/api' instead */
-type BasemapWebmapItem = BasemapWebMapItemRead;
+interface BasemapWebmapItem {
+    resource_id: number;
+    display_name: string;
+    position?: number;
+    enabled?: boolean;
+    opacity?: number;
+}
 /** @deprecated use  BasemapWebMapRead from '@nextgisweb/resource/type/api' instead */
-type BasemapWebmap = BasemapWebMapRead;
+interface BasemapWebmap {
+    basemaps: BasemapWebmapItem[];
+}
 interface LookupTableResource {
     items: Record<string, string>;
 }
@@ -647,10 +676,17 @@ interface FeatureLayerField {
     typemod?: unknown;
 }
 /** @deprecated use  FeatureLayerRead from '@nextgisweb/resource/type/api' instead */
-type FeatureResource = FeatureLayerRead;
+interface FeatureResource {
+    fields: FeatureLayerField[];
+}
 type GeometryType = 'POINT' | 'LINESTRING' | 'POLYGON' | 'MULTIPOINT' | 'MULTILINESTRING' | 'MULTIPOLYGON' | 'POINTZ' | 'LINESTRINGZ' | 'POLYGONZ' | 'MULTIPOINTZ' | 'MULTILINESTRINGZ' | 'MULTIPOLYGONZ';
 /** @deprecated use  VectorLayerRead from '@nextgisweb/resource/type/api' instead */
-type VectorLayer = VectorLayerRead;
+interface VectorLayer {
+    srs: {
+        id: number;
+    };
+    geometry_type: GeometryType;
+}
 interface FileBucket {
     files: NgwFile[];
     tstamp?: any;
@@ -723,8 +759,28 @@ interface NgwFile {
 interface Resmeta {
     items: Record<string, any>;
 }
+interface ResourceItemMain {
+    resource: Resource;
+    resmeta: Resmeta;
+}
 /** @deprecated use  CompositeRead from '@nextgisweb/resource/type/api' instead */
-type ResourceItem = CompositeRead;
+interface ResourceItem extends ResourceItemMain {
+    [cls: string]: any;
+    webmap?: WebmapResource;
+    feature_layer?: FeatureResource;
+    vector_layer?: VectorLayer;
+    basemap_layer?: BasemapResource;
+    basemap_webmap?: BasemapWebmap;
+    lookup_table?: LookupTableResource;
+    file_bucket?: FileBucket;
+    wmsserver_service?: WmsServerService;
+    wmsclient_layer?: WmsClientLayer;
+    wmsclient_connection?: WmsClientConnection;
+}
+interface VectorLayerResourceItem extends ResourceItemMain {
+    vector_layer: VectorLayer;
+    feature_layer: FeatureResource;
+}
 
 type ResourceStoreItemProperties = {
     [name: string]: any;
@@ -1072,6 +1128,7 @@ declare class NgwConnector {
     user?: UserInfo;
     cache: Cache;
     withCredentials?: boolean;
+    private readonly routeCache;
     private client;
     private routeStr;
     private activeRequests;
@@ -1329,4 +1386,4 @@ interface LayerLegend {
     setSymbolRender?: (symbolIndex: number, status: boolean) => void;
 }
 
-export { type ApiRouteParams, type BaseRequestOptions, type BasemapResource, type BasemapWebmap, type BasemapWebmapItem, type BookmarkProperties, type CreatedResource, type Credentials, type DeleteRequestItemsResponseMap, type DeleteRequestOptions, type FeatureItem, type FeatureItemAttachment, type FeatureItemExtensions, type FeatureItemToNgw, type FeatureLayerCount, type FeatureLayerField, type FeatureLayersIdentify, type FeatureLayersIdentifyItems, type FeatureResource, type FileBucket, type FileMeta, type FileUploadResp, type GeometryType, type GetChildrenOfOptions, type GetRequestItemsResponseMap, type GetRequestOptions, type GetRouteParam, type IdOnly, type KeysWithMethodAndPath, type KeysWithMethods, type KeysWithPaths, type LayerFeature, type LayerLegend, type LoadingQueue, type LookupTableResource, type LunkwillData, type Method, type MethodAvailable, type MethodRequestOptions, type NgwConnectorOptions, type NgwDateFormat, type NgwDateTimeFormat, type NgwExceptions, type NgwExtent, type NgwFile, type NgwLayerIdentifyError, type NgwTimeFormat, type Params, type PatchRequestItemsResponseMap, type PatchRequestOptions, type Permission, type PostRequestItemsResponseMap, type PostRequestOptions, type PutRequestItemsResponseMap, type PutRequestOptions, type PyramidRoute, type PyramidSettings, type PyramidSettingsPyramid, type PyramidSettingsPyramidCompanyLogo, type RequestHeaders, type RequestItemAdditionalParams, type RequestItemKeys, type RequestItemsParams, type RequestItemsParamsMap, type RequestItemsResponseMap, type RequestMethod, type RequestMethods, type RequestOptions, type RequestOptionsBody, type RequestOptionsByMethod, type RequestOptionsJSON, type RequestTransformFunction, type Resmeta, type Resource, type ResourceCls, type ResourceDefinition, type ResourceHierarchy, type ResourceIdKeynameDef, type ResourceItem, type ResourceItemDatatype, type ResourceStoreItem, type ResourceStoreItemDefault, type ResourceStoreItemProperties, type ResponseType, type RouteBody, type RouteMethods, type RouteName, type RouteParameters, type RouteQuery, type RouteRequestOptions, type RouteResp, type RouteResults, type Router, type SrsItem, type ToReturn, type TreeGroup, type TreeItem, type TreeLayer, type UserInfo, type VectorFieldDatatype, type VectorLayer, type WebmapResource, type WmsClientConnection, type WmsClientLayer, type WmsServerService, type WmsServerServiceLayer, NgwConnectorExtended as default };
+export { type ApiRouteParams, type BaseRequestOptions, type BasemapResource, type BasemapWebmap, type BasemapWebmapItem, type BookmarkProperties, type CreatedResource, type Credentials, type DeleteRequestItemsResponseMap, type DeleteRequestOptions, type FeatureItem, type FeatureItemAttachment, type FeatureItemExtensions, type FeatureItemToNgw, type FeatureLayerCount, type FeatureLayerField, type FeatureLayersIdentify, type FeatureLayersIdentifyItems, type FeatureResource, type FileBucket, type FileMeta, type FileUploadResp, type GeometryType, type GetChildrenOfOptions, type GetRequestItemsResponseMap, type GetRequestOptions, type GetRouteParam, type IdOnly, type KeysWithMethodAndPath, type KeysWithMethods, type KeysWithPaths, type LayerFeature, type LayerLegend, type LoadingQueue, type LookupTableResource, type LunkwillData, type Method, type MethodAvailable, type MethodRequestOptions, type NgwConnectorOptions, type NgwDateFormat, type NgwDateTimeFormat, type NgwExceptions, type NgwExtent, type NgwFile, type NgwLayerIdentifyError, type NgwTimeFormat, type Params, type PatchRequestItemsResponseMap, type PatchRequestOptions, type Permission, type PostRequestItemsResponseMap, type PostRequestOptions, type PutRequestItemsResponseMap, type PutRequestOptions, type PyramidRoute, type PyramidSettings, type PyramidSettingsPyramid, type PyramidSettingsPyramidCompanyLogo, type RequestHeaders, type RequestItemAdditionalParams, type RequestItemKeys, type RequestItemsParams, type RequestItemsParamsMap, type RequestItemsResponseMap, type RequestMethod, type RequestMethods, type RequestOptions, type RequestOptionsBody, type RequestOptionsByMethod, type RequestOptionsJSON, type RequestTransformFunction, type Resmeta, type Resource, type ResourceCls, type ResourceDefinition, type ResourceHierarchy, type ResourceIdKeynameDef, type ResourceItem, type ResourceItemDatatype, type ResourceItemMain, type ResourceStoreItem, type ResourceStoreItemDefault, type ResourceStoreItemProperties, type ResponseType, type RouteBody, type RouteMethods, type RouteName, type RouteParameters, type RouteQuery, type RouteRequestOptions, type RouteResp, type RouteResults, type Router, type SrsItem, type ToReturn, type TreeGroup, type TreeItem, type TreeLayer, type UserInfo, type VectorFieldDatatype, type VectorLayer, type VectorLayerResourceItem, type WebmapResource, type WmsClientConnection, type WmsClientLayer, type WmsServerService, type WmsServerServiceLayer, NgwConnectorExtended as default };

package/lib/ngw-connector.cjs.js

@@ -1,4 +1,4 @@
-/** Bundle of @nextgis/ngw-connector; version: 3.0.0-alpha.13; author: NextGIS */
+/** Bundle of @nextgis/ngw-connector; version: 3.0.0-alpha.16; author: NextGIS */
 'use strict';
 
 var utils = require('@nextgis/utils');
@@ -70,7 +70,7 @@ async function apiRequest(opt) {
 
 var pkg = {
 	name: "@nextgis/ngw-connector",
-	version: "3.0.0-alpha.13",
+	version: "3.0.0-alpha.16",
 	_priority: 12,
 	description: "A lightweight HTTP client optimized for use with NextGIS Web API",
 	main: "index.js",
@@ -411,7 +411,7 @@ function generateUrl(path, query) {
   return path + urlParams;
 }
 async function request(path, options, cacheEngine) {
-  var _a;
+  var _a, _b;
   const defaults = {
     method: "GET",
     credentials: "same-origin",
@@ -431,6 +431,7 @@ async function request(path, options, cacheEngine) {
     ...defaults,
     ...options
   };
+  opt.method = (_a = opt.method) == null ? void 0 : _a.toUpperCase();
   if (withCredentials) {
     opt.credentials = "include";
   }
@@ -488,17 +489,26 @@ async function request(path, options, cacheEngine) {
     }
     return body;
   };
-  if (cacheEngine && cache !== false && ((_a = opt.method) == null ? void 0 : _a.toUpperCase()) === "GET") {
-    const props = cacheProps ? cacheProps : {
-      ...utils.objectRemoveEmpty({
-        withCredentials,
-        responseType
-      })
-    };
-    return cacheEngine.add(cacheName || url, makeRequest, {
-      props,
-      expirationTime: cache ? void 0 : 500
-    });
+  if (cacheEngine) {
+    if (((_b = opt.method) == null ? void 0 : _b.toUpperCase()) === "GET") {
+      if (cache !== false) {
+        const props = cacheProps ? cacheProps : {
+          ...utils.objectRemoveEmpty({
+            withCredentials,
+            responseType
+          })
+        };
+        return cacheEngine.add(cacheName || url, makeRequest, {
+          props,
+          expirationTime: cache ? void 0 : 500
+        });
+      }
+    } else {
+      const ignoredForClean = ["api/feature_layer/identify"];
+      if (ignoredForClean.every((part) => !path.includes(part))) {
+        cacheEngine.clean();
+      }
+    }
   }
   return makeRequest();
 }
@@ -744,12 +754,16 @@ class NgwConnector {
     __publicField$2(this, "user");
     __publicField$2(this, "cache");
     __publicField$2(this, "withCredentials");
+    // Dedicated cache for route requests, as these are executed before any other requests.
+    // This cache does not need to be cleared during the session.
+    __publicField$2(this, "routeCache");
     __publicField$2(this, "client", `NextGIS-NGW-Connector/${pkg.version}`);
     __publicField$2(this, "routeStr", "/api/component/pyramid/route");
     __publicField$2(this, "activeRequests", {});
     __publicField$2(this, "requestTransform");
     const exist = findConnector(options);
     this.cache = new Cache({ namespace: options.cacheId });
+    this.routeCache = new Cache({ namespace: "routecache" });
     if (exist) {
       return exist;
     } else {
@@ -809,19 +823,9 @@ class NgwConnector {
       }
     }
     const routeUrl = `${this.routeStr}?client=${this.client}`;
-    return this.makeQuery(
-      routeUrl,
-      {},
-      {
-        cacheName: "route",
-        signal,
-        cache: true,
-        cacheProps: {
-          id: this.id,
-          auth,
-          baseUrl: this.options.baseUrl
-        }
-      }
+    return this.routeCache.add(
+      this.options.baseUrl || String(this.id),
+      () => this.makeQuery(routeUrl, null, { signal, cache: false })
     );
   }
   /**
@@ -841,6 +845,7 @@ class NgwConnector {
     removeConnector(this);
     this.options.auth = void 0;
     this.user = void 0;
+    this.routeCache.clean();
     this.clearCache();
     this.emitter.emit("logout");
   }
@@ -945,7 +950,7 @@ class NgwConnector {
         this._cleanActiveRequest(id);
       }
     };
-    if (method === "GET") {
+    if (method === "GET" && cache !== false) {
       const cacheOptions = cacheProps ? cacheProps : {
         ...utils.objectRemoveEmpty({
           headers,