@arcgis/core 5.2.0-next.120 → 5.2.0-next.121

package/basemaps/BasemapCollection.d.ts

@@ -0,0 +1,148 @@
+import type Basemap from "../Basemap.js";
+import type LocalBasemapsSource from "./LocalBasemapsSource.js";
+import type PortalBasemapsSource from "./PortalBasemapsSource.js";
+import type BasemapItem from "./support/BasemapItem.js";
+import type Collection from "../core/Collection.js";
+import type Portal from "../portal/Portal.js";
+import type { BasemapProperties } from "../Basemap.js";
+import type { LocalBasemapsSourceProperties } from "./LocalBasemapsSource.js";
+import type { PortalBasemapsSourceProperties } from "./PortalBasemapsSource.js";
+import type { BasemapCompatibilityFunction } from "./types.js";
+import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
+import type { Loadable, LoadableMixinProperties } from "../core/Loadable.js";
+import type { AbortOptions } from "../core/promiseUtils.js";
+import type { MapViewOrSceneView } from "../views/MapViewOrSceneView.js";
+
+/** @since 5.2 */
+export interface BasemapCollectionProperties extends LoadableMixinProperties, Partial<Pick<BasemapCollection, "view">> {
+  /**
+   * The map's [Map.basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).
+   *
+   * @since 5.2
+   */
+  activeBasemap?: BasemapProperties | string | null;
+  /**
+   * Function used to determine whether a basemap is compatible with the current view.
+   * This is mostly needed for SceneView.
+   *
+   * @since 5.2
+   */
+  compatibilityFunction?: BasemapCompatibilityFunction | null;
+  /**
+   * The source for basemaps that the gallery will display.
+   * This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s, or
+   * a [Portal](https://developers.arcgis.com/javascript/latest/references/core/portal/Portal/) instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/references/core/basemaps/PortalBasemapsSource/).
+   *
+   * @since 5.2
+   */
+  source?: Portal | LocalBasemapsSourceProperties | ReadonlyArrayOrCollection<Basemap> | PortalBasemapsSourceProperties;
+}
+
+/**
+ * Provides the logic for displaying and selecting a collection of basemaps.
+ *
+ * @since 5.2
+ * @see [LocalBasemapsSource](https://developers.arcgis.com/javascript/latest/references/core/basemaps/LocalBasemapsSource/)
+ * @see [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/references/core/basemaps/PortalBasemapsSource/)
+ */
+export default class BasemapCollection extends Loadable {
+  /** @since 5.2 */
+  constructor(properties?: BasemapCollectionProperties);
+  /**
+   * The map's [Map.basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).
+   *
+   * @since 5.2
+   */
+  get activeBasemap(): Basemap | null;
+  set activeBasemap(value: BasemapProperties | string | null | undefined);
+  /**
+   * The current index of the active [Map.basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).
+   *
+   * @since 5.2
+   */
+  get activeBasemapIndex(): number;
+  /**
+   * Function used to determine whether a basemap is compatible with the current view.
+   * This is mostly needed for SceneView.
+   *
+   * @since 5.2
+   */
+  get compatibilityFunction(): BasemapCompatibilityFunction;
+  set compatibilityFunction(value: BasemapCompatibilityFunction | null | undefined);
+  /**
+   * A collection of items representing basemaps.
+   *
+   * @since 5.2
+   */
+  get items(): Collection<BasemapItem>;
+  /**
+   * Indicates whether any basemap item in the collection is loading.
+   *
+   * @default false
+   * @since 5.2
+   */
+  get loading(): boolean;
+  /**
+   * Indicates whether the projection engine is loading resources required to change the active basemap.
+   *
+   * @default false
+   * @internal
+   * @since 5.2
+   */
+  get projectionEngineLoading(): boolean;
+  /**
+   * The source for basemaps that the gallery will display.
+   * This property can be autocast with an array or [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s, or
+   * a [Portal](https://developers.arcgis.com/javascript/latest/references/core/portal/Portal/) instance. The default source is a [PortalBasemapsSource](https://developers.arcgis.com/javascript/latest/references/core/basemaps/PortalBasemapsSource/).
+   *
+   * @since 5.2
+   */
+  get source(): LocalBasemapsSource | PortalBasemapsSource;
+  set source(value: Portal | LocalBasemapsSourceProperties | ReadonlyArrayOrCollection<Basemap> | PortalBasemapsSourceProperties);
+  /**
+   * The view from which the Basemap Gallery will operate. This view provides access to the active
+   * [Map.basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap) through the view's [View.map](https://developers.arcgis.com/javascript/latest/references/core/views/View/#map) property.
+   *
+   * @since 5.2
+   */
+  accessor view: MapViewOrSceneView | null | undefined;
+  /**
+   * A convenience function to check basemap equality.
+   *
+   * @param basemap1 - The basemap to compare against `basemap2`.
+   * @param basemap2 - The basemap to compare against `basemap1`.
+   * @returns Returns `true` if both basemaps are equal, `false` otherwise.
+   * @since 5.2
+   */
+  basemapEquals(basemap1: Basemap | null | undefined, basemap2: Basemap | null | undefined): boolean;
+  /**
+   * Destroys the basemap collection.
+   *
+   * @since 5.2
+   */
+  destroy(): void;
+  /**
+   * Loads the current basemap source.
+   *
+   * @returns A promise that resolves with this collection when the source has loaded.
+   * @since 5.2
+   */
+  load(): Promise<this>;
+  /**
+   * Loads the current basemap source.
+   *
+   * Unlike [load()](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/#load), this method can be called again after the source changes.
+   *
+   * @param options - Options for aborting the load.
+   * @returns A promise that resolves with this collection when the source has loaded.
+   * @internal
+   * @since 5.2
+   */
+  loadSource(options?: AbortOptions | null | undefined): Promise<this>;
+  /**
+   * Refreshes the collection of basemap items.
+   *
+   * @since 5.2
+   */
+  refresh(): void;
+}

