@esri/hub-common 14.47.0 → 14.48.1

package/dist/types/core/schemas/internal/metrics/editorToMetric.d.ts

@@ -0,0 +1,26 @@
+import { IMetric, IMetricDisplayConfig, IEntityInfo, IExpression, IMetricEditorValues } from "../../../types/Metrics";
+/**
+ * Transforms the IConfigurationValues into an object with IMetric and IMetricDisplayConfig to be saved on an entity or rendered in the ui.
+ * @param values IConfigurationValues for the arcgis-hub-metric-card to use
+ * @param metricId what should be the id of the transformed metric
+ * @param entityInfo what should be the entityInfo of the transformed metric
+ * @returns IMetricCardParams
+ */
+export declare function editorToMetric(values: IMetricEditorValues, metricId: string, opts?: {
+    metricName?: string;
+    entityInfo?: IEntityInfo;
+}): {
+    metric: IMetric;
+    displayConfig: IMetricDisplayConfig;
+};
+/**
+ * Constructs a where clause from a given expression set.
+ *
+ * @param {Array} fields the available fields for a given dataset
+ * @param {Object} values the selected values
+ *
+ * @returns {string} returns a string for the where clause query
+ *
+ * NOTE: currently returns string as a MATCH and everything else as BETWEEN
+ */
+export declare function buildWhereClause(expressionSet?: IExpression[]): string;

package/dist/types/core/schemas/internal/metrics/metricToEditor.d.ts

@@ -0,0 +1,8 @@
+import { IMetric, IMetricDisplayConfig, IMetricEditorValues } from "../../../types/Metrics";
+/**
+ * Util to convert a metric into editor values consumable by the configuration editor
+ * @param metric - IMetric metric
+ * @param displayConfig - display configuration for the metric
+ * @returns
+ */
+export declare function metricToEditor(metric: IMetric, displayConfig: IMetricDisplayConfig): IMetricEditorValues;

package/dist/types/core/schemas/internal/metrics/setMetricAndDisplay.d.ts

@@ -0,0 +1,13 @@
+import { IHubProject } from "../../../types/IHubProject";
+import { IMetric, IMetricDisplayConfig } from "../../../types/Metrics";
+/**
+ * Sets a given metric and metricDisplayConfig on an entity's metric and view.metricDisplays props.
+ *
+ * @param entity - should have metric and metricDisplays implemented
+ * @param metric - IMetric
+ * @param displayConfig - IMetricDisplayConfig configuration to display the metric in the ui
+ *
+ * Right now, this just accepts a HubProject; in the future as more entities support metrics,
+ * other entities can be allowed.
+ */
+export declare function setMetricAndDisplay(entity: IHubProject, metric: IMetric, displayConfig: IMetricDisplayConfig): IHubProject;

package/dist/types/core/schemas/shared/enums.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Alignment values allowed for a display
+ *
+ * values = start | center | end
+ */
+export declare enum ALIGNMENTS {
+    start = "start",
+    center = "center",
+    end = "end"
+}
+/**
+ * Corner values allowed for a display
+ *
+ * values = square | round
+ */
+export declare enum CORNERS {
+    square = "square",
+    round = "round"
+}
+/**
+ * Drop shadow values allowed for a display
+ *
+ * values = none | low | medium | heavy
+ */
+export declare enum DROP_SHADOWS {
+    none = "none",
+    low = "low",
+    medium = "medium",
+    heavy = "heavy"
+}

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

