@feltmaps/js-sdk 1.5.0-next.8 → 1.5.1

package/dist/client.cjs

@@ -1 +1 @@
-"use strict";var g=Object.defineProperty;var F=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var S=Object.prototype.hasOwnProperty;var G=(e,n)=>{for(var r in n)g(e,r,{get:n[r],enumerable:!0})},I=(e,n,r,s)=>{if(n&&typeof n=="object"||typeof n=="function")for(let l of b(n))!S.call(e,l)&&l!==r&&g(e,l,{get:()=>n[l],enumerable:!(s=F(n,l))||s.enumerable});return e};var x=e=>I(g({},"__esModule",{value:!0}),e);var K={};G(K,{Felt:()=>M});module.exports=x(K);function o(e,n){return r=>{let s=new MessageChannel,l=r.handler,a="options"in r?r.options:void 0,i=crypto.randomUUID();return e.postMessage({type:"felt.addListener",event:a?{eventName:n,id:i,options:a}:{eventName:n,id:i}},"*",[s.port2]),s.port1.onmessage=d=>{l(d.data)},()=>{s.port1.onmessage=null,s.port1.close(),s.port2.close(),e.postMessage({type:"felt.removeListener",id:i},"*")}}}function t(e,n){return r=>{let s=new MessageChannel;return e.postMessage({type:n,params:r},"*",[s.port2]),new Promise((l,a)=>{s.port1.onmessage=i=>{i.data&&typeof i.data=="object"&&"__error__"in i.data?a(new Error(i.data.__error__)):l(i.data),s.port1.close(),s.port2.close()}})}}var u=e=>({getElement:t(e,"getElement"),getElementGeometry:t(e,"getElementGeometry"),getElements:t(e,"getElements"),setElementGroupVisibility:t(e,"setElementGroupVisibility"),getElementGroup:t(e,"getElementGroup"),getElementGroups:t(e,"getElementGroups"),onElementChange:o(e,"onElementChange"),onElementCreate:o(e,"onElementCreate"),onElementCreateEnd:o(e,"onElementCreateEnd"),onElementDelete:o(e,"onElementDelete"),onElementGroupChange:o(e,"onElementGroupChange"),createElement:t(e,"createElement"),updateElement:t(e,"updateElement"),deleteElement:t(e,"deleteElement")});var C=e=>({onPointerClick:o(e,"onPointerClick"),onPointerMove:o(e,"onPointerMove")});var h=e=>({getLayer:t(e,"getLayer"),getLayers:t(e,"getLayers"),setLayerVisibility:t(e,"setLayerVisibility"),setLayerStyle:t(e,"setLayerStyle"),setLayerLegendVisibility:t(e,"setLayerLegendVisibility"),onLayerChange:o(e,"onLayerChange"),getLayerGroup:t(e,"getLayerGroup"),getLayerGroups:t(e,"getLayerGroups"),setLayerGroupVisibility:t(e,"setLayerGroupVisibility"),setLayerGroupLegendVisibility:t(e,"setLayerGroupLegendVisibility"),onLayerGroupChange:o(e,"onLayerGroupChange"),getLegendItem:t(e,"getLegendItem"),getLegendItems:t(e,"getLegendItems"),setLegendItemVisibility:t(e,"setLegendItemVisibility"),onLegendItemChange:o(e,"onLegendItemChange"),getLayerFilters:t(e,"getLayerFilters"),setLayerFilters:t(e,"setLayerFilters"),onLayerFiltersChange:o(e,"onLayerFiltersChange"),getRenderedFeatures:t(e,"getRenderedFeatures"),getCategoryData:t(e,"getCategoryData"),getHistogramData:t(e,"getHistogramData"),getAggregates:t(e,"getAggregates")});var L=e=>({getMapDetails:t(e,"getMapDetails")});var T=e=>({onSelectionChange:o(e,"onSelectionChange"),getSelection:t(e,"getSelection"),selectFeature:t(e,"selectFeature"),clearSelection:t(e,"clearSelection")});var E=e=>({setTool:t(e,"setTool"),getTool:t(e,"getTool"),onToolChange:o(e,"onToolChange"),setToolSettings:t(e,"setToolSettings"),getToolSettings:t(e,"getToolSettings"),onToolSettingsChange:o(e,"onToolSettingsChange")});var v=e=>({updateUiControls:t(e,"updateUiControls"),setOnMapInteractionsUi:t(e,"setOnMapInteractionsUi"),showLayerDataTable:t(e,"showLayerDataTable"),hideLayerDataTable:t(e,"hideLayerDataTable")});var P=e=>({getViewport:t(e,"getViewport"),setViewport:t(e,"setViewport"),getViewportConstraints:t(e,"getViewportConstraints"),setViewportConstraints:t(e,"setViewportConstraints"),fitViewportToBounds:t(e,"fitViewportToBounds"),onViewportMove:o(e,"onViewportMove"),onViewportMoveEnd:o(e,"onViewportMoveEnd"),onMapIdle:o(e,"onMapIdle")});function V(e){return{iframe:null,...P(e),...v(e),...h(e),...u(e),...T(e),...C(e),...E(e),...L(e)}}var M={embed(e,n,r){let s={uiControls:{showLegend:!0,cooperativeGestures:!0,fullScreenButton:!0,geolocation:!1,zoomControls:!0,scaleBar:!0},initialViewport:void 0,origin:"https://felt.com"},l=r?.origin??s.origin,a=new URL(`${l}/embed/map/${n}`),i={showLegend:"legend",cooperativeGestures:"cooperativeGestures",fullScreenButton:"link",geolocation:"geolocation",zoomControls:"zoomControls",scaleBar:"scaleBar"},d={...s.uiControls,...r?.uiControls};for(let[p,y]of f(d))y!=null&&a.searchParams.set(i[p],y?"1":"0");if(r?.token&&a.searchParams.set("token",r.token),r?.initialViewport){let p=r.initialViewport;a.searchParams.set("loc",`${p.center.latitude},${p.center.longitude},${p.zoom}z`)}let c=e.tagName==="IFRAME",m=c?e:e.ownerDocument.createElement("iframe");return m.src=a.toString(),c||(m.style.width="100%",m.style.height="100%",m.style.border="none",m.style.margin="0",e.appendChild(m)),m.referrerPolicy="strict-origin-when-cross-origin",new Promise((p,y)=>{m.addEventListener("load",()=>{m.contentWindow==null?y(new Error("Failed to load Felt map")):p(m.contentWindow)},{once:!0})}).then(M.connect).then(p=>(Object.defineProperties(p,{iframe:{value:m,writable:!1,configurable:!1}}),p))},connect(e){let n=V(e);return new Promise((r,s)=>{let l=setTimeout(()=>{s(new Error("Failed to load Felt map")),clearInterval(i)},5e3),a=new MessageChannel,i=setInterval(()=>{e.postMessage({type:"felt.ready"},"*",[a.port2])},100);a.port1.onmessage=d=>{d.data===!0&&(clearInterval(i),clearTimeout(l),a.port1.close(),a.port2.close(),r(n))}})}},f=Object.entries;0&&(module.exports={Felt});
+"use strict";var c=Object.defineProperty;var V=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var I=Object.prototype.hasOwnProperty;var x=(e,o)=>{for(var n in o)c(e,n,{get:o[n],enumerable:!0})},f=(e,o,n,s)=>{if(o&&typeof o=="object"||typeof o=="function")for(let a of b(o))!I.call(e,a)&&a!==n&&c(e,a,{get:()=>o[a],enumerable:!(s=V(o,a))||s.enumerable});return e};var K=e=>f(c({},"__esModule",{value:!0}),e);var O={};x(O,{Felt:()=>S});module.exports=K(O);function r(e,o){return n=>{let s=new MessageChannel,a=n.handler,i="options"in n?n.options:void 0,m=crypto.randomUUID();return e.postMessage({type:"felt.addListener",event:i?{eventName:o,id:m,options:i}:{eventName:o,id:m}},"*",[s.port2]),s.port1.onmessage=y=>{u(y)||a(y.data)},()=>{s.port1.onmessage=null,s.port1.close(),s.port2.close(),e.postMessage({type:"felt.removeListener",id:m},"*")}}}function t(e,o,n){return async s=>{let a=new MessageChannel,i=s&&n?await n(s):s;return e.postMessage({type:o,params:i},"*",[a.port2]),new Promise((m,y)=>{a.port1.onmessage=g=>{u(g)?y(new Error(g.data.__error__)):m(g.data),a.port1.close(),a.port2.close()}})}}function u(e){return e.data&&typeof e.data=="object"&&"__error__"in e.data}var C=e=>({getElement:t(e,"getElement"),getElementGeometry:t(e,"getElementGeometry"),getElements:t(e,"getElements"),setElementGroupVisibility:t(e,"setElementGroupVisibility"),getElementGroup:t(e,"getElementGroup"),getElementGroups:t(e,"getElementGroups"),onElementChange:r(e,"onElementChange"),onElementCreate:r(e,"onElementCreate"),onElementCreateEnd:r(e,"onElementCreateEnd"),onElementDelete:r(e,"onElementDelete"),onElementGroupChange:r(e,"onElementGroupChange"),createElement:t(e,"createElement"),updateElement:t(e,"updateElement"),deleteElement:t(e,"deleteElement")});var L=e=>({onPointerClick:r(e,"onPointerClick"),onPointerMove:r(e,"onPointerMove")});var T=e=>({getLayer:t(e,"getLayer"),getLayers:t(e,"getLayers"),setLayerVisibility:t(e,"setLayerVisibility"),setLayerStyle:t(e,"setLayerStyle"),setLayerLegendVisibility:t(e,"setLayerLegendVisibility"),onLayerChange:r(e,"onLayerChange"),createLayersFromGeoJson:t(e,"createLayersFromGeoJson",h),updateLayer:t(e,"updateLayer",h),deleteLayer:t(e,"deleteLayer"),getLayerGroup:t(e,"getLayerGroup"),getLayerGroups:t(e,"getLayerGroups"),setLayerGroupVisibility:t(e,"setLayerGroupVisibility"),setLayerGroupLegendVisibility:t(e,"setLayerGroupLegendVisibility"),onLayerGroupChange:r(e,"onLayerGroupChange"),getLegendItem:t(e,"getLegendItem"),getLegendItems:t(e,"getLegendItems"),setLegendItemVisibility:t(e,"setLegendItemVisibility"),onLegendItemChange:r(e,"onLegendItemChange"),getLayerFilters:t(e,"getLayerFilters"),setLayerFilters:t(e,"setLayerFilters"),onLayerFiltersChange:r(e,"onLayerFiltersChange"),getRenderedFeatures:t(e,"getRenderedFeatures"),getFeature:t(e,"getFeature"),getGeoJsonFeature:t(e,"getGeoJsonFeature"),getCategoryData:t(e,"getCategoryData"),getHistogramData:t(e,"getHistogramData"),getAggregates:t(e,"getAggregates"),getLayerSchema:t(e,"getLayerSchema")});async function h(e){let{source:o}=e;return o&&o.type==="geoJsonFile"?{...e,source:{type:"geoJsonData",data:JSON.parse(await o.file.text())}}:e}var P=e=>({getMapDetails:t(e,"getMapDetails")});var E=e=>({onSelectionChange:r(e,"onSelectionChange"),getSelection:t(e,"getSelection"),selectFeature:t(e,"selectFeature"),clearSelection:t(e,"clearSelection")});var v=e=>({setTool:t(e,"setTool"),getTool:t(e,"getTool"),onToolChange:r(e,"onToolChange"),setToolSettings:t(e,"setToolSettings"),getToolSettings:t(e,"getToolSettings"),onToolSettingsChange:r(e,"onToolSettingsChange")});var M=e=>({updateUiControls:t(e,"updateUiControls"),setOnMapInteractionsUi:t(e,"setOnMapInteractionsUi"),showLayerDataTable:t(e,"showLayerDataTable"),hideLayerDataTable:t(e,"hideLayerDataTable")});var F=e=>({getViewport:t(e,"getViewport"),setViewport:t(e,"setViewport"),getViewportConstraints:t(e,"getViewportConstraints"),setViewportConstraints:t(e,"setViewportConstraints"),fitViewportToBounds:t(e,"fitViewportToBounds"),onViewportMove:r(e,"onViewportMove"),onViewportMoveEnd:r(e,"onViewportMoveEnd"),onMapIdle:r(e,"onMapIdle")});function G(e){return{iframe:null,...F(e),...M(e),...T(e),...C(e),...E(e),...L(e),...v(e),...P(e)}}var S={embed(e,o,n){let s={uiControls:{showLegend:!0,cooperativeGestures:!0,fullScreenButton:!0,geolocation:!1,zoomControls:!0,scaleBar:!0},initialViewport:void 0,origin:"https://felt.com"},a=n?.origin??s.origin,i=new URL(`${a}/embed/map/${o}`),m={showLegend:"legend",cooperativeGestures:"cooperativeGestures",fullScreenButton:"link",geolocation:"geolocation",zoomControls:"zoomControls",scaleBar:"scaleBar"},y={...s.uiControls,...n?.uiControls};for(let[p,d]of k(y))d!=null&&i.searchParams.set(m[p],d?"1":"0");if(n?.token&&i.searchParams.set("token",n.token),n?.initialViewport){let p=n.initialViewport;i.searchParams.set("loc",`${p.center.latitude},${p.center.longitude},${p.zoom}z`)}let g=e.tagName==="IFRAME",l=g?e:e.ownerDocument.createElement("iframe");return l.src=i.toString(),g||(l.style.width="100%",l.style.height="100%",l.style.border="none",l.style.margin="0",e.appendChild(l)),l.referrerPolicy="strict-origin-when-cross-origin",new Promise((p,d)=>{l.addEventListener("load",()=>{l.contentWindow==null?d(new Error("Failed to load Felt map")):p(l.contentWindow)},{once:!0})}).then(S.connect).then(p=>(Object.defineProperties(p,{iframe:{value:l,writable:!1,configurable:!1}}),p))},connect(e){let o=G(e);return new Promise((n,s)=>{let a=setTimeout(()=>{s(new Error("Failed to load Felt map")),clearInterval(m)},5e3),i=new MessageChannel,m=setInterval(()=>{e.postMessage({type:"felt.ready"},"*",[i.port2])},100);i.port1.onmessage=y=>{y.data===!0&&(clearInterval(m),clearTimeout(a),i.port1.close(),i.port2.close(),n(o))}})}},k=Object.entries;0&&(module.exports={Felt});

