@conterra/ct-mapapps-typings 4.18.0-next.20240419040340 → 4.18.0-next.20240423041951

package/agssearch/api.d.ts

@@ -114,6 +114,14 @@ interface AGSStoreFromURLOptions extends AGSStoreCommonOptions {
      * Default is false.
      */
     supportsIdQueries?: boolean;
+    /**
+     * Flag to indicate that the layer supports filtering using POST requests.
+     * Default is `false` for non ArcGIS OGCFeaturesServices,
+     * which means that requests with long query strings will fail.
+     * If `supportsIdQueries` is `true` and `supportsPOSTQueries` is `false`
+     * then these id queries are split to ensure GET requests are used for feature lookup by ids.
+     */
+    supportsPOSTQueries?: boolean;
 }
 /**
  * The type of stores created by the {@link AGSStoreFactory}.

package/apprt-core/Promise.d.ts

@@ -59,7 +59,9 @@ declare class ExtendedPromise<T> implements Promise<T> {
      *
      * @param iterable Iterable of Promise instances
      */
-    static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
+    static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
+        -readonly [P in keyof T]: Awaited<T[P]>;
+    }>;
     /**
      * Creates promise which fulfills if one of the other promises fulfills.
      * Or rejects if one of the promises rejects.

package/apprt-core/parallel.d.ts

@@ -0,0 +1,23 @@
+/**
+ * An asynchronous function.
+ */
+type Task<T> = () => Promise<T>;
+/**
+ * Options for {@link runParallel}.
+ */
+interface RunParallelOptions {
+    /**
+     * The number of tasks that can be executed in parallel.
+     * Defaults to 4.
+     */
+    parallelTasks?: number;
+}
+/**
+ * Runs the given array of tasks in parallel.
+ * @param tasks The tasks the execute.
+ * @param options Additional options.
+ * @returns An array of promises that resolve to results, in the same order as `tasks`.
+ */
+declare function runParallel<T>(tasks: Task<T>[], options?: RunParallelOptions): Promise<T>[];
+
+export { type RunParallelOptions, type Task, runParallel };

package/ct/util/css.d.ts

