tempest-react-sdk 0.5.1 → 0.8.0

package/dist/sw.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Install a `notificationclick` handler that focuses an existing client when
+ * possible and falls back to opening a new window.
+ */
+export declare function installNotificationClickHandler(options?: InstallNotificationClickHandlerOptions): void;
+
+export declare interface InstallNotificationClickHandlerOptions {
+    /** Resolve the destination URL from the notification data. Default: `data.url`. */
+    resolveUrl?: (data: unknown) => string;
+}
+
+/**
+ * Install a `push` event listener that parses the payload as JSON (with a
+ * plain-text fallback) and shows a notification.
+ */
+export declare function installPushHandler(options?: InstallPushHandlerOptions): void;
+
+export declare interface InstallPushHandlerOptions {
+    /** Title used when the payload omits one. */
+    defaultTitle?: string;
+    /** Icon used when the payload omits one. */
+    defaultIcon?: string;
+    /** Badge image (mobile). */
+    defaultBadge?: string;
+    /**
+     * Transform the raw payload before showing the notification. Return `null`
+     * to suppress the notification entirely (e.g. silent pings).
+     */
+    transform?: (payload: PushPayload) => PushPayload | null;
+}
+
+/**
+ * Install a `message` listener that activates a waiting worker when the host
+ * app sends `{ type: "SKIP_WAITING" }`.
+ */
+export declare function installSkipWaitingListener(): void;
+
+/**
+ * Service-worker context helpers for handling `push` and `notificationclick`
+ * events. Import these inside your own `sw.ts` — they expect to run in the
+ * service-worker global scope, not in the main thread.
+ *
+ * @example
+ *   /// <reference lib="webworker" />
+ *   import { installPushHandler, installNotificationClickHandler } from "tempest-react-sdk";
+ *
+ *   installPushHandler({ defaultIcon: "/icons/Logo.png" });
+ *   installNotificationClickHandler();
+ */
+export declare interface PushPayload {
+    title?: string;
+    body?: string;
+    icon?: string;
+    badge?: string;
+    image?: string;
+    tag?: string;
+    url?: string;
+    /** Arbitrary extra data forwarded to `event.notification.data`. */
+    data?: Record<string, unknown>;
+}
+
+/**
+ * Register a service worker with consistent update-detection wiring.
+ *
+ * Skips silently when the runtime has no `serviceWorker` support. The host
+ * app keeps full control over the SW file — this helper only handles the
+ * boilerplate around `register()` and `updatefound`.
+ *
+ * @returns The registration when it succeeds, or `null` when unsupported.
+ */
+export declare function registerServiceWorker(options: RegisterServiceWorkerOptions): Promise<ServiceWorkerRegistration | null>;
+
+export declare interface RegisterServiceWorkerOptions {
+    /** Public URL of the compiled service worker file (e.g. `/sw.js`). */
+    url: string;
+    /** SW scope (default: SW directory). */
+    scope?: string;
+    /** Called once the registration is active. */
+    onReady?: (registration: ServiceWorkerRegistration) => void;
+    /**
+     * Called when a new worker has finished installing while another worker
+     * still controls the page. The host app typically prompts the user to
+     * reload and then calls {@link skipWaiting} on the returned worker.
+     */
+    onUpdate?: (waiting: ServiceWorker, registration: ServiceWorkerRegistration) => void;
+    /** Called on registration failure. */
+    onError?: (error: unknown) => void;
+}
+
+/**
+ * Tell a waiting worker to activate immediately. Pair with `onUpdate` to roll
+ * out updates after the user confirms a reload prompt.
+ */
+export declare function skipWaiting(worker: ServiceWorker): void;
+
+/**
+ * Unregister all registered service workers for this origin.
+ *
+ * @returns Number of workers that were unregistered.
+ */
+export declare function unregisterAllServiceWorkers(): Promise<number>;
+
+export { }

package/dist/sw.js