package/basemaps/BasemapCollection.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"./LocalBasemapsSource.js";import i from"./PortalBasemapsSource.js";import{default3DCompatibility as s,default2DCompatibility as a}from"./support/basemapCompatibilityUtils.js";import o from"./support/BasemapItem.js";import r from"../core/Collection.js";import{Loadable as n,isLoadable as p}from"../core/Loadable.js";import{watch as c,on as m,when as l}from"../core/reactiveUtils.js";import{property as u,subclass as d}from"../core/accessorSupport/decorators.js";import{canProjectWithoutEngine as h,isLoaded as f,load as y}from"../geometry/projectionUtils.js";import{equals as v}from"../geometry/support/spatialReferenceUtils.js";import{basemapEnsureType as b}from"../support/basemapEnsureType.js";import{contentEquals as g}from"../support/basemapUtils.js";import{isBasemapsSource as j}from"../support/userTypeGuards/isBasemapsSource.js";const w=r.ofType(o);function _(e){return e&&"esri.portal.Portal"===e.declaredClass}function B(e){return e&&!(e instanceof i)&&(!!e.portal||!!e.query)}let I=class extends n{constructor(e){super(e),this._loadingProjectionEngine=!1,this.items=new w,this.view=null,this.source=new i}initialize(){const e=()=>this._recreateItems();this.addHandles([c(()=>[this.view,this.compatibilityFunction],()=>this._updateItems()),m(()=>this.source?.basemaps,"change",e,{onListenerAdd:e}),l(()=>this.view,()=>{this.source instanceof i&&(this.source.viewType=this.view?.type)},{once:!0})])}destroy(){const e=this.source.basemaps.indexOf(this.activeBasemap);this.source.basemaps.removeAt(e),this.source?.destroy()}get activeBasemap(){return this.view?.map?.basemap??null}set activeBasemap(e){const t=this.view;if(!t?.map)return;if(!(e=b(e))||!t.ready)return t.map.basemap=e,void this._clearOverride("activeBasemap");const i=e.spatialReference||this.items?.find(t=>this.basemapEquals(e,t.basemap))?.spatialReference;if(i&&"spatialReferenceLocked"in t&&!t.spatialReferenceLocked){const s=t.spatialReference;if(null!=i&&!v(s,i)&&!h(t.spatialReference,i)&&!f())return this._override("activeBasemap",e),this._loadingProjectionEngine=!0,void y().then(()=>{this._get("activeBasemap")===e&&(t.map.basemap=e,t.spatialReference=i,this._clearOverride("activeBasemap"))},()=>{}).finally(()=>{this._loadingProjectionEngine=!1});t.map.basemap=e,this._clearOverride("activeBasemap"),null==i||v(t.spatialReference,i)||(t.spatialReference=i)}else t.map.basemap=e,this._clearOverride("activeBasemap")}get activeBasemapIndex(){return this._findBasemapIndex(this.activeBasemap)}get compatibilityFunction(){return"3d"===this.view?.type?s:a}set compatibilityFunction(e){this._overrideIfSome("compatibilityFunction",e)}get source(){return this._get("source")}set source(e){(Array.isArray(e)||r.isCollection(e))&&(e=new t({basemaps:Array.isArray(e)?new r(e):e})),_(e)&&(e=new i({portal:e})),B(e)&&(e=new i(e)),j(e)||(e=null),this._set("source",e)}get loading(){return this.items.some(e=>"loading"===e.state)}get projectionEngineLoading(){return this._loadingProjectionEngine}basemapEquals(e,t){return g(e,t)}refresh(){this._recreateItems()}load(){return this.loadSource()}loadSource(e){return this.addResolvingPromise(p(this.source)?this.source.load(e):null),Promise.resolve(this)}_findBasemapIndex(e){const{items:t}=this,i=t.findIndex(t=>t.basemap===e);return-1===i?t.findIndex(t=>this.basemapEquals(t.basemap,e)):i}_recreateItems(){const e=this.source?.basemaps??[],{view:t,compatibilityFunction:i}=this,s=new Map(this.items.map(e=>[e.basemap,e])),a=e.map(e=>{const a=s.get(e);return a?(s.delete(e),a):new o({basemap:e,compatibilityFunction:i,view:t})});this.items.removeAll(),this.items.addMany(a),s.forEach(e=>e.destroy())}_updateItems(){for(const e of this.items)e.compatibilityFunction=this.compatibilityFunction,e.view=this.view}};e([u()],I.prototype,"_loadingProjectionEngine",void 0),e([u()],I.prototype,"activeBasemap",null),e([u({readOnly:!0})],I.prototype,"activeBasemapIndex",null),e([u()],I.prototype,"compatibilityFunction",null),e([u({readOnly:!0,type:w})],I.prototype,"items",void 0),e([u()],I.prototype,"source",null),e([u({readOnly:!0})],I.prototype,"loading",null),e([u({readOnly:!0})],I.prototype,"projectionEngineLoading",null),e([u()],I.prototype,"view",void 0),I=e([d("esri.basemaps.BasemapCollection")],I);const E=I;export{E as default};

