Introduce SerializeOptions to editor serialize() functions

Author: jeremywiebe

packages/perseus-editor/src/editor-page.tsx

@@ -8,6 +8,7 @@ import CombinedHintsEditor from "./hint-editor";
 import ItemEditor from "./item-editor";
 
 import type {Issue} from "./issues-panel";
+import type {SerializeOptions} from "./types";
 import type {
     APIOptions,
     APIOptionsWithDefaults,
@@ -188,7 +189,7 @@ class EditorPage extends React.Component<Props, State> {
         return issues1.concat(issues2);
     }
 
-    serialize(options?: {keepDeletedWidgets?: boolean}): any | PerseusItem {
+    serialize(options?: SerializeOptions): PerseusItem {
         if (this.props.jsonMode) {
             return this.state.json;
         }

packages/perseus-editor/src/editor.tsx

@@ -28,6 +28,7 @@ import WidgetEditor from "./components/widget-editor";
 import WidgetSelect from "./components/widget-select";
 import TexErrorView from "./tex-error-view";
 
+import type {SerializeOptions} from "./types";
 import type {ChangeHandler, ImageUploader} from "@khanacademy/perseus";
 import type {PerseusWidget, PerseusWidgetsMap} from "@khanacademy/perseus-core";
 
@@ -833,12 +834,12 @@ class Editor extends React.Component<Props, State> {
         }
     };
 
-    serialize: (options?: any) => {
+    serialize: (options?: SerializeOptions) => {
         content: string;
         images: any;
         replace: any | undefined;
         widgets: Record<any, any>;
-    } = (options: any) => {
+    } = (options) => {
         // need to serialize the widgets since the state might not be
         // completely represented in props. ahem //transformer// (and
         // interactive-graph and plotter).

packages/perseus-editor/src/hint-editor.tsx

@@ -17,6 +17,7 @@ import {
     iconPlus,
 } from "./styles/icon-paths";
 
+import type {SerializeOptions} from "./types";
 import type {
     APIOptions,
     ImageDict,
@@ -90,7 +91,7 @@ class HintEditor extends React.Component<HintEditorProps> {
         return this.editor.current?.getSaveWarnings();
     };
 
-    serialize: (options?: any) => any = (options: any) => {
+    serialize: (options?: SerializeOptions) => any = (options) => {
         return this.editor.current?.serialize(options);
     };
 
@@ -224,7 +225,7 @@ class CombinedHintEditor extends React.Component<CombinedHintEditorProps> {
         return this.editor.current?.getSaveWarnings();
     };
 
-    serialize = (options: any) => {
+    serialize = (options: SerializeOptions) => {
         return this.editor.current?.serialize(options);
     };
 
@@ -387,7 +388,9 @@ class CombinedHintsEditor extends React.Component<CombinedHintsEditorProps> {
             .value();
     };
 
-    serialize: (options?: any) => ReadonlyArray<string> = (options: any) => {
+    serialize: (options?: SerializeOptions) => ReadonlyArray<string> = (
+        options,
+    ) => {
         return this.props.hints.map((hint, i) => {
             return this.serializeHint(i, options);
         });

packages/perseus-editor/src/item-editor.tsx

@@ -11,6 +11,7 @@ import ItemExtrasEditor from "./item-extras-editor";
 import {WARNINGS} from "./messages";
 
 import type {Issue} from "./issues-panel";
+import type {SerializeOptions} from "./types";
 import type {
     APIOptions,
     ImageUploader,
@@ -130,7 +131,7 @@ class ItemEditor extends React.Component<Props, State> {
         return this.questionEditor.current?.getSaveWarnings();
     };
 
-    serialize: (options?: any) => {
+    serialize: (options?: SerializeOptions) => {
         answerArea: PerseusAnswerArea | undefined;
         question: any;
     } = (options: any) => {

packages/perseus-editor/src/types.ts

@@ -0,0 +1 @@
+export type SerializeOptions = {keepDeletedWidgets?: boolean};