From b7dda0a0c4809aa2418beb1ac3e2cab008ca3bfd Mon Sep 17 00:00:00 2001 From: richford Date: Fri, 19 Jan 2024 18:56:26 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20yeatmanl?= =?UTF-8?q?ab/roar-firekit@c085ea5664f3acfad6168dea10225d2e370c2b22=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/firestore_app_appkit.RoarAppkit.html | 18 +++++++++--------- classes/firestore_app_run.RoarRun.html | 14 +++++++------- .../firestore_app_task.RoarTaskVariant.html | 8 ++++---- classes/firestore_app_user.RoarAppUser.html | 8 ++++---- classes/firestore_firekit.RoarFirekit.html | 8 ++++---- enums/firestore_interfaces.UserType.html | 2 +- enums/firestore_util.AuthPersistence.html | 2 +- index.html | 2 +- .../firestore_app_run.IComputedScores.html | 2 +- interfaces/firestore_app_run.IRawScores.html | 2 +- interfaces/firestore_app_run.IRunInput.html | 2 +- interfaces/firestore_app_run.IRunScores.html | 2 +- .../firestore_app_task.IFirestoreTaskData.html | 2 +- ...restore_app_task.IFirestoreVariantData.html | 2 +- interfaces/firestore_app_task.ITaskData.html | 2 +- .../firestore_app_task.ITaskVariantInfo.html | 2 +- .../firestore_app_task.ITaskVariantInput.html | 2 +- interfaces/firestore_app_user.IUserInfo.html | 2 +- interfaces/firestore_app_user.IUserInput.html | 2 +- .../firestore_app_user.IUserUpdateInput.html | 6 +++--- .../firestore_firekit.IRequestConfig.html | 2 +- .../firestore_interfaces.IAdminData.html | 2 +- ...restore_interfaces.IAdministrationData.html | 2 +- .../firestore_interfaces.IAssessmentData.html | 2 +- ...ore_interfaces.IAssignedAssessmentData.html | 2 +- .../firestore_interfaces.IAssignmentData.html | 2 +- ...irestore_interfaces.IAssignmentDateMap.html | 2 +- interfaces/firestore_interfaces.IClass.html | 2 +- interfaces/firestore_interfaces.IDistrict.html | 2 +- ...firestore_interfaces.IExternalUserData.html | 2 +- .../firestore_interfaces.IExtraMetadata.html | 2 +- interfaces/firestore_interfaces.IFamily.html | 2 +- interfaces/firestore_interfaces.IFirekit.html | 2 +- interfaces/firestore_interfaces.IGroup.html | 2 +- interfaces/firestore_interfaces.IName.html | 2 +- .../firestore_interfaces.IOrgDateMap.html | 2 +- interfaces/firestore_interfaces.IOrgLists.html | 2 +- interfaces/firestore_interfaces.IOrgs.html | 2 +- .../firestore_interfaces.IRoarConfigData.html | 2 +- interfaces/firestore_interfaces.ISchool.html | 2 +- .../firestore_interfaces.IStudentData.html | 2 +- interfaces/firestore_interfaces.IUserData.html | 2 +- ...irestore_query_assessment.ITaskVariant.html | 2 +- ...uery_assessment_compat.IUserQueryInput.html | 2 +- .../firestore_util.CommonFirebaseConfig.html | 2 +- .../firestore_util.EmulatorConfigData.html | 2 +- interfaces/firestore_util.IUserDocument.html | 2 +- interfaces/firestore_util.MarkRawConfig.html | 2 +- interfaces/firestore_util.RealConfigData.html | 2 +- modules.html | 2 +- modules/auth.html | 2 +- modules/firestore_app_appkit.html | 2 +- modules/firestore_app_run.html | 2 +- modules/firestore_app_task.html | 2 +- modules/firestore_app_user.html | 2 +- modules/firestore_firekit.html | 2 +- modules/firestore_interfaces.html | 2 +- modules/firestore_query_assessment.html | 2 +- modules/firestore_query_assessment_compat.html | 2 +- modules/firestore_util.html | 12 ++++++------ modules/index.html | 2 +- 61 files changed, 91 insertions(+), 91 deletions(-) diff --git a/classes/firestore_app_appkit.RoarAppkit.html b/classes/firestore_app_appkit.RoarAppkit.html index 577fcba2..183c52de 100644 --- a/classes/firestore_app_appkit.RoarAppkit.html +++ b/classes/firestore_app_appkit.RoarAppkit.html @@ -1,20 +1,20 @@ -RoarAppkit | @bdelab/roar-firekit - v4.3.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoarAppkit

+RoarAppkit | @bdelab/roar-firekit - v4.3.1
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoarAppkit

The RoarAppkit class is the main entry point for ROAR apps using the ROAR Firestore API. It represents multiple linked Firestore documents and provides methods for interacting with them.

-

Hierarchy

  • RoarAppkit

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RoarAppkit(input: IAppkitConstructorParams): RoarAppkit

Hierarchy

  • RoarAppkit

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RoarAppkit(input: IAppkitConstructorParams): RoarAppkit

Properties

Private Optional _assigningOrgs

_assigningOrgs?: IOrgLists

Private Optional _assignmentId

_assignmentId?: string

Private _authenticated

_authenticated: boolean

Private _initialized

_initialized: boolean

Private Optional _readOrgs

_readOrgs?: IOrgLists

Private Optional _runId

_runId?: string

Private _started

_started: boolean

Private _taskInfo

_taskInfo: ITaskVariantInfo

Private _userInfo

_userInfo: IUserInfo

Optional firebaseConfig

firebaseConfig?: FirebaseConfigData

Optional firebaseProject

firebaseProject?: IFirekit

Optional run

run?: RoarRun

Optional task

task?: RoarTaskVariant

Optional user

user?: RoarAppUser

Accessors

authenticated

  • get authenticated(): boolean

Methods

Private _init

  • _init(): Promise<void>

abortRun

  • abortRun(): void

Properties

Private Optional _assigningOrgs

_assigningOrgs?: IOrgLists

Private Optional _assignmentId

_assignmentId?: string

Private _authenticated

_authenticated: boolean

Private _initialized

_initialized: boolean

Private Optional _readOrgs

_readOrgs?: IOrgLists

Private Optional _runId

_runId?: string

Private _started

_started: boolean

Private _taskInfo

_taskInfo: ITaskVariantInfo

Private _userInfo

_userInfo: IUserInfo

Optional firebaseConfig

firebaseConfig?: FirebaseConfigData

Optional firebaseProject

firebaseProject?: IFirekit

Optional run

run?: RoarRun

Optional task

task?: RoarTaskVariant

Optional user

user?: RoarAppUser

Accessors

authenticated

  • get authenticated(): boolean

