@conterra/ct-mapapps-typings 4.20.1 → 4.20.2-RC-1

package/apprt-fetch/package.json

@@ -1,5 +1,5 @@
 {
     "name": "apprt-fetch",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": "./index.d.ts"
 }

package/apprt-streams/Stream.d.ts

@@ -304,7 +304,7 @@ declare abstract class Stream<T> implements Iterable<T> {
      * const result = Stream.from(items).take(1).toArray(); // [1]
      * ```
      *
-     * @count the number of elements to include in the returned stream
+     * @param count the number of elements to include in the returned stream
      */
     take(count: number): Stream<T>;
     /**

package/apprt-streams/package.json

@@ -1,5 +1,5 @@
 {
     "name": "apprt-streams",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": ""
 }

package/apprt-tokens/package.json

@@ -1,5 +1,5 @@
 {
     "name": "apprt-tokens",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": ""
 }

package/apprt-vue/package.json

@@ -1,5 +1,5 @@
 {
     "name": "apprt-vue",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": "./index.d.ts"
 }

package/apprt-vuetify/RegisterVuetify.d.ts

@@ -1,2 +1,2 @@
 
-export {  }
+export { };

package/apprt-vuetify/components/copyText.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copies text to the user's clipboard.
+ *
+ * Returns `true` on success and `false` on failure.
+ */
+declare function copyText(text: string): Promise<boolean>;
+
+export { copyText };

package/apprt-vuetify/package.json

@@ -1,5 +1,5 @@
 {
     "name": "apprt-vuetify",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": ""
 }

package/coordinateconversion/api.d.ts

@@ -0,0 +1,182 @@
+import Point from '@arcgis/core/geometry/Point';
+import SpatialReference from '@arcgis/core/geometry/SpatialReference';
+
+/**
+ * Parsing succeeded and returned a valid value.
+ */
+interface ParseSuccess<T> {
+    kind: "success";
+    value: T;
+}
+/**
+ * Parsing resulted in an error.
+ */
+interface ParseError {
+    kind: "error";
+    /**
+     * Human readable error message.
+     * This message may be presented to the user.
+     */
+    message?: string;
+}
+/**
+ * The result of parsing inputs.
+ */
+type ParseResult<T> = ParseSuccess<T> | ParseError;
+/**
+ * Implements a format for coordinate conversions.
+ *
+ * You can extend the builtin set of formats by providing a service with `"coordinateconversion.SegmentedFormat"`.
+ */
+interface SegmentedFormat {
+    /**
+     * Unique id of this format.
+     */
+    readonly id: string;
+    /**
+     * Human readable label of this format.
+     */
+    readonly label: string;
+    /**
+     * Input segments required by the format, for example `x` and `y` coordinates.
+     * The coordinate conversion widget shows one input field for each segment.
+     */
+    readonly segments: CoordinateSegment[];
+    /**
+     * When specified, points will be projected to this spatial reference before being passed to {@link pointToSegments}.
+     *
+     * If this is not specified, you will receive the point in the current spatial reference of the view, and
+     * you will have to perform any necessary projections yourself.
+     */
+    readonly spatialReference?: SpatialReference;
+    /**
+     * Renders a point to _segment_ values.
+     * The returned record is indexed by segment ids and contains a string for each segment.
+     *
+     * The output of this function should be compatible with {@link segmentsToPoint}.
+     *
+     * Example:
+     *
+     * ```js
+     * const point = ...;
+     * const segments = format.pointToSegments(point);
+     * // segments == { x: "...", y: "..." }
+     * ```
+     */
+    pointToSegments(point: Point): Promise<Record<string, string>>;
+    /**
+     * Formats a set of _segment_ values to a human readable string.
+     * This combines the segment values to a final display string, including separating characters (like ',' or ' ')
+     * and units (like '°' and '"').
+     *
+     * The `segments` parameter can be assumed to contain valid strings: either
+     * - user input validated by {@link CoordinateSegment.validate} or
+     * - segment values generated by {@link pointToSegments}.
+     *
+     * The value returned here should be compatible with {@link stringToSegments}.
+     *
+     * Example:
+     *
+     * ```js
+     * const segments = { x: "1", y: "2" }
+     * const output = format.segmentsToString(segments);
+     * // output == "1°, 2°"
+     * ``
+     */
+    segmentsToString(segments: Record<string, string>): string;
+    /**
+     * Splits a human readable coordinates string (like returned by {@link segmentsToString}) into its input segment.
+     *
+     * For example:
+     *
+     * ```js
+     * const input = "123.4 567.8";
+     * const segments = format.stringToSegments(input).value; // assumes success
+     * // segments == { x: "123.4", y: "567.8" };
+     * ```
+     */
+    stringToSegments(input: string): ParseResult<Record<string, string>>;
+    /**
+     * Parses a set of (validated) segment values into a `Point`.
+     * This can be used, for example, to place a marker on the map.
+     *
+     * Example:
+     *
+     * ```js
+     * const segments = { x: "1", y: "2" }
+     * const point = await format.segmentsToPoint(segments).value; // assumes success
+     * // point == { x: 1234, y: 5678, spatialReference: { ... }}
+     * ```
+     */
+    segmentsToPoint(segments: Record<string, string>): Promise<ParseResult<Point>>;
+}
+/**
+ * A coordinate segment within a {@link SegmentedFormat}.
+ */
+interface CoordinateSegment {
+    /**
+     * Id of this segment.
+     *
+     * This should be unique within the context of its format.
+     */
+    id: string;
+    /**
+     * Human readable label for this coordinate segment (e.g. "Latitude").
+     */
+    label: string;
+    /**
+     * Example for this segment, like '51° 57' 40"N'
+     */
+    example?: string;
+    /**
+     * A prefix value that will be shown as part of the input field for this coordinate segment.
+     *
+     * This is a display-only field for strings that do not need to be typed by the user (such as "°").
+     */
+    prefix?: string;
+    /**
+     * A suffix value that will be shown as part of the input field for this coordinate segment.
+     *
+     * This is a display-only field for strings that do not need to be typed by the user (such as "°").
+     */
+    suffix?: string;
+    /**
+     * Validates an input string for this coordinate segment.
+     * `input` is the (trimmed) text typed by the user.
+     *
+     * This function should return `true` if the input is valid,
+     * or an error message otherwise.
+     *
+     * `validate()` usually only performs text based validation (e.g. regular expressions).
+     * Parsing the actual input string (using {@link SegmentedFormat.segmentsToPoint}) can return additional errors.
+     *
+     * Only valid inputs will be passed to {@link SegmentedFormat.segmentsToPoint}.
+     */
+    validate(input: string): true | false | ParseError;
+}
+/**
+ * A model that provides access to the current state of the coordinate conversion widget.
+ * Properties and methods are designed to be used together with the Reactivity API.
+ *
+ * It is available as service `coordinateconversion.Model`.
+ */
+interface CoordinateConversionModel {
+    /**
+     * True if the widget is currently active.
+     */
+    readonly active: boolean;
+    /**
+     * The current marker location, if any.
+     * This value represents explicit location inputs and also locations from mouse movements.
+     */
+    readonly currentLocation: Point | undefined;
+    /**
+     * The current marker location, if any.
+     *
+     * This value represents explicit location inputs only, i.e. if the user clicked on the map (not just moving the mouse)
+     * or confirmed the input form.
+     */
+    readonly confirmedLocation: Point | undefined;
+}
+
+export type { CoordinateConversionModel, CoordinateSegment, ParseError, ParseResult, ParseSuccess, SegmentedFormat };

