feat: Add a JSON Block definition interface #9613
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import {FieldCheckboxFromJsonConfig} from '../field_checkbox.js'; | ||
| import {FieldDropdownFromJsonConfig} from '../field_dropdown'; | ||
| import {FieldImageFromJsonConfig} from '../field_image'; | ||
| import {FieldNumberFromJsonConfig} from '../field_number'; | ||
| import {FieldTextInputFromJsonConfig} from '../field_textinput'; | ||
| import {FieldVariableFromJsonConfig} from '../field_variable'; | ||
|
|
||
| /** | ||
| * Defines the JSON structure for a block definition. | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * const blockDef: JsonBlockDefinition = { | ||
| * type: 'custom_block', | ||
| * message0: 'move %1 steps', | ||
| * args0: [ | ||
| * { | ||
| * 'type': 'field_number', | ||
| * 'name': 'INPUT', | ||
| * }, | ||
| * ], | ||
| * previousStatement: null, | ||
| * nextStatement: null, | ||
| * }; | ||
| * ``` | ||
| */ | ||
| export interface JsonBlockDefinition { | ||
| type: string; | ||
| style?: string | null; | ||
| colour?: string | number; | ||
| output?: string | string[] | null; | ||
| previousStatement?: string | string[] | null; | ||
| nextStatement?: string | string[] | null; | ||
| outputShape?: number; | ||
| inputsInline?: boolean; | ||
| tooltip?: string; | ||
| helpUrl?: string; | ||
| extensions?: string[]; | ||
| mutator?: string; | ||
| enableContextMenu?: boolean; | ||
| suppressPrefixSuffix?: boolean; | ||
|
|
||
| [key: `message${number}`]: string | undefined; | ||
| [key: `args${number}`]: JsonBlockArg[] | undefined; | ||
| [key: `implicitAlign${number}`]: string | undefined; | ||
| } | ||
|
|
||
| /** | ||
| * A map for custom args. | ||
| * | ||
| * @example | ||
| * ```typescript | ||
| * declare module 'blockly/core/interfaces/i_json_block_definition' { | ||
|
Contributor
There was a problem hiding this comment. This is an interesting idea, but I don't think it's a pattern we want to add here. Using I think for now, it would be best to have custom fields/inputs/args use |
||
| * interface JsonBlockCustomArgMap { | ||
| * field_mitosis: { | ||
| * type: 'field_mitosis'; | ||
| * name?: string; | ||
| * cellId: string; | ||
| * }; | ||
| * } | ||
| * } | ||
| * ``` | ||
| */ | ||
| export interface JsonBlockCustomArgMap {} | ||
|
|
||
| export type BuiltinJsonBlockArg = | ||
| | InputValueArg | ||
| | InputStatementArg | ||
| | InputDummyArg | ||
| | InputEndRowArg | ||
| | FieldInputArg | ||
| | FieldNumberArg | ||
| | FieldDropdownArg | ||
| | FieldCheckboxArg | ||
| | FieldImageArg | ||
| | FieldVariableArg; | ||
|
|
||
| export type CustomJsonBlockArg = | ||
| JsonBlockCustomArgMap[keyof JsonBlockCustomArgMap]; | ||
|
|
||
| export type JsonBlockArg = BuiltinJsonBlockArg | CustomJsonBlockArg; | ||
|
|
||
| /** Input args */ | ||
| interface InputValueArg { | ||
| type: 'input_value'; | ||
| name?: string; | ||
| check?: string | string[]; | ||
| align?: FieldsAlign; | ||
| } | ||
|
|
||
| interface InputStatementArg { | ||
| type: 'input_statement'; | ||
| name?: string; | ||
| check?: string | string[]; | ||
| } | ||
|
|
||
| interface InputDummyArg { | ||
| type: 'input_dummy'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface InputEndRowArg { | ||
| type: 'input_end_row'; | ||
| name?: string; | ||
| } | ||
|
|
||
| /** Field args */ | ||
| interface FieldInputArg extends FieldTextInputFromJsonConfig { | ||
| type: 'field_input'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface FieldNumberArg extends FieldNumberFromJsonConfig { | ||
| type: 'field_number'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface FieldDropdownArg extends FieldDropdownFromJsonConfig { | ||
| type: 'field_dropdown'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface FieldCheckboxArg extends FieldCheckboxFromJsonConfig { | ||
| type: 'field_checkbox'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface FieldImageArg extends FieldImageFromJsonConfig { | ||
| type: 'field_image'; | ||
| name?: string; | ||
| } | ||
|
|
||
| interface FieldVariableArg extends FieldVariableFromJsonConfig { | ||
| type: 'field_variable'; | ||
| name?: string; | ||
| } | ||
|
|
||
| export type FieldsAlign = 'LEFT' | 'RIGHT' | 'CENTRE'; | ||
|
Contributor
There was a problem hiding this comment. We might want to use |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import {defineBlocksWithJsonArray} from 'blockly-test/core'; | ||
| import type {JsonBlockDefinition} from 'blockly-test/core/interfaces/i_json_block_definition'; | ||
|
|
||
| import './different_user_input'; | ||
|
|
||
| declare module 'blockly-test/core/interfaces/i_json_block_definition' { | ||
|
Contributor
There was a problem hiding this comment. As discussed above, if you have the internal Blockly types use |
||
| interface JsonBlockCustomArgMap { | ||
| field_mitosis: { | ||
| type: 'field_mitosis'; | ||
| name?: string; | ||
| cellId: string; | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| const mitosisBlockDefinition: JsonBlockDefinition = { | ||
| type: 'mitosis_block', | ||
| message0: 'split cell %1', | ||
| args0: [ | ||
| { | ||
| type: 'field_mitosis', | ||
| name: 'CELL', | ||
| cellId: 'cell-A', | ||
| }, | ||
| ], | ||
| previousStatement: null, | ||
| nextStatement: null, | ||
| }; | ||
|
|
||
| defineBlocksWithJsonArray([mitosisBlockDefinition]); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change to this file should not be made. You are changing the block definitions in unexpected ways.