package/basemaps/BasemapsSource.d.ts

@@ -0,0 +1,39 @@
+import type Basemap from "../Basemap.js";
+import type Accessor from "../core/Accessor.js";
+import type Collection from "../core/Collection.js";
+import type { BasemapsSourceState } from "./types.js";
+
+/**
+ * Properties for constructing a [BasemapsSource](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapsSource/).
+ *
+ * @since 5.2
+ */
+export interface BasemapsSourceProperties {}
+
+/**
+ * Defines a source of basemaps.
+ *
+ * @since 5.2
+ */
+export default abstract class BasemapsSource extends Accessor {
+  /** @since 5.2 */
+  constructor(properties?: BasemapsSourceProperties);
+  /**
+   * The collection of basemaps provided by the source.
+   *
+   * @since 5.2
+   */
+  abstract basemaps: Collection<Basemap>;
+  /**
+   * The current state of the source.
+   *
+   * @since 5.2
+   */
+  abstract readonly state: BasemapsSourceState;
+  /**
+   * Refreshes the basemaps provided by the source.
+   *
+   * @since 5.2
+   */
+  abstract refresh(): void;
+}

package/basemaps/BasemapsSource.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as s}from"tslib";import r from"../core/Accessor.js";import{subclass as o}from"../core/accessorSupport/decorators.js";import{BasemapsSourceSymbol as e}from"../support/userTypeGuards/isBasemapsSource.js";var t;let a=class extends r{static{t=e}constructor(s){super(s),this[t]=!0}};a=s([o("esri.basemaps.BasemapsSource")],a);const c=a;export{c as default};

package/basemaps/LocalBasemapsSource.d.ts

@@ -0,0 +1,55 @@
+import type Basemap from "../Basemap.js";
+import type BasemapsSource from "./BasemapsSource.js";
+import type Collection from "../core/Collection.js";
+import type { BasemapsSourceState } from "./types.js";
+import type { BasemapProperties } from "../Basemap.js";
+import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
+import type { BasemapsSourceProperties } from "./BasemapsSource.js";
+
+/** @since 5.2 */
+export interface LocalBasemapsSourceProperties extends BasemapsSourceProperties {
+  /**
+   * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s.
+   *
+   * @since 5.2
+   */
+  basemaps?: ReadonlyArrayOrCollection<BasemapProperties>;
+}
+
+/**
+ * A collection-driven source for [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s in a [BasemapCollection](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/).
+ *
+ * @since 5.2
+ * @see [BasemapCollection.source](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/#source)
+ */
+export default class LocalBasemapsSource extends BasemapsSource {
+  /** @since 5.2 */
+  constructor(properties?: LocalBasemapsSourceProperties);
+  /**
+   * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s.
+   *
+   * @since 5.2
+   */
+  get basemaps(): Collection<Basemap>;
+  set basemaps(value: ReadonlyArrayOrCollection<BasemapProperties>);
+  /**
+   * The source's state. The state is always `ready`.
+   *
+   * @since 5.2
+   */
+  get state(): BasemapsSourceState;
+  /**
+   * Destroys the local basemaps source.
+   *
+   * @since 5.2
+   */
+  destroy(): void;
+  /**
+   * Refreshes the source basemaps.
+   * Note: `refresh` will not affect LocalBasemapsSource.
+   * Modify basemaps directly instead.
+   *
+   * @since 5.2
+   */
+  refresh(): void;
+}

package/basemaps/LocalBasemapsSource.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as s}from"tslib";import e from"../Basemap.js";import o from"./BasemapsSource.js";import r from"../core/Collection.js";import{property as t,subclass as a}from"../core/accessorSupport/decorators.js";const p=r.ofType(e);let m=class extends o{constructor(s){super(s),this.basemaps=new p}destroy(){this.basemaps.forEach(s=>s.destroy())}get state(){return"ready"}refresh(){}};s([t({type:p})],m.prototype,"basemaps",void 0),s([t({readOnly:!0})],m.prototype,"state",null),m=s([a("esri.basemaps.LocalBasemapsSource")],m);const c=m;export{c as default};

package/basemaps/PortalBasemapsSource.d.ts