package/coordinateconversion/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "coordinateconversion",
+    "version": "4.20.2-RC-1",
+    "types": ""
+}

package/coordinatetransformer/api/CoordinateTransformer.d.ts

@@ -1,5 +1,7 @@
-import { SpatialReference, Geometry, Extent } from 'esri/geometry';
-import BaseGeometry from 'esri/geometry/Geometry';
+import { Geometry } from '@arcgis/core/geometry';
+import SpatialReference from '@arcgis/core/geometry/SpatialReference';
+import Extent from '@arcgis/core/geometry/Extent';
+import BaseGeometry from '@arcgis/core/geometry/Geometry';
 
 /** Helper type to represent an item or an array of items. */
 type Items<T> = T | T[];
@@ -19,7 +21,7 @@ interface Coordinates {
  * const wgs84String = "EPSG:4326";
  * const wgs84Wkid   = 4326;
  *
- * import SpatialReference from "esri/geometry/SpatialReference";
+ * import SpatialReference from "@arcgis/core/geometry/SpatialReference";
  * const wgs84 = new SpatialReference({wkid:4326});
  * ```
  */
@@ -82,7 +84,7 @@ type CoordinateModificationCallback = (input: Readonly<Coordinates>) => Coordina
  * ```ts
  * import { InjectedReference } from "apprt-core/InjectedReference";
  * import { CoordinateTransformer } from "coordinatetransformer/CoordinateTransformer";
- * import { Geometry } from "esri/geometry";
+ * import { Geometry } from "@arcgis/core/geometry";
  *
  * export default class MyComponent {
  *     private coordinateTransformer: InjectedReference<CoordinateTransformer>;

package/coordinatetransformer/api/ProjectionStore.d.ts

@@ -1,7 +1,9 @@
 import { Store } from 'store-api/api';
 import { Projection } from './CoordinateTransformer.js';
-import 'esri/geometry';
-import 'esri/geometry/Geometry';
+import '@arcgis/core/geometry';
+import '@arcgis/core/geometry/SpatialReference';
+import '@arcgis/core/geometry/Extent';
+import '@arcgis/core/geometry/Geometry';
 
 /**
  * Store which provides access to the available projections via the store interface.

package/coordinatetransformer/api/TransformationProvider.d.ts

@@ -1,8 +1,10 @@
-import { SpatialReference } from 'esri/geometry';
-import GeographicTransformation from 'esri/geometry/support/GeographicTransformation';
-import GeographicTransformationStep from 'esri/geometry/support/GeographicTransformationStep';
+import SpatialReference from '@arcgis/core/geometry/SpatialReference';
+import GeographicTransformation from '@arcgis/core/geometry/operators/support/GeographicTransformation';
+import GeographicTransformationStep from '@arcgis/core/geometry/operators/support/GeographicTransformationStep';
 import { Items } from './CoordinateTransformer.js';
-import 'esri/geometry/Geometry';
+import '@arcgis/core/geometry';
+import '@arcgis/core/geometry/Extent';
+import '@arcgis/core/geometry/Geometry';
 
 /**
  * A transformation provider supplies custom transformations between spatial reference systems.

package/coordinatetransformer/api/TransformerStrategy.d.ts

@@ -1,6 +1,8 @@
-import { Geometry, SpatialReference } from 'esri/geometry';
+import { Geometry } from '@arcgis/core/geometry';
+import SpatialReference from '@arcgis/core/geometry/SpatialReference';
 import { Items } from './CoordinateTransformer.js';
-import 'esri/geometry/Geometry';
+import '@arcgis/core/geometry/Extent';
+import '@arcgis/core/geometry/Geometry';
 
 /**
  * A transformer strategy is an interface used by the CoordinateTransformer

package/coordinatetransformer/api/index.d.ts

@@ -2,8 +2,10 @@ export { CoordinateModificationCallback, CoordinateTransformer, Coordinates, Ite
 export { TransformationProvider } from './TransformationProvider.js';
 export { TransformerStrategy } from './TransformerStrategy.js';
 export { ProjectionStore } from './ProjectionStore.js';
-import 'esri/geometry';
-import 'esri/geometry/Geometry';
-import 'esri/geometry/support/GeographicTransformation';
-import 'esri/geometry/support/GeographicTransformationStep';
+import '@arcgis/core/geometry';
+import '@arcgis/core/geometry/SpatialReference';
+import '@arcgis/core/geometry/Extent';
+import '@arcgis/core/geometry/Geometry';
+import '@arcgis/core/geometry/operators/support/GeographicTransformation';
+import '@arcgis/core/geometry/operators/support/GeographicTransformationStep';
 import 'store-api/api';

package/coordinatetransformer/package.json

@@ -1,5 +1,5 @@
 {
     "name": "coordinatetransformer",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": ""
 }

package/ct/async.d.ts

@@ -1,4 +1,4 @@
-declare function hitch(scope: any, cb: any, ...args: any[]): (...args: any[]) => any;
+declare function hitch(scope: any, cb: any, ...args: any[]): () => any;
 declare function join(arr: any): any;
 declare function queue(): {
     cancel: () => void;

package/ct/mapping/geometry.d.ts

@@ -1,7 +1,7 @@
-import SpatialReference from 'esri/geometry/SpatialReference';
-import Point from 'esri/geometry/Point';
-import Extent from 'esri/geometry/Extent';
-import TimeExtent from 'esri/time/TimeExtent';
+import SpatialReference from '@arcgis/core/geometry/SpatialReference';
+import Point from '@arcgis/core/geometry/Point';
+import Extent from '@arcgis/core/geometry/Extent';
+import TimeExtent from '@arcgis/core/time/TimeExtent';
 
 declare namespace exports {
     export { createSpatialReference };
@@ -111,7 +111,7 @@ declare function equalSpatialReference(a: any, b: any): boolean;
  * var point = ctgeometry.createPoint(e);
  *
  */
-declare function createPoint(params?: any, ...args: any[]): Point;
+declare function createPoint(_params: any, ...args: any[]): Point;
 /**
  * Function to create an instance of {.Extent} by some alternative arguments.
  * @param [params] an init object or an argument list, see the sample.
@@ -256,7 +256,7 @@ declare function equalTimeExtent(a: any, b: any): boolean;
  */
 declare function correctAspectRatio(extentIn: any, extentReference: any): Extent;
 /**
- * Checks geometry equality, coordinate equality checked by esri/geometry/mathUtils._equals, which uses an epsilon of
+ * Checks geometry equality, coordinate equality checked by @arcgis/core/geometry/mathUtils._equals, which uses an epsilon of
  * 1e-8 for number compare.
  */
 declare function equal(gA: any, gB: any, eps: any): any;

package/ct/package.json

@@ -1,5 +1,5 @@
 {
     "name": "ct",
-    "version": "4.20.1",
+    "version": "4.20.2-RC-1",
     "types": "./main.d.ts"
 }