@open-pioneer/map-test-utils 1.5.0-dev.20260911123645 → 1.5.0-dev.20260917081843

package/CHANGELOG.md

@@ -1,10 +1,17 @@
 # @open-pioneer/map-test-utils
 
-## 1.5.0-dev.20260911123645
+## 1.5.0-dev.20260917081843
 
 ### Minor Changes
 
 - f790fda: Update to Chakra 3.37.0
+- 0d9a9d0: The map initialization has been adjusted to fix the map view initialization if initial view is configured with extent.
+  This change affects the order and timing of the map's initialization.
+
+  The timing changes might affect early map interactions or tests:
+  To wait until the map is actually being rendered (and thus fully initialized), you can use the map model's existing `whenDisplayed()` method.
+  The new test helper function `waitForMapRender` is provided from (`@open-pioneer/map-test-utils`) to wait in tests for the map view to be completely initialized.
+
 - ebda251: Add new properties for topmost layers and base layers in `MapConfig`.
 
   - With `MapConfig.topmostLayers` topmost layers can now be defined in the initial map setup.
@@ -41,6 +48,7 @@
 ### Patch Changes
 
 - 09ec7c7: Updated dependencies
+- 0d9a9d0: Do not mock layer rendering when vitest browser mode is detected.
 
 ## 1.4.0
 

package/index.d.ts

@@ -58,7 +58,18 @@ export interface SimpleMapOptions {
      * Use `false` to test the async loading behavior of the registry.
      */
     returnMap?: boolean;
+    /**
+     * If true, the map is rendered in a dummy div instead of the real OpenLayers canvas.
+     * This is useful for tests that need the map's view to be initialized, but don't need to actually render the map.
+     *
+     * False by default.
+     */
+    mockMapRender?: boolean;
 }
+/**
+ * Waits until the OpenLayers map is initialized/displayed and is visible in the DOM.
+ */
+export declare function waitForMapRender(map: MapModel): Promise<void>;
 /**
  * Waits until the OpenLayers map has been mounted in the parent with the given id.
  */
