@mapbox/mapbox-gl-style-spec 14.16.0-beta.1 → 14.16.0-beta.3

package/expression/definitions/index.ts

@@ -266,6 +266,19 @@ CompoundExpression.register(expressions, {
         [],
         (ctx) => ctx.globals.worldview || ""
     ],
+    'is-active-floor': [
+        BooleanType,
+        varargs(StringType),
+        (ctx, args) => {
+            const hasActiveFloors = ctx.globals.activeFloors && ctx.globals.activeFloors.size > 0;
+            if (!hasActiveFloors) { return false; }
+            const floorIds: Set<string> = ctx.globals.activeFloors;
+            return args.some(arg => {
+                const value = arg.evaluate(ctx) as string;
+                return floorIds.has(value);
+            });
+        }
+    ],
     'id': [
         ValueType,
         [],

package/expression/expression_dependencies.ts

@@ -0,0 +1,33 @@
+import CompoundExpression from "./compound_expression";
+import Config from "./definitions/config";
+
+import type {Expression} from "./expression";
+
+function getConfigDependencies(e: Expression): Set<string> {
+    if (e instanceof Config) {
+        const singleConfig = new Set([e.key]);
+        return singleConfig;
+    }
+
+    let result = new Set<string>();
+    e.eachChild(arg => {
+        result = new Set([...result, ...getConfigDependencies(arg)]);
+    });
+    return result;
+}
+
+function isIndoorDependent(e: Expression): boolean {
+    if (e instanceof CompoundExpression && e.name === 'is-active-floor') {
+        return true;
+    }
+
+    let result = false;
+    e.eachChild(arg => {
+        if (!result && isIndoorDependent(arg)) {
+            result = true;
+        }
+    });
+    return result;
+}
+
+export {getConfigDependencies, isIndoorDependent};

package/expression/index.ts

@@ -9,6 +9,7 @@ import Coalesce from './definitions/coalesce';
 import Let from './definitions/let';
 import definitions from './definitions/index';
 import * as isConstant from './is_constant';
+import * as expressionDependencies from './expression_dependencies';
 import RuntimeError from './runtime_error';
 import {success, error} from '../util/result';
 import {
@@ -60,16 +61,17 @@ export interface GlobalProperties {
     accumulated?: Value;
     brightness?: number;
     worldview?: string;
+    activeFloors?: Set<string>;
 }
 
 export class StyleExpression {
     expression: Expression;
-
     _evaluator: EvaluationContext;
     _defaultValue: Value;
     _warningHistory: {[key: string]: boolean};
     _enumValues?: {[_: string]: unknown};
     configDependencies: Set<string>;
+    isIndoorDependent: boolean;
 
     constructor(expression: Expression, propertySpec?: StylePropertySpecification, scope?: string, options?: ConfigOptions, iconImageUseTheme?: string) {
         this.expression = expression;
@@ -77,7 +79,8 @@ export class StyleExpression {
         this._evaluator = new EvaluationContext(scope, options, iconImageUseTheme);
         this._defaultValue = propertySpec ? getDefaultValue(propertySpec) : null;
         this._enumValues = propertySpec && propertySpec.type === 'enum' ? propertySpec.values : null;
-        this.configDependencies = isConstant.getConfigDependencies(expression);
+        this.configDependencies = expressionDependencies.getConfigDependencies(expression);
+        this.isIndoorDependent = expressionDependencies.isIndoorDependent(expression);
     }
 
     evaluateWithoutErrorHandling(
@@ -124,7 +127,6 @@ export class StyleExpression {
         this._evaluator.featureTileCoord = featureTileCoord || null;
         this._evaluator.featureDistanceData = featureDistanceData || null;
         this._evaluator.iconImageUseTheme = iconImageUseTheme || null;
-
         try {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             const val = this.expression.evaluate(this._evaluator);
@@ -190,6 +192,7 @@ export class ZoomConstantExpression<Kind extends EvaluationKind> {
     kind: Kind;
     isStateDependent: boolean;
     configDependencies: Set<string>;
+    isIndoorDependent: boolean;
     _styleExpression: StyleExpression;
     isLightConstant: boolean | null | undefined;
     isLineProgressConstant: boolean | null | undefined;
@@ -200,7 +203,8 @@ export class ZoomConstantExpression<Kind extends EvaluationKind> {
         this.isLightConstant = isLightConstant;
         this.isLineProgressConstant = isLineProgressConstant;
         this.isStateDependent = kind !== ('constant' as EvaluationKind) && !isConstant.isStateConstant(expression.expression);
-        this.configDependencies = isConstant.getConfigDependencies(expression.expression);
+        this.configDependencies = expressionDependencies.getConfigDependencies(expression.expression);
+        this.isIndoorDependent = expressionDependencies.isIndoorDependent(expression.expression);
     }
 
     evaluateWithoutErrorHandling(
@@ -233,6 +237,7 @@ export class ZoomDependentExpression<Kind extends EvaluationKind> {
     kind: Kind;
     zoomStops: Array<number>;
     isStateDependent: boolean;
+    isIndoorDependent: boolean;
     isLightConstant: boolean | null | undefined;
     isLineProgressConstant: boolean | null | undefined;
     configDependencies: Set<string>;
@@ -245,9 +250,10 @@ export class ZoomDependentExpression<Kind extends EvaluationKind> {
         this.zoomStops = zoomStops;
         this._styleExpression = expression;
         this.isStateDependent = kind !== ('camera' as EvaluationKind) && !isConstant.isStateConstant(expression.expression);
+        this.isIndoorDependent = expressionDependencies.isIndoorDependent(expression.expression);
         this.isLightConstant = isLightConstant;
         this.isLineProgressConstant = isLineProgressConstant;
-        this.configDependencies = isConstant.getConfigDependencies(expression.expression);
+        this.configDependencies = expressionDependencies.getConfigDependencies(expression.expression);
         this.interpolationType = interpolationType;
     }
 
@@ -287,6 +293,7 @@ export class ZoomDependentExpression<Kind extends EvaluationKind> {
 export type ConstantExpression = {
     kind: 'constant';
     configDependencies: Set<string>;
+    isIndoorDependent: boolean;
     readonly evaluate: <T = unknown>(
         globals: GlobalProperties,
         feature?: Feature,
@@ -301,6 +308,7 @@ export type ConstantExpression = {
 export type SourceExpression = {
     kind: 'source';
     isStateDependent: boolean;
+    isIndoorDependent: boolean;
     isLightConstant: boolean | null | undefined;
     isLineProgressConstant: boolean | null | undefined;
     configDependencies: Set<string>;
@@ -317,6 +325,7 @@ export type SourceExpression = {
 export type CameraExpression = {
     kind: 'camera';
     isStateDependent: boolean;
+    isIndoorDependent: boolean;
     configDependencies: Set<string>;
     readonly evaluate: <T = unknown>(
         globals: GlobalProperties,
@@ -333,6 +342,7 @@ export type CameraExpression = {
 export interface CompositeExpression {
     kind: 'composite';
     isStateDependent: boolean;
+    isIndoorDependent: boolean;
     isLightConstant: boolean | null | undefined;
     isLineProgressConstant: boolean | null | undefined;
     configDependencies: Set<string>;
@@ -484,6 +494,7 @@ export function normalizePropertyExpression<T>(
         return {
             kind: 'constant',
             configDependencies: new Set(),
+            isIndoorDependent: false,
             evaluate: () => constant
         } as ConstantExpression;
     }

package/expression/is_constant.ts

@@ -56,19 +56,6 @@ function isStateConstant(e: Expression): boolean {
     return result;
 }
 
-function getConfigDependencies(e: Expression): Set<string> {
-    if (e instanceof Config) {
-        const singleConfig = new Set([e.key]);
-        return singleConfig;
-    }
-
-    let result = new Set<string>();
-    e.eachChild(arg => {
-        result = new Set([...result, ...getConfigDependencies(arg)]);
-    });
-    return result;
-}
-
 function isGlobalPropertyConstant(e: Expression, properties: Array<string>): boolean {
     if (e instanceof CompoundExpression && properties.indexOf(e.name) >= 0) { return false; }
     let result = true;
@@ -78,4 +65,4 @@ function isGlobalPropertyConstant(e: Expression, properties: Array<string>): boo
     return result;
 }
 
-export {isFeatureConstant, isGlobalPropertyConstant, isStateConstant, getConfigDependencies};
+export {isFeatureConstant, isGlobalPropertyConstant, isStateConstant};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/mapbox-gl-style-spec",
-  "version": "14.16.0-beta.1",
+  "version": "14.16.0-beta.3",
   "description": "a specification for mapbox gl styles",
   "author": "Mapbox",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -21,7 +21,8 @@
   "exports": {
     ".": {
       "require": "./dist/index.cjs",
-      "import": "./dist/index.es.js"
+      "import": "./dist/index.es.js",
+      "types": "./dist/index.d.ts"
     },
     "./": {
       "import": "./"

package/reference/v8.json

@@ -125,6 +125,7 @@
     },
     "indoor": {
       "type": "indoor",
+      "private": true,
       "experimental": true,
       "doc": "Controls the behaviour of indoor features."
     },
@@ -5746,6 +5747,19 @@
           }
         }
       },
+      "is-active-floor": {
+        "doc": "Experimental. Returns `true` if the input floor id belongs to one of the active indoor floors, `false` otherwise. In case of array of strings, returns `true` if any of the input floor ids belongs to one of the active indoor floors, `false` otherwise. Only supported in filters.",
+        "group": "Indoor",
+        "experimental": true,
+        "private": true,
+        "sdk-support": {
+          "basic functionality": {
+            "js": "3.16.0",
+            "android": "11.16.0",
+            "ios": "11.16.0"
+          }
+        }
+      },
       "random": {
         "doc": "Returns a random value in the specified range (first two input numbers) based on a supplied seed (third input). The seed can be an expression or a constant number or string value.",
         "group": "Math",
@@ -6574,26 +6588,29 @@
       }
     }
   },
-  "indoor": {
-    "floorplanFeaturesetId": {
+  "indoor_source": {
+    "sourceId": {
       "type": "string",
-      "doc": "An ID of a featureset to be used to query indoor floorplans.",
+      "doc": "Source ID of a source to be used to retrieve indoor data.",
       "experimental": true,
+      "private": true,
       "transition": false,
-      "property-type": "data-constant",
-      "expression": {
-        "interpolated": false
-      }
+      "property-type": "data-constant"
     },
-    "buildingFeaturesetId": {
-      "type": "string",
-      "doc": "An ID of a featureset to be used to add interactivity for building selection.",
+    "sourceLayers": {
+      "type": "array",
+      "value": "string",
+      "doc": "An array of source layers to be used to retrieve indoor data.",
       "experimental": true,
+      "private": true,
       "transition": false,
-      "property-type": "data-constant",
-      "expression": {
-        "interpolated": false
-      }
+      "property-type": "data-constant"
+    }
+  },
+  "indoor": {
+    "*": {
+      "type": "indoor_source",
+      "doc": "Specification of an indoor source - sourceId and sourceLayer required for vector source, for GeoJSON sourceLayers should be omitted."
     }
   },
   "light": {

package/types.ts

@@ -329,14 +329,18 @@ export type ImportSpecification = {
 };
 
 export type IndoorSpecification = {
+    [_: string]: IndoorSourceSpecification
+};
+
+export type IndoorSourceSpecification = {
     /**
      * @experimental This property is experimental and subject to change in future versions.
      */
-    "floorplanFeaturesetId"?: ExpressionSpecification,
+    "sourceId"?: string,
     /**
      * @experimental This property is experimental and subject to change in future versions.
      */
-    "buildingFeaturesetId"?: ExpressionSpecification
+    "sourceLayers"?: Array<string>
 };
 
 export type ConfigSpecification = {

package/validate/validate_appearance.ts

@@ -7,6 +7,7 @@ import latest from '../reference/latest';
 
 import type {StyleSpecification, LayerSpecification, AppearanceSpecification} from '../types';
 import type {StyleReference} from '../reference/latest';
+import type {StylePropertySpecification} from '../style-spec';
 
 export type AppearanceValidatorOptions = {
     key: string;
@@ -37,7 +38,7 @@ export default function validateAppearance(options: AppearanceValidatorOptions):
         }
     });
 
-    if (name !== 'hidden' && !condition) {
+    if (name !== 'hidden' && condition === undefined) {
         errors.push(new ValidationError(options.key, 'name', `Appearance with name different than "hidden" must have a condition`));
     }
 
@@ -49,10 +50,8 @@ function validateProperties(options: AppearanceValidatorOptions): Array<Validati
 
     const {styleSpec, layer, layerType} = options;
 
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const paintProperties = styleSpec[`paint_${layerType}`];
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const layoutProperties = styleSpec[`layout_${layerType}`];
+    const paintProperties = styleSpec[`paint_${layerType}`] as Record<string, StylePropertySpecification> | undefined;
+    const layoutProperties = styleSpec[`layout_${layerType}`] as Record<string, StylePropertySpecification> | undefined;
     const properties = options.object[options.objectKey] as object;
 
     for (const propertyKey in properties) {
@@ -73,8 +72,7 @@ function validateProperties(options: AppearanceValidatorOptions): Array<Validati
             layer,
             layerType,
             value: properties[propertyKey] as unknown,
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-            valueSpec: (propertyType === 'paint' ? paintProperties[propertyKey] : layoutProperties[propertyKey]) as object,
+            valueSpec: (propertyType === 'paint' ? paintProperties[propertyKey] : layoutProperties[propertyKey]),
         });
 
         errors.push(...validateProperty(propertyValidationOptions, propertyType));

package/validate/validate_expression.ts

@@ -4,7 +4,7 @@ import {deepUnbundle} from '../util/unbundle_jsonlint';
 import {isStateConstant, isGlobalPropertyConstant, isFeatureConstant} from '../expression/is_constant';
 import CompoundExpression from '../expression/compound_expression';
 
-import type {StylePropertySpecification} from '../../style-spec/style-spec';
+import type {StylePropertySpecification} from '../style-spec';
 import type {Expression} from '../expression/expression';
 import type {StyleReference} from '../reference/latest';
 import type {StyleSpecification} from '../types';

package/validate/validate_filter.ts

@@ -59,14 +59,12 @@ function validateNonExpressionFilter(options: FilterValidatorOptions): Validatio
     case '<':
     case '<=':
     case '>':
-    // @ts-expect-error - falls through
     case '>=':
         if (value.length >= 2 && unbundle(value[1]) === '$type') {
             errors.push(new ValidationError(key, value, `"$type" cannot be use with operator "${value[0]}"`));
         }
         /* falls through */
     case '==':
-    // @ts-expect-error - falls through
     case '!=':
         if (value.length !== 3) {
             errors.push(new ValidationError(key, value, `filter array for operator "${value[0]}" must have 3 elements`));

package/validate/validate_layer.ts

@@ -10,6 +10,7 @@ import validateSpec from './validate';
 import {isObject, isString} from '../util/get_type';
 
 import type {StyleReference} from '../reference/latest';
+import type {PropertyValidatorOptions} from './validate_property';
 import type {StyleSpecification, LayerSpecification, GeoJSONSourceSpecification} from '../types';
 
 type LayerValidatorOptions = {
@@ -138,7 +139,7 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
                     style: options.style,
                     styleSpec: options.styleSpec,
                     objectElementValidators: {
-                        '*'(options) {
+                        '*'(options: PropertyValidatorOptions) {
                             return validateLayoutProperty(Object.assign({layerType: type}, options));
                         }
                     }
@@ -153,7 +154,7 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
                     style: options.style,
                     styleSpec: options.styleSpec,
                     objectElementValidators: {
-                        '*'(options) {
+                        '*'(options: PropertyValidatorOptions) {
                             return validatePaintProperty(Object.assign({layerType: type, layer}, options));
                         }
                     }

package/validate/validate_property.ts

@@ -8,12 +8,13 @@ import {isGlobalPropertyConstant, isFeatureConstant, isStateConstant} from '../e
 import {createPropertyExpression, isExpression} from '../expression/index';
 
 import type {StyleReference} from '../reference/latest';
+import type {StylePropertySpecification} from '../style-spec';
 import type {StyleSpecification, LayerSpecification} from '../types';
 
 export type PropertyValidatorOptions = {
     key: string;
     value: unknown;
-    valueSpec?: unknown;
+    valueSpec?: StylePropertySpecification;
     style: Partial<StyleSpecification>;
     styleSpec: StyleReference;
     objectKey?: string;
@@ -28,29 +29,24 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
     const styleSpec = options.styleSpec;
     const value = options.value;
     const propertyKey = options.objectKey;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const layerSpec = styleSpec[`${propertyType}_${options.layerType}`];
+    const layerSpec = styleSpec[`${propertyType}_${options.layerType}`] as Record<string, StylePropertySpecification> | undefined;
 
     if (!layerSpec) return [];
 
     const useThemeMatch = propertyKey.match(/^(.*)-use-theme$/);
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     if (useThemeMatch && layerSpec[useThemeMatch[1]]) {
-        if (isExpression(value)) {
+        if (isExpression(deepUnbundle(value))) {
             const errors: ValidationError[] = [];
             return errors.concat(validate({
-                key: options.key,
+                key,
                 value,
                 valueSpec: {
-                    "type": "string",
-                    "expression": {
-                        "interpolated": false,
-                        "parameters": [
-                            "zoom",
-                            "feature"
-                        ]
+                    type: 'string',
+                    expression: {
+                        interpolated: false,
+                        parameters: ['zoom', 'feature']
                     },
-                    "property-type": "data-driven"
+                    'property-type': 'data-driven'
                 },
                 style,
                 styleSpec,
@@ -59,6 +55,7 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
                 propertyKey
             }));
         }
+
         return validate({
             key,
             value,
@@ -69,7 +66,6 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
     }
 
     const transitionMatch = propertyKey.match(/^(.*)-transition$/);
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     if (propertyType === 'paint' && transitionMatch && layerSpec[transitionMatch[1]] && layerSpec[transitionMatch[1]].transition) {
         return validate({
             key,
@@ -81,14 +77,12 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
         });
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
     const valueSpec = options.valueSpec || layerSpec[propertyKey];
     if (!valueSpec) {
         return [new ValidationWarning(key, value, `unknown property "${propertyKey}"`)];
     }
 
     let tokenMatch: RegExpExecArray | undefined;
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
     if (isString(value) && supportsPropertyExpression(valueSpec) && !valueSpec.tokens && (tokenMatch = /^{([^}]+)}$/.exec(value))) {
         const example = `\`{ "type": "identity", "property": ${tokenMatch ? JSON.stringify(tokenMatch[1]) : '"_"'} }\``;
         return [new ValidationError(
@@ -107,10 +101,8 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
             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')) {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         if (supportsPropertyExpression(valueSpec) && (supportsLightExpression(valueSpec) || supportsZoomExpression(valueSpec))) {
             // Performance related style spec limitation: zoom and light expressions are not allowed for e.g. trees.
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             const expression = createPropertyExpression(deepUnbundle(value), valueSpec);
             // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
             const expressionObj = (expression.value as any).expression || (expression.value as any)._styleExpression.expression;
@@ -128,7 +120,6 @@ export default function validateProperty(options: PropertyValidatorOptions, prop
     return errors.concat(validate({
         key: options.key,
         value,
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         valueSpec,
         style,
         styleSpec,