Overview
@roar-firebase-functions/core
This documentation covers the complete API for the ROAR Firebase Functions core library, organized into the following sections:
Enumerations
Type-safe sets of named constants used throughout the system, including collection types, SSO provider types, and query operators.
Classes
Core implementation classes organized into repository classes for data access, error classes for handling exceptions, and utility classes for support functionality.
- AdministrationServiceError
- FirebaseClientError
- FirebaseImplementationError
- FirestoreAdministrationRepository
- FirestoreAdministrationRepositoryError
- FirestoreBaseRepository
- FirestoreFilterAdapter
- FirestoreIdentityProviderRepository
- FirestoreIdentityProviderRepositoryError
- FirestoreOrgRepository
- FirestoreOrgRepositoryError
- FirestoreRepositoryError
- FirestoreUserClaimRepository
- FirestoreUserClaimRepositoryError
- FirestoreUserRepository
- FirestoreUserRepositoryError
- IdentityProviderServiceError
Interfaces
Core data structures and contracts covering administration, identity/authorization, organizations, repositories, parameters, Firestore implementation, and legal documentation.
- _setAdministrationIdsParams
- Administration
- AdministrationBaseRepository
- AdministrationService
- AssentConsent
- Assessment
- BaseModel
- BaseRepository
- Claims
- CompositeCondition
- CompositeFilter
- CreateAdministrationServiceParams
- createIdentityProviderServiceParams
- CreateParams
- DeleteParams
- EducationalOrgsList
- FieldCondition
- FilterAdapter
- FirestoreCreateParams
- FirestoreDeleteParams
- FirestoreFetchDocumentParams
- FirestoreGetAllParams
- FirestoreGetByIdParams
- FirestoreGetByNameParams
- FirestoreGetByRoarUidParams
- FirestoreGetParams
- FirestoreGetWithFiltersParams
- FirestoreImplementation
- FirestoreRunTransactionParams
- FirestoreUpdateParams
- FutureParams
- GetAdministrationIdsForAdministratorParams
- getAdministrationIdsFromOrgsParams
- GetAdministrationIdsFromOrgsParams
- GetAllParams
- GetByNameParams
- GetByProviderIdParams
- GetByRoarUidParams
- GetParams
- GetRoarUidParams
- IdentityProvider
- IdentityProviderBaseRepository
- IdentityProviderService
- Legal
- OrgBase
- OrgBaseRepository
- OrgsList
- Result
- RunTransactionParams
- SingleFilter
- UpdateParams
- User
- UserBaseRepository
- UserClaim
- UserClaimBaseRepository
Type Aliases
Reusable type definitions for filters, Firestore events, parameter values and conditions.
- BaseFilter
- ComparisonOperator
- Condition
- DocumentCreatedEvent
- DocumentDeletedEvent
- DocumentUpdatedEvent
- DocumentWrittenEvent
- ParameterValue
- SelectAllCondition
Variables
Essential Firebase client instances and system constants providing access to Firebase services and configuration.
Functions
Utility and factory functions for service creation, data processing and system setup.