package/dist/client.d.cts

@@ -1,5 +1,5 @@
-import { E as Element, G as Geometry, a as GetElementsConstraint, b as ElementGroup, c as GetElementGroupsConstraint, S as SetVisibilityRequest, d as ElementChangeCallbackParams, e as ElementGroupChangeCallbackParams, f as ElementCreate, g as ElementUpdate, L as Layer, h as GetLayersConstraint, i as LayerChangeCallbackParams, j as LayerGroup, k as GetLayerGroupsConstraint, l as LayerGroupChangeCallbackParams, m as LegendItemIdentifier, n as LegendItem, o as LegendItemsConstraint, p as LegendItemChangeCallbackParams, q as LayerFilters, F as Filters, r as GetRenderedFeaturesConstraint, s as Feature, t as GetLayerCategoriesParams, u as GetLayerCategoriesGroup, v as GetLayerHistogramParams, w as GetLayerHistogramBin, A as AggregationMethod, x as GetLayerCalculationParams, M as MapInteractionEvent, y as MapDetails, z as EntityNode, B as FeatureSelection, T as ToolType, I as InputToolSettings, C as ConfigurableToolType, D as ToolSettingsMap, H as ToolSettingsChangeEvent, J as zInfer, K as SortConfig, V as ViewportState, N as SetViewportCenterZoomParams, O as ViewportConstraints, P as ViewportFitBoundsParams, Q as ViewportCenterZoom } from './types-BXCTpxot.cjs';
-export { ap as AggregationConfig, R as CircleElementCreate, U as CircleElementRead, W as CircleElementUpdate, aH as CircleToolSettings, as as ElementGroupNode, at as ElementNode, au as FeatureNode, ax as FeltBoundary, ay as FeltZoom, am as FilterExpression, an as FilterLogicGate, ao as FilterTernary, X as HighlighterElementCreate, Y as HighlighterElementRead, Z as HighlighterElementUpdate, aI as HighlighterToolSettings, _ as ImageElementCreate, $ as ImageElementRead, a0 as ImageElementUpdate, az as LatLng, av as LayerGroupNode, aw as LayerNode, ak as LayerProcessingStatus, aA as LineStringGeometry, aJ as LineToolSettings, a1 as LinkElementRead, aB as LngLatTuple, a2 as MarkerElementCreate, a3 as MarkerElementRead, a4 as MarkerElementUpdate, aK as MarkerToolSettings, aq as MultiAggregationConfig, aC as MultiLineStringGeometry, aD as MultiPolygonGeometry, a5 as NoteElementCreate, a6 as NoteElementRead, a7 as NoteElementUpdate, aL as NoteToolSettings, a8 as PathElementCreate, a9 as PathElementRead, aa as PathElementUpdate, aM as PinToolSettings, ab as PlaceElementCreate, ac as PlaceElementRead, ad as PlaceElementUpdate, aN as PlaceFrame, aO as PlaceSymbol, aE as PointGeometry, ae as PolygonElementCreate, af as PolygonElementRead, ag as PolygonElementUpdate, aF as PolygonGeometry, aP as PolygonToolSettings, al as RasterValue, aQ as RouteToolSettings, aG as SortDirection, ah as TextElementCreate, ai as TextElementRead, aj as TextElementUpdate, aR as TextToolSettings, ar as ValueConfiguration } from './types-BXCTpxot.cjs';
+import { E as Element, G as GeoJsonGeometry, a as GetElementsConstraint, b as ElementGroup, c as GetElementGroupsConstraint, S as SetVisibilityRequest, d as ElementChangeCallbackParams, e as ElementGroupChangeCallbackParams, f as ElementCreate, g as ElementUpdate, L as Layer, h as GetLayersConstraint, i as LayerChangeCallbackParams, C as CreateLayersFromGeoJsonParams, j as LayerGroup, U as UpdateLayerParams, k as GetLayerGroupsConstraint, l as LayerGroupChangeCallbackParams, m as LegendItemIdentifier, n as LegendItem, o as LegendItemsConstraint, p as LegendItemChangeCallbackParams, q as LayerFilters, F as Filters, r as GetRenderedFeaturesConstraint, s as LayerFeature, t as GeoJsonFeature, u as GetLayerCategoriesParams, v as GetLayerCategoriesGroup, w as GetLayerHistogramParams, x as GetLayerHistogramBin, A as AggregationMethod, y as GetLayerCalculationParams, z as LayerSchema, M as MapInteractionEvent, B as MapDetails, D as EntityNode, H as FeatureSelection, T as ToolType, I as InputToolSettings, J as ConfigurableToolType, K as ToolSettingsMap, N as ToolSettingsChangeEvent, O as zInfer, P as SortConfig, V as ViewportState, Q as SetViewportCenterZoomParams, R as ViewportConstraints, W as ViewportFitBoundsParams, X as ViewportCenterZoom } from './types-CnYUajGG.cjs';
+export { aK as AggregationConfig, Y as CircleElementCreate, Z as CircleElementRead, _ as CircleElementUpdate, b3 as CircleToolSettings, ao as DataOnlyLayer, aO as ElementGroupNode, aP as ElementNode, aQ as FeatureNode, aT as FeltBoundary, ap as FeltTiledVectorSource, aU as FeltZoom, aH as FilterExpression, aI as FilterLogicGate, aJ as FilterTernary, aq as GeoJsonDataVectorSource, ar as GeoJsonFileVectorSource, aV as GeoJsonProperties, as as GeoJsonUrlVectorSource, aL as GeometryFilter, $ as HighlighterElementCreate, a0 as HighlighterElementRead, a1 as HighlighterElementUpdate, b4 as HighlighterToolSettings, a2 as ImageElementCreate, a3 as ImageElementRead, a4 as ImageElementUpdate, aW as LatLng, at as LayerCommon, aR as LayerGroupNode, aS as LayerNode, au as LayerProcessingStatus, aA as LayerSchemaAttribute, aB as LayerSchemaBooleanAttribute, aC as LayerSchemaCommonAttribute, aD as LayerSchemaDateAttribute, aE as LayerSchemaDateTimeAttribute, aF as LayerSchemaNumericAttribute, aG as LayerSchemaTextAttribute, aX as LineStringGeometry, b5 as LineToolSettings, a5 as LinkElementRead, aY as LngLatTuple, a6 as MarkerElementCreate, a7 as MarkerElementRead, a8 as MarkerElementUpdate, b6 as MarkerToolSettings, aM as MultiAggregationConfig, aZ as MultiLineStringGeometry, a_ as MultiPointGeometry, a$ as MultiPolygonGeometry, a9 as NoteElementCreate, aa as NoteElementRead, ab as NoteElementUpdate, b7 as NoteToolSettings, ac as PathElementCreate, ad as PathElementRead, ae as PathElementUpdate, b8 as PinToolSettings, af as PlaceElementCreate, ag as PlaceElementRead, ah as PlaceElementUpdate, b9 as PlaceFrame, ba as PlaceSymbol, b0 as PointGeometry, ai as PolygonElementCreate, aj as PolygonElementRead, ak as PolygonElementUpdate, b1 as PolygonGeometry, bb as PolygonToolSettings, av as RasterBand, aw as RasterLayer, ax as RasterLayerSource, ay as RasterValue, bc as RouteToolSettings, b2 as SortDirection, al as TextElementCreate, am as TextElementRead, an as TextElementUpdate, bd as TextToolSettings, aN as ValueConfiguration, az as VectorLayer } from './types-CnYUajGG.cjs';
 import { z } from 'zod';
 
 /**
@@ -25,7 +25,23 @@ interface ElementsController {
      */
     id: string): Promise<Element | null>;
     /**
-     * Get the geometry of an element.
+     * Get the geometry of an element in GeoJSON geometry format.
+     *
+     * For most element types, the geometry returned is based on the `coordinates`
+     * property of the element, with some differences:
+     *
+     * - For Circle elements, the geometry is a Polygon drawn from the `center` and
+     * `radius` properties.
+     *
+     * - Path elements become MultiLineString geometries.
+     *
+     * - Marker elements return a MultiLineString of the path traced by the user
+     * as they drew the marker. Note that this is not the polygon formed by filled-in
+     * "pen" stroke, which doesn't exactly follow the path traced by the user as it
+     * is smoothed and interpolated to create a continuous line.
+     *
+     * - Text, Note and Image elements do not return geometry, so will return `null`.
+     *
      *
      * @example
      * ```typescript
@@ -37,7 +53,7 @@ interface ElementsController {
     /**
      * The id of the element you want to get the geometry of.
      */