@@ -0,0 +1,95 @@
+async function d(n) {
+  if (typeof navigator > "u" || !("serviceWorker" in navigator))
+    return null;
+  try {
+    const t = await navigator.serviceWorker.register(n.url, {
+      scope: n.scope
+    });
+    return t.active && n.onReady?.(t), t.addEventListener("updatefound", () => {
+      const i = t.installing;
+      i && i.addEventListener("statechange", () => {
+        i.state === "installed" && navigator.serviceWorker.controller && n.onUpdate?.(i, t);
+      });
+    }), t;
+  } catch (t) {
+    return n.onError?.(t), null;
+  }
+}
+function g(n) {
+  n.postMessage({ type: "SKIP_WAITING" });
+}
+async function v() {
+  if (typeof navigator > "u" || !("serviceWorker" in navigator)) return 0;
+  const n = await navigator.serviceWorker.getRegistrations();
+  let t = 0;
+  for (const i of n)
+    await i.unregister() && (t += 1);
+  return t;
+}
+function l() {
+  return globalThis;
+}
+function y(n = {}) {
+  const t = l(), { defaultTitle: i = "Notificação", defaultIcon: e, defaultBadge: o, transform: s } = n;
+  t.addEventListener("push", (a) => {
+    if (!a.data) return;
+    let c;
+    try {
+      c = a.data.json();
+    } catch {
+      c = { title: i, body: a.data.text() };
+    }
+    const r = s ? s(c) : c;
+    if (!r) return;
+    const u = r.title ?? i, f = {
+      body: r.body,
+      icon: r.icon ?? e,
+      badge: r.badge ?? o,
+      image: r.image,
+      tag: r.tag,
+      data: { url: r.url ?? "/", ...r.data ?? {} }
+    };
+    a.waitUntil(t.registration.showNotification(u, f));
+  });
+}
+function p(n = {}) {
+  const t = l(), i = n.resolveUrl ?? ((e) => {
+    if (typeof e == "string") return e;
+    if (e && typeof e == "object" && "url" in e) {
+      const o = e.url;
+      return typeof o == "string" ? o : "/";
+    }
+    return "/";
+  });
+  t.addEventListener("notificationclick", (e) => {
+    e.notification.close();
+    const o = i(e.notification.data);
+    e.waitUntil(
+      (async () => {
+        const s = await t.clients.matchAll({
+          type: "window",
+          includeUncontrolled: !0
+        });
+        for (const a of s)
+          if (a.url.includes(o))
+            return a.focus();
+        return t.clients.openWindow(o);
+      })()
+    );
+  });
+}
+function w() {
+  const n = l();
+  n.addEventListener("message", (t) => {
+    t.data?.type === "SKIP_WAITING" && n.skipWaiting();
+  });
+}
+export {
+  p as installNotificationClickHandler,
+  y as installPushHandler,
+  w as installSkipWaitingListener,
+  d as registerServiceWorker,
+  g as skipWaiting,
+  v as unregisterAllServiceWorkers
+};
+//# sourceMappingURL=sw.js.map

