@conterra/ct-mapapps-typings 4.13.2-next.20220704040728 → 4.13.2-next.20220712041527

package/README.md

@@ -8,7 +8,7 @@ Type definitions for ct-mapapps
 npm install --save-dev @conterra/ct-mapapps-typings
 ```
 
-## Use in TypeScript module
+### Use in TypeScript module
 
 `tsconfig.json`
 
@@ -22,7 +22,8 @@ npm install --save-dev @conterra/ct-mapapps-typings
     }
 }
 ```
-## Use in JavaScript module
+
+### Use in JavaScript module
 
 `tsconfig.json`
 
@@ -37,4 +38,23 @@ npm install --save-dev @conterra/ct-mapapps-typings
         "noEmit": true
     }
 }
-```
+```
+
+## Additional recommended typings
+
+We also recommend to install the declaration files for the ArcGIS JavaScript API and the Dojo Toolkit:
+
+```sh
+$ npm install @types/arcgis-js-api
+$ npm install dojo-typings --save-dev
+```
+
+```json
+// tsconfig.json
+{
+    "include": [
+        // ...
+        "node_modules/dojo-typings/index.d.ts"
+    ]
+}
+```

package/agolauthn/SyncAuthnState.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/agssearch/FilterStoreFactory.d.ts

@@ -3,12 +3,7 @@ export function FilterStoreFactory(): {
     _initStore(): any;
     _logError(id: any, error: any): any;
     _observeLayer(layerId: any): void;
-    _buildLayerObserver(mapWidgetModel: any, path: any): {
-        map: any;
-        layers: any;
-        start(skipInitial: any): void;
-        stop(skipCleanup: any): void;
-    };
+    _buildLayerObserver(mapWidgetModel: any, path: any): import("map-widget/LayerObserver").LayerObserver;
     _trackLayerChange(path: any, layer: any, removed: any): void;
     _trackSublayerChange(layer: any, subLayerId: any): void;
     _trackVisibilityChanges(layerOrSublayer: any): void;

package/app-portal-registration/PortalItemColumnExtender.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appautorefresh/Refresher.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/ProductInfoService.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/VersionReplacerService.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/VersionReplacerToolClickHandler.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/ConfirmationPaneFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/DataFormPaneFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/ProductsPaneFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/ReportWidget.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/VersionLoadPaneFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/VersionPaneFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appbundlemanagement/wizard/VersionReplacerView.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppBundlesController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppColumnExtender.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppDetailsController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppDetailsWidgetFactory.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppFilesController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/AppViewToolRuleProcessor.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/CreateAppController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/CreateTemplateController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/CustomActions.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/appmanagement/TemplateDetailsController.d.ts

@@ -1,2 +1,2 @@
-declare var _default: any;
+declare const _default: any;
 export default _default;

package/apprt/semver.d.ts

@@ -1,13 +1,55 @@
 export default semver;
-declare function semver(...args: any[]): any;
+declare function semver(...args: any[]): {
+    major: any;
+    minor: any;
+    patch: any;
+    hotfix: any;
+    prerelease: any;
+    isPrerelease: any;
+    build: any;
+    toString: typeof buildVersionString;
+    compare: typeof selfCompare;
+    equals: typeof selfEquals;
+    stripBuild: typeof stripBuild;
+    stripPreRelease: typeof self;
+    lowestPreRelease: typeof self;
+};
 declare namespace semver {
     export { parse };
     export { create };
     export { compare };
     export { equals };
 }
-declare function parse(versionString: any, ignoreBuild: any): any;
-declare function create(major: any, minor: any, patch: any, hotfix: any, prerelease: any, build: any): any;
+declare function parse(versionString: any, ignoreBuild: any): {
+    major: any;
+    minor: any;
+    patch: any;
+    hotfix: any;
+    prerelease: any;
+    isPrerelease: any;
+    build: any;
+    toString: typeof buildVersionString;
+    compare: typeof selfCompare;
+    equals: typeof selfEquals;
+    stripBuild: typeof stripBuild;
+    stripPreRelease: typeof self;
+    lowestPreRelease: typeof self;
+};
+declare function create(major: any, minor: any, patch: any, hotfix: any, prerelease: any, build: any): {
+    major: any;
+    minor: any;
+    patch: any;
+    hotfix: any;
+    prerelease: any;
+    isPrerelease: any;
+    build: any;
+    toString: typeof buildVersionString;
+    compare: typeof selfCompare;
+    equals: typeof selfEquals;
+    stripBuild: typeof stripBuild;
+    stripPreRelease: typeof self;
+    lowestPreRelease: typeof self;
+};
 /**
  * Compares two semantic versions
  */

package/apprt-binding/Bindable.d.ts

@@ -1,3 +1,4 @@
+import { PropertyName } from "./Binding";
 /**
  * Return type of the {@link Bindable} watch function, used to unregister a watch.
  */
@@ -22,7 +23,7 @@ export interface BindableInterface {
      * @param propName the name of the property
      * @param value the new value of the property
      */
-    set?(propName: string, value: any): void;
+    set?(propName: PropertyName, value: any): void;
     /**
      * Returns the value of the property `propName`. This function will be called,
      * for example, when the Binding is notified about an update (via watch).
@@ -30,7 +31,7 @@ export interface BindableInterface {
      * @param propName the name of the property
      * @returns the current value of the property
      */
-    get?(propName: string): any;
+    get?(propName: PropertyName): any;
     /**
      * Registers a watch callback for the property `propName` on this Bindable.
      *
@@ -42,7 +43,7 @@ export interface BindableInterface {
      * @param callback a callback function that takes no arguments
      * @returns an object implementing {@link WatchHandle} that allows the Binding to unregister the watch.
      */
-    watch?(propName: string, callback: WatchCallback): WatchHandle;
+    watch?(propName: PropertyName, callback: WatchCallback): WatchHandle;
 }
 /**
  * All methods on the bindable interface are optional, you can also use plain objects.

package/apprt-binding/Binding.d.ts

@@ -29,13 +29,13 @@ export interface Context {
     /** The target bindable. */
     readonly target: Bindable;
     /** The property name on the source side (for single source property). */
-    readonly sourceName: string;
+    readonly sourceName: PropertyName;
     /** The property names on the source side (for multiple source properties). */
-    readonly sourceNames: readonly string[];
+    readonly sourceNames: readonly PropertyName[];
     /** The property name on the target side (for single source property). */
-    readonly targetName: string;
+    readonly targetName: PropertyName;
     /** The property names on the target side (for multiple source properties). */
-    readonly targetNames: readonly string[];
+    readonly targetNames: readonly PropertyName[];
     /** The old property value. Provided if single source property. */
     oldValue(): any;
     /** The new property value. Provided if single source property. */
@@ -57,6 +57,7 @@ export interface Context {
      */
     promiseValue<T>(candidate: PromiseLike<T>): any;
 }
+export declare type PropertyName = string | symbol;
 /**
  * Class for two way binding between bindables.
  */
@@ -104,8 +105,8 @@ export interface Binding {
      * Binding.for(esriAccessor, vueComponent).sync('textField', 'numberField', Number, String);
      * ```
      */
-    sync(leftProperty: string | string[], rightProperty: string | string[], convertLeftToRight?: ConvertFunction, convertRightToLeft?: ConvertFunction): this;
-    sync(leftProperty: string | string[], convertLeftToRight?: ConvertFunction, convertRightToLeft?: ConvertFunction): this;
+    sync(leftProperty: PropertyName | PropertyName[], rightProperty: PropertyName | PropertyName[], convertLeftToRight?: ConvertFunction, convertRightToLeft?: ConvertFunction): this;
+    sync(leftProperty: PropertyName | PropertyName[], convertLeftToRight?: ConvertFunction, convertRightToLeft?: ConvertFunction): this;
     /**
      * Define properties to be synchronized and converted from left bindable to right bindable
      *
@@ -130,8 +131,8 @@ export interface Binding {
      * Binding.for(esriAccessor, vueComponent).syncToLeft('numberField', 'textField', String);
      * ```
      */
-    syncToLeft(leftProperty: string | string[], rightProperty: string | string[], convertValue?: ConvertFunction): this;
-    syncToLeft(leftProperty: string | string[], convertValue?: ConvertFunction): this;
+    syncToLeft(leftProperty: PropertyName | PropertyName[], rightProperty: PropertyName | PropertyName[], convertValue?: ConvertFunction): this;
+    syncToLeft(leftProperty: PropertyName | PropertyName[], convertValue?: ConvertFunction): this;
     /**
      * Define properties to be synchronized between two bindables.
      *
@@ -150,8 +151,8 @@ export interface Binding {
      * });
      * ```
      */
-    syncAll(properties: Record<string, string>): this;
-    syncAll(...properties: (string | ConvertFunction | undefined)[]): this;
+    syncAll(properties: Record<PropertyName, PropertyName>): this;
+    syncAll(...properties: (PropertyName | ConvertFunction | undefined)[]): this;
     /**
      * Define properties to be synchronized between from left to right bindables.
      *
@@ -169,8 +170,8 @@ export interface Binding {
      * });
      * ```
      */
-    syncAllToRight(properties: Record<string, string>): this;
-    syncAllToRight(...properties: (string | ConvertFunction | undefined)[]): this;
+    syncAllToRight(properties: Record<PropertyName, PropertyName>): this;
+    syncAllToRight(...properties: (PropertyName | ConvertFunction | undefined)[]): this;
     /**
      * Define properties to be synchronized between from left to right bindables.
      *
@@ -188,8 +189,8 @@ export interface Binding {
      * });
      * ```
      */
-    syncAllToLeft(properties: Record<string, string>): this;
-    syncAllToLeft(...properties: (string | ConvertFunction | undefined)[]): this;
+    syncAllToLeft(properties: Record<PropertyName, PropertyName>): this;
+    syncAllToLeft(...properties: (PropertyName | ConvertFunction | undefined)[]): this;
     /**
      * Trigger the synchronization of the properties of left to their pedants on right.
      */
@@ -252,9 +253,9 @@ declare const IGNORE: unique symbol;
  *
  * @example
  * ```
- * import BindingFactory, { Binding } from "apprt-binding/Binding";
- * const binding = BindingFactory.for(left, right);
+ * import { Binding } from "apprt-binding/Binding";
+ * const binding = Binding.for(left, right);
  * ```
  */
-declare const factory: Factory;
-export default factory;
+export declare const Binding: Factory;
+export default Binding;

package/apprt-binding/PropertyAccess.d.ts

@@ -1,4 +1,5 @@
 import { Bindable, WatchHandle } from "./Bindable";
+import { PropertyName } from "./Binding";
 declare const ACCESS_IN_INSTANCE_KEY: unique symbol;
 declare const _state: unique symbol;
 declare const _instance: unique symbol;
@@ -8,7 +9,7 @@ export declare type PropertyAccessInstance = Bindable & {
 };
 export declare type GroupId = number | string;
 export interface WatchState {
-    name: string;
+    name: PropertyName;
     value: any;
     version: number;
 }
@@ -21,17 +22,17 @@ export declare class PropertyAccess {
     static for(instance: PropertyAccessInstance, create: true): PropertyAccess;
     static for(instance: PropertyAccessInstance, create: boolean): PropertyAccess | undefined;
     get destroyed(): boolean;
-    get(propertyName: string): any;
-    getVersionOf(propertyName: string): number;
-    isVersionOf(propertyName: string, versionNumber: number): boolean;
-    set(propertyName: string, value: any): boolean | undefined;
-    setIfVersionMatch(propertyName: string, version: number, value: any): boolean | undefined;
-    getTrackedProperties(groupId?: GroupId): string[];
+    get(propertyName: PropertyName): any;
+    getVersionOf(propertyName: PropertyName): number;
+    isVersionOf(propertyName: PropertyName, versionNumber: number): boolean;
+    set(propertyName: PropertyName, value: any): boolean | undefined;
+    setIfVersionMatch(propertyName: PropertyName, version: number, value: any): boolean | undefined;
+    getTrackedProperties(groupId?: GroupId): PropertyName[];
     hasTrackedProperties(): boolean;
-    track(propertyName: string, groupId?: GroupId): void;
+    track(propertyName: PropertyName, groupId?: GroupId): void;
     untrackGroup(groupId?: GroupId): void;
-    untrack(propertyName: string, groupId?: GroupId): void;
-    watch(propertyName: string, watchListener: WatchListener): WatchHandle;
+    untrack(propertyName: PropertyName, groupId?: GroupId): void;
+    watch(propertyName: PropertyName, watchListener: WatchListener): WatchHandle;
     destroy(): void;
 }
 declare type WatchListener = (state: WatchState, ...args: any[]) => void;

package/apprt-binding/Watchable.d.ts

@@ -1,4 +1,5 @@
 import { Bindable, BindableInterface, WatchHandle } from "./Bindable";
+import { PropertyName } from "./Binding";
 export interface WatchEvent {
     name: string;
 }
@@ -17,7 +18,7 @@ export interface Watchable extends Required<BindableInterface> {
      * Enhances the definition of watch in Bindable: the property name is passed in the event.
      * This is currently an implementation detail and not required by the Bindable interface.
      */
-    watch(propName: string, callback: InternalWatchCallback): WatchHandle;
+    watch(propName: PropertyName, callback: InternalWatchCallback): WatchHandle;
     /**
      * Destroys the Watchable and returns the original bindable, if any.
      */

package/apprt-core/Logger.d.ts

@@ -195,9 +195,12 @@ export declare function getLogLevel(name: string): LogLevel;
 /**
  * Sets the logging configuration state.
  * Note that this function resets any existing configuration state.
+ *
  * @param config the new configuration. If empty or undefined, the configuration is cleared.
+ *               It can be string with the syntax `bundle:LEVEL,otherbundle:LEVEL`,
+ *               e.g. `apprt-core:DEBUG, map-init:WARN`
  */
-export declare function setLogConfig(config?: [string, LogLevel][]): void;
+export declare function setLogConfig(config?: [string, LogLevel][] | string): void;
 /**
  * Gets the current logging configuration state.
  * @returns Array like: [["", "DEBUG"] , ["apprt-core", "INFO"], ...];
@@ -236,3 +239,12 @@ export interface Writer {
  * @param newWriter the new Writer. If undefined, the console is used.
  */
 export declare function setWriter(newWriter?: Writer): void;
+/**
+ * Parses a configuration string into a logging configuration.
+ * @param loggingConfStr a string in the format `logger-name:LEVEL, other-logger-name: LEVEL`.
+ *                       e.g. `apprt-core:DEBUG, map-init:WARN`
+ *                       or   `DEBUG` for the root level.
+ *                       or   `apprt-core` to set it to DEBUG.
+ * @returns the parsed logging configuration.
+ */
+export declare function readConfigFromString(loggingConfStr?: string): [string, LogLevel][];

package/apprt-core/Mutable.d.ts

@@ -3,18 +3,17 @@ interface MembersTag<Members> {
     [_mutableMembers]: Members;
 }
 declare type PropertyKey = string | symbol;
-declare type Constructor<T> = new (...args: any[]) => T;
 declare type SimpleValueSpec = null | undefined | boolean | number | PropertyKey | bigint | any[];
 interface ComplexValueSpec<T> {
     value?: T;
-    type?: Constructor<T> | PropType<T>;
+    type?: PropType<T>;
     required?: boolean;
     writable?: boolean;
     depends?: PropertyKey[];
     init?(): T;
     get?(): T;
     set?(value: T): void;
-    cast?(value: T): T;
+    cast?(value: unknown): T;
     clone?(value: T): T;
 }
 declare type ValueSpec = SimpleValueSpec | ComplexValueSpec<any>;
@@ -34,7 +33,7 @@ export declare type MutableDefinition<T> = {
 };
 declare type IsEmptyObject<T> = T extends {} ? ({} extends T ? true : false) : false;
 declare type ResolveSpecType<Spec> = Spec extends {
-    type: PropType<infer T> | Constructor<infer T>;
+    type: PropType<infer T>;
 } ? T : Spec extends {
     value: infer V;
 } ? V : Spec extends ComplexValueSpec<infer V> ? V : never;
@@ -97,7 +96,7 @@ interface MutableBase<Members> extends MembersTag<Members> {
      * @param callback will be invoked when a property changes.
      * @returns a handle to stop watching
      */
-    watch(property: "*", callback: WatchCallback<PropertyName<this>, Properties<this>[PropertyName<this>]>): WatchHandle;
+    watch(property: "*", callback: WatchCallback<PublicPropertyName<this>, Properties<this>[PublicPropertyName<this>]>): WatchHandle;
 }
 /**
  * Represents the type of mutable instances built from some definition.
@@ -129,7 +128,7 @@ declare type RemoveFunctions<T> = {
 export declare type PropType<T> = {
     (): T;
 } | {
-    new (...args: never[]): T;
+    new (...args: never[]): T & object;
 } | {
     new (...args: string[]): Function;
 };
@@ -141,6 +140,8 @@ export declare type Properties<M extends Mutable<any>> = M extends MembersTag<in
  * This type is a union listing all valid property identifiers for the given mutable.
  */
 export declare type PropertyName<M extends Mutable<any>> = Extract<keyof Properties<M>, PropertyKey>;
+/** Excludes symbol properties from the list of property names (they are not watchable via '*') */
+declare type PublicPropertyName<M extends Mutable<any>> = Exclude<PropertyName<M>, symbol>;
 /**
  * Represents the type of a mutable class created from a definition.
  * Instances of this type are created by calling the `declare()` function.

package/apprt-core/TreeWalker.d.ts

@@ -68,14 +68,14 @@ export interface Visitor<NodeType extends Node> {
      * @param context The walker's context at current node.
      * @returns Indicates how the walker shall proceed, the default is VisitCodes.CONTINUE.
      */
-    getChildren(node: NodeType, context: Context<NodeType>): NodeType[] | void | undefined;
+    getChildren(node: NodeType, context: Context<NodeType>): NodeType[] | Iterable<NodeType> | void | undefined;
 }
 /** Base type of tree nodes. */
 export interface Node {
     /** Optional array of child nodes. */
     children?: Node[];
     /** Optional accessor function for child nodes. */
-    getChildren?(): Node[] | void | undefined;
+    getChildren?(): Node[] | Iterable<Node> | void | undefined;
 }
 /** Current visitor context. */
 export interface Context<NodeType extends Node> {

package/apprt-core/config-dojo.d.ts

@@ -1,7 +1,7 @@
-import { RegisterOptions, ValueOrProvider } from "./config";
+import { RegisterOptions, SupportedValueTypes, ValueOrValueProvider } from "./config";
 import "dojo/_base/sniff";
 interface RegisterFunction<T> {
-    (key: keyof T, valueOrProvider: ValueOrProvider<T>, options?: RegisterOptions): void;
+    (key: keyof T, valueOrProvider: ValueOrValueProvider<keyof T, SupportedValueTypes>, options?: RegisterOptions): void;
 }
 export declare function registerDojoConfigKey<T>(registerFn: RegisterFunction<T>, name: keyof T, path: string, dconfig?: any): void;
 export declare function registerHasKey<T>(registerFn: RegisterFunction<T>, name: keyof T): void;