@mapbox/mapbox-gl-style-spec 14.11.0-beta.1 → 14.11.0

package/dist/index.d.ts

@@ -1498,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;
@@ -1583,8 +1596,7 @@ type ResolvedImageTypeT = {
 	kind: "resolvedImage";
 };
 type EvaluationKind = "constant" | "source" | "camera" | "composite";
-type Type = NullTypeT | NumberTypeT | StringTypeT | BooleanTypeT | ColorTypeT | ObjectTypeT | ValueTypeT | // eslint-disable-line no-use-before-define
-ArrayType | ErrorTypeT | CollatorTypeT | FormattedTypeT | ResolvedImageTypeT;
+type Type = NullTypeT | NumberTypeT | StringTypeT | BooleanTypeT | ColorTypeT | ObjectTypeT | ValueTypeT | ArrayType | ErrorTypeT | CollatorTypeT | FormattedTypeT | ResolvedImageTypeT;
 type ArrayType = {
 	kind: "array";
 	itemType: Type;
@@ -1656,7 +1668,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;
@@ -1737,8 +1749,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>>;
@@ -1750,8 +1762,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;
@@ -1763,14 +1775,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";
@@ -1778,13 +1790,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;
@@ -1795,7 +1807,7 @@ 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;
@@ -1894,7 +1906,7 @@ type ValidationErrors = ReadonlyArray<ValidationError$1>;
  *   var style = fs.readFileSync('./style.json', 'utf8');
  *   var errors = validate(style);
  */
-declare function validateStyle(style: StyleSpecification | string | Buffer, styleSpec?: any): ValidationErrors;
+declare function validateStyle(style: StyleSpecification | string | Buffer, styleSpec?: StyleReference): ValidationErrors;
 /**
  * Validate a Mapbox GL style against the style specification and check for
  * compatibility with the Mapbox Styles API.