@esri/hub-common 12.29.0 → 12.30.1

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

@@ -0,0 +1,159 @@
+/// <reference types="arcgis-js-api" />
+import { IQuery } from "../../search/types/IHubCatalog";
+import { ServiceAggregation } from "./DynamicValues";
+import { IReference } from "./IReference";
+/**
+ * Defines the information required from a Metric
+ */
+export interface IMetric {
+    /**
+     * Identifier for the metric. This must be static over time or linkages
+     * between items will break. Can be the camelCase version of the name
+     * as long as it's a valid Javascript property name (can't start with numbers).
+     */
+    id: string;
+    /**
+     * Name of the metric. Will be shown in UI's
+     */
+    name?: string;
+    /**
+     * Description of the metric. Will be shown in UI when user is configuring
+     * the value or source of the value
+     */
+    description?: string;
+    /**
+     * Unit of the value. In the future this will be a list of well-known units
+     */
+    units?: string;
+    /**
+     * Source definition. This can be an `IReference` to another metric to enable
+     * re-use of the same metric source for multiple metrics.
+     */
+    source: MetricSource | IReference;
+    /**
+     * Information about the source entity that will be attached to the `IMetricFeature` when it's resolved.
+     * This will be added to the `IMetric` as it's processed.
+     */
+    entityInfo?: IEntityInfo;
+}
+/**
+ * Basic information about the source of the metric, that will be added to the `IMetricFeature` when it's resolved
+ */
+export interface IEntityInfo {
+    /**
+     * The id of the entity from which the Metric was computed
+     */
+    id: string;
+    /**
+     * Name of the entity from which the value was computed
+     */
+    name: string;
+    /**
+     * The type of entity from which the value was computed
+     */
+    type: string;
+}
+/**
+ * Defines a query to a service
+ */
+export interface IServiceQuery {
+    /**
+     * Feature Service Url
+     */
+    serviceUrl: string;
+    /**
+     * Layer Id
+     */
+    layerId: number;
+    /**
+     * Field to run stats on
+     */
+    field: string;
+    /**
+     * Statistic to run on the field
+     */
+    statistic: ServiceAggregation;
+    /**
+     * Optional where clause to filter the query
+     */
+    where?: string;
+    /**
+     * NOT IMPLEMENTED: Optional set of fields to group by.
+     */
+    groupBy?: {
+        fields: string[];
+        having: string;
+    };
+    /**
+     * NOT IMPLEMENTED: Optional set of fields to order by.
+     */
+    orderBy?: string[];
+    /**
+     * NOT IMPLEMENTED: Time instant to query
+     */
+    time?: number;
+    /**
+     * NOT IMPLEMENTED: Time range to query
+     */
+    timeRange?: [null | number, null | number];
+}
+/**
+ * Union type of all the valid metric sources.
+ * To add additional sources, add them to this union type
+ */
+export declare type MetricSource = IStaticValueMetricSource | IServiceQueryMetricSource | IItemQueryMetricSource;
+/**
+ * Defines a metric source that is a static value
+ */
+export interface IStaticValueMetricSource {
+    type: "static-value";
+    /**
+     * Static value to use
+     */
+    value: string | number;
+}
+/**
+ * Defines a metric source that is a query to a service.
+ */
+export interface IServiceQueryMetricSource extends IServiceQuery {
+    type: "service-query";
+}
+/**
+ * Defines a metric source that fetches values from a set of items.
+ */
+export interface IItemQueryMetricSource {
+    type: "item-query";
+    /**
+     * Property path to get the value from the item
+     * e.g. `properties.numComments` or `properties.metrics[findBy(id,'funding_00c')].source`
+     */
+    propertyPath: string;
+    /**
+     * Keywords used in the query to search for items
+     */
+    keywords: string[];
+    /**
+     * Item types to limit the search
+     */
+    itemTypes?: string[];
+    /**
+     * Key of the collection to further limit the search
+     * This is resolved into an `IQuery` in the pre-processing step.
+     * If not defined, only the keyword and item types are used.
+     */
+    collectionKey?: string;
+    /**
+     * Scope query. This will be pulled from the collection if `collectionKey` is defined.
+     */
+    scope?: IQuery;
+}
+export interface IMetricAttributes extends IEntityInfo {
+    [key: string]: number | string | null;
+}
+/**
+ * Output of a metric, which merges the source info (id, label, type) with the value
+ */
+export interface IMetricFeature {
+    attributes: IMetricAttributes;
+    geometry?: __esri.Geometry;
+}

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

@@ -21,3 +21,5 @@ export * from "./IServerEnrichments";
 export * from "./ISystemStatus";
 export * from "./types";
 export * from "./DynamicValues";
+export * from "./IReference";
+export * from "./Metrics";

package/dist/types/index.d.ts