@@ -61,7 +61,9 @@ declare class ExtendedPromise<T> implements Promise<T> {
      *
      * @param iterable Iterable of Promise instances
      */
-    static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
+    static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
+        -readonly [P in keyof T]: Awaited<T[P]>;
+    }>;
     /**
      * Creates promise which fulfills if one of the other promises fulfills.
      * Or rejects if one of the promises rejects.

package/map-basemaps-api/BasemapItem.d.ts

@@ -1,15 +1,15 @@
-import * as apprt_core_Mutable from 'apprt-core/Mutable';
+/// <reference types="arcgis-js-api" />
+import { MutableConstructor } from 'apprt-core/Mutable';
+import { BasemapItem as BasemapItem$1 } from './api.js';
+import Basemap from 'esri/Basemap';
 
-/**
- * @class Items within BasemapsModel.
- * @alias module:BasemapItem
- */
-declare const BasemapItem: apprt_core_Mutable.MutableConstructor<{
-    id: string | undefined;
+declare const BasemapItem: MutableConstructor<{
+    id: string;
     title: string | undefined;
     description: string | undefined;
-    basemap: any;
+    basemap: Basemap | undefined;
     thumbnailUrl: string | undefined;
 }>;
+type BasemapItem = BasemapItem$1;
 
-export { BasemapItem as default };
+export { BasemapItem, BasemapItem as default };

package/map-basemaps-api/BasemapsModel.d.ts

@@ -1,11 +1,10 @@
-import * as apprt_core_Mutable from 'apprt-core/Mutable';
+import { BasemapsModelMembers, BasemapItem, BasemapItemProps, BasemapsModel as BasemapsModel$1 } from './api.js';
+import 'apprt-core/Mutable';
+import 'esri/Basemap';
 
-/**
- * @class BasemapsModel contains list of BasemapItems.
- * @alias module:BasemapsModel
- */
-declare const BasemapsModel: apprt_core_Mutable.MutableConstructor<{
-    [x: string]: any;
-}>;
+declare const BasemapsModel: new (options?: Partial<Omit<BasemapsModelMembers, "basemaps"> & {
+    basemaps: (BasemapItem | BasemapItemProps)[];
+}>) => BasemapsModel$1;
+type BasemapsModel = BasemapsModel$1;
 
-export { BasemapsModel as default };
+export { BasemapsModel, BasemapsModel as default };

package/map-basemaps-api/api.d.ts

@@ -0,0 +1,110 @@
+/// <reference types="arcgis-js-api" />
+import { Mutable } from 'apprt-core/Mutable';
+import Basemap from 'esri/Basemap';
+
+/**
+ * Documentation for the members of {@link BasemapsModel}.
+ */
+interface BasemapsModelMembers {
+    /**
+     * Id of selected basemap item.
+     */
+    selectedId: string | undefined;
+    /**
+     * Getter for the selected basemap item.
+     */
+    readonly selected: BasemapItem | undefined;
+    /**
+     * Array of basemap items.
+     */
+    get basemaps(): BasemapItem[];
+    /**
+     * Setter for the basemap items array.
+     */
+    set basemaps(value: (BasemapItem | BasemapItemProps)[]);
+    /**
+     * Object lookup for style classes.
+     */
+    styleLookup: Record<string, any> | undefined;
+    /**
+     * Adds the basemap item to the basemaps array.
+     */
+    add(item: BasemapItem | BasemapItemProps): BasemapsModel;
+    /**
+     * Removes basemap item from the basemaps array.
+     */
+    remove(item: Pick<BasemapItem, "id">): BasemapsModel;
+    /**
+     * Removes the basemap item with the given `id` from the basemaps array.
+     */
+    removeById(id: string): BasemapsModel;
+    /**
+     * Removes all basemap items and selectedId state.
+     */
+    clear(): BasemapsModel;
+    /**
+     * Returns `true` if basemaps are empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Finds the first item with the given id.
+     */
+    findItemById(id: string): BasemapItem | undefined;
+    /**
+     * Finds the first item referencing the given Basemap.
+     */
+    findItemByBasemap(basemap: Basemap): BasemapItem | undefined;
+}
+/**
+ * The `BasemapsModel` contains a list of BasemapItems.
+ */
+type BasemapsModel = Mutable<BasemapsModelMembers>;
+/**
+ * Documentation for the members of {@link BasemapItem}.
+ */
+interface BasemapItemMembers {
+    /**
+     * A basemap item needs an id.
+     */
+    id: string;
+    /**
+     * The title of the item.
+     */
+    title: string | undefined;
+    /**
+     * The description of the item.
+     */
+    description: string | undefined;
+    /**
+     * The esri.Basemap instance.
+     */
+    basemap: Basemap | undefined;
+    /**
+     * An optional thumbnail url.
+     */
+    thumbnailUrl: string | undefined;
+}
+/**
+ * Represents a basemap in the {@link BasemapsModel}.
+ */
+type BasemapItem = Mutable<BasemapItemMembers>;
+type BasemapItemProps = Partial<BasemapItemMembers>;
+/**
+ * Registers {@link BasemapsModel | BasemapsModels} with the system.
+ *
+ * Use `"map-basemaps-api.BasemapsModelRegistration"` to inject an instance of this service.
+ */
+interface BasemapModelRegistration {
+    /**
+     * Registers a given BasemapsModel with the system.
+     */
+    register(options: {
+        basemaps: BasemapsModel;
+    }): void;
+    /**
+     * Unregister the BasemapsModel instance.
+     */
+    unregister(keepInstances?: boolean): void;
+}
+
+export type { BasemapItem, BasemapItemMembers, BasemapItemProps, BasemapModelRegistration, BasemapsModel, BasemapsModelMembers };

package/map-init/api.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="arcgis-js-api" />
+import Map from 'esri/Map';
+import { BasemapsModel } from 'map-basemaps-api/api';
+import { MapWidgetModel, MapWidget } from 'map-widget/api';
+
+/**
+ * Interprets the map configuration.
+ *
+ * Use `"map-init.Interpreter"` to inject a reference to this interface.
+ */
+interface ConfigInterpreter {
+    /**
+     * Interprets a json config.
+     *
+     * @param config the json config input.
+     * @example
+     *
+     * ```js
+     * let interpreter = ...;
+     * let result = interpreter.interpret({map: {basemap: "streets"}});
+     * // create widget and model classes
+     * let {mapWidget, mapWidgetModel, map, basemapsModel} = await result.toMapWidget();
+     * // alternative is to only create the model classes
+     * let {mapWidgetModel, map, basemapsModel} = await result.toMapWidgetModel();
+     * ```
+     */
+    interpret(config: Record<string, any>): InterpreterResult;
+}
+/**
+ * The result of {@link InterpreterResult.toMapWidgetModel}.
+ */
+interface MapWidgetModelResult {
+    /**
+     * The map instance.
+     */
+    map: Map;
+    /**
+     * The basemaps model.
+     */
+    basemapsModel: BasemapsModel;
+    /**
+     *  The map widget model.
+     */
+    mapWidgetModel: MapWidgetModel;
+}
+/**
+ * The result of {@link InterpreterResult.toMapWidget}.
+ */
+interface MapWidgetResult extends MapWidgetModelResult {
+    /**
+     * The map widget.
+     */
+    mapWidget: MapWidget;
+}
+/**
+ * The result of interpreting a json configuration using {@link ConfigInterpreter.interpret()}.
+ */
+interface InterpreterResult {
+    /**
+     * Returns the map, the basemaps model and finally the mapWidgetModel.
+     */
+    toMapWidgetModel(): Promise<MapWidgetModelResult>;
+    /**
+     * Like {@link toMapWidgetModel}, but also creates a `MapWidget`.
+     */
+    toMapWidget(): Promise<MapWidgetResult>;
+}
+
+export type { ConfigInterpreter, InterpreterResult, MapWidgetModelResult, MapWidgetResult };

package/map-init/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "map-init",
+    "version": "4.18.0-SNAPSHOT",
+    "types": ""
+}

package/package.json

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

package/selection-resultcenter/CachingStore.d.ts

@@ -61,7 +61,9 @@ declare class ExtendedPromise<T> implements Promise<T> {
      *
      * @param iterable Iterable of Promise instances
      */
-    static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
+    static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
+        -readonly [P in keyof T]: Awaited<T[P]>;
+    }>;
     /**
      * Creates promise which fulfills if one of the other promises fulfills.
      * Or rejects if one of the promises rejects.