Accurate projection naming

maplibre · Nov 2, 2024 · 211f7a7 · 211f7a7
1 parent 248b4f5
commit 211f7a7
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/src/reference/v8.json b/src/reference/v8.json
@@ -129,7 +129,7 @@
       "type": "projection",
       "doc": "The projection configuration. **Note:** this definition is still experimental and is under development in maplibre-gl-js.",
       "example": {
-        "type": "globe"
+        "type": "web-mercator"
       }
     },
     "terrain": {
@@ -4538,7 +4538,7 @@
         ]
       },
       "transition": true,
-      "doc": "How to blend the atmosphere. Where 1 is visible atmosphere and 0 is hidden. It is best to interpolate this expression when using globe projection."
+      "doc": "How to blend the atmosphere. Where 1 is visible atmosphere and 0 is hidden. It is best to interpolate this expression when using globe-to-web-mercator projection."
     }
   },
   "terrain": {
@@ -4572,13 +4572,16 @@
     "type": {
       "type": "enum",
       "doc": "The projection type.",
-      "default": "mercator",
+      "default": "web-mercator",
       "values": {
-        "mercator": {
-          "doc": "The Mercator projection."
+        "web-mercator": {
+          "doc": "Web Mercator projection."
         },
         "globe": {
-          "doc": "The globe projection."
+          "doc": "\"Static Globe\". Spherical projection."
+        },
+        "globe-to-web-mercator": {
+          "doc": "\"Adaptive Globe\". Transition from a Spherical projection to a Web Mercator projection on zoom."
         }
       }
     }

diff --git a/src/validate/validate_projection.test.ts b/src/validate/validate_projection.test.ts
@@ -26,13 +26,13 @@ describe('Validate projection', () => {
     test('Should return errors according to spec violations', () => {
         const errors = validateProjection({validateSpec, value: {type: 1 as any}, styleSpec: v8, style: {} as any});
         expect(errors).toHaveLength(1);
-        expect(errors[0].message).toBe('type: expected one of [mercator, globe], 1 found');
+        expect(errors[0].message).toBe('type: expected one of [web-mercator, globe, globe-to-web-mercator], 1 found');
     });
 
     test('Should pass if everything is according to spec', () => {
-        let errors = validateProjection({validateSpec, value: {type: 'globe'}, styleSpec: v8, style: {} as any});
+        let errors = validateProjection({validateSpec, value: {type: 'spherical-to-web-mercator'}, styleSpec: v8, style: {} as any});
         expect(errors).toHaveLength(0);
-        errors = validateProjection({validateSpec, value: {type: 'mercator'}, styleSpec: v8, style: {} as any});
+        errors = validateProjection({validateSpec, value: {type: 'web-mercator'}, styleSpec: v8, style: {} as any});
         expect(errors).toHaveLength(0);
     });
 });