@ntix/components-scorad 1.0.1 → 1.0.3

package/LICENSE.md

@@ -0,0 +1,32 @@
+# License: @ntix/components-scorad
+
+Copyright (c) 2025 Antix Software Limited ([antix.co.uk](https://antix.co.uk))
+
+## 1. PURPOSE
+This license governs the use of the @ntix/components-scorad software package, including all source code, assets, and compiled distributions (the "Software"). The Software is owned and managed by Antix Software Limited.
+
+## 2. EVALUATION & PERSONAL USE
+Permission is granted to any person obtaining a copy of this Software to use it for **personal, educational, or internal evaluation purposes** only. 
+
+* This allows for local testing, prototyping, and development-environment integration.
+* Any deployment to a production environment or use beyond evaluation requires adherence to the terms below.
+
+## 3. COMMERCIAL USE
+**Commercial Use requires a separate paid license agreement from Antix.** Commercial Use includes, but is not limited to:
+* Use within a for-profit organization.
+* Integration into revenue-generating products or services.
+* Use within private medical systems or Electronic Health Record (EHR) platforms.
+
+To purchase a Commercial License, please contact Antix at [hello@antix.co.uk].
+
+## 4. NON-PROFIT, RESEARCH & PUBLIC HEALTH
+For use by registered non-profit organizations, academic researchers, or public health bodies, you must **inform Antix prior to deployment**. 
+
+Please provide a project summary to [hello@antix.co.uk]. Antix reserves the right to grant or withhold permission based on the project's adherence to clinical safety and quality standards.
+
+## 5. RESTRICTIONS
+* **Redistribution:** You may not redistribute, sub-license, or sell the Software as a standalone library or part of a third-party UI kit.
+* **Attribution:** All copies of the Software must retain the original Antix copyright notices.
+
+## 6. LIMITATION OF LIABILITY
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL ANTIX BE LIABLE FOR ANY CLAIM, DAMAGES, MEDICAL INACCURACIES, OR OTHER LIABILITY ARISING FROM THE USE OF THE SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @ntix/components-scorad
+
+A professional-grade component library for calculating and visualizing SCORAD (SCORing Atopic Dermatitis) assessments. Developed by Antix Software Limited.
+
+<a href="https://antix.co.uk/scorad">
+  <img src="https://github-production-user-asset-6210df.s3.amazonaws.com/873305/531299043-0c2a392c-f250-493f-b444-696413df6757.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20260101%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260101T004816Z&X-Amz-Expires=300&X-Amz-Signature=822cca7d3b90525f61745a99c5cc64765128ba7a59b6a3d4f43d433103748ccc&X-Amz-SignedHeaders=host" alt="SCORAD Component Preview" width="320" />
+</a>
+
+**View the interactive demo [antix.co.uk/scorad](https://antix.co.uk/scorad)**
+
+## Features
+
+- Interactive Body Maps: High-performance SVG-based surface area selection.
+- SCORAD Formula: Sections A (Extent), B (Intensity), and C (Subjective).
+- Custom Elements: Easy integration with any framework or plain HTML.
+
+## Validation & Accuracy
+This component has been mathematically validated against the ETFAD SCORAD reference standards. 
+See [VALIDATION.md](./VALIDATION.md) for the full report and test coverage details.
+
+## Installation
+
+```shell
+npm install @ntix/components-scorad
+```
+
+## Quick Start
+
+### 1. Configuration (CSS Variables)
+This library uses CSS variables for theming. Add these to your global styles:
+
+```css
+:root {
+  --color: #444;
+  --background-color: #eee;
+  --scorad-h: 75; 
+
+  color: var(--color);
+  background-color: var(--background-color);
+}
+```
+
+### 2. Usage
+Import the package to register the custom elements:
+
+```js
+import '@ntix/components-scorad';
+```
+
+Then add the component to your HTML:
+
+```html
+<scorad-component></scorad-component>
+```
+
+## Licensing
+
+This package is NOT open-source. Usage is governed by the Antix Software License. 
+For the full legal terms, please refer to the LICENSE.md file included in this package.
+
+- Personal & Evaluation: Free for personal projects and local evaluation.
+- Commercial Use: Requires a paid license agreement.
+- Non-Profit & Research: Free use permitted, but you MUST inform Antix prior to deployment.
+
+Contact: hello@antix.co.uk
+
+## Clinical Disclaimer
+
+The SCORAD calculation is a clinical tool intended for use by healthcare professionals. Antix Software Limited does not provide medical advice. The Software is provided "as is," and Antix is not liable for clinical decisions or diagnostic inaccuracies.
+
+---
+
+(c) 2025 Antix Software Limited ([antix.co.uk](https://antix.co.uk)). All rights reserved.

package/VALIDATION.md

@@ -0,0 +1,39 @@
+# Validation: @ntix/components-scorad
+
+## 1. Overview
+This document outlines the validation procedures and mathematical accuracy of the SCORAD (SCORing Atopic Dermatitis) calculation logic within this package.
+
+## 2. Reference Standard
+The implementation is based on the consensus report of the European Task Force on Atopic Dermatitis (ETFAD).
+
+**Formula:** $Score = \frac{A}{5} + \frac{7B}{2} + C$
+
+- **A (Extent):** Surface area percentage (0–100). Includes adult/child weighting adjustments for head and limbs.
+- **B (Intensity):** Sum of 6 clinical signs (0–3 each), max 18.
+- **C (Subjective):** Sum of Pruritus and Insomnia (0–10 each), max 20.
+
+## 3. Automated Test Suite
+Validation is performed using `vitest` in a `happy-dom` environment. The following critical paths are verified on every build:
+
+### 3.1. Boundary Testing
+- **Minimum Score:** Confirmed $0.00$ when all inputs are zero.
+- **Maximum Score:** Confirmed $103.00$ when all inputs are at maximum capacity.
+
+### 3.2. Weighting & Precision
+- **Intensity Weighting:** Verifies that Intensity (Section B) contributes to the total with a multiplier of $3.5$ (e.g., an Intensity of 3 results in a sub-score of 10.5).
+- **Rounding:** Results are rounded to 2 decimal places to ensure consistency across clinical documentation.
+
+### 3.3. Age-Based Extent (Adult vs Child)
+- Validates the calculation across both adult and pediatric surface area distributions.
+
+## 4. Error Handling & Safety
+The library implements strict validation via `@ntix/components-core`. Calculations will fail with a descriptive `Failure` object if:
+- Extent values exceed physiological maximums.
+- Intensity values fall outside the 0–3 range.
+- Subjective values fall outside the 0–10 range.
+
+## 5. Summary
+The @ntix/components-scorad calculation logic is deemed mathematically sound and compliant with the ETFAD standard for digital SCORAD assessments.
+
+---
+© 2025 Antix Software Limited ([antix.co.uk](https://antix.co.uk)). Prepared for clinical and commercial review.