@ntix/components-scorad 1.0.3 → 1.0.5

package/docs/ScoradIntensityData.md

@@ -0,0 +1,64 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradIntensityData
+
+```ts
+type ScoradIntensityData = object;
+```
+
+Represents the single assessment of the six clinical signs from a representative lesion area.
+Used for calculating the Intensity Score (B).
+
+#### Properties
+
+##### erythema
+
+```ts
+erythema: number;
+```
+
+Erythema (Redness).
+
+##### excoriations
+
+```ts
+excoriations: number;
+```
+
+Excoriations (Scratch marks).
+
+##### lichenification
+
+```ts
+lichenification: number;
+```
+
+Lichenification (Skin thickening).
+
+##### oedemaPapulation
+
+```ts
+oedemaPapulation: number;
+```
+
+Oedema and Papulation (Swelling/Bumps).
+
+##### oozingCrusting
+
+```ts
+oozingCrusting: number;
+```
+
+Oozing and Crusting.
+
+##### xerosis
+
+```ts
+xerosis: number;
+```
+
+Xerosis (Dryness).

package/docs/ScoradResources.md

@@ -0,0 +1,41 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradResource
+
+```ts
+type ScoradResource = object;
+```
+
+A single resource item containing UI text strings.
+
+***
+
+### ScoradResourceMap
+
+```ts
+type ScoradResourceMap<T> = { [P in keyof T]: T[P] extends object ? ScoradResourceMap<T[P]> : ScoradResource };
+```
+
+A recursive type that mirrors the structure of a SCORAD data record,
+replacing leaf values with ScoradResource objects.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Variables
+
+### ScoradResources
+
+```ts
+const ScoradResources: ScoradResourceMap<ScoradData>;
+```
+
+Localization and UI resources for the SCORAD component.
+Maps data keys to human-readable labels and descriptions for display in the UI.

package/docs/ScoradScore.md

@@ -0,0 +1,47 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradScore
+
+```ts
+type ScoradScore = object;
+```
+
+Computed SCORAD values representing the three clinical sections and the final sum.
+
+#### Properties
+
+##### A
+
+```ts
+A: number;
+```
+
+Extent (Surface Area): The percentage of body surface area affected, weighted by age.
+
+##### B
+
+```ts
+B: number;
+```
+
+Intensity: The sum of the six clinical sign grades (Erythema, Oedema, etc.).
+
+##### C
+
+```ts
+C: number;
+```
+
+Subjective Symptoms: The sum of patient-reported pruritus and sleeplessness scores.
+
+##### total
+
+```ts
+total: number;
+```
+
+The final calculated score using the standard formula: A/5 + 7B/2 + C.

package/docs/ScoradSubjectiveData.md

@@ -0,0 +1,32 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradSubjectiveData
+
+```ts
+type ScoradSubjectiveData = object;
+```
+
+Represents the patient-reported scores for subjective symptoms (Itch/Sleeplessness).
+Used for calculating the Subjective Score (C).
+
+#### Properties
+
+##### pruritus
+
+```ts
+pruritus: number;
+```
+
+Visual Analog Scale (VAS) score (0-10) for Pruritus (Itch) over the last 3 days/nights.
+
+##### sleeplessness
+
+```ts
+sleeplessness: number;
+```
+
+Visual Analog Scale (VAS) score (0-10) for Sleeplessness over the last 3 days/nights.

package/docs/component.md

