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

package/lib/index.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import Cache from '@nextgis/cache';
-import CancelablePromise from '@nextgis/cancelable-promise';
 import { FeatureProperties, DeepPartial } from '@nextgis/utils';
 import { GeoJsonObject, Geometry } from 'geojson';
 
@@ -800,7 +799,11 @@ interface RequestHeaders {
 }
 type RequestMethods = 'POST' | 'GET' | 'PATCH' | 'DELETE' | 'PUT';
 type NgwExceptions = 'nextgisweb.resource.exception.ResourceNotFound' | 'nextgisweb.core.exception.InsufficientPermissions';
-interface RequestOptions<M extends RequestMethods = RequestMethods, K extends keyof RequestItemsParamsMap = keyof RequestItemsParamsMap> {
+interface BaseRequestOptions {
+    cache?: boolean;
+    signal?: AbortSignal;
+}
+interface RequestOptions<M extends RequestMethods = RequestMethods, K extends keyof RequestItemsParamsMap = keyof RequestItemsParamsMap> extends BaseRequestOptions {
     data?: any;
     file?: File;
     method?: M;
@@ -811,6 +814,9 @@ interface RequestOptions<M extends RequestMethods = RequestMethods, K extends ke
     signal?: AbortSignal;
     params?: RequestItemsParams<K>;
     onProgress?: (percentComplete: number, event: ProgressEvent) => void;
+    cacheName?: string;
+    /** Use to override default cache props */
+    cacheProps?: Record<string, unknown>;
 }
 type RequestItemAdditionalParams = {
     [name: string]: any;
@@ -838,7 +844,7 @@ interface GetChildrenOfOptions extends Pick<RequestOptions, 'cache'> {
 }
 
 declare class ResourcesControl {
-    cache: Cache<CancelablePromise<ResourceItem | undefined>, {
+    cache: Cache<Promise<ResourceItem | undefined>, {
         id?: number | string;
     }>;
     connector: NgwConnector;
@@ -853,8 +859,8 @@ declare class ResourcesControl {
      * @remarks
      * Fetching resource would be cached to speed up next call
      */
-    getOne(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem | undefined>;
-    getOneOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem>;
+    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
@@ -865,7 +871,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'>): CancelablePromise<number | undefined>;
+    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
@@ -874,16 +880,16 @@ 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'>): CancelablePromise<number>;
-    getMany(resource: DeepPartial<Resource>, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem[]>;
-    getParent(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem | undefined>;
-    getChildrenOf(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): CancelablePromise<ResourceItem[]>;
-    update(resource: ResourceDefinition, data: DeepPartial<ResourceItem>): CancelablePromise<ResourceItem | undefined>;
+    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): CancelablePromise<void>;
+    delete(resource: ResourceDefinition): Promise<void>;
     private _getChildrenOf;
     private _cleanResourceItemCache;
     private _fetchResourceById;
@@ -955,17 +961,17 @@ declare class NgwConnector {
      *   .catch((er) => console.log('Connection problem', er));
      * ```
      */
-    connect(): CancelablePromise<PyramidRoute>;
+    connect(): Promise<PyramidRoute>;
     /**
      * Quick way to change NextGIS Web user.
      * @param credentials - New user credentials
      */
-    login(credentials: Credentials, options?: RequestOptions): CancelablePromise<UserInfo>;
+    login(credentials: Credentials, options?: RequestOptions): Promise<UserInfo>;
     /**
      * Disconnecting a user. Aborting all current requests
      */
     logout(): void;
-    getUserInfo(credentials?: Credentials, options?: RequestOptions): CancelablePromise<UserInfo>;
+    getUserInfo(credentials?: Credentials, options?: RequestOptions): Promise<UserInfo>;
     /**
      * Obtaining the required Headers for authentication of requests in the NGW.
      */
@@ -973,7 +979,9 @@ declare class NgwConnector {
     makeClientId(credentials?: Credentials): string | undefined;
     /** Stop all api requests */
     abort(): void;
-    getActiveApiRequests(): CancelablePromise<any>[];
+    getActiveApiRequests(): {
+        [x: number]: AbortController;
+    };
     /**
      * 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}
@@ -1003,7 +1011,7 @@ declare class NgwConnector {
      *
      * ```
      */
-    apiRequest<K extends keyof RequestItemsParamsMap, P extends RequestItemKeys = RequestItemKeys>(name: K, params_?: RequestItemsParams<K>, requestOptions?: RequestOptions): CancelablePromise<P[K]>;
+    apiRequest<K extends keyof RequestItemsParamsMap, P extends RequestItemKeys = RequestItemKeys>(name: K, params_?: RequestItemsParams<K>, requestOptions?: RequestOptions): Promise<P[K]>;
     /**
      * Shortcut method for send POST request to NGW.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
@@ -1017,93 +1025,93 @@ declare class NgwConnector {
      *   .catch((error) => console.warn(error));
      * ```
      */
-    post<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'POST', K>, params?: RequestItemsParams<K>): CancelablePromise<PostRequestItemsResponseMap[K]>;
+    post<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'POST', K>, params?: RequestItemsParams<K>): Promise<PostRequestItemsResponseMap[K]>;
     /**
      * Shortcut method for send GET request to NGW.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
      * @param options - Request options
      * @param params - Request item params or query params
      */
-    get<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'GET', K> | undefined | null, params?: RequestItemsParams<K>): CancelablePromise<GetRequestItemsResponseMap[K]>;
+    get<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'GET', K> | undefined | null, params?: RequestItemsParams<K>): Promise<GetRequestItemsResponseMap[K]>;
     /**
      * Shortcut method for send PATCH request to NGW.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
      * @param options - Request options
      * @param params - Request item params or query params
      */
-    patch<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'PATCH', K>, params?: RequestItemsParams<K>): CancelablePromise<PatchRequestItemsResponseMap[K]>;
+    patch<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'PATCH', K>, params?: RequestItemsParams<K>): Promise<PatchRequestItemsResponseMap[K]>;
     /**
      * Shortcut method for send PUT request to NGW.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
      * @param options - Request options
      * @param params - Request item params or query params
      */
-    put<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'PUT', K>, params?: RequestItemsParams<K>): CancelablePromise<PutRequestItemsResponseMap[K]>;
+    put<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'PUT', K>, params?: RequestItemsParams<K>): Promise<PutRequestItemsResponseMap[K]>;
     /**
      * Shortcut method for send DELETE request to NGW.
      * @param name - NGW route name from {@link https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource.html#routes | routes}
      * @param options - Request options
      * @param params - Request item params or query params
      */