-    id: string): Promise<Geometry | null>;
+    id: string): Promise<GeoJsonGeometry | null>;
     /**
      * Gets elements from the map, according to the constraints supplied. If no
      * constraints are supplied, all elements will be returned.
@@ -121,7 +137,7 @@ interface ElementsController {
          * still being created by a drawing tool.
          *
          * If you want to know when the element is finished being created, you can
-         * use the `onToolCreateElementEnd` listener.
+         * use the {@link ElementsController.onElementCreateEnd | `onElementCreateEnd`} listener.
          *
          * @param change - An object describing the change that occurred.
          */
@@ -130,7 +146,7 @@ interface ElementsController {
     /**
      * Listens for when a new element is finished being created by a drawing tool.
      *
-     * This differs from the `onElementCreate` listener, which fires whenever an
+     * This differs from the {@link ElementsController.onElementCreate | `onElementCreate`} listener, which fires whenever an
      * element is first created. This fires when the user finishes creating an element
      * which could be after a series of interactions.
      *
@@ -140,6 +156,7 @@ interface ElementsController {
      *
      * @returns A function to unsubscribe from the listener
      *
+     * @event
      * @example
      * ```typescript
      * const unsubscribe = felt.onToolCreatedElement({
@@ -166,10 +183,10 @@ interface ElementsController {
      * This will fire when an element is being edited, either on the map by the user
      * or programatically.
      *
-     * Like the `onElementCreate` listener, this will fire when an element is
+     * Like the {@link ElementsController.onElementCreate | `onElementCreate`} listener, this will fire when an element is
      * still being created by a drawing tool.
      *
-     * You can check the `isBeingCreated` property to determine if the element is
+     * You can check the {@link ElementChangeCallbackParams.isBeingCreated | `isBeingCreated`} property to determine if the element is
      * still being created by a drawing tool.
      *
      * @returns A function to unsubscribe from the listener
@@ -212,7 +229,7 @@ interface ElementsController {
      * ```typescript
      * const unsubscribe = felt.onElementDelete({
      *   options: { id: "element-1" },
-     *   handler: (element) => console.log(element.id),
+     *   handler: () => console.log("element-1 deleted"),
      * });
      *
      * // later on...
@@ -265,10 +282,31 @@ interface ElementsController {
     createElement(element: ElementCreate): Promise<Element>;
     /**
      * Update an element on the map.
+     *
+     * @example
+     * ```typescript
+     * // Update a place element's coordinates
+     * await felt.updateElement({
+     *   id: "element-1",
+     *   coordinates: [10, 20]
+     * });
+     *
+     * // Update a polygon's style
+     * await felt.updateElement({
+     *   id: "element-2",
+     *   color: "#ABC123",
+     *   fillOpacity: 0.5
+     * });
+     * ```
      */
     updateElement(element: ElementUpdate): Promise<Element>;
     /**
      * Delete an element from the map.
+     *
+     * @example
+     * ```typescript
+     * await felt.deleteElement("element-1");
+     * ```
      */
     deleteElement(id: string): Promise<void>;
 }
