@molecule/app-reputation-badge-react 1.0.1 → 1.0.3

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 +51 -51
  3. package/package.json +13 -12
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:30.440Z
6
+ Generated: 2026-10-16T23:37:33.623Z
7
7
  -->
8
8
 
9
9
  # @molecule/app-reputation-badge-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 reputation/karma surfaces — `<ReputationBadge>` and `<BadgeShelf>` —
16
12
  for forum, discussion-board, and social flagships.
17
13
 
@@ -23,6 +19,10 @@ legend 10000) unless you pass `level` or `thresholds`. `variant` is
23
19
  `<BadgeShelf badges limit onClick />` renders earned-badge icons with a
24
20
  trailing `+N` overflow chip (`onClick(null)` signals "expand all").
25
21
 
22
+ > **Auto-generated, AI-first package reference** for the [molecule.dev](https://molecule.dev) ecosystem.
23
+ > It is written to be read by coding agents as much as by people, and is generated from this
24
+ > package's source — edit `src/index.ts` JSDoc, not this file.
25
+
26
26
  ## Quick Start
27
27
 
28
28
  ```tsx
@@ -62,27 +62,6 @@ npm install -D @types/react
62
62
 
63
63
  ### Interfaces
64
64
 
65
- #### `Badge`
66
-
67
- A single earned badge — one icon on the `<BadgeShelf>` row.
68
-
69
- ```typescript
70
- interface Badge {
71
- /** Stable identifier (used as React key + click payload). */
72
- id: string
73
- /** Display name (translated upstream — passed verbatim). */
74
- name: string
75
- /** Optional longer description, shown in the native tooltip. */
76
- description?: string
77
- /** Icon glyph or short emoji (rendered inline). Mutually exclusive with `iconSrc`. */
78
- icon?: string
79
- /** Image URL for the badge icon. */
80
- iconSrc?: string
81
- /** ISO date string the badge was earned (passed back via `onClick`). */
82
- earnedAt?: string
83
- }
84
- ```
85
-
86
65
  #### `BadgeShelfProps`
87
66
 
88
67
  Props accepted by the {@link BadgeShelf} component.
@@ -162,6 +141,27 @@ interface ReputationThresholds {
162
141
  }
163
142
  ```
164
143
 
144
+ #### `Badge`
145
+
146
+ A single earned badge — one icon on the `<BadgeShelf>` row.
147
+
148
+ ```typescript
149
+ interface Badge {
150
+ /** Stable identifier (used as React key + click payload). */
151
+ id: string
152
+ /** Display name (translated upstream — passed verbatim). */
153
+ name: string
154
+ /** Optional longer description, shown in the native tooltip. */
155
+ description?: string
156
+ /** Icon glyph or short emoji (rendered inline). Mutually exclusive with `iconSrc`. */
157
+ icon?: string
158
+ /** Image URL for the badge icon. */
159
+ iconSrc?: string
160
+ /** ISO date string the badge was earned (passed back via `onClick`). */
161
+ earnedAt?: string
162
+ }
163
+ ```
164
+
165
165
  ### Types
166
166
 
167
167
  #### `ReputationLevel`
@@ -201,21 +201,30 @@ function BadgeShelf({
201
201
 
202
202
  **Returns:** The rendered shelf, or `null` if no badges are supplied.
203
203
 
204
- #### `colorForLevel(level)`
204
+ #### `ReputationBadge(props)`
205
205
 
206
- Return the semantic Badge color for a given level.
206
+ User reputation / karma display.
207
207
 
208
- Unknown levels fall back to `'secondary'`.
208
+ Renders a numeric score paired with a tier chip whose color reflects the
209
+ derived (or explicit) {@link ReputationLevel}. Used by discussion-boards,
210
+ forum, and social-media flagships to surface community standing.
211
+
212
+ Tier color comes from the active ClassMap bond's `cm.badge()` helper, so
213
+ apps swapping styling libraries restyle these chips for free.
209
214
 
210
215
  ```typescript
211
- function colorForLevel(
212
- level: ReputationLevel,
213
- ): 'primary' | 'secondary' | 'success' | 'warning' | 'info'
216
+ function ReputationBadge({
217
+ score,
218
+ level,
219
+ thresholds = DEFAULT_THRESHOLDS,
220
+ variant = 'compact',
221
+ className,
222
+ }: ReputationBadgeProps): React.JSX.Element
214
223
  ```
215
224
 
216
- - `level` — The reputation level.
225
+ - `props` — Component props (see {@link ReputationBadgeProps}).
217
226
 
218
- **Returns:** A badge color name from `@molecule/app-ui-react`.
227
+ **Returns:** The rendered reputation badge element.
219
228
 
220
229
  #### `levelForScore(score, thresholds)`
221
230
 
@@ -233,30 +242,21 @@ function levelForScore(score: number, thresholds?: ReputationThresholds): Reputa
233
242
 
234
243
  **Returns:** The derived reputation level.
235
244
 
236
- #### `ReputationBadge(props)`
237
-
238
- User reputation / karma display.
245
+ #### `colorForLevel(level)`
239
246
 
240
- Renders a numeric score paired with a tier chip whose color reflects the
241
- derived (or explicit) {@link ReputationLevel}. Used by discussion-boards,
242
- forum, and social-media flagships to surface community standing.
247
+ Return the semantic Badge color for a given level.
243
248
 
244
- Tier color comes from the active ClassMap bond's `cm.badge()` helper, so
245
- apps swapping styling libraries restyle these chips for free.
249
+ Unknown levels fall back to `'secondary'`.
246
250
 
247
251
  ```typescript
248
- function ReputationBadge({
249
- score,
250
- level,
251
- thresholds = DEFAULT_THRESHOLDS,
252
- variant = 'compact',
253
- className,
254
- }: ReputationBadgeProps): React.JSX.Element
252
+ function colorForLevel(
253
+ level: ReputationLevel,
254
+ ): 'primary' | 'secondary' | 'success' | 'warning' | 'info'
255
255
  ```
256
256
 
257
- - `props` — Component props (see {@link ReputationBadgeProps}).
257
+ - `level` — The reputation level.
258
258
 
259
- **Returns:** The rendered reputation badge element.
259
+ **Returns:** A badge color name from `@molecule/app-ui-react`.
260
260
 
261
261
  ### Constants
262
262
 
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@molecule/app-reputation-badge-react",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "User reputation/karma badge with score, level chip, and earned-badges shelf",
5
+ "homepage": "https://www.molecule.dev/packages/app-reputation-badge-react",
5
6
  "type": "module",
6
7
  "main": "dist/index.js",
7
8
  "types": "dist/index.d.ts",
@@ -40,17 +41,17 @@
40
41
  "react": "^18.0.0 || ^19.0.0"
41
42
  },
42
43
  "devDependencies": {
43
- "@molecule/app-i18n": "1.0.1",
44
- "@molecule/app-react": "1.0.1",
45
- "@molecule/app-ui": "1.0.1",
46
- "@molecule/app-ui-react": "1.0.1",
47
- "@testing-library/react": "16.3.2",
48
- "@types/node": "26.1.2",
49
- "@types/react": "19.2.17",
50
- "jsdom": "30.0.1",
51
- "react": "19.2.8",
52
- "react-dom": "19.2.8",
44
+ "@molecule/app-i18n": "1.0.4",
45
+ "@molecule/app-react": "1.10.1",
46
+ "@molecule/app-ui": "1.3.8",
47
+ "@molecule/app-ui-react": "1.3.6",
48
+ "@testing-library/react": "16.3.3",
49
+ "@types/node": "26.6.5",
50
+ "@types/react": "19.3.0",
51
+ "jsdom": "30.1.3",
52
+ "react": "19.3.1",
53
+ "react-dom": "19.3.1",
53
54
  "typescript": "6.0.3",
54
- "vitest": "4.1.10"
55
+ "vitest": "4.1.12"
55
56
  }
56
57
  }