package/dist/sw.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sw.js","sources":["../src/sw/register-service-worker.ts","../src/sw/create-push-handler.ts"],"sourcesContent":["export interface RegisterServiceWorkerOptions {\n    /** Public URL of the compiled service worker file (e.g. `/sw.js`). */\n    url: string;\n    /** SW scope (default: SW directory). */\n    scope?: string;\n    /** Called once the registration is active. */\n    onReady?: (registration: ServiceWorkerRegistration) => void;\n    /**\n     * Called when a new worker has finished installing while another worker\n     * still controls the page. The host app typically prompts the user to\n     * reload and then calls {@link skipWaiting} on the returned worker.\n     */\n    onUpdate?: (waiting: ServiceWorker, registration: ServiceWorkerRegistration) => void;\n    /** Called on registration failure. */\n    onError?: (error: unknown) => void;\n}\n\n/**\n * Register a service worker with consistent update-detection wiring.\n *\n * Skips silently when the runtime has no `serviceWorker` support. The host\n * app keeps full control over the SW file — this helper only handles the\n * boilerplate around `register()` and `updatefound`.\n *\n * @returns The registration when it succeeds, or `null` when unsupported.\n */\nexport async function registerServiceWorker(\n    options: RegisterServiceWorkerOptions,\n): Promise<ServiceWorkerRegistration | null> {\n    if (typeof navigator === \"undefined\" || !(\"serviceWorker\" in navigator)) {\n        return null;\n    }\n\n    try {\n        const registration = await navigator.serviceWorker.register(options.url, {\n            scope: options.scope,\n        });\n\n        if (registration.active) options.onReady?.(registration);\n\n        registration.addEventListener(\"updatefound\", () => {\n            const installing = registration.installing;\n            if (!installing) return;\n            installing.addEventListener(\"statechange\", () => {\n                if (installing.state === \"installed\" && navigator.serviceWorker.controller) {\n                    options.onUpdate?.(installing, registration);\n                }\n            });\n        });\n\n        return registration;\n    } catch (error) {\n        options.onError?.(error);\n        return null;\n    }\n}\n\n/**\n * Tell a waiting worker to activate immediately. Pair with `onUpdate` to roll\n * out updates after the user confirms a reload prompt.\n */\nexport function skipWaiting(worker: ServiceWorker): void {\n    worker.postMessage({ type: \"SKIP_WAITING\" });\n}\n\n/**\n * Unregister all registered service workers for this origin.\n *\n * @returns Number of workers that were unregistered.\n */\nexport async function unregisterAllServiceWorkers(): Promise<number> {\n    if (typeof navigator === \"undefined\" || !(\"serviceWorker\" in navigator)) return 0;\n    const registrations = await navigator.serviceWorker.getRegistrations();\n    let count = 0;\n    for (const registration of registrations) {\n        const result = await registration.unregister();\n        if (result) count += 1;\n    }\n    return count;\n}\n","/**\n * Service-worker context helpers for handling `push` and `notificationclick`\n * events. Import these inside your own `sw.ts` — they expect to run in the\n * service-worker global scope, not in the main thread.\n *\n * @example\n *   /// <reference lib=\"webworker\" />\n *   import { installPushHandler, installNotificationClickHandler } from \"tempest-react-sdk\";\n *\n *   installPushHandler({ defaultIcon: \"/icons/Logo.png\" });\n *   installNotificationClickHandler();\n */\n\ninterface SwGlobal {\n    registration: {\n        showNotification(title: string, options?: NotificationOptions): Promise<void>;\n    };\n    clients: {\n        matchAll(options: { type: \"window\"; includeUncontrolled?: boolean }): Promise<\n            {\n                url: string;\n                focused: boolean;\n                focus(): Promise<unknown>;\n                navigate(url: string): Promise<unknown>;\n            }[]\n        >;\n        openWindow(url: string): Promise<unknown>;\n    };\n    addEventListener(\n        type: \"push\",\n        listener: (event: {\n            data: { json(): unknown; text(): string } | null;\n            waitUntil(promise: Promise<unknown>): void;\n        }) => void,\n    ): void;\n    addEventListener(\n        type: \"notificationclick\",\n        listener: (event: {\n            notification: { close(): void; data?: unknown };\n            waitUntil(promise: Promise<unknown>): void;\n        }) => void,\n    ): void;\n    skipWaiting(): Promise<void>;\n}\n\nfunction getSwScope(): SwGlobal {\n    return globalThis as unknown as SwGlobal;\n}\n\nexport interface PushPayload {\n    title?: string;\n    body?: string;\n    icon?: string;\n    badge?: string;\n    image?: string;\n    tag?: string;\n    url?: string;\n    /** Arbitrary extra data forwarded to `event.notification.data`. */\n    data?: Record<string, unknown>;\n}\n\nexport interface InstallPushHandlerOptions {\n    /** Title used when the payload omits one. */\n    defaultTitle?: string;\n    /** Icon used when the payload omits one. */\n    defaultIcon?: string;\n    /** Badge image (mobile). */\n    defaultBadge?: string;\n    /**\n     * Transform the raw payload before showing the notification. Return `null`\n     * to suppress the notification entirely (e.g. silent pings).\n     */\n    transform?: (payload: PushPayload) => PushPayload | null;\n}\n\n/**\n * Install a `push` event listener that parses the payload as JSON (with a\n * plain-text fallback) and shows a notification.\n */\nexport function installPushHandler(options: InstallPushHandlerOptions = {}): void {\n    const sw = getSwScope();\n    const { defaultTitle = \"Notificação\", defaultIcon, defaultBadge, transform } = options;\n\n    sw.addEventListener(\"push\", (event) => {\n        if (!event.data) return;\n\n        let raw: PushPayload;\n        try {\n            raw = event.data.json() as PushPayload;\n        } catch {\n            raw = { title: defaultTitle, body: event.data.text() };\n        }\n\n        const payload = transform ? transform(raw) : raw;\n        if (!payload) return;\n\n        const title = payload.title ?? defaultTitle;\n        const notification: NotificationOptions & { image?: string } = {\n            body: payload.body,\n            icon: payload.icon ?? defaultIcon,\n            badge: payload.badge ?? defaultBadge,\n            image: payload.image,\n            tag: payload.tag,\n            data: { url: payload.url ?? \"/\", ...(payload.data ?? {}) },\n        };\n\n        event.waitUntil(sw.registration.showNotification(title, notification));\n    });\n}\n\nexport interface InstallNotificationClickHandlerOptions {\n    /** Resolve the destination URL from the notification data. Default: `data.url`. */\n    resolveUrl?: (data: unknown) => string;\n}\n\n/**\n * Install a `notificationclick` handler that focuses an existing client when\n * possible and falls back to opening a new window.\n */\nexport function installNotificationClickHandler(\n    options: InstallNotificationClickHandlerOptions = {},\n): void {\n    const sw = getSwScope();\n    const resolveUrl =\n        options.resolveUrl ??\n        ((data: unknown) => {\n            if (typeof data === \"string\") return data;\n            if (data && typeof data === \"object\" && \"url\" in data) {\n                const url = (data as Record<string, unknown>).url;\n                return typeof url === \"string\" ? url : \"/\";\n            }\n            return \"/\";\n        });\n\n    sw.addEventListener(\"notificationclick\", (event) => {\n        event.notification.close();\n        const target = resolveUrl(event.notification.data);\n\n        event.waitUntil(\n            (async () => {\n                const clients = await sw.clients.matchAll({\n                    type: \"window\",\n                    includeUncontrolled: true,\n                });\n                for (const client of clients) {\n                    if (client.url.includes(target)) {\n                        return client.focus();\n                    }\n                }\n                return sw.clients.openWindow(target);\n            })(),\n        );\n    });\n}\n\n/**\n * Install a `message` listener that activates a waiting worker when the host\n * app sends `{ type: \"SKIP_WAITING\" }`.\n */\nexport function installSkipWaitingListener(): void {\n    const sw = getSwScope() as SwGlobal & {\n        addEventListener(\n            type: \"message\",\n            listener: (event: { data?: { type?: string } }) => void,\n        ): void;\n    };\n    sw.addEventListener(\"message\", (event) => {\n        if (event.data?.type === \"SKIP_WAITING\") {\n            void sw.skipWaiting();\n        }\n    });\n}\n"],"names":["registerServiceWorker","options","registration","installing","error","skipWaiting","worker","unregisterAllServiceWorkers","registrations","count","getSwScope","installPushHandler","sw","defaultTitle","defaultIcon","defaultBadge","transform","event","raw","payload","title","notification","installNotificationClickHandler","resolveUrl","data","url","target","clients","client","installSkipWaitingListener"],"mappings":"AA0BA,eAAsBA,EAClBC,GACyC;AACzC,MAAI,OAAO,YAAc,OAAe,EAAE,mBAAmB;AACzD,WAAO;AAGX,MAAI;AACA,UAAMC,IAAe,MAAM,UAAU,cAAc,SAASD,EAAQ,KAAK;AAAA,MACrE,OAAOA,EAAQ;AAAA,IAAA,CAClB;AAED,WAAIC,EAAa,UAAQD,EAAQ,UAAUC,CAAY,GAEvDA,EAAa,iBAAiB,eAAe,MAAM;AAC/C,YAAMC,IAAaD,EAAa;AAChC,MAAKC,KACLA,EAAW,iBAAiB,eAAe,MAAM;AAC7C,QAAIA,EAAW,UAAU,eAAe,UAAU,cAAc,cAC5DF,EAAQ,WAAWE,GAAYD,CAAY;AAAA,MAEnD,CAAC;AAAA,IACL,CAAC,GAEMA;AAAA,EACX,SAASE,GAAO;AACZ,WAAAH,EAAQ,UAAUG,CAAK,GAChB;AAAA,EACX;AACJ;AAMO,SAASC,EAAYC,GAA6B;AACrD,EAAAA,EAAO,YAAY,EAAE,MAAM,eAAA,CAAgB;AAC/C;AAOA,eAAsBC,IAA+C;AACjE,MAAI,OAAO,YAAc,OAAe,EAAE,mBAAmB,WAAY,QAAO;AAChF,QAAMC,IAAgB,MAAM,UAAU,cAAc,iBAAA;AACpD,MAAIC,IAAQ;AACZ,aAAWP,KAAgBM;AAEvB,IADe,MAAMN,EAAa,WAAA,MACtBO,KAAS;AAEzB,SAAOA;AACX;AClCA,SAASC,IAAuB;AAC5B,SAAO;AACX;AAgCO,SAASC,EAAmBV,IAAqC,IAAU;AAC9E,QAAMW,IAAKF,EAAA,GACL,EAAE,cAAAG,IAAe,eAAe,aAAAC,GAAa,cAAAC,GAAc,WAAAC,MAAcf;AAE/E,EAAAW,EAAG,iBAAiB,QAAQ,CAACK,MAAU;AACnC,QAAI,CAACA,EAAM,KAAM;AAEjB,QAAIC;AACJ,QAAI;AACA,MAAAA,IAAMD,EAAM,KAAK,KAAA;AAAA,IACrB,QAAQ;AACJ,MAAAC,IAAM,EAAE,OAAOL,GAAc,MAAMI,EAAM,KAAK,OAAK;AAAA,IACvD;AAEA,UAAME,IAAUH,IAAYA,EAAUE,CAAG,IAAIA;AAC7C,QAAI,CAACC,EAAS;AAEd,UAAMC,IAAQD,EAAQ,SAASN,GACzBQ,IAAyD;AAAA,MAC3D,MAAMF,EAAQ;AAAA,MACd,MAAMA,EAAQ,QAAQL;AAAA,MACtB,OAAOK,EAAQ,SAASJ;AAAA,MACxB,OAAOI,EAAQ;AAAA,MACf,KAAKA,EAAQ;AAAA,MACb,MAAM,EAAE,KAAKA,EAAQ,OAAO,KAAK,GAAIA,EAAQ,QAAQ,CAAA,EAAC;AAAA,IAAG;AAG7D,IAAAF,EAAM,UAAUL,EAAG,aAAa,iBAAiBQ,GAAOC,CAAY,CAAC;AAAA,EACzE,CAAC;AACL;AAWO,SAASC,EACZrB,IAAkD,IAC9C;AACJ,QAAMW,IAAKF,EAAA,GACLa,IACFtB,EAAQ,eACP,CAACuB,MAAkB;AAChB,QAAI,OAAOA,KAAS,SAAU,QAAOA;AACrC,QAAIA,KAAQ,OAAOA,KAAS,YAAY,SAASA,GAAM;AACnD,YAAMC,IAAOD,EAAiC;AAC9C,aAAO,OAAOC,KAAQ,WAAWA,IAAM;AAAA,IAC3C;AACA,WAAO;AAAA,EACX;AAEJ,EAAAb,EAAG,iBAAiB,qBAAqB,CAACK,MAAU;AAChD,IAAAA,EAAM,aAAa,MAAA;AACnB,UAAMS,IAASH,EAAWN,EAAM,aAAa,IAAI;AAEjD,IAAAA,EAAM;AAAA,OACD,YAAY;AACT,cAAMU,IAAU,MAAMf,EAAG,QAAQ,SAAS;AAAA,UACtC,MAAM;AAAA,UACN,qBAAqB;AAAA,QAAA,CACxB;AACD,mBAAWgB,KAAUD;AACjB,cAAIC,EAAO,IAAI,SAASF,CAAM;AAC1B,mBAAOE,EAAO,MAAA;AAGtB,eAAOhB,EAAG,QAAQ,WAAWc,CAAM;AAAA,MACvC,GAAA;AAAA,IAAG;AAAA,EAEX,CAAC;AACL;AAMO,SAASG,IAAmC;AAC/C,QAAMjB,IAAKF,EAAA;AAMX,EAAAE,EAAG,iBAAiB,WAAW,CAACK,MAAU;AACtC,IAAIA,EAAM,MAAM,SAAS,kBAChBL,EAAG,YAAA;AAAA,EAEhB,CAAC;AACL;"}