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

package/README.md

@@ -46,6 +46,38 @@ We recommend linking to a specific version number `/ngw-connector@[version]`
 npm install @nextgis/ngw-connector
 ```
 
+## TypeScript Support
+
+If you plan to use this library in a TypeScript project, it's recommended to install TypeScript declaration files for NextGIS Web by using the `@nextgis/ngw-types-loader` tool.
+
+### Installing NGW Types
+
+Run the following command to download the latest TypeScript declaration files:
+
+```bash
+npx @nextgis/ngw-types-loader
+```
+
+This will download the declaration file from the default NextGIS Web instance (`https://demo.nextgis.com`) and update your `tsconfig.json` to include it.
+
+If you are using a custom NextGIS Web deployment, you can specify the URL:
+
+```bash
+npx @nextgis/ngw-types-loader https://your-custom-ngw-url.com
+```
+
+After running the tool, ensure that your `tsconfig.json` includes the downloaded file:
+
+```json
+{
+  "include": [
+    "./nextgisweb.d.ts"
+  ]
+}
+```
+
+For more details, refer to the [NGW Types Loader](https://www.npmjs.com/package/@nextgis/ngw-types-loader).
+
 ## Usage
 
 ```javascript
@@ -56,22 +88,25 @@ const ngwConnector = new NgwConnector({
   // auth: {login, password}
 });
 
-ngwConnector.get('resource.item', null, { id: 485 }).then((data) => {
-  console.log(data);
-});
+ngwConnector
+  .route('resource.item', { id: 485 })
+  .get()
+  .then((data) => {
+    console.log(data);
+  });
 
-ngwConnector.post('resource.collection', { data: [RESOURCE JSON] });
-ngwConnector.patch(
-  'feature_layer.feature.collection',
-  { data: [ITEMS JSON] },
-  {
-    id,
+ngwConnector.route('resource.collection').patch({ json: RESOURCE });
+ngwConnector.route('feature_layer.feature.collection', { id }).patch({
+  json: ITEMS,
+  query: {
     srs: 4326,
     geom_format: 'geojson',
-  }
-);
-ngwConnector.put('feature_layer.feature.item', { data: [ITEM JSON] }, { id, fid })
-ngwConnector.delete('feature_layer.feature.item', null, { id, fid })
+  },
+});
+ngwConnector
+  .route('feature_layer.feature.item', { id, fid })
+  .put({ json: ITEM });
+ngwConnector.route('feature_layer.feature.item', { id, fid }).delete();
 
 // Shortcuts methods to find resources
 ngwConnector.getResource(2011); // by id

package/lib/index.d.ts

@@ -1,10 +1,10 @@
 import { Routes } from '@nextgisweb/pyramid/type/route';
-import { EventEmitter } from 'events';
 import Cache from '@nextgis/cache';
+import { EventEmitter } from 'events';
 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';
+import { GeoJsonObject, Geometry } from 'geojson';
 
 declare class LunkwillParam {
     static VALUES: (string | null)[];
@@ -589,12 +589,32 @@ 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;
     parent: {
         id: any;
     };
 }
+/** @deprecated use  ResourceRead from '@nextgisweb/resource/type/api' instead */
+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;
@@ -610,6 +630,17 @@ 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;
+    extent_bottom: number;
+    extent_top: number;
+    extent_constrained: boolean;
+    draw_order_enabled: boolean;
+    bookmark_resource: ResourceHierarchy;
+    root_item: TreeGroup;
+}
 interface BasemapResource {
     url: string;
     /**
@@ -617,6 +648,18 @@ interface BasemapResource {
      */
     qms: string;
 }
+/** @deprecated use  BasemapWebMapItemRead from '@nextgisweb/resource/type/api' instead */
+interface BasemapWebmapItem {
+    resource_id: number;
+    display_name: string;
+    position?: number;
+    enabled?: boolean;
+    opacity?: number;
+}
+/** @deprecated use  BasemapWebMapRead from '@nextgisweb/resource/type/api' instead */
+interface BasemapWebmap {
+    basemaps: BasemapWebmapItem[];
+}
 interface LookupTableResource {
     items: Record<string, string>;
 }
@@ -632,7 +675,18 @@ 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;
+    };
+    geometry_type: GeometryType;
+}
 interface FileBucket {
     files: NgwFile[];
     tstamp?: any;
@@ -705,6 +759,28 @@ interface NgwFile {
 interface Resmeta {
     items: Record<string, any>;
 }
+interface ResourceItemMain {
+    resource: Resource;
+    resmeta: Resmeta;
+}
+/** @deprecated use  CompositeRead from '@nextgisweb/resource/type/api' instead */
+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;
@@ -874,7 +950,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.
@@ -916,7 +992,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.
      */
@@ -976,6 +1052,28 @@ 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 ...
  */
@@ -985,6 +1083,8 @@ declare class InsufficientPermissionsError extends NgwError {
     constructor(obj: InsufficientPermissionsError);
 }
 
+declare function isError(error: unknown): error is Error;
+
 /**
  * Thrown when...
  */
@@ -993,16 +1093,6 @@ declare class NetworkError extends Error {
     constructor(url: string);
 }
 
-/**
- * Thrown when ...
- */
-declare class NetworksResponseError extends NgwError {
-    message: string;
-    title: string;
-    detail: string;
-    constructor(obj?: Partial<NetworksResponseError>);
-}
-
 /**
  * Thrown when ...
  */
@@ -1012,20 +1102,6 @@ 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;
@@ -1081,7 +1157,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
@@ -1309,4 +1385,4 @@ interface LayerLegend {
     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 };
+export { type ApiRouteParams, type BaseRequestOptions, type BasemapResource, type BasemapWebmap, type BasemapWebmapItem, type BookmarkProperties, type CreatedResource, type Credentials, type DeleteRequestItemsResponseMap, type DeleteRequestOptions, type FeatureItem, type FeatureItemAttachment, type FeatureItemExtensions, type FeatureItemToNgw, type FeatureLayerCount, type FeatureLayerField, type FeatureLayersIdentify, type FeatureLayersIdentifyItems, type FeatureResource, type FileBucket, type FileMeta, type FileUploadResp, type GeometryType, type GetChildrenOfOptions, type GetRequestItemsResponseMap, type GetRequestOptions, type GetRouteParam, type IdOnly, type KeysWithMethodAndPath, type KeysWithMethods, type KeysWithPaths, type LayerFeature, type LayerLegend, type LoadingQueue, type LookupTableResource, type LunkwillData, type Method, type MethodAvailable, type MethodRequestOptions, type NgwConnectorOptions, type NgwDateFormat, type NgwDateTimeFormat, type NgwExceptions, type NgwExtent, type NgwFile, type NgwLayerIdentifyError, type NgwTimeFormat, type Params, type PatchRequestItemsResponseMap, type PatchRequestOptions, type Permission, type PostRequestItemsResponseMap, type PostRequestOptions, type PutRequestItemsResponseMap, type PutRequestOptions, type PyramidRoute, type PyramidSettings, type PyramidSettingsPyramid, type PyramidSettingsPyramidCompanyLogo, type RequestHeaders, type RequestItemAdditionalParams, type RequestItemKeys, type RequestItemsParams, type RequestItemsParamsMap, type RequestItemsResponseMap, type RequestMethod, type RequestMethods, type RequestOptions, type RequestOptionsBody, type RequestOptionsByMethod, type RequestOptionsJSON, type RequestTransformFunction, type Resmeta, type Resource, type ResourceCls, type ResourceDefinition, type ResourceHierarchy, type ResourceIdKeynameDef, type ResourceItem, type ResourceItemDatatype, type ResourceItemMain, type ResourceStoreItem, type ResourceStoreItemDefault, type ResourceStoreItemProperties, type ResponseType, type RouteBody, type RouteMethods, type RouteName, type RouteParameters, type RouteQuery, type RouteRequestOptions, type RouteResp, type RouteResults, type Router, type SrsItem, type ToReturn, type TreeGroup, type TreeItem, type TreeLayer, type UserInfo, type VectorFieldDatatype, type VectorLayer, type VectorLayerResourceItem, type WebmapResource, type WmsClientConnection, type WmsClientLayer, type WmsServerService, type WmsServerServiceLayer, NgwConnectorExtended as default };