@meridian/web-sdk - npm Package Compare versions

Comparing version 1.17.2 to 1.18.0

dist/src/MapComponent.d.ts

@@ -52,2 +52,3 @@ /** @jsx h */
         onFloorChange: () => void;
+        onLoadingStateChange: () => void;
         onFloorsUpdate: () => void;
@@ -57,2 +58,3 @@ };
     isMounted: boolean;
+    isLoaded: boolean;
     fetchAllTagsTimeout: any;
@@ -59,0 +61,0 @@ fetchAllTagsInitialized: boolean;

dist/src/web-sdk.d.ts

@@ -153,10 +153,10 @@ /** @jsx h */
 export interface CreateMapTagsOptions {
-    /** Should we show control tags? Defaults to false. */
+    /** Should we show control tags? Defaults to `false`. */
     showControlTags?: boolean;
     /**
-     * Filter function used to hide tags. Return false to hide a tag. Defaults
+     * Filter function used to hide tags. Return `false` to hide a tag. Defaults
      * to `() => true`.
      */
     filter?: (tag: TagData) => boolean;
-    /** Disable clicking tags when true. Defaults to false. */
+    /** Disable clicking tags when `true`. Defaults to `false`. */
     disabled?: boolean;
@@ -167,10 +167,10 @@ /** Update interval in milliseconds, defaults to 5000 */
 export interface CreateMapPlacemarksOptions {
-    /** Should we show hidden placemarks? Defaults to false. */
+    /** Should we show hidden placemarks? Defaults to `false`. */
     showHiddenPlacemarks?: boolean;
     /**
-     * Filter function used to hide placemarks. Return false to hide a
+     * Filter function used to hide placemarks. Return `false` to hide a
      * placemark. Defaults to `() => true`.
      */
     filter?: (placemark: PlacemarkData) => boolean;
-    /** Disable clicking placemarks when true. Defaults to false. */
+    /** Disable clicking placemarks when `true`. Defaults to `false`. */
     disabled?: boolean;
@@ -190,6 +190,17 @@ /**
 /**
- * Object describing a polygon overlay drawn on the map
+ * Object describing an SVG `<polygon>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/polygon>
  */
 export interface CustomOverlayPolygon {
     type: "polygon";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
     points: number[];
@@ -204,6 +215,6 @@ fill?: string;
     strokeOpacity?: number | string;
+    markerStart: string;
+    markerMid: string;
+    markerEnd: string;
     animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
-    style?: h.JSX.CSSProperties;
-    id?: string;
-    className?: string;
     /** Arbitrary data for use with onClick handler */
@@ -214,6 +225,17 @@ data?: Record<string, any>;
 /**
- * Object describing a polyline overlay drawn on the map
+ * Object describing an SVG `<polyline>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/polyline>
  */
 export interface CustomOverlayPolyline {
     type: "polyline";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
     points: number[];
@@ -229,12 +251,23 @@ fill?: string;
     strokeOpacity?: number | string;
+    markerStart: string;
+    markerMid: string;
+    markerEnd: string;
     animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
-    style?: h.JSX.CSSProperties;
-    id?: string;
-    className?: string;
 }
 /**
- * Object describing a SVG path drawn on the map
+ * Object describing an SVG `<path>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/path>
  */
 export interface CustomOverlayPath {
     type: "path";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
     shape: string;
@@ -249,14 +282,25 @@ fill?: string;
     strokeOpacity?: number | string;
+    markerStart: string;
+    markerMid: string;
+    markerEnd: string;
+    animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
     animateMotion?: h.JSX.SVGAttributes<SVGAnimateMotionElement>;
-    animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
     mpath?: SVGMPathElement;
-    style?: h.JSX.CSSProperties;
-    id?: string;
-    className?: string;
 }
 /**
- * Object describing a SVG circle drawn on the map
+ * Object describing an SVG `<circle>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/circle>
  */
 export interface CustomOverlayCircle {
     type: "circle";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
     cx: string;
@@ -275,8 +319,5 @@ cy: string;
     strokeOpacity?: number | string;
+    animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
     animateMotion?: h.JSX.SVGAttributes<SVGAnimateMotionElement>;
-    animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
     mpath?: SVGMPathElement;
-    style?: h.JSX.CSSProperties;
-    id?: string;
-    className?: string;
     /** Arbitrary data for use with onClick handler */
@@ -287,6 +328,17 @@ data?: Record<string, any>;
 /**
- * Object describing a SVG image drawn on the map
+ * Object describing an SVG `<image>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/image>
  */
 export interface CustomOverlayImage {
     type: "image";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
     x?: number;
@@ -300,5 +352,2 @@ y?: number;
     mpath?: SVGMPathElement;
-    style?: h.JSX.CSSProperties;
-    id?: string;
-    className?: string;
     /** Arbitrary data for use with onClick handler */
@@ -309,5 +358,72 @@ data?: Record<string, any>;
 /**
+ * Object describing an SVG `<marker>` element drawn on the map
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/marker>
+ */
+export interface CustomOverlayMarker {
+    type: "marker";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
+    viewBox: string;
+    refX: string;
+    refY: string;
+    markerWidth: number;
+    markerHeight: number;
+    orient: string;
+    fill?: string;
+    fillOpacity?: number | string;
+    stroke?: string;
+    strokeWidth?: number;
+    strokeLineJoin?: "miter" | "round";
+    strokeLineCap?: "butt" | "round" | "square";
+    strokeDasharray?: string | number;
+    strokeDashoffset?: string | number;
+    strokeOpacity?: number | string;
+    shapeElementType: "circle" | "polygon" | "polyline" | "path" | "image";
+    shapeElementAttributes: Record<string, any>;
+}
+/**
+ * Object describing an SVG `<use>` element drawn on the map.
+ *
+ * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use>
+ */
+export interface CustomOverlayUse {
+    type: "use";
+    /**
+     * `true` will result in the element being wrapped in a `<defs>` (default: `false`)
+     *
+     * <https://developer.mozilla.org/en-US/docs/Web/SVG/Element/defs>
+     */
+    defs?: boolean;
+    id?: string;
+    className?: string;
+    style?: h.JSX.CSSProperties;
+    x?: number;
+    y?: number;
+    width: number;
+    height: number;
+    href: string;
+    fill?: string;
+    stroke?: string;
+    strokeWidth?: number;
+    strokeLineJoin?: "miter" | "round";
+    strokeLineCap?: "butt" | "round" | "square";
+    strokeDasharray?: string | number;
+    strokeDashoffset?: string | number;
+    strokeOpacity?: number | string;
+    animate?: h.JSX.SVGAttributes<SVGAnimateElement>;
+    animateMotion?: h.JSX.SVGAttributes<SVGAnimateMotionElement>;
+    mpath?: SVGMPathElement;
+}
+/**
  * Object describing a custom overlay
  */
-export type CustomOverlay = CustomOverlayImage | CustomOverlayPath | CustomOverlayPolygon | CustomOverlayPolyline | CustomOverlayCircle;
+export type CustomOverlay = CustomOverlayImage | CustomOverlayPath | CustomOverlayPolygon | CustomOverlayPolyline | CustomOverlayCircle | CustomOverlayMarker | CustomOverlayUse;
 /**
@@ -349,11 +465,11 @@ * Object describing a point annotation drawn on the map
     api?: API;
-    /** Should we show the floor switcher UI control? Defaults to true. */
+    /** Should we show the floor switcher UI control? Defaults to `true`. */
     showFloorsControl?: boolean;
-    /** Should we show the Search UI control? Defaults to true. */
+    /** Should we show the Search UI control? Defaults to `true`. */
     showSearchControl?: boolean;
-    /** Set to false to disable loading tags (default: true) */
+    /** Set to `false` to disable loading tags (default: `true`) */
     loadTags?: boolean;
     /** Options related to tags. */
     tags?: CreateMapTagsOptions;
-    /** Set to false to disable loading placemarks (default: true) */
+    /** Set to `false` to disable loading placemarks (default: `true`) */
     loadPlacemarks?: boolean;
@@ -413,10 +529,14 @@ /** Options related to placemarks. */
     /**
-     * Called with an array of floors after the floors list is updated.
+     * Called after the floors list is updated.
      */
     onFloorsUpdate?: (floors: FloorData[]) => void;
     /**
-     * Called with a floor object when the floor is changed.
+     * Called after the floor is changed.
      */
     onFloorChange?: (floor: FloorData) => void;
     /**
+     * Called when the loading state changes.
+     */
+    onLoadingStateChange?: (isLoading: boolean) => void;
+    /**
      * Called when the map has been destroyed, either by manually calling
@@ -423,0 +543,0 @@ * map.destroy() or by being automatically destroyed when its DOM is tampered

package.json

 {
   "name": "@meridian/web-sdk",
   "private": false,
-  "version": "1.17.2",
+  "version": "1.18.0",
   "description": "Web SDK for showing Aruba Meridian maps, tags, and more",
@@ -6,0 +6,0 @@ "main": "./dist/web-sdk.js",

No alert changes

Improved metrics

Total package byte prevSize

507681

increased by2.66%

Number of package files

129

increased by1.57%

Lines of code

1624

increased by9.14%

No dependency changes