-    delete<K extends keyof RequestItemsParamsMap>(name: K, options?: RequestOptions<'DELETE', K> | undefined | null, params?: RequestItemsParams<K>): CancelablePromise<DeleteRequestItemsResponseMap[K]>;
+    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): CancelablePromise<R>;
+    makeQuery<R = unknown>(url: string, params?: Params | null, options?: RequestOptions): Promise<R>;
     /**
      * {@link ResourcesControl.getOne}
      */
-    getResource(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem | undefined>;
+    getResource(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
     /**
      * {@link ResourcesControl.getOneOrFail}
      */
-    getResourceOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem>;
+    getResourceOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceBy(resource: DeepPartial<Resource>): CancelablePromise<ResourceItem | undefined>;
+    getResourceBy(resource: DeepPartial<Resource>): Promise<ResourceItem | undefined>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceByKeyname(keyname: string): CancelablePromise<ResourceItem | undefined>;
+    getResourceByKeyname(keyname: string): Promise<ResourceItem | undefined>;
     /**
      * @deprecated - use {@link getResource}
      */
-    getResourceById(id: number): CancelablePromise<ResourceItem | undefined>;
+    getResourceById(id: number): Promise<ResourceItem | undefined>;
     /**
      * {@link ResourcesControl.getId}
      */
-    getResourceId(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<number | undefined>;
+    getResourceId(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number | undefined>;
     /**
      * {@link ResourcesControl.getIdOrFail}
      */
-    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<number>;
+    getResourceIdOrFail(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<number>;
     /**
      * {@link ResourcesControl.getMany}
      */
-    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem[]>;
+    getResourcesBy(resource: DeepPartial<Resource>, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem[]>;
     /**
      * {@link ResourcesControl.getParent}
      */
-    getResourceParent(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): CancelablePromise<ResourceItem | undefined>;
+    getResourceParent(resource: ResourceDefinition, requestOptions?: RequestOptions<'GET'>): Promise<ResourceItem | undefined>;
     /**
      * {@link ResourcesControl.getChildrenOf}
      */
-    getResourceChildren(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): CancelablePromise<ResourceItem[]>;
+    getResourceChildren(resource: ResourceDefinition, requestOptions?: GetChildrenOfOptions): Promise<ResourceItem[]>;
     /**
      * {@link ResourcesControl.update}
      */
-    updateResource(resource: ResourceIdKeynameDef, data: DeepPartial<ResourceItem>): CancelablePromise<ResourceItem | undefined>;
+    updateResource(resource: ResourceIdKeynameDef, data: DeepPartial<ResourceItem>): Promise<ResourceItem | undefined>;
     /**
      * {@link ResourcesControl.delete}
      */
-    deleteResource(resource: ResourceIdKeynameDef): CancelablePromise<void>;
+    deleteResource(resource: ResourceIdKeynameDef): Promise<void>;
     private _login;
-    private _cleanActiveRequests;
+    private _cleanActiveRequest;
     private _handleHttpError;
 }
 
-export { 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 };
+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 };