Fixing Bug codex-team#1270 and resolve all yarn lint warning. (codex-…

…team#1292) * Fixing Bug codex-team#1270 and resolve all yarn lint warning. * Update CHANGELOG.md * Change the Log type from Error to Warn * upd types Co-authored-by: Peter Savchenko <[email protected]>
lbergelt · Sep 1, 2020 · 274e1d1 · 274e1d1
1 parent 0929abc
commit 274e1d1
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 20 deletions.
diff --git a/dist/editor.js b/dist/editor.js
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -14,6 +14,7 @@
 - `Improvements` - Unuseful log about missed i18n section has been removed [#1269](https://github.com/codex-team/editor.js/issues/1269)
 - `Fix` - Fixed issue with enter key in inputs and textareas [#920](https://github.com/codex-team/editor.js/issues/920)
 - `Improvements` - Allowed to set `false` as `toolbox` config in order to hide Toolbox button [#1221](https://github.com/codex-team/editor.js/issues/1221)
+- `Fix` - blocks.getBlockByIndex() API method now returns void for indexes out of range [#1270](https://github.com/codex-team/editor.js/issues/1270)
 
 ### 2.18
 

diff --git a/src/components/__module.ts b/src/components/__module.ts
@@ -53,5 +53,4 @@ export default class Module {
  protected get isRtl(): boolean {
  return this.config.i18n.direction === 'rtl';
  }
-
 }
diff --git a/src/components/block-tunes/block-tune-move-down.ts b/src/components/block-tunes/block-tune-move-down.ts
@@ -84,6 +84,11 @@ export default class MoveDownTune implements BlockTune {
  }
 
  const nextBlock = this.api.blocks.getBlockByIndex(currentBlockIndex + 1);
+
+ if (!nextBlock) {
+ return;
+ }
+
  const nextBlockElement = nextBlock.holder;
  const nextBlockCoords = nextBlockElement.getBoundingClientRect();
 

diff --git a/src/components/block-tunes/block-tune-move-up.ts b/src/components/block-tunes/block-tune-move-up.ts
@@ -82,8 +82,13 @@ export default class MoveUpTune implements BlockTune {
  }
 
  const currentBlock = this.api.blocks.getBlockByIndex(currentBlockIndex);
- const currentBlockElement = currentBlock.holder;
  const previousBlock = this.api.blocks.getBlockByIndex(currentBlockIndex - 1);
+
+ if (!currentBlock || !previousBlock){
+ return;
+ }
+
+ const currentBlockElement = currentBlock.holder;
  const previousBlockElement = previousBlock.holder;
 
  /**

diff --git a/src/components/block/index.ts b/src/components/block/index.ts
@@ -14,7 +14,6 @@ import { SavedData } from '../../../types/data-formats';
 import $ from '../dom';
 import * as _ from '../utils';
 import ApiModule from '../modules/api';
-import SelectionUtils from '../selection';
 import BlockAPI from './api';
 import { ToolType } from '../modules/tools';
 

diff --git a/src/components/modules/api/blocks.ts b/src/components/modules/api/blocks.ts
@@ -23,7 +23,7 @@ export default class BlocksAPI extends Module {
  delete: (index?: number): void => this.delete(index),
  swap: (fromIndex: number, toIndex: number): void => this.swap(fromIndex, toIndex),
  move: (toIndex: number, fromIndex?: number): void => this.move(toIndex, fromIndex),
- getBlockByIndex: (index: number): BlockAPIInterface => this.getBlockByIndex(index),
+ getBlockByIndex: (index: number): BlockAPIInterface | void => this.getBlockByIndex(index),
  getCurrentBlockIndex: (): number => this.getCurrentBlockIndex(),
  getBlocksCount: (): number => this.getBlocksCount(),
  stretchBlock: (index: number, status = true): void => this.stretchBlock(index, status),
@@ -51,15 +51,19 @@ export default class BlocksAPI extends Module {
  }
 
  /**
- * Returns Block holder by Block index
+ * Returns BlockAPI object by Block index
  *
  * @param {number} index - index to get
- *
- * @returns {HTMLElement}
  */
- public getBlockByIndex(index: number): BlockAPIInterface {
+ public getBlockByIndex(index: number): BlockAPIInterface | void {
  const block = this.Editor.BlockManager.getBlockByIndex(index);
 
+ if (block === undefined) {
+ _.log('There is no block at index `' + index + '`', 'warn');
+
+ return;
+ }
+
  return new BlockAPI(block);
  }
 

diff --git a/src/components/modules/toolbar/conversion.ts b/src/components/modules/toolbar/conversion.ts
@@ -67,7 +67,7 @@ export default class ConversionToolbar extends Module {
  public make(): HTMLElement {
  this.nodes.wrapper = $.make('div', [
  ConversionToolbar.CSS.conversionToolbarWrapper,
- ...(this.isRtl ? [this.Editor.UI.CSS.editorRtlFix] : []),
+ ...(this.isRtl ? [ this.Editor.UI.CSS.editorRtlFix ] : []),
  ]);
  this.nodes.tools = $.make('div', ConversionToolbar.CSS.conversionToolbarTools);
 
@@ -298,8 +298,8 @@ export default class ConversionToolbar extends Module {
  * @param {string} title - button title
  */
  private addTool(toolName: string, toolIcon: string, title: string): void {
- const tool = $.make('div', [ConversionToolbar.CSS.conversionTool]);
- const icon = $.make('div', [ConversionToolbar.CSS.conversionToolIcon]);
+ const tool = $.make('div', [ ConversionToolbar.CSS.conversionTool ]);
+ const icon = $.make('div', [ ConversionToolbar.CSS.conversionToolIcon ]);
 
  tool.dataset.tool = toolName;
  icon.innerHTML = toolIcon;
@@ -310,7 +310,7 @@ export default class ConversionToolbar extends Module {
  $.append(this.nodes.tools, tool);
  this.tools[toolName] = tool;
 
- this.Editor.Listeners.on(tool, 'click', async() => {
+ this.Editor.Listeners.on(tool, 'click', async () => {
  await this.replaceWithBlock(toolName);
  });
  }

diff --git a/src/components/modules/toolbar/inline.ts b/src/components/modules/toolbar/inline.ts
@@ -32,7 +32,7 @@ export default class InlineToolbar extends Module {
  focusedButton: 'ce-inline-tool--focused',
  conversionToggler: 'ce-inline-toolbar__dropdown',
  conversionTogglerHidden: 'ce-inline-toolbar__dropdown--hidden',
- conversionTogglerContent: 'ce-inline-toolbar__dropdown-content'
+ conversionTogglerContent: 'ce-inline-toolbar__dropdown-content',
  };
 
  /**
@@ -118,7 +118,7 @@ export default class InlineToolbar extends Module {
  public make(): void {
  this.nodes.wrapper = $.make('div', [
  this.CSS.inlineToolbar,
- ...(this.isRtl ? [this.Editor.UI.CSS.editorRtlFix] : []),
+ ...(this.isRtl ? [ this.Editor.UI.CSS.editorRtlFix ] : []),
  ]);
  this.nodes.buttons = $.make('div', this.CSS.buttonsWrapper);
  this.nodes.actions = $.make('div', this.CSS.actionsWrapper);
@@ -572,7 +572,7 @@ export default class InlineToolbar extends Module {
 
  return (toolClass as ToolSettings).class[Tools.INTERNAL_SETTINGS.IS_INLINE];
  })
- .map(([name]: [string, InlineToolConstructable | ToolSettings]) => name);
+ .map(([ name ]: [string, InlineToolConstructable | ToolSettings]) => name);
 
  /**
  * 1) For internal tools, check public getter 'shortcut'

diff --git a/src/components/modules/ui.ts b/src/components/modules/ui.ts
@@ -256,7 +256,7 @@ export default class UI extends Module {
  */
  this.nodes.wrapper = $.make('div', [
  this.CSS.editorWrapper,
- ...(this.isRtl ? [this.CSS.editorRtlFix] : []),
+ ...(this.isRtl ? [ this.CSS.editorRtlFix ] : []),
  ]);
  this.nodes.redactor = $.make('div', this.CSS.editorZone);
 

diff --git a/types/api/blocks.d.ts b/types/api/blocks.d.ts
@@ -47,11 +47,10 @@ export interface Blocks {
  move(toIndex: number, fromIndex?: number): void;
 
  /**
- * Returns Block holder by Block index
+ * Returns Block API object by passed Block index
  * @param {number} index
- * @returns {HTMLElement}
  */
- getBlockByIndex(index: number): BlockAPI;
+ getBlockByIndex(index: number): BlockAPI | void;
 
  /**
  * Returns current Block index