chore: Add deprecation notices.

google · Jan 8, 2025 · f39d232 · f39d232
1 parent aff572d
commit f39d232
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/core/procedures.ts b/core/procedures.ts
@@ -42,6 +42,7 @@ import {IProcedureModel} from './interfaces/i_procedure_model.js';
 import {Msg} from './msg.js';
 import {Names} from './names.js';
 import {ObservableProcedureMap} from './observable_procedure_map.js';
+import * as deprecation from './utils/deprecation.js';
 import type {FlyoutItemInfo} from './utils/toolbox.js';
 import * as utilsXml from './utils/xml.js';
 import * as Variables from './variables.js';
@@ -355,6 +356,12 @@ export function flyoutCategory(
   useXml = true,
 ): Element[] | FlyoutItemInfo[] {
   if (useXml) {
+    deprecation.warn(
+      'The XML return value of Blockly.Procedures.flyoutCategory()',
+      'v12',
+      'v13',
+      'the same method, but handle a return type of FlyoutItemInfo[] (JSON) instead.',
+    );
     return xmlFlyoutCategory(workspace);
   }
   const blocks = [];

diff --git a/core/variables.ts b/core/variables.ts
@@ -13,6 +13,7 @@ import {isLegacyProcedureDefBlock} from './interfaces/i_legacy_procedure_blocks.
 import {isVariableBackedParameterModel} from './interfaces/i_variable_backed_parameter_model.js';
 import {IVariableModel, IVariableState} from './interfaces/i_variable_model.js';
 import {Msg} from './msg.js';
+import * as deprecation from './utils/deprecation.js';
 import type {BlockInfo, FlyoutItemInfo} from './utils/toolbox.js';
 import * as utilsXml from './utils/xml.js';
 import type {Workspace} from './workspace.js';
@@ -124,6 +125,12 @@ export function flyoutCategory(
   }
 
   if (useXml) {
+    deprecation.warn(
+      'The XML return value of Blockly.Variables.flyoutCategory()',
+      'v12',
+      'v13',
+      'the same method, but handle a return type of FlyoutItemInfo[] (JSON) instead.',
+    );
     return xmlFlyoutCategory(workspace);
   }
 

diff --git a/core/variables_dynamic.ts b/core/variables_dynamic.ts
@@ -9,6 +9,7 @@
 import {Blocks} from './blocks.js';
 import type {FlyoutButton} from './flyout_button.js';
 import {Msg} from './msg.js';
+import * as deprecation from './utils/deprecation.js';
 import type {FlyoutItemInfo} from './utils/toolbox.js';
 import * as xml from './utils/xml.js';
 import * as Variables from './variables.js';
@@ -107,6 +108,12 @@ export function flyoutCategory(
   }
 
   if (useXml) {
+    deprecation.warn(
+      'The XML return value of Blockly.VariablesDynamic.flyoutCategory()',
+      'v12',
+      'v13',
+      'the same method, but handle a return type of FlyoutItemInfo[] (JSON) instead.',
+    );
     return xmlFlyoutCategory(workspace);
   }