Scheduler: Rename observer to scheduler (#30627)

Author: aleksei-semikozov

packages/devextreme/js/__internal/scheduler/appointments/appointment/m_appointment.ts

@@ -24,6 +24,7 @@ import {
   REDUCED_APPOINTMENT_PARTS_CLASSES,
 } from '../../m_classes';
 import { getRecurrenceProcessor } from '../../m_recurrence';
+import type { SubscribeKey, SubscribeMethods } from '../../m_subscribes';
 import type { AppointmentDataAccessor } from '../../utils/data_accessor/appointment_data_accessor';
 import type { AppointmentProperties } from './m_types';
 import {
@@ -72,20 +73,24 @@ export class Appointment extends DOMComponent<AppointmentProperties> {
     });
   }
 
-  notifyObserver(subject, args) {
-    const observer = this.option('observer');
-    if (observer) {
-      observer.fire(subject, args);
-    }
+  notifyObserver<Subject extends SubscribeKey>(
+    funcName: Subject,
+    args: Parameters<SubscribeMethods[Subject]>,
+  ): void {
+    this.invoke(funcName, ...args);
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  invoke(funcName: string) {
-    const observer = this.option('observer');
+  invoke<Subject extends SubscribeKey>(
+    funcName: Subject,
+    ...args: Parameters<SubscribeMethods[Subject]>
+  ): ReturnType<SubscribeMethods[Subject]> | undefined {
+    const notifyScheduler = this.option('notifyScheduler');
 
-    if (observer) {
-      return observer.fire.apply(observer, arguments);
+    if (!notifyScheduler) {
+      return undefined;
     }
+
+    return notifyScheduler.invoke(funcName, ...args);
   }
 
   _optionChanged(args) {

packages/devextreme/js/__internal/scheduler/appointments/appointment/m_types.ts

@@ -1,4 +1,5 @@
 import type { Orientation } from '@js/common';
+import type NotifyScheduler from '@ts/scheduler/base/m_widget_notify_scheduler';
 import type { TimeZoneCalculator } from '@ts/scheduler/r1/timezone_calculator/calculator';
 import type { SafeAppointment } from '@ts/scheduler/types';
 import type { AppointmentDataAccessor } from '@ts/scheduler/utils/data_accessor/appointment_data_accessor';
@@ -8,7 +9,7 @@ export interface AppointmentProperties extends Record<string, unknown> {
   data: SafeAppointment;
   groupIndex?: number;
   groupTexts: string[];
-  observer: any;
+  notifyScheduler: NotifyScheduler | undefined;
   geometry: any;
   direction: Orientation;
   allowResize: boolean;

packages/devextreme/js/__internal/scheduler/appointments/m_appointment_collection.ts

@@ -104,18 +104,17 @@ class SchedulerAppointments extends CollectionWidget {
   }
 
   notifyObserver(subject, args) {
-    const observer: any = this.option('observer');
-    if (observer) {
-      observer.fire(subject, args);
+    const notifyScheduler: any = this.option('notifyScheduler');
+    if (notifyScheduler) {
+      notifyScheduler.invoke(subject, args);
     }
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   invoke(funcName: string, ...args) {
-    const observer: any = this.option('observer');
+    const notifyScheduler: any = this.option('notifyScheduler');
 
-    if (observer) {
-      return observer.fire.apply(observer, arguments);
+    if (notifyScheduler) {
+      return notifyScheduler.invoke(funcName, ...args);
     }
   }
 
@@ -645,7 +644,7 @@ class SchedulerAppointments extends CollectionWidget {
       data: settings.itemData,
       groupIndex: settings.groupIndex,
       groupTexts: getGroupTexts(groups, groupsLeafs, resourceById, settings.groupIndex),
-      observer: this.option('observer'),
+      notifyScheduler: this.option('notifyScheduler'),
       geometry: settings,
       direction: settings.direction || 'vertical',
       allowResize: false,
@@ -675,7 +674,7 @@ class SchedulerAppointments extends CollectionWidget {
       data: settings.itemData,
       groupIndex: settings.groupIndex,
       groupTexts: getGroupTexts(groups, groupsLeafs, resourceById, settings.groupIndex),
-      observer: this.option('observer'),
+      notifyScheduler: this.option('notifyScheduler'),
       geometry: settings,
       direction: settings.direction || 'vertical',
       allowResize,

packages/devextreme/js/__internal/scheduler/base/m_widget_notify_scheduler.ts

@@ -0,0 +1,19 @@
+import type Scheduler from '../m_scheduler';
+import type { SubscribeKey, SubscribeMethods } from '../m_subscribes';
+
+class NotifyScheduler {
+  scheduler: Scheduler;
+
+  constructor({ scheduler }: { scheduler: Scheduler }) {
+    this.scheduler = scheduler;
+  }
+
+  invoke<Subject extends SubscribeKey>(
+    funcName: Subject,
+    ...args: Parameters<SubscribeMethods[Subject]>
+  ): ReturnType<SubscribeMethods[Subject]> {
+    return this.scheduler.fire(funcName, ...args);
+  }
+}
+
+export default NotifyScheduler;

packages/devextreme/js/__internal/scheduler/base/m_widget_observer.ts

@@ -37,12 +37,14 @@ import { getA11yStatusText } from './a11y_status/a11y_status_text';
 import { AppointmentForm } from './appointment_popup/m_form';
 import { ACTION_TO_APPOINTMENT, AppointmentPopup } from './appointment_popup/m_popup';
 import AppointmentCollection from './appointments/m_appointment_collection';
+import NotifyScheduler from './base/m_widget_notify_scheduler';
 import { SchedulerHeader } from './header/m_header';
 import type { HeaderOptions } from './header/types';
 import { CompactAppointmentsHelper } from './m_compact_appointments_helper';
 import { AppointmentTooltipInfo } from './m_data_structures';
 import { hide as hideLoading, show as showLoading } from './m_loading';
 import { getRecurrenceProcessor } from './m_recurrence';
+import type { SubscribeKey, SubscribeMethods } from './m_subscribes';
 import subscribes from './m_subscribes';
 import { utils } from './m_utils';
 import timeZoneUtils, { type TimezoneLabel } from './m_utils_time_zone';
@@ -196,6 +198,8 @@ class Scheduler extends SchedulerOptionsBaseWidget {
 
   _subscribes: any;
 
+  _notifyScheduler!: NotifyScheduler;
+
   _recurrenceDialog: any;
 
   _layoutManager!: AppointmentLayoutManager;
@@ -742,6 +746,8 @@ class Scheduler extends SchedulerOptionsBaseWidget {
     this._subscribes = subscribes;
 
     this.resourceManager = new ResourceManager(this.option('resources'));
+
+    this._notifyScheduler = new NotifyScheduler({ scheduler: this });
   }
 
   createAppointmentDataProvider() {
@@ -1230,7 +1236,7 @@ class Scheduler extends SchedulerOptionsBaseWidget {
 
       getAppointmentDataProvider: () => this.appointmentDataProvider,
       dataAccessors: this._dataAccessors,
-      observer: this,
+      notifyScheduler: this._notifyScheduler,
       onItemRendered: this._getAppointmentRenderedAction(),
       onItemClick: this._createActionByOption('onAppointmentClick'),
       onItemContextMenu: this._createActionByOption('onAppointmentContextMenu'),
@@ -1370,7 +1376,7 @@ class Scheduler extends SchedulerOptionsBaseWidget {
       renovateRender: this._isRenovatedRender(isVirtualScrolling),
     }, currentViewOptions);
 
-    result.observer = this;
+    result.notifyScheduler = this._notifyScheduler;
     result.groups = groupsResources;
     result.onCellClick = this._createActionByOption('onCellClick');
     result.onCellContextMenu = this._createActionByOption('onCellContextMenu');
@@ -1713,15 +1719,17 @@ class Scheduler extends SchedulerOptionsBaseWidget {
     this._subscribes[subject] = subscribes[subject] = action;
   }
 
-  fire(subject) {
+  fire<Subject extends SubscribeKey>(
+    subject: Subject,
+    ...args: Parameters<SubscribeMethods[Subject]>
+  ): ReturnType<SubscribeMethods[Subject]> {
     const callback = this._subscribes[subject];
-    const args = Array.prototype.slice.call(arguments);
 
     if (!isFunction(callback)) {
       throw errors.Error('E1031', subject);
     }
 
-    return callback.apply(this, args.slice(1));
+    return callback.call(this, ...args);
   }
 
   getTargetCellData() {

packages/devextreme/js/__internal/scheduler/m_publisher_mixin.ts

@@ -316,5 +316,8 @@ const subscribes = {
   removeDroppableCellClass() {
     this._workSpace.removeDroppableCellClass();
   },
-};
+} as const;
+
 export default subscribes;
+export type SubscribeMethods = typeof subscribes;
+export type SubscribeKey = keyof typeof subscribes;

packages/devextreme/js/__internal/scheduler/m_scheduler.ts

@@ -31,6 +31,7 @@ import { getWindow, hasWindow } from '@js/core/utils/window';
 import type { dxSchedulerOptions } from '@js/ui/scheduler';
 import Scrollable from '@js/ui/scroll_view/ui.scrollable';
 import errors from '@js/ui/widget/ui.errors';
+import Widget from '@js/ui/widget/ui.widget';
 import { getMemoizeScrollTo } from '@ts/core/utils/scroll';
 import {
   AllDayPanelTitleComponent,
@@ -51,7 +52,7 @@ import {
 } from '@ts/scheduler/r1/utils/index';
 import type { SafeAppointment, ViewType } from '@ts/scheduler/types';
 
-import WidgetObserver from '../base/m_widget_observer';
+import type NotifyScheduler from '../base/m_widget_notify_scheduler';
 import { APPOINTMENT_SETTINGS_KEY } from '../constants';
 import { Cache } from '../global_cache';
 import AppointmentDragBehavior from '../m_appointment_drag_behavior';
@@ -66,6 +67,7 @@ import {
   VERTICAL_GROUP_COUNT_CLASSES,
   VIRTUAL_CELL_CLASS,
 } from '../m_classes';
+import type { SubscribeKey, SubscribeMethods } from '../m_subscribes';
 import tableCreatorModule from '../m_table_creator';
 import { utils } from '../m_utils';
 import VerticalShader from '../shaders/m_current_time_shader_vertical';
@@ -109,8 +111,8 @@ const { tableCreator } = tableCreatorModule;
 // The constant is needed so that the dragging is not sharp. To prevent small twitches
 const DRAGGING_MOUSE_FAULT = 10;
 
-// @ts-expect-error
-const { abstract } = WidgetObserver;
+// @ts-expect-error Widget exposes a static abstract() helper not typed in its d.ts
+const { abstract } = Widget;
 const toMs = dateUtils.dateToMilliseconds;
 
 const COMPONENT_CLASS = 'dx-scheduler-work-space';
@@ -202,7 +204,7 @@ type WorkspaceOptionsInternal = Omit<dxSchedulerOptions, 'groups'> & {
   startDayHour: number;
   endDayHour: number;
 };
-class SchedulerWorkSpace extends WidgetObserver<WorkspaceOptionsInternal> {
+class SchedulerWorkSpace extends Widget<WorkspaceOptionsInternal> {
   _viewDataProvider: any;
 
   _cache: any;
@@ -393,6 +395,26 @@ class SchedulerWorkSpace extends WidgetObserver<WorkspaceOptionsInternal> {
     return this.option('draggingMode') === 'default';
   }
 
+  notifyObserver<Subject extends SubscribeKey>(
+    funcName: Subject,
+    args: Parameters<SubscribeMethods[Subject]>,
+  ): void {
+    this.invoke(funcName, ...args);
+  }
+
+  invoke<Subject extends SubscribeKey>(
+    funcName: Subject,
+    ...args: Parameters<SubscribeMethods[Subject]>
+  ): ReturnType<SubscribeMethods[Subject]> | undefined {
+    const notifyScheduler = this.option('notifyScheduler') as NotifyScheduler | undefined;
+
+    if (!notifyScheduler) {
+      return undefined;
+    }
+
+    return notifyScheduler.invoke(funcName, ...args);
+  }
+
   _supportedKeys() {
     const clickHandler = function (e) {
       e.preventDefault();

packages/devextreme/js/__internal/scheduler/m_subscribes.ts

@@ -37,8 +37,8 @@ module('Agenda', {}, () => {
             onContentReady: e => {
                 e.component.onDataSourceChanged(rows);
             },
-            observer: {
-                fire: (functionName) => {
+            notifyScheduler: {
+                invoke: (functionName) => {
                     if(functionName === 'getLayoutManager') {
                         return {
                             getRenderingStrategyInstance: () => {