psytools 0.6.2 → 0.6.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 (165) hide show
  1. package/LICENSE +8 -5
  2. package/README.md +14 -4
  3. package/SOURCES.md +108 -3
  4. package/dist/cjs/inventories/cbi.d.ts +31 -0
  5. package/dist/cjs/inventories/cbi.js +122 -0
  6. package/dist/cjs/inventories/csi16.d.ts +10 -0
  7. package/dist/cjs/inventories/csi16.js +160 -0
  8. package/dist/cjs/inventories/eat26.d.ts +12 -0
  9. package/dist/cjs/inventories/eat26.js +111 -0
  10. package/dist/cjs/inventories/index.d.ts +8 -1
  11. package/dist/cjs/inventories/index.js +19 -1
  12. package/dist/cjs/inventories/pcl5.d.ts +10 -0
  13. package/dist/cjs/inventories/pcl5.js +124 -0
  14. package/dist/cjs/inventories/phq15.d.ts +10 -0
  15. package/dist/cjs/inventories/phq15.js +74 -0
  16. package/dist/cjs/inventories/ucla-ls3.d.ts +10 -0
  17. package/dist/cjs/inventories/ucla-ls3.js +127 -0
  18. package/dist/cjs/locales/de/cbi.d.ts +7 -0
  19. package/dist/cjs/locales/de/cbi.js +110 -0
  20. package/dist/cjs/locales/de/csi16.d.ts +3 -0
  21. package/dist/cjs/locales/de/csi16.js +61 -0
  22. package/dist/cjs/locales/de/eat26.d.ts +3 -0
  23. package/dist/cjs/locales/de/eat26.js +47 -0
  24. package/dist/cjs/locales/de/pcl5.d.ts +4 -0
  25. package/dist/cjs/locales/de/pcl5.js +48 -0
  26. package/dist/cjs/locales/de/phq15.d.ts +4 -0
  27. package/dist/cjs/locales/de/phq15.js +35 -0
  28. package/dist/cjs/locales/de/ucla-ls3.d.ts +4 -0
  29. package/dist/cjs/locales/de/ucla-ls3.js +48 -0
  30. package/dist/cjs/locales/es/cbi.d.ts +7 -0
  31. package/dist/cjs/locales/es/cbi.js +110 -0
  32. package/dist/cjs/locales/es/csi16.d.ts +3 -0
  33. package/dist/cjs/locales/es/csi16.js +68 -0
  34. package/dist/cjs/locales/es/eat26.d.ts +3 -0
  35. package/dist/cjs/locales/es/eat26.js +47 -0
  36. package/dist/cjs/locales/es/pcl5.d.ts +4 -0
  37. package/dist/cjs/locales/es/pcl5.js +48 -0
  38. package/dist/cjs/locales/es/phq15.d.ts +4 -0
  39. package/dist/cjs/locales/es/phq15.js +35 -0
  40. package/dist/cjs/locales/es/ucla-ls3.d.ts +4 -0
  41. package/dist/cjs/locales/es/ucla-ls3.js +44 -0
  42. package/dist/cjs/locales/index.js +36 -0
  43. package/dist/cjs/locales/tr/cbi.d.ts +8 -0
  44. package/dist/cjs/locales/tr/cbi.js +111 -0
  45. package/dist/cjs/locales/tr/csi16.d.ts +3 -0
  46. package/dist/cjs/locales/tr/csi16.js +68 -0
  47. package/dist/cjs/locales/tr/eat26.d.ts +3 -0
  48. package/dist/cjs/locales/tr/eat26.js +47 -0
  49. package/dist/cjs/locales/tr/pcl5.d.ts +4 -0
  50. package/dist/cjs/locales/tr/pcl5.js +48 -0
  51. package/dist/cjs/locales/tr/phq15.d.ts +4 -0
  52. package/dist/cjs/locales/tr/phq15.js +35 -0
  53. package/dist/cjs/locales/tr/ucla-ls3.d.ts +4 -0
  54. package/dist/cjs/locales/tr/ucla-ls3.js +44 -0
  55. package/dist/cjs/locales/zh/cbi.d.ts +7 -0
  56. package/dist/cjs/locales/zh/cbi.js +110 -0
  57. package/dist/cjs/locales/zh/csi16.d.ts +3 -0
  58. package/dist/cjs/locales/zh/csi16.js +46 -0
  59. package/dist/cjs/locales/zh/eat26.d.ts +3 -0
  60. package/dist/cjs/locales/zh/eat26.js +45 -0
  61. package/dist/cjs/locales/zh/pcl5.d.ts +4 -0
  62. package/dist/cjs/locales/zh/pcl5.js +44 -0
  63. package/dist/cjs/locales/zh/phq15.d.ts +4 -0
  64. package/dist/cjs/locales/zh/phq15.js +35 -0
  65. package/dist/cjs/locales/zh/ucla-ls3.d.ts +4 -0
  66. package/dist/cjs/locales/zh/ucla-ls3.js +34 -0
  67. package/dist/cjs/types.d.ts +10 -2
  68. package/dist/esm/inventories/cbi.d.ts +31 -0
  69. package/dist/esm/inventories/cbi.js +119 -0
  70. package/dist/esm/inventories/csi16.d.ts +10 -0
  71. package/dist/esm/inventories/csi16.js +157 -0
  72. package/dist/esm/inventories/eat26.d.ts +12 -0
  73. package/dist/esm/inventories/eat26.js +108 -0
  74. package/dist/esm/inventories/index.d.ts +8 -1
  75. package/dist/esm/inventories/index.js +13 -0
  76. package/dist/esm/inventories/pcl5.d.ts +10 -0
  77. package/dist/esm/inventories/pcl5.js +121 -0
  78. package/dist/esm/inventories/phq15.d.ts +10 -0
  79. package/dist/esm/inventories/phq15.js +71 -0
  80. package/dist/esm/inventories/ucla-ls3.d.ts +10 -0
  81. package/dist/esm/inventories/ucla-ls3.js +124 -0
  82. package/dist/esm/locales/de/cbi.d.ts +7 -0
  83. package/dist/esm/locales/de/cbi.js +108 -0
  84. package/dist/esm/locales/de/csi16.d.ts +3 -0
  85. package/dist/esm/locales/de/csi16.js +59 -0
  86. package/dist/esm/locales/de/eat26.d.ts +3 -0
  87. package/dist/esm/locales/de/eat26.js +45 -0
  88. package/dist/esm/locales/de/pcl5.d.ts +4 -0
  89. package/dist/esm/locales/de/pcl5.js +46 -0
  90. package/dist/esm/locales/de/phq15.d.ts +4 -0
  91. package/dist/esm/locales/de/phq15.js +33 -0
  92. package/dist/esm/locales/de/ucla-ls3.d.ts +4 -0
  93. package/dist/esm/locales/de/ucla-ls3.js +46 -0
  94. package/dist/esm/locales/es/cbi.d.ts +7 -0
  95. package/dist/esm/locales/es/cbi.js +108 -0
  96. package/dist/esm/locales/es/csi16.d.ts +3 -0
  97. package/dist/esm/locales/es/csi16.js +66 -0
  98. package/dist/esm/locales/es/eat26.d.ts +3 -0
  99. package/dist/esm/locales/es/eat26.js +45 -0
  100. package/dist/esm/locales/es/pcl5.d.ts +4 -0
  101. package/dist/esm/locales/es/pcl5.js +46 -0
  102. package/dist/esm/locales/es/phq15.d.ts +4 -0
  103. package/dist/esm/locales/es/phq15.js +33 -0
  104. package/dist/esm/locales/es/ucla-ls3.d.ts +4 -0
  105. package/dist/esm/locales/es/ucla-ls3.js +42 -0
  106. package/dist/esm/locales/index.js +36 -0
  107. package/dist/esm/locales/tr/cbi.d.ts +8 -0
  108. package/dist/esm/locales/tr/cbi.js +109 -0
  109. package/dist/esm/locales/tr/csi16.d.ts +3 -0
  110. package/dist/esm/locales/tr/csi16.js +66 -0
  111. package/dist/esm/locales/tr/eat26.d.ts +3 -0
  112. package/dist/esm/locales/tr/eat26.js +45 -0
  113. package/dist/esm/locales/tr/pcl5.d.ts +4 -0
  114. package/dist/esm/locales/tr/pcl5.js +46 -0
  115. package/dist/esm/locales/tr/phq15.d.ts +4 -0
  116. package/dist/esm/locales/tr/phq15.js +33 -0
  117. package/dist/esm/locales/tr/ucla-ls3.d.ts +4 -0
  118. package/dist/esm/locales/tr/ucla-ls3.js +42 -0
  119. package/dist/esm/locales/zh/cbi.d.ts +7 -0
  120. package/dist/esm/locales/zh/cbi.js +108 -0
  121. package/dist/esm/locales/zh/csi16.d.ts +3 -0
  122. package/dist/esm/locales/zh/csi16.js +44 -0
  123. package/dist/esm/locales/zh/eat26.d.ts +3 -0
  124. package/dist/esm/locales/zh/eat26.js +43 -0
  125. package/dist/esm/locales/zh/pcl5.d.ts +4 -0
  126. package/dist/esm/locales/zh/pcl5.js +42 -0
  127. package/dist/esm/locales/zh/phq15.d.ts +4 -0
  128. package/dist/esm/locales/zh/phq15.js +33 -0
  129. package/dist/esm/locales/zh/ucla-ls3.d.ts +4 -0
  130. package/dist/esm/locales/zh/ucla-ls3.js +32 -0
  131. package/dist/esm/types.d.ts +10 -2
  132. package/package.json +14 -3
  133. package/src/inventories/cbi.ts +131 -0
  134. package/src/inventories/csi16.ts +189 -0
  135. package/src/inventories/eat26.ts +118 -0
  136. package/src/inventories/index.ts +20 -1
  137. package/src/inventories/pcl5.ts +127 -0
  138. package/src/inventories/phq15.ts +77 -0
  139. package/src/inventories/ucla-ls3.ts +131 -0
  140. package/src/locales/de/cbi.ts +111 -0
  141. package/src/locales/de/csi16.ts +66 -0
  142. package/src/locales/de/eat26.ts +52 -0
  143. package/src/locales/de/pcl5.ts +51 -0
  144. package/src/locales/de/phq15.ts +38 -0
  145. package/src/locales/de/ucla-ls3.ts +51 -0
  146. package/src/locales/es/cbi.ts +111 -0
  147. package/src/locales/es/csi16.ts +73 -0
  148. package/src/locales/es/eat26.ts +52 -0
  149. package/src/locales/es/pcl5.ts +51 -0
  150. package/src/locales/es/phq15.ts +37 -0
  151. package/src/locales/es/ucla-ls3.ts +47 -0
  152. package/src/locales/index.ts +36 -0
  153. package/src/locales/tr/cbi.ts +112 -0
  154. package/src/locales/tr/csi16.ts +73 -0
  155. package/src/locales/tr/eat26.ts +52 -0
  156. package/src/locales/tr/pcl5.ts +51 -0
  157. package/src/locales/tr/phq15.ts +37 -0
  158. package/src/locales/tr/ucla-ls3.ts +46 -0
  159. package/src/locales/zh/cbi.ts +111 -0
  160. package/src/locales/zh/csi16.ts +51 -0
  161. package/src/locales/zh/eat26.ts +48 -0
  162. package/src/locales/zh/pcl5.ts +46 -0
  163. package/src/locales/zh/phq15.ts +36 -0
  164. package/src/locales/zh/ucla-ls3.ts +36 -0
  165. package/src/types.ts +10 -1
