@ntix/components-scorad 1.0.3 → 1.0.5

package/dist/ScoradIntensityData.d.ts

@@ -1,18 +1,22 @@
 /**
- * @description Represents the single assessment of the six clinical signs from a representative lesion area.
+ * @module
+ * @group Data
+ */
+/**
+ * Represents the single assessment of the six clinical signs from a representative lesion area.
  * Used for calculating the Intensity Score (B).
  */
 export type ScoradIntensityData = {
-    /** @description Erythema (Redness). */
+    /** Erythema (Redness). */
     erythema: number;
-    /** @description Oedema and Papulation (Swelling/Bumps). */
+    /** Oedema and Papulation (Swelling/Bumps). */
     oedemaPapulation: number;
-    /** @description Oozing and Crusting. */
+    /** Oozing and Crusting. */
     oozingCrusting: number;
-    /** @description Excoriations (Scratch marks). */
+    /** Excoriations (Scratch marks). */
     excoriations: number;
-    /** @description Lichenification (Skin thickening). */
+    /** Lichenification (Skin thickening). */
     lichenification: number;
-    /** @description Xerosis (Dryness). */
+    /** Xerosis (Dryness). */
     xerosis: number;
 };

package/dist/ScoradResources.d.ts

@@ -1,9 +1,20 @@
 import { ScoradData } from './ScoradData';
+/**
+ Localization and UI resources for the SCORAD component.
+ Maps data keys to human-readable labels and descriptions for display in the UI.
+ */
 export declare const ScoradResources: ScoradResourceMap<ScoradData>;
+/**
+ A single resource item containing UI text strings.
+ */
 export type ScoradResource = {
     text: string;
     description: string;
 };
+/**
+ A recursive type that mirrors the structure of a SCORAD data record,
+ replacing leaf values with ScoradResource objects.
+ */
 export type ScoradResourceMap<T> = {
     [P in keyof T]: T[P] extends object ? ScoradResourceMap<T[P]> : ScoradResource;
 };

package/dist/ScoradScore.d.ts

@@ -1,7 +1,20 @@
-/** Scorad score and component values A, B and C */
+/**
+ * @module
+ * @group Data
+ */
+/** Computed SCORAD values representing the three clinical sections and the final sum.
+ */
 export type ScoradScore = {
+    /** Extent (Surface Area): The percentage of body surface area affected, weighted by age.
+     */
     A: number;
+    /** Intensity: The sum of the six clinical sign grades (Erythema, Oedema, etc.).
+     */
     B: number;
+    /** Subjective Symptoms: The sum of patient-reported pruritus and sleeplessness scores.
+     */
     C: number;
+    /** The final calculated score using the standard formula: A/5 + 7B/2 + C.
+     */
     total: number;
 };

package/dist/ScoradSubjectiveData.d.ts

@@ -1,10 +1,14 @@
 /**
- * @description Represents the patient-reported scores for subjective symptoms (Itch/Sleeplessness).
+ * @module
+ * @group Data
+ */
+/**
+ * Represents the patient-reported scores for subjective symptoms (Itch/Sleeplessness).
  * Used for calculating the Subjective Score (C).
  */
 export type ScoradSubjectiveData = {
-    /** @description Visual Analog Scale (VAS) score (0-10) for Pruritus (Itch) over the last 3 days/nights. */
+    /** Visual Analog Scale (VAS) score (0-10) for Pruritus (Itch) over the last 3 days/nights. */
     pruritus: number;
-    /** @description Visual Analog Scale (VAS) score (0-10) for Sleeplessness over the last 3 days/nights. */
+    /** Visual Analog Scale (VAS) score (0-10) for Sleeplessness over the last 3 days/nights. */
     sleeplessness: number;
 };

package/dist/component.d.ts

@@ -1,15 +1,43 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
 import { ScoradData } from './ScoradData';
