@pie-element/placement-ordering 15.0.4-next.20261011174919 → 15.0.4

package/dist/author/choice-editor.d.ts

@@ -1,6 +1,48 @@
 import PropTypes from 'prop-types';
 import React from 'react';
-declare class ChoiceEditor extends React.Component {
+import type { DeleteDone, ImageHandler } from '@pie-element/shared-configure-events';
+import type { ConfigureMathMLProp, EditableHtmlConfigureProp } from '@pie-element/shared-types';
+import type { PlacementOrderingValidationErrors } from '../controller/index.js';
+import type { Choice, CorrectResponse } from '../types.js';
+/** A tile the author drags: a choice, or a slot of the correct order. */
+export type AuthorTile = Partial<Choice> & {
+    type: 'choice' | 'target';
+    draggable: boolean;
+    editable: boolean;
+    droppable?: boolean;
+    index?: number;
+};
+/** The choices, the correct order being edited, and the tiles built from both. */
+export type AuthorOrdering = {
+    choices: Choice[];
+    /** Has empty slots while the author has not placed every choice */
+    response: Array<CorrectResponse | string | undefined>;
+    tiles: AuthorTile[];
+};
+type ChoiceEditorProps = {
+    correctResponse?: Array<CorrectResponse | string>;
+    choices: Choice[];
+    onChange: (choices: Choice[], correctResponse?: AuthorOrdering['response']) => void;
+    imageSupport?: {
+        add: (handler: ImageHandler) => void;
+        delete: (src: string, done: DeleteDone) => void;
+    };
+    toolbarOpts?: {
+        position: string;
+    };
+    pluginProps?: EditableHtmlConfigureProp;
+    choicesLabel?: string;
+    placementArea?: boolean;
+    singularChoiceLabel?: string;
+    pluralChoiceLabel?: string;
+    spellCheck?: boolean;
+    maxImageWidth?: number;
+    maxImageHeight?: number;
+    errors?: PlacementOrderingValidationErrors;
+    mathMlOptions?: ConfigureMathMLProp;
+    ordering: AuthorOrdering;
+};
+declare class ChoiceEditor extends React.Component<ChoiceEditorProps> {
     static propTypes: {
         correctResponse: PropTypes.Validator<any[]>;
         choices: PropTypes.Validator<any[]>;

package/dist/author/defaults.d.ts

@@ -1,3 +1,5 @@
+import type { ConfigureLanguageOptionsProp } from '@pie-element/shared-types';
+import type { Choice, CorrectResponse } from '../types.js';
 /** NOTE: teacherInstructions, studentInstructions, rationale & scoringType
  * functionalities are not defined yet - the value for those can belong to
  * model or to configuration
@@ -5,168 +7,168 @@
 declare const _default: {
     model: {
         choiceLabel: string;
-        choiceLabelEnabled: boolean;
-        choices: never[];
-        correctResponse: never[];
-        feedbackEnabled: boolean;
-        numberedGuides: boolean;
-        orientation: string;
-        partialScoring: boolean;
-        placementArea: boolean;
+        choiceLabelEnabled: true;
+        choices: Choice[];
+        correctResponse: CorrectResponse[];
+        feedbackEnabled: false;
+        numberedGuides: false;
+        orientation: "vertical";
+        partialScoring: true;
+        placementArea: false;
         prompt: string;
-        promptEnabled: boolean;
+        promptEnabled: true;
         rationale: string;
-        rationaleEnabled: boolean;
-        removeTilesAfterPlacing: boolean;
-        scoringType: string;
-        studentInstructionsEnabled: boolean;
+        rationaleEnabled: true;
+        removeTilesAfterPlacing: true;
+        scoringType: "auto";
+        studentInstructionsEnabled: true;
         targetLabel: string;
         teacherInstructions: string;
-        teacherInstructionsEnabled: boolean;
-        toolbarEditorPosition: string;
+        teacherInstructionsEnabled: true;
+        toolbarEditorPosition: "bottom";
     };
     configuration: {
         baseInputConfiguration: {
             h3: {
-                disabled: boolean;
+                disabled: true;
             };
             audio: {
-                disabled: boolean;
+                disabled: false;
             };
             video: {
-                disabled: boolean;
+                disabled: false;
             };
             image: {
-                disabled: boolean;
+                disabled: false;
             };
             textAlign: {
-                disabled: boolean;
+                disabled: true;
             };
             showParagraphs: {
-                disabled: boolean;
+                disabled: false;
             };
             separateParagraphs: {
-                disabled: boolean;
+                disabled: true;
             };
         };
         choiceLabel: {
-            settings: boolean;
+            settings: true;
             label: string;
             inputConfiguration: {
                 audio: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 video: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 image: {
-                    disabled: boolean;
+                    disabled: false;
                 };
             };
         };
         choices: {
-            settings: boolean;
+            settings: true;
             label: string;
             inputConfiguration: {
                 audio: {
-                    disabled: boolean;
+                    disabled: true;
                 };
                 video: {
-                    disabled: boolean;
+                    disabled: true;
                 };
                 image: {
-                    disabled: boolean;
+                    disabled: true;
                 };
             };
         };
         feedback: {
-            settings: boolean;
+            settings: true;
             label: string;
-            enabled: boolean;
+            enabled: true;
         };
         prompt: {
-            settings: boolean;
+            settings: true;
             label: string;
-            required: boolean;
+            required: false;
             inputConfiguration: {
                 audio: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 video: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 image: {
-                    disabled: boolean;
+                    disabled: false;
                 };
             };
         };
         numberedGuides: {
-            settings: boolean;
+            settings: true;
             label: string;
         };
         orientation: {
-            settings: boolean;
+            settings: true;
             label: string;
         };
         partialScoring: {
-            settings: boolean;
+            settings: false;
             label: string;
         };
         placementArea: {
-            settings: boolean;
+            settings: true;
             label: string;
         };
         rationale: {
-            settings: boolean;
+            settings: true;
             label: string;
-            required: boolean;
+            required: false;
             inputConfiguration: {
                 audio: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 video: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 image: {
-                    disabled: boolean;
+                    disabled: false;
                 };
             };
         };
         removeTilesAfterPlacing: {
-            settings: boolean;
+            settings: false;
             label: string;
         };
-        settingsPanelDisabled: boolean;
+        settingsPanelDisabled: false;
         scoringType: {
-            settings: boolean;
+            settings: false;
             label: string;
         };
         studentInstructions: {
-            settings: boolean;
+            settings: false;
             label: string;
         };
         targetLabel: {
-            settings: boolean;
+            settings: true;
             label: string;
         };
         spellCheck: {
             label: string;
-            settings: boolean;
-            enabled: boolean;
+            settings: false;
+            enabled: true;
         };
         teacherInstructions: {
-            settings: boolean;
+            settings: true;
             label: string;
-            required: boolean;
+            required: false;
             inputConfiguration: {
                 audio: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 video: {
-                    disabled: boolean;
+                    disabled: false;
                 };
                 image: {
-                    disabled: boolean;
+                    disabled: false;
                 };
             };
         };
@@ -184,21 +186,21 @@ declare const _default: {
             choices: number;
         };
         withRubric: {
-            settings: boolean;
+            settings: false;
             label: string;
         };
         mathMlOptions: {
-            mmlOutput: boolean;
-            mmlEditing: boolean;
+            mmlOutput: false;
+            mmlEditing: false;
         };
         language: {
-            settings: boolean;
+            settings: false;
             label: string;
-            enabled: boolean;
+            enabled: false;
         };
         languageChoices: {
             label: string;
-            options: never[];
+            options: ConfigureLanguageOptionsProp[];
         };
     };
 };

package/dist/author/design.d.ts

@@ -1,13 +1,43 @@
 import React from 'react';
-import PropTypes from 'prop-types';
-export declare class Design extends React.Component {
-    static propTypes: {
-        uploadSoundSupport: PropTypes.Requireable<object>;
+import type { DragEndEvent } from '@dnd-kit/core';
+import { type AuthorOrdering } from './choice-editor.js';
+import type { DeleteDone, ImageHandler, SoundHandler } from '@pie-element/shared-configure-events';
+import type { PlacementOrderingValidationErrors } from '../controller/index.js';
+import type { Choice, PlacementOrderingConfiguration, PlacementOrderingModel } from '../types.js';
+/** The model the author edits; the host sets `errors` from the controller's `validate()`. */
+export type AuthorModel = Partial<PlacementOrderingModel> & {
+    choices: Choice[];
+    errors?: PlacementOrderingValidationErrors;
+};
+type MediaSupport<Handler> = {
+    add: (handler: Handler) => void;
+    delete: (src: string, done: DeleteDone) => void;
+};
+export type DesignProps = {
+    model: AuthorModel;
+    configuration: PlacementOrderingConfiguration;
+    onModelChanged: (model: AuthorModel, resetSession?: boolean) => void;
+    onConfigurationChanged: (configuration: PlacementOrderingConfiguration, reset?: boolean) => void;
+    imageSupport?: MediaSupport<ImageHandler>;
+    uploadSoundSupport?: MediaSupport<SoundHandler>;
+};
+export declare class Design extends React.Component<DesignProps> {
+    static defaultProps: {
+        onModelChanged: () => void;
+        onConfigurationChanged: () => void;
     };
-    static defaultProps: {};
-    constructor(props: any);
+    applyUpdate: (modelFn: (model: AuthorModel) => AuthorModel) => void;
+    changeHandler: (modelPath: string, valuePath?: string) => (value: unknown) => void;
+    onPromptChange: (value: unknown) => void;
+    onTeacherInstructionsChange: (value: unknown) => void;
+    onRationaleChange: (value: unknown) => void;
+    onChoiceAreaLabelChange: (value: unknown) => void;
+    onAnswerAreaLabelChange: (value: unknown) => void;
+    onFeedbackChange: (value: unknown) => void;
+    onChoiceEditorChange: (choices: Choice[], correctResponse?: AuthorOrdering['response']) => void;
+    constructor(props: DesignProps);
     componentDidMount(): void;
-    onDragEnd: any;
+    onDragEnd: (event: DragEndEvent, ordering: AuthorOrdering) => void;
     render(): React.JSX.Element;
 }
 export default Design;