package/LICENSE CHANGED
@@ -6,7 +6,7 @@ everything that makes psytools run — is licensed under the MIT
6
6
  License below. Copyright (c) 2026 Samed Kahyaoglu.
7
7
 
8
8
  The bundled instrument text — the titles, descriptions, instructions,
9
- item wording, and answer-option labels of the twenty-one third-party
9
+ item wording, and answer-option labels of the twenty-seven third-party
10
10
  psychological assessment instruments psytools ships, in every
11
11
  language psytools provides them — is licensed by each instrument's
12
12
  own rights holder, on the terms recorded instrument by instrument in
@@ -20,10 +20,13 @@ permission before commercial use: the ECR-R, the ERQ, and the HSPS,
20
20
  which SOURCES.md tags "Research only," and the SWLS and the
21
21
  Flourishing Scale, which SOURCES.md tags "Free with conditions" but
22
22
  whose own terms are non-commercial-only — the same restriction in
23
- substance, under a different tag. Two more, the AQ-10 and the RSES,
24
- are neither free nor restricted for commercial use: their rights
25
- holders simply haven't addressed it, so confirm with them before
26
- shipping commercially. Read SOURCES.md before you rely on any
23
+ substance, under a different tag. One more, the EAT-26, is free for
24
+ individual use but requires a licensing agreement from its copyright
25
+ holder for commercial web platforms that charge user fees. Four
26
+ others — the AQ-10, the RSES, the CSI-16, and the UCLA Loneliness
27
+ Scale — are neither free nor restricted for commercial use: their
28
+ rights holders simply haven't addressed it, so confirm with them
29
+ before shipping commercially. Read SOURCES.md before you rely on any
27
30
  instrument's text, particularly before commercial use.
28
31
 
29
32
  The MIT License below is the license for the code. The bundled
package/README.md CHANGED
@@ -19,7 +19,7 @@ That's a complete depression screening: standardized items, answer validation, p
19
19
 
20
20
  ## Why psytools
21
21
 
22
- - **Batteries included** — twenty-one instruments (PHQ-9, GAD-7, DASS-21, WHO-5, ASRS, AQ-10, AUDIT, Mini-IPIP, Mini-IPIP6, CES-D, ECR-R, ERQ, HSPS, SWLS, Flourishing, K10, K6, RSES, IPIP BIS/BAS, IPIP-NEO-60, IPIP-VIA-R) ship ready to use in up to five languages (English, Turkish, German, Chinese, Spanish — see the table below), with published scoring rules, citations, and filtering metadata (category, target audience, respondent role).
22
+ - **Batteries included** — twenty-six instruments (PHQ-9, PHQ-15, GAD-7, DASS-21, WHO-5, ASRS, AQ-10, AUDIT, Mini-IPIP, Mini-IPIP6, CES-D, ECR-R, ERQ, HSPS, SWLS, Flourishing, K10, K6, RSES, IPIP BIS/BAS, IPIP-NEO-60, IPIP-VIA-R, PCL-5, EAT-26, CSI-16, UCLA Loneliness Scale) ship ready to use in up to five languages (English, Turkish, German, Chinese, Spanish — see the table below), with published scoring rules, citations, and filtering metadata (category, target audience, respondent role).
23
23
  - **Your tests too** — therapists and researchers can define their own instruments as one plain JSON object; psytools validates, localizes, and scores them the same way.
24
24
  - **Everything is plain JSON** — assessments and responses `stringify()`/`parse()` losslessly, so definitions live in your database and travel between backend and frontend. Scoring rules are data, not code, and survive the round trip.
25
25
  - **Safe by default** — every answer is validated against the option scale, incomplete responses can't be scored accidentally, and submitted responses are immutable.
@@ -104,8 +104,16 @@ const response = AssessmentResponse.parse(assessment, rowFromDb); // answers re-
104
104
  | `bis-bas` | IPIP BIS/BAS scales (approach and avoidance motivation) | personality, motivation | 36 | 4 subscales (BIS 10, fun-seeking 10, drive 10, reward responsiveness 6), 10 reverse-keyed, no cutoffs | en, tr, de, zh, es |
105
105
  | `ipip-neo-60` | IPIP-NEO-60 personality inventory | personality | 60 | 5 domain subscales × 12 items (12–60 each), 23 reverse-keyed, no cutoffs | en, tr, de, zh, es |
106
106
  | `ipip-via-r` | IPIP-VIA-R short scales (24 character strengths) | character-strengths, personality | 96 | 24 strength subscales × 4 items (4–20 each), balanced 2 positive / 2 reverse, no cutoffs | en, tr, de, zh, es |
107
+ | `phq15` | Patient Health Questionnaire-15 (somatic symptoms) | somatic-symptoms | 15 | Sum 0–30 (0–2 coding), 4 severity bands, item 4 optional (women only) | en, tr, de, zh, es |
108
+ | `pcl5` | PTSD Checklist for DSM-5 (PCL-5), standard form | post-traumatic-stress | 20 | Sum 0–80, no bands² | en, tr, de, zh, es |
109
+ | `eat26` | Eating Attitudes Test (EAT-26) | disordered-eating | 26 | Sum 0–78 on an asymmetric key, referral at ≥20 | en, tr, de, zh, es |
110
+ | `csi16` | Couples Satisfaction Index (CSI-16) | relationships | 16 | Sum 0–81, **higher is better**, dissatisfied below 51.5 | en, tr, de, zh, es |
111
+ | `ucla-ls3` | UCLA Loneliness Scale (Version 3) | loneliness | 20 | Sum 20–80, 9 reverse-keyed items, no bands² | en, tr, de, zh, es |
112
+ | `cbi` | Copenhagen Burnout Inventory (CBI) | burnout | 19 | Three scales scored separately, sums; published score is the mean on 0–100, no bands² | en, tr, de, zh, es |
107
113
 