@@ -0,0 +1,98 @@
+import type Basemap from "../Basemap.js";
+import type LocalBasemapsSource from "./LocalBasemapsSource.js";
+import type Collection from "../core/Collection.js";
+import type Portal from "../portal/Portal.js";
+import type { LocalBasemapsSourceProperties } from "./LocalBasemapsSource.js";
+import type { BasemapFilter, BasemapsSourceState, UpdateBasemapsCallback } from "./types.js";
+import type { LoadableMixin, LoadableMixinProperties } from "../core/Loadable.js";
+import type { EsriPromiseMixin } from "../core/Promise.js";
+import type { AbortOptions } from "../core/promiseUtils.js";
+import type { PortalProperties } from "../portal/Portal.js";
+
+/** @since 5.2 */
+export interface PortalBasemapsSourceProperties extends LocalBasemapsSourceProperties, LoadableMixinProperties, Partial<Pick<PortalBasemapsSource, "filterFunction" | "query" | "updateBasemapsCallback" | "viewType">> {
+  /**
+   * The Portal from which to fetch basemaps.
+   *
+   * @since 5.2
+   */
+  portal?: PortalProperties;
+}
+
+/**
+ * A Portal-driven source for [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s in a [BasemapCollection](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/).
+ *
+ * @since 5.2
+ * @see [BasemapCollection.source](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/#source)
+ */
+export default class PortalBasemapsSource extends PortalBasemapsSourceSuperclass {
+  /** @since 5.2 */
+  constructor(properties?: PortalBasemapsSourceProperties);
+  /**
+   * A collection of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)s fetched from the source's Portal.
+   *
+   * @since 5.2
+   */
+  get basemaps(): Collection<Basemap>;
+  /**
+   * Function used to filter basemaps after being fetched from the Portal.
+   *
+   * @since 5.2
+   */
+  accessor filterFunction: BasemapFilter | null | undefined;
+  /**
+   * The Portal from which to fetch basemaps.
+   *
+   * @since 5.2
+   */
+  get portal(): Portal;
+  set portal(value: PortalProperties);
+  /**
+   * An object with key-value pairs used to create a custom basemap gallery group query.
+   * Note that all parameters will be joined using the `AND` operator.
+   * A query string can also be provided for more advanced use cases.
+   *
+   * @since 5.2
+   */
+  accessor query: Record<string, any> | string | null | undefined;
+  /**
+   * The source's state.
+   *
+   * @default "not-loaded"
+   * @since 5.2
+   */
+  get state(): BasemapsSourceState;
+  /**
+   * Callback for updating basemaps after being fetched and filtered.
+   *
+   * @since 5.2
+   */
+  accessor updateBasemapsCallback: UpdateBasemapsCallback | null | undefined;
+  /**
+   * @internal
+   * @since 5.2
+   */
+  accessor viewType: "2d" | "3d" | null | undefined;
+  /**
+   * Destroys the Portal basemaps source.
+   *
+   * @since 5.2
+   */
+  destroy(): void;
+  /**
+   * Loads the source's Portal.
+   *
+   * @param options - Options for aborting the load.
+   * @returns A promise that resolves with this source when the Portal has loaded.
+   * @since 5.2
+   */
+  load(options?: AbortOptions | null | undefined): Promise<this>;
+  /**
+   * Refreshes basemaps by fetching them from the Portal.
+   *
+   * @returns A promise that resolves when the basemaps have been fetched.
+   * @since 5.2
+   */
+  refresh(): Promise<void>;
+}
+declare const PortalBasemapsSourceSuperclass: typeof LocalBasemapsSource & typeof EsriPromiseMixin & typeof LoadableMixin

package/basemaps/PortalBasemapsSource.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as t}from"tslib";import a from"../Basemap.js";import s from"./LocalBasemapsSource.js";import{createTask as e}from"../core/asyncUtils.js";import o from"../core/Collection.js";import r from"../core/Error.js";import{LoadableMixin as i}from"../core/Loadable.js";import l from"../core/Logger.js";import{EsriPromiseMixin as p}from"../core/Promise.js";import{ignoreAbortErrors as m,throwIfAborted as n,isAbortError as d}from"../core/promiseUtils.js";import{watch as u,initial as h}from"../core/reactiveUtils.js";import{property as c,subclass as y}from"../core/accessorSupport/decorators.js";import f from"../portal/Portal.js";const b=o.ofType(a);let v=class extends(i(p(s))){constructor(t){super(t),this._loadTask=null,this.basemaps=new b,this.filterFunction=null,this.portal=f.getDefault(),this.query=null,this.updateBasemapsCallback=null,this.viewType=null}initialize(){this.addHandles(u(()=>[this.filterFunction,this.loadStatus,this.portal?.basemapGalleryGroupQuery,this.portal?.basemapGalleryGroupQuery3D,this.portal?.user,this.query,this.updateBasemapsCallback],()=>m(this.refresh()),h))}destroy(){this._loadTask?.abort(),this.filterFunction=null,this.portal=null,this.basemaps.forEach(t=>t.destroy())}get state(){return"not-loaded"===this.loadStatus?"not-loaded":"loading"===this.loadStatus||this._loadTask&&!this._loadTask.finished?"loading":"ready"}load(t){return this.addResolvingPromise(this.portal.load(t)),Promise.resolve(this)}async refresh(){if("loaded"!==this.loadStatus)return;this._loadTask?.abort();const t=this.portal;return(this._loadTask=e(async a=>{try{const s=await t.fetchBasemaps(this._toQueryString(this.query),{signal:a,include3d:"3d"===this.viewType||void 0});n(a),await this._updateBasemaps(s,a)}catch(s){if(d(s))throw s;n(a),l.getLogger(this).warn(new r("basemap-source:fetch-basemaps-error","Could not fetch basemaps from portal.",{error:s})),await this._updateBasemaps([],a)}})).promise}_toQueryString(t){return t&&"string"!=typeof t?Object.keys(t).map(a=>`${a}:${t[a]}`).join(" AND "):t}async _updateBasemaps(t,a){let s=await this._filterBasemaps(t);n(a),this.updateBasemapsCallback&&(s=await this.updateBasemapsCallback(s),n(a)),this.basemaps.removeAll(),this.basemaps.addMany(s)}async _filterBasemaps(t){if(!this.filterFunction)return t;const a=t.map(this.filterFunction),s=await Promise.all(a);return t.filter((t,a)=>s[a])}};t([c()],v.prototype,"_loadTask",void 0),t([c({readOnly:!0,type:b})],v.prototype,"basemaps",void 0),t([c()],v.prototype,"filterFunction",void 0),t([c({type:f})],v.prototype,"portal",void 0),t([c()],v.prototype,"query",void 0),t([c({readOnly:!0})],v.prototype,"state",null),t([c()],v.prototype,"updateBasemapsCallback",void 0),t([c()],v.prototype,"viewType",void 0),v=t([y("esri.basemaps.PortalBasemapsSource")],v);const g=v;export{g as default};

