@pyric/cli 0.1.0-alpha.10 → 0.1.0-alpha.11

package/dist/serve/docs-ui/docs/pyric-messaging-sw-reference-api.md

@@ -1,206 +1,4 @@
-
-<!-- Generated from published package declarations via TypeDoc. Do not edit by hand; run bun run docs:api:generate. -->
-
-## Interfaces
-
-<a id="deliverspec"></a>
-
-### DeliverSpec
-
-#### Properties
-
-| Property | Type | Description |
-| :------ | :------ | :------ |
-| <a id="data"></a> `data?` | `Record`\<`string`, `string`\> | - |
-| <a id="from"></a> `from?` | `string` | - |
-| <a id="messageid"></a> `messageId?` | `string` | - |
-| <a id="notification"></a> `notification?` | \{ `body?`: `string`; `image?`: `string`; `title?`: `string`; \} | - |
-| `notification.body?` | `string` | - |
-| `notification.image?` | `string` | - |
-| `notification.title?` | `string` | - |
-| <a id="visibilitystate"></a> `visibilityState?` | `"visible"` \| `"hidden"` | Simulated visibility of the (single) window client at delivery time. |
-
-***
-
-<a id="deliveryresult"></a>
-
-### DeliveryResult
-
-#### Properties
-
-| Property | Type | Description |
-| :------ | :------ | :------ |
-| <a id="handlercount"></a> `handlerCount` | `number` | Handlers actually invoked on the chosen route. |
-| <a id="payload"></a> `payload` | `DeliveredPayload` | - |
-| <a id="route"></a> `route` | `DeliveryRoute` | - |
-
-***
-
-<a id="fcmoptions"></a>
-
-### FcmOptions
-
-Options carried on a client [MessagePayload](#messagepayload).
-
-#### Properties
-
-| Property | Type |
-| :------ | :------ |
-| <a id="analyticslabel"></a> `analyticsLabel?` | `string` |
-| <a id="link"></a> `link?` | `string` |
-
-***
-
-<a id="gettokenoptions"></a>
-
-### GetTokenOptions
-
-Options for getToken.
-
-#### Properties
-
-| Property | Type | Description |
-| :------ | :------ | :------ |
-| <a id="serviceworkerregistration"></a> `serviceWorkerRegistration?` | `object` | A (simulated) service-worker registration; token stability keys on its identity. |
-| <a id="vapidkey"></a> `vapidKey?` | `string` | - |
-
-***
-
-<a id="messagepayload"></a>
-
-### MessagePayload
-
-Received message envelope delivered to `onMessage` / `onBackgroundMessage`.
-`from` / `collapseKey` / `messageId` are typed required (upstream parity);
-captured production deliveries carry top-level keys
-`data` / `from` / `messageId` (+ `notification`) — `collapseKey` was not
-observed on the wire and the sandbox likewise omits it at runtime.
-
-#### Properties
-
-| Property | Type |
-| :------ | :------ |
-| <a id="collapsekey"></a> `collapseKey` | `string` |
-| <a id="data-1"></a> `data?` | \{ \[`key`: `string`\]: `string`; \} |
-| <a id="fcmoptions-1"></a> `fcmOptions?` | [`FcmOptions`](#fcmoptions) |
-| <a id="from-1"></a> `from` | `string` |
-| <a id="messageid-1"></a> `messageId` | `string` |
-| <a id="notification-1"></a> `notification?` | [`NotificationPayload`](#notificationpayload) |
-
-***
-
-<a id="messaging"></a>
-
-### Messaging
-
-The FCM `Messaging` instance mirror — exposes the bound app as `app`
-(upstream `@firebase/messaging` public-types parity).
-
-#### Properties
-
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="app"></a> `app` | `readonly` | `FirebaseApp` |
-
-***
-
-<a id="notificationpayload"></a>
-
-### NotificationPayload
-
-Display-notification block inside a [MessagePayload](#messagepayload).
-
-#### Properties
-
-| Property | Type |
-| :------ | :------ |
-| <a id="body"></a> `body?` | `string` |
-| <a id="icon"></a> `icon?` | `string` |
-| <a id="image"></a> `image?` | `string` |
-| <a id="title"></a> `title?` | `string` |
-
-***
-
-<a id="observer"></a>
-
-### Observer
-
-#### Type Parameters
-
-| Type Parameter |
-| :------ |
-| `T` |
-
-#### Properties
-
-| Property | Type |
-| :------ | :------ |
-| <a id="complete"></a> `complete` | () => `void` |
-| <a id="error"></a> `error` | (`error`: `Error`) => `void` |
-| <a id="next"></a> `next` | [`NextFn`](#nextfn)\<`T`\> |
-
-***
-
-<a id="simulatedserviceworkerregistration"></a>
-
-### SimulatedServiceWorkerRegistration
-
-Minimal structural stand-in for a `ServiceWorkerRegistration` in the
-headless sandbox (bun has no DOM lib). Identity is what matters: token
-stability is keyed per registration object.
-
-#### Properties
-
-| Property | Modifier | Type |
-| :------ | :------ | :------ |
-| <a id="active"></a> `active` | `readonly` | \{ `state`: `"activated"`; \} |
-| `active.state` | `readonly` | `"activated"` |
-| <a id="scope"></a> `scope` | `readonly` | `string` |
-
-## Type Aliases
-
-<a id="nextfn"></a>
-
-### NextFn()
-
-```ts
-type NextFn<T> = (value: T) => void;
-```
-
-Callback / observer / teardown shapes — structurally identical to the
-`@firebase/util` types the upstream entry re-exports (declared locally
-because `@firebase/util` is not a direct dependency of `pyric`; the
-tier-2 assignability census closes exact type parity).
-
-#### Type Parameters
-
-| Type Parameter |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Parameter | Type |
-| :------ | :------ |
-| `value` | `T` |
-
-#### Returns
-
-`void`
-
-***
-
-<a id="unsubscribe"></a>
-
-### Unsubscribe()
-
-```ts
-type Unsubscribe = () => void;
-```
-
-#### Returns
-
-`void`
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
 
 ## Variables
 
@@ -231,12 +29,12 @@ Same driver as the client entry — see `pyric/messaging`'s `sandbox.deliver`.
 
 | Parameter | Type |
 | :------ | :------ |
-| `messaging` | [`Messaging`](#messaging) |
-| `spec` | [`DeliverSpec`](#deliverspec) |
+| `messaging` | [`Messaging`](pyric-messaging-reference-api.md#messaging) |
+| `spec` | [`DeliverSpec`](pyric-messaging-reference-api.md#deliverspec) |
 
 ###### Returns
 
-`Promise`\<[`DeliveryResult`](#deliveryresult)\>
+`Promise`\<[`DeliveryResult`](pyric-messaging-reference-api.md#deliveryresult)\>
 
 <a id="registration"></a>
 
@@ -250,7 +48,7 @@ The module-default simulated service-worker registration.
 
 ###### Returns
 
-[`SimulatedServiceWorkerRegistration`](#simulatedserviceworkerregistration)
+[`SimulatedServiceWorkerRegistration`](pyric-messaging-reference-api.md#simulatedserviceworkerregistration)
 
 ## Functions
 
@@ -270,7 +68,7 @@ nothing — there is no BigQuery plane to export to.
 
 | Parameter | Type |
 | :------ | :------ |
-| `messaging` | [`Messaging`](#messaging) |
+| `messaging` | [`Messaging`](pyric-messaging-reference-api.md#messaging) |
 | `enable` | `boolean` |
 
 #### Returns
@@ -295,11 +93,11 @@ service-worker plane (upstream: `getMessagingInSw`, component name
 
 | Parameter | Type |
 | :------ | :------ |
-| `app?` | `FirebaseApp` |
+| `app?` | [`FirebaseApp`](pyric-app-reference-api.md#firebaseapp) |
 
 #### Returns
 
-[`Messaging`](#messaging)
+[`Messaging`](pyric-messaging-reference-api.md#messaging)
 
 ***
 
@@ -332,17 +130,106 @@ function onBackgroundMessage(messaging: Messaging, nextOrObserver:
 Called when a message arrives while the app has NO visible window client
 (oracle: `messaging-web-onbackgroundmessage`,
 `messaging-web-visibility-routing`). A DATA-ONLY message still fires with
-no `notification` key (oracle: `messaging-web-data-only-background`), and
-registering a handler suppresses the SDK auto-display — the sandbox has
-no display plane, so suppression is the (only) modeled behavior.
+no `notification` key (oracle: `messaging-web-data-only-background`). As in
+Firebase, registering a handler suppresses SDK auto-display. A handler that
+runs in a real Service Worker may use `self.registration.showNotification()`;
+the in-page fallback has no native display plane.
 
 #### Parameters
 
 | Parameter | Type |
 | :------ | :------ |
-| `messaging` | [`Messaging`](#messaging) |
-| `nextOrObserver` | \| [`NextFn`](#nextfn)\<[`MessagePayload`](#messagepayload)\> \| [`Observer`](#observer)\<[`MessagePayload`](#messagepayload)\> |
+| `messaging` | [`Messaging`](pyric-messaging-reference-api.md#messaging) |
+| `nextOrObserver` | \| [`NextFn`](pyric-messaging-reference-api.md#nextfn)\<[`MessagePayload`](pyric-messaging-reference-api.md#messagepayload)\> \| [`Observer`](pyric-messaging-reference-api.md#observer)\<[`MessagePayload`](pyric-messaging-reference-api.md#messagepayload)\> |
 
 #### Returns
 
-[`Unsubscribe`](#unsubscribe)
+[`Unsubscribe`](pyric-messaging-reference-api.md#unsubscribe)
+
+## References
+
+<a id="deliverspec"></a>
+
+### DeliverSpec
+
+Re-exports [DeliverSpec](pyric-messaging-reference-api.md#deliverspec)
+
+***
+
+<a id="deliveryresult"></a>
+
+### DeliveryResult
+
+Re-exports [DeliveryResult](pyric-messaging-reference-api.md#deliveryresult)
+
+***
+
+<a id="fcmoptions"></a>
+
+### FcmOptions
+
+Re-exports [FcmOptions](pyric-messaging-reference-api.md#fcmoptions)
+
+***
+
+<a id="gettokenoptions"></a>
+
+### GetTokenOptions
+
+Re-exports [GetTokenOptions](pyric-messaging-reference-api.md#gettokenoptions)
+
+***
+
+<a id="messagepayload"></a>
+
+### MessagePayload
+
+Re-exports [MessagePayload](pyric-messaging-reference-api.md#messagepayload)
+
+***
+
+<a id="messaging"></a>
+
+### Messaging
+
+Re-exports [Messaging](pyric-messaging-reference-api.md#messaging)
+
+***
+
+<a id="nextfn"></a>
+
+### NextFn
+
+Re-exports [NextFn](pyric-messaging-reference-api.md#nextfn)
+
+***
+
+<a id="notificationpayload"></a>
+
+### NotificationPayload
+
+Re-exports [NotificationPayload](pyric-messaging-reference-api.md#notificationpayload)
+
+***
+
+<a id="observer"></a>
+
+### Observer
+
+Re-exports [Observer](pyric-messaging-reference-api.md#observer)
+
+***
+
+<a id="simulatedserviceworkerregistration"></a>
+
+### SimulatedServiceWorkerRegistration
+
+Re-exports [SimulatedServiceWorkerRegistration](pyric-messaging-reference-api.md#simulatedserviceworkerregistration)
+
+***
+
+<a id="unsubscribe"></a>
+
+### Unsubscribe
+
+Re-exports [Unsubscribe](pyric-messaging-reference-api.md#unsubscribe)