npm - @pie-element/passage - Versions diffs - 2.15.1-next.12 → 2.15.1-next.3 - Mend

@pie-element/passage 2.15.1-next.12 → 2.15.1-next.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/controller/lib/index.js +8 -54
package/controller/lib/index.js.map +1 -1
package/docs/pie-schema.json +1 -377
package/docs/pie-schema.json.md +1 -279
package/module/controller.js +2296 -253
package/module/demo.js +5 -2
package/package.json +2 -2
package/configure/lib/defaults.js +0 -139
package/configure/lib/defaults.js.map +0 -1
package/configure/lib/design.js +0 -311
package/configure/lib/design.js.map +0 -1
package/configure/lib/index.js +0 -138
package/configure/lib/index.js.map +0 -1
package/configure/package.json +0 -19
package/controller/lib/defaults.js +0 -22
package/controller/lib/defaults.js.map +0 -1
package/docs/config-schema.json +0 -644
package/docs/config-schema.json.md +0 -477
package/module/configure.js +0 -5995

package/docs/config-schema.json.md DELETED Viewed

@@ -1,477 +0,0 @@
-Config Object for @pie-elements/passage-configure
-The schema defines the following properties:
-# `settingsPanelDisabled` (boolean)
-Indicates if the settings panel is not available
-# `teacherInstructions` (object)
-Properties of the `teacherInstructions` object:
-## `inputConfiguration` (object)
-Properties of the `inputConfiguration` object:
-### `math` (object)
-Properties of the `math` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `audio` (object)
-Properties of the `audio` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `video` (object)
-Properties of the `video` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `image` (object)
-Properties of the `image` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `customPlugins` (array)
-An array of objects that determine custom plugins.
-A 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).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-#### `event` (string, required)
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-#### `iconAlt` (string, required)
-The alt for the custom button icon
-#### `iconType` (string, required)
-The icon type.
-Currently, only "SVG" is supported.
-#### `icon` (string, required)
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-## `required` (boolean)
-Indicates if the item is required and the value cannot be empty
-## `settings` (boolean)
-Indicates if the item has to be displayed in the Settings Panel
-## `label` (string)
-Indicates the label for the item that has to be displayed in the Settings Panel
-# `maxImageWidth` (object)
-Properties of the `maxImageWidth` object:
-## `teacherInstructions` (number)
-Indicates the max dimension for images in teacher instructions
-## `prompt` (number)
-Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
-## `rationale` (number)
-Indicates the max dimension for images in rationale
-# `maxImageHeight` (object)
-Properties of the `maxImageHeight` object:
-## `teacherInstructions` (number)
-Indicates the max dimension for images in teacher instructions
-## `prompt` (number)
-Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
-## `rationale` (number)
-Indicates the max dimension for images in rationale
-# `mathMlOptions` (object)
-Properties of the `mathMlOptions` object:
-## `mmlOutput` (number)
-Indicates if model should have mathML output instead of latex
-## `mmlEditing` (number)
-Indicates if mathML that's already in model should be editable
-# `baseInputConfiguration` (object)
-Properties of the `baseInputConfiguration` object:
-## `math` (object)
-Properties of the `math` object:
-### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-## `audio` (object)
-Properties of the `audio` object:
-### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-## `video` (object)
-Properties of the `video` object:
-### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-## `image` (object)
-Properties of the `image` object:
-### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-## `customPlugins` (array)
-An array of objects that determine custom plugins.
-A 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).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-### `event` (string, required)
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-### `iconAlt` (string, required)
-The alt for the custom button icon
-### `iconType` (string, required)
-The icon type.
-Currently, only "SVG" is supported.
-### `icon` (string, required)
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-# `language` (object)
-Properties of the `language` object:
-## `enabled` (boolean)
-Indicates the value of the item if it affects config-ui
-(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
-## `settings` (boolean)
-Indicates if the item has to be displayed in the Settings Panel
-## `label` (string)
-Indicates the label for the item that has to be displayed in the Settings Panel
-# `languageChoices` (object)
-Language choices configuration
-Only available if language is enabled
-Properties of the `languageChoices` object:
-## `label` (string, required)
-## `options` (array, required)
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-### `value` (string, required)
-Value of the language option
-### `label` (string, required)
-Label of the language option
----
-# Sub Schemas
-The schema defines the following additional types:
-## `EditableHtmlPluginConfigureRequired` (object)
-Properties of the `EditableHtmlPluginConfigureRequired` object:
-### `inputConfiguration` (object)
-Properties of the `inputConfiguration` object:
-#### `math` (object)
-Properties of the `math` object:
-##### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-#### `audio` (object)
-Properties of the `audio` object:
-##### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-#### `video` (object)
-Properties of the `video` object:
-##### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-#### `image` (object)
-Properties of the `image` object:
-##### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-#### `customPlugins` (array)
-An array of objects that determine custom plugins.
-A 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).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-##### `event` (string, required)
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-##### `iconAlt` (string, required)
-The alt for the custom button icon
-##### `iconType` (string, required)
-The icon type.
-Currently, only "SVG" is supported.
-##### `icon` (string, required)
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-### `required` (boolean)
-Indicates if the item is required and the value cannot be empty
-### `settings` (boolean)
-Indicates if the item has to be displayed in the Settings Panel
-### `label` (string)
-Indicates the label for the item that has to be displayed in the Settings Panel
-## `EditableHtmlConfigureProp` (object)
-Properties of the `EditableHtmlConfigureProp` object:
-### `math` (object)
-Properties of the `math` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `audio` (object)
-Properties of the `audio` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `video` (object)
-Properties of the `video` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `image` (object)
-Properties of the `image` object:
-#### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-### `customPlugins` (array)
-An array of objects that determine custom plugins.
-A 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).
-Example can be found at https://github.com/pie-framework/pie-lib/blob/develop/packages/demo/pages/editable-html.js#L425.
-The object is an array with all elements of the type `object`.
-The array object has the following properties:
-#### `event` (string, required)
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-#### `iconAlt` (string, required)
-The alt for the custom button icon
-#### `iconType` (string, required)
-The icon type.
-Currently, only "SVG" is supported.
-#### `icon` (string, required)
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-## `EditableHtmlButtonConfigure` (object)
-Properties of the `EditableHtmlButtonConfigure` object:
-### `disabled` (boolean)
-Indicates if the plugin is disabled or not
-## `CustomPlugin` (object)
-Properties of the `CustomPlugin` object:
-### `event` (string, required)
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
-### `iconAlt` (string, required)
-The alt for the custom button icon
-### `iconType` (string, required)
-The icon type.
-Currently, only "SVG" is supported.
-### `icon` (string, required)
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
-## `ConfigureMaxImageDimensionsProp` (object)
-Properties of the `ConfigureMaxImageDimensionsProp` object:
-### `teacherInstructions` (number)
-Indicates the max dimension for images in teacher instructions
-### `prompt` (number)
-Indicates the max dimension for images in prompt - this is also the default dimension for all other input fields if it's not specified
-### `rationale` (number)
-Indicates the max dimension for images in rationale
-## `ConfigureMathMLProp` (object)
-Properties of the `ConfigureMathMLProp` object:
-### `mmlOutput` (number)
-Indicates if model should have mathML output instead of latex
-### `mmlEditing` (number)
-Indicates if mathML that's already in model should be editable
-## `ConfigurePropWithEnabled` (object)
-Properties of the `ConfigurePropWithEnabled` object:
-### `enabled` (boolean)
-Indicates the value of the item if it affects config-ui
-(eg.: if item is a switch and displaying an input on the config-ui depends on the switch value: on/off)
-### `settings` (boolean)
-Indicates if the item has to be displayed in the Settings Panel
-### `label` (string)
-Indicates the label for the item that has to be displayed in the Settings Panel
-## `ConfigureLanguageOptionsProp` (object)
-Properties of the `ConfigureLanguageOptionsProp` object:
-### `value` (string, required)
-Value of the language option
-### `label` (string, required)
-Label of the language option