@univ-lehavre/atlas-redcap-core
v1.1.5
Published
Pure functional core for REDCap domain logic with Effect
Readme
@univ-lehavre/atlas-redcap-core
Coeur fonctionnel REDCap partagé par les packages Atlas.
About
Ce package rassemble les briques pures utilisées par les clients et services REDCap: types brandés, erreurs Effect, parsing et comparaison de versions, content-types, validation de formats, builders de paramètres et adaptateurs par versions REDCap 14, 15 et 16.
Features
- Branded types: Typed identifiers (RecordId, ProjectId, etc.)
- Error handling: REDCap error types with Effect
- Version detection: REDCap version parsing and comparison
- Content types: REDCap API content type definitions
- Validation: Input validation utilities
- Adapters: Version-specific API adapters
Installation
pnpm add @univ-lehavre/atlas-redcap-core effectUsage
import { RecordId, ProjectId } from '@univ-lehavre/atlas-redcap-core/brands';
import { RedcapError } from '@univ-lehavre/atlas-redcap-core/errors';
import { parseVersion } from '@univ-lehavre/atlas-redcap-core/version';Exports
| Export | Description |
|--------|-------------|
| /brands | Branded types for typed identifiers |
| /errors | REDCap error types |
| /version | Version parsing and comparison |
| /content-types | API content type definitions |
| /params | Request parameter types |
| /adapters | Version-specific adapters |
| /validation | Validation utilities |
| /utils | General utilities |
| /types | Shared type definitions |
Scripts
pnpm -F @univ-lehavre/atlas-redcap-core dev # Development
pnpm -F @univ-lehavre/atlas-redcap-core build # Build
pnpm -F @univ-lehavre/atlas-redcap-core test # Tests
pnpm -F @univ-lehavre/atlas-redcap-core typecheck # Type checking
pnpm -F @univ-lehavre/atlas-redcap-core lint # ESLintDocumentation
Organization
This package is part of Atlas, a set of tools developed by Le Havre Normandie University to facilitate research and collaboration between researchers.
Atlas is developed as part of two projects led by Le Havre Normandie University:
- Campus Polytechnique des Territoires Maritimes et Portuaires: research and training program focused on maritime and port issues
- EUNICoast: European university alliance bringing together institutions located in European coastal areas
License
MIT
