@molecule/app-settings-panel-react 1.0.4 → 1.0.6

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.
Files changed (3) hide show
  1. package/LICENSE +111 -24
  2. package/README.md +107 -107
  3. package/package.json +10 -10
package/LICENSE CHANGED
@@ -1,3 +1,4 @@
1
+
1
2
  Apache License
2
3
  Version 2.0, January 2004
3
4
  http://www.apache.org/licenses/
@@ -34,21 +35,33 @@
34
35
 
35
36
  "Work" shall mean the work of authorship, whether in Source or
36
37
  Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work.
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
38
40
 
39
41
  "Derivative Works" shall mean any work, whether in Source or Object
40
42
  form, that is based on (or derived from) the Work and for which the
41
43
  editorial revisions, annotations, elaborations, or other modifications
42
- represent, as a whole, an original work of authorship.
43
-
44
- "Contribution" shall mean any work of authorship, including the
45
- original version of the Work and any modifications or additions
46
- to that Work, that is intentionally submitted to the Licensor for
47
- inclusion in the Work by the copyright owner or by an individual or
48
- Legal Entity authorized to submit on behalf of the copyright owner.
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
49
62
 
50
63
  "Contributor" shall mean Licensor and any individual or Legal Entity
51
- on behalf of whom a Contribution has been received by the Licensor and
64
+ on behalf of whom a Contribution has been received by Licensor and
52
65
  subsequently incorporated within the Work.
53
66
 
54
67
  2. Grant of Copyright License. Subject to the terms and conditions of
@@ -61,8 +74,18 @@
61
74
  3. Grant of Patent License. Subject to the terms and conditions of
62
75
  this License, each Contributor hereby grants to You a perpetual,
63
76
  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
64
- patent license to make, have made, use, offer to sell, sell, import,
65
- and otherwise transfer the Work.
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
66
89
 
67
90
  4. Redistribution. You may reproduce and distribute copies of the
68
91
  Work or Derivative Works thereof in any medium, with or without
@@ -84,23 +107,87 @@
84
107
  (d) If the Work includes a "NOTICE" text file as part of its
85
108
  distribution, then any Derivative Works that You distribute must
86
109
  include a readable copy of the attribution notices contained
87
- within such NOTICE file.
88
-
89
- 5. Submission of Contributions.
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
90
138
 
91
139
  6. Trademarks. This License does not grant permission to use the trade
92
- names, trademarks, service marks, or product names of the Licensor.
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
93
143
 
94
144
  7. Disclaimer of Warranty. Unless required by applicable law or
95
- agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
96
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
97
-
98
- 8. Limitation of Liability. In no event and under no legal theory shall
99
- any Contributor be liable to You for damages.
100
-
101
- 9. Accepting Warranty or Additional Liability.
102
-
103
- Copyright 2026 Molecule Dev, Inc.
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
104
191
 
105
192
  Licensed under the Apache License, Version 2.0 (the "License");
106
193
  you may not use this file except in compliance with the License.
package/README.md CHANGED
@@ -3,15 +3,11 @@ 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-08-04T01:52:38.141Z
6
+ Generated: 2026-10-16T23:37:50.540Z
7
7
  -->
8
8
 
9
9
  # @molecule/app-settings-panel-react
10
10
 
11
- > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
12
- > It is written to be read by coding agents as much as by people, and is generated from this
13
- > package's source — edit `src/index.ts` JSDoc, not this file.
14
-
15
11
  `@molecule/app-settings-panel-react` — composable, batteries-included
16
12
  settings panel.
17
13
 
@@ -36,6 +32,10 @@ through hooks:
36
32
  Apps compose via JSX children — pick sections, order them, and interleave
37
33
  custom sections.
38
34
 
35
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
36
+ > It is written to be read by coding agents as much as by people, and is generated from this
37
+ > package's source — edit `src/index.ts` JSDoc, not this file.
38
+
39
39
  ## Quick Start
40
40
 
