esri-gl 1.0.5 → 2.0.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esri-gl",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "A module for making it easier to use Esri services in mapbox-gl or maplibre-gl.",
   "type": "module",
   "main": "index.js",
@@ -63,6 +63,10 @@
     }
   },
   "dependencies": {
+    "@esri/arcgis-rest-basemap-sessions": "^4.10.2",
+    "@esri/arcgis-rest-feature-service": "^4.10.2",
+    "@esri/arcgis-rest-portal": "^4.10.2",
+    "@esri/arcgis-rest-request": "^4.10.2",
     "@mapbox/tilebelt": "^2.0.3",
     "arcgis-pbf-parser": "^0.0.4"
   }

package/dist/react-map-gl.d.ts

@@ -1,11 +1,35 @@
-import { u as useDynamicMapService, U as UseEsriServiceResult, x as useTiledMapService, w as useImageService, y as useVectorTileService, v as useFeatureService } from './useFeatureService-QUqwJcet.js';
-import { Map } from 'maplibre-gl';
+import { r as EsriAuthentication, a2 as PortalServiceResult, D as DynamicMapService, T as TiledMapService, g as ImageService, h as VectorTileService, i as FeatureService } from './index-Doq93o-G.js';
+export { l as AGOLServiceError, A as ApplyEditsResult, m as AttachmentInfo, B as BatchLayerOperation, n as BetweenFilter, C as ComparisonFilter, o as ComparisonOp, p as DynamicLayer, a as EditResult, q as EsriAuthOptions, s as EsriDrawingInfo, t as EsriDynamicMapLayerSource, u as EsriRenderer, v as EsriRequestOptions, E as EsriServiceOptions, w as EsriTextSymbol, x as Extent, F as FeatureServiceOptions, y as FeatureSet, z as FieldInfo, G as Find, H as GroupFilter, J as IdentifyFeatures, k as IdentifyImage, c as ImageServiceOptions, K as InFilter, L as LayerFilter, M as LayerInfo, N as LayerLabelingInfo, O as LayerMetadata, Q as LayerQueryOptions, R as LayerScaleRange, S as LayerSpecification, U as LayerTimeOptions, W as LayerUpdateEvent, X as LayerUpdateType, Y as LegendInfo, Z as LogicalOp, _ as MapExportOptions, $ as NullFilter, a0 as PaginatedFeatureCollection, P as PortalItemServiceOptions, a1 as PortalRequestOptions, d as PortalResolvedService, e as PortalServiceKind, a3 as Query, a4 as RasterSourceOptions, a5 as Service, a6 as ServiceErrorEvent, a7 as ServiceEventType, a8 as ServiceMetadata, a9 as SourceSpecification, aa as StatisticResult, ab as Task, ac as TimeAnimationOptions, j as VectorBasemapStyle, V as VectorBasemapStyleOptions, ad as VectorSourceOptions, f as VectorTileServiceOptions, ae as WebMapOptions, af as cleanTrailingSlash, ag as esriRequest, ah as find, ai as getServiceDetails, aj as identifyImage, ak as query, al as resolveAuthentication, am as searchPortalItems, an as serviceFromPortalItem, ao as servicesFromWebMap, ap as updateAttribution } from './index-Doq93o-G.js';
+import * as maplibre_gl from 'maplibre-gl';
 export { Map } from 'maplibre-gl';
