@kahwee/sf-map-svg 1.5.2 → 2.1.0

package/dist/src/configuration.js

@@ -0,0 +1,73 @@
+import { controlKeys, layerKeys, normalizeFeatures, validateSwitchPatch } from './features.js';
+import { assertOptions, validateExplorerOptions } from './validation.js';
+const appearanceKeys = [
+    'theme',
+    'colors',
+    'labelStyle',
+    'areaStyle',
+    'labelSize',
+    'style',
+    'markerRadius',
+    'markerHitSize',
+    'markerColor',
+    'selectedMarkerColor',
+];
+const featureKeys = [
+    'motion',
+    'markerEntrance',
+    'selectedMarkerRing',
+    'clustering',
+    'northArrow',
+    'scaleBar',
+];
+export function expandMapOptions(options) {
+    const record = assertOptions(options, 'map');
+    for (const key of [
+        ...appearanceKeys,
+        ...featureKeys,
+        'interface',
+        'onMarkerActivate',
+        'onOverlayActivate',
+    ])
+        if (key in record)
+            throw new TypeError(`Use the v2 grouped options or map.on() instead of ${key}.`);
+    if (options.appearance !== undefined)
+        assertOptions(options.appearance, 'appearance', appearanceKeys);
+    if (options.features !== undefined)
+        normalizeFeatures(options.features);
+    const { features, appearance, ...rest } = options;
+    const expanded = { ...rest, ...appearance, ...features };
+    validateExplorerOptions(expanded);
+    return expanded;
+}
+/** Prepare the entire configuration before any DOM mutation. */
+export function prepareConfiguration(current, patch) {
+    assertOptions(patch, 'configuration', ['features', 'layers', 'controls']);
+    const features = 'features' in patch
+        ? normalizeFeatures(patch.features === undefined
+            ? {}
+            : { ...current.features, ...checkedFeatures(patch.features) })
+        : current.features;
+    const switches = (key, previous, keys) => {
+        if (!(key in patch))
+            return previous;
+        const value = patch[key];
+        if (value === undefined)
+            return {};
+        validateSwitchPatch(value, keys);
+        const next = { ...previous, ...value };
+        for (const property of Object.keys(next))
+            if (next[property] === undefined)
+                delete next[property];
+        return next;
+    };
+    return structuredClone({
+        features,
+        layers: switches('layers', current.layers, layerKeys),
+        controls: switches('controls', current.controls, controlKeys),
+    });
+}
+function checkedFeatures(value) {
+    normalizeFeatures(value);
+    return value;
+}

package/dist/src/controller-types.d.ts

@@ -0,0 +1,84 @@
+import type { Geometry, NeighborhoodSource } from '../data/types.js';
+import type { CameraOptions, InteractiveLayers, MapFeatures, MapMarker, MapOverlay, MapPadding, MapViewport, NeighborhoodExplorerOptions, NeighborhoodSelection } from './types.js';
+export type MapAppearance = Pick<NeighborhoodExplorerOptions, 'theme' | 'colors' | 'labelStyle' | 'areaStyle' | 'labelSize' | 'style' | 'markerRadius' | 'markerHitSize' | 'markerColor' | 'selectedMarkerColor'>;
+export type MapControls = NonNullable<NeighborhoodExplorerOptions['controls']>;
+/** Omitted groups/keys retain their values; undefined groups reset all keys in that group. */
+export interface MapConfiguration {
+    features?: MapFeatures;
+    layers?: InteractiveLayers;
+    controls?: MapControls;
+}
+export interface MapOptions extends Omit<NeighborhoodExplorerOptions, keyof MapFeatures | keyof MapAppearance | 'interface' | 'onMarkerActivate' | 'onOverlayActivate'> {
+    features?: MapFeatures;
+    appearance?: MapAppearance;
+}
+export interface MapConfigurationSnapshot {
+    features: MapFeatures;
+    /** Explicit overrides; absent values continue to follow the current mode. */
+    layers: InteractiveLayers;
+    controls: MapControls;
+}
+export interface MapEvents {
+    markerchange: {
+        id: string | null;
+        marker: MapMarker | null;
+    };
+    neighborhoodchange: NeighborhoodSelection | {
+        id: null;
+        name: null;
+        source: NeighborhoodSource;
+        feature: null;
+    };
+    overlayactivate: {
+        overlay: MapOverlay;
+    };
+    clusteractivate: {
+        markers: MapMarker[];
+    };
+    viewportchange: {
+        viewport: MapViewport;
+    };
+    mapresize: undefined;
+}
+export interface MapCamera {
+    get(): MapViewport;
+    set(view: MapViewport, options?: CameraOptions): void;
+    fit(geometry: Geometry, options?: CameraOptions & {
+        padding?: number | MapPadding;
+    }): void;
+    pan(x: number, y: number, options?: CameraOptions): void;
+    zoom(factor: number, options?: CameraOptions): void;
+    reset(options?: CameraOptions): void;
+    stop(): void;
+}
+/** Owns the map lifecycle separately from its mountable DOM element. */
+export interface MapController {
+    readonly element: HTMLElement;
+    readonly overlayElement: HTMLDivElement;
+    readonly camera: MapCamera;
+    readonly destroyed: boolean;
+    configure(patch: MapConfiguration): void;
+    getConfiguration(): MapConfigurationSnapshot;
+    on<K extends keyof MapEvents>(type: K, listener: (detail: MapEvents[K]) => void): () => void;
+    setMarkers(markers: readonly MapMarker[]): void;
+    setOverlays(overlays: readonly MapOverlay[]): void;
+    selectMarker(id: string | null, options?: CameraOptions & {
+        fit?: boolean;
+    }): boolean;
+    getSelectedMarker(): MapMarker | null;
+    selectNeighborhood(name: string | null, options?: CameraOptions & {
+        fit?: boolean;
+    }): boolean;
+    getSelectedNeighborhood(): NeighborhoodSelection | null;
+    setSource(source: NeighborhoodSource): void;
+    setMode(mode: NonNullable<MapOptions['mode']>): void;
+    setLabels(visible: boolean): void;
+    setTouchNavigation(enabled: boolean): void;
+    projectToScreen(lng: number, lat: number): {
+        x: number;
+        y: number;
+        visible: boolean;
+    };
+    /** Idempotent; stops work and managed subscriptions. Does not remove host-owned DOM. */
+    destroy(): void;
+}

package/dist/src/controller-types.js

@@ -0,0 +1 @@
+export {};

package/dist/src/explorer-core.d.ts

@@ -2,4 +2,4 @@ import type { InteractiveSFMapData } from './explorer-data.js';
 import type { NeighborhoodExplorerElement, NeighborhoodExplorerOptions } from './types.js';
 export type { ExplorerMode, NeighborhoodExplorerElement, NeighborhoodExplorerOptions, } from './types.js';
 /** Create an offline, browser-only neighborhood explorer. Call destroy() before disposal. */
-export declare function createNeighborhoodExplorerCore({ source, mode, labels, neighborhood, year, theme, interface: chrome, layers, selectableNeighborhoods, labelSize, fitPadding, markers: initialMarkers, markerRadius, markerHitSize, markerColor, selectedMarkerColor, onMarkerActivate, overlays: initialOverlays, onOverlayActivate, style: styleOptions, strings, controls, }: NeighborhoodExplorerOptions | undefined, data: InteractiveSFMapData): NeighborhoodExplorerElement;
+export declare function createNeighborhoodExplorerCore(options: NeighborhoodExplorerOptions | undefined, data: InteractiveSFMapData): NeighborhoodExplorerElement;