41
41
  ```tsx
@@ -97,15 +97,17 @@ interface Device {
97
97
  }
98
98
  ```
99
99
 
100
- #### `PushToggleDevice`
100
+ #### `SettingsPanelContextValue`
101
101
 
102
- Device row slice returned by `GET /api/devices`.
102
+ Context published by `<SettingsContainer>` to its children.
103
+
104
+ The container owns the dismiss-the-panel handler; sub-components
105
+ that need to close after an action (logout, delete account, email
106
+ error) read it from context rather than threading the prop down.
103
107
 
104
108
  ```typescript
105
- interface PushToggleDevice {
106
- id: string
107
- isCurrent?: boolean
108
- hasPushSubscription?: boolean
109
+ interface SettingsPanelContextValue {
110
+ onClose: () => void
109
111
  }
110
112
  ```
111
113
 
@@ -120,28 +122,26 @@ interface PushToggleHttp {
120
122
  }
121
123
  ```
122
124
 
123
- #### `PushToggleToken`
125
+ #### `PushToggleDevice`
124
126
 
125
- Push token slice returned by `@molecule/app-push` `register()`.
127
+ Device row slice returned by `GET /api/devices`.
126
128
 
127
129
  ```typescript
128
- interface PushToggleToken {
129
- value: string
130
- platform: 'web' | 'ios' | 'android'
130
+ interface PushToggleDevice {
131
+ id: string
132
+ isCurrent?: boolean
133
+ hasPushSubscription?: boolean
131
134
  }
132
135
  ```
133
136
 
134
- #### `SettingsPanelContextValue`
135
-
136
- Context published by `<SettingsContainer>` to its children.
137
+ #### `PushToggleToken`
137
138
 
138
- The container owns the dismiss-the-panel handler; sub-components
139
- that need to close after an action (logout, delete account, email
140
- error) read it from context rather than threading the prop down.
139
+ Push token slice returned by `@molecule/app-push` `register()`.
141
140
 
142
141
  ```typescript
143
- interface SettingsPanelContextValue {
144
- onClose: () => void
142
+ interface PushToggleToken {
143
+ value: string
144
+ platform: 'web' | 'ios' | 'android'
145
145
  }
146
146
  ```
147
147
 
@@ -267,62 +267,6 @@ function DevicesSection({
267
267
  }): JSX.Element
268
268
  ```
269
269
 
270
- #### `disablePushOnCurrentDevice(deps)`
271
-
272
- Disables push: unsubscribes the browser (best-effort — a dev build without
273
- a service worker has nothing to unsubscribe) and ALWAYS clears the server
274
- state so no further pushes target this device.
275
-
276
- ```typescript
277
- function disablePushOnCurrentDevice(deps: {
278
- http: PushToggleHttp
279
- unregister: () => Promise<void>
280
- }): Promise<PushToggleResult>
281
- ```
282
-
283
- - `deps` — The http client + push action from `usePush()`.
284
- - `deps.http` — Authenticated http client (`useHttpClient()`).
285
- - `deps.unregister` — `usePush().unregister`.
286
-
287
- **Returns:** `{ ok: true }` or a typed failure (server state not cleared).
288
-
289
- #### `enablePushOnCurrentDevice(deps)`
290
-
291
- Runs the full enable chain: browser permission → runtime VAPID public key
292
- (`GET /api/devices/push/public-key`) → `register({ vapidPublicKey })` →
293
- persist the subscription on the current device row.
294
-
295
- Every failure is returned as a typed reason (never thrown) so the UI can
296
- show an honest, specific message instead of hanging or silently reverting.
297
-
298
- ```typescript
299
- function enablePushOnCurrentDevice(deps: {
300
- http: PushToggleHttp
301
- requestPermission: () => Promise<string>
302
- register: (options?: { vapidPublicKey?: string }) => Promise<PushToggleToken>
303
- }): Promise<PushToggleResult>
304
- ```
305
-
306
- - `deps` — The http client + push actions from `usePush()`.
307
- - `deps.http` — Authenticated http client (`useHttpClient()`).
308
- - `deps.requestPermission` — `usePush().requestPermission`.
309
- - `deps.register` — `usePush().register`.
310
-
311
- **Returns:** `{ ok: true }` or a typed failure.
312
-
313
- #### `findCurrentDevice(devices)`
314
-
315
- Picks the caller's own device row: the api flags the session device
316
- `isCurrent`; fall back to the first row for sessions predating the flag.
317
-
318
- ```typescript
319
- function findCurrentDevice(devices: PushToggleDevice[] | undefined): PushToggleDevice | undefined
320
- ```
321
-
322
- - `devices` — Rows from `GET /api/devices`.
323
-
324
- **Returns:** The current device row, or `undefined` when the user has none.
325
-
326
270
  #### `LogOutDeleteSection()`
327
271
 
328
272
  Bottom actions section — Log out + Delete account.
@@ -354,19 +298,6 @@ hanging the switch.
354
298
  function NotificationsSection(): JSX.Element
355
299
  ```
356
300
 
357
- #### `readCurrentDevicePushEnabled(http)`
358
-
359
- Reads whether push is currently enabled for THIS device (server truth:
360
- the current device row's `hasPushSubscription`).
361
-
362
- ```typescript
363
- function readCurrentDevicePushEnabled(http: PushToggleHttp): Promise<boolean>
364
- ```
365
-
366
- - `http` — Authenticated http client (`useHttpClient()`).
367
-
368
- **Returns:** `true` when the current device has a stored subscription.
369
-
370
301
  #### `SettingsContainer(props)`
371
302
 
372
303
  Outer settings-panel layout: padded vertical stack that hosts the
@@ -384,20 +315,6 @@ function SettingsContainer({
384
315
  }): ReactElement<unknown, string | JSXElementConstructor<any>>
385
316
  ```
386
317
 
387
- #### `subscriptionFromToken(token)`
388
-
389
- Converts an `@molecule/app-push` token into the device resource's
390
- `pushSubscription` shape (web PushSubscription JSON, FCM registration for
391
- Android, APNs registration for iOS).
392
-
393
- ```typescript
394
- function subscriptionFromToken(token: PushToggleToken): unknown
395
- ```
396
-
397
- - `token` — The push token returned by `register()`.
398
-
399
- **Returns:** The `pushSubscription` value to PATCH onto the device row.
400
-
401
318
  #### `ThisDeviceSection()`
402
319
 
403
320
  "This device" detail strip — OS, browser, online/offline.
@@ -435,6 +352,89 @@ Throws if used outside the container so component misuse is loud.
435
352
  function useSettingsPanelContext(): SettingsPanelContextValue
436
353
  ```
437
354
 
355
+ #### `findCurrentDevice(devices)`
356
+
357
+ Picks the caller's own device row: the api flags the session device
358
+ `isCurrent`; fall back to the first row for sessions predating the flag.
359
+
360
+ ```typescript
361
+ function findCurrentDevice(devices: PushToggleDevice[] | undefined): PushToggleDevice | undefined
362
+ ```
363
+
364
+ - `devices` — Rows from `GET /api/devices`.
365
+
366
+ **Returns:** The current device row, or `undefined` when the user has none.
367
+
368
+ #### `subscriptionFromToken(token)`
369
+
370
+ Converts an `@molecule/app-push` token into the device resource's
371
+ `pushSubscription` shape (web PushSubscription JSON, FCM registration for
372
+ Android, APNs registration for iOS).
373
+
374
+ ```typescript
375
+ function subscriptionFromToken(token: PushToggleToken): unknown
376
+ ```
377
+
378
+ - `token` — The push token returned by `register()`.
379
+
380
+ **Returns:** The `pushSubscription` value to PATCH onto the device row.
381
+
382
+ #### `enablePushOnCurrentDevice(deps)`
383
+
384
+ Runs the full enable chain: browser permission → runtime VAPID public key
385
+ (`GET /api/devices/push/public-key`) → `register({ vapidPublicKey })` →
386
+ persist the subscription on the current device row.
387
+
388
+ Every failure is returned as a typed reason (never thrown) so the UI can
389
+ show an honest, specific message instead of hanging or silently reverting.
390
+
391
+ ```typescript
392
+ function enablePushOnCurrentDevice(deps: {
393
+ http: PushToggleHttp
394
+ requestPermission: () => Promise<string>
395
+ register: (options?: { vapidPublicKey?: string }) => Promise<PushToggleToken>
396
+ }): Promise<PushToggleResult>
397
+ ```
398
+
399
+ - `deps` — The http client + push actions from `usePush()`.
400
+ - `deps.http` — Authenticated http client (`useHttpClient()`).
401
+ - `deps.requestPermission` — `usePush().requestPermission`.
402
+ - `deps.register` — `usePush().register`.
403
+
404
+ **Returns:** `{ ok: true }` or a typed failure.
405
+
406
+ #### `disablePushOnCurrentDevice(deps)`
407
+
408
+ Disables push: unsubscribes the browser (best-effort — a dev build without
409
+ a service worker has nothing to unsubscribe) and ALWAYS clears the server
410
+ state so no further pushes target this device.
411
+
412
+ ```typescript
413
+ function disablePushOnCurrentDevice(deps: {
414
+ http: PushToggleHttp
415
+ unregister: () => Promise<void>
416
+ }): Promise<PushToggleResult>
417
+ ```
418
+
419
+ - `deps` — The http client + push action from `usePush()`.
420
+ - `deps.http` — Authenticated http client (`useHttpClient()`).
421
+ - `deps.unregister` — `usePush().unregister`.
422
+
423
+ **Returns:** `{ ok: true }` or a typed failure (server state not cleared).
424
+
425
+ #### `readCurrentDevicePushEnabled(http)`
426
+
427
+ Reads whether push is currently enabled for THIS device (server truth:
428
+ the current device row's `hasPushSubscription`).
429
+
430
+ ```typescript
431
+ function readCurrentDevicePushEnabled(http: PushToggleHttp): Promise<boolean>
432
+ ```
433
+
434
+ - `http` — Authenticated http client (`useHttpClient()`).
435
+
436
+ **Returns:** `true` when the current device has a stored subscription.
437
+
438
438
  ### Constants
439
439
 
440
440
  #### `SettingsPanelContext`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@molecule/app-settings-panel-react",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "Composable settings panel — a SettingsContainer + family of section sub-components (Account, Auth, Notifications, Billing, Devices, ThisDevice, LogOutDelete). Apps compose via JSX children, picking which sections to include and what order.",
5
5
  "homepage": "https://www.molecule.dev/packages/app-settings-panel-react",
6
6
  "type": "module",
@@ -34,16 +34,16 @@
34
34
  "directory": "packages/app/features/settings-panel-react"
35
35
  },
36
36
  "devDependencies": {
37
- "@types/node": "26.1.2",
37
+ "@types/node": "26.6.5",
38
38
  "typescript": "6.0.3",
39
- "vitest": "4.1.11",
40
- "@molecule/app-auth": "1.1.1",
41
- "@molecule/app-react": "1.6.0",
42
- "@molecule/app-ui": "1.2.0",
43
- "@molecule/app-ui-react": "1.2.0",
44
- "@types/react": "19.2.17",
45
- "react": "19.2.8",
46
- "react-router": "8.3.0"
39
+ "vitest": "4.1.12",
40
+ "@molecule/app-auth": "1.8.2",
41
+ "@molecule/app-react": "1.10.1",
42
+ "@molecule/app-ui": "1.3.8",
43
+ "@molecule/app-ui-react": "1.3.6",
44
+ "@types/react": "19.3.0",
45
+ "react": "19.3.1",
46
+ "react-router": "8.5.0"
47
47
  },
48
48
  "peerDependencies": {
49
49
  "@molecule/app-auth": "^1.0.1",