@nextgis/ngw-connector 3.0.0-alpha.8 → 3.0.0

package/lib/index.d.ts

@@ -1,8 +1,11 @@
 import { Routes } from '@nextgisweb/pyramid/type/route';
-import { EventEmitter } from 'events';
+import { CompositeRead, ResourceRead } from '@nextgisweb/resource/type/api';
 import Cache from '@nextgis/cache';
+import { EventEmitter } from 'events';
 import { FeatureProperties, DeepPartial } from '@nextgis/utils';
+import { LegendSymbol } from '@nextgisweb/render/type/api';
 import { GeoJsonObject, Geometry } from 'geojson';
+import { LegendSymbolsEnum } from '@nextgisweb/webmap/type/api';
 
 declare class LunkwillParam {
     static VALUES: (string | null)[];
@@ -18,10 +21,14 @@ 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 CompositeFor<K extends keyof CompositeRead> = CompositeRead & Required<Pick<CompositeRead, K>>;
 type ResponseType = 'blob' | 'json';
-interface RequestOptions$1<RT extends ResponseType = 'json', ReturnUrl extends boolean = false, Q = any, B = string | null | boolean | Record<string, any> | any[]> extends Omit<RequestInit, 'cache'> {
+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;
@@ -50,29 +57,34 @@ interface RequestOptions$1<RT extends ResponseType = 'json', ReturnUrl extends b
     lunkwill?: LunkwillParam;
     lunkwillReturnUrl?: ReturnUrl;
 }
-interface GetRequestOptions<Q = any, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> extends Omit<RequestOptions$1<RT, ReturnUrl, Q>, 'json' | 'body'> {
+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<RequestOptions$1<RT, false, Q, B>, 'json' | 'body'> {
+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<RequestOptions$1<RT, false, Q>, 'json' | 'body'> {
+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'> = RequestOptions$1<RT, false, Q>;
-interface RouteRequestOptions<Q = any, B = any, RT extends ResponseType = 'json', ReturnUrl extends boolean = false> {
+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 RouteRequestOptions ? RouteRequestOptions<Q, B, RT, ReturnUrl>[M] : never;
+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;
@@ -92,6 +104,20 @@ type MethodAvailable<N extends RouteName, M extends RequestMethod> = M extends '
 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';
@@ -132,50 +158,6 @@ interface FeatureItem<F = FeatureProperties, G extends Geometry | string = Geome
 }
 type FeatureItemToNgw<F = FeatureProperties, G extends Geometry | string = Geometry> = FeatureItem<F, G>;
 
-/**
- * Represents an item in a legend, with additional rendering and indexing information.
- */
-interface LegendItem {
-    /**
-     * The index of the legend item.
-     */
-    index: number;
-    /**
-     * A flag indicating whether this legend item should be rendered.
-     */
-    render: boolean | null;
-    /**
-     * The display name of the legend item.
-     */
-    display_name: string;
-    /**
-     * The symbol associated with this legend item.
-     */
-    icon: LegendItemSymbol;
-}
-/**
- * Represents a symbol in a legend item.
- */
-interface LegendItemSymbol {
-    /**
-     * The format of the symbol, e.g., 'svg', 'png'.
-     */
-    format: string;
-    /**
-     * The actual data of the symbol in a specified format.
-     * This could be a base64 encoded string, SVG path, etc.
-     */
-    data: string;
-}
-/**
- * Represents a legend for a specific layer.
- */
-interface LayerLegend {
-    layerId: string;
-    legend: LegendItem[];
-    setSymbolRender?: (symbolIndex: number, status: boolean) => void;
-}
-
 interface RequestItemsParamsMap {
     'pyramid.static': {
         skey: number;
@@ -609,6 +591,7 @@ interface Permission {
     permission: string;
     propagate: boolean;
 }
+/** @deprecated use  ResourceCls from '@nextgisweb/resource/type/api' instead */
 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;
@@ -616,6 +599,7 @@ interface ResourceHierarchy {
         id: any;
     };
 }
+/** @deprecated use  ResourceRead from '@nextgisweb/resource/type/api' instead */
 interface Resource {
     cls: ResourceCls;
     id: number;
@@ -648,6 +632,7 @@ interface NgwTimeFormat {
     second: number;
 }
 type NgwDateTimeFormat = NgwDateFormat & NgwTimeFormat;
+/** @deprecated use  WebMapRead from '@nextgisweb/resource/type/api' instead */
 interface WebmapResource {
     extent_left: number;
     extent_right: number;
@@ -665,6 +650,7 @@ interface BasemapResource {
      */
     qms: string;
 }
+/** @deprecated use  BasemapWebMapItemRead from '@nextgisweb/resource/type/api' instead */
 interface BasemapWebmapItem {
     resource_id: number;
     display_name: string;
@@ -672,6 +658,7 @@ interface BasemapWebmapItem {
     enabled?: boolean;
     opacity?: number;
 }
+/** @deprecated use  BasemapWebMapRead from '@nextgisweb/resource/type/api' instead */
 interface BasemapWebmap {
     basemaps: BasemapWebmapItem[];
 }
@@ -690,10 +677,12 @@ interface FeatureLayerField {
     label_field: boolean;
     typemod?: unknown;
 }
+/** @deprecated use  FeatureLayerRead from '@nextgisweb/resource/type/api' instead */
 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 */
 interface VectorLayer {
     srs: {
         id: number;
@@ -776,6 +765,7 @@ interface ResourceItemMain {
     resource: Resource;
     resmeta: Resmeta;
 }
+/** @deprecated use  CompositeRead from '@nextgisweb/resource/type/api' instead */
 interface ResourceItem extends ResourceItemMain {
     [cls: string]: any;
     webmap?: WebmapResource;
@@ -831,7 +821,7 @@ interface FeatureLayerCount {
     total_count: number;
 }
 type ResourceIdKeynameDef = string | number;
-type ResourceDefinition = ResourceIdKeynameDef | DeepPartial<Resource>;
+type ResourceDefinition = ResourceIdKeynameDef | DeepPartial<ResourceRead>;
 interface FileUploadResp {
     upload_meta: FileMeta[];
 }
@@ -866,10 +856,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;
@@ -880,7 +870,7 @@ interface GetRequestItemsResponseMap extends RequestItemKeys {
     'feature_layer.feature.count': FeatureLayerCount;
     'pyramid.company_logo': string;
     'spatial_ref_sys.collection': SrsItem[];
-    'render.legend_symbols': LegendItem[];
+    'render.legend_symbols': LegendSymbol[];
 }
 interface IdOnly {
     id: number;
@@ -962,7 +952,7 @@ type RequestMethods = 'POST' | 'GET' | 'PATCH' | 'DELETE' | 'PUT';
 type NgwExceptions = 'nextgisweb.resource.exception.ResourceNotFound' | 'nextgisweb.core.exception.InsufficientPermissions';
 interface BaseRequestOptions {
     cache?: boolean;
-    signal?: AbortSignal;
+    signal?: AbortSignal | null;
 }
 /**
  * Options for configuring requests to NGW.
@@ -1004,7 +994,7 @@ interface RequestOptions<M extends RequestMethods = RequestMethods, K extends ke
     /**
      * Signal object that allows you to communicate with a DOM request (such as fetch) and abort it if desired via an AbortController.
      */
-    signal?: AbortSignal;
+    signal?: AbortSignal | null;
     /**
      * Parameters to be included in the request URL.
      */
@@ -1064,6 +1054,47 @@ declare class NgwError extends Error {
     constructor(er?: Partial<NgwError>);
 }
 
+/**
+ * Thrown when ...
+ */
+declare class NetworksResponseError extends NgwError {
+    message: string;
+    title: string;
+    detail: string;
+    constructor(obj?: Partial<NetworksResponseError>);
+}
+
+declare function extractError(error: unknown): NetworksResponseError | {
+    title: any;
+    message: any;
+    detail: any;
+    data: any;
+} | {
+    title: string;
+    message: string;
+    detail?: undefined;
+    data?: undefined;
+} | undefined;
+
+/**
+ * Thrown when ...
+ */
+declare class InsufficientPermissionsError extends NgwError {
+    name: string;
+    exception: NgwExceptions;
+    constructor(obj: InsufficientPermissionsError);
+}
+
+declare function isError(error: unknown): error is Error;
+
+/**
+ * Thrown when...
+ */
+declare class NetworkError extends Error {
+    name: string;
+    constructor(url: string);
+}
+
 /**
  * Thrown when ...
  */
@@ -1073,17 +1104,42 @@ declare class ResourceNotFoundError extends NgwError {
     constructor(obj?: ResourceNotFoundError);
 }
 
+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;
     cache: Cache;
     withCredentials?: boolean;
+    private readonly routeCache;
     private client;
     private routeStr;
     private activeRequests;
@@ -1113,7 +1169,7 @@ declare class NgwConnector {
      *   .catch((er) => console.log('Connection problem', er));
      * ```
      */
-    connect(): Promise<PyramidRoute>;
+    connect({ signal, }?: Pick<RequestOptions, 'signal'>): Promise<PyramidRoute>;
     /**
      * Quick way to change NextGIS Web user.
      * @param credentials - New user credentials
@@ -1132,7 +1188,7 @@ declare class NgwConnector {
     /** Stop all api requests */
     abort(): void;
     getActiveApiRequests(): {
-        [x: number]: AbortController;
+        [requestId: number]: AbortController;
     };
     route<N extends RouteName>(name: N, ...rest: RouteParameters[N]): RouteResults<N>;
     /**
@@ -1149,7 +1205,7 @@ declare class NgwConnector {
 }
 
 declare class ResourcesControl {
-    cache: Cache<Promise<ResourceItem | undefined>, {
+    cache: Cache<Promise<CompositeRead | undefined>, {
         id?: number | string;
     }>;
     connector: NgwConnectorExtended;
@@ -1164,8 +1220,8 @@ declare class ResourcesControl {
      * @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>;
+    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
@@ -1176,7 +1232,7 @@ declare class ResourcesControl {
      * 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>;
+    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
@@ -1185,11 +1241,11 @@ declare class ResourcesControl {
      * 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>;
+    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
@@ -1285,51 +1341,63 @@ declare class NgwConnectorExtended extends NgwConnector {
     /**
      * {@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>;
 }
 
-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 LayerLegend, type LegendItem, type LegendItemSymbol, 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 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, NgwConnectorExtended as default };
+/**
+ * Represents a legend for a specific layer.
+ */
+interface LayerLegend {
+    layerId: string;
+    legend?: LegendSymbol[];
+    resourceId: number;
+    setSymbolRender?: (symbolIndex: number, status: boolean) => void;
+    legendSymbols?: LegendSymbolsEnum;
+}
+
+export { NgwConnectorExtended as default };
+export type { ApiRouteParams, BaseRequestOptions, BasemapResource, BasemapWebmap, BasemapWebmapItem, BookmarkProperties, CompositeFor, CreatedResource, Credentials, DeleteRequestItemsResponseMap, DeleteRequestOptions, FeatureItem, FeatureItemAttachment, FeatureItemExtensions, FeatureItemToNgw, FeatureLayerCount, FeatureLayerField, FeatureLayersIdentify, FeatureLayersIdentifyItems, FeatureResource, FileBucket, FileMeta, FileUploadResp, GeometryType, GetChildrenOfOptions, GetRequestItemsResponseMap, GetRequestOptions, GetRouteParam, IdOnly, KeysWithMethodAndPath, KeysWithMethods, KeysWithPaths, LayerFeature, LayerLegend, LoadingQueue, LookupTableResource, LunkwillData, Method, MethodAvailable, MethodRequestOptions, NgwConnectorOptions, NgwDateFormat, NgwDateTimeFormat, NgwExceptions, NgwExtent, NgwFile, NgwLayerIdentifyError, NgwTimeFormat, Params, PatchRequestItemsResponseMap, PatchRequestOptions, Permission, PostRequestItemsResponseMap, PostRequestOptions, PutRequestItemsResponseMap, PutRequestOptions, PyramidRoute, PyramidSettings, PyramidSettingsPyramid, PyramidSettingsPyramidCompanyLogo, RequestHeaders, RequestItemAdditionalParams, RequestItemKeys, RequestItemsParams, RequestItemsParamsMap, RequestItemsResponseMap, RequestMethod, RequestMethods, RequestOptions, RequestOptionsBody, RequestOptionsByMethod, RequestOptionsJSON, RequestTransformFunction, Resmeta, Resource, ResourceCls, ResourceDefinition, ResourceHierarchy, ResourceIdKeynameDef, ResourceItem, ResourceItemDatatype, ResourceItemMain, ResourceStoreItem, ResourceStoreItemDefault, ResourceStoreItemProperties, ResponseType, RouteBody, RouteMethods, RouteName, RouteParameters, RouteQuery, RouteRequestOptions, RouteResp, RouteResults, Router, SrsItem, ToReturn, TreeGroup, TreeItem, TreeLayer, UserInfo, VectorFieldDatatype, VectorLayer, VectorLayerResourceItem, WebmapResource, WmsClientConnection, WmsClientLayer, WmsServerService, WmsServerServiceLayer };