-export interface HTMLScoradElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<number>;
-    'value-change': CustomEvent<number>;
-}
-export declare class HTMLScoradElement extends HTMLComponentElement<HTMLScoradElementEventMap> {
+import { HTMLScoradValueElement } from './HTMLScoradValueElement';
+/**
+ * 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.
+ */
+export declare class HTMLScoradElement extends HTMLComponentElement<HTMLScoradValueElement<ScoradData>> {
     connectedCallback(): void;
+    /**
+     * Value is readonly
+     * @group Properties
+     */
+    readonly: boolean;
+    /**
+     * The current value of the component.
+     * @group Properties
+     */
     value: ScoradData;
+    /**
+     * Show the errors from validation on the components
+     * @group Properties
+     * */
     showErrors: boolean;
     afterRender(): void;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
-    valueInput: EventEmitter<ScoradData>;
-    valueChange: EventEmitter<ScoradData>;
+    /**
+     * Fired immediately as the user interacts with the input (high frequency).
+     *
+     * @param detail - The current value during input.
+     * @group Events
+     */
+    readonly valueInput: EventEmitter<ScoradData>;
+    /**
+     * Fired when the value is finalized or "committed" by the user.
+     *
+     * @param detail - The final updated value.
+     * @group Events
+     */
+    readonly valueChange: EventEmitter<ScoradData>;
 }

package/dist/componentsScoradLogger.d.ts

@@ -1 +1,9 @@
+/**
+ * @module
+ * @group Utils
+ */
+/**
+ Internal logger instance for @ntix/components-scorad.
+ Configured with a dedicated namespace and the resolved {@link logLevel}.
+ */
 export declare const componentsScoradLogger: import('@ntix/components-core').ILogger;

package/dist/constants.d.ts

@@ -3,20 +3,35 @@ import { ScoradExtentData } from './ScoradExtentData';
 import { ScoradExtentWeights } from './ScoradExtentWeights';
 import { ScoradIntensityData } from './ScoradIntensityData';
 import { ScoradSubjectiveData } from './ScoradSubjectiveData';
+/** Maximum percentage value allowed for any body region in the Extent (A) calculation. */
 export declare const SCORAD_EXTENT_MAX_VALUE: number;
+/** Maximum grade (0-3) allowed for clinical signs in the Intensity (B) calculation. */
 export declare const SCORAD_INTENSITY_MAX_VALUE: number;
+/** Maximum value (0-10) allowed for patient-reported symptoms in the Subjective (C) calculation. */
 export declare const SCORAD_SUBJECTIVE_MAX_VALUE: number;
+/** Initial state for SCORAD Extent data.
+ All regions are initialized as non-null to satisfy record constraints.
+ */
 export declare const SCORAD_EXTENT_DEFAULT: ScoradExtentData;
+/** Initial state for SCORAD Intensity data.
+ Represents a baseline where no clinical signs have been graded.
+ */
 export declare const SCORAD_INTENSITY_DEFAULT: ScoradIntensityData;
+/** Initial state for SCORAD Subjective data.
+ Represents a baseline for pruritus and sleeplessness.
+ */
 export declare const SCORAD_SUBJECTIVE_DEFAULT: ScoradSubjectiveData;
+/** Global default state for a complete SCORAD assessment.
+ Uses adult weighting by default.
+ */
 export declare const SCORAD_DEFAULT: ScoradData;
 /**
- * @description 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.
+ 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.
  */
 export declare const SCORAD_ADULT_WEIGHTS: ScoradExtentWeights;
 /**
- * @description 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.
+ 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.
  */
 export declare const SCORAD_CHILD_WEIGHTS: ScoradExtentWeights;

package/dist/extent/component.d.ts

@@ -1,24 +1,61 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
 import { ScoradExtentData } from '../ScoradExtentData';
-export interface HTMLScoradExtentElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<ScoradExtentData>;
-    'value-change': CustomEvent<ScoradExtentData>;
-}
-export declare class HTMLScoradExtentElement extends HTMLComponentElement<HTMLScoradExtentElementEventMap> {
+import { HTMLScoradValueElement } from '../HTMLScoradValueElement';
+/**
+ * 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.
+ */
+export declare class HTMLScoradExtentElement extends HTMLComponentElement<HTMLScoradValueElement<ScoradExtentData>> {
     connectedCallback(): void;
     disconnectedCallback(): void;
     private handleFocusIn;
     private handleFocusOut;
+    /**
+     * Extent score is to be weighted as a child or adult
+     * @group Properties
+     */
     child: boolean;
+    /**
+     * Value is readonly
+     * @group Properties
+     */
     readonly: boolean;
-    committedValue: ScoradExtentData;
+    private committedValue;
+    /**
+     * The current value of the component.
+     * @group Properties
+     */
     value: ScoradExtentData;
+    /**
+     * Subjective SCORAD score (A)
+     * @group Properties
+     */
     score?: number;
     setValue: (value: ScoradExtentData) => void;
+    /**
+     * validation errors
+     * shows as has-errors attribute
+     * @group Properties
+     */
     errors?: Record<string, string>;
     afterRender(): void;
     resizeCallback(): void;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
-    valueInput: EventEmitter<ScoradExtentData>;
-    valueChange: EventEmitter<ScoradExtentData>;
+    /**
+     * Fired immediately as the user interacts with the input (high frequency).
+     *
+     * @param detail - The current value during input.
+     * @group Events
+     */
+    readonly valueInput: EventEmitter<ScoradExtentData>;
+    /**
+     * Fired when the value is finalized or "committed" by the user.
+     *
+     * @param detail - The final updated value.
+     * @group Events
+     */
+    readonly valueChange: EventEmitter<ScoradExtentData>;
 }

package/dist/getScoradScore.d.ts

@@ -2,9 +2,8 @@ import { Result } from '@ntix/components-core';
 import { ScoradData } from './ScoradData';
 import { ScoradScore } from './ScoradScore';
 /**
- * @description Calculates the final composite SCORAD score (A/5 + 7B/2 + C) from the raw data.
+ * Calculates the final composite SCORAD score (A/5 + 7B/2 + C) from the raw data.
  * @param data - The complete ScoradData input object.
- * @param weights - The BSA weighting configuration (defaults to adult weights).
  * @returns The final SCORAD score, rounded to two decimal places.
  */
 export declare const getScoradScore: (data: ScoradData | null | undefined) => Result<ScoradScore>;

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './componentsScoradLogger';
 export * from './constants';
 export * from './extent';
 export * from './getScoradScore';
+export * from './HTMLScoradValueElement';
 export * from './intensity';
 export * from './label';
 export * from './options';

package/dist/intensity/component.d.ts

@@ -1,18 +1,50 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
 import { ScoradIntensityData } from '../ScoradIntensityData';
-export interface HTMLScoradIntensityElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<ScoradIntensityData>;
-    'value-change': CustomEvent<ScoradIntensityData>;
-}
-export declare class HTMLScoradIntensityElement extends HTMLComponentElement<HTMLScoradIntensityElementEventMap> {
+import { HTMLScoradValueElement } from '../HTMLScoradValueElement';
+/**
+ * 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.
+ */
+export declare class HTMLScoradIntensityElement extends HTMLComponentElement<HTMLScoradValueElement<ScoradIntensityData>> {
     connectedCallback(): void;
+    /**
+     * Value is readonly
+     * @group Properties
+     */
     readonly: boolean;
+    /**
+     * The current value of the component.
+     * @group Properties
+     */
     value: ScoradIntensityData;
+    /**
+     * Subjective SCORAD score (B)
+     * @group Properties
+     */
     score?: number;
+    /**
+     * validation errors
+     * shows as has-errors attribute
+     * @group Properties
+     */
     errors?: Record<string, string>;
     afterRender(): void;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
     renderLevel(name: keyof ScoradIntensityData): import('@ntix/components-renderer').HTMLLiteralResult;
-    valueInput: EventEmitter<ScoradIntensityData>;
-    valueChange: EventEmitter<ScoradIntensityData>;
+    /**
+     * Fired immediately as the user interacts with the input (high frequency).
+     *
+     * @param detail - The current value during input.
+     * @group Events
+     */
+    readonly valueInput: EventEmitter<ScoradIntensityData>;
+    /**
+     * Fired when the value is finalized or "committed" by the user.
+     *
+     * @param detail - The final updated value.
+     * @group Events
+     */
+    readonly valueChange: EventEmitter<ScoradIntensityData>;
 }

package/dist/label/component.d.ts

@@ -4,7 +4,7 @@ export interface HTMLScoradLabelElementEventMap extends HTMLElementEventMap {
 export declare class HTMLScoradLabelElement extends HTMLComponentElement<HTMLScoradLabelElementEventMap> {
     connectedCallback(): void;
     diconnectedCallback(): void;
-    _handleClick: (_: MouseEvent) => void;
+    private handleClick;
     text: string;
     description?: string;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;

package/dist/options/component.d.ts

@@ -1,9 +1,6 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
-export interface HTMLScoradOptionsElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<number>;
-    'value-change': CustomEvent<number>;
-}
-export declare class HTMLScoradOptionsElement extends HTMLComponentElement<HTMLScoradOptionsElementEventMap> {
+import { HTMLScoradValueElement } from '../HTMLScoradValueElement';
+export declare class HTMLScoradOptionsElement extends HTMLComponentElement<HTMLScoradValueElement<number>> {
     connectedCallback(): void;
     disconnectedCallback(): void;
     private handleFocusIn;
@@ -20,6 +17,6 @@ export declare class HTMLScoradOptionsElement extends HTMLComponentElement<HTMLS
     text: string[];
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
     afterRender(): void;
-    valueInput: EventEmitter<number>;
-    valueChange: EventEmitter<number>;
+    readonly valueInput: EventEmitter<number>;
+    readonly valueChange: EventEmitter<number>;
 }

package/dist/subjective/component.d.ts

@@ -1,17 +1,50 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
 import { ScoradSubjectiveData } from '../ScoradSubjectiveData';
-export interface HTMLScoradSubjectiveElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<ScoradSubjectiveData>;
-    'value-change': CustomEvent<ScoradSubjectiveData>;
-}
-export declare class HTMLScoradSubjectiveElement extends HTMLComponentElement<HTMLScoradSubjectiveElementEventMap> {
+import { HTMLScoradValueElement } from '../HTMLScoradValueElement';
+/**
+ * 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.
+ */
+export declare class HTMLScoradSubjectiveElement extends HTMLComponentElement<HTMLScoradValueElement<ScoradSubjectiveData>> {
     connectedCallback(): void;
+    /**
+     * Value is readonly
+     * @group Properties
+     */
+    readonly: boolean;
+    /**
+     * The current value of the component.
+     * @group Properties
+     */
     value: ScoradSubjectiveData;
+    /**
+     * Subjective SCORAD score (C)
+     * @group Properties
+     */
     score?: number;
+    /**
+     * validation errors
+     * shows as has-errors attribute
+     * @group Properties
+     */
     errors?: Record<string, string>;
     afterRender(): void;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
     renderLevel(name: keyof ScoradSubjectiveData): import('@ntix/components-renderer').HTMLLiteralResult;
-    valueInput: EventEmitter<ScoradSubjectiveData>;
-    valueChange: EventEmitter<ScoradSubjectiveData>;
+    /**
+     * Fired immediately as the user interacts with the input (high frequency).
+     *
+     * @param detail - The current value during input.
+     * @group Events
+     */
+    readonly valueInput: EventEmitter<ScoradSubjectiveData>;
+    /**
+     * Fired when the value is finalized or "committed" by the user.
+     *
+     * @param detail - The final updated value.
+     * @group Events
+     */
+    readonly valueChange: EventEmitter<ScoradSubjectiveData>;
 }

package/dist/weightings/component.d.ts

@@ -1,13 +1,36 @@
 import { HTMLComponentElement, EventEmitter } from '@ntix/components-core';
-export interface HTMLScoradWeightingsElementEventMap extends HTMLElementEventMap {
-    'value-input': CustomEvent<boolean>;
-    'value-change': CustomEvent<boolean>;
-}
-export declare class HTMLScoradWeightingsElement extends HTMLComponentElement<HTMLScoradWeightingsElementEventMap> {
+import { HTMLScoradValueElement } from '../HTMLScoradValueElement';
+/**
+ * A toggle component to switch between 'Adult' and 'Child' SCORAD calculation weightings.
+ * This component maps a boolean state to specific clinical weighting logic,
+ * primarily influencing the surface area calculation in the Extent (Section A) component.
+ */
+export declare class HTMLScoradWeightingsElement extends HTMLComponentElement<HTMLScoradValueElement<boolean>> {
     connectedCallback(): void;
+    /**
+     * Value is readonly
+     * @group Properties
+     */
+    readonly: boolean;
+    /**
+     * The current value of the component.
+     * @group Properties
+     */
     value: boolean;
     afterRender(): void;
     render(): import('@ntix/components-renderer').HTMLLiteralResult;
-    valueInput: EventEmitter<boolean>;
-    valueChange: EventEmitter<boolean>;
+    /**
+     * Fired immediately as the user interacts with the input (high frequency).
+     *
+     * @param detail - The current value during input.
+     * @group Events
+     */
+    readonly valueInput: EventEmitter<boolean>;
+    /**
+     * Fired when the value is finalized or "committed" by the user.
+     *
+     * @param detail - The final updated value.
+     * @group Events
+     */
+    readonly valueChange: EventEmitter<boolean>;
 }

package/docs/HTMLScoradValueElement.md

@@ -0,0 +1,35 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Interfaces
+
+### HTMLScoradValueElement
+
+Common interface for SCORAD input elements.
+
+This interface defines the standard reactive contract for components that manage a generic score value.
+
+#### Extends
+
+- `HTMLElementEventMap`
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The data type of the SCORAD value |
+
+#### Events
+
+| Event | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="value-change"></a> `value-change` | `readonly` | `CustomEvent`\<`T`\> | Fired when the value is finalized or "committed" by the user. **Param** The final updated value of type [T](#t). |
+| <a id="value-input"></a> `value-input` | `readonly` | `CustomEvent`\<`T`\> | Fired immediately as the user interacts with the input (high frequency). **Param** The current value of type [T](#t) during input. |
+
+#### Properties
+
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="readonly"></a> `readonly` | `public` | `boolean` | Value is readonly |
+| <a id="value"></a> `value` | `readonly` | `T` | The current value of the component. |

package/docs/README.md

@@ -0,0 +1,36 @@
+**@ntix/components-scorad**
+
+***
+
+## Components
+
+- [component](component.md)
+- [extent/component](extent.component.md)
+- [HTMLScoradValueElement](HTMLScoradValueElement.md)
+- [intensity/component](intensity.component.md)
+- [subjective/component](subjective.component.md)
+- [weightings/component](weightings.component.md)
+
+## Data
+
+- [constants](constants.md)
+- [ScoradData](ScoradData.md)
+- [ScoradExtentData](ScoradExtentData.md)
+- [ScoradExtentWeights](ScoradExtentWeights.md)
+- [ScoradIntensityData](ScoradIntensityData.md)
+- [ScoradScore](ScoradScore.md)
+- [ScoradSubjectiveData](ScoradSubjectiveData.md)
+- [selectScoradWeights](selectScoradWeights.md)
+
+## Functions
+
+- [getScoradScore](getScoradScore.md)
+- [validateScoradData](validateScoradData.md)
+
+## Resources
+
+- [ScoradResources](ScoradResources.md)
+
+## Utils
+
+- [componentsScoradLogger](componentsScoradLogger.md)

package/docs/ScoradData.md

@@ -0,0 +1,13 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradData
+
+```ts
+type ScoradData = object;
+```
+
+The complete data model for the SCORAD index, containing all three components (A, B, C).

package/docs/ScoradExtentData.md

@@ -0,0 +1,63 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradExtentData
+
+```ts
+type ScoradExtentData = object;
+```
+
+Represents the raw percentage affected (0-100) for each of the six SCORAD regions.
+
+#### Properties
+
+##### anteriorTrunk
+
+```ts
+anteriorTrunk: number;
+```
+
+Percentage (0-100) of the Anterior Trunk region affected.
+
+##### genitals
+
+```ts
+genitals: number;
+```
+
+Percentage (0-100) of the Genital region affected.
+
+##### headNeck
+
+```ts
+headNeck: number;
+```
+
+Percentage (0-100) of the Head and Neck region affected.
+
+##### lowerLimbs
+
+```ts
+lowerLimbs: number;
+```
+
+Percentage (0-100) of the Lower Limbs region affected.
+
+##### posteriorTrunk
+
+```ts
+posteriorTrunk: number;
+```
+
+Percentage (0-100) of the Posterior Trunk region affected.
+
+##### upperLimbs
+
+```ts
+upperLimbs: number;
+```
+
+Percentage (0-100) of the Upper Limbs region affected.

package/docs/ScoradExtentWeights.md

@@ -0,0 +1,13 @@
+[**@ntix/components-scorad**](README.md)
+
+***
+
+## Type Aliases
+
+### ScoradExtentWeights
+
+```ts
+type ScoradExtentWeights = Readonly<ScoradExtentData>;
+```
+
+Defines the type for the fixed BSA weights.