@open-pioneer/map 0.6.1 → 0.8.0-dev.20241120115147

package/ui/useMapModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"useMapModel.js","sources":["useMapModel.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { useService } from \"open-pioneer:react-hooks\";\nimport { useMemo } from \"react\";\nimport { useAsync } from \"react-use\";\nimport { MapModel, MapRegistry } from \"../api\";\n\n/** Return value of {@link useMapModel}. */\nexport type UseMapModelResult =\n    | {\n          kind: \"loading\" | \"resolved\" | \"rejected\";\n          map?: MapModel | undefined;\n          error?: Error | undefined;\n      }\n    | UseMapModelLoading\n    | UseMapModelResolved\n    | UseMapModelRejected;\n\nexport interface UseMapModelLoading {\n    kind: \"loading\";\n    map?: undefined;\n    error?: undefined;\n}\n\nexport interface UseMapModelResolved {\n    kind: \"resolved\";\n    map: MapModel;\n    error?: undefined;\n}\n\nexport interface UseMapModelRejected {\n    kind: \"rejected\";\n    map?: undefined;\n    error: Error;\n}\n\n/**\n * React hooks that looks up the map with the given id in the `map.MapRegistry` service.\n *\n * Returns an object representing the progress, which will eventually represent either\n * the map model value or an initialization error.\n *\n * The map model cannot be returned directly because it may not have completed its initialization yet.\n */\nexport function useMapModel(mapId: string): UseMapModelResult {\n    const mapRegistry = useService<MapRegistry>(\"map.MapRegistry\");\n    const state = useAsync(() => mapRegistry.getMapModel(mapId), [mapRegistry, mapId]);\n    const result = useMemo((): UseMapModelResult => {\n        if (state.loading) {\n            return { kind: \"loading\" };\n        }\n        if (state.error) {\n            return { kind: \"rejected\", error: state.error };\n        }\n        return { kind: \"resolved\", map: state.value };\n    }, [state]);\n    return result;\n}\n"],"names":[],"mappings":";;;;AA4CO,SAAS,YAAY,KAAkC,EAAA;AAC1D,EAAM,MAAA,WAAA,GAAc,WAAwB,iBAAiB,CAAA,CAAA;AAC7D,EAAM,MAAA,KAAA,GAAQ,QAAS,CAAA,MAAM,WAAY,CAAA,WAAA,CAAY,KAAK,CAAG,EAAA,CAAC,WAAa,EAAA,KAAK,CAAC,CAAA,CAAA;AACjF,EAAM,MAAA,MAAA,GAAS,QAAQ,MAAyB;AAC5C,IAAA,IAAI,MAAM,OAAS,EAAA;AACf,MAAO,OAAA,EAAE,MAAM,SAAU,EAAA,CAAA;AAAA,KAC7B;AACA,IAAA,IAAI,MAAM,KAAO,EAAA;AACb,MAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,KAAA,EAAO,MAAM,KAAM,EAAA,CAAA;AAAA,KAClD;AACA,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,GAAA,EAAK,MAAM,KAAM,EAAA,CAAA;AAAA,GAChD,EAAG,CAAC,KAAK,CAAC,CAAA,CAAA;AACV,EAAO,OAAA,MAAA,CAAA;AACX;;;;"}
+{"version":3,"file":"useMapModel.js","sources":["useMapModel.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { useService } from \"open-pioneer:react-hooks\";\nimport { useMemo } from \"react\";\nimport { useAsync } from \"react-use\";\nimport { MapModel, MapRegistry } from \"../api\";\nimport { MapModelImpl } from \"../model/MapModelImpl\";\n// eslint-disable-next-line unused-imports/no-unused-imports\nimport { DefaultMapProvider, useDefaultMapProps } from \"./DefaultMapProvider\";\n\n/** Return value of {@link useMapModel}. */\nexport type UseMapModelResult = UseMapModelLoading | UseMapModelResolved | UseMapModelRejected;\n\nexport interface UseMapModelLoading {\n    kind: \"loading\";\n    map?: undefined;\n    error?: undefined;\n}\n\nexport interface UseMapModelResolved {\n    kind: \"resolved\";\n    map: MapModel;\n    error?: undefined;\n}\n\nexport interface UseMapModelRejected {\n    kind: \"rejected\";\n    map?: undefined;\n    error: Error;\n}\n\n/**\n * Options that specify which map to use. See {@link useMapModel}.\n *\n * When not setting any of these properties on a component, the default map (from the `DefaultMapProvider`) will be used.\n * If that is not available either, an error will be thrown.\n */\nexport interface MapModelProps {\n    /**\n     * The id of the map.\n     * The map will be looked up in the MapRegistry service.\n     */\n    mapId?: string | undefined;\n\n    /**\n     * The direct map model reference to use.\n     * This property can be used as an alternative to the {@link mapId}.\n     */\n    map?: MapModel | undefined;\n}\n\n/**\n * React hook that looks up the map with the given id in the `map.MapRegistry` service.\n *\n * Returns an object representing the progress, which will eventually represent either\n * the map model value or an initialization error.\n *\n * The map model cannot be returned directly because it may not have completed its initialization yet.\n */\nexport function useMapModel(mapId: string): UseMapModelResult;\n\n/**\n * React hook that resolves a map model specified by the given `props` (see {@link MapModelProps}).\n *\n * Returns an object representing the progress, which will eventually represent either\n * the map model value or an initialization error.\n *\n * The map model cannot be returned directly because it may not have completed its initialization yet.\n */\nexport function useMapModel(props: MapModelProps): UseMapModelResult;\n\n/**\n * React hook that returns the default map model (if available, see {@link DefaultMapProvider}).\n */\nexport function useMapModel(): UseMapModelResult;\nexport function useMapModel(props?: undefined | string | MapModelProps): UseMapModelResult {\n    const resolvedMapArg = useResolvedMapArg(props);\n    const mapRegistry = useService<MapRegistry>(\"map.MapRegistry\");\n    const state = useAsync(async () => {\n        if (typeof resolvedMapArg === \"string\") {\n            return await mapRegistry.expectMapModel(resolvedMapArg);\n        }\n        return Promise.resolve(resolvedMapArg);\n    }, [mapRegistry, resolvedMapArg]);\n    const result = useMemo((): UseMapModelResult => {\n        if (state.loading) {\n            return { kind: \"loading\" };\n        }\n        if (state.error) {\n            return { kind: \"rejected\", error: state.error };\n        }\n        return { kind: \"resolved\", map: state.value! };\n    }, [state]);\n    return result;\n}\n\n/**\n * Resolves the map model (or its id) from the given props and the default map props.\n */\nfunction useResolvedMapArg(props?: undefined | string | MapModelProps): MapModel | string {\n    if (typeof props === \"object\" && props.mapId != null && props.map != null) {\n        throw new Error(`Cannot specify both 'mapId' and 'map' in useMapModel at the same time.`);\n    }\n    if (props instanceof MapModelImpl) {\n        // This cannot happen in valid typescript code, but it might be a common mistake.\n        throw new Error(\n            `Map model instances cannot be passed directly to 'useMapModel' (see TypeScript signature).`\n        );\n    }\n    const localProps = useMemo((): MapModelProps => {\n        // Normalize local props for compatibility with old string overload.\n        if (props == null) {\n            return {};\n        }\n        if (typeof props === \"string\") {\n            return { mapId: props };\n        }\n        return { mapId: props.mapId, map: props.map };\n        // eslint-disable-next-line react-hooks/exhaustive-deps\n    }, [...(typeof props === \"string\" || props == null ? [props] : [props.mapId, props.map])]);\n    const defaultProps = useDefaultMapProps();\n\n    const resolvedMapArg = resolveMap(localProps) ?? resolveMap(defaultProps);\n    if (resolvedMapArg == null) {\n        throw new Error(\n            `No map specified. ` +\n                `You must either specify the map (or its id) via a DefaultMapProvider parent or configure it explicitly.`\n        );\n    }\n    return resolvedMapArg;\n}\n\nfunction resolveMap(props?: MapModelProps): MapModel | string | undefined {\n    return props?.map ?? props?.mapId;\n}\n"],"names":[],"mappings":";;;;;;AA2EO,SAAS,YAAY,KAA+D,EAAA;AACvF,EAAM,MAAA,cAAA,GAAiB,kBAAkB,KAAK,CAAA,CAAA;AAC9C,EAAM,MAAA,WAAA,GAAc,WAAwB,iBAAiB,CAAA,CAAA;AAC7D,EAAM,MAAA,KAAA,GAAQ,SAAS,YAAY;AAC/B,IAAI,IAAA,OAAO,mBAAmB,QAAU,EAAA;AACpC,MAAO,OAAA,MAAM,WAAY,CAAA,cAAA,CAAe,cAAc,CAAA,CAAA;AAAA,KAC1D;AACA,IAAO,OAAA,OAAA,CAAQ,QAAQ,cAAc,CAAA,CAAA;AAAA,GACtC,EAAA,CAAC,WAAa,EAAA,cAAc,CAAC,CAAA,CAAA;AAChC,EAAM,MAAA,MAAA,GAAS,QAAQ,MAAyB;AAC5C,IAAA,IAAI,MAAM,OAAS,EAAA;AACf,MAAO,OAAA,EAAE,MAAM,SAAU,EAAA,CAAA;AAAA,KAC7B;AACA,IAAA,IAAI,MAAM,KAAO,EAAA;AACb,MAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,KAAA,EAAO,MAAM,KAAM,EAAA,CAAA;AAAA,KAClD;AACA,IAAA,OAAO,EAAE,IAAA,EAAM,UAAY,EAAA,GAAA,EAAK,MAAM,KAAO,EAAA,CAAA;AAAA,GACjD,EAAG,CAAC,KAAK,CAAC,CAAA,CAAA;AACV,EAAO,OAAA,MAAA,CAAA;AACX,CAAA;AAKA,SAAS,kBAAkB,KAA+D,EAAA;AACtF,EAAI,IAAA,OAAO,UAAU,QAAY,IAAA,KAAA,CAAM,SAAS,IAAQ,IAAA,KAAA,CAAM,OAAO,IAAM,EAAA;AACvE,IAAM,MAAA,IAAI,MAAM,CAAwE,sEAAA,CAAA,CAAA,CAAA;AAAA,GAC5F;AACA,EAAA,IAAI,iBAAiB,YAAc,EAAA;AAE/B,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,0FAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACA,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAqB;AAE5C,IAAA,IAAI,SAAS,IAAM,EAAA;AACf,MAAA,OAAO,EAAC,CAAA;AAAA,KACZ;AACA,IAAI,IAAA,OAAO,UAAU,QAAU,EAAA;AAC3B,MAAO,OAAA,EAAE,OAAO,KAAM,EAAA,CAAA;AAAA,KAC1B;AACA,IAAA,OAAO,EAAE,KAAO,EAAA,KAAA,CAAM,KAAO,EAAA,GAAA,EAAK,MAAM,GAAI,EAAA,CAAA;AAAA,KAE7C,CAAC,GAAI,OAAO,KAAA,KAAU,YAAY,KAAS,IAAA,IAAA,GAAO,CAAC,KAAK,IAAI,CAAC,KAAA,CAAM,OAAO,KAAM,CAAA,GAAG,CAAE,CAAC,CAAA,CAAA;AACzF,EAAA,MAAM,eAAe,kBAAmB,EAAA,CAAA;AAExC,EAAA,MAAM,cAAiB,GAAA,UAAA,CAAW,UAAU,CAAA,IAAK,WAAW,YAAY,CAAA,CAAA;AACxE,EAAA,IAAI,kBAAkB,IAAM,EAAA;AACxB,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,yHAAA,CAAA;AAAA,KAEJ,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,cAAA,CAAA;AACX,CAAA;AAEA,SAAS,WAAW,KAAsD,EAAA;AACtE,EAAO,OAAA,KAAA,EAAO,OAAO,KAAO,EAAA,KAAA,CAAA;AAChC;;;;"}

