@nextgis/ngw-connector 3.0.0-alpha.4 → 3.0.0-alpha.6

package/lib/index.d.ts

@@ -1,8 +1,98 @@
+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';
 
+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 RequestMethod = keyof RouteMethods<RouteName>;
+type Method = RequestMethod | Uppercase<RequestMethod>;
+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'> {
+    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<RequestOptions$1<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'> {
+    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'> {
+    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> {
+    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 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>;
+};
+
 interface NgwLayerIdentifyError {
     error: 'Not implemented';
 }
@@ -958,60 +1048,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...
  */
@@ -1045,7 +1081,6 @@ declare class NgwConnector {
     id: number;
     emitter: EventEmitter<[never]>;
     user?: UserInfo;
-    resources: ResourcesControl;
     cache: Cache;
     withCredentials?: boolean;
     private client;
@@ -1072,7 +1107,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));
@@ -1092,13 +1127,88 @@ 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<ResourceItem | 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?: 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;
+}
+
+declare class NgwConnectorExtended extends NgwConnector {
+    resources: ResourcesControl;
+    constructor(options: NgwConnectorOptions);
+    /**
+     * 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}
@@ -1171,13 +1281,6 @@ 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}
      */
@@ -1226,9 +1329,6 @@ declare class NgwConnector {
      * {@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 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, 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 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 };