core/templates/domain/statistics/learner-action.model.ts - develop - githubmirror/oppia

core/templates/domain/statistics/learner-action.model.ts
144 строки5 KB
Hardik Goyal
Fix part of #22082: Migrate ng-class to ngClass (#22166)
20 апр 2025, 10:52
20 апр 2025, 10:5250f6cba
// Copyright 2023 The Oppia Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview Model class for creating new frontend instances of Learner
 *     Action domain objects.
 */

import {StatisticsDomainConstants} from 'domain/statistics/statistics-domain.constants';

export interface ExplorationStartCustomizationArgs {
  state_name: {value: string};
}

export interface AnswerSubmitCustomizationArgs {
  state_name: {value: string};
  dest_state_name: {value: string};
  interaction_id: {value: string};
  submitted_answer: {value: string};
  feedback: {value: string};
  time_spent_state_in_msecs: {value: number};
}

export interface ExplorationQuitCustomizationArgs {
  state_name: {value: string};
  time_spent_in_state_in_msecs: {value: number};
}

type LearnerActionCustomizationArgs =
  | ExplorationStartCustomizationArgs
  | AnswerSubmitCustomizationArgs
  | ExplorationQuitCustomizationArgs;

export interface LearnerActionBackendDict {
  action_type: LearnerActionType;
  action_customization_args: LearnerActionCustomizationArgs;
  schema_version: number;
}

export enum LearnerActionType {
  ExplorationStart = 'ExplorationStart',
  AnswerSubmit = 'AnswerSubmit',
  ExplorationQuit = 'ExplorationQuit',
}

export class LearnerAction {
  constructor(
    public readonly actionType: LearnerActionType,
    public actionCustomizationArgs: LearnerActionCustomizationArgs,
    public schemaVersion: number
  ) {}

  toBackendDict(): LearnerActionBackendDict {
    return {
      action_type: this.actionType,
      action_customization_args: this.actionCustomizationArgs,
      schema_version: this.schemaVersion,
    };
  }

  static createNewExplorationStartAction(
    actionCustomizationArgs: ExplorationStartCustomizationArgs
  ): LearnerAction {
    return new LearnerAction(
      LearnerActionType.ExplorationStart,
      actionCustomizationArgs,
      StatisticsDomainConstants.LEARNER_ACTION_SCHEMA_LATEST_VERSION
    );
  }

  static createNewAnswerSubmitAction(
    actionCustomizationArgs: AnswerSubmitCustomizationArgs
  ): LearnerAction {
    return new LearnerAction(
      LearnerActionType.AnswerSubmit,
      actionCustomizationArgs,
      StatisticsDomainConstants.LEARNER_ACTION_SCHEMA_LATEST_VERSION
    );
  }

  static createNewExplorationQuitAction(
    actionCustomizationArgs: ExplorationQuitCustomizationArgs
  ): LearnerAction {
    return new LearnerAction(
      LearnerActionType.ExplorationQuit,
      actionCustomizationArgs,
      StatisticsDomainConstants.LEARNER_ACTION_SCHEMA_LATEST_VERSION
    );
  }

  /**
   * @typedef LearnerActionBackendDict
   * @property {string} actionType - type of an action.
   * @property {Object.<string, *>} LearnerActionCustomizationArgs
   *  - customization dict for an action.
   * @property {number} schemaVersion - schema version of the class instance.
   *   Defaults to the latest schema version.
   */

  /**
   * @param {LearnerActionBackendDict} learnerActionBackendDict
   * @returns {LearnerAction}
   */
  static createFromBackendDict(
    learnerActionBackendDict: LearnerActionBackendDict
  ): LearnerAction {
    switch (learnerActionBackendDict.action_type) {
      case LearnerActionType.ExplorationStart:
        return new LearnerAction(
          learnerActionBackendDict.action_type,
          learnerActionBackendDict.action_customization_args as ExplorationStartCustomizationArgs,
          learnerActionBackendDict.schema_version
        );
      case LearnerActionType.AnswerSubmit:
        return new LearnerAction(
          learnerActionBackendDict.action_type,
          learnerActionBackendDict.action_customization_args as AnswerSubmitCustomizationArgs,
          learnerActionBackendDict.schema_version
        );
      case LearnerActionType.ExplorationQuit:
        return new LearnerAction(
          learnerActionBackendDict.action_type,
          learnerActionBackendDict.action_customization_args as ExplorationQuitCustomizationArgs,
          learnerActionBackendDict.schema_version
        );
      default:
        throw new Error(
          'Backend dict does not match any known action type: ' +
            JSON.stringify(learnerActionBackendDict)
        );
    }
  }
}