@open-pioneer/map 1.4.0-dev.20260727093741 → 1.5.0-dev.20260910103330

package/LayerFactory.d.ts

@@ -1,7 +1,7 @@
 import { HttpService } from "@open-pioneer/http";
 import { DECLARE_SERVICE_INTERFACE, ServiceOptions } from "@open-pioneer/runtime";
-import { LayerConfig } from "./layers/shared/LayerConfig";
 import { LayerConstructor } from "./layers/shared/internals";
+import { LayerConfig } from "./layers/shared/LayerConfig";
 import { Layer } from "./layers/unions";
 interface References {
     httpService: HttpService;

package/LayerFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"LayerFactory.js","sources":["LayerFactory.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { HttpService } from \"@open-pioneer/http\";\nimport { DECLARE_SERVICE_INTERFACE, ServiceOptions } from \"@open-pioneer/runtime\";\nimport { AbstractLayer } from \"./layers/AbstractLayer\";\nimport { LayerConfig } from \"./layers/shared/LayerConfig\";\nimport { LayerConstructor } from \"./layers/shared/internals\";\nimport { INTERNAL_CONSTRUCTOR_TAG } from \"./utils/InternalConstructorTag\";\nimport { Layer } from \"./layers/unions\";\n\ninterface References {\n    httpService: HttpService;\n}\n\n/**\n * Options that can be passed to {@link LayerFactory.create}.\n *\n * The `type` option is mandatory and indicates the type of the layer (e.g. `WMSLayer`).\n * The other options depend on the specific layer type.\n *\n * @group Services\n */\nexport type LayerCreateOptions<LayerType extends Layer, Config extends LayerConfig> = {\n    /** The layer type to construct. */\n    type: LayerConstructor<Config, LayerType>;\n} & Config;\n\n/**\n * Creates instances of layer classes.\n *\n * Use the interface `\"map.LayerFactory\"` to obtain an instance of this service.\n *\n * @group Services\n */\nexport class LayerFactory {\n    declare [DECLARE_SERVICE_INTERFACE]: \"map.LayerFactory\";\n\n    #httpService: HttpService;\n\n    constructor(options: ServiceOptions<References>) {\n        this.#httpService = options.references.httpService;\n    }\n\n    /**\n     * Creates a new instance of the given layer type.\n     * The `\"type\"` option is mandatory and specifies which layer type to create.\n     *\n     * The other configuration options may be dependent on the specific layer type.\n     *\n     * Example:\n     *\n     * ```ts\n     * import { SimpleLayer } from \"@open-pioneer/map\";\n     *\n     * const layerFactory = ...; // injected\n     * const layer = layerFactory.create({\n     *     type: SimpleLayer,\n     *     title: \"Layer title\",\n     *     olLayer: new TileLayer({}),\n     *     // ... other options\n     * });\n     * ```\n     */\n    create<LayerType extends Layer, Config extends LayerConfig>(\n        config: LayerCreateOptions<LayerType, Config>\n    ): LayerType {\n        const { type, ...rest } = config;\n        if (!type || !(type.prototype instanceof AbstractLayer)) {\n            throw new Error(\n                `Invalid layer type option. Use one of the layer classes exported by this package.`\n            );\n        }\n        return new type(\n            rest as unknown as Config,\n            { httpService: this.#httpService },\n            INTERNAL_CONSTRUCTOR_TAG\n        );\n    }\n}\n"],"names":[],"mappings":";;;AAkCO,MAAM,YAAA,CAAa;AAAA,EAGtB,YAAA;AAAA,EAEA,YAAY,OAAA,EAAqC;AAC7C,IAAA,IAAA,CAAK,YAAA,GAAe,QAAQ,UAAA,CAAW,WAAA;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,OACI,MAAA,EACS;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,GAAG,IAAA,EAAK,GAAI,MAAA;AAC1B,IAAA,IAAI,CAAC,IAAA,IAAQ,EAAE,IAAA,CAAK,qBAAqB,aAAA,CAAA,EAAgB;AACrD,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,CAAA,iFAAA;AAAA,OACJ;AAAA,IACJ;AACA,IAAA,OAAO,IAAI,IAAA;AAAA,MACP,IAAA;AAAA,MACA,EAAE,WAAA,EAAa,IAAA,CAAK,YAAA,EAAa;AAAA,MACjC;AAAA,KACJ;AAAA,EACJ;AACJ;;;;"}
+{"version":3,"file":"LayerFactory.js","sources":["LayerFactory.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { HttpService } from \"@open-pioneer/http\";\nimport { DECLARE_SERVICE_INTERFACE, ServiceOptions } from \"@open-pioneer/runtime\";\nimport { AbstractLayer } from \"./layers/AbstractLayer\";\nimport { LayerConstructor } from \"./layers/shared/internals\";\nimport { LayerConfig } from \"./layers/shared/LayerConfig\";\nimport { Layer } from \"./layers/unions\";\nimport { INTERNAL_CONSTRUCTOR_TAG } from \"./utils/InternalConstructorTag\";\n\ninterface References {\n    httpService: HttpService;\n}\n\n/**\n * Options that can be passed to {@link LayerFactory.create}.\n *\n * The `type` option is mandatory and indicates the type of the layer (e.g. `WMSLayer`).\n * The other options depend on the specific layer type.\n *\n * @group Services\n */\nexport type LayerCreateOptions<LayerType extends Layer, Config extends LayerConfig> = {\n    /** The layer type to construct. */\n    type: LayerConstructor<Config, LayerType>;\n} & Config;\n\n/**\n * Creates instances of layer classes.\n *\n * Use the interface `\"map.LayerFactory\"` to obtain an instance of this service.\n *\n * @group Services\n */\nexport class LayerFactory {\n    declare [DECLARE_SERVICE_INTERFACE]: \"map.LayerFactory\";\n\n    #httpService: HttpService;\n\n    constructor(options: ServiceOptions<References>) {\n        this.#httpService = options.references.httpService;\n    }\n\n    /**\n     * Creates a new instance of the given layer type.\n     * The `\"type\"` option is mandatory and specifies which layer type to create.\n     *\n     * The other configuration options may be dependent on the specific layer type.\n     *\n     * Example:\n     *\n     * ```ts\n     * import { SimpleLayer } from \"@open-pioneer/map\";\n     *\n     * const layerFactory = ...; // injected\n     * const layer = layerFactory.create({\n     *     type: SimpleLayer,\n     *     title: \"Layer title\",\n     *     olLayer: new TileLayer({}),\n     *     // ... other options\n     * });\n     * ```\n     */\n    create<LayerType extends Layer, Config extends LayerConfig>(\n        config: LayerCreateOptions<LayerType, Config>\n    ): LayerType {\n        const { type, ...rest } = config;\n        if (!type || !(type.prototype instanceof AbstractLayer)) {\n            throw new Error(\n                `Invalid layer type option. Use one of the layer classes exported by this package.`\n            );\n        }\n        return new type(\n            rest as unknown as Config,\n            { httpService: this.#httpService },\n            INTERNAL_CONSTRUCTOR_TAG\n        );\n    }\n}\n"],"names":[],"mappings":";;;AAmCO,MAAM,YAAA,CAAa;AAAA,EAGtB,YAAA;AAAA,EAEA,YAAY,OAAA,EAAqC;AAC7C,IAAA,IAAA,CAAK,YAAA,GAAe,QAAQ,UAAA,CAAW,WAAA;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBA,OACI,MAAA,EACS;AACT,IAAA,MAAM,EAAE,IAAA,EAAM,GAAG,IAAA,EAAK,GAAI,MAAA;AAC1B,IAAA,IAAI,CAAC,IAAA,IAAQ,EAAE,IAAA,CAAK,qBAAqB,aAAA,CAAA,EAAgB;AACrD,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,CAAA,iFAAA;AAAA,OACJ;AAAA,IACJ;AACA,IAAA,OAAO,IAAI,IAAA;AAAA,MACP,IAAA;AAAA,MACA,EAAE,WAAA,EAAa,IAAA,CAAK,YAAA,EAAa;AAAA,MACjC;AAAA,KACJ;AAAA,EACJ;AACJ;;;;"}

