@molecule/api-push-notifications-web-push 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
3
3
  Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
4
4
  Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
5
5
  To change this document, edit the module-level JSDoc in src/index.ts.
6
- Generated: 2026-10-16T23:31:02.507Z
6
+ Generated: 2026-11-15T15:36:36.904Z
7
7
  -->
8
8
 
9
9
  # @molecule/api-push-notifications-web-push
@@ -100,7 +100,7 @@ export function setupPushNotificationsWebPush(): void {
100
100
  Peer dependencies:
101
101
 
102
102
  - `@molecule/api-bond` ^1.0.1
103
- - `@molecule/api-push-notifications` ^1.0.1
103
+ - `@molecule/api-push-notifications` ^1.1.0
104
104
  - `@molecule/api-secrets` ^1.0.1
105
105
 
106
106
  ### Environment Variables
@@ -1 +1 @@
1
- {"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,cAAc,CAAA;AAIrB,OAAO,KAAK,EAEV,wBAAwB,EAKzB,MAAM,kCAAkC,CAAA;AAoHzC;;;GAGG;AACH,wBAAgB,cAAc,IAAI,wBAAwB,CAEzD;AAID;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,EAAE,wBASrB,CAAA"}
1
+ {"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,OAAO,cAAc,CAAA;AAIrB,OAAO,KAAK,EAEV,wBAAwB,EAMzB,MAAM,kCAAkC,CAAA;AAsJzC;;;GAGG;AACH,wBAAgB,cAAc,IAAI,wBAAwB,CAEzD;AAID;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,EAAE,wBASrB,CAAA"}
package/dist/provider.js CHANGED
@@ -19,6 +19,25 @@ import { getLogger } from '@molecule/api-bond';
19
19
  * for VAPID-authenticated push notification delivery over the Web Push protocol.
20
20
  */
21
21
  const logger = getLogger();
22
+ /**
23
+ * The web-push request options for `options`. Each unset field is left out, so web-push
24
+ * applies its own default for it (TTL four weeks, urgency normal, no topic).
25
+ *
26
+ * @param options - The delivery settings the caller asked for.
27
+ * @returns web-push's options, or undefined when nothing was asked for.
28
+ */
29
+ function webPushOptions(options) {
30
+ if (!options)
31
+ return undefined;
32
+ const requestOptions = {};
33
+ if (options.ttl !== undefined)
34
+ requestOptions.TTL = options.ttl;
35
+ if (options.urgency !== undefined)
36
+ requestOptions.urgency = options.urgency;
37
+ if (options.topic !== undefined)
38
+ requestOptions.topic = options.topic;
39
+ return requestOptions;
40
+ }
22
41
  /**
23
42
  * Web Push implementation of `PushNotificationProvider` using the `web-push` library.
24
43
  */
@@ -62,16 +81,22 @@ class WebPushProvider {
62
81
  * Auto-configures VAPID on first call if not already configured.
63
82
  * @param subscription - The browser push subscription (endpoint + keys).
64
83
  * @param payload - The notification payload (title, body, icon, etc.) serialized as JSON.
84
+ * @param options - Optional delivery settings, sent as the TTL, Urgency and Topic headers;
85
+ * web-push refuses an invalid one (a negative TTL, an unknown urgency, a topic that is not
86
+ * URL-safe base64 of up to 32 characters) before any request leaves.
65
87
  * @returns The HTTP status code, headers, and body from the push service response.
66
88
  */
67
- async send(subscription, payload) {
89
+ async send(subscription, payload, options) {
68
90
  if (!this.configured)
69
91
  this.configure();
70
92
  if (!this.configured) {
71
93
  throw new Error('Push notifications not configured. Set VAPID_EMAIL, VAPID_PUBLIC_KEY, and VAPID_PRIVATE_KEY.');
72
94
  }
73
95
  try {
74
- const result = await webPush.sendNotification(subscription, JSON.stringify(payload));
96
+ const requestOptions = webPushOptions(options);
97
+ const result = requestOptions
98
+ ? await webPush.sendNotification(subscription, JSON.stringify(payload), requestOptions)
99
+ : await webPush.sendNotification(subscription, JSON.stringify(payload));
75
100
  return { statusCode: result.statusCode, headers: result.headers, body: result.body };
76
101
  }
77
102
  catch (error) {
@@ -83,10 +108,11 @@ class WebPushProvider {
83
108
  * Sends a push notification to multiple subscriptions in parallel using `Promise.allSettled`.
84
109
  * @param subscriptions - An array of browser push subscriptions.
85
110
  * @param payload - The notification payload to send to all subscriptions.
111
+ * @param options - Optional delivery settings applied to every message.
86
112
  * @returns An array of results, each containing the subscription, send result (if successful), and error (if failed).
87
113
  */
88
- async sendMany(subscriptions, payload) {
89
- const results = await Promise.allSettled(subscriptions.map((sub) => this.send(sub, payload)));
114
+ async sendMany(subscriptions, payload, options) {
115
+ const results = await Promise.allSettled(subscriptions.map((sub) => this.send(sub, payload, options)));
90
116
  return results.map((result, i) => ({
91
117
  subscription: subscriptions[i],
92
118
  result: result.status === 'fulfilled' ? result.value : undefined,
@@ -1 +1 @@
1
- {"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,sEAAsE;AACtE,2EAA2E;AAC3E,oCAAoC;AACpC,OAAO,cAAc,CAAA;AACrB,OAAO,OAAO,MAAM,UAAU,CAAA;AAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAU9C;;;GAGG;AACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;AAE1B;;GAEG;AACH,MAAM,eAAe;IACX,UAAU,GAAG,KAAK,CAAA;IAClB,SAAS,CAAoB;IAErC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAoB;QAC5B,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAA;QACtD,MAAM,SAAS,GAAG,MAAM,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;QACnE,MAAM,UAAU,GAAG,MAAM,EAAE,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QAEtE,IAAI,KAAK,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;YACrC,MAAM,OAAO,GACX,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAA;YACvF,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;YACvD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;YACtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG;gBACd,CAAC,KAAK,IAAI,aAAa;gBACvB,CAAC,SAAS,IAAI,kBAAkB;gBAChC,CAAC,UAAU,IAAI,mBAAmB;aACnC;iBACE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,IAAI,CAAC,CAAA;YACb,MAAM,CAAC,IAAI,CAAC,wCAAwC,OAAO,EAAE,CAAC,CAAA;QAChE,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,YAA8B,EAAE,OAA4B;QACrE,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,SAAS,EAAE,CAAA;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,8FAA8F,CAC/F,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAC3C,YAAwC,EACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CACxB,CAAA;YACD,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;QACtF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAA;YAC1C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAiC,EACjC,OAA4B;QAE5B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAE7F,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;YAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YAChE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SAChE,CAAC,CAAC,CAAA;IACL,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,OAAO,OAAO,CAAC,iBAAiB,EAAE,CAAA;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;IACvD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,IAAI,eAAe,EAAE,CAAA;AAC9B,CAAC;AAED,IAAI,SAA+C,CAAA;AAEnD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,QAAQ,GAA6B,IAAI,KAAK,CAAC,EAA8B,EAAE;IAC1F,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ;QACnB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC/C,CAAC;IACD,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK;QAChB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;CACF,CAAC,CAAA"}
1
+ {"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,sEAAsE;AACtE,2EAA2E;AAC3E,oCAAoC;AACpC,OAAO,cAAc,CAAA;AACrB,OAAO,OAAO,MAAM,UAAU,CAAA;AAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAW9C;;;GAGG;AACH,MAAM,MAAM,GAAG,SAAS,EAAE,CAAA;AAE1B;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,OAAqB;IAC3C,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAA;IAC9B,MAAM,cAAc,GAA2B,EAAE,CAAA;IACjD,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS;QAAE,cAAc,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAA;IAC/D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;IAC3E,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,cAAc,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;IACrE,OAAO,cAAc,CAAA;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,eAAe;IACX,UAAU,GAAG,KAAK,CAAA;IAClB,SAAS,CAAoB;IAErC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAoB;QAC5B,MAAM,KAAK,GAAG,MAAM,EAAE,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAA;QACtD,MAAM,SAAS,GAAG,MAAM,EAAE,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;QACnE,MAAM,UAAU,GAAG,MAAM,EAAE,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAA;QAEtE,IAAI,KAAK,IAAI,SAAS,IAAI,UAAU,EAAE,CAAC;YACrC,MAAM,OAAO,GACX,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,KAAK,EAAE,CAAA;YACvF,OAAO,CAAC,eAAe,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;YACvD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;YACtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG;gBACd,CAAC,KAAK,IAAI,aAAa;gBACvB,CAAC,SAAS,IAAI,kBAAkB;gBAChC,CAAC,UAAU,IAAI,mBAAmB;aACnC;iBACE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,IAAI,CAAC,CAAA;YACb,MAAM,CAAC,IAAI,CAAC,wCAAwC,OAAO,EAAE,CAAC,CAAA;QAChE,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CACR,YAA8B,EAC9B,OAA4B,EAC5B,OAAqB;QAErB,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,IAAI,CAAC,SAAS,EAAE,CAAA;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,8FAA8F,CAC/F,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,MAAM,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;YAC9C,MAAM,MAAM,GAAG,cAAc;gBAC3B,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,CAC5B,YAAwC,EACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EACvB,cAAc,CACf;gBACH,CAAC,CAAC,MAAM,OAAO,CAAC,gBAAgB,CAC5B,YAAwC,EACxC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CACxB,CAAA;YACL,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;QACtF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAA;YAC1C,MAAM,KAAK,CAAA;QACb,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CACZ,aAAiC,EACjC,OAA4B,EAC5B,OAAqB;QAErB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CACtC,aAAa,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAC7D,CAAA;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;YAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YAChE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SAChE,CAAC,CAAC,CAAA;IACL,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,OAAO,OAAO,CAAC,iBAAiB,EAAE,CAAA;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAA;IACvD,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,IAAI,eAAe,EAAE,CAAA;AAC9B,CAAC;AAED,IAAI,SAA+C,CAAA;AAEnD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,QAAQ,GAA6B,IAAI,KAAK,CAAC,EAA8B,EAAE;IAC1F,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ;QACnB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC/C,CAAC;IACD,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK;QAChB,IAAI,CAAC,SAAS;YAAE,SAAS,GAAG,cAAc,EAAE,CAAA;QAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IAC5C,CAAC;CACF,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@molecule/api-push-notifications-web-push",
3
- "version": "1.0.3",
4
- "description": "Web Push provider for molecule.dev push notifications",
3
+ "version": "1.1.0",
4
+ "description": "Push notification provider using web-push library with VAPID authentication",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
7
7
  "types": "dist/index.d.ts",
@@ -31,12 +31,12 @@
31
31
  },
32
32
  "peerDependencies": {
33
33
  "@molecule/api-bond": "^1.0.1",
34
- "@molecule/api-push-notifications": "^1.0.1",
34
+ "@molecule/api-push-notifications": "^1.1.0",
35
35
  "@molecule/api-secrets": "^1.0.1"
36
36
  },
37
37
  "devDependencies": {
38
- "@molecule/api-bond": "1.0.3",
39
- "@molecule/api-push-notifications": "1.0.3",
38
+ "@molecule/api-bond": "1.0.4",
39
+ "@molecule/api-push-notifications": "1.2.0",
40
40
  "@types/node": "26.6.5",
41
41
  "@types/web-push": "3.6.4",
42
42
  "typescript": "6.0.3",