package/basemaps/support/BasemapItem.d.ts

@@ -0,0 +1,74 @@
+import type Basemap from "../../Basemap.js";
+import type Accessor from "../../core/Accessor.js";
+import type EsriError from "../../core/Error.js";
+import type SpatialReference from "../../geometry/SpatialReference.js";
+import type { BasemapCompatibilityFunction } from "../types.js";
+import type { IdentifiableMixin, IdentifiableMixinProperties } from "../../core/Identifiable.js";
+import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
+
+/** @since 5.2 */
+export interface BasemapItemProperties extends IdentifiableMixinProperties, Partial<Pick<BasemapItem, "basemap" | "compatibilityFunction" | "view">> {}
+
+/** @since 5.2 */
+export type BasemapItemState = "ready" | "loading" | "error";
+
+/**
+ * Represents one of the basemaps in [BasemapCollection.items](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/#items).
+ *
+ * @since 5.2
+ * @see [BasemapCollection.items](https://developers.arcgis.com/javascript/latest/references/core/basemaps/BasemapCollection/#items)
+ */
+export default class BasemapItem extends BasemapItemSuperclass {
+  /** @since 5.2 */
+  constructor(properties?: BasemapItemProperties);
+  /**
+   * The item's associated basemap.
+   *
+   * @since 5.2
+   */
+  accessor basemap: Basemap;
+  /**
+   * Function used to determine whether a basemap is compatible with the current view.
+   * This is mostly needed for SceneView.
+   *
+   * @since 5.2
+   */
+  accessor compatibilityFunction: BasemapCompatibilityFunction | null;
+  /**
+   * The Error object returned if an error occurred.
+   *
+   * @since 5.2
+   */
+  get error(): EsriError | null | undefined;
+  /**
+   * The spatial reference of the item's basemap.
+   *
+   * @since 5.2
+   */
+  get spatialReference(): SpatialReference | null | undefined;
+  /**
+   * The item's state.
+   *
+   * @since 5.2
+   */
+  get state(): BasemapItemState;
+  /**
+   * The view associated with this item.
+   *
+   * @since 5.2
+   */
+  accessor view: MapViewOrSceneView | null | undefined;
+  /**
+   * Destroys the basemap item.
+   *
+   * @since 5.2
+   */
+  destroy(): void;
+  /**
+   * Refreshes the item's state.
+   *
+   * @since 5.2
+   */
+  refresh(): void;
+}
+declare const BasemapItemSuperclass: typeof Accessor & typeof IdentifiableMixin

package/basemaps/support/BasemapItem.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"../../core/Accessor.js";import{createTask as r}from"../../core/asyncUtils.js";import{IdentifiableMixin as s}from"../../core/Identifiable.js";import{abortMaybe as i}from"../../core/maybe.js";import{isAbortError as a}from"../../core/promiseUtils.js";import{watch as o,whenOnce as l}from"../../core/reactiveUtils.js";import{property as n,subclass as p}from"../../core/accessorSupport/decorators.js";import{findSpatialReference as c}from"../../support/basemapUtils.js";let h=class extends(s(t)){constructor(e){super(e),this._refreshTask=null,this.compatibilityFunction=null,this.view=null}initialize(){this.addHandles(o(()=>[this.basemap?.loadStatus,this.compatibilityFunction,this.view&&"basemapTerrain"in this.view&&this.view.basemapTerrain?.tilingScheme,this.view?.ready,this.view?.spatialReference],()=>this.refresh())),this.refresh()}destroy(){this._refreshTask?.abort()}get _spatialReferenceTask(){return c(this.view,this.basemap)}set basemap(e){e?.load().catch(()=>{}),this._set("basemap",e)}get error(){if(!this.compatibilityFunction)return"failed"===this.basemap?.loadStatus?this.basemap.loadError:null;const e=this._refreshTask?.error;return a(e)?null:e}get spatialReference(){return this._spatialReferenceTask.spatialReference}get state(){const e=this.basemap?.loadStatus;if("loaded"!==e&&"failed"!==e)return"loading";if(!this.compatibilityFunction)return"loaded"===e?"ready":"error";const t=this._refreshTask;return!t?.finished||a(t.error)?"loading":t.error?"error":"ready"}refresh(){this._refreshTask=i(this._refreshTask);const e=this.basemap?.loadStatus;if("loaded"!==e&&"failed"!==e)return;const t=this.compatibilityFunction;t&&(this._refreshTask=r(async e=>{await t(this,{signal:e}),await l(()=>!this._spatialReferenceTask.updating,e)}))}};e([n()],h.prototype,"_refreshTask",void 0),e([n({readOnly:!0})],h.prototype,"_spatialReferenceTask",null),e([n()],h.prototype,"basemap",null),e([n()],h.prototype,"compatibilityFunction",void 0),e([n({readOnly:!0})],h.prototype,"error",null),e([n({readOnly:!0})],h.prototype,"spatialReference",null),e([n({readOnly:!0})],h.prototype,"state",null),e([n()],h.prototype,"view",void 0),h=e([p("esri.basemaps.support.BasemapItem")],h);const m=h;export{m as default};

