@arcgis/charts-components 5.0.0-next.98 → 5.0.0

package/dist/utils/layer/query-parser/index.d.ts

@@ -1,86 +1,98 @@
-import { default as Geometry } from '@arcgis/core/geometry/Geometry';
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer.js';
-import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer.js';
-import { default as AttributeBinsQuery } from '@arcgis/core/rest/support/AttributeBinsQuery.js';
-import { QueryProperties, default as Query } from '@arcgis/core/rest/support/Query.js';
-import { default as TimeExtent } from '@arcgis/core/time/TimeExtent.js';
-import { WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning, RESTFieldType } from '../../../spec';
-import { QueryObject } from '../interfaces';
+import type Geometry from "@arcgis/core/geometry/Geometry.js";
+import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
+import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
+import type AttributeBinsQuery from "@arcgis/core/rest/support/AttributeBinsQuery.js";
+import type Query from "@arcgis/core/rest/support/Query.js";
+import type TimeExtent from "@arcgis/core/time/TimeExtent.js";
+import type { QueryProperties } from "@arcgis/core/rest/support/Query.js";
+import type { RESTFieldType } from "../../../spec/rest-js-object-literals.js";
+import type { WebChartHeatChartSeries, WebChartQuery, WebChartTemporalBinning } from "../../../spec/web-chart.js";
+import type { QueryObject } from "../interfaces.js";
+
 /**
  * Indicates whether a query can be cached. It is not when:
  * - a geometry is set (unless it's an extent)
  * - a date filter is set
- * @param query The query object or query parameters
+ *
+ * @param query - The query object or query parameters
+ * @internal
  */
