@pugpigbolt/bridge 0.1.0 → 0.1.2

package/README.md

@@ -2,13 +2,15 @@
 
 Communication layer between Bolt web apps and the native Pugpig shell. Provides a reactive bridge object that syncs native state (stories, auth, timelines, locale) into the web layer and exposes action methods for triggering native behaviour.
 
+[![npm](https://img.shields.io/npm/v/@pugpigbolt/bridge)](https://www.npmjs.com/package/@pugpigbolt/bridge)
+
 ## Installation
 
 ```bash
 npm install @pugpigbolt/bridge
 ```
 
-Vue is an optional peer dependency — only needed when using `@pugpigbolt/bridge/vue`.
+`vue >= 3` is an optional peer dependency, only needed when using `@pugpigbolt/bridge/vue`.
 
 ## Usage
 
@@ -17,10 +19,8 @@ Vue is an optional peer dependency — only needed when using `@pugpigbolt/bridg
 ```ts
 import { globalBridge } from '@pugpigbolt/bridge'
 
-// Read state
 console.log(globalBridge.stories)
 
-// Listen for changes
 globalBridge.$on('change:stories', (stories) => {
   console.log('stories updated', stories)
 })
@@ -36,7 +36,6 @@ import { BoltBridgeVue } from '@pugpigbolt/bridge/vue'
 
 const app = createApp(App)
 app.use(BoltBridgeVue, () => {
-  // optional callback — called once the bridge is ready
   app.mount('#app')
 })
 ```
@@ -49,29 +48,6 @@ import { useBridge } from '@pugpigbolt/bridge/vue'
 const { stories, openArticle, sendAnalytics } = useBridge()
 ```
 
-`useBridge()` returns Vue refs for all reactive state (individually reactive via `toRefs`) plus bound outgoing action methods.
-
-## Exports
-
-### `@pugpigbolt/bridge`
-
-| Export                              | Description                                                                                                                                                         |
-| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `globalBridge`                      | Proxy-wrapped bridge singleton for non-Vue contexts. Fires `change:<prop>` and `change` events on writes.                                                           |
-| `bootstrap(options?)`               | Framework-agnostic entry-point init. Handles scroll restoration, pugpigUpdate sequence, theme CSS, feed classes, and `timelineIsReady`. Returns a cleanup function. |
-| `createPugpigBridgeService(config)` | Factory for a mock `window.pugpigBridgeService` — used in local development to simulate the native shell.                                                           |
-| All types                           | `Story`, `StoryEntry`, `BridgeService`, `RemoteConfig`, `Timeline`, `Feed`, `AuthorisationStatus`, `BootstrapOptions`, etc.                                         |
-
-### `@pugpigbolt/bridge/vue`
-
-| Export             | Description                                                                                                              |
-| ------------------ | ------------------------------------------------------------------------------------------------------------------------ |
-| `BoltBridgeVue`    | Vue plugin. Sets `$bridge` on `globalProperties`, installs tooltip directive, lazy-loads dev overlay in `?preview` mode. |
-| `useBridge()`      | Composable returning reactive state refs + bound action methods.                                                         |
-| `globalBridge`     | `reactive(rawBridge)` — Vue-reactive bridge, also set as `window.boltBridge`.                                            |
-| `isDebug`          | `true` when `window.location.search` includes `'preview'`.                                                               |
-| `registerToolTips` | Registers tooltip definitions for the native tooltip directive.                                                          |
-
 ## Local development (mock bridge)
 
 When running outside the native shell, install a mock service to simulate native responses:
@@ -81,15 +57,9 @@ import { createPugpigBridgeService } from '@pugpigbolt/bridge'
 
 window.pugpigBridgeService = createPugpigBridgeService({
   live_domain: 'https://example.com',
-  stories: [...],          // StoryEntry[]
-  timelines: [...],        // Timeline[]
+  stories: [...],
+  timelines: [...],
   timeline: { id: 'main' },
   debugLogs: true,
 })
 ```
-
-## How it works
-
-The native Pugpig shell calls `window.pugpigUpdate(method, payload)` to push state into the web view. `@pugpigbolt/bridge` registers this global and dispatches calls to internal handlers that update the reactive store. The store is exposed via `globalBridge` / `useBridge()`.
-
-Outgoing calls (open article, share, analytics, etc.) invoke `window.pugpigBridgeService[method](jsonPayload)` — the native shell implements this interface.

package/dist/{bootstrap-DnSyt3hZ.mjs → bootstrap-DQyoNFue.mjs}

@@ -174,6 +174,7 @@ const analytics = {
 	},
 	sendAnalytics(type, story, index = 0, dimensions = {}) {
 		const pathName = getPathName();
+		const baseUrl = story?.originalBaseURL || story?.baseURL;
 		const overrides = typeof type === "object" && type !== null ? type : {};
 		const payload = {
 			type,
@@ -183,14 +184,19 @@ const analytics = {
 			dimensions,
 			...overrides
 		};
+		let paramName = payload.paramName || "pugpigEditionID";
+		const category = this.timelineType === "SavedTimeline" ? "/SavedTimeline" : "/Timeline";
 		payload.dimensions.pugpigEventOrigin = pathName;
-		if (pathName !== "Bolt Timeline") return analytics.sendAnalyticsEvent(payload.type, "/Timeline", payload.param, payload.dimensions, payload.story?.entry, payload.story?.feedid, payload.index);
-		return dispatchBridgeAction("trackAnalyticsEvent", payload);
+		if (!payload.paramName && payload?.param === payload?.story?.entry.title) paramName = "pugpigPageName";
+		if (payload?.story?.entry.url && baseUrl) payload.story.entry.url = new URL(payload.story.entry.url, baseUrl).href;
+		if (payload?.story?.entry.shareurl && baseUrl) payload.story.entry.shareurl = new URL(payload.story.entry.shareurl, baseUrl).href;
+		return analytics.sendAnalyticsEvent(payload.type, category, payload.param, paramName, payload.dimensions, payload.story?.entry, payload.story?.feedid, payload.index);
 	},
-	sendAnalyticsEvent(name, category, param = "", dimensions = {}, storyEntry, feedid, index) {
+	sendAnalyticsEvent(name, category, param = "", paramName = "", dimensions = {}, storyEntry, feedid, index) {
 		const payload = {
 			name,
 			category,
+			paramName,
 			feedid,
 			storyEntry,
 			index,
@@ -480,8 +486,8 @@ const BOOTSTRAP_METHODS = [
 	"actionProviderNames",
 	"stories"
 ];
-function triggerPugpigUpdateSequence() {
-	for (const method of BOOTSTRAP_METHODS) window.pugpigUpdate(method);
+function triggerPugpigUpdateSequence(methods = BOOTSTRAP_METHODS) {
+	for (const method of methods) window.pugpigUpdate(method);
 }
 function bootstrap(bridge, options = {}) {
 	const { rootSelector = "#app", readyTimeout = 4e3 } = options;

package/dist/{index-D5X9A3Gj.d.mts → index-BjDhZ_q5.d.mts}

@@ -402,6 +402,7 @@ interface AnalyticsContext {
   feed?: {
     id?: string;
   };
+  timelineType?: string;
 }
 interface AnalyticsDimensions {
   pugpigEventOrigin?: string;
@@ -487,7 +488,7 @@ declare const rawBridge: {
   openImageGallery(images: StoryImage[] | undefined, initialImage?: number): Promise<unknown>;
   logInfo(this: AnalyticsContext, logLevel: string, payload: string): void;
   sendAnalytics(this: AnalyticsContext, type: string | Record<string, unknown>, story: Story, index?: number, dimensions?: AnalyticsDimensions): Promise<unknown>;
-  sendAnalyticsEvent(name: string, category: string, param?: string, dimensions?: AnalyticsDimensions, storyEntry?: StoryEntry, feedid?: string, index?: number): Promise<unknown>;
+  sendAnalyticsEvent(name: string, category: string, param?: string, paramName?: string, dimensions?: AnalyticsDimensions, storyEntry?: StoryEntry, feedid?: string, index?: number): Promise<unknown>;
   openArticle(story: Story, index: number): Promise<unknown>;
   openEdition(editionId: string, defaultPartition?: string, skipTimeline?: boolean, autoDownload?: boolean): Promise<unknown>;
   shouldViewWidget(story: Story, index: number): Promise<unknown>;
@@ -581,6 +582,10 @@ declare function createPugpigBridgeService(config: BridgeServiceConfig): {
   setRead(payload?: string): any;
 };
 //#endregion
+//#region src/core/bootstrap.d.ts
+declare const BOOTSTRAP_METHODS: readonly ["localeInfo", "timelineInfo", "authorisationStatus", "savedStories", "readStories", "updateTime", "actionProviderNames", "stories"];
+declare function triggerPugpigUpdateSequence(methods?: readonly string[]): void;
+//#endregion
 //#region src/index.d.ts
 /**
  * @signature globalBridge: GlobalBridge
@@ -593,4 +598,4 @@ declare const globalBridge: GlobalBridge;
  */
 declare function bootstrap(options?: BootstrapOptions): () => void;
 //#endregion
-export { UpdateTimePayload as A, Theme as C, TimelineMetadata as D, TimelineInfoPayload as E, TimelineState as O, StoryImage as S, TimelineArgs as T, RemoteConfig as _, AdSize as a, Story as b, AuthorisationStatus as c, BridgeService as d, Feed as f, ReadStoriesPayload as g, PugpigBridgeService as h, GlobalBridge as i, WebviewInfoPayload as j, TimelinesInfoPayload as k, BoltBridgePlugin as l, LocaleInfoPayload as m, globalBridge as n, AnalyticsContext as o, IssueAuthorisationStatus as p, createPugpigBridgeService as r, AnalyticsDimensions as s, bootstrap as t, BootstrapOptions as u, SavedStoriesPayload as v, Timeline as w, StoryEntry as x, StoriesPayload as y };
+export { TimelineState as A, StoryEntry as C, TimelineArgs as D, Timeline as E, UpdateTimePayload as M, WebviewInfoPayload as N, TimelineInfoPayload as O, Story as S, Theme as T, PugpigBridgeService as _, createPugpigBridgeService as a, SavedStoriesPayload as b, AnalyticsContext as c, BoltBridgePlugin as d, BootstrapOptions as f, LocaleInfoPayload as g, IssueAuthorisationStatus as h, triggerPugpigUpdateSequence as i, TimelinesInfoPayload as j, TimelineMetadata as k, AnalyticsDimensions as l, Feed as m, globalBridge as n, GlobalBridge as o, BridgeService as p, BOOTSTRAP_METHODS as r, AdSize as s, bootstrap as t, AuthorisationStatus as u, ReadStoriesPayload as v, StoryImage as w, StoriesPayload as x, RemoteConfig as y };

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { A as UpdateTimePayload, C as Theme, D as TimelineMetadata, E as TimelineInfoPayload, O as TimelineState, S as StoryImage, T as TimelineArgs, _ as RemoteConfig, a as AdSize, b as Story, c as AuthorisationStatus, d as BridgeService, f as Feed, g as ReadStoriesPayload, h as PugpigBridgeService, i as GlobalBridge, j as WebviewInfoPayload, k as TimelinesInfoPayload, l as BoltBridgePlugin, m as LocaleInfoPayload, n as globalBridge, o as AnalyticsContext, p as IssueAuthorisationStatus, r as createPugpigBridgeService, s as AnalyticsDimensions, t as bootstrap, u as BootstrapOptions, v as SavedStoriesPayload, w as Timeline, x as StoryEntry, y as StoriesPayload } from "./index-D5X9A3Gj.mjs";
-export { AdSize, AnalyticsContext, AnalyticsDimensions, AuthorisationStatus, BoltBridgePlugin, BootstrapOptions, BridgeService, Feed, GlobalBridge, IssueAuthorisationStatus, LocaleInfoPayload, PugpigBridgeService, ReadStoriesPayload, RemoteConfig, SavedStoriesPayload, StoriesPayload, Story, StoryEntry, StoryImage, Theme, Timeline, TimelineArgs, TimelineInfoPayload, TimelineMetadata, TimelineState, TimelinesInfoPayload, UpdateTimePayload, WebviewInfoPayload, bootstrap, createPugpigBridgeService, globalBridge };
+import { A as TimelineState, C as StoryEntry, D as TimelineArgs, E as Timeline, M as UpdateTimePayload, N as WebviewInfoPayload, O as TimelineInfoPayload, S as Story, T as Theme, _ as PugpigBridgeService, a as createPugpigBridgeService, b as SavedStoriesPayload, c as AnalyticsContext, d as BoltBridgePlugin, f as BootstrapOptions, g as LocaleInfoPayload, h as IssueAuthorisationStatus, i as triggerPugpigUpdateSequence, j as TimelinesInfoPayload, k as TimelineMetadata, l as AnalyticsDimensions, m as Feed, n as globalBridge, o as GlobalBridge, p as BridgeService, r as BOOTSTRAP_METHODS, s as AdSize, t as bootstrap, u as AuthorisationStatus, v as ReadStoriesPayload, w as StoryImage, x as StoriesPayload, y as RemoteConfig } from "./index-BjDhZ_q5.mjs";
+export { AdSize, AnalyticsContext, AnalyticsDimensions, AuthorisationStatus, BOOTSTRAP_METHODS, BoltBridgePlugin, BootstrapOptions, BridgeService, Feed, GlobalBridge, IssueAuthorisationStatus, LocaleInfoPayload, PugpigBridgeService, ReadStoriesPayload, RemoteConfig, SavedStoriesPayload, StoriesPayload, Story, StoryEntry, StoryImage, Theme, Timeline, TimelineArgs, TimelineInfoPayload, TimelineMetadata, TimelineState, TimelinesInfoPayload, UpdateTimePayload, WebviewInfoPayload, bootstrap, createPugpigBridgeService, globalBridge, triggerPugpigUpdateSequence };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { a as makeProxyBridge, i as setupPugpigUpdate, n as bootstrap$1, o as rawBridge } from "./bootstrap-DnSyt3hZ.mjs";
+import { a as makeProxyBridge, i as setupPugpigUpdate, n as bootstrap$1, o as rawBridge, r as triggerPugpigUpdateSequence, t as BOOTSTRAP_METHODS } from "./bootstrap-DQyoNFue.mjs";
 import { t as createPugpigBridgeService } from "./mockBridgeService-vnaAIjCu.mjs";
 //#region src/index.ts
 /**
@@ -16,4 +16,4 @@ function bootstrap(options) {
 	return bootstrap$1(globalBridge, options);
 }
 //#endregion
-export { bootstrap, createPugpigBridgeService, globalBridge };
+export { BOOTSTRAP_METHODS, bootstrap, createPugpigBridgeService, globalBridge, triggerPugpigUpdateSequence };

package/dist/vue.d.mts

@@ -1,4 +1,4 @@
-import { A as UpdateTimePayload, C as Theme, D as TimelineMetadata, E as TimelineInfoPayload, O as TimelineState, S as StoryImage, T as TimelineArgs, _ as RemoteConfig, a as AdSize, b as Story, c as AuthorisationStatus, d as BridgeService, f as Feed, g as ReadStoriesPayload, h as PugpigBridgeService, i as GlobalBridge, j as WebviewInfoPayload, k as TimelinesInfoPayload, l as BoltBridgePlugin, m as LocaleInfoPayload, o as AnalyticsContext, p as IssueAuthorisationStatus, s as AnalyticsDimensions, u as BootstrapOptions, v as SavedStoriesPayload, w as Timeline, x as StoryEntry, y as StoriesPayload } from "./index-D5X9A3Gj.mjs";
+import { A as TimelineState, C as StoryEntry, D as TimelineArgs, E as Timeline, M as UpdateTimePayload, N as WebviewInfoPayload, O as TimelineInfoPayload, S as Story, T as Theme, _ as PugpigBridgeService, b as SavedStoriesPayload, c as AnalyticsContext, d as BoltBridgePlugin, f as BootstrapOptions, g as LocaleInfoPayload, h as IssueAuthorisationStatus, i as triggerPugpigUpdateSequence, j as TimelinesInfoPayload, k as TimelineMetadata, l as AnalyticsDimensions, m as Feed, o as GlobalBridge, p as BridgeService, r as BOOTSTRAP_METHODS, s as AdSize, u as AuthorisationStatus, v as ReadStoriesPayload, w as StoryImage, x as StoriesPayload, y as RemoteConfig } from "./index-BjDhZ_q5.mjs";
 import * as _$vue from "vue";
 import { App } from "vue";
 
@@ -69,7 +69,7 @@ declare function useBridge(): {
   openImageGallery(images: StoryImage[] | undefined, initialImage?: number): Promise<unknown>;
   logInfo(this: AnalyticsContext, logLevel: string, payload: string): void;
   sendAnalytics(this: AnalyticsContext, type: string | Record<string, unknown>, story: Story, index?: number, dimensions?: AnalyticsDimensions): Promise<unknown>;
-  sendAnalyticsEvent(name: string, category: string, param?: string, dimensions?: AnalyticsDimensions, storyEntry?: StoryEntry, feedid?: string, index?: number): Promise<unknown>;
+  sendAnalyticsEvent(name: string, category: string, param?: string, paramName?: string, dimensions?: AnalyticsDimensions, storyEntry?: StoryEntry, feedid?: string, index?: number): Promise<unknown>;
   openArticle(story: Story, index: number): Promise<unknown>;
   openEdition(editionId: string, defaultPartition?: string, skipTimeline?: boolean, autoDownload?: boolean): Promise<unknown>;
   shouldViewWidget(story: Story, index: number): Promise<unknown>;
@@ -106,10 +106,6 @@ declare function useBridge(): {
 };
 type UseBridgeReturn = ReturnType<typeof useBridge>;
 //#endregion
-//#region src/core/bootstrap.d.ts
-declare const BOOTSTRAP_METHODS: readonly ["localeInfo", "timelineInfo", "authorisationStatus", "savedStories", "readStories", "updateTime", "actionProviderNames", "stories"];
-declare function triggerPugpigUpdateSequence(): void;
-//#endregion
 //#region src/vue/bootstrap.d.ts
 declare function useBootstrap(options?: BootstrapOptions): void;
 declare function injectThemeAndWait(readyTimeout?: number): void;

package/dist/vue.mjs

@@ -1,4 +1,4 @@
-import { i as setupPugpigUpdate, o as rawBridge, r as triggerPugpigUpdateSequence, s as outgoingActions, t as BOOTSTRAP_METHODS } from "./bootstrap-DnSyt3hZ.mjs";
+import { i as setupPugpigUpdate, o as rawBridge, r as triggerPugpigUpdateSequence, s as outgoingActions, t as BOOTSTRAP_METHODS } from "./bootstrap-DQyoNFue.mjs";
 import { onUnmounted, reactive, ref, toRefs, watchEffect } from "vue";
 //#region src/vue/tooltip.ts
 const tooltipsQueue = ref([]);

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@pugpigbolt/bridge",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "license": "MIT",
   "files": [
     "dist"
   ],