@vertigis/arcgis-extensions 49.8.1 → 50.0.0

package/utilities/CollectionProxy.d.ts

@@ -1,17 +1,14 @@
 import type Collection from "@arcgis/core/core/Collection";
-import { Observable } from "../support/Observable.js";
-import type { ItemCallback, ItemCompareCallback, ItemMapCallback, ItemReduceCallback, ItemTestCallback, CollectionAfterAddEventHandler, CollectionChangeEventHandler, CollectionAfterChangesEventHandler, CollectionAfterRemoveEventHandler, CollectionBeforeAddEventHandler, CollectionBeforeChangesEventHandler, CollectionBeforeRemoveEventHandler, EventHandler, WatchCallback } from "../support/esri.js";
-interface CollectionCompatibleObservable<T> extends Omit<Observable, "notifyChange" | "set" | "on" | "watch" | "emit" | "get"> {
-    on(type: string | string[], listener: EventHandler): IHandle;
-    watch(path: string | string[], callback: WatchCallback<T>, sync: boolean | undefined): IHandle;
-}
-type CollectionCompatibleObservableConstructor = new () => CollectionCompatibleObservable<unknown>;
+import Evented from "@arcgis/core/core/Evented.js";
+import { type IDeprecatedObservable } from "../support/Observable.js";
+import type { ItemCallback, ItemCompareCallback, ItemMapCallback, ItemReduceCallback, ItemTestCallback, CollectionAfterAddEventHandler, CollectionChangeEventHandler, CollectionAfterChangesEventHandler, CollectionAfterRemoveEventHandler, CollectionBeforeAddEventHandler, CollectionBeforeChangesEventHandler, CollectionBeforeRemoveEventHandler, EventHandler } from "../support/esri.js";
+import type { WatchCallback } from "./watch.js";
 /**
  * Merge typings of Collection and CollectionProxy.
  */
 export interface CollectionProxy<T> extends Collection<T> {
 }
-declare const CollectionProxy_base: CollectionCompatibleObservableConstructor;
+declare const CollectionProxy_base: typeof Evented & (abstract new (...args: any[]) => import("../support/observableUtils.js").ObservableMixin);
 /**
  * Base class for implementing a Collection proxy, i.e. a class that wraps an
  * existing collection and provides additional functionality or logic. The
@@ -21,7 +18,8 @@ declare const CollectionProxy_base: CollectionCompatibleObservableConstructor;
  * that need to implement special add/remove logic only need to override those
  * methods.
  */
