@swisper.ai/web-map 0.0.2

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025-2026 Fintama AG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,134 @@
+# @swisper.ai/web-map
+
+[![npm](https://img.shields.io/npm/v/@swisper.ai/web-map)](https://www.npmjs.com/package/@swisper.ai/web-map)
+[![license](https://img.shields.io/npm/l/@swisper.ai/web-map)](https://unpkg.com/@swisper.ai/web-map/LICENSE)
+
+Interactive MapLibre maps with selectable markers for Swisper web apps. `MapView` frames a set of points and shares selection and hover state with the `MapMarker`s inside it, but it doesn't store that state: your app holds the selected id and passes it back. All text is passed in as props (the package has no i18n dependency), and components are styled with Tailwind v4 utilities against the `@swisper.ai/design-system` theme.
+
+## Boundary
+
+Code belongs here if it puts a map on screen: the map surface, its markers, controls and overlays, and the engine setup it needs. Heavy map engines stay here, so consumers that never show a map don't download them. Chat-specific UI around a map, such as the chat-card layout that lists places beside it, belongs in `@swisper.ai/web-chat-ui`.
+
+## Install
+
+```sh
+npm install @swisper.ai/web-map
+```
+
+| Peer        | Range      | Why                  |
+| ----------- | ---------- | -------------------- |
+| `react`     | `>=18.0.0` | Components and hooks |
+| `react-dom` | `>=18.0.0` | Rendering            |
+
+MapLibre GL (`maplibre-gl`, through `@vis.gl/react-maplibre`) is a regular dependency, loaded lazily with the first map; its worker ships with the package and starts from a same-origin `blob:` URL, so your bundler needs no worker configuration. The package imports `maplibre-gl/dist/maplibre-gl.css` itself. It also depends on `@swisper.ai/ui`, whose peers (`@mui/material`, `@mui/system`, `@mui/icons-material`, `@emotion/react`, `@emotion/styled`) apply too.
+
+## Setup
+
+1. Load the styles (see [Styles](#styles)).
+2. If you render `MapUserLocation` with its default pin, mount `TooltipProvider` from `@swisper.ai/ui` above the map: the pin shows its label in a tooltip.
+3. Render the map inside a parent with an explicit height, and memoise `fitPoints`: it is compared by identity, so a new array on every render re-frames the map and undoes the user's pan and zoom.
+
+```tsx
+import { MapMarker, MapPin, MapView } from '@swisper.ai/web-map';
+import { useMemo, useState } from 'react';
+
+interface Place {
+  id: string;
+  name: string;
+  rating: string;
+  lng: number;
+  lat: number;
+}
+
+export function PlacesMap({ places }: { places: Place[] }) {
+  const [selectedId, setSelectedId] = useState<string | null>(null);
+  const fitPoints = useMemo(
+    () => places.map((place): [number, number] => [place.lng, place.lat]),
+    [places],
+  );
+
+  return (
+    <MapView
+      testId="places-map"
+      ariaLabel="Restaurants near you"
+      fitPoints={fitPoints}
+      selectedId={selectedId}
+      onSelect={setSelectedId}
+      className="h-[400px]"
+    >
+      {places.map((place) => (
+        <MapMarker
+          key={place.id}
+          id={place.id}
+          longitude={place.lng}
+          latitude={place.lat}
+          label={place.name}
+        >
+          <MapPin label={place.name} value={place.rating} />
+        </MapMarker>
+      ))}
+    </MapView>
+  );
+}
+```
+
+Tiles come from OpenFreeMap's Liberty style (`DEFAULT_MAP_STYLE_URL`) unless you pass `mapStyleUrl`.
+
+## Styles
+
+Pick **one** of the two options.
+
+| Your app                            | Use                                                                         |
+| ----------------------------------- | --------------------------------------------------------------------------- |
+| Builds its own CSS with Tailwind v4 | `@import '@swisper.ai/web-map/tailwind.css';` after the design-system theme |
+| Has no Tailwind                     | `import '@swisper.ai/web-map/index.css';` once, at the app's entry          |
+
+With Tailwind, install `@swisper.ai/design-system` too and import its theme first:
+
+```css
+@import '@swisper.ai/design-system/src/tailwind.css'; /* tailwindcss + theme: colors, radii, fonts */
+@import '@swisper.ai/web-map/tailwind.css';
+```
+
+`@swisper.ai/web-map/tailwind.css` holds only `@source "./dist";`, which makes Tailwind scan the built components for class names. The prebuilt `index.css` instead brings its own preflight, theme and every utility the `@swisper.ai` packages use, so loading it next to your own Tailwind build ships everything twice, and whichever file loads last wins wherever the two conflict.
+
+## API
+
+Props and live examples are on each component's page in the [Echo DS Storybook](https://fintama.github.io/fintama/).
+
+| Export                                                                                           | Why it exists                                                                                                                                                                      |
+| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `MapView`                                                                                        | Root. Frames `fitPoints` (one point zooms in, none shows the world) and reports marker clicks and hover through `onSelect` / `onHover`; selection and hover are controlled by you. |
+| `MapMarker`, `useMapMarker`                                                                      | A selectable, hoverable point that wraps its pin in a button and passes `{ isSelected, isHovered }` to it, as an element reading `useMapMarker` or a render function.              |
+| `MapPin`                                                                                         | The default callout pin: a value that expands to value and place name on hover or selection, restyled through `--map-pin-*` CSS variables.                                         |
+| `MapUserLocation`, `UserLocationPin`                                                             | The user's own position; renders nothing until coordinates are known, and is not added to `fitPoints` for you.                                                                     |
+| `useMapView`                                                                                     | The map instance (`mapRef`) and selection state, for custom children of a `MapView`.                                                                                               |
+| `BaseMap`                                                                                        | The bare map with loading and error states, framing and style URL, but no selection context.                                                                                       |
+| `Layer`, `Marker`, `Source`, `useMap`                                                            | Re-exported from `@vis.gl/react-maplibre`, so what you draw inside a `BaseMap` or `MapView` reads the same map context as this package.                                            |
+| `loadMapLib`                                                                                     | MapLibre with its worker already set up, loaded once and shared by every map; pass it as `mapLib` if you render a react-maplibre `Map` yourself.                                   |
+| `resolveMapStyleUrl`, `DEFAULT_MAP_STYLE_URL`, `DEFAULT_FIT_BOUNDS_PADDING`, `SINGLE_POINT_ZOOM` | The defaults the components use, for maps of your own that should match.                                                                                                           |
+| `getBoundsFromPoints`, `getBoundsCentroid`, `isDegenerateBounds`                                 | Helpers for framing a set of `[longitude, latitude]` points.                                                                                                                       |
+
+## Troubleshooting
+
+| Symptom                                                                     | Cause                                                                                                   | Fix                                                                                          |
+| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| "Invalid hook call", or a context is missing                                | The app resolves two copies of React                                                                    | Add `resolve: { dedupe: ['react', 'react-dom'] }` to the Vite config                         |
+| Components render without layout or colors                                  | Tailwind never scans the package, because it skips `node_modules` by default                            | Import the package's `tailwind.css` in your Tailwind entry, or load its prebuilt `index.css` |
+| Layout is right, but colors or radii are wrong or missing                   | The design-system theme isn't loaded, so theme utilities such as `bg-paper-elevation-1` are empty       | Import `@swisper.ai/design-system/src/tailwind.css` before the package's `tailwind.css`      |
+| Your own base styles (fonts, headings, resets) get overridden               | The prebuilt `index.css` is loaded next to your own Tailwind build, and its preflight wins              | Use one of the two: drop `index.css` and import `tailwind.css`                               |
+| Spacing looks wrong after upgrading (huge gaps, tiny icons)                 | A number in a spacing class is pixels: `gap-8` is 8px, not Tailwind's default 32px                      | Write the pixel value you want                                                               |
+| Styles are missing or doubled, or the MUI theme doesn't apply               | The app resolves two copies of `@emotion/react` or `@mui/material`                                      | Add them to `resolve.dedupe` in the Vite config, next to `react` and `react-dom`             |
+| `ERR_UNSUPPORTED_DIR_IMPORT` when a test imports the package                | `dist/` uses extensionless imports that only a bundler resolves, and Vitest externalizes it             | Set `server.deps.inline: [/@swisper\.ai\//]` in the Vitest config                            |
+| The map has zero height                                                     | `MapView` fills its parent (`size-full`), and the parent has no height                                  | Give the parent (or `className`) an explicit height                                          |
+| The map jumps back to its starting frame whenever a marker is selected      | `fitPoints` is a new array on every render, and each new array is framed again                          | Memoise `fitPoints`                                                                          |
+| Clicking the map doesn't clear the selection                                | `MapView` never clears it; selection is controlled by the parent                                        | Set your selected id to `null` where you want to deselect                                    |
+| `VITE_MAP_STYLE_URL` is ignored                                             | The library reads no env vars (Vite would have baked them in when the library was built)                | Pass `mapStyleUrl`                                                                           |
+| `Tooltip` must be used within `TooltipProvider`                             | `MapUserLocation`'s default pin shows its label in a tooltip                                            | Mount `TooltipProvider` from `@swisper.ai/ui` above the map                                  |
+| The map stays blank under a strict CSP                                      | MapLibre's worker starts from a `blob:` URL, and tiles load from the style's host                       | Allow `blob:` in `worker-src`, and the style, tile and font hosts in `connect-src`           |
+| Bundler error importing `maplibre-gl/dist/maplibre-gl.css`                  | The package imports MapLibre's stylesheet, and the bundler doesn't handle CSS imports from dependencies | Enable CSS imports for `node_modules` (Vite does by default)                                 |
+| `useMapView must be used within a MapView component`, or `MapMarker` throws | `MapMarker` and `useMapView` read the `MapView` context                                                 | Render them inside a `MapView`; inside a bare `BaseMap`, use `Marker` instead                |
+
+## License
+
+[Apache-2.0](https://unpkg.com/@swisper.ai/web-map/LICENSE)

package/dist/base-map.d.ts

@@ -0,0 +1,28 @@
+import { MapRef } from '@vis.gl/react-maplibre';
+import { ReactNode, RefObject } from 'react';
+import { MapBounds, MapLngLat } from './utils/get-bounds-from-points';
+interface BaseMapProps {
+    children?: ReactNode;
+    className?: string;
+    testId: string;
+    ariaLabel: string;
+    hasError?: boolean;
+    isLoading?: boolean;
+    initialViewState: {
+        center: MapLngLat | null;
+        zoom: number;
+    };
+    bounds?: MapBounds | null;
+    fitBoundsPadding?: number;
+    mapStyleUrl?: string;
+    mapRef?: RefObject<MapRef>;
+    onLoad?: () => void;
+    /**
+     * Shown when `hasError` is set. A prop rather than a translation lookup, so the
+     * package does not tie consumers to one i18n library or namespace.
+     */
+    errorLabel?: string;
+}
+export declare function BaseMap({ children, className, testId, ariaLabel, hasError, isLoading, initialViewState, bounds, fitBoundsPadding, mapStyleUrl, mapRef: externalMapRef, onLoad, errorLabel, }: BaseMapProps): import('react').JSX.Element;
+export {};
+//# sourceMappingURL=base-map.d.ts.map

package/dist/base-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-map.d.ts","sourceRoot":"","sources":["../src/base-map.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAErD,OAAO,EAAqB,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAQ1E,OAAO,EAAsB,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,MAAM,gCAAgC,CAAC;AAEpG,OAAO,kCAAkC,CAAC;AAE1C,UAAU,YAAY;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE;QAAE,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7D,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAaD,wBAAgB,OAAO,CAAC,EACtB,QAAQ,EACR,SAAS,EACT,MAAM,EACN,SAAS,EACT,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,MAAa,EACb,gBAA6C,EAC7C,WAAW,EACX,MAAM,EAAE,cAAc,EACtB,MAAM,EACN,UAAmD,GACpD,EAAE,YAAY,+BA+Dd"}

package/dist/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const DEFAULT_MAP_STYLE_URL = "https://tiles.openfreemap.org/styles/liberty";
+export declare const DEFAULT_FIT_BOUNDS_PADDING = 48;
+export declare const SINGLE_POINT_ZOOM = 15;
+/**
+ * No `import.meta.env` fallback: Vite replaces it when this library is built, so a
+ * consumer's `VITE_MAP_STYLE_URL` would never be read. Pass `mapStyleUrl` instead.
+ */
+export declare function resolveMapStyleUrl(mapStyleUrl?: string): string;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,iDAAiD,CAAC;AACpF,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAE/D"}