@maplibre-yaml/core 0.1.2 → 0.1.3-beta.0

package/dist/schemas/index.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export { j as BackgroundLayerSchema, B as BaseLayerPropertiesSchema, p as BlockSchema, e as CircleLayerSchema, m as ControlPositionSchema, C as ControlsConfigSchema, h as FillExtrusionLayerSchema, F as FillLayerSchema, G as GlobalConfigSchema, H as HeatmapLayerSchema, i as HillshadeLayerSchema, I as InteractiveConfigSchema, l as LayerOrReferenceSchema, k as LayerReferenceSchema, L as LayerSchema, a as LegendConfigSchema, d as LegendItemSchema, f as LineLayerSchema, M as MapBlockSchema, b as MapConfigSchema, n as MapFullPageBlockSchema, o as MixedBlockSchema, q as PageSchema, c as PopupContentItemSchema, P as PopupContentSchema, g as RasterLayerSchema, R as RootSchema, S as SymbolLayerSchema } from '../page.schema-CzdCyPFI.js';
+export { k as BackgroundLayerSchema, B as BaseLayerPropertiesSchema, O as Block, G as BlockSchema, y as Chapter, z as ChapterAction, v as ChapterActionSchema, A as ChapterLayers, w as ChapterLayersSchema, x as ChapterSchema, e as CircleLayerSchema, p as ControlPosition, n as ControlPositionSchema, q as ControlsConfig, C as ControlsConfigSchema, i as FillExtrusionLayerSchema, F as FillLayerSchema, T as GlobalConfig, K as GlobalConfigSchema, H as HeatmapLayerSchema, j as HillshadeLayerSchema, I as InteractiveConfigSchema, m as LayerOrReferenceSchema, l as LayerReferenceSchema, L as LayerSchema, r as LegendConfig, a as LegendConfigSchema, d as LegendItemSchema, f as LineLayerSchema, t as MapBlock, M as MapBlockSchema, s as MapConfig, b as MapConfigSchema, u as MapFullPageBlock, o as MapFullPageBlockSchema, N as MixedBlock, E as MixedBlockSchema, Q as Page, J as PageSchema, c as PopupContentItemSchema, P as PopupContentSchema, h as RasterLayerSchema, U as RootConfig, R as RootSchema, D as ScrollytellingBlock, S as ScrollytellingBlockSchema, g as SymbolLayerSchema } from '../page.schema-VBytF9l5.js';
 
 /**
  * @file Base schemas for maplibre-yaml
@@ -2260,485 +2260,4 @@ declare const ContentBlockSchema: z.ZodObject<{
     className?: string | undefined;
 }>;
 
-/**
- * @file Scrollytelling schemas for maplibre-yaml
- * @module @maplibre-yaml/core/schemas/scrollytelling
- *
- * @description
- * Zod schemas for narrative scrollytelling maps with chapters, animations,
- * and layer transitions.
- *
- * @example
- * ```typescript
- * import { ScrollytellingBlockSchema, ChapterSchema } from '@maplibre-yaml/core/schemas';
- * ```
- */
-
-/**
- * Chapter action for map state changes.
- *
- * @remarks
- * Actions are triggered when entering or exiting a chapter.
- * They can modify layer properties, filters, or trigger animations.
- *
- * **Action Types:**
- * - `setFilter` - Update layer filter
- * - `setPaintProperty` - Update layer paint property
- * - `setLayoutProperty` - Update layer layout property
- * - `flyTo` - Fly to location (handled by chapter config)
- * - `easeTo` - Ease to location (handled by chapter config)
- * - `fitBounds` - Fit to bounds
- * - `custom` - Custom action (handled by application)
- *
- * @example Set Filter
- * ```yaml
- * onChapterEnter:
- *   - action: setFilter
- *     layer: earthquakes
- *     filter: [">=", ["get", "magnitude"], 5]
- * ```
- *
- * @example Set Paint Property
- * ```yaml
- * onChapterEnter:
- *   - action: setPaintProperty
- *     layer: buildings
- *     property: fill-extrusion-height
- *     value: ["get", "height"]
- * ```
- *
- * @example Fit Bounds
- * ```yaml
- * onChapterEnter:
- *   - action: fitBounds
- *     bounds: [-74.3, 40.5, -73.7, 40.9]
- *     options:
- *       padding: 50
- *       duration: 1000
- * ```
- */
-declare const ChapterActionSchema: z.ZodObject<{
-    action: z.ZodEnum<["setFilter", "setPaintProperty", "setLayoutProperty", "flyTo", "easeTo", "fitBounds", "custom"]>;
-    layer: z.ZodOptional<z.ZodString>;
-    property: z.ZodOptional<z.ZodString>;
-    value: z.ZodOptional<z.ZodAny>;
-    filter: z.ZodOptional<z.ZodNullable<z.ZodType<any[], z.ZodTypeDef, any[]>>>;
-    bounds: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
-    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, "strip", z.ZodTypeAny, {
-    action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-    value?: any;
-    filter?: any[] | null | undefined;
-    options?: Record<string, any> | undefined;
-    bounds?: number[] | undefined;
-    property?: string | undefined;
-    layer?: string | undefined;
-}, {
-    action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-    value?: any;
-    filter?: any[] | null | undefined;
-    options?: Record<string, any> | undefined;
-    bounds?: number[] | undefined;
-    property?: string | undefined;
-    layer?: string | undefined;
-}>;
-/**
- * Chapter layer visibility configuration.
- *
- * @remarks
- * Controls which layers are visible during this chapter.
- *
- * @example
- * ```yaml
- * layers:
- *   show:
- *     - earthquakes
- *     - fault-lines
- *   hide:
- *     - buildings
- * ```
- */
-declare const ChapterLayersSchema: z.ZodObject<{
-    show: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    hide: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodTypeAny, {
-    show: string[];
-    hide: string[];
-}, {
-    show?: string[] | undefined;
-    hide?: string[] | undefined;
-}>;
-/**
- * Scrollytelling chapter.
- *
- * @remarks
- * A chapter represents one section of the scrollytelling narrative.
- * As the user scrolls, the map transitions between chapters with
- * camera animations and layer changes.
- *
- * **Required:**
- * - `id` - Unique chapter identifier
- * - `title` - Chapter title
- * - `center` - Map center for this chapter
- * - `zoom` - Zoom level for this chapter
- *
- * **Content:**
- * - `description` - HTML description (supports markdown)
- * - `image` - Hero image URL
- * - `video` - Video URL
- *
- * **Camera:**
- * - `pitch` - Camera tilt (0-85)
- * - `bearing` - Camera rotation (-180 to 180)
- * - `animation` - Animation type (flyTo, easeTo, jumpTo)
- * - `speed`, `curve` - Animation parameters
- *
- * **Layout:**
- * - `alignment` - Content position (left, right, center, full)
- * - `hidden` - Hide chapter content (map-only)
- *
- * **Interactivity:**
- * - `layers` - Show/hide layers
- * - `onChapterEnter`, `onChapterExit` - Actions
- *
- * @example Basic Chapter
- * ```yaml
- * - id: intro
- *   title: "Welcome"
- *   description: "This is the introduction."
- *   center: [-74.006, 40.7128]
- *   zoom: 12
- * ```
- *
- * @example Chapter with 3D View
- * ```yaml
- * - id: downtown
- *   title: "Downtown"
- *   description: "Explore the city center in 3D."
- *   center: [-74.006, 40.7128]
- *   zoom: 16
- *   pitch: 60
- *   bearing: 30
- * ```
- *
- * @example Chapter with Media
- * ```yaml
- * - id: overview
- *   title: "City Overview"
- *   description: "A bird's eye view of the city."
- *   image: "https://example.com/overview.jpg"
- *   center: [-74.006, 40.7128]
- *   zoom: 10
- * ```
- *
- * @example Chapter with Layer Control
- * ```yaml
- * - id: earthquakes
- *   title: "Recent Earthquakes"
- *   description: "Major earthquakes in the last month."
- *   center: [-120, 35]
- *   zoom: 6
- *   layers:
- *     show:
- *       - earthquakes
- *       - fault-lines
- *     hide:
- *       - cities
- * ```
- *
- * @example Chapter with Actions
- * ```yaml
- * - id: filtered
- *   title: "High Magnitude Events"
- *   center: [-120, 35]
- *   zoom: 6
- *   onChapterEnter:
- *     - action: setFilter
- *       layer: earthquakes
- *       filter: [">=", ["get", "magnitude"], 5]
- *   onChapterExit:
- *     - action: setFilter
- *       layer: earthquakes
- *       filter: null
- * ```
- *
- * @example Full-Width Chapter
- * ```yaml
- * - id: fullwidth
- *   title: "Immersive View"
- *   alignment: full
- *   center: [-74.006, 40.7128]
- *   zoom: 14
- *   pitch: 45
- * ```
- */
-declare const ChapterSchema: z.ZodObject<{
-    id: z.ZodString;
-    title: z.ZodString;
-    center: z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>;
-    zoom: z.ZodNumber;
-    description: z.ZodOptional<z.ZodString>;
-    image: z.ZodOptional<z.ZodString>;
-    video: z.ZodOptional<z.ZodString>;
-    pitch: z.ZodDefault<z.ZodNumber>;
-    bearing: z.ZodDefault<z.ZodNumber>;
-    speed: z.ZodDefault<z.ZodNumber>;
-    curve: z.ZodDefault<z.ZodNumber>;
-    animation: z.ZodDefault<z.ZodEnum<["flyTo", "easeTo", "jumpTo"]>>;
-    rotateAnimation: z.ZodOptional<z.ZodBoolean>;
-    spinGlobe: z.ZodOptional<z.ZodBoolean>;
-    alignment: z.ZodDefault<z.ZodEnum<["left", "right", "center", "full"]>>;
-    hidden: z.ZodDefault<z.ZodBoolean>;
-    layers: z.ZodOptional<z.ZodObject<{
-        show: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-        hide: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        show: string[];
-        hide: string[];
-    }, {
-        show?: string[] | undefined;
-        hide?: string[] | undefined;
-    }>>;
-    onChapterEnter: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        action: z.ZodEnum<["setFilter", "setPaintProperty", "setLayoutProperty", "flyTo", "easeTo", "fitBounds", "custom"]>;
-        layer: z.ZodOptional<z.ZodString>;
-        property: z.ZodOptional<z.ZodString>;
-        value: z.ZodOptional<z.ZodAny>;
-        filter: z.ZodOptional<z.ZodNullable<z.ZodType<any[], z.ZodTypeDef, any[]>>>;
-        bounds: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
-        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }, {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }>, "many">>;
-    onChapterExit: z.ZodDefault<z.ZodArray<z.ZodObject<{
-        action: z.ZodEnum<["setFilter", "setPaintProperty", "setLayoutProperty", "flyTo", "easeTo", "fitBounds", "custom"]>;
-        layer: z.ZodOptional<z.ZodString>;
-        property: z.ZodOptional<z.ZodString>;
-        value: z.ZodOptional<z.ZodAny>;
-        filter: z.ZodOptional<z.ZodNullable<z.ZodType<any[], z.ZodTypeDef, any[]>>>;
-        bounds: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
-        options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, "strip", z.ZodTypeAny, {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }, {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }>, "many">>;
-    callback: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    center: [number, number];
-    zoom: number;
-    id: string;
-    title: string;
-    pitch: number;
-    bearing: number;
-    speed: number;
-    curve: number;
-    animation: "flyTo" | "easeTo" | "jumpTo";
-    alignment: "center" | "left" | "right" | "full";
-    hidden: boolean;
-    onChapterEnter: {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }[];
-    onChapterExit: {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }[];
-    image?: string | undefined;
-    video?: string | undefined;
-    layers?: {
-        show: string[];
-        hide: string[];
-    } | undefined;
-    description?: string | undefined;
-    rotateAnimation?: boolean | undefined;
-    spinGlobe?: boolean | undefined;
-    callback?: string | undefined;
-}, {
-    center: [number, number];
-    zoom: number;
-    id: string;
-    title: string;
-    image?: string | undefined;
-    video?: string | undefined;
-    pitch?: number | undefined;
-    bearing?: number | undefined;
-    layers?: {
-        show?: string[] | undefined;
-        hide?: string[] | undefined;
-    } | undefined;
-    description?: string | undefined;
-    speed?: number | undefined;
-    curve?: number | undefined;
-    animation?: "flyTo" | "easeTo" | "jumpTo" | undefined;
-    rotateAnimation?: boolean | undefined;
-    spinGlobe?: boolean | undefined;
-    alignment?: "center" | "left" | "right" | "full" | undefined;
-    hidden?: boolean | undefined;
-    onChapterEnter?: {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }[] | undefined;
-    onChapterExit?: {
-        action: "custom" | "flyTo" | "setFilter" | "setPaintProperty" | "setLayoutProperty" | "easeTo" | "fitBounds";
-        value?: any;
-        filter?: any[] | null | undefined;
-        options?: Record<string, any> | undefined;
-        bounds?: number[] | undefined;
-        property?: string | undefined;
-        layer?: string | undefined;
-    }[] | undefined;
-    callback?: string | undefined;
-}>;
-/**
- * Scrollytelling block for narrative map stories.
- *
- * @remarks
- * Creates an immersive scrollytelling experience where the map
- * transitions between chapters as the user scrolls through content.
- *
- * **Features:**
- * - Smooth camera transitions
- * - Layer show/hide animations
- * - Dynamic property updates
- * - Chapter-based narrative structure
- * - Customizable themes and markers
- *
- * **Structure:**
- * 1. Base map configuration (persistent)
- * 2. Persistent layers (visible throughout)
- * 3. Chapters (individual story sections)
- * 4. Optional footer
- *
- * @example Basic Scrollytelling
- * ```yaml
- * - type: scrollytelling
- *   id: story
- *   config:
- *     center: [-74.006, 40.7128]
- *     zoom: 12
- *     mapStyle: "https://demotiles.maplibre.org/style.json"
- *   chapters:
- *     - id: intro
- *       title: "Introduction"
- *       description: "Welcome to our story."
- *       center: [-74.006, 40.7128]
- *       zoom: 12
- *     - id: detail
- *       title: "A Closer Look"
- *       description: "Let's zoom in."
- *       center: [-74.006, 40.7128]
- *       zoom: 16
- * ```
- *
- * @example Themed Scrollytelling
- * ```yaml
- * - type: scrollytelling
- *   id: dark-story
- *   theme: dark
- *   showMarkers: true
- *   markerColor: "#ff0000"
- *   config:
- *     center: [0, 0]
- *     zoom: 2
- *     mapStyle: "https://demotiles.maplibre.org/style.json"
- *   chapters:
- *     - id: chapter1
- *       title: "Chapter 1"
- *       center: [0, 0]
- *       zoom: 3
- * ```
- *
- * @example With Persistent Layers
- * ```yaml
- * - type: scrollytelling
- *   id: earthquake-story
- *   config:
- *     center: [-120, 35]
- *     zoom: 5
- *     mapStyle: "https://demotiles.maplibre.org/style.json"
- *   layers:
- *     - id: base-layer
- *       type: circle
- *       source:
- *         type: geojson
- *         url: "https://example.com/data.geojson"
- *       paint:
- *         circle-radius: 6
- *         circle-color: "#888888"
- *   chapters:
- *     - id: overview
- *       title: "Overview"
- *       center: [-120, 35]
- *       zoom: 5
- *     - id: detail
- *       title: "Major Event"
- *       center: [-118, 34]
- *       zoom: 10
- *       layers:
- *         show:
- *           - base-layer
- * ```
- *
- * @example With Footer
- * ```yaml
- * - type: scrollytelling
- *   id: story
- *   config:
- *     center: [0, 0]
- *     zoom: 2
- *     mapStyle: "https://demotiles.maplibre.org/style.json"
- *   chapters:
- *     - id: chapter1
- *       title: "Chapter 1"
- *       center: [0, 0]
- *       zoom: 3
- *   footer: |
- *     <p>Data sources: ...</p>
- *     <p>Created with maplibre-yaml</p>
- * ```
- */
-declare const ScrollytellingBlockSchema: z.ZodObject<any>;
-
-export { ChapterActionSchema, ChapterLayersSchema, ChapterSchema, ColorOrExpressionSchema, ColorSchema, ContentBlockSchema, ContentElementSchema, ContentItemSchema, ExpressionSchema, GeoJSONSourceSchema, ImageSourceSchema, LatitudeSchema, LayerSourceSchema, LngLatBoundsSchema, LngLatSchema, LoadingConfigSchema, LongitudeSchema, NumberOrExpressionSchema, RasterSourceSchema, ScrollytellingBlockSchema, StreamConfigSchema, ValidTagNames, VectorSourceSchema, VideoSourceSchema, ZoomLevelSchema };
+export { ColorOrExpressionSchema, ColorSchema, ContentBlockSchema, ContentElementSchema, ContentItemSchema, ExpressionSchema, GeoJSONSourceSchema, ImageSourceSchema, LatitudeSchema, LayerSourceSchema, LngLatBoundsSchema, LngLatSchema, LoadingConfigSchema, LongitudeSchema, NumberOrExpressionSchema, RasterSourceSchema, StreamConfigSchema, ValidTagNames, VectorSourceSchema, VideoSourceSchema, ZoomLevelSchema };

package/dist/schemas/index.js

@@ -532,7 +532,9 @@ var MapConfigSchema = z.object({
   // Required
   center: LngLatSchema.describe("Initial map center [longitude, latitude]"),
   zoom: ZoomLevelSchema.describe("Initial zoom level (0-24)"),
-  mapStyle: z.union([z.string().url(), z.any()]).describe("MapLibre style URL or style object"),
+  mapStyle: z.union([z.string().url(), z.any()]).optional().describe(
+    "MapLibre style URL or style object. Optional when global config.defaultMapStyle is set."
+  ),
   // View
   pitch: z.number().min(0).max(85).default(0).describe("Camera pitch angle in degrees (0-85)"),
   bearing: z.number().min(-180).max(180).default(0).describe("Camera bearing (rotation) in degrees (-180 to 180)"),