package/MapRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapRegistry.js","sources":["MapRegistry.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { batch, ReadonlyReactive } from \"@conterra/reactivity-core\";\nimport { on } from \"@conterra/reactivity-events\";\nimport { createLogger, Resource } from \"@open-pioneer/core\";\nimport { HttpService } from \"@open-pioneer/http\";\nimport {\n    DECLARE_SERVICE_INTERFACE,\n    PackageIntl,\n    Service,\n    ServiceOptions\n} from \"@open-pioneer/runtime\";\nimport OlMap from \"ol/Map\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport { LayerFactory } from \"./LayerFactory\";\nimport { createMapModel } from \"./model/createMapModel\";\nimport { MapConfig } from \"./model/MapConfig\";\nimport { MapModel } from \"./model/MapModel\";\n\nconst LOG = createLogger(sourceId);\n\n/**\n * Options passed to the {@link MapConfigProvider.getMapConfig} method.\n *\n * @group Services\n */\nexport interface MapConfigProviderOptions {\n    /**\n     * A reference to the layer factory, for the construction of new layer instances.\n     */\n    layerFactory: LayerFactory;\n}\n\n/**\n * Provides an OpenLayers map configuration with a given map id.\n *\n * The implementor must also provide the interface name `\"map.MapConfigProvider\"`.\n *\n * @group Services\n */\nexport interface MapConfigProvider {\n    /**\n     * Unique identifier of the map.\n     */\n    readonly mapId: string;\n\n    /**\n     * Returns the map configuration for this map.\n     *\n     * Called by the {@link MapRegistry} when the map is requested for the first time.\n     *\n     * See {@link MapConfig} for supported options during map creation.\n     * Use {@link MapConfigProviderOptions.layerFactory} to construct new layers.\n     */\n    getMapConfig(options: MapConfigProviderOptions): Promise<MapConfig>;\n}\n\ninterface References {\n    providers: MapConfigProvider[];\n    httpService: HttpService;\n    layerFactory: LayerFactory;\n}\n\ntype ModelJobResult =\n    { kind: \"model\"; model: MapModel; listener: Resource } | { kind: \"error\"; error: Error };\n\n/**\n * Provides access to registered map instances.\n *\n * Maps are identified by a unique id.\n *\n * Inject an instance of this service by referencing the interface name `\"map.MapRegistry\"`.\n *\n * @group Services\n */\nexport class MapRegistry implements Service {\n    declare [DECLARE_SERVICE_INTERFACE]: \"map.MapRegistry\";\n\n    #currentIntl: ReadonlyReactive<PackageIntl>;\n    #httpService: HttpService;\n    #layerFactory: LayerFactory;\n\n    #configProviders = new Map<string, MapConfigProvider>();\n    #entries = new Map<string, ModelJobResult>();\n    #modelCreationJobs = new Map<string, Promise<ModelJobResult>>();\n    #modelsByOlMap = new WeakMap<OlMap, MapModel>();\n    #destroyed = false;\n\n    constructor({ references, currentIntl }: ServiceOptions<References>) {\n        this.#currentIntl = currentIntl;\n        this.#httpService = references.httpService;\n        this.#layerFactory = references.layerFactory;\n\n        const providers = references.providers;\n        for (const provider of providers) {\n            this.#configProviders.set(provider.mapId, provider);\n        }\n    }\n\n    destroy(): void {\n        if (this.#destroyed) {\n            return;\n        }\n\n        batch(() => {\n            LOG.debug(`Destroy map registry and all maps`);\n            this.#destroyed = true;\n            this.#entries.forEach((entry) => {\n                if (entry.kind === \"model\") {\n                    entry.listener.destroy();\n                    entry.model.destroy();\n                }\n            });\n            this.#entries.clear();\n            this.#modelCreationJobs.clear();\n        });\n    }\n\n    /**\n     * Returns the map model associated with the given id.\n     * Returns undefined if there is no such model.\n     */\n    async getMapModel(mapId: string): Promise<MapModel | undefined> {\n        if (this.#destroyed) {\n            throw new Error(\"MapRegistry has already been destroyed.\");\n        }\n\n        const entry = this.#entries.get(mapId);\n        if (entry) {\n            return unbox(entry);\n        }\n\n        const creationJob = this.#modelCreationJobs.get(mapId);\n        if (creationJob) {\n            return await waitForResult(creationJob);\n        }\n\n        const provider = this.#configProviders.get(mapId);\n        if (!provider) {\n            LOG.debug(`Failed to find a config provider for map id '${mapId}'.`);\n            return undefined;\n        }\n\n        return await this.#createMapModel(mapId, () =>\n            provider.getMapConfig({\n                layerFactory: this.#layerFactory\n            })\n        );\n    }\n\n    /**\n     * Like {@link getMapModel}, but throws if no model exists for the given `mapId`.\n     */\n    async expectMapModel(mapId: string): Promise<MapModel> {\n        const model = await this.getMapModel(mapId);\n        if (!model) {\n            throw new Error(`No configuration available for map with id '${mapId}'.`);\n        }\n        return model;\n    }\n\n    /**\n     * Creates a MapModel without the need to provide a {@link MapConfigProvider}.\n     * Throws an error if a map with the given id already exists or if the map config is invalid.\n     */\n    async createMapModel(mapId: string, options?: MapConfig): Promise<MapModel> {\n        if (this.#destroyed) {\n            throw new Error(\"MapRegistry has already been destroyed.\");\n        }\n        if (this.#entries.has(mapId)) {\n            throw new Error(`Map id '${mapId}' is not unique.`);\n        }\n        if (this.#modelCreationJobs.has(mapId)) {\n            throw new Error(`A map with the id '${mapId}' is already under construction.`);\n        }\n        return await this.#createMapModel(mapId, () => Promise.resolve(options ?? {}));\n    }\n\n    /**\n     * Given a raw OpenLayers map instance, returns the associated {@link MapModel} - or undefined\n     * if the map is unknown to this registry.\n     *\n     * All OpenLayers maps created by this registry (e.g. via {@link MapConfigProvider} or {@link createMapModel}) have an associated map model.\n     */\n    getMapModelByRawInstance(olMap: OlMap): MapModel | undefined {\n        return this.#modelsByOlMap.get(olMap);\n    }\n\n    // Wrapper method to ensure that in-progress construction of maps can be observed.\n    #createMapModel(mapId: string, configProvider: () => Promise<MapConfig>): Promise<MapModel> {\n        const creationJob = this.#modelCreationJobs.get(mapId);\n        if (creationJob) {\n            throw new Error(\"Internal error: a map model is already being created for this mapId\");\n        }\n\n        const modelPromise = this.#createMapModelImpl(mapId, configProvider)\n            .then((mapModel) => {\n                if (this.#destroyed) {\n                    mapModel.destroy();\n                    throw new Error(`MapRegistry has been destroyed.`);\n                }\n\n                const listener = on(\n                    mapModel.destroyed,\n                    () => {\n                        // Allow id reuse for dynamically created maps\n                        if (this.#isDynamic(mapId)) {\n                            const currentEntry = this.#entries.get(mapId);\n                            if (currentEntry === entry) {\n                                this.#entries.delete(mapId);\n                            }\n                        }\n                    },\n                    { dispatch: \"sync\" }\n                );\n\n                const entry: ModelJobResult = { kind: \"model\", model: mapModel, listener };\n                this.#entries.set(mapId, entry);\n                this.#modelCreationJobs.delete(mapId);\n                this.#modelsByOlMap.set(mapModel.olMap, mapModel);\n                return entry;\n            })\n            .catch((cause) => {\n                const error = new Error(`Failed to construct map '${mapId}'`, { cause });\n                const entry: ModelJobResult = { kind: \"error\", error };\n                this.#modelCreationJobs.delete(mapId);\n                if (!this.#isDynamic(mapId)) {\n                    // Don't store errors for dynamically created maps (the caller already got the error via promise).\n                    this.#entries.set(mapId, entry);\n                }\n                return entry;\n            });\n        this.#modelCreationJobs.set(mapId, modelPromise);\n        return waitForResult(modelPromise);\n    }\n\n    async #createMapModelImpl(\n        mapId: string,\n        configProvider: () => Promise<MapConfig>\n    ): Promise<MapModel> {\n        LOG.info(`Creating map with id '${mapId}'`);\n        const mapConfig = await configProvider();\n        const mapModel = await createMapModel(\n            mapId,\n            mapConfig,\n            this.#currentIntl,\n            this.#httpService\n        );\n        return mapModel;\n    }\n\n    #isDynamic(mapId: string): boolean {\n        return !this.#configProviders.has(mapId);\n    }\n}\n\nasync function waitForResult(job: Promise<ModelJobResult>): Promise<MapModel> {\n    return unbox(await job);\n}\n\nfunction unbox(entry: ModelJobResult): MapModel {\n    if (entry.kind === \"error\") {\n        throw entry.error;\n    }\n    return entry.model;\n}\n"],"names":[],"mappings":";;;;;;AAmBA,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAwD1B,MAAM,WAAA,CAA+B;AAAA,EAGxC,YAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EAEA,gBAAA,uBAAuB,GAAA,EAA+B;AAAA,EACtD,QAAA,uBAAe,GAAA,EAA4B;AAAA,EAC3C,kBAAA,uBAAyB,GAAA,EAAqC;AAAA,EAC9D,cAAA,uBAAqB,OAAA,EAAyB;AAAA,EAC9C,UAAA,GAAa,KAAA;AAAA,EAEb,WAAA,CAAY,EAAE,UAAA,EAAY,WAAA,EAAY,EAA+B;AACjE,IAAA,IAAA,CAAK,YAAA,GAAe,WAAA;AACpB,IAAA,IAAA,CAAK,eAAe,UAAA,CAAW,WAAA;AAC/B,IAAA,IAAA,CAAK,gBAAgB,UAAA,CAAW,YAAA;AAEhC,IAAA,MAAM,YAAY,UAAA,CAAW,SAAA;AAC7B,IAAA,KAAA,MAAW,YAAY,SAAA,EAAW;AAC9B,MAAA,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,QAAA,CAAS,KAAA,EAAO,QAAQ,CAAA;AAAA,IACtD;AAAA,EACJ;AAAA,EAEA,OAAA,GAAgB;AACZ,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA;AAAA,IACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAA,GAAA,CAAI,MAAM,CAAA,iCAAA,CAAmC,CAAA;AAC7C,MAAA,IAAA,CAAK,UAAA,GAAa,IAAA;AAClB,MAAA,IAAA,CAAK,QAAA,CAAS,OAAA,CAAQ,CAAC,KAAA,KAAU;AAC7B,QAAA,IAAI,KAAA,CAAM,SAAS,OAAA,EAAS;AACxB,UAAA,KAAA,CAAM,SAAS,OAAA,EAAQ;AACvB,UAAA,KAAA,CAAM,MAAM,OAAA,EAAQ;AAAA,QACxB;AAAA,MACJ,CAAC,CAAA;AACD,MAAA,IAAA,CAAK,SAAS,KAAA,EAAM;AACpB,MAAA,IAAA,CAAK,mBAAmB,KAAA,EAAM;AAAA,IAClC,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,YAAY,KAAA,EAA8C;AAC5D,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,MAAM,IAAI,MAAM,yCAAyC,CAAA;AAAA,IAC7D;AAEA,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA;AACrC,IAAA,IAAI,KAAA,EAAO;AACP,MAAA,OAAO,MAAM,KAAK,CAAA;AAAA,IACtB;AAEA,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA;AACrD,IAAA,IAAI,WAAA,EAAa;AACb,MAAA,OAAO,MAAM,cAAc,WAAW,CAAA;AAAA,IAC1C;AAEA,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,KAAK,CAAA;AAChD,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA,GAAA,CAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,eAAA;AAAA,MAAgB,KAAA;AAAA,MAAO,MACrC,SAAS,YAAA,CAAa;AAAA,QAClB,cAAc,IAAA,CAAK;AAAA,OACtB;AAAA,KACL;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,KAAA,EAAkC;AACnD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,WAAA,CAAY,KAAK,CAAA;AAC1C,IAAA,IAAI,CAAC,KAAA,EAAO;AACR,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,4CAAA,EAA+C,KAAK,CAAA,EAAA,CAAI,CAAA;AAAA,IAC5E;AACA,IAAA,OAAO,KAAA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,cAAA,CAAe,KAAA,EAAe,OAAA,EAAwC;AACxE,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,MAAM,IAAI,MAAM,yCAAyC,CAAA;AAAA,IAC7D;AACA,IAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,QAAA,EAAW,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAAA,IACtD;AACA,IAAA,IAAI,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA,EAAG;AACpC,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,KAAK,CAAA,gCAAA,CAAkC,CAAA;AAAA,IACjF;AACA,IAAA,OAAO,MAAM,IAAA,CAAK,eAAA,CAAgB,KAAA,EAAO,MAAM,QAAQ,OAAA,CAAQ,OAAA,IAAW,EAAE,CAAC,CAAA;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,yBAAyB,KAAA,EAAoC;AACzD,IAAA,OAAO,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,KAAK,CAAA;AAAA,EACxC;AAAA;AAAA,EAGA,eAAA,CAAgB,OAAe,cAAA,EAA6D;AACxF,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA;AACrD,IAAA,IAAI,WAAA,EAAa;AACb,MAAA,MAAM,IAAI,MAAM,qEAAqE,CAAA;AAAA,IACzF;AAEA,IAAA,MAAM,YAAA,GAAe,KAAK,mBAAA,CAAoB,KAAA,EAAO,cAAc,CAAA,CAC9D,IAAA,CAAK,CAAC,QAAA,KAAa;AAChB,MAAA,IAAI,KAAK,UAAA,EAAY;AACjB,QAAA,QAAA,CAAS,OAAA,EAAQ;AACjB,QAAA,MAAM,IAAI,MAAM,CAAA,+BAAA,CAAiC,CAAA;AAAA,MACrD;AAEA,MAAA,MAAM,QAAA,GAAW,EAAA;AAAA,QACb,QAAA,CAAS,SAAA;AAAA,QACT,MAAM;AAEF,UAAA,IAAI,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AACxB,YAAA,MAAM,YAAA,GAAe,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA;AAC5C,YAAA,IAAI,iBAAiB,KAAA,EAAO;AACxB,cAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAK,CAAA;AAAA,YAC9B;AAAA,UACJ;AAAA,QACJ,CAAA;AAAA,QACA,EAAE,UAAU,MAAA;AAAO,OACvB;AAEA,MAAA,MAAM,QAAwB,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAO,UAAU,QAAA,EAAS;AACzE,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAA,EAAO,KAAK,CAAA;AAC9B,MAAA,IAAA,CAAK,kBAAA,CAAmB,OAAO,KAAK,CAAA;AACpC,MAAA,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,QAAA,CAAS,KAAA,EAAO,QAAQ,CAAA;AAChD,MAAA,OAAO,KAAA;AAAA,IACX,CAAC,CAAA,CACA,KAAA,CAAM,CAAC,KAAA,KAAU;AACd,MAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,CAAA,EAAK,EAAE,OAAO,CAAA;AACvE,MAAA,MAAM,KAAA,GAAwB,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAM;AACrD,MAAA,IAAA,CAAK,kBAAA,CAAmB,OAAO,KAAK,CAAA;AACpC,MAAA,IAAI,CAAC,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AAEzB,QAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAA,EAAO,KAAK,CAAA;AAAA,MAClC;AACA,MAAA,OAAO,KAAA;AAAA,IACX,CAAC,CAAA;AACL,IAAA,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAA,EAAO,YAAY,CAAA;AAC/C,IAAA,OAAO,cAAc,YAAY,CAAA;AAAA,EACrC;AAAA,EAEA,MAAM,mBAAA,CACF,KAAA,EACA,cAAA,EACiB;AACjB,IAAA,GAAA,CAAI,IAAA,CAAK,CAAA,sBAAA,EAAyB,KAAK,CAAA,CAAA,CAAG,CAAA;AAC1C,IAAA,MAAM,SAAA,GAAY,MAAM,cAAA,EAAe;AACvC,IAAA,MAAM,WAAW,MAAM,cAAA;AAAA,MACnB,KAAA;AAAA,MACA,SAAA;AAAA,MACA,IAAA,CAAK,YAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACT;AACA,IAAA,OAAO,QAAA;AAAA,EACX;AAAA,EAEA,WAAW,KAAA,EAAwB;AAC/B,IAAA,OAAO,CAAC,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,KAAK,CAAA;AAAA,EAC3C;AACJ;AAEA,eAAe,cAAc,GAAA,EAAiD;AAC1E,EAAA,OAAO,KAAA,CAAM,MAAM,GAAG,CAAA;AAC1B;AAEA,SAAS,MAAM,KAAA,EAAiC;AAC5C,EAAA,IAAI,KAAA,CAAM,SAAS,OAAA,EAAS;AACxB,IAAA,MAAM,KAAA,CAAM,KAAA;AAAA,EAChB;AACA,EAAA,OAAO,KAAA,CAAM,KAAA;AACjB;;;;"}
+{"version":3,"file":"MapRegistry.js","sources":["MapRegistry.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { batch, ReadonlyReactive } from \"@conterra/reactivity-core\";\nimport { on } from \"@conterra/reactivity-events\";\nimport { createLogger, Resource } from \"@open-pioneer/core\";\nimport { HttpService } from \"@open-pioneer/http\";\nimport {\n    DECLARE_SERVICE_INTERFACE,\n    PackageIntl,\n    Service,\n    ServiceOptions\n} from \"@open-pioneer/runtime\";\nimport OlMap from \"ol/Map\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport { LayerFactory } from \"./LayerFactory\";\nimport { createMapModel } from \"./model/createMapModel\";\nimport { MapConfig } from \"./model/MapConfig\";\nimport { MapModel } from \"./model/MapModel\";\n\nconst LOG = createLogger(sourceId);\n\n/**\n * Options passed to the {@link MapConfigProvider.getMapConfig} method.\n *\n * @group Services\n */\nexport interface MapConfigProviderOptions {\n    /**\n     * A reference to the layer factory, for the construction of new layer instances.\n     */\n    layerFactory: LayerFactory;\n}\n\n/**\n * Provides an OpenLayers map configuration with a given map id.\n *\n * The implementor must also provide the interface name `\"map.MapConfigProvider\"`.\n *\n * @group Services\n */\nexport interface MapConfigProvider {\n    /**\n     * Unique identifier of the map.\n     */\n    readonly mapId: string;\n\n    /**\n     * Returns the map configuration for this map.\n     *\n     * Called by the {@link MapRegistry} when the map is requested for the first time.\n     *\n     * See {@link MapConfig} for supported options during map creation.\n     * Use {@link MapConfigProviderOptions.layerFactory} to construct new layers.\n     */\n    getMapConfig(options: MapConfigProviderOptions): Promise<MapConfig>;\n}\n\ninterface References {\n    providers: MapConfigProvider[];\n    httpService: HttpService;\n    layerFactory: LayerFactory;\n}\n\ntype ModelJobResult =\n    | { kind: \"model\"; model: MapModel; listener: Resource }\n    | { kind: \"error\"; error: Error };\n\n/**\n * Provides access to registered map instances.\n *\n * Maps are identified by a unique id.\n *\n * Inject an instance of this service by referencing the interface name `\"map.MapRegistry\"`.\n *\n * @group Services\n */\nexport class MapRegistry implements Service {\n    declare [DECLARE_SERVICE_INTERFACE]: \"map.MapRegistry\";\n\n    #currentIntl: ReadonlyReactive<PackageIntl>;\n    #httpService: HttpService;\n    #layerFactory: LayerFactory;\n\n    #configProviders = new Map<string, MapConfigProvider>();\n    #entries = new Map<string, ModelJobResult>();\n    #modelCreationJobs = new Map<string, Promise<ModelJobResult>>();\n    #modelsByOlMap = new WeakMap<OlMap, MapModel>();\n    #destroyed = false;\n\n    constructor({ references, currentIntl }: ServiceOptions<References>) {\n        this.#currentIntl = currentIntl;\n        this.#httpService = references.httpService;\n        this.#layerFactory = references.layerFactory;\n\n        const providers = references.providers;\n        for (const provider of providers) {\n            this.#configProviders.set(provider.mapId, provider);\n        }\n    }\n\n    destroy(): void {\n        if (this.#destroyed) {\n            return;\n        }\n\n        batch(() => {\n            LOG.debug(`Destroy map registry and all maps`);\n            this.#destroyed = true;\n            this.#entries.forEach((entry) => {\n                if (entry.kind === \"model\") {\n                    entry.listener.destroy();\n                    entry.model.destroy();\n                }\n            });\n            this.#entries.clear();\n            this.#modelCreationJobs.clear();\n        });\n    }\n\n    /**\n     * Returns the map model associated with the given id.\n     * Returns undefined if there is no such model.\n     */\n    async getMapModel(mapId: string): Promise<MapModel | undefined> {\n        if (this.#destroyed) {\n            throw new Error(\"MapRegistry has already been destroyed.\");\n        }\n\n        const entry = this.#entries.get(mapId);\n        if (entry) {\n            return unbox(entry);\n        }\n\n        const creationJob = this.#modelCreationJobs.get(mapId);\n        if (creationJob) {\n            return await waitForResult(creationJob);\n        }\n\n        const provider = this.#configProviders.get(mapId);\n        if (!provider) {\n            LOG.debug(`Failed to find a config provider for map id '${mapId}'.`);\n            return undefined;\n        }\n\n        return await this.#createMapModel(mapId, () =>\n            provider.getMapConfig({\n                layerFactory: this.#layerFactory\n            })\n        );\n    }\n\n    /**\n     * Like {@link getMapModel}, but throws if no model exists for the given `mapId`.\n     */\n    async expectMapModel(mapId: string): Promise<MapModel> {\n        const model = await this.getMapModel(mapId);\n        if (!model) {\n            throw new Error(`No configuration available for map with id '${mapId}'.`);\n        }\n        return model;\n    }\n\n    /**\n     * Creates a MapModel without the need to provide a {@link MapConfigProvider}.\n     * Throws an error if a map with the given id already exists or if the map config is invalid.\n     */\n    async createMapModel(mapId: string, options?: MapConfig): Promise<MapModel> {\n        if (this.#destroyed) {\n            throw new Error(\"MapRegistry has already been destroyed.\");\n        }\n        if (this.#entries.has(mapId)) {\n            throw new Error(`Map id '${mapId}' is not unique.`);\n        }\n        if (this.#modelCreationJobs.has(mapId)) {\n            throw new Error(`A map with the id '${mapId}' is already under construction.`);\n        }\n        return await this.#createMapModel(mapId, () => Promise.resolve(options ?? {}));\n    }\n\n    /**\n     * Given a raw OpenLayers map instance, returns the associated {@link MapModel} - or undefined\n     * if the map is unknown to this registry.\n     *\n     * All OpenLayers maps created by this registry (e.g. via {@link MapConfigProvider} or {@link createMapModel}) have an associated map model.\n     */\n    getMapModelByRawInstance(olMap: OlMap): MapModel | undefined {\n        return this.#modelsByOlMap.get(olMap);\n    }\n\n    // Wrapper method to ensure that in-progress construction of maps can be observed.\n    #createMapModel(mapId: string, configProvider: () => Promise<MapConfig>): Promise<MapModel> {\n        const creationJob = this.#modelCreationJobs.get(mapId);\n        if (creationJob) {\n            throw new Error(\"Internal error: a map model is already being created for this mapId\");\n        }\n\n        const modelPromise = this.#createMapModelImpl(mapId, configProvider)\n            .then((mapModel) => {\n                if (this.#destroyed) {\n                    mapModel.destroy();\n                    throw new Error(`MapRegistry has been destroyed.`);\n                }\n\n                const listener = on(\n                    mapModel.destroyed,\n                    () => {\n                        // Allow id reuse for dynamically created maps\n                        if (this.#isDynamic(mapId)) {\n                            const currentEntry = this.#entries.get(mapId);\n                            if (currentEntry === entry) {\n                                this.#entries.delete(mapId);\n                            }\n                        }\n                    },\n                    { dispatch: \"sync\" }\n                );\n\n                const entry: ModelJobResult = { kind: \"model\", model: mapModel, listener };\n                this.#entries.set(mapId, entry);\n                this.#modelCreationJobs.delete(mapId);\n                this.#modelsByOlMap.set(mapModel.olMap, mapModel);\n                return entry;\n            })\n            .catch((cause) => {\n                const error = new Error(`Failed to construct map '${mapId}'`, { cause });\n                const entry: ModelJobResult = { kind: \"error\", error };\n                this.#modelCreationJobs.delete(mapId);\n                if (!this.#isDynamic(mapId)) {\n                    // Don't store errors for dynamically created maps (the caller already got the error via promise).\n                    this.#entries.set(mapId, entry);\n                }\n                return entry;\n            });\n        this.#modelCreationJobs.set(mapId, modelPromise);\n        return waitForResult(modelPromise);\n    }\n\n    async #createMapModelImpl(\n        mapId: string,\n        configProvider: () => Promise<MapConfig>\n    ): Promise<MapModel> {\n        LOG.info(`Creating map with id '${mapId}'`);\n        const mapConfig = await configProvider();\n        const mapModel = await createMapModel(\n            mapId,\n            mapConfig,\n            this.#currentIntl,\n            this.#httpService\n        );\n        return mapModel;\n    }\n\n    #isDynamic(mapId: string): boolean {\n        return !this.#configProviders.has(mapId);\n    }\n}\n\nasync function waitForResult(job: Promise<ModelJobResult>): Promise<MapModel> {\n    return unbox(await job);\n}\n\nfunction unbox(entry: ModelJobResult): MapModel {\n    if (entry.kind === \"error\") {\n        throw entry.error;\n    }\n    return entry.model;\n}\n"],"names":[],"mappings":";;;;;;AAoBA,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAyD1B,MAAM,WAAA,CAA+B;AAAA,EAGxC,YAAA;AAAA,EACA,YAAA;AAAA,EACA,aAAA;AAAA,EAEA,gBAAA,uBAAuB,GAAA,EAA+B;AAAA,EACtD,QAAA,uBAAe,GAAA,EAA4B;AAAA,EAC3C,kBAAA,uBAAyB,GAAA,EAAqC;AAAA,EAC9D,cAAA,uBAAqB,OAAA,EAAyB;AAAA,EAC9C,UAAA,GAAa,KAAA;AAAA,EAEb,WAAA,CAAY,EAAE,UAAA,EAAY,WAAA,EAAY,EAA+B;AACjE,IAAA,IAAA,CAAK,YAAA,GAAe,WAAA;AACpB,IAAA,IAAA,CAAK,eAAe,UAAA,CAAW,WAAA;AAC/B,IAAA,IAAA,CAAK,gBAAgB,UAAA,CAAW,YAAA;AAEhC,IAAA,MAAM,YAAY,UAAA,CAAW,SAAA;AAC7B,IAAA,KAAA,MAAW,YAAY,SAAA,EAAW;AAC9B,MAAA,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,QAAA,CAAS,KAAA,EAAO,QAAQ,CAAA;AAAA,IACtD;AAAA,EACJ;AAAA,EAEA,OAAA,GAAgB;AACZ,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA;AAAA,IACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAA,GAAA,CAAI,MAAM,CAAA,iCAAA,CAAmC,CAAA;AAC7C,MAAA,IAAA,CAAK,UAAA,GAAa,IAAA;AAClB,MAAA,IAAA,CAAK,QAAA,CAAS,OAAA,CAAQ,CAAC,KAAA,KAAU;AAC7B,QAAA,IAAI,KAAA,CAAM,SAAS,OAAA,EAAS;AACxB,UAAA,KAAA,CAAM,SAAS,OAAA,EAAQ;AACvB,UAAA,KAAA,CAAM,MAAM,OAAA,EAAQ;AAAA,QACxB;AAAA,MACJ,CAAC,CAAA;AACD,MAAA,IAAA,CAAK,SAAS,KAAA,EAAM;AACpB,MAAA,IAAA,CAAK,mBAAmB,KAAA,EAAM;AAAA,IAClC,CAAC,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,YAAY,KAAA,EAA8C;AAC5D,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,MAAM,IAAI,MAAM,yCAAyC,CAAA;AAAA,IAC7D;AAEA,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA;AACrC,IAAA,IAAI,KAAA,EAAO;AACP,MAAA,OAAO,MAAM,KAAK,CAAA;AAAA,IACtB;AAEA,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA;AACrD,IAAA,IAAI,WAAA,EAAa;AACb,MAAA,OAAO,MAAM,cAAc,WAAW,CAAA;AAAA,IAC1C;AAEA,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,KAAK,CAAA;AAChD,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA,GAAA,CAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,KAAK,CAAA,EAAA,CAAI,CAAA;AACnE,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,OAAO,MAAM,IAAA,CAAK,eAAA;AAAA,MAAgB,KAAA;AAAA,MAAO,MACrC,SAAS,YAAA,CAAa;AAAA,QAClB,cAAc,IAAA,CAAK;AAAA,OACtB;AAAA,KACL;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,eAAe,KAAA,EAAkC;AACnD,IAAA,MAAM,KAAA,GAAQ,MAAM,IAAA,CAAK,WAAA,CAAY,KAAK,CAAA;AAC1C,IAAA,IAAI,CAAC,KAAA,EAAO;AACR,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,4CAAA,EAA+C,KAAK,CAAA,EAAA,CAAI,CAAA;AAAA,IAC5E;AACA,IAAA,OAAO,KAAA;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,cAAA,CAAe,KAAA,EAAe,OAAA,EAAwC;AACxE,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,MAAM,IAAI,MAAM,yCAAyC,CAAA;AAAA,IAC7D;AACA,IAAA,IAAI,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA,EAAG;AAC1B,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,QAAA,EAAW,KAAK,CAAA,gBAAA,CAAkB,CAAA;AAAA,IACtD;AACA,IAAA,IAAI,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA,EAAG;AACpC,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,KAAK,CAAA,gCAAA,CAAkC,CAAA;AAAA,IACjF;AACA,IAAA,OAAO,MAAM,IAAA,CAAK,eAAA,CAAgB,KAAA,EAAO,MAAM,QAAQ,OAAA,CAAQ,OAAA,IAAW,EAAE,CAAC,CAAA;AAAA,EACjF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,yBAAyB,KAAA,EAAoC;AACzD,IAAA,OAAO,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,KAAK,CAAA;AAAA,EACxC;AAAA;AAAA,EAGA,eAAA,CAAgB,OAAe,cAAA,EAA6D;AACxF,IAAA,MAAM,WAAA,GAAc,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAK,CAAA;AACrD,IAAA,IAAI,WAAA,EAAa;AACb,MAAA,MAAM,IAAI,MAAM,qEAAqE,CAAA;AAAA,IACzF;AAEA,IAAA,MAAM,YAAA,GAAe,KAAK,mBAAA,CAAoB,KAAA,EAAO,cAAc,CAAA,CAC9D,IAAA,CAAK,CAAC,QAAA,KAAa;AAChB,MAAA,IAAI,KAAK,UAAA,EAAY;AACjB,QAAA,QAAA,CAAS,OAAA,EAAQ;AACjB,QAAA,MAAM,IAAI,MAAM,CAAA,+BAAA,CAAiC,CAAA;AAAA,MACrD;AAEA,MAAA,MAAM,QAAA,GAAW,EAAA;AAAA,QACb,QAAA,CAAS,SAAA;AAAA,QACT,MAAM;AAEF,UAAA,IAAI,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AACxB,YAAA,MAAM,YAAA,GAAe,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA;AAC5C,YAAA,IAAI,iBAAiB,KAAA,EAAO;AACxB,cAAA,IAAA,CAAK,QAAA,CAAS,OAAO,KAAK,CAAA;AAAA,YAC9B;AAAA,UACJ;AAAA,QACJ,CAAA;AAAA,QACA,EAAE,UAAU,MAAA;AAAO,OACvB;AAEA,MAAA,MAAM,QAAwB,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAO,UAAU,QAAA,EAAS;AACzE,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAA,EAAO,KAAK,CAAA;AAC9B,MAAA,IAAA,CAAK,kBAAA,CAAmB,OAAO,KAAK,CAAA;AACpC,MAAA,IAAA,CAAK,cAAA,CAAe,GAAA,CAAI,QAAA,CAAS,KAAA,EAAO,QAAQ,CAAA;AAChD,MAAA,OAAO,KAAA;AAAA,IACX,CAAC,CAAA,CACA,KAAA,CAAM,CAAC,KAAA,KAAU;AACd,MAAA,MAAM,KAAA,GAAQ,IAAI,KAAA,CAAM,CAAA,yBAAA,EAA4B,KAAK,CAAA,CAAA,CAAA,EAAK,EAAE,OAAO,CAAA;AACvE,MAAA,MAAM,KAAA,GAAwB,EAAE,IAAA,EAAM,OAAA,EAAS,KAAA,EAAM;AACrD,MAAA,IAAA,CAAK,kBAAA,CAAmB,OAAO,KAAK,CAAA;AACpC,MAAA,IAAI,CAAC,IAAA,CAAK,UAAA,CAAW,KAAK,CAAA,EAAG;AAEzB,QAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,KAAA,EAAO,KAAK,CAAA;AAAA,MAClC;AACA,MAAA,OAAO,KAAA;AAAA,IACX,CAAC,CAAA;AACL,IAAA,IAAA,CAAK,kBAAA,CAAmB,GAAA,CAAI,KAAA,EAAO,YAAY,CAAA;AAC/C,IAAA,OAAO,cAAc,YAAY,CAAA;AAAA,EACrC;AAAA,EAEA,MAAM,mBAAA,CACF,KAAA,EACA,cAAA,EACiB;AACjB,IAAA,GAAA,CAAI,IAAA,CAAK,CAAA,sBAAA,EAAyB,KAAK,CAAA,CAAA,CAAG,CAAA;AAC1C,IAAA,MAAM,SAAA,GAAY,MAAM,cAAA,EAAe;AACvC,IAAA,MAAM,WAAW,MAAM,cAAA;AAAA,MACnB,KAAA;AAAA,MACA,SAAA;AAAA,MACA,IAAA,CAAK,YAAA;AAAA,MACL,IAAA,CAAK;AAAA,KACT;AACA,IAAA,OAAO,QAAA;AAAA,EACX;AAAA,EAEA,WAAW,KAAA,EAAwB;AAC/B,IAAA,OAAO,CAAC,IAAA,CAAK,gBAAA,CAAiB,GAAA,CAAI,KAAK,CAAA;AAAA,EAC3C;AACJ;AAEA,eAAe,cAAc,GAAA,EAAiD;AAC1E,EAAA,OAAO,KAAA,CAAM,MAAM,GAAG,CAAA;AAC1B;AAEA,SAAS,MAAM,KAAA,EAAiC;AAC5C,EAAA,IAAI,KAAA,CAAM,SAAS,OAAA,EAAS;AACxB,IAAA,MAAM,KAAA,CAAM,KAAA;AAAA,EAChB;AACA,EAAA,OAAO,KAAA,CAAM,KAAA;AACjB;;;;"}