@@ -405,6 +443,70 @@ interface LayersController {
          */
         change: LayerChangeCallbackParams) => void;
     }): VoidFunction;
+    /**
+     * Adds layers to the map from file or URL sources.
+     *
+     * @remarks This allows you to add temporary layers to the map that don't depend on
+     * any processing by Felt. This is useful for viewing data from external sources or
+     * remote files.
+     *
+     * @returns The layer groups that were created.
+     *
+     * @example
+     * ```typescript
+     * const layerFromFile = await felt.createLayersFromGeoJson({
+     *   source: {
+     *     type: "geoJsonFile",
+     *     file: someFile,
+     *   },
+     *   name: "Parcels",
+     * });
+     *
+     * const layerFromUrl = await felt.createLayersFromGeoJson({
+     *   source: {
+     *     sourceType: "geoJsonUrl",
+     *     url: "https://example.com/parcels.geojson",
+     *   },
+     *   name: "Parcels",
+     * ```
+     */
+    createLayersFromGeoJson(params: CreateLayersFromGeoJsonParams): Promise<{
+        /**
+         * The layer group that was created containing the created layers.
+         */
+        layerGroup: LayerGroup;
+        /**
+         * The layers that were created from the source.
+         */
+        layers: Array<Layer>;
+    } | null>;
+    /**
+     * Update a layer by passing a subset of the layer's properties.
+     *
+     * Note that not all properties can be updated, so check the {@link UpdateLayerParams}
+     * type to see which properties can be updated.
+     *
+     * @example
+     * ```typescript
+     * await felt.updateLayer({
+     *   id: "layer-1",
+     *   name: "My Layer",
+     *   caption: "A description of the layer",
+     * });
+     * ```
+     */
+    updateLayer(params: UpdateLayerParams): Promise<Layer>;
+    /**
+     * Delete a layer from the map by its id.
+     *
+     * @remarks This only works for layers created via the SDK `createLayersFromGeoJson` method, not layers added via the Felt UI.
+     *
+     * @example
+     * ```typescript
+     * await felt.deleteLayer("layer-1");
+     * ```
+     */
+    deleteLayer(id: string): Promise<void>;
     /**
      * Get a layer group from the map by its id.
      *
@@ -550,7 +652,7 @@ interface LayersController {
      *
      * @example
      * ```typescript
-     * felt.setLayerFilters({
+     * await felt.setLayerFilters({
      *   layerId: "layer-1",
      *   filters: ["AREA", "gt", 30_000],
      * });
@@ -625,7 +727,41 @@ interface LayersController {
     /**
      * The constraints to apply to the features returned from the map.
      */