@@ -82,13 +93,31 @@ export interface SetupMapResult {
  */
 export declare function setupMap(options?: SimpleMapOptions & {
     returnMap?: true;
+    mockMapRender?: boolean;
 }): Promise<SetupMapResult & {
     map: MapModel;
 }>;
 export declare function setupMap(options?: SimpleMapOptions): Promise<SetupMapResult>;
+/**
+ * Renders an OL map into a pseudo (non-visible) div so the map's view gets initialized.
+ */
+export declare function mockMapRender(map: MapModel): void;
 /** Creates an new layer of the specified type for testing. */
 export declare function createTestLayer<LayerType extends Layer, Config extends MapPackageLayerConfig>(config: LayerCreateOptions<LayerType, Config>, mapOptions?: Pick<SimpleMapOptions, "fetch">): LayerType;
-/** Creates a new, basic SimpleLayer for testing. */
+/**
+ *
+ * Creates a new, basic SimpleLayer for testing.
+ *
+ * For example:
+ *
+ * ```ts
+ * const layer1 = createTestLayer();
+ * const layer2 = createTestLayer({
+ *   title: "My test layer",
+ *   olLayer: ...
+ * })
+ * ```
+ **/
 export declare function createTestLayer(config?: SimpleLayerConfig, mapOptions?: Pick<SimpleMapOptions, "fetch">): SimpleLayer;
 /**
  * Returns a simple, empty OpenLayers layer object.

package/index.js

@@ -14,6 +14,15 @@ const DUMMY_HTTP_SERVICE = {
   }
 };
 const DUMMY_LAYER_FACTORY = createLayerFactory();
+async function waitForMapRender(map) {
+  await map.whenDisplayed();
+  await waitFor(async () => {
+    const container = map.container?.querySelector(".ol-viewport");
+    if (!container) {
+      throw new Error("map not mounted");
+    }
+  });
+}
 async function waitForMapMount(parentTestId = "base") {
   return await waitFor(async () => {
     const domElement = await screen.findByTestId(parentTestId);
@@ -78,13 +87,24 @@ async function setupMap(options) {
   });
   let map;
   const promise = registry.createMapModel(mapId, mapConfig);
-  if (options?.returnMap !== false) {
+  if (options?.returnMap !== false || options?.mockMapRender) {
     map = await promise;
+    if (options?.mockMapRender) {
+      mockMapRender(map);
+    }
   } else {
     promise.catch(() => void 0);
   }
   return { mapId, registry, layerFactory, map };
 }
+function mockMapRender(map) {
+  const dummyContainer = document.createElement("div");
+  dummyContainer.style.width = "100px";
+  dummyContainer.style.height = "100px";
+  dummyContainer.setAttribute("data-testid", "map");
+  document.body.appendChild(dummyContainer);
+  map.olMap.setTarget(dummyContainer);
+}
 function getInitialView(options) {
   if (options?.extent) {
     return {
@@ -129,16 +149,21 @@ function createLayerFactory(httpService) {
     referencesMeta: { httpService: { serviceId: "http.HttpService" } }
   });
 }
-function mockVectorLayer() {
+function mockLayers() {
   const div = document.createElement("div");
   VectorLayer.prototype.render = () => {
     return div;
   };
+  TileLayer.prototype.render = () => {
+    return div;
+  };
 }
 function useOrCreateLayer(config) {
   return "map" in config ? config : createTestLayer({ type: SimpleLayer, ...config });
 }
-mockVectorLayer();
+if (!globalThis.__vitest_browser__) {
+  mockLayers();
+}
 
-export { createServiceOptions, createTestLayer, createTestOlLayer, setupMap, waitForInitialExtent, waitForMapMount };
+export { createServiceOptions, createTestLayer, createTestOlLayer, mockMapRender, setupMap, waitForInitialExtent, waitForMapMount, waitForMapRender };
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { constant, watch } from \"@conterra/reactivity-core\";\nimport { HttpService, HttpServiceRequestInit } from \"@open-pioneer/http\";\nimport {\n    ExtentConfig,\n    InitialViewConfig,\n    Layer,\n    LayerCreateOptions,\n    LayerFactory,\n    MapConfig,\n    MapModel,\n    LayerConfig as MapPackageLayerConfig,\n    MapRegistry,\n    OlMapOptions,\n    SimpleLayer,\n    SimpleLayerConfig\n} from \"@open-pioneer/map\";\nimport {\n    LayerFactory as LayerFactoryImpl,\n    MapRegistry as MapRegistryImpl\n} from \"@open-pioneer/map/internalTestSupport\";\nimport { PackageIntl } from \"@open-pioneer/runtime\";\nimport { createService } from \"@open-pioneer/test-utils/services\";\nimport { screen, waitFor } from \"@testing-library/react\";\nimport TileLayer from \"ol/layer/Tile\";\nimport VectorLayer from \"ol/layer/Vector\";\n\nexport type LayerConfig = SimpleLayerConfig | Layer;\n\nexport interface SimpleMapOptions {\n    /** ID of the map.\n     * Defaults to \"test\". */\n    mapId?: string;\n\n    /** Center coordinates for the map. */\n    center?: { x: number; y: number };\n\n    /** Zoom level of the map. */\n    zoom?: number;\n\n    /**\n     * Initial extent (don't mix with center / zoom).\n     */\n    extent?: ExtentConfig;\n\n    /**\n     * The map's projection.\n     */\n    projection?: string;\n\n    /**\n     * Layers used by the map.\n     */\n    layers?: LayerConfig[];\n\n    /**\n     * Base layers for the map.\n     */\n    baseLayers?: LayerConfig[];\n\n    /**\n     * Layers that are displayed on top of all other layers.\n     */\n    topmostLayers?: LayerConfig[];\n\n    /** See {@link MapConfig.showAttributions} */\n    showAttributions?: boolean;\n\n    /**\n     * Overrides fetching of network resources (such as service capabilities).\n     */\n    fetch?: (resource: URL, init: HttpServiceRequestInit | undefined) => Promise<Response>;\n\n    /**\n     * Passed to the open layers map constructor.\n     */\n    advanced?: OlMapOptions;\n\n    /**\n     * Disables the initial view when set to true.\n     */\n    noInitialView?: boolean;\n\n    /**\n     * Disables the default projection when set to true.\n     */\n    noProjection?: boolean;\n\n    /**\n     * Also returns the map object in the return value.\n     * True by default.\n     *\n     * Use `false` to test the async loading behavior of the registry.\n     */\n    returnMap?: boolean;\n}\nconst DUMMY_HTTP_SERVICE = {\n    async fetch() {\n        throw new Error(\n            \"Network requests are not implemented (override fetch via map test utils if your test requires network access).\"\n        );\n    }\n} satisfies Partial<HttpService> as HttpService;\nconst DUMMY_LAYER_FACTORY = createLayerFactory();\n\n/**\n * Waits until the OpenLayers map has been mounted in the parent with the given id.\n */\nexport async function waitForMapMount(parentTestId = \"base\") {\n    return await waitFor(async () => {\n        const domElement = await screen.findByTestId(parentTestId);\n        const container = domElement.querySelector(\".ol-viewport\");\n        if (!container) {\n            throw new Error(\"map not mounted\");\n        }\n        return domElement;\n    });\n}\n\n/**\n * Waits until the model has an initial extent.\n */\nexport async function waitForInitialExtent(model: MapModel) {\n    if (model.initialExtent) {\n        return;\n    }\n\n    await new Promise<void>((resolve, reject) => {\n        const resource = watch(\n            () => [model.initialExtent],\n            ([extent]) => {\n                resource.destroy();\n                if (extent) {\n                    resolve();\n                } else {\n                    reject(new Error(\"Expected a valid initial extent\"));\n                }\n            }\n        );\n    });\n}\n\nexport interface SetupMapResult {\n    mapId: string;\n    registry: MapRegistry;\n    layerFactory: LayerFactory;\n}\n\n/**\n * Creates a simple map registry service with exactly one map configuration.\n *\n * The map is configured by using the `options` parameter.\n * If `options.returnMap` is `true` (the default), the map model is also returned.\n *\n * Returns the map registry and the id of the configured map.\n */\nexport async function setupMap(\n    options?: SimpleMapOptions & { returnMap?: true }\n): Promise<SetupMapResult & { map: MapModel }>;\nexport async function setupMap(options?: SimpleMapOptions): Promise<SetupMapResult>;\nexport async function setupMap(\n    options?: SimpleMapOptions\n): Promise<SetupMapResult & { map: MapModel | undefined }> {\n    const mapId = options?.mapId ?? \"test\";\n    const mapConfig: MapConfig = {\n        initialView: options?.noInitialView ? undefined : getInitialView(options),\n        projection: options?.noProjection ? undefined : (options?.projection ?? \"EPSG:3857\"),\n        layers: options?.layers?.map((config) => useOrCreateLayer(config)) ?? [createTestLayer()],\n        baseLayers: options?.baseLayers?.map((config) => useOrCreateLayer(config)) ?? [],\n        topmostLayers: options?.topmostLayers?.map((config) => useOrCreateLayer(config)) ?? [],\n        showAttributions: options?.showAttributions,\n        advanced: options?.advanced\n    };\n\n    const httpService = {\n        async fetch(resource, init) {\n            if (options?.fetch) {\n                const url = new URL(resource, \"http://localhost:1234\");\n                return options.fetch(url, init);\n            }\n            throw new Error(\n                \"Network requests are not implemented (override fetch via map test utils if your test requires network access).\"\n            );\n        }\n    } satisfies Partial<HttpService> as HttpService;\n\n    const layerFactory = await createService(LayerFactoryImpl, {\n        references: {\n            httpService\n        }\n    });\n\n    const registry = await createService(MapRegistryImpl, {\n        references: {\n            providers: [],\n            httpService,\n            layerFactory\n        }\n    });\n\n    let map: MapModel | undefined;\n    const promise = registry.createMapModel(mapId, mapConfig);\n    if (options?.returnMap !== false) {\n        map = await promise;\n    } else {\n        // Ignore error on this promise (prevents unhandled error in tests)\n        promise.catch(() => undefined);\n    }\n    return { mapId, registry, layerFactory, map };\n}\n\nfunction getInitialView(options: SimpleMapOptions | undefined): InitialViewConfig {\n    if (options?.extent) {\n        return {\n            kind: \"extent\",\n            extent: options.extent\n        };\n    }\n    return {\n        kind: \"position\",\n        center: options?.center ?? { x: 847541, y: 6793584 },\n        zoom: options?.zoom ?? 10\n    };\n}\n\n/** Creates an new layer of the specified type for testing. */\nexport function createTestLayer<LayerType extends Layer, Config extends MapPackageLayerConfig>(\n    config: LayerCreateOptions<LayerType, Config>,\n    mapOptions?: Pick<SimpleMapOptions, \"fetch\">\n): LayerType;\n\n/** Creates a new, basic SimpleLayer for testing. */\nexport function createTestLayer(\n    config?: SimpleLayerConfig,\n    mapOptions?: Pick<SimpleMapOptions, \"fetch\">\n): SimpleLayer;\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport function createTestLayer(config?: any, mapOptions?: Pick<SimpleMapOptions, \"fetch\">): Layer {\n    // Basic case: If no config is given, use SimpleLayer\n    if (!config) {\n        config = {\n            type: SimpleLayer,\n            title: \"Test layer\",\n            olLayer: new VectorLayer()\n        } as LayerCreateOptions<SimpleLayer, SimpleLayerConfig>;\n    } else if (!config.type) {\n        config.type = SimpleLayer;\n    }\n\n    const factory = mapOptions?.fetch\n        ? createLayerFactory({ fetch: mapOptions.fetch })\n        : DUMMY_LAYER_FACTORY;\n    return factory.create(config);\n}\n\n/**\n * Returns a simple, empty OpenLayers layer object.\n *\n * Use this if you need any kind of `olLayer` in your test.\n */\nexport function createTestOlLayer(): TileLayer {\n    return new TileLayer();\n}\n\n/**\n * Creates (service name, service implementation)-pairs suitable for the `services`\n * option of the `PackageContextProvider`.\n *\n * This helper method can be used to avoid hard-coding service names used in the implementation.\n *\n * @deprecated This function is no longer needed, since most widgets no longer depend on the registry\n * and accept the `map` directly.\n */\nexport function createServiceOptions(services: { registry: MapRegistry }): Record<string, unknown> {\n    return {\n        \"map.MapRegistry\": services.registry\n    };\n}\n\nfunction createLayerFactory(httpService?: HttpService): LayerFactory {\n    const intl = {} satisfies Partial<PackageIntl> as PackageIntl;\n    return new LayerFactoryImpl({\n        intl,\n        currentIntl: constant(intl),\n        references: { httpService: httpService ?? DUMMY_HTTP_SERVICE },\n        properties: {},\n        referencesMeta: { httpService: { serviceId: \"http.HttpService\" } }\n    });\n}\n\nfunction mockVectorLayer() {\n    // Overwrite render so it doesn't actually do anything during tests.\n    // Would otherwise error because <canvas /> is not fully implemented in happy dom.\n    const div = document.createElement(\"div\");\n    VectorLayer.prototype.render = () => {\n        return div;\n    };\n}\n\nfunction useOrCreateLayer(config: LayerConfig): Layer {\n    return \"map\" in config\n        ? config\n        : createTestLayer({ type: SimpleLayer, ...(config as SimpleLayerConfig) });\n    // using map as discriminator (no prototype for Layer)\n}\n\nmockVectorLayer();\n"],"names":["LayerFactoryImpl","MapRegistryImpl"],"mappings":";;;;;;;;AAkGA,MAAM,kBAAA,GAAqB;AAAA,EACvB,MAAM,KAAA,GAAQ;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACN;AAAA,KACJ;AAAA,EACJ;AACJ,CAAA;AACA,MAAM,sBAAsB,kBAAA,EAAmB;AAK/C,eAAsB,eAAA,CAAgB,eAAe,MAAA,EAAQ;AACzD,EAAA,OAAO,MAAM,QAAQ,YAAY;AAC7B,IAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,YAAA,CAAa,YAAY,CAAA;AACzD,IAAA,MAAM,SAAA,GAAY,UAAA,CAAW,aAAA,CAAc,cAAc,CAAA;AACzD,IAAA,IAAI,CAAC,SAAA,EAAW;AACZ,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACrC;AACA,IAAA,OAAO,UAAA;AAAA,EACX,CAAC,CAAA;AACL;AAKA,eAAsB,qBAAqB,KAAA,EAAiB;AACxD,EAAA,IAAI,MAAM,aAAA,EAAe;AACrB,IAAA;AAAA,EACJ;AAEA,EAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAA,KAAW;AACzC,IAAA,MAAM,QAAA,GAAW,KAAA;AAAA,MACb,MAAM,CAAC,KAAA,CAAM,aAAa,CAAA;AAAA,MAC1B,CAAC,CAAC,MAAM,CAAA,KAAM;AACV,QAAA,QAAA,CAAS,OAAA,EAAQ;AACjB,QAAA,IAAI,MAAA,EAAQ;AACR,UAAA,OAAA,EAAQ;AAAA,QACZ,CAAA,MAAO;AACH,UAAA,MAAA,CAAO,IAAI,KAAA,CAAM,iCAAiC,CAAC,CAAA;AAAA,QACvD;AAAA,MACJ;AAAA,KACJ;AAAA,EACJ,CAAC,CAAA;AACL;AAoBA,eAAsB,SAClB,OAAA,EACuD;AACvD,EAAA,MAAM,KAAA,GAAQ,SAAS,KAAA,IAAS,MAAA;AAChC,EAAA,MAAM,SAAA,GAAuB;AAAA,IACzB,WAAA,EAAa,OAAA,EAAS,aAAA,GAAgB,MAAA,GAAY,eAAe,OAAO,CAAA;AAAA,IACxE,UAAA,EAAY,OAAA,EAAS,YAAA,GAAe,MAAA,GAAa,SAAS,UAAA,IAAc,WAAA;AAAA,IACxE,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,GAAA,CAAI,CAAC,MAAA,KAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,CAAC,eAAA,EAAiB,CAAA;AAAA,IACxF,UAAA,EAAY,OAAA,EAAS,UAAA,EAAY,GAAA,CAAI,CAAC,WAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,EAAC;AAAA,IAC/E,aAAA,EAAe,OAAA,EAAS,aAAA,EAAe,GAAA,CAAI,CAAC,WAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,EAAC;AAAA,IACrF,kBAAkB,OAAA,EAAS,gBAAA;AAAA,IAC3B,UAAU,OAAA,EAAS;AAAA,GACvB;AAEA,EAAA,MAAM,WAAA,GAAc;AAAA,IAChB,MAAM,KAAA,CAAM,QAAA,EAAU,IAAA,EAAM;AACxB,MAAA,IAAI,SAAS,KAAA,EAAO;AAChB,QAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,QAAA,EAAU,uBAAuB,CAAA;AACrD,QAAA,OAAO,OAAA,CAAQ,KAAA,CAAM,GAAA,EAAK,IAAI,CAAA;AAAA,MAClC;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACN;AAAA,OACJ;AAAA,IACJ;AAAA,GACJ;AAEA,EAAA,MAAM,YAAA,GAAe,MAAM,aAAA,CAAcA,YAAA,EAAkB;AAAA,IACvD,UAAA,EAAY;AAAA,MACR;AAAA;AACJ,GACH,CAAA;AAED,EAAA,MAAM,QAAA,GAAW,MAAM,aAAA,CAAcC,WAAA,EAAiB;AAAA,IAClD,UAAA,EAAY;AAAA,MACR,WAAW,EAAC;AAAA,MACZ,WAAA;AAAA,MACA;AAAA;AACJ,GACH,CAAA;AAED,EAAA,IAAI,GAAA;AACJ,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,cAAA,CAAe,KAAA,EAAO,SAAS,CAAA;AACxD,EAAA,IAAI,OAAA,EAAS,cAAc,KAAA,EAAO;AAC9B,IAAA,GAAA,GAAM,MAAM,OAAA;AAAA,EAChB,CAAA,MAAO;AAEH,IAAA,OAAA,CAAQ,KAAA,CAAM,MAAM,MAAS,CAAA;AAAA,EACjC;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,QAAA,EAAU,YAAA,EAAc,GAAA,EAAI;AAChD;AAEA,SAAS,eAAe,OAAA,EAA0D;AAC9E,EAAA,IAAI,SAAS,MAAA,EAAQ;AACjB,IAAA,OAAO;AAAA,MACH,IAAA,EAAM,QAAA;AAAA,MACN,QAAQ,OAAA,CAAQ;AAAA,KACpB;AAAA,EACJ;AACA,EAAA,OAAO;AAAA,IACH,IAAA,EAAM,UAAA;AAAA,IACN,QAAQ,OAAA,EAAS,MAAA,IAAU,EAAE,CAAA,EAAG,MAAA,EAAQ,GAAG,OAAA,EAAQ;AAAA,IACnD,IAAA,EAAM,SAAS,IAAA,IAAQ;AAAA,GAC3B;AACJ;AAeO,SAAS,eAAA,CAAgB,QAAc,UAAA,EAAqD;AAE/F,EAAA,IAAI,CAAC,MAAA,EAAQ;AACT,IAAA,MAAA,GAAS;AAAA,MACL,IAAA,EAAM,WAAA;AAAA,MACN,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,IAAI,WAAA;AAAY,KAC7B;AAAA,EACJ,CAAA,MAAA,IAAW,CAAC,MAAA,CAAO,IAAA,EAAM;AACrB,IAAA,MAAA,CAAO,IAAA,GAAO,WAAA;AAAA,EAClB;AAEA,EAAA,MAAM,OAAA,GAAU,YAAY,KAAA,GACtB,kBAAA,CAAmB,EAAE,KAAA,EAAO,UAAA,CAAW,KAAA,EAAO,CAAA,GAC9C,mBAAA;AACN,EAAA,OAAO,OAAA,CAAQ,OAAO,MAAM,CAAA;AAChC;AAOO,SAAS,iBAAA,GAA+B;AAC3C,EAAA,OAAO,IAAI,SAAA,EAAU;AACzB;AAWO,SAAS,qBAAqB,QAAA,EAA8D;AAC/F,EAAA,OAAO;AAAA,IACH,mBAAmB,QAAA,CAAS;AAAA,GAChC;AACJ;AAEA,SAAS,mBAAmB,WAAA,EAAyC;AACjE,EAAA,MAAM,OAAO,EAAC;AACd,EAAA,OAAO,IAAID,YAAA,CAAiB;AAAA,IACxB,IAAA;AAAA,IACA,WAAA,EAAa,SAAS,IAAI,CAAA;AAAA,IAC1B,UAAA,EAAY,EAAE,WAAA,EAAa,WAAA,IAAe,kBAAA,EAAmB;AAAA,IAC7D,YAAY,EAAC;AAAA,IACb,gBAAgB,EAAE,WAAA,EAAa,EAAE,SAAA,EAAW,oBAAmB;AAAE,GACpE,CAAA;AACL;AAEA,SAAS,eAAA,GAAkB;AAGvB,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,aAAA,CAAc,KAAK,CAAA;AACxC,EAAA,WAAA,CAAY,SAAA,CAAU,SAAS,MAAM;AACjC,IAAA,OAAO,GAAA;AAAA,EACX,CAAA;AACJ;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AAClD,EAAA,OAAO,KAAA,IAAS,SACV,MAAA,GACA,eAAA,CAAgB,EAAE,IAAA,EAAM,WAAA,EAAa,GAAI,MAAA,EAA8B,CAAA;AAEjF;AAEA,eAAA,EAAgB;;;;"}
+{"version":3,"file":"index.js","sources":["index.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { constant, watch } from \"@conterra/reactivity-core\";\nimport { HttpService, HttpServiceRequestInit } from \"@open-pioneer/http\";\nimport {\n    ExtentConfig,\n    InitialViewConfig,\n    Layer,\n    LayerCreateOptions,\n    LayerFactory,\n    MapConfig,\n    MapModel,\n    LayerConfig as MapPackageLayerConfig,\n    MapRegistry,\n    OlMapOptions,\n    SimpleLayer,\n    SimpleLayerConfig\n} from \"@open-pioneer/map\";\nimport {\n    LayerFactory as LayerFactoryImpl,\n    MapRegistry as MapRegistryImpl\n} from \"@open-pioneer/map/internalTestSupport\";\nimport { PackageIntl } from \"@open-pioneer/runtime\";\nimport { createService } from \"@open-pioneer/test-utils/services\";\nimport { screen, waitFor } from \"@testing-library/react\";\nimport TileLayer from \"ol/layer/Tile\";\nimport VectorLayer from \"ol/layer/Vector\";\n\nexport type LayerConfig = SimpleLayerConfig | Layer;\n\nexport interface SimpleMapOptions {\n    /** ID of the map.\n     * Defaults to \"test\". */\n    mapId?: string;\n\n    /** Center coordinates for the map. */\n    center?: { x: number; y: number };\n\n    /** Zoom level of the map. */\n    zoom?: number;\n\n    /**\n     * Initial extent (don't mix with center / zoom).\n     */\n    extent?: ExtentConfig;\n\n    /**\n     * The map's projection.\n     */\n    projection?: string;\n\n    /**\n     * Layers used by the map.\n     */\n    layers?: LayerConfig[];\n\n    /**\n     * Base layers for the map.\n     */\n    baseLayers?: LayerConfig[];\n\n    /**\n     * Layers that are displayed on top of all other layers.\n     */\n    topmostLayers?: LayerConfig[];\n\n    /** See {@link MapConfig.showAttributions} */\n    showAttributions?: boolean;\n\n    /**\n     * Overrides fetching of network resources (such as service capabilities).\n     */\n    fetch?: (resource: URL, init: HttpServiceRequestInit | undefined) => Promise<Response>;\n\n    /**\n     * Passed to the open layers map constructor.\n     */\n    advanced?: OlMapOptions;\n\n    /**\n     * Disables the initial view when set to true.\n     */\n    noInitialView?: boolean;\n\n    /**\n     * Disables the default projection when set to true.\n     */\n    noProjection?: boolean;\n\n    /**\n     * Also returns the map object in the return value.\n     * True by default.\n     *\n     * Use `false` to test the async loading behavior of the registry.\n     */\n    returnMap?: boolean;\n\n    /**\n     * If true, the map is rendered in a dummy div instead of the real OpenLayers canvas.\n     * This is useful for tests that need the map's view to be initialized, but don't need to actually render the map.\n     *\n     * False by default.\n     */\n    mockMapRender?: boolean;\n}\nconst DUMMY_HTTP_SERVICE = {\n    async fetch() {\n        throw new Error(\n            \"Network requests are not implemented (override fetch via map test utils if your test requires network access).\"\n        );\n    }\n} satisfies Partial<HttpService> as HttpService;\nconst DUMMY_LAYER_FACTORY = createLayerFactory();\n\n/**\n * Waits until the OpenLayers map is initialized/displayed and is visible in the DOM.\n */\nexport async function waitForMapRender(map: MapModel) {\n    await map.whenDisplayed();\n    await waitFor(async () => {\n        const container = map.container?.querySelector(\".ol-viewport\");\n        if (!container) {\n            throw new Error(\"map not mounted\");\n        }\n    });\n}\n\n/**\n * Waits until the OpenLayers map has been mounted in the parent with the given id.\n */\nexport async function waitForMapMount(parentTestId = \"base\") {\n    return await waitFor(async () => {\n        const domElement = await screen.findByTestId(parentTestId);\n        const container = domElement.querySelector(\".ol-viewport\");\n        if (!container) {\n            throw new Error(\"map not mounted\");\n        }\n        return domElement;\n    });\n}\n\n/**\n * Waits until the model has an initial extent.\n */\nexport async function waitForInitialExtent(model: MapModel) {\n    if (model.initialExtent) {\n        return;\n    }\n\n    await new Promise<void>((resolve, reject) => {\n        const resource = watch(\n            () => [model.initialExtent],\n            ([extent]) => {\n                resource.destroy();\n                if (extent) {\n                    resolve();\n                } else {\n                    reject(new Error(\"Expected a valid initial extent\"));\n                }\n            }\n        );\n    });\n}\n\nexport interface SetupMapResult {\n    mapId: string;\n    registry: MapRegistry;\n    layerFactory: LayerFactory;\n}\n\n/**\n * Creates a simple map registry service with exactly one map configuration.\n *\n * The map is configured by using the `options` parameter.\n * If `options.returnMap` is `true` (the default), the map model is also returned.\n *\n * Returns the map registry and the id of the configured map.\n */\nexport async function setupMap(\n    options?: SimpleMapOptions & { returnMap?: true; mockMapRender?: boolean }\n): Promise<SetupMapResult & { map: MapModel }>;\nexport async function setupMap(options?: SimpleMapOptions): Promise<SetupMapResult>;\nexport async function setupMap(\n    options?: SimpleMapOptions\n): Promise<SetupMapResult & { map: MapModel | undefined }> {\n    const mapId = options?.mapId ?? \"test\";\n    const mapConfig: MapConfig = {\n        initialView: options?.noInitialView ? undefined : getInitialView(options),\n        projection: options?.noProjection ? undefined : (options?.projection ?? \"EPSG:3857\"),\n        layers: options?.layers?.map((config) => useOrCreateLayer(config)) ?? [createTestLayer()],\n        baseLayers: options?.baseLayers?.map((config) => useOrCreateLayer(config)) ?? [],\n        topmostLayers: options?.topmostLayers?.map((config) => useOrCreateLayer(config)) ?? [],\n        showAttributions: options?.showAttributions,\n        advanced: options?.advanced\n    };\n\n    const httpService = {\n        async fetch(resource, init) {\n            if (options?.fetch) {\n                const url = new URL(resource, \"http://localhost:1234\");\n                return options.fetch(url, init);\n            }\n            throw new Error(\n                \"Network requests are not implemented (override fetch via map test utils if your test requires network access).\"\n            );\n        }\n    } satisfies Partial<HttpService> as HttpService;\n\n    const layerFactory = await createService(LayerFactoryImpl, {\n        references: {\n            httpService\n        }\n    });\n\n    const registry = await createService(MapRegistryImpl, {\n        references: {\n            providers: [],\n            httpService,\n            layerFactory\n        }\n    });\n\n    let map: MapModel | undefined;\n    const promise = registry.createMapModel(mapId, mapConfig);\n    if (options?.returnMap !== false || options?.mockMapRender) {\n        map = await promise;\n\n        if (options?.mockMapRender) {\n            mockMapRender(map);\n        }\n    } else {\n        // Ignore error on this promise (prevents unhandled error in tests)\n        promise.catch(() => undefined);\n    }\n    return { mapId, registry, layerFactory, map };\n}\n\n/**\n * Renders an OL map into a pseudo (non-visible) div so the map's view gets initialized.\n */\nexport function mockMapRender(map: MapModel) {\n    const dummyContainer = document.createElement(\"div\");\n    dummyContainer.style.width = \"100px\";\n    dummyContainer.style.height = \"100px\";\n    dummyContainer.setAttribute(\"data-testid\", \"map\");\n    document.body.appendChild(dummyContainer);\n    map.olMap.setTarget(dummyContainer);\n}\n\nfunction getInitialView(options: SimpleMapOptions | undefined): InitialViewConfig {\n    if (options?.extent) {\n        return {\n            kind: \"extent\",\n            extent: options.extent\n        };\n    }\n    return {\n        kind: \"position\",\n        center: options?.center ?? { x: 847541, y: 6793584 },\n        zoom: options?.zoom ?? 10\n    };\n}\n\n/** Creates an new layer of the specified type for testing. */\nexport function createTestLayer<LayerType extends Layer, Config extends MapPackageLayerConfig>(\n    config: LayerCreateOptions<LayerType, Config>,\n    mapOptions?: Pick<SimpleMapOptions, \"fetch\">\n): LayerType;\n\n/**\n *\n * Creates a new, basic SimpleLayer for testing.\n *\n * For example:\n *\n * ```ts\n * const layer1 = createTestLayer();\n * const layer2 = createTestLayer({\n *   title: \"My test layer\",\n *   olLayer: ...\n * })\n * ```\n **/\nexport function createTestLayer(\n    config?: SimpleLayerConfig,\n    mapOptions?: Pick<SimpleMapOptions, \"fetch\">\n): SimpleLayer;\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport function createTestLayer(config?: any, mapOptions?: Pick<SimpleMapOptions, \"fetch\">): Layer {\n    // Basic case: If no config is given, use SimpleLayer\n    if (!config) {\n        config = {\n            type: SimpleLayer,\n            title: \"Test layer\",\n            olLayer: new VectorLayer()\n        } as LayerCreateOptions<SimpleLayer, SimpleLayerConfig>;\n    } else if (!config.type) {\n        config.type = SimpleLayer;\n    }\n\n    const factory = mapOptions?.fetch\n        ? createLayerFactory({ fetch: mapOptions.fetch })\n        : DUMMY_LAYER_FACTORY;\n    return factory.create(config);\n}\n\n/**\n * Returns a simple, empty OpenLayers layer object.\n *\n * Use this if you need any kind of `olLayer` in your test.\n */\nexport function createTestOlLayer(): TileLayer {\n    return new TileLayer();\n}\n\n/**\n * Creates (service name, service implementation)-pairs suitable for the `services`\n * option of the `PackageContextProvider`.\n *\n * This helper method can be used to avoid hard-coding service names used in the implementation.\n *\n * @deprecated This function is no longer needed, since most widgets no longer depend on the registry\n * and accept the `map` directly.\n */\nexport function createServiceOptions(services: { registry: MapRegistry }): Record<string, unknown> {\n    return {\n        \"map.MapRegistry\": services.registry\n    };\n}\n\nfunction createLayerFactory(httpService?: HttpService): LayerFactory {\n    const intl = {} satisfies Partial<PackageIntl> as PackageIntl;\n    return new LayerFactoryImpl({\n        intl,\n        currentIntl: constant(intl),\n        references: { httpService: httpService ?? DUMMY_HTTP_SERVICE },\n        properties: {},\n        referencesMeta: { httpService: { serviceId: \"http.HttpService\" } }\n    });\n}\n\nfunction mockLayers() {\n    // Overwrite render so it doesn't actually do anything during tests.\n    // Would otherwise error because <canvas /> is not fully implemented in happy-dom.\n    const div = document.createElement(\"div\");\n    VectorLayer.prototype.render = () => {\n        return div;\n    };\n    TileLayer.prototype.render = () => {\n        return div;\n    };\n}\n\nfunction useOrCreateLayer(config: LayerConfig): Layer {\n    return \"map\" in config\n        ? config\n        : createTestLayer({ type: SimpleLayer, ...(config as SimpleLayerConfig) });\n    // using map as discriminator (no prototype for Layer)\n}\n\n// Do not mock layer rendering when running in vitest's browser mode.\n// oxlint-disable-next-line typescript/no-explicit-any\nif (!(globalThis as any).__vitest_browser__) {\n    mockLayers();\n}\n"],"names":["LayerFactoryImpl","MapRegistryImpl"],"mappings":";;;;;;;;AA0GA,MAAM,kBAAA,GAAqB;AAAA,EACvB,MAAM,KAAA,GAAQ;AACV,IAAA,MAAM,IAAI,KAAA;AAAA,MACN;AAAA,KACJ;AAAA,EACJ;AACJ,CAAA;AACA,MAAM,sBAAsB,kBAAA,EAAmB;AAK/C,eAAsB,iBAAiB,GAAA,EAAe;AAClD,EAAA,MAAM,IAAI,aAAA,EAAc;AACxB,EAAA,MAAM,QAAQ,YAAY;AACtB,IAAA,MAAM,SAAA,GAAY,GAAA,CAAI,SAAA,EAAW,aAAA,CAAc,cAAc,CAAA;AAC7D,IAAA,IAAI,CAAC,SAAA,EAAW;AACZ,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACrC;AAAA,EACJ,CAAC,CAAA;AACL;AAKA,eAAsB,eAAA,CAAgB,eAAe,MAAA,EAAQ;AACzD,EAAA,OAAO,MAAM,QAAQ,YAAY;AAC7B,IAAA,MAAM,UAAA,GAAa,MAAM,MAAA,CAAO,YAAA,CAAa,YAAY,CAAA;AACzD,IAAA,MAAM,SAAA,GAAY,UAAA,CAAW,aAAA,CAAc,cAAc,CAAA;AACzD,IAAA,IAAI,CAAC,SAAA,EAAW;AACZ,MAAA,MAAM,IAAI,MAAM,iBAAiB,CAAA;AAAA,IACrC;AACA,IAAA,OAAO,UAAA;AAAA,EACX,CAAC,CAAA;AACL;AAKA,eAAsB,qBAAqB,KAAA,EAAiB;AACxD,EAAA,IAAI,MAAM,aAAA,EAAe;AACrB,IAAA;AAAA,EACJ;AAEA,EAAA,MAAM,IAAI,OAAA,CAAc,CAAC,OAAA,EAAS,MAAA,KAAW;AACzC,IAAA,MAAM,QAAA,GAAW,KAAA;AAAA,MACb,MAAM,CAAC,KAAA,CAAM,aAAa,CAAA;AAAA,MAC1B,CAAC,CAAC,MAAM,CAAA,KAAM;AACV,QAAA,QAAA,CAAS,OAAA,EAAQ;AACjB,QAAA,IAAI,MAAA,EAAQ;AACR,UAAA,OAAA,EAAQ;AAAA,QACZ,CAAA,MAAO;AACH,UAAA,MAAA,CAAO,IAAI,KAAA,CAAM,iCAAiC,CAAC,CAAA;AAAA,QACvD;AAAA,MACJ;AAAA,KACJ;AAAA,EACJ,CAAC,CAAA;AACL;AAoBA,eAAsB,SAClB,OAAA,EACuD;AACvD,EAAA,MAAM,KAAA,GAAQ,SAAS,KAAA,IAAS,MAAA;AAChC,EAAA,MAAM,SAAA,GAAuB;AAAA,IACzB,WAAA,EAAa,OAAA,EAAS,aAAA,GAAgB,MAAA,GAAY,eAAe,OAAO,CAAA;AAAA,IACxE,UAAA,EAAY,OAAA,EAAS,YAAA,GAAe,MAAA,GAAa,SAAS,UAAA,IAAc,WAAA;AAAA,IACxE,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,GAAA,CAAI,CAAC,MAAA,KAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,CAAC,eAAA,EAAiB,CAAA;AAAA,IACxF,UAAA,EAAY,OAAA,EAAS,UAAA,EAAY,GAAA,CAAI,CAAC,WAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,EAAC;AAAA,IAC/E,aAAA,EAAe,OAAA,EAAS,aAAA,EAAe,GAAA,CAAI,CAAC,WAAW,gBAAA,CAAiB,MAAM,CAAC,CAAA,IAAK,EAAC;AAAA,IACrF,kBAAkB,OAAA,EAAS,gBAAA;AAAA,IAC3B,UAAU,OAAA,EAAS;AAAA,GACvB;AAEA,EAAA,MAAM,WAAA,GAAc;AAAA,IAChB,MAAM,KAAA,CAAM,QAAA,EAAU,IAAA,EAAM;AACxB,MAAA,IAAI,SAAS,KAAA,EAAO;AAChB,QAAA,MAAM,GAAA,GAAM,IAAI,GAAA,CAAI,QAAA,EAAU,uBAAuB,CAAA;AACrD,QAAA,OAAO,OAAA,CAAQ,KAAA,CAAM,GAAA,EAAK,IAAI,CAAA;AAAA,MAClC;AACA,MAAA,MAAM,IAAI,KAAA;AAAA,QACN;AAAA,OACJ;AAAA,IACJ;AAAA,GACJ;AAEA,EAAA,MAAM,YAAA,GAAe,MAAM,aAAA,CAAcA,YAAA,EAAkB;AAAA,IACvD,UAAA,EAAY;AAAA,MACR;AAAA;AACJ,GACH,CAAA;AAED,EAAA,MAAM,QAAA,GAAW,MAAM,aAAA,CAAcC,WAAA,EAAiB;AAAA,IAClD,UAAA,EAAY;AAAA,MACR,WAAW,EAAC;AAAA,MACZ,WAAA;AAAA,MACA;AAAA;AACJ,GACH,CAAA;AAED,EAAA,IAAI,GAAA;AACJ,EAAA,MAAM,OAAA,GAAU,QAAA,CAAS,cAAA,CAAe,KAAA,EAAO,SAAS,CAAA;AACxD,EAAA,IAAI,OAAA,EAAS,SAAA,KAAc,KAAA,IAAS,OAAA,EAAS,aAAA,EAAe;AACxD,IAAA,GAAA,GAAM,MAAM,OAAA;AAEZ,IAAA,IAAI,SAAS,aAAA,EAAe;AACxB,MAAA,aAAA,CAAc,GAAG,CAAA;AAAA,IACrB;AAAA,EACJ,CAAA,MAAO;AAEH,IAAA,OAAA,CAAQ,KAAA,CAAM,MAAM,MAAS,CAAA;AAAA,EACjC;AACA,EAAA,OAAO,EAAE,KAAA,EAAO,QAAA,EAAU,YAAA,EAAc,GAAA,EAAI;AAChD;AAKO,SAAS,cAAc,GAAA,EAAe;AACzC,EAAA,MAAM,cAAA,GAAiB,QAAA,CAAS,aAAA,CAAc,KAAK,CAAA;AACnD,EAAA,cAAA,CAAe,MAAM,KAAA,GAAQ,OAAA;AAC7B,EAAA,cAAA,CAAe,MAAM,MAAA,GAAS,OAAA;AAC9B,EAAA,cAAA,CAAe,YAAA,CAAa,eAAe,KAAK,CAAA;AAChD,EAAA,QAAA,CAAS,IAAA,CAAK,YAAY,cAAc,CAAA;AACxC,EAAA,GAAA,CAAI,KAAA,CAAM,UAAU,cAAc,CAAA;AACtC;AAEA,SAAS,eAAe,OAAA,EAA0D;AAC9E,EAAA,IAAI,SAAS,MAAA,EAAQ;AACjB,IAAA,OAAO;AAAA,MACH,IAAA,EAAM,QAAA;AAAA,MACN,QAAQ,OAAA,CAAQ;AAAA,KACpB;AAAA,EACJ;AACA,EAAA,OAAO;AAAA,IACH,IAAA,EAAM,UAAA;AAAA,IACN,QAAQ,OAAA,EAAS,MAAA,IAAU,EAAE,CAAA,EAAG,MAAA,EAAQ,GAAG,OAAA,EAAQ;AAAA,IACnD,IAAA,EAAM,SAAS,IAAA,IAAQ;AAAA,GAC3B;AACJ;AA4BO,SAAS,eAAA,CAAgB,QAAc,UAAA,EAAqD;AAE/F,EAAA,IAAI,CAAC,MAAA,EAAQ;AACT,IAAA,MAAA,GAAS;AAAA,MACL,IAAA,EAAM,WAAA;AAAA,MACN,KAAA,EAAO,YAAA;AAAA,MACP,OAAA,EAAS,IAAI,WAAA;AAAY,KAC7B;AAAA,EACJ,CAAA,MAAA,IAAW,CAAC,MAAA,CAAO,IAAA,EAAM;AACrB,IAAA,MAAA,CAAO,IAAA,GAAO,WAAA;AAAA,EAClB;AAEA,EAAA,MAAM,OAAA,GAAU,YAAY,KAAA,GACtB,kBAAA,CAAmB,EAAE,KAAA,EAAO,UAAA,CAAW,KAAA,EAAO,CAAA,GAC9C,mBAAA;AACN,EAAA,OAAO,OAAA,CAAQ,OAAO,MAAM,CAAA;AAChC;AAOO,SAAS,iBAAA,GAA+B;AAC3C,EAAA,OAAO,IAAI,SAAA,EAAU;AACzB;AAWO,SAAS,qBAAqB,QAAA,EAA8D;AAC/F,EAAA,OAAO;AAAA,IACH,mBAAmB,QAAA,CAAS;AAAA,GAChC;AACJ;AAEA,SAAS,mBAAmB,WAAA,EAAyC;AACjE,EAAA,MAAM,OAAO,EAAC;AACd,EAAA,OAAO,IAAID,YAAA,CAAiB;AAAA,IACxB,IAAA;AAAA,IACA,WAAA,EAAa,SAAS,IAAI,CAAA;AAAA,IAC1B,UAAA,EAAY,EAAE,WAAA,EAAa,WAAA,IAAe,kBAAA,EAAmB;AAAA,IAC7D,YAAY,EAAC;AAAA,IACb,gBAAgB,EAAE,WAAA,EAAa,EAAE,SAAA,EAAW,oBAAmB;AAAE,GACpE,CAAA;AACL;AAEA,SAAS,UAAA,GAAa;AAGlB,EAAA,MAAM,GAAA,GAAM,QAAA,CAAS,aAAA,CAAc,KAAK,CAAA;AACxC,EAAA,WAAA,CAAY,SAAA,CAAU,SAAS,MAAM;AACjC,IAAA,OAAO,GAAA;AAAA,EACX,CAAA;AACA,EAAA,SAAA,CAAU,SAAA,CAAU,SAAS,MAAM;AAC/B,IAAA,OAAO,GAAA;AAAA,EACX,CAAA;AACJ;AAEA,SAAS,iBAAiB,MAAA,EAA4B;AAClD,EAAA,OAAO,KAAA,IAAS,SACV,MAAA,GACA,eAAA,CAAgB,EAAE,IAAA,EAAM,WAAA,EAAa,GAAI,MAAA,EAA8B,CAAA;AAEjF;AAIA,IAAI,CAAE,WAAmB,kBAAA,EAAoB;AACzC,EAAA,UAAA,EAAW;AACf;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/map-test-utils",
-  "version": "1.5.0-dev.20260911123645",
+  "version": "1.5.0-dev.20260917081843",
   "description": "This package is an internal support package for testing map-related UI components.",
   "keywords": [
     "open-pioneer-trails"
@@ -15,7 +15,7 @@
   },
   "dependencies": {
     "@conterra/reactivity-core": "^0.8.8",
-    "@open-pioneer/map": "1.5.0-dev.20260911123645",
+    "@open-pioneer/map": "1.5.0-dev.20260917081843",
     "@open-pioneer/test-utils": "4.8.0-dev.20260910101405",
     "@testing-library/react": "^16.3.3",
     "ol": "^10.10.0"