@@ -9,7 +9,7 @@ export interface IEditorConfig {
  * to the supported/defined uiSchema configurations
  */
 export declare type EntityEditorType = (typeof validEntityEditorTypes)[number];
-export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:initiativeTemplate:edit"];
+export declare const validEntityEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:initiativeTemplate:edit"];
 /** Defines the possible editor type values for a stat card. These
  * correspond to the supported/defined uiSchema configurations. This should
  * have its own signature in the getEditorConfig function.
@@ -27,7 +27,7 @@ export declare const validCardEditorTypes: readonly ["hub:card:stat"];
  * to defined schema/uiSchema configurations
  */
 export declare type EditorType = (typeof validEditorTypes)[number];
-export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:initiativeTemplate:edit", "hub:card:stat"];
+export declare const validEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics", "hub:content:edit", "hub:content:settings", "hub:content:discussions", "hub:initiative:edit", "hub:initiative:create", "hub:site:edit", "hub:site:create", "hub:site:followers", "hub:site:discussions", "hub:site:settings", "hub:discussion:edit", "hub:discussion:create", "hub:discussion:settings", "hub:page:edit", "hub:template:edit", "hub:group:edit", "hub:group:settings", "hub:group:discussions", "hub:initiativeTemplate:edit", "hub:card:stat"];
 export declare enum UiSchemaRuleEffects {
     SHOW = "SHOW",
     HIDE = "HIDE",
@@ -131,18 +131,3 @@ export interface IUiSchemaCondition {
     scope?: string;
     schema: IConfigurationSchema;
 }
-export declare enum ALIGNMENTS {
-    start = "start",
-    center = "center",
-    end = "end"
-}
-export declare enum CORNERS {
-    square = "square",
-    round = "round"
-}
-export declare enum DROP_SHADOWS {
-    none = "none",
-    low = "low",
-    medium = "medium",
-    heavy = "heavy"
-}

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

@@ -8,4 +8,5 @@ export declare type HubEntityEditor = Record<string, any>;
 export interface IEntityEditorContext {
     collaborationGroupId?: string;
     contentGroupId?: string;
+    metricId?: string;
 }

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

@@ -5,6 +5,7 @@ import { IWithPermissions, IWithViewSettings, IWithDiscussions } from "../traits
 import { IHubLocation } from "./IHubLocation";
 import { IWithFollowers } from "../traits/IWithFollowers";
 import { IWithAssociations } from "../traits/IWithAssociations";
+import { IMetricEditorValues } from "./Metrics";
 /**
  * Properties exposed by Entities that are backed by Items
  */
@@ -122,4 +123,5 @@ export declare type IHubItemEntityEditor<T> = Omit<T, "extent"> & {
         showFollowAction?: boolean;
         isDiscussable?: boolean;
     };
+    _metric?: IMetricEditorValues;
 };

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

@@ -1,8 +1,8 @@
 /// <reference types="arcgis-js-api" />
 import { IQuery } from "../../search/types/IHubCatalog";
-import { IField } from "@esri/arcgis-rest-types";
-import { ServiceAggregation } from "./DynamicValues";
+import { FieldType, IField } from "@esri/arcgis-rest-types";
 import { IReference } from "./IReference";
+import { ServiceAggregation } from "../../core/types/DynamicValues";
 /**
  * Defines the information required from a Metric
  */
@@ -182,6 +182,20 @@ export interface IExpression {
      * A special identifier given to the expression when it is created
      */
     key?: string;
+    /**
+     * Relation between the values in an expression
+     */
+    relationship?: ExpressionRelationships;
+}
+/**
+ * Possible relationships for an expression
+ * BETWEEN -- used to show between two values, i.e. 7 < x < 10
+ * IS_EXACTLY -- for exact matching, i.e. two same strings
+ */
+export declare enum ExpressionRelationships {
+    BETWEEN = "between",
+    IS_EXACTLY = "isExactly",
+    LIKE = "like"
 }
 /**
  * Configuration for how to show a metric in the ui
@@ -191,3 +205,42 @@ export interface IMetricDisplayConfig {
     displayType: string;
     [key: string]: any;
 }
+/**
+ * Editor values expected when editing a metric
+ */
+export interface IMetricEditorValues extends IMetricDisplayConfig {
+    /** the main value of the metric  */
+    value?: string | number;
+    /** all values related to constructing a service-query metric */
+    dynamicMetric?: IDynamicMetricValues;
+}
+/**
+ * Editor values associated with editing a dynamic metric
+ */
+export interface IDynamicMetricValues {
+    /** id of the item being queried */
+    itemId?: string;
+    /** id of the layer of the item being queried */
+    layerId?: number;
+    /** field of the layer of the item being queried to run the aggregation on */
+    field?: string;
+    /** the method of service aggregation -- count, min, max, etc. */
+    statistic?: string;
+    /** the feature service url of the item being queried */
+    serviceUrl?: string;
+    /** the esri-dictated field type of the field being queried */
+    fieldType?: FieldType;
+    /** a clause to filter the query by -- ex: field BETWEEN 0 AND 2 */
+    where?: string;
+    /** the ui navigational link to the item source */
+    sourceLink?: string;
+    /** the text displayed in the ui for the sourceLink */
+    sourceTitle?: string;
+    /** whether attribute filtering should be enabled */
+    allowExpressionSet?: boolean;
+    /** a list of expressions with which to construct a where clause */
+    expressionSet?: IExpression[];
+    /** the old where clause, utilized during the migration of the old summary stat card */
+    legacyWhere?: string;
+    [key: string]: any;
+}

package/dist/types/projects/HubProject.d.ts

@@ -71,7 +71,7 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * @param editor
      * @returns
      */
-    fromEditor(editor: IHubProjectEditor): Promise<IHubProject>;
+    fromEditor(editor: IHubProjectEditor, editorContext?: IEntityEditorContext): Promise<IHubProject>;
     /**
      * Apply a new state to the instance
      * @param changes

package/dist/types/projects/_internal/ProjectSchema.d.ts

@@ -1,6 +1,6 @@
 import { IConfigurationSchema } from "../../core/schemas/types";
 export declare type ProjectEditorType = (typeof ProjectEditorTypes)[number];
-export declare const ProjectEditorTypes: readonly ["hub:project:create", "hub:project:edit"];
+export declare const ProjectEditorTypes: readonly ["hub:project:create", "hub:project:edit", "hub:project:metrics"];
 /**
  * Defines the JSON schema for a Hub Project's editable fields
  */

package/package.json

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