@wssto2/vue-core 0.5.1 → 0.5.2

package/dist/index.d.ts

@@ -1,2 +1,2 @@
 /** The version of @wssto2/vue-core (kept equal to package.json by index.test.ts). */
-export declare const version = "0.5.1";
+export declare const version = "0.5.2";

package/dist/index.js

@@ -1,4 +1,4 @@
-const o = "0.5.1";
+const o = "0.5.2";
 export {
   o as version
 };

package/dist/notifications/index.d.ts

@@ -7,6 +7,8 @@ export { eventsRoutes } from "../modules/events/routes";
 export { notificationsFeature } from "./feature";
 export type { NotificationsFeatureOptions } from "./feature";
 export type { NotificationCategoryLook, NotificationSettingsSection } from "./context";
+export { usePushState } from "./push/pushState";
+export type { PushState } from "./push/pushState";
 export { notificationSettingsRoutes } from "./settings/routes";
 export type { NotificationSettingsRoutes } from "./settings/routes";
 export { deadLettersRoutes } from "./deadletters/routes";

package/dist/notifications/index.js

@@ -1,8 +1,9 @@
-import { d as s, e as o, n as a, b as i, c as n } from "../index-BTRv8mcf.js";
+import { d as s, e as a, n as o, b as i, c as n, f as u } from "../index-BPwfLD7i.js";
 export {
   s as deadLettersRoutes,
-  o as eventsRoutes,
-  a as notificationRoutes,
+  a as eventsRoutes,
+  o as notificationRoutes,
   i as notificationSettingsRoutes,
-  n as notificationsFeature
+  n as notificationsFeature,
+  u as usePushState
 };

package/dist/notifications/push/pushState.d.ts

@@ -0,0 +1,27 @@
+import { type ComputedRef, type Ref } from "vue";
+import type { HttpClient } from "../../client";
+import { type PushBrowser } from "./browser";
+/** This browser's push, for an application's own screens (an onboarding step): the same state the settings page shows. */
+export interface PushState {
+    /** Settled: `available`, `permission` and `subscribed` are read. Until then `subscribed` is false, so wait for it before offering push. */
+    readonly ready: Readonly<Ref<boolean>>;
+    /** The server has push and this browser can use it (not an old browser, not an iPhone Safari tab outside the home-screen app). */
+    readonly available: ComputedRef<boolean>;
+    /** The browser's permission; `unknown` where there is no Notification API. */
+    readonly permission: Readonly<Ref<NotificationPermission | "unknown">>;
+    /** This browser holds a push subscription, backed by the permission, which the server was given at sign-in or by `enable()`. */
+    readonly subscribed: ComputedRef<boolean>;
+    readonly busy: Readonly<Ref<boolean>>;
+    /** Asks for the permission and registers this browser; call it from a tap. Resolves to `subscribed`. */
+    enable(): Promise<boolean>;
+    /** Stops push on this browser only. */
+    disable(): Promise<void>;
+}
+/**
+ * This browser's push state and its two actions, read at once when called (in `setup`). Built on what the notification settings page uses,
+ * so a browser that already has push on is `subscribed` and an onboarding step does not offer it again.
+ *
+ *   const push = usePushState();
+ *   // v-if="push.ready.value && push.available.value && !push.subscribed.value" -> <Button @click="push.enable()">
+ */
+export declare function usePushState(http?: HttpClient, browser?: PushBrowser): PushState;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wssto2/vue-core",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "goCore": "v1.8.0",
   "description": "Shared Vue 3 library for go-core applications: app shell, list / record / form pages and their controls.",
   "keywords": [