-    params?: GetRenderedFeaturesConstraint): Promise<Array<Feature>>;
+    params?: GetRenderedFeaturesConstraint): Promise<Array<LayerFeature>>;
+    /**
+     * Get a feature from the map by its ID and layer ID.
+     *
+     * The response is a {@link LayerFeature} object, which does not include the
+     * geometry of the feature.
+     *
+     * You may want to use this when you don't need the geometry of a feature,
+     * but you know the ID of the feature you need.
+     *
+     * @example
+     * ```typescript
+     * const feature = await felt.getFeature({ layerId: "layer-1", id: 123 });
+     * ```
+     */
+    getFeature(params: {
+        id: string | number;
+        layerId: string;
+    }): Promise<LayerFeature | null>;
+    /**
+     * Get a feature in GeoJSON format from the map by its ID and layer ID.
+     *
+     * The response is a GeoJSON Feature object with the complete geometry of the
+     * feature. Note that for some _very_ large geometries, the response may take a
+     * long time to return, and may return a very large object.
+     *
+     * @example
+     * ```typescript
+     * const feature = await felt.getGeoJsonFeature({ layerId: "layer-1", id: 123 });
+     * ```
+     */
+    getGeoJsonFeature(params: {
+        id: string | number;
+        layerId: string;
+    }): Promise<GeoJsonFeature | null>;
     /**
      * Gets values from a layer grouped by a given attribute.
      *
@@ -777,6 +913,23 @@ interface LayersController {
      * ```
      */
     getAggregates<T extends AggregationMethod | "count">(params: GetLayerCalculationParams<T>): Promise<Record<T, number | null>>;