Methods

Private _init

  • _init(): Promise<void>

abortRun

  • abortRun(): void

finishRun

  • finishRun(): Promise<undefined | boolean>

finishRun

  • finishRun(): Promise<undefined | boolean>

  • Finish the ROAR run by marking it as finished in Firestore. Call this method after the jsPsych experiment finishes. For example:

    jsPsych.init({
      timeline: exp,
      on_finish: function(data) {
        firekit.finishRun();
      }
    });
    -
    method
    async

    Returns Promise<undefined | boolean>

startRun

  • startRun(additionalRunMetadata?: {}): Promise<boolean>

startRun

  • startRun(additionalRunMetadata?: {}): Promise<boolean>

  • Start the ROAR run. Push the task and run info to Firestore. Call this method before starting the jsPsych experiment.

    -
    method
    async

    Parameters

    • Optional additionalRunMetadata: {}
      • [key: string]: string

    Returns Promise<boolean>

updateEngagementFlags

  • updateEngagementFlags(flagNames: string[], markAsReliable?: boolean): Promise<void>
  • +
    method
    async

    Parameters

    • Optional additionalRunMetadata: {}
      • [key: string]: string

    Returns Promise<boolean>

updateEngagementFlags

  • updateEngagementFlags(flagNames: string[], markAsReliable?: boolean): Promise<void>

  • Update the engagement flags for the current run.

    method
    async

    Please note that calling this function with a new set of engagement flags will overwrite the previous set.

    @@ -22,12 +22,12 @@

    The names of the engagement flags to add.

  • markAsReliable: boolean = false

    Whether or not to mark the run as reliable, defaults to false

    -

    • Returns Promise<void>

    updateTaskParams

    • updateTaskParams(newParams: {}): Promise<void>

    Returns Promise<void>

    updateTaskParams

    • updateTaskParams(newParams: {}): Promise<void>

    • Update the ROAR task's game parameters. This must be called after the startRun() method.

      -
      method
      async

      Parameters

      • newParams: {}
        • [key: string]: unknown

      Returns Promise<void>

    updateUser

    updateUser

    writeTrial

    • writeTrial(trialData: Record<string, unknown>, computedScoreCallback?: ((rawScores: IRawScores) => Promise<IComputedScores>)): Promise<void>

    writeTrial

    • writeTrial(trialData: Record<string, unknown>, computedScoreCallback?: ((rawScores: IRawScores) => Promise<IComputedScores>)): Promise<void>

    finishRun

    • finishRun(): Promise<undefined | boolean>

    • Mark this run as complete on Firestore

      -
      method
      async

      Returns Promise<undefined | boolean>

    startRun

    • startRun(additionalRunMetadata?: {}): Promise<void>

    startRun

    • startRun(additionalRunMetadata?: {}): Promise<void>

    • Create a new run on Firestore

      -
      method
      async

      Parameters

      • Optional additionalRunMetadata: {}
        • [key: string]: unknown

      Returns Promise<void>

    writeTrial

    • writeTrial(trialData: Record<string, unknown>, computedScoreCallback?: ((rawScores: IRawScores) => Promise<IComputedScores>)): Promise<void>
    • +
      method
      async

      Parameters

      • Optional additionalRunMetadata: {}
        • [key: string]: unknown

      Returns Promise<void>

    writeTrial

    • writeTrial(trialData: Record<string, unknown>, computedScoreCallback?: ((rawScores: IRawScores) => Promise<IComputedScores>)): Promise<void>

    createAdministrator

    createOrg

    createStudentWithEmailPassword

    • createStudentWithEmailPassword(email: string, password: string, userData: ICreateUserInput): Promise<void>

    createStudentWithUsernamePassword

    • createStudentWithUsernamePassword(username: string, password: string, userData: ICreateUserInput): Promise<void>

    • Parameters

      • username: string
      • password: string
      • userData: ICreateUserInput

      Returns Promise<void>

    deleteAdministration

    • deleteAdministration(administrationId: string): Promise<void>

    • Delete an administration

      Parameters

      • administrationId: string

        The administration ID to delete

        -

      Returns Promise<void>

    fetchEmailAuthMethods

    • fetchEmailAuthMethods(email: string): Promise<string[]>

    getLegalDoc

    • getLegalDoc(docName: string): Promise<null | { text: string; version: any }>

    getMyData

    • getMyData(): Promise<void>

    getOrgs

    getTasks

    • getTasks(requireRegistered?: boolean): Promise<ITaskData[]>

    getUsers

    • getUsers(uidArray: string[]): Promise<undefined | IUserData>[]

    getVariants

    • getVariants(requireRegistered?: boolean): Promise<ITaskVariant[]>

    init

    initiateLoginWithEmailLink

    • initiateLoginWithEmailLink(__namedParameters: { email: string; redirectUrl: string }): Promise<void>

    • Parameters

      • __namedParameters: { email: string; redirectUrl: string }
        • email: string
        • redirectUrl: string

      Returns Promise<void>

    initiateRedirect

    • initiateRedirect(provider: AuthProviderType): Promise<never>

    isAdmin

    • isAdmin(): boolean

    isEmailAvailable

    • isEmailAvailable(email: string): Promise<boolean>

    isRoarAuthEmail

    • isRoarAuthEmail(email: string): boolean

    isSignInWithEmailLink

    • isSignInWithEmailLink(emailLink: string): Promise<boolean>

    isUsernameAvailable

    • isUsernameAvailable(username: string): Promise<boolean>

    listUsers

    • listUsers(): Promise<void>

    logInWithEmailAndPassword

    • logInWithEmailAndPassword(__namedParameters: { email: string; password: string }): Promise<HttpsCallableResult<unknown>>

    • Parameters

      • __namedParameters: { email: string; password: string }
        • email: string
        • password: string

      Returns Promise<HttpsCallableResult<unknown>>

    logInWithUsernameAndPassword

    • logInWithUsernameAndPassword(__namedParameters: { password: string; username: string }): Promise<HttpsCallableResult<unknown>>

    • Parameters

      • __namedParameters: { password: string; username: string }
        • password: string
        • username: string

      Returns Promise<HttpsCallableResult<unknown>>

    registerTaskVariant

    registerWithEmailAndPassword

    • registerWithEmailAndPassword(__namedParameters: { email: string; password: string }): Promise<HttpsCallableResult<unknown>>

    • Parameters

      • __namedParameters: { email: string; password: string }
        • email: string
        • password: string

      Returns Promise<HttpsCallableResult<unknown>>

    selectBestRun

    • selectBestRun(__namedParameters: { assignmentId: string; taskId: string }): Promise<undefined>

    • Parameters

      • __namedParameters: { assignmentId: string; taskId: string }
        • assignmentId: string
        • taskId: string

      Returns Promise<undefined>

    signInFromRedirectResult

    • signInFromRedirectResult(enableCookiesCallback: (() => void)): Promise<null | { status: string }>

    • Parameters

      • enableCookiesCallback: (() => void)
          • (): void

          • Returns void

      Returns Promise<null | { status: string }>

    signInWithEmailLink

    • signInWithEmailLink(__namedParameters: { email: string; emailLink: string }): Promise<undefined | HttpsCallableResult<unknown>>

    • Parameters

      • __namedParameters: { email: string; emailLink: string }
        • email: string
        • emailLink: string

      Returns Promise<undefined | HttpsCallableResult<unknown>>

    signInWithPopup

    • signInWithPopup(provider: AuthProviderType): Promise<void>

    signOut

    • signOut(): Promise<void>

    startAssessment

    • startAssessment(administrationId: string, taskId: string): Promise<RoarAppkit>

    startAssignment

    • startAssignment(administrationId: string, transaction?: Transaction): Promise<void | Transaction>

    • Parameters

      • administrationId: string
      • Optional transaction: Transaction

      Returns Promise<void | Transaction>

    syncCleverOrgs

    • syncCleverOrgs(shallow?: boolean): Promise<void>

    unassignAdministrationToOrgs

    • unassignAdministrationToOrgs(administrationId: string, orgs?: IOrgLists): Promise<void>

    updateAssessmentRewardShown

    • updateAssessmentRewardShown(administrationId: string, taskId: string): Promise<void>

    updateConsentStatus

    • updateConsentStatus(docName: string, consentVersion: string): Promise<void>

    updateUserExternalData

    • updateUserExternalData(uid: string, externalResourceId: string, externalData: IExternalUserData): Promise<void>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    fetchEmailAuthMethods

    getLegalDoc

    getMyData

    getOrgs

    getTasks

    getUsers

    getVariants

    init

    initiateLoginWithEmailLink

    initiateRedirect

    isAdmin

    isEmailAvailable

    isRoarAuthEmail

    isSignInWithEmailLink

    isUsernameAvailable

    listUsers

    logInWithEmailAndPassword

    logInWithUsernameAndPassword

    registerTaskVariant

    registerWithEmailAndPassword

    selectBestRun

    signInFromRedirectResult

    signInWithEmailLink

    signInWithPopup

    signOut

    startAssessment

    startAssignment

    syncCleverOrgs

    unassignAdministrationToOrgs

    updateAssessmentRewardShown

    updateConsentStatus

    updateUserExternalData

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/firestore_interfaces.UserType.html b/enums/firestore_interfaces.UserType.html index 30361c9e..231b677e 100644 --- a/enums/firestore_interfaces.UserType.html +++ b/enums/firestore_interfaces.UserType.html @@ -1 +1 @@ -UserType | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration UserType

    Index

    Enumeration Members

    Enumeration Members

    admin

    admin: "admin"

    caregiver

    caregiver: "caregiver"

    educator

    educator: "educator"

    guest

    guest: "guest"

    researcher

    researcher: "researcher"

    student

    student: "student"

    Generated using TypeDoc

    \ No newline at end of file +UserType | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration UserType

    Index

    Enumeration Members

    Enumeration Members

    admin

    admin: "admin"

    caregiver

    caregiver: "caregiver"

    educator

    educator: "educator"

    guest

    guest: "guest"

    researcher

    researcher: "researcher"

    student

    student: "student"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/enums/firestore_util.AuthPersistence.html b/enums/firestore_util.AuthPersistence.html index 667610c3..3bc709b3 100644 --- a/enums/firestore_util.AuthPersistence.html +++ b/enums/firestore_util.AuthPersistence.html @@ -1 +1 @@ -AuthPersistence | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration AuthPersistence

    Index

    Enumeration Members

    Enumeration Members

    local

    local: "local"

    none

    none: "none"

    session

    session: "session"

    Generated using TypeDoc

    \ No newline at end of file +AuthPersistence | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Enumeration AuthPersistence

    Index

    Enumeration Members

    Enumeration Members

    local

    local: "local"

    none

    none: "none"

    session

    session: "session"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index 71da7bf2..8764277d 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -@bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @bdelab/roar-firekit - v4.3.0

    npm version +@bdelab/roar-firekit - v4.3.1

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @bdelab/roar-firekit - v4.3.1

    npm version NPM License

    diff --git a/interfaces/firestore_app_run.IComputedScores.html b/interfaces/firestore_app_run.IComputedScores.html index e9a75413..22ff9f94 100644 --- a/interfaces/firestore_app_run.IComputedScores.html +++ b/interfaces/firestore_app_run.IComputedScores.html @@ -1 +1 @@ -IComputedScores | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IComputedScores

    Hierarchy

    • IComputedScores

    Indexable

    [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IComputedScores | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IComputedScores

    Hierarchy

    • IComputedScores

    Indexable

    [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_run.IRawScores.html b/interfaces/firestore_app_run.IRawScores.html index d2679be5..9125d304 100644 --- a/interfaces/firestore_app_run.IRawScores.html +++ b/interfaces/firestore_app_run.IRawScores.html @@ -1 +1 @@ -IRawScores | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRawScores

    Hierarchy

    • IRawScores

    Indexable

    [key: string]: { practice: ISummaryScores; test: ISummaryScores }
    • practice: ISummaryScores
    • test: ISummaryScores

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IRawScores | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRawScores

    Hierarchy

    • IRawScores

    Indexable

    [key: string]: { practice: ISummaryScores; test: ISummaryScores }
    • practice: ISummaryScores
    • test: ISummaryScores

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_run.IRunInput.html b/interfaces/firestore_app_run.IRunInput.html index 993392fa..88d3ea1a 100644 --- a/interfaces/firestore_app_run.IRunInput.html +++ b/interfaces/firestore_app_run.IRunInput.html @@ -1 +1 @@ -IRunInput | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRunInput

    Hierarchy

    • IRunInput

    Index

    Properties

    Properties

    Optional assigningOrgs

    assigningOrgs?: IOrgLists

    Optional assignmentId

    assignmentId?: string

    Optional readOrgs

    readOrgs?: IOrgLists

    Optional runId

    runId?: string

    task

    task: RoarTaskVariant

    user

    user: RoarAppUser

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IRunInput | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRunInput

    Hierarchy

    • IRunInput

    Index

    Properties

    Properties

    Optional assigningOrgs

    assigningOrgs?: IOrgLists

    Optional assignmentId

    assignmentId?: string

    Optional readOrgs

    readOrgs?: IOrgLists

    Optional runId

    runId?: string

    task

    task: RoarTaskVariant

    user

    user: RoarAppUser

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_run.IRunScores.html b/interfaces/firestore_app_run.IRunScores.html index 57046fd1..d51bc5fc 100644 --- a/interfaces/firestore_app_run.IRunScores.html +++ b/interfaces/firestore_app_run.IRunScores.html @@ -1 +1 @@ -IRunScores | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRunScores

    Hierarchy

    • IRunScores

    Index

    Properties

    Properties

    computed

    computed: IComputedScores

    raw

    raw: IRawScores

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IRunScores | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRunScores

    Hierarchy

    • IRunScores

    Index

    Properties

    Properties

    computed

    computed: IComputedScores

    raw

    raw: IRawScores

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_task.IFirestoreTaskData.html b/interfaces/firestore_app_task.IFirestoreTaskData.html index a87d51a7..a81345bc 100644 --- a/interfaces/firestore_app_task.IFirestoreTaskData.html +++ b/interfaces/firestore_app_task.IFirestoreTaskData.html @@ -1 +1 @@ -IFirestoreTaskData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirestoreTaskData

    Hierarchy

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    Optional image

    image?: string

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    Optional registered

    registered?: boolean

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IFirestoreTaskData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirestoreTaskData

    Hierarchy

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    Optional image

    image?: string

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    Optional registered

    registered?: boolean

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_task.IFirestoreVariantData.html b/interfaces/firestore_app_task.IFirestoreVariantData.html index a4fb3a41..279b6251 100644 --- a/interfaces/firestore_app_task.IFirestoreVariantData.html +++ b/interfaces/firestore_app_task.IFirestoreVariantData.html @@ -1 +1 @@ -IFirestoreVariantData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirestoreVariantData

    Hierarchy

    • IFirestoreVariantData

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    params

    params: {}

    Type declaration

    • [key: string]: unknown

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IFirestoreVariantData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirestoreVariantData

    Hierarchy

    • IFirestoreVariantData

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    params

    params: {}

    Type declaration

    • [key: string]: unknown

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_task.ITaskData.html b/interfaces/firestore_app_task.ITaskData.html index 8dc58670..dd3bb556 100644 --- a/interfaces/firestore_app_task.ITaskData.html +++ b/interfaces/firestore_app_task.ITaskData.html @@ -1 +1 @@ -ITaskData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskData

    Hierarchy

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    id

    id: string

    Optional image

    image?: string

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    Optional registered

    registered?: boolean

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ITaskData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskData

    Hierarchy

    Index

    Properties

    Properties

    Optional description

    description?: null | string

    Optional external

    external?: boolean

    id

    id: string

    Optional image

    image?: string

    lastUpdated

    lastUpdated: FieldValue

    Optional name

    name?: string

    Optional registered

    registered?: boolean

    Optional taskURL

    taskURL?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_task.ITaskVariantInfo.html b/interfaces/firestore_app_task.ITaskVariantInfo.html index 8234fd06..740b5cd8 100644 --- a/interfaces/firestore_app_task.ITaskVariantInfo.html +++ b/interfaces/firestore_app_task.ITaskVariantInfo.html @@ -1 +1 @@ -ITaskVariantInfo | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariantInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional external

    external?: boolean

    Optional taskDescription

    taskDescription?: string

    taskId

    taskId: string

    Optional taskImage

    taskImage?: string

    Optional taskName

    taskName?: string

    Optional taskURL

    taskURL?: string

    Optional variantDescription

    variantDescription?: string

    Optional variantName

    variantName?: string

    variantParams

    variantParams: {}

    Type declaration

    • [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ITaskVariantInfo | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariantInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional external

    external?: boolean

    Optional taskDescription

    taskDescription?: string

    taskId

    taskId: string

    Optional taskImage

    taskImage?: string

    Optional taskName

    taskName?: string

    Optional taskURL

    taskURL?: string

    Optional variantDescription

    variantDescription?: string

    Optional variantName

    variantName?: string

    variantParams

    variantParams: {}

    Type declaration

    • [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_task.ITaskVariantInput.html b/interfaces/firestore_app_task.ITaskVariantInput.html index 026364dd..63ae6f5f 100644 --- a/interfaces/firestore_app_task.ITaskVariantInput.html +++ b/interfaces/firestore_app_task.ITaskVariantInput.html @@ -1 +1 @@ -ITaskVariantInput | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariantInput

    Hierarchy

    Index

    Properties

    Properties

    db

    db: Firestore

    Optional external

    external?: boolean

    Optional taskDescription

    taskDescription?: string

    taskId

    taskId: string

    Optional taskImage

    taskImage?: string

    Optional taskName

    taskName?: string

    Optional taskURL

    taskURL?: string

    Optional variantDescription

    variantDescription?: string

    Optional variantName

    variantName?: string

    variantParams

    variantParams: {}

    Type declaration

    • [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ITaskVariantInput | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariantInput

    Hierarchy

    Index

    Properties

    Properties

    db

    db: Firestore

    Optional external

    external?: boolean

    Optional taskDescription

    taskDescription?: string

    taskId

    taskId: string

    Optional taskImage

    taskImage?: string

    Optional taskName

    taskName?: string

    Optional taskURL

    taskURL?: string

    Optional variantDescription

    variantDescription?: string

    Optional variantName

    variantName?: string

    variantParams

    variantParams: {}

    Type declaration

    • [key: string]: unknown

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_user.IUserInfo.html b/interfaces/firestore_app_user.IUserInfo.html index 083aef44..6ba69fb7 100644 --- a/interfaces/firestore_app_user.IUserInfo.html +++ b/interfaces/firestore_app_user.IUserInfo.html @@ -1 +1 @@ -IUserInfo | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string

    assessmentUid

    assessmentUid: string

    Optional roarUid

    roarUid?: string

    Optional userMetadata

    userMetadata?: {}

    Type declaration

    • [key: string]: unknown

    Optional userType

    userType?: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IUserInfo | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserInfo

    Hierarchy

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string

    assessmentUid

    assessmentUid: string

    Optional roarUid

    roarUid?: string

    Optional userMetadata

    userMetadata?: {}

    Type declaration

    • [key: string]: unknown

    Optional userType

    userType?: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_user.IUserInput.html b/interfaces/firestore_app_user.IUserInput.html index 2a29383d..32072dca 100644 --- a/interfaces/firestore_app_user.IUserInput.html +++ b/interfaces/firestore_app_user.IUserInput.html @@ -1 +1 @@ -IUserInput | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserInput

    Hierarchy

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string

    assessmentUid

    assessmentUid: string

    db

    db: Firestore

    Optional roarUid

    roarUid?: string

    Optional userMetadata

    userMetadata?: {}

    Type declaration

    • [key: string]: unknown

    Optional userType

    userType?: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IUserInput | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserInput

    Hierarchy

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string

    assessmentUid

    assessmentUid: string

    db

    db: Firestore

    Optional roarUid

    roarUid?: string

    Optional userMetadata

    userMetadata?: {}

    Type declaration

    • [key: string]: unknown

    Optional userType

    userType?: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_app_user.IUserUpdateInput.html b/interfaces/firestore_app_user.IUserUpdateInput.html index 2aee2488..5adc0fd7 100644 --- a/interfaces/firestore_app_user.IUserUpdateInput.html +++ b/interfaces/firestore_app_user.IUserUpdateInput.html @@ -1,5 +1,5 @@ -IUserUpdateInput | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserUpdateInput

    Hierarchy

    • IUserUpdateInput

    Indexable

    [key: string]: unknown

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string
    +IUserUpdateInput | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserUpdateInput

    Hierarchy

    • IUserUpdateInput

    Indexable

    [key: string]: unknown

    Index

    Properties

    Properties

    Optional assessmentPid

    assessmentPid?: string

    And these are keys that only guest users will be able to create/update

    -

    Optional tasks

    tasks?: string[]
    +

    Optional tasks

    tasks?: string[]

    These are keys that all users can update

    -

    Optional variants

    variants?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Optional variants

    variants?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_firekit.IRequestConfig.html b/interfaces/firestore_firekit.IRequestConfig.html index 3fde4770..318be9d7 100644 --- a/interfaces/firestore_firekit.IRequestConfig.html +++ b/interfaces/firestore_firekit.IRequestConfig.html @@ -1 +1 @@ -IRequestConfig | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRequestConfig

    Hierarchy

    • IRequestConfig

    Index

    Properties

    Properties

    baseURL

    baseURL: string

    headers

    headers: { Authorization: string }

    Type declaration

    • Authorization: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IRequestConfig | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRequestConfig

    Hierarchy

    • IRequestConfig

    Index

    Properties

    Properties

    baseURL

    baseURL: string

    headers

    headers: { Authorization: string }

    Type declaration

    • Authorization: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAdminData.html b/interfaces/firestore_interfaces.IAdminData.html index 52332c1d..9df8da3a 100644 --- a/interfaces/firestore_interfaces.IAdminData.html +++ b/interfaces/firestore_interfaces.IAdminData.html @@ -1 +1 @@ -IAdminData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAdminData

    Hierarchy

    • DocumentData
      • IAdminData

    Index

    Properties

    Properties

    administrationsCreated

    administrationsCreated: string[]

    permissions

    permissions: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAdminData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAdminData

    Hierarchy

    • DocumentData
      • IAdminData

    Index

    Properties

    Properties

    administrationsCreated

    administrationsCreated: string[]

    permissions

    permissions: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAdministrationData.html b/interfaces/firestore_interfaces.IAdministrationData.html index 13715f00..994cb6f2 100644 --- a/interfaces/firestore_interfaces.IAdministrationData.html +++ b/interfaces/firestore_interfaces.IAdministrationData.html @@ -1 +1 @@ -IAdministrationData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAdministrationData

    Hierarchy

    Index

    Properties

    Properties

    assessments

    assessments: IAssessmentData[]

    classes

    classes: string[]

    createdBy

    createdBy: string

    dateClosed

    dateClosed: Date | Timestamp

    dateCreated

    dateCreated: Date | Timestamp

    dateOpened

    dateOpened: Date | Timestamp

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    Optional id

    id?: string

    name

    name: string

    Optional readOrgs

    readOrgs?: IOrgLists

    schools

    schools: string[]

    sequential

    sequential: boolean

    Optional tags

    tags?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAdministrationData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAdministrationData

    Hierarchy

    Index

    Properties

    Properties

    assessments

    assessments: IAssessmentData[]

    classes

    classes: string[]

    createdBy

    createdBy: string

    dateClosed

    dateClosed: Date | Timestamp

    dateCreated

    dateCreated: Date | Timestamp

    dateOpened

    dateOpened: Date | Timestamp

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    Optional id

    id?: string

    name

    name: string

    Optional readOrgs

    readOrgs?: IOrgLists

    schools

    schools: string[]

    sequential

    sequential: boolean

    Optional tags

    tags?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAssessmentData.html b/interfaces/firestore_interfaces.IAssessmentData.html index 37296345..c3e8b3fd 100644 --- a/interfaces/firestore_interfaces.IAssessmentData.html +++ b/interfaces/firestore_interfaces.IAssessmentData.html @@ -1 +1 @@ -IAssessmentData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssessmentData

    Hierarchy

    • DocumentData
      • IAssessmentData

    Index

    Properties

    Properties

    params

    params: {}

    Type declaration

    • [x: string]: unknown

    taskId

    taskId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAssessmentData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssessmentData

    Hierarchy

    • DocumentData
      • IAssessmentData

    Index

    Properties

    Properties

    params

    params: {}

    Type declaration

    • [x: string]: unknown

    taskId

    taskId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAssignedAssessmentData.html b/interfaces/firestore_interfaces.IAssignedAssessmentData.html index 8836ce58..2f8b6fbe 100644 --- a/interfaces/firestore_interfaces.IAssignedAssessmentData.html +++ b/interfaces/firestore_interfaces.IAssignedAssessmentData.html @@ -1 +1 @@ -IAssignedAssessmentData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignedAssessmentData

    Hierarchy

    • DocumentData
      • IAssignedAssessmentData

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    Optional allRunIds

    allRunIds?: string[]

    Optional completedOn

    completedOn?: Date

    rewardShown

    rewardShown: boolean

    Optional runId

    runId?: string

    Optional startedOn

    startedOn?: Date

    taskId

    taskId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAssignedAssessmentData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignedAssessmentData

    Hierarchy

    • DocumentData
      • IAssignedAssessmentData

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    Optional allRunIds

    allRunIds?: string[]

    Optional completedOn

    completedOn?: Date

    rewardShown

    rewardShown: boolean

    Optional runId

    runId?: string

    Optional startedOn

    startedOn?: Date

    taskId

    taskId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAssignmentData.html b/interfaces/firestore_interfaces.IAssignmentData.html index 49b425da..6fa0ce73 100644 --- a/interfaces/firestore_interfaces.IAssignmentData.html +++ b/interfaces/firestore_interfaces.IAssignmentData.html @@ -1 +1 @@ -IAssignmentData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignmentData

    Hierarchy

    • DocumentData
      • IAssignmentData

    Index

    Properties

    Properties

    assessments

    assessments: IAssignedAssessmentData[]

    assigningOrgs

    assigningOrgs: IOrgLists

    Optional assignmentId

    assignmentId?: string

    completed

    completed: boolean

    dateAssigned

    dateAssigned: Date

    dateClosed

    dateClosed: Date

    dateOpened

    dateOpened: Date

    readOrgs

    readOrgs: IOrgLists

    started

    started: boolean

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAssignmentData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignmentData

    Hierarchy

    • DocumentData
      • IAssignmentData

    Index

    Properties

    Properties

    assessments

    assessments: IAssignedAssessmentData[]

    assigningOrgs

    assigningOrgs: IOrgLists

    Optional assignmentId

    assignmentId?: string

    completed

    completed: boolean

    dateAssigned

    dateAssigned: Date

    dateClosed

    dateClosed: Date

    dateOpened

    dateOpened: Date

    readOrgs

    readOrgs: IOrgLists

    started

    started: boolean

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IAssignmentDateMap.html b/interfaces/firestore_interfaces.IAssignmentDateMap.html index 70669d78..c05c4b30 100644 --- a/interfaces/firestore_interfaces.IAssignmentDateMap.html +++ b/interfaces/firestore_interfaces.IAssignmentDateMap.html @@ -1 +1 @@ -IAssignmentDateMap | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignmentDateMap

    Hierarchy

    • IAssignmentDateMap

    Indexable

    [x: string]: Date

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IAssignmentDateMap | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IAssignmentDateMap

    Hierarchy

    • IAssignmentDateMap

    Indexable

    [x: string]: Date

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IClass.html b/interfaces/firestore_interfaces.IClass.html index 4603f425..29fba161 100644 --- a/interfaces/firestore_interfaces.IClass.html +++ b/interfaces/firestore_interfaces.IClass.html @@ -1 +1 @@ -IClass | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IClass

    Hierarchy

    • DocumentData
      • IClass

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    districtId

    districtId: string

    grade

    grade: Grade

    name

    name: string

    schoolId

    schoolId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IClass | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IClass

    Hierarchy

    • DocumentData
      • IClass

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    districtId

    districtId: string

    grade

    grade: Grade

    name

    name: string

    schoolId

    schoolId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IDistrict.html b/interfaces/firestore_interfaces.IDistrict.html index f25fbabf..0e403a77 100644 --- a/interfaces/firestore_interfaces.IDistrict.html +++ b/interfaces/firestore_interfaces.IDistrict.html @@ -1 +1 @@ -IDistrict | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IDistrict

    Hierarchy

    • DocumentData
      • IDistrict

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    name

    name: string

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IDistrict | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IDistrict

    Hierarchy

    • DocumentData
      • IDistrict

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    name

    name: string

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IExternalUserData.html b/interfaces/firestore_interfaces.IExternalUserData.html index b19a36c3..b45429d4 100644 --- a/interfaces/firestore_interfaces.IExternalUserData.html +++ b/interfaces/firestore_interfaces.IExternalUserData.html @@ -1 +1 @@ -IExternalUserData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IExternalUserData

    Hierarchy

    • DocumentData
      • IExternalUserData

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IExternalUserData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IExternalUserData

    Hierarchy

    • DocumentData
      • IExternalUserData

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IExtraMetadata.html b/interfaces/firestore_interfaces.IExtraMetadata.html index 4797a5ea..b7b7dd73 100644 --- a/interfaces/firestore_interfaces.IExtraMetadata.html +++ b/interfaces/firestore_interfaces.IExtraMetadata.html @@ -1 +1 @@ -IExtraMetadata | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IExtraMetadata

    Hierarchy

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IExtraMetadata | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IExtraMetadata

    Hierarchy

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IFamily.html b/interfaces/firestore_interfaces.IFamily.html index dddcb389..76fb5f05 100644 --- a/interfaces/firestore_interfaces.IFamily.html +++ b/interfaces/firestore_interfaces.IFamily.html @@ -1 +1 @@ -IFamily | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFamily

    Hierarchy

    • DocumentData
      • IFamily

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IFamily | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFamily

    Hierarchy

    • DocumentData
      • IFamily

    Indexable

    [x: string]: unknown

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IFirekit.html b/interfaces/firestore_interfaces.IFirekit.html index 2259938b..a2dcaf02 100644 --- a/interfaces/firestore_interfaces.IFirekit.html +++ b/interfaces/firestore_interfaces.IFirekit.html @@ -1 +1 @@ -IFirekit | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirekit

    Hierarchy

    • IFirekit

    Index

    Properties

    Properties

    auth

    auth: Auth

    Optional claimsLastUpdated

    claimsLastUpdated?: Date

    db

    db: Firestore

    firebaseApp

    firebaseApp: FirebaseApp

    functions

    functions: Functions

    Optional user

    user?: User

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IFirekit | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IFirekit

    Hierarchy

    • IFirekit

    Index

    Properties

    Properties

    auth

    auth: Auth

    Optional claimsLastUpdated

    claimsLastUpdated?: Date

    db

    db: Firestore

    firebaseApp

    firebaseApp: FirebaseApp

    functions

    functions: Functions

    Optional user

    user?: User

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IGroup.html b/interfaces/firestore_interfaces.IGroup.html index 2dc68ddf..9c89c129 100644 --- a/interfaces/firestore_interfaces.IGroup.html +++ b/interfaces/firestore_interfaces.IGroup.html @@ -1 +1 @@ -IGroup | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IGroup

    Hierarchy

    • DocumentData
      • IGroup

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    name

    name: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IGroup | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IGroup

    Hierarchy

    • DocumentData
      • IGroup

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    name

    name: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IName.html b/interfaces/firestore_interfaces.IName.html index e72119b1..48cfe686 100644 --- a/interfaces/firestore_interfaces.IName.html +++ b/interfaces/firestore_interfaces.IName.html @@ -1 +1 @@ -IName | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IName

    Hierarchy

    • IName

    Index

    Properties

    Properties

    first

    first: string

    last

    last: string

    Optional middle

    middle?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IName | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IName

    Hierarchy

    • IName

    Index

    Properties

    Properties

    first

    first: string

    last

    last: string

    Optional middle

    middle?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IOrgDateMap.html b/interfaces/firestore_interfaces.IOrgDateMap.html index 1f4248f3..b9239302 100644 --- a/interfaces/firestore_interfaces.IOrgDateMap.html +++ b/interfaces/firestore_interfaces.IOrgDateMap.html @@ -1 +1 @@ -IOrgDateMap | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgDateMap

    Hierarchy

    • IOrgDateMap

    Indexable

    [x: string]: { from: Date; to?: Date }
    • from: Date
    • Optional to?: Date

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IOrgDateMap | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgDateMap

    Hierarchy

    • IOrgDateMap

    Indexable

    [x: string]: { from: Date; to?: Date }
    • from: Date
    • Optional to?: Date

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IOrgLists.html b/interfaces/firestore_interfaces.IOrgLists.html index e83a613b..02a12f01 100644 --- a/interfaces/firestore_interfaces.IOrgLists.html +++ b/interfaces/firestore_interfaces.IOrgLists.html @@ -1 +1 @@ -IOrgLists | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgLists

    Hierarchy

    Index

    Properties

    Properties

    classes

    classes: string[]

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IOrgLists | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgLists

    Hierarchy

    Index

    Properties

    Properties

    classes

    classes: string[]

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IOrgs.html b/interfaces/firestore_interfaces.IOrgs.html index 31ade254..38edb93f 100644 --- a/interfaces/firestore_interfaces.IOrgs.html +++ b/interfaces/firestore_interfaces.IOrgs.html @@ -1 +1 @@ -IOrgs | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgs

    Hierarchy

    • IOrgs

    Index

    Properties

    Properties

    all

    all: string[]

    current

    current: string[]

    dates

    dates: IOrgDateMap

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IOrgs | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IOrgs

    Hierarchy

    • IOrgs

    Index

    Properties

    Properties

    all

    all: string[]

    current

    current: string[]

    dates

    dates: IOrgDateMap

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IRoarConfigData.html b/interfaces/firestore_interfaces.IRoarConfigData.html index 73bf91d9..4ebf8310 100644 --- a/interfaces/firestore_interfaces.IRoarConfigData.html +++ b/interfaces/firestore_interfaces.IRoarConfigData.html @@ -1 +1 @@ -IRoarConfigData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRoarConfigData

    Hierarchy

    • IRoarConfigData

    Index

    Properties

    Properties

    admin

    admin: FirebaseConfigData

    app

    app: FirebaseConfigData

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IRoarConfigData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IRoarConfigData

    Hierarchy

    • IRoarConfigData

    Index

    Properties

    Properties

    admin

    admin: FirebaseConfigData

    app

    app: FirebaseConfigData

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.ISchool.html b/interfaces/firestore_interfaces.ISchool.html index 4aa5cb85..f212ed55 100644 --- a/interfaces/firestore_interfaces.ISchool.html +++ b/interfaces/firestore_interfaces.ISchool.html @@ -1 +1 @@ -ISchool | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ISchool

    Hierarchy

    • DocumentData
      • ISchool

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    abbreviation

    abbreviation: string

    classes

    classes: string[]

    districtId

    districtId: string

    name

    name: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ISchool | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ISchool

    Hierarchy

    • DocumentData
      • ISchool

    Indexable

    [x: string]: unknown

    Index

    Properties

    Properties

    abbreviation

    abbreviation: string

    classes

    classes: string[]

    districtId

    districtId: string

    name

    name: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IStudentData.html b/interfaces/firestore_interfaces.IStudentData.html index cd2e18f2..e7194903 100644 --- a/interfaces/firestore_interfaces.IStudentData.html +++ b/interfaces/firestore_interfaces.IStudentData.html @@ -1 +1 @@ -IStudentData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IStudentData

    Hierarchy

    Index

    Properties

    Properties

    dob

    dob: Date

    Optional ell_status

    ell_status?: string

    Optional frl_status

    frl_status?: string

    Optional gender

    gender?: string

    grade

    grade: Grade

    Optional iep_status

    iep_status?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IStudentData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IStudentData

    Hierarchy

    Index

    Properties

    Properties

    dob

    dob: Date

    Optional ell_status

    ell_status?: string

    Optional frl_status

    frl_status?: string

    Optional gender

    gender?: string

    grade

    grade: Grade

    Optional iep_status

    iep_status?: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_interfaces.IUserData.html b/interfaces/firestore_interfaces.IUserData.html index b7057f0d..463f0b32 100644 --- a/interfaces/firestore_interfaces.IUserData.html +++ b/interfaces/firestore_interfaces.IUserData.html @@ -1 +1 @@ -IUserData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserData

    Hierarchy

    • DocumentData
      • IUserData

    Index

    Properties

    Properties

    Optional adminData

    adminData?: IAdminData

    archived

    archived: boolean

    Optional assessmentPid

    assessmentPid?: string

    Optional assessmentUid

    assessmentUid?: string

    Optional assessmentsAssigned

    assessmentsAssigned?: string[]

    Optional assessmentsCompleted

    assessmentsCompleted?: string[]

    Optional assignmentsAssigned

    assignmentsAssigned?: IAssignmentDateMap

    Optional assignmentsCompleted

    assignmentsCompleted?: IAssignmentDateMap

    Optional assignmentsStarted

    assignmentsStarted?: IAssignmentDateMap

    Optional caregiverData

    caregiverData?: IExtraMetadata

    classes

    classes: IOrgs

    districts

    districts: IOrgs

    Optional educatorData

    educatorData?: IExtraMetadata

    Optional externalData

    externalData?: {}

    Type declaration

    families

    families: IOrgs

    groups

    groups: IOrgs

    Optional id

    id?: string

    Optional name

    name?: IName

    schools

    schools: IOrgs

    Optional studentData

    studentData?: IStudentData

    userType

    userType: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IUserData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserData

    Hierarchy

    • DocumentData
      • IUserData

    Index

    Properties

    Properties

    Optional adminData

    adminData?: IAdminData

    archived

    archived: boolean

    Optional assessmentPid

    assessmentPid?: string

    Optional assessmentUid

    assessmentUid?: string

    Optional assessmentsAssigned

    assessmentsAssigned?: string[]

    Optional assessmentsCompleted

    assessmentsCompleted?: string[]

    Optional assignmentsAssigned

    assignmentsAssigned?: IAssignmentDateMap

    Optional assignmentsCompleted

    assignmentsCompleted?: IAssignmentDateMap

    Optional assignmentsStarted

    assignmentsStarted?: IAssignmentDateMap

    Optional caregiverData

    caregiverData?: IExtraMetadata

    classes

    classes: IOrgs

    districts

    districts: IOrgs

    Optional educatorData

    educatorData?: IExtraMetadata

    Optional externalData

    externalData?: {}

    Type declaration

    families

    families: IOrgs

    groups

    groups: IOrgs

    Optional id

    id?: string

    Optional name

    name?: IName

    schools

    schools: IOrgs

    Optional studentData

    studentData?: IStudentData

    userType

    userType: UserType

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_query_assessment.ITaskVariant.html b/interfaces/firestore_query_assessment.ITaskVariant.html index 7570acf6..fc2e6eab 100644 --- a/interfaces/firestore_query_assessment.ITaskVariant.html +++ b/interfaces/firestore_query_assessment.ITaskVariant.html @@ -1 +1 @@ -ITaskVariant | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariant

    Hierarchy

    • ITaskVariant

    Index

    Properties

    Properties

    id

    id: string

    task

    task: ITaskData

    variant

    variant: IVariant

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ITaskVariant | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface ITaskVariant

    Hierarchy

    • ITaskVariant

    Index

    Properties

    Properties

    id

    id: string

    task

    task: ITaskData

    variant

    variant: IVariant

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_query_assessment_compat.IUserQueryInput.html b/interfaces/firestore_query_assessment_compat.IUserQueryInput.html index 35e1a0a2..d1dc452c 100644 --- a/interfaces/firestore_query_assessment_compat.IUserQueryInput.html +++ b/interfaces/firestore_query_assessment_compat.IUserQueryInput.html @@ -1 +1 @@ -IUserQueryInput | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserQueryInput

    Hierarchy

    • IUserQueryInput

    Index

    Properties

    Properties

    classes

    classes: string[]

    db

    db: Firestore

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IUserQueryInput | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserQueryInput

    Hierarchy

    • IUserQueryInput

    Index

    Properties

    Properties

    classes

    classes: string[]

    db

    db: Firestore

    districts

    districts: string[]

    families

    families: string[]

    groups

    groups: string[]

    schools

    schools: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_util.CommonFirebaseConfig.html b/interfaces/firestore_util.CommonFirebaseConfig.html index b9e6eacc..3e56a638 100644 --- a/interfaces/firestore_util.CommonFirebaseConfig.html +++ b/interfaces/firestore_util.CommonFirebaseConfig.html @@ -1 +1 @@ -CommonFirebaseConfig | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CommonFirebaseConfig

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    projectId

    projectId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CommonFirebaseConfig | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CommonFirebaseConfig

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    projectId

    projectId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_util.EmulatorConfigData.html b/interfaces/firestore_util.EmulatorConfigData.html index f691ec29..21acf0af 100644 --- a/interfaces/firestore_util.EmulatorConfigData.html +++ b/interfaces/firestore_util.EmulatorConfigData.html @@ -1 +1 @@ -EmulatorConfigData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface EmulatorConfigData

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    emulatorPorts

    emulatorPorts: { auth: number; db: number; functions: number }

    Type declaration

    • auth: number
    • db: number
    • functions: number

    projectId

    projectId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EmulatorConfigData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface EmulatorConfigData

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    emulatorPorts

    emulatorPorts: { auth: number; db: number; functions: number }

    Type declaration

    • auth: number
    • db: number
    • functions: number

    projectId

    projectId: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_util.IUserDocument.html b/interfaces/firestore_util.IUserDocument.html index f4eb3160..b9d152d3 100644 --- a/interfaces/firestore_util.IUserDocument.html +++ b/interfaces/firestore_util.IUserDocument.html @@ -1 +1 @@ -IUserDocument | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserDocument

    Hierarchy

    • IUserDocument

    Index

    Properties

    Properties

    Optional classId

    classId?: string

    Optional classes

    classes?: string[]

    Optional districtId

    districtId?: string

    Optional groupId

    groupId?: string

    Optional groups

    groups?: string[]

    Optional schoolId

    schoolId?: string

    Optional schools

    schools?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IUserDocument | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface IUserDocument

    Hierarchy

    • IUserDocument

    Index

    Properties

    Properties

    Optional classId

    classId?: string

    Optional classes

    classes?: string[]

    Optional districtId

    districtId?: string

    Optional groupId

    groupId?: string

    Optional groups

    groups?: string[]

    Optional schoolId

    schoolId?: string

    Optional schools

    schools?: string[]

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_util.MarkRawConfig.html b/interfaces/firestore_util.MarkRawConfig.html index 33f49762..cb7134cb 100644 --- a/interfaces/firestore_util.MarkRawConfig.html +++ b/interfaces/firestore_util.MarkRawConfig.html @@ -1 +1 @@ -MarkRawConfig | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MarkRawConfig

    Hierarchy

    • MarkRawConfig

    Index

    Properties

    Properties

    Optional auth

    auth?: boolean

    Optional db

    db?: boolean

    Optional functions

    functions?: boolean

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +MarkRawConfig | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MarkRawConfig

    Hierarchy

    • MarkRawConfig

    Index

    Properties

    Properties

    Optional auth

    auth?: boolean

    Optional db

    db?: boolean

    Optional functions

    functions?: boolean

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/firestore_util.RealConfigData.html b/interfaces/firestore_util.RealConfigData.html index c892b0d7..d5979a34 100644 --- a/interfaces/firestore_util.RealConfigData.html +++ b/interfaces/firestore_util.RealConfigData.html @@ -1 +1 @@ -RealConfigData | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RealConfigData

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    appId

    appId: string

    authDomain

    authDomain: string

    Optional measurementId

    measurementId?: string

    messagingSenderId

    messagingSenderId: string

    projectId

    projectId: string

    storageBucket

    storageBucket: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RealConfigData | @bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface RealConfigData

    Hierarchy

    Index

    Properties

    Properties

    apiKey

    apiKey: string

    appId

    appId: string

    authDomain

    authDomain: string

    Optional measurementId

    measurementId?: string

    messagingSenderId

    messagingSenderId: string

    projectId

    projectId: string

    storageBucket

    storageBucket: string

    Legend

    • Function
    • Type alias
    • Interface
    • Property
    • Enumeration
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules.html b/modules.html index 64e9810d..c5c5f73a 100644 --- a/modules.html +++ b/modules.html @@ -1 +1 @@ -@bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @bdelab/roar-firekit - v4.3.0

    Index

    Modules

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +@bdelab/roar-firekit - v4.3.1
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    @bdelab/roar-firekit - v4.3.1

    Index

    Modules

    Legend

    • Function
    • Type alias
    • Enumeration
    • Interface
    • Class

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/auth.html b/modules/auth.html index 814944dd..611de98e 100644 --- a/modules/auth.html +++ b/modules/auth.html @@ -1,4 +1,4 @@ -auth | @bdelab/roar-firekit - v4.3.0
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Module auth

    Index

    Functions

    Functions

    fetchEmailAuthMethods

    • fetchEmailAuthMethods(auth: Auth, email: string): Promise<string[]>

    • Parameters

      • auth: Auth
      • email: string

      Returns Promise<string[]>

    isEmailAvailable

    • isEmailAvailable(auth: Auth, email: string): Promise<boolean>

    • Parameters

      • auth: Auth
      • email: string

      Returns Promise<boolean>

    isRoarAuthEmail

    • isRoarAuthEmail(email: string): boolean

    • Parameters

      • email: string

      Returns boolean

    isUsernameAvailable

    • isUsernameAvailable(auth: Auth, username: string): Promise<boolean>

    • Parameters

      • auth: Auth
      • username: string

      Returns Promise<boolean>

    roarEmail

    • roarEmail(roarPid: string): string