@@ -31,6 +31,7 @@ export * from "./users";
 export * from "./util";
 export * from "./utils";
 export * from "./versioning";
+export * from "./metrics";
 export * from "./core/updateHubEntity";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";

package/dist/types/initiatives/HubInitiative.d.ts

@@ -1,12 +1,13 @@
-import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig } from "../core";
+import { IHubInitiative, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IEditorConfig, IMetricFeature } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { InitiativeEditorType } from "./_internal/InitiativeSchema";
+import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
 /**
  * Hub Initiative Class
  */
-export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithSharingBehavior {
+export declare class HubInitiative extends HubItemEntity<IHubInitiative> implements IWithStoreBehavior<IHubInitiative>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior {
     private _catalog;
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
@@ -70,4 +71,10 @@ export declare class HubInitiative extends HubItemEntity<IHubInitiative> impleme
      * @returns
      */
     delete(): Promise<void>;
+    /**
+     * Resolve a single metric for this metric
+     * @param metricId
+     * @returns
+     */
+    resolveMetric(metricId: string): Promise<IMetricFeature[]>;
 }

package/dist/types/metrics/aggregateMetrics.d.ts

@@ -0,0 +1,10 @@
+import { IMetricFeature } from "../core";
+import { DynamicAggregation } from "../core/types/DynamicValues";
+/**
+ * Given an array of metrics, aggregate them using the specified aggregation
+ * Consumer must be aware of the type of the metrics and pass an appropriate aggregation
+ * @param metrics
+ * @param aggregation
+ * @returns
+ */
+export declare function aggregateMetrics(metrics: IMetricFeature[], field: string, aggregation: DynamicAggregation): any;

package/dist/types/metrics/getEntityMetrics.d.ts

@@ -0,0 +1,10 @@
+import { IHubInitiative } from "../core/types/IHubInitiative";
+import { IHubProject } from "../core/types/IHubProject";
+import { IMetric } from "../core/types/Metrics";
+/**
+ * Get the metrics from an entity applying some pre-processing
+ * and adding source info.
+ * @param entity
+ * @returns
+ */
+export declare function getEntityMetrics(entity: IHubProject | IHubInitiative): IMetric[];

package/dist/types/metrics/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./getEntityMetrics";
+export * from "./resolveMetric";
+export * from "./aggregateMetrics";

package/dist/types/metrics/resolveMetric.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../ArcGISContext";
+import { IMetric, IMetricFeature } from "../core/types/Metrics";
+/**
+ * Resolve a Metric into an array of `IMetricFeature` objects.
+ * This implementation is similar to DynamicValues, but is just different
+ * enough to warrant a separate implementation.
+ * @param metric
+ * @param context
+ * @returns
+ */
+export declare function resolveMetric(metric: IMetric, context: IArcGISContext): Promise<IMetricFeature[]>;

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

@@ -1,13 +1,14 @@
-import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions } from "../core";
+import { IHubProject, IWithCatalogBehavior, IWithStoreBehavior, IWithSharingBehavior, UiSchemaElementOptions, IMetricFeature } from "../core";
 import { Catalog } from "../search";
 import { IArcGISContext } from "../ArcGISContext";
 import { HubItemEntity } from "../core/HubItemEntity";
 import { IEditorConfig } from "../core/behaviors/IWithEditorBehavior";
 import { ProjectEditorType } from "./_internal/ProjectSchema";
+import { IWithMetricsBehavior } from "../core/behaviors/IWithMetricsBehavior";
 /**
  * Hub Project Class
  */
-export declare class HubProject extends HubItemEntity<IHubProject> implements IWithStoreBehavior<IHubProject>, IWithCatalogBehavior, IWithSharingBehavior {
+export declare class HubProject extends HubItemEntity<IHubProject> implements IWithStoreBehavior<IHubProject>, IWithCatalogBehavior, IWithMetricsBehavior, IWithSharingBehavior {
     private _catalog;
     /**
      * Private constructor so we don't have `new` all over the place. Allows for
@@ -70,4 +71,10 @@ export declare class HubProject extends HubItemEntity<IHubProject> implements IW
      * @returns
      */
     delete(): Promise<void>;
+    /**
+     * Resolve a single metric for this metric
+     * @param metricId
+     * @returns
+     */
+    resolveMetric(metricId: string): Promise<IMetricFeature[]>;
 }

package/dist/types/utils/memoize.d.ts

@@ -8,6 +8,8 @@
 export declare const memoize: <ARGS extends unknown[], RET>(fn: (...args: ARGS) => RET) => any;
 /**
  * Clear the cache of a memoized function
+ * If no function name is provided, the entire cache is cleared
+ * This is useful for testing, but should not be used in production
  * @param fn
  */
-export declare const clearMemoizedCache: (fnName: string) => void;
+export declare const clearMemoizedCache: (fnName?: string) => void;

package/package.json

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