108
- ¹ The `ecr-r` and `hsps` Turkish packs reproduce **published, validated Turkish adaptations** (Sümer and colleagues — see [SOURCES.md](SOURCES.md)); other locales can follow once verified sources are available. `ecr-r`, `erq`, and `hsps` are licensed for **non-commercial research use only** — check [SOURCES.md](SOURCES.md) before shipping them in a product. `asrs6` is free to ship, commercially included, but its license makes attribution mandatory: render `meta.attribution` wherever it appears.
114
+ ¹ The `ecr-r` and `hsps` Turkish packs reproduce **published, validated Turkish adaptations** (Sümer and colleagues — see [SOURCES.md](SOURCES.md)); other locales can follow once verified sources are available. `ecr-r`, `erq`, and `hsps` are licensed for **non-commercial research use only** — check [SOURCES.md](SOURCES.md) before shipping them in a product. `asrs6` is free to ship, commercially included, but its license makes attribution mandatory: render `meta.attribution` wherever it appears. `eat26` is free for individual use but a **commercial web platform that charges user fees needs a licensing agreement** from its copyright holder — read its section in [SOURCES.md](SOURCES.md) before you build one. `cbi` has the thinnest licensing record of anything bundled — its steward publishes it openly but its rights holders have never granted anything in writing; read its section too.
115
+
116
+ ² `pcl5`, `ucla-ls3` and `cbi` ship no severity bands, because their rights holders publish none to ship: the VA offers a cutoff *range* (31–33) it describes as initial research, Russell scores the loneliness scale continuously, and the CBI's authors publish population norms rather than thresholds. Each records what is published in `meta.scoringNote` so you can apply your own threshold. Note also that `csi16` runs the opposite way to every other inventory here — a high score is a good result — so do not wire it to a shared "higher is worse" display.
109
117
 
110
118
  ```ts
111
119
  import { loadInventory, inventories, dass21 } from "psytools";
@@ -131,7 +139,9 @@ Every definition carries three optional fields for picking the right instrument:
131
139
 
132
140
  Audience and respondent are separate axes because instruments *about* children are commonly filled in by someone else — a parent-report ADHD scale is `audience: ["child"]`, `respondent: "parent"`. `audience` is an array, since one wording is often validated across bands; `respondent` is a single value, since a definition is written from exactly one point of view. Parent- and teacher-report forms of the same instrument say "your child" and "this student", so they are separate definitions with separate ids, not one definition with two respondents.
133
141
 
134
- Neither field encodes the recall timeframe or the administration mode: a retrospective instrument answered by an adult about their own childhood is `["adult"]` + `"self"`, with the childhood framing in `instructions`, and a clinician reading items aloud to a client is still `"self"` because the answers are the client's own report. Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except `rses` — Rosenberg developed the scale on high-school students and the same ten items are standard for both bands, so it is `["adolescent", "adult"]`.
142
+ Neither field encodes the recall timeframe or the administration mode: a retrospective instrument answered by an adult about their own childhood is `["adult"]` + `"self"`, with the childhood framing in `instructions`, and a clinician reading items aloud to a client is still `"self"` because the answers are the client's own report. Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except `rses` and `eat26`, which are both `["adolescent", "adult"]` — Rosenberg developed his scale on high-school students, Garner names high school and college among the EAT-26's screening populations, and neither instrument changes its wording between bands.
143
+
144
+ No bundled inventory is adolescent- or child-only yet, and none has a `respondent` other than `"self"`. That reflects who licenses their instruments freely, not what exists — the parent- and teacher-report scales that would fill those gaps are recorded, with their terms, under [instruments evaluated and not bundled](SOURCES.md#instruments-evaluated-and-not-bundled).
135
145
 
136
146
  ## Defining your own assessment
137
147
 
@@ -227,7 +237,7 @@ scoring: {
227
237
 
228
238
  `ignore` sums what is answered (partial totals understate severity — use deliberately); `prorate` scales the raw score up to the full item count (rounded) and refuses to score below `minAnswered`; `require-complete` throws unless every contributing non-optional item is answered. For subscale scoring the policy applies to each subscale independently.
229
239
 
230
- The bundled inventories ship with policies (PHQ-9/GAD-7/DASS-21 and the five IPIP inventories prorate with thresholds, WHO-5/ASRS/AQ-10 require-complete, AUDIT ignores to match its skip logic) — see [SOURCES.md](SOURCES.md#missing-data-policies) for the rationale and how to override.
240
+ The bundled inventories ship with policies (PHQ-9/GAD-7/DASS-21 and the five IPIP inventories prorate with thresholds, WHO-5/ASRS/AQ-10/CSI-16 require-complete, AUDIT ignores to match its skip logic, PHQ-15 ignores because its item 4 is marked women-only on the instrument) — see [SOURCES.md](SOURCES.md#missing-data-policies) for the rationale and how to override.
231
241
 
232
242
  ## Custom evaluation
233
243
 
package/SOURCES.md CHANGED
@@ -24,7 +24,7 @@ The same provenance applies to every bundled inventory **except where an invento
24
24
  | zh | AI translation (Anthropic Claude) from the original English | No |
25
25
  | es | AI translation (Anthropic Claude) from the original English | No |
26
26
 
27
- The exact translating model is stated per inventory in `meta.translationProvenance` (`claude-fable-5` for the original batch, `claude-sonnet-5` for later additions, `claude-opus-5` for the IPIP batch).
27
+ The exact translating model is stated per inventory in `meta.translationProvenance` (`claude-fable-5` for the original batch, `claude-sonnet-5` for later additions, `claude-opus-5` for the IPIP batch and the 2026-07 coverage wave).
28
28
 
29
29
  Official validated translations exist for most of these instruments, but they were **not consulted** in preparing the bundled texts, so they are deliberately not cited as sources. The packaged non-English wording has not been checked against them and has not been psychometrically validated. Validated instruments are only validated for their exact wording — before clinical or research use, obtain the official version for your language and compare or replace the text.
30
30
 
@@ -36,7 +36,9 @@ This table is the only place translation status is tracked — psytools has no `
36
36
 
37
37
  Each inventory declares two independent axes in its definition: `audience`, the age band(s) the instrument is written and validated for — who it is *about* — and `respondent`, whose report the answers are. They are separate because instruments about children are commonly completed by a parent or a teacher rather than by the child.
38
38
 
