@autobusal/providers 1.10.0 → 1.12.0

package/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to `@autobusal/providers` are documented here. This project
 adheres to [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+> Note: 1.8.0 through 1.11.0 were published without changelog entries. The
+> gap is left as-is rather than reconstructed after the fact.
+
+## [1.12.0] - 2026-08-01
+
+### Added
+
+- `FoundData.stops_count` - intermediate stops between the searched from/to,
+  where 0 means a direct trip. Optional, because external-provider offers do
+  not report one: a filter must read "missing" as unknown, never as direct.
+- `FoundData.priority` - the operator's subscription priority, which obtapi
+  was already sending but which was not typed. Used only as a tiebreak in
+  routes-order's "recommended" ordering.
+
 ## [1.7.0] - 2026-07-31
 
 ### Added

package/Setup/Setup.tsx

@@ -17,7 +17,11 @@ const Setup = ({ type, children }: Props): JSX.Element => {
 
   languages(type, data.preferences.languages.default);
 
-  analytics(data.preferences.googleAnalyticsID);
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // The brand's GTM container, from labels_settings via the admin GUI.
+  // obtapi sends `analytics` only when it is switched on AND configured, so
+  // this is a single truthy check with nothing to keep in sync.
+  analytics(data.analytics?.gtm_id);
 
   return (
     <Preload data={ data }>

package/Setup/analytics.ts

@@ -1,18 +1,75 @@
-import ReactGA from 'react-ga4';
-
-// `send_page_view: false` disables gtag.js's automatic page_view on this
-// initial `config` call - client-side route changes in this SPA never
-// trigger another `config`, so relying on the automatic one meant only
-// the very first page of a session was ever tracked. Every pageview
-// (including the first) is instead sent explicitly from
-// @autobusal/common's Meta component, which re-fires on every route change
-// since it's rendered by (almost) every page - see the comment there.
-const analytics = (id: string | null): void => {
-  if (id === null) {
+/**
+ * Google Tag Manager, loaded per brand from the label's own settings.
+ *
+ * Edited: Ferjolt Ozuni - Date: 2026-08-01
+ *
+ * This replaced a direct GA4 (react-ga4) integration driven by
+ * `preferences.googleAnalyticsID`, which lived in each brand's static
+ * settings.json on disk - not in the database, with no admin screen, so
+ * changing it meant editing a file on the server. It was unset on every
+ * brand, so nothing was actually being measured.
+ *
+ * GTM instead, for the reason GTM exists: GA4, Ads and anything added later
+ * are configured in the container, so a new tag never needs a code change or
+ * a deploy. Nothing in this codebase should know which tags a brand runs.
+ *
+ * The dataLayer is created BEFORE the container script loads. GTM reads
+ * whatever is already queued there when it initialises, so anything pushed
+ * in the meantime - the first page_view, most importantly - survives the
+ * race with the network rather than being dropped.
+ */
+
+declare global {
+  interface Window {
+    dataLayer?: Record<string, any>[]
+  }
+}
+
+const CONTAINER_ID = 'gtm-container';
+
+const analytics = (container: string | null | undefined): void => {
+  if (!container) {
+    return;
+  }
+
+  // Guard against a second insert. Two containers on one page double-count
+  // every tag they fire, and Setup can re-run (a settings refetch, a
+  // remount) without the page ever reloading.
+  if (document.getElementById(CONTAINER_ID)) {
     return;
   }
 
-  ReactGA.initialize(id, { gaOptions: { send_page_view: false } });
+  window.dataLayer = window.dataLayer || [];
+  window.dataLayer.push({ 'gtm.start': Date.now(), event: 'gtm.js' });
+
+  const script = document.createElement('script');
+
+  script.id = CONTAINER_ID;
+  script.async = true;
+  script.src = `https://www.googletagmanager.com/gtm.js?id=${ encodeURIComponent(container) }`;
+
+  document.head.appendChild(script);
+};
+
+/**
+ * Announce a page view.
+ *
+ * A single-page app never reloads, so GTM's own page-load trigger fires
+ * exactly once per session - every client-side route change after that is
+ * invisible unless it is announced. The container is expected to listen for
+ * this `page_view` event and fire GA4 (or anything else) from it.
+ *
+ * Safe to call before GTM has finished loading: the push simply queues.
+ */
+export const pageview = (path: string, title: string): void => {
+  window.dataLayer = window.dataLayer || [];
+
+  window.dataLayer.push({
+    event: 'page_view',
+    page_path: path,
+    page_title: title,
+    page_location: window.location.href
+  });
 };
 
 export default analytics;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autobusal/providers",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "author": "Ferjolt Ozuni",
   "type": "module",
   "main": "index.ts"

package/types/routes.ts

@@ -91,6 +91,16 @@ export interface FoundData extends Omit<RouteData, 'locations' | 'id'> {
   // still assume a real numeric local id.
   price: Omit<PriceData, 'id'> & { id: number | string }
   duration: string
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // Intermediate stops between the searched from/to - 0 is a direct trip.
+  // Optional because external-provider offers don't report one; a filter
+  // must read "missing" as unknown, never as direct.
+  stops_count?: number
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // The operator's subscription priority, as obtapi already sends it.
+  // Used only as a tiebreak in the "recommended" ordering - see
+  // routes-order's Found/refine.ts. Absent on external-provider offers.
+  priority?: number
   customs: string[]
   locations: {
     from: LocationData

package/types/settings.ts

@@ -8,6 +8,14 @@ export interface SettingsData {
   construction?: {
     title: string
     message: string
+  } | null
+
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // The brand's Google Tag Manager container, managed from the admin GUI.
+  // Present ONLY when analytics is switched on and a container is actually
+  // configured, so its presence is the switch. Replaces the old
+  // preferences.googleAnalyticsID, which lived in a static file on disk.
+  analytics?: {
     gtm_id: string
   } | null
 
@@ -41,7 +49,10 @@ export interface SettingsData {
   preferences: {
     company: string
 
-    googleAnalyticsID: string | null
+    /** @deprecated Replaced by the admin-managed GTM container - see
+     *  `analytics` above. Nothing reads this any more; it remains only
+     *  because it is still present in older brands' settings.json files. */
+    googleAnalyticsID?: string | null
     bookingID?: string
 
     operatorId?: number
@@ -231,6 +242,23 @@ export interface LabelSettings {
     description?: string
     keywords?: string
   }
+
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // Admin-managed Google Tag Manager container. The PUBLIC settings payload
+  // exposes only the id, and only while enabled - see
+  // Labels\AdminController::analytics().
+  analytics?: {
+    enabled?: boolean
+    gtm_id?: string
+  }
+
+  // Edited: Ferjolt Ozuni - Date: 2026-08-01
+  // Admin-managed under-construction holding page.
+  construction?: {
+    enabled?: boolean
+    title?: string
+    message?: string
+  }
 }
 
 // Edited: Ferjolt Ozuni - Date: 2026-07-18