extensions/interactions/customization-args-defs.ts - develop - githubmirror/oppia

extensions/interactions/customization-args-defs.ts
460 строк10 KB
ateeksh22
Fix #25231: Migrate interaction ID contracts to InteractionSpecsKey (#26089)
09 июл 2026, 14:27
09 июл 2026, 14:270a2505c
// Copyright 2020 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 Type definiitions for Customization Args.
 */

import {GraphAnswer} from 'interactions/answer-defs';

import {
  SubtitledHtmlBackendDict,
  SubtitledHtml,
} from 'domain/exploration/subtitled-html.model';
import {
  SubtitledUnicodeBackendDict,
  SubtitledUnicode,
} from 'domain/exploration/subtitled-unicode.model';
import {InteractionSpecsKey} from 'pages/interaction-specs.constants';

export interface LabeledRegion {
  region: {
    area: number[][];
  };
  label: string;
}

export interface ImageWithRegions {
  labeledRegions: LabeledRegion[];
  imagePath: string;
}

export interface ReadableMusicNote {
  readableNoteName: string;
  noteDuration: {
    num: number;
    den: number;
  };
}

export interface AlgebraicExpressionInputCustomizationArgs {
  useFractionForDivision: boolean;
  allowedVariables: {
    value: string[];
  };
}
export interface AlgebraicExpressionInputCustomizationArgsBackendDict {
  useFractionForDivision: boolean;
  allowedVariables: {
    value: string[];
  };
}

export interface CodeReplCustomizationArgsBackendDict {
  language: {
    value: string;
  };
  placeholder: {
    value: string;
  };
  preCode: {
    value: string;
  };
  postCode: {
    value: string;
  };
}
export interface CodeReplCustomizationArgs {
  language: {
    value: string;
  };
  placeholder: {
    value: string;
  };
  preCode: {
    value: string;
  };
  postCode: {
    value: string;
  };
}

export interface ContinueCustomizationArgsBackendDict {
  buttonText: {
    value: SubtitledUnicodeBackendDict;
  };
}
export interface ContinueCustomizationArgs {
  buttonText: {
    value: SubtitledUnicode;
  };
}

export interface DragAndDropSortInputCustomizationArgsBackendDict {
  choices: {
    value: SubtitledHtmlBackendDict[];
  };
  allowMultipleItemsInSamePosition: {
    value: boolean;
  };
}
export interface DragAndDropSortInputCustomizationArgs {
  choices: {
    value: SubtitledHtml[];
  };
  allowMultipleItemsInSamePosition: {
    value: boolean;
  };
}

export interface EndExplorationCustomizationArgsBackendDict {
  recommendedExplorationIds: {
    value: string[];
  };
}
export interface EndExplorationCustomizationArgs {
  recommendedExplorationIds: {
    value: string[];
  };
}

export interface FractionInputCustomizationArgsBackendDict {
  requireSimplestForm: {
    value: boolean;
  };
  allowImproperFraction: {
    value: boolean;
  };
  allowNonzeroIntegerPart: {
    value: boolean;
  };
  customPlaceholder: {
    value: SubtitledUnicodeBackendDict;
  };
}
export interface FractionInputCustomizationArgs {
  requireSimplestForm: {
    value: boolean;
  };
  allowImproperFraction: {
    value: boolean;
  };
  allowNonzeroIntegerPart: {
    value: boolean;
  };
  customPlaceholder: {
    value: SubtitledUnicode;
  };
}

export interface GraphInputCustomizationArgsBackendDict {
  graph: {
    value: GraphAnswer;
  };
  canAddVertex: {
    value: boolean;
  };
  canDeleteVertex: {
    value: boolean;
  };
  canEditVertexLabel: {
    value: boolean;
  };
  canMoveVertex: {
    value: boolean;
  };
  canAddEdge: {
    value: boolean;
  };
  canDeleteEdge: {
    value: boolean;
  };
  canEditEdgeWeight: {
    value: boolean;
  };
}
export interface GraphInputCustomizationArgs {
  graph: {
    value: GraphAnswer;
  };
  canAddVertex: {
    value: boolean;
  };
  canDeleteVertex: {
    value: boolean;
  };
  canEditVertexLabel: {
    value: boolean;
  };
  canMoveVertex: {
    value: boolean;
  };
  canAddEdge: {
    value: boolean;
  };
  canDeleteEdge: {
    value: boolean;
  };
  canEditEdgeWeight: {
    value: boolean;
  };
}

export interface ImageClickInputCustomizationArgsBackendDict {
  imageAndRegions: {
    value: ImageWithRegions;
  };
  highlightRegionsOnHover: {
    value: boolean;
  };
}
export interface ImageClickInputCustomizationArgs {
  imageAndRegions: {
    value: ImageWithRegions;
  };
  highlightRegionsOnHover: {
    value: boolean;
  };
}

export interface InteractiveMapCustomizationArgsBackendDict {
  latitude: {
    value: number;
  };
  longitude: {
    value: number;
  };
  zoom: {
    value: number;
  };
}
export interface InteractiveMapCustomizationArgs {
  latitude: {
    value: number;
  };
  longitude: {
    value: number;
  };
  zoom: {
    value: number;
  };
}

export interface ItemSelectionInputCustomizationArgsBackendDict {
  choices: {
    value: SubtitledHtmlBackendDict[];
  };
  maxAllowableSelectionCount: {
    value: number;
  };
  minAllowableSelectionCount: {
    value: number;
  };
}
export interface ItemSelectionInputCustomizationArgs {
  choices: {
    value: SubtitledHtml[];
  };
  maxAllowableSelectionCount: {
    value: number;
  };
  minAllowableSelectionCount: {
    value: number;
  };
}

