fix: Extract SLD version from SLD #696 and #925

src/SldStyleParser.ts

@@ -56,11 +56,14 @@ import {
   numberExpression
 } from './Util/SldUtil';
 
-export type SldVersion = '1.0.0' | '1.1.0';
+const SLD_VERSIONS = ['1.0.0','1.1.0'] as const;
+
+export type SldVersion = (typeof SLD_VERSIONS)[number];
 
 export type ConstructorParams = {
   numericFilterFields?: string[];
   boolFilterFields?: string[];
+  /* optional for reading style (it will be guessed from sld style) and mandatory for writing */
   sldVersion?: SldVersion;
   symbolizerUnits?: string;
   parserOptions?: X2jOptionsOptional;
@@ -271,9 +274,9 @@ export class SldStyleParser implements StyleParser<string> {
 
   /**
    * String indicating the SLD version to use. 1.1.0 will make use of
-   * Symbology Encoding. Default ist to use SLD 1.0.0
+   * Symbology Encoding.
    */
-  private _sldVersion: SldVersion = '1.0.0';
+  private _sldVersion: SldVersion;
 
   /**
    * Getter for _sldVersion
@@ -325,6 +328,15 @@ export class SldStyleParser implements StyleParser<string> {
     return new Promise<ReadStyleResult>((resolve) => {
       try {
         const sldObject = this.parser.parse(sldString);
+
+        if (this._sldVersion === undefined) {
+          const version = getAttribute(sldObject[0], 'version');
+          if (! SLD_VERSIONS.includes(version)) {
+            throw new Error(`SLD version must be ${SLD_VERSIONS.toString()}`);
+          }
+          this._sldVersion = version;
+        }
+
         const geoStylerStyle: Style = this.sldObjectToGeoStylerStyle(sldObject);
         resolve({
           output: geoStylerStyle
@@ -1165,6 +1177,10 @@ export class SldStyleParser implements StyleParser<string> {
    * @return The Promise resolving with the SLD as a string.
    */
   writeStyle(geoStylerStyle: Style): Promise<WriteStyleResult<string>> {
+    if (this._sldVersion === undefined) {
+      throw new Error('sldVersion is mandatory');
+    }
+
     return new Promise<WriteStyleResult<string>>(resolve => {
       const unsupportedProperties = this.checkForUnsupportedProperties(geoStylerStyle);
       try {

src/SldStyleParser.v1.0.spec.ts

@@ -51,7 +51,7 @@ it('SldStyleParser is defined', () => {
   expect(SldStyleParser).toBeDefined();
 });
 
-describe('SldStyleParser implements StyleParser', () => {
+describe('SldStyleParser implements StyleParser (reading)', () => {
   let styleParser: SldStyleParser;
 
   beforeEach(() => {
@@ -361,6 +361,14 @@ describe('SldStyleParser implements StyleParser', () => {
       });
     });
   });
+});
+
+describe('SldStyleParser implements StyleParser (writing)', () => {
+  let styleParser: SldStyleParser;
+
+  beforeEach(() => {
+    styleParser = new SldStyleParser({sldVersion: '1.0.0'});
+  });
 
   describe('#writeStyle', () => {
     it('is defined', () => {
@@ -924,6 +932,7 @@ describe('SldStyleParser implements StyleParser', () => {
 
     it('creates the correct order in a text symbolizer', async () => {
       const styleParserOrder = new SldStyleParser({
+        sldVersion: '1.0.0',
         builderOptions: {
           format: true
         }
@@ -935,6 +944,7 @@ describe('SldStyleParser implements StyleParser', () => {
     });
     it('adds unsupportedProperties to the write output', async () => {
       const styleParserOrder = new SldStyleParser({
+        sldVersion: '1.0.0',
         builderOptions: {
           format: true
         }

src/SldStyleParser.v1.1.spec.ts

@@ -52,13 +52,11 @@ it('SldStyleParser is defined', () => {
   expect(SldStyleParser).toBeDefined();
 });
 
-describe('SldStyleParser with Symbology Encoding implements StyleParser', () => {
+describe('SldStyleParser with Symbology Encoding implements StyleParser (reading)', () => {
   let styleParser: SldStyleParser;
 
   beforeEach(() => {
-    styleParser = new SldStyleParser({
-      sldVersion: '1.1.0'
-    });
+    styleParser = new SldStyleParser();
   });
 
   describe('#readStyle', () => {
@@ -370,11 +368,20 @@ describe('SldStyleParser with Symbology Encoding implements StyleParser', () =>
       });
     });
   });
+});
+
+describe('SldStyleParser with Symbology Encoding implements StyleParser (writing)', () => {
+  let styleParser: SldStyleParser;
+
+  beforeEach(() => {
+    styleParser = new SldStyleParser({sldVersion: '1.1.0'});
+  });
 
   describe('#writeStyle', () => {
     it('is defined', () => {
       expect(styleParser.writeStyle).toBeDefined();
     });
+
     it('can write a SLD 1.1 PointSymbolizer', async () => {
       const { output: sldString } = await styleParser.writeStyle(point_simplepoint);
       expect(sldString).toBeDefined();