+    /**
+     * Get the schema for a layer.
+     *
+     * @remarks
+     * The schema describes the structure of the data in a layer, including the attributes
+     * that are available on the features in the layer.
+     *
+     * This can be useful to build generic UIs that need to know the structure of the data in
+     * a layer, such as a dropdown to choose an attribute.
+     *
+     * @example
+     * ```typescript
+     * const schema = await felt.getLayerSchema("layer-1");
+     * const attributeIds = schema.attributes.map((attr) => attr.id);
+     * ```
+     */
+    getLayerSchema(layerId: string): Promise<LayerSchema>;
 }
 
 /**
@@ -813,8 +966,12 @@ interface InteractionsController {
      * @event
      * @example
      * ```typescript
+     * // Track mouse movement and features under cursor
      * const unsubscribe = felt.onPointerMove({
-     *   handler: (event) => console.log(event.center, event.features),
+     *   handler: (event) => {
+     *     console.log("Mouse position:", event.center);
+     *     console.log("Features under cursor:", event.features);
+     *   }
      * });
      *
      * // later on...
@@ -840,6 +997,16 @@ interface InteractionsController {
 interface MiscController {
     /**
      * Gets the details of the map.
+     *
+     * @example
+     * ```typescript
+     * const details = await felt.getMapDetails();
+     * console.log({
+     *   id: details.id,
+     *   title: details.title,
+     *   description: details.description,
+     * });
+     * ```
      */
     getMapDetails(): Promise<MapDetails>;
 }
