@molecule/app-billing-react 1.0.4 → 1.0.5

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 +132 -132
  3. package/package.json +9 -9
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:50:09.341Z
6
+ Generated: 2026-10-16T23:33:14.880Z
7
7
  -->
8
8
 
9
9
  # @molecule/app-billing-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
  React pricing page + checkout flow for the molecule.dev billing kit.
16
12
 
17
13
  Components:
@@ -42,6 +38,10 @@ mlcl flagship template that includes `@molecule/api-entitlements`
42
38
  already exposes the `/api/billing/*` routes), then drop `<PricingPage />`
43
39
  onto a `/pricing` route.
44
40
 
41
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
42
+ > It is written to be read by coding agents as much as by people, and is generated from this
43
+ > package's source — edit `src/index.ts` JSDoc, not this file.
44
+
45
45
  ## Quick Start
46
46
 
47
47
  ```tsx
@@ -76,47 +76,6 @@ npm install -D @types/react
76
76
 
77
77
  ### Interfaces
78
78
 
79
- #### `BillingActionState`
80
-
81
- Async-state shape returned by `useStartCheckout` / `useCancelSubscription`.
82
-
83
- ```typescript
84
- interface BillingActionState<T> {
85
- /** The most recent response from the action, or `null` before the first call. */
86
- data: T | null
87
-
88
- /** True while a request is in flight. */
89
- loading: boolean
90
-
91
- /** Last error thrown by the action, or `null` on success. */
92
- error: Error | null
93
- }
94
- ```
95
-
96
- #### `BillingStatus`
97
-
98
- Snapshot of the signed-in user's current billing state. Returned by
99
- `GET /api/billing/status` once the user is authenticated.
100
-
101
- ```typescript
102
- interface BillingStatus<TLimits = unknown> {
103
- /** The user's `users.planKey` (`'free'`, `'stripeMonthly'`, etc.). */
104
- planKey: string
105
-
106
- /** Tier category — `'free'`, `'pro'`, `'team'`, or any app-defined extension. */
107
- category: string
108
-
109
- /** Display name (matches `PricingTierEntry.name` for the active tier). */
110
- name: string
111
-
112
- /** Tier-specific limits the user is currently entitled to. */
113
- limits: TLimits
114
-
115
- /** True when the user is on the registry default (free) tier. */
116
- isFree: boolean
117
- }
118
- ```
119
-
120
79
  #### `BillingStatusBadgeProps`
121
80
 
122
81
  Props for `<BillingStatusBadge />`.
@@ -140,40 +99,6 @@ interface BillingStatusBadgeProps {
140
99
  }
141
100
  ```
142
101
 
143
- #### `CancelResponse`
144
-
145
- Response from `POST /api/billing/cancel`.
146
-
147
- ```typescript
148
- interface CancelResponse {
149
- /** True when the cancellation request was accepted. */
150
- canceled?: boolean
151
-
152
- /** Localized error message when cancellation failed. */
153
- error?: string
154
- }
155
- ```
156
-
157
- #### `CheckoutResponse`
158
-
159
- Response from `POST /api/billing/checkout`. Either `checkoutUrl` or `updated` is set.
160
-
161
- ```typescript
162
- interface CheckoutResponse {
163
- /** Stripe Checkout URL — set when the user has no active subscription yet. */
164
- checkoutUrl?: string
165
-
166
- /** True when the user already had a subscription that was updated in place. */
167
- updated?: boolean
168
-
169
- /** Updated subscription metadata (only when `updated === true`). */
170
- subscription?: {
171
- expiresAt?: string
172
- autoRenews?: boolean
173
- }
174
- }
175
- ```
176
-
177
102
  #### `LimitsItemProps`
178
103
 
179
104
  Props for `<LimitsItem>`.
@@ -262,27 +187,20 @@ interface PricingPageProps<TLimits = unknown> {
262
187
  }
263
188
  ```
264
189
 
265
- #### `PricingTierEntry`
190
+ #### `BillingActionState`
266
191
 
267
- One row of the public pricing table. Apps can declare any number of
268
- `period` variants per tier (typically a `month` and `year` pair).
192
+ Async-state shape returned by `useStartCheckout` / `useCancelSubscription`.
269
193
 
270
194
  ```typescript
