psytools 0.5.2 → 0.5.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -12
- package/SOURCES.md +116 -8
- package/dist/cjs/index.d.ts +2 -2
- package/dist/cjs/index.js +10 -1
- package/dist/cjs/inventories/aq10.js +3 -0
- package/dist/cjs/inventories/asrs6.d.ts +12 -5
- package/dist/cjs/inventories/asrs6.js +17 -6
- package/dist/cjs/inventories/audit.js +3 -0
- package/dist/cjs/inventories/cesd.d.ts +11 -0
- package/dist/cjs/inventories/cesd.js +207 -0
- package/dist/cjs/inventories/common.d.ts +11 -0
- package/dist/cjs/inventories/common.js +26 -1
- package/dist/cjs/inventories/dass21.js +3 -0
- package/dist/cjs/inventories/ecr-r.d.ts +16 -0
- package/dist/cjs/inventories/ecr-r.js +114 -0
- package/dist/cjs/inventories/erq.d.ts +16 -0
- package/dist/cjs/inventories/erq.js +79 -0
- package/dist/cjs/inventories/flourishing.d.ts +12 -0
- package/dist/cjs/inventories/flourishing.js +53 -0
- package/dist/cjs/inventories/gad7.js +3 -0
- package/dist/cjs/inventories/hsps.d.ts +14 -0
- package/dist/cjs/inventories/hsps.js +83 -0
- package/dist/cjs/inventories/index.d.ts +11 -2
- package/dist/cjs/inventories/index.js +28 -1
- package/dist/cjs/inventories/k10.d.ts +12 -0
- package/dist/cjs/inventories/k10.js +62 -0
- package/dist/cjs/inventories/k6.d.ts +12 -0
- package/dist/cjs/inventories/k6.js +57 -0
- package/dist/cjs/inventories/mini-ipip.js +3 -0
- package/dist/cjs/inventories/phq9.js +3 -0
- package/dist/cjs/inventories/rses.d.ts +11 -0
- package/dist/cjs/inventories/rses.js +63 -0
- package/dist/cjs/inventories/swls.d.ts +12 -0
- package/dist/cjs/inventories/swls.js +59 -0
- package/dist/cjs/inventories/who5.js +3 -0
- package/dist/cjs/locales/de/cesd.d.ts +4 -0
- package/dist/cjs/locales/de/cesd.js +43 -0
- package/dist/cjs/locales/de/erq.d.ts +4 -0
- package/dist/cjs/locales/de/erq.js +36 -0
- package/dist/cjs/locales/de/flourishing.d.ts +4 -0
- package/dist/cjs/locales/de/flourishing.js +30 -0
- package/dist/cjs/locales/de/k10.d.ts +4 -0
- package/dist/cjs/locales/de/k10.js +36 -0
- package/dist/cjs/locales/de/k6.d.ts +4 -0
- package/dist/cjs/locales/de/k6.js +31 -0
- package/dist/cjs/locales/de/rses.d.ts +4 -0
- package/dist/cjs/locales/de/rses.js +34 -0
- package/dist/cjs/locales/de/swls.d.ts +4 -0
- package/dist/cjs/locales/de/swls.js +36 -0
- package/dist/cjs/locales/es/cesd.d.ts +4 -0
- package/dist/cjs/locales/es/cesd.js +43 -0
- package/dist/cjs/locales/es/erq.d.ts +4 -0
- package/dist/cjs/locales/es/erq.js +36 -0
- package/dist/cjs/locales/es/flourishing.d.ts +4 -0
- package/dist/cjs/locales/es/flourishing.js +46 -0
- package/dist/cjs/locales/es/k10.d.ts +4 -0
- package/dist/cjs/locales/es/k10.js +56 -0
- package/dist/cjs/locales/es/k6.d.ts +4 -0
- package/dist/cjs/locales/es/k6.js +43 -0
- package/dist/cjs/locales/es/rses.d.ts +4 -0
- package/dist/cjs/locales/es/rses.js +54 -0
- package/dist/cjs/locales/es/swls.d.ts +4 -0
- package/dist/cjs/locales/es/swls.js +46 -0
- package/dist/cjs/locales/index.js +51 -0
- package/dist/cjs/locales/tr/cesd.d.ts +4 -0
- package/dist/cjs/locales/tr/cesd.js +43 -0
- package/dist/cjs/locales/tr/ecr-r.d.ts +12 -0
- package/dist/cjs/locales/tr/ecr-r.js +70 -0
- package/dist/cjs/locales/tr/erq.d.ts +10 -0
- package/dist/cjs/locales/tr/erq.js +42 -0
- package/dist/cjs/locales/tr/flourishing.d.ts +4 -0
- package/dist/cjs/locales/tr/flourishing.js +46 -0
- package/dist/cjs/locales/tr/hsps.d.ts +10 -0
- package/dist/cjs/locales/tr/hsps.js +55 -0
- package/dist/cjs/locales/tr/k10.d.ts +4 -0
- package/dist/cjs/locales/tr/k10.js +56 -0
- package/dist/cjs/locales/tr/k6.d.ts +4 -0
- package/dist/cjs/locales/tr/k6.js +43 -0
- package/dist/cjs/locales/tr/rses.d.ts +4 -0
- package/dist/cjs/locales/tr/rses.js +54 -0
- package/dist/cjs/locales/tr/swls.d.ts +4 -0
- package/dist/cjs/locales/tr/swls.js +46 -0
- package/dist/cjs/locales/zh/cesd.d.ts +4 -0
- package/dist/cjs/locales/zh/cesd.js +43 -0
- package/dist/cjs/locales/zh/erq.d.ts +4 -0
- package/dist/cjs/locales/zh/erq.js +36 -0
- package/dist/cjs/locales/zh/flourishing.d.ts +4 -0
- package/dist/cjs/locales/zh/flourishing.js +46 -0
- package/dist/cjs/locales/zh/k10.d.ts +4 -0
- package/dist/cjs/locales/zh/k10.js +56 -0
- package/dist/cjs/locales/zh/k6.d.ts +4 -0
- package/dist/cjs/locales/zh/k6.js +43 -0
- package/dist/cjs/locales/zh/rses.d.ts +4 -0
- package/dist/cjs/locales/zh/rses.js +54 -0
- package/dist/cjs/locales/zh/swls.d.ts +4 -0
- package/dist/cjs/locales/zh/swls.js +46 -0
- package/dist/cjs/types.d.ts +52 -0
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +1 -1
- package/dist/esm/inventories/aq10.js +3 -0
- package/dist/esm/inventories/asrs6.d.ts +12 -5
- package/dist/esm/inventories/asrs6.js +17 -6
- package/dist/esm/inventories/audit.js +3 -0
- package/dist/esm/inventories/cesd.d.ts +11 -0
- package/dist/esm/inventories/cesd.js +204 -0
- package/dist/esm/inventories/common.d.ts +11 -0
- package/dist/esm/inventories/common.js +25 -0
- package/dist/esm/inventories/dass21.js +3 -0
- package/dist/esm/inventories/ecr-r.d.ts +16 -0
- package/dist/esm/inventories/ecr-r.js +111 -0
- package/dist/esm/inventories/erq.d.ts +16 -0
- package/dist/esm/inventories/erq.js +76 -0
- package/dist/esm/inventories/flourishing.d.ts +12 -0
- package/dist/esm/inventories/flourishing.js +50 -0
- package/dist/esm/inventories/gad7.js +3 -0
- package/dist/esm/inventories/hsps.d.ts +14 -0
- package/dist/esm/inventories/hsps.js +80 -0
- package/dist/esm/inventories/index.d.ts +11 -2
- package/dist/esm/inventories/index.js +19 -1
- package/dist/esm/inventories/k10.d.ts +12 -0
- package/dist/esm/inventories/k10.js +59 -0
- package/dist/esm/inventories/k6.d.ts +12 -0
- package/dist/esm/inventories/k6.js +54 -0
- package/dist/esm/inventories/mini-ipip.js +3 -0
- package/dist/esm/inventories/phq9.js +3 -0
- package/dist/esm/inventories/rses.d.ts +11 -0
- package/dist/esm/inventories/rses.js +60 -0
- package/dist/esm/inventories/swls.d.ts +12 -0
- package/dist/esm/inventories/swls.js +56 -0
- package/dist/esm/inventories/who5.js +3 -0
- package/dist/esm/locales/de/cesd.d.ts +4 -0
- package/dist/esm/locales/de/cesd.js +41 -0
- package/dist/esm/locales/de/erq.d.ts +4 -0
- package/dist/esm/locales/de/erq.js +34 -0
- package/dist/esm/locales/de/flourishing.d.ts +4 -0
- package/dist/esm/locales/de/flourishing.js +28 -0
- package/dist/esm/locales/de/k10.d.ts +4 -0
- package/dist/esm/locales/de/k10.js +34 -0
- package/dist/esm/locales/de/k6.d.ts +4 -0
- package/dist/esm/locales/de/k6.js +29 -0
- package/dist/esm/locales/de/rses.d.ts +4 -0
- package/dist/esm/locales/de/rses.js +32 -0
- package/dist/esm/locales/de/swls.d.ts +4 -0
- package/dist/esm/locales/de/swls.js +34 -0
- package/dist/esm/locales/es/cesd.d.ts +4 -0
- package/dist/esm/locales/es/cesd.js +41 -0
- package/dist/esm/locales/es/erq.d.ts +4 -0
- package/dist/esm/locales/es/erq.js +34 -0
- package/dist/esm/locales/es/flourishing.d.ts +4 -0
- package/dist/esm/locales/es/flourishing.js +44 -0
- package/dist/esm/locales/es/k10.d.ts +4 -0
- package/dist/esm/locales/es/k10.js +54 -0
- package/dist/esm/locales/es/k6.d.ts +4 -0
- package/dist/esm/locales/es/k6.js +41 -0
- package/dist/esm/locales/es/rses.d.ts +4 -0
- package/dist/esm/locales/es/rses.js +52 -0
- package/dist/esm/locales/es/swls.d.ts +4 -0
- package/dist/esm/locales/es/swls.js +44 -0
- package/dist/esm/locales/index.js +51 -0
- package/dist/esm/locales/tr/cesd.d.ts +4 -0
- package/dist/esm/locales/tr/cesd.js +41 -0
- package/dist/esm/locales/tr/ecr-r.d.ts +12 -0
- package/dist/esm/locales/tr/ecr-r.js +68 -0
- package/dist/esm/locales/tr/erq.d.ts +10 -0
- package/dist/esm/locales/tr/erq.js +40 -0
- package/dist/esm/locales/tr/flourishing.d.ts +4 -0
- package/dist/esm/locales/tr/flourishing.js +44 -0
- package/dist/esm/locales/tr/hsps.d.ts +10 -0
- package/dist/esm/locales/tr/hsps.js +53 -0
- package/dist/esm/locales/tr/k10.d.ts +4 -0
- package/dist/esm/locales/tr/k10.js +54 -0
- package/dist/esm/locales/tr/k6.d.ts +4 -0
- package/dist/esm/locales/tr/k6.js +41 -0
- package/dist/esm/locales/tr/rses.d.ts +4 -0
- package/dist/esm/locales/tr/rses.js +52 -0
- package/dist/esm/locales/tr/swls.d.ts +4 -0
- package/dist/esm/locales/tr/swls.js +44 -0
- package/dist/esm/locales/zh/cesd.d.ts +4 -0
- package/dist/esm/locales/zh/cesd.js +41 -0
- package/dist/esm/locales/zh/erq.d.ts +4 -0
- package/dist/esm/locales/zh/erq.js +34 -0
- package/dist/esm/locales/zh/flourishing.d.ts +4 -0
- package/dist/esm/locales/zh/flourishing.js +44 -0
- package/dist/esm/locales/zh/k10.d.ts +4 -0
- package/dist/esm/locales/zh/k10.js +54 -0
- package/dist/esm/locales/zh/k6.d.ts +4 -0
- package/dist/esm/locales/zh/k6.js +41 -0
- package/dist/esm/locales/zh/rses.d.ts +4 -0
- package/dist/esm/locales/zh/rses.js +52 -0
- package/dist/esm/locales/zh/swls.d.ts +4 -0
- package/dist/esm/locales/zh/swls.js +44 -0
- package/dist/esm/types.d.ts +52 -0
- package/package.json +18 -2
- package/schema/assessment-definition.schema.json +16 -0
- package/src/index.ts +12 -0
- package/src/inventories/aq10.ts +3 -0
- package/src/inventories/asrs6.ts +18 -6
- package/src/inventories/audit.ts +3 -0
- package/src/inventories/cesd.ts +210 -0
- package/src/inventories/common.ts +27 -0
- package/src/inventories/dass21.ts +3 -0
- package/src/inventories/ecr-r.ts +119 -0
- package/src/inventories/erq.ts +83 -0
- package/src/inventories/flourishing.ts +56 -0
- package/src/inventories/gad7.ts +3 -0
- package/src/inventories/hsps.ts +88 -0
- package/src/inventories/index.ts +29 -2
- package/src/inventories/k10.ts +64 -0
- package/src/inventories/k6.ts +59 -0
- package/src/inventories/mini-ipip.ts +3 -0
- package/src/inventories/phq9.ts +3 -0
- package/src/inventories/rses.ts +66 -0
- package/src/inventories/swls.ts +62 -0
- package/src/inventories/who5.ts +3 -0
- package/src/locales/de/cesd.ts +44 -0
- package/src/locales/de/erq.ts +37 -0
- package/src/locales/de/flourishing.ts +31 -0
- package/src/locales/de/k10.ts +37 -0
- package/src/locales/de/k6.ts +32 -0
- package/src/locales/de/rses.ts +35 -0
- package/src/locales/de/swls.ts +37 -0
- package/src/locales/es/cesd.ts +44 -0
- package/src/locales/es/erq.ts +37 -0
- package/src/locales/es/flourishing.ts +47 -0
- package/src/locales/es/k10.ts +57 -0
- package/src/locales/es/k6.ts +44 -0
- package/src/locales/es/rses.ts +55 -0
- package/src/locales/es/swls.ts +47 -0
- package/src/locales/index.ts +51 -0
- package/src/locales/tr/cesd.ts +44 -0
- package/src/locales/tr/ecr-r.ts +71 -0
- package/src/locales/tr/erq.ts +43 -0
- package/src/locales/tr/flourishing.ts +47 -0
- package/src/locales/tr/hsps.ts +56 -0
- package/src/locales/tr/k10.ts +57 -0
- package/src/locales/tr/k6.ts +44 -0
- package/src/locales/tr/rses.ts +55 -0
- package/src/locales/tr/swls.ts +47 -0
- package/src/locales/zh/cesd.ts +44 -0
- package/src/locales/zh/erq.ts +37 -0
- package/src/locales/zh/flourishing.ts +47 -0
- package/src/locales/zh/k10.ts +57 -0
- package/src/locales/zh/k6.ts +44 -0
- package/src/locales/zh/rses.ts +55 -0
- package/src/locales/zh/swls.ts +47 -0
- package/src/types.ts +69 -0
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** —
|
|
22
|
+
- **Batteries included** — seventeen instruments (PHQ-9, GAD-7, DASS-21, WHO-5, ASRS, AQ-10, AUDIT, Mini-IPIP, CES-D, ECR-R, ERQ, HSPS, SWLS, Flourishing, K10, K6, RSES) 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.
|
|
@@ -81,16 +81,27 @@ const response = AssessmentResponse.parse(assessment, rowFromDb); // answers re-
|
|
|
81
81
|
|
|
82
82
|
## Predefined inventories
|
|
83
83
|
|
|
84
|
-
| Id | Instrument | Items | Scoring | Locales |
|
|
85
|
-
| --- | --- | --- | --- | --- |
|
|
86
|
-
| `phq9` | Patient Health Questionnaire-9 (depression) | 9 | Sum 0–27, 5 severity bands, item-9 suicidality flag | en, tr, de, zh, es |
|
|
87
|
-
| `gad7` | Generalized Anxiety Disorder-7 | 7 | Sum 0–21, 4 severity bands | en, tr, de, zh, es |
|
|
88
|
-
| `dass21` | Depression Anxiety Stress Scales (short form) | 21 | 3 subscales × 7 items, sums doubled, banded per subscale | en, tr, de, zh, es |
|
|
89
|
-
| `who5` | WHO-5 Well-Being Index | 5 | Sum × 4 → 0–100 (higher is better), 3 well-being bands | en, tr, de, zh, es |
|
|
90
|
-
| `asrs6` | Adult ADHD Self-Report Scale (ASRS-v1.1) screener | 6 | Count of screen-positive items (per-item thresholds), ≥4 positive | en, tr, de, zh, es |
|
|
91
|
-
| `aq10` | Autism Spectrum Quotient (AQ-10, adult) | 10 | 1 point per item in trait direction (agree/disagree), ≥6 refer | en, tr, de, zh, es |
|
|
92
|
-
| `audit` | Alcohol Use Disorders Identification Test (WHO) | 10 | Sum 0–40 with per-question point systems, 4 WHO risk zones | en, tr, de, zh, es |
|
|
93
|
-
| `mini-ipip` | Mini-IPIP Big Five personality scale | 20 | 5 trait subscales (4–20 each), reverse-keyed items, no cutoffs | en, tr, de, zh, es |
|
|
84
|
+
| Id | Instrument | Category | Items | Scoring | Locales |
|
|
85
|
+
| --- | --- | --- | --- | --- | --- |
|
|
86
|
+
| `phq9` | Patient Health Questionnaire-9 (depression) | depression | 9 | Sum 0–27, 5 severity bands, item-9 suicidality flag | en, tr, de, zh, es |
|
|
87
|
+
| `gad7` | Generalized Anxiety Disorder-7 | anxiety | 7 | Sum 0–21, 4 severity bands | en, tr, de, zh, es |
|
|
88
|
+
| `dass21` | Depression Anxiety Stress Scales (short form) | depression, anxiety, stress | 21 | 3 subscales × 7 items, sums doubled, banded per subscale | en, tr, de, zh, es |
|
|
89
|
+
| `who5` | WHO-5 Well-Being Index | well-being | 5 | Sum × 4 → 0–100 (higher is better), 3 well-being bands | en, tr, de, zh, es |
|
|
90
|
+
| `asrs6` | Adult ADHD Self-Report Scale (ASRS-v1.1) screener | adhd | 6 | Count of screen-positive items (per-item thresholds), ≥4 positive | en, tr, de, zh, es |
|
|
91
|
+
| `aq10` | Autism Spectrum Quotient (AQ-10, adult) | autism | 10 | 1 point per item in trait direction (agree/disagree), ≥6 refer | en, tr, de, zh, es |
|
|
92
|
+
| `audit` | Alcohol Use Disorders Identification Test (WHO) | substance-use | 10 | Sum 0–40 with per-question point systems, 4 WHO risk zones | en, tr, de, zh, es |
|
|
93
|
+
| `mini-ipip` | Mini-IPIP Big Five personality scale | personality | 20 | 5 trait subscales (4–20 each), reverse-keyed items, no cutoffs | en, tr, de, zh, es |
|
|
94
|
+
| `cesd` | Center for Epidemiologic Studies Depression Scale (CES-D) | depression | 20 | Sum 0–60, 4 reverse-keyed items, elevated at ≥16 | en, tr, de, zh, es |
|
|
95
|
+
| `ecr-r` | Experiences in Close Relationships-Revised (adult attachment) | attachment, relationships | 36 | 2 subscales × 18 items (anxiety, avoidance), 14 reverse-keyed, no cutoffs | en, tr¹ |
|
|
96
|
+
| `erq` | Emotion Regulation Questionnaire | emotion-regulation | 10 | 2 subscales (reappraisal 6, suppression 4), no reversals, no cutoffs | en, tr, de, zh, es |
|
|
97
|
+
| `hsps` | Highly Sensitive Person Scale | sensory-processing, personality | 27 | Sum 27–189, no reversals, no cutoffs | en, tr¹ |
|
|
98
|
+
| `swls` | Satisfaction with Life Scale | well-being | 5 | Sum 5–35, Diener's 7 score groupings | en, tr, de, zh, es |
|
|
99
|
+
| `flourishing` | Flourishing Scale | well-being | 8 | Sum 8–56, no cutoffs | en, tr, de, zh, es |
|
|
100
|
+
| `k10` | Kessler Psychological Distress Scale (K10) | distress | 10 | Sum 10–50 (1–5 coding), 4 severity bands | en, tr, de, zh, es |
|
|
101
|
+
| `k6` | Kessler Psychological Distress Scale (K6) | distress | 6 | Sum 0–24 (0–4 coding), ≥13 serious distress | en, tr, de, zh, es |
|
|
102
|
+
| `rses` | Rosenberg Self-Esteem Scale | self-esteem | 10 | Sum 0–30, 5 reverse-keyed items, 15–25 normal range | en, tr, de, zh, es |
|
|
103
|
+
|
|
104
|
+
¹ 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.
|
|
94
105
|
|
|
95
106
|
```ts
|
|
96
107
|
import { loadInventory, inventories, dass21 } from "psytools";
|
|
@@ -110,6 +121,14 @@ const result = assessment.evaluate(response);
|
|
|
110
121
|
// ], flags: [] }
|
|
111
122
|
```
|
|
112
123
|
|
|
124
|
+
### Filtering metadata
|
|
125
|
+
|
|
126
|
+
Every definition carries three optional fields for picking the right instrument: `categories` (what it measures — e.g. `inventories` entries with `categories.includes("depression")`), `audience` (the age band(s) it is written and validated for — `adult`, `adolescent`, `child`), and `respondent` (whose report the answers are — `self`, `parent`, `teacher`, `clinician`). Bundled inventories draw from the vocabularies exported as `InventoryCategory`, `InventoryAudience`, and `InventoryRespondent`; the fields themselves are plain strings, so your own definitions can use their own taxonomy.
|
|
127
|
+
|
|
128
|
+
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.
|
|
129
|
+
|
|
130
|
+
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"]`.
|
|
131
|
+
|
|
113
132
|
## Defining your own assessment
|
|
114
133
|
|
|
115
134
|
An assessment is one plain object — questions, an enumerated option scale, and optional declarative scoring:
|
|
@@ -262,7 +281,8 @@ npm run build # ESM + CJS + type declarations into dist/
|
|
|
262
281
|
|
|
263
282
|
- **Not a diagnostic tool.** Scores, severity bands, and flags implement the published scoring rules of screening instruments; they are not diagnoses and do not replace clinical judgment.
|
|
264
283
|
- **Crisis-relevant answers.** PHQ-9 item 9 raises a `suicidality` flag — applications should surface this to a responsible clinician and provide crisis resources to respondents.
|
|
265
|
-
- **Instrument licensing.** [SOURCES.md](SOURCES.md)
|
|
284
|
+
- **Instrument licensing.** [SOURCES.md](SOURCES.md) records who holds the rights to each bundled instrument and flags it **Free** (PHQ-9, GAD-7, DASS-21, WHO-5, AUDIT, Mini-IPIP, CES-D, K10, K6 — usable without permission, including commercially), **Free with conditions** (ASRS screener, AQ-10, SWLS, Flourishing Scale, RSES — free as distributed, but the conditions differ per instrument: the ASRS screener requires attribution, the AQ-10's commercial terms are unstated), or **Research only** (ECR-R, ERQ, HSPS — not licensed for clinical products or personnel selection). Each inventory's `meta.licenseFlag` carries the flag programmatically; read the instrument's section before shipping it.
|
|
285
|
+
- **Required attribution.** Where a license fixes the exact credit line that must be displayed, the inventory carries it verbatim in `meta.attribution` — render it wherever the instrument or its results appear. Today only `asrs6` sets it (© New York University and the President and Fellows of Harvard College). It is deliberately separate from `meta.reference`, which is the scientific citation: an academic reference is not a copyright attribution, and only one of the two is a license obligation.
|
|
266
286
|
- **Translation provenance.** English texts are reproduced from the original instruments. Turkish, German, Simplified Chinese, and Spanish texts are AI translations (Anthropic Claude, model `claude-fable-5`) of the original English — official translations were **not** consulted and the texts are unverified. This status is documentation-only: psytools does not track or expose per-pack verification programmatically (no `verified` field, no gating option, no status API) — read [SOURCES.md](SOURCES.md) and decide for yourself whether the bundled wording is fit for your use case. If it isn't for a specific item, use [local overrides](#local-translation-overrides) rather than forking the package. Obtain and compare the official version for your language before clinical use. Corrections: <samed@luckys.dev>.
|
|
267
287
|
|
|
268
288
|
## License
|
package/SOURCES.md
CHANGED
|
@@ -9,20 +9,22 @@ psytools is integrated into real products, so this file states precisely — per
|
|
|
9
9
|
| Flag | Meaning |
|
|
10
10
|
| --- | --- |
|
|
11
11
|
| **Free** | Public domain or explicitly free for any use, including commercial products, without permission. |
|
|
12
|
-
| **Free with conditions** | Free
|
|
13
|
-
| **Research only** | Usable in research contexts only
|
|
12
|
+
| **Free with conditions** | Free to use as distributed, but the rights holder attaches conditions — mandatory attribution, limits on modification, or commercial terms that are simply unstated. The conditions differ per instrument, so read that instrument's section below before shipping. |
|
|
13
|
+
| **Research only** | Usable in non-commercial research contexts only; not licensed for clinical products, diagnosis, or personnel selection. Carried by the ECR-R, ERQ, and HSPS — see their sections. |
|
|
14
14
|
|
|
15
15
|
## Translation provenance — read this before clinical use
|
|
16
16
|
|
|
17
|
-
The same provenance applies to every bundled inventory
|
|
17
|
+
The same provenance applies to every bundled inventory **except where an inventory's section below states otherwise**. Two inventories deviate: the ECR-R and HSPS Turkish packs reproduce published, validated Turkish adaptations (see their sections) instead of AI translations.
|
|
18
18
|
|
|
19
19
|
| Language | Text source | Verified against an official version |
|
|
20
20
|
| --- | --- | --- |
|
|
21
21
|
| en | Reproduced from the original published instrument | Yes |
|
|
22
|
-
| tr | AI translation (Anthropic Claude
|
|
23
|
-
| de | AI translation (Anthropic Claude
|
|
24
|
-
| zh | AI translation (Anthropic Claude
|
|
25
|
-
| es | AI translation (Anthropic Claude
|
|
22
|
+
| tr | AI translation (Anthropic Claude) from the original English | No |
|
|
23
|
+
| de | AI translation (Anthropic Claude) from the original English | No |
|
|
24
|
+
| zh | AI translation (Anthropic Claude) from the original English | No |
|
|
25
|
+
| es | AI translation (Anthropic Claude) from the original English | No |
|
|
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).
|
|
26
28
|
|
|
27
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.
|
|
28
30
|
|
|
@@ -30,6 +32,17 @@ Non-English texts live as one file per inventory per language under [`src/locale
|
|
|
30
32
|
|
|
31
33
|
This table is the only place translation status is tracked — psytools has no `verified` field, no gating option, and no API to query pack status at runtime; that would overstate a confidence level nobody has confirmed. If you've corrected a specific item's wording for your own use and don't want to wait on an upstream fix, apply it locally with `loadInventory(id, { overrides })` (see the README's [local translation overrides](README.md#local-translation-overrides)) rather than forking the package — or, better, send the correction upstream so everyone benefits.
|
|
32
34
|
|
|
35
|
+
## Target audience & respondent
|
|
36
|
+
|
|
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
|
+
|
|
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"]`.
|
|
40
|
+
|
|
41
|
+
Two things `audience` and `respondent` deliberately do *not* encode:
|
|
42
|
+
|
|
43
|
+
- **The recall timeframe.** A retrospective instrument answered by an adult about their own childhood is `audience: ["adult"]`, `respondent: "self"` — the childhood framing lives in `instructions` and `meta.timeframe`, not here.
|
|
44
|
+
- **The administration mode.** An interviewer-read self-report — the K10's full interview form, for example — is still `respondent: "self"`, because the answers are the client's own report. `"clinician"` is reserved for instruments where the clinician is the informant, rating the client from their own observation.
|
|
45
|
+
|
|
33
46
|
## Missing-data policies
|
|
34
47
|
|
|
35
48
|
Bundled inventories ship with declarative missing-data policies (`scoring.missing`). **The prorating thresholds are implementation choices reflecting common research practice — they are not part of the instruments' official scoring rules.** Override by cloning the definition if your protocol differs.
|
|
@@ -42,6 +55,12 @@ Bundled inventories ship with declarative missing-data policies (`scoring.missin
|
|
|
42
55
|
| `mini-ipip` | prorate, ≥3 of 4 per trait | IPIP scoring is mean-based; prorating is equivalent |
|
|
43
56
|
| `who5`, `asrs6`, `aq10` | require-complete | Short instruments; cutoffs/counts are undefined for partial data |
|
|
44
57
|
| `audit` | ignore | Unanswered items score 0, matching the instrument's skip logic (e.g. non-drinkers skipping items 2–8) |
|
|
58
|
+
| `cesd` | prorate, ≥16 of 20 answered | Common research practice (≈80% completion) |
|
|
59
|
+
| `ecr-r` | prorate, ≥14 of 18 per subscale | Subscales are mean-based in the literature; prorating is equivalent |
|
|
60
|
+
| `erq` | require-complete | Short subscales (6 and 4 items); partial means are unstable |
|
|
61
|
+
| `hsps` | prorate, ≥21 of 27 answered | Total is mean-based in the literature; prorating is equivalent |
|
|
62
|
+
| `swls`, `flourishing`, `k10`, `k6` | require-complete | Short instruments; cutoffs are undefined for partial data (K10 note: the interview form scores skipped items 1 — see its section) |
|
|
63
|
+
| `rses` | prorate, ≥8 of 10 answered | Common research practice (80% completion) |
|
|
45
64
|
|
|
46
65
|
## PHQ-9 — Patient Health Questionnaire-9 (`phq9`)
|
|
47
66
|
|
|
@@ -87,14 +106,103 @@ Bundled inventories ship with declarative missing-data policies (`scoring.missin
|
|
|
87
106
|
|
|
88
107
|
## ASRS v1.1 — Adult ADHD Self-Report Scale, 6-item screener (`asrs6`)
|
|
89
108
|
|
|
90
|
-
**License: Free with conditions.** Copyright is held by
|
|
109
|
+
**License: Free with conditions.** Copyright is held by **New York University and the President and Fellows of Harvard College**; licensing is administered by NYU Technology Opportunities & Ventures (<https://license.tov.med.nyu.edu/product/asrs6Qscreener>). The WHO's name is in the instrument's title, not on its copyright. The licensing page states: "The screener is freely available for clinical and non-clinical use, including commercial use, but does require attribution. This is an evidence-based tool, and as such no other modifications, other than creating electronic versions, are permitted." Commercial use therefore needs no separate permission; the two conditions below are what the flag refers to.
|
|
110
|
+
|
|
111
|
+
- **Attribution is mandatory.** Display this credit line, verbatim, wherever the screener or its results appear. It ships in `meta.attribution` so applications can render it:
|
|
112
|
+
|
|
113
|
+
> The 6-question Adult Self-Report Scale-Version1.1 (ASRS-V1.1) Screener is a subset of the 18-question Adult ADHD Self-Report Scale-Version1.1 (Adult ASRSV1.1) Symptom Checklist. © New York University and the President and Fellows of Harvard College.
|
|
91
114
|
|
|
115
|
+
This is the copyright attribution the license demands, which is a different thing from the scientific citation below — hence two fields, `meta.attribution` and `meta.reference`.
|
|
116
|
+
- **Whether translation is a permitted "modification" is unresolved.** The license permits no modifications "other than creating electronic versions" and says nothing about translation in either direction. psytools ships `asrs6` in tr, de, zh, and es as AI translations, so their standing under that clause is an open question. Settling it takes a direct question to NYU TOV, which has not been put to them yet; this file will be updated when there is an answer. One fact that bears on it without settling it: NYU TOV distributes its own official translations of the screener in about fifteen languages (Arabic, Chinese, Dutch, French, German, Hebrew, Italian, Japanese, Norwegian, Portuguese, Russian, Serbian, Spanish, Swedish, Thai — Turkish is not among them). A rights holder that maintains its own translations cuts somewhat against reading third-party translation as freely permitted. The English text is unaffected either way.
|
|
92
117
|
- **Citation:** Kessler, R. C., Adler, L., Ames, M., Demler, O., Faraone, S., Hiripi, E., et al. (2005). The World Health Organization Adult ADHD Self-Report Scale (ASRS): A short screening scale for use in the general population. *Psychological Medicine, 35*(2), 245–256.
|
|
93
118
|
- **Scoring:** Count of screen-positive items (items 1–3 from "Sometimes", items 4–6 from "Often"); ≥4 positives = positive screen, per the ASRS-v1.1 screener key.
|
|
94
119
|
|
|
120
|
+
*Correction, 2026-07-29:* psytools up to and including 0.5.3 named the World Health Organization and the Workgroup on Adult ADHD as the rights holders, carried no attribution, and hedged on commercial use. All three were wrong. The record above follows the rights holder's current licensing page.
|
|
121
|
+
|
|
95
122
|
## AQ-10 — Autism Spectrum Quotient, 10-item adult version (`aq10`)
|
|
96
123
|
|
|
97
124
|
**License: Free with conditions.** Copyright is held by the Autism Research Centre (ARC), University of Cambridge. ARC distributes its measures free of charge and the AQ-10 is recommended by NICE (CG142) for adult screening in clinical practice. Commercial redistribution is not explicitly licensed — verify with ARC before shipping commercially.
|
|
98
125
|
|
|
99
126
|
- **Citation:** Allison, C., Auyeung, B., & Baron-Cohen, S. (2012). Toward brief "Red Flags" for autism screening: The Short Autism Spectrum Quotient and the Short Quantitative Checklist in 1,000 cases and 3,000 controls. *Journal of the American Academy of Child & Adolescent Psychiatry, 51*(2), 202–212.
|
|
100
127
|
- **Scoring:** 1 point per item in the trait direction (agree on items 1, 7, 8, 10; disagree on the rest); ≥6 suggests specialist referral, per Allison et al. (2012).
|
|
128
|
+
- **Audience:** Allison et al. (2012) published three AQ-10 forms — adult, adolescent, and child. psytools bundles the **adult self-report** form only (`audience: ["adult"]`, `respondent: "self"`); the adolescent and child forms are completed by a parent and are not included.
|
|
129
|
+
|
|
130
|
+
## CES-D — Center for Epidemiologic Studies Depression Scale (`cesd`)
|
|
131
|
+
|
|
132
|
+
**License: Free.** Developed by Lenore Radloff at the U.S. National Institute of Mental Health; as a work of the U.S. government it is in the public domain and may be used without permission. The English text was taken from the NIDA "Seek, Test, Treat and Retain" data harmonization packet (<https://nida.nih.gov/sites/default/files/Mental_HealthV.pdf>).
|
|
133
|
+
|
|
134
|
+
- **Citation:** Radloff, L. S. (1977). The CES-D Scale: A self-report depression scale for research in the general population. *Applied Psychological Measurement, 1*(3), 385–401.
|
|
135
|
+
- **Scoring:** Sum 0–60 with items 4, 8, 12, 16 reverse-scored. The bundled bands split at the classic cutoff — scores ≥16 indicate elevated depressive symptoms (Radloff, 1977). The cutoff screens for risk; it is not a diagnosis.
|
|
136
|
+
|
|
137
|
+
## ECR-R — Experiences in Close Relationships-Revised (`ecr-r`)
|
|
138
|
+
|
|
139
|
+
**License: Research only.** Per the authors, the items "were published in a scientific journal for use in the public domain" and may be used **in non-commercial research without permission; commercial use requires permission** (R. C. Fraley, <https://labs.psychology.illinois.edu/~rcfraley/measures/>). The Turkish adaptation is distributed at <http://www.nebisumer.com> for scientific research only — explicitly not for clinical diagnosis, psychological evaluation, or personnel selection.
|
|
140
|
+
|
|
141
|
+
- **Citation:** Fraley, R. C., Waller, N. G., & Brennan, K. A. (2000). An item response theory analysis of self-report measures of adult attachment. *Journal of Personality and Social Psychology, 78*(2), 350–365.
|
|
142
|
+
- **Turkish adaptation (validated, reproduced):** Selçuk, E., Günaydın, G., Sümer, N., & Uysal, A. (2005). Yetişkin bağlanma boyutları için yeni bir ölçüm: Yakın İlişkilerde Yaşantılar Envanteri-II'nin Türk örnekleminde psikometrik açıdan değerlendirilmesi. *Türk Psikoloji Yazıları, 8*, 1–11. The `tr` locale pack **deviates from the global provenance table**: it reproduces this published adaptation's wording (via nebisumer.com) rather than an AI translation. The Turkish source presents the same 36 items interleaved (odd = anxiety, even = avoidance); the bundled definition keeps the original English item order, with each Turkish wording attached to its matching item — the item-level reverse keys of both published versions agree under this mapping. The pack's description and final instruction sentence are adapted for on-screen rendering.
|
|
143
|
+
- **Scoring:** Two 18-item subscales (attachment anxiety: items 1–18; avoidance: items 19–36), 14 items reverse-scored. psytools reports subscale sums (18–126); the published convention is the item mean (divide by 18). No clinical cutoffs exist.
|
|
144
|
+
|
|
145
|
+
## ERQ — Emotion Regulation Questionnaire (`erq`)
|
|
146
|
+
|
|
147
|
+
**License: Research only.** Distributed by the authors free of charge for non-commercial research (Stanford Psychophysiology Laboratory, <https://spl.stanford.edu>); commercial use is not licensed.
|
|
148
|
+
|
|
149
|
+
- **Citation:** Gross, J. J., & John, O. P. (2003). Individual differences in two emotion regulation processes: Implications for affect, relationships, and well-being. *Journal of Personality and Social Psychology, 85*(2), 348–362.
|
|
150
|
+
- **Scoring:** Two subscales, no reversals: cognitive reappraisal (items 1, 3, 5, 7, 8, 10) and expressive suppression (items 2, 4, 6, 9). psytools reports sums; the published convention is item means. The authors instruct not to change the item order (items 1 and 3 define "positive emotion" and "negative emotion").
|
|
151
|
+
- **Turkish note:** A validated Turkish adaptation exists (Ulaşan Özgüle, E. T., 2011, unpublished Ph.D. dissertation, METU; distributed at nebisumer.com), but it uses a **6-point "how true of me" scale and a different item order**, so its wording cannot be attached to this 7-point agreement definition without misrepresenting the validated form. The bundled `tr` pack is therefore an AI translation like the other locales.
|
|
152
|
+
|
|
153
|
+
## HSPS — Highly Sensitive Person Scale (`hsps`)
|
|
154
|
+
|
|
155
|
+
**License: Research only.** HSP Scale © 1997 Elaine Aron; the scale is distributed for research use (see Aron & Aron, 1997, and <https://hsperson.com>). The Turkish adaptation is distributed at <http://www.nebisumer.com> for scientific research only — explicitly not for clinical diagnosis, psychological evaluation, or personnel selection.
|
|
156
|
+
|
|
157
|
+
- **Citation:** Aron, E. N., & Aron, A. (1997). Sensory-processing sensitivity and its relation to introversion and emotionality. *Journal of Personality and Social Psychology, 73*(2), 345–368.
|
|
158
|
+
- **Turkish adaptation (validated, reproduced):** Şengül-İnal, G., & Sümer, N. (2017). Exploring the multidimensional structure of sensory processing sensitivity in Turkish samples. *Current Psychology.* The `tr` locale pack **deviates from the global provenance table**: items, title, and option anchors reproduce this published adaptation (via nebisumer.com) rather than an AI translation; only the pack's description and instructions are adapted for on-screen rendering. The Turkish item order matches the original 1:1.
|
|
159
|
+
- **Scoring:** Sum over all 27 items (27–189), no reverse-scored items; the literature commonly reports the item mean (divide by 27). Sensory-processing sensitivity is a continuous trait — no clinical cutoffs are defined.
|
|
160
|
+
|
|
161
|
+
## SWLS — Satisfaction with Life Scale (`swls`)
|
|
162
|
+
|
|
163
|
+
**License: Free with conditions.** Copyrighted by Ed Diener and co-authors; per the authors' site the scale may be used "without permission or charge by all professionals (researchers and practitioners)" as long as credit is given, **for non-commercial purposes only** (<https://eddiener.com/scales/>). Embedding in commercial products is not licensed.
|
|
164
|
+
|
|
165
|
+
- **Citation:** Diener, E., Emmons, R. A., Larsen, R. J., & Griffin, S. (1985). The Satisfaction With Life Scale. *Journal of Personality Assessment, 49*(1), 71–75.
|
|
166
|
+
- **Scoring:** Sum 5–35 on a fully labeled 1–7 agreement scale; interpreted against Diener's published groupings (5–9 extremely dissatisfied … 20 neutral … 31–35 extremely satisfied).
|
|
167
|
+
|
|
168
|
+
## FS — Flourishing Scale (`flourishing`)
|
|
169
|
+
|
|
170
|
+
**License: Free with conditions.** Same rights statement as the SWLS (copyright Ed Diener and co-authors; free for researchers and practitioners with credit, non-commercial purposes only).
|
|
171
|
+
|
|
172
|
+
- **Citation:** Diener, E., Wirtz, D., Tov, W., Kim-Prieto, C., Choi, D., Oishi, S., & Biswas-Diener, R. (2010). New well-being measures: Short scales to assess flourishing and positive and negative feelings. *Social Indicators Research, 97*(2), 143–156.
|
|
173
|
+
- **Scoring:** Sum 8–56; higher scores indicate more self-perceived psychological resources. No published cutoffs.
|
|
174
|
+
|
|
175
|
+
## K10 — Kessler Psychological Distress Scale, 10 items (`k10`)
|
|
176
|
+
|
|
177
|
+
**License: Free.** The K10/K6 scales are in the public domain and free for clinical and research use (Kessler and colleagues; distributed via the Harvard NCS site and government health surveys worldwide).
|
|
178
|
+
|
|
179
|
+
- **Citation:** Kessler, R. C., Andrews, G., Colpe, L. J., Hiripi, E., Mroczek, D. K., Normand, S.-L. T., Walters, E. E., & Zaslavsky, A. M. (2002). Short screening scales to monitor population prevalences and trends in non-specific psychological distress. *Psychological Medicine, 32*(6), 959–976.
|
|
180
|
+
- **Scoring:** Items scored 1–5, sum 10–50. The bundled severity groupings (10–19 likely well, 20–24 mild, 25–29 moderate, 30–50 severe) follow the widely used Australian convention; other groupings exist. The full interview administration skips items 3/6 after a "none of the time" answer and scores them 1; this simple form administers all items.
|
|
181
|
+
|
|
182
|
+
## K6 — Kessler Psychological Distress Scale, 6 items (`k6`)
|
|
183
|
+
|
|
184
|
+
**License: Free.** Same public-domain status as the K10.
|
|
185
|
+
|
|
186
|
+
- **Citation:** Kessler et al. (2002), as above. Serious-distress cutoff: Kessler, R. C., Barker, P. R., Colpe, L. J., et al. (2003). Screening for serious mental illness in the general population. *Archives of General Psychiatry, 60*(2), 184–189. Moderate band: Prochaska, J. J., Sung, H.-Y., Max, W., Shi, Y., & Ong, M. (2012). Validity study of the K6 scale as a measure of moderate mental distress based on mental health treatment need and utilization. *International Journal of Methods in Psychiatric Research, 21*(2), 88–97.
|
|
187
|
+
- **Scoring:** U.S. convention — items scored 0–4, sum 0–24; ≥13 indicates serious psychological distress, 5–12 moderate distress.
|
|
188
|
+
|
|
189
|
+
## RSES — Rosenberg Self-Esteem Scale (`rses`)
|
|
190
|
+
|
|
191
|
+
**License: Free with conditions.** The Rosenberg family (Morris Rosenberg Foundation) permits use of the scale for educational and professional research without charge or explicit permission, with attribution; see the University of Maryland Department of Sociology FAQ (<https://socy.umd.edu/rosenberg-scale-faq>). Commercial use is not explicitly licensed.
|
|
192
|
+
|
|
193
|
+
- **Citation:** Rosenberg, M. (1965). *Society and the Adolescent Self-Image.* Princeton, NJ: Princeton University Press.
|
|
194
|
+
- **Scoring:** Items scored 0–3 (Strongly disagree = 0 … Strongly agree = 3), items 2, 5, 6, 8, 9 reverse-scored, sum 0–30. Scores 15–25 are commonly described as the normal range (University of Maryland scoring guidance).
|
|
195
|
+
- **Audience — deviates from the default:** `audience: ["adolescent", "adult"]`. Rosenberg developed the scale on high-school students (*Society and the Adolescent Self-Image*), and the same ten items are the standard self-esteem measure for adolescents and adults alike — the wording does not change between bands.
|
|
196
|
+
|
|
197
|
+
## Instruments evaluated and not bundled
|
|
198
|
+
|
|
199
|
+
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.
|
|
200
|
+
|
|
201
|
+
- **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.
|
|
202
|
+
- **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.
|
|
203
|
+
- **WURS-25 (Wender Utah Rating Scale)** — American Psychiatric Association Publishing (*American Journal of Psychiatry*, 1993). No free-redistribution grant could be found; the "public domain" claim repeated across the web traces to no source. Not bundled.
|
|
204
|
+
- **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.
|
|
205
|
+
- **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.
|
|
206
|
+
- **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.
|
|
207
|
+
|
|
208
|
+
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.
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export type { LocalizedText, AssessmentOption, AssessmentQuestion, AssessmentDefinition, ScoreBand, ScoreFlag, SumScoring, SubscaleDefinition, SubscaleScoring, CountScoringItem, CountScoring, MissingDataPolicy, MissingDataStrategy, ScoringDefinition, ValidationIssueCode, AnswerMap, InventoryLocalePack, ResponseStatus, ResponseData, ValidationIssue, ValidationResult, BandResult, TriggeredFlag, ScaleScore, ScaleResult, MultiScaleResult, CategoricalResult, CustomResult, EvaluationResult, Evaluator, LocalizedAssessmentView, } from "./types.ts";
|
|
1
|
+
export type { LocalizedText, AssessmentOption, AssessmentQuestion, AssessmentDefinition, InventoryCategory, InventoryAudience, InventoryRespondent, ScoreBand, ScoreFlag, SumScoring, SubscaleDefinition, SubscaleScoring, CountScoringItem, CountScoring, MissingDataPolicy, MissingDataStrategy, ScoringDefinition, ValidationIssueCode, AnswerMap, InventoryLocalePack, ResponseStatus, ResponseData, ValidationIssue, ValidationResult, BandResult, TriggeredFlag, ScaleScore, ScaleResult, MultiScaleResult, CategoricalResult, CustomResult, EvaluationResult, Evaluator, LocalizedAssessmentView, } from "./types.ts";
|
|
2
2
|
export { PsytoolsError } from "./errors.ts";
|
|
3
3
|
export type { PsytoolsErrorCode } from "./errors.ts";
|
|
4
4
|
export { localizeText, collectLocales, pickLocales, applyLocale } from "./i18n.ts";
|
|
@@ -8,5 +8,5 @@ export { Assessment, validateDefinition } from "./assessment.ts";
|
|
|
8
8
|
export { AssessmentResponse } from "./response.ts";
|
|
9
9
|
export { evaluate } from "./evaluation.ts";
|
|
10
10
|
export type { EvaluateOptions } from "./evaluation.ts";
|
|
11
|
-
export { phq9, gad7, dass21, who5, asrs6, aq10, audit, miniIpip, inventories, loadInventory, twoWeekFrequencyOptions, twoWeekInstructions, } from "./inventories/index.ts";
|
|
11
|
+
export { phq9, gad7, dass21, who5, asrs6, aq10, audit, miniIpip, cesd, ecrR, erq, hsps, swls, flourishing, k10, k6, rses, inventories, loadInventory, twoWeekFrequencyOptions, twoWeekInstructions, } from "./inventories/index.ts";
|
|
12
12
|
export type { InventoryId } from "./inventories/index.ts";
|
package/dist/cjs/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.twoWeekInstructions = exports.twoWeekFrequencyOptions = exports.loadInventory = exports.inventories = exports.miniIpip = exports.audit = exports.aq10 = exports.asrs6 = exports.who5 = exports.dass21 = exports.gad7 = exports.phq9 = exports.evaluate = exports.AssessmentResponse = exports.validateDefinition = exports.Assessment = exports.availableLocales = exports.localePacks = exports.applyLocale = exports.pickLocales = exports.collectLocales = exports.localizeText = exports.PsytoolsError = void 0;
|
|
3
|
+
exports.twoWeekInstructions = exports.twoWeekFrequencyOptions = exports.loadInventory = exports.inventories = exports.rses = exports.k6 = exports.k10 = exports.flourishing = exports.swls = exports.hsps = exports.erq = exports.ecrR = exports.cesd = exports.miniIpip = exports.audit = exports.aq10 = exports.asrs6 = exports.who5 = exports.dass21 = exports.gad7 = exports.phq9 = exports.evaluate = exports.AssessmentResponse = exports.validateDefinition = exports.Assessment = exports.availableLocales = exports.localePacks = exports.applyLocale = exports.pickLocales = exports.collectLocales = exports.localizeText = exports.PsytoolsError = void 0;
|
|
4
4
|
var errors_ts_1 = require("./errors.js");
|
|
5
5
|
Object.defineProperty(exports, "PsytoolsError", { enumerable: true, get: function () { return errors_ts_1.PsytoolsError; } });
|
|
6
6
|
var i18n_ts_1 = require("./i18n.js");
|
|
@@ -27,6 +27,15 @@ Object.defineProperty(exports, "asrs6", { enumerable: true, get: function () { r
|
|
|
27
27
|
Object.defineProperty(exports, "aq10", { enumerable: true, get: function () { return index_ts_2.aq10; } });
|
|
28
28
|
Object.defineProperty(exports, "audit", { enumerable: true, get: function () { return index_ts_2.audit; } });
|
|
29
29
|
Object.defineProperty(exports, "miniIpip", { enumerable: true, get: function () { return index_ts_2.miniIpip; } });
|
|
30
|
+
Object.defineProperty(exports, "cesd", { enumerable: true, get: function () { return index_ts_2.cesd; } });
|
|
31
|
+
Object.defineProperty(exports, "ecrR", { enumerable: true, get: function () { return index_ts_2.ecrR; } });
|
|
32
|
+
Object.defineProperty(exports, "erq", { enumerable: true, get: function () { return index_ts_2.erq; } });
|
|
33
|
+
Object.defineProperty(exports, "hsps", { enumerable: true, get: function () { return index_ts_2.hsps; } });
|
|
34
|
+
Object.defineProperty(exports, "swls", { enumerable: true, get: function () { return index_ts_2.swls; } });
|
|
35
|
+
Object.defineProperty(exports, "flourishing", { enumerable: true, get: function () { return index_ts_2.flourishing; } });
|
|
36
|
+
Object.defineProperty(exports, "k10", { enumerable: true, get: function () { return index_ts_2.k10; } });
|
|
37
|
+
Object.defineProperty(exports, "k6", { enumerable: true, get: function () { return index_ts_2.k6; } });
|
|
38
|
+
Object.defineProperty(exports, "rses", { enumerable: true, get: function () { return index_ts_2.rses; } });
|
|
30
39
|
Object.defineProperty(exports, "inventories", { enumerable: true, get: function () { return index_ts_2.inventories; } });
|
|
31
40
|
Object.defineProperty(exports, "loadInventory", { enumerable: true, get: function () { return index_ts_2.loadInventory; } });
|
|
32
41
|
Object.defineProperty(exports, "twoWeekFrequencyOptions", { enumerable: true, get: function () { return index_ts_2.twoWeekFrequencyOptions; } });
|
|
@@ -2,10 +2,17 @@ import type { AssessmentDefinition } from "../types.ts";
|
|
|
2
2
|
/**
|
|
3
3
|
* ASRS v1.1 — Adult ADHD Self-Report Scale, 6-item screener (Part A).
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* items 4–6 from "Often"; four or more positive items indicate
|
|
8
|
-
* highly consistent with adult ADHD and warrant further investigation
|
|
9
|
-
* (Kessler et al., 2005).
|
|
5
|
+
* A subset of the 18-question ASRS v1.1 Symptom Checklist, developed with the
|
|
6
|
+
* WHO's Workgroup on Adult ADHD. Items 1–3 count as screen-positive from
|
|
7
|
+
* "Sometimes" and items 4–6 from "Often"; four or more positive items indicate
|
|
8
|
+
* symptoms highly consistent with adult ADHD and warrant further investigation
|
|
9
|
+
* (Kessler et al., 2005).
|
|
10
|
+
*
|
|
11
|
+
* Copyright is held by New York University and the President and Fellows of
|
|
12
|
+
* Harvard College, and licensing is administered by NYU Technology
|
|
13
|
+
* Opportunities & Ventures — not by the WHO. Free for clinical, non-clinical
|
|
14
|
+
* and commercial use, but attribution is mandatory: render `meta.attribution`
|
|
15
|
+
* verbatim wherever the screener or its results appear. See `meta.license` for
|
|
16
|
+
* the open question about translation.
|
|
10
17
|
*/
|
|
11
18
|
export declare const asrs6: AssessmentDefinition;
|
|
@@ -4,15 +4,25 @@ exports.asrs6 = void 0;
|
|
|
4
4
|
/**
|
|
5
5
|
* ASRS v1.1 — Adult ADHD Self-Report Scale, 6-item screener (Part A).
|
|
6
6
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* items 4–6 from "Often"; four or more positive items indicate
|
|
10
|
-
* highly consistent with adult ADHD and warrant further investigation
|
|
11
|
-
* (Kessler et al., 2005).
|
|
7
|
+
* A subset of the 18-question ASRS v1.1 Symptom Checklist, developed with the
|
|
8
|
+
* WHO's Workgroup on Adult ADHD. Items 1–3 count as screen-positive from
|
|
9
|
+
* "Sometimes" and items 4–6 from "Often"; four or more positive items indicate
|
|
10
|
+
* symptoms highly consistent with adult ADHD and warrant further investigation
|
|
11
|
+
* (Kessler et al., 2005).
|
|
12
|
+
*
|
|
13
|
+
* Copyright is held by New York University and the President and Fellows of
|
|
14
|
+
* Harvard College, and licensing is administered by NYU Technology
|
|
15
|
+
* Opportunities & Ventures — not by the WHO. Free for clinical, non-clinical
|
|
16
|
+
* and commercial use, but attribution is mandatory: render `meta.attribution`
|
|
17
|
+
* verbatim wherever the screener or its results appear. See `meta.license` for
|
|
18
|
+
* the open question about translation.
|
|
12
19
|
*/
|
|
13
20
|
exports.asrs6 = {
|
|
14
21
|
id: "asrs6",
|
|
15
22
|
version: "1.0.0",
|
|
23
|
+
categories: ["adhd"],
|
|
24
|
+
audience: ["adult"],
|
|
25
|
+
respondent: "self",
|
|
16
26
|
title: {
|
|
17
27
|
en: "Adult ADHD Self-Report Scale (ASRS-v1.1) Screener",
|
|
18
28
|
},
|
|
@@ -100,7 +110,8 @@ exports.asrs6 = {
|
|
|
100
110
|
},
|
|
101
111
|
meta: {
|
|
102
112
|
reference: "Kessler, R. C., Adler, L., Ames, M., Demler, O., Faraone, S., Hiripi, E., et al. (2005). The World Health Organization Adult ADHD Self-Report Scale (ASRS): a short screening scale for use in the general population. Psychological Medicine, 35(2), 245-256.",
|
|
103
|
-
|
|
113
|
+
attribution: "The 6-question Adult Self-Report Scale-Version1.1 (ASRS-V1.1) Screener is a subset of the 18-question Adult ADHD Self-Report Scale-Version1.1 (Adult ASRSV1.1) Symptom Checklist. © New York University and the President and Fellows of Harvard College.",
|
|
114
|
+
license: "Free with conditions — © New York University and the President and Fellows of Harvard College; licensing administered by NYU Technology Opportunities & Ventures (license.tov.med.nyu.edu/product/asrs6Qscreener). Freely available for clinical and non-clinical use, including commercial use, but attribution is required: display meta.attribution verbatim wherever the screener or its results appear. No modifications other than creating electronic versions are permitted, and the license does not say whether translation is a modification — so the standing of the bundled tr/de/zh/es translations is unresolved, pending a question to NYU TOV. See SOURCES.md.",
|
|
104
115
|
licenseFlag: "free-with-conditions",
|
|
105
116
|
translationProvenance: "en: reproduced from the original. Other locales (tr, de, zh, es): AI translation (Anthropic Claude, claude-fable-5) from the original English; official translations were not consulted and the texts are unverified. See SOURCES.md.",
|
|
106
117
|
timeframe: "past 6 months",
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { AssessmentDefinition } from "../types.ts";
|
|
2
|
+
/**
|
|
3
|
+
* CES-D — Center for Epidemiologic Studies Depression Scale.
|
|
4
|
+
*
|
|
5
|
+
* 20 items, 0–3 past-week frequency scale, total score 0–60. Items 4, 8,
|
|
6
|
+
* 12 and 16 are positively worded and reverse scored. Scores of 16 or
|
|
7
|
+
* above indicate elevated depressive symptoms (Radloff, 1977). Developed
|
|
8
|
+
* at the U.S. National Institute of Mental Health; the scale is in the
|
|
9
|
+
* public domain.
|
|
10
|
+
*/
|
|
11
|
+
export declare const cesd: AssessmentDefinition;
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.cesd = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* CES-D — Center for Epidemiologic Studies Depression Scale.
|
|
6
|
+
*
|
|
7
|
+
* 20 items, 0–3 past-week frequency scale, total score 0–60. Items 4, 8,
|
|
8
|
+
* 12 and 16 are positively worded and reverse scored. Scores of 16 or
|
|
9
|
+
* above indicate elevated depressive symptoms (Radloff, 1977). Developed
|
|
10
|
+
* at the U.S. National Institute of Mental Health; the scale is in the
|
|
11
|
+
* public domain.
|
|
12
|
+
*/
|
|
13
|
+
exports.cesd = {
|
|
14
|
+
id: "cesd",
|
|
15
|
+
version: "1.0.0",
|
|
16
|
+
categories: ["depression"],
|
|
17
|
+
audience: ["adult"],
|
|
18
|
+
respondent: "self",
|
|
19
|
+
title: {
|
|
20
|
+
en: "Center for Epidemiologic Studies Depression Scale (CES-D)",
|
|
21
|
+
},
|
|
22
|
+
description: {
|
|
23
|
+
en: "A 20-item self-report scale designed to measure depressive symptomatology in the general population.",
|
|
24
|
+
},
|
|
25
|
+
instructions: {
|
|
26
|
+
en: "Please read each statement carefully, then indicate how often you felt or behaved this way during the past week, including today.",
|
|
27
|
+
},
|
|
28
|
+
defaultLocale: "en",
|
|
29
|
+
options: [
|
|
30
|
+
{
|
|
31
|
+
value: 0,
|
|
32
|
+
label: {
|
|
33
|
+
en: "Rarely or none of the time (less than 1 day)",
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
value: 1,
|
|
38
|
+
label: {
|
|
39
|
+
en: "Some or a little of the time (1-2 days)",
|
|
40
|
+
},
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
value: 2,
|
|
44
|
+
label: {
|
|
45
|
+
en: "Occasionally or a moderate amount of the time (3-4 days)",
|
|
46
|
+
},
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
value: 3,
|
|
50
|
+
label: {
|
|
51
|
+
en: "Most or all of the time (5-7 days)",
|
|
52
|
+
},
|
|
53
|
+
},
|
|
54
|
+
],
|
|
55
|
+
questions: [
|
|
56
|
+
{
|
|
57
|
+
id: "cesd-1",
|
|
58
|
+
text: {
|
|
59
|
+
en: "I was bothered by things that usually don't bother me",
|
|
60
|
+
},
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
id: "cesd-2",
|
|
64
|
+
text: {
|
|
65
|
+
en: "I did not feel like eating; my appetite was poor",
|
|
66
|
+
},
|
|
67
|
+
},
|
|
68
|
+
{
|
|
69
|
+
id: "cesd-3",
|
|
70
|
+
text: {
|
|
71
|
+
en: "I felt that I could not shake off the blues even with help from my family and friends",
|
|
72
|
+
},
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
id: "cesd-4",
|
|
76
|
+
text: {
|
|
77
|
+
en: "I felt that I was just as good as other people",
|
|
78
|
+
},
|
|
79
|
+
reverseScored: true,
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
id: "cesd-5",
|
|
83
|
+
text: {
|
|
84
|
+
en: "I had trouble keeping my mind on what I was doing",
|
|
85
|
+
},
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
id: "cesd-6",
|
|
89
|
+
text: {
|
|
90
|
+
en: "I felt depressed",
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
id: "cesd-7",
|
|
95
|
+
text: {
|
|
96
|
+
en: "I felt that everything I did was an effort",
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
{
|
|
100
|
+
id: "cesd-8",
|
|
101
|
+
text: {
|
|
102
|
+
en: "I felt hopeful about the future",
|
|
103
|
+
},
|
|
104
|
+
reverseScored: true,
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
id: "cesd-9",
|
|
108
|
+
text: {
|
|
109
|
+
en: "I thought my life had been a failure",
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
id: "cesd-10",
|
|
114
|
+
text: {
|
|
115
|
+
en: "I felt fearful",
|
|
116
|
+
},
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
id: "cesd-11",
|
|
120
|
+
text: {
|
|
121
|
+
en: "My sleep was restless",
|
|
122
|
+
},
|
|
123
|
+
},
|
|
124
|
+
{
|
|
125
|
+
id: "cesd-12",
|
|
126
|
+
text: {
|
|
127
|
+
en: "I was happy",
|
|
128
|
+
},
|
|
129
|
+
reverseScored: true,
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
id: "cesd-13",
|
|
133
|
+
text: {
|
|
134
|
+
en: "I talked less than usual",
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
id: "cesd-14",
|
|
139
|
+
text: {
|
|
140
|
+
en: "I felt lonely",
|
|
141
|
+
},
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
id: "cesd-15",
|
|
145
|
+
text: {
|
|
146
|
+
en: "People were unfriendly",
|
|
147
|
+
},
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
id: "cesd-16",
|
|
151
|
+
text: {
|
|
152
|
+
en: "I enjoyed life",
|
|
153
|
+
},
|
|
154
|
+
reverseScored: true,
|
|
155
|
+
},
|
|
156
|
+
{
|
|
157
|
+
id: "cesd-17",
|
|
158
|
+
text: {
|
|
159
|
+
en: "I had crying spells",
|
|
160
|
+
},
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
id: "cesd-18",
|
|
164
|
+
text: {
|
|
165
|
+
en: "I felt sad",
|
|
166
|
+
},
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
id: "cesd-19",
|
|
170
|
+
text: {
|
|
171
|
+
en: "I felt that people disliked me",
|
|
172
|
+
},
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
id: "cesd-20",
|
|
176
|
+
text: {
|
|
177
|
+
en: "I could not get \"going\"",
|
|
178
|
+
},
|
|
179
|
+
},
|
|
180
|
+
],
|
|
181
|
+
scoring: {
|
|
182
|
+
kind: "sum",
|
|
183
|
+
missing: { strategy: "prorate", minAnswered: 16 },
|
|
184
|
+
bands: [
|
|
185
|
+
{
|
|
186
|
+
id: "below-cutoff",
|
|
187
|
+
min: 0,
|
|
188
|
+
max: 15,
|
|
189
|
+
label: { en: "Below the clinical cutoff" },
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
id: "elevated",
|
|
193
|
+
min: 16,
|
|
194
|
+
max: 60,
|
|
195
|
+
label: { en: "Elevated depressive symptoms (at or above the cutoff of 16)" },
|
|
196
|
+
},
|
|
197
|
+
],
|
|
198
|
+
},
|
|
199
|
+
meta: {
|
|
200
|
+
reference: "Radloff, L. S. (1977). The CES-D Scale: A self-report depression scale for research in the general population. Applied Psychological Measurement, 1(3), 385-401.",
|
|
201
|
+
license: "Free — developed at the U.S. National Institute of Mental Health; the scale is in the public domain and may be used without permission",
|
|
202
|
+
licenseFlag: "free",
|
|
203
|
+
translationProvenance: "en: reproduced from the original instrument (via the NIDA Seek, Test, Treat and Retain data harmonization packet). Other locales (tr, de, zh, es): AI translation (Anthropic Claude, claude-fable-5) from the original English; official translations were not consulted and the texts are unverified. See SOURCES.md.",
|
|
204
|
+
timeframe: "past week",
|
|
205
|
+
scoringNote: "The >=16 cutoff for elevated depressive symptoms follows Radloff (1977); it screens for risk and is not a diagnosis. The prorating threshold (>=16 of 20 items) is an implementation choice, not part of the published scoring.",
|
|
206
|
+
},
|
|
207
|
+
};
|