Molecule.dev

@molecule/api-push-capture

Provider bond · push-notifications · API (Node) · v1.0.3 · Apache-2.0

Push notification capture provider for molecule.dev

npm install @molecule/api-push-capture

npm · Source on GitHub · Implements @molecule/api-push-notifications

How it works

@molecule/api-push-capture is a provider bond on the API (Node) side: it implements the push-notifications core interface (@molecule/api-push-notifications) with a concrete vendor or library behind it.

Your code calls the core; you wire this provider once at startup. Swapping vendors later is one line in that wiring, not a rewrite.

import { setProvider } from '@molecule/api-push-notifications'
import { provider } from '@molecule/api-push-capture'

setProvider(provider)

Works with: @molecule/api-activity, @molecule/api-push-notifications

Reference

Push notification capture provider for molecule.dev.

Records every send() / sendMany() call as an activity event. Intercept-only by default; delegates + tees when wrapping a real provider.

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

Quick Start

import { setProvider } from '@molecule/api-push-notifications'
import { provider } from '@molecule/api-push-capture'

setProvider(provider)

Type

provider

Installation

npm install @molecule/api-push-capture @molecule/api-activity @molecule/api-push-notifications

API

Functions

createPushCaptureProvider(realProvider)

Creates a push notification capture provider.

When realProvider is provided, each notification is delivered through it and the captured event records the real outcome (delegate + tee). When omitted (the dev default), notifications are intercepted and a synthetic SendResult (statusCode: 201) is returned.

function createPushCaptureProvider(
  realProvider?: PushNotificationProvider,
): PushNotificationProvider
  • realProvider — Optional real provider to delegate to and tee.

Returns: A PushNotificationProvider that records activity for every send.

Constants

provider

Default push notification capture provider (intercept-only).

const provider: PushNotificationProvider

Core Interface

Implements @molecule/api-push-notifications interface.

Bond Wiring

Setup function to register this provider with the core interface:

import { setProvider } from '@molecule/api-push-notifications'
import { provider } from '@molecule/api-push-capture'

export function setupPushNotificationsCapture(): void {
  setProvider(provider)
}

Injection Notes

Requirements

Peer dependencies:

  • @molecule/api-activity ^1.0.1
  • @molecule/api-push-notifications ^1.0.1

Runtime Dependencies

  • @molecule/api-activity

  • @molecule/api-push-notifications

  • Two modes, and the choice decides whether the notification is DELIVERED. INTERCEPT-ONLY (provider, or createPushCaptureProvider() with no argument) records the notification and returns a synthetic 201 — nothing reaches the subscriber. DELEGATE + TEE (createPushCaptureProvider(real)) delivers through the real provider AND records the real outcome. Anywhere real notifications must go out (production), wrap the real provider — never bond the intercept-only provider.

  • Recording is best-effort: a bonded ActivitySink that throws NEVER changes the outcome of send() — a successful real send still resolves and a failed one still rejects with the REAL provider error.

In intercept-only mode (no realProvider), generateVapidKeys() THROWS — there is no real push transport behind it to generate real keys with. Wrap a real provider (createPushCaptureProvider(realProvider)) to delegate key generation, or generate VAPID keys once with a real provider (e.g. @molecule/api-push-notifications-web-push's generateVapidKeys()) and set VAPID_PUBLIC_KEY / VAPID_PRIVATE_KEY. getPublicKey() is unaffected — it honestly falls back to the VAPID_PUBLIC_KEY env var so the enable-push UI keeps working in capture mode even though sends stay captured.

E2E Tests

Integration checklist — drive the real UI (live preview, no mocks), adapt each item to this app's actual screens/flows, and check every box off one by one. A box you can't check is an integration bug to fix — not a skip:

  • The UI offers an enable-notifications control; activating it triggers the browser permission prompt and, once granted, the subscription is stored (the UI still shows "enabled" after a full reload).
  • An event this app notifies about actually delivers a push to the subscribed session, with a readable title/body (not raw JSON). The sandbox CAPTURES outbound pushes instead of delivering — read the captured message with the read_activity tool (filter type 'push'); never mock the flow or modify production code to expose it.
  • Clicking the delivered notification opens/focuses the relevant screen (when the app claims deep-linking).
  • Denying the permission leaves the app fully usable and truthful about the state (no crash, no false "enabled").
  • Disabling/unsubscribing stops deliveries, and the disabled state persists across a reload.