fix: properly export interfaces that were typedefs (google#6250)

* fix: properly export interfaces that were typedefs * fix: allowCollsion -> allowCollision * fix: convert unconverted enums * fix: enums that were/are instance properties * fix: revert changes to property enums
BeksOmega · Aug 2, 2022 · fdb716b · fdb716b
1 parent d3cca8a
commit fdb716b
Show file tree

Hide file tree

Showing 13 changed files with 250 additions and 146 deletions.
diff --git a/core/block.ts b/core/block.ts
@@ -2102,8 +2102,13 @@ export class Block implements IASTNodeLocation, IDeletable {
     return msg;
   }
 }
-export interface CommentModel {
-  text: string|null;
-  pinned: boolean;
-  size: Size;
+
+export namespace Block {
+  export interface CommentModel {
+    text: string|null;
+    pinned: boolean;
+    size: Size;
+  }
 }
+
+export type CommentModel = Block.CommentModel;
diff --git a/core/component_manager.ts b/core/component_manager.ts
@@ -211,8 +211,14 @@ export class ComponentManager {
     return components;
   }
 }
-export interface ComponentDatum {
-  component: IComponent;
-  capabilities: Array<string|Capability<IComponent>>;
-  weight: number;
-}
+
+export namespace ComponentManager {
+  /** An object storing component information. */
+  export interface ComponentDatum {
+    component: IComponent;
+    capabilities: Array<string|Capability<IComponent>>;
+    weight: number;
+  }
+}
+
+export type ComponentDatum = ComponentManager.ComponentDatum;
diff --git a/core/interfaces/i_copyable.ts b/core/interfaces/i_copyable.ts
@@ -31,8 +31,13 @@ export interface ICopyable extends ISelectable {
    */
   toCopyData: AnyDuringMigration;
 }
-export interface CopyData {
-  saveInfo: AnyDuringMigration|Element;
-  source: WorkspaceSvg;
-  typeCounts: AnyDuringMigration|null;
+
+export namespace ICopyable {
+  export interface CopyData {
+    saveInfo: AnyDuringMigration|Element;
+    source: WorkspaceSvg;
+    typeCounts: AnyDuringMigration|null;
+  }
 }
+
+export type CopyData = ICopyable.CopyData;
diff --git a/core/keyboard_nav/ast_node.ts b/core/keyboard_nav/ast_node.ts
@@ -42,18 +42,6 @@ import {Workspace} from '../workspace.js';
  * @alias Blockly.ASTNode
  */
 export class ASTNode {
-  /** Object holding different types for an AST node. */
-  static types = {
-    FIELD: 'field',
-    BLOCK: 'block',
-    INPUT: 'input',
-    OUTPUT: 'output',
-    NEXT: 'next',
-    PREVIOUS: 'previous',
-    STACK: 'stack',
-    WORKSPACE: 'workspace',
-  };
-
   /**
    * True to navigate to all fields. False to only navigate to clickable fields.
    */
@@ -694,10 +682,30 @@ export class ASTNode {
     return astNode;
   }
 }
-export interface Params {
-  wsCoordinate: Coordinate;
+
+export namespace ASTNode {
+  export interface Params {
+    wsCoordinate: Coordinate;
+  }
+
+  export enum types {
+    FIELD = 'field',
+    BLOCK = 'block',
+    INPUT = 'input',
+    OUTPUT = 'output',
+    NEXT = 'next',
+    PREVIOUS = 'previous',
+    STACK = 'stack',
+    WORKSPACE = 'workspace',
+  }
 }
 
+export type Params = ASTNode.Params;
+// No need to export ASTNode.types from the module at this time because (1) it
+// wasn't automatically converted by the automatic migration script, (2) the
+// name doesn't follow the styleguide.
+
+
 /**
  * Gets the parent connection on a block.
  * This is either an output connection, previous connection or undefined.

diff --git a/core/metrics_manager.ts b/core/metrics_manager.ts
@@ -401,32 +401,56 @@ export class MetricsManager implements IMetricsManager {
     };
   }
 }
-export interface ToolboxMetrics {
-  width: number;
-  height: number;
-  position: toolboxUtils.Position;
-}
-export interface AbsoluteMetrics {
-  left: number;
-  top: number;
-}
-export interface ContainerRegion {
-  height: number;
-  width: number;
-  top: number;
-  left: number;
-}
-export interface FixedEdges {
-  top?: number;
-  bottom?: number;
-  left?: number;
-  right?: number;
-}
-export interface UiMetrics {
-  viewMetrics: ContainerRegion;
-  absoluteMetrics: AbsoluteMetrics;
-  toolboxMetrics: ToolboxMetrics;
+
+export namespace MetricsManager {
+  /**
+   * Describes the width, height and location of the toolbox on the main
+   * workspace.
+   */
+  export interface ToolboxMetrics {
+    width: number;
+    height: number;
+    position: toolboxUtils.Position;
+  }
+
+  /** Describes where the viewport starts in relation to the workspace SVG. */
+  export interface AbsoluteMetrics {
+    left: number;
+    top: number;
+  }
+
+  /**
+   * All the measurements needed to describe the size and location of a
+   * container.
+   */
+  export interface ContainerRegion {
+    height: number;
+    width: number;
+    top: number;
+    left: number;
+  }
+
+  /** Describes fixed edges of the workspace. */
+  export interface FixedEdges {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+  }
+
+  /** Common metrics used for UI elements. */
+  export interface UiMetrics {
+    viewMetrics: ContainerRegion;
+    absoluteMetrics: AbsoluteMetrics;
+    toolboxMetrics: ToolboxMetrics;
+  }
 }
 
+export type ToolboxMetrics = MetricsManager.ToolboxMetrics;
+export type AbsoluteMetrics = MetricsManager.AbsoluteMetrics;
+export type ContainerRegion = MetricsManager.ContainerRegion;
+export type FixedEdges = MetricsManager.FixedEdges;
+export type UiMetrics = MetricsManager.UiMetrics;
+
 registry.register(
     registry.Type.METRICS_MANAGER, registry.DEFAULT, MetricsManager);
diff --git a/core/options.ts b/core/options.ts
@@ -429,27 +429,38 @@ export class Options {
         theme.name || 'builtin' + idGenerator.getNextUniqueId(), theme);
   }
 }
