@zohodesk/library-platform 1.1.2 → 1.1.3-exp.1

package/es/library/behaviours/keyboard-controls/adapters/controllers/InitializeController.js

@@ -0,0 +1,20 @@
+import AbstractController from "./AbstractController";
+
+class InitializeController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      updateState,
+      dispatch,
+      host
+    } = event;
+    const {
+      InitializeUsecase
+    } = this.service;
+    InitializeUsecase.updateDependencies(state, updateState, dispatch, host);
+    InitializeUsecase.execute(host);
+  }
+
+}
+
+export default InitializeController;

package/es/library/behaviours/keyboard-controls/adapters/controllers/SpacePressController.js

@@ -0,0 +1,24 @@
+import AbstractController from "./AbstractController";
+
+class SpacePressController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      updateState,
+      dispatch,
+      action,
+      host
+    } = event;
+    const {
+      SpacePressUsecase
+    } = this.service;
+    SpacePressUsecase.updateDependencies(state, updateState, dispatch, host);
+    SpacePressUsecase.execute({
+      dispatch,
+      event: action.payload.event
+    });
+  }
+
+}
+
+export default SpacePressController;

package/es/library/behaviours/keyboard-controls/adapters/controllers/UpArrowPressController.js

@@ -0,0 +1,20 @@
+import AbstractController from "./AbstractController";
+
+class UpArrowPressController extends AbstractController {
+  handle(event) {
+    const {
+      state,
+      updateState,
+      dispatch,
+      host
+    } = event;
+    const {
+      UpArrowPressUsecase
+    } = this.service;
+    UpArrowPressUsecase.updateDependencies(state, updateState, dispatch, host);
+    UpArrowPressUsecase.execute();
+  }
+
+}
+
+export default UpArrowPressController;

package/es/library/behaviours/keyboard-controls/adapters/gateways/KeyboardHandler.js

@@ -0,0 +1,81 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import { KEYBOARD_CONTROL_DOWN_ARROW_PRESSED, KEYBOARD_CONTROL_ENTER_PRESSED, KEYBOARD_CONTROL_SPACE_PRESSED, KEYBOARD_CONTROL_UP_ARROW_PRESSED } from "../../../../../bc/keyboard-controls/Constants";
+
+class KeyboardHandler {
+  constructor() {
+    _defineProperty(this, "dispatch", void 0);
+
+    this.handleKeypress = this.handleKeypress.bind(this);
+    this.initialize = this.initialize.bind(this);
+    this.destruct = this.destruct.bind(this);
+  }
+
+  setDispatch(dispatch) {
+    this.dispatch = dispatch;
+  }
+
+  handleKeypress(event) {
+    if (['ArrowUp', 'ArrowDown', 'Space', 'Enter'].includes(event.code)) {
+      event.preventDefault();
+      event.stopPropagation();
+    }
+
+    switch (event.code) {
+      case 'ArrowUp':
+        this.dispatch({
+          type: KEYBOARD_CONTROL_UP_ARROW_PRESSED,
+          payload: {
+            event
+          }
+        });
+        break;
+
+      case 'ArrowDown':
+        this.dispatch({
+          type: KEYBOARD_CONTROL_DOWN_ARROW_PRESSED,
+          payload: {
+            event
+          }
+        });
+        break;
+
+      case 'Space':
+        this.dispatch({
+          type: KEYBOARD_CONTROL_SPACE_PRESSED,
+          payload: {
+            event
+          }
+        });
+        break;
+
+      case 'Enter':
+        this.dispatch({
+          type: KEYBOARD_CONTROL_ENTER_PRESSED,
+          payload: {
+            event
+          }
+        });
+        break;
+    }
+  }
+
+  initialize(host) {
+    if (host) {
+      host.addEventListener('keydown', this.handleKeypress);
+    } else {
+      document.addEventListener('keydown', this.handleKeypress);
+    }
+  }
+
+  destruct(host) {
+    if (host) {
+      host.removeEventListener('keydown', this.handleKeypress);
+    } else {
+      document.removeEventListener('keydown', this.handleKeypress);
+    }
+  }
+
+}
+
+export default KeyboardHandler;

package/es/library/behaviours/keyboard-controls/adapters/gateways/Repository.js

