fcad-core-dragon 2.0.0-beta.1 → 2.0.0-beta.3

package/src/module/store.js

@@ -1,895 +0,0 @@
-import Vue from 'vue'
-
-const thisModule = {} /* */
-const state = {
-  status: '',
-  anchorStatus: null,
-  thisModule,
-  currentActivity: null,
-  currentPage: null,
-  currentBranchPage: null,
-  currentBranching: null,
-  currentSection: null,
-  currentPageMediaElement: null,
-  currentMediaDuration: null,
-  currentPageTimeline: null,
-  bookmark: null,
-  currentBrowser: null,
-  isMobile: null,
-  deviceType: null,
-  introAcitve: null,
-  userMetaData: {},
-  appConfigs: null,
-  menuSetting: null,
-  applicationSettings: {},
-  routeHistory: null,
-  mediaVolume: 1,
-  mediaSubtitles: false,
-  showPrimaryCtrl: true,
-  showNavLeftCtrl: true,
-  showNavRightCtrl: true,
-  prevActivity: null,
-  nextActivity: null,
-  lrsConfig: null,
-  compStatusTracker: []
-}
-const getters = {
-  /**
-   * @description: Check if subtitles are enabled or not
-   */
-  getMediaSubtitles(state) {
-    return state.mediaSubtitles
-  },
-  /**
-   * @description: get media volume for the playbar
-   */
-  getMediaVolume(state) {
-    return state.mediaVolume
-  },
-
-  /**
-   * @description: Check if automatic video playback is enabled in application settings
-   */
-
-  getAutoplayEnabled(state) {
-    return state.applicationSettings.autoplay
-      ? state.applicationSettings.autoplay
-      : null
-  },
-
-  /**
-   * @description: Check if onboarding is enabled in application settings
-   */
-  getOnboardingEnabled(state) {
-    return state.applicationSettings.onboarding
-      ? state.applicationSettings.onboarding
-      : null
-  },
-
-  /**
-   * @description: Check if auto-show subtitles is enabled in application settings
-   */
-  getShowSubtitles(state) {
-    return state.applicationSettings.subtitles
-      ? state.applicationSettings.subtitles
-      : null
-  },
-
-  /**
-   * @description: Getter to return the app status
-   */
-  getAppStatus(state) {
-    // return state.status
-    // if (state.compStatusTracker.length) return 'loading'
-    // else return 'ready'
-
-    return state.compStatusTracker.length ? 'loading' : 'ready'
-  },
-
-  /**
-   * @description: Getter to return the a page and its data
-   * @param {String} activity_Id: ID of the activity
-   * @param {String} page_Id: ID of the page
-   * @return {Object} : data of the search result
-   */
-  getPageData(state) {
-    return (activity_Id, page_Id) => {
-      //Must have activity_Id,  page_Id params
-      if (!activity_Id || !page_Id)
-        throw new Error(
-          ` ⚠️ Invalid call to getPageData \n 🚩 Missing required arguments`
-        )
-
-      if (state.thisModule.activities.get(activity_Id)) {
-        let page
-
-        //handle the case for branching and normal pages
-        if (page_Id.length > 3) {
-          const splitted = page_Id.split('_')
-          page = state.thisModule.activities
-            .get(activity_Id)
-            .get(splitted[0])
-            .get(splitted[1])
-            .get(page_Id)
-        } else {
-          const p = state.thisModule.activities.get(activity_Id).get(page_Id)
-          if (p)
-            switch (p.constructor) {
-              //Branching root page
-              case Map:
-                page = p.get(page_Id)
-                break
-              //Normal page
-              default:
-                page = state.thisModule.activities.get(activity_Id).get(page_Id)
-                break
-            }
-        }
-        if (page) return page
-      }
-
-      return false
-    }
-  },
-  /**
-   * @description: Getter to return all activities of the module
-   */
-  getAllActivities(state) {
-    if (Object.keys(state.thisModule).length && state.thisModule.activities)
-      return {
-        list: state.thisModule.activities,
-        pageSize: (() => {
-          let size = 0
-          state.thisModule.activities.forEach((value) => {
-            size = size + value.size
-          })
-          return size
-        })()
-      }
-    return {}
-  },
-  getAnchorStatus(state) {
-    return state.anchorStatus
-  },
-  getIntroStatus(state, getters) {
-    let activities = getters.getAllActivities.list
-    return activities.get('A00') ? true : false
-  },
-  getConcluStatus(state, getters) {
-    let activities = getters.getAllActivities.list
-    return activities.get('A99') ? true : false
-  },
-  getModuleInfo(state) {
-    if (state.thisModule.info) return state.thisModule.info
-    else return state.thisModule
-  },
-  getAppConfigs(state) {
-    if (state.appConfigs) return state.appConfigs
-    else return false
-  },
-  getRouteHistory(state) {
-    return state.routeHistory ? state.routeHistory : []
-  },
-  hasMediaElOrTimeline(state) {
-    return state.currentPageMediaElement || state.currentPageTimeline
-  },
-  /**
-   * @description: Getter to return the current page
-   * @returns: page {Object}
-   */
-  getCurrentPage(state) {
-    let page = null
-    if (state.currentPage !== null) {
-      page = {
-        ...state.currentPage
-      }
-      page.mElement = state.currentPageMediaElement
-      page.timeline = state.currentPageTimeline
-    }
-    return page
-  },
-  /**
-   * @description: Getter to return the current branching page
-   * @returns: page {Object}
-   */
-  getCurrentBranching(state) {
-    return state.currentBranching
-  },
-  /**
-   * @description: Getter to return the current branch page in a branching
-   * @returns: page {Object}
-   */
-  getCurrentBranchPage(state) {
-    return state.currentBranchPage
-  },
-  /**
-   * @description: Getter to return the current Media Duration
-   */
-  getCurrentMediaDuration(state) {
-    return state.currentMediaDuration
-  },
-  /**
-   * @description: Getter to return the browser
-   */
-  getCurrentBrowser(state) {
-    return state.currentBrowser
-  },
-
-  getIsMobile(state) {
-    return state.isMobile
-  },
-  /**
-   * @description: Getter to return the type of device on which app is running (iosDevice, Android device or Desktop)
-   */
-  getDeviceType(state) {
-    return state.deviceType
-  },
-  /**
-   * @description: Getter to return the current enabled user settings
-   */
-  getApplicationSettings(state) {
-    return state.applicationSettings
-  },
-
-  /**
-   * @description: Getter to return the userMetadata
-   * * @returns: {Object}
-   */
-  getUserInteraction(state) {
-    return state.userMetaData
-  },
-  /**
-   * @description: Getter to return all  states of the  activities
-   * @returns: progess {Object}
-   */
-  getAllActivitiesState(state, getters) {
-    const activities = getters.getAllActivities.list
-    let progress = {}
-    // search this acvitity in the userInteraction
-    activities.forEach((aValue, aKey) => {
-      let allStates
-      let temp = []
-
-      if (state.userMetaData[aKey]) {
-        const activity = Object.entries(state.userMetaData[aKey])
-
-        // get all the completed acitivities
-        allStates = activity.map((page) => {
-          // return only all the pages which state are completed or started
-          if (
-            page[1].userInteraction.state === 'completed' ||
-            page[1].userInteraction.state === 'started'
-          ) {
-            return {
-              ...allStates,
-              [page[0]]: page[1].userInteraction.state
-            }
-          }
-        })
-      }
-      if (allStates && allStates.length) {
-        temp = [...allStates]
-      }
-
-      // Getting the(Map type Object) length of the activities including the branching
-      let z = [] //placeholder
-      const getLength = (el) => {
-        if (el.size && el.size > 0) {
-          el.forEach((v) => {
-            // v is a map get its length with a recursive call to its elements
-            if (v && v.constructor === Map && v.size > 0) getLength(v)
-            else z.push(v) // v is an object add it to z
-          })
-        }
-        return z.length //return the length of the paceholder
-      }
-
-      // Update the progress with new values
-      progress = {
-        ...progress,
-        [aKey]: {
-          size: getLength(aValue),
-          progressions: [...temp]
-        }
-      }
-    })
-    return progress
-  },
-
-  /**
-   * @description: Getter to return only completed activities
-   * @returns: record {Object}
-   */
-  getAllCompleted(state, getters) {
-    const allActivities = getters.getAllActivitiesState
-    let record = {}
-
-    for (const key in allActivities) {
-      // get only actities that are completed
-      const completed = allActivities[key].progressions.filter((page) => {
-        if (page) return Object.values(page)[0] === 'completed'
-      })
-      // add  the activity and its completed pages
-      if (completed.length)
-        record = {
-          ...record,
-          [key]: [...completed]
-        } // add the complete array to the record
-    }
-    return record
-  },
-
-  // for the quizzes
-  getAllQuizAnswers(state) {
-    return state.quizAnswers
-  },
-  getAllPollAnswers(state) {
-    return state.pollAnswers
-  },
-  getQuizAnswers(state) {
-    return (question_id) => {
-      const indexQuestion = state.quizAnswers.findIndex(function(element) {
-        return element.questionId == question_id
-      })
-      if (indexQuestion !== -1) {
-        return state.quizAnswers[indexQuestion]
-      }
-      return false
-    }
-  },
-  getPollAnswers(state) {
-    return (question_id) => {
-      const indexQuestion = state.pollAnswers.findIndex(function(element) {
-        return element.questionId == question_id
-      })
-      if (indexQuestion !== -1) {
-        return state.pollAnswers[indexQuestion]
-      }
-      return false
-    }
-  },
-  getBifChoice(state, getters) {
-    const activities = getters.getUserInteraction
-    let data = {}
-
-    let act = null
-    let page = null
-    for (const c in activities) {
-      act = c
-      const activity = state.userMetaData[c]
-      for (const b in activity) {
-        page = b
-        if (
-          activity[b] &&
-          [b].userInteractionactivity &&
-          [b].userInteraction.bifChoice
-        ) {
-          let choix = activity[b].userInteraction.bifChoice
-          data = { ...data, act, page, choix }
-        }
-      }
-    }
-
-    return data
-  },
-  /**
-   * @description: Getter to return the connection information of the app
-   * @returns: record {Object}
-   */
-  getConnectionInfo(state, getters) {
-    return getters.getLrsInfo
-  },
-
-  /**
-   * @description: Getter to return the menu setting
-   * @returns: record {Object}
-   */
-  getMenuSettings(state) {
-    return state.menuSetting
-  },
-  getTask(state) {
-    return (id) => {
-      for (const column of state.board.columns) {
-        for (const task of column.tasks) {
-          if (task.id === id) return task
-        }
-      }
-    }
-  },
-  /**
-   * @description: Getter to return the menu setting
-   * @returns: record {Array}: liste of all the anchors by activity
-   */
-  getMenuAnchors(state, getters) {
-    const menu = getters.getMenuSettings
-    let anchors = []
-    for (const c in menu) {
-      anchors = [...anchors, { [c]: menu[c].anchors }]
-    }
-    return anchors
-  },
-
-  /**
-   * @description: Getter to return the menu setting
-   * @params ID {String}: id of the Activity
-   * @returns: record {ArrayOfObject}
-   */
-  getAnchorsForActivity(state, getters) {
-    const allAnchors = getters.getMenuAnchors
-    return (id) => {
-      const result = allAnchors.find((a) => a[id]) // find the object which has id
-
-      if (result) return result[id]
-      else return []
-    }
-  },
-
-  /**
-   * @description: Getter to return the current Section
-   * @returns:  {Object}
-   */
-  getCurrentSection(state) {
-    if (state.currentSection) return state.currentSection
-    else return {}
-  },
-
-  getShowPrimaryCtrl(state) {
-    return state.showPrimaryCtrl
-  },
-
-  getShowNavLeftCtrl(state) {
-    return state.showNavLeftCtrl
-  },
-
-  getShowNavRightCtrl(state) {
-    return state.showNavRightCtrl
-  },
-
-  getLrsInfo(state) {
-    return state.lrsConfig
-  },
-
-  getNextActivity(state) {
-    return state.nextActivity
-  },
-
-  getPreviousActivity(state) {
-    return state.prevActivity
-  }
-}
-
-/**
- * @description: Getter to return the Anchors of on Activity
- * @params ID {String}: id of the activity for the search
- * @returns: record {Array}: liste of the anchors
- */
-
-const mutations = {
-  UPDATE_APP_STATUS(state, status) {
-    state.status = status
-  },
-
-  UPDATE_ANCHOR_STATE(state, status) {
-    state.anchorStatus = status
-  },
-
-  UPDATE_INTRO_STATE(state, status) {
-    state.introAcitve = status
-  },
-
-  SET_MOBILE_STATE(state, status) {
-    state.isMobile = status
-  },
-  SET_CURRENT_BROWSER(state, browser) {
-    state.currentBrowser = browser
-  },
-  SET_DEVICE_TYPE(state, device) {
-    state.deviceType = device
-  },
-  SET_APPLICATION_SETTINGS(state, settings) {
-    state.applicationSettings = settings
-  },
-
-  SET_MEDIA_VOLUME(state, volume) {
-    state.mediaVolume = volume
-  },
-  SET_MEDIA_SUBTITLES(state, subtitlesEnabled) {
-    state.mediaSubtitles = subtitlesEnabled
-  },
-
-  /* set/update the Application configuration*/
-  SET_APP_CONFIGS(state, data) {
-    state.appConfigs = data
-  },
-
-  SET_ROUTE_HISTORY(state, data) {
-    state.routeHistory = data
-  },
-  /* set/update the Menu configuration*/
-  SET_MENU(state, data) {
-    state.menuSetting = data
-  },
-
-  ADD_PAGES(state, pages) {
-    // Add Pages to the module
-    if (!state.thisModule.children) state.thisModule.activities = pages
-  },
-  /* set/update the Branching information*/
-  UPDATE_CURRENT_BRANCHING(state, data) {
-    state.currentBranching = data
-  },
-  /* set/update the branch page information*/
-  UPDATE_CURRENT_BRANCH_PAGE(state, data) {
-    state.currentBranchPage = data
-  },
-  /* set/update  page information*/
-  UPDATE_CURRENT_PAGE(state, { activity_Id, page_Id }) {
-    if (activity_Id && page_Id) {
-      let page
-      //id type case PXX_EXX_PXX
-      if (page_Id.length > 3) {
-        const splitted = page_Id.split('_')
-        page = state.thisModule.activities
-          .get(activity_Id)
-          .get(splitted[0])
-          .get(page_Id).content
-      } else {
-        const p = state.thisModule.activities.get(activity_Id).get(page_Id)
-
-        //this branching page if the constructor is a map
-        if (p && p.constructor === Map) {
-          page = state.thisModule.activities
-            .get(activity_Id)
-            .get(page_Id)
-            .get(page_Id).content
-        } else
-          page = state.thisModule.activities.get(activity_Id).get(page_Id)
-            .content
-      }
-      state.currentPage = page
-    } else state.currentPage = {}
-  },
-  /**
-    @description update the module data.
-                  If no key is passed update the entire module with new data. if key is passed add/update the key
-    @param {String} key : a key to add/update in the module
-    @param {String} key : a key to add/update in the module
-
-   */
-  UPDATE_MODULE(state, { key, data }) {
-    if (key || state.thisModule[key]) state.thisModule[key] = data
-    else state.thisModule = data
-  },
-
-  UPDATE_CURRENT_PAGE_TIMELINE(state, data) {
-    state.currentPageTimeline = data
-  },
-
-  UPDATE_CURRENT_PAGE_MEDIA_ELEMENT(state, data) {
-    state.currentPageMediaElement = data
-  },
-
-  UPDATE_CURRENT_MEDIA_DURATION(state, data) {
-    state.currentMediaDuration = data
-  },
-
-  UPDATE_CURRENT_SECTION(state, data) {
-    // update when new data
-    if (
-      !state.currentSection ||
-      state.currentSection.anchorName !== data.anchorName
-    )
-      state.currentSection = data
-  },
-  /**
-   * @description: Save user interaction on a page to store: DONE
-   * USe to Update existing userMetadata
-   */
-  UPDATE_USER_METADATA(state, data) {
-    const _keys = Object.keys(data) // get all keys in the passed data
-    // ckeck if the Activity existe in the user data
-    if (data.activityRef) {
-      if (state.userMetaData[data.activityRef]) {
-        const activity = state.userMetaData[data.activityRef] // get targeted activity in the user data
-        const page = data.id // page id
-
-        // check if the page exist in the the activity
-        if (Object.keys(activity).includes(page)) {
-          // add entry for new key in user data for the target page
-          _keys.forEach((key) => {
-            // add add value of new key in the record : discart key=ActivityRef and key ===
-            if (key !== _keys[0] && key !== _keys[1]) {
-              // store the current user interaction in a variable
-              const oldValue = activity[page][key]
-
-              // update the user data by copying the old value and add new data
-              activity[page][key] = {
-                ...oldValue,
-                ...data[key]
-              }
-            }
-          })
-        } else {
-          /**
-           * add the page reference as an object to the user data
-           * and create entry for user interaction
-           * */
-          _keys.forEach((key) => {
-            if (key !== _keys[0] && key !== _keys[1]) {
-              Vue.set(activity, [page], {
-                [key]: data[key]
-              })
-            }
-          })
-        }
-      } else {
-        // create a new entry for the activity
-        state.userMetaData = {
-          ...state.userMetaData,
-          [data.activityRef]: {
-            [data.id]: {}
-          }
-        }
-
-        // Add data for each new page
-        _keys.forEach((key) => {
-          if (key !== _keys[0] && key !== _keys[1]) {
-            // add the page datas
-            state.userMetaData[data.activityRef][data.id] = {
-              [key]: data[key]
-            }
-          }
-        })
-      }
-    }
-  },
-
-  /* set/update the user data with existing record */
-  SET_USER_METADATA(state, data) {
-    state.userMetaData = data
-  },
-
-  // to update the answers
-  UPDATE_ANSWERS_QUIZ(state, answers) {
-    const theAnswers = this.getters.getAllQuizAnswers.findIndex(function(
-      element
-    ) {
-      return element.questionId == answers.questionId
-    })
-    if (theAnswers == -1) {
-      // if the answer already existed
-      state.quizAnswers.push(answers)
-    } else {
-      state.quizAnswers[theAnswers] = answers
-    }
-  },
-
-  UPDATE_ANSWERS_POLL(state, answers) {
-    const theAnswers = this.getters.getAllPollAnswers.findIndex(function(
-      element
-    ) {
-      return element.questionId == answers.questionId
-    })
-    if (theAnswers == -1) {
-      // if the answer already existed
-      state.pollAnswers.push(answers)
-    } else {
-      state.pollAnswers[theAnswers] = answers
-    }
-  },
-
-  SET_SHOW_PRIMARY_CONTROL(state, bool) {
-    state.showPrimaryCtrl = bool
-  },
-
-  SET_SHOW_NAV_LEFT_CONTROL(state, bool) {
-    state.showNavLeftCtrl = bool
-  },
-
-  SET_SHOW_NAV_RIGHT_CONTROL(state, bool) {
-    state.showNavRightCtrl = bool
-  },
-
-  SET_LRS_CONFIG(state, data) {
-    if (data) state.lrsConfig = data
-  },
-
-  UPDATE_PREVIOUS_ACTIVITY(state, data) {
-    state.prevActivity = data
-  },
-
-  UPDATE_NEXT_ACTIVITY(state, data) {
-    state.nextActivity = data
-  },
-
-  UPDATE_COMPONENTS_STATUS(state, data) {
-    if (!data) return
-
-    const { name, status } = data
-
-    if (!name || !status) return
-
-    let tracker = state.compStatusTracker
-
-    //search for the component
-    let target = tracker.find((e) => e == name)
-
-    //add component to tracking cue
-    if (!target && status == 'loading') tracker.push(name)
-
-    if (!tracker.length) return
-
-    //remove component to tracking cue
-    if (status == 'ready') {
-      const index = tracker.indexOf(target)
-
-      if (index >= 0) tracker = tracker.splice(index, 1)
-    }
-  }
-}
-
-const actions = {
-  updateAppStatus({ commit }, status) {
-    commit('UPDATE_APP_STATUS', status)
-  },
-  updateAnchorStatus({ commit }, status) {
-    commit('UPDATE_ANCHOR_STATE', status)
-  },
-  updateIntroStatus({ commit }, status) {
-    commit('UPDATE_INTRO_STATE', status)
-  },
-  /**
-   * @description: add a page in to the state collection
-   */
-  addPage({ commit }, page) {
-    commit('ADD_PAGE', page)
-  },
-
-  setRouteHistory({ commit }, data) {
-    commit('SET_ROUTE_HISTORY', data)
-  },
-
-  /**
-   * @description: Update page in state collection
-   */
-  updatePage({ commit }, newData) {
-    commit('UPDATE_PAGE', newData)
-  },
-  /**
-   * @description: Update module
-   */
-  updateActivitiesState({ commit }, data) {
-    commit('UPDATE_ACTIVITES_STATE', data)
-  },
-  /**
-   * @description: Update module
-   */
-  updateModule({ commit }, data) {
-    commit('UPDATE_MODULE', data)
-  },
-
-  /**
-   * @description: Update current Timeline
-   */
-  updateCurrentTimeline({ commit }, data) {
-    commit('UPDATE_CURRENT_PAGE_TIMELINE', data)
-  },
-
-  /**
-   * @description: Update current page
-   */
-  updateCurrentPage({ commit }, data) {
-    commit('UPDATE_CURRENT_PAGE', data)
-  },
-  /**
-   * @description: Update current section name
-   */
-  updateCurrentSection({ commit }, data) {
-    commit('UPDATE_CURRENT_SECTION', data)
-  },
-
-  // /**
-  //  * @description: Update current media element (video/ audio)
-  //  */
-  // updateCurrentMediaElement({ commit }, data) {
-  //   commit('UPDATE_CURRENT_PAGE_MEDIA_ELEMENT', data)
-  // },
-
-  /**
-   * @description: Update current media element (video/ audio)
-   */
-  async updateCurrentMediaElement({ commit }, data) {
-    return new Promise((resolve) => {
-      commit('UPDATE_CURRENT_PAGE_MEDIA_ELEMENT', data)
-      resolve()
-    })
-  },
-  /**
-   * @description: Update duration of current media element (video/ audio)
-   */
-  updateCurrentMediaDuration({ commit }, duration) {
-    commit('UPDATE_CURRENT_MEDIA_DURATION', duration)
-  },
-
-  /**
-   * @description: Update user meta data (video/ audio)
-   */
-  updateUserMetaData({ commit }, data) {
-    commit('UPDATE_USER_METADATA', data)
-  },
-  setUserMetaData({ commit }, data) {
-    commit('SET_USER_METADATA', data)
-  },
-
-  // to save the answers
-  saveAnswersQuiz({ commit }, data) {
-    commit('UPDATE_ANSWERS_QUIZ', data)
-  },
-  saveAnswersPoll({ commit }, data) {
-    commit('UPDATE_ANSWERS_POLL', data)
-  },
-  // to
-
-  /**
-   * @description: Set app settings
-   */
-  setAppConfigs({ commit }, data) {
-    commit('SET_APP_CONFIGS', data)
-  },
-  setMobileState({ commit }, data) {
-    commit('SET_MOBILE_STATE', data)
-  },
-  setCurrentBrowser({ commit }, data) {
-    commit('SET_CURRENT_BROWSER', data)
-  },
-  setDeviceType({ commit }, data) {
-    commit('SET_DEVICE_TYPE', data)
-  },
-  setApplicationSettings({ commit }, data) {
-    commit('SET_APPLICATION_SETTINGS', data)
-  },
-
-  setMediaVolume({ commit }, data) {
-    commit('SET_MEDIA_VOLUME', data)
-  },
-  setMediaSubtitles({ commit }, data) {
-    commit('SET_MEDIA_SUBTITLES', data)
-  },
-
-  setShowPrimaryCtrl({ commit }, data) {
-    commit('SET_SHOW_PRIMARY_CONTROL', data)
-  },
-
-  setShowNavLeftCtrl({ commit }, data) {
-    commit('SET_SHOW_NAV_LEFT_CONTROL', data)
-  },
-
-  setShowNavRightCtrl({ commit }, data) {
-    commit('SET_SHOW_NAV_RIGHT_CONTROL', data)
-  },
-
-  setLrsConfig({ commit }, data) {
-    // commit('UPDATE_APP_STATUS', 'loading')
-    commit('SET_LRS_CONFIG', data)
-    // commit('UPDATE_APP_STATUS', 'ready')
-  },
-
-  updatePreviousActivity({ commit }, data) {
-    commit('UPDATE_PREVIOUS_ACTIVITY', data)
-  },
-
-  updateNextActivity({ commit }, data) {
-    commit('UPDATE_NEXT_ACTIVITY', data)
-  },
-
-  updateCompStatusTracker({ commit }, data) {
-    commit('UPDATE_COMPONENTS_STATUS', data)
-  }
-}
-
-export default {
-  state,
-  mutations,
-  actions,
-  getters
-}