(chore) @otjs/types: Create Generic Event Emitter Interface

0xTheProDev · 0xTheProDev · commit 33d3a6f4d4f7 · 2024-02-03T23:09:02.000+05:30
Each event-enabled component gets to extend Generic Event Emitter interface with their set of events and corresponding arguments.
Upgraded Mitt dependency to 3.0.1

Signed-off-by: Progyan Bhattacharya &lt;bprogyan@gmail.com&gt;
diff --git a/packages/ace/package.json b/packages/ace/package.json
@@ -49,7 +49,7 @@
     "@types/lodash": "4.14.191"
   },
   "dependencies": {
-    "mitt": "3.0.0"
+    "mitt": "3.0.1"
   },
   "peerDependencies": {
     "@otjs/plaintext": "^0.2.0",
diff --git a/packages/firebase-ace/package.json b/packages/firebase-ace/package.json
@@ -49,7 +49,7 @@
     "@otjs/utils": "workspace:*",
     "@types/ace": "0.0.48",
     "firebase": "9.15.0",
-    "mitt": "3.0.0"
+    "mitt": "3.0.1"
   },
   "dependencies": {
     "@otjs/ace": "0.2.1",
diff --git a/packages/firebase-ace/src/firebase-ace.ts b/packages/firebase-ace/src/firebase-ace.ts
@@ -24,8 +24,11 @@
 
 import { TAceAdapterConstructionOptions } from "@otjs/ace";
 import { TFirebaseAdapterConstructionOptions } from "@otjs/firebase-plaintext";
-import { TEditorClientEventArgs } from "@otjs/plaintext-editor";
-import { IDisposable } from "@otjs/types";
+import {
+  EditorClientEvent,
+  TEditorClientEventArgs,
+} from "@otjs/plaintext-editor";
+import { IDisposable, IEventEmitter } from "@otjs/types";
 import { Handler } from "mitt";
 
 /**
@@ -40,7 +43,9 @@ export type TFireAceEditorConstructionOptions =
  * @public
  * FireAce Editor Interface - Public APIs to interact with Collaborative Editor.
  */
-export interface IFireAceEditor extends IDisposable {
+export interface IFireAceEditor
+  extends IDisposable,
+    IEventEmitter<EditorClientEvent, TEditorClientEventArgs> {
   /** Returns if the Editor has already been disposed. */
   disposed: boolean;
   /** Returns Text Content of the Editor. Can be used to both get and set. Returns empty string if already disposed. */
@@ -57,24 +62,6 @@ export interface IFireAceEditor extends IDisposable {
    * Returns false if at least one operation has been performed after initialisation for the first time, True otherwise.
    */
   isHistoryEmpty(): boolean;
-  /**
-   * Add listener to FireAce Editor.
-   * @param event - Event name.
-   * @param listener - Event handler callback.
-   */
-  on<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener: Handler<TEditorClientEventArgs[Key]>
-  ): void;
-  /**
-   * Remove listener to FireAce Editor.
-   * @param event - Event name.
-   * @param listener - Event handler callback (optional).
-   */
-  off<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener?: Handler<TEditorClientEventArgs[Key]>
-  ): void;
 }
 
-export { IDisposable };
+export { IDisposable, IEventEmitter };
diff --git a/packages/firebase-monaco/package.json b/packages/firebase-monaco/package.json
@@ -48,7 +48,7 @@
     "@otjs/types": "workspace:*",
     "@otjs/utils": "workspace:*",
     "firebase": "9.15.0",
-    "mitt": "3.0.0",
+    "mitt": "3.0.1",
     "monaco-editor": "0.34.1"
   },
   "dependencies": {
diff --git a/packages/firebase-monaco/src/firebase-monaco.ts b/packages/firebase-monaco/src/firebase-monaco.ts
@@ -24,9 +24,11 @@
 
 import { TFirebaseAdapterConstructionOptions } from "@otjs/firebase-plaintext";
 import { TMonacoAdapterConstructionOptions } from "@otjs/monaco";
-import { TEditorClientEventArgs } from "@otjs/plaintext-editor";
-import { IDisposable } from "@otjs/types";
-import { Handler } from "mitt";
+import {
+  EditorClientEvent,
+  TEditorClientEventArgs,
+} from "@otjs/plaintext-editor";
+import { IDisposable, IEventEmitter } from "@otjs/types";
 
 /**
  * @public
@@ -40,7 +42,9 @@ export type TFireMonacoEditorConstructionOptions =
  * @public
  * FireMonaco Editor Interface - Public APIs to interact with Collaborative Editor.
  */
-export interface IFireMonacoEditor extends IDisposable {
+export interface IFireMonacoEditor
+  extends IDisposable,
+    IEventEmitter<EditorClientEvent, TEditorClientEventArgs> {
   /** Returns if the Editor has already been disposed. */
   disposed: boolean;
   /** Returns Text Content of the Editor. Can be used to both get and set. Returns empty string if already disposed. */
@@ -57,24 +61,6 @@ export interface IFireMonacoEditor extends IDisposable {
    * Returns false if at least one operation has been performed after initialisation for the first time, True otherwise.
    */
   isHistoryEmpty(): boolean;
-  /**
-   * Add listener to FireMonaco Editor.
-   * @param event - Event name.
-   * @param listener - Event handler callback.
-   */
-  on<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener: Handler<TEditorClientEventArgs[Key]>
-  ): void;
-  /**
-   * Remove listener to FireMonaco Editor.
-   * @param event - Event name.
-   * @param listener - Event handler callback (optional).
-   */
-  off<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener?: Handler<TEditorClientEventArgs[Key]>
-  ): void;
 }
 
-export { IDisposable };
+export { IDisposable, IEventEmitter };
diff --git a/packages/firebase-plaintext/package.json b/packages/firebase-plaintext/package.json
@@ -50,7 +50,7 @@
     "firebase": "9.15.0"
   },
   "dependencies": {
-    "mitt": "3.0.0"
+    "mitt": "3.0.1"
   },
   "peerDependencies": {
     "@otjs/plaintext": "^0.2.0",
diff --git a/packages/monaco/package.json b/packages/monaco/package.json
@@ -48,7 +48,7 @@
     "monaco-editor": "0.34.1"
   },
   "dependencies": {
-    "mitt": "3.0.0"
+    "mitt": "3.0.1"
   },
   "peerDependencies": {
     "@otjs/plaintext": "^0.2.0",
diff --git a/packages/plaintext-editor/package.json b/packages/plaintext-editor/package.json
@@ -53,7 +53,7 @@
   },
   "dependencies": {
     "@otjs/state-machine": "0.2.1",
-    "mitt": "3.0.0"
+    "mitt": "3.0.1"
   },
   "peerDependencies": {
     "@otjs/plaintext": "^0.2.0"
diff --git a/packages/plaintext-editor/src/database-adapter.ts b/packages/plaintext-editor/src/database-adapter.ts
@@ -24,8 +24,7 @@
 
 import { ICursor, TCursor } from "./cursor";
 import { IPlainTextOperation } from "@otjs/plaintext";
-import { IDisposable } from "@otjs/types";
-import { Handler } from "mitt";
+import { IDisposable, IEventEmitter } from "@otjs/types";
 
 /**
  * @public
@@ -87,25 +86,9 @@ export type TDatabaseAdapterEventArgs = {
  * @public
  * Database Adapter Interface - This Interface should be implemented over Persistence Layer to have OT capabilities.
  */
-export interface IDatabaseAdapter extends IDisposable {
-  /**
-   * Add listener to Database Adapter.
-   * @param event - Event name.
-   * @param listener - Event handler callback.
-   */
-  on<Key extends keyof TDatabaseAdapterEventArgs>(
-    event: Key,
-    listener: Handler<TDatabaseAdapterEventArgs[Key]>
-  ): void;
-  /**
-   * Remove listener to Database Adapter.
-   * @param event - Event name.
-   * @param listener - Event handler callback (optional).
-   */
-  off<Key extends keyof TDatabaseAdapterEventArgs>(
-    event: Key,
-    listener?: Handler<TDatabaseAdapterEventArgs[Key]>
-  ): void;
+export interface IDatabaseAdapter
+  extends IDisposable,
+    IEventEmitter<DatabaseAdapterEvent, TDatabaseAdapterEventArgs> {
   /**
    * Tests if any operation has been done yet on the document.
    */
diff --git a/packages/plaintext-editor/src/editor-adapter.ts b/packages/plaintext-editor/src/editor-adapter.ts
@@ -23,7 +23,7 @@
  */
 
 import { IPlainTextOperation } from "@otjs/plaintext";
-import { IDisposable } from "@otjs/types";
+import { IDisposable, IEventEmitter } from "@otjs/types";
 import { Handler } from "mitt";
 import { ICursor } from "./cursor";
 
@@ -96,30 +96,14 @@ export type TEditorAdapterCursorParams = {
  * @public
  * Editor Adapter Interface - This Interface should be implemented over Plain Text Editor to have OT functionalities.
  */
-export interface IEditorAdapter extends IDisposable {
+export interface IEditorAdapter
+  extends IDisposable,
+    IEventEmitter<EditorAdapterEvent, TEditorAdapterEventArgs> {
   /**
    * Returns whether or not Editor Adapter instance will emit event.
    * Toggling this value will set/reset event listeners on Editor.
    */
   events: boolean;
-  /**
-   * Add listener to Editor Adapter.
-   * @param event - Event name.
-   * @param listener - Event handler callback.
-   */
-  on<Key extends keyof TEditorAdapterEventArgs>(
-    event: Key,
-    listener: Handler<TEditorAdapterEventArgs[Key]>
-  ): void;
-  /**
-   * Remove listener to Editor Adapter.
-   * @param event - Event name.
-   * @param listener - Event handler callback (optional).
-   */
-  off<Key extends keyof TEditorAdapterEventArgs>(
-    event: Key,
-    listener?: Handler<TEditorAdapterEventArgs[Key]>
-  ): void;
   /**
    * Add Undo callback to maintain sync while doing Undo in Plain Text Editor.
    * @param callback - Undo Event Handler.
diff --git a/packages/plaintext-editor/src/editor-client.ts b/packages/plaintext-editor/src/editor-client.ts
@@ -23,8 +23,7 @@
  */
 
 import { ITransitionHandler } from "@otjs/state-machine";
-import { IDisposable } from "@otjs/types";
-import { Handler } from "mitt";
+import { IDisposable, IEventEmitter } from "@otjs/types";
 import { IDatabaseAdapter } from "./database-adapter";
 import { IEditorAdapter } from "./editor-adapter";
 
@@ -86,29 +85,14 @@ export type TEditorClientConstructionOptions = {
  * @public
  * Editor Client Interface - Public APIs to interact with Collaborative Editor.
  */
-export interface IEditorClient extends IDisposable, ITransitionHandler {
-  /**
-   * Add listener to Editor Client.
-   * @param event - Event name.
-   * @param listener - Event handler callback.
-   */
-  on<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener: Handler<TEditorClientEventArgs[Key]>
-  ): void;
-  /**
-   * Remove listener to Editor Client.
-   * @param event - Event name.
-   * @param listener - Event handler callback (optional).
-   */
-  off<Key extends keyof TEditorClientEventArgs>(
-    event: Key,
-    listener?: Handler<TEditorClientEventArgs[Key]>
-  ): void;
+export interface IEditorClient
+  extends IDisposable,
+    IEventEmitter<EditorClientEvent, TEditorClientEventArgs>,
+    ITransitionHandler {
   /**
    * Clears undo redo stack of current Editor model.
    */
   clearUndoRedoStack(): void;
 }
 
-export { IDisposable };
+export { IDisposable, IEventEmitter };
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -22,5 +22,8 @@
   },
   "engines": {
     "node": ">=10.0.0"
+  },
+  "devDependencies": {
+    "mitt": "3.0.1"
   }
 }
diff --git a/packages/types/src/emitter.ts b/packages/types/src/emitter.ts
@@ -0,0 +1,53 @@
+/**
+ * Copyright © 2021 Progyan Bhattacharya
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * See LICENSE file in the root directory for more details.
+ */
+
+import { Handler } from "mitt";
+
+/**
+ * @internal
+ * Event Emitter Interface - Generic Interface that handles raising Event to outside world.
+ */
+export interface IEventEmitter<
+  Event extends string,
+  EventArgs extends Record<Event, any>,
+> {
+  /**
+   * Adds event listener.
+   * @param event - Event name.
+   * @param listener - Event handler callback.
+   */
+  on<Key extends keyof EventArgs>(
+    event: Key,
+    listener: Handler<EventArgs[Key]>,
+  ): void;
+  /**
+   * Removes event listener.
+   * @param event - Event name.
+   * @param listener - Event handler callback (optional).
+   */
+  off<Key extends keyof EventArgs>(
+    event: Key,
+    listener?: Handler<EventArgs[Key]>,
+  ): void;
+}
diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -25,6 +25,7 @@
 export * from "./cancelable";
 export * from "./operation";
 export * from "./disposable";
+export * from "./emitter";
 export * from "./memoize";
 export * from "./thenable";
 export * from "./utility-types";
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
