@pie-element/drawing-response 12.1.0-next.28 → 12.1.1-next.0

package/docs/pie-schema.json

@@ -1,823 +0,0 @@
-{
-  "description": "Model for the @pie-elements/drawing-response Interaction",
-  "additionalProperties": false,
-  "type": "object",
-  "properties": {
-    "prompt": {
-      "description": "The question prompt or item stem",
-      "type": "string",
-      "title": "prompt"
-    },
-    "promptEnabled": {
-      "description": "Indicates if the prompt is enabled",
-      "type": "boolean",
-      "title": "promptEnabled"
-    },
-    "imageUrl": {
-      "description": "The image over which shapes, patterns and texts will be added",
-      "type": "string",
-      "title": "imageUrl"
-    },
-    "imageDimensions": {
-      "description": "The dimensions of the image",
-      "type": "array",
-      "items": {
-        "title": "Dimension",
-        "type": "object",
-        "properties": {
-          "height": {
-            "description": "the height of the section",
-            "type": "number",
-            "title": "height"
-          },
-          "width": {
-            "description": "the width of the section",
-            "type": "number",
-            "title": "width"
-          }
-        },
-        "required": [
-          "height",
-          "width"
-        ]
-      },
-      "title": "imageDimensions"
-    },
-    "studentInstructions": {
-      "description": "Indicates student instructions",
-      "type": "string",
-      "title": "studentInstructions"
-    },
-    "teacherInstructions": {
-      "description": "Indicates teacher instructions",
-      "type": "string",
-      "title": "teacherInstructions"
-    },
-    "studentInstructionsEnabled": {
-      "description": "Indicates if Student Instructions are enabled",
-      "type": "boolean",
-      "title": "studentInstructionsEnabled"
-    },
-    "teacherInstructionsEnabled": {
-      "description": "Indicates if Teacher Instructions are enabled",
-      "type": "boolean",
-      "title": "teacherInstructionsEnabled"
-    },
-    "spellCheckEnabled": {
-      "description": "Indicates if spellcheck is enabled for the author. Default value is true",
-      "type": "boolean",
-      "title": "spellCheckEnabled"
-    },
-    "backgroundImageEnabled": {
-      "description": "Indicates if Background Image is enabled",
-      "type": "boolean",
-      "title": "backgroundImageEnabled"
-    },
-    "toolbarEditorPosition": {
-      "description": "Indicates the editor's toolbar position which can be 'bottom' or 'top'",
-      "default": ": 'bottom'",
-      "enum": [
-        "bottom",
-        "top"
-      ],
-      "type": "string",
-      "title": "toolbarEditorPosition"
-    },
-    "rubricEnabled": {
-      "description": "Indicates if Rubric is enabled",
-      "type": "boolean",
-      "title": "rubricEnabled"
-    },
-    "language": {
-      "description": "Indicates the language of the component\nSupported options: en, es, en_US, en-US, es_ES, es-ES, es_MX, es-MX",
-      "type": "string",
-      "title": "language"
-    },
-    "id": {
-      "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
-      "type": "string",
-      "title": "id"
-    },
-    "element": {
-      "description": "The html Element tag name",
-      "type": "string",
-      "title": "element"
-    }
-  },
-  "required": [
-    "backgroundImageEnabled",
-    "element",
-    "id",
-    "imageDimensions",
-    "rubricEnabled",
-    "spellCheckEnabled",
-    "studentInstructionsEnabled",
-    "teacherInstructionsEnabled"
-  ],
-  "definitions": {
-    "EditableHtmlConfigureProp": {
-      "title": "EditableHtmlConfigureProp",
-      "type": "object",
-      "properties": {
-        "math": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "audio": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "video": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "image": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "customPlugins": {
-          "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
-          "type": "array",
-          "items": {
-            "title": "CustomPlugin",
-            "type": "object",
-            "properties": {
-              "event": {
-                "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-                "type": "string",
-                "title": "event"
-              },
-              "iconAlt": {
-                "description": "The alt for the custom button icon",
-                "type": "string",
-                "title": "iconAlt"
-              },
-              "iconType": {
-                "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-                "type": "string",
-                "title": "iconType"
-              },
-              "icon": {
-                "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-                "type": "string",
-                "title": "icon"
-              }
-            },
-            "required": [
-              "event",
-              "icon",
-              "iconAlt",
-              "iconType"
-            ]
-          },
-          "title": "customPlugins"
-        },
-        "blockquote": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "h3": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "characters": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "bold": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "html": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "italic": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "ol_list": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "redo": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "strikethrough": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "sub": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "sup": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "table": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "ul_list": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "underline": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        },
-        "undo": {
-          "title": "EditableHtmlButtonConfigure",
-          "type": "object",
-          "properties": {
-            "disabled": {
-              "description": "Indicates if the plugin is disabled or not",
-              "type": "boolean",
-              "title": "disabled"
-            }
-          }
-        }
-      }
-    },
-    "EditableHtmlButtonConfigure": {
-      "title": "EditableHtmlButtonConfigure",
-      "type": "object",
-      "properties": {
-        "disabled": {
-          "description": "Indicates if the plugin is disabled or not",
-          "type": "boolean",
-          "title": "disabled"
-        }
-      }
-    },
-    "CustomPlugin": {
-      "title": "CustomPlugin",
-      "type": "object",
-      "properties": {
-        "event": {
-          "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-          "type": "string",
-          "title": "event"
-        },
-        "iconAlt": {
-          "description": "The alt for the custom button icon",
-          "type": "string",
-          "title": "iconAlt"
-        },
-        "iconType": {
-          "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-          "type": "string",
-          "title": "iconType"
-        },
-        "icon": {
-          "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-          "type": "string",
-          "title": "icon"
-        }
-      },
-      "required": [
-        "event",
-        "icon",
-        "iconAlt",
-        "iconType"
-      ]
-    },
-    "ConfigurePropWithEnabled": {
-      "title": "ConfigurePropWithEnabled",
-      "type": "object",
-      "properties": {
-        "enabled": {
-          "description": "Indicates the value of the item if it affects config-ui\n(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)",
-          "type": "boolean",
-          "title": "enabled"
-        },
-        "settings": {
-          "description": "Indicates if the item has to be displayed in the Settings Panel",
-          "type": "boolean",
-          "title": "settings"
-        },
-        "label": {
-          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
-          "type": "string",
-          "title": "label"
-        }
-      }
-    },
-    "ConfigureProp": {
-      "title": "ConfigureProp",
-      "type": "object",
-      "properties": {
-        "settings": {
-          "description": "Indicates if the item has to be displayed in the Settings Panel",
-          "type": "boolean",
-          "title": "settings"
-        },
-        "label": {
-          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
-          "type": "string",
-          "title": "label"
-        }
-      }
-    },
-    "EditableHtmlPluginConfigureRequired": {
-      "title": "EditableHtmlPluginConfigureRequired",
-      "type": "object",
-      "properties": {
-        "inputConfiguration": {
-          "title": "EditableHtmlConfigureProp",
-          "type": "object",
-          "properties": {
-            "math": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "audio": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "video": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "image": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "customPlugins": {
-              "description": "An array of objects that determine custom plugins.\nA custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).\nExample can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.",
-              "type": "array",
-              "items": {
-                "title": "CustomPlugin",
-                "type": "object",
-                "properties": {
-                  "event": {
-                    "description": "The name of the custom event. It needs to be valid (only letters, numbers and \"_\" can be used).\nPIE will emit the event prefixed with \"PIE-\".\nEg: event = 'client_custom_event_A' => the emitted event will be \"PIE-client_custom_event_A\"",
-                    "type": "string",
-                    "title": "event"
-                  },
-                  "iconAlt": {
-                    "description": "The alt for the custom button icon",
-                    "type": "string",
-                    "title": "iconAlt"
-                  },
-                  "iconType": {
-                    "description": "The icon type.\nCurrently, only \"SVG\" is supported.",
-                    "type": "string",
-                    "title": "iconType"
-                  },
-                  "icon": {
-                    "description": "The icon string. Currently, only \"SVG\" is supported, so it needs to be a valid svg.",
-                    "type": "string",
-                    "title": "icon"
-                  }
-                },
-                "required": [
-                  "event",
-                  "icon",
-                  "iconAlt",
-                  "iconType"
-                ]
-              },
-              "title": "customPlugins"
-            },
-            "blockquote": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "h3": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "characters": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "bold": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "html": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "italic": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "ol_list": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "redo": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "strikethrough": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "sub": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "sup": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "table": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "ul_list": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "underline": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            },
-            "undo": {
-              "title": "EditableHtmlButtonConfigure",
-              "type": "object",
-              "properties": {
-                "disabled": {
-                  "description": "Indicates if the plugin is disabled or not",
-                  "type": "boolean",
-                  "title": "disabled"
-                }
-              }
-            }
-          }
-        },
-        "required": {
-          "description": "Indicates if the item is required and the value cannot be empty",
-          "type": "boolean",
-          "title": "required"
-        },
-        "settings": {
-          "description": "Indicates if the item has to be displayed in the Settings Panel",
-          "type": "boolean",
-          "title": "settings"
-        },
-        "label": {
-          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
-          "type": "string",
-          "title": "label"
-        }
-      }
-    },
-    "ConfigureMaxImageDimensionsProp": {
-      "title": "ConfigureMaxImageDimensionsProp",
-      "type": "object",
-      "properties": {
-        "teacherInstructions": {
-          "description": "Indicates the max dimension for images in teacher instructions",
-          "type": "number",
-          "title": "teacherInstructions"
-        },
-        "prompt": {
-          "description": "Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified",
-          "type": "number",
-          "title": "prompt"
-        },
-        "rationale": {
-          "description": "Indicates the max dimension for images in rationale",
-          "type": "number",
-          "title": "rationale"
-        }
-      }
-    },
-    "ConfigureWithForceProp": {
-      "title": "ConfigureWithForceProp",
-      "type": "object",
-      "properties": {
-        "forceEnabled": {
-          "description": "Indicates the value for the toggle;\nif true:\n- this property will not be visible in Settings Panel (settings will become automatically false)\n- the model property afferent to it will become automatically false",
-          "type": "boolean",
-          "title": "forceEnabled"
-        },
-        "settings": {
-          "description": "Indicates if the item has to be displayed in the Settings Panel",
-          "type": "boolean",
-          "title": "settings"
-        },
-        "label": {
-          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
-          "type": "string",
-          "title": "label"
-        }
-      }
-    },
-    "ConfigureMathMLProp": {
-      "title": "ConfigureMathMLProp",
-      "type": "object",
-      "properties": {
-        "mmlOutput": {
-          "description": "Indicates if model should have mathML output instead of latex",
-          "type": "number",
-          "title": "mmlOutput"
-        },
-        "mmlEditing": {
-          "description": "Indicates if mathML that's already in model should be editable",
-          "type": "number",
-          "title": "mmlEditing"
-        }
-      }
-    },
-    "ConfigureLanguageOptionsProp": {
-      "title": "ConfigureLanguageOptionsProp",
-      "type": "object",
-      "properties": {
-        "value": {
-          "description": "Value of the language option",
-          "type": "string",
-          "title": "value"
-        },
-        "label": {
-          "description": "Label of the language option",
-          "type": "string",
-          "title": "label"
-        }
-      },
-      "required": [
-        "label",
-        "value"
-      ]
-    },
-    "Dimension": {
-      "title": "Dimension",
-      "type": "object",
-      "properties": {
-        "height": {
-          "description": "the height of the section",
-          "type": "number",
-          "title": "height"
-        },
-        "width": {
-          "description": "the width of the section",
-          "type": "number",
-          "title": "width"
-        }
-      },
-      "required": [
-        "height",
-        "width"
-      ]
-    }
-  },
-  "$schema": "http://json-schema.org/draft-07/schema#"
-}