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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-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 } from './schemas/index.js';
-import { L as LayerSchema, P as PopupContentSchema, C as ControlsConfigSchema } from './page.schema-CzdCyPFI.js';
-export { j as BackgroundLayerSchema, B as BaseLayerPropertiesSchema, p as BlockSchema, e as CircleLayerSchema, m as ControlPositionSchema, h as FillExtrusionLayerSchema, F as FillLayerSchema, G as GlobalConfigSchema, H as HeatmapLayerSchema, i as HillshadeLayerSchema, I as InteractiveConfigSchema, l as LayerOrReferenceSchema, k as LayerReferenceSchema, 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, g as RasterLayerSchema, R as RootSchema, S as SymbolLayerSchema } from './page.schema-CzdCyPFI.js';
-export { L as LegendBuilder, M as MapBlock, b as MapRenderer, d as MapRendererEvents, c as MapRendererOptions, P as ParseError, a as ParseResult, R as RootConfig, Y as YAMLParser, p as parseYAMLConfig, s as safeParseYAMLConfig } from './map-renderer-DOLO9y-3.js';
+export { ColorOrExpressionSchema, ColorSchema, ContentBlockSchema, ContentElementSchema, ContentItemSchema, ExpressionSchema, GeoJSONSourceSchema, ImageSourceSchema, LatitudeSchema, LayerSourceSchema, LngLatBoundsSchema, LngLatSchema, LoadingConfigSchema, LongitudeSchema, NumberOrExpressionSchema, RasterSourceSchema, StreamConfigSchema, ValidTagNames, VectorSourceSchema, VideoSourceSchema, ZoomLevelSchema } from './schemas/index.js';
+import { L as LayerSchema, P as PopupContentSchema, C as ControlsConfigSchema } from './page.schema-VBytF9l5.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, 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, 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, h as RasterLayerSchema, U as RootConfig, R as RootSchema, D as ScrollytellingBlock, S as ScrollytellingBlockSchema, g as SymbolLayerSchema } from './page.schema-VBytF9l5.js';
+export { L as LegendBuilder, M as MapRenderer, c as MapRendererEvents, b as MapRendererOptions, P as ParseError, a as ParseResult, Y as YAMLParser, p as parseYAMLConfig, s as safeParseYAMLConfig } from './map-renderer-IvxniEQy.js';
 import { Map, LngLat } from 'maplibre-gl';
 import { z } from 'zod';
 import { FeatureCollection } from 'geojson';

package/dist/index.js

@@ -534,7 +534,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)"),
@@ -908,6 +910,104 @@ var YAMLParser = class {
       };
     }
   }
+  /**
+   * Parse YAML string for a scrollytelling block and validate against ScrollytellingBlockSchema
+   *
+   * @param yaml - YAML string to parse (should be a scrollytelling block, not a full document)
+   * @returns Validated scrollytelling block object
+   * @throws {Error} If YAML syntax is invalid
+   * @throws {ZodError} If validation fails
+   *
+   * @remarks
+   * This method is specifically for parsing individual scrollytelling blocks (e.g., in documentation
+   * or component usage). Unlike {@link parse}, it validates against ScrollytellingBlockSchema rather
+   * than RootSchema, so it expects a single scrollytelling configuration without the pages array wrapper.
+   *
+   * @example
+   * ```typescript
+   * const yaml = `
+   * type: scrollytelling
+   * id: story
+   * config:
+   *   center: [0, 0]
+   *   zoom: 2
+   *   mapStyle: "https://example.com/style.json"
+   * chapters:
+   *   - id: intro
+   *     title: "Introduction"
+   *     center: [0, 0]
+   *     zoom: 3
+   *     description: "Welcome to our story."
+   *   - id: chapter2
+   *     title: "Chapter 2"
+   *     center: [10, 10]
+   *     zoom: 5
+   *     description: "The story continues."
+   * `;
+   *
+   * const scrollyBlock = YAMLParser.parseScrollytellingBlock(yaml);
+   * ```
+   */
+  static parseScrollytellingBlock(yaml) {
+    let parsed;
+    try {
+      parsed = parse(yaml);
+    } catch (error) {
+      throw new Error(
+        `YAML syntax error: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+    return ScrollytellingBlockSchema.parse(parsed);
+  }
+  /**
+   * Parse YAML string for a scrollytelling block, returning a result object
+   *
+   * @param yaml - YAML string to parse (should be a scrollytelling block, not a full document)
+   * @returns Result object with success flag and either data or errors
+   *
+   * @remarks
+   * This is the non-throwing version of {@link parseScrollytellingBlock}. Instead of throwing
+   * errors, it returns a result object that indicates success or failure.
+   * Use this when you want to handle errors gracefully without try/catch.
+   *
+   * @example
+   * ```typescript
+   * const result = YAMLParser.safeParseScrollytellingBlock(yamlString);
+   * if (result.success) {
+   *   console.log('Scrollytelling config:', result.data);
+   * } else {
+   *   result.errors.forEach(err => {
+   *     console.error(`Error at ${err.path}: ${err.message}`);
+   *   });
+   * }
+   * ```
+   */
+  static safeParseScrollytellingBlock(yaml) {
+    try {
+      const data = this.parseScrollytellingBlock(yaml);
+      return {
+        success: true,
+        data,
+        errors: []
+      };
+    } catch (error) {
+      if (error instanceof ZodError) {
+        return {
+          success: false,
+          errors: this.formatZodErrors(error)
+        };
+      }
+      return {
+        success: false,
+        errors: [
+          {
+            path: "",
+            message: error instanceof Error ? error.message : String(error)
+          }
+        ]
+      };
+    }
+  }
   /**
    * Resolve $ref references to global layers and sources
    *