@tangram.gl/basemap-layers 0.0.0-stage → 0.0.0

package/src/mapbox-style.ts

@@ -0,0 +1,168 @@
+// tangram-layers
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {
+  compileStyleFilter,
+  getCompiledStyleProperty,
+  getStylePropertyReference
+} from './style-expression';
+
+type GlobalProperties = {
+  zoom?: number;
+  [key: string]: unknown;
+};
+
+type GeometryLike = {
+  type: string;
+};
+
+type FeatureLike = {
+  type?: number | string;
+  geometry?: GeometryLike;
+  properties?: Record<string, unknown>;
+};
+
+type FilterFeaturesOptions = {
+  features: FeatureLike[];
+  filter: unknown[];
+  globalProperties?: GlobalProperties;
+};
+
+type FindFeaturesStyledByLayerOptions = {
+  features: Record<string, Record<string, FeatureLike[]>>;
+  layer: {
+    source?: string;
+    'source-layer'?: string;
+    filter?: unknown[];
+  };
+  globalProperties?: GlobalProperties;
+};
+
+type PropertyReference = Record<string, unknown> | null;
+
+type VisitedProperty = {
+  layer: Record<string, any>;
+  path: string[];
+  key: string;
+  value: unknown;
+  reference: PropertyReference;
+  set: (value: unknown) => void;
+};
+
+type VisitOptions = {
+  paint?: boolean;
+  layout?: boolean;
+};
+
+/**
+ * Applies a Mapbox style-spec filter expression to a set of features.
+ */
+export function filterFeatures({
+  features,
+  filter,
+  globalProperties = {}
+}: FilterFeaturesOptions): FeatureLike[] {
+  if (!features || features.length === 0) {
+    return [];
+  }
+
+  const filterFn = compileStyleFilter(filter);
+
+  // `compileStyleFilter` derives the geometry type itself, so the features are not modified.
+  return features.filter(feature => filterFn(globalProperties, feature));
+}
+
+/**
+ * Finds the source-layer features that participate in a particular style layer
+ * and applies the layer's filter expression when present.
+ */
+export function findFeaturesStyledByLayer({
+  features,
+  layer,
+  globalProperties
+}: FindFeaturesStyledByLayerOptions): FeatureLike[] {
+  const sourceLayerFeatures = features[layer.source || '']?.[layer['source-layer'] || ''];
+  if (!sourceLayerFeatures) {
+    return [];
+  }
+
+  if (layer.filter && layer.filter.length > 0) {
+    return filterFeatures({
+      features: sourceLayerFeatures,
+      filter: layer.filter,
+      globalProperties
+    });
+  }
+
+  return sourceLayerFeatures;
+}
+
+/**
+ * Evaluates paint properties for a style layer at the requested zoom.
+ */
+export function parseProperties(
+  layer: Record<string, any>,
+  globalProperties: GlobalProperties
+): Array<Record<string, unknown>> {
+  const layerProperties: Array<Record<string, unknown>> = [];
+  visitProperties(layer, {paint: true}, property => {
+    layerProperties.push(parseProperty(property, globalProperties));
+  });
+
+  return layerProperties;
+}
+
+/**
+ * Walks layout and paint properties for a style layer.
+ */
+function visitProperties(
+  layer: Record<string, any>,
+  options: VisitOptions,
+  callback: (property: VisitedProperty) => void
+): void {
+  function inner(targetLayer: Record<string, any>, propertyType: 'paint' | 'layout') {
+    const properties = targetLayer[propertyType];
+    if (!properties) {
+      return;
+    }
+
+    Object.keys(properties).forEach(key => {
+      callback({
+        layer: targetLayer,
+        path: [targetLayer.id, propertyType, key],
+        key,
+        value: properties[key],
+        reference: getStylePropertyReference(key),
+        set(value) {
+          properties[key] = value;
+        }
+      });
+    });
+  }
+
+  if (options.paint) {
+    inner(layer, 'paint');
+  }
+  if (options.layout) {
+    inner(layer, 'layout');
+  }
+}
+
+/**
+ * Evaluates a single style property expression.
+ */
+function parseProperty(
+  property: VisitedProperty,
+  globalProperties: GlobalProperties
+): Record<string, unknown> {
+  const compiled = getCompiledStyleProperty(property.layer, property.key);
+  return {
+    [property.key]: compiled?.evaluateWithGlobals({
+      ...globalProperties,
+      zoom: globalProperties.zoom ?? 0
+    })
+  };
+}
+
+export {colorToArray} from './style-expression';