package/README.md

@@ -325,7 +325,6 @@ layerFactory.create({
     // Any properties supported by the layer type
     title: "OSM",
     id: "osm",
-    isBaseLayer: true,
     olLayer: new TileLayer({
         source: new OSM()
     })
@@ -348,7 +347,7 @@ import OSM from "ol/source/OSM";
 export class MapConfigProviderImpl implements MapConfigProvider {
     async getMapConfig({ layerFactory }: MapConfigProviderOptions): Promise<MapConfig> {
         return {
-            layers: [
+            baseLayers: [
                 layerFactory.create({
                     // minimal layer configuration
                     type: SimpleLayer,
@@ -356,7 +355,9 @@ export class MapConfigProviderImpl implements MapConfigProvider {
                     olLayer: new TileLayer({
                         source: new OSM()
                     })
-                }),
+                })
+            ],
+            layers: [
                 layerFactory.create({
                     // layer configuration with optional properties
                     type: SimpleLayer,
@@ -369,7 +370,6 @@ export class MapConfigProviderImpl implements MapConfigProvider {
                         foo: "bar"
                     },
                     description: "additional description",
-                    isBaseLayer: false,
                     visible: false
                 })
             ]
@@ -442,7 +442,6 @@ export class MapConfigProviderImpl implements MapConfigProvider {
                     // check layer availability by requesting the provided URL
                     healthCheck:
                         "https://sgx.geodatenzentrum.de/wmts_topplus_open/1.0.0/WMTSCapabilities.xml",
-                    isBaseLayer: false,
                     visible: true
                 }),
                 layerFactory.create({
@@ -461,7 +460,6 @@ export class MapConfigProviderImpl implements MapConfigProvider {
                         await wait(3000);
                         return "error";
                     },
-                    isBaseLayer: false,
                     visible: false
                 })
             ]
@@ -604,12 +602,11 @@ export class MapConfigProviderImpl implements MapConfigProvider {
                 zoom: 14
             },
             projection: "EPSG:31466",
-            layers: [
+            baseLayers: [
                 layerFactory.create({
                     type: SimpleLayer,
                     id: "topplus_open",
                     title: "TopPlus Open",
-                    isBaseLayer: true,
                     visible: true,
                     olLayer: new TileLayer({
                         source: createWMTSSource("web")

package/layers/AbstractLayer.d.ts

@@ -1,8 +1,9 @@
 import OlBaseLayer from "ol/layer/Base";
+import OlSource from "ol/source/Source";
 import { MapModel } from "../model/MapModel";
 import { InternalConstructorTag } from "../utils/InternalConstructorTag";
 import { AbstractLayerBase } from "./AbstractLayerBase";
-import { ATTACH_TO_MAP, GET_DEPS, LayerDependencies, SET_VISIBLE } from "./shared/internals";
+import { ATTACH_TO_MAP, DECLARED_AS_BASE_LAYER, GET_DEPS, LayerDependencies, SET_METADATA_LOAD_INFO, SET_VISIBLE } from "./shared/internals";
 import { SimpleLayerConfig } from "./SimpleLayer";
 import { LayerTypes } from "./unions";
 /**
@@ -11,6 +12,15 @@ import { LayerTypes } from "./unions";
  * @group Layer Utilities
  **/
 export type LayerLoadState = "not-loaded" | "loading" | "loaded" | "error";
+/**
+ * Load state of a single layer, bundling the state with its error.
+ *
+ * @internal
+ */
+export type LayerLoadInfo = "not-loaded" | "loading" | "loaded" | {
+    kind: "error";
+    error: Error;
+};
 /**
  * Represents an operational layer in the map.
  *
@@ -23,7 +33,10 @@ export type LayerLoadState = "not-loaded" | "loading" | "loaded" | "error";
  */
 export declare abstract class AbstractLayer extends AbstractLayerBase {
     #private;
-    constructor(config: SimpleLayerConfig, deps?: LayerDependencies, internalTag?: InternalConstructorTag);
+    constructor(config: SimpleLayerConfig & {
+        /** The initial load state (default: not-loaded). */
+        initialLoadInfo?: LayerLoadInfo;
+    }, deps?: LayerDependencies, internalTag?: InternalConstructorTag);
     destroy(): void;
     /**
      * Identifies the type of this layer.
@@ -34,6 +47,10 @@ export declare abstract class AbstractLayer extends AbstractLayerBase {
      * The raw OpenLayers layer.
      */
     get olLayer(): OlBaseLayer;
+    /**
+     * The current source of the {@link olLayer}.
+     */
+    get olSource(): OlSource | undefined;
     /**
      * True if this layer is a base layer.
      *
@@ -41,9 +58,19 @@ export declare abstract class AbstractLayer extends AbstractLayerBase {
      */
     get isBaseLayer(): boolean;
     /**
-     * The load state of a layer.
+     * The combined load state of a layer.
+     *
+     * Aggregates the OpenLayers source state, health check and metadata state.
+     * Priority for the state: `error` > `loading` > `not-loaded` > `loaded`.
      */
     get loadState(): LayerLoadState;
+    /**
+     * The error (if any) that prevented this layer from loading.
+     *
+     * Combines errors from the OpenLayers source, the health check and the
+     * metadata request (health > metadata > source).
+     */
+    get loadError(): Error | undefined;
     /**
      * The minimum resolution (inclusive) at which this layer will be visible.
      */
@@ -86,9 +113,20 @@ export declare abstract class AbstractLayer extends AbstractLayerBase {
      * @internal
      */
     [ATTACH_TO_MAP](map: MapModel): void;
+    /**
+     * Updates the load state of the layer's metadata request.
+     *
+     * @internal
+     */
+    [SET_METADATA_LOAD_INFO](loadInfo: LayerLoadInfo): void;
     setVisible(newVisibility: boolean): void;
     /** @internal */
     [SET_VISIBLE](newVisibility: boolean): void;
     /** @internal */
     [GET_DEPS](): LayerDependencies;
+    /**
+     * Always returns original, configured `isBaseLayer` value from LayerConfig instead of computed value from `get isBaseLayer()`
+     *
+     * @internal */
+    get [DECLARED_AS_BASE_LAYER](): boolean | undefined;
 }

package/layers/AbstractLayer.js

@@ -1,10 +1,10 @@
-import { synchronized, reactive, computed } from '@conterra/reactivity-core';
-import { createLogger, destroyResource } from '@open-pioneer/core';
+import { computed, synchronized, reactive, constant } from '@conterra/reactivity-core';
+import { createLogger } from '@open-pioneer/core';
 import OlLayer from 'ol/layer/Layer.js';
 import { unByKey } from 'ol/Observable.js';
 import { sourceId } from '../_virtual/source-info.js';
 import { AbstractLayerBase } from './AbstractLayerBase.js';
-import { getLayerDependencies, SET_VISIBLE, ATTACH_TO_MAP, GET_DEPS, LAYER_DEPS } from './shared/internals.js';
+import { getLayerDependencies, SET_VISIBLE, ATTACH_TO_MAP, SET_METADATA_LOAD_INFO, GET_DEPS, LAYER_DEPS, DECLARED_AS_BASE_LAYER } from './shared/internals.js';
 
 const LOG = createLogger(sourceId);
 class AbstractLayer extends AbstractLayerBase {
@@ -13,22 +13,37 @@ class AbstractLayer extends AbstractLayerBase {
   // from the map, once connected).
   #deps;
   #olLayer;
-  #isBaseLayer;
+  #olSource;
+  #declaredAsBaseLayer;
+  //original value from LayerConfig, only used internally
   #healthCheck;
+  #isBaseLayer;
   #visible;
   #minResolution;
   #maxResolution;
   #minZoom;
   #maxZoom;
-  #loadState;
-  #stateWatchResource;
+  #sourceState;
+  #sourceInfo;
+  #healthInfo;
+  #healthCheckStarted = false;
+  #metadataInfo;
+  #loadInfo = computed(
+    () => combineLoadInfos(this.#sourceInfo.value, this.#healthInfo.value, this.#metadataInfo.value)
+  );
   #visibleInScale;
   constructor(config, deps, internalTag) {
     super(config);
     this.#deps = getLayerDependencies(deps, internalTag);
     this.#olLayer = config.olLayer;
-    this.#isBaseLayer = config.isBaseLayer ?? false;
+    this.#olSource = synchronizedOlSource(this.#olLayer);
+    this.#declaredAsBaseLayer = config.isBaseLayer;
     this.#healthCheck = config.healthCheck;
+    this.#isBaseLayer = computed(() => {
+      const effective = this.nullableMap?.layers.getBaseLayers().includes(this);
+      const declared = this.#declaredAsBaseLayer;
+      return effective || declared || false;
+    });
     this.#visible = synchronized(
       () => this.#olLayer.getVisible(),
       (cb) => {
@@ -64,7 +79,22 @@ class AbstractLayer extends AbstractLayerBase {
         return () => unByKey(key);
       }
     );
-    this.#loadState = reactive(getSourceState(getSource(this.#olLayer)));
+    this.#sourceState = computed(() => {
+      const olSource = this.olSource;
+      if (!olSource) {
+        return void 0;
+      }
+      return synchronized(
+        () => getSourceState(olSource),
+        (cb) => {
+          const key = olSource.on("change", cb);
+          return () => unByKey(key);
+        }
+      );
+    });
+    this.#sourceInfo = computed(() => makeSourceInfo(this.id, this.#sourceState.value?.value));
+    this.#healthInfo = reactive("not-loaded");
+    this.#metadataInfo = reactive(config.initialLoadInfo ?? "not-loaded");
     this[SET_VISIBLE](config.visible ?? true);
     this.#visibleInScale = computed(() => {
       const map = this.nullableMap;
@@ -102,7 +132,6 @@ class AbstractLayer extends AbstractLayerBase {
     if (this.isDestroyed) {
       return;
     }
-    this.#stateWatchResource = destroyResource(this.#stateWatchResource);
     this.olLayer.dispose();
     super.destroy();
   }
@@ -115,19 +144,37 @@ class AbstractLayer extends AbstractLayerBase {
   get olLayer() {
     return this.#olLayer;
   }
+  /**
+   * The current source of the {@link olLayer}.
+   */
+  get olSource() {
+    return this.#olSource.value;
+  }
   /**
    * True if this layer is a base layer.
    *
    * Only one base layer can be visible at a time.
    */
   get isBaseLayer() {
-    return this.#isBaseLayer;
+    return this.#isBaseLayer.value;
   }
   /**
-   * The load state of a layer.
+   * The combined load state of a layer.
+   *
+   * Aggregates the OpenLayers source state, health check and metadata state.
+   * Priority for the state: `error` > `loading` > `not-loaded` > `loaded`.
    */
   get loadState() {
-    return this.#loadState.value;
+    return loadInfoState(this.#loadInfo.value);
+  }
+  /**
+   * The error (if any) that prevented this layer from loading.
+   *
+   * Combines errors from the OpenLayers source, the health check and the
+   * metadata request (health > metadata > source).
+   */
+  get loadError() {
+    return errorOf(this.#loadInfo.value);
   }
   /**
    * The minimum resolution (inclusive) at which this layer will be visible.
@@ -190,18 +237,21 @@ class AbstractLayer extends AbstractLayerBase {
    */
   [ATTACH_TO_MAP](map) {
     super[ATTACH_TO_MAP](map);
-    if (!this.#stateWatchResource) {
-      const { initial: initialState, resource: stateWatchResource } = watchLoadState(
-        this,
-        this.#healthCheck,
-        (state) => {
-          this.#loadState.value = state;
-        }
-      );
-      this.#stateWatchResource = stateWatchResource;
-      this.#loadState.value = initialState;
+    if (!this.#healthCheckStarted && errorOf(this.#sourceInfo.value) == null) {
+      this.#healthCheckStarted = true;
+      doHealthCheck(this, this.#healthCheck).then((loadInfo) => {
+        this.#healthInfo.value = loadInfo;
+      });
     }
   }
+  /**
+   * Updates the load state of the layer's metadata request.
+   *
+   * @internal
+   */
+  [SET_METADATA_LOAD_INFO](loadInfo) {
+    this.#metadataInfo.value = loadInfo;
+  }
   setVisible(newVisibility) {
     if (this.isBaseLayer) {
       LOG.warn(
@@ -232,58 +282,13 @@ class AbstractLayer extends AbstractLayerBase {
             + "Use the LayerFactory to create an instance or add the layer to the map first.`
     );
   }
-}
-function watchLoadState(layer, healthCheck, onChange) {
-  const olLayer = layer.olLayer;
-  if (!(olLayer instanceof OlLayer)) {
-    return {
-      initial: "loaded",
-      resource: {
-        destroy() {
-        }
-      }
-    };
-  }
-  let currentSource = getSource(olLayer);
-  const currentOlLayerState = getSourceState(currentSource);
-  let currentLoadState = currentOlLayerState;
-  let currentHealthState = "loading";
-  if (currentOlLayerState !== "error") {
-    doHealthCheck(layer, healthCheck).then((state) => {
-      currentHealthState = state;
-      updateState();
-    });
+  /**
+   * Always returns original, configured `isBaseLayer` value from LayerConfig instead of computed value from `get isBaseLayer()`
+   *
+   * @internal */
+  get [DECLARED_AS_BASE_LAYER]() {
+    return this.#declaredAsBaseLayer;
   }
-  const updateState = () => {
-    const olLayerState = getSourceState(currentSource);
-    const nextLoadState = currentHealthState === "error" ? "error" : olLayerState;
-    if (currentLoadState !== nextLoadState) {
-      currentLoadState = nextLoadState;
-      onChange(currentLoadState);
-    }
-  };
-  let stateHandle;
-  stateHandle = currentSource?.on("change", () => {
-    updateState();
-  });
-  const sourceHandle = olLayer.on("change:source", () => {
-    stateHandle && unByKey(stateHandle);
-    stateHandle = void 0;
-    currentSource = getSource(olLayer);
-    stateHandle = currentSource?.on("change", () => {
-      updateState();
-    });
-    updateState();
-  });
-  return {
-    initial: currentLoadState,
-    resource: {
-      destroy() {
-        stateHandle && unByKey(stateHandle);
-        unByKey(sourceHandle);
-      }
-    }
-  };
 }
 async function doHealthCheck(layer, healthCheck) {
   if (healthCheck == null) {
@@ -309,23 +314,76 @@ async function doHealthCheck(layer, healthCheck) {
       `Unexpected object for 'healthCheck' parameter of layer '${layer.id}'`,
       healthCheck
     );
-    return "error";
+    return {
+      kind: "error",
+      error: new Error(`Invalid 'healthCheck' configuration for layer '${layer.id}'`)
+    };
   }
   try {
-    return await healthCheckFn(layer);
+    const state = await healthCheckFn(layer);
+    if (state === "error") {
+      return {
+        kind: "error",
+        error: new Error(`Health check failed for layer '${layer.id}'`)
+      };
+    }
+    return state;
   } catch (e) {
     LOG.warn(`Health check failed for layer '${layer.id}'`, e);
-    return "error";
+    return {
+      kind: "error",
+      error: e instanceof Error ? e : new Error(String(e))
+    };
+  }
+}
+const LOAD_STATE_SEVERITY = {
+  "not-loaded": 0,
+  loaded: 1,
+  loading: 2,
+  error: 3
+};
+function higherSeverity(a, b) {
+  return LOAD_STATE_SEVERITY[a] >= LOAD_STATE_SEVERITY[b] ? a : b;
+}
+function combineLoadInfos(source, health, metadata) {
+  const error = errorOf(health) ?? errorOf(metadata) ?? errorOf(source);
+  if (error) {
+    return { kind: "error", error };
   }
+  return higherSeverity(loadInfoState(source), loadInfoState(metadata));
 }
-function getSource(olLayer) {
-  if (!(olLayer instanceof OlLayer)) {
-    return void 0;
+function errorOf(info) {
+  return typeof info === "object" ? info.error : void 0;
+}
+function loadInfoState(info) {
+  return typeof info === "object" ? "error" : info;
+}
+function makeSourceInfo(id, state) {
+  if (state == null) {
+    return "loaded";
   }
-  return olLayer?.getSource() ?? void 0;
+  if (state === "error") {
+    return {
+      kind: "error",
+      error: new Error(`Source of layer '${id}' is in error state`)
+    };
+  }
+  return state;
+}
+function synchronizedOlSource(layer) {
+  if (!(layer instanceof OlLayer)) {
+    return constant(void 0);
+  }
+  return synchronized(
+    () => layer.getSource() ?? void 0,
+    (cb) => {
+      const key = layer.on("change:source", cb);
+      return () => unByKey(key);
+    }
+  );
 }
 function getSourceState(olSource) {
-  const state = olSource?.getState();
+  const state = olSource.getState();
   switch (state) {
     case void 0:
       return "loaded";