39
- **Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except where its section below states otherwise.** One deviates today: the RSES is `["adolescent", "adult"]`.
39
+ **Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except where its section below states otherwise.** Two deviate today, both by widening rather than narrowing: the RSES and the EAT-26 are each `["adolescent", "adult"]`, because the same wording is standard for both bands.
40
+
41
+ Two gaps are worth naming, since they are what the fields exist for and neither is filled yet. **No bundled inventory is written for adolescents or children only**, and **none has a `respondent` other than `"self"`** — no parent- or teacher-report form is bundled. The instruments that would fill those gaps are, so far, the ones whose rights holders restrict redistribution: the parent and teacher Vanderbilt scales, the SDQ, and the CRAFFT all sit in [instruments evaluated and not bundled](#instruments-evaluated-and-not-bundled) below. Filter on `audience` and `respondent` by all means, but do not read today's values as a survey of what exists.
40
42
 
41
43
  Two things `audience` and `respondent` deliberately do *not* encode:
42
44
 
@@ -65,6 +67,12 @@ Bundled inventories ship with declarative missing-data policies (`scoring.missin
65
67
  | `bis-bas` | prorate, ≥5 per subscale | One threshold serves subscales of 10, 10, 10, and 6 items, so it is pinned to the strictest value the 6-item subscale allows — 5 of 6 there, 5 of 10 on the others |
66
68
  | `ipip-neo-60` | prorate, ≥9 of 12 per domain | Common research practice (75% completion) |
67
69
  | `ipip-via-r` | prorate, ≥3 of 4 per strength | 75% completion; note that dropping one item of a balanced 2-positive/2-negative scale reintroduces acquiescence bias |
70
+ | `phq15` | ignore | Item 4 is printed "[women only]" on the instrument, so it is legitimately unanswered by around half of respondents; an unanswered item contributes 0, which is what the instrument's own total-score line does. Prorating would inflate a man's score by 15/14 for answering the form as printed. The usual `ignore` caveat still applies to an accidental skip |
71
+ | `pcl5` | prorate, ≥16 of 20 | Common research practice (≈80% completion) — the same threshold as `cesd`, the package's other 20-item sum. The VA publishes no prorating rule of its own |
72
+ | `eat26` | prorate, ≥21 of 26 | Common research practice (≈80% completion) |
73
+ | `csi16` | require-complete | The authors' scoring instruction is a plain sum over all sixteen items, and their 51.5 cutoff is calibrated to the full 0–81 range. No prorating rule is published, and inventing one would move a clinical threshold |
74
+ | `ucla-ls3` | prorate, ≥16 of 20 | Common research practice (≈80% completion); the score is continuous with no cutoff, so prorating carries no risk of tipping a respondent across a threshold |
75
+ | `cbi` | prorate, ≥4 per scale | The authors' own rule is 3 of 6 (personal), 4 of 7 (work), 3 of 6 (client). One policy cannot carry three thresholds, so it is pinned to the strictest — stricter than the authors on the two 6-item scales, which fails safe. Prorating is the authors' method: their score is the mean of the answered items |
68
76
 
69
77
  ## PHQ-9 — Patient Health Questionnaire-9 (`phq9`)
70
78
 
@@ -249,9 +257,97 @@ Five bundled inventories are drawn from the International Personality Item Pool
249
257
  - **Reliability is modest for several scales, by construction.** Four items divided between two wordings buys balance at the cost of internal consistency. The authors report McDonald's ω between .57 and .84 across German and UK samples and argue that Cronbach's α is the wrong estimate for a balanced scale of this shape; α runs as low as .42 (self-regulation, UK). Treat single-strength scores as indicative, not precise. The 2–3 week retest reliabilities (.53–.84) are the more useful number for most applications.
250
258
  - **Scale labels.** IPIP lists several strengths under two or three names (for example "Industry/Perseverance/Persistence"). psytools keeps a descriptive label carrying the alternatives and uses a single short id (`perseverance`); the mapping is visible in the definition.
251
259
 
260
+ ## PHQ-15 — Patient Health Questionnaire-15 (`phq15`)
261
+
262
+ **License: Free.** The same Pfizer grant as the bundled PHQ-9 and GAD-7, confirmed twice from primary sources. The instrument's own footer reads: "Copyright Pfizer Inc. No permission required to reproduce, translate, display, or distribute." The PHQ family's instruction manual says the same of the whole family and names the PHQ-15 explicitly in its table of measures: "All of the measures included in Table 1 are in the public domain. No permission is required to reproduce, translate, display or distribute." Official repository: <https://www.phqscreeners.com>.
263
+
264
+ - **Citation:** Kroenke, K., Spitzer, R. L., & Williams, J. B. W. (2002). The PHQ-15: Validity of a new measure for evaluating the severity of somatic symptoms. *Psychosomatic Medicine, 64*(2), 258–266.
265
+ - **Scoring:** Sum 0–30 on a 0–2 bother scale over the past 4 weeks. Bands split at the PHQ manual's own cutpoints of 5, 10 and 15 for low, medium and high somatic symptom severity.
266
+ - **Item 4 is optional, because the instrument says so.** "Menstrual cramps or other problems with your periods" is printed "[women only]" on the form. psytools marks it `optional`, and the missing-data policy is `ignore` so that a respondent who skips it is scored on what they answered — see [missing-data policies](#missing-data-policies) for why prorating would be wrong here.
267
+ - **Two items are shared with the PHQ-9, and the answers are not interchangeable.** Item 14 (tired) and item 15 (sleep) cover the same symptoms as PHQ-9 items 4 and 3. The wording is shorter here and, more importantly, the scale runs 0–2 rather than 0–3. Do not copy an answer from one inventory to the other; administer each on its own scale.
268
+
269
+ ## PCL-5 — PTSD Checklist for DSM-5 (`pcl5`)
270
+
271
+ **License: Free.** The rights holder's own page states it without qualification: "This measure was developed by staff at VA's National Center for PTSD and is in the public domain and not copyrighted" (<https://www.ptsd.va.gov/professional/assessment/adult-sr/ptsd-checklist.asp>). English text transcribed from the VA's own PCL-5 Standard form PDF, version date 29 August 2023.
272
+
273
+ - **Citation:** Weathers, F. W., Litz, B. T., Keane, T. M., Palmieri, P. A., Marx, B. P., & Schnurr, P. P. (2013). *The PTSD Checklist for DSM-5 (PCL-5) — Standard* [Measurement instrument]. National Center for PTSD. Available from <https://www.ptsd.va.gov/>.
274
+ - **Scoring:** Sum 0–80 on a 0–4 scale, recall window one month. psytools bundles the standard form; the VA also publishes forms with a Criterion A event checklist and with an extended timeframe, which are not included.
275
+ - **No bands, and that is deliberate — the cutoff is provisional in the VA's own words.** The VA writes that "initial research suggests that a PCL-5 cutoff score between 31–33 is indicative of probable PTSD across samples," and asks users to weigh their own setting when choosing one. That is a range offered as initial research, not a settled threshold. A `band` renders to whoever is reading the result as a categorical verdict, so encoding one number out of 31–33 as a boundary would present a provisional finding as a decided one. The range is recorded in `meta.scoringNote` instead; apply your own cutoff over `score` if your protocol names one.
276
+ - **The DSM-5 provisional-diagnosis rule is not implemented.** The VA's second scoring route — at least one item from cluster B, one from C, two from D and two from E, each rated 2 or higher — needs per-cluster counts of items above a threshold, which none of psytools' three declarative scorings expresses. The cluster composition is recorded in `meta.scoringNote` (B: 1–5, C: 6–7, D: 8–14, E: 15–20) so a custom evaluator can implement it in a few lines.
277
+
278
+ ## EAT-26 — Eating Attitudes Test (`eat26`)
279
+
280
+ **License: Free with conditions.** Copyright is held by David M. Garner / Eating Attitudes LLC. Fees and royalties are waived for individual users, and permission letters to reproduce paper or electronic copies are granted on request through the copyright holder's own site (<https://www.eat-26.com/permission/>). One exception is stated explicitly, and a consumer building a paid product needs to see it before they build:
281
+
282
+ > Commercial WEB platforms that charge user fees must obtain a licensing agreement from the copyright holder.
283
+
284
+ **Our position, stated separately from the rights holder's words above:** psytools is an open-source library, not a commercial web platform, and it charges no user fees — so we read that condition as landing on the deployment, not on the library, and bundle the text on that basis. **If you are building a web platform that charges user fees, the condition lands on you.** Contact <dmgarner@gmail.com> for a licensing agreement before you ship. The flag does not encode our reading; it says `free-with-conditions` and this section is the condition.
285
+
286
+ - **Citation:** Garner, D. M., Olmsted, M. P., Bohr, Y., & Garfinkel, P. E. (1982). The Eating Attitudes Test: Psychometric features and clinical correlates. *Psychological Medicine, 12*(4), 871–878.
287
+ - **Scoring:** Sum 0–78 on Garner's own asymmetric key, taken from his scoring and interpretation document. For items 1–25, Always scores 3, Usually 2, Often 1, and Sometimes, Rarely and Never all score 0; item 26 is keyed the other way round (Never 3, Rarely 2, Sometimes 1, the rest 0). A score of 20 or above is his referral criterion, which is where the two bands split. His three subscales — dieting, bulimia and food preoccupation, oral control — are recorded in `meta.scoringNote` but not scored, because the total is what carries the cutoff.
288
+ - **Three of the six answer anchors score the same number, so key your UI by option position.** That collapse is the instrument's, not ours: Garner's scoring table gives Sometimes, Rarely and Never an identical 0 on items 1–25. psytools' model stores an answer as its score contribution, so `value` alone cannot say which of the three a respondent picked. Render options and store raw responses by their index in the `options` array — `meta.renderingNote` repeats this next to the data.
289
+ - **psytools bundles Part B only, and Garner's referral logic is wider than that.** His full form has three parts: a demographic and BMI section (Part A), the 26 scored items (Part B), and five behavioural questions about bingeing, vomiting, laxatives, exercise and weight loss (Part C). Only Part B carries the 0–78 score, so only Part B is bundled. Garner refers a respondent on a score of 20 or above **or** on low age-referenced BMI **or** on any flagged behavioural answer — so a score below 20 does not, on its own, complete his screening protocol. Implement Parts A and C alongside if you are reproducing that protocol rather than the scale.
290
+ - **Audience — deviates from the default:** `audience: ["adolescent", "adult"]`. Garner's own scoring document describes the EAT-26 as "particularly useful as a screening tool to assess 'eating disorder risk' in high school, college and other special risk samples such as athletes," and the BMI referral criteria he publishes with it are age-referenced from age 9 upward. The item wording does not change between bands. We stop at adolescent rather than following the BMI table down to age 9, because high school and college is what the rights holder names.
291
+
292
+ ## CSI-16 — Couples Satisfaction Index (`csi16`)
293
+
294
+ **License: Free with conditions.** Ronald Rogge and colleagues (University of Rochester) distribute the CSI scales from their own lab site, and the grant is printed both on the site and on the instrument file itself. The site says:
295
+
296
+ > These scales are freely available for use in both clinical and research settings. No additional permission is necessary for their use.
297
+
298
+ The CSI-16 file adds:
299
+
300
+ > PERMISSION FOR USE: We developed the CSI scales to be freely available for research and clinical use. No further permission is required beyond this form and the authors will not generate study-specific permission letters.
301
+
302
+ **This is the cleanest, least hedged grant of the four conditional instruments — and it still never says "commercial", in either direction.** Both statements scope themselves to clinical and research settings. There is no commercial carve-out to comply with, and no commercial permission to rely on; the authors simply did not address it, most likely because they had individual clinicians and researchers in mind rather than software redistribution. That silence is the whole of the condition, and the reason the flag is not `free`. **Our position:** we read a grant this unhedged as covering distribution of the item text in an open-source library, and bundle it. If your own use is commercial and you want certainty rather than a reasonable reading, ask the authors — the scales are hosted at <https://couples-research.com/measures/>.
303
+
304
+ - **Citation:** Funk, J. L., & Rogge, R. D. (2007). Testing the ruler with item response theory: Increasing precision of measurement for relationship satisfaction with the Couples Satisfaction Index. *Journal of Family Psychology, 21*(4), 572–583.
305
+ - **Scoring:** Sum 0–81. **Higher is more satisfied** — the opposite direction from every other bundled inventory, where a higher score means more of a problem. Do not wire a shared "higher is worse" display to this one. The authors' cutoff is 51.5, so the bands split at 51/52.
306
+ - **Four different answer scales, which is why most items carry their own `options`.** Item 1 is a 7-point 0–6 happiness scale ending in "Perfect"; item 2 runs 5 down to 0; items 3–6 are 0–5 agreement; items 7–10 use the assessment-level 0–5 scale; items 11–16 are semantic differentials.
307
+ - **Items 11–16 are semantic differentials and need a renderer that knows it.** Each is a pair of opposing words with six positions between them. psytools puts both poles in the question `text`, in the order the authors print them left to right, and labels the six options with the position numbers as printed on the authors' form. The authors note that when they administer the scale they replace those numbers with blank circles; a renderer wanting that should draw the poles from `text` at each end of a row of six controls. The locale packs restate the same digits rather than inventing words for the intermediate positions.
308
+ - **`instructions` is the form's only instruction line, and on paper it introduces items 11–16.** Items 1–10 carry self-contained stems and need no preamble. psytools has one instruction field per assessment, so that line is promoted to the assessment's `instructions`; it is reproduced verbatim rather than rewritten to cover all sixteen.
309
+ - **This inventory is the first to populate the `relationships` category on its own.** The category has been declared since the first release and was carried only as a secondary label on `ecr-r`, which measures attachment.
310
+
311
+ ## UCLA Loneliness Scale, Version 3 (`ucla-ls3`)
312
+
313
+ **License: Free with conditions.** This is the thinnest licensing record of anything bundled, and the section is long because the reader deserves both halves of it.
314
+
315
+ Daniel W. Russell (Iowa State University) developed the scale and has publicly disclaimed any requirement to seek his permission. In a 2022 openly-licensed interview he described the daily requests he receives from graduate students "whose committees are telling them 'you have to get permission from the developer to use the scale' which is not true." That is current, first-person and unambiguous as far as it goes. What it is not is a formal licence: it is a remark in an interview, it is addressed to researchers rather than to redistributors, and it does not mention commercial use in either direction.
316
+
317
+ Set against it, without contradicting it: HealthMeasures lists Russell and the UCLA Loneliness Scale among the third-party content PROMIS uses **with the permission of the copyright holders**. The two facts sit together perfectly well — an author who tells students they need not ask can still receive and grant a formal institutional request — but a reader weighing their own risk should have both, so both are here.
318
+
319
+ **Our position:** on the strength of the author's own words we bundle the text and flag it `free-with-conditions` rather than `free`, because no licence exists to point at. If your use is commercial and you want certainty, write to Russell. We have not.
320
+
321
+ - **Citation:** Russell, D. W. (1996). UCLA Loneliness Scale (Version 3): Reliability, validity, and factor structure. *Journal of Personality Assessment, 66*(1), 20–40.
322
+ - **Item source — no first-party copy exists.** Russell distributes no copy of his own and the 1996 article is paywalled, so unlike every other instrument in this file the English text does not come from the rights holder. It is transcribed from two independent reproductions of Russell (1996), read and checked against each other: Stanford SPARQ's *Measuring Mobility* toolkit (<https://sparqtools.org/mobility-measure/ucla-loneliness-scale-version-3/>) and the Fetzer Institute's self-measures compendium. They agree item for item and on the reverse keys.
323
+ - **They disagree on the top anchor, and psytools follows "Always".** One prints Never / Rarely / Sometimes / **Often**, the other Never / Rarely / Sometimes / **Always**. Russell's own instruction example settles it — it ends "if you always feel happy, you would respond 'always'" — and "Often" belongs to the earlier Revised UCLA Loneliness Scale, a different instrument. This is exactly the kind of drift a single source would have shipped unnoticed.
324
+ - **Scoring:** Sum 20–80 on a 1–4 frequency scale, higher is lonelier. **Nine of the twenty items are reverse-keyed** — 1, 5, 6, 9, 10, 15, 16, 19 and 20, the positively worded ones. (Nine, not ten: descriptions of this scale sometimes quote "10 of the 20 items reverse scored", which is a statement about the earlier Revised version, not about Version 3.)
325
+ - **No bands, because Russell publishes no cutoffs.** The scale is scored continuously. Severity bandings for it circulate widely on the web; none of them traces back to Russell, so none is bundled.
326
+
327
+ ## CBI — Copenhagen Burnout Inventory (`cbi`)
328
+
329
+ **License: Free with conditions.** Like the UCLA scale above, this record has two halves and you should have both.
330
+
331
+ **What supports it.** NFA — Det Nationale Forskningscenter for Arbejdsmiljø, Denmark's national occupational-health research institute — hosts the complete instrument in its public questionnaire library with no registration, no fee and no gate of any kind, under a named live contact (Thomas Clausen, <tcl@nfa.dk>). An independent peer-reviewed validation study describes it, citing Kristensen et al. by name, as "a public domain questionnaire." And the two published Turkish adaptations (2009, 2013) describe their method without describing a permission-seeking step — which carries some weight in this file specifically, because the Turkish teams behind the WURS-25, the WFIRS and the Athens Insomnia Scale all state plainly that they wrote and asked first.
332
+
333
+ **What is missing.** No statement from the rights holders themselves. NFA stewards and distributes the instrument; it did not write it. Two independent research passes went looking for a first-party grant and neither found one, and the original Kristensen et al. (2005) paper stayed paywalled across every route tried, so if it settles the question either way we have not read it. Nothing in the first-edition document itself — read in full — carries a copyright line, a licence, or a permission statement.
334
+
335
+ **Our position:** bundled on the strength of NFA's open hosting, and flagged `free-with-conditions` rather than `free` because there is no grant to point at. If your use is commercial and you want certainty, write to NFA. We have not.
336
+
337
+ - **Citation:** Kristensen, T. S., Borritz, M., Villadsen, E., & Christensen, K. B. (2005). The Copenhagen Burnout Inventory: A new tool for the assessment of burnout. *Work & Stress, 19*(3), 192–207.
338
+ - **Item source:** the authors' own English first edition (February 2004), by Marianne Borritz and Tage S. Kristensen at the National Institute of Occupational Health, Copenhagen, as hosted by NFA. Read in full, including the normative tables. **Single source** — unlike `ucla-ls3` there was no second reproduction to cross-check against, but unlike `ucla-ls3` this one comes from the authors themselves.
339
+ - **Development language was Danish**, for the PUMA study on a Danish population. The English text bundled here is the authors' own, not a third-party translation, so the file's general provenance rule still holds — but this is the first bundled instrument whose *development* language is not English, and that distinction is worth keeping in view as more non-English-origin instruments are considered.
340
+ - **Three scales, scored separately, no total.** Personal burnout (6 items), work-related burnout (7), client-related burnout (6). There is deliberately no score across all nineteen: the three ask about the same exhaustion under different attributions, and the authors treat them as independent.
341
+ - **Two response scales are mixed within a scale.** Items phrased as "is your work…" take a degree scale (To a very high degree … To a very low degree); items phrased as "how often…" take a frequency scale (Always … Never/almost never). Both map to the same 100 / 75 / 50 / 25 / 0 key, so a mis-assigned scale would produce a wrong score rather than an out-of-range answer — `test/evaluation.test.ts` pins which items carry which.
342
+ - **Scoring:** the published score for each scale is the **mean** of its items, on 0–100. psytools reports subscale sums; divide by 6, 7 and 6 respectively — the same convention the ECR-R, ERQ and HSPS entries follow. **One item is reverse-keyed**: work-burnout item 7 (`cbi-13`), on having energy left for family and friends, where more energy means less burnout.
343
+ - **Missing data:** the authors' own rule classifies a respondent as a non-responder below 3 of 6 answered (personal), 4 of 7 (work) and 3 of 6 (client). A single policy cannot carry three thresholds, so `minAnswered` is pinned to 4 — stricter than the authors on the two 6-item scales, which fails safe by refusing to score rather than scoring thin data.
344
+ - **No bands, because the authors publish norms rather than cutoffs.** The first edition gives population means (around 32.7 for personal burnout in a representative Danish sample, SD 15.7) and no severity thresholds, so none are bundled.
345
+ - **The authors ask that the items not be presented in the printed order**, and say they may be interleaved with questions on other topics, to avoid stereotyped response patterns. psytools keeps the published order so the definition stays checkable against the source — shuffle at presentation time if you follow the recommendation.
346
+ - **"Clients" is meant to be substituted.** The authors instruct that the term should match the setting — patients for nurses, students or children for teachers. The bundled instructions say so; the Turkish pack uses *danışan*, which is already the right word for a therapy setting.
347
+
252
348
  ## Instruments evaluated and not bundled
253
349
 
254
- Instruments considered for inclusion and not shipped, each checked against the rights holder's own published terms. Recorded so the same ground is not covered twice. Today's entries all come from one sweep of widely used ADHD instruments (July 2026); five are blocked by their licensing and one is waiting on a permission request.
350
+ Instruments considered for inclusion and not shipped, each checked against the rights holder's own published terms. Recorded so the same ground is not covered twice. Six entries come from a sweep of widely used ADHD instruments (July 2026) and one from the 2026-07 coverage wave; five are blocked by their licensing and two are waiting on a permission request.
255
351
 
256
352
  - **ASRS v1.1, full 18-item Symptom Checklist** — © New York University and the President and Fellows of Harvard College. A separate product on the same NYU TOV platform from the 6-item screener, and the screener's free-commercial grant does not extend to it: clinical use is routed to a different site, research use requires an institutional signatory, and no commercial tier is offered. Not bundled.
257
353
  - **ASRS-5 (DSM-5-aligned, 6 items)** — © New York University / NYU Langone Health. A different instrument from the v1.1 screener despite the similar name and length. Only a research-and-academic license is publicly offered, and the rights holder's own product listing calls the scoring rules proprietary. Not bundled.
@@ -259,5 +355,14 @@ Instruments considered for inclusion and not shipped, each checked against the r
259
355
  - **SNAP-IV** — James M. Swanson / University of California, Irvine. Neither the instrument nor the developer's own published history of the scale carries a copyright or license statement at all. The absence of a grant is not a grant. Not bundled.
260
356
  - **NICHQ Vanderbilt Assessment Scales (parent and teacher forms)** — © 2012 American Academy of Pediatrics, printed "All Rights Reserved" on the instrument. Free to download and administer, which is not the same as licensed to redistribute inside a package. Not bundled.
261
357
  - **WFIRS-P / WFIRS-S (Weiss Functional Impairment Rating Scale)** — © Margaret Danielle Weiss, MD PhD. Permissive terms, but the notice asks that the author be contacted before translation. **Blocked on a permission request we intend to make, not on a refusal** — so this one may yet arrive.
358
+ - **CRAFFT 2.1 (adolescent substance-use screener)** — © John R. Knight, MD / Boston Children's Hospital, distributed by the Center for Adolescent Behavioral Health Research. Free of charge, warmly distributed, and it would have been the first non-adult instrument in the package. Held back on three grounds, any one of which is enough, all three read off the rights holder's own CRAFFT 2.1 Manual (version 28 October 2021):
359
+
360
+ 1. **The permission we would need is the one that has not been asked for.** The manual grants clinicians permission-free use in their own practice "provided that questions are presented exactly as they appear in the copyrighted version," and then says plainly: "You do need to request approval to re-publish the CRAFFT in another print or electronic format. There is no fee for use or to request permission." Bundling the item text in a package *is* re-publishing it in another electronic format. That obligation lands on psytools at the moment we publish, not on the consumer at the moment they deploy — so it is not the kind of condition this file can pass downstream and let a reader apply to their own use. It is the same shape as the WFIRS entry above, and a degree stronger.
361
+ 2. **Our translations would conflict with the condition attached to the grant.** Permission-free use is conditioned on questions appearing exactly as in the copyrighted version, and the rights holder maintains official translations in 27 languages — including all four psytools ships: Turkish, German, Chinese (Simplified) and Spanish. Shipping unverified AI translations next to that is not defensible, and it is a sharper conflict than the unresolved ASRS-6 translation question, where no official Turkish version exists to have used instead.
362
+ 3. **Part A cannot be represented in this data model at all.** The CRAFFT's three opening questions ask on how many days in the past 12 months the respondent drank, used cannabis, or used anything else to get high, and the answer is a number written in a box. Every psytools question resolves to an enumerated option scale; there is no numeric-entry question type. Any enumerated scale we invented for Part A would be an answer format the instrument does not have — which independently breaks the "exactly as they appear" condition — and the earlier CRAFFT's yes/no opening questions are not a substitute, since 2.1 replaced them deliberately after finding they under-detected use.
363
+
364
+ **On the conditional structure specifically, since it is the interesting part and the next person should not have to re-derive it.** Part A gates Part B: if all three frequency answers are 0 the respondent is asked only the first Part B question (CAR, a riding-with-an-impaired-driver safety item asked of everyone), and otherwise all six. The score is the count of "yes" answers across Part B, 0–6, and 2 or more is the referral threshold. Two thirds of that *is* expressible declaratively — `count` scoring naming only the six Part B items, `optional: true` on the five that the gate can skip, and an `ignore` missing-data policy. That combination produces the right answer rather than a quietly wrong one: a respondent who reports no use is scored on the CAR item alone, giving 0 or 1, which is what the manual says their score is and is below the threshold either way. What it cannot do is *enforce* the gate — nothing in a declarative definition stops a consumer showing all six Part B items to a respondent who reported no use, or requires the other five when use is reported. So the honest summary is that the scoring survives the model and the administration logic does not.
365
+
366
+ **Blocked on a permission request, not on a refusal.** The ask is narrow and the manual says there is no fee for it: approval to re-publish the CRAFFT 2.1 English text inside an open-source package, and separately whether the official translations may be used in place of ours. Contact: <crafft@childrens.harvard.edu>. Until that comes back, `audience: ["adolescent"]` has no bundled instrument and the note in [target audience & respondent](#target-audience--respondent) above says so.
262
367
 
263
368
  Hold rights to any of these, or know of a grant we missed? Please write to <samed@luckys.dev> — a correction here is as welcome as one to a bundled instrument.
@@ -0,0 +1,31 @@
1
+ import type { AssessmentDefinition } from "../types.ts";
2
+ /**
3
+ * CBI — Copenhagen Burnout Inventory (Kristensen, Borritz, Villadsen &
4
+ * Christensen, 2005).
5
+ *
6
+ * 19 items in three independent scales: personal burnout (6), work-related
7
+ * burnout (7), and client-related burnout (6). Each scale is scored on its
8
+ * own; there is no total across all 19, because the three ask about
9
+ * different attributions of the same exhaustion.
10
+ *
11
+ * Two response scales are mixed within the work and client scales — the
12
+ * degree scale on the items phrased as "is your work..." and the frequency
13
+ * scale on those phrased as "how often...". Both map to the same 100/75/50/
14
+ * 25/0 key, which is why the published score for each scale is the mean of
15
+ * its items on a 0–100 range. psytools reports subscale sums; divide by 6,
16
+ * 7, and 6 to get the published figure (the same convention the ECR-R, ERQ
17
+ * and HSPS entries follow).
18
+ *
19
+ * One item is reverse-keyed: work-burnout item 7, on having energy left for
20
+ * family and friends, where more energy means less burnout.
21
+ *
22
+ * No cutoffs are defined. The authors publish population norms (Danish
23
+ * means around 32 for personal burnout) rather than severity thresholds, so
24
+ * no bands are declared — see SOURCES.md.
25
+ *
26
+ * Item text is reproduced from the authors' own English first edition
27
+ * (February 2004), hosted by NFA, Denmark's National Research Centre for
28
+ * the Working Environment. Rights: no first-party grant exists — read the
29
+ * SOURCES.md entry before shipping this commercially.
30
+ */
31
+ export declare const cbi: AssessmentDefinition;
@@ -0,0 +1,122 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.cbi = void 0;
4
+ /** Always ... Never/almost never, scored 100 down to 0 (Kristensen et al.'s own key). */
5
+ const frequencyOptions = [
6
+ { value: 100, label: { en: "Always" } },
7
+ { value: 75, label: { en: "Often" } },
8
+ { value: 50, label: { en: "Sometimes" } },
9
+ { value: 25, label: { en: "Seldom" } },
10
+ { value: 0, label: { en: "Never/almost never" } },
11
+ ];
12
+ /** To a very high degree ... To a very low degree, scored on the same 100–0 key. */
13
+ const degreeOptions = [
14
+ { value: 100, label: { en: "To a very high degree" } },
15
+ { value: 75, label: { en: "To a high degree" } },
16
+ { value: 50, label: { en: "Somewhat" } },
17
+ { value: 25, label: { en: "To a low degree" } },
18
+ { value: 0, label: { en: "To a very low degree" } },
19
+ ];
20
+ /**
21
+ * CBI — Copenhagen Burnout Inventory (Kristensen, Borritz, Villadsen &
22
+ * Christensen, 2005).
23
+ *
24
+ * 19 items in three independent scales: personal burnout (6), work-related
25
+ * burnout (7), and client-related burnout (6). Each scale is scored on its
26
+ * own; there is no total across all 19, because the three ask about
27
+ * different attributions of the same exhaustion.
28
+ *
29
+ * Two response scales are mixed within the work and client scales — the
30
+ * degree scale on the items phrased as "is your work..." and the frequency
31
+ * scale on those phrased as "how often...". Both map to the same 100/75/50/
32
+ * 25/0 key, which is why the published score for each scale is the mean of
33
+ * its items on a 0–100 range. psytools reports subscale sums; divide by 6,
34
+ * 7, and 6 to get the published figure (the same convention the ECR-R, ERQ
35
+ * and HSPS entries follow).
36
+ *
37
+ * One item is reverse-keyed: work-burnout item 7, on having energy left for
38
+ * family and friends, where more energy means less burnout.
39
+ *
40
+ * No cutoffs are defined. The authors publish population norms (Danish
41
+ * means around 32 for personal burnout) rather than severity thresholds, so
42
+ * no bands are declared — see SOURCES.md.
43
+ *
44
+ * Item text is reproduced from the authors' own English first edition
45
+ * (February 2004), hosted by NFA, Denmark's National Research Centre for
46
+ * the Working Environment. Rights: no first-party grant exists — read the
47
+ * SOURCES.md entry before shipping this commercially.
48
+ */
49
+ exports.cbi = {
50
+ id: "cbi",
51
+ version: "1.0.0",
52
+ categories: ["burnout"],
53
+ audience: ["adult"],
54
+ respondent: "self",
55
+ title: {
56
+ en: "Copenhagen Burnout Inventory (CBI)",
57
+ },
58
+ description: {
59
+ en: "A 19-item measure of burnout in three separately-scored scales: personal, work-related, and client-related exhaustion.",
60
+ },
61
+ instructions: {
62
+ en: "Choose the option that best describes you. Where the questions mention clients, read the word that fits your own work — patients, students, children, or whoever you work with. Answer the client questions only if your work involves them.",
63
+ },
64
+ defaultLocale: "en",
65
+ options: frequencyOptions,
66
+ questions: [
67
+ // Part one: personal burnout (frequency scale).
68
+ { id: "cbi-1", text: { en: "How often do you feel tired?" } },
69
+ { id: "cbi-2", text: { en: "How often are you physically exhausted?" } },
70
+ { id: "cbi-3", text: { en: "How often are you emotionally exhausted?" } },
71
+ { id: "cbi-4", text: { en: "How often do you think: “I can’t take it anymore”?" } },
72
+ { id: "cbi-5", text: { en: "How often do you feel worn out?" } },
73
+ { id: "cbi-6", text: { en: "How often do you feel weak and susceptible to illness?" } },
74
+ // Part two: work-related burnout (first three on the degree scale).
75
+ { id: "cbi-7", text: { en: "Is your work emotionally exhausting?" }, options: degreeOptions },
76
+ { id: "cbi-8", text: { en: "Do you feel burnt out because of your work?" }, options: degreeOptions },
77
+ { id: "cbi-9", text: { en: "Does your work frustrate you?" }, options: degreeOptions },
78
+ { id: "cbi-10", text: { en: "Do you feel worn out at the end of the working day?" } },
79
+ { id: "cbi-11", text: { en: "Are you exhausted in the morning at the thought of another day at work?" } },
80
+ { id: "cbi-12", text: { en: "Do you feel that every working hour is tiring for you?" } },
81
+ { id: "cbi-13", text: { en: "Do you have enough energy for family and friends during leisure time?" }, reverseScored: true },
82
+ // Part three: client-related burnout (first four on the degree scale).
83
+ { id: "cbi-14", text: { en: "Do you find it hard to work with clients?" }, options: degreeOptions },
84
+ { id: "cbi-15", text: { en: "Do you find it frustrating to work with clients?" }, options: degreeOptions },
85
+ { id: "cbi-16", text: { en: "Does it drain your energy to work with clients?" }, options: degreeOptions },
86
+ { id: "cbi-17", text: { en: "Do you feel that you give more than you get back when you work with clients?" }, options: degreeOptions },
87
+ { id: "cbi-18", text: { en: "Are you tired of working with clients?" } },
88
+ { id: "cbi-19", text: { en: "Do you sometimes wonder how long you will be able to continue working with clients?" } },
89
+ ],
90
+ scoring: {
91
+ kind: "subscales",
92
+ subscales: [
93
+ {
94
+ id: "personal",
95
+ label: { en: "Personal burnout" },
96
+ questionIds: ["cbi-1", "cbi-2", "cbi-3", "cbi-4", "cbi-5", "cbi-6"],
97
+ },
98
+ {
99
+ id: "work",
100
+ label: { en: "Work-related burnout" },
101
+ questionIds: ["cbi-7", "cbi-8", "cbi-9", "cbi-10", "cbi-11", "cbi-12", "cbi-13"],
102
+ },
103
+ {
104
+ id: "client",
105
+ label: { en: "Client-related burnout" },
106
+ questionIds: ["cbi-14", "cbi-15", "cbi-16", "cbi-17", "cbi-18", "cbi-19"],
107
+ },
108
+ ],
109
+ missing: { strategy: "prorate", minAnswered: 4 },
110
+ },
111
+ meta: {
112
+ reference: "Kristensen, T. S., Borritz, M., Villadsen, E., & Christensen, K. B. (2005). The Copenhagen Burnout Inventory: A new tool for the assessment of burnout. Work & Stress, 19(3), 192-207.",
113
+ source: "Item text reproduced from the authors' own English first edition (February 2004), Marianne Borritz and Tage S. Kristensen, National Institute of Occupational Health, Copenhagen; hosted by NFA (Det Nationale Forskningscenter for Arbejdsmiljoe).",
114
+ license: "Free with conditions - no first-party grant exists. NFA, Denmark's national occupational-health research institute, hosts the complete instrument publicly with no gatekeeping, and an independent peer-reviewed validation study describes it as a public domain questionnaire; but neither the instrument nor any rights holder's own statement grants redistribution. See SOURCES.md for exactly what supports this and what is missing.",
115
+ licenseFlag: "free-with-conditions",
116
+ translationProvenance: "en: reproduced from the authors' own English edition. The instrument was developed in Danish for the PUMA study; the English text is the authors' own, not a third-party translation. Other locales (tr, de, zh, es): AI translation (Anthropic Claude, claude-opus-5) from that English; official translations were not consulted and the texts are unverified. See SOURCES.md.",
117
+ scoringNote: "Each scale is scored separately as the mean of its items on 0-100. psytools reports sums; divide by 6 (personal), 7 (work), and 6 (client).",
118
+ definitions: "Personal burnout: a state of prolonged physical and psychological exhaustion. Work-related burnout: the same, perceived as related to the person's work. Client-related burnout: the same, perceived as related to the person's work with clients.",
119
+ presentationNote: "The authors instruct that the items should not be presented in the printed order and may be interleaved with questions on other topics, to avoid stereotyped response patterns. psytools keeps the published order so the definition stays checkable against the source; shuffle at presentation time if you follow the recommendation.",
120
+ missingDataNote: "The authors' own rule classifies a respondent as a non-responder below 3 of 6 answered (personal), 4 of 7 (work), and 3 of 6 (client). A single policy cannot carry three thresholds, so minAnswered is pinned to 4 - stricter than the authors on the two 6-item scales, which fails safe by refusing to score rather than scoring thin data.",
121
+ },
122
+ };
@@ -0,0 +1,10 @@
1
+ import type { AssessmentDefinition } from "../types.ts";
2
+ /**
3
+ * CSI-16 — Couples Satisfaction Index, 16-item version.
4
+ *
5
+ * 16 items on four different answer scales, total 0–81, higher is more
6
+ * satisfied; below 51.5 suggests notable dissatisfaction. Freely
7
+ * available for clinical and research use per the authors' own form;
8
+ * commercial use is not addressed either way — see SOURCES.md.
9
+ */
10
+ export declare const csi16: AssessmentDefinition;
@@ -0,0 +1,160 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.csi16 = void 0;
4
+ /** Descending 5–0 scale: the pole named first on the form scores highest. */
5
+ const descending = [5, 4, 3, 2, 1, 0].map((value) => ({
6
+ value,
7
+ label: { en: String(value) },
8
+ }));
9
+ /** Ascending 0–5 scale, for the two pairs the form prints the other way round. */
10
+ const ascending = [0, 1, 2, 3, 4, 5].map((value) => ({
11
+ value,
12
+ label: { en: String(value) },
13
+ }));
14
+ const labelled = (labels, values) => labels.map((label, i) => ({ value: values[i], label: { en: label } }));
15
+ /**
16
+ * CSI-16 — Couples Satisfaction Index, 16-item version.
17
+ *
18
+ * 16 items on four different answer scales, total 0–81, higher is more
19
+ * satisfied; below 51.5 suggests notable dissatisfaction. Freely
20
+ * available for clinical and research use per the authors' own form;
21
+ * commercial use is not addressed either way — see SOURCES.md.
22
+ */
23
+ exports.csi16 = {
24
+ id: "csi16",
25
+ version: "1.0.0",
26
+ categories: ["relationships"],
27
+ audience: ["adult"],
28
+ respondent: "self",
29
+ title: {
30
+ en: "Couples Satisfaction Index (CSI-16)",
31
+ },
32
+ description: {
33
+ en: "A 16-item self-report measure of relationship satisfaction, built with item response theory for precision in the dissatisfied range.",
34
+ },
35
+ instructions: {
36
+ en: "For each of the following items, select the answer that best describes how you feel about your relationship. Base your responses on your first impressions and immediate feelings about the item.",
37
+ },
38
+ defaultLocale: "en",
39
+ // Most items use the 0-5 "Not at all ... Completely" scale; the rest
40
+ // carry their own, so the assessment-level scale is that one.
41
+ options: labelled(["Not at all", "A little", "Somewhat", "Mostly", "Almost Completely", "Completely"], [0, 1, 2, 3, 4, 5]),
42
+ questions: [
43
+ {
44
+ id: "csi16-1",
45
+ text: {
46
+ en: "Please indicate the degree of happiness, all things considered, of your relationship.",
47
+ },
48
+ options: labelled([
49
+ "Extremely Unhappy",
50
+ "Fairly Unhappy",
51
+ "A Little Unhappy",
52
+ "Happy",
53
+ "Very Happy",
54
+ "Extremely Happy",
55
+ "Perfect",
56
+ ], [0, 1, 2, 3, 4, 5, 6]),
57
+ },
58
+ {
59
+ id: "csi16-2",
60
+ text: {
61
+ en: "In general, how often do you think that things between you and your partner are going well?",
62
+ },
63
+ options: labelled([
64
+ "All the time",
65
+ "Most of the time",
66
+ "More often than not",
67
+ "Occasionally",
68
+ "Rarely",
69
+ "Never",
70
+ ], [5, 4, 3, 2, 1, 0]),
71
+ },
72
+ {
73
+ id: "csi16-3",
74
+ text: { en: "Our relationship is strong" },
75
+ options: labelled([
76
+ "Not at all TRUE",
77
+ "A little TRUE",
78
+ "Somewhat TRUE",
79
+ "Mostly TRUE",
80
+ "Almost Completely TRUE",
81
+ "Completely TRUE",
82
+ ], [0, 1, 2, 3, 4, 5]),
83
+ },
84
+ {
85
+ id: "csi16-4",
86
+ text: { en: "My relationship with my partner makes me happy" },
87
+ options: labelled([
88
+ "Not at all TRUE",
89
+ "A little TRUE",
90
+ "Somewhat TRUE",
91
+ "Mostly TRUE",
92
+ "Almost Completely TRUE",
93
+ "Completely TRUE",
94
+ ], [0, 1, 2, 3, 4, 5]),
95
+ },
96
+ {
97
+ id: "csi16-5",
98
+ text: { en: "I have a warm and comfortable relationship with my partner" },
99
+ options: labelled([
100
+ "Not at all TRUE",
101
+ "A little TRUE",
102
+ "Somewhat TRUE",
103
+ "Mostly TRUE",
104
+ "Almost Completely TRUE",
105
+ "Completely TRUE",
106
+ ], [0, 1, 2, 3, 4, 5]),
107
+ },
108
+ {
109
+ id: "csi16-6",
110
+ text: { en: "I really feel like part of a team with my partner" },
111
+ options: labelled([
112
+ "Not at all TRUE",
113
+ "A little TRUE",
114
+ "Somewhat TRUE",
115
+ "Mostly TRUE",
116
+ "Almost Completely TRUE",
117
+ "Completely TRUE",
118
+ ], [0, 1, 2, 3, 4, 5]),
119
+ },
120
+ { id: "csi16-7", text: { en: "How rewarding is your relationship with your partner?" } },
121
+ { id: "csi16-8", text: { en: "How well does your partner meet your needs?" } },
122
+ {
123
+ id: "csi16-9",
124
+ text: { en: "To what extent has your relationship met your original expectations?" },
125
+ },
126
+ { id: "csi16-10", text: { en: "In general, how satisfied are you with your relationship?" } },
127
+ { id: "csi16-11", text: { en: "INTERESTING — BORING" }, options: descending },
128
+ { id: "csi16-12", text: { en: "BAD — GOOD" }, options: ascending },
129
+ { id: "csi16-13", text: { en: "FULL — EMPTY" }, options: descending },
130
+ { id: "csi16-14", text: { en: "STURDY — FRAGILE" }, options: descending },
131
+ { id: "csi16-15", text: { en: "DISCOURAGING — HOPEFUL" }, options: ascending },
132
+ { id: "csi16-16", text: { en: "ENJOYABLE — MISERABLE" }, options: descending },
133
+ ],
134
+ scoring: {
135
+ kind: "sum",
136
+ missing: { strategy: "require-complete" },
137
+ bands: [
138
+ {
139
+ id: "dissatisfied",
140
+ min: 0,
141
+ max: 51,
142
+ label: { en: "Notable relationship dissatisfaction" },
143
+ },
144
+ {
145
+ id: "satisfied",
146
+ min: 52,
147
+ max: 81,
148
+ label: { en: "No notable relationship dissatisfaction" },
149
+ },
150
+ ],
151
+ },
152
+ meta: {
153
+ reference: "Funk, J. L., & Rogge, R. D. (2007). Testing the ruler with item response theory: Increasing precision of measurement for relationship satisfaction with the Couples Satisfaction Index. Journal of Family Psychology, 21(4), 572-583.",
154
+ license: "Free with conditions — the authors state the CSI scales are freely available for use in both clinical and research settings with no additional permission necessary; commercial use is not addressed either way",
155
+ licenseFlag: "free-with-conditions",
156
+ translationProvenance: "en: transcribed from the authors' own CSI-16 form, https://couples-research.com/measures/. Other locales (tr, de, zh, es): AI translation (Anthropic Claude, claude-opus-5) from the original English; published adaptations were not consulted and the texts are unverified. See SOURCES.md.",
157
+ scoringNote: "Sum 0-81, higher is more satisfied — the opposite direction from every other bundled inventory, where a higher score means more of a problem. The authors' cutoff is 51.5, so the bundled bands split at 51/52. Four different answer scales are in play, which is why most items carry their own `options`: item 1 is a 7-point 0-6 happiness scale, item 2 runs 5 down to 0, items 3-6 are 0-5 agreement, items 7-10 are the 0-5 assessment-level scale, and items 11-16 are semantic differentials.",
158
+ renderingNote: "Items 11-16 are semantic differentials: two opposing words with six unlabelled positions between them. The `text` carries both poles in the order the authors print them, left to right, and the six options are labelled with the position numbers as they appear on the authors' own form. The authors note that when they administer the scale they replace those numbers with blank circles or radio buttons; a renderer wanting that should draw the poles from `text` at each end of a row of six controls, keyed by option position. `instructions` carries the only instruction line printed on the form, which on paper introduces items 11-16; items 1-10 carry self-contained stems and need none.",
159
+ },
160
+ };
@@ -0,0 +1,12 @@
1
+ import type { AssessmentDefinition } from "../types.ts";
2
+ /**
3
+ * EAT-26 — Eating Attitudes Test, 26-item version.
4
+ *
5
+ * 26 items, total 0–78, referral recommended at 20 or above. psytools
6
+ * bundles Part B of Garner's form (the 26 scored items); the BMI section
7
+ * and the five behavioural questions of Parts A and C are part of his
8
+ * wider screening protocol, not of the EAT-26 score, and are not shipped.
9
+ * Free for individual use; commercial web platforms that charge user fees
10
+ * need a licensing agreement from the copyright holder — see SOURCES.md.
11
+ */
12
+ export declare const eat26: AssessmentDefinition;