@conterra/ct-mapapps-typings 4.17.1-next.20240312050147 → 4.17.1-next.20240313051616

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@conterra/ct-mapapps-typings",
3
- "version": "4.17.1-next.20240312050147",
3
+ "version": "4.17.1-next.20240313051616",
4
4
  "description": "TypeDefinitions for ct-mapapps",
5
5
  "author": "conterra",
6
6
  "license": "Apache-2.0"
@@ -25,6 +25,16 @@ type DateTimeFormat = "date" | "time" | "datetime" | "short-date" | "short-date-
25
25
  interface DateTimeFormatOptions {
26
26
  dateTimeFormat?: DateTimeFormat;
27
27
  }
28
+ /**
29
+ * Options how arcade columns are formatted.
30
+ */
31
+ interface ArcadeFormatOptions {
32
+ fieldNames: string[];
33
+ arcadeExecutor: (args: {
34
+ $feature: __esri.Graphic;
35
+ }) => string;
36
+ arcadeExpression?: string;
37
+ }
28
38
  /**
29
39
  * Well known formatting option flags.
30
40
  */
@@ -234,6 +244,18 @@ interface ColumnProvider<IdType extends DatasetItemId = DatasetItemId> {
234
244
  */
235
245
  (dataset: Dataset<IdType>, formatters: FormatterFacade): Promise<Column[]>;
236
246
  }
247
+ /**
248
+ * Factory injected into the DataTableFactory implementation.
249
+ */
250
+ interface ColumnProviderFactory<IdType extends DatasetItemId = DatasetItemId> {
251
+ /**
252
+ * Creates a ColumnProvider.
253
+ * @param opts helper calculate the columns.
254
+ */
255
+ create(opts: {
256
+ isAllowedField: (name: string) => boolean;
257
+ }): ColumnProvider<IdType>;
258
+ }
237
259
  /**
238
260
  * Represents a common event when collection is changed.
239
261
  */
@@ -583,6 +605,10 @@ interface Dataset<IdType extends DatasetItemId = DatasetItemId> extends EventSou
583
605
  * The real data source.
584
606
  */
585
607
  readonly dataSource: DataSource<IdType>;
608
+ /**
609
+ * Service metadata about the data source if provided.
610
+ */
611
+ readonly dataSourceProperties: Readonly<Record<string, unknown>> | undefined;
586
612
  /**
587
613
  * Capabilities of the data set.
588
614
  * The capabilities are only readable if the dataset is "initialized".
@@ -1124,4 +1150,4 @@ interface SortSpecifier {
1124
1150
  descending: boolean;
1125
1151
  }
1126
1152
 
1127
- export type { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, 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 };
1153
+ export type { 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 };
@@ -1,4 +1,4 @@
1
- import { DataTable, TableItem, DataTableCollection } from '../__internal__/GYEen8Tf.js';
1
+ import { DataTable, TableItem, DataTableCollection } from '../__internal__/Ql_bC0Ds.js';
2
2
  import { EventSource } from 'apprt-core/Events';
3
3
  import 'apprt-core/Types';
4
4
  import 'esri/geometry';
@@ -1,4 +1,4 @@
1
- export { DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/GYEen8Tf.js';
1
+ export { ArcadeFormatOptions, DateTimeFormat, DateTimeFormatOptions, FORMATTER_COMBINED_IDENTIFIER, FORMATTER_DOMAIN_VALUE_IDENTIFIER, FORMATTER_ID_IDENTIFIER, Formatter, FormatterFacade, FormatterOptions, FormattingInfo, FormattingInfoProvider, NumberFormatOptions, WellKnownFormatterOptions } from '../__internal__/Ql_bC0Ds.js';
2
2
  import 'apprt-core/Types';
3
3
  import 'esri/geometry';
4
4
  import 'store-api/api';
@@ -1,4 +1,4 @@
1
- export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, 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__/GYEen8Tf.js';
1
+ 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__/Ql_bC0Ds.js';
2
2
  export { DataTableFactory, ResultViewerService, ResultViewerServiceEvents, ResultViewerServiceOpenOptions } from './service.js';
3
3
  export { DataTableUi, DataTableUiConfig, DataTableUiEvents, DataTableUiFactory } from './ui.js';
4
4
  export { BulkActionContext, BulkButtonTableAction, BulkTableAction, RowActionContext, RowButtonTableAction, RowTableAction, TableAction, TableActionDisplayState, TableActionDisplayStateProvider, TableActionItem, TableActionResolver, TableActionResolverContext, TableActionResolverContextEvents, TableActionResolverContextOptions, TableActionUIType } from './actions.js';
@@ -1,4 +1,4 @@
1
1
  import 'apprt-core/Types';
2
2
  import 'esri/geometry';
3
3
  import 'store-api/api';
4
- export { CollectionChangedEvent, Column, ColumnAlign, ColumnProvider, 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__/GYEen8Tf.js';
4
+ 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__/Ql_bC0Ds.js';
@@ -1,5 +1,5 @@
1
1
  import { Store, ComplexQueryExpression, QueryOptions } from 'store-api/api';
2
- import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/GYEen8Tf.js';
2
+ import { DataTableCollection, DataTable, DatasetItemIdsProvider } from '../__internal__/Ql_bC0Ds.js';
3
3
  import { EventSource, Handle } from 'apprt-core/Types';
4
4
  import 'esri/geometry';
5
5
 
@@ -1,4 +1,4 @@
1
- import { DataTableCollection } from '../__internal__/GYEen8Tf.js';
1
+ import { DataTableCollection } from '../__internal__/Ql_bC0Ds.js';
2
2
  import { EventSource } from 'apprt-core/Types';
3
3
  import 'esri/geometry';
4
4
  import 'store-api/api';