@@ -0,0 +1,47 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import KeyboardControls from "../../domain/entities/KeyboardControls";
+
+class Repository {
+  constructor() {
+    _defineProperty(this, "state", void 0);
+  }
+
+  init(state) {
+    this.state = state;
+  }
+
+  getKeyboardControls() {
+    var _zrecord$records;
+
+    const {
+      behaviours,
+      properties
+    } = this.state;
+    const {
+      keyboardControlsConfig
+    } = properties;
+    let isKeyboardControlEnabled = keyboardControlsConfig === null || keyboardControlsConfig === void 0 ? void 0 : keyboardControlsConfig.isEnabled;
+
+    if (!isKeyboardControlEnabled) {
+      return null;
+    }
+    /* eslint-disable-next-line @zohodesk/architecturerules/no-defaultProps-rule */
+
+
+    const {
+      zrecord,
+      keyboardControls
+    } = behaviours;
+    const {
+      focussedIndex
+    } = keyboardControls;
+    /* eslint-disable-next-line @zohodesk/architecturerules/no-defaultProps-rule */
+
+    const totalRows = (zrecord === null || zrecord === void 0 ? void 0 : (_zrecord$records = zrecord.records) === null || _zrecord$records === void 0 ? void 0 : _zrecord$records.length) || 0;
+    return new KeyboardControls(focussedIndex, totalRows);
+  }
+
+}
+
+export default Repository;

package/es/library/behaviours/keyboard-controls/adapters/gateways/Service.js

@@ -0,0 +1,40 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import DestructUsecase from "../../applications/usecases/DestructUsecase";
+import DownArrowPress from "../../applications/usecases/DownArrowPress";
+import EnterPress from "../../applications/usecases/EnterPress"; // import FocusNextUsecase from "../../applications/usecases/FocusNextUsecase";
+// import FocusPreviousUsecase from "../../applications/usecases/FocusPreviousUsecase";
+
+import InitializeUsecase from "../../applications/usecases/InitializeUsecase";
+import SpacePress from "../../applications/usecases/SpacePress";
+import UpArrowPress from "../../applications/usecases/UpArrowPress";
+
+class Service {
+  // FocusPreviousUsecase: FocusPreviousUsecase;
+  // FocusNextUsecase: FocusNextUsecase;
+  constructor(dependencies) {
+    _defineProperty(this, "UpArrowPressUsecase", void 0);
+
+    _defineProperty(this, "DownArrowPressUsecase", void 0);
+
+    _defineProperty(this, "SpacePressUsecase", void 0);
+
+    _defineProperty(this, "EnterPressUsecase", void 0);
+
+    _defineProperty(this, "InitializeUsecase", void 0);
+
+    _defineProperty(this, "DestructUsecase", void 0);
+
+    this.UpArrowPressUsecase = new UpArrowPress(dependencies);
+    this.DownArrowPressUsecase = new DownArrowPress(dependencies);
+    this.SpacePressUsecase = new SpacePress(dependencies);
+    this.EnterPressUsecase = new EnterPress(dependencies); // this.FocusPreviousUsecase = new FocusPreviousUsecase(dependencies);
+    // this.FocusNextUsecase = new FocusNextUsecase(dependencies);
+
+    this.InitializeUsecase = new InitializeUsecase(dependencies);
+    this.DestructUsecase = new DestructUsecase(dependencies);
+  }
+
+}
+
+export default Service;

package/es/library/behaviours/keyboard-controls/adapters/presenters/Presenter.js

@@ -0,0 +1,39 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+class Presenter {
+  constructor() {
+    _defineProperty(this, "state", void 0);
+
+    _defineProperty(this, "updateState", void 0);
+
+    _defineProperty(this, "host", document.createElement('div'));
+
+    _defineProperty(this, "listItemSelector", 'tbody tr');
+  }
+
+  updateDependencies(state, updateState, host) {
+    this.state = state;
+    this.updateState = updateState;
+    this.host = host;
+  }
+
+  updateKeyboardControls(keyboardControls) {
+    this.updateState({ ...this.state,
+      behaviours: { ...this.state.behaviours,
+        keyboardControls
+      }
+    });
+    this.focusListItem(keyboardControls.focussedIndex);
+  }
+
+  focusListItem(index) {
+    const listItems = this.host.querySelectorAll(this.listItemSelector);
+
+    if (listItems.length !== 0) {
+      listItems[index].focus();
+    }
+  }
+
+}
+
+export default Presenter;

package/es/library/behaviours/keyboard-controls/applications/interfaces/UseCaseDependencies.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/gateways/IKeyboardHandler.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/gateways/IRepository.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/gateways/IService.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/DestructInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/DownArrowPressInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/EnterPressInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/FocusNextInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/FocusPreviousInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/InitializeInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/RowActionInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/SelectionInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/SpacePressInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/input/UpArrowPressInputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/output/IPresenter.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/interfaces/output/OutputModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/applications/usecases/AbstractUseCase.js

