@conterra/ct-mapapps-typings 4.17.1-next.20240315052740 → 4.17.1-next.20240319050341

package/agssearch/api.d.ts

@@ -65,11 +65,6 @@ interface AGSStoreFactory {
 interface AGSStoreCommonOptions {
     /**  The id of the new store. */
     id: string;
-    /**
-     * Set this value to `true` to use the deprecated old MapServerLayerStore implementation
-     * instead of the new LayerStore.
-     */
-    legacyImplementation?: boolean;
 }
 /**
  * Specifies an AGSStore constructed from a layer or sublayer id.
@@ -92,7 +87,6 @@ interface AGSStoreFromURLOptions extends AGSStoreCommonOptions {
     type?: "feature" | "geojson" | "csv" | "wfs";
     /**
      * An API key (or token) required to access the service.
-     * This parameter is not supported when `legacyImplementation` is true.
      *
      * See also https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#apiKey
      */
@@ -120,7 +114,7 @@ interface AGSStore extends AsyncStore {
     /**
      * The layer used by this store.
      */
-    layer?: Layer | Sublayer | undefined;
+    layer: Layer | Sublayer;
 }
 
 export type { AGSStore, AGSStoreCommonOptions, AGSStoreFactory, AGSStoreFromLayerOptions, AGSStoreFromURLOptions };

package/ct/util/css.d.ts

@@ -1,6 +1,185 @@
-import { ExtendedPromise } from '../__internal__/fs6eANFo.js';
 import * as apprt_core_load_css from 'apprt-core/load-css';
 
+/**
+ * The methods of this interface are available when a Promise
+ * has been augmented using the `trackState` function.
+ */
+interface StateQueryable {
+    /** Returns true if the promise is settled, i.e. if it is no longer pending. */
+    isSettled(): boolean;
+    /** Returns true if the promise is fulfilled, i.e. if it has a success value. */
+    isFulfilled(): boolean;
+    /** Returns true if the promise is rejected, i.e. if it contains an error. */
+    isRejected(): boolean;
+    /** Returns true if the promise was cancelled before it was able to complete. */
+    isCancelled(): boolean;
+}
+type State = "pending" | "fulfilled" | "rejected" | "cancelled";
+declare const PROMISE: unique symbol;
+declare const STATE: unique symbol;
+declare const PRIVATE_CONSTUCTOR_TAG: unique symbol;
+/**
+ * Wrapper of global.Promise class.
+ * Read more about [Promises](./PROMISES.md).
+ *
+ * @see https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Promise
+ */
+declare class ExtendedPromise<T> implements Promise<T> {
+    private [PROMISE];
+    private [STATE]?;
+    /**
+     * Creates Promise instances.
+     * @param executor defined as (resolve,reject)=> \{\}
+     * @example
+     * ```js
+     * new Promise((resolve,reject)=>{
+     *      ...
+     * });
+     * ```
+     */
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
+    /**
+     * Internal constructor. Do not call.
+     */
+    constructor(promise: PromiseLike<T> | LegacyDojoDeferred, state: State | undefined, tag: typeof PRIVATE_CONSTUCTOR_TAG);
+    /** Creates a new resolved promise */
+    static resolve(): ExtendedPromise<void>;
+    /**
+     * Creates a new resolved promise with the given value
+     * @param value result object.
+     * @returns a promise in fulfilled state.
+     */
+    static resolve<T>(value: T): ExtendedPromise<T>;
+    /**
+     * @param reason The reason the promise was rejected.
+     * @returns a promise in rejected state.
+     */
+    static reject<T = never>(reason?: any): ExtendedPromise<T>;
+    /**
+     * Creates promise which fulfills if all other promises are fulfilled.
+     * Or rejects if one of the promises rejects.
+     *
+     * @param iterable Iterable of Promise instances
+     */
+    static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
+    /**
+     * Creates promise which fulfills if one of the other promises fulfills.
+     * Or rejects if one of the promises rejects.
+     *
+     * @param iterable Iterable of Promise instances
+     */
+    static race<T>(iterable: Iterable<T>): ExtendedPromise<T extends PromiseLike<infer U> ? U : T>;
+    /**
+     * Creates promise which fulfills if one of the other promises fulfills.
+     * Or rejects if one of the promises rejects.
+     *
+     * @param iterable Iterable of Promise instances
+     */
+    static race<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
+    /**
+     * Creates a promise that resolves after all of the given promises have either fulfilled or rejected,
+     * with an array of objects that each describes the outcome of each promise.
+     *
+     * @param iterable Iterable of Promise instances
+     */
+    static allSettled<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<PromiseSettledResult<Awaited<T>>[]>;
+    /**
+     * Promise.any() takes an iterable of Promise objects and, as soon as one of the promises in the iterable fulfills,
+     * returns a single promise that resolves with the value from that promise.
+     * If no promises in the iterable fulfill (if all of the given promises are rejected),
+     * then the returned promise is rejected with an AggregateError,
+     * Essentially, this method is the opposite of Promise.all().
+     *
+     * @param iterable Iterable of Promise instances
+     */
+    static any<T>(iterable: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
+    /**
+     * Produces an object with a promise along with its resolution and rejection functions.
+     * Allows to resolve/reject the promise manually after creating it.
+     *
+     * @example
+     * ```js
+     * const { promise, resolve, reject } = Promise.withResolvers();
+     * ```
+     * @returns {{ promise, resolve, reject }}
+     */
+    static withResolvers<T>(): {
+        resolve: (value: T | PromiseLike<T>) => void;
+        reject: (reason?: unknown) => void;
+        promise: ExtendedPromise<T>;
+    };
+    /**
+     * This method tests if a given object is a promise.
+     * The algorithm will return true for:
+     *  * apprt-core/Promise
+     *  * global Promise
+     *  * dojo/Deferred
+     *  * dojo/Deferred.promise
+     *
+     * Note: Because of support for dojo/Deferred any object with a
+     * 'then', 'isResolved' and 'isRejected' method is detected as a promise.
+     *
+     * @param candidate a potential promise.
+     * @returns true if candidate is a promise.
+     */
+    static isPromise(candidate: any): candidate is PromiseLike<unknown>;
+    /**
+     * Wraps e.g. dojo/Deferred or native Promise to this Promise class.
+     * @returns a promise
+     */
+    static wrap<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T>;
+    /**
+     * Augments the given Promise with new state lookup functions.
+     */
+    static trackState<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T> & StateQueryable;
+    /**
+     * Registers success and/or error handlers.
+     * @param success called when the promise resolves
+     * @param failure called when the promise rejects
+     */
+    then<TResult1 = T, TResult2 = never>(success?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, failure?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): ExtendedPromise<TResult1 | TResult2>;
+    /**
+     * Registers an error handler.
+     * @param failure called when the promise rejects
+     */
+    catch<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
+    /**
+     * Registers an error handler. Which is not called if the error is a Cancel instance.
+     * @param failure called when the promise rejects
+     */
+    else<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
+    /**
+     * Registers a handler, which is called in success or error state.
+     * But the handler is not able to change the result state!
+     * @param handler function invoked regardless of success or error
+     */
+    finally(handler?: (() => void) | undefined | null): ExtendedPromise<T>;
+    /**
+     * @returns this instance, augmented with augmented with:
+     *
+     * *    isFulfilled()
+     * *    isRejected()
+     * *    isCancelled()
+     * *    isSettled()
+     */
+    trackState(): ExtendedPromise<T> & StateQueryable;
+    get [Symbol.toStringTag](): string;
+}
+
+interface LegacyDojoDeferred {
+    promise: any;
+    isResolved(): boolean;
+    isRejected(): boolean;
+    isFulfilled(): boolean;
+    isCanceled(): boolean;
+    progress(update: any, strict?: boolean): any;
+    resolve(value?: any, strict?: boolean): any;
+    reject(error?: any, strict?: boolean): any;
+    then(callback?: any, errback?: any, progback?: any): any;
+    cancel(reason?: any, strict?: boolean): any;
+    toString(): string;
+}
+
 /**
  * The executor argument for new cancelable promises.
  *

package/editing/api.d.ts

@@ -11,6 +11,10 @@ type WellKnownWorkflow = NonNullable<__esri.EditorProperties["allowedWorkflows"]
  * Properties used to create an {@link Editor}.
  */
 type EditorProperties = Omit<__esri.EditorProperties, "allowedWorkflows"> & {
+    /**
+     * @deprecated since ArcGIS Maps SDK for JavaScript 4.29
+     * use {@link __esri.EditorProperties.visibleElements} instead;
+     */
     allowedWorkflows?: WellKnownWorkflow[];
 };
 /**

package/package.json

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

package/ct/__internal__/fs6eANFo.d.ts

@@ -1,181 +0,0 @@
-/**
- * The methods of this interface are available when a Promise
- * has been augmented using the `trackState` function.
- */
-interface StateQueryable {
-    /** Returns true if the promise is settled, i.e. if it is no longer pending. */
-    isSettled(): boolean;
-    /** Returns true if the promise is fulfilled, i.e. if it has a success value. */
-    isFulfilled(): boolean;
-    /** Returns true if the promise is rejected, i.e. if it contains an error. */
-    isRejected(): boolean;
-    /** Returns true if the promise was cancelled before it was able to complete. */
-    isCancelled(): boolean;
-}
-type State = "pending" | "fulfilled" | "rejected" | "cancelled";
-declare const PROMISE: unique symbol;
-declare const STATE: unique symbol;
-declare const PRIVATE_CONSTUCTOR_TAG: unique symbol;
-/**
- * Wrapper of global.Promise class.
- * Read more about [Promises](./PROMISES.md).
- *
- * @see https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Promise
- */
-declare class ExtendedPromise<T> implements Promise<T> {
-    private [PROMISE];
-    private [STATE]?;
-    /**
-     * Creates Promise instances.
-     * @param executor defined as (resolve,reject)=> \{\}
-     * @example
-     * ```js
-     * new Promise((resolve,reject)=>{
-     *      ...
-     * });
-     * ```
-     */
-    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
-    /**
-     * Internal constructor. Do not call.
-     */
-    constructor(promise: PromiseLike<T> | LegacyDojoDeferred, state: State | undefined, tag: typeof PRIVATE_CONSTUCTOR_TAG);
-    /** Creates a new resolved promise */
-    static resolve(): ExtendedPromise<void>;
-    /**
-     * Creates a new resolved promise with the given value
-     * @param value result object.
-     * @returns a promise in fulfilled state.
-     */
-    static resolve<T>(value: T): ExtendedPromise<T>;
-    /**
-     * @param reason The reason the promise was rejected.
-     * @returns a promise in rejected state.
-     */
-    static reject<T = never>(reason?: any): ExtendedPromise<T>;
-    /**
-     * Creates promise which fulfills if all other promises are fulfilled.
-     * Or rejects if one of the promises rejects.
-     *
-     * @param iterable Iterable of Promise instances
-     */
-    static all<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T[]>;
-    /**
-     * Creates promise which fulfills if one of the other promises fulfills.
-     * Or rejects if one of the promises rejects.
-     *
-     * @param iterable Iterable of Promise instances
-     */
-    static race<T>(iterable: Iterable<T>): ExtendedPromise<T extends PromiseLike<infer U> ? U : T>;
-    /**
-     * Creates promise which fulfills if one of the other promises fulfills.
-     * Or rejects if one of the promises rejects.
-     *
-     * @param iterable Iterable of Promise instances
-     */
-    static race<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
-    /**
-     * Creates a promise that resolves after all of the given promises have either fulfilled or rejected,
-     * with an array of objects that each describes the outcome of each promise.
-     *
-     * @param iterable Iterable of Promise instances
-     */
-    static allSettled<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<PromiseSettledResult<Awaited<T>>[]>;
-    /**
-     * Promise.any() takes an iterable of Promise objects and, as soon as one of the promises in the iterable fulfills,
-     * returns a single promise that resolves with the value from that promise.
-     * If no promises in the iterable fulfill (if all of the given promises are rejected),
-     * then the returned promise is rejected with an AggregateError,
-     * Essentially, this method is the opposite of Promise.all().
-     *
-     * @param iterable Iterable of Promise instances
-     */
-    static any<T>(iterable: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
-    /**
-     * Produces an object with a promise along with its resolution and rejection functions.
-     * Allows to resolve/reject the promise manually after creating it.
-     *
-     * @example
-     * ```js
-     * const { promise, resolve, reject } = Promise.withResolvers();
-     * ```
-     * @returns {{ promise, resolve, reject }}
-     */
-    static withResolvers<T>(): {
-        resolve: (value: T | PromiseLike<T>) => void;
-        reject: (reason?: unknown) => void;
-        promise: ExtendedPromise<T>;
-    };
-    /**
-     * This method tests if a given object is a promise.
-     * The algorithm will return true for:
-     *  * apprt-core/Promise
-     *  * global Promise
-     *  * dojo/Deferred
-     *  * dojo/Deferred.promise
-     *
-     * Note: Because of support for dojo/Deferred any object with a
-     * 'then', 'isResolved' and 'isRejected' method is detected as a promise.
-     *
-     * @param candidate a potential promise.
-     * @returns true if candidate is a promise.
-     */
-    static isPromise(candidate: any): candidate is PromiseLike<unknown>;
-    /**
-     * Wraps e.g. dojo/Deferred or native Promise to this Promise class.
-     * @returns a promise
-     */
-    static wrap<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T>;
-    /**
-     * Augments the given Promise with new state lookup functions.
-     */
-    static trackState<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T> & StateQueryable;
-    /**
-     * Registers success and/or error handlers.
-     * @param success called when the promise resolves
-     * @param failure called when the promise rejects
-     */
-    then<TResult1 = T, TResult2 = never>(success?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, failure?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): ExtendedPromise<TResult1 | TResult2>;
-    /**
-     * Registers an error handler.
-     * @param failure called when the promise rejects
-     */
-    catch<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
-    /**
-     * Registers an error handler. Which is not called if the error is a Cancel instance.
-     * @param failure called when the promise rejects
-     */
-    else<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
-    /**
-     * Registers a handler, which is called in success or error state.
-     * But the handler is not able to change the result state!
-     * @param handler function invoked regardless of success or error
-     */
-    finally(handler?: (() => void) | undefined | null): ExtendedPromise<T>;
-    /**
-     * @returns this instance, augmented with augmented with:
-     *
-     * *    isFulfilled()
-     * *    isRejected()
-     * *    isCancelled()
-     * *    isSettled()
-     */
-    trackState(): ExtendedPromise<T> & StateQueryable;
-    get [Symbol.toStringTag](): string;
-}
-
-interface LegacyDojoDeferred {
-    promise: any;
-    isResolved(): boolean;
-    isRejected(): boolean;
-    isFulfilled(): boolean;
-    isCanceled(): boolean;
-    progress(update: any, strict?: boolean): any;
-    resolve(value?: any, strict?: boolean): any;
-    reject(error?: any, strict?: boolean): any;
-    then(callback?: any, errback?: any, progback?: any): any;
-    cancel(reason?: any, strict?: boolean): any;
-    toString(): string;
-}
-
-export { ExtendedPromise };

package/ct/mapping/store/MapServerLayerStore.d.ts

@@ -1,90 +0,0 @@
-/// <reference types="arcgis-js-api" />
-import { ExtendedPromise } from '../../__internal__/fs6eANFo.js';
-import Query from 'esri/rest/support/Query';
-
-/** @lends ct.mapping.store.MapServerLayerStore.prototype*/
-declare class MapServerLayerStore {
-    /**
-     * This store provides the dojo.store interface implemented over the MapServerQueryStore interface.
-     * @constructs
-     */
-    constructor(options: any);
-    /**
-     * The target url pointing to the query layer, e.g.:
-     * http://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer/9
-     */
-    target: any;
-    /**
-     * Sets the property to use as the identity property, if it's not possible to determine the identity property
-     * from the service metadata automatically. It does not overwrite the identity property from the service
-     * metadata.
-     */
-    idProperty: string;
-    definitionExpression: string;
-    /**
-     * This flag enables the support for server-side pagination.
-     * It also requires support by from the server (metadata.advancedQueryCapabilities.supportsPagination)
-     */
-    enablePagination: boolean;
-    /**
-     * This flag enables an optimization to use objectIds queries instead of where=OBJECTID in [...] sql queries.
-     * But MapServers based on DB-Views do not support this. That is the reason why it is disabled by default.
-     */
-    enableObjectIdsQueries: boolean;
-    /**
-     * How many records can be requested.
-     */
-    maxRecordCount: number;
-    /**
-     * How many records are requested by default.
-     */
-    defaultRecordCount: number;
-    suggestContains: boolean;
-    fetchIdPropertyFromMetadata(): ExtendedPromise<string>;
-    /**
-     * Retrieves an object by its identity.
-     * @param {String|Number} id The identity to use to lookup the object
-     * @param {Object} options options to manipulate the request.
-     * @returns {Object} The object in the store that matches the given id.
-     */
-    get(id: string | number, options: Object): Object;
-    /**
-     * Returns an object's identity
-     */
-    getIdentity(object: any): any;
-    _isIdQuery({ fields }: {
-        fields?: {} | undefined;
-    }): any;
-    query(query: any, options: any): any;
-    _isInRecordCountBounds({ count, start }: {
-        count: any;
-        start: any;
-    }): boolean;
-    _queryAfterFetchingMetadata(taskQuery: any, options: any): ExtendedPromise<ExtendedPromise<any>>;
-    _queryWithoutPagination(taskQuery: any, options: any, supportsOrderBy: any): ExtendedPromise<any>;
-    _queryWithServerSideSupportedPagination(taskQuery: any, options: any, supportsOrderBy: any): ExtendedPromise<any[] | ExtendedPromise<any>>;
-    _executeQuery(queryFunc: any, taskQuery: any, signal: any, callback: any): ExtendedPromise<any>;
-    _idSortingNotPossible: boolean | undefined;
-    _featuresToItems(outSRS: any, features: any): any;
-    getMetadata(): any;
-    _metadataReq: any;
-    _metadata: any;
-    _parseMetaData(metadata: any): any;
-    _toTaskQuery(query: any, options: any): Query;
-    _convertToSort(sort: any): any;
-    /**
-     * Converts { fieldname : 1, fieldname2:1 } to [fieldname,fieldname2].
-     * It also ensures that the idProperty (OBJECTID) is always requested.
-     * The support for {fieldname : 0) is only implemented for "geometry".
-     */
-    _convertToOutFields(fields: any): string[];
-    _convertQuery(taskQuery: any, query: any, options: any): void;
-    _convertToWhere(taskQuery: any, walker: any): void;
-    _getAllFeaturesQuery(): string;
-    _convertToSpatialQuery(taskQuery: any, walker: any): void;
-    _checkSpatialOperatorOnNodeAndChildren(taskQuery: any, walker: any): boolean;
-    _checkSpatialOperator(taskQuery: any, walker: any): boolean;
-    _isSupportedSpatialRel(relation: any): boolean;
-}
-
-export { MapServerLayerStore as default };