-export interface GridOptions {
-  colour: string;
-  length: number;
-  snap: boolean;
-  spacing: number;
-}
-export interface MoveOptions {
-  drag: boolean;
-  scrollbars: boolean|ScrollbarOptions;
-  wheel: boolean;
-}
-export interface ScrollbarOptions {
-  horizontal: boolean;
-  vertical: boolean;
-}
-export interface ZoomOptions {
-  controls: boolean;
-  maxScale: number;
-  minScale: number;
-  pinch: boolean;
-  scaleSpeed: number;
-  startScale: number;
-  wheel: boolean;
+
+export namespace Options {
+  export interface GridOptions {
+    colour: string;
+    length: number;
+    snap: boolean;
+    spacing: number;
+  }
+
+  export interface MoveOptions {
+    drag: boolean;
+    scrollbars: boolean|ScrollbarOptions;
+    wheel: boolean;
+  }
+
+  export interface ScrollbarOptions {
+    horizontal: boolean;
+    vertical: boolean;
+  }
+
+  export interface ZoomOptions {
+    controls: boolean;
+    maxScale: number;
+    minScale: number;
+    pinch: boolean;
+    scaleSpeed: number;
+    startScale: number;
+    wheel: boolean;
+  }
 }
+
+export type GridOptions = Options.GridOptions;
+export type MoveOptions = Options.MoveOptions;
+export type ScrollbarOptions = Options.ScrollbarOptions;
+export type ZoomOptions = Options.ZoomOptions;
diff --git a/core/renderers/common/constants.ts b/core/renderers/common/constants.ts
@@ -399,8 +399,7 @@ export class ConstantProvider {
    */
   INSERTION_MARKER_OPACITY = 0.2;
 
-  /** Enum for connection shapes. */
-  SHAPES = {PUZZLE: 1, NOTCH: 2};
+  SHAPES: {[key: string]: number} = {PUZZLE: 1, NOTCH: 2};
   // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
   JAGGED_TEETH!: JaggedTeeth;
   // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.

diff --git a/core/shortcut_registry.ts b/core/shortcut_registry.ts
@@ -30,13 +30,6 @@ import {Workspace} from './workspace.js';
  * @alias Blockly.ShortcutRegistry
  */
 export class ShortcutRegistry {
-  /** Enum of valid modifiers. */
-  static modifierKeys = {
-    'Shift': KeyCodes.SHIFT,
-    'Control': KeyCodes.CTRL,
-    'Alt': KeyCodes.ALT,
-    'Meta': KeyCodes.META,
-  };
   static registry: AnyDuringMigration;
   // TODO(b/109816955): remove '!', see go/strict-prop-init-fix.
   private registry_!: {[key: string]: KeyboardShortcut};
@@ -326,15 +319,30 @@ export class ShortcutRegistry {
   }
 }
 
-export interface KeyboardShortcut {
-  callback?: ((p1: Workspace, p2: Event, p3: KeyboardShortcut) => boolean);
-  name: string;
-  preconditionFn?: ((p1: Workspace) => boolean);
-  metadata?: object;
-  keyCodes?: (number|string)[];
-  allowCollision?: boolean;
+export namespace ShortcutRegistry {
+  export interface KeyboardShortcut {
+    callback?: ((p1: Workspace, p2: Event, p3: KeyboardShortcut) => boolean);
+    name: string;
+    preconditionFn?: ((p1: Workspace) => boolean);
+    metadata?: object;
+    keyCodes?: (number|string)[];
+    allowCollision?: boolean;
+  }
+
+  /** Supported modifiers. */
+  export enum modifierKeys {
+    Shift = KeyCodes.SHIFT,
+    Control = KeyCodes.CTRL,
+    Alt = KeyCodes.ALT,
+    Meta = KeyCodes.META,
+  }
 }
 
+export type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
+// No need to export ShorcutRegistry.modifierKeys from the module at this time
+// because (1) it wasn't automatically converted by the automatic migration
+// script, (2) the name doesn't follow the styleguide.
+
 // Creates and assigns the singleton instance.
 const registry = new ShortcutRegistry();
 ShortcutRegistry.registry = registry;
diff --git a/core/theme.ts b/core/theme.ts
@@ -166,35 +166,46 @@ export class Theme {
     return theme;
   }
 }
-export interface BlockStyle {
-  colourPrimary: string;
-  colourSecondary: string;
-  colourTertiary: string;
-  hat?: string;
-}
-export interface CategoryStyle {
-  colour: string;
-}
-export interface ComponentStyle {
-  workspaceBackgroundColour: string|null;
-  toolboxBackgroundColour: string|null;
-  toolboxForegroundColour: string|null;
-  flyoutBackgroundColour: string|null;
-  flyoutForegroundColour: string|null;
-  flyoutOpacity: number|null;
-  scrollbarColour: string|null;
-  scrollbarOpacity: number|null;
-  insertionMarkerColour: string|null;
-  insertionMarkerOpacity: number|null;
-  markerColour: string|null;
-  cursorColour: string|null;
-  selectedGlowColour: string|null;
-  selectedGlowOpacity: number|null;
-  replacementGlowColour: string|null;
-  replacementGlowOpacity: number|null;
-}
-export interface FontStyle {
-  family: string|null;
-  weight: string|null;
-  size: number|null;
+
+export namespace Theme {
+  export interface BlockStyle {
+    colourPrimary: string;
+    colourSecondary: string;
+    colourTertiary: string;
+    hat?: string;
+  }
+
+  export interface CategoryStyle {
+    colour: string;
+  }
+
+  export interface ComponentStyle {
+    workspaceBackgroundColour: string|null;
+    toolboxBackgroundColour: string|null;
+    toolboxForegroundColour: string|null;
+    flyoutBackgroundColour: string|null;
+    flyoutForegroundColour: string|null;
+    flyoutOpacity: number|null;
+    scrollbarColour: string|null;
+    scrollbarOpacity: number|null;
+    insertionMarkerColour: string|null;
+    insertionMarkerOpacity: number|null;
+    markerColour: string|null;
+    cursorColour: string|null;
+    selectedGlowColour: string|null;
+    selectedGlowOpacity: number|null;
+    replacementGlowColour: string|null;
+    replacementGlowOpacity: number|null;
+  }
+
+  export interface FontStyle {
+    family: string|null;
+    weight: string|null;
+    size: number|null;
+  }
 }
+
+export type BlockStyle = Theme.BlockStyle;
+export type CategoryStyle = Theme.CategoryStyle;
+export type ComponentStyle = Theme.ComponentStyle;
+export type FontStyle = Theme.FontStyle;