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

package/agolauthn/AuthenticationPlugin.d.ts

@@ -6,7 +6,7 @@ export default class AGOLAuthenticationPlugin {
     _roleMapping: any;
     _organizationId: any;
     _fetchSelf: any;
-    _oauth: any;
+    _oauth: boolean | undefined;
     /**
      * @returns {Authentication} authentication instance
      */

package/agssearch/LayerStore.d.ts

@@ -10,7 +10,7 @@ export interface LayerStoreMetadata extends Metadata {
     /** Whether the store supports pagination or not. */
     readonly supportsPagination: boolean;
     /** Maximum number of features that can be requested from the server. */
-    readonly maxRecordCount: number;
+    readonly maxRecordCount: number | undefined;
 }
 declare type FeatureLayerProps = "type" | "destroy" | "load" | "loaded" | "url" | "layerId" | "capabilities" | "sourceJSON" | "objectIdField" | "title" | "displayField" | "geometryType" | "fullExtent" | "popupTemplate" | "fields" | "createQuery" | "queryObjectIds" | "queryFeatures" | "queryFeatureCount" | "definitionExpression";
 export declare type SimpleFeatureLayer = Pick<FeatureLayer, FeatureLayerProps>;

package/apprt-core/Logger.d.ts

@@ -112,6 +112,11 @@ export interface Logger {
      * @param args arguments filled into the placeholder or directly logged.
      */
     warn(msg: string, ...args: any[]): void;
+    /**
+     * Convenience method to log an error (without an additional message) as a warning.
+     * @param error the error to log
+     */
+    warn(error: Error): void;
     /**
      * Log a message at level ERROR.
      *
@@ -121,6 +126,11 @@ export interface Logger {
      * @param args arguments filled into the placeholder or directly logged.
      */
     error(msg: string, ...args: any[]): void;
+    /**
+     * Convenience method to log an error (without an additional message) as an error.
+     * @param error the error to log
+     */
+    error(error: Error): void;
     /**
      * Creates a new Logger, which will prefix each log message with the given prefix.
      *

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

@@ -0,0 +1,8 @@
+import { RegisterOptions, ValueOrProvider } from "./config";
+import "dojo/_base/sniff";
+interface RegisterFunction<T> {
+    (key: keyof T, valueOrProvider: ValueOrProvider<T>, 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;
+export {};

package/apprt-core/config.d.ts

@@ -1,49 +1,338 @@
 import { DeepReadonly } from "./Types";
-import "dojo/_base/sniff";
 /**
  * Lists well known config property names and their types.
- *
- * TODO: will be split into config and environment detection!
  */
-export interface ConfigProperties {
-    /** True if deprecation messages shall be logged. */
+export interface WellknownConfigKeys {
+    /**
+     * True if deprecation messages shall be logged.
+     */
     "ct-log-deprecations": boolean;
-    /** TODO ?? */
+    /**
+     * Is an algorithm to re-calcuate the viewport size for mobile enabled.
+     */
     "ct-fix-viewport": boolean;
+    /**
+     * Should the use of the fix algorithm be enforced.
+     */
     "ct-fix-viewport-force": boolean;
+    /**
+     * Is touch scroll enabled for dgrid.
+     */
     "ct-dgrid-touchscroll": boolean;
-    /** True if content security policy settings prevent eval() etc. */
+    /**
+     * Is the debug mode enabled
+     */
+    "debug": boolean;
+    /**
+     *  The configured locale.
+     *  Please use `apprt-core/Locale.getCurrent()` to access the value.
+     */
+    "locale": string;
+    /**
+     *  Url pointing to the current app directory.
+     */
+    "app-base-url": string;
+    /**
+     * The global logging configuration.
+     * Is interpreted by apprt-core/Logger
+     */
+    "logging": string;
+    /**
+     * Url to the js-registry providing the test bundles.
+     * Only available during test execution.
+     */
+    "testing-jsregistry-url": string;
+    /**
+     * Registry url used to fetch the apprt system.
+     */
+    "apprt-jsregistry-url": string;
+    /**
+     * The name of the default application.
+     */
+    "app-launch-default-app": string;
+    /**
+     * Defines that pre-fetching of module.js files via registry/layer.js is enabled.
+     */
+    "app-launch-prefetch-enabled": boolean;
+    /**
+     * Defines that during the pre-fetching main.js files should be included.
+     * @deprecated the settings is obsolete.
+     */
+    "app-launch-prefetch-main": boolean;
+    /**
+     * Defines that switching to HTTP Post is allowed during layer.js pre-fetching.
+     */
+    "app-launch-prefetch-with-post-enabled": boolean;
+    /**
+     * Defines that the layer.js request is using gzip encoded parameters to keep the parameter size short.
+     */
+    "app-launch-prefetch-params-compressed": boolean;
+    /**
+     * Defines that the app.json and bundles.json requests should use jsonp.
+     * @deprecated this support will be dropped for security reasons.
+     */
+    "app-launch-jsonp-enabled": boolean;
+    /**
+     * Enables statistics calculation during app start.
+     */
+    "app-launch-statistics-enabled": boolean;
+    /**
+     * Information of apprt-boot for the Launcher.
+     */
+    "apprt-boot-loader-info": any;
+    /**
+     * A global configured Enterprise-Portal url.
+     */
+    "arcgis-portal-url": string;
+    /**
+     * Url to the agol/token endpoint of map.apps.
+     * Which provides an technical user token to e.g. consume a geolocation service as anonymous app user.
+     */
+    "esri-identity-app-token-url": string;
+    /**
+     * Enables the use of the agol/token endpoint.
+     */
+    "esri-identity-app-token-enabled": boolean;
+    /**
+     * Enables the persistence of the esri/identity/IdentityManager state in the local storage.
+     */
+    "esri-identity-state-persist": boolean;
+    /**
+     * The name of the state in the local storage.
+     */
+    "esri-identity-state-name": string;
+    /**
+     * The prefix of the state in the local storage.
+     * If this is not configured then the default prefix is the app location.
+     * This should prevent interferences between apps.
+     */
+    "esri-identity-state-name-prefix": string;
+    /**
+     * Allows the esri/IdentityManager to send credentials via http.
+     * Not this is only intended for developement purpose
+     * and should never be enabled during production.
+     */
+    "esri-identity-allow-credentials-over-http": boolean;
+    /**
+     * Enables client side oauth for the application.
+     */
+    "oauth-enabled": boolean;
+    /**
+     * Which expiration should the requested oauth token have.
+     */
+    "oauth-access-token-expiration": number;
+    /**
+     * The client-id or app-id to authenticated with.
+     */
+    "oauth-app-id": string;
+    /**
+     * A special namespace value.
+     * Experimental, ignore that.
+     */
+    "oauth-namespace": string;
+    /**
+     * Should the login dialog be shown inside a popup.
+     */
+    "oauth-use-popup": boolean;
+    /**
+     * Url to a callback page which consumes the access token.
+     * Only of interest if oauth-use-popup is true.
+     */
+    "oauth-popup-callback-page": string;
+    /**
+     * Flag to enforce a login,
+     * Experimental, ignore that.
+     */
+    "oauth-force-login": string;
+    /**
+     * Refresh interval for geo-location updates.
+     */
+    "geolocation-update-interval": number;
+    /**
+     * Maximal allowed url length before automatically switching to POST.
+     */
+    "request-max-url-length": number;
+    /**
+     * Default request timeout.
+     */
+    "request-timeout": number;
+    /**
+     * Disables automatic CORS proxy fallback.
+     */
+    "request-proxy-disabled": boolean;
+    /**
+     * The default proxy url.
+     */
+    "request-proxy-url": string;
+    /**
+     * Proxy use rules.
+     */
+    "request-proxy-rules": string;
+    /**
+     * The trusted servers.
+     * Required for secure CORS communication.
+     */
+    "request-trusted-servers": string;
+    /**
+     * Flag for apprt-request to return dojo/Deferred instead of Promises.
+     */
+    "request-return-dojo-deferred": boolean;
+}
+/** Valid configuration property names. */
+export declare type ConfigKey = keyof WellknownConfigKeys;
+/**
+ * Lists well known environment property names and their types.
+ */
+export interface WellknownEnvKeys {
+    /**
+     * True if content security policy settings prevent eval() etc.
+     */
     "csp-restrictions": boolean;
-    /** True if WebAssembly is enabled. */
+    /**
+     * True if WebAssembly is enabled.
+     */
     "webassembly": boolean;
+    /**
+     * Detection if the client device is touch enabled.
+     */
     "touch": boolean;
+    /**
+     * Detection if the client is a mobile device.
+     */
     "mobile": boolean;
+    /**
+     * Detection if the client is the Internet Explorer.
+     */
     "ie": number;
+    /**
+     * Detection if the client is FireFox.
+     */
     "ff": number;
+    /**
+     * Detection if the client is Safari.
+     */
     "safari": number;
+    /**
+     * Detection if the client is an Android device.
+     */
     "android": number;
-    "native-xhr2": boolean;
 }
-/** Valid configuration property names. */
-export declare type ConfigPropertyKey = keyof ConfigProperties;
+/** Valid environment property names. */
+export declare type EnvKey = keyof WellknownEnvKeys;
 /** Supported value types. */
-export declare type ConfigValue = undefined | null | boolean | number | string | ConfigValue[] | {
-    [prop: string]: ConfigValue;
+export declare type SupportedValueTypes = undefined | null | boolean | number | string | SupportedValueTypes[] | {
+    [prop: string]: SupportedValueTypes;
 };
-declare type ValueProvider<T> = T | (() => T);
+declare type ValueCallback<K, R> = (key: K) => R | undefined;
+declare type ValueOrCallback<K, R> = R | ValueCallback<K, R>;
+/**
+ * Type used by the register functions.
+ * To distinguish a plain value or a function providing the value.
+ */
+export declare type ValueOrProvider<T, K extends keyof T = keyof T> = ValueOrCallback<K, Extract<T[K], SupportedValueTypes>>;
+/**
+ * Options accepted by the register* functions.
+ */
+export interface RegisterOptions {
+    /**
+     * If true and the value is a provider function it is only invoked once,
+     * otherwise the function is invoked for every call for key.
+     * Default is true.
+     */
+    cacheProvidedValue?: boolean;
+    /**
+     * If true and and there is an already existing provider, then the existing provider is replaced.
+     * Otherwise an error is thrown.
+     */
+    overwrite?: boolean;
+}
+/**
+ * A value interceptor.
+ */
+export interface Interceptor {
+    /**
+     * The interceptor is informed about any config key access.
+     * The lookupValue function can be used to fetch the original configuration value.
+     * Or the interceptor may return custom values.
+     *
+     * @param key config key
+     * @param lookupValue a function providing the original config value
+     */
+    (key: string, lookupValue: () => SupportedValueTypes): SupportedValueTypes | undefined;
+}
+/**
+ * This class implements the internal lazy configuration state.
+ * It is exported for test purpose only.
+ *
+ * @internal
+ */
+export declare class LazyValues<SupportedKeys, Key extends keyof SupportedKeys = keyof SupportedKeys> {
+    #private;
+    interceptor: Interceptor | undefined;
+    get<K extends Key>(k: K): DeepReadonly<SupportedKeys[K]> | undefined;
+    registeredKeys(): Set<Key>;
+    register<K extends Key>(key: K, valueProvider: ValueOrProvider<SupportedKeys, K>, { cacheProvidedValue, overwrite }?: RegisterOptions): void;
+    isRegistered(key: Key): boolean;
+    unregister(key: Key): boolean;
+}
 /**
  * Returns the configuration value associated with the given key.
  * Returns undefined if the key is not known.
  */
-export declare function config<K extends ConfigPropertyKey>(key: K): DeepReadonly<ConfigProperties[K]> | undefined;
-export default config;
+export declare function configValue<K extends ConfigKey>(k: K): DeepReadonly<WellknownConfigKeys[K]> | undefined;
 /**
  * Registers a new key with the configuration.
- * Keys and values must also be declared at the type level by extending the `ConfigProperties` interface.
+ * Keys and values must also be declared at the type level by extending the `WellknownConfigKeys` interface.
  *
  * Throws an exception if the key was already registered.
  *
  * @param key the configuration key
  * @param value the value or a function returning the value (for lazy evaluation).
+ * @param options registration flags
+ */
+export declare function registerConfigValue<K extends keyof WellknownConfigKeys>(key: K, valueOrProvider: ValueOrProvider<WellknownConfigKeys, K>, options?: RegisterOptions): void;
+/**
+ * The intention of this function is to make testing simpler.
+ * A test can register a config value and unregister it afterwards.
+ * @param key a config key
+ * @returns true if conf value was un-registered(previously registered)
+ */
+export declare function unregisterConfigValue<K extends keyof WellknownConfigKeys>(key: K): boolean;
+/**
+ * The intention of this function is to make testing simpler.
+ *
+ * Do not forget to unset your interceptor after the tests.
+ * @param interceptor a callback informed about any config value access.
+ */
+export declare function setConfigValueInterceptor(interceptor?: Interceptor): void;
+/**
+ * Returns the environment value associated with the given key.
+ * Returns undefined if the key is not known.
+ */
+export declare function envValue<K extends EnvKey>(k: K): DeepReadonly<WellknownEnvKeys[K]> | undefined;
+/**
+ * Registers a new environment key with the configuration.
+ * Keys and values must also be declared at the type level by extending the `WellknownEnvKeys` interface.
+ *
+ * Throws an exception if the key was already registered.
+ *
+ * @param key the env key
+ * @param value the value or a function returning the value (for lazy evaluation).
+ * @param options registration flags
+ */
+export declare function registerEnvValue<K extends keyof WellknownEnvKeys>(key: K, valueOrProvider: ValueOrProvider<WellknownEnvKeys, K>, options?: RegisterOptions): void;
+/**
+ * The intention of this function is to make testing simpler.
+ * A test can register a env value and unregister it afterwards.
+ * @param key a env key
+ * @returns true if env value was un-registered(previously registered)
+ */
+export declare function unregisterEnvValue<K extends keyof WellknownEnvKeys>(key: K): boolean;
+/**
+ * The intention of this function is to make testing simpler.
+ *
+ * Do not forget to unset the interceptor after the tests.
+ * @param interceptor a callback informed about any env value access.
  */
-export declare function register<K extends ConfigPropertyKey>(key: K, value: ValueProvider<Extract<ConfigProperties[K], ConfigValue>>): void;
+export declare function setEnvValueInterceptor(interceptor?: Interceptor): void;
+export {};

package/apprt-core/url-utils.d.ts

@@ -34,7 +34,6 @@ export declare function objectToQuery(object: Record<string, any | any[]>): stri
  * @returns the parsed object
  */
 export declare function queryToObject(query: string | URLSearchParams): Record<string, string | string[]>;
-export declare function normalizeOrigin(origin: string): string;
 /**
  * Returns true if the given `url` is on a different origin than the current host.
  */

package/apprt-esri-init/CredentialStorage.d.ts

@@ -4,5 +4,5 @@ export default function _default(identityManager: any, opts: any): {
     get: () => any;
     clear: () => void;
     watchForChanges: () => void;
-    isWatchingForChanges: () => boolean;
+    isWatchingForChanges(): boolean;
 };

package/apprt-fetch/config.d.ts

@@ -1,6 +1,6 @@
 import { DeepReadonly } from "apprt-core/Types";
 import type { Config, Interceptor, ProxyRule, TrustedServer } from ".";
-import { Origin } from "./origin";
+import { OriginPattern } from "./origin";
 export declare class FetchConfig implements Config {
     defaultProxy: string | undefined;
     disableProxySupport: boolean;
@@ -21,9 +21,9 @@ export declare class FetchConfig implements Config {
     };
 }
 export interface InternalProxyRule {
-    origin: Origin;
+    origin: OriginPattern;
     proxyUrl?: string;
 }
 export interface InternalTrustedServer {
-    origin: Origin;
+    origin: OriginPattern;
 }

package/apprt-fetch/origin.d.ts

@@ -1,21 +1,26 @@
-declare const ORIGIN_TAG: unique symbol;
-/**
- * Wrapper type representing normalized origin values.
- *
- * This is important because there can be some confusion w.r.t. default ports (present or not?).
- * Normalized origins use the same format and can be compared with string comparisons.
- */
-export declare type Origin = string & {
-    _tag: typeof ORIGIN_TAG;
-};
-/**
- * Normalizes an origin string (e.g. "https://host.com").
- * Returns the normalized value casted to the `Origin` type.
- */
-export declare function normalizeOrigin(origin: string): Origin;
-/**
- * Retrieves the normalized origin from the given URL as an instance of `Origin`.
- */
-export declare function originFromUrl(url: URL): Origin;
-export declare function originsEqual(lhs: Origin, rhs: Origin): boolean;
-export {};
+export declare type Protocol = "http:" | "https:";
+export declare class OriginPattern {
+    readonly protocol: Protocol | undefined;
+    readonly hostname: string;
+    readonly port: string | undefined;
+    readonly path: string;
+    /**
+     * Attempts to parse a pattern from the given string.
+     * Throws an error if the pattern is invalid.
+     */
+    static fromString(pattern: string): OriginPattern;
+    private constructor();
+    /**
+     * Returns true if `other` is equivalent to `this`, false otherwise.
+     */
+    equalTo(other: OriginPattern): boolean;
+    /**
+     * Returns true if the given `url` matches this pattern,
+     * false otherwise.
+     */
+    matches(url: URL): boolean;
+    /**
+     * Serialized this pattern to a normalized string representation.
+     */
+    toString(): string;
+}

package/apprt-streams/Stream.d.ts

@@ -610,7 +610,7 @@ export declare abstract class Stream<T> implements Iterable<T> {
      *
      * ```js
      * for (const value of Stream.integers(5)) {
-     *     console.log(value);
+     *     console.info(value);
      * }
      * ```
      */

package/banner-config/DataFormBuilderWidgetFactory.d.ts

@@ -1,2 +1,7 @@
-export default BannerWidget;
-declare const BannerWidget: any;
+declare const BannerWidget_base: any;
+export default class BannerWidget extends BannerWidget_base {
+    [x: string]: any;
+    createInstance(): any;
+    _handleError(event: any): void;
+}
+export {};

package/package.json

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

package/selection-resultcenter/CachingStore.d.ts

@@ -17,16 +17,15 @@ export default class CachingStore {
     getMetadata(object: any): any;
     getIdentity(object: any): any;
     _getAllMasterStoreFields(): import("../../apprt/apprt-core/Promise").ExtendedPromise<{}>;
-    _getItems(itemIds: any, opts: any): any;
-    _fixCount(opts: any, itemIds: any): any;
+    _getItems(itemIds: any, opts: any): Promise<any[]>;
     _buildQuery(itemIds: any): {};
     _isGeometryRequired(options: any, defaultRequired: any): Any;
     _getGeometryFromCache(id: any, offset: any): any;
     _isSpatialQuery(query: any): boolean;
-    _getItemsFromCache(query: any, options?: {}): import("../store-api/api/Store").ResultItems<Readonly<Record<string, any>>>;
+    _getItemsFromCache(query: any, options?: {}): import("store-api/api/Store").ResultItems<Readonly<Record<string, any>>>;
     _getGeometryForItems(items: any, options: any): import("../../apprt/apprt-core/Promise").ExtendedPromise<any>;
     _getItemsForQuery(query: any, options: any): import("../../apprt/apprt-core/Promise").ExtendedPromise<any[]>;
-    query(query: any, options: any): import("../store-api/api/Store").ResultItems<any>;
+    query(query: any, options: any): import("store-api/api/Store").ResultItems<any>;
     _synchronizedQueryOnCache(query: any, opts: any): any;
     querySequence: any;
     _queryOnCache(query: any, opts: any): import("../../apprt/apprt-core/Promise").ExtendedPromise<any>;

package/store-api/api/Store.d.ts

@@ -9,6 +9,11 @@ export declare type IndexableThing = Readonly<Record<string, any>>;
 export interface ResultItems<ItemType extends IndexableThing> extends ReadonlyArray<ItemType> {
     /** Total number of available items in the result. */
     readonly total?: number;
+    /**
+     * Set to true if by the store to indicate that there are more results.
+     * The client may query again with an appropriate `start` value.
+     */
+    readonly hasMore?: boolean;
     /** Function to cancel the query. It is always 'undefined' in synchronous responses. */
     readonly cancel?: undefined;
     /** Function to react on the provided result. It is always 'undefined' in synchronous responses. */