package/ui/MapContext.d.ts

@@ -1,11 +0,0 @@
-import { Provider } from "react";
-import { type MapPadding } from "../api";
-import type OlMap from "ol/Map";
-/** Values provided to children of {@link MapContainer}. */
-export interface MapContextType {
-    map: OlMap;
-    mapAnchorsHost: HTMLElement;
-    padding: Required<MapPadding>;
-}
-export declare const MapContextProvider: Provider<MapContextType>;
-export declare function useMapContext(): MapContextType;

package/ui/MapContext.js

@@ -1,17 +0,0 @@
-import { createContext, useContext } from 'react';
-
-const MapContext = createContext(void 0);
-MapContext.displayName = "MapContext";
-const MapContextProvider = MapContext.Provider;
-function useMapContext() {
-  const contextValue = useContext(MapContext);
-  if (!contextValue) {
-    throw new Error(
-      `Map context is not available. The component must be a child of the <MapContainer /> component.`
-    );
-  }
-  return contextValue;
-}
-
-export { MapContextProvider, useMapContext };
-//# sourceMappingURL=MapContext.js.map

package/ui/MapContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MapContext.js","sources":["MapContext.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Provider, createContext, useContext } from \"react\";\nimport { type MapPadding } from \"../api\";\nimport type OlMap from \"ol/Map\";\n\n/** Values provided to children of {@link MapContainer}. */\nexport interface MapContextType {\n    map: OlMap;\n    mapAnchorsHost: HTMLElement;\n    padding: Required<MapPadding>;\n}\n\nconst MapContext = createContext<MapContextType | undefined>(undefined);\nMapContext.displayName = \"MapContext\";\n\nexport const MapContextProvider: Provider<MapContextType> =\n    MapContext.Provider as Provider<MapContextType>;\n\nexport function useMapContext(): MapContextType {\n    const contextValue = useContext(MapContext);\n    if (!contextValue) {\n        throw new Error(\n            `Map context is not available. The component must be a child of the <MapContainer /> component.`\n        );\n    }\n    return contextValue;\n}\n"],"names":[],"mappings":";;AAaA,MAAM,UAAA,GAAa,cAA0C,KAAS,CAAA,CAAA,CAAA;AACtE,UAAA,CAAW,WAAc,GAAA,YAAA,CAAA;AAElB,MAAM,qBACT,UAAW,CAAA,SAAA;AAER,SAAS,aAAgC,GAAA;AAC5C,EAAM,MAAA,YAAA,GAAe,WAAW,UAAU,CAAA,CAAA;AAC1C,EAAA,IAAI,CAAC,YAAc,EAAA;AACf,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,8FAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,YAAA,CAAA;AACX;;;;"}

