Scheduler — Refactor scheduler.d.ts file

packages/devextreme-vue/src/scheduler.ts

@@ -120,7 +120,6 @@ import {
  ShowTextMode,
 } from "devextreme/ui/toolbar";
 import {
- dxButtonGroupOptions,
  dxButtonGroupItem,
  ContentReadyEvent as ButtonGroupContentReadyEvent,
  DisposingEvent as ButtonGroupDisposingEvent,
@@ -1006,7 +1005,7 @@ const DxItemConfig = {
     location: String as PropType<ToolbarItemLocation>,
     menuItemTemplate: {},
     name: String as PropType<string | FormPredefinedButtonItem | SchedulerPredefinedToolbarItem>,
-    options: Object as PropType<DateNavigatorItemProperties | Record<string, any> | dxButtonGroupOptions>,
+    options: Object as PropType<DateNavigatorItemProperties | Record<string, any>>,
     showText: String as PropType<ShowTextMode>,
     tabPanelOptions: Object as PropType<dxTabPanelOptions | Record<string, any>>,
     tabs: Array as PropType<Array<Record<string, any>>>,
@@ -1704,7 +1703,7 @@ const DxToolbarItemConfig = {
     location: String as PropType<ToolbarItemLocation>,
     menuItemTemplate: {},
     name: String as PropType<SchedulerPredefinedToolbarItem>,
-    options: Object as PropType<DateNavigatorItemProperties | Record<string, any> | dxButtonGroupOptions>,
+    options: Object as PropType<DateNavigatorItemProperties | Record<string, any>>,
     showText: String as PropType<ShowTextMode>,
     template: {},
     text: String,

packages/devextreme/js/ui/scheduler.d.ts

@@ -24,7 +24,10 @@ import {
   PointerInteractionEvent,
 } from '../events';
 
-import { dxButtonGroupOptions, dxButtonGroupItem } from './button_group';
+import {
+  Properties as ButtonGroupProperties,
+  Item as ButtonGroupItem,
+} from './button_group';
 import {
   CollectionWidgetItem,
 } from './collection/ui.collection_widget.base';
@@ -56,12 +59,10 @@ interface AppointmentDraggingEvent {
 export interface TargetedAppointmentInfo {
   /**
    * @docid
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /**
    * @docid
-   * @type dxSchedulerAppointment
    */
   readonly targetedAppointmentData?: Appointment;
 }
@@ -115,7 +116,6 @@ export type SchedulerPredefinedDateNavigatorItem = 'prev' | 'next' | 'dateInterv
 export type AppointmentAddedEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentAddedEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /** @docid _ui_scheduler_AppointmentAddedEvent.error */
@@ -131,12 +131,10 @@ export type AppointmentAddedEvent = EventInfo<dxScheduler> & {
 export type AppointmentAddingEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentAddingEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /**
    * @docid _ui_scheduler_AppointmentAddingEvent.cancel
-   * @type Boolean|Promise<Boolean>
    */
   cancel: boolean | PromiseLike<boolean>;
 };
@@ -183,7 +181,6 @@ export type AppointmentDblClickEvent = Cancelable & NativeEventInfo<dxScheduler,
 export type AppointmentDeletedEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentDeletedEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /** @docid _ui_scheduler_AppointmentDeletedEvent.error */
@@ -199,12 +196,10 @@ export type AppointmentDeletedEvent = EventInfo<dxScheduler> & {
 export type AppointmentDeletingEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentDeletingEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /**
    * @docid _ui_scheduler_AppointmentDeletingEvent.cancel
-   * @type Boolean|Promise<Boolean>
    */
   cancel: boolean | PromiseLike<boolean>;
 };
@@ -218,7 +213,6 @@ export type AppointmentDeletingEvent = EventInfo<dxScheduler> & {
 export type AppointmentFormOpeningEvent = Cancelable & EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentFormOpeningEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData?: Appointment;
   /** @docid _ui_scheduler_AppointmentFormOpeningEvent.form */
@@ -248,7 +242,6 @@ export type AppointmentTooltipShowingEvent = Cancelable & EventInfo<dxScheduler>
   readonly targetElement: DxElement;
   /**
    * @docid _ui_scheduler_AppointmentTooltipShowingEvent.appointments
-   * @type Array<object>
    */
   readonly appointments: AppointmentTooltipShowingAppointmentInfo[];
 };
@@ -273,7 +266,6 @@ export type AppointmentRenderedEvent = EventInfo<dxScheduler> & TargetedAppointm
 export type AppointmentUpdatedEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentUpdatedEvent.appointmentData
-   * @type dxSchedulerAppointment
    */
   readonly appointmentData: Appointment;
   /** @docid _ui_scheduler_AppointmentUpdatedEvent.error */
@@ -289,17 +281,14 @@ export type AppointmentUpdatedEvent = EventInfo<dxScheduler> & {
 export type AppointmentUpdatingEvent = EventInfo<dxScheduler> & {
   /**
    * @docid _ui_scheduler_AppointmentUpdatingEvent.oldData
-   * @type Object
    */
-  readonly oldData: any;
+  readonly oldData: Object;
   /**
    * @docid _ui_scheduler_AppointmentUpdatingEvent.newData
-   * @type Object
    */
-  readonly newData: any;
+  readonly newData: Object;
   /**
    * @docid _ui_scheduler_AppointmentUpdatingEvent.cancel
-   * @type Boolean|Promise<Boolean>
    */
   cancel?: boolean | PromiseLike<boolean>;
 };
@@ -442,7 +431,6 @@ export type AppointmentCollectorTemplateData = {
   readonly appointmentCount: number;
   /**
    * @docid
-   * @type Array<dxSchedulerAppointment>
    */
   readonly items: Appointment[];
   /**
@@ -1206,17 +1194,18 @@ export interface dxSchedulerOptions extends WidgetOptions<dxScheduler> {
 
 /**
  * @docid
+ * @type object
  * @inherits dxButtonGroupOptions
  * @namespace DevExpress.ui.dxScheduler
  * @public
  */
-export type DateNavigatorItemProperties = dxButtonGroupOptions & {
+export type DateNavigatorItemProperties = ButtonGroupProperties & {
   /**
    * @docid
    * @type Array<dxButtonGroupItem,Enums.SchedulerPredefinedDateNavigatorItem>
    * @public
    */
-  items: Array<dxButtonGroupItem | SchedulerPredefinedDateNavigatorItem>;
+  items: Array<ButtonGroupItem | SchedulerPredefinedDateNavigatorItem>;
 };
 
 /**
@@ -1293,25 +1282,22 @@ export type Toolbar = {
  * @namespace DevExpress.ui
  * @public
  */
-export default class dxScheduler extends Widget<dxSchedulerOptions> {
+export default class dxScheduler extends Widget<Properties> {
     /**
      * @docid
      * @publicName addAppointment(appointment)
-     * @param1 appointment:dxSchedulerAppointment
      * @public
      */
     addAppointment(appointment: Appointment): void;
     /**
      * @docid
      * @publicName deleteAppointment(appointment)
-     * @param1 appointment:dxSchedulerAppointment
      * @public
      */
     deleteAppointment(appointment: Appointment): void;
     /**
      * @docid
      * @publicName deleteRecurrence(appointment, date, recurrenceEditMode)
-     * @param1 appointmentData:dxSchedulerAppointment
      * @public
      */
     deleteRecurrence(
@@ -1329,7 +1315,6 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
     /**
      * @docid
      * @publicName getOccurrences(startDate, endDate, appointments)
-     * @param3 appointments:Array<dxSchedulerAppointment>
      * @public
      */
     getOccurrences(startDate: Date, endDate: Date, appointments: Appointment[]): Occurrence[];
@@ -1342,7 +1327,6 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
     /**
      * @docid
      * @publicName hideAppointmentPopup(saveChanges)
-     * @param1 saveChanges:Boolean|undefined
      * @public
      */
     hideAppointmentPopup(saveChanges?: boolean): void;
@@ -1355,10 +1339,6 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
     /**
      * @docid
      * @publicName scrollTo(date, options)
-     * @param2 options:Object|undefined
-     * @param2_field group:Object|undefined
-     * @param2_field allDay:Boolean|undefined
-     * @param2_field alignInView:Enums.SchedulerScrollToAlign|undefined
      * @public
      */
     scrollTo(date: Date, options?: {
@@ -1369,35 +1349,25 @@ export default class dxScheduler extends Widget<dxSchedulerOptions> {
     /**
      * @docid
      * @publicName scrollTo(date, group, allDay)
-     * @param2 group:Object|undefined
-     * @param3 allDay:Boolean|undefined
      * @public
      * @deprecated
      */
     scrollTo(date: Date, group?: object, allDay?: boolean): void;
     /**
      * @docid
      * @publicName showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)
-     * @param1 appointmentData:dxSchedulerAppointment|undefined
-     * @param2 createNewAppointment:Boolean|undefined
-     * @param3 currentAppointmentData:dxSchedulerAppointment|undefined
      * @public
      */
     showAppointmentPopup(appointmentData?: Appointment, createNewAppointment?: boolean, currentAppointmentData?: Appointment): void;
     /**
      * @docid
      * @publicName showAppointmentTooltip(appointmentData, target, currentAppointmentData)
-     * @param1 appointmentData:dxSchedulerAppointment
-     * @param2 target:string|Element|jQuery
-     * @param3 currentAppointmentData:dxSchedulerAppointment|undefined
      * @public
      */
     showAppointmentTooltip(appointmentData: Appointment, target: string | UserDefinedElement, currentAppointmentData?: Appointment): void;
     /**
      * @docid
      * @publicName updateAppointment(target, appointment)
-     * @param1 target:dxSchedulerAppointment
-     * @param2 appointment:dxSchedulerAppointment
      * @public
      */
     updateAppointment(target: Appointment, appointment: Appointment): void;
@@ -1504,7 +1474,6 @@ export type Occurrence = {
   /**
    * @docid
    * @public
-   * @type dxSchedulerAppointment
    */
   appointmentData: Appointment;
 };

packages/devextreme/ts/dx.all.d.ts

@@ -26242,7 +26242,7 @@ declare module DevExpress.ui {
   /**
    * [descr:dxScheduler]
    */
-  export class dxScheduler extends Widget<dxSchedulerOptions> {
+  export class dxScheduler extends Widget<DevExpress.ui.dxScheduler.Properties> {
     /**
      * [descr:dxScheduler.addAppointment(appointment)]
      */
@@ -26581,11 +26581,11 @@ declare module DevExpress.ui {
         /**
          * [descr:_ui_scheduler_AppointmentUpdatingEvent.oldData]
          */
-        readonly oldData: any;
+        readonly oldData: Object;
         /**
          * [descr:_ui_scheduler_AppointmentUpdatingEvent.newData]
          */
-        readonly newData: any;
+        readonly newData: Object;
         /**
          * [descr:_ui_scheduler_AppointmentUpdatingEvent.cancel]
          */
@@ -35012,12 +35012,15 @@ declare module DevExpress.ui.dxScheduler {
   /**
    * [descr:DateNavigatorItemProperties]
    */
-  export type DateNavigatorItemProperties = dxButtonGroupOptions & {
-    /**
-     * [descr:DateNavigatorItemProperties.items]
-     */
-    items: Array<dxButtonGroupItem | SchedulerPredefinedDateNavigatorItem>;
-  };
+  export type DateNavigatorItemProperties =
+    DevExpress.ui.dxButtonGroup.Properties & {
+      /**
+       * [descr:DateNavigatorItemProperties.items]
+       */
+      items: Array<
+        DevExpress.ui.dxButtonGroup.Item | SchedulerPredefinedDateNavigatorItem
+      >;
+    };
   /**
    * [descr:dxSchedulerToolbar]
    */