@esri/hub-common 14.52.0 → 14.53.0

package/dist/esm/core/types/Metrics.js

@@ -10,4 +10,14 @@ export var ExpressionRelationships;
     // deprecated and not currently allowed for new use, only used for migrating older stat cards
     ExpressionRelationships["LIKE"] = "like";
 })(ExpressionRelationships || (ExpressionRelationships = {}));
+/**
+ * Types of states of visibility a metric can be in
+ * featured, visible, or hidden
+ */
+export var MetricVisibility;
+(function (MetricVisibility) {
+    MetricVisibility["visible"] = "visible";
+    MetricVisibility["hidden"] = "hidden";
+    MetricVisibility["featured"] = "featured";
+})(MetricVisibility || (MetricVisibility = {}));
 //# sourceMappingURL=Metrics.js.map

package/dist/esm/core/types/Metrics.js.map

@@ -1 +1 @@
-{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../../../src/core/types/Metrics.ts"],"names":[],"mappings":"AA4MA;;;;GAIG;AACH,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,mDAAwB,CAAA;IAExB,6FAA6F;IAC7F,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC"}
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../../../src/core/types/Metrics.ts"],"names":[],"mappings":"AA4MA;;;;GAIG;AACH,MAAM,CAAN,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,mDAAwB,CAAA;IAExB,6FAA6F;IAC7F,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,KAAvB,uBAAuB,QAMlC;AAYD;;;GAGG;AACH,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;IACjB,yCAAqB,CAAA;AACvB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B"}

package/dist/node/core/types/Metrics.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExpressionRelationships = void 0;
+exports.MetricVisibility = exports.ExpressionRelationships = void 0;
 /**
  * Possible relationships for an expression
  * BETWEEN -- used to show between two values, i.e. 7 < x < 10
@@ -13,4 +13,14 @@ var ExpressionRelationships;
     // deprecated and not currently allowed for new use, only used for migrating older stat cards
     ExpressionRelationships["LIKE"] = "like";
 })(ExpressionRelationships = exports.ExpressionRelationships || (exports.ExpressionRelationships = {}));
+/**
+ * Types of states of visibility a metric can be in
+ * featured, visible, or hidden
+ */
+var MetricVisibility;
+(function (MetricVisibility) {
+    MetricVisibility["visible"] = "visible";
+    MetricVisibility["hidden"] = "hidden";
+    MetricVisibility["featured"] = "featured";
+})(MetricVisibility = exports.MetricVisibility || (exports.MetricVisibility = {}));
 //# sourceMappingURL=Metrics.js.map

package/dist/node/core/types/Metrics.js.map

@@ -1 +1 @@
-{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../../../src/core/types/Metrics.ts"],"names":[],"mappings":";;;AA4MA;;;;GAIG;AACH,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,mDAAwB,CAAA;IAExB,6FAA6F;IAC7F,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMlC"}
+{"version":3,"file":"Metrics.js","sourceRoot":"","sources":["../../../../src/core/types/Metrics.ts"],"names":[],"mappings":";;;AA4MA;;;;GAIG;AACH,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,mDAAwB,CAAA;IAExB,6FAA6F;IAC7F,wCAAa,CAAA;AACf,CAAC,EANW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAMlC;AAYD;;;GAGG;AACH,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;IACjB,yCAAqB,CAAA;AACvB,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B"}

package/dist/types/core/types/Metrics.d.ts

@@ -198,21 +198,33 @@ export declare enum ExpressionRelationships {
     LIKE = "like"
 }
 /**
- * Configuration for how to show a metric in the ui
+ * Configuration for how to show a metric in the ui. These are just values that are important to how to
+ * display the metric; values that are configured in the editor should be added to IMetricEditorValues instead.
  */
-export interface IMetricDisplayConfig {
+export interface IMetricDisplayConfig extends IMetricEditorValues {
     metricId: string;
     displayType: string;
-    [key: string]: any;
+    visibility?: MetricVisibility;
 }
 /**
- * Editor values expected when editing a metric
+ * Types of states of visibility a metric can be in
+ * featured, visible, or hidden
  */
-export interface IMetricEditorValues extends IMetricDisplayConfig {
+export declare enum MetricVisibility {
+    visible = "visible",
+    hidden = "hidden",
+    featured = "featured"
+}
+/**
+ * Editor values expected when editing a metric. These are options that are set in the metric editor that
+ * help build the IMetricDisplayConfig.
+ */
+export interface IMetricEditorValues {
     /** the main value of the metric  */
     value?: string | number;
     /** all values related to constructing a service-query metric */
     dynamicMetric?: IDynamicMetricValues;
+    [key: string]: any;
 }
 /**
  * Editor values associated with editing a dynamic metric

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "14.52.0",
+  "version": "14.53.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",