-import { D as DynamicMapService, T as TiledMapService, e as ImageService, f as VectorTileService, g as FeatureService } from './index-DczUYC4z.js';
-export { j as AGOLServiceError, A as ApplyEditsResult, k as AttachmentInfo, B as BatchLayerOperation, l as BetweenFilter, C as ComparisonFilter, m as ComparisonOp, n as DynamicLayer, a as EditResult, o as EsriDrawingInfo, p as EsriDynamicMapLayerSource, q as EsriRenderer, E as EsriServiceOptions, r as EsriTextSymbol, s as Extent, F as FeatureServiceOptions, t as FeatureSet, u as FieldInfo, v as Find, G as GroupFilter, w as IdentifyFeatures, i as IdentifyImage, c as ImageServiceOptions, x as InFilter, L as LayerFilter, y as LayerInfo, z as LayerLabelingInfo, H as LayerMetadata, J as LayerQueryOptions, K as LayerScaleRange, M as LayerSpecification, N as LayerTimeOptions, O as LayerUpdateEvent, P as LayerUpdateType, Q as LegendInfo, R as LogicalOp, S as MapExportOptions, U as NullFilter, W as PaginatedFeatureCollection, X as Query, Y as RasterSourceOptions, Z as Service, _ as ServiceErrorEvent, $ as ServiceEventType, a0 as ServiceMetadata, a1 as SourceSpecification, a2 as StatisticResult, a3 as Task, a4 as TimeAnimationOptions, h as VectorBasemapStyle, V as VectorBasemapStyleOptions, a5 as VectorSourceOptions, d as VectorTileServiceOptions, a6 as cleanTrailingSlash, a7 as find, a8 as getServiceDetails, a9 as identifyImage, aa as query, ab as updateAttribution } from './index-DczUYC4z.js';
+import { u as useDynamicMapService, U as UseEsriServiceResult, r as useTiledMapService, q as useImageService, s as useVectorTileService, p as useFeatureService } from './useFeatureService-CG70gjQy.js';
+export { ApiKeyManager, ApplicationCredentialsManager, ArcGISAuthError, ArcGISIdentityManager, ArcGISRequestError, FieldType, GeometryType, IAuthenticationManager, ICodedValue, IDomain, IExtent, IFeature, IFeatureSet, IField, IGeometry, IHasZM, IMultipoint, IPoint, IPolygon, IPolyline, IRequestOptions, ISpatialReference, Units } from '@esri/arcgis-rest-request';
+export { IAddAttachmentOptions, IAddFeaturesOptions, IAllLayersAndTablesResponse, IApplyEditsOptions, IApplyEditsResult, IAttachmentInfo, IDecodeValuesOptions, IDeleteAttachmentsOptions, IDeleteFeaturesOptions, IEditFeatureResult, IFeatureServiceDefinition, IGetAttachmentsOptions, IGetFeatureOptions, IGetLayerOptions, ILayer, ILayerDefinition, IOrderByField, IQueryAllFeaturesOptions, IQueryAllFeaturesResponse, IQueryFeaturesOptions, IQueryFeaturesResponse, IQueryRelatedOptions, IQueryRelatedResponse, IQueryResponse, IRelatedRecordGroup, IRelatedRecordsInfo, ISharedEditOptions, ISharedQueryOptions, IStatisticDefinition } from '@esri/arcgis-rest-feature-service';
+export { BasemapStyleSession, IStartSessionParams, StyleFamily } from '@esri/arcgis-rest-basemap-sessions';
+export { IGroup, IItem, IPagingParams, ISearchOptions, ISearchResult, IUser, SearchQueryBuilder } from '@esri/arcgis-rest-portal';
 import 'react';
 
