Interfaces

This documentation covers the interfaces that define the core data structures and contracts in the ROAR Firebase Functions library.

Administration & Assessment

• Administration - Core data structure for administrations including assessments and org settings
• AdministrationBaseRepository - Base repository for Administration CRUD operations
• AdministrationService - Service layer for administration operations
• Assessment - Data structure for individual assessments and parameters

Identity & Authorization

• IdentityProvider - Provider identity and sync state
• IdentityProviderService - Identity provider operations
• User - Basic user properties
• UserClaim - User permissions and roles
• UserClaimBaseRepository - Repository for user claims

Organizations

• OrgBase - Core organization data model
• OrgBaseRepository - Organization repository operations
• OrgsList - Organization ID collection structure
• EducationalOrgsList - Educational institution organization list

Repository Base Classes

• BaseRepository - Generic repository with CRUD operations
• Result - Operation result wrapper
• FilterAdapter - Filter format conversion
• SingleFilter - Field comparison filter

Repository Parameters

• CreateParams - Create operation parameters
• DeleteParams - Delete operation parameters
• GetParams - Get operation parameters
• UpdateParams - Update operation parameters
• GetByNameParams - Name lookup parameters
• GetByRoarUidParams - ROAR UID lookup parameters
• RunTransactionParams - Transaction parameters

Firestore Implementation

• FirestoreImplementation - Firestore-specific repository and service implementation
• FirestoreCreateParams - Firestore create parameters
• FirestoreDeleteParams - Firestore delete parameters
• FirestoreGetParams - Firestore get parameters
• FirestoreUpdateParams - Firestore update parameters

Legal & Consent

• Legal - Legal information structure
• AssentConsent - Assent/consent document structure