@conterra/ct-mapapps-typings 4.17.1-next.20240325052139 → 4.17.1-next.20240328070851

package/apprt-core/NumberParser.d.ts

@@ -11,6 +11,8 @@
 declare class NumberParser {
     private groupRegexp;
     private decimalRegexp;
+    readonly groupSeparator: string | undefined;
+    readonly decimalSeparator: string | undefined;
     constructor(locale: string);
     parse(numberString: string): number;
 }

package/apprt-core/comparators.d.ts

@@ -34,6 +34,29 @@ declare const TYPE_BASED_COMPARE: (a: any, b: any) => number;
  * @implements Comparator
  */
 declare const IGNORE_CASE: (a: any, b: any) => number;
+/**
+ * Factory to create a comparator to compare strings using localCompare function.
+ * @param locale locale, e.g. `en` or `de`.
+ * @param ignoreCase `true`, if strings should be compared ignoring case, otherwise `false`.
+ * @param numeric `true`, try to interpret the string as number
+ * @returns comparator for strings
+ */
+declare function createStringComparator(locale?: string, ignoreCase?: boolean, numeric?: boolean): Comparator<any>;
+/**
+ * Factory to create a string comparator which compares strings respecting numeric parts of the given strings.
+ * The comparator splits the input into string and numeric parts to compare them separately.
+ * @example
+ * ```js
+ * const comparator = createStringWithNumberPartsComparator();
+ * const values = ["a1", "a10", "a2", "b1, "a20", "a3"];
+ * values.sort(comparator);
+ * assert.deepStrictEqual(["a1", "a2", "a3", "a10", "a20", "b1"], values);
+ * ```
+ * @param locale locale, e.g. `en` or `de`.
+ * @param ignoreCase `true`, if strings should be compared ignoring case, otherwise `false`.
+ * @returns comparator for comparing strings with numeric parts
+ */
+declare function createStringWithNumberPartsComparator(locale?: string, ignoreCase?: boolean): Comparator<any>;
 /**
  * An interface implemented by objects with custom comparison logic.
  * Used in conjunction with {@link BY_COMPARE_TO}.
@@ -176,4 +199,4 @@ keyof ObjectType | AllFieldSpecObjects<ObjectType, keyof ObjectType>;
  */
 declare function compareFields<ObjectType>(...fields: FieldSpec<ObjectType>[]): Comparator<ObjectType>;
 
-export { BY_COMPARE_TO, type Comparable, type Comparator, DEFAULT_COMPARE, type FieldSpecObject, IGNORE_CASE, TYPE_BASED_COMPARE, compareFields };
+export { BY_COMPARE_TO, type Comparable, type Comparator, DEFAULT_COMPARE, type FieldSpecObject, IGNORE_CASE, TYPE_BASED_COMPARE, compareFields, createStringComparator, createStringWithNumberPartsComparator };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@conterra/ct-mapapps-typings",
-    "version": "4.17.1-next.20240325052139",
+    "version": "4.17.1-next.20240328070851",
     "description": "TypeDefinitions for ct-mapapps",
     "author": "conterra",
     "license": "Apache-2.0"

package/result-api/__internal__/{czLyVyOh.d.ts → XYqJysD8.d.ts}

@@ -1131,6 +1131,16 @@ interface Column {
      * Specifies if this column is sortable.
      */
     readonly sortable: boolean;
+    /**
+     * Specifies if this column should be sorted by its original value or by its formatted display value.
+     * The following values are allowed:
+     *
+     * - `undefined` (default): The column is sorted by its original value.
+     * - `string`: The column is sorted by its formatted display value as a string.
+     * - `string-with-number`: The column is sorted by its formatted display value,
+     *    whereby numeric parts are sorted as numbers. Example: "a1" < "a2" < "a10".
+     */
+    readonly sortFormattedValue?: "string" | "string-with-number" | undefined;
     /**
      * Id of a formatter.
      */

package/result-api/api/actions.d.ts

@@ -1,4 +1,4 @@
-import { DataTable, TableItem, DataTableCollection } from '../__internal__/czLyVyOh.js';
+import { DataTable, TableItem, DataTableCollection } from '../__internal__/XYqJysD8.js';
 import { EventSource } from 'apprt-core/Events';
 import 'apprt-core/Types';
 import 'esri/geometry';

package/result-api/api/formatting.d.ts

@@ -1,4 +1,4 @@
-export { ArcadeFormatOptions, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/czLyVyOh.js';
+export { ArcadeFormatOptions, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/XYqJysD8.js';
 import 'apprt-core/Types';
 import 'esri/geometry';
 import 'store-api/api';

package/result-api/api/index.d.ts

@@ -1,4 +1,4 @@
-export { ArcadeFormatOptions, CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Filter, FocusChangedEvent, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, ItemCount, NumberFormatOptions, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties, WellKnownFormatterOptions } from '../__internal__/czLyVyOh.js';
+export { ArcadeFormatOptions, CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Filter, FocusChangedEvent, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, ItemCount, NumberFormatOptions, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties, WellKnownFormatterOptions } from '../__internal__/XYqJysD8.js';
 export { DataTableFactory, ResultViewerService, ResultViewerServiceEvents, ResultViewerServiceOpenOptions } from './service.js';
 export { DataTableUi, DataTableUiConfig, DataTableUiEvents, DataTableUiFactory } from './ui.js';
 export { BulkActionContext, BulkButtonTableAction, BulkTableAction, RowActionContext, RowButtonTableAction, RowTableAction, TableAction, TableActionDisplayState, TableActionDisplayStateProvider, TableActionItem, TableActionResolver, TableActionResolverContext, TableActionResolverContextEvents, TableActionResolverContextOptions, TableActionUIType } from './actions.js';

package/result-api/api/model.d.ts

@@ -1,4 +1,4 @@
 import 'apprt-core/Types';
 import 'esri/geometry';
 import 'store-api/api';
-export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, Filter, FocusChangedEvent, ItemCount, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties } from '../__internal__/czLyVyOh.js';
+export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, ColumnProviderFactory, DataSource, DataTable, DataTableCollection, DataTableCollectionEvents, DataTableEvents, DataTableId, DataTableWatchProperties, Dataset, DatasetCapabilities, DatasetEvents, DatasetField, DatasetItem, DatasetItemId, DatasetItemIdsProvider, DatasetState, DatasetWatchProperties, Filter, FocusChangedEvent, ItemCount, QueryDefinition, QueryResult, RowEvent, RowItem, SELECTION_COLUMN_NAME, Selection, SelectionEvents, SortSpecifier, SuggestFilter, TableItem, TableModel, TableModelEvents, TableModelState, TableModelWatchProperties } from '../__internal__/XYqJysD8.js';

package/result-api/api/service.d.ts

@@ -1,5 +1,5 @@
 import { Store, ComplexQueryExpression, QueryOptions } from 'store-api/api';
-import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/czLyVyOh.js';
+import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/XYqJysD8.js';
 import { EventSource, Handle } from 'apprt-core/Types';
 import 'esri/geometry';
 

package/result-api/api/ui.d.ts

@@ -1,4 +1,4 @@
-import { DataTableCollection } from '../__internal__/czLyVyOh.js';
+import { DataTableCollection } from '../__internal__/XYqJysD8.js';
 import { EventSource } from 'apprt-core/Types';
 import 'esri/geometry';
 import 'store-api/api';