@elice/material-quiz 1.220803.0

package/es/components/material-quiz-edit/MaterialQuizEdit.d.ts

@@ -0,0 +1,25 @@
+import React from 'react';
+import type { MarkdownEditorFileUploadReqFn } from '@elice/markdown';
+import type { GetOrgMaterialQuizGetResponses } from '@elice/types';
+import type { FormState } from 'react-hook-form';
+export declare type MaterialQuizEditValue = Pick<GetOrgMaterialQuizGetResponses['materialQuiz'], 'id' | 'questionTitle' | 'questionDescription' | 'optionType' | 'optionInfo' | 'answerInfo' | 'answerHint' | 'isAutoGrade' | 'explanationInfo'>;
+export declare type MaterialQuizEditFormState = Pick<FormState<Record<string, any>>, 'isDirty' | 'isValid'>;
+export interface MaterialQuizEditProps {
+    /** Value of material quiz edit form. */
+    value: MaterialQuizEditValue;
+    /**
+     * Is editing disabled?
+     * When true, cannot change `optionType`, `optionInfo` and `answerInfo`.
+     */
+    disabled?: boolean;
+    /** Locale of edit form. */
+    locale: string;
+    /** Handle form change event. */
+    onChange: (value: MaterialQuizEditValue) => void;
+    /** Handle form state changes. (`FormState` from react-hook-form) */
+    onFormStateChange?: (state: MaterialQuizEditFormState) => void;
+    /** Handle file upload. */
+    onFileUploadRequest: MarkdownEditorFileUploadReqFn;
+}
+declare const MaterialQuizEdit: React.ForwardRefExoticComponent<MaterialQuizEditProps & React.RefAttributes<HTMLFormElement>>;
+export default MaterialQuizEdit;

package/es/components/material-quiz-edit/MaterialQuizEdit.js