271
- interface PricingTierEntry<TLimits = unknown> {
272
- /** Stable slug used as a row key (`'free'`, `'pro'`, `'team'`). */
273
- key: string
274
-
275
- /** Display name shown in the page heading and CTA. */
276
- name: string
277
-
278
- /** Price variants for the tier. Order is presentation order. */
279
- prices: PricingTierPrice[]
195
+ interface BillingActionState<T> {
196
+ /** The most recent response from the action, or `null` before the first call. */
197
+ data: T | null
280
198
 
281
- /** Tier-specific limits — render any/all of these on the comparison row. */
282
- limits: TLimits
199
+ /** True while a request is in flight. */
200
+ loading: boolean
283
201
 
284
- /** Whether the tier is billed per seat (rendered as a footnote). */
285
- perSeat?: boolean
202
+ /** Last error thrown by the action, or `null` on success. */
203
+ error: Error | null
286
204
  }
287
205
  ```
288
206
 
@@ -311,6 +229,30 @@ interface PricingTierPrice {
311
229
  }
312
230
  ```
313
231
 
232
+ #### `PricingTierEntry`
233
+
234
+ One row of the public pricing table. Apps can declare any number of
235
+ `period` variants per tier (typically a `month` and `year` pair).
236
+
237
+ ```typescript
238
+ interface PricingTierEntry<TLimits = unknown> {
239
+ /** Stable slug used as a row key (`'free'`, `'pro'`, `'team'`). */
240
+ key: string
241
+
242
+ /** Display name shown in the page heading and CTA. */
243
+ name: string
244
+
245
+ /** Price variants for the tier. Order is presentation order. */
246
+ prices: PricingTierPrice[]
247
+
248
+ /** Tier-specific limits — render any/all of these on the comparison row. */
249
+ limits: TLimits
250
+
251
+ /** Whether the tier is billed per seat (rendered as a footnote). */
252
+ perSeat?: boolean
253
+ }
254
+ ```
255
+
314
256
  #### `PricingTiersResponse`
315
257
 
316
258
  Response envelope for `GET /api/billing/tiers`.
@@ -322,6 +264,64 @@ interface PricingTiersResponse<TLimits = unknown> {
322
264
  }
323
265
  ```
324
266
 
267
+ #### `BillingStatus`
268
+
269
+ Snapshot of the signed-in user's current billing state. Returned by
270
+ `GET /api/billing/status` once the user is authenticated.
271
+
272
+ ```typescript
273
+ interface BillingStatus<TLimits = unknown> {
274
+ /** The user's `users.planKey` (`'free'`, `'stripeMonthly'`, etc.). */
275
+ planKey: string
276
+
277
+ /** Tier category — `'free'`, `'pro'`, `'team'`, or any app-defined extension. */
278
+ category: string
279
+
280
+ /** Display name (matches `PricingTierEntry.name` for the active tier). */
281
+ name: string
282
+
283
+ /** Tier-specific limits the user is currently entitled to. */
284
+ limits: TLimits
285
+
286
+ /** True when the user is on the registry default (free) tier. */
287
+ isFree: boolean
288
+ }
289
+ ```
290
+
291
+ #### `CheckoutResponse`
292
+
293
+ Response from `POST /api/billing/checkout`. Either `checkoutUrl` or `updated` is set.
294
+
295
+ ```typescript
296
+ interface CheckoutResponse {
297
+ /** Stripe Checkout URL — set when the user has no active subscription yet. */
298
+ checkoutUrl?: string
299
+
300
+ /** True when the user already had a subscription that was updated in place. */
301
+ updated?: boolean
302
+
303
+ /** Updated subscription metadata (only when `updated === true`). */
304
+ subscription?: {
305
+ expiresAt?: string
306
+ autoRenews?: boolean
307
+ }
308
+ }
309
+ ```
310
+
311
+ #### `CancelResponse`
312
+
313
+ Response from `POST /api/billing/cancel`.
314
+
315
+ ```typescript
316
+ interface CancelResponse {
317
+ /** True when the cancellation request was accepted. */
318
+ canceled?: boolean
319
+
320
+ /** Localized error message when cancellation failed. */
321
+ error?: string
322
+ }
323
+ ```
324
+
325
325
  ### Functions
326
326
 
327
327
  #### `BillingStatusBadge(props)`
@@ -339,18 +339,6 @@ function BillingStatusBadge(
339
339
 
340
340
  **Returns:** The rendered status badge.
341
341
 
342
- #### `LimitsItem(props)`
343
-
344
- Single row in a tier's feature list — a check (or em-dash) icon
345
- followed by the row label. Use inside `<LimitsList>`.
346
-
347
- ```typescript
348
- function LimitsItem({
349
- children,
350
- included = true,
351
- }: LimitsItemProps): ReactElement<unknown, string | JSXElementConstructor<any>>
352
- ```
353
-
354
342
  #### `LimitsList(props)`
355
343
 
356
344
  Container for a tier's feature list. Apps use this in their
@@ -366,6 +354,18 @@ function LimitsList({
366
354
  }): ReactElement<unknown, string | JSXElementConstructor<any>>
367
355
  ```
368
356
 
357
+ #### `LimitsItem(props)`
358
+
359
+ Single row in a tier's feature list — a check (or em-dash) icon
360
+ followed by the row label. Use inside `<LimitsList>`.
361
+
362
+ ```typescript
363
+ function LimitsItem({
364
+ children,
365
+ included = true,
366
+ }: LimitsItemProps): ReactElement<unknown, string | JSXElementConstructor<any>>
367
+ ```
368
+
369
369
  #### `PricingPage(props)`
370
370
 
371
371
  Renders the public pricing page. Fetches `/api/billing/tiers` on mount
@@ -390,41 +390,28 @@ function PricingPage(
390
390
 
391
391
  **Returns:** The rendered pricing page.
392
392
 
393
- #### `useBillingStatus()`
394
-
395
- Fetch the signed-in user's current subscription state once on mount.
396
- Returns 401 from the API when the user is not authenticated; consumers
397
- should treat the absence of `data` as "anonymous → free tier".
398
-
399
- ```typescript
400
- function useBillingStatus(): UseHttpResult<BillingStatus<TLimits>>
401
- ```
402
-
403
- **Returns:** Async-state for the user's billing status.
404
-
405
- #### `useCancelSubscription()`
393
+ #### `usePricingTiers()`
406
394
 
407
- Cancel the user's active subscription at the end of the current
408
- billing period. Returns the response from the bonded payment provider.
395
+ Fetch the public pricing data once on mount. Useful inside a
396
+ pricing/upgrade page where the tiers are needed before render.
409
397
 
410
398
  ```typescript
411
- function useCancelSubscription(): BillingActionState<CancelResponse> & {
412
- cancel: () => Promise<CancelResponse | null>
413
- }
399
+ function usePricingTiers(): UseHttpResult<PricingTiersResponse<TLimits>>
414
400
  ```
415
401
 
416
- **Returns:** Async-state plus a `cancel` function.
402
+ **Returns:** Async-state for the pricing tiers response.
417
403
 
418
- #### `usePricingTiers()`
404
+ #### `useBillingStatus()`
419
405
 
420
- Fetch the public pricing data once on mount. Useful inside a
421
- pricing/upgrade page where the tiers are needed before render.
406
+ Fetch the signed-in user's current subscription state once on mount.
407
+ Returns 401 from the API when the user is not authenticated; consumers
408
+ should treat the absence of `data` as "anonymous → free tier".
422
409
 
423
410
  ```typescript
424
- function usePricingTiers(): UseHttpResult<PricingTiersResponse<TLimits>>
411
+ function useBillingStatus(): UseHttpResult<BillingStatus<TLimits>>
425
412
  ```
426
413
 
427
- **Returns:** Async-state for the pricing tiers response.
414
+ **Returns:** Async-state for the user's billing status.
428
415
 
429
416
  #### `useStartCheckout()`
430
417
 
@@ -442,6 +429,19 @@ function useStartCheckout(): BillingActionState<CheckoutResponse> & {
442
429
 
443
430
  **Returns:** Async-state plus a `start` function.
444
431
 
432
+ #### `useCancelSubscription()`
433
+
434
+ Cancel the user's active subscription at the end of the current
435
+ billing period. Returns the response from the bonded payment provider.
436
+
437
+ ```typescript
438
+ function useCancelSubscription(): BillingActionState<CancelResponse> & {
439
+ cancel: () => Promise<CancelResponse | null>
440
+ }
441
+ ```
442
+
443
+ **Returns:** Async-state plus a `cancel` function.
444
+
445
445
  ## Injection Notes
446
446
 
447
447
  ### Requirements
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@molecule/app-billing-react",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "React pricing page + checkout flow that consumes /api/billing/* (provided by @molecule/api-entitlements + @molecule/api-payments-stripe)",
5
5
  "homepage": "https://www.molecule.dev/packages/app-billing-react",
6
6
  "type": "module",
@@ -42,14 +42,14 @@
42
42
  "react": "^18.0.0 || ^19.0.0"
43
43
  },
44
44
  "devDependencies": {
45
- "@molecule/app-http": "1.0.2",
46
- "@molecule/app-react": "1.6.0",
47
- "@molecule/app-ui": "1.2.1",
48
- "@molecule/app-ui-react": "1.2.1",
49
- "@types/node": "26.1.2",
50
- "@types/react": "19.2.17",
51
- "react": "19.2.8",
45
+ "@molecule/app-http": "1.4.1",
46
+ "@molecule/app-react": "1.10.1",
47
+ "@molecule/app-ui": "1.3.8",
48
+ "@molecule/app-ui-react": "1.3.6",
49
+ "@types/node": "26.6.5",
50
+ "@types/react": "19.3.0",
51
+ "react": "19.3.1",
52
52
  "typescript": "6.0.3",
53
- "vitest": "4.1.11"
53
+ "vitest": "4.1.12"
54
54
  }
55
55
  }