-interface EsriLayerBaseProps {
+/**
+ * Common authentication and request options forwarded to the underlying
+ * Esri service when any defined value is passed on a layer component.
+ */
+interface EsriAuthProps {
+    /** ArcGIS token (sent as the `token` request parameter) */
+    token?: string;
+    /** ArcGIS Location Platform API key (sent as the `token` parameter) */
+    apiKey?: string;
+    /** ArcGIS REST JS authentication manager (preferred for OAuth/user sign-in) */
+    authentication?: EsriAuthentication;
+    /** @deprecated No longer applied. */
+    proxy?: string | boolean;
+    /** Whether to fetch and apply service attribution (default true in services) */
+    getAttributionFromService?: boolean;
+    /** Extra request params merged into every service request */
+    requestParams?: Record<string, unknown>;
+    /** @deprecated No longer forwarded to requests; use `authentication`. */
+    fetchOptions?: RequestInit;
+}
+interface EsriLayerBaseProps extends EsriAuthProps {
     id: string;
     sourceId?: string;
     beforeId?: string;
@@ -33,7 +57,14 @@ interface EsriVectorTileLayerProps extends EsriLayerBaseProps {
 }
 interface EsriVectorBasemapLayerProps extends EsriLayerBaseProps {
     basemapEnum: string;
-    token: string;
+    /** OAuth / user token (v2 host). Provide `token` or `apiKey`. */
+    token?: string;
+    /** ArcGIS Location Platform API key (v1 host). Provide `token` or `apiKey`. */
+    apiKey?: string;
+    /** Optional locale for the basemap labels. */
+    language?: string;
+    /** Optional worldview. */
+    worldview?: string;
 }
 interface EsriFeatureLayerProps extends EsriLayerBaseProps {
     url: string;
@@ -43,6 +74,16 @@ interface EsriFeatureLayerProps extends EsriLayerBaseProps {
     paint?: Record<string, unknown>;
     layout?: Record<string, unknown>;
 }
+interface EsriPortalLayerProps extends EsriLayerBaseProps {
+    /** ArcGIS portal item id to resolve to a service. */
+    itemId: string;
+    /** For multi-layer Feature Services, which sublayer to load (default 0). */
+    layerId?: number;
+    /** Portal sharing REST URL (defaults to ArcGIS Online). */
+    portal?: string;
+    /** Called once the item resolves, with the resolved service/kind/url/title. */
+    onResolve?: (result: PortalServiceResult) => void;
+}
 
 /**
  * React Map GL component for Esri Dynamic Map Service
@@ -74,11 +115,17 @@ declare function EsriVectorBasemapLayer(props: EsriVectorBasemapLayerProps): nul
  */
 declare function EsriFeatureLayer(props: EsriFeatureLayerProps): null;
 
+/**
+ * React Map GL component that resolves an ArcGIS portal item id to the matching
+ * esri-gl service and adds a renderer-appropriate layer for it.
+ */
+declare function EsriPortalLayer(props: EsriPortalLayerProps): null;
+
 /**
  * Hook for using Esri services with Mapbox GL JS (via react-map-gl)
  */
 declare function useEsriMapboxLayer(): {
-    map: Map | null;
+    map: maplibre_gl.Map | undefined;
     useDynamicMapService: (options: Parameters<typeof useDynamicMapService>[0]) => UseEsriServiceResult<DynamicMapService>;
     useTiledMapService: (options: Parameters<typeof useTiledMapService>[0]) => UseEsriServiceResult<TiledMapService>;
     useImageService: (options: Parameters<typeof useImageService>[0]) => UseEsriServiceResult<ImageService>;
@@ -90,7 +137,7 @@ declare function useEsriMapboxLayer(): {
  * Hook for using Esri services with MapLibre GL JS (via react-map-gl/maplibre)
  */
 declare function useEsriMaplibreLayer(): {
-    map: Map | null;
+    map: maplibre_gl.Map | undefined;
     useDynamicMapService: (options: Parameters<typeof useDynamicMapService>[0]) => UseEsriServiceResult<DynamicMapService>;
     useTiledMapService: (options: Parameters<typeof useTiledMapService>[0]) => UseEsriServiceResult<TiledMapService>;
     useImageService: (options: Parameters<typeof useImageService>[0]) => UseEsriServiceResult<ImageService>;
@@ -98,5 +145,5 @@ declare function useEsriMaplibreLayer(): {
     useFeatureService: (options: Parameters<typeof useFeatureService>[0]) => UseEsriServiceResult<FeatureService>;
 };
 
-export { DynamicMapService, EsriDynamicLayer, EsriFeatureLayer, EsriImageLayer, EsriTiledLayer, EsriVectorBasemapLayer, EsriVectorTileLayer, FeatureService, ImageService, TiledMapService, VectorTileService, useEsriMapboxLayer, useEsriMaplibreLayer };
-export type { EsriDynamicLayerProps as ReactMapGLEsriDynamicLayerProps, EsriFeatureLayerProps as ReactMapGLEsriFeatureLayerProps, EsriImageLayerProps as ReactMapGLEsriImageLayerProps, EsriTiledLayerProps as ReactMapGLEsriTiledLayerProps, EsriVectorBasemapLayerProps as ReactMapGLEsriVectorBasemapLayerProps, EsriVectorTileLayerProps as ReactMapGLEsriVectorTileLayerProps };
+export { DynamicMapService, EsriAuthentication, EsriDynamicLayer, EsriFeatureLayer, EsriImageLayer, EsriPortalLayer, EsriTiledLayer, EsriVectorBasemapLayer, EsriVectorTileLayer, FeatureService, ImageService, PortalServiceResult, TiledMapService, VectorTileService, useEsriMapboxLayer, useEsriMaplibreLayer };
+export type { EsriDynamicLayerProps as ReactMapGLEsriDynamicLayerProps, EsriFeatureLayerProps as ReactMapGLEsriFeatureLayerProps, EsriImageLayerProps as ReactMapGLEsriImageLayerProps, EsriPortalLayerProps as ReactMapGLEsriPortalLayerProps, EsriTiledLayerProps as ReactMapGLEsriTiledLayerProps, EsriVectorBasemapLayerProps as ReactMapGLEsriVectorBasemapLayerProps, EsriVectorTileLayerProps as ReactMapGLEsriVectorTileLayerProps };