-export declare function isQueryCacheable(query: AttributeBinsQuery | Query | QueryProperties): boolean;
-export declare function getMaxRecords(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number;
+export function isQueryCacheable(query: AttributeBinsQuery | Query | QueryProperties): boolean;
+
+/**
+ * @param layer
+ * @internal
+ */
+export function getMaxRecords(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number;
+
 /**
  * Function building a where clause by concatenating a list of filters by using the AND operator.
- * @param filterList The list of filters to combine
- * @param operand The operand to use to combine the filters (OR, AND...)
+ *
+ * @param filterList - The list of filters to combine
+ * @param operand - The operand to use to combine the filters (OR, AND...)
+ * @internal
  */
-export declare function combineFilters(filterList: (string | null | undefined)[], operand?: string): string;
+export function combineFilters(filterList: (string | null | undefined)[], operand?: string): string;
+
 /**
  * Computes the time extent to be used by the query.
- * @param queryObject The layer or feature layer view
- * @param defaultTimeExtent The time extent defined at the series config level or provided at runtime
+ *
+ * @param queryObject - The layer or feature layer view
+ * @param defaultTimeExtent - The time extent defined at the series config level or provided at runtime
+ * @internal
  */
-export declare function getQueryTimeExtent(queryObject: QueryObject, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
+export function getQueryTimeExtent(queryObject: QueryObject, defaultTimeExtent?: WebChartQuery["timeExtent"]): WebChartQuery["timeExtent"] | undefined;
+
 /**
  * Computes the extent to be used by the query. We prioritize the feature layer view extent
  * over the series config extent, unless `ignoreViewExtent` is set to true.
- * @param props.queryObject The layer or feature layer view
- * @param props.defaultGeometry The geometry defined at the series config level or provided at runtime
- * @param props.ignoreViewExtent Whether to ignore the view's extent
+ *
+ * @param props - The layer or feature layer view
+ * @internal
  */
-export declare function getQueryGeometry(props: {
+export function getQueryGeometry(props: {
     queryObject: QueryObject;
     defaultGeometry?: WebChartQuery["geometry"];
     ignoreViewExtent?: boolean;
 }): WebChartQuery["geometry"] | undefined;
+
 /**
  * Transforms a [timestamp, timestamp] to a JSAPI TimeExtent object
- * @param timeExtentConfig The time extent filter from the config
+ *
+ * @param timeExtentConfig - The time extent filter from the config
+ * @internal
  */
-export declare function mapQueryTimeExtent(timeExtentConfig?: WebChartQuery["timeExtent"]): TimeExtent | undefined;
+export function mapQueryTimeExtent(timeExtentConfig?: WebChartQuery["timeExtent"]): TimeExtent | undefined;
+
 /**
  * Transforms a IGeometry to a JSAPI Geometry
- * @param geometryConfig The geometry from the config
- */
-export declare function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Geometry | null | undefined;
-/**
- * Sanitizes an outFields array by:
- * - removing the duplicates
- * @param outFields The array to sanitize
- * @returns The sanitized array
+ *
+ * @param geometryConfig - The geometry from the config
+ * @internal
  */
-declare function sanitizeOutFields(outFields?: string[]): string[];
+export function mapQueryGeometry(geometryConfig?: WebChartQuery["geometry"]): Geometry | null | undefined;
+
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
- * @param props.queryObject The layer or feature layer view
- * @param props.queryConfig The query configuration
- * @param props.temporalBinning The temporal binning configuration
- * @param props.dateField The date field to bin
- * @param props.splitByField The split-by field
+ *
+ * @param props - The layer or feature layer view
+ * @internal
  */
-export declare function mapAttributeBinsQueryForTemporalData(props: {
+export function mapAttributeBinsQueryForTemporalData(props: {
     queryObject?: QueryObject;
     queryConfig?: WebChartQuery;
     temporalBinning: WebChartTemporalBinning;
     dateField: string;
     splitByField?: string;
 }): Promise<AttributeBinsQuery>;
+
 /**
  * Builds a SQL expression as well as the start and end values necessary for the calendar date parts binning.
- * @param props.field The field used by the heat chart
- * @param props.fieldType The field type
- * @param props.unit The unit of the temporal binning
- * @param props.addIntervalStatement Whether to add the interval statement to shift the date from the data time zone to the output time zone
- * @param props.outTimeZone The output time zone
- * @param props.dataTimeZone The data time zone
- * @param props.runsOnClientQueryEngine Whether the query will be executed on the client query engine (FeatureLayerView) or on the server
+ *
+ * @param props - The field used by the heat chart
+ * @internal
  */
-export declare function getCalendarDatePartsParameters(props: {
+export function getCalendarDatePartsParameters(props: {
     field: string;
     fieldType?: RESTFieldType;
     unit?: string;
@@ -88,23 +100,20 @@ export declare function getCalendarDatePartsParameters(props: {
     outTimeZone?: string;
     dataTimeZone?: string | null;
     runsOnClientQueryEngine?: boolean;
+    addLeapDayExpression?: boolean;
 }): {
     expression?: string;
     start?: number;
     end?: number;
 };
+
 /**
  * Maps properties from a WebChartQuery and properties specific to heat chart into an AttributeBinsQuery object.
- * @param props.queryObject The layer or feature layer view
- * @param props.queryConfig The query configuration
- * @param props.x The x field
- * @param props.y The y field
- * @param props.xTemporalBinning The x temporal binning configuration
- * @param props.yTemporalBinning The y temporal binning configuration
- * @param props.firstDayOfWeek The first day of the week, used for date-based bins
- * @param props.outTimeZone The IANA time zone used for temporal bin calculations
+ *
+ * @param props - The layer or feature layer view
+ * @internal
  */
-export declare function mapAttributeBinsQueryForHeatChart(props: {
+export function mapAttributeBinsQueryForHeatChart(props: {
     queryObject?: QueryObject;
     queryConfig?: WebChartQuery;
     x: string;
@@ -113,19 +122,16 @@ export declare function mapAttributeBinsQueryForHeatChart(props: {
     yTemporalBinning?: WebChartHeatChartSeries["yTemporalBinning"];
     firstDayOfWeek?: number;
     outTimeZone?: string;
+    includeLeapDay?: boolean;
 }): Promise<AttributeBinsQuery>;
+
 /**
  * Maps properties from a WebChartQuery and properties specific to temporal binning into an AttributeBinsQuery object.
- * @param props.queryObject The layer or feature layer view
- * @param props.queryConfig The query configuration
- * @param props.xStep The x step
- * @param props.yStep The y step
- * @param props.xMin The x min
- * @param props.xMax The x max
- * @param props.x The x field
- * @param props.y The y field
+ *
+ * @param props - The layer or feature layer view
+ * @internal
  */
-export declare function mapAttributeBinsQueryForScatterplot(props: {
+export function mapAttributeBinsQueryForScatterplot(props: {
     queryObject?: QueryObject;
     queryConfig?: WebChartQuery;
     xStep: number;
@@ -135,19 +141,21 @@ export declare function mapAttributeBinsQueryForScatterplot(props: {
     x: string;
     y: string;
 }): AttributeBinsQuery;
+
 /**
  * Maps properties from a WebChartQuery into a Query object.
- * @param props.queryObject The layer or feature layer view
- * @param props.queryConfig The query configuration
- * @param props.maxRecordCountFactor When set, the maximum number of features returned by the query will equal the `maxRecordCount` of the service multiplied by this factor.
+ *
+ * @param props - The layer or feature layer view
+ * @internal
  */
-export declare function mapQuery(props: {
+export function mapQuery(props: {
     queryObject?: QueryObject;
     queryConfig?: WebChartQuery;
     maxRecordCountFactor?: number;
 }): Query;
-export declare function getMaxRecordCountFactor(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number | undefined;
-export declare const queryParserPrivateFunctions: {
-    sanitizeOutFields: typeof sanitizeOutFields;
-};
-export {};
+
+/**
+ * @param layer
+ * @internal
+ */
+export function getMaxRecordCountFactor(layer?: Pick<FeatureLayer, "sourceJSON"> | SubtypeSublayer): number | undefined;

package/dist/utils/layer/utils/index.d.ts

@@ -1,110 +1,168 @@
-import { default as FeatureLayer } from '@arcgis/core/layers/FeatureLayer';
-import { default as SubtypeGroupLayer } from '@arcgis/core/layers/SubtypeGroupLayer';
-import { default as SubtypeSublayer } from '@arcgis/core/layers/support/SubtypeSublayer';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView.js';
-import { WebChart } from '../../../spec';
-import { QueryObject } from '../interfaces';
-import { SupportedLayer } from '../../../interfaces';
+import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
+import type SubtypeGroupLayer from "@arcgis/core/layers/SubtypeGroupLayer.js";
+import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
+import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
+import type { QueryObject } from "../interfaces.js";
+import type { SupportedLayer } from "../../../interfaces.js";
+import type { WebChart } from "../../../spec/web-chart.js";
+
 /**
  * Indicates whether the input object is a feature collection.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isFeatureCollectionLayer(queryObject: QueryObject): queryObject is FeatureLayerView;
+export function isFeatureCollectionLayer(queryObject: QueryObject): queryObject is FeatureLayerView;
+
 /**
  * Indicates whether the input object is an instance of `FeatureLayerView`.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer): queryObject is FeatureLayerView;
+export function isFeatureLayerView(queryObject: QueryObject | SubtypeGroupLayer): queryObject is FeatureLayerView;
+
 /**
  * Indicates whether the input object is an instance of `FeatureLayer`.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isFeatureLayer(queryObject: QueryObject): queryObject is FeatureLayer;
+export function isFeatureLayer(queryObject: QueryObject): queryObject is FeatureLayer;
+
 /**
  * Indicates whether the input object is an instance of `SubtypeGroupLayer`.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isSubtypeGroupLayer(queryObject: QueryObject | SubtypeGroupLayer): queryObject is SubtypeGroupLayer;
+export function isSubtypeGroupLayer(queryObject: QueryObject | SubtypeGroupLayer): queryObject is SubtypeGroupLayer;
+
 /**
  * Indicates whether the input object is an instance of `SubtypeSublayer`.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isSubtypeSublayer(queryObject: Pick<SubtypeSublayer, "type"> | QueryObject): queryObject is SubtypeSublayer;
+export function isSubtypeSublayer(queryObject: Pick<SubtypeSublayer, "type"> | QueryObject): queryObject is SubtypeSublayer;
+
 /**
  * Indicates whether the input object is an instance of `SupportedLayer` (`FeatureLayer` or `SubtypeSublayer`).
+ *
  * @param queryObject
+ * @internal
  */
-export declare function isSupportedLayer(queryObject: QueryObject): queryObject is SupportedLayer;
+export function isSupportedLayer(queryObject: QueryObject): queryObject is SupportedLayer;
+
 /**
  * Returns the main `Layer` instance associated with the layer being used.
  *
  * Only needed for the case where the layer is a `SubtypeSublayer`, in which case we use the parent layer which is a `SubtypeGroupLayer`.
  *
  * @param layer
+ * @internal
+ */
+export function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type">): FeatureLayer | SubtypeGroupLayer;
+
+/**
+ * @param layer
+ * @internal
+ */
+export function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type"> | undefined): FeatureLayer | SubtypeGroupLayer | null | undefined;
+
+/**
+ * @param layer
+ * @internal
  */
-export declare function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type">): FeatureLayer | SubtypeGroupLayer;
-export declare function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type"> | undefined): FeatureLayer | SubtypeGroupLayer | null | undefined;
+export function getMainLayer(layer: FeatureLayer | Pick<SubtypeSublayer, "parent" | "type"> | undefined): FeatureLayer | SubtypeGroupLayer | null | undefined;
+
 /**
  * Indicates whether a layer supports queries with a `distance` parameter
- * @param layer The layer to test
+ *
+ * @param layer - The layer to test
  * @returns A boolean
+ * @internal
  */
-export declare function doesLayerSupportQueryWithDistance(layer: SupportedLayer): boolean;
+export function doesLayerSupportQueryWithDistance(layer: SupportedLayer): boolean;
+
 /**
  * Indicates whether a layer supports the queryBins operation for the heat chart use case.
- * @param layer The layer to test
+ *
+ * @param layer - The layer to test
+ * @param queryObject
  * @returns A boolean indicating whether the operation is supported
+ * @internal
  */
-export declare function doesLayerSupportsQueryBinsForHeatChart(layer: SupportedLayer, queryObject: QueryObject): boolean;
+export function doesLayerSupportsQueryBinsForHeatChart(layer: SupportedLayer, queryObject: QueryObject): boolean;
+
 /**
  * Indicates whether a layer supports the queryBins operation for the temporal data use case.
  * We currently only use the "date" operation.
  * If a split-by field is provided we verify whether `stackBy` parameter is supported (refer to `mapAttributeBinsQuery()`).
- * @param layer The layer to test
- * @param splitByField The split-by field
+ *
+ * @param layer - The layer to test
+ * @param splitByField - The split-by field
  * @returns A boolean indicating whether the operation is supported
+ * @internal
  */
-export declare function doesLayerSupportsQueryBinsForTemporalData(layer?: FeatureLayerView | SubtypeGroupLayer | SupportedLayer, splitByField?: string): boolean;
+export function doesLayerSupportsQueryBinsForTemporalData(layer?: FeatureLayerView | SubtypeGroupLayer | SupportedLayer, splitByField?: string): boolean;
+
 /**
  * Indicates whether the layer supports the cacheHint parameter for the queryBins operation
- * @param queryObject The layer or feature layer view
+ *
+ * @param queryObject - The layer or feature layer view
+ * @internal
  */
-export declare function doesLayerSupportsCacheHintForQueryBins(queryObject: QueryObject): boolean;
+export function doesLayerSupportsCacheHintForQueryBins(queryObject: QueryObject): boolean;
+
 /**
  * Indicates whether the layer supports the query bins operation for scatterplot:
  * - supports queryBins
  * - supports the type `fixedIntervalBin`
  * - statistics: supports MAX and COUNT
- * @param queryObject The layer or feature layer view
+ *
+ * @param queryObject - The layer or feature layer view
+ * @internal
  */
-export declare function doesLayerSupportsQueryBinsForScatterplot(queryObject: QueryObject): boolean;
+export function doesLayerSupportsQueryBinsForScatterplot(queryObject: QueryObject): boolean;
+
 /**
  * Returns a feature layer from a QueryObject instance.
  * It will use the QueryObject itself if it's a Feature Layer, or the `layer` property from it if it's a Feature Layer View.
- * @param queryObject
+ *
+ * @param layerOrLayerView
+ * @internal
  */
-export declare function getLayerFromLayerOrLayerView(layerOrLayerView: FeatureLayerView | SupportedLayer): SupportedLayer;
+export function getLayerFromLayerOrLayerView(layerOrLayerView: FeatureLayerView | SupportedLayer): SupportedLayer;
+
 /**
  * Returns a feature layer from a QueryObject instance.
  * It will use the QueryObject itself if it's a Feature Layer, or the `layer` property from it if it's a Feature Layer View.
+ *
  * @param queryObject
+ * @internal
  */
-export declare function getLayerFromQueryObject(queryObject: QueryObject): SupportedLayer;
+export function getLayerFromQueryObject(queryObject: QueryObject): SupportedLayer;
+
 /**
  * Computes a feature layer capabilities regarding its spatial aggregation statistics.
  * Only considers the 'EnvelopeAggregate' for now.
- * @param layer The layer instance
+ *
+ * @param layer - The layer instance
  * @returns A sum up of the capabilities
+ * @internal
  */
-export declare function getLayerSpatialAggregationStatisticsCapabilities(layer: SupportedLayer): boolean;
+export function getLayerSpatialAggregationStatisticsCapabilities(layer: SupportedLayer): boolean;
+
 /**
  * Adds a iLayer to a WebChart.
  * If the `queryObject` prop is provided an `iLayer` is added to the config.
- * @param props.chartConfig The chart config with no iLayer
- * @param props.queryObject The layer or feature layer view instance. Its information are **not** used to create the iLayer.
+ *
+ * @param props - The chart config with no iLayer
  * @returns The update chart config with a `iLayer` property
+ * @internal
  */
-export declare function addILayer<T extends WebChart>(props: {
+export function addILayer<T extends WebChart>(props: {
     chartConfig: T;
     queryObject?: FeatureLayerView | SupportedLayer;
-}): T & WebChart;
+}): T & WebChart;

package/dist/utils/localization/index.d.ts

@@ -1,41 +1,69 @@
-import { default as MapView } from '@arcgis/core/views/MapView';
-import { ErrorStrings, LocaleInfo, UtilsStrings, SupportedLocalesForFormats } from './interfaces';
+import type MapView from "@arcgis/core/views/MapView.js";
+import type { ErrorStrings, LocaleInfo, UtilsStrings, SupportedLocalesForFormats } from "./interfaces.js";
+
 /**
  * Finds the locale info of the closest element to the given element.
  *
  * @param element - The element to get the locale info from.
+ * @internal
  */
-export declare function getLocaleInfo(element?: HTMLElement): LocaleInfo;
+export function getLocaleInfo(element?: HTMLElement): LocaleInfo;
+
 /**
  * Converts the given `timeZone` from ArcGIS `MapView` to a valid time zone string.
+ *
+ * @param timeZone
+ * @internal
  */
-export declare function convertTimeZone(timeZone: MapView["timeZone"] | undefined): string | undefined;
+export function convertTimeZone(timeZone: MapView["timeZone"] | undefined): string | undefined;
+
 /**
  * Returns the date string in the Calcite date picker's expected format `YYYY-MM-DD` based on the given date and time zone.
+ *
+ * @param date
+ * @param timeZone
+ * @internal
  */
-export declare function getDateStringInCalciteDatePickerFormat(date: Date, timeZone: string): string;
+export function getDateStringInCalciteDatePickerFormat(date: Date, timeZone: string): string;
+
 /**
  * Returns the time string in the Calcite time picker's expected format `HH:mm` based on the given date and time zone.
+ *
+ * @param date
+ * @param timeZone
+ * @internal
  */
-export declare function getTimeStringInCalciteTimePickerFormat(date: Date, timeZone: string): string;
+export function getTimeStringInCalciteTimePickerFormat(date: Date, timeZone: string): string;
+
 /**
  * Performs locale aware parse float
- * @param localizedString string that has to be parsed
- * @param locale  locale used for parsing the float
+ *
+ * @param localizedString - string that has to be parsed
+ * @param locale - locale used for parsing the float
+ * @internal
  */
-export declare function localeParseFloat(localizedString: string, locale?: string): number;
+export function localeParseFloat(localizedString: string, locale?: string): number;
+
 /**
  * Gets the format locale from the given element.
- * @param element HTMLElement to get the locale from
+ *
+ * @param element - HTMLElement to get the locale from
+ * @internal
  */
-export declare function getElementFormatLocale(element: HTMLElement): SupportedLocalesForFormats;
+export function getElementFormatLocale(element: HTMLElement): SupportedLocalesForFormats;
+
 /**
  * Returns a default `CommonStrings` t9n object.
  * This is used by the chart components unit tests and the charts-js Storybook demos.
+ *
+ * @internal
  */
-export declare function getDefaultErrorsStrings(): Promise<ErrorStrings>;
+export function getDefaultErrorsStrings(): Promise<ErrorStrings>;
+
 /**
  * Returns a default `UtilsStrings` t9n object.
  * This is used by the chart components unit tests and the charts-js Storybook demos.
+ *
+ * @internal
  */
-export declare function getDefaultUtilsStrings(): Promise<UtilsStrings>;
+export function getDefaultUtilsStrings(): Promise<UtilsStrings>;