feat(typings): Enhance typing support with withAppTypes and custom services throughout OHIF (#4090)

platform/core/src/services/UIDialogService/UIDialogService.ts

@@ -0,0 +1,80 @@
+import { PubSubService } from '../_shared/pubSubServiceInterface';
+
+class UIDialogService extends PubSubService {
+  public static readonly EVENTS = {};
+
+  public static REGISTRATION = {
+    name: 'uiDialogService',
+    altName: 'UIDialogService',
+    create: ({ configuration = {} }) => {
+      return new UIDialogService();
+    },
+  };
+
+  serviceImplementation = {
+    _dismiss: () => console.warn('dismiss() NOT IMPLEMENTED'),
+    _dismissAll: () => console.warn('dismissAll() NOT IMPLEMENTED'),
+    _create: () => console.warn('create() NOT IMPLEMENTED'),
+  };
+
+  constructor() {
+    super(UIDialogService.EVENTS);
+    this.serviceImplementation = {
+      ...this.serviceImplementation,
+    };
+  }
+
+  public create({
+    id,
+    content,
+    contentProps,
+    onStart,
+    onDrag,
+    onStop,
+    centralize = false,
+    preservePosition = true,
+    isDraggable = true,
+    showOverlay = false,
+    defaultPosition,
+  }) {
+    return this.serviceImplementation._create({
+      id,
+      content,
+      contentProps,
+      onStart,
+      onDrag,
+      onStop,
+      centralize,
+      preservePosition,
+      isDraggable,
+      showOverlay,
+      defaultPosition,
+    });
+  }
+
+  public dismiss({ id }) {
+    return this.serviceImplementation._dismiss({ id });
+  }
+
+  public dismissAll() {
+    return this.serviceImplementation._dismissAll();
+  }
+
+  public setServiceImplementation({
+    dismiss: dismissImplementation,
+    dismissAll: dismissAllImplementation,
+    create: createImplementation,
+  }) {
+    if (dismissImplementation) {
+      this.serviceImplementation._dismiss = dismissImplementation;
+    }
+    if (dismissAllImplementation) {
+      this.serviceImplementation._dismissAll = dismissAllImplementation;
+    }
+    if (createImplementation) {
+      this.serviceImplementation._create = createImplementation;
+    }
+  }
+}
+
+export default UIDialogService;

platform/core/src/services/UIDialogService/index.js

@@ -1,131 +0,0 @@
-/**
- * A UI Element Position
- *
- * @typedef {Object} ElementPosition
- * @property {number} top -
- * @property {number} left -
- * @property {number} right -
- * @property {number} bottom -
- */
-
-/**
- * UI Dialog
- *
- * @typedef {Object} DialogProps
- * @property {string} id The dialog id.
- * @property {ReactElement|HTMLElement} content The dialog content.
- * @property {Object} contentProps The dialog content props.
- * @property {boolean} [isDraggable=true] Controls if dialog content is draggable or not.
- * @property {boolean} [showOverlay=false] Controls dialog overlay.
- * @property {boolean} [centralize=false] Center the dialog on the screen.
- * @property {boolean} [preservePosition=true] Use last position instead of default.
- * @property {ElementPosition} defaultPosition Specifies the `x` and `y` that the dragged item should start at.
- * @property {Function} onStart Called when dragging starts. If `false` is returned any handler, the action will cancel.
- * @property {Function} onStop Called when dragging stops.
- * @property {Function} onDrag Called while dragging.
- */
-
-const name = 'uiDialogService';
-
-const publicAPI = {
-  name,
-  dismiss: _dismiss,
-  dismissAll: _dismissAll,
-  create: _create,
-  setServiceImplementation,
-};
-
-const serviceImplementation = {
-  _dismiss: () => console.warn('dismiss() NOT IMPLEMENTED'),
-  _dismissAll: () => console.warn('dismissAll() NOT IMPLEMENTED'),
-  _create: () => console.warn('create() NOT IMPLEMENTED'),
-};
-
-/**
- * Show a new UI dialog;
- *
- * @param {DialogProps} props { id, content, contentProps, onStart, onDrag, onStop, centralize, isDraggable, showOverlay, preservePosition, defaultPosition }
- */
-function _create({
-  id,
-  content,
-  contentProps,
-  onStart,
-  onDrag,
-  onStop,
-  centralize = false,
-  preservePosition = true,
-  isDraggable = true,
-  showOverlay = false,
-  onClickOutside,
-  defaultPosition,
-}) {
-  return serviceImplementation._create({
-    id,
-    content,
-    contentProps,
-    onStart,
-    onDrag,
-    onStop,
-    centralize,
-    preservePosition,
-    isDraggable,
-    onClickOutside,
-    showOverlay,
-    defaultPosition,
-  });
-}
-
-/**
- * Destroys all dialogs, if any
- *
- * @returns void
- */
-function _dismissAll() {
-  return serviceImplementation._dismissAll();
-}
-
-/**
- * Destroy the dialog, if currently created
- *
- * @returns void
- */
-function _dismiss({ id }) {
-  return serviceImplementation._dismiss({ id });
-}
-
-/**
- *
- *
- * @param {*} {
- *   dismiss: dismissImplementation,
- *   dismissAll: dismissAllImplementation,
- *   create: createImplementation,
- * }
- */
-function setServiceImplementation({
-  dismiss: dismissImplementation,
-  dismissAll: dismissAllImplementation,
-  create: createImplementation,
-}) {
-  if (dismissImplementation) {
-    serviceImplementation._dismiss = dismissImplementation;
-  }
-  if (dismissAllImplementation) {
-    serviceImplementation._dismissAll = dismissAllImplementation;
-  }
-  if (createImplementation) {
-    serviceImplementation._create = createImplementation;
-  }
-}
-
-// TODO - export type here
-export default {
-  REGISTRATION: {
-    name,
-    altName: 'UIDialogService',
-    create: ({ configuration = {} }) => {
-      return publicAPI;
-    },
-  },
-};

platform/core/src/services/UIDialogService/index.ts

@@ -0,0 +1,3 @@
+import UIDialogService from './UIDialogService';
+
+export default UIDialogService;