@mapbox/mapbox-gl-style-spec 14.23.0 → 14.24.0-rc.1

package/validate/validate_enum.ts

@@ -16,12 +16,12 @@ export default function validateEnum(options: EnumValidatorOptions): ValidationE
 
     const errors: ValidationError[] = [];
     if (Array.isArray(valueSpec.values)) { // <=v7
-        if (valueSpec.values.indexOf(unbundle(value)) === -1) {
+        if (!valueSpec.values.includes(unbundle(value))) {
             // eslint-disable-next-line @typescript-eslint/no-base-to-string
             errors.push(new ValidationError(key, value, `expected one of [${valueSpec.values.join(', ')}], ${JSON.stringify(value)} found`));
         }
     } else { // >=v8
-        if (Object.keys(valueSpec.values).indexOf(unbundle(value) as string) === -1) {
+        if (!Object.keys(valueSpec.values).includes(unbundle(value) as string)) {
             errors.push(new ValidationError(key, value, `expected one of [${Object.keys(valueSpec.values).join(', ')}], ${JSON.stringify(value)} found`));
         }
     }

package/validate/validate_fog.ts

@@ -1,6 +1,7 @@
 import {default as ValidationError, ValidationWarning} from '../error/validation_error';
 import validate from './validate';
 import {getType, isObject} from '../util/get_type';
+import {TRANSITION_KEY_RE, USE_THEME_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -29,8 +30,8 @@ export default function validateFog(options: FogValidatorOptions): ValidationErr
 
     let errors: ValidationError[] = [];
     for (const key in fog) {
-        const transitionMatch = key.match(/^(.*)-transition$/);
-        const useThemeMatch = key.match(/^(.*)-use-theme$/);
+        const transitionMatch = key.match(TRANSITION_KEY_RE);
+        const useThemeMatch = key.match(USE_THEME_KEY_RE);
 
         // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         if (useThemeMatch && fogSpec[useThemeMatch[1]]) {

package/validate/validate_function.ts

@@ -40,10 +40,10 @@ export default function validateFunction(options: FunctionValidatorOptions): Val
 
     const functionValueSpec = options.valueSpec;
     const functionType = unbundle(value.type);
-    let stopKeyType;
+    let stopKeyType: string | undefined;
     let stopDomainValues: Partial<Record<string | number, boolean>> = {};
     let previousStopDomainValue: unknown;
-    let previousStopDomainZoom;
+    let previousStopDomainZoom: number | undefined;
 
     const isZoomFunction = functionType !== 'categorical' && value.property === undefined;
     const isPropertyFunction = !isZoomFunction;

package/validate/validate_glyphs_url.ts

@@ -11,11 +11,11 @@ export default function validateGlyphsUrl({key, value}: GlyphsUrlValidatorOption
     if (errors.length) return errors;
 
     const str = value as string;
-    if (str.indexOf('{fontstack}') === -1) {
+    if (!str.includes('{fontstack}')) {
         errors.push(new ValidationError(key, value, '"glyphs" url must include a "{fontstack}" token'));
     }
 
-    if (str.indexOf('{range}') === -1) {
+    if (!str.includes('{range}')) {
         errors.push(new ValidationError(key, value, '"glyphs" url must include a "{range}" token'));
     }
 

package/validate/validate_layer.ts

@@ -57,7 +57,7 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
             }
         });
 
-        let parent;
+        let parent: LayerSpecification | undefined;
 
         style.layers.forEach((layer) => {
             if (unbundle(layer.id) === ref) parent = layer;
@@ -66,11 +66,9 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
         if (!parent) {
             if (typeof ref === 'string')
                 errors.push(new ValidationError(key, layer.ref, `ref layer "${ref}" not found`));
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-        } else if (parent.ref) {
+        } else if ((parent as LayerSpecification & {ref?: unknown}).ref) {
             errors.push(new ValidationError(key, layer.ref, 'ref cannot reference another ref layer'));
         } else {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             type = unbundle(parent.type) as string;
         }
     } else if (!(type === 'background' || type === 'sky' || type === 'slot')) {
@@ -93,9 +91,12 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
                 errors.push(new ValidationError(key, layer.source, 'raster-dem source can only be used with layer type \'hillshade\'.'));
             } else if (sourceType === 'raster-array' && !['raster', 'raster-particle'].includes(type)) {
                 errors.push(new ValidationError(key, layer.source, `raster-array source can only be used with layer type \'raster\'.`));
-            } else if (type === 'line' && layer.paint && (layer.paint['line-gradient'] || layer.paint['line-trim-offset']) &&
+            } else if (type === 'line' && layer.paint && layer.paint['line-gradient'] &&
                     (sourceType === 'geojson' && !(source as GeoJSONSourceSpecification).lineMetrics)) {
                 errors.push(new ValidationError(key, layer, `layer "${layer.id as string}" specifies a line-gradient, which requires the GeoJSON source to have \`lineMetrics\` enabled.`));
+            } else if (type === 'line' && layer.paint && layer.paint['line-trim-offset'] &&
+                    (sourceType === 'geojson' && !(source as GeoJSONSourceSpecification).lineMetrics)) {
+                errors.push(new ValidationError(key, layer, `layer "${layer.id as string}" specifies a line-trim-offset, which requires the GeoJSON source to have \`lineMetrics\` enabled.`));
             } else if (type === 'raster-particle' && sourceType !== 'raster-array') {
                 errors.push(new ValidationError(key, layer.source, `layer "${layer.id as string}" requires a \'raster-array\' source.`));
             }

package/validate/validate_light.ts

@@ -1,6 +1,7 @@
 import ValidationError from '../error/validation_error';
 import {getType, isObject} from '../util/get_type';
 import validate from './validate';
+import {TRANSITION_KEY_RE, USE_THEME_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -29,8 +30,8 @@ export default function validateLight(options: LightValidatorOptions): Validatio
 
     let errors: ValidationError[] = [];
     for (const key in light) {
-        const transitionMatch = key.match(/^(.*)-transition$/);
-        const useThemeMatch = key.match(/^(.*)-use-theme$/);
+        const transitionMatch = key.match(TRANSITION_KEY_RE);
+        const useThemeMatch = key.match(USE_THEME_KEY_RE);
 
         // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         if (useThemeMatch && lightSpec[useThemeMatch[1]]) {

package/validate/validate_lights.ts

@@ -2,6 +2,7 @@ import {default as ValidationError, ValidationWarning} from '../error/validation
 import {getType, isObject, isString} from '../util/get_type';
 import validate from './validate';
 import {unbundle} from '../util/unbundle_jsonlint';
+import {TRANSITION_KEY_RE, USE_THEME_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -72,8 +73,8 @@ export default function validateLights(options: LightsValidatorOptions): Validat
                 return errors;
             }
             for (const propertyKey in properties) {
-                const transitionMatch = propertyKey.match(/^(.*)-transition$/);
-                const useThemeMatch = propertyKey.match(/^(.*)-use-theme$/);
+                const transitionMatch = propertyKey.match(TRANSITION_KEY_RE);
+                const useThemeMatch = propertyKey.match(USE_THEME_KEY_RE);
 
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
                 if (useThemeMatch && lightPropertySpec[useThemeMatch[1]]) {

package/validate/validate_model.ts

@@ -6,7 +6,7 @@ import type {StyleSpecification} from '../types';
 
 // Allow any URL, use dummy base, if it's a relative URL
 export function isValidUrl(str: string, allowRelativeUrls: boolean): boolean {
-    const isRelative = str.indexOf('://') === -1;
+    const isRelative = !str.includes('://');
     try {
         new URL(str, isRelative && allowRelativeUrls ? 'http://example.com' : undefined);
         return true;

package/validate/validate_object.ts

@@ -45,7 +45,7 @@ export default function validateObject(options: ObjectValidatorOptions): Validat
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         const elementSpec = elementSpecs[elementSpecKey] || elementSpecs['*'];
 
-        let validateElement;
+        let validateElement: ((options: ObjectElementValidatorOptions, object?: unknown) => ValidationError[]) | undefined;
         if (elementValidators[elementSpecKey]) {
             validateElement = elementValidators[elementSpecKey];
         } else if (elementSpecs[elementSpecKey]) {
@@ -61,11 +61,9 @@ export default function validateObject(options: ObjectValidatorOptions): Validat
             continue;
         }
 
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-call
         errors = errors.concat(validateElement({
             key: (key ? `${key}.` : key) + objectKey,
             value: object[objectKey],
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             valueSpec: elementSpec,
             style,
             styleSpec,

package/validate/validate_property.ts

@@ -3,7 +3,7 @@ import {default as ValidationError, ValidationWarning} from '../error/validation
 import {isString} from '../util/get_type';
 import {isFunction} from '../function/index';
 import {unbundle, deepUnbundle} from '../util/unbundle_jsonlint';
-import {supportsLightExpression, supportsPropertyExpression, supportsZoomExpression} from '../util/properties';
+import {supportsLightExpression, supportsPropertyExpression, supportsZoomExpression, TRANSITION_KEY_RE, USE_THEME_KEY_RE} from '../util/properties';
 import {isGlobalPropertyConstant, isFeatureConstant, isStateConstant} from '../expression/is_constant';
 import {createPropertyExpression, isExpression} from '../expression/index';
 
@@ -12,6 +12,8 @@ import type {StyleReference} from '../reference/latest';
 import type {StylePropertySpecification} from '../style-spec';
 import type {StyleSpecification, LayerSpecification} from '../types';
 
+const TOKEN_PATTERN_RE = /^{([^}]+)}$/;
+
 export type PropertyValidatorOptions = {
     key: string;
     value: unknown;
@@ -34,7 +36,7 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
 
     if (!layerSpec) return [];
 
-    const useThemeMatch = propertyKey.match(/^(.*)-use-theme$/);
+    const useThemeMatch = propertyKey.match(USE_THEME_KEY_RE);
     if (useThemeMatch && layerSpec[useThemeMatch[1]]) {
         if (isExpression(deepUnbundle(value))) {
             const errors: ValidationError[] = [];
@@ -66,7 +68,7 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
         });
     }
 
-    const transitionMatch = propertyKey.match(/^(.*)-transition$/);
+    const transitionMatch = propertyKey.match(TRANSITION_KEY_RE);
     if (propertyType === 'paint' && transitionMatch && layerSpec[transitionMatch[1]] && layerSpec[transitionMatch[1]].transition) {
         return validate({
             key,
@@ -84,7 +86,7 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
     }
 
     let tokenMatch: RegExpExecArray | undefined;
-    if (isString(value) && supportsPropertyExpression(valueSpec) && !valueSpec.tokens && (tokenMatch = /^{([^}]+)}$/.exec(value))) {
+    if (isString(value) && supportsPropertyExpression(valueSpec) && !valueSpec.tokens && (tokenMatch = TOKEN_PATTERN_RE.exec(value))) {
         const example = `\`{ "type": "identity", "property": ${tokenMatch ? JSON.stringify(tokenMatch[1]) : '"_"'} }\``;
         return [new ValidationError(
             key, value,
@@ -101,7 +103,7 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
         if (propertyKey === 'text-font' && isFunction(deepUnbundle(value)) && unbundle((value as {type: unknown}).type) === 'identity') {
             errors.push(new ValidationError(key, value, '"text-font" does not support identity functions'));
         }
-    } else if (options.layerType === 'model' && propertyType === 'paint' && layer && layer.layout && layer.layout.hasOwnProperty('model-id')) {
+    } else if (options.layerType === 'model' && propertyType === 'paint' && layer && layer.layout && Object.hasOwn(layer.layout, 'model-id')) {
         if (supportsPropertyExpression(valueSpec) && (supportsLightExpression(valueSpec) || supportsZoomExpression(valueSpec))) {
             // Performance related style spec limitation: zoom and light expressions are not allowed for e.g. trees.
             const expression = createPropertyExpression(deepUnbundle(value), valueSpec);

package/validate/validate_rain.ts

@@ -1,6 +1,7 @@
 import {default as ValidationError, ValidationWarning} from '../error/validation_error';
 import validate from './validate';
 import {getType, isObject} from '../util/get_type';
+import {TRANSITION_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -29,7 +30,7 @@ export default function validateRain(options: RainValidatorOptions): ValidationE
 
     let errors: ValidationError[] = [];
     for (const key in rain) {
-        const transitionMatch = key.match(/^(.*)-transition$/);
+        const transitionMatch = key.match(TRANSITION_KEY_RE);
 
         if (transitionMatch && rainSpec[transitionMatch[1]] && rainSpec[transitionMatch[1]].transition) {
             errors = errors.concat(validate({

package/validate/validate_snow.ts

@@ -1,6 +1,7 @@
 import {default as ValidationError, ValidationWarning} from '../error/validation_error';
 import validate from './validate';
 import {getType, isObject} from '../util/get_type';
+import {TRANSITION_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -29,7 +30,7 @@ export default function validateSnow(options: SnowValidatorOptions): ValidationE
 
     let errors: ValidationError[] = [];
     for (const key in snow) {
-        const transitionMatch = key.match(/^(.*)-transition$/);
+        const transitionMatch = key.match(TRANSITION_KEY_RE);
 
         if (transitionMatch && snowSpec[transitionMatch[1]] && snowSpec[transitionMatch[1]].transition) {
             errors = errors.concat(validate({

package/validate/validate_style.ts

@@ -15,6 +15,7 @@ export default function validateStyle(style: unknown, styleSpec: StyleReference
         value: style,
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         valueSpec: Object.assign(
+            {},
             styleSpec.$root,
             // Skip validation of the root properties that are not defined in the style spec (e.g. 'owner').
             {'*': {type: '*'}},

package/validate/validate_terrain.ts

@@ -2,6 +2,7 @@ import {default as ValidationError, ValidationWarning} from '../error/validation
 import validate from './validate';
 import {getType, isObject, isString} from '../util/get_type';
 import {unbundle} from '../util/unbundle_jsonlint';
+import {TRANSITION_KEY_RE, USE_THEME_KEY_RE} from '../util/properties';
 
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';
@@ -31,8 +32,8 @@ export default function validateTerrain(options: TerrainValidatorOptions): Valid
 
     let errors: ValidationError[] = [];
     for (const key in terrain) {
-        const transitionMatch = key.match(/^(.*)-transition$/);
-        const useThemeMatch = key.match(/^(.*)-use-theme$/);
+        const transitionMatch = key.match(TRANSITION_KEY_RE);
+        const useThemeMatch = key.match(USE_THEME_KEY_RE);
 
         // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         if (useThemeMatch && terrainSpec[useThemeMatch[1]]) {

package/validate_mapbox_api_supported.ts

@@ -13,6 +13,11 @@ import type {
     ImportSpecification
 } from './types';
 
+const MAPBOX_SOURCE_URL_RE = /^mapbox:\/\/([^/]*)$/;
+const MAPBOX_GLYPH_URL_RE = /^mapbox:\/\/fonts\/([^/]*)\/{fontstack}\/{range}.pbf$/;
+const MAPBOX_SPRITE_URL_RE = /^mapbox:\/\/sprites\/([^/]*)\/([^/]*)\/?([^/]*)?$/;
+const VISIBILITY_RE = /^(public|private)$/;
+
 type MapboxStyleSpecification = StyleSpecification & {
     visibility?: 'public' | 'private';
     protected?: boolean;
@@ -63,8 +68,7 @@ function getSourceErrors(source: SourceSpecification, i: number): Array<Validati
      * mapbox://penny.abcd1234
      * mapbox://mapbox.abcd1234,penny.abcd1234
      */
-    const sourceUrlPattern = /^mapbox:\/\/([^/]*)$/;
-    if (!('url' in source) || !isValid(source.url, sourceUrlPattern)) {
+    if (!('url' in source) || !isValid(source.url, MAPBOX_SOURCE_URL_RE)) {
         errors.push(new ValidationError(`sources[${i}].url`, (source as {url?: string}).url, 'Expected a valid Mapbox tileset url'));
     }
 
@@ -166,8 +170,7 @@ function getRootErrors(style: MapboxStyleSpecification, specKeys: string[]): Arr
      * mapbox://fonts/penny/{fontstack}/{range}.pbf
      * mapbox://fonts/mapbox/{fontstack}/{range}.pbf
      */
-    const glyphUrlPattern = /^mapbox:\/\/fonts\/([^/]*)\/{fontstack}\/{range}.pbf$/;
-    if (!isValid(style.glyphs, glyphUrlPattern)) {
+    if (!isValid(style.glyphs, MAPBOX_GLYPH_URL_RE)) {
         errors.push(new ValidationError('glyphs', style.glyphs, 'Styles must reference glyphs hosted by Mapbox'));
     }
 
@@ -177,8 +180,7 @@ function getRootErrors(style: MapboxStyleSpecification, specKeys: string[]): Arr
      * mapbox://sprites/mapbox/abcd1234/draft
      * mapbox://sprites/cyrus/abcd1234/abcd1234
      */
-    const spriteUrlPattern = /^mapbox:\/\/sprites\/([^/]*)\/([^/]*)\/?([^/]*)?$/;
-    if (!isValid(style.sprite, spriteUrlPattern)) {
+    if (!isValid(style.sprite, MAPBOX_SPRITE_URL_RE)) {
         errors.push(new ValidationError('sprite', style.sprite, 'Styles must reference sprites hosted by Mapbox'));
     }
 
@@ -187,8 +189,7 @@ function getRootErrors(style: MapboxStyleSpecification, specKeys: string[]): Arr
      * "private"
      * "public"
      */
-    const visibilityPattern = /^(public|private)$/;
-    if (!isValid(style.visibility, visibilityPattern)) {
+    if (!isValid(style.visibility, VISIBILITY_RE)) {
         errors.push(new ValidationError('visibility', style.visibility, 'Style visibility must be public or private'));
     }