@mapvx/web-components-ssr 1.7.0-dev.1 → 1.7.0-dev.2

package/dist/types/public-api.d.ts

@@ -135,6 +135,35 @@ declare class MVXRoute {
      * @param data API response data containing route information
      */
     constructor(data: RouteResponse);
+    /**
+     * Rebuilds the class prototypes of a route read back from localStorage.
+     *
+     * `JSON.parse` returns plain objects, and every derived value of a route —
+     * `steps`, `duration`, `length`, a step's `coordinates` — is a getter on the
+     * prototype, so a persisted route came back without them and broke whatever
+     * drew it. Values that already are instances pass through unchanged.
+     *
+     * @hidden
+     * @param value A route, or its JSON round-trip.
+     * @returns The same data with `MVXRoute`, leg, step and polyline prototypes.
+     */
+    static fromCache(value: unknown): MVXRoute;
+    /**
+     * Returns `route` under a new {@link id}, with its own `legs` and `steps` arrays.
+     *
+     * A cached route is handed to every caller that asks for it, and the map keys
+     * its layers by route id: drawing the same cached object twice would collide.
+     * Static so that `MVXRoute` literals (test doubles) still type-check.
+     *
+     * The arrays are copied because the route this is built from stays in the
+     * cache for the next caller: trimming the returned route — dropping a leg, or
+     * a step already walked — would otherwise shorten the cached one too. The
+     * steps themselves are shared, being read-only data whose polylines would
+     * have to be decoded again to copy.
+     *
+     * @hidden
+     */
+    static withNewId(route: MVXRoute): MVXRoute;
     /**
      * Gets all steps of the route by combining steps from all legs
      * @returns Array with all route steps
@@ -361,6 +390,21 @@ interface InnerFloor {
     reachableFromGPS?: boolean;
 }
 
+interface InstitutionCityFilterOption {
+    institutionId: string;
+    filterId: string;
+    name: string;
+    type: "institution";
+}
+interface ParentPlaceCityFilterOption {
+    parentPlaceId: string;
+    filterId: string;
+    name: string;
+    type: "parent-place";
+    institutionId: string;
+}
+type CityFilterOption = InstitutionCityFilterOption | ParentPlaceCityFilterOption;
+
 interface Metadata {
     category?: string[];
     image?: string;
@@ -802,21 +846,6 @@ declare class MVXPlace {
     toString(): string;
 }
 
-interface InstitutionCityFilterOption {
-    institutionId: string;
-    filterId: string;
-    name: string;
-    type: "institution";
-}
-interface ParentPlaceCityFilterOption {
-    parentPlaceId: string;
-    filterId: string;
-    name: string;
-    type: "parent-place";
-    institutionId: string;
-}
-type CityFilterOption = InstitutionCityFilterOption | ParentPlaceCityFilterOption;
-
 interface InstitutionResponse {
     id: string;
     title: string;
@@ -1097,10 +1126,39 @@ interface CurrentLocation {
     title: 'Current location';
     position: LatLng;
 }
+/**
+ * A point the visitor picked by tapping the map, instead of one of the known places.
+ *
+ * It carries a coordinate and nothing else: there is no place behind it to look up, which
+ * is exactly why it needs its own type rather than a stand-in {@link MVXPlace}.
+ */
+interface DroppedPin {
+    type: 'dropped-pin';
+    title: 'Dropped pin';
+    position: LatLng;
+}
 declare function toCurrentLocation(position: GeolocationPosition): CurrentLocation;
+declare function toDroppedPin(position: LatLng): DroppedPin;
 declare function isCurrentLocation(point: RoutePoint | null): point is CurrentLocation;
+declare function isDroppedPin(point: RoutePoint | null): point is DroppedPin;
 declare function isPlace(point: RoutePoint | null): point is MVXPlace;
-type RoutePoint = MVXPlace | CurrentLocation;
+/**
+ * Points the router has to locate by coordinate rather than by id.
+ *
+ * A place is sent as `{ id }` and the API resolves where it is; the visitor's own location
+ * and a pin they dropped have no id to send, only a position. This is deliberately separate
+ * from {@link isCurrentLocation}, which answers *which* kind of point it is — what the
+ * analytics and the destination rules ask about.
+ */
+declare function hasOwnPosition(point: RoutePoint | null): point is CurrentLocation | DroppedPin;
+/**
+ * The id to report for a point in logs and analytics.
+ *
+ * The points without a place behind them report what they are, so a funnel can still tell
+ * a route from the visitor's location apart from one from a pin they dropped.
+ */
+declare function routePointId(point: RoutePoint | null): string;
+type RoutePoint = MVXPlace | CurrentLocation | DroppedPin;
 
 interface FormattedSchedule {
     day: string;
@@ -1113,11 +1171,21 @@ interface SearchData {
 }
 declare const EMPTY_SEARCH_DATA: SearchData;
 
+/**
+ * What the visitor has the category filter set to.
+ *
+ * `filters` is the whole selection, which can hold several categories or none at all.
+ * `filter` is the first of them — or `'All'` when none are on — and is kept because hosts
+ * have been reading it since the filter allowed a single category, and many write it
+ * straight into `?tab=`. Prefer `filters` in new code.
+ */
+interface FilterSelection {
+    filter: string;
+    filters: string[];
+}
 interface SelectFilterAction {
     type: 'select-filter';
-    data: {
-        filter: string;
-    };
+    data: FilterSelection;
 }
 interface ShowPlaceAction {
     type: 'show-place';
@@ -1141,9 +1209,7 @@ interface SearchAction {
 }
 interface ReturnToHomeAction {
     type: 'return-to-home';
-    data: {
-        filter: string;
-    };
+    data: FilterSelection;
 }
 type UserAction = SelectFilterAction | ShowPlaceAction | SelectDestinationAction | SearchAction | ReturnToHomeAction;
 
@@ -1161,5 +1227,5 @@ declare const MEASUREMENT_ID = "G-9KB6BB1J7M";
 declare function getSchedule(openingHours: OpeningHours): string;
 declare function prepareAllSchedules(openingHours: OpeningHours): FormattedSchedule[];
 
-export { AnimationState, Banner, EMPTY_SEARCH_DATA, FALLBACK_IMAGE_URL, Institution, MEASUREMENT_ID, MVXPlace, MVXRoute, MVXRouteLeg, MVXRouteStep, MVXTransport, extractBannerColor, getSchedule, isCurrentLocation, isDealOrEventBanner, isPlace, prepareAllSchedules, toCurrentLocation };
-export type { CategoryFiltersData, CityFilterOption, CurrentLocation, DaysOfTheWeek, FormattedSchedule, InitialData, InnerFloor, InstitutionResponse, LatLng, MVXLocation, OpeningHours, OpeningTime, PlaceResponse, Property, ReturnToHomeAction, RoutePoint, SearchAction, SearchData, SelectDestinationAction, SelectFilterAction, ShowPlaceAction, UserAction };
+export { AnimationState, Banner, EMPTY_SEARCH_DATA, FALLBACK_IMAGE_URL, Institution, MEASUREMENT_ID, MVXPlace, MVXRoute, MVXRouteLeg, MVXRouteStep, MVXTransport, extractBannerColor, getSchedule, hasOwnPosition, isCurrentLocation, isDealOrEventBanner, isDroppedPin, isPlace, prepareAllSchedules, routePointId, toCurrentLocation, toDroppedPin };
+export type { CategoryFiltersData, CityFilterOption, CurrentLocation, DaysOfTheWeek, DroppedPin, FilterSelection, FormattedSchedule, InitialData, InnerFloor, InstitutionResponse, LatLng, MVXLocation, OpeningHours, OpeningTime, PlaceResponse, Property, ReturnToHomeAction, RoutePoint, SearchAction, SearchData, SelectDestinationAction, SelectFilterAction, ShowPlaceAction, UserAction };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapvx/web-components-ssr",
-  "version": "1.7.0-dev.1",
+  "version": "1.7.0-dev.2",
   "publishConfig": {
     "access": "public"
   },
@@ -36,7 +36,7 @@
     "release": "semantic-release",
     "upload-sourcemaps": "bash scripts/upload-sourcemaps-to-sentry.sh",
     "docs:dev": "npm --prefix docs run dev",
-    "docs:build": "npm --prefix docs ci && npm --prefix docs run build"
+    "docs:build": "node scripts/build-docs.mjs"
   },
   "lint-staged": {
     "*.{css,scss}": "stylelint --fix --allow-empty-input",
@@ -46,56 +46,56 @@
     ]
   },
   "dependencies": {
-    "@angular/common": "^22.1.7",
-    "@angular/compiler": "^22.1.7",
-    "@angular/core": "^22.1.7",
-    "@angular/elements": "^22.1.7",
-    "@angular/forms": "^22.1.7",
-    "@angular/platform-browser": "^22.1.7",
-    "@angular/router": "^22.1.7",
+    "@angular/common": "^22.2.3",
+    "@angular/compiler": "^22.2.3",
+    "@angular/core": "^22.2.3",
+    "@angular/elements": "^22.2.3",
+    "@angular/forms": "^22.2.3",
+    "@angular/platform-browser": "^22.2.3",
+    "@angular/router": "^22.2.3",
     "@fortawesome/angular-fontawesome": "^5.1.0",
     "@fortawesome/fontawesome-svg-core": "^7.3.1",
-    "@sentry/browser": "^10.75.0",
+    "@sentry/browser": "^10.76.2",
     "ngx-google-analytics": "^14.0.1",
     "rxjs": "~7.8.2",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@angular/build": "^22.1.8",
-    "@angular/cli": "^22.1.8",
-    "@angular/compiler-cli": "^22.1.7",
+    "@angular/build": "^22.2.3",
+    "@angular/cli": "^22.2.3",
+    "@angular/compiler-cli": "^22.2.3",
     "@awesome.me/kit-099daaf0b1": "^1.0.75",
-    "@commitlint/cli": "^21.2.2",
+    "@commitlint/cli": "^21.2.4",
     "@eslint/js": "^10.0.1",
-    "@mapvx/web-js": "^4.0.1",
-    "@playwright/test": "^1.63.0",
+    "@mapvx/web-js": "^4.4.0",
+    "@playwright/test": "^1.64.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^12.0.9",
-    "@semantic-release/npm": "^13.1.5",
+    "@semantic-release/github": "^12.0.10",
+    "@semantic-release/npm": "^13.2.0",
     "@semantic-release/release-notes-generator": "^14.1.1",
-    "@sentry/cli": "^3.8.0",
-    "@vitest/coverage-v8": "^4.1.11",
-    "angular-eslint": "^22.5.0",
+    "@sentry/cli": "^3.8.2",
+    "@vitest/coverage-v8": "^4.1.12",
+    "angular-eslint": "^22.6.0",
     "commitlint-config-gitmoji": "^2.3.1",
     "conventional-changelog-conventionalcommits": "~9.3.1",
-    "eslint": "^10.10.0",
+    "eslint": "^10.13.0",
     "eslint-import-resolver-typescript": "^4.4.5",
     "eslint-plugin-import-x": "^4.17.1",
     "http-server": "^14.1.1",
     "husky": "^9.1.7",
     "istanbul-lib-instrument": "^6.0.3",
-    "jsdom": "^30.0.1",
-    "lint-staged": "^17.5.1",
+    "jsdom": "^30.1.3",
+    "lint-staged": "^17.6.0",
     "prettier": "3.9.7",
-    "rollup": "^4.63.3",
+    "rollup": "^4.65.0",
     "rollup-plugin-dts": "^6.5.1",
-    "semantic-release": "^25.0.5",
-    "stylelint": "^17.15.0",
+    "semantic-release": "^25.0.9",
+    "stylelint": "^17.16.0",
     "stylelint-config-standard-scss": "^17.0.0",
     "typescript": "~6.0.3",
-    "typescript-eslint": "^8.70.0",
-    "vitest": "^4.1.11"
+    "typescript-eslint": "^8.72.0",
+    "vitest": "^4.1.12"
   }
 }