package/util/defer.d.ts

@@ -1,18 +0,0 @@
-export interface DeferredExecution {
-    /**
-     * Re-schedule execution of `func` (if it was not already executed).
-     * Returns true on success, false otherwise.
-     */
-    reschedule(): boolean;
-    /**
-     * Cancels the pending execution (if it is still pending).
-     */
-    cancel(): void;
-}
-/**
- * Calls `func` at a slightly later time.
- *
- * The returned object can be used to re-schedule or cancel the execution of `func`.
- * However, `func` will be executed at most once.
- */
-export declare function defer(func: () => void): DeferredExecution;

package/util/defer.js

@@ -1,21 +0,0 @@
-function defer(func) {
-  let executed = false;
-  let timeout = setTimeout(() => {
-    executed = true;
-    timeout = void 0;
-    func();
-  });
-  return {
-    reschedule() {
-      return !executed;
-    },
-    cancel() {
-      if (timeout) {
-        clearTimeout(timeout);
-      }
-    }
-  };
-}
-
-export { defer };
-//# sourceMappingURL=defer.js.map

package/util/defer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defer.js","sources":["defer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nexport interface DeferredExecution {\n    /**\n     * Re-schedule execution of `func` (if it was not already executed).\n     * Returns true on success, false otherwise.\n     */\n    reschedule(): boolean;\n\n    /**\n     * Cancels the pending execution (if it is still pending).\n     */\n    cancel(): void;\n}\n\n/**\n * Calls `func` at a slightly later time.\n *\n * The returned object can be used to re-schedule or cancel the execution of `func`.\n * However, `func` will be executed at most once.\n */\nexport function defer(func: () => void): DeferredExecution {\n    let executed = false;\n    let timeout: ReturnType<typeof setTimeout> | undefined = setTimeout(() => {\n        executed = true;\n        timeout = undefined;\n        func();\n    });\n    return {\n        reschedule() {\n            // Do nothing: if not executed, the timeout is still pending\n            // and it will run in the future.\n            return !executed;\n        },\n        cancel() {\n            if (timeout) {\n                clearTimeout(timeout);\n            }\n        }\n    };\n}\n"],"names":[],"mappings":"AAqBO,SAAS,MAAM,IAAqC,EAAA;AACvD,EAAA,IAAI,QAAW,GAAA,KAAA,CAAA;AACf,EAAI,IAAA,OAAA,GAAqD,WAAW,MAAM;AACtE,IAAW,QAAA,GAAA,IAAA,CAAA;AACX,IAAU,OAAA,GAAA,KAAA,CAAA,CAAA;AACV,IAAK,IAAA,EAAA,CAAA;AAAA,GACR,CAAA,CAAA;AACD,EAAO,OAAA;AAAA,IACH,UAAa,GAAA;AAGT,MAAA,OAAO,CAAC,QAAA,CAAA;AAAA,KACZ;AAAA,IACA,MAAS,GAAA;AACL,MAAA,IAAI,OAAS,EAAA;AACT,QAAA,YAAA,CAAa,OAAO,CAAA,CAAA;AAAA,OACxB;AAAA,KACJ;AAAA,GACJ,CAAA;AACJ;;;;"}