@nextgis/ngw-connector 3.0.0-alpha.0 → 3.0.0-alpha.12

package/lib/index.d.ts

@@ -1,8 +1,121 @@
-/// <reference types="node" />
+import { Routes } from '@nextgisweb/pyramid/type/route';
 import { EventEmitter } from 'events';
 import Cache from '@nextgis/cache';
 import { FeatureProperties, DeepPartial } from '@nextgis/utils';
 import { GeoJsonObject, Geometry } from 'geojson';
+import { LegendSymbol } from '@nextgisweb/render/type/api';
+import { ResourceRead, CompositeRead } from '@nextgisweb/resource/type/api';
+
+declare class LunkwillParam {
+    static VALUES: (string | null)[];
+    private value;
+    constructor();
+    update(value: string | null, cond?: boolean): void;
+    suggest(cond?: boolean): void;
+    require(cond?: boolean): void;
+    toHeaders(headers: Record<string, string>): void;
+}
+
+type RouteParameters = {
+    [K in keyof Routes]: Routes[K]['pathArr'] | [Routes[K]['pathObj']];
+};
+type RouteName = keyof Routes;
+type GetRouteParam<R extends RouteName> = (RouteParameters[R] & [
+    object
+])[0];
+type RequestMethod = keyof RouteMethods<RouteName>;
+type Method = RequestMethod | Uppercase<RequestMethod>;
+type ResponseType = 'blob' | 'json';
+interface RouteRequestOptions<RT extends ResponseType = 'json', ReturnUrl extends boolean = false, Q = any, B = string | null | boolean | Record<string, any> | any[]> extends Omit<RequestInit, 'cache'> {
+    headers?: Record<string, string>;
+    cache?: boolean;
+    query?: Q;
+    json?: B;
+    /** Has lower priority than the json */
+    body?: string;
+    /**
+     * The type of data that the server will respond with.
+     * Can be either 'json' or 'blob'.
+     */
+    responseType?: RT;
+    /**
+     * @deprecated use {@link RequestInit.credential}
+     * Indicates whether to include credentials such as cookies, authentication headers,
+     * or TLS client certificates in cross-site Access-Control requests.
+     */
+    withCredentials?: boolean;
+    /**
+     * Name to use for caching the request.
+     */
+    cacheName?: string;
+    /**
+     * Properties to override default cache behavior.
+     */
+    cacheProps?: Record<string, unknown>;
+    lunkwill?: LunkwillParam;
+    lunkwillReturnUrl?: ReturnUrl;
+}
+interface GetRequestOptions<Q = any, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> extends Omit<RouteRequestOptions<RT, ReturnUrl, Q>, 'json' | 'body'> {
+    method?: 'GET';
+}
+interface RequestOptionsJSON<Q = any, B = string | null | boolean | Record<string, any> | any[], RT extends ResponseType = 'json', M extends Method = Method> extends Omit<RouteRequestOptions<RT, false, Q, B>, 'json' | 'body'> {
+    json: B;
+    method?: M;
+}
+interface RequestOptionsBody<Q = any, RT extends ResponseType = 'json', M extends Method = Method> extends Omit<RouteRequestOptions<RT, false, Q>, 'json' | 'body'> {
+    body: string;
+    method?: M;
+}
+type PutRequestOptions<Q = any, B = any, RT extends ResponseType = 'json'> = RequestOptionsJSON<Q, B, RT, 'PUT'> | RequestOptionsBody<Q, RT, 'PUT'>;
+type PostRequestOptions<Q = any, B = any, RT extends ResponseType = 'json'> = RequestOptionsJSON<Q, B, RT, 'POST'> | RequestOptionsBody<Q, RT, 'POST'>;
+type PatchRequestOptions<Q = any, B = any, RT extends ResponseType = 'json'> = RequestOptionsJSON<Q, B, RT, 'PATCH'> | RequestOptionsBody<Q, RT, 'PATCH'>;
+type DeleteRequestOptions<Q = any, RT extends ResponseType = 'json'> = RouteRequestOptions<RT, false, Q>;
+interface MethodRequestOptions<Q = any, B = any, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> {
+    get: GetRequestOptions<Q, RT, ReturnUrl>;
+    post: PostRequestOptions<Q, B, RT>;
+    put: PutRequestOptions<Q, B, RT>;
+    patch: PatchRequestOptions<Q, RT>;
+    delete: DeleteRequestOptions<Q, RT>;
+}
+type RequestOptionsByMethod<M extends RequestMethod, Q = any, B = any, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> = M extends keyof MethodRequestOptions ? MethodRequestOptions<Q, B, RT, ReturnUrl>[M] : never;
+type ApiRouteParams = Record<string, string>;
+interface LunkwillData {
+    status?: string;
+    delay_ms?: number;
+}
+type RouteResp<N extends RouteName, M extends RequestMethod> = N extends keyof Routes ? M extends keyof Routes[N] ? 'response' extends keyof Routes[N][M] ? Routes[N][M]['response'] : never : never : never;
+type RouteQuery<N extends RouteName, M extends RequestMethod> = N extends keyof Routes ? M extends keyof Routes[N] ? 'query' extends keyof Routes[N][M] ? Routes[N][M]['query'] : any : never : never;
+type RouteBody<N extends RouteName, M extends RequestMethod> = N extends keyof Routes ? M extends keyof Routes[N] ? 'body' extends keyof Routes[N][M] ? Routes[N][M]['body'] : any : never : never;
+type ToReturn<T = unknown, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> = ReturnUrl extends true ? string : RT extends 'blob' ? Blob : T;
+type HasRequiredKeys<T> = {
+    [P in keyof T]-?: object extends Pick<T, P> ? never : P;
+}[keyof T] extends never ? false : true;
+interface RouteMethods<N extends RouteName> {
+    url: HasRequiredKeys<RouteQuery<N, 'get'>> extends true ? (options: Pick<RequestOptionsByMethod<'get', RouteQuery<N, 'get'>>, 'query'>) => Promise<string> : (options?: Pick<RequestOptionsByMethod<'get', RouteQuery<N, 'get'>>, 'query'>) => Promise<string>;
+    get: HasRequiredKeys<RouteQuery<N, 'get'>> extends true ? <T = RouteResp<N, 'get'>, RT extends ResponseType = 'json', B extends boolean = false>(options: RequestOptionsByMethod<'get', RouteQuery<N, 'get'>, any, RT, B>) => Promise<ToReturn<T, RT, B>> : <T = RouteResp<N, 'get'>, B extends boolean = false, RT extends ResponseType = 'json'>(options?: RequestOptionsByMethod<'get', RouteQuery<N, 'get'>, any, RT, B>) => Promise<ToReturn<T, RT, B>>;
+    post: <T = RouteResp<N, 'post'>, RT extends ResponseType = 'json'>(options: RequestOptionsByMethod<'post', RouteQuery<N, 'post'>, RouteBody<N, 'post'>, RT>) => Promise<ToReturn<T, RT>>;
+    put: <T = RouteResp<N, 'put'>, RT extends ResponseType = 'json'>(options: RequestOptionsByMethod<'put', RouteQuery<N, 'put'>, RouteBody<N, 'put'>, RT>) => Promise<ToReturn<T, RT>>;
+    patch: <T = RouteResp<N, 'patch'>, RT extends ResponseType = 'json'>(options: RequestOptionsByMethod<'patch', RouteQuery<N, 'patch'>, RouteBody<N, 'patch'>, RT>) => Promise<ToReturn<T, RT>>;
+    delete: HasRequiredKeys<RouteQuery<N, 'delete'>> extends true ? <T = RouteResp<N, 'delete'>>(options: RequestOptionsByMethod<'delete', RouteQuery<N, 'delete'>>) => Promise<ToReturn<T>> : <T = RouteResp<N, 'delete'>>(options?: RequestOptionsByMethod<'delete', RouteQuery<N, 'delete'>>) => Promise<ToReturn<T>>;
+}
+type MethodAvailable<N extends RouteName, M extends RequestMethod> = M extends 'url' ? RouteMethods<N>['url'] : M extends keyof Routes[N] ? RouteMethods<N>[M] : never;
+type RouteResults<N extends RouteName> = {
+    [M in keyof RouteMethods<any>]: MethodAvailable<N, M>;
+};
+type KeysWithMethods<Methods extends RequestMethod[]> = {
+    [K in keyof Routes]: Methods extends (keyof Routes[K])[] ? K : never;
+}[keyof Routes];
+type PathKeys = any;
+type KeysWithPaths<P extends PathKeys> = {
+    [K in keyof Routes]: P extends Array<keyof Routes[K]['pathObj']> ? K : never;
+}[keyof Routes];
+type KeysWithMethodAndPath<M extends RequestMethod[], P extends PathKeys> = {
+    [K in keyof Routes]: K extends KeysWithMethods<M> ? K extends KeysWithPaths<P> ? K : never : never;
+}[keyof Routes];
+
+declare class AbortError extends Error {
+    constructor(message?: string);
+}
 
 interface NgwLayerIdentifyError {
     error: 'Not implemented';
@@ -476,30 +589,12 @@ interface Permission {
     permission: string;
     propagate: boolean;
 }
-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: {
         id: any;
     };
 }