@@ -0,0 +1,19 @@
+class AbstractUseCase {
+  constructor(dependencies) {
+    this.dependencies = dependencies;
+  }
+
+  updateDependencies(state, updateState, dispatch, host) {
+    const {
+      repository,
+      presenter,
+      keyboardHandler
+    } = this.dependencies;
+    repository.init(state);
+    presenter.updateDependencies(state, updateState, host);
+    keyboardHandler.setDispatch(dispatch);
+  }
+
+}
+
+export default AbstractUseCase;

package/es/library/behaviours/keyboard-controls/applications/usecases/DestructUsecase.js

@@ -0,0 +1,20 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class DestructUsecase extends AbstractUseCase {
+  execute(host) {
+    const {
+      repository,
+      presenter,
+      keyboardHandler
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+
+    if (keyboardControls !== null) {
+      keyboardHandler.destruct(host);
+      presenter.updateKeyboardControls(keyboardControls.toObject());
+    }
+  }
+
+}
+
+export default DestructUsecase;

package/es/library/behaviours/keyboard-controls/applications/usecases/DownArrowPress.js

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class DownArrowPress extends AbstractUseCase {
+  execute() {
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    keyboardControls.focusNext();
+    presenter.updateKeyboardControls(keyboardControls.toObject());
+  }
+
+}
+
+export default DownArrowPress;

package/es/library/behaviours/keyboard-controls/applications/usecases/EnterPress.js

@@ -0,0 +1,19 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class EnterPress extends AbstractUseCase {
+  execute(inputModel) {
+    const {
+      repository
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    const {
+      dispatch,
+      event
+    } = inputModel;
+    const data = keyboardControls.getClickActionEvent(event);
+    dispatch(data);
+  }
+
+}
+
+export default EnterPress;

package/es/library/behaviours/keyboard-controls/applications/usecases/FocusNextUsecase.js

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class FocusNextUsecase extends AbstractUseCase {
+  execute() {
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    keyboardControls.focusNext();
+    presenter.updateKeyboardControls(keyboardControls.toObject());
+  }
+
+}
+
+export default FocusNextUsecase;

package/es/library/behaviours/keyboard-controls/applications/usecases/FocusPreviousUsecase.js

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class FocusPreviousUsecase extends AbstractUseCase {
+  execute() {
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    keyboardControls.focusPrevious();
+    presenter.updateKeyboardControls(keyboardControls.toObject());
+  }
+
+}
+
+export default FocusPreviousUsecase;

package/es/library/behaviours/keyboard-controls/applications/usecases/InitializeUsecase.js

@@ -0,0 +1,20 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class InitializeUsecase extends AbstractUseCase {
+  execute(host) {
+    const {
+      repository,
+      presenter,
+      keyboardHandler
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+
+    if (keyboardControls !== null) {
+      keyboardHandler.initialize(host);
+      presenter.updateKeyboardControls(keyboardControls.toObject());
+    }
+  }
+
+}
+
+export default InitializeUsecase;

package/es/library/behaviours/keyboard-controls/applications/usecases/SpacePress.js

@@ -0,0 +1,19 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class SpacePress extends AbstractUseCase {
+  execute(inputModel) {
+    const {
+      repository
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    const {
+      dispatch,
+      event
+    } = inputModel;
+    const data = keyboardControls.getSelectionEvent(event);
+    dispatch(data);
+  }
+
+}
+
+export default SpacePress;

package/es/library/behaviours/keyboard-controls/applications/usecases/UpArrowPress.js

@@ -0,0 +1,16 @@
+import AbstractUseCase from "./AbstractUseCase";
+
+class UpArrowPress extends AbstractUseCase {
+  execute() {
+    const {
+      repository,
+      presenter
+    } = this.dependencies;
+    const keyboardControls = repository.getKeyboardControls();
+    keyboardControls.focusPrevious();
+    presenter.updateKeyboardControls(keyboardControls.toObject());
+  }
+
+}
+
+export default UpArrowPress;

package/es/library/behaviours/keyboard-controls/domain/entities/KeyboardControls.js

@@ -0,0 +1,87 @@
+import { SMART_TABLE_ACTION_TRIGGERED, SMART_TABLE_SELECTION_TOGGLED } from "../../../../../cc/table-connected/constants/Events";
+
+class KeyboardControls {
+  constructor(focussedIndex, totalLists) {
+    this.focussedIndex = focussedIndex;
+    this.totalLists = totalLists;
+  }
+
+  setFocussedIndex(index) {
+    this.focussedIndex = index;
+  }
+
+  getFocussedIndex() {
+    return this.focussedIndex;
+  }
+
+  focusPrevious() {
+    if (this.focussedIndex > 0) {
+      this.focussedIndex -= 1;
+    }
+  }
+
+  focusNext() {
+    if (this.totalLists > 1 && this.focussedIndex < this.totalLists - 1) {
+      this.focussedIndex += 1;
+    }
+  } // focusPrevious(): void {
+  //     if (this.focussedIndex > 0) {
+  //         this.focussedIndex -= 1;
+  //     } else if (this.focussedIndex === 0 && this.totalLists > 1) {
+  //         this.focussedIndex = this.totalLists - 1;
+  //     }
+  // }
+  // focusNext(): void {
+  //     if ((this.totalLists > 1) && (this.focussedIndex <= this.totalLists - 1)) {
+  //         if (this.focussedIndex >= this.totalLists - 1) {
+  //             this.focussedIndex = 0;
+  //         } else {
+  //             this.focussedIndex += 1;
+  //         }
+  //     }
+  // }
+  // getPreviousFocusEvent(event: KeyboardEvent): EventModel {
+  //     return {
+  //         type: SMART_TABLE_PREVIOUS_FOCUS,
+  //         payload: {
+  //             event
+  //         }
+  //     }
+  // }
+  // getNextFocusEvent(event: KeyboardEvent): EventModel {
+  //     return {
+  //         type: SMART_TABLE_NEXT_FOCUS,
+  //         payload: {
+  //             event
+  //         }
+  //     }
+  // }
+
+
+  getSelectionEvent(event) {
+    return {
+      type: SMART_TABLE_SELECTION_TOGGLED,
+      payload: {
+        event
+      }
+    };
+  }
+
+  getClickActionEvent(event) {
+    return {
+      type: SMART_TABLE_ACTION_TRIGGERED,
+      payload: {
+        event
+      }
+    };
+  }
+
+  toObject() {
+    return {
+      focussedIndex: this.focussedIndex
+    };
+  }
+
+}
+
+export default KeyboardControls;

package/es/library/behaviours/keyboard-controls/domain/entities/interface/IKeyboardControls.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/domain/entities/interface/KeyboardControlModel.js

@@ -0,0 +1 @@
+export {};

package/es/library/behaviours/keyboard-controls/frameworks/EventHandlerFactory.js

@@ -0,0 +1,48 @@
+import { KEYBOARD_CONTROL_DOWN_ARROW_PRESSED, KEYBOARD_CONTROL_ENTER_PRESSED, KEYBOARD_CONTROL_SPACE_PRESSED, KEYBOARD_CONTROL_UP_ARROW_PRESSED } from "../../../../bc/keyboard-controls/Constants";
+import UpArrowPressController from "../adapters/controllers/UpArrowPressController";
+import DownArrowPressController from "../adapters/controllers/DownArrowPressController";
+import SpacePressController from "../adapters/controllers/SpacePressController";
+import EnterPressController from "../adapters/controllers/EnterPressController";
+import Service from "../adapters/gateways/Service";
+import Repository from "../adapters/gateways/Repository";
+import Presenter from "../adapters/presenters/Presenter";
+import KeyboardHandler from "../adapters/gateways/KeyboardHandler"; // import FocusPreviousController from "../adapters/controllers/FocusPreviousController";
+// import FocusNextController from "../adapters/controllers/FocusNextController";
+
+import LifeCycleAction from "../../../../cc/architecture/LifeCycleActionEnum";
+import InitializeController from "../adapters/controllers/InitializeController";
+import DestructController from "../adapters/controllers/DestructController";
+
+class EventHandlerFactory {
+  static create() {
+    const service = this.createService();
+    return this.createHandlers(service);
+  }
+
+  static createService() {
+    const repository = new Repository();
+    const presenter = new Presenter();
+    const keyboardHandler = new KeyboardHandler();
+    return new Service({
+      repository: repository,
+      presenter,
+      keyboardHandler
+    });
+  }
+
+  static createHandlers(service) {
+    return {
+      [LifeCycleAction.MOUNT]: new InitializeController(service).handle,
+      [LifeCycleAction.UN_MOUNT]: new DestructController(service).handle,
+      // [SMART_TABLE_PREVIOUS_FOCUS]: new FocusPreviousController(service).handle,
+      // [SMART_TABLE_NEXT_FOCUS]: new FocusNextController(service).handle,
+      [KEYBOARD_CONTROL_UP_ARROW_PRESSED]: new UpArrowPressController(service).handle,
+      [KEYBOARD_CONTROL_DOWN_ARROW_PRESSED]: new DownArrowPressController(service).handle,
+      [KEYBOARD_CONTROL_SPACE_PRESSED]: new SpacePressController(service).handle,
+      [KEYBOARD_CONTROL_ENTER_PRESSED]: new EnterPressController(service).handle
+    };
+  }
+
+}
+
+export default EventHandlerFactory;