@@ -960,10 +1127,10 @@ interface ToolsController {
      * @example
      * ```typescript
      * // Set the tool to "marker"
-     * felt.setTool("marker");
+     * await felt.setTool("marker");
      *
      * // put down the tool
-     * felt.setTool(null);
+     * await felt.setTool(null);
      * ```
      */
     setTool(tool: ToolType | null): void;
@@ -1004,18 +1171,41 @@ interface ToolsController {
     /**
      * Sets the settings for the current tool.
      *
+     * @example
+     * ```typescript
+     * // Set the settings for the marker tool
+     * await felt.setToolSettings({
+     *   tool: "marker",
+     *   color: "#FE17",
+     * });
+     * ```
+     *
      * @param settings - The settings to set.
      */
     setToolSettings(settings: InputToolSettings): void;
     /**
-     * Gets the settings for the current tool.
+     * Gets the settings for the chosen tool
+     *
+     * @example
+     * ```typescript
+     * const settings = await felt.getToolSettings("marker");
+     * ```
      *
-     * @returns The settings for the current tool.
+     * @returns The settings for the chosen tool.
      */
     getToolSettings<T extends ConfigurableToolType>(tool: T): Promise<ToolSettingsMap[T]>;
     /**
      * Listens for changes to the settings on all tools.
      *
+     * @example
+     * ```typescript
+     * const unsubscribe = felt.onToolSettingsChange({
+     *   handler: settings => console.log(settings),
+     * });
+     *
+     * // later on...
+     * unsubscribe();
+     * ```
      * @returns A function to unsubscribe from the listener
      */
     onToolSettingsChange(args: {
@@ -1174,6 +1364,21 @@ interface UiController {
     /**
      * Updates the UI controls on the embedded map.
      *
+     * @example
+     * ```typescript
+     * // Show some UI controls
+     * await felt.updateUiControls({
+     *   showLegend: true,
+     *   fullScreenButton: true,
+     * });
+     *
+     * // Disable some UI options
+     * await felt.updateUiControls({
+     *   cooperativeGestures: false,
+     *   geolocation: false,
+     * });
+     * ```
+     *
      * @param controls - The controls to update.
      */
     updateUiControls(controls: UiControlsOptions): void;
@@ -1187,6 +1392,15 @@ interface UiController {
      *
      * This does not affect selection. That means that selectable features and elements
      * will still be selected when clicked.
+     *
+     * @example
+     * ```typescript
+     * // Disable UI when hovering or selecting features
+     * await felt.setOnMapInteractionsUi({
+     *   featureSelectPanel: false,
+     *   featureHoverPanel: false,
+     * });
+     * ```
      */
     setOnMapInteractionsUi(options: UiOnMapInteractionsOptions): void;
     /**
@@ -1239,6 +1453,16 @@ interface UiController {
 interface ViewportController {
     /**
      * Gets the current state of the viewport.
+     *
+     * @example
+     * ```typescript
+     * // Get current viewport state
+     * const viewport = await felt.getViewport();
+     * console.log({
+     *   center: viewport.center,
+     *   zoom: viewport.zoom,
+     * });
+     * ```
      */
     getViewport(): Promise<ViewportState>;
     /**
@@ -1255,6 +1479,21 @@ interface ViewportController {
     setViewport(viewport: SetViewportCenterZoomParams): void;
     /**
      * Gets the current state of the viewport constraints.
+     *
+     * @example
+     * ```typescript
+     * // Get current viewport constraints
+     * const constraints = await felt.getViewportConstraints();
+     * if (constraints) {
+     *   console.log({
+     *     bounds: constraints.bounds,
+     *     minZoom: constraints.minZoom,
+     *     maxZoom: constraints.maxZoom
+     *   });
+     * } else {
+     *   console.log("No viewport constraints set");
+     * }
+     * ```
      */
     getViewportConstraints(): Promise<ViewportConstraints | null>;
     /**
@@ -1449,17 +1688,17 @@ declare const FeltEmbedOptionsSchema: z.ZodObject<{
         }>;
         zoom: z.ZodNumber;
     }, "strip", z.ZodTypeAny, {
-        zoom: number;
         center: {
             latitude: number;
             longitude: number;
         };
-    }, {
         zoom: number;
+    }, {
         center: {
             latitude: number;
             longitude: number;
         };
+        zoom: number;
     }>>;
 }, "strip", z.ZodTypeAny, {
     origin?: string | undefined;
@@ -1473,11 +1712,11 @@ declare const FeltEmbedOptionsSchema: z.ZodObject<{
         scaleBar?: boolean | undefined;
     } | undefined;
     initialViewport?: {
-        zoom: number;
         center: {
             latitude: number;
             longitude: number;
         };
+        zoom: number;
     } | undefined;
 }, {
     origin?: string | undefined;
@@ -1491,11 +1730,11 @@ declare const FeltEmbedOptionsSchema: z.ZodObject<{
         scaleBar?: boolean | undefined;
     } | undefined;
     initialViewport?: {
-        zoom: number;
         center: {
             latitude: number;
             longitude: number;
         };
+        zoom: number;
     } | undefined;
 }>;
 
@@ -1538,12 +1777,13 @@ declare const FeltEmbedOptionsSchema: z.ZodObject<{
  */
 declare const Felt: {
     /**
-     * Embeds a Felt map into the provided container.
+     * Embeds a Felt map into the provided container, returning a promise that resolves
+     * to a {@link FeltController} object that you can use to control the map.
      *
      * @param container - The container element to embed the map into.
      * @param mapId - The ID of the map to embed.
      * @param options - The options to configure the map.
-     * @returns
+     * @returns A promise for a {@link FeltController}.
      */
     embed(container: HTMLElement, mapId: string, options?: FeltEmbedOptions): Promise<FeltController>;
     /**
@@ -1552,7 +1792,7 @@ declare const Felt: {
      * @param feltWindow - The iframe element containing the Felt map.
      * @returns
      */
-    connect(feltWindow: Window): Promise<FeltController>;
+    connect(feltWindow: Pick<Window, "postMessage">): Promise<FeltController>;
 };
 
-export { AggregationMethod, ConfigurableToolType, Element, ElementChangeCallbackParams, ElementCreate, ElementGroup, ElementGroupChangeCallbackParams, ElementUpdate, type ElementsController, EntityNode, Feature, FeatureSelection, Felt, type FeltController, type FeltEmbedOptions, Filters, Geometry, GetElementGroupsConstraint, GetElementsConstraint, GetLayerCalculationParams, GetLayerCategoriesGroup, GetLayerCategoriesParams, GetLayerGroupsConstraint, GetLayerHistogramBin, GetLayerHistogramParams, GetLayersConstraint, GetRenderedFeaturesConstraint, InputToolSettings, type InteractionsController, Layer, LayerChangeCallbackParams, LayerFilters, LayerGroup, LayerGroupChangeCallbackParams, type LayersController, LegendItem, LegendItemChangeCallbackParams, LegendItemIdentifier, LegendItemsConstraint, MapDetails, MapInteractionEvent, type MiscController, type UiOnMapInteractionsOptions as OnMapInteractionsOptions, type SelectionController, SetViewportCenterZoomParams, SetVisibilityRequest, SortConfig, ToolSettingsChangeEvent, ToolSettingsMap, ToolType, type ToolsController, type UiController, type UiControlsOptions, ViewportCenterZoom, ViewportConstraints, type ViewportController, ViewportFitBoundsParams, ViewportState };
+export { AggregationMethod, ConfigurableToolType, CreateLayersFromGeoJsonParams, Element, ElementChangeCallbackParams, ElementCreate, ElementGroup, ElementGroupChangeCallbackParams, ElementUpdate, type ElementsController, EntityNode, FeatureSelection, Felt, type FeltController, type FeltEmbedOptions, Filters, GeoJsonFeature, GeoJsonGeometry, GetElementGroupsConstraint, GetElementsConstraint, GetLayerCalculationParams, GetLayerCategoriesGroup, GetLayerCategoriesParams, GetLayerGroupsConstraint, GetLayerHistogramBin, GetLayerHistogramParams, GetLayersConstraint, GetRenderedFeaturesConstraint, InputToolSettings, type InteractionsController, Layer, LayerChangeCallbackParams, LayerFeature, LayerFilters, LayerGroup, LayerGroupChangeCallbackParams, LayerSchema, type LayersController, LegendItem, LegendItemChangeCallbackParams, LegendItemIdentifier, LegendItemsConstraint, MapDetails, MapInteractionEvent, type MiscController, type UiOnMapInteractionsOptions as OnMapInteractionsOptions, type SelectionController, SetViewportCenterZoomParams, SetVisibilityRequest, SortConfig, ToolSettingsChangeEvent, ToolSettingsMap, ToolType, type ToolsController, type UiController, type UiControlsOptions, UpdateLayerParams, ViewportCenterZoom, ViewportConstraints, type ViewportController, ViewportFitBoundsParams, ViewportState };