-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;
@@ -515,16 +610,6 @@ interface NgwTimeFormat {
     second: number;
 }
 type NgwDateTimeFormat = NgwDateFormat & NgwTimeFormat;
-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;
     /**
@@ -532,16 +617,6 @@ interface BasemapResource {
      */
     qms: string;
 }
-interface BasemapWebmapItem {
-    resource_id: number;
-    display_name: string;
-    position?: number;
-    enabled?: boolean;
-    opacity?: number;
-}
-interface BasemapWebmap {
-    basemaps: BasemapWebmapItem[];
-}
 interface LookupTableResource {
     items: Record<string, string>;
 }
@@ -557,16 +632,7 @@ interface FeatureLayerField {
     label_field: boolean;
     typemod?: unknown;
 }
-interface FeatureResource {
-    fields: FeatureLayerField[];
-}
 type GeometryType = 'POINT' | 'LINESTRING' | 'POLYGON' | 'MULTIPOINT' | 'MULTILINESTRING' | 'MULTIPOLYGON' | 'POINTZ' | 'LINESTRINGZ' | 'POLYGONZ' | 'MULTIPOINTZ' | 'MULTILINESTRINGZ' | 'MULTIPOLYGONZ';
-interface VectorLayer {
-    srs: {
-        id: number;
-    };
-    geometry_type: GeometryType;
-}
 interface FileBucket {
     files: NgwFile[];
     tstamp?: any;
@@ -639,27 +705,6 @@ interface NgwFile {
 interface Resmeta {
     items: Record<string, any>;
 }
-interface ResourceItemMain {
-    resource: Resource;
-    resmeta: Resmeta;
-}
-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;
@@ -694,19 +739,11 @@ interface SrsItem {
     id: number;
     wkt: string;
 }
-interface Icon {
-    format: string;
-    data: string;
-}
-interface RenderLegendSymbol {
-    display_name: string;
-    icon: Icon;
-}
 interface FeatureLayerCount {
     total_count: number;
 }
 type ResourceIdKeynameDef = string | number;
-type ResourceDefinition = ResourceIdKeynameDef | DeepPartial<Resource>;
+type ResourceDefinition = ResourceIdKeynameDef | DeepPartial<ResourceRead>;
 interface FileUploadResp {
     upload_meta: FileMeta[];
 }
@@ -741,10 +778,10 @@ interface RequestItemsResponseMap {
 interface GetRequestItemsResponseMap extends RequestItemKeys {
     'pyramid.route': PyramidRoute;
     'pyramid.settings': PyramidSettings;
-    'resource.item': ResourceItem;
-    'resource.search': ResourceItem[];
+    'resource.item': CompositeRead;
+    'resource.search': CompositeRead[];
     'resource.child': any;
-    'resource.collection': ResourceItem[];
+    'resource.collection': CompositeRead[];
     'file_upload.upload': FileUploadResp;
     'layer.extent': NgwExtent;
     'feature_layer.feature.item': FeatureItem;
@@ -755,7 +792,7 @@ interface GetRequestItemsResponseMap extends RequestItemKeys {
     'feature_layer.feature.count': FeatureLayerCount;
     'pyramid.company_logo': string;
     'spatial_ref_sys.collection': SrsItem[];
-    'render.legend_symbols': RenderLegendSymbol[];
+    'render.legend_symbols': LegendSymbol[];
 }
 interface IdOnly {
     id: number;
@@ -778,16 +815,52 @@ interface PutRequestItemsResponseMap extends RequestItemKeys {
 interface DeleteRequestItemsResponseMap extends RequestItemKeys {
     'feature_layer.feature.item': any;
 }
+/**
+ * User credentials for authorization.
+ */
 interface Credentials {
+    /**
+     * The login username for the user.
+     */
     login: string;
+    /**
+     * The password for the user.
+     */
     password: string;
 }
 type RequestTransformFunction = (url: string, options: RequestOptions) => [url: string, options: RequestOptions];
 interface NgwConnectorOptions {
+    /**
+     * The base URL of the NextGIS Web (NGW) server.
+     * Example: "https://demo.nextgis.com"
+     */
     baseUrl?: string;
+    /**
+     * The API route path to use for requests.
+     * If not specified, the default route "/api/component/pyramid/route" will be used.
+     */
     route?: string;
+    /**
+     * User credentials for authorization in NGW.
+     * These credentials will be used for authentication in NGW requests.
+     */
     auth?: Credentials;
+    /**
+     * Indicates whether to include credentials such as cookies, authentication headers,
+     * or TLS client certificates in cross-site Access-Control requests.
+     * Setting this property ensures that cookies from another domain are used in the requests.
+     * Note that setting this property has no effect on same-origin requests.
+     */
+    withCredentials?: boolean;
+    /**
+     * A function to transform the request before sending it.
+     * This function can be used to modify the URL, headers, or other options.
+     */
     requestTransform?: RequestTransformFunction;
+    /**
+     * Identifier for caching requests.
+     * This can be used to segregate cached data for different connectors.
+     */
     cacheId?: string;
 }
 interface RequestHeaders {
@@ -803,19 +876,64 @@ interface BaseRequestOptions {
     cache?: boolean;
     signal?: AbortSignal;
 }
+/**
+ * Options for configuring requests to NGW.
+ */
 interface RequestOptions<M extends RequestMethods = RequestMethods, K extends keyof RequestItemsParamsMap = keyof RequestItemsParamsMap> extends BaseRequestOptions {
+    /**
+     * Data to be sent as the request body.
+     * Typically used with POST, PUT, or PATCH requests.
+     */
     data?: any;
+    /**
+     * File to be sent in the request.
+     */
     file?: File;
+    /**
+     * HTTP method to be used for the request.
+     * Example: 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'
+     */
     method?: M;
+    /**
+     * HTTP headers to be included in the request.
+     */
     headers?: RequestHeaders;
+    /**
+     * Indicates whether to include credentials such as cookies, authentication headers,
+     * or TLS client certificates in cross-site Access-Control requests.
+     */
     withCredentials?: boolean;
+    /**
+     * The type of data that the server will respond with.
+     * Can be either 'json' or 'blob'.
+     */
     responseType?: 'json' | 'blob';
+    /**
+     * Whether to cache the request.
+     * When set to true, the response will be stored in the cache.
+     */
     cache?: boolean;
+    /**
+     * Signal object that allows you to communicate with a DOM request (such as fetch) and abort it if desired via an AbortController.
+     */
     signal?: AbortSignal;
+    /**
+     * Parameters to be included in the request URL.
+     */
     params?: RequestItemsParams<K>;
+    /**
+     * A function to be called to monitor the progress of the request.
+     * @param percentComplete - The percentage of the request that has been completed.
+     * @param event - The progress event.
+     */
     onProgress?: (percentComplete: number, event: ProgressEvent) => void;
+    /**
+     * Name to use for caching the request.
+     */
     cacheName?: string;
-    /** Use to override default cache props */
+    /**
+     * Properties to override default cache behavior.
+     */
     cacheProps?: Record<string, unknown>;
 }
 type RequestItemAdditionalParams = {
@@ -843,60 +961,6 @@ interface GetChildrenOfOptions extends Pick<RequestOptions, 'cache'> {
     recursive?: boolean;
 }
 
-declare class ResourcesControl {
-    cache: Cache<Promise<ResourceItem | undefined>, {
-        id?: number | string;
-    }>;
-    connector: NgwConnector;
-    constructor({ connector, cacheId, }: {
-        connector: NgwConnector;
-        cacheId?: string;
-    });
-    /**
-     * Receive resource from NGW by id, keyname or search-object parameter.
-     * @param resource - Resource id, keyname or search-object
-     *
-     * @remarks
-     * Fetching resource would be cached to speed up next call
-     */
-    getOne(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
-    getOneOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem>;
-    /**
-     * A fast way to retrieve resource ID for any resource definition.
-     * @param resource - Any available resource definition
-     *
-     * @remarks
-     * There are situations when exactly the resource id is needed
-     * (for example, to compose the correct request to the api)
-     * then this method will come in handy to facilitate the extraction of the identifier
-     * if the resource is specified through a keyname or other parameters.
-     */
-    getId(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number | undefined>;
-    /**
-     * A fast way to retrieve resource ID for any resource definition.
-     * @param resource - Any available resource definition
-     *
-     * @remarks
-     * Similar with {@link NgwConnector.getResourceId | getResourceId} but rise error if resource is not exist.
-     * To not make one more checks if the resource is definitely exists
-     */
-    getIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number>;
-    getMany(resource: DeepPartial<Resource>, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem[]>;
-    getParent(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
-    getChildrenOf(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): Promise<ResourceItem[]>;
-    update(resource: ResourceDefinition, data: DeepPartial<ResourceItem>): Promise<ResourceItem | undefined>;
-    /**
-     * Fast way to delete resource from NGW and clean cache.
-     * @param resource - Resource definition
-     */
-    delete(resource: ResourceDefinition): Promise<void>;
-    private _getChildrenOf;
-    private _cleanResourceItemCache;
-    private _fetchResourceById;
-    private _fetchResourceBy;
-    private _resourceCacheFilter;
-}
-
 /**
  * Thrown when...
  */
@@ -912,6 +976,33 @@ declare class NgwError extends Error {
     constructor(er?: Partial<NgwError>);
 }
 
+/**
+ * Thrown when ...
+ */
+declare class InsufficientPermissionsError extends NgwError {
+    name: string;
+    exception: NgwExceptions;
+    constructor(obj: InsufficientPermissionsError);
+}
+
+/**
+ * Thrown when...
+ */
+declare class NetworkError extends Error {
+    name: string;
+    constructor(url: string);
+}
+
+/**
+ * Thrown when ...
+ */
+declare class NetworksResponseError extends NgwError {
+    message: string;
+    title: string;
+    detail: string;
+    constructor(obj?: Partial<NetworksResponseError>);
+}
+
 /**
  * Thrown when ...
  */
@@ -921,22 +1012,51 @@ declare class ResourceNotFoundError extends NgwError {
     constructor(obj?: ResourceNotFoundError);
 }
 
+declare function isError(error: unknown): error is Error;
+
+declare function extractError(error: unknown): NetworksResponseError | {
+    title: any;
+    message: any;
+    detail: any;
+    data: any;
+} | {
+    title: string;
+    message: string;
+    detail?: undefined;
+    data?: undefined;
+} | undefined;
+
+type errors_AbortError = AbortError;
+declare const errors_AbortError: typeof AbortError;
+type errors_InsufficientPermissionsError = InsufficientPermissionsError;
+declare const errors_InsufficientPermissionsError: typeof InsufficientPermissionsError;
+type errors_NetworkError = NetworkError;
+declare const errors_NetworkError: typeof NetworkError;
+type errors_NetworksResponseError = NetworksResponseError;
+declare const errors_NetworksResponseError: typeof NetworksResponseError;
+type errors_NgwError = NgwError;
+declare const errors_NgwError: typeof NgwError;
+type errors_ResourceNotFoundError = ResourceNotFoundError;
+declare const errors_ResourceNotFoundError: typeof ResourceNotFoundError;
+declare const errors_extractError: typeof extractError;
+declare const errors_isError: typeof isError;
+declare namespace errors {
+  export { errors_AbortError as AbortError, errors_InsufficientPermissionsError as InsufficientPermissionsError, errors_NetworkError as NetworkError, errors_NetworksResponseError as NetworksResponseError, errors_NgwError as NgwError, errors_ResourceNotFoundError as ResourceNotFoundError, errors_extractError as extractError, errors_isError as isError };
+}
+
 declare class NgwConnector {
     options: NgwConnectorOptions;
-    static errors: {
-        NgwError: typeof NgwError;
-        ResourceNotFoundError: typeof ResourceNotFoundError;
-    };
+    static errors: typeof errors;
     id: number;
     emitter: EventEmitter<[never]>;
     user?: UserInfo;
-    resources: ResourcesControl;
     cache: Cache;
+    withCredentials?: boolean;
+    private client;
     private routeStr;
     private activeRequests;
     private requestTransform?;
     constructor(options: NgwConnectorOptions);
-    static create(options: NgwConnectorOptions): NgwConnector;
     /**
      * Clear the cache.
      */
@@ -955,7 +1075,7 @@ declare class NgwConnector {
      * Can be used to check connection.
      * @example
      * ```javascript
-     * const connector = new NgwConnector({baseUrl: 'https://demo.nextgis.com'});
+     * const connector = new NgwConnector({ baseUrl: 'https://demo.nextgis.com' });
      * connector.connect()
      *   .then(() => console.log('Ok'))
      *   .catch((er) => console.log('Connection problem', er));
@@ -975,13 +1095,89 @@ declare class NgwConnector {
     /**
      * Obtaining the required Headers for authentication of requests in the NGW.
      */
-    getAuthorizationHeaders(credentials?: Credentials): RequestHeaders | undefined;
+    getAuthorizationHeaders(credentials?: Credentials): RequestHeaders;
     makeClientId(credentials?: Credentials): string | undefined;
     /** Stop all api requests */
     abort(): void;
     getActiveApiRequests(): {
         [x: number]: AbortController;
     };
+    route<N extends RouteName>(name: N, ...rest: RouteParameters[N]): RouteResults<N>;
+    /**
+     * Send request to NGW.
+     * @param url - URL address to NGW
+     * @param params - Query params
+     * @param options - Request options
+     */
+    makeQuery<R = unknown>(url: string, params?: Params | null, options?: RequestOptions): Promise<R>;
+    protected _loadData<R = unknown>(url: string, options: RequestOptions): Promise<R>;
+    private _login;
+    private _cleanActiveRequest;
+    private _handleHttpError;
+}
+
+declare class ResourcesControl {
+    cache: Cache<Promise<CompositeRead | undefined>, {
+        id?: number | string;
+    }>;
+    connector: NgwConnectorExtended;
+    constructor({ connector, cacheId, }: {
+        connector: NgwConnectorExtended;
+        cacheId?: string;
+    });
+    /**
+     * Receive resource from NGW by id, keyname or search-object parameter.
+     * @param resource - Resource id, keyname or search-object
+     *
+     * @remarks
+     * Fetching resource would be cached to speed up next call
+     */
+    getOne(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead | undefined>;
+    getOneOrFail(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead>;
+    /**
+     * A fast way to retrieve resource ID for any resource definition.
+     * @param resource - Any available resource definition
+     *
+     * @remarks
+     * There are situations when exactly the resource id is needed
+     * (for example, to compose the correct request to the api)
+     * then this method will come in handy to facilitate the extraction of the identifier
+     * if the resource is specified through a keyname or other parameters.
+     */
+    getId(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<number | undefined>;
+    /**
+     * A fast way to retrieve resource ID for any resource definition.
+     * @param resource - Any available resource definition
+     *
+     * @remarks
+     * Similar with {@link NgwConnector.getResourceId | getResourceId} but rise error if resource is not exist.
+     * To not make one more checks if the resource is definitely exists
+     */
+    getIdOrFail(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<number>;
+    getMany(resource: DeepPartial<ResourceRead>, requestOptions?: GetRequestOptions): Promise<CompositeRead[]>;
+    getParent(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead | undefined>;
+    getChildrenOf(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): Promise<CompositeRead[]>;
+    update(resource: ResourceDefinition, data: DeepPartial<CompositeRead>): Promise<CompositeRead | undefined>;
+    /**
+     * Fast way to delete resource from NGW and clean cache.
+     * @param resource - Resource definition
+     */
+    delete(resource: ResourceDefinition): Promise<void>;
+    private _getChildrenOf;
+    private _cleanResourceItemCache;
+    private _fetchResourceById;
+    private _fetchResourceBy;
+    private _resourceCacheFilter;
+}
+
+declare class NgwConnectorExtended extends NgwConnector {
+    resources: ResourcesControl;
+    constructor(options: NgwConnectorOptions);
+    static create(options: NgwConnectorOptions): NgwConnectorExtended;
+    /**
+     * Clear the cache.
+     */
+    clearCache(): void;
     /**
      * Send request to NGW api router.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
@@ -1054,64 +1250,63 @@ declare class NgwConnector {
      * @param params - Request item params or query params
      */
     delete<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'DELETE', K> | undefined | null, params?: RequestItemsParams<K>): Promise<DeleteRequestItemsResponseMap[K]>;
-    /**
-     * Send request to NGW.
-     * @param url - URL address to NGW
-     * @param params - Query params
-     * @param options - Request options
-     */
-    makeQuery<R = unknown>(url: string, params?: Params | null, options?: RequestOptions): Promise<R>;
     /**
      * {@link ResourcesControl.getOne}
      */
-    getResource(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
+    getResource(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead | undefined>;
     /**
      * {@link ResourcesControl.getOneOrFail}
      */
-    getResourceOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem>;
+    getResourceOrFail(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceBy(resource: DeepPartial<Resource>): Promise<ResourceItem | undefined>;
+    getResourceBy(resource: DeepPartial<ResourceRead>): Promise<CompositeRead | undefined>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceByKeyname(keyname: string): Promise<ResourceItem | undefined>;
+    getResourceByKeyname(keyname: string): Promise<CompositeRead | undefined>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceById(id: number): Promise<ResourceItem | undefined>;
+    getResourceById(id: number): Promise<CompositeRead | undefined>;
     /**
      * {@link ResourcesControl.getId}
      */
-    getResourceId(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number | undefined>;
+    getResourceId(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<number | undefined>;
     /**
      * {@link ResourcesControl.getIdOrFail}
      */
-    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number>;
+    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<number>;
     /**
      * {@link ResourcesControl.getMany}
      */
-    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem[]>;
+    getResourcesBy(resource: DeepPartial<ResourceRead>, requestOptions?: GetRequestOptions): Promise<CompositeRead[]>;
     /**
      * {@link ResourcesControl.getParent}
      */
-    getResourceParent(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
+    getResourceParent(resource: ResourceDefinition, requestOptions?: GetRequestOptions): Promise<CompositeRead | undefined>;
     /**
      * {@link ResourcesControl.getChildrenOf}
      */
-    getResourceChildren(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): Promise<ResourceItem[]>;
+    getResourceChildren(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): Promise<CompositeRead[]>;
     /**
      * {@link ResourcesControl.update}
      */
-    updateResource(resource: ResourceIdKeynameDef, data: DeepPartial<ResourceItem>): Promise<ResourceItem | undefined>;
+    updateResource(resource: ResourceIdKeynameDef, data: DeepPartial<CompositeRead>): Promise<CompositeRead | undefined>;
     /**
      * {@link ResourcesControl.delete}
      */
     deleteResource(resource: ResourceIdKeynameDef): Promise<void>;
-    private _login;
-    private _cleanActiveRequest;
-    private _handleHttpError;
 }
 
-export { type BaseRequestOptions, type BasemapResource, type BasemapWebmap, type BasemapWebmapItem, type BookmarkProperties, type CreatedResource, type Credentials, type DeleteRequestItemsResponseMap, 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 IdOnly, type LayerFeature, type LoadingQueue, type LookupTableResource, type NgwConnectorOptions, type NgwDateFormat, type NgwDateTimeFormat, type NgwExceptions, type NgwExtent, type NgwFile, type NgwLayerIdentifyError, type NgwTimeFormat, type Params, type PatchRequestItemsResponseMap, type Permission, type PostRequestItemsResponseMap, type PutRequestItemsResponseMap, type PyramidRoute, type PyramidSettings, type PyramidSettingsPyramid, type PyramidSettingsPyramidCompanyLogo, type RenderLegendSymbol, type RequestHeaders, type RequestItemAdditionalParams, type RequestItemKeys, type RequestItemsParams, type RequestItemsParamsMap, type RequestItemsResponseMap, type RequestMethods, type RequestOptions, 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 Router, type SrsItem, type TreeGroup, type TreeItem, type TreeLayer, type UserInfo, type VectorFieldDatatype, type VectorLayer, type VectorLayerResourceItem, type WebmapResource, type WmsClientConnection, type WmsClientLayer, type WmsServerService, type WmsServerServiceLayer, NgwConnector as default };
+/**
+ * Represents a legend for a specific layer.
+ */
+interface LayerLegend {
+    layerId: string;
+    legend: LegendSymbol[];
+    setSymbolRender?: (symbolIndex: number, status: boolean) => void;
+}
+
+export { type ApiRouteParams, type BaseRequestOptions, type BasemapResource, 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 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 ResourceDefinition, type ResourceHierarchy, type ResourceIdKeynameDef, 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 WmsClientConnection, type WmsClientLayer, type WmsServerService, type WmsServerServiceLayer, NgwConnectorExtended as default };