package/basemaps/support/basemapCompatibilityUtils.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{isSome as e}from"../../core/arrayUtils.js";import t from"../../core/Error.js";import{throwIfAborted as a}from"../../core/promiseUtils.js";import{isTiledLayer as i,isBasemap3DSupportedLayer as r,isIntegratedMesh3DTilesLayer as n,isBasemapSupportedTiledLayer as s}from"../../layers/support/layerUtils.js";import{stringFromViewingMode as o}from"../../views/ViewingMode.js";import{getTileInfoAndExtentFromWMTSLayer as l,checkIfTileInfoSupportedForView as p}from"../../views/3d/terrain/terrainUtils.js";import{TilingScheme as c}from"../../views/3d/terrain/TilingScheme.js";import{isSpatialReferenceSupported as m}from"../../views/support/spatialReferenceSupport.js";async function f(e,t={}){const{basemap:i,view:r}=e;await i.load(t),w(i),await h(i,r,t),a(t)}async function u(t,r={}){const{basemap:n,view:s}=t;a(r);const o=n.baseLayers.find(e=>"unknown"===e.type)?.loadError;if(null!=o)throw o;if(!s||"spatialReferenceLocked"in s&&!s.spatialReferenceLocked)return;if(await n.load(r),a(r),0===n.baseLayers.length)return;const l=n.baseLayers.at(0);if(!i(l))return;if(n.spatialReference){if(s.spatialReference.equals(n.spatialReference))return;y()}await l.load(r),a(r);const p=(("supportedSpatialReferences"in l?l.supportedSpatialReferences:null)||["tileInfo"in l?l.tileInfo?.spatialReference:null]).filter(e);0!==p.length&&p.every(e=>!s.spatialReference.equals(e))&&y()}function y(){throw new t("basemap-compatibility:incompatible-spatial-reference","Basemap spatial reference is not compatible with the view")}function w(e){if(0===e.baseLayers.length&&0===e.groundLayers.length&&0===e.referenceLayers.length)return;const t=e.baseLayers.concat(e.referenceLayers).toArray().filter(e=>!r(e)).map(e=>b(e));if(t.length)throw t[0];if(e.groundLayers){const t=e.groundLayers.filter(e=>!n(e)).map(e=>b(e)).toArray();if(t.length)throw t[0]}}function b(e){const a=e.operationalLayerType||"unknown";return new t("basemap-compatibility:unsupported-basemap-layer-type",`Unsupported basemap layer type ${a}`,{layer:e,operationalLayerType:a})}async function h(e,a,i){let r=e.baseLayers.at(0);if(e.groundLayers?.length>0)r=e.groundLayers.at(0);else{if(!(e.baseLayers.length>0))return;r=e.baseLayers.at(0)}if(s(r)){try{await r.load(i)}catch(n){const e="basemap-compatibility:unknown-error",a="Unknown basemap compatibility error",{name:i=e,message:r=a,details:s}=n;throw new t(i,r,s)}g(r,a)}}function g(e,a){const i=a.state.viewingMode;if(!i)return;let r,n;if("wmts"===e?.type){const s=l(e,a.spatialReference,i);if(null==s.tileInfo)throw new t("basemapgalleryitem:tiling-scheme-incompatible","Basemap tiling scheme is incompatible with the view");r=s.tileInfo,n=s.fullExtent}else r=e.tileInfo,n=e.fullExtent;if(null==r)return;if(!m(r.spatialReference,i))throw new t(`basemapgalleryitem:spatial-reference-unsupported-${o(i)}`,`Basemap spatial reference is unsupported in ${o(i)} mode`);const s="vector-tile"===e?.type?r.getCompatibleForVTL(256):null;if(1===i){let a=p(r,n,null,i);if(a&&"vector-tile"===e?.type&&null!=n&&s&&!p(s,n,null,i)&&(a=null),a){const e=r.spatialReference.isWebMercator?"web-mercator":"wgs84";throw new t(`basemapgalleryitem:tiling-scheme-unsupported-${e}-global`,"Basemap tiling scheme is unsupported in global mode",{error:a})}}else if(c.checkUnsupported(r))throw new t("basemapgalleryitem:tiling-scheme-unsupported-local","Basemap tiling scheme is unsupported in local mode");const f=a.basemapTerrain?.tilingScheme;if(f&&!f.compatibleWith(r)&&("vector-tile"!==e?.type||!s||!f.compatibleWith(s)))throw new t("basemapgalleryitem:tiling-scheme-incompatible","Basemap tiling scheme is incompatible with the view")}export{u as default2DCompatibility,f as default3DCompatibility};

