Merge pull request #482 from terrestris/add-XYZ-serialzer

feat: adds a XYZ Serializer

Author: faouziH21

Diff for: src/serializer/MapFishPrintV3OSMSerializer.ts

@@ -1,21 +1,16 @@
+import OlLayer from 'ol/layer/Layer';
 import OlSource from 'ol/source/Source';
 import OlSourceOSM from 'ol/source/OSM';
-import OlLayer from 'ol/layer/Layer';
-
-import BaseSerializer from './BaseSerializer';
-
-export class MapFishPrintV3OSMSerializer implements BaseSerializer {
+import MapFishPrintV3XYZSerializer from './MapFishPrintV3XYZSerializer';
 
-  /**
-   * The WMS layer type identificator.
-   */
-  static TYPE_OSM: string = 'osm';
+export class MapFishPrintV3OSMSerializer extends MapFishPrintV3XYZSerializer {
 
   validateSource(source: OlSource): source is OlSourceOSM {
     return source instanceof OlSourceOSM;
   }
 
   serialize(olLayer: OlLayer, opts?: any) {
+    const source = olLayer.getSource();
     const optsToApply = {
       baseURL: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png',
       customParams: {},
@@ -28,24 +23,18 @@ export class MapFishPrintV3OSMSerializer implements BaseSerializer {
       ...opts
     };
 
-    const source = olLayer.getSource();
-
     if (!source || !this.validateSource(source)) {
       return;
     }
 
-    const tileGrid = source.getTileGrid();
-    const tileGridResolutions = tileGrid?.getResolutions() || [];
+    const urls = source.getUrls();
+    const baseUrl = urls ? urls[0] : undefined;
 
-    const serialized = {
-      name: olLayer.get('name'),
-      opacity: olLayer.getOpacity(),
-      resolutions: tileGridResolutions,
-      type: MapFishPrintV3OSMSerializer.TYPE_OSM,
+    return {
+      ...super.serialize(olLayer, opts),
+      baseURL: baseUrl,
       ...optsToApply
     };
-
-    return serialized;
   }
 }
 

Diff for: src/serializer/MapFishPrintV3StamenSerializer.ts

@@ -1,9 +1,10 @@
 import OlLayer from 'ol/layer/Layer';
 import OlSource from 'ol/source/Source';
-import StadiaMaps from 'ol/source/StadiaMaps.js';
-import MapFishPrintV3OSMSerializer from './MapFishPrintV3OSMSerializer';
+import StadiaMaps from 'ol/source/StadiaMaps';
+import MapFishPrintV3XYZSerializer from './MapFishPrintV3XYZSerializer';
 
-export class MapFishPrintV3StamenSerializer extends MapFishPrintV3OSMSerializer {
+
+export class MapFishPrintV3StamenSerializer extends MapFishPrintV3XYZSerializer {
 
   validateSource(source: OlSource): source is StadiaMaps {
     return source instanceof StadiaMaps;

Diff for: src/serializer/MapFishPrintV3XYZSerializer.ts

@@ -0,0 +1,56 @@
+import OlSource from 'ol/source/Source';
+import OlSourceXYZ from 'ol/source/XYZ';
+import OlLayer from 'ol/layer/Layer';
+
+import BaseSerializer from './BaseSerializer';
+
+export class MapFishPrintV3XYZSerializer implements BaseSerializer {
+
+  /**
+   * The XYZ layer type identificator.
+   * We use OSM for the type because the backend does not
+   * have XYZ implemented which leads to the map not being printed
+   */
+  static TYPE_XYZ: string = 'osm';
+
+  validateSource(source: OlSource): source is OlSourceXYZ {
+    return source instanceof OlSourceXYZ;
+  }
+
+  serialize(olLayer: OlLayer, opts?: any) {
+    const optsToApply = {
+      baseURL: undefined,
+      customParams: {},
+      dpi: 72,
+      failOnError: false,
+      imageExtension: 'png',
+      maxExtent: [-20037508.34, -20037508.34, 20037508.34, 20037508.34],
+      rasterStyle: undefined,
+      tileSize: [256, 256],
+      ...opts
+    };
+
+    const source = olLayer.getSource();
+
+    if (!source || !this.validateSource(source)) {
+      return;
+    }
+
+    const tileGrid = source.getTileGrid();
+    const tileGridResolutions = tileGrid?.getResolutions() || [];
+    const urls = source.getUrls();
+    const baseUrl = urls ? urls[0] : undefined;
+
+    const serialized = {
+      name: olLayer.get('name'),
+      opacity: olLayer.getOpacity(),
+      resolutions: tileGridResolutions,
+      baseURL: baseUrl,
+      type: MapFishPrintV3XYZSerializer.TYPE_XYZ,
+      ...optsToApply
+    };
+    return serialized;
+  }
+}
+
+export default MapFishPrintV3XYZSerializer;