@vertigis/arcgis-extensions 49.9.0 → 50.0.1

package/support/observableUtils.d.ts

@@ -0,0 +1,560 @@
+import Accessor from "@arcgis/core/core/Accessor";
+import Collection from "@arcgis/core/core/Collection.js";
+import type Evented from "@arcgis/core/core/Evented.js";
+import { type ObservableMap } from "../utilities/ObservableMap.js";
+import type { ObservableSet } from "../utilities/ObservableSet.js";
+/**
+ * Represents an observable object. This can be an esri class that extends
+ * Accessor and implements esri's property watch functionality or an object that
+ * has been made observable via the {@link support/observableUtils!observable}
+ * mixin.
+ */
+export type Observable = ObservableMixin | Accessor;
+/**
+ * Represents an object that is collection like and can be observed. This can be
+ * an esri collection, an ObservableMap, or an ObservableSet.
+ */
+type ObservableCollectionLike<T> = Collection<T> | ObservableMap<any, T> | ObservableSet<T>;
+/**
+ * Represents a path to a property on an observable or esri class with a base
+ * class of accessor. Only traverses to 3 levels deep.
+ *
+ * Examples:
+ *
+ * "foo" | "bar.baz" | "foo.bar.baz" | "foo.bar.baz.qux".
+ *
+ * Note: This is a complex recursive type that should only be used for function
+ * definitions related to the observable watch system. It is not intended to be
+ * used for general purposes and should not be used by casts or other type
+ * manipulations. Do not set the Depth type parameter.
+ */
+export type ObservablePropertyPath<T extends Observable, Depth extends number[] = []> = Depth["length"] extends 3 ? never : NestedObjectPaths<T, Depth>;
+type NestedObjectPaths<T extends Observable, Depth extends number[]> = {
+    [K in Extract<keyof T, string>]-?: [NonNullable<T[K]>] extends [never] ? never : NonNullable<T[K]> extends Observable ? K | `${K}.${ObservablePropertyPath<NonNullable<T[K]>, [...Depth, 0]>}` : K;
+}[Extract<keyof T, string>];
+/**
+ * Represents a path to a property on an observable or esri class with a base
+ * class of accessor in a collection. Only traverse to 2 levels deep to the
+ * collection then 1 level into the object type in the collection.
+ *
+ * This will build paths into the objects of the collections if the collection
+ * is properly typed and contains observables or accessors. Collections are only
+ * supported at the first and second level of the path as well as being the root
+ * of the path. It is only possible to watch up to two properties deep into the
+ * object in a collection. This helps stave off some performance issues with the
+ * type system.
+ *
+ * Examples:
+ *
+ * "[].foo" | "[].foo.bar".
+ *
+ * "foo.[].bar" | "foo.[].bar.baz" | "foo.bar.[].baz" | "foo.bar.[].baz.qux".
+ */
+type CollectionPropertyPath<T extends Observable, Depth extends number[] = []> = Depth["length"] extends 2 ? never : T extends ObservableCollectionLike<infer ItemType> ? ItemType extends Observable ? `[].${DeepObjectPaths<ItemType>}` : never : NestedCollectionPropertyPath<T, Depth>;
+type NestedCollectionPropertyPath<T, Depth extends number[]> = {
+    [K in Extract<keyof T, string>]-?: [NonNullable<T[K]>] extends [never] ? never : NonNullable<T[K]> extends ObservableCollectionLike<infer ItemType> ? ItemType extends Observable ? `${K}.[].${DeepObjectPaths<ItemType>}` : never : NonNullable<T[K]> extends Observable ? `${K}.${CollectionPropertyPath<NonNullable<T[K]>, [...Depth, 0]>}` : never;
+}[Extract<keyof T, string>];
+type DeepObjectPaths<T extends Observable> = {
+    [K in Extract<keyof T, string>]-?: [NonNullable<T[K]>] extends [never] ? never : K;
+}[Extract<keyof T, string>];
+/**
+ * The type of the value at the end of a path created from
+ * ObservablePropertyPath or CollectionPropertyPath. Only intended for use with
+ * ObservablePropertyPath or CollectionPropertyPath.
+ *
+ * Because the path was built with ObservablePropertyPath or
+ * CollectionPropertyPath, we know that the path is valid. We still have to
+ * build out the conditionals for the type system to understand what we are
+ * doing, but we don't need to handle the false cases.
+ *
+ * This type uses recursion without any depth limits because the path is
+ * guaranteed to be valid and of a limited depth.
+ *
+ * Note: This is a complex recursive type that should only be used for function
+ * definitions related to the observable watch system. It is not intended to be
+ * used for general purposes and should not be used by casts or other type
+ * manipulations.
+ */
+export type ValueTypeFromPath<T extends Observable, P extends string> = P extends keyof T ? T[P] : P extends `[].${infer ItemPath}` ? [
+    T
+] extends [ObservableCollectionLike<infer ItemType>] ? ItemType extends Observable ? ItemPath extends keyof ItemType ? ItemType[ItemPath] : ValueTypeFromPath<ItemType, ItemPath> : unknown : unknown : P extends `${infer K}.${infer Rest}` ? K extends keyof T ? [T[K]] extends [Observable | undefined | null] ? Rest extends `[].${string}` ? ValueTypeFromPath<NonNullable<T[K]>, Rest> : // Keep recursing through the path to get the type of the
+ValueTypeFromPath<NonNullable<T[K]>, Rest> | (undefined extends T[K] ? undefined : never) : unknown : unknown : unknown;
+/**
+ * The type of the target at the second to last position of a path created from
+ * ObservablePropertyPath or CollectionPropertyPath. Only intended for use with
+ * ObservablePropertyPath or CollectionPropertyPath.
+ *
+ * Because the path was built with ObservablePropertyPath or
+ * CollectionPropertyPath, we know that the path is valid. We still have to
+ * build out the conditionals for the type system to understand what we are
+ * doing, but we don't need to handle the false cases.
+ *
+ * This type uses recursion without any depth limits because the path is
+ * guaranteed to be valid and of a limited depth.
+ *
+ * Note: This is a complex recursive type that should only be used for function
+ * definitions related to the observable watch system. It is not intended to be
+ * used for general purposes and should not be used by casts or other type
+ * manipulations.
+ */
+export type TargetTypeFromPath<T extends Observable, P extends string> = P extends keyof T ? T : P extends `[].${infer ItemPath}` ? [
+    T
+] extends [ObservableCollectionLike<infer ItemType>] ? ItemType extends Observable ? ItemPath extends keyof ItemType ? ItemType : TargetTypeFromPath<ItemType, ItemPath> : unknown : unknown : P extends `${infer K}.${infer Rest}` ? K extends keyof T ? [T[K]] extends [Observable | undefined | null] ? Rest extends `[].${string}` ? TargetTypeFromPath<NonNullable<T[K]>, Rest> : // Keep recursing through the path to get the type of the
+TargetTypeFromPath<NonNullable<T[K]>, Rest> | (undefined extends T[K] ? undefined : never) : unknown : unknown : T;
+/**
+ * The type of the path to a property that is an evented object in an observable
+ * or esri class. Limits the depth of the path to 3 levels deep.
+ */
+type EventedPropertyPath<T extends Observable, Depth extends number[] = []> = Depth["length"] extends 3 ? never : NestedEventedPropertyPath<T, Depth>;
+type NestedEventedPropertyPath<T extends Observable, Depth extends number[]> = {
+    [K in Extract<keyof T, string>]-?: [NonNullable<T[K]>] extends [never] ? never : NonNullable<T[K]> extends Observable ? (NonNullable<T[K]> extends Evented ? K : never) | `${K}.${EventedPropertyPath<NonNullable<T[K]>, [...Depth, 0]>}` : NonNullable<T[K]> extends Evented ? K : never;
+}[Extract<keyof T, string>];
+/**
+ * The type of the value at the end of a path created from EventedPropertyPath.
+ * Only intended for use with EventedPropertyPath.
+ *
+ * Because the path was built with ObservablePropertyPath, we know that the path
+ * is valid. We still have to build out the conditionals for the type system to
+ * understand what we are doing, but we don't need to handle the false cases.
+ *
+ * This type uses recursion without any depth limits because the path is
+ * guaranteed to be valid and of a limited depth.
+ */
+type EventedTypeFromPath<T extends Observable, P extends string> = P extends keyof T ? T[P] : P extends `${infer K}.${infer Rest}` ? K extends keyof T ? NonNullable<T[K]> extends Observable ? // Keep recursing through the path to get the type of the
+EventedTypeFromPath<NonNullable<T[K]>, Rest> | (undefined extends T[K] ? undefined : never) : unknown : unknown : unknown;
+type OverloadProps<TOverload> = Pick<TOverload, keyof TOverload>;
+type OverloadUnionRecursive<TOverload, TPartialOverload = unknown> = TOverload extends (...args: infer TArgs) => infer TReturn ? TPartialOverload extends TOverload ? never : OverloadUnionRecursive<TPartialOverload & TOverload, TPartialOverload & ((...args: TArgs) => TReturn) & OverloadProps<TOverload>> | ((...args: TArgs) => TReturn) : never;
+type OverloadUnion<TOverload extends (...args: any[]) => any> = Exclude<OverloadUnionRecursive<(() => never) & TOverload>, TOverload extends () => never ? never : () => never>;
+type OverloadParameters<T extends (...args: any[]) => any> = Parameters<OverloadUnion<T>>;
+/**
+ * Options for {@link support/observableUtils!watch}.
+ */
+export interface WatchOptions {
+    /**
+     * If true, the watch callback will be invoked immediately with the current
+     * value of the property being watched. Both the newValue and oldValue
+     * parameters will be set to the current value.
+     *
+     * If sync is also true, the callback invoked with the initial value will be
+     * synchronous. Otherwise it will be asynchronous.
+     *
+     * @default false
+     */
+    initial?: boolean;
+    /**
+     * If true, the watch callback will be invoked synchronously. If false, the
+     * watch callback will be invoked asynchronously.
+     *
+     * @default false
+     */
+    sync?: boolean;
+    /**
+     * If true, the watch callback will only be invoked once and then the remove
+     * handle will be called. If false, the watch callback will be invoked each
+     * time the watched property changes.
+     *
+     * If sync is also true, the callback will be invoked synchronously.
+     * Otherwise it will be asynchronous.
+     *
+     * @default false
+     */
+    once?: boolean;
+}
+/**
+ * Options for {@link support/observableUtils!watchEach}.
+ */
+export interface WatchEachOptions extends WatchOptions {
+    /**
+     * If true, the watch callback will be invoked immediately for each object
+     * in the collection with the current value of the property being watched,
+     * as well as any item added to the collection. Both the newValue and
+     * oldValue parameters will be set to the current value of the object in the
+     * collection.
+     *
+     * If sync is also true, the callback invoked with the initial value will be
+     * synchronous. Otherwise it will be asynchronous.
+     *
+     * @default false
+     */
+    initial?: boolean;
+    /**
+     * If true, the watch callback will be invoked once for each object in the
+     * collection as well as once for each item added to the collection. If
+     * false, the watch callback will be invoked each time the watched property
+     * changes for each item in the collection.
+     *
+     * If sync is also true, the callback will be invoked synchronously.
+     * Otherwise it will be asynchronous.
+     *
+     * @default false
+     */
+    once?: boolean;
+}
+/**
+ * Options for {@link support/observableUtils!when}.
+ */
+export type WhenOptions = Omit<WatchOptions, "initial"> & {
+    /**
+     * If true, the when callback will be invoked if the value is falsy. If
+     * false, the when callback will be invoked if the value is truthy.
+     *
+     * @default false
+     */
+    invert?: boolean;
+};
+/**
+ * Returned by {@link support/observableUtils!watch}.
+ *
+ * Call `remove` to stop watching.
+ */
+export interface IHandle {
+    /**
+     * Stops watching the property.
+     *
+     * Any pending asynchronous callbacks (watch options used `sync: false`)
+     * that have not yet been invoked will also be stopped and not invoked. This
+     * includes the callback invoked with the initial value (watch options used
+     * `initial: true`).
+     */
+    remove(): void;
+}
+/**
+ * Supporting mixin declaration for {@link support/observableUtils!observable}.
+ */
+export declare class ObservableMixin {
+    private readonly __isObservable;
+    private readonly _subscribedPaths;
+    private readonly _onWatchPaths;
+    private readonly _esriProps;
+    private _onWatch;
+    private _notifyChange;
+    private _watch;
+    private _recurseWatch;
+    private _recurseCollectionWatch;
+    private _collectionWatch;
+    private _watchSingle;
+    private _createWatchDescriptor;
+    private _createSingleWatchRemoveHandle;
+}
+/**
+ * Mixin to add observable functionality to a class.
+ *
+ * Observability allows you to watch for changes to properties on an object.
+ *
+ * Observability is handled by this mixin but if you have an accessor property
+ * that is backed by a backing field and that backing field is updated
+ * separately from the accessor set, you must call
+ * {@link support/observableUtils!notifyChange} for the accessor property after
+ * the backing field has changed to ensure watchers are notified of the change.
+ *
+ * The implementation of the mixin expects that accessor properties with a
+ * setter use the value given to the setter as the new value that will be
+ * returned by the getter.
+ *
+ * See {@link support/observableUtils!watch}.
+ *
+ * See {@link support/observableUtils!notifyChange}.
+ *
+ * See {@link support/observableUtils!onWatch}.
+ *
+ * See {@link support/observableUtils!watchEvent}.
+ *
+ * See {@link support/observableUtils!once}.
+ *
+ * Usage example of the mixin by wrapping a base class.
+ *
+ * ```ts
+ * class MyClass extends observable(BaseClass) {
+ *     foo: string = "foo";
+ * }
+ *
+ * const myClass = new MyClass();
+ * watch(myClass, "foo", (newValue, oldValue) => {});
+ * ```
+ *
+ * Usage example of the mixin used as a base class.
+ *
+ * ```ts
+ * export class MyClass extends observable() {
+ *     private _otherObservable: OtherObservable = new OtherObservable();
+ *
+ *     get foo(): string {
+ *         return this._otherObservable.foo;
+ *     }
+ *
+ *     constructor() {
+ *         super();
+ *
+ *         onWatch(this, "foo", () =>
+ *             watch(this._otherObservable, "foo", () => {
+ *                 notifyChange(this, "foo");
+ *             })
+ *         );
+ *     }
+ * }
+ * ```
+ *
+ * Usage example of the mixin by wrapping a class implementation.
+ *
+ * Note: while this pattern is supported, it is not recommended since it will
+ * not allow observable functionality to be used by the class in itself.
+ *
+ * ```ts
+ * const MyClass = observable(
+ *     class MyClass {
+ *         foo: string = "foo";
+ *     }
+ * );
+ *
+ * const myClass = new MyClass();
+ * watch(myClass, "foo", (newValue, oldValue) => {});
+ * ```
+ *
+ * @param obj The class to make observable.
+ */
+export declare function observable<T extends abstract new (...args: any[]) => any = new () => ObservableMixin>(obj?: T): T & (abstract new (...args: any[]) => ObservableMixin);
+/**
+ * Watches a property for changes. This can be a property on the given object or
+ * a property on a nested object if the nested object is also observable.
+ *
+ * This function will return a handle that can be used to stop watching the
+ * property.
+ *
+ * The callback will be invoked with the new value, old value, and the target
+ * object when the property changes. The target object is the object that
+ * contains the property that changed.
+ *
+ * The callback will not be invoked if the value has not changed. This includes
+ * if a parent property changes but the resulting value is the same as the
+ * previous value.
+ *
+ * If any property in the path can be undefined, the callback will be invoked
+ * with an undefined newValue and an undefined target when a parent property
+ * changes to undefined.
+ *
+ * ```ts
+ * class MyObservable extends observable() {
+ *     private _backingFieldForGetter = "backingFieldForGetter";
+ *     dataProperty: string = "dataProperty";
+ *
+ *     get getter() {
+ *       return this._backingFieldForGetter;
+ *     }
+ * }
+ *
+ * const myObservable = new MyObservable();
+ * watch(myObservable, "getter", (newValue, oldValue) => {});
+ * watch(myObservable, "dataProperty", (newValue, oldValue) => {});
+ *
+ * class MyClass extends observable() {
+ *    private _backingFieldForAccessor = new MyObservable();
+ *
+ *    get getterSetter {
+ *      return this._backingFieldForAccessor;
+ *    }
+ *    set getterSetter(value: MyObservable) {
+ *      this._backingFieldForAccessor = value;
+ *    }
+ * }
+ *
+ * const myClass = new MyClass();
+ * watch(myClass, "getterSetter", (newValue, oldValue) => {});
+ * watch(myClass, "getterSetter.getter", (newValue, oldValue) => {});
+ * watch(myClass, "getterSetter.dataProperty", (newValue, oldValue) => {});
+ * ```
+ *
+ * @param obj The object to watch.
+ * @param path The property path on the given object to watch.
+ * @param callback The callback to invoke when the property changes.
+ * @param options The options to use for watching the property.
+ * @throws Error if the object is not observable.
+ * @throws Error if the path is to a non-configurable property.
+ * @throws Error if the path is not a valid property path.
+ */
+export declare function watch<TObsv extends Observable, TPath extends ObservablePropertyPath<TObsv>, TValue extends ValueTypeFromPath<TObsv, TPath>, TTarget extends TargetTypeFromPath<TObsv, TPath>>(obj: TObsv, path: TPath, callback: (newValue: TValue, oldValue: TValue, target: TTarget) => void, options?: WatchOptions): IHandle;
+export declare function watch<TObsv extends Observable, TPath extends `${string}.${string}.${string}.${string}`, TValue extends ValueTypeFromPath<TObsv, TPath>, TTarget extends TargetTypeFromPath<TObsv, TPath>>(obj: TObsv, path: TPath, callback: (newValue: TValue, oldValue: TValue, target: TTarget) => void, options?: WatchOptions): IHandle;
+/**
+ * Watches a property for changes on each item in a collection like object. This
+ * can be a property on an item in a collection, an item in a collection in the
+ * given object or an item in a collection in a nested observable object.
+ *
+ * This function will return a handle that can be used to stop watching the
+ * property.
+ *
+ * If the collection contains multiple different types of objects, only objects
+ * that have the property being watched will be watched for changes, the other
+ * objects will be ignored.
+ *
+ * The callback will be invoked with the new value, old value, and the target
+ * object when the property changes. The target object will be the object in the
+ * collection that changed. The callback will be invoked for each item in the
+ * collection when the property on the object changes. The callback will not be
+ * invoked when items are added or removed from the collection unless the
+ * options include `initial: true` in which case the callback will be invoked
+ * for each item in the collection when the watch is created as well as for any
+ * items that are added to the collection after.
+ *
+ * The callback will not be invoked if the value has not changed. This includes
+ * if a parent property changes but the resulting value is the same as the
+ * previous value.
+ *
+ * If any property in the path after the path to the collection can be
+ * undefined, the callback will be invoked with an undefined newValue and an
+ * undefined target when a parent property changes to undefined.
+ *
+ * ```ts
+ * class MyObservable extends observable() {
+ *     property: string = "testProperty";
+ * }
+ *
+ * class MyClass extends observable() {
+ *     collection: Collection<MyObservable> = new Collection();
+ * }
+ *
+ * const myClass = new MyClass();
+ * watchEach(myClass, "collection.[].property", (newValue, oldValue) => {});
+ *
+ * const myCollection = new Collection<MyObservable>();
+ * watchEach(myCollection, "[].property", (newValue, oldValue) => {});
+ * ```
+ *
+ * @param obj The object to watch.
+ * @param path The property path on the given object to watch.
+ * @param callback The callback to invoke when the property changes.
+ * @param options The options to use for watching the property.
+ * @throws Error if the object is not observable.
+ * @throws Error if the path is to a non-configurable property.
+ * @throws Error if the path is not a valid property path.
+ */
+export declare function watchEach<TObsv extends Observable, TPath extends CollectionPropertyPath<TObsv>, TValue extends ValueTypeFromPath<TObsv, TPath>, TTarget extends TargetTypeFromPath<TObsv, TPath>>(obj: TObsv, path: TPath, callback: (newValue: TValue, oldValue: TValue, target: TTarget) => void, options?: WatchEachOptions): IHandle;
+export declare function watchEach<TObsv extends Observable, TPath extends `${string}.[].${string}.${string}` | `[].${string}.${string}`, TValue extends ValueTypeFromPath<TObsv, TPath>, TTarget extends TargetTypeFromPath<TObsv, TPath>>(obj: TObsv, path: TPath, callback: (newValue: TValue, oldValue: TValue, target: TTarget) => void, options?: WatchEachOptions): IHandle;
+/**
+ * Watches the given path on the given object for the first change.
+ *
+ * See {@link support/observableUtils!watch} for more details.
+ *
+ * @param obj The object to watch.
+ * @param path The property path to watch.
+ * @param options Optional. The options to use for watching the property.
+ * @param options.signal Optional signal to abort. The promise will be rejected
+ *   if the signal is aborted.
+ * @throws Error if the object is not observable.
+ * @throws Error if the path is to a non-configurable property.
+ * @throws Error if the path is not a valid property path.
+ */
+export declare function once<TObsv extends Observable, TPath extends ObservablePropertyPath<TObsv>>(obj: TObsv, path: TPath, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;
+/**
+ * Notifies any watchers that a property has changed. Will not notify if the
+ * value has not changed.
+ *
+ * Typically only used when a backing field for a getter only property has
+ * changed.
+ *
+ * @param obj The object with the property that changed.
+ * @param path The property that changed.
+ * @throws Error if the object is not observable.
+ */
+export declare function notifyChange<TObsv extends ObservableMixin, TPath extends keyof TObsv>(obj: TObsv, path: TPath): void;
+/**
+ * For the given object, if a watch is added to the given path the callback will
+ * be invoked. When all the watches are removed, the handle returned by the
+ * callback will be invoked.
+ *
+ * A common use case for this is to notify changes to a property only if someone
+ * is watching it, this avoids unnecessary work from the watch if no one is
+ * watching the property.
+ *
+ * ```ts
+ * class MyClass extends observable() {
+ *     _foo = "foo";
+ *     _bar = "bar";
+ *
+ *     get foo() {
+ *         return `${this._foo} ${this._bar}`;
+ *     }
+ *
+ *     get bar() {
+ *         return this._bar;
+ *     }
+ *     set bar(value: string) {
+ *         this._bar = value;
+ *     }
+ * }
+ *
+ * const myClass = new MyClass();
+ *
+ * onWatch(myClass, "foo", () =>
+ *     watch(myClass, "bar", () => notifyChange(myClass, "foo"), {
+ *         sync: true,
+ *     })
+ * );
+ * ```
+ *
+ * @param obj The object to watch.
+ * @param path The property to watch.
+ * @param callback The callback to invoke when the property is watched.
+ * @throws Error if the object is not observable.
+ */
+export declare function onWatch<TObsv extends ObservableMixin>(obj: TObsv, path: keyof TObsv, callback: () => IHandle): IHandle;
+/**
+ * Watches the given path on the given object for changes and automatically adds
+ * and removes the given event listener.
+ *
+ * @param obj The object to watch.
+ * @param path The property path to an Evented object on the given object to
+ *   watch.
+ * @param event The event and the listener to add to the Evented object.
+ * @param watchCallback The callback to invoke when the watched property
+ *   changes. This is optional and will be invoked with the Evented object being
+ *   watched.
+ * @throws Error if the object is not observable.
+ * @throws Error if the path is to a non-configurable property on an observable.
+ */
+export declare function watchEvent<TObsv extends Observable, TPath extends EventedPropertyPath<TObsv>, TTarget extends EventedTypeFromPath<TObsv, TPath>>(obj: TObsv, path: TPath, event: OverloadParameters<NonNullable<TTarget>["on"]>, watchCallback?: (newTarget: TTarget, oldTarget: TTarget) => void): IHandle;
+/**
+ * Watches the given path on the given object and invokes the callback when the
+ * value of the property becomes truthy.
+ *
+ * If the value of the property is already truthy, the callback will be invoked
+ * immediately.
+ *
+ * @param obj The object to watch.
+ * @param path The property path to watch.
+ * @param callback The callback to invoke when the property becomes truthy.
+ * @param options Optional. The options to use for watching the property.
+ */
+export declare function when<TObsv extends Observable, TPath extends ObservablePropertyPath<TObsv>>(obj: TObsv, path: TPath, callback: () => void, options?: WhenOptions): IHandle;
+export declare function when<TObsv extends Observable, TPath extends `${string}.${string}.${string}.${string}`>(obj: TObsv, path: TPath, callback: () => void, options?: WhenOptions): IHandle;
+/**
+ * Watches the given path on the given object for the first change that causes
+ * the value of the watched property to be truthy.
+ *
+ * See {@link support/observableUtils!watch} for more details.
+ *
+ * @param obj The object to watch.
+ * @param path The property path to watch.
+ * @param options Optional. The options to use for watching the property.
+ * @throws Error if the object is not observable.
+ * @throws Error if the path is to a non-configurable property on an observable.
+ */
+export declare function whenOnce<TObsv extends Observable, TPath extends ObservablePropertyPath<TObsv>>(obj: TObsv, path: TPath, options?: Pick<WhenOptions, "invert"> & {
+    /**
+     * The promise will be rejected if the signal is aborted.
+     */
+    signal?: AbortSignal;
+}): Promise<void>;
+/**
+ * Creates an IHandle that will remove all the handles in the given iterable
+ * when the returned handle is removed.
+ *
+ * This holds the reference to the iterable of handles so that the handles can
+ * be updated and the returned handle will remove the handles in the iterable
+ * even if added later when it is removed.
+ *
+ * @param handles An iterable of handles to remove when the returned handle is
+ *   removed.
+ */
+export declare function createIHandle(handles: Iterable<IHandle>): IHandle;
+export {};

package/support/observableUtils.js

@@ -0,0 +1 @@
+import t from"@arcgis/core/core/Accessor";import e from"@arcgis/core/core/Collection.js";import{Property as r}from"@arcgis/core/core/accessorSupport/Property";import{trackAccess as n}from"@arcgis/core/core/accessorSupport/tracking";import{watch as o}from"@arcgis/core/core/reactiveUtils";import{}from"../utilities/ObservableMap.js";function s(t){return null!=t&&"object"==typeof t&&"__isObservable"in t&&t.__isObservable}function i(t){if(s(t))return t}function c(e){return e instanceof t}function a(t){return t instanceof e||null!=t&&"esri.core.Collection"===t.declaredClass}function l(t){return s(t)&&"ObservableMap"===t[Symbol.toStringTag]}function u(t){return a(t)||l(t)||function(t){return s(t)&&"ObservableSet"===t[Symbol.toStringTag]}(t)}class h{}export function observable(t){return class extends(t??h){__isObservable=!0;_subscribedPaths=new Map;_onWatchPaths=new Map;_esriProps=new Map;constructor(...t){return super(...t),function(t){return new Proxy(t,{get:(t,e,r)=>{if("_esriProps"===e)return Reflect.get(t,e,r);const o=Reflect.get(t,e,r);let s=t._esriProps.get(e);return null==s&&(s=new w(e.toString(),o),t._esriProps.set(e,s)),n(s),o},set:(t,e,r,n)=>{if(Reflect.set(t,e,r,n),"_esriProps"===e)return!0;const o=t._esriProps.get(e);if(o){if(!o.invalidated&&r===o.currentValue)return!0;o.invalidate(),o.currentValue=r,o.commit()}return!0}})}(this)}_onWatch(t,e){let r,n;"string"==typeof t?(r=t,n=e):n=t;let o=this._onWatchPaths.get(r);if(null==o&&(o=[],this._onWatchPaths.set(r,o)),o.push(n),null!=r&&this._subscribedPaths.has(r)){this._subscribedPaths.get(r).onWatchHandles.set(n,n())}else if(null==r&&this._subscribedPaths.size>0)for(const[t,e]of this._subscribedPaths){const r=n(t);e.onWatchHandles.set(n,r)}const s=new WeakRef(this);return{remove:()=>{const t=s.deref();if(null==t)return;if(!t._onWatchPaths.has(r))return;const e=t._onWatchPaths.get(r),o=e.indexOf(n);if(-1!==o&&e.splice(o,1),null!=r&&t._subscribedPaths.has(r)){const e=t._subscribedPaths.get(r),o=e.onWatchHandles.get(n);null!=o&&(o.remove(),e.onWatchHandles.delete(n))}else if(null==r&&t._subscribedPaths.size>0)for(const[,e]of t._subscribedPaths){const t=e.onWatchHandles.get(n);null!=t&&(t.remove(),e.onWatchHandles.delete(n))}0===e.length&&t._onWatchPaths.delete(r)}}}_notifyChange(t){let e;e=null==t?this._subscribedPaths.keys():[t];for(const t of e){if(this._esriProps.has(t)){const e=this._esriProps.get(t),r=this[t];r!==e.currentValue&&(e.invalidate(),e.currentValue=r,e.commit())}const e=this._subscribedPaths.get(t);if(null==e)continue;const r=e.currentValue,n=this[t];if(Object.is(n,r))continue;e.currentValue=n;const o=[...e.callbacks];for(const t of o)t(n,r,this)}}_watch(t,e,r){const n=[];if(t.includes(".")){if(t.includes("[]"))return this._recurseCollectionWatch(t,e,r);const o=t.split("."),s=o.shift(),i=new AbortController,{signal:c}=i,a=new WeakRef(this);let l;const u=v(e,t),h=()=>{if(c.aborted)return void(l=void 0);const t=a.deref();if(null==t){for(const t of n)t.remove();return n.length=0,void(l=void 0)}let e=t[s],r=t;for(let t=0;t<o.length;t++)if(r=e,e=e?.[o[t]],null==e){t<o.length-1&&(r=void 0);break}if(e!==l){const t=l;l=e,u(e,t,r)}},f=r?.sync?v(h,t):_(h,t,c);let b,p,w;if([l,w,b,p]=this._recurseWatch(t,f),n.push(g(b,p)),r?.initial){(r?.sync?v(e,t):_(e,t,c))(l,l,w)}return d(n,i)}return this._watchSingle(t,e,r)}_recurseWatch(t,e){const r=t.split("."),n=r.shift(),o=[];let a,l;if(r.length>0){const t=this[n];if(s(t)){const[n,s,c,u]=i(t)._recurseWatch(r.join("."),e);o.push(g(c,u)),a=n,l=s}else if(c(t)){const[n,s,i]=f(t,r,e,{sync:!0});o.push(i),a=n,l=s}}const u=this._watchSingle(n,((t,n)=>{if(t!==n){if(r.length>0){if(s(n)||c(n)){for(const t of o)t.remove();o.length=0}if(s(t)){const[,,n,s]=i(t)._recurseWatch(r.join("."),e);o.push(g(n,s))}else if(c(t)){const[,,n]=f(t,r,e,{sync:!0});o.push(n)}}e()}}),{sync:!0});return[r.length>0?a:this._subscribedPaths.get(n).currentValue,r.length>0?l:this,o,u]}_recurseCollectionWatch(t,e,r){const n=t.split("."),o=n.shift();if("[]"===n[0])return this._collectionWatch(o,n,e,r);{const t=[],a=this._watchSingle(o,(o=>{for(const e of t)e.remove();t.length=0,s(o)?t.push(i(o)._recurseCollectionWatch(n.join("."),e,r)):c(o)&&t.push(f(o,n,e,r)[2])})),l=this[o];return s(l)?t.push(i(l)._recurseCollectionWatch(n.join("."),e,r)):c(l)&&t.push(f(l,n,e,r)[2]),g(t,a)}}_collectionWatch(t,e,r,n){const o=[];u(this[t])&&o.push(b(this[t],e.join("."),r,n));const s=this._watchSingle(t,((t,s)=>{if(u(s)){for(const t of o)t.remove();o.length=0}u(t)&&o.push(b(t,e.join("."),r,n))}),{sync:!0});return g(o,s)}_watchSingle(t,e,r){let n=this._subscribedPaths.get(t)?.callbacks;if(null==n){let e=Object.getOwnPropertyDescriptor(this,t),r=this;for(;null==e&&(r=Object.getPrototypeOf(r),null!=r);)e=Object.getOwnPropertyDescriptor(r,t);if(null==e)return console.warn(`[observableUtils]: The property ${t.toString()} you are trying to watch does not exist on the object and will not be watched. This is likely a coding error. Please check the property name and ensure it exists on the object. In the future this will throw an exception.`),{remove:()=>{}};if(!1===e.configurable)return console.warn(`[observableUtils]: Property "${t.toString()}" is not configurable so it cannot be watched. In the future this will throw an exception.`),{remove:()=>{}};n=[];const o=new Map;if(this._subscribedPaths.set(t,{callbacks:n,currentValue:this[t],onWatchHandles:o}),!0!==e.writable&&null==e.set||(this._subscribedPaths.get(t).originalDescriptor=e,null!=e.value&&(e.value=void 0),this._createWatchDescriptor(t,e)),this._onWatchPaths.has(t))for(const e of this._onWatchPaths.get(t))o.set(e,e());if(this._onWatchPaths.has(void 0))for(const e of this._onWatchPaths.get(void 0))o.set(e,e(t))}const o=new AbortController,s=v(e,t.toString()),{currentValue:i}=this._subscribedPaths.get(t);let c=i;const a=(t,e,r)=>{const n=c;c=t,s(t,n,r)},l=r?.sync?v(a,t.toString()):_(a,t.toString(),o.signal);return n.push(l),r?.initial&&l(i,i,this),this._createSingleWatchRemoveHandle(t,l,o)}_createWatchDescriptor(t,e){const r={configurable:!0,enumerable:e.enumerable};null==e.get?(r.get=()=>this._subscribedPaths.get(t).currentValue,r.set=e=>{const r=this._subscribedPaths.get(t),n=r.currentValue;if(Object.is(n,e))return;r.currentValue=e;const o=[...r.callbacks];for(const t of o)t(e,n,this)}):(r.get=e.get,r.set=r=>{const n=this._subscribedPaths.get(t),o=n.currentValue;if(Object.is(o,r))return void e.set.call(this,r);n.currentValue=r,e.set.call(this,r);const s=[...n.callbacks];for(const t of s)t(r,o,this)}),Object.defineProperty(this,t,r)}_createSingleWatchRemoveHandle(t,e,r){const n=new WeakRef(this);return{remove:()=>{r.abort();const o=n.deref();if(null==o)return;if(!o._subscribedPaths.has(t))return;const{callbacks:s}=o._subscribedPaths.get(t),i=s.indexOf(e);if(i>=0&&s.splice(i,1),0===s.length){const e=o._subscribedPaths.get(t);o._subscribedPaths.delete(t);for(const t of e.onWatchHandles.values())t.remove();null!=e.originalDescriptor&&(null==e.originalDescriptor.get&&(e.originalDescriptor.value=e.currentValue),Object.defineProperty(o,t,e.originalDescriptor))}}}}}}export function watch(t,e,r,n){if(!s(t)&&c(t))return f(t,e.split("."),r,n)[2];const o=i(t);if(null==o)throw new Error("Object is not observable");if(n?.once){let t;const s=new AbortController,{signal:i}=s,c=n?.sync?v(r,e):_(r,e,i);let a=!1;const l=(e,r,n)=>{i.aborted||(a=!0,t?.remove(),t=void 0,c(e,r,n))};t=o._watch(e,l,{...n,sync:!0});const u=d([t],s);return a&&u.remove(),u}return o._watch(e,r,n)}export function watchEach(t,e,r,n){if(u(t)&&e.startsWith("[]."))return b(t,e,r,n);if(!s(t)&&c(t))return f(t,e.split("."),r,n)[2];const o=i(t);if(null==o)throw new Error("Object is not observable");return o._watch(e,r,n)}export async function once(t,e,r){const{signal:n}=r??{};return new Promise(((r,o)=>{if(n?.aborted)return void o();const s=()=>{i.remove(),o()},i=watch(t,e,(()=>{n?.removeEventListener("abort",s),r()}),{once:!0});n?.addEventListener("abort",s)}))}export function notifyChange(t,e){const r=i(t);if(null==r)throw new Error("Object is not observable");if(null!=e&&"string"!=typeof e)throw new Error("Path must be a string");r._notifyChange(e)}export function onWatch(t,e,r){const n=i(t);if(null==n)throw new Error("Object is not observable");if("string"==typeof e)return n._onWatch(e,r);if("function"!=typeof e)throw new Error("Path must be a string or a function");return n._onWatch(e)}export function watchEvent(t,e,r,n){const o=r[0],s=r[1],i=new WeakMap,c=new Set;let a;return a=watch(t,e,((t,e)=>{if(null!=e&&i.has(e)){const t=i.get(e);t.remove(),i.delete(e),c.delete(t)}if(null!=t&&!i.has(t)){const e=t.on(o,s);i.set(t,e),c.add(e)}t!==e&&n?.(t,e)}),{sync:!0,initial:!0}),g(c,a)}export function when(t,e,r,n){const{invert:o=!1,once:s,...i}=n??{};let c;const a=v(r,e);let l=!1;return c=watch(t,e,(t=>{!t===o&&(a(),s&&(l=!0,c?.remove(),c=void 0))}),{...i,initial:!0}),s&&l&&c?.remove(),c}export function whenOnce(t,e,r){const{signal:n,invert:o=!1}=r??{};return new Promise(((r,s)=>{if(n?.aborted)return void s();const i=()=>{n?.removeEventListener("abort",i),c.remove(),s()},c=when(t,e,(()=>{n?.aborted||(n?.removeEventListener("abort",i),r())}),{invert:o,once:!0});n?.addEventListener("abort",i)}))}export function createIHandle(t){return{remove:()=>{for(const e of t)e.remove()}}}function f(t,e,r,n){const s=e.indexOf("[]");if(-1!==s){const o=e.slice(0,s),i=e.slice(s),c=[],[a,l,h]=f(t,o,((t,e)=>{if(u(e)){for(const t of c)t.remove();c.length=0}u(t)&&c.push(b(t,i.join("."),r,n))}),{sync:!0});return u(a)&&c.push(b(a,i.join("."),r,n)),[a,l,g(c,h)]}return function(t,e,r,n){const s=new WeakRef(t);let i;const c=()=>{let t=s.deref();if(null==t)return i?.remove(),[void 0,void 0];let r=t;for(let n=0;n<e.length;n++)if(t=r,r=t[e[n]],null==r){n<e.length-1&&(t=void 0);break}return[r,t]},a=new AbortController,{signal:l}=a,u=n?.initial&&!1===n?.sync?_(r,e.join("."),l):v(r,e.join(".")),h=function(t){const e=(e,r)=>{Object.is(e[0],r?.[0])||t(e[0],r?.[0],e[1])};return e}(u),[f,b]=c();return n?.initial&&n?.once?(u(f,f,b),[f,b,d([],a)]):(i=o(c,h,{...n,initial:!1}),n?.initial&&u(f,f,b),[f,b,d([i],a)])}(t,e,r,n)}function b(t,e,r,n){const o=new WeakMap,i=new Set,u=e.slice(3),h=t=>{if(!s(t)&&!c(t)||o.has(t))return;if(!(u.split(".")[0]in t))return;const e=watch(t,u,r,n);o.set(t,e),i.add(e)};i.add(t.on("after-add",(t=>{let e=t.item;"target"in t&&l(t.target)&&(e=t.item[1]),h(e)}))),i.add(t.on("after-remove",(t=>{let e=t.item;if("target"in t&&l(t.target)&&(e=t.item[1]),!s(e)&&!c(e))return;const r=o.get(e);null!=r&&(r.remove(),o.delete(e),i.delete(r))})));for(const e of a(t)?t:t.values())h(e);return g(i)}function d(t,e){return{remove:()=>{e?.abort();for(const e of t)e.remove()}}}function g(t,...e){return{remove:()=>{for(const e of t)e.remove();for(const t of e)t.remove()}}}const p="[observableUtils]: Error thrown by watch callback. Thrown errors from watch callbacks should be avoided where possible, they affect the performance of the entire watch system. Watch property:";function v(t,e){return(...r)=>{try{const n=t(...r);"object"==typeof n&&n instanceof Promise&&n.catch((t=>{console.error(`${p} ${e}`,t)}))}catch(t){console.error(`${p} ${e}`,t)}}}function _(t,e,r){const n=v(t,e);let o=new AbortController;return(...t)=>{o.abort(),o=new AbortController;const{signal:e}=o;queueMicrotask((()=>{r.aborted||e.aborted||n(...t)}))}}class w extends r{invalidated=!0;_currentValue;get currentValue(){return this._currentValue}set currentValue(t){this._currentValue=t,this.invalidated=!1}constructor(t,e){super(t,{}),this._currentValue=e}onInvalidated(){this.invalidated=!0,super.onInvalidated()}}

package/tasks/geocoding/ArcGISGeocoder.js

@@ -1 +1 @@
-var e;import{__decorate as t}from"tslib";import s from"@arcgis/core/core/Collection";import i from"@arcgis/core/geometry/SpatialReference";import r from"@arcgis/core/layers/support/Field";import{addressToLocations as a,addressesToLocations as o,locationToAddress as n,suggestLocations as c}from"@arcgis/core/rest/locator";import{InvalidOperationError as l}from"../../InvalidOperationError.js";import{isFeature as d}from"../../ItemType.js";import{Feature as u,SCORE_FIELD as p,SCORE_FIELD_ORIGINAL as h}from"../../data/Feature.js";import{Schema as f}from"../../data/Schema.js";import{DefaultArcGISRequestHelper as g}from"../../support/ArcGISRequestHelper.js";import{cancelify as m}from"../../support/Cancellable.js";import{serializable as y}from"../../support/Serializable.js";import{ReadOnlyCollection as _}from"../../utilities/ReadOnlyCollection.js";import{checkArg as S}from"../../utilities/checkArg.js";import{load as w}from"../../utilities/esri.js";import{getLogger as A}from"../../utilities/log.js";import{toPortalItem as b}from"../../utilities/portal.js";import{ADDRESS_FIELD as R,GeocodeOptions as v,Geocoder as F}from"./Geocoder.js";export{R as ADDRESS_FIELD,p as SCORE_FIELD};const x=A("ArcGISGeocoder"),z="https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",C="This schema property is read-only.",T="Match_addr";let j=e=class extends F{get requestHelper(){return this._requestHelper||(this._requestHelper=new g),this._requestHelper}set requestHelper(e){this._requestHelper=e}get categories(){return this._categories||(this._categories=new s),this._categories}get url(){return this._url}set url(e){this.updateUrl(e)}countryCode;_categories;_requestHelper;_singleLineAddressField;_maxBatchSize;_url;_magicKeyAddressMap=new Map;static async fromPortalItem(t,s){S("portalItem",t).isNotMissing();const i=b(t);await w(i);const r={...s};return void 0!==r.title&&null!==r.title||(r.title=i.title),r.url=i.url,new e(r)}updateUrl(e){return this._url===e?Promise.resolve():(this._url=e,this.isInitialized?(async()=>{const e=await this._getGeocodeService(this.url);this._updateGeocodeProperties(e)})():Promise.resolve())}async*geocode(e,t){S("address",e).isNotMissing(),await this.initialize();const s={...v.DEFAULTS,...v.fromFeatureSource(this),...t},i="string"==typeof e?this._magicKeyAddressMap?.get(e):void 0,{outFields:r,outSpatialReference:o,maxResults:n,searchArea:c}=s,l={address:this._addressToAttributes(e),categories:this.categories.toArray(),countryCode:this.countryCode,outFields:r,outSpatialReference:o,maxLocations:n,searchExtent:c?.extent,forStorage:void 0,magicKey:i,location:t?.searchPoint},d=a(this.url,l),u=await m(d,t?.cancelToken);yield*u.map((e=>this._candidateToFeature(e,s)))}async count(e,t){S("address",e).isNotMissing(),await this.initialize();const s={...v.DEFAULTS,...v.fromFeatureSource(this),...t},{outFields:i,outSpatialReference:r,maxResults:o,searchArea:n}=s,c={address:this._addressToAttributes(e),categories:this.categories.toArray(),countryCode:this.countryCode,outFields:i,outSpatialReference:r,maxLocations:o,searchExtent:n?n.extent:void 0,forStorage:void 0,magicKey:void 0,location:t?.searchPoint},l=a(this.url,c);return{source:this,count:(await m(l,t?.cancelToken)).length}}async*batchGeocode(e,t){S("addresses",e).isNotMissing(),await this.initialize();const s={...v.DEFAULTS,...v.fromFeatureSource(this),...t};if(!this.capabilities.supportsBatch)throw new l("Batch geocoding is not supported.");if(this._maxBatchSize&&e.length>this._maxBatchSize)throw new l(`Batch geocoding is limited to ${this._maxBatchSize} addresses at a time.`);let i=0;const r={addresses:e.map((e=>this._addressToAttributes(e,i++))),categories:this.categories.toArray(),countryCode:this.countryCode,outSpatialReference:s.outSpatialReference},a=o(this.url,r),n=(await m(a,t?.cancelToken)).map((e=>this._candidateToFeature(e,s)));for(const t of n){const s=t.attributes.get("ResultID");void 0!==s&&s>=0&&t.attributes.set(R,e[s]),t.attributes.delete("ResultID")}yield*n}async suggest(e,t){if(S("searchText",e).isNotMissing(),await this.initialize(),!this.capabilities.supportsSuggest)throw new l("Suggestions are not supported.");const s={text:e,categories:this.categories.toArray(),searchExtent:t?.searchArea?.extent,maxSuggestions:t?.maxResults,countryCode:this.countryCode,location:t?.searchPoint},i=c(this.url,s),r=await m(i,t?.cancelToken);return r.forEach((e=>this._magicKeyAddressMap.set(e.text,e.magicKey))),r.map((e=>e.text))}async reverseGeocode(e,t){S("location",e).isNotMissing(),await this.initialize();const s={...v.DEFAULTS,...v.fromFeatureSource(this),...t};if(!this.capabilities.supportsReverse)throw new l("Reverse geocoding is not supported.");let i;try{const r=n(this.url,{location:e,outSpatialReference:s.outSpatialReference});i=await m(r,t?.cancelToken)}catch(e){if(400===e.details?.httpStatus)return;throw e}const r=this._candidateToFeature(i,s);return r.settings.parent=this.featureSettings,r.schema.parent=this.addressSchema,r}_getSerializableProperties(){return{...super._getSerializableProperties(),url:"initial",categories:{serializeModes:["initial"],deserialize:e=>{this.categories.removeAll(),this.categories.addMany(e)}},countryCode:"initial",requestHelper:{serialize:!1}}}_createSchema(){return new B}_createAddressSchema(){return new B}async _onInitialize(){if(await super._onInitialize(),!this.url)throw new Error("ArcGISGeocoder must be created with a url.");let e;try{e=await this._getGeocodeService(this.url)}catch(t){t instanceof Error&&x.error({message:`Failed to get geocode service from ${this.url}. Using default service: ${z}.`,error:t}),await this.updateUrl(z),e=await this._getGeocodeService(this.url)}this._updateGeocodeProperties(e),this.assignProperties({});const t=i.fromJSON(e.spatialReference);this.schema.initialize({fields:e.candidateFields,spatialReference:t}),this.addressSchema.initialize({fields:e.addressFields,spatialReference:t})}async _getGeocodeService(e){const{data:t}=await this.requestHelper.request(e,{query:{f:"json"}});if(!t)throw new Error(`Response to request for url ${e} was invalid.`);return t}_updateGeocodeProperties(e){if(e.singleLineAddressField&&(this._singleLineAddressField=e.singleLineAddressField.name),e.locatorProperties&&(this._maxBatchSize=e.locatorProperties.MaxBatchSize),e.capabilities){const t=e.capabilities.split(",").map((e=>e.trim()));this._capabilitiesInternal=Object.freeze({supportsAdd:!1,supportsUpdate:!1,supportsDelete:!1,supportsEditing:!1,supportsBatch:t.includes("Geocode"),supportsReverse:t.includes("ReverseGeocode"),supportsSuggest:t.includes("Suggest"),maxResults:void 0,supportsAttachmentEditing:!1})}else this._capabilitiesInternal=Object.freeze({supportsAdd:!1,supportsUpdate:!1,supportsDelete:!1,supportsEditing:!1,supportsBatch:e.currentVersion>=10.1,supportsReverse:!0,supportsSuggest:!1,maxResults:void 0,supportsAttachmentEditing:!1})}_addressToAttributes(e,t){const s={};if("string"==typeof e)if(this._singleLineAddressField)s[this._singleLineAddressField]=e,[...this.defaultAddressValues.entries()].forEach((([e,t])=>{s[e]=t}));else{const t=this.addressSchema.fields.map((e=>e.name)).filter((e=>!this.defaultAddressValues.has(e))).toArray();if(1!==t.length)throw new l("Single line geocoding is not supported.");s[t[0]]=e}else{const t=d(e)?e.toGraphic().attributes:e;for(const e of this.addressSchema.fields.map((e=>e.name)).toArray())e in t?s[e]=t[e]:this.defaultAddressValues.has(e)&&(s[e]=this.defaultAddressValues.get(e));if(0===Object.keys(s).length)throw new l("At least one valid address field is required.")}return void 0!==t&&(s.OBJECTID=t),s}_candidateToFeature(e,t){const s=new u({source:this});if(e.attributes)for(const t of Object.keys(e.attributes))s.attributes.set(t,e.attributes[t]);const{address:i}=e;if("string"!=typeof i||s.attributes.has(T)&&s.attributes.get(T)){if("object"==typeof i&&i)for(const e of Object.keys(i))s.attributes.set(e,i[e])}else i?s.attributes.set(T,i):s.attributes.set(T,Object.values(e.attributes).join(", "));return e.score&&(s.attributes.set(p,e.score),s.attributes.set(h,e.score)),s.geometry=e.location,t.outSpatialReference&&(s.schema.spatialReference=t.outSpatialReference),s}};j=e=t([y],j);export{j as ArcGISGeocoder};let B=class extends f{_spatialReference;_fieldBackingCollection;_fieldCollection;constructor(){super(),this._fieldBackingCollection=new s,this._fieldCollection=new _(this._fieldBackingCollection),this.notifyChange("_fields")}get _fields(){return this._fieldCollection}get spatialReference(){return this._spatialReference}set spatialReference(e){throw new l(C)}get geometryType(){return"point"}set geometryType(e){throw new l(C)}initialize(e){if(e.fields&&(this._fieldBackingCollection.removeAll(),this._fieldBackingCollection.addMany(e.fields.map((e=>r.fromJSON(e))))),e.spatialReference&&(this._spatialReference=e.spatialReference,this.notifyChange("spatialReference")),!this.isModified("displayField")){let e=this.fields.findFieldByName("match_addr");e||(e=this.fields.findFieldByName("address")),e&&(this.displayField=e.name,this.notifyChange("displayField"))}}};B=t([y],B);
+var e;import{__decorate as t}from"tslib";import s from"@arcgis/core/core/Collection";import i from"@arcgis/core/geometry/SpatialReference";import r from"@arcgis/core/layers/support/Field";import{addressToLocations as a,addressesToLocations as o,locationToAddress as c,suggestLocations as n}from"@arcgis/core/rest/locator";import{InvalidOperationError as l}from"../../InvalidOperationError.js";import{isFeature as d}from"../../ItemType.js";import{Feature as u,SCORE_FIELD as p,SCORE_FIELD_ORIGINAL as h}from"../../data/Feature.js";import{Schema as f}from"../../data/Schema.js";import{DefaultArcGISRequestHelper as g}from"../../support/ArcGISRequestHelper.js";import{cancelify as m}from"../../support/Cancellable.js";import{serializable as _}from"../../support/Serializable.js";import{notifyChange as y}from"../../support/observableUtils.js";import{ReadOnlyCollection as S}from"../../utilities/ReadOnlyCollection.js";import{checkArg as w}from"../../utilities/checkArg.js";import{load as b}from"../../utilities/esri.js";import{getLogger as A}from"../../utilities/log.js";import{toPortalItem as R}from"../../utilities/portal.js";import{ADDRESS_FIELD as v,GeocodeOptions as F,Geocoder as x}from"./Geocoder.js";export{v as ADDRESS_FIELD,p as SCORE_FIELD};const z=A("ArcGISGeocoder"),j="https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer",T="This schema property is read-only.",C="Match_addr";let B=e=class extends x{get requestHelper(){return this._requestHelper||(this._requestHelper=new g),this._requestHelper}set requestHelper(e){this._requestHelper=e}get categories(){return this._categories||(this._categories=new s),this._categories}get url(){return this._url}set url(e){this.updateUrl(e)}countryCode;_categories;_requestHelper;_singleLineAddressField;_maxBatchSize;_url;_magicKeyAddressMap=new Map;static async fromPortalItem(t,s){w("portalItem",t).isNotMissing();const i=R(t);await b(i);const r={...s};return void 0!==r.title&&null!==r.title||(r.title=i.title),r.url=i.url,new e(r)}updateUrl(e){return this._url===e?Promise.resolve():(this._url=e,this.isInitialized?(async()=>{const e=await this._getGeocodeService(this.url);this._updateGeocodeProperties(e)})():Promise.resolve())}async*geocode(e,t){w("address",e).isNotMissing(),await this.initialize();const s={...F.DEFAULTS,...F.fromFeatureSource(this),...t},i="string"==typeof e?this._magicKeyAddressMap?.get(e):void 0,{outFields:r,outSpatialReference:o,maxResults:c,searchArea:n}=s,l={address:this._addressToAttributes(e),categories:this.categories.toArray(),countryCode:this.countryCode,outFields:r,outSpatialReference:o,maxLocations:c,searchExtent:n?.extent,forStorage:void 0,magicKey:i,location:t?.searchPoint},d=a(this.url,l),u=await m(d,t?.cancelToken);yield*u.map((e=>this._candidateToFeature(e,s)))}async count(e,t){w("address",e).isNotMissing(),await this.initialize();const s={...F.DEFAULTS,...F.fromFeatureSource(this),...t},{outFields:i,outSpatialReference:r,maxResults:o,searchArea:c}=s,n={address:this._addressToAttributes(e),categories:this.categories.toArray(),countryCode:this.countryCode,outFields:i,outSpatialReference:r,maxLocations:o,searchExtent:c?c.extent:void 0,forStorage:void 0,magicKey:void 0,location:t?.searchPoint},l=a(this.url,n);return{source:this,count:(await m(l,t?.cancelToken)).length}}async*batchGeocode(e,t){w("addresses",e).isNotMissing(),await this.initialize();const s={...F.DEFAULTS,...F.fromFeatureSource(this),...t};if(!this.capabilities.supportsBatch)throw new l("Batch geocoding is not supported.");if(this._maxBatchSize&&e.length>this._maxBatchSize)throw new l(`Batch geocoding is limited to ${this._maxBatchSize} addresses at a time.`);let i=0;const r={addresses:e.map((e=>this._addressToAttributes(e,i++))),categories:this.categories.toArray(),countryCode:this.countryCode,outSpatialReference:s.outSpatialReference},a=o(this.url,r),c=(await m(a,t?.cancelToken)).map((e=>this._candidateToFeature(e,s)));for(const t of c){const s=t.attributes.get("ResultID");void 0!==s&&s>=0&&t.attributes.set(v,e[s]),t.attributes.delete("ResultID")}yield*c}async suggest(e,t){if(w("searchText",e).isNotMissing(),await this.initialize(),!this.capabilities.supportsSuggest)throw new l("Suggestions are not supported.");const s={text:e,categories:this.categories.toArray(),searchExtent:t?.searchArea?.extent,maxSuggestions:t?.maxResults,countryCode:this.countryCode,location:t?.searchPoint},i=n(this.url,s),r=await m(i,t?.cancelToken);return r.forEach((e=>this._magicKeyAddressMap.set(e.text,e.magicKey))),r.map((e=>e.text))}async reverseGeocode(e,t){w("location",e).isNotMissing(),await this.initialize();const s={...F.DEFAULTS,...F.fromFeatureSource(this),...t};if(!this.capabilities.supportsReverse)throw new l("Reverse geocoding is not supported.");let i;try{const r=c(this.url,{location:e,outSpatialReference:s.outSpatialReference});i=await m(r,t?.cancelToken)}catch(e){if(400===e.details?.httpStatus)return;throw e}const r=this._candidateToFeature(i,s);return r.settings.parent=this.featureSettings,r.schema.parent=this.addressSchema,r}_getSerializableProperties(){return{...super._getSerializableProperties(),url:"initial",categories:{serializeModes:["initial"],deserialize:e=>{this.categories.removeAll(),this.categories.addMany(e)}},countryCode:"initial",requestHelper:{serialize:!1}}}_createSchema(){return new G}_createAddressSchema(){return new G}async _onInitialize(){if(await super._onInitialize(),!this.url)throw new Error("ArcGISGeocoder must be created with a url.");let e;try{e=await this._getGeocodeService(this.url)}catch(t){t instanceof Error&&z.error({message:`Failed to get geocode service from ${this.url}. Using default service: ${j}.`,error:t}),await this.updateUrl(j),e=await this._getGeocodeService(this.url)}this._updateGeocodeProperties(e),this.assignProperties({});const t=i.fromJSON(e.spatialReference);this.schema.initialize({fields:e.candidateFields,spatialReference:t}),this.addressSchema.initialize({fields:e.addressFields,spatialReference:t})}async _getGeocodeService(e){const{data:t}=await this.requestHelper.request(e,{query:{f:"json"}});if(!t)throw new Error(`Response to request for url ${e} was invalid.`);return t}_updateGeocodeProperties(e){if(e.singleLineAddressField&&(this._singleLineAddressField=e.singleLineAddressField.name),e.locatorProperties&&(this._maxBatchSize=e.locatorProperties.MaxBatchSize),e.capabilities){const t=e.capabilities.split(",").map((e=>e.trim()));this._capabilitiesInternal=Object.freeze({supportsAdd:!1,supportsUpdate:!1,supportsDelete:!1,supportsEditing:!1,supportsBatch:t.includes("Geocode"),supportsReverse:t.includes("ReverseGeocode"),supportsSuggest:t.includes("Suggest"),maxResults:void 0,supportsAttachmentEditing:!1})}else this._capabilitiesInternal=Object.freeze({supportsAdd:!1,supportsUpdate:!1,supportsDelete:!1,supportsEditing:!1,supportsBatch:e.currentVersion>=10.1,supportsReverse:!0,supportsSuggest:!1,maxResults:void 0,supportsAttachmentEditing:!1})}_addressToAttributes(e,t){const s={};if("string"==typeof e)if(this._singleLineAddressField)s[this._singleLineAddressField]=e,[...this.defaultAddressValues.entries()].forEach((([e,t])=>{s[e]=t}));else{const t=this.addressSchema.fields.map((e=>e.name)).filter((e=>!this.defaultAddressValues.has(e))).toArray();if(1!==t.length)throw new l("Single line geocoding is not supported.");s[t[0]]=e}else{const t=d(e)?e.toGraphic().attributes:e;for(const e of this.addressSchema.fields.map((e=>e.name)).toArray())e in t?s[e]=t[e]:this.defaultAddressValues.has(e)&&(s[e]=this.defaultAddressValues.get(e));if(0===Object.keys(s).length)throw new l("At least one valid address field is required.")}return void 0!==t&&(s.OBJECTID=t),s}_candidateToFeature(e,t){const s=new u({source:this});if(e.attributes)for(const t of Object.keys(e.attributes))s.attributes.set(t,e.attributes[t]);const{address:i}=e;if("string"!=typeof i||s.attributes.has(C)&&s.attributes.get(C)){if("object"==typeof i&&i)for(const e of Object.keys(i))s.attributes.set(e,i[e])}else i?s.attributes.set(C,i):s.attributes.set(C,Object.values(e.attributes).join(", "));return e.score&&(s.attributes.set(p,e.score),s.attributes.set(h,e.score)),s.geometry=e.location,t.outSpatialReference&&(s.schema.spatialReference=t.outSpatialReference),s}};B=e=t([_],B);export{B as ArcGISGeocoder};let G=class extends f{_spatialReference;_fieldBackingCollection;_fieldCollection;constructor(){super(),this._fieldBackingCollection=new s,this._fieldCollection=new S(this._fieldBackingCollection),y(this,"_fields")}get _fields(){return this._fieldCollection}get spatialReference(){return this._spatialReference}set spatialReference(e){throw new l(T)}get geometryType(){return"point"}set geometryType(e){throw new l(T)}initialize(e){if(e.fields&&(this._fieldBackingCollection.removeAll(),this._fieldBackingCollection.addMany(e.fields.map((e=>r.fromJSON(e))))),e.spatialReference&&(this._spatialReference=e.spatialReference,y(this,"spatialReference")),!this.isModified("displayField")){let e=this.fields.findFieldByName("match_addr");e||(e=this.fields.findFieldByName("address")),e&&(this.displayField=e.name)}}};G=t([_],G);

package/tasks/query/ClientSideQueryProvider.js

@@ -1 +1 @@
-import{toFeature as e}from"../../data/Feature.js";import{cancelify as t,cancelifyWithAbortSignal as r}from"../../support/Cancellable.js";import*as i from"../../utilities/asyncIterable.js";import{isSubtypeSublayerExtension as a}from"../../utilities/extensions.js";import{isBuildingComponentSublayer as n}from"../../utilities/layers.js";import{QueryProviderBase as s}from"./QueryProviderBase.js";export class ClientSideQueryProvider extends s{get _waitForUpdatingFinished(){return!0}_query(t,r,a){const n=this;return async function*(){const s=await n._getClientSideLayerGraphics(t,r,a);s?.length?yield*s.map((r=>e(r,{source:t}))):yield*i.empty()}()}async _count(e,t,r){const i=await this._getClientSideLayerGraphics(e,t,r);return{source:e,count:i?i.length:0}}_createQuery(e,t,r){const i=a(e)?e.layerExtension:e,{_layerView:s,featureSettings:o}=i,l=n(i.sublayer)?e.layerExtension?.mapExtension:e.mapExtension,u=s.createQuery();return u.where=t,u.geometry=r.spatialFilter,u.outFields=o.outFields,u.returnGeometry=r.returnGeometry,u.outSpatialReference=r.outSpatialReference,u.maxAllowableOffset=r.maxAllowableOffset,u.num=r.maxResults,u.returnZ="scene"===l?.viewMode,u}async _getClientSideLayerGraphics(e,i,n){const s=a(e)?e.layerExtension:e,{_layerView:o}=s;if(!o)return;this._waitForUpdatingFinished&&await t(new Promise(((e,t)=>{o.updating||e();const r=o.watch("updating",(t=>{t||(r.remove(),e())}))})),n.cancelToken);const l=await r((async t=>o.queryFeatures(this._createQuery(e,i,n),{signal:t})),n.cancelToken);return l?.features}}
+import{toFeature as e}from"../../data/Feature.js";import{cancelify as t,cancelifyWithAbortSignal as r}from"../../support/Cancellable.js";import{watch as i}from"../../support/observableUtils.js";import*as a from"../../utilities/asyncIterable.js";import{isSubtypeSublayerExtension as s}from"../../utilities/extensions.js";import{isBuildingComponentSublayer as n}from"../../utilities/layers.js";import{QueryProviderBase as o}from"./QueryProviderBase.js";export class ClientSideQueryProvider extends o{get _waitForUpdatingFinished(){return!0}_query(t,r,i){const s=this;return async function*(){const n=await s._getClientSideLayerGraphics(t,r,i);n?.length?yield*n.map((r=>e(r,{source:t}))):yield*a.empty()}()}async _count(e,t,r){const i=await this._getClientSideLayerGraphics(e,t,r);return{source:e,count:i?i.length:0}}_createQuery(e,t,r){const i=s(e)?e.layerExtension:e,{_layerView:a,featureSettings:o}=i,l=n(i.sublayer)?e.layerExtension?.mapExtension:e.mapExtension,u=a.createQuery();return u.where=t,u.geometry=r.spatialFilter,u.outFields=o.outFields,u.returnGeometry=r.returnGeometry,u.outSpatialReference=r.outSpatialReference,u.maxAllowableOffset=r.maxAllowableOffset,u.num=r.maxResults,u.returnZ="scene"===l?.viewMode,u}async _getClientSideLayerGraphics(e,a,n){const o=s(e)?e.layerExtension:e,{_layerView:l}=o;if(!l)return;this._waitForUpdatingFinished&&await t(new Promise(((e,t)=>{l.updating||e();const r=i(l,"updating",(t=>{t||(r.remove(),e())}))})),n.cancelToken);const u=await r((async t=>l.queryFeatures(this._createQuery(e,a,n),{signal:t})),n.cancelToken);return u?.features}}