@feltmaps/js-sdk 1.5.0-next.21 → 1.5.0-next.22

package/{types-f_Zc32jS.d.ts → types-CnYUajGG.d.ts}

@@ -4012,8 +4012,16 @@ interface HighlighterElementUpdate extends zInfer<typeof HighlighterUpdateSchema
     coordinates?: LngLatTuple[][][];
 }
 interface TextElementUpdate extends zInfer<typeof TextUpdateSchema> {
+    /**
+     * The geographical position of the center of the text element.
+     */
+    position?: LngLatTuple;
 }
 interface NoteElementUpdate extends zInfer<typeof NoteUpdateSchema> {
+    /**
+     * The geographical position of the center of the note element.
+     */
+    position?: LngLatTuple;
 }
 interface ImageElementUpdate extends zInfer<typeof ImageUpdateSchema> {
 }
@@ -4215,7 +4223,7 @@ declare const LayerProcessingStatusSchema: z.ZodEnum<["processing", "completed",
  */
 interface LayerCommon {
     /**
-     * The string identifying the layer
+     * A string identifying the layer
      */
     id: string;
     /**
@@ -4381,12 +4389,22 @@ declare const GeoJsonUrlVectorSourceSchema: z.ZodObject<{
      * The remote URL of the GeoJSON file used to populate the layer.
      */
     url: z.ZodString;
+    /**
+     * The interval in milliseconds between automatic refreshes of the GeoJSON.
+     *
+     * The value must be in the range of 250ms - 5 minutes (300,000ms).
+     *
+     * If the value is `null`, the GeoJSON will not be refreshed automatically.
+     */
+    refreshInterval: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, "strip", z.ZodTypeAny, {
     type: "geoJsonUrl";
     url: string;
+    refreshInterval?: number | null | undefined;
 }, {
     type: "geoJsonUrl";
     url: string;
+    refreshInterval?: number | null | undefined;
 }>;
 /**
  * A GeoJSON URL source is a layer that is populated from a GeoJSON file at a remote URL.
@@ -4413,6 +4431,8 @@ interface GeoJsonDataVectorSource {
     type: "geoJsonData";
     /**
      * The GeoJSON data for the layer.
+     *
+     * This must be a GeoJSON FeatureCollection.
      */
     data: object;
 }
@@ -4443,6 +4463,144 @@ declare const GeoJsonFileVectorSourceSchema: z.ZodObject<{
  */
 interface GeoJsonFileVectorSource extends zInfer<typeof GeoJsonFileVectorSourceSchema> {
 }
+/**
+ * The parameters for the {@link LayersController.updateLayer} method.
+ */
+declare const UpdateLayerSchema: z.ZodObject<{
+    /**
+     * The id of the layer to update.
+     */
+    id: z.ZodString;
+    style: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    /**
+     * Changes whether the layer is shown in the legend.
+     */
+    shownInLegend: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * Changes the name of the layer.
+     */
+    name: z.ZodOptional<z.ZodString>;
+    /**
+     * Changes the caption of the layer.
+     */
+    caption: z.ZodOptional<z.ZodString>;
+    /**
+     * Changes the description of the layer.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * Changes the bounds of the layer.
+     */
+    bounds: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>>;
+    source: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        /**
+         * Identifies this as a GeoJSON URL source.
+         */
+        type: z.ZodLiteral<"geoJsonUrl">;
+        /**
+         * The remote URL of the GeoJSON file used to populate the layer.
+         */
+        url: z.ZodString;
+        /**
+         * The interval in milliseconds between automatic refreshes of the GeoJSON.
+         *
+         * The value must be in the range of 250ms - 5 minutes (300,000ms).
+         *
+         * If the value is `null`, the GeoJSON will not be refreshed automatically.
+         */
+        refreshInterval: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "geoJsonUrl";
+        url: string;
+        refreshInterval?: number | null | undefined;
+    }, {
+        type: "geoJsonUrl";
+        url: string;
+        refreshInterval?: number | null | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"geoJsonData">;
+        data: z.ZodUnion<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, z.ZodType<ArrayBuffer, z.ZodTypeDef, ArrayBuffer>]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectOutputType<{}, z.ZodTypeAny, "passthrough">;
+    }, {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectInputType<{}, z.ZodTypeAny, "passthrough">;
+    }>, z.ZodObject<{
+        /**
+         * Identifies this as a GeoJSON file source.
+         */
+        type: z.ZodLiteral<"geoJsonFile">;
+        /**
+         * The GeoJSON file for the layer.
+         */
+        file: z.ZodType<File, z.ZodTypeDef, File>;
+    }, "strip", z.ZodTypeAny, {
+        type: "geoJsonFile";
+        file: File;
+    }, {
+        type: "geoJsonFile";
+        file: File;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name?: string | undefined;
+    description?: string | undefined;
+    style?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    source?: {
+        type: "geoJsonUrl";
+        url: string;
+        refreshInterval?: number | null | undefined;
+    } | {
+        type: "geoJsonFile";
+        file: File;
+    } | {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectOutputType<{}, z.ZodTypeAny, "passthrough">;
+    } | undefined;
+    bounds?: [number, number, number, number] | undefined;
+    caption?: string | undefined;
+    shownInLegend?: boolean | undefined;
+}, {
+    id: string;
+    name?: string | undefined;
+    description?: string | undefined;
+    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    source?: {
+        type: "geoJsonUrl";
+        url: string;
+        refreshInterval?: number | null | undefined;
+    } | {
+        type: "geoJsonFile";
+        file: File;
+    } | {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectInputType<{}, z.ZodTypeAny, "passthrough">;
+    } | undefined;
+    bounds?: [number, number, number, number] | undefined;
+    caption?: string | undefined;
+    shownInLegend?: boolean | undefined;
+}>;
+/**
+ * The value you need to pass to {@link LayersController.updateLayer}
+ *
+ * @group Layers
+ */
+interface UpdateLayerParams extends Omit<zInfer<typeof UpdateLayerSchema>, "style" | "source"> {
+    /**
+     * The style of the layer.
+     */
+    style?: object;
+    /**
+     * Updates the source of the layer.
+     *
+     * Only layers that have a GeoJSON source can have their source udpated.
+     *
+     * For URL sources, if you pass the same URL again it will cause the data to be
+     * refreshed.
+     */
+    source?: GeoJsonUrlVectorSource | GeoJsonDataVectorSource | GeoJsonFileVectorSource;
+}
 /**
  * A data-only layer doesn't have any geometry, but can be used to join with other layers
  *
@@ -4916,25 +5074,31 @@ declare const CreateLayersFromGeoJsonSchema: z.ZodObject<{
          * The remote URL of the GeoJSON file used to populate the layer.
          */
         url: z.ZodString;
+        /**
+         * The interval in milliseconds between automatic refreshes of the GeoJSON.
+         *
+         * The value must be in the range of 250ms - 5 minutes (300,000ms).
+         *
+         * If the value is `null`, the GeoJSON will not be refreshed automatically.
+         */
+        refreshInterval: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     }, "strip", z.ZodTypeAny, {
         type: "geoJsonUrl";
         url: string;
+        refreshInterval?: number | null | undefined;
     }, {
         type: "geoJsonUrl";
         url: string;
+        refreshInterval?: number | null | undefined;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"geoJsonData">;
-        data: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+        data: z.ZodUnion<[z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, z.ZodType<ArrayBuffer, z.ZodTypeDef, ArrayBuffer>]>;
     }, "strip", z.ZodTypeAny, {
         type: "geoJsonData";
-        data: {} & {
-            [k: string]: unknown;
-        };
+        data: ArrayBuffer | z.objectOutputType<{}, z.ZodTypeAny, "passthrough">;
     }, {
         type: "geoJsonData";
-        data: {} & {
-            [k: string]: unknown;
-        };
+        data: ArrayBuffer | z.objectInputType<{}, z.ZodTypeAny, "passthrough">;
     }>, z.ZodObject<{
         /**
          * Identifies this as a GeoJSON file source.
@@ -4955,6 +5119,21 @@ declare const CreateLayersFromGeoJsonSchema: z.ZodObject<{
      * The name of the layer to create.
      */
     name: z.ZodString;
+    /**
+     * Sets the bounds of the layer.
+     */
+    bounds: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>>;
+    /**
+     * Sets the caption of the layer.
+     */
+    caption: z.ZodOptional<z.ZodString>;
+    /**
+     * Sets the description of the layer.
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * Sets the styles to apply to each geometry on the layer.
+     */
     geometryStyles: z.ZodOptional<z.ZodObject<{
         Point: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
         Line: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
@@ -4973,15 +5152,17 @@ declare const CreateLayersFromGeoJsonSchema: z.ZodObject<{
     source: {
         type: "geoJsonUrl";
         url: string;
-    } | {
-        type: "geoJsonData";
-        data: {} & {
-            [k: string]: unknown;
-        };
+        refreshInterval?: number | null | undefined;
     } | {
         type: "geoJsonFile";
         file: File;
+    } | {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectOutputType<{}, z.ZodTypeAny, "passthrough">;
     };
+    description?: string | undefined;
+    bounds?: [number, number, number, number] | undefined;
+    caption?: string | undefined;
     geometryStyles?: {
         Point?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
         Polygon?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
@@ -4992,15 +5173,17 @@ declare const CreateLayersFromGeoJsonSchema: z.ZodObject<{
     source: {
         type: "geoJsonUrl";
         url: string;
-    } | {
-        type: "geoJsonData";
-        data: {} & {
-            [k: string]: unknown;
-        };
+        refreshInterval?: number | null | undefined;
     } | {
         type: "geoJsonFile";
         file: File;
+    } | {
+        type: "geoJsonData";
+        data: ArrayBuffer | z.objectInputType<{}, z.ZodTypeAny, "passthrough">;
     };
+    description?: string | undefined;
+    bounds?: [number, number, number, number] | undefined;
+    caption?: string | undefined;
     geometryStyles?: {
         Point?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
         Polygon?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
@@ -6471,4 +6654,4 @@ declare const ViewportFitBoundsParamsSchema: z.ZodObject<{
     bounds: [number, number, number, number];
 }>;
 
-export type { HighlighterElementRead as $, AggregationMethod as A, MapDetails as B, CreateLayersFromGeoJsonParams as C, EntityNode as D, Element as E, Filters as F, GeoJsonGeometry as G, FeatureSelection as H, InputToolSettings as I, ConfigurableToolType as J, ToolSettingsMap as K, Layer as L, MapInteractionEvent as M, ToolSettingsChangeEvent as N, zInfer as O, SortConfig as P, SetViewportCenterZoomParams as Q, ViewportConstraints as R, SetVisibilityRequest as S, ToolType as T, ViewportFitBoundsParams as U, ViewportState as V, ViewportCenterZoom as W, CircleElementCreate as X, CircleElementRead as Y, CircleElementUpdate as Z, HighlighterElementCreate as _, GetElementsConstraint as a, PointGeometry as a$, HighlighterElementUpdate as a0, ImageElementCreate as a1, ImageElementRead as a2, ImageElementUpdate as a3, LinkElementRead as a4, MarkerElementCreate as a5, MarkerElementRead as a6, MarkerElementUpdate as a7, NoteElementCreate as a8, NoteElementRead as a9, LayerSchemaBooleanAttribute as aA, LayerSchemaCommonAttribute as aB, LayerSchemaDateAttribute as aC, LayerSchemaDateTimeAttribute as aD, LayerSchemaNumericAttribute as aE, LayerSchemaTextAttribute as aF, FilterExpression as aG, FilterLogicGate as aH, FilterTernary as aI, AggregationConfig as aJ, GeometryFilter as aK, MultiAggregationConfig as aL, ValueConfiguration as aM, ElementGroupNode as aN, ElementNode as aO, FeatureNode as aP, LayerGroupNode as aQ, LayerNode as aR, FeltBoundary as aS, FeltZoom as aT, GeoJsonProperties as aU, LatLng as aV, LineStringGeometry as aW, LngLatTuple as aX, MultiLineStringGeometry as aY, MultiPointGeometry as aZ, MultiPolygonGeometry as a_, NoteElementUpdate as aa, PathElementCreate as ab, PathElementRead as ac, PathElementUpdate as ad, PlaceElementCreate as ae, PlaceElementRead as af, PlaceElementUpdate as ag, PolygonElementCreate as ah, PolygonElementRead as ai, PolygonElementUpdate as aj, TextElementCreate as ak, TextElementRead as al, TextElementUpdate as am, DataOnlyLayer as an, FeltTiledVectorSource as ao, GeoJsonDataVectorSource as ap, GeoJsonFileVectorSource as aq, GeoJsonUrlVectorSource as ar, LayerCommon as as, LayerProcessingStatus as at, RasterBand as au, RasterLayer as av, RasterLayerSource as aw, RasterValue as ax, VectorLayer as ay, LayerSchemaAttribute as az, ElementGroup as b, PolygonGeometry as b0, SortDirection as b1, CircleToolSettings as b2, HighlighterToolSettings as b3, LineToolSettings as b4, MarkerToolSettings as b5, NoteToolSettings as b6, PinToolSettings as b7, PlaceFrame as b8, PlaceSymbol as b9, PolygonToolSettings as ba, RouteToolSettings as bb, TextToolSettings as bc, UnionToIntersection as bd, PromiseOrNot as be, GetElementGroupsConstraint as c, ElementChangeCallbackParams as d, ElementGroupChangeCallbackParams as e, ElementCreate as f, ElementUpdate as g, GetLayersConstraint as h, LayerChangeCallbackParams as i, LayerGroup as j, GetLayerGroupsConstraint as k, LayerGroupChangeCallbackParams as l, LegendItemIdentifier as m, LegendItem as n, LegendItemsConstraint as o, LegendItemChangeCallbackParams as p, LayerFilters as q, GetRenderedFeaturesConstraint as r, LayerFeature as s, GeoJsonFeature as t, GetLayerCategoriesParams as u, GetLayerCategoriesGroup as v, GetLayerHistogramParams as w, GetLayerHistogramBin as x, GetLayerCalculationParams as y, LayerSchema as z };
+export type { HighlighterElementCreate as $, AggregationMethod as A, MapDetails as B, CreateLayersFromGeoJsonParams as C, EntityNode as D, Element as E, Filters as F, GeoJsonGeometry as G, FeatureSelection as H, InputToolSettings as I, ConfigurableToolType as J, ToolSettingsMap as K, Layer as L, MapInteractionEvent as M, ToolSettingsChangeEvent as N, zInfer as O, SortConfig as P, SetViewportCenterZoomParams as Q, ViewportConstraints as R, SetVisibilityRequest as S, ToolType as T, UpdateLayerParams as U, ViewportState as V, ViewportFitBoundsParams as W, ViewportCenterZoom as X, CircleElementCreate as Y, CircleElementRead as Z, CircleElementUpdate as _, GetElementsConstraint as a, MultiPolygonGeometry as a$, HighlighterElementRead as a0, HighlighterElementUpdate as a1, ImageElementCreate as a2, ImageElementRead as a3, ImageElementUpdate as a4, LinkElementRead as a5, MarkerElementCreate as a6, MarkerElementRead as a7, MarkerElementUpdate as a8, NoteElementCreate as a9, LayerSchemaAttribute as aA, LayerSchemaBooleanAttribute as aB, LayerSchemaCommonAttribute as aC, LayerSchemaDateAttribute as aD, LayerSchemaDateTimeAttribute as aE, LayerSchemaNumericAttribute as aF, LayerSchemaTextAttribute as aG, FilterExpression as aH, FilterLogicGate as aI, FilterTernary as aJ, AggregationConfig as aK, GeometryFilter as aL, MultiAggregationConfig as aM, ValueConfiguration as aN, ElementGroupNode as aO, ElementNode as aP, FeatureNode as aQ, LayerGroupNode as aR, LayerNode as aS, FeltBoundary as aT, FeltZoom as aU, GeoJsonProperties as aV, LatLng as aW, LineStringGeometry as aX, LngLatTuple as aY, MultiLineStringGeometry as aZ, MultiPointGeometry as a_, NoteElementRead as aa, NoteElementUpdate as ab, PathElementCreate as ac, PathElementRead as ad, PathElementUpdate as ae, PlaceElementCreate as af, PlaceElementRead as ag, PlaceElementUpdate as ah, PolygonElementCreate as ai, PolygonElementRead as aj, PolygonElementUpdate as ak, TextElementCreate as al, TextElementRead as am, TextElementUpdate as an, DataOnlyLayer as ao, FeltTiledVectorSource as ap, GeoJsonDataVectorSource as aq, GeoJsonFileVectorSource as ar, GeoJsonUrlVectorSource as as, LayerCommon as at, LayerProcessingStatus as au, RasterBand as av, RasterLayer as aw, RasterLayerSource as ax, RasterValue as ay, VectorLayer as az, ElementGroup as b, PointGeometry as b0, PolygonGeometry as b1, SortDirection as b2, CircleToolSettings as b3, HighlighterToolSettings as b4, LineToolSettings as b5, MarkerToolSettings as b6, NoteToolSettings as b7, PinToolSettings as b8, PlaceFrame as b9, PlaceSymbol as ba, PolygonToolSettings as bb, RouteToolSettings as bc, TextToolSettings as bd, UnionToIntersection as be, PromiseOrNot as bf, GetElementGroupsConstraint as c, ElementChangeCallbackParams as d, ElementGroupChangeCallbackParams as e, ElementCreate as f, ElementUpdate as g, GetLayersConstraint as h, LayerChangeCallbackParams as i, LayerGroup as j, GetLayerGroupsConstraint as k, LayerGroupChangeCallbackParams as l, LegendItemIdentifier as m, LegendItem as n, LegendItemsConstraint as o, LegendItemChangeCallbackParams as p, LayerFilters as q, GetRenderedFeaturesConstraint as r, LayerFeature as s, GeoJsonFeature as t, GetLayerCategoriesParams as u, GetLayerCategoriesGroup as v, GetLayerHistogramParams as w, GetLayerHistogramBin as x, GetLayerCalculationParams as y, LayerSchema as z };