feat: drop deprecated aliases (#1505)

Co-authored-by: ala'n (Alexey Stsefanovich) <astsefanovich@exadel.com> BREAKING CHANGE: `ESLEventUtils.descriptors` alias of `ESLEventUtils.getAutoDescriptors` is no longer supported BREAKING CHANGE: `EventUtils` alias of `ESLEventUtils` is no longer supported BREAKING CHANGE: `esl-media-quey` module no longer supports `addListener` and `removeListener` shorthand BREAKING CHANGE: `SynteticEventTarget` no longer supports `addListener` and `removeListener` shorthand BREAKING CHANGE: 'fallback-duration' is no longer in the JSX shape of ESLPanel and ESLPanelGroup BREAKING CHANGE: `ToggleableActionParams` alias of `ESLToggleableActionParams` is no longer supported BREAKING CHANGE: `TraversingQuery` alias of `ESLTraversingQuery` is no longer supported BREAKING CHANGE: `RTLUtils` retired use separate methods instead BREAKING CHANGE: `TraversingUtils` retired use separate methods instead BREAKING CHANGE: `deepCompare` alias of `isEqual` is no longer supported BREAKING CHANGE: `generateUId` alias of `randUID` no longer supported
exadel-inc · Mar 17, 2023 · df7f5e5 · df7f5e5
1 parent a442a3a
commit df7f5e5
Show file tree

Hide file tree

Showing 15 changed files with 2 additions and 104 deletions.
diff --git a/src/modules/draft/esl-carousel/core/esl-carousel.ts b/src/modules/draft/esl-carousel/core/esl-carousel.ts
@@ -196,10 +196,10 @@ export class ESLCarousel extends ESLBaseElement {
 
   set configRules(rules: ESLMediaRuleList<CarouselConfig | null>) {
     if (this._configRules) {
-      this._configRules.removeListener(this._onMatchChange);
+      this._configRules.removeEventListener(this._onMatchChange);
     }
     this._configRules = rules;
-    this._configRules.addListener(this._onMatchChange);
+    this._configRules.addEventListener(this._onMatchChange);
   }
 
   private update(force: boolean = false) {

diff --git a/src/modules/esl-event-listener/README.md b/src/modules/esl-event-listener/README.md
@@ -272,12 +272,6 @@ ESLEventUtils.descriptors(host?: any): ESLListenerDescriptorFn[]
 
 - `host` - object to get auto-collectable descriptors from;
 
-<a name="-esleventutilsdescriptors"></a>
-
-### ⚡ `ESLEventUtils.descriptors`
-
-Deprecated alias for `ESLEventUtils.getAutoDescriptors`
-
 <a name="-esleventutilsinitdescriptor"></a>
 
 ### ⚡ `ESLEventUtils.initDescriptor`

diff --git a/src/modules/esl-event-listener/core/api.ts b/src/modules/esl-event-listener/core/api.ts
@@ -22,9 +22,6 @@ export class ESLEventUtils {
    */
   public static dispatch = dispatchCustomEvent;
 
-  /** @deprecated alias for {@link getAutoDescriptors} */
-  public static descriptors = getAutoDescriptors;
-
   /** Gets {@link ESLListenerDescriptorFn}s of the passed object */
   public static getAutoDescriptors = getAutoDescriptors;
 
@@ -130,6 +127,3 @@ export class ESLEventUtils {
    */
   public static decorate = ESLEventTargetDecorator.cached;
 }
-
-/** @deprecated alias for {@link ESLEventUtils} */
-export const EventUtils = ESLEventUtils;
diff --git a/src/modules/esl-media-query/core/conditions/media-query-base.ts b/src/modules/esl-media-query/core/conditions/media-query-base.ts
@@ -2,15 +2,11 @@ export interface IMediaQueryCondition extends EventTarget {
   /** @returns true if current environment satisfies query */
   matches: boolean;
 
-  /** @deprecated alias for `addEventListener` */
-  addListener(cb: EventListener): void;
   /** Subscribes to media query state change. Shortcut for `addEventListener('change', callback)` */
   addEventListener(callback: EventListener): void;
   /** Subscribes to media query state change. Implements {@link EventTarget} interface */
   addEventListener(type: 'change', callback: EventListener): void;
 
-  /** @deprecated alias for `removeEventListener` */
-  removeListener(cb: EventListener): void;
   /** Unsubscribes from media query state change event. Shortcut for `removeEventListener('change', callback)` */
   removeEventListener(callback: EventListener): void;
   /** Unsubscribes from media query state change event. Implements {@link EventTarget} interface */

diff --git a/src/modules/esl-media-query/core/esl-media-query.ts b/src/modules/esl-media-query/core/esl-media-query.ts
@@ -105,11 +105,6 @@ export abstract class ESLMediaQuery implements IMediaQueryCondition {
   public abstract addEventListener(type: 'change', callback: EventListener): void;
   public abstract removeEventListener(callback: EventListener): void;
   public abstract removeEventListener(type: 'change', callback: EventListener): void;
-
-  /** @deprecated alias for `addEventListener` */
-  public abstract addListener(cb: EventListener): void;
-  /** @deprecated alias for `removeEventListener` */
-  public abstract removeListener(cb: EventListener): void;
 }
 
 // Register otb preprocessors

diff --git a/src/modules/esl-panel-group/core/esl-panel-group.shape.ts b/src/modules/esl-panel-group/core/esl-panel-group.shape.ts
@@ -39,9 +39,6 @@ export interface ESLPanelGroupTagShape extends ESLBaseElementShape<ESLPanelGroup
 
   /** Allowed children */
   children?: any;
-
-  /** @deprecated fallback time no longer required */
-  'fallback-duration'?: string | number;
 }
 
 declare global {

diff --git a/src/modules/esl-panel/core/esl-panel.shape.ts b/src/modules/esl-panel/core/esl-panel.shape.ts
@@ -15,9 +15,6 @@ export interface ESLPanelTagShape extends ESLToggleableTagShape<ESLPanel> {
 
   /** Define CSS selector of the parent group (default: 'esl-panel-group')*/
   'panel-group-sel'?: string;
-
-  /** @deprecated fallback time is no longer required */
-  'fallback-duration'?: string | number;
 }
 
 declare global {

diff --git a/src/modules/esl-toggleable/core/esl-toggleable.ts b/src/modules/esl-toggleable/core/esl-toggleable.ts
@@ -39,9 +39,6 @@ export interface ESLToggleableRequestDetails extends ESLToggleableActionParams {
   match?: string | ((target: Element) => boolean);
 }
 
-/** @deprecated alias for ESLToggleableActionParams */
-export type ToggleableActionParams = ESLToggleableActionParams;
-
 const activators: WeakMap<ESLToggleable, HTMLElement | undefined> = new WeakMap();
 
 /**

diff --git a/src/modules/esl-traversing-query/core/esl-traversing-query.ts b/src/modules/esl-traversing-query/core/esl-traversing-query.ts
@@ -144,9 +144,6 @@ export class ESLTraversingQuery {
   }
 }
 
-/** @deprecated alias for {@link ESLTraversingQuery} */
-export const TraversingQuery = ESLTraversingQuery;
-
 declare global {
   export interface ESLLibrary {
     TraversingQuery: typeof ESLTraversingQuery;

diff --git a/src/modules/esl-utils/dom/events/target.ts b/src/modules/esl-utils/dom/events/target.ts
@@ -54,15 +54,6 @@ export class SyntheticEventTarget implements EventTarget {
     });
     return e.defaultPrevented;
   }
-
-  /** @deprecated alias for `addEventListener` */
-  public addListener(cb: EventListener): void {
-    this.addEventListener(cb);
-  }
-  /** @deprecated alias for `removeEventListener` */
-  public removeListener(cb: EventListener): void {
-    this.removeEventListener(cb);
-  }
 }
 
 function validateEventListenerType(callback: any): void | never {

diff --git a/src/modules/esl-utils/dom/events/test/target.test.ts b/src/modules/esl-utils/dom/events/test/target.test.ts
@@ -94,28 +94,6 @@ describe('dom/events: SyntheticEventTarget', () => {
       afterAll(() => jest.clearAllMocks());
     });
 
-    describe('Legacy functionality', () => {
-      const et = new SyntheticEventTarget();
-
-      const event1 = new CustomEvent('change');
-      const event2 = new CustomEvent('change');
-      const listener = jest.fn();
-      et.addListener(listener);
-
-      test('listener shoudn`t be called', () => expect(listener).toBeCalledTimes(0));
-
-      test('listener should be called once', () => {
-        et.dispatchEvent(event1);
-        expect(listener).toBeCalledWith(event1);
-      });
-
-      test('listener shouldn`t be called second time', () => {
-        et.removeListener(listener);
-        et.dispatchEvent(event2);
-        expect(listener).toBeCalledTimes(1);
-      });
-    });
-
     describe('API restriction', () => {
       const et = new SyntheticEventTarget();
       // @ts-ignore

diff --git a/src/modules/esl-utils/dom/rtl.ts b/src/modules/esl-utils/dom/rtl.ts
@@ -54,17 +54,3 @@ export const normalizeScrollLeft = (el: HTMLElement, value: number | null = null
       return value;
   }
 };
-
-/** @deprecated use separate functions from the module */
-export abstract class RTLUtils {
-  /** @deprecated use {@link isRTL} instead */
-  static readonly isRtl = isRTL;
-
-  /** @deprecated use {@link normalizeScrollLeft} instead */
-  static readonly normalizeScrollLeft = normalizeScrollLeft;
-
-  /** @deprecated use {@link RTLScroll}.type instead */
-  static get scrollType(): ScrollType {
-    return RTLScroll.type;
-  }
-}
diff --git a/src/modules/esl-utils/dom/traversing.ts b/src/modules/esl-utils/dom/traversing.ts
@@ -60,18 +60,3 @@ export const findClosestBy = (node: Node | null, predicate: (node: Node) => bool
   }
   return null;
 };
-
-/** @deprecated Cumulative traversing utility set */
-export abstract class TraversingUtils {
-  static isRelative = isRelativeNode;
-  static closestBy = findClosestBy;
-  static createSequenceFinder = createSequenceFinder;
-
-  static findNext = findNext;
-  static findPrev = findPrev;
-  static findParent = findParent;
-  static findClosest = findClosest;
-
-  static findAll = findAll;
-  static findChildren = findChildren;
-}
diff --git a/src/modules/esl-utils/misc/object/compare.ts b/src/modules/esl-utils/misc/object/compare.ts
@@ -13,9 +13,6 @@ export function isEqual(obj1: any, obj2: any): boolean {
   return false;
 }
 
-/** @deprecated alias for `isEqual` method */
-export const deepCompare = isEqual;
-
 /** Check if arr and arr mask has intersection */
 function isIntersect(arrObj: any[], arrMask: any[], comparer: (a: any, b: any) => boolean): boolean {
   return arrMask.every((key) => arrObj.some((itm) => comparer(itm, key)));

diff --git a/src/modules/esl-utils/misc/uid.ts b/src/modules/esl-utils/misc/uid.ts
@@ -21,9 +21,3 @@ export const randUID = (prefix: string = ''): string => {
   const rand = Math.round(Math.random() * 1024 * 1024).toString(32);
   return prefix + time + '-' + rand;
 };
-
-/**
- * Generate unique id
- * @deprecated Alias for {@link randUID}
- */
-export const generateUId = randUID;