@mapbox/mapbox-gl-style-spec 14.10.0 → 14.11.0-beta.2

package/dist/index.d.ts

@@ -209,6 +209,10 @@ type StyleSpecification = {
 	 */
 	"indoor"?: IndoorSpecification;
 	"imports"?: Array<ImportSpecification>;
+	/**
+	 * @experimental This property is experimental and subject to change in future versions.
+	 */
+	"iconsets"?: IconsetsSpecification;
 	"schema"?: SchemaSpecification;
 	"sources": SourcesSpecification;
 	"sprite"?: string;
@@ -228,6 +232,9 @@ type SourcesSpecification = {
 type ModelsSpecification = {
 	[_: string]: ModelSpecification;
 };
+type IconsetsSpecification = {
+	[_: string]: IconsetSpecification;
+};
 type LightSpecification = {
 	"anchor"?: PropertyValueSpecification<"map" | "viewport">;
 	"position"?: PropertyValueSpecification<[
@@ -557,6 +564,13 @@ type ModelSourceSpecification = {
 	"tiles"?: Array<string>;
 };
 type SourceSpecification = VectorSourceSpecification | RasterSourceSpecification | RasterDEMSourceSpecification | RasterArraySourceSpecification | GeoJSONSourceSpecification | VideoSourceSpecification | ImageSourceSpecification | ModelSourceSpecification;
+type IconsetSpecification = {
+	"type": "sprite";
+	"url": string;
+} | {
+	"type": "source";
+	"source": string;
+};
 type ModelSpecification = string;
 type AmbientLightSpecification = {
 	"id": string;
@@ -628,6 +642,10 @@ type FillLayerSpecification = {
 		 * @experimental This property is experimental and subject to change in future versions.
 		 */
 		"fill-elevation-reference"?: "none" | "hd-road-base" | "hd-road-markup" | ExpressionSpecification;
+		/**
+		 * @experimental This property is experimental and subject to change in future versions.
+		 */
+		"fill-construct-bridge-guard-rail"?: DataDrivenPropertyValueSpecification<boolean>;
 	};
 	"paint"?: {
 		"fill-antialias"?: PropertyValueSpecification<boolean>;
@@ -650,6 +668,12 @@ type FillLayerSpecification = {
 		"fill-emissive-strength-transition"?: TransitionSpecification;
 		"fill-z-offset"?: DataDrivenPropertyValueSpecification<number>;
 		"fill-z-offset-transition"?: TransitionSpecification;
+		"fill-bridge-guard-rail-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
+		"fill-bridge-guard-rail-color-transition"?: TransitionSpecification;
+		"fill-bridge-guard-rail-color-use-theme"?: PropertyValueSpecification<string>;
+		"fill-tunnel-structure-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
+		"fill-tunnel-structure-color-transition"?: TransitionSpecification;
+		"fill-tunnel-structure-color-use-theme"?: PropertyValueSpecification<string>;
 	};
 };
 type LineLayerSpecification = {
@@ -1376,7 +1400,7 @@ export declare class Color {
 	 * Parses valid CSS color strings and returns a `Color` instance.
 	 * @returns A `Color` instance, or `undefined` if the input is not a valid color string.
 	 */
-	static parse(input?: string | Color | null): Color | void;
+	static parse(input?: string | Color | null): Color | undefined;
 	/**
 	 * Returns an RGBA string representing the color value.
 	 *
@@ -1474,39 +1498,52 @@ declare class Collator {
 	compare(lhs: string, rhs: string): number;
 	resolvedLocale(): string;
 }
-declare class ImageIdWithOptions {
-	id: string;
-	options: RasterizationOptions;
-	constructor(id: string, options?: RasterizationOptions);
-	static deserializeId(serialized: string): string;
-	static deserializeFromString(serialized: string): ImageIdWithOptions;
-	scaleSelf(factor: number): this;
-	serialize(): string;
+type Brand<T, U> = T & {
+	__brand: U;
+};
+type ImageIdSpec = {
+	name: string;
+	iconsetId?: string;
+};
+type StringifiedImageId = Brand<string, "ImageId">;
+declare class ImageId {
+	name: string;
+	iconsetId?: string;
+	constructor(id: string | ImageId | ImageIdSpec);
+	static from(id: string | ImageId | ImageIdSpec): ImageId;
+	static toString(id: ImageId | ImageIdSpec): StringifiedImageId;
+	static parse(str: StringifiedImageId): ImageId | null;
+	static isEqual(a: ImageId | ImageIdSpec, b: ImageId | ImageIdSpec): boolean;
+	toString(): StringifiedImageId;
+	serialize(): ImageIdSpec;
 }
+type StringifiedImageVariant = Brand<string, "ImageVariant">;
 type RasterizationOptions = {
-	params: Record<string, Color>;
+	params?: Record<string, Color>;
 	transform?: DOMMatrix;
 };
-type ResolvedImageOptions = {
-	namePrimary: string;
-	optionsPrimary: RasterizationOptions | null | undefined;
-	nameSecondary: string | null | undefined;
-	optionsSecondary: RasterizationOptions | null | undefined;
-	available: boolean;
-};
+declare class ImageVariant {
+	id: ImageId;
+	options: RasterizationOptions;
+	constructor(id: string | ImageIdSpec, options?: RasterizationOptions);
+	toString(): StringifiedImageVariant;
+	static parse(str: StringifiedImageVariant): ImageVariant | null;
+	scaleSelf(factor: number): this;
+}
 declare class ResolvedImage {
-	namePrimary: string;
-	optionsPrimary: RasterizationOptions | null | undefined;
-	nameSecondary: string | null | undefined;
-	optionsSecondary: RasterizationOptions | null | undefined;
+	primaryId: ImageId;
+	primaryOptions?: RasterizationOptions;
+	secondaryId?: ImageId;
+	secondaryOptions?: RasterizationOptions;
 	available: boolean;
-	constructor(options: ResolvedImageOptions);
+	constructor(primaryId: string | ImageIdSpec, primaryOptions?: RasterizationOptions, secondaryId?: string | ImageIdSpec, secondaryOptions?: RasterizationOptions, available?: boolean);
 	toString(): string;
-	getPrimary(): ImageIdWithOptions;
-	getSerializedPrimary(): string;
-	getSecondary(): ImageIdWithOptions | null;
+	hasPrimary(): boolean;
+	getPrimary(): ImageVariant;
+	hasSecondary(): boolean;
+	getSecondary(): ImageVariant | null;
 	static from(image: string | ResolvedImage): ResolvedImage;
-	static build(namePrimary: string, nameSecondary?: string | null, optionsPrimary?: RasterizationOptions | null, optionsSecondary?: RasterizationOptions | null): ResolvedImage | null;
+	static build(primaryId: string | ImageIdSpec, secondaryId?: string | ImageIdSpec, primaryOptions?: RasterizationOptions, secondaryOptions?: RasterizationOptions): ResolvedImage | null;
 }
 declare class FormattedSection {
 	text: string;
@@ -1632,7 +1669,7 @@ declare class EvaluationContext {
 	feature: Feature | null | undefined;
 	featureState: FeatureState | null | undefined;
 	formattedSection: FormattedSection | null | undefined;
-	availableImages: Array<string> | null | undefined;
+	availableImages: ImageId[] | null | undefined;
 	canonical: null | CanonicalTileID;
 	featureTileCoord: Point | null | undefined;
 	featureDistanceData: FeatureDistanceData | null | undefined;
@@ -1651,7 +1688,7 @@ declare class EvaluationContext {
 	};
 	measureLight(_: string): number;
 	distanceFromCenter(): number;
-	parseColor(input: string): Color | null | undefined;
+	parseColor(input: string): Color | undefined;
 	getConfig(id: string): ConfigOptionValue | null | undefined;
 }
 type Result<T, E> = {
@@ -1713,8 +1750,8 @@ declare class StyleExpression {
 	};
 	configDependencies: Set<string>;
 	constructor(expression: Expression, propertySpec?: StylePropertySpecification, scope?: string, options?: ConfigOptions);
-	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection, featureTileCoord?: Point, featureDistanceData?: FeatureDistanceData): any;
-	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection, featureTileCoord?: Point, featureDistanceData?: FeatureDistanceData): any;
+	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection, featureTileCoord?: Point, featureDistanceData?: FeatureDistanceData): any;
+	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection, featureTileCoord?: Point, featureDistanceData?: FeatureDistanceData): any;
 }
 declare function isExpression(expression: unknown): boolean;
 declare function createExpression(expression: unknown, propertySpec?: StylePropertySpecification | null, scope?: string | null, options?: ConfigOptions | null): Result<StyleExpression, Array<ParsingError$1>>;
@@ -1726,8 +1763,8 @@ declare class ZoomConstantExpression<Kind extends EvaluationKind> {
 	isLightConstant: boolean | null | undefined;
 	isLineProgressConstant: boolean | null | undefined;
 	constructor(kind: Kind, expression: StyleExpression, isLightConstant?: boolean | null, isLineProgressConstant?: boolean | null);
-	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection): any;
-	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection): any;
+	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection): any;
+	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection): any;
 }
 declare class ZoomDependentExpression<Kind extends EvaluationKind> {
 	kind: Kind;
@@ -1739,14 +1776,14 @@ declare class ZoomDependentExpression<Kind extends EvaluationKind> {
 	_styleExpression: StyleExpression;
 	interpolationType: InterpolationType | null | undefined;
 	constructor(kind: Kind, expression: StyleExpression, zoomStops: Array<number>, interpolationType?: InterpolationType, isLightConstant?: boolean | null, isLineProgressConstant?: boolean | null);
-	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection): any;
-	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection): any;
+	evaluateWithoutErrorHandling(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection): any;
+	evaluate(globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection): any;
 	interpolationFactor(input: number, lower: number, upper: number): number;
 }
 type ConstantExpression = {
 	kind: "constant";
 	configDependencies: Set<string>;
-	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>) => any;
+	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[]) => any;
 };
 type SourceExpression = {
 	kind: "source";
@@ -1754,13 +1791,13 @@ type SourceExpression = {
 	isLightConstant: boolean | null | undefined;
 	isLineProgressConstant: boolean | null | undefined;
 	configDependencies: Set<string>;
-	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection) => any;
+	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection) => any;
 };
 type CameraExpression = {
 	kind: "camera";
 	isStateDependent: boolean;
 	configDependencies: Set<string>;
-	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>) => any;
+	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[]) => any;
 	readonly interpolationFactor: (input: number, lower: number, upper: number) => number;
 	zoomStops: Array<number>;
 	interpolationType: InterpolationType | null | undefined;
@@ -1771,13 +1808,13 @@ interface CompositeExpression {
 	isLightConstant: boolean | null | undefined;
 	isLineProgressConstant: boolean | null | undefined;
 	configDependencies: Set<string>;
-	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: Array<string>, formattedSection?: FormattedSection) => any;
+	readonly evaluate: (globals: GlobalProperties, feature?: Feature, featureState?: FeatureState, canonical?: CanonicalTileID, availableImages?: ImageId[], formattedSection?: FormattedSection) => any;
 	readonly interpolationFactor: (input: number, lower: number, upper: number) => number;
 	zoomStops: Array<number>;
 	interpolationType: InterpolationType | null | undefined;
 }
 type StylePropertyExpression = ConstantExpression | SourceExpression | CameraExpression | CompositeExpression;
-declare function createPropertyExpression(expression: unknown, propertySpec: StylePropertySpecification, scope?: string | null, options?: ConfigOptions | null): Result<StylePropertyExpression, Array<ParsingError$1>>;
+declare function createPropertyExpression(expression: any, propertySpec: StylePropertySpecification, scope?: string | null, options?: ConfigOptions | null): Result<StylePropertyExpression, Array<ParsingError$1>>;
 declare class StylePropertyFunction<T> {
 	_parameters: PropertyValueSpecification<T>;
 	_specification: StylePropertySpecification;