@@ -0,0 +1,86 @@
+import React, { forwardRef } from 'react';
+import { useForm, FormProvider } from 'react-hook-form';
+import { IntlProvider } from 'react-intl';
+import { useDeepCompareEffect } from 'react-use';
+import { manipulateValue, restoreValue } from './utils/editValue.js';
+import MaterialQuizEditContext from './context.js';
+import * as locales from './locales.js';
+import { en } from './locales.js';
+import MaterialQuizEditContent from './MaterialQuizEditContent.js';
+
+const MaterialQuizEdit = forwardRef(({
+  value,
+  disabled = false,
+  locale = 'en',
+  onChange,
+  onFormStateChange,
+  onFileUploadRequest
+}, ref) => {
+  const formElRef = React.useRef(null);
+  const useFormMethods = useForm({
+    defaultValues: manipulateValue(value),
+    mode: 'onBlur'
+  });
+  const watchedMaterialQuizEditValue = useFormMethods.watch();
+  const {
+    isDirty,
+    isValid
+  } = useFormMethods.formState; //
+  // Reset from value, when `value` changes.
+  // TODO: will be removed, since `CourseLecturesMaterialTemplate` removed at `elice-web`.
+  //
+
+  useDeepCompareEffect(() => {
+    useFormMethods.reset(manipulateValue(value), {
+      keepDirty: true,
+      keepErrors: true,
+      keepIsValid: true,
+      keepTouched: true,
+      keepValues: true
+    });
+    void useFormMethods.trigger();
+  }, [value]); //
+  // Emit `onChange` handler when form value changed.
+  // TODO: will be removed, since `CourseLecturesMaterialTemplate` removed at `elice-web`.
+  //
+
+  useDeepCompareEffect(() => onChange(restoreValue(watchedMaterialQuizEditValue)), [watchedMaterialQuizEditValue]); //
+  // Emit `onFormStateChange` handler when form state change.
+  //
+
+  React.useEffect(() => {
+    if (typeof onFormStateChange === 'function') {
+      onFormStateChange({
+        isDirty,
+        isValid
+      });
+    }
+  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  [isDirty, isValid]); //
+  // Set ref.
+  //
+
+  React.useImperativeHandle(ref, () => Object.assign(Object.assign({}, formElRef.current), {
+    reset: () => {
+      useFormMethods.reset(manipulateValue(value));
+      void useFormMethods.trigger();
+    }
+  }), [useFormMethods, value]); //
+  //
+  //
+
+  return React.createElement("form", {
+    ref: formElRef
+  }, React.createElement(MaterialQuizEditContext.Provider, {
+    value: {
+      disabled,
+      onFileUploadRequest
+    }
+  }, React.createElement(IntlProvider, {
+    locale: locale,
+    defaultLocale: "en",
+    messages: locale in locales ? locales[locale] : en
+  }, React.createElement(FormProvider, Object.assign({}, useFormMethods), React.createElement(MaterialQuizEditContent, null)))));
+});
+
+export { MaterialQuizEdit as default };

package/es/components/material-quiz-edit/MaterialQuizEditContent.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const MaterialQuizEditContent: React.FC;
+export default MaterialQuizEditContent;

package/es/components/material-quiz-edit/MaterialQuizEditContent.js

@@ -0,0 +1,456 @@
+import React from 'react';
+import { useFormContext, Controller } from 'react-hook-form';
+import { useIntl, FormattedMessage } from 'react-intl';
+import { Transition } from 'react-transition-group';
+import { FormInputVerticalLayout, Label, Input, Tooltip, Select, StatusText, Vspace, Text, Checkbox, Flex } from '@elice/blocks';
+import { MarkdownEditor } from '@elice/markdown';
+import { enums } from '@elice/types';
+import styled from 'styled-components';
+import OptionSelectMultiple from './options/OptionSelectMultiple.js';
+import OptionSelectMultipleOrder from './options/OptionSelectMultipleOrder.js';
+import OptionSelectOne from './options/OptionSelectOne.js';
+import OptionText from './options/OptionText.js';
+import { createRandomId } from './utils/randomId.js';
+import { useMaterialQuizEditContext } from './context.js';
+
+const MIN_TEXT_LENGTH = 1;
+const MAX_TEXT_LENGTH = 128;
+const StyledQuizOptionTypeSelectWrap = styled.div.withConfig({
+  componentId: "sc-1cf4b99-0"
+})(["display:flex;max-width:12rem;"]);
+
+const MaterialQuizEditContent = () => {
+  const intl = useIntl();
+  const {
+    disabled,
+    onFileUploadRequest
+  } = useMaterialQuizEditContext();
+  const {
+    control,
+    watch,
+    setValue
+  } = useFormContext();
+  const [watchedOptionType, watchedOptionInfo, watchedAnswerInfo, watchedAnswerHint, watchedExplanationInfo, watchedIsAutoGrade] = watch(['optionType', 'optionInfo', 'answerInfo', 'answerHint', 'explanationInfo', 'isAutoGrade']); //
+  // Change `optionInfo` according to `optionType`.
+  //
+
+  React.useEffect(() => {
+    const get = () => {
+      switch (watchedOptionType) {
+        case enums.QuizOptionType.SelectOne:
+        case enums.QuizOptionType.SelectMultiple:
+        case enums.QuizOptionType.SelectMultipleOrder:
+          return watchedOptionInfo.length > 0 ? watchedOptionInfo : // add default option info
+          [{
+            id: createRandomId(),
+            value: intl.formatMessage({
+              id: 'common.option'
+            }, {
+              number: 1
+            })
+          }, {
+            id: createRandomId(),
+            value: intl.formatMessage({
+              id: 'common.option'
+            }, {
+              number: 2
+            })
+          }];
+
+        case enums.QuizOptionType.Text:
+          return [];
+
+        default:
+          return [];
+      }
+    };
+
+    setValue('optionInfo', get());
+  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  [watchedOptionType, setValue, intl]); //
+  // Change `answerInfo` according to `optionType`.
+  //
+
+  React.useEffect(() => {
+    const get = () => {
+      switch (watchedOptionType) {
+        case enums.QuizOptionType.SelectOne:
+          return Array.isArray(watchedAnswerInfo) ? // get first option
+          watchedAnswerInfo.slice(0, 1) : [0];
+
+        case enums.QuizOptionType.SelectMultiple:
+        case enums.QuizOptionType.SelectMultipleOrder:
+          return Array.isArray(watchedAnswerInfo) ? watchedAnswerInfo : [0];
+
+        case enums.QuizOptionType.Text:
+          return typeof watchedAnswerInfo === 'string' ? watchedAnswerInfo : '';
+
+        default:
+          return [];
+      }
+    };
+
+    setValue('answerInfo', get());
+  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  [watchedOptionType, setValue, intl]); //
+  // Change `answerHint` according to `optionType`.
+  //
+
+  React.useEffect(() => {
+    const get = () => {
+      switch (watchedOptionType) {
+        case enums.QuizOptionType.SelectOne:
+        case enums.QuizOptionType.SelectMultiple:
+        case enums.QuizOptionType.SelectMultipleOrder:
+          return null;
+
+        case enums.QuizOptionType.Text:
+          return watchedAnswerHint !== null && watchedAnswerHint !== void 0 ? watchedAnswerHint : '';
+
+        default:
+          return null;
+      }
+    };
+
+    setValue('answerHint', get());
+  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  [watchedOptionType, setValue, intl]); //
+  // Change `isAutoGrade` according to `optionType`.
+  //
+
+  React.useEffect(() => {
+    const get = () => {
+      switch (watchedOptionType) {
+        case enums.QuizOptionType.SelectOne:
+        case enums.QuizOptionType.SelectMultiple:
+        case enums.QuizOptionType.SelectMultipleOrder:
+          return true;
+
+        case enums.QuizOptionType.Text:
+          return typeof watchedIsAutoGrade === 'boolean' ? watchedIsAutoGrade : true;
+
+        default:
+          return true;
+      }
+    };
+
+    setValue('isAutoGrade', get());
+  }, // eslint-disable-next-line react-hooks/exhaustive-deps
+  [watchedOptionType, setValue, intl]);
+  /**
+   * Input of option info and answer info,
+   * according to option type.
+   */
+
+  const Option = React.useMemo(() => {
+    switch (watchedOptionType) {
+      case enums.QuizOptionType.SelectOne:
+        return OptionSelectOne;
+
+      case enums.QuizOptionType.SelectMultiple:
+        return OptionSelectMultiple;
+
+      case enums.QuizOptionType.SelectMultipleOrder:
+        return OptionSelectMultipleOrder;
+
+      case enums.QuizOptionType.Text:
+        return OptionText;
+
+      default:
+        return React.Fragment;
+    }
+  }, [watchedOptionType]);
+  /**
+   * Render input for quiz title.
+   */
+
+  const renderQuestionTitleInput = () => {
+    return React.createElement(FormInputVerticalLayout, {
+      label: React.createElement(Label, {
+        size: "small",
+        required: true
+      }, React.createElement(FormattedMessage, {
+        id: "content.title"
+      })),
+      input: React.createElement(Controller, {
+        control: control,
+        name: "questionTitle",
+        rules: {
+          required: {
+            value: true,
+            message: intl.formatMessage({
+              id: 'content.title.errorMessage.required'
+            })
+          },
+          minLength: {
+            value: MIN_TEXT_LENGTH,
+            message: intl.formatMessage({
+              id: 'common.errorMessage.range'
+            }, {
+              min: MIN_TEXT_LENGTH,
+              max: MAX_TEXT_LENGTH
+            })
+          },
+          maxLength: {
+            value: MAX_TEXT_LENGTH,
+            message: intl.formatMessage({
+              id: 'common.errorMessage.range'
+            }, {
+              min: MIN_TEXT_LENGTH,
+              max: MAX_TEXT_LENGTH
+            })
+          }
+        },
+        render: ({
+          field,
+          fieldState
+        }) => {
+          var _a;
+
+          return React.createElement(Input, Object.assign({
+            size: "small",
+            width: "full",
+            minLength: MIN_TEXT_LENGTH,
+            maxLength: MAX_TEXT_LENGTH,
+            placeholder: intl.formatMessage({
+              id: 'content.title.placeholder'
+            }),
+            invalid: fieldState.invalid,
+            invalidText: (_a = fieldState.error) === null || _a === void 0 ? void 0 : _a.message
+          }, field));
+        }
+      })
+    });
+  };
+  /**
+   * Render input for quiz description.
+   */
+
+
+  const renderQuestionDescriptionInput = () => {
+    return React.createElement(FormInputVerticalLayout, {
+      label: React.createElement(Label, {
+        size: "small"
+      }, React.createElement(FormattedMessage, {
+        id: "content.description.title"
+      })),
+      input: React.createElement(Controller, {
+        control: control,
+        name: "questionDescription",
+        render: ({
+          field
+        }) => React.createElement(MarkdownEditor, Object.assign({
+          enableFooter: true,
+          placeholder: intl.formatMessage({
+            id: 'content.description.placeholder'
+          }),
+          onFileUploadRequest: onFileUploadRequest
+        }, field))
+      })
+    });
+  };
+  /**
+   * Render input of option type, option info and answer info.
+   */
+
+
+  const renderOptionInput = () => {
+    return React.createElement(FormInputVerticalLayout, {
+      label: React.createElement(Label, {
+        size: "small",
+        required: true
+      }, React.createElement(FormattedMessage, {
+        id: "content.option.title"
+      })),
+      input: React.createElement(React.Fragment, null, React.createElement(Controller, {
+        control: control,
+        name: "optionType",
+        render: ({
+          field
+        }) => React.createElement(Tooltip, {
+          title: disabled ? intl.formatMessage({
+            id: 'content.option.tooltip.disabled'
+          }) : undefined,
+          placement: "top-end"
+        }, React.createElement(StyledQuizOptionTypeSelectWrap, null, React.createElement(Select, Object.assign({
+          size: "small",
+          width: "small",
+          readOnly: disabled
+        }, field, {
+          onChange: v => field.onChange(Number(v))
+        }), React.createElement("option", {
+          value: enums.QuizOptionType.SelectOne,
+          children: intl.formatMessage({
+            id: 'content.option.select.items.selectOne'
+          })
+        }), React.createElement("option", {
+          value: enums.QuizOptionType.SelectMultiple,
+          children: intl.formatMessage({
+            id: 'content.option.select.items.selectMultiple'
+          })
+        }), React.createElement("option", {
+          value: enums.QuizOptionType.SelectMultipleOrder,
+          children: intl.formatMessage({
+            id: 'content.option.select.items.selectMultipleOrder'
+          })
+        }), React.createElement("option", {
+          value: enums.QuizOptionType.Text,
+          children: intl.formatMessage({
+            id: 'content.option.select.items.text'
+          })
+        }))))
+      }), React.createElement(Transition, {
+        in: watchedOptionType === enums.QuizOptionType.SelectMultipleOrder,
+        timeout: 0,
+        mountOnEnter: true,
+        unmountOnExit: true
+      }, React.createElement(StatusText, {
+        role: "description",
+        preWrap: true
+      }, React.createElement(FormattedMessage, {
+        id: "content.option.statusText.dragNDrop"
+      }))), React.createElement(Vspace, {
+        height: 0.5
+      }), React.createElement(Option, null))
+    });
+  };
+  /**
+   * Input of answer hint.
+   */
+
+
+  const renderAnswerHintInput = () => {
+    if (watchedOptionType !== enums.QuizOptionType.Text) {
+      return null;
+    }
+
+    return React.createElement(FormInputVerticalLayout, {
+      label: React.createElement(Label, {
+        size: "small"
+      }, React.createElement(FormattedMessage, {
+        id: "content.answerHint.title"
+      })),
+      description: React.createElement(Text, null, React.createElement(FormattedMessage, {
+        id: "content.answerHint.description"
+      })),
+      input: React.createElement(Controller, {
+        control: control,
+        name: "answerHint",
+        rules: {
+          minLength: {
+            value: MIN_TEXT_LENGTH,
+            message: intl.formatMessage({
+              id: 'common.errorMessage.range'
+            }, {
+              min: MIN_TEXT_LENGTH,
+              max: MAX_TEXT_LENGTH
+            })
+          },
+          maxLength: {
+            value: MAX_TEXT_LENGTH,
+            message: intl.formatMessage({
+              id: 'common.errorMessage.range'
+            }, {
+              min: MIN_TEXT_LENGTH,
+              max: MAX_TEXT_LENGTH
+            })
+          }
+        },
+        render: ({
+          field,
+          fieldState
+        }) => {
+          var _a, _b;
+
+          return React.createElement(Input, Object.assign({
+            size: "small",
+            width: "full",
+            minLength: MIN_TEXT_LENGTH,
+            maxLength: MAX_TEXT_LENGTH,
+            placeholder: intl.formatMessage({
+              id: 'content.answerHint.placeholder'
+            }),
+            invalid: fieldState.invalid,
+            invalidText: (_a = fieldState.error) === null || _a === void 0 ? void 0 : _a.message
+          }, field, {
+            value: (_b = field.value) !== null && _b !== void 0 ? _b : ''
+          }));
+        }
+      })
+    });
+  };
+  /**
+   * Input of explanation info.
+   */
+
+
+  const renderExplanationInfoInput = () => {
+    return React.createElement(FormInputVerticalLayout, {
+      label: React.createElement(Label, {
+        size: "small"
+      }, React.createElement(FormattedMessage, {
+        id: "content.explanationInfo.title"
+      })),
+      description: React.createElement(Text, null, React.createElement(FormattedMessage, {
+        id: "content.explanationInfo.description"
+      })),
+      input: React.createElement(React.Fragment, null, React.createElement(Controller, {
+        control: control,
+        name: "explanationInfo.isEnabled",
+        render: ({
+          field
+        }) => React.createElement(Checkbox, Object.assign({
+          size: "small"
+        }, field), React.createElement(FormattedMessage, {
+          id: "content.explanationInfo.checkbox.label"
+        }))
+      }), React.createElement(Transition, {
+        in: watchedExplanationInfo.isEnabled,
+        timeout: 0,
+        mountOnEnter: true,
+        unmountOnExit: true
+      }, React.createElement(React.Fragment, null, React.createElement(Vspace, {
+        height: 1
+      }), React.createElement(Controller, {
+        control: control,
+        name: "explanationInfo.value",
+        rules: {
+          required: {
+            value: true,
+            message: intl.formatMessage({
+              id: 'content.explanationInfo.textarea.placeholder'
+            })
+          }
+        },
+        render: ({
+          field,
+          fieldState
+        }) => {
+          var _a;
+
+          return React.createElement(Flex, {
+            column: true
+          }, fieldState.invalid ? React.createElement(React.Fragment, null, React.createElement(StatusText, {
+            children: (_a = fieldState.error) === null || _a === void 0 ? void 0 : _a.message,
+            role: "danger"
+          }), React.createElement(Vspace, {
+            height: 0.5
+          })) : null, React.createElement(MarkdownEditor, Object.assign({
+            enableFooter: true,
+            placeholder: intl.formatMessage({
+              id: 'content.explanationInfo.textarea.errorMessage.required'
+            }),
+            onFileUploadRequest: onFileUploadRequest
+          }, field)));
+        }
+      }))))
+    });
+  }; //
+  //
+  //
+
+
+  return React.createElement(React.Fragment, null, renderQuestionTitleInput(), renderQuestionDescriptionInput(), renderOptionInput(), renderAnswerHintInput(), renderExplanationInfoInput());
+};
+
+export { MaterialQuizEditContent as default };

package/es/components/material-quiz-edit/context.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import type { MaterialQuizEditProps } from './MaterialQuizEdit';
+declare type MaterialQuizEditContextValue = Pick<MaterialQuizEditProps, 'disabled' | 'onFileUploadRequest'>;
+declare const MaterialQuizEditContext: React.Context<MaterialQuizEditContextValue>;
+export declare const useMaterialQuizEditContext: () => MaterialQuizEditContextValue;
+export default MaterialQuizEditContext;

package/es/components/material-quiz-edit/context.js

@@ -0,0 +1,6 @@
+import React from 'react';
+
+const MaterialQuizEditContext = React.createContext(null);
+const useMaterialQuizEditContext = () => React.useContext(MaterialQuizEditContext);
+
+export { MaterialQuizEditContext as default, useMaterialQuizEditContext };

package/es/components/material-quiz-edit/index.d.ts

@@ -0,0 +1,2 @@
+export { default as MaterialQuizEdit } from './MaterialQuizEdit';
+export type { MaterialQuizEditProps, MaterialQuizEditFormState, MaterialQuizEditValue, } from './MaterialQuizEdit';

package/es/components/material-quiz-edit/locales.d.ts

@@ -0,0 +1,34 @@
+export declare const en: {
+    'common.option': string;
+    'common.errorMessage.range': string;
+    'content.title': string;
+    'content.title.errorMessage.required': string;
+    'content.title.placeholder': string;
+    'content.description.title': string;
+    'content.description.placeholder': string;
+    'content.option.title': string;
+    'content.option.tooltip.disabled': string;
+    'content.option.select.items.selectOne': string;
+    'content.option.select.items.selectMultiple': string;
+    'content.option.select.items.selectMultipleOrder': string;
+    'content.option.select.items.text': string;
+    'content.option.statusText.dragNDrop': string;
+    'content.option.errorMessage.required': string;
+    'content.answerHint.title': string;
+    'content.answerHint.description': string;
+    'content.answerHint.placeholder': string;
+    'content.explanationInfo.title': string;
+    'content.explanationInfo.description': string;
+    'content.explanationInfo.checkbox.label': string;
+    'content.explanationInfo.textarea.placeholder': string;
+    'content.explanationInfo.textarea.errorMessage.required': string;
+    'option.common.select.errorMessage.required': string;
+    'option.common.select.placeholder': string;
+    'option.common.select.tooltip.minOptionInfoItem': string;
+    'option.common.select.tooltip.maxOptionInfoItem': string;
+    'option.common.select.addButton': string;
+    'option.text.answerInfo.errorMessage.required': string;
+    'option.text.answerInfo.hintText': string;
+    'option.text.isAutoGrade.checkbox.label': string;
+};
+export declare const ko: typeof en;