export interface MathEquationInputCustomizationArgsBackendDict {
  useFractionForDivision: boolean;
  allowedVariables: {
    value: string[];
  };
}
export interface MathEquationInputCustomizationArgs {
  useFractionForDivision: boolean;
  allowedVariables: {
    value: string[];
  };
}

export interface MultipleChoiceInputCustomizationArgsBackendDict {
  showChoicesInShuffledOrder: {
    value: boolean;
  };
  choices: {
    value: SubtitledHtmlBackendDict[];
  };
}
export interface MultipleChoiceInputCustomizationArgs {
  showChoicesInShuffledOrder: {
    value: boolean;
  };
  choices: {
    value: SubtitledHtml[];
  };
}

export interface MusicNotesInputCustomizationArgsBackendDict {
  sequenceToGuess: {
    value: ReadableMusicNote[];
  };
  initialSequence: {
    value: ReadableMusicNote[];
  };
}
export interface MusicNotesInputCustomizationArgs {
  sequenceToGuess: {
    value: ReadableMusicNote[];
  };
  initialSequence: {
    value: ReadableMusicNote[];
  };
}

export interface PencilCodeEditorCustomizationArgsBackendDict {
  initialCode: {
    value: string;
  };
}
export interface PencilCodeEditorCustomizationArgs {
  initialCode: {
    value: string;
  };
}

export interface RatioExpressionInputCustomizationArgsBackendDict {
  placeholder: {
    value: SubtitledUnicodeBackendDict;
  };
  numberOfTerms: {
    value: number;
  };
}
export interface RatioExpressionInputCustomizationArgs {
  placeholder: {
    value: SubtitledUnicode;
  };
  numberOfTerms: {
    value: number;
  };
}

export interface SetInputCustomizationArgsBackendDict {
  buttonText: {
    value: SubtitledUnicodeBackendDict;
  };
}
export interface SetInputCustomizationArgs {
  buttonText: {
    value: SubtitledUnicode;
  };
}

export interface TextInputCustomizationArgsBackendDict {
  placeholder: {
    value: SubtitledUnicodeBackendDict;
  };
  rows: {
    value: number;
  };
  catchMisspellings: {
    value: boolean;
  };
}
export interface TextInputCustomizationArgs {
  placeholder: {
    value: SubtitledUnicode;
  };
  rows: {
    value: number;
  };
  catchMisspellings: {
    value: boolean;
  };
}

export interface NumericExpressionInputCustomizationArgsBackendDict {
  useFractionForDivision: boolean;
  placeholder: {
    value: SubtitledUnicodeBackendDict;
  };
}
export interface NumericExpressionInputCustomizationArgs {
  useFractionForDivision: boolean;
  placeholder: {
    value: SubtitledUnicode;
  };
}

export interface NumericInputCustomizationArgsBackendDict {
  requireNonnegativeInput: {
    value: boolean;
  };
}
export interface NumericInputCustomizationArgs {
  requireNonnegativeInput: {
    value: boolean;
  };
}

export interface NumberWithUnitsCustomizationArgsBackendDict {}
export interface NumberWithUnitsCustomizationArgs {}

export type InteractionCustomizationArgsBackendDict =
  | AlgebraicExpressionInputCustomizationArgsBackendDict
  | CodeReplCustomizationArgsBackendDict
  | ContinueCustomizationArgsBackendDict
  | DragAndDropSortInputCustomizationArgsBackendDict
  | EndExplorationCustomizationArgsBackendDict
  | FractionInputCustomizationArgsBackendDict
  | GraphInputCustomizationArgsBackendDict
  | ImageClickInputCustomizationArgsBackendDict
  | InteractiveMapCustomizationArgsBackendDict
  | ItemSelectionInputCustomizationArgsBackendDict
  | MathEquationInputCustomizationArgsBackendDict
  | MultipleChoiceInputCustomizationArgsBackendDict
  | MusicNotesInputCustomizationArgsBackendDict
  | NumberWithUnitsCustomizationArgsBackendDict
  | NumericExpressionInputCustomizationArgsBackendDict
  | NumericInputCustomizationArgsBackendDict
  | PencilCodeEditorCustomizationArgsBackendDict
  | RatioExpressionInputCustomizationArgsBackendDict
  | SetInputCustomizationArgsBackendDict
  | TextInputCustomizationArgsBackendDict;

export type InteractionCustomizationArgs =
  | AlgebraicExpressionInputCustomizationArgs
  | CodeReplCustomizationArgs
  | ContinueCustomizationArgs
  | DragAndDropSortInputCustomizationArgs
  | EndExplorationCustomizationArgs
  | FractionInputCustomizationArgs
  | GraphInputCustomizationArgs
  | ImageClickInputCustomizationArgs
  | InteractiveMapCustomizationArgs
  | ItemSelectionInputCustomizationArgs
  | MathEquationInputCustomizationArgs
  | MultipleChoiceInputCustomizationArgs
  | MusicNotesInputCustomizationArgs
  | NumberWithUnitsCustomizationArgs
  | NumericExpressionInputCustomizationArgs
  | NumericInputCustomizationArgs
  | PencilCodeEditorCustomizationArgs
  | RatioExpressionInputCustomizationArgs
  | SetInputCustomizationArgs
  | TextInputCustomizationArgs;

export interface InteractionData {
  interactionId: InteractionSpecsKey | null;
  customizationArgs: InteractionCustomizationArgs;
}