-export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
+export declare abstract class CollectionProxy<T> extends CollectionProxy_base implements Omit<Collection<T>, "notifyChange">, IDeprecatedObservable {
+    private readonly _handles;
     /**
      * The number of items in the collection.
      */
@@ -49,7 +47,6 @@ export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
     private _destroyed;
     private _initialized;
     private _collectionField;
-    private readonly _collectionChangeHandle;
     /**
      * Initializes a new instance of the
      * {@link utilities/CollectionProxy!CollectionProxy} class.
@@ -92,7 +89,7 @@ export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
      */
     concat(value: T[] | Collection<T>): Collection<T>;
     /**
-     * Not implemented. Has no effect.
+     * Removes all event listeners and destroys the collection.
      */
     destroy(): void;
     /**
@@ -151,6 +148,13 @@ export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
      * @param callback The function to call for each item in the Collection.
      */
     forEach(callback: ItemCallback<T>): void;
+    /**
+     * Returns the item at the specified index.
+     *
+     * @param index Zero-based index of the item in the Collection to retrieve.
+     * @returns The item in the Collection stored at the specified index.
+     */
+    at(index: number): T | undefined;
     /**
      * Returns the item at the specified index.
      *
@@ -207,10 +211,7 @@ export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
     on(type: "before-changes", listener: CollectionBeforeChangesEventHandler): IHandle;
     on(type: "before-remove", listener: CollectionBeforeRemoveEventHandler<T>): IHandle;
     on(type: "change", listener: CollectionChangeEventHandler<T>): IHandle;
-    /**
-     * @inheritdoc
-     */
-    watch(path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
+    on(type: string, listener: EventHandler): IHandle;
     /**
      * Removes the last item from the collection and returns it.
      */
@@ -329,17 +330,47 @@ export declare abstract class CollectionProxy<T> extends CollectionProxy_base {
      */
     unshift(item: T): number;
     /**
-     * Not implemented but necessary to be accessor like.
-     *
-     * @param propertyName The property.
+     * @deprecated
+     * @inheritdoc
      */
-    protected _get<T>(propertyName: string): T;
+    set<T>(propertyPath: string, value: T): this;
     /**
-     * Not implemented but necessary to be accessor like.
-     *
-     * @param propertyName The property.
-     * @param value The value.
+     * @deprecated
+     * @inheritdoc
      */
+    set(properties: HashMap<unknown>): this;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    get<T>(propertyPath: string): T;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    get(propertyPath: string): unknown;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    watch(path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    notifyChange(propertyKey: string): void;
+    notifyChange(propertyKey: keyof this): void;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    _watchProperty(propertyKey: keyof this, subpath: string, callback: WatchCallback, sync: boolean): IHandle;
+    addHandles<T>(handles: IHandle | IHandle[], groupKey?: GroupKey<T>): void;
+    removeHandles<T>(groupKey?: GroupKey<T>): void;
+    hasHandles<T>(groupKey?: GroupKey<T>): boolean;
+    protected _get(propertyName: string): any;
+    protected _get<T>(propertyName: string): T;
     protected _set<T>(propertyName: string, value: T): this;
+    private _addForwardingEvents;
 }
 export {};

package/utilities/CollectionProxy.js

@@ -1 +1 @@
-import{Observable as e}from"../support/Observable.js";import{_generateChangeEvent as t}from"./watch.js";export class CollectionProxy extends e{get length(){return this._collection.length}get declaredClass(){return"esri.core.Collection"}get destroyed(){return this._destroyed}set destroyed(e){this._destroyed=e}get initialized(){return this._initialized}set initialized(e){this._initialized=e}get _collection(){if(void 0===this._collectionField)throw new Error("CollectionProxy requires a backing collection.");return this._collectionField}set _collection(e){const t=this._collectionField;this._collectionField=e,this.emit("collection-changed",{newValue:e,oldValue:t}),this.emit("after-add"),this.emit("after-changes"),this.emit("after-remove"),this.emit("before-add"),this.emit("before-changes"),this.emit("before-remove"),this.notifyChange("length")}_destroyed=!1;_initialized=!0;_collectionField;_collectionChangeHandle;constructor(e){super(),this._collectionField=e}*[Symbol.iterator](){for(const e of this._collection)yield e}add(e,t){return this._collection.add(e,t),this}addMany(e,t){if(!e)return this;if(arguments.length>1){let o=t;for(let t=0;t<e.length;t++)"function"==typeof e.getItemAt?this.add(e.getItemAt(t),o++):this.add(e[t],o++)}else for(let t=0;t<e.length;t++)"function"==typeof e.getItemAt?this.add(e.getItemAt(t)):this.add(e[t]);return this}clone(){const e=Object.create(Object.getPrototypeOf(this));return e._collection=this._collection,e}concat(e){return this._collection.concat(e)}destroy(){}every(e){return this._collection.every(e)}filter(e){return this._collection.filter(e)}find(e){return this._collection.find(e)}findIndex(e){return this._collection.findIndex(e)}flatten(e){return this._collection.flatten(e)}forEach(e){return this._collection.forEach(e)}getItemAt(e){return this._collection.getItemAt(e)}includes(e){return this._collection.includes(e)}indexOf(e,t){return this._collection.indexOf(e,t)}join(e){return this._collection.join(e)}lastIndexOf(e,t){return this._collection.lastIndexOf(e,t)}map(e){return this._collection.map(e)}on(e,o){if("collection-changed"===e)return super.on(e,o);{let r=this._collection.on(e,o);const i=[super.on(e,o),super.on("collection-changed",(({newValue:i,oldValue:n})=>{if(r.remove(),r=i.on(e,o),"change"===e){const e=t(n,i);(e?.added.length||e?.removed.length||e?.moved.length)&&o(e)}}))];return{remove:()=>{r.remove();for(const e of i)e.remove()}}}}watch(e,t,o){if((Array.isArray(e)?e:[e]).includes("length")){let r=this._collection.watch(e,t,o);const i=[super.watch(e,t,o),super.on("collection-changed",(({newValue:i})=>{r.remove(),r=i.watch(e,t,o)}))];return{remove:()=>{r.remove();for(const e of i)e.remove()}}}return super.watch(e,t,o)}pop(){return this.removeAt(this.length-1)}push(e){return this.add(e,this.length),this.length}reduce(e,t){return this._collection.reduce(e,t)}reduceRight(e,t){return this._collection.reduceRight(e,t)}remove(e){return this.removeAt(this.indexOf(e))}removeAll(){const e=[];for(;this.length;){const t=this.pop();t&&e.push(t)}return e}removeAt(e){return this._collection.removeAt(e)}removeMany(e){const t=[];for(let o=0;o<e.length;o++){const r="function"==typeof e.getItemAt?e.getItemAt(o):e[o],i=this.indexOf(r);if(i>=0){const e=this.removeAt(i);e&&t.push(e)}}return t}reorder(e,t){return this._collection.reorder(e,t)}reverse(){return this._collection.reverse(),this}shift(){return this.removeAt(0)}slice(e,t){return this._collection.slice(e,t)}some(e){return this._collection.some(e)}sort(e){return this._collection.sort(e),this}splice(e,t,...o){const r=[];for(let o=t;o>0;o--){const t=this.removeAt(e);t&&r.push(t)}let i=e;return o.forEach((e=>{this.add(e,i),i++})),r}toArray(){return this._collection.toArray()}unshift(e){return this.add(e,0),this.length}_get(e){throw Error()}_set(e,t){throw Error()}}
+import e from"@arcgis/core/core/Evented.js";import{deprecatedGetPropertyPath as t,deprecatedNotifyChange as i,deprecatedSet as o,deprecatedWatch as r,deprecatedWatchProperty as n}from"../support/Observable.js";import{notifyChange as s,observable as l,onWatch as c,watch as h}from"../support/observableUtils.js";import{_generateChangeEvent as d}from"./collection.js";const a="collection-proxy-collection-change-handles";export class CollectionProxy extends(l(e)){_handles=new Map;get length(){return this._collection.length}get declaredClass(){return"esri.core.Collection"}get destroyed(){return this._destroyed}set destroyed(e){this._destroyed=e}get initialized(){return this._initialized}set initialized(e){this._initialized=e}get _collection(){if(void 0===this._collectionField)throw new Error("CollectionProxy requires a backing collection.");return this._collectionField}set _collection(e){if(this._collectionField===e)return;const t=this._collectionField;this.removeHandles(a);const i=d(t,e);if(null!=i){for(const e of i.added){const t={item:e,cancellable:!1,defaultPrevented:!1,preventDefault:()=>{},target:this};this.emit("before-add",t)}for(const e of i.removed){const t={item:e,cancellable:!1,defaultPrevented:!1,preventDefault:()=>{},target:this};this.emit("before-remove",t)}this.emit("before-changes",{cancellable:!1,defaultPrevented:!1,preventDefault:()=>{},target:this})}if(this._collectionField=e,this._addForwardingEvents(),null!=i){this.emit("change",i);for(const e of i.added)this.emit("after-add",{item:e,target:this});for(const e of i.removed)this.emit("after-remove",{item:e,target:this});this.emit("after-changes")}s(this,"length")}_destroyed=!1;_initialized=!0;_collectionField;constructor(e){super(),this._collectionField=e,this._addForwardingEvents()}*[Symbol.iterator](){for(const e of this._collection)yield e}add(e,t){return this._collection.add(e,t),this}addMany(e,t){if(!e)return this;if(arguments.length>1){let i=t;for(let t=0;t<e.length;t++)"function"==typeof e.getItemAt?this.add(e.getItemAt(t),i++):this.add(e[t],i++)}else for(let t=0;t<e.length;t++)"function"==typeof e.getItemAt?this.add(e.getItemAt(t)):this.add(e[t]);return this}clone(){const e=Object.create(Object.getPrototypeOf(this));return e._collection=this._collection,e}concat(e){return this._collection.concat(e)}destroy(){this.removeHandles(),this._destroyed=!0,this._initialized=!1,this._collection.destroy()}every(e){return this._collection.every(e)}filter(e){return this._collection.filter(e)}find(e){return this._collection.find(e)}findIndex(e){return this._collection.findIndex(e)}flatten(e){return this._collection.flatten(e)}forEach(e){return this._collection.forEach(e)}at(e){return this.getItemAt(e)}getItemAt(e){return this._collection.getItemAt(e)}includes(e){return this._collection.includes(e)}indexOf(e,t){return this._collection.indexOf(e,t)}join(e){return this._collection.join(e)}lastIndexOf(e,t){return this._collection.lastIndexOf(e,t)}map(e){return this._collection.map(e)}on(e,t){return super.on(e,t)}pop(){return this.removeAt(this.length-1)}push(e){return this.add(e,this.length),this.length}reduce(e,t){return this._collection.reduce(e,t)}reduceRight(e,t){return this._collection.reduceRight(e,t)}remove(e){return this.removeAt(this.indexOf(e))}removeAll(){const e=[];for(;this.length;){const t=this.pop();t&&e.push(t)}return e}removeAt(e){return this._collection.removeAt(e)}removeMany(e){const t=[];for(let i=0;i<e.length;i++){const o="function"==typeof e.getItemAt?e.getItemAt(i):e[i],r=this.indexOf(o);if(r>=0){const e=this.removeAt(r);e&&t.push(e)}}return t}reorder(e,t){return this._collection.reorder(e,t)}reverse(){return this._collection.reverse(),this}shift(){return this.removeAt(0)}slice(e,t){return this._collection.slice(e,t)}some(e){return this._collection.some(e)}sort(e){return this._collection.sort(e),this}splice(e,t,...i){const o=[];for(let i=t;i>0;i--){const t=this.removeAt(e);t&&o.push(t)}let r=e;return i.forEach((e=>{this.add(e,r),r++})),o}toArray(){return this._collection.toArray()}unshift(e){return this.add(e,0),this.length}set(e,t){return o(this,e,t)}get(e){return t(this,e)}watch(e,t,i){return r(this,e,t,i)}notifyChange(e){i(this,e)}_watchProperty(e,t,i,o){return n(this,e,t,i,o)}addHandles(e,t){const i=Array.isArray(e)?e:[e],o=t??"default";this._handles.has(o)||this._handles.set(o,[]),this._handles.get(o).push(...i)}removeHandles(e){if(null==e)for(const e of this._handles.values())for(const t of e)t.remove();else{const t=this._handles.get(e);if(null!=t){for(const e of t)e.remove();this._handles.delete(e)}}}hasHandles(e){return null==e?this._handles.size>0:this._handles.has(e)}_get(e){return this.get(e)}_set(e,t){return this.set(e,t)}_addForwardingEvents(){null!=this._collectionField&&this.addHandles([this._collectionField.on("before-add",(e=>this.emit("before-add",e))),this._collectionField.on("before-changes",(e=>this.emit("before-changes",e))),this._collectionField.on("before-remove",(e=>this.emit("before-remove",e))),this._collectionField.on("change",(e=>this.emit("change",e))),this._collectionField.on("after-add",(e=>this.emit("after-add",e))),this._collectionField.on("after-changes",(e=>this.emit("after-changes",e))),this._collectionField.on("after-remove",(e=>this.emit("after-remove",e))),c(this,"length",(()=>h(this._collectionField,"length",(()=>s(this,"length")),{sync:!0})))],a)}}

package/utilities/MapTransformCollection.js

@@ -1 +1 @@
-import{ReadOnlyCollection as l}from"./ReadOnlyCollection.js";import{checkArg as o}from"./checkArg.js";export class MapTransformCollection extends l{get _collection(){return this._originalCollection.map(this._callback)}_callback;_originalCollection;constructor(l,t){super(),o("originalCollection",l).isNotMissing(),this._callback=t,this._originalCollection=l,l.on("change",(l=>{this.emit("change",{added:l.added.map(this._callback),removed:l.removed.map(this._callback),moved:l.moved.map(this._callback),target:this})})),l.watch("length",(()=>this.notifyChange("length")))}}
+import{onWatch as e,watch as t,notifyChange as i}from"../support/observableUtils.js";import{ReadOnlyCollection as a}from"./ReadOnlyCollection.js";export class MapTransformCollection extends a{get _collection(){return this._originalCollection.map(this._callback)}_callback;_originalCollection;constructor(a,s){super(),this._callback=s,this._originalCollection=a,a.on("change",(e=>{this.hasEventListener("change")&&this.emit("change",{added:e.added.map(this._callback),removed:e.removed.map(this._callback),moved:e.moved.map(this._callback),target:this})})),a.on("before-add",(e=>{this.hasEventListener("before-add")&&this.emit("before-add",{...e,item:this._callback(e.item),target:this})})),a.on("before-remove",(e=>{this.hasEventListener("before-remove")&&this.emit("before-remove",{...e,item:this._callback(e.item),target:this})})),a.on("before-changes",(e=>{this.hasEventListener("before-changes")&&this.emit("before-changes",{...e,target:this})})),a.on("after-add",(e=>{this.hasEventListener("after-add")&&this.emit("after-add",{...e,item:this._callback(e.item),target:this})})),a.on("after-remove",(e=>{this.hasEventListener("after-remove")&&this.emit("after-remove",{...e,item:this._callback(e.item),target:this})})),a.on("after-changes",(e=>{this.hasEventListener("after-changes")&&this.emit("after-changes",{...e,target:this})})),e(this,"length",(()=>t(this._originalCollection,"length",(()=>i(this,"length")),{sync:!0})))}}

package/utilities/ObservableMap.d.ts

@@ -1,5 +1,8 @@
-import { Observable } from "../support/Observable.js";
+import Evented from "@arcgis/core/core/Evented.js";
+import { type IDeprecatedObservable } from "../support/Observable.js";
 import type { EventHandler } from "../support/esri.js";
+import type { AfterItemChangeEvent } from "./collection.js";
+import type { WatchCallback } from "./watch.js";
 /**
  * Raised when items are added or removed from an {@link ObservableMap}.
  */
@@ -17,14 +20,15 @@ export interface MapChangeEvent<K, V> {
      */
     target: ObservableMap<K, V>;
 }
+declare const ObservableMap_base: typeof Evented & (abstract new (...args: any[]) => import("../support/observableUtils.js").ObservableMixin);
 /**
  * A Map that supports observability.
  */
-export declare class ObservableMap<K, V> extends Observable implements Map<K, V> {
+export declare class ObservableMap<K, V> extends ObservableMap_base implements Map<K, V>, IDeprecatedObservable {
     /**
      * Used by Object.toString().
      */
-    readonly [Symbol.toStringTag]: "Map";
+    readonly [Symbol.toStringTag] = "ObservableMap";
     /**
      * The number of elements.
      */
@@ -53,6 +57,9 @@ export declare class ObservableMap<K, V> extends Observable implements Map<K, V>
      */
     forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: unknown): void;
     get(key: K): V;
+    /**
+     * @deprecated
+     */
     get(property: unknown): unknown;
     /**
      * Indicates whether or not an element with the specified key exists.
@@ -60,9 +67,15 @@ export declare class ObservableMap<K, V> extends Observable implements Map<K, V>
      * @param key The key to test for.
      */
     has(key: K): boolean;
+    set(key: K, value: V): this;
+    /**
+     * @deprecated
+     */
     set(property: unknown, value: unknown): this;
+    /**
+     * @deprecated
+     */
     set(properties: unknown): this;
-    set(key: K, value?: V): this;
     /**
      * Returns the `[key, value]` pairs for each element in the map in insertion
      * order.
@@ -86,5 +99,23 @@ export declare class ObservableMap<K, V> extends Observable implements Map<K, V>
      */
     toJSON(): unknown;
     on(name: "change", callback: (event: MapChangeEvent<K, V>) => void): IHandle;
+    on(name: "after-add", callback: (event: AfterItemChangeEvent<ObservableMap<K, V>, [K, V]>) => void): IHandle;
+    on(name: "after-remove", callback: (event: AfterItemChangeEvent<ObservableMap<K, V>, [K, V]>) => void): IHandle;
     on(name: string, callback: EventHandler): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    watch(path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    notifyChange(propertyKey: keyof this): void;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    _watchProperty(propertyKey: keyof this, subpath: string, callback: WatchCallback, sync: boolean): IHandle;
 }
+export {};

package/utilities/ObservableMap.js

@@ -1 +1 @@
-import{Observable as t}from"../support/Observable.js";import{toJSON as e}from"./object.js";export class ObservableMap extends t{[Symbol.toStringTag];get size(){return this._originalMap.size}_originalMap;constructor(){super(),this._originalMap=new Map}clear(){if(!this.size)return;this.notifyChange("size");const t=Array.from(this.entries());this._originalMap.clear(),this.emit("change",{added:[],removed:t,target:this})}delete(t){if(!this.has(t))return!1;const e=this.get(t);return this.notifyChange("size"),this._originalMap.delete(t),this.emit("change",{added:[],removed:[[t,e]],target:this}),!0}forEach(t,e){this._originalMap.forEach(t,e)}get(t){return this._originalMap.get(t)}has(t){return this._originalMap.has(t)}set(t,e){const i=!this.has(t),r=this.get(t);return this.notifyChange("size"),this._originalMap.set(t,e),this.emit("change",{added:[[t,e]],removed:i?[]:[[t,r]],target:this}),this}entries(){return this._originalMap.entries()}keys(){return this._originalMap.keys()}values(){return this._originalMap.values()}[Symbol.iterator](){return this._originalMap[Symbol.iterator]()}toJSON(){return e([...this])}on(t,e){return super.on(t,e)}}
+import t from"@arcgis/core/core/Evented.js";import{deprecatedNotifyChange as e,deprecatedWatch as r,deprecatedWatchProperty as i}from"../support/Observable.js";import{notifyChange as s,observable as a}from"../support/observableUtils.js";import{toJSON as o}from"./object.js";export class ObservableMap extends(a(t)){[Symbol.toStringTag]="ObservableMap";get size(){return this._originalMap.size}_originalMap;constructor(){super(),this._originalMap=new Map}clear(){if(!this.size)return;const t=Array.from(this.entries());if(this._originalMap.clear(),s(this,"size"),this.hasEventListener("after-remove"))for(const[e,r]of t)this.emit("after-remove",{item:[e,r],target:this});this.emit("change",{added:[],removed:t,target:this})}delete(t){if(!this.has(t))return!1;const e=this.get(t);return this._originalMap.delete(t),s(this,"size"),this.emit("after-remove",{item:[t,e],target:this}),this.emit("change",{added:[],removed:[[t,e]],target:this}),!0}forEach(t,e){this._originalMap.forEach(t,e)}get(t){return this._originalMap.get(t)}has(t){return this._originalMap.has(t)}set(t,e){const r=!this.has(t),i=this.get(t);return this._originalMap.set(t,e),s(this,"size"),r||this.emit("after-remove",{item:[t,i],target:this}),this.emit("after-add",{item:[t,e],target:this}),this.emit("change",{added:[[t,e]],removed:r?[]:[[t,i]],target:this}),this}entries(){return this._originalMap.entries()}keys(){return this._originalMap.keys()}values(){return this._originalMap.values()}[Symbol.iterator](){return this._originalMap[Symbol.iterator]()}toJSON(){return o([...this])}on(t,e){return super.on(t,e)}watch(t,e,i){return r(this,t,e,i)}notifyChange(t){e(this,t)}_watchProperty(t,e,r,s){return i(this,t,e,r,s)}}

package/utilities/ObservableSet.d.ts

@@ -1,10 +1,13 @@
-import { Observable } from "../support/Observable.js";
+import Evented from "@arcgis/core/core/Evented.js";
+import { type IDeprecatedObservable } from "../support/Observable.js";
 import type { EventHandler } from "../support/esri.js";
-import type { ChangeEvent } from "./collection.js";
+import type { AfterItemChangeEvent, ChangeEvent } from "./collection.js";
+import type { WatchCallback } from "./watch.js";
+declare const ObservableSet_base: typeof Evented & (abstract new (...args: any[]) => import("../support/observableUtils.js").ObservableMixin);
 /**
  * A Set that supports observability.
  */
-export declare class ObservableSet<T> extends Observable implements Set<T> {
+export declare class ObservableSet<T> extends ObservableSet_base implements Set<T>, IDeprecatedObservable {
     /**
      * Used by Object.toString().
      */
@@ -82,5 +85,43 @@ export declare class ObservableSet<T> extends Observable implements Set<T> {
      */
     toJSON(): unknown;
     on(name: "change", callback: (event: ChangeEvent<T>) => void): IHandle;
+    on(name: "after-add", callback: (event: AfterItemChangeEvent<this, T>) => void): IHandle;
+    on(name: "after-remove", callback: (event: AfterItemChangeEvent<this, T>) => void): IHandle;
     on(name: string, callback: EventHandler): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    set<T>(propertyPath: string, value: T): this;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    set(properties: HashMap<unknown>): this;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    get<T>(propertyPath: string): T;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    get(propertyPath: string): unknown;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    watch(path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    notifyChange(propertyKey: keyof this): void;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
+    _watchProperty(propertyKey: keyof this, subpath: string, callback: WatchCallback, sync: boolean): IHandle;
 }
+export {};

package/utilities/ObservableSet.js

@@ -1 +1 @@
-import{Observable as e}from"../support/Observable.js";import{toJSON as t}from"./object.js";export class ObservableSet extends e{[Symbol.toStringTag]="ObservableSet";get size(){return this._originalSet.size}_originalSet;constructor(){super(),this._originalSet=new Set}add(e){return this.has(e)||(this.notifyChange("size"),this._originalSet.add(e),this.emit("change",{added:[e],removed:[],moved:[],target:this})),this}addMany(e){const t=[];for(const i of e)this.has(i)||(t.push(i),this._originalSet.add(i));return t.length&&(this.notifyChange("size"),this.emit("change",{added:t,removed:[],moved:[],target:this})),this}clear(){if(!this.size)return;this.notifyChange("size");const e=Array.from(this.values());this._originalSet.clear(),this.emit("change",{added:[],removed:e,moved:[],target:this})}delete(e){return!!this.has(e)&&(this.notifyChange("size"),this._originalSet.delete(e),this.emit("change",{added:[],removed:[e],moved:[],target:this}),!0)}deleteMany(e){const t=[];for(const i of e)this.has(i)&&(t.push(i),this._originalSet.delete(i));return t.length&&(this.notifyChange("size"),this.emit("change",{added:[],removed:t,moved:[],target:this})),!!t.length}forEach(e,t){this._originalSet.forEach(e,t)}has(e){return this._originalSet.has(e)}entries(){return this._originalSet.entries()}keys(){return this._originalSet.keys()}values(){return this._originalSet.values()}[Symbol.iterator](){return this._originalSet[Symbol.iterator]()}toJSON(){return t([...this.values()])}on(e,t){return super.on(e,t)}}
+import t from"@arcgis/core/core/Evented.js";import{deprecatedGetPropertyPath as e,deprecatedNotifyChange as i,deprecatedSet as r,deprecatedWatch as s,deprecatedWatchProperty as a}from"../support/Observable.js";import{notifyChange as h,observable as o}from"../support/observableUtils.js";import{toJSON as n}from"./object.js";export class ObservableSet extends(o(t)){[Symbol.toStringTag]="ObservableSet";get size(){return this._originalSet.size}_originalSet;constructor(){super(),this._originalSet=new Set}add(t){return this.has(t)||(this._originalSet.add(t),h(this,"size"),this.emit("after-add",{item:t,target:this}),this.emit("change",{added:[t],removed:[],moved:[],target:this})),this}addMany(t){const e=[];for(const i of t)this.has(i)||(e.push(i),this._originalSet.add(i));if(e.length){if(h(this,"size"),this.hasEventListener("after-add"))for(const t of e)this.emit("after-add",{item:t,target:this});this.emit("change",{added:e,removed:[],moved:[],target:this})}return this}clear(){if(!this.size)return;const t=Array.from(this.values());if(this._originalSet.clear(),h(this,"size"),this.hasEventListener("after-remove"))for(const e of t)this.emit("after-remove",{item:e,target:this});this.emit("change",{added:[],removed:t,moved:[],target:this})}delete(t){return!!this.has(t)&&(this._originalSet.delete(t),h(this,"size"),this.emit("after-remove",{item:t,target:this}),this.emit("change",{added:[],removed:[t],moved:[],target:this}),!0)}deleteMany(t){const e=[];for(const i of t)this.has(i)&&(e.push(i),this._originalSet.delete(i));if(e.length){if(h(this,"size"),this.hasEventListener("after-remove"))for(const t of e)this.emit("after-remove",{item:t,target:this});this.emit("change",{added:[],removed:e,moved:[],target:this})}return!!e.length}forEach(t,e){this._originalSet.forEach(t,e)}has(t){return this._originalSet.has(t)}entries(){return this._originalSet.entries()}keys(){return this._originalSet.keys()}values(){return this._originalSet.values()}[Symbol.iterator](){return this._originalSet[Symbol.iterator]()}toJSON(){return n([...this.values()])}on(t,e){return super.on(t,e)}set(t,e){return r(this,t,e)}get(t){return e(this,t)}watch(t,e,i){return s(this,t,e,i)}notifyChange(t){i(this,t)}_watchProperty(t,e,i,r){return a(this,t,e,i,r)}}

package/utilities/ObservableWeakSet.d.ts

@@ -2,6 +2,9 @@ import { Observable } from "../support/Observable.js";
 import type { ChangeEvent } from "./collection.js";
 /**
  * A Set that supports observability.
+ *
+ * @deprecated This class is deprecated and will be removed in a future version.
+ *   Use {@link utilities/ObservableSet} instead.
  */
 export declare class ObservableWeakSet<T extends object> extends Observable implements WeakSet<T> {
     /**

package/utilities/ReadOnlyMap.d.ts

@@ -1,4 +1,6 @@
+import type { EventHandler } from "../support/esri.js";
 import { ObservableMap, type MapChangeEvent } from "./ObservableMap.js";
+import type { AfterItemChangeEvent } from "./collection.js";
 import type { WatchCallback } from "./watch.js";
 /**
  * A map that is read-only and delegates operations to an underlying
@@ -14,13 +16,24 @@ export declare class ReadOnlyMap<K, V> extends ObservableMap<K, V> {
      */
     protected readonly _originalMap: ObservableMap<K, V>;
     constructor(originalMap: ObservableMap<K, V>);
+    emit(type: string, event?: unknown): boolean;
     clear(): void;
     delete(key: K): boolean;
-    emit(type: string, event?: unknown): boolean;
     set(property: unknown, value: unknown): this;
     set(properties: unknown): this;
     set(key: K, value?: V): this;
+    on(name: "change", callback: (event: MapChangeEvent<K, V>) => void): IHandle;
+    on(name: "after-add", callback: (event: AfterItemChangeEvent<ObservableMap<K, V>, [K, V]>) => void): IHandle;
+    on(name: "after-remove", callback: (event: AfterItemChangeEvent<ObservableMap<K, V>, [K, V]>) => void): IHandle;
+    on(name: string, callback: EventHandler): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
     notifyChange(propertyKey: keyof this): void;
-    on(name: string, callback: (event: MapChangeEvent<K, V>) => void): IHandle;
+    /**
+     * @deprecated
+     * @inheritdoc
+     */
     watch(path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
 }

package/utilities/ReadOnlyMap.js

@@ -1 +1 @@
-import{InvalidOperationError as r}from"../InvalidOperationError.js";import{ObservableMap as t}from"./ObservableMap.js";const i="This map is read-only.";export class ReadOnlyMap extends t{constructor(r){super(),this._originalMap=r}clear(){throw new r(i)}delete(t){throw new r(i)}emit(r,t){return this._originalMap.emit(r,t)}set(){throw new r(i)}notifyChange(r){this._originalMap.notifyChange(r)}on(r,t){return this._originalMap.on(r,t)}watch(r,t,i){return this._originalMap.watch(r,t,i)}}
+import{InvalidOperationError as i}from"../InvalidOperationError.js";import{notifyChange as r,onWatch as t,watch as e}from"../support/observableUtils.js";import{ObservableMap as o}from"./ObservableMap.js";const s="This map is read-only.";export class ReadOnlyMap extends o{constructor(i){super(),this._originalMap=i,t(this,"size",(()=>e(this._originalMap,"size",(()=>r(this,"size")),{sync:!0})))}emit(i,r){return this._originalMap.emit(i,r)}clear(){throw new i(s)}delete(r){throw new i(s)}set(){throw new i(s)}on(i,r){return this._originalMap.on(i,r)}notifyChange(i){this._originalMap.notifyChange(i)}watch(i,r,t){return this._originalMap.watch(i,r,t)}}

package/utilities/_layer-preset.d.ts

@@ -0,0 +1,65 @@
+import type EsriMap from "@arcgis/core/Map";
+import Collection from "@arcgis/core/core/Collection.js";
+import type Layer from "@arcgis/core/layers/Layer";
+import { MapExtension } from "../mapping/MapExtension.js";
+import type { LayerExtension, LayerReference } from "../mapping/_LayerExtension.js";
+import type { SublayerExtension, SublayerReference } from "../mapping/_SublayerExtension.js";
+import type { SublayerLike } from "../support/esri.js";
+/**
+ * Creates a LayerReference or SublayerReference from various input types.
+ *
+ * @param ref The reference, which can be a string, number, LayerReference,
+ *   SublayerReference, Layer, or SublayerLike.
+ * @returns A LayerReference or SublayerReference object.
+ */
+export declare function createRef(ref: string | number | LayerReference | SublayerReference | Layer | SublayerLike): LayerReference | SublayerReference | undefined;
+/**
+ * Returns true if two LayerReference objects are considered equal.
+ *
+ * @param layerRef1 The first layer reference to compare.
+ * @param layerRef2 The second layer reference to compare.
+ * @param layerXList Optional to check group extensions.
+ */
+export declare function isLayerRefEqual(layerRef1: LayerReference, layerRef2: LayerReference, layerXList?: LayerExtension[]): boolean;
+/**
+ * Returns true if two SublayerReference objects are considered equal.
+ *
+ * Sublayers are considered equal if both their `id` and `title` properties
+ * match.
+ *
+ * @param subLayerRef1 The first sublayer reference to compare.
+ * @param sublayerRef2 The second sublayer reference to compare.
+ * @returns True if the sublayer references are equal, otherwise false.
+ */
+export declare function isSublayerRefEqual(subLayerRef1: SublayerReference, sublayerRef2: SublayerReference): boolean;
+/**
+ * Flattens a MapExtension or a Collection of LayerExtensions into a single
+ * Collection of LayerExtensions, including nested group layers.
+ *
+ * @param source The MapExtension or Collection of LayerExtensions to flatten.
+ * @returns A flattened Collection of LayerExtensions.
+ */
+export declare function createFlattenedLayerXList(source: MapExtension | Collection<LayerExtension>): Collection<LayerExtension>;
+/**
+ * Returns the backing Layer or SublayerLike for a given LayerExtension or
+ * SublayerExtension.
+ *
+ * @param extension The LayerExtension or SublayerExtension to get the backing
+ *   layer from.
+ * @returns The backing Layer or SublayerLike.
+ */
+export declare function getBackingLayer(extension: LayerExtension | SublayerExtension): Layer | SublayerLike;
+/**
+ * Converts an EsriMap or MapExtension to a MapExtension instance.
+ *
+ * @param mapOrExtension The EsriMap or MapExtension to convert.
+ * @returns A MapExtension instance.
+ */
+export declare function toMapExtension(mapOrExtension: EsriMap | MapExtension): MapExtension;
+/**
+ * Checks if the provided value is iterable.
+ *
+ * @param value The value to check.
+ * @returns True if the value is iterable, otherwise false.
+ */
+export declare function isIterable<T>(value: unknown): value is Iterable<T>;

package/utilities/_layer-preset.js

@@ -0,0 +1 @@
+import t from"@arcgis/core/core/Collection.js";import{isLayerExtension as e,isMapExtension as r,isSublayerExtension as i,isTableExtension as n}from"../ItemType.js";import{MapExtension as o}from"../mapping/MapExtension.js";import{isMap as a,isWebMap as u,isWebScene as l}from"../utilities/mapping.js";import{getLayerUrl as s,hasMmapLayer as f}from"./_layers.js";import{isGroupLayerExtension as p}from"./extensions.js";function c(t){if(t.layer)return;const e=function(t){const e=t.toJSON?.();if(e)return n(t),e?.$ref}(t);return e?"string"==typeof e?e:e.path:void 0}function y(t){if(t.sublayer)return t.sublayer.id;const e=function(t){const e=t.toJSON?.();if(e)return e?.$ref}(t);return e?"string"==typeof e?e:e.id:void 0}export function createRef(t){return"string"==typeof t?{id:t,title:t}:"number"==typeof t?{id:t}:e(t)?function(t){const e={id:t.layer?.id,title:t.title,url:s(t.layer)},r=c(t);return r&&(e.path=r),e}(t):i(t)?{id:y(r=t),title:r.title}:t&&"object"==typeof t&&"id"in t?t:void 0;var r}export function isLayerRefEqual(t,e,r){const i=t.id&&e.id&&t.id===e.id,n=t.title===e.title,o=t.url&&e.url&&t.url===e.url,a=t.path&&e.path&&t.path===e.path;if(i&&n||n&&a||n&&o||i&&o)return!0;if(n&&r){return r.some((t=>t.title===e.title&&(f([t])||p(t)&&0===t.layerExtensions.length)))}return!1}export function isSublayerRefEqual(t,e){return t.id===e.id&&t.title===e.title}export function createFlattenedLayerXList(e){if(r(e))return createFlattenedLayerXList(e.layerExtensions);const i=new t;for(const t of e.filter((t=>!!t.layer)).toArray())i.add(t),p(t)&&i.addMany(createFlattenedLayerXList(t.layerExtensions));return i}export function getBackingLayer(t){return e(t)?t.layer:t.sublayer}export function toMapExtension(t){const e=t;return a(e)||u(e)||l(e)?new o({map:e}):t}export function isIterable(t){return!!t?.[Symbol.iterator]}

package/utilities/collection.d.ts

@@ -7,6 +7,15 @@ import type { CompareOptions } from "./array.js";
 declare const DeprecatedCollection: typeof Collection;
 export { DeprecatedCollection as Collection };
 export type { CompareOptions, ChangeEvent };
+/**
+ * Raised when items are added or removed from a collection like object.
+ */
+export interface AfterItemChangeEvent<TCollection, TItem> extends __esri.CollectionAfterItemEvent<TItem> {
+    /**
+     * The collection like object that raised the event.
+     */
+    target: TCollection;
+}
 /**
  * Compares two collections and invokes callbacks for items that are new,
  * missing, or matching in the second collection relative to the first.

package/utilities/collection.js

@@ -1 +1 @@
-import o from"@arcgis/core/core/Collection";import{compare as r,compareAsync as c}from"./array.js";const e=o;export{e as Collection};export function compare(o,c,e){return r(o,c,e)}export async function compareAsync(o,r,e){return c(o,r,e)}
+import e from"@arcgis/core/core/Collection";import{compare as r,compareAsync as t}from"./array.js";const o=e;export{o as Collection};export function compare(e,t,o){return r(e,t,o)}export async function compareAsync(e,r,o){return t(e,r,o)}export function _generateChangeEvent(r,t){const o=t??new e,n=r??new e,c=o,a=o.filter((e=>n.includes(e))),i=n.filter((e=>o.includes(e))),l={added:o.filter((e=>!n.includes(e))).toArray(),removed:n.filter((e=>!o.includes(e))).toArray(),moved:a.filter(((e,r)=>i.indexOf(e)!==r)).toArray(),target:c};if(l.added.length||l.removed.length||l.moved.length)return l}

package/utilities/layer-preset.d.ts

@@ -0,0 +1 @@
+export { createRef, isLayerRefEqual, isSublayerRefEqual, getBackingLayer, toMapExtension, isIterable, } from "./_layer-preset.js";

package/utilities/layer-preset.js

@@ -0,0 +1 @@
+export{createRef,isLayerRefEqual,isSublayerRefEqual,getBackingLayer,toMapExtension,isIterable}from"./_layer-preset.js";

package/utilities/layers.d.ts

@@ -1 +1 @@
-export { hasMmapLayer, layersAreEquivalent, isBuildingComponentSublayer, isBuildingGroupSublayer, isBuildingSceneLayer, isCSVLayer, isElevationLayer, isFeatureLayer, isFeatureLayerBase, isGeoJSONLayer, isGeoRssLayer, isGraphicsLayer, isGroupLayer, isImageryLayer, isImageryTileLayer, isIntegratedMeshLayer, isKMLLayer, isKMLSublayer, isLayer, isLayerWithLegendEnabledProperty, isMapImageLayer, isMapImageSublayer, isOpenStreetMapLayer, isPointCloudLayer, isSceneLayer, isStreamLayer, isSublayer, isSubtypeGroupLayer, isSubtypeSublayer, isTileLayer, isTiledImageServiceLayer, isTiledMapServiceLayer, isVectorTileLayer, isWMSLayer, isWMSSublayer, isWMTSLayer, isWMTSSublayer, isWebTileLayer, } from "./_layers.js";
+export { getLayerUrl, hasMmapLayer, layersAreEquivalent, isBuildingComponentSublayer, isBuildingGroupSublayer, isBuildingSceneLayer, isCSVLayer, isElevationLayer, isFeatureLayer, isFeatureLayerBase, isGeoJSONLayer, isGeoRssLayer, isGraphicsLayer, isGroupLayer, isImageryLayer, isImageryTileLayer, isIntegratedMeshLayer, isKMLLayer, isKMLSublayer, isLayer, isLayerWithLegendEnabledProperty, isMapImageLayer, isMapImageSublayer, isOpenStreetMapLayer, isPointCloudLayer, isSceneLayer, isStreamLayer, isSublayer, isSubtypeGroupLayer, isSubtypeSublayer, isTileLayer, isTiledImageServiceLayer, isTiledMapServiceLayer, isVectorTileLayer, isWMSLayer, isWMSSublayer, isWMTSLayer, isWMTSSublayer, isWebTileLayer, } from "./_layers.js";

package/utilities/layers.js

@@ -1 +1 @@
-export{hasMmapLayer,layersAreEquivalent,isBuildingComponentSublayer,isBuildingGroupSublayer,isBuildingSceneLayer,isCSVLayer,isElevationLayer,isFeatureLayer,isFeatureLayerBase,isGeoJSONLayer,isGeoRssLayer,isGraphicsLayer,isGroupLayer,isImageryLayer,isImageryTileLayer,isIntegratedMeshLayer,isKMLLayer,isKMLSublayer,isLayer,isLayerWithLegendEnabledProperty,isMapImageLayer,isMapImageSublayer,isOpenStreetMapLayer,isPointCloudLayer,isSceneLayer,isStreamLayer,isSublayer,isSubtypeGroupLayer,isSubtypeSublayer,isTileLayer,isTiledImageServiceLayer,isTiledMapServiceLayer,isVectorTileLayer,isWMSLayer,isWMSSublayer,isWMTSLayer,isWMTSSublayer,isWebTileLayer}from"./_layers.js";
+export{getLayerUrl,hasMmapLayer,layersAreEquivalent,isBuildingComponentSublayer,isBuildingGroupSublayer,isBuildingSceneLayer,isCSVLayer,isElevationLayer,isFeatureLayer,isFeatureLayerBase,isGeoJSONLayer,isGeoRssLayer,isGraphicsLayer,isGroupLayer,isImageryLayer,isImageryTileLayer,isIntegratedMeshLayer,isKMLLayer,isKMLSublayer,isLayer,isLayerWithLegendEnabledProperty,isMapImageLayer,isMapImageSublayer,isOpenStreetMapLayer,isPointCloudLayer,isSceneLayer,isStreamLayer,isSublayer,isSubtypeGroupLayer,isSubtypeSublayer,isTileLayer,isTiledImageServiceLayer,isTiledMapServiceLayer,isVectorTileLayer,isWMSLayer,isWMSSublayer,isWMTSLayer,isWMTSSublayer,isWebTileLayer}from"./_layers.js";

package/utilities/watch.d.ts

@@ -1,8 +1,17 @@
-import Collection from "@arcgis/core/core/Collection";
+import type Accessor from "@arcgis/core/core/Accessor";
+import type Collection from "@arcgis/core/core/Collection";
 import type Evented from "@arcgis/core/core/Evented";
-import type { AccessorLike, ChangeEventCallback, EventHandler, WatchCallback } from "../support/esri.js";
+import type { Observable as DeprecatedObservable } from "../support/Observable.js";
+import type { ChangeEventCallback, EventHandler } from "../support/esri.js";
+import { type Observable } from "../support/observableUtils.js";
 import type { ObservableMap } from "./ObservableMap.js";
-export type { WatchCallback } from "../support/esri.js";
+/**
+ * A callback that gets invoked by esri's `watch` on classes that inherit from
+ * Accessor to notify observers about property changes.
+ *
+ * @deprecated
+ */
+export type WatchCallback<T = any, U = any> = (newValue: T, oldValue: T, propertyName: string, target: U) => void;
 /**
  * Listens for an event on each item in a collection.
  *
@@ -14,6 +23,7 @@ export declare function onEach<T extends Evented>(collection: Collection<T>, eve
 /**
  * Watches a property on each item in a collection.
  *
+ * @deprecated Use {@link support/observableUtils!watch} instead.
  * @param collection The collection of items to watch.
  * @param path The property path to watch on each item.
  * @param callback The callback to invoke. Note that the item that changed is
@@ -21,10 +31,11 @@ export declare function onEach<T extends Evented>(collection: Collection<T>, eve
  * @param sync Whether to invoke the callback synchronously. The default is
  *   `false`.
  */
-export declare function watchEach<T extends AccessorLike, U = unknown>(collection: Collection<T> | ObservableMap<unknown, T>, path: string | string[], callback: WatchCallback<U, T>, sync?: boolean): IHandle;
+export declare function watchEach<T extends Observable, U = unknown>(collection: Collection<T> | ObservableMap<unknown, T>, path: string | string[], callback: WatchCallback<U, T>, sync?: boolean): IHandle;
 /**
  * Watches a property on each item in a collection.
  *
+ * @deprecated Use {@link support/observableUtils!watchEach} instead.
  * @param collection The collection of items to watch.
  * @param getValue Function used to get the current value from each item. All
  *   accessed properties will be tracked.
@@ -33,10 +44,11 @@ export declare function watchEach<T extends AccessorLike, U = unknown>(collectio
  * @param sync Whether to invoke the callback synchronously. The default is
  *   `false`.
  */
-export declare function watchEach<T extends AccessorLike, U = unknown>(collection: Collection<T> | ObservableMap<unknown, T>, getValue: (item: T) => U, callback: (newValue: U, oldValue: U | undefined, item: T) => void, sync?: boolean): IHandle;
+export declare function watchEach<T extends DeprecatedObservable | Accessor, U = unknown>(collection: Collection<T> | ObservableMap<unknown, T>, getValue: (item: T) => U, callback: (newValue: U, oldValue: U | undefined, item: T) => void, sync?: boolean): IHandle;
 /**
  * Watches a property on each item in a collection property.
  *
+ * @deprecated Use {@link support/observableUtils!watchEach} instead.
  * @param obj The object to watch.
  * @param collectionPath The property path on the object that returns the
  *   collection to watch.
@@ -46,7 +58,7 @@ export declare function watchEach<T extends AccessorLike, U = unknown>(collectio
  * @param sync Whether to invoke the callback synchronously. The default is
  *   `false`.
  */
-export declare function watchCollectionPropertyEach(obj: AccessorLike, collectionPath: string, path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
+export declare function watchCollectionPropertyEach(obj: Observable, collectionPath: string, path: string | string[], callback: WatchCallback, sync?: boolean): IHandle;
 /**
  * Listens to change events on a collection property. This function also handles
  * the case where the collection property itself is changed, in addition to
@@ -56,13 +68,19 @@ export declare function watchCollectionPropertyEach(obj: AccessorLike, collectio
  * between the two collections and emit a "change" event with the appropriate
  * values for event.added, event.removed, etc.
  *
+ * Because this function calculates the difference between property changes it
+ * is best to avoid using this function if you are only interested in the
+ * collection changed event occurring and not the items that were added or
+ * removed. In that case, use {@link support/observableUtils!watchEvent}
+ * instead.
+ *
  * @param obj The object that owns the collection property to watch.
  * @param path The collection property to watch.
  * @param callback The callback to invoke when the collection changes.
  * @param sync Whether to invoke the callback synchronously. The default is
  *   `false`.
  */
-export declare function onCollectionPropertyChange<T>(obj: AccessorLike, path: string, callback: ChangeEventCallback<T>, sync?: boolean): IHandle;
+export declare function onCollectionPropertyChange<T>(obj: Observable, path: string, callback: ChangeEventCallback<T>, sync?: boolean): IHandle;
 /**
  * Listens for an emitted event from an object and executes a callback only once
  * before removing the listener.

package/utilities/watch.js

@@ -1 +1 @@
-import o from"@arcgis/core/core/Collection";import*as e from"@arcgis/core/core/reactiveUtils";import{getPropertyByPath as t}from"../support/Observable.js";import{checkArg as n}from"./checkArg.js";export function onEach(o,e,t){n("collection",o).isNotMissing(),n("eventType",e).isNotMissing().isNotEmpty(),n("callback",t).isNotMissing();const r=new Map;for(const n of o.toArray())r.set(n,n.on(e,t));const s=o.on("change",(o=>{for(const n of o.added)r.set(n,n.on(e,t));for(const e of o.removed){const o=r.get(e);o&&o.remove(),r.delete(e)}}));return{remove:()=>{s.remove(),r.forEach((o=>o.remove()))}}}export function watchEach(o,...t){let r;if(n("collection",o).isNotMissing(),"function"==typeof t[0]){const[o,s,i=!1]=t;n("getValue",o).isNotMissing(),n("callback",s).isNotMissing(),r=t=>e.watch((()=>o(t)),((o,e)=>s(o,e,t)),{sync:i})}else{const[o,e,s=!1]=t;n("path",o).isNotMissing().isNotEmpty(),n("callback",e).isNotMissing(),r=t=>t.watch(o,e,s)}const s=new Map;for(const e of"function"==typeof o.toArray?o.toArray():[...o.values()])s.set(e,r(e));const i=o.on("change",(o=>{for(const e of o.added){const o=Array.isArray(e)?e[1]:e;s.set(o,r(o))}for(const e of o.removed){const o=Array.isArray(e)?e[1]:e,t=s.get(o);t&&t.remove(),s.delete(o)}}));return{remove:()=>{i.remove(),s.forEach((o=>o.remove()))}}}export function watchCollectionPropertyEach(o,e,r,s,i=!1){n("obj",o).isNotMissing(),n("collectionProperty",e).isNotMissing().isNotEmpty(),n("path",r).isNotMissing().isNotEmpty(),n("callback",s).isNotMissing();const c=new Map,a=t(o,e);if(a)for(const o of a.toArray())c.set(o,o.watch(r,s,i));const l=onCollectionPropertyChange(o,e,(o=>{for(const e of o.added)c.set(e,e.watch(r,s,i));for(const e of o.removed){const o=c.get(e);o&&o.remove(),c.delete(e)}}),i);return{remove:()=>{l.remove(),c.forEach((o=>o.remove()))}}}export function onCollectionPropertyChange(o,e,r,s=!1){let i;n("obj",o).isNotMissing(),n("property",e).isNotMissing().isNotEmpty(),n("callback",r).isNotMissing();const c=t(o,e);c&&(i=c.on("change",r));const a=o.watch(e,((o,e)=>{i&&(i.remove(),i=void 0),o&&(i=o.on("change",r));const t=_generateChangeEvent(e,o);(t?.added.length||t?.removed.length||t?.moved.length)&&r(t)}),s);return{remove:()=>{i&&i.remove(),a.remove()}}}export function _generateChangeEvent(e,t){const n=t??new o,r=e??new o,s=n,i=n.filter((o=>r.includes(o))),c=r.filter((o=>n.includes(o))),a={added:n.filter((o=>!r.includes(o))).toArray(),removed:r.filter((o=>!n.includes(o))).toArray(),moved:i.filter(((o,e)=>c.indexOf(o)!==e)).toArray(),target:s};if(a.added.length||a.removed.length||a.moved.length)return a}export function onOnce(o,e,t){const n=o.on(e,(o=>{t(o),n.remove()}));return n}
+import*as o from"@arcgis/core/core/reactiveUtils";import{getPropertyByPath as t}from"../support/Observable.js";import{createIHandle as e,watch as r}from"../support/observableUtils.js";import{checkArg as s}from"./checkArg.js";import{_generateChangeEvent as n}from"./collection.js";export function onEach(o,t,e){s("collection",o).isNotMissing(),s("eventType",t).isNotMissing().isNotEmpty(),s("callback",e).isNotMissing();const r=new Map;for(const s of o.toArray())r.set(s,s.on(t,e));const n=o.on("change",(o=>{for(const s of o.added)r.set(s,s.on(t,e));for(const t of o.removed){const o=r.get(t);o&&o.remove(),r.delete(t)}}));return{remove:()=>{n.remove(),r.forEach((o=>o.remove()))}}}export function watchEach(t,...n){let c;if(s("collection",t).isNotMissing(),"function"==typeof n[0]){const[t,e,r=!1]=n;s("getValue",t).isNotMissing(),s("callback",e).isNotMissing(),c=s=>o.watch((()=>t(s)),((o,t)=>e(o,t,s)),{sync:r})}else{const[o,t,i=!1]=n;s("path",o).isNotMissing().isNotEmpty(),s("callback",t).isNotMissing(),c=s=>{const n=[];for(const e of Array.isArray(o)?o:[o])n.push(r(s,e,((o,r,s)=>t(o,r,e,s)),{sync:i}));return e(n)}}const i=new Map;for(const o of"function"==typeof t.toArray?t.toArray():[...t.values()])i.set(o,c(o));const a=t.on("change",(o=>{for(const t of o.added){const o=Array.isArray(t)?t[1]:t;i.set(o,c(o))}for(const t of o.removed){const o=Array.isArray(t)?t[1]:t,e=i.get(o);e&&e.remove(),i.delete(o)}}));return{remove:()=>{a.remove(),i.forEach((o=>o.remove()))}}}export function watchCollectionPropertyEach(o,e,n,c,i=!1){s("obj",o).isNotMissing(),s("collectionProperty",e).isNotMissing().isNotEmpty(),s("path",n).isNotMissing().isNotEmpty(),s("callback",c).isNotMissing();const a=new Map,f=t(o,e);if(f)for(const o of f.toArray())for(const t of Array.isArray(n)?n:[n])a.set(o,r(o,t,((o,e,r)=>c(o,e,t,r)),{sync:i}));const l=onCollectionPropertyChange(o,e,(o=>{for(const t of o.added)for(const o of Array.isArray(n)?n:[n])a.set(t,r(t,o,((t,e,r)=>c(t,e,o,r)),{sync:i}));for(const t of o.removed){const o=a.get(t);o&&o.remove(),a.delete(t)}}),i);return{remove:()=>{l.remove(),a.forEach((o=>o.remove()))}}}export function onCollectionPropertyChange(o,e,c,i=!1){let a;s("obj",o).isNotMissing(),s("property",e).isNotMissing().isNotEmpty(),s("callback",c).isNotMissing();const f=t(o,e);f&&(a=f.on("change",c));const l=r(o,e,((o,t)=>{a&&(a.remove(),a=void 0),o&&(a=o.on("change",c));const e=n(t,o);(e?.added.length||e?.removed.length||e?.moved.length)&&c(e)}),{sync:i});return{remove:()=>{a&&a.remove(),l.remove()}}}export function onOnce(o,t,e){const r=o.on(t,(o=>{e(o),r.remove()}));return r}

package/version.d.ts

@@ -1,4 +1,4 @@
 /**
  * The current version of the Geocortex ArcGIS Extensions API.
  */
-export declare const version = "49.8.1";
+export declare const version = "50.0.0";

package/version.js

@@ -1 +1 @@
-export const version="49.8.1";
+export const version="50.0.0";