@@ -0,0 +1,68 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Classes
+
+### HTMLScoradElement
+
+Root component for calculating and displaying the total SCORAD (SCORing Atopic Dermatitis).
+
+This component aggregates data from Extent, Intensity, and Subjective sub-components
+to calculate the final clinical score.
+
+#### Extends
+
+- `HTMLComponentElement`\<[`HTMLScoradValueElement`](HTMLScoradValueElement.md#htmlscoradvalueelement)\<[`ScoradData`](ScoradData.md#scoraddata)\>\>
+
+#### Events
+
+##### valueChange
+
+```ts
+readonly valueChange: EventEmitter<ScoradData>;
+```
+
+Fired when the value is finalized or "committed" by the user.
+
+###### Param
+
+The final updated value.
+
+##### valueInput
+
+```ts
+readonly valueInput: EventEmitter<ScoradData>;
+```
+
+Fired immediately as the user interacts with the input (high frequency).
+
+###### Param
+
+The current value during input.
+
+#### Properties
+
+##### readonly
+
+```ts
+readonly: boolean = false;
+```
+
+Value is readonly
+
+##### showErrors
+
+```ts
+showErrors: boolean = false;
+```
+
+Show the errors from validation on the components
+
+##### value
+
+```ts
+value: ScoradData = SCORAD_DEFAULT;
+```
+
+The current value of the component.

package/docs/componentsScoradLogger.md

@@ -0,0 +1,14 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Variables
+
+### componentsScoradLogger
+
+```ts
+const componentsScoradLogger: ILogger;
+```
+
+Internal logger instance for @ntix/components-scorad.
+Configured with a dedicated namespace and the resolved logLevel.

package/docs/constants.md

@@ -0,0 +1,99 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Variables
+
+### SCORAD\_ADULT\_WEIGHTS
+
+```ts
+const SCORAD_ADULT_WEIGHTS: ScoradExtentWeights;
+```
+
+Configuration map for the Body Surface Area (BSA) weights for adult SCORAD Extent (A) calculation.
+The values are decimals representing the percentage of total BSA.
+
+***
+
+### SCORAD\_CHILD\_WEIGHTS
+
+```ts
+const SCORAD_CHILD_WEIGHTS: ScoradExtentWeights;
+```
+
+Configuration map for the Body Surface Area (BSA) weights for child SCORAD Extent (A) calculation.
+The head and neck area is proportionally larger than in adults.
+
+***
+
+### SCORAD\_DEFAULT
+
+```ts
+const SCORAD_DEFAULT: ScoradData;
+```
+
+Global default state for a complete SCORAD assessment.
+Uses adult weighting by default.
+
+***
+
+### SCORAD\_EXTENT\_DEFAULT
+
+```ts
+const SCORAD_EXTENT_DEFAULT: ScoradExtentData;
+```
+
+Initial state for SCORAD Extent data. 
+All regions are initialized as non-null to satisfy record constraints.
+
+***
+
+### SCORAD\_EXTENT\_MAX\_VALUE
+
+```ts
+const SCORAD_EXTENT_MAX_VALUE: number = 100;
+```
+
+Maximum percentage value allowed for any body region in the Extent (A) calculation.
+
+***
+
+### SCORAD\_INTENSITY\_DEFAULT
+
+```ts
+const SCORAD_INTENSITY_DEFAULT: ScoradIntensityData;
+```
+
+Initial state for SCORAD Intensity data. 
+Represents a baseline where no clinical signs have been graded.
+
+***
+
+### SCORAD\_INTENSITY\_MAX\_VALUE
+
+```ts
+const SCORAD_INTENSITY_MAX_VALUE: number = 3;
+```
+
+Maximum grade (0-3) allowed for clinical signs in the Intensity (B) calculation.
+
+***
+
+### SCORAD\_SUBJECTIVE\_DEFAULT
+
+```ts
+const SCORAD_SUBJECTIVE_DEFAULT: ScoradSubjectiveData;
+```
+
+Initial state for SCORAD Subjective data. 
+Represents a baseline for pruritus and sleeplessness.
+
+***
+
+### SCORAD\_SUBJECTIVE\_MAX\_VALUE
+
+```ts
+const SCORAD_SUBJECTIVE_MAX_VALUE: number = 10;
+```
+
+Maximum value (0-10) allowed for patient-reported symptoms in the Subjective (C) calculation.

package/docs/extent.component.md

@@ -0,0 +1,86 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Classes
+
+### HTMLScoradExtentElement
+
+Interactive SVG component for calculating the 'Extent' (A) section of the SCORAD score.
+
+Users can interact with different body regions (head, trunk, limbs) via pointer gestures 
+or keyboard input to define the percentage of affected surface area. The component 
+supports different surface area weightings based on the `child` attribute.
+
+#### Extends
+
+- `HTMLComponentElement`\<[`HTMLScoradValueElement`](HTMLScoradValueElement.md#htmlscoradvalueelement)\<[`ScoradExtentData`](ScoradExtentData.md#scoradextentdata)\>\>
+
+#### Events
+
+##### valueChange
+
+```ts
+readonly valueChange: EventEmitter<ScoradExtentData>;
+```
+
+Fired when the value is finalized or "committed" by the user.
+
+###### Param
+
+The final updated value.
+
+##### valueInput
+
+```ts
+readonly valueInput: EventEmitter<ScoradExtentData>;
+```
+
+Fired immediately as the user interacts with the input (high frequency).
+
+###### Param
+
+The current value during input.
+
+#### Properties
+
+##### child
+
+```ts
+child: boolean = false;
+```
+
+Extent score is to be weighted as a child or adult
+
+##### errors?
+
+```ts
+optional errors: Record<string, string>;
+```
+
+validation errors
+shows as has-errors attribute
+
+##### readonly
+
+```ts
+readonly: boolean = false;
+```
+
+Value is readonly
+
+##### score?
+
+```ts
+optional score: number;
+```
+
+Subjective SCORAD score (A)
+
+##### value
+
+```ts
+value: ScoradExtentData = SCORAD_EXTENT_DEFAULT;
+```
+
+The current value of the component.

package/docs/getScoradScore.md

@@ -0,0 +1,25 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Functions
+
+### getScoradScore()
+
+```ts
+function getScoradScore(data): Result<ScoradScore>;
+```
+
+Calculates the final composite SCORAD score (A/5 + 7B/2 + C) from the raw data.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`ScoradData`](ScoradData.md#scoraddata) \| `null` \| `undefined` | The complete ScoradData input object. |
+
+#### Returns
+
+`Result`\<[`ScoradScore`](ScoradScore.md#scoradscore)\>
+
+The final SCORAD score, rounded to two decimal places.

package/docs/intensity.component.md

@@ -0,0 +1,77 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Classes
+
+### HTMLScoradIntensityElement
+
+Component for assessing the 'Intensity' (B) criteria of the SCORAD score.
+
+It renders a list of clinical signs (e.g., Erythema, Edema, Oozing) and allows
+the user to grade each on a scale of 0 to 3 using integrated option pickers.
+
+#### Extends
+
+- `HTMLComponentElement`\<[`HTMLScoradValueElement`](HTMLScoradValueElement.md#htmlscoradvalueelement)\<[`ScoradIntensityData`](ScoradIntensityData.md#scoradintensitydata)\>\>
+
+#### Events
+
+##### valueChange
+
+```ts
+readonly valueChange: EventEmitter<ScoradIntensityData>;
+```
+
+Fired when the value is finalized or "committed" by the user.
+
+###### Param
+
+The final updated value.
+
+##### valueInput
+
+```ts
+readonly valueInput: EventEmitter<ScoradIntensityData>;
+```
+
+Fired immediately as the user interacts with the input (high frequency).
+
+###### Param
+
+The current value during input.
+
+#### Properties
+
+##### errors?
+
+```ts
+optional errors: Record<string, string>;
+```
+
+validation errors
+shows as has-errors attribute
+
+##### readonly
+
+```ts
+readonly: boolean = false;
+```
+
+Value is readonly
+
+##### score?
+
+```ts
+optional score: number;
+```
+
+Subjective SCORAD score (B)
+
+##### value
+
+```ts
+value: ScoradIntensityData = SCORAD_INTENSITY_DEFAULT;
+```
+
+The current value of the component.

package/docs/selectScoradWeights.md

@@ -0,0 +1,25 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Functions
+
+### selectScoradWeights()
+
+```ts
+function selectScoradWeights(data): ScoradExtentWeights;
+```
+
+Select the weights by the data passed
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`ScoradData`](ScoradData.md#scoraddata) \| `null` \| `undefined` | scorad data |
+
+#### Returns
+
+[`ScoradExtentWeights`](ScoradExtentWeights.md#scoradextentweights)
+
+weights to use

package/docs/subjective.component.md

@@ -0,0 +1,77 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Classes
+
+### HTMLScoradSubjectiveElement
+
+Component for assessing the 'Subjective' (C) criteria of the SCORAD score.
+
+It provides visual analog scales (VAS) for patients to self-report symptoms 
+such as pruritus (itching) and insomnia (sleep loss) over the last 3 days.
+
+#### Extends
+
+- `HTMLComponentElement`\<[`HTMLScoradValueElement`](HTMLScoradValueElement.md#htmlscoradvalueelement)\<[`ScoradSubjectiveData`](ScoradSubjectiveData.md#scoradsubjectivedata)\>\>
+
+#### Events
+
+##### valueChange
+
+```ts
+readonly valueChange: EventEmitter<ScoradSubjectiveData>;
+```
+
+Fired when the value is finalized or "committed" by the user.
+
+###### Param
+
+The final updated value.
+
+##### valueInput
+
+```ts
+readonly valueInput: EventEmitter<ScoradSubjectiveData>;
+```
+
+Fired immediately as the user interacts with the input (high frequency).
+
+###### Param
+
+The current value during input.
+
+#### Properties
+
+##### errors?
+
+```ts
+optional errors: Record<string, string>;
+```
+
+validation errors
+shows as has-errors attribute
+
+##### readonly
+
+```ts
+readonly: boolean = false;
+```
+
+Value is readonly
+
+##### score?
+
+```ts
+optional score: number;
+```
+
+Subjective SCORAD score (C)
+
+##### value
+
+```ts
+value: ScoradSubjectiveData = SCORAD_SUBJECTIVE_DEFAULT;
+```
+
+The current value of the component.

package/docs/validateScoradData.md

@@ -0,0 +1,26 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Functions
+
+### validateScoradData()
+
+```ts
+function validateScoradData(data): Result<ScoradData>;
+```
+
+Validates all fields within the ScoradData object against their allowed clinical bounds.
+Returns an array of error messages.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`ScoradData`](ScoradData.md#scoraddata) \| `null` \| `undefined` | The complete ScoradData input object. |
+
+#### Returns
+
+`Result`\<[`ScoradData`](ScoradData.md#scoraddata)\>
+
+Result.