package/basemaps/types.d.ts

@@ -0,0 +1,42 @@
+import type Basemap from "../Basemap.js";
+import type BasemapItem from "./support/BasemapItem.js";
+import type { AbortOptions } from "../core/promiseUtils.js";
+
+/**
+ * This function is used by the [PortalBasemapsSource.filterFunction](https://developers.arcgis.com/javascript/latest/references/core/basemaps/PortalBasemapsSource/#filterFunction) property to filter
+ * basemaps after they are fetched from the Portal.
+ *
+ * _Support for asynchronous filter functions was added at version 4.27._
+ *
+ * @param item - The current Basemap item being assessed in the array.
+ * @param index - The index of the Basemap being assessed.
+ * @param array - The array of basemaps being filtered.
+ * @returns Returns true if the test passes, false otherwise.
+ * @since 5.2
+ */
+export type BasemapFilter = (item: Basemap, index: number, array: Basemap[]) => boolean | Promise<boolean>;
+
+/**
+ * This function is used by the [PortalBasemapsSource.updateBasemapsCallback](https://developers.arcgis.com/javascript/latest/references/core/basemaps/PortalBasemapsSource/#updateBasemapsCallback) property for
+ * updating basemaps after being fetched and filtered.
+ *
+ * _Support for asynchronous update functions was added at version 4.29._
+ *
+ * @param items - An array of basemaps that have been fetched and filtered from the Portal.
+ * @returns The array of basemaps to display in the BasemapGallery.
+ * @since 5.2
+ */
+export type UpdateBasemapsCallback = (items: Basemap[]) => Basemap[] | Promise<Basemap[]>;
+
+/** @since 5.2 */
+export type BasemapsSourceState = "ready" | "loading" | "not-loaded";
+
+/**
+ * Determines whether a basemap is compatible with a view.
+ *
+ * @param item - The basemap gallery item to check.
+ * @param options - Options for aborting the compatibility check.
+ * @returns A promise that resolves when the basemap is compatible.
+ * @since 5.2
+ */
+export type BasemapCompatibilityFunction = (item: BasemapItem, options?: AbortOptions) => Promise<void>;

package/chunks/CheckerBoard.glsl.js

@@ -1,5 +1,5 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{SliceDraw as e}from"../views/3d/webgl-engine/core/shaderLibrary/Slice.glsl.js";import{ColorConversion as o}from"../views/3d/webgl-engine/core/shaderLibrary/util/ColorConversion.glsl.js";import{addProjViewLocalOrigin as r}from"../views/3d/webgl-engine/core/shaderLibrary/util/View.glsl.js";import{Float2PassUniform as i}from"../views/3d/webgl-engine/core/shaderModules/Float2PassUniform.js";import{Float4PassUniform as l}from"../views/3d/webgl-engine/core/shaderModules/Float4PassUniform.js";import{glsl as s}from"../views/3d/webgl-engine/core/shaderModules/glsl.js";import{outputColorHighlightOLID as a}from"../views/3d/webgl-engine/shaders/OutputColorHighlightOLID.glsl.js";import{ShaderBuilder as d}from"../views/webgl/ShaderBuilder.js";function t(t){const n=new d,{vertex:c,fragment:v,varyings:g}=n;return n.fragment.include(e,t),n.include(a,t),r(c,t),n.attributes.add("position","vec3"),n.attributes.add("uv0","vec2"),g.add("vUV","vec2"),g.add("vpos","vec3"),c.main.add(s`vUV = uv0;
+import{sliceDraw as e}from"../views/3d/webgl-engine/core/shaderLibrary/Slice.glsl.js";import{ColorConversion as o}from"../views/3d/webgl-engine/core/shaderLibrary/util/ColorConversion.glsl.js";import{addProjViewLocalOrigin as r}from"../views/3d/webgl-engine/core/shaderLibrary/util/View.glsl.js";import{Float2PassUniform as i}from"../views/3d/webgl-engine/core/shaderModules/Float2PassUniform.js";import{Float4PassUniform as l}from"../views/3d/webgl-engine/core/shaderModules/Float4PassUniform.js";import{glsl as s}from"../views/3d/webgl-engine/core/shaderModules/glsl.js";import{outputColorHighlightOLID as a}from"../views/3d/webgl-engine/shaders/OutputColorHighlightOLID.glsl.js";import{ShaderBuilder as d}from"../views/webgl/ShaderBuilder.js";function t(t){const n=new d,{vertex:c,fragment:v,varyings:g}=n;return n.fragment.include(e,t),n.include(a,t),r(c,t),n.attributes.add("position","vec3"),n.attributes.add("uv0","vec2"),g.add("vUV","vec2"),g.add("vpos","vec3"),c.main.add(s`vUV = uv0;
 vpos = position;
 gl_Position = proj * view * vec4(position, 1.0);`),v.uniforms.add(new i("size",e=>e.size)),v.uniforms.add(new l("color1",e=>e.color1)),v.uniforms.add(new l("color2",e=>e.color2)),v.include(o),v.main.add(s`vec2 uvScaled = vUV / (2.0 * size);
 vec2 uv = fract(uvScaled - 0.25);

package/chunks/ColorMaterial.glsl.js

@@ -1,5 +1,5 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{normalize as e}from"../core/libs/gl-matrix-2/math/vec3.js";import{ScreenSizeScaling as o}from"../views/3d/webgl-engine/core/shaderLibrary/ScreenSizeScaling.glsl.js";import{SliceDraw as r}from"../views/3d/webgl-engine/core/shaderLibrary/Slice.glsl.js";import{Transform as i}from"../views/3d/webgl-engine/core/shaderLibrary/Transform.glsl.js";import{ObjectAndLayerIdColor as l}from"../views/3d/webgl-engine/core/shaderLibrary/attributes/ObjectAndLayerIdColor.glsl.js";import{VertexColor as a}from"../views/3d/webgl-engine/core/shaderLibrary/attributes/VertexColor.glsl.js";import{VisualVariables as s}from"../views/3d/webgl-engine/core/shaderLibrary/shading/VisualVariables.glsl.js";import{viewNormal as d}from"../views/3d/webgl-engine/core/shaderLibrary/util/cameraUniforms.js";import{ColorConversion as n}from"../views/3d/webgl-engine/core/shaderLibrary/util/ColorConversion.glsl.js";import{addProjViewLocalOrigin as t}from"../views/3d/webgl-engine/core/shaderLibrary/util/View.glsl.js";import{Float4PassUniform as c}from"../views/3d/webgl-engine/core/shaderModules/Float4PassUniform.js";import{glsl as g,If as v}from"../views/3d/webgl-engine/core/shaderModules/glsl.js";import{outputColorHighlightOLID as m}from"../views/3d/webgl-engine/shaders/OutputColorHighlightOLID.glsl.js";import{ShaderBuilder as b}from"../views/webgl/ShaderBuilder.js";function u(u){const p=new b,{vertex:f,fragment:w,attributes:h,varyings:C}=p,{hasVVColor:j,hasVertexColors:y,screenSizeEnabled:S,shadingEnabled:L}=u;return h.add("position","vec3"),f.inputs.add("position",()=>"position"),t(f,u),p.include(i),p.include(o,u),p.include(a,u),p.include(s,u),p.include(l,u),w.include(r,u),p.include(m,u),j&&h.add("colorFeatureAttribute","float"),S&&h.add("offset","vec3"),y||C.add("vColor","vec4"),L&&(h.add("normal","vec3"),C.add("vViewNormal","vec3"),C.add("vShadedColor","vec4"),f.uniforms.add(d),f.constants.add("shadingTint","vec4",[0,0,0,.25]),w.constants.add("shadingDirection","vec3",e([.5,-.5,-.5])),f.code.add(g`vec4 blendColor(vec4 source, vec4 dest) {
+import{normalize as e}from"../core/libs/gl-matrix-2/math/vec3.js";import{ScreenSizeScaling as o}from"../views/3d/webgl-engine/core/shaderLibrary/ScreenSizeScaling.glsl.js";import{sliceDraw as r}from"../views/3d/webgl-engine/core/shaderLibrary/Slice.glsl.js";import{Transform as i}from"../views/3d/webgl-engine/core/shaderLibrary/Transform.glsl.js";import{ObjectAndLayerIdColor as l}from"../views/3d/webgl-engine/core/shaderLibrary/attributes/ObjectAndLayerIdColor.glsl.js";import{VertexColor as a}from"../views/3d/webgl-engine/core/shaderLibrary/attributes/VertexColor.glsl.js";import{VisualVariables as s}from"../views/3d/webgl-engine/core/shaderLibrary/shading/VisualVariables.glsl.js";import{viewNormal as d}from"../views/3d/webgl-engine/core/shaderLibrary/util/cameraUniforms.js";import{ColorConversion as n}from"../views/3d/webgl-engine/core/shaderLibrary/util/ColorConversion.glsl.js";import{addProjViewLocalOrigin as t}from"../views/3d/webgl-engine/core/shaderLibrary/util/View.glsl.js";import{Float4PassUniform as c}from"../views/3d/webgl-engine/core/shaderModules/Float4PassUniform.js";import{glsl as g,If as v}from"../views/3d/webgl-engine/core/shaderModules/glsl.js";import{outputColorHighlightOLID as m}from"../views/3d/webgl-engine/shaders/OutputColorHighlightOLID.glsl.js";import{ShaderBuilder as b}from"../views/webgl/ShaderBuilder.js";function u(u){const p=new b,{vertex:f,fragment:w,attributes:h,varyings:C}=p,{hasVVColor:j,hasVertexColors:y,screenSizeEnabled:S,shadingEnabled:L}=u;return h.add("position","vec3"),f.inputs.add("position",()=>"position"),t(f,u),p.include(i),p.include(o,u),p.include(a,u),p.include(s,u),p.include(l,u),w.include(r,u),p.include(m,u),j&&h.add("colorFeatureAttribute","float"),S&&h.add("offset","vec3"),y||C.add("vColor","vec4"),L&&(h.add("normal","vec3"),C.add("vViewNormal","vec3"),C.add("vShadedColor","vec4"),f.uniforms.add(d),f.constants.add("shadingTint","vec4",[0,0,0,.25]),w.constants.add("shadingDirection","vec3",e([.5,-.5,-.5])),f.code.add(g`vec4 blendColor(vec4 source, vec4 dest) {
 float blendAlpha = source.a + dest.a * (1.0 - source.a);
 vec3 blendedColor = blendAlpha == 0.0
 ? vec3(0.0)