@mlightcad/cad-simple-viewer 1.0.0 → 1.0.1

package/lib/editor/command/AcEdCommand.js

@@ -1,11 +1,60 @@
 import { AcCmEventManager } from '@mlightcad/data-model';
 /**
- * Base class of all commands.
+ * Abstract base class for all CAD commands.
+ *
+ * This class provides the foundation for implementing CAD commands with:
+ * - Command name management (global and localized names)
+ * - Lifecycle event handling (command start/end)
+ * - Execution framework with context access
+ * - Event notification system
+ *
+ * Commands are the primary way users interact with the CAD system. Each command
+ * represents a specific operation like drawing lines, selecting objects, zooming, etc.
+ *
+ * ## Command Lifecycle
+ * 1. Command is triggered via `trigger()` method
+ * 2. `commandWillStart` event is fired
+ * 3. `execute()` method is called with current context
+ * 4. `commandEnded` event is fired
+ *
+ * @example
+ * ```typescript
+ * class MyDrawCommand extends AcEdCommand {
+ *   constructor() {
+ *     super();
+ *     this.globalName = 'DRAW';
+ *     this.localName = 'Draw Line';
+ *   }
+ *
+ *   execute(context: AcApContext) {
+ *     // Implement command logic here
+ *     const view = context.view;
+ *     const document = context.doc;
+ *     // ... drawing logic
+ *   }
+ * }
+ *
+ * // Usage
+ * const command = new MyDrawCommand();
+ * command.events.commandWillStart.addEventListener(args => {
+ *   console.log('Command starting:', args.command.globalName);
+ * });
+ * command.trigger(context);
+ * ```
  */
 var AcEdCommand = /** @class */ (function () {
+    /**
+     * Creates a new command instance.
+     *
+     * Initializes the command with empty names. Subclasses should set
+     * appropriate global and local names in their constructors.
+     */
     function AcEdCommand() {
+        /** Events fired during command execution lifecycle */
         this.events = {
+            /** Fired just before the command starts executing */
             commandWillStart: new AcCmEventManager(),
+            /** Fired after the command finishes executing */
             commandEnded: new AcCmEventManager()
         };
         this._globalName = '';
@@ -13,11 +62,21 @@ var AcEdCommand = /** @class */ (function () {
     }
     Object.defineProperty(AcEdCommand.prototype, "globalName", {
         /**
-         * The global or untranslated name associated with the command.
+         * Gets the global (untranslated) name of the command.
+         *
+         * The global name is typically used for programmatic access and
+         * should remain consistent across different language localizations.
+         *
+         * @returns The global command name
          */
         get: function () {
             return this._globalName;
         },
+        /**
+         * Sets the global (untranslated) name of the command.
+         *
+         * @param value - The global command name (e.g., 'LINE', 'CIRCLE', 'ZOOM')
+         */
         set: function (value) {
             this._globalName = value;
         },
@@ -26,11 +85,21 @@ var AcEdCommand = /** @class */ (function () {
     });
     Object.defineProperty(AcEdCommand.prototype, "localName", {
         /**
-         * The local or translated name associated with the command.
+         * Gets the local (translated) name of the command.
+         *
+         * The local name is displayed to users and should be localized
+         * to the current language/region.
+         *
+         * @returns The localized command name
          */
         get: function () {
             return this._localName;
         },
+        /**
+         * Sets the local (translated) name of the command.
+         *
+         * @param value - The localized command name (e.g., 'Draw Line', 'Zoom In')
+         */
         set: function (value) {
             this._localName = value;
         },
@@ -38,9 +107,24 @@ var AcEdCommand = /** @class */ (function () {
         configurable: true
     });
     /**
-     * Trigger this command. The children class should not override this method to keep event notification
-     * work correctly.
-     * @param context Input current context to execute this command.
+     * Triggers the command execution with proper event handling.
+     *
+     * This method should not be overridden by subclasses as it handles
+     * the event notification workflow. Subclasses should implement the
+     * `execute()` method instead.
+     *
+     * The execution flow:
+     * 1. Fires `commandWillStart` event
+     * 2. Calls the `execute()` method
+     * 3. Fires `commandEnded` event
+     *
+     * @param context - The current application context containing view and document
+     *
+     * @example
+     * ```typescript
+     * const command = new MyCommand();
+     * command.trigger(docManager.context);
+     * ```
      */
     AcEdCommand.prototype.tirgger = function (context) {
         this.events.commandWillStart.dispatch({ command: this });
@@ -48,11 +132,31 @@ var AcEdCommand = /** @class */ (function () {
         this.events.commandEnded.dispatch({ command: this });
     };
     /**
-     * Execute this command. The children class should override this method to add business logic of this command.
-     * @param _context Input current context to execute this command.
+     * Executes the command logic.
+     *
+     * This abstract method must be implemented by subclasses to define
+     * the specific behavior of the command. The method receives the current
+     * application context providing access to the view and document.
+     *
+     * @param _context - The current application context
+     *
+     * @example
+     * ```typescript
+     * execute(context: AcApContext) {
+     *   const view = context.view;
+     *   const doc = context.doc;
+     *
+     *   // Get user input
+     *   const point = await view.editor.getPoint();
+     *
+     *   // Create entity in document
+     *   const entity = new SomeEntity(point);
+     *   doc.database.addEntity(entity);
+     * }
+     * ```
      */
     AcEdCommand.prototype.execute = function (_context) {
-        // Do nothing
+        // Do nothing - subclasses should override this method
     };
     return AcEdCommand;
 }());

package/lib/editor/command/AcEdCommand.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdCommand.js","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAWxD;;GAEG;AACH;IAIE;QAKgB,WAAM,GAAG;YACvB,gBAAgB,EAAE,IAAI,gBAAgB,EAAwB;YAC9D,YAAY,EAAE,IAAI,gBAAgB,EAAwB;SAC3D,CAAA;QAPC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;IACtB,CAAC;IAUD,sBAAI,mCAAU;QAHd;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;aACD,UAAe,KAAa;YAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAQD,sBAAI,kCAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IAKD;;;;OAIG;IACH,6BAAO,GAAP,UAAQ,OAAoB;QAC1B,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QACxD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrB,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACtD,CAAC;IAED;;;OAGG;IACH,6BAAO,GAAP,UAAQ,QAAqB;QAC3B,aAAa;IACf,CAAC;IACH,kBAAC;AAAD,CAAC,AApDD,IAoDC"}
+{"version":3,"file":"AcEdCommand.js","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAcxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH;IAME;;;;;OAKG;IACH;QAKA,sDAAsD;QACtC,WAAM,GAAG;YACvB,qDAAqD;YACrD,gBAAgB,EAAE,IAAI,gBAAgB,EAAwB;YAC9D,iDAAiD;YACjD,YAAY,EAAE,IAAI,gBAAgB,EAAwB;SAC3D,CAAA;QAVC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAA;QACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;IACtB,CAAC;IAkBD,sBAAI,mCAAU;QARd;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,WAAW,CAAA;QACzB,CAAC;QAED;;;;WAIG;aACH,UAAe,KAAa;YAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OATA;IAmBD,sBAAI,kCAAS;QARb;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;QAED;;;;WAIG;aACH,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OATA;IAWD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,6BAAO,GAAP,UAAQ,OAAoB;QAC1B,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;QACxD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACrB,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,6BAAO,GAAP,UAAQ,QAAqB;QAC3B,sDAAsD;IACxD,CAAC;IACH,kBAAC;AAAD,CAAC,AAxHD,IAwHC"}

package/lib/editor/command/AcEdCommandStack.d.ts

@@ -1,26 +1,76 @@
 import { AcEdCommand } from './AcEdCommand';
 import { AcEdCommandIterator } from './AcEdCommandIterator';
+/**
+ * Interface representing a command group in the command stack.
+ * Groups commands by name and provides maps for both global and local command lookups.
+ */
 export interface AcEdCommandGroup {
+    /** The name of the command group */
     groupName: string;
+    /** Map of commands indexed by their global names */
     commandsByGlobalName: Map<string, AcEdCommand>;
+    /** Map of commands indexed by their local names */
     commandsByLocalName: Map<string, AcEdCommand>;
 }
 /**
  * The class to create, define, and register command objects.
+ *
+ * This is a singleton class that manages all command registration and lookup functionality.
+ * Commands are organized into groups, with system commands (ACAD) and user commands (USER)
+ * being the default groups.
+ *
+ * @example
+ * ```typescript
+ * const commandStack = AcEdCommandStack.instance;
+ * commandStack.addCommand('USER', 'MYCOMMAND', 'MYCOMMAND', myCommandInstance);
+ * const command = commandStack.lookupGlobalCmd('MYCOMMAND');
+ * ```
  */
 export declare class AcEdCommandStack {
+    /** The name of the system command group */
     static SYSTEMT_COMMAND_GROUP_NAME: string;
+    /** The name of the default user command group */
     static DEFAUT_COMMAND_GROUP_NAME: string;
+    /** Array of all command groups in the stack */
     private _commandsByGroup;
+    /** Reference to the system command group */
     private _systemCommandGroup;
+    /** Reference to the default user command group */
     private _defaultCommandGroup;
+    /** Singleton instance of the command stack */
     private static _instance?;
+    /**
+     * Private constructor to enforce singleton pattern.
+     * Initializes the command stack with system and default command groups.
+     */
     private constructor();
+    /**
+     * Gets the singleton instance of the command stack.
+     * Creates a new instance if one doesn't exist.
+     *
+     * @returns The singleton instance of AcEdCommandStack
+     */
     static get instance(): AcEdCommandStack;
+    /**
+     * Adds a command to the specified command group.
+     *
+     * @param cmdGroupName - The name of the command group. If empty, uses the default group.
+     * @param cmdGlobalName - The global (untranslated) name of the command. Must be unique within the group.
+     * @param cmdLocalName - The local (translated) name of the command. Defaults to global name if empty.
+     * @param cmd - The command object to add to the stack.
+     *
+     * @throws {Error} When the global name is empty or when a command with the same name already exists
+     *
+     * @example
+     * ```typescript
+     * commandStack.addCommand('USER', 'LINE', 'ligne', new LineCommand());
+     * ```
+     */
     addCommand(cmdGroupName: string, cmdGlobalName: string, cmdLocalName: string, cmd: AcEdCommand): void;
     /**
      * Return an iterator that can be used to traverse all of command objects in this command stack
      * (that is, the iterator iterates through all commands in all groups).
+     *
      * @returns Return an iterator that can be used to traverse all of command objects in this command
      * stack.
      */
@@ -31,7 +81,8 @@ export declare class AcEdCommandStack {
      * matched AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command
      * could not be found. If more than one command of the same name is present in the command stack (that
      * is, in separate command groups), then the first one found is used.
-     * @param cmdName Input the command name to search for
+     *
+     * @param cmdName - Input the command name to search for
      * @returns Return the matched AcEdCommand object if a match is found. Otherwise, return undefined.
      */
     lookupGlobalCmd(cmdName: string): AcEdCommand | undefined;
@@ -41,7 +92,8 @@ export declare class AcEdCommandStack {
      * AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command could not
      * be found. If more than one command of the same name is present in the command stack (that is, in
      * separate command groups), then the first one found is used.
-     * @param cmdName Input the command name to search for
+     *
+     * @param cmdName - Input the command name to search for
      * @returns Return the matched AcEdCommand object if a match is found. Otherwise, return undefined.
      */
     lookupLocalCmd(cmdName: string): AcEdCommand | undefined;
@@ -49,8 +101,9 @@ export declare class AcEdCommandStack {
      * Remove the command with the global and untranslated name `cmdGlobalName` from the `cmdGroupName`
      * command group. Return true if successful. Return false if no command with the global and untranslated
      * name `cmdGlobalName` is found in the `cmdGroupName` command group.
-     * @param cmdGroupName Input the name of the command group containing the command to be removed
-     * @param cmdGlobalName Input the command name which is to be removed from cmdGroupName
+     *
+     * @param cmdGroupName - Input the name of the command group containing the command to be removed
+     * @param cmdGlobalName - Input the command name which is to be removed from cmdGroupName
      * @returns Return true if successful. Return false if no command with the global and untranslated
      * name `cmdGlobalName` is found in the `cmdGroupName` command group.
      */
@@ -58,7 +111,8 @@ export declare class AcEdCommandStack {
     /**
      * Remove the command group with the name `GroupName` from the command stack and delete the command group
      * dictionary object and all the AcEdCommand objects stored within it.
-     * @param groupName Input the name of the command group to be removed from the command stack.
+     *
+     * @param groupName - Input the name of the command group to be removed from the command stack.
      * @returns Return true if successful. Return false if no command group is found with the name `GroupName`.
      */
     removeGroup(groupName: string): boolean;

package/lib/editor/command/AcEdCommandStack.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdCommandStack.d.ts","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommandStack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC9C,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CAC9C;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,0BAA0B,SAAS;IAC1C,MAAM,CAAC,yBAAyB,SAAS;IACzC,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAkB;IAE3C,OAAO;IAgBP,MAAM,KAAK,QAAQ,qBAKlB;IAED,UAAU,CACR,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,WAAW;IA2ClB;;;;;OAKG;IACH,QAAQ;IAIR;;;;;;;;OAQG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM;IAS/B;;;;;;;;OAQG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM;IAS9B;;;;;;;;OAQG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IASrD;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM;CAY9B"}
+{"version":3,"file":"AcEdCommandStack.d.ts","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommandStack.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,oDAAoD;IACpD,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAC9C,mDAAmD;IACnD,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CAC9C;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAgB;IAC3B,2CAA2C;IAC3C,MAAM,CAAC,0BAA0B,SAAS;IAC1C,iDAAiD;IACjD,MAAM,CAAC,yBAAyB,SAAS;IAEzC,+CAA+C;IAC/C,OAAO,CAAC,gBAAgB,CAAoB;IAC5C,4CAA4C;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,kDAAkD;IAClD,OAAO,CAAC,oBAAoB,CAAkB;IAC9C,8CAA8C;IAC9C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAkB;IAE3C;;;OAGG;IACH,OAAO;IAgBP;;;;;OAKG;IACH,MAAM,KAAK,QAAQ,qBAKlB;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAU,CACR,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,WAAW;IA2ClB;;;;;;OAMG;IACH,QAAQ;IAIR;;;;;;;;;OASG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM;IAS/B;;;;;;;;;OASG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM;IASrD;;;;;;OAMG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM;CAY9B"}

package/lib/editor/command/AcEdCommandStack.js

@@ -12,8 +12,23 @@ var __values = (this && this.__values) || function(o) {
 import { AcEdCommandIterator } from './AcEdCommandIterator';
 /**
  * The class to create, define, and register command objects.
+ *
+ * This is a singleton class that manages all command registration and lookup functionality.
+ * Commands are organized into groups, with system commands (ACAD) and user commands (USER)
+ * being the default groups.
+ *
+ * @example
+ * ```typescript
+ * const commandStack = AcEdCommandStack.instance;
+ * commandStack.addCommand('USER', 'MYCOMMAND', 'MYCOMMAND', myCommandInstance);
+ * const command = commandStack.lookupGlobalCmd('MYCOMMAND');
+ * ```
  */
 var AcEdCommandStack = /** @class */ (function () {
+    /**
+     * Private constructor to enforce singleton pattern.
+     * Initializes the command stack with system and default command groups.
+     */
     function AcEdCommandStack() {
         this._commandsByGroup = [];
         this._systemCommandGroup = {
@@ -30,6 +45,12 @@ var AcEdCommandStack = /** @class */ (function () {
         this._commandsByGroup.push(this._defaultCommandGroup);
     }
     Object.defineProperty(AcEdCommandStack, "instance", {
+        /**
+         * Gets the singleton instance of the command stack.
+         * Creates a new instance if one doesn't exist.
+         *
+         * @returns The singleton instance of AcEdCommandStack
+         */
         get: function () {
             if (!AcEdCommandStack._instance) {
                 AcEdCommandStack._instance = new AcEdCommandStack();
@@ -39,6 +60,21 @@ var AcEdCommandStack = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Adds a command to the specified command group.
+     *
+     * @param cmdGroupName - The name of the command group. If empty, uses the default group.
+     * @param cmdGlobalName - The global (untranslated) name of the command. Must be unique within the group.
+     * @param cmdLocalName - The local (translated) name of the command. Defaults to global name if empty.
+     * @param cmd - The command object to add to the stack.
+     *
+     * @throws {Error} When the global name is empty or when a command with the same name already exists
+     *
+     * @example
+     * ```typescript
+     * commandStack.addCommand('USER', 'LINE', 'ligne', new LineCommand());
+     * ```
+     */
     AcEdCommandStack.prototype.addCommand = function (cmdGroupName, cmdGlobalName, cmdLocalName, cmd) {
         if (!cmdGlobalName) {
             throw new Error('[AcEdCommandStack] The global name of the command is required!');
@@ -74,6 +110,7 @@ var AcEdCommandStack = /** @class */ (function () {
     /**
      * Return an iterator that can be used to traverse all of command objects in this command stack
      * (that is, the iterator iterates through all commands in all groups).
+     *
      * @returns Return an iterator that can be used to traverse all of command objects in this command
      * stack.
      */
@@ -86,7 +123,8 @@ var AcEdCommandStack = /** @class */ (function () {
      * matched AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command
      * could not be found. If more than one command of the same name is present in the command stack (that
      * is, in separate command groups), then the first one found is used.
-     * @param cmdName Input the command name to search for
+     *
+     * @param cmdName - Input the command name to search for
      * @returns Return the matched AcEdCommand object if a match is found. Otherwise, return undefined.
      */
     AcEdCommandStack.prototype.lookupGlobalCmd = function (cmdName) {
@@ -115,7 +153,8 @@ var AcEdCommandStack = /** @class */ (function () {
      * AcEdCommand object is returned. Otherwise undefined is returned to indicate that the command could not
      * be found. If more than one command of the same name is present in the command stack (that is, in
      * separate command groups), then the first one found is used.
-     * @param cmdName Input the command name to search for
+     *
+     * @param cmdName - Input the command name to search for
      * @returns Return the matched AcEdCommand object if a match is found. Otherwise, return undefined.
      */
     AcEdCommandStack.prototype.lookupLocalCmd = function (cmdName) {
@@ -142,8 +181,9 @@ var AcEdCommandStack = /** @class */ (function () {
      * Remove the command with the global and untranslated name `cmdGlobalName` from the `cmdGroupName`
      * command group. Return true if successful. Return false if no command with the global and untranslated
      * name `cmdGlobalName` is found in the `cmdGroupName` command group.
-     * @param cmdGroupName Input the name of the command group containing the command to be removed
-     * @param cmdGlobalName Input the command name which is to be removed from cmdGroupName
+     *
+     * @param cmdGroupName - Input the name of the command group containing the command to be removed
+     * @param cmdGlobalName - Input the command name which is to be removed from cmdGroupName
      * @returns Return true if successful. Return false if no command with the global and untranslated
      * name `cmdGlobalName` is found in the `cmdGroupName` command group.
      */
@@ -169,7 +209,8 @@ var AcEdCommandStack = /** @class */ (function () {
     /**
      * Remove the command group with the name `GroupName` from the command stack and delete the command group
      * dictionary object and all the AcEdCommand objects stored within it.
-     * @param groupName Input the name of the command group to be removed from the command stack.
+     *
+     * @param groupName - Input the name of the command group to be removed from the command stack.
      * @returns Return true if successful. Return false if no command group is found with the name `GroupName`.
      */
     AcEdCommandStack.prototype.removeGroup = function (groupName) {
@@ -184,7 +225,9 @@ var AcEdCommandStack = /** @class */ (function () {
         }
         return false;
     };
+    /** The name of the system command group */
     AcEdCommandStack.SYSTEMT_COMMAND_GROUP_NAME = 'ACAD';
+    /** The name of the default user command group */
     AcEdCommandStack.DEFAUT_COMMAND_GROUP_NAME = 'USER';
     return AcEdCommandStack;
 }());

package/lib/editor/command/AcEdCommandStack.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdCommandStack.js","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommandStack.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAQ3D;;GAEG;AACH;IAQE;QACE,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAA;QAC1B,IAAI,CAAC,mBAAmB,GAAG;YACzB,SAAS,EAAE,gBAAgB,CAAC,0BAA0B;YACtD,oBAAoB,EAAE,IAAI,GAAG,EAAE;YAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;SAC/B,CAAA;QACD,IAAI,CAAC,oBAAoB,GAAG;YAC1B,SAAS,EAAE,gBAAgB,CAAC,yBAAyB;YACrD,oBAAoB,EAAE,IAAI,GAAG,EAAE;YAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;SAC/B,CAAA;QACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QACpD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACvD,CAAC;IAED,sBAAW,4BAAQ;aAAnB;YACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBAChC,gBAAgB,CAAC,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAA;YACrD,CAAC;YACD,OAAO,gBAAgB,CAAC,SAAS,CAAA;QACnC,CAAC;;;OAAA;IAED,qCAAU,GAAV,UACE,YAAoB,EACpB,aAAqB,EACrB,YAAoB,EACpB,GAAgB;QAEhB,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAA;QACH,CAAC;QACD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,YAAY,GAAG,aAAa,CAAA;QAC9B,CAAC;QAED,IAAI,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAA;QAC5C,IAAI,YAAY,EAAE,CAAC;YACjB,IAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CACpC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,SAAS,IAAI,YAAY,EAA/B,CAA+B,CACzC,CAAA;YACD,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,YAAY,GAAG;oBACb,SAAS,EAAE,YAAY;oBACvB,oBAAoB,EAAE,IAAI,GAAG,EAAE;oBAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;iBAC/B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,YAAY,GAAG,GAAG,CAAA;YACpB,CAAC;QACH,CAAC;QACD,IAAI,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,2DAAoD,aAAa,sBAAmB,CACrF,CAAA;QACH,CAAC;QACD,IAAI,YAAY,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CACb,0DAAmD,YAAY,sBAAmB,CACnF,CAAA;QACH,CAAC;QAED,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;QACzD,YAAY,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QACvD,GAAG,CAAC,UAAU,GAAG,aAAa,CAAA;QAC9B,GAAG,CAAC,SAAS,GAAG,YAAY,CAAA;IAC9B,CAAC;IAED;;;;;OAKG;IACH,mCAAQ,GAAR;QACE,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACvD,CAAC;IAED;;;;;;;;OAQG;IACH,0CAAe,GAAf,UAAgB,OAAe;;QAC7B,IAAI,MAAM,GAA4B,SAAS,CAAA;;YAC/C,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,MAAM,GAAG,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAChD,IAAI,MAAM;oBAAE,MAAK;YACnB,CAAC;;;;;;;;;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,yCAAc,GAAd,UAAe,OAAe;;QAC5B,IAAI,MAAM,GAA4B,SAAS,CAAA;;YAC/C,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,MAAM,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAC/C,IAAI,MAAM;oBAAE,MAAK;YACnB,CAAC;;;;;;;;;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;OAQG;IACH,oCAAS,GAAT,UAAU,YAAoB,EAAE,aAAqB;;;YACnD,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,IAAI,KAAK,CAAC,SAAS,IAAI,YAAY,EAAE,CAAC;oBACpC,OAAO,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBACzD,CAAC;YACH,CAAC;;;;;;;;;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,sCAAW,GAAX,UAAY,SAAiB;QAC3B,IAAI,GAAG,GAAG,CAAC,CAAC,CAAA;QACZ,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAC,KAAK,EAAE,KAAK;YACtC,GAAG,GAAG,KAAK,CAAA;YACX,OAAO,KAAK,CAAC,SAAS,IAAI,SAAS,CAAA;QACrC,CAAC,CAAC,CAAA;QACF,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IA9JM,2CAA0B,GAAG,MAAM,CAAA;IACnC,0CAAyB,GAAG,MAAM,CAAA;IA8J3C,uBAAC;CAAA,AAhKD,IAgKC;SAhKY,gBAAgB"}
+{"version":3,"file":"AcEdCommandStack.js","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommandStack.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAe3D;;;;;;;;;;;;;GAaG;AACH;IAeE;;;OAGG;IACH;QACE,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAA;QAC1B,IAAI,CAAC,mBAAmB,GAAG;YACzB,SAAS,EAAE,gBAAgB,CAAC,0BAA0B;YACtD,oBAAoB,EAAE,IAAI,GAAG,EAAE;YAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;SAC/B,CAAA;QACD,IAAI,CAAC,oBAAoB,GAAG;YAC1B,SAAS,EAAE,gBAAgB,CAAC,yBAAyB;YACrD,oBAAoB,EAAE,IAAI,GAAG,EAAE;YAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;SAC/B,CAAA;QACD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QACpD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACvD,CAAC;IAQD,sBAAW,4BAAQ;QANnB;;;;;WAKG;aACH;YACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC;gBAChC,gBAAgB,CAAC,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAA;YACrD,CAAC;YACD,OAAO,gBAAgB,CAAC,SAAS,CAAA;QACnC,CAAC;;;OAAA;IAED;;;;;;;;;;;;;;OAcG;IACH,qCAAU,GAAV,UACE,YAAoB,EACpB,aAAqB,EACrB,YAAoB,EACpB,GAAgB;QAEhB,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAA;QACH,CAAC;QACD,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,YAAY,GAAG,aAAa,CAAA;QAC9B,CAAC;QAED,IAAI,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAAA;QAC5C,IAAI,YAAY,EAAE,CAAC;YACjB,IAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CACpC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,SAAS,IAAI,YAAY,EAA/B,CAA+B,CACzC,CAAA;YACD,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,YAAY,GAAG;oBACb,SAAS,EAAE,YAAY;oBACvB,oBAAoB,EAAE,IAAI,GAAG,EAAE;oBAC/B,mBAAmB,EAAE,IAAI,GAAG,EAAE;iBAC/B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,YAAY,GAAG,GAAG,CAAA;YACpB,CAAC;QACH,CAAC;QACD,IAAI,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,2DAAoD,aAAa,sBAAmB,CACrF,CAAA;QACH,CAAC;QACD,IAAI,YAAY,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CACb,0DAAmD,YAAY,sBAAmB,CACnF,CAAA;QACH,CAAC;QAED,YAAY,CAAC,oBAAoB,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAA;QACzD,YAAY,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QACvD,GAAG,CAAC,UAAU,GAAG,aAAa,CAAA;QAC9B,GAAG,CAAC,SAAS,GAAG,YAAY,CAAA;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,mCAAQ,GAAR;QACE,OAAO,IAAI,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;IACvD,CAAC;IAED;;;;;;;;;OASG;IACH,0CAAe,GAAf,UAAgB,OAAe;;QAC7B,IAAI,MAAM,GAA4B,SAAS,CAAA;;YAC/C,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,MAAM,GAAG,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAChD,IAAI,MAAM;oBAAE,MAAK;YACnB,CAAC;;;;;;;;;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;;OASG;IACH,yCAAc,GAAd,UAAe,OAAe;;QAC5B,IAAI,MAAM,GAA4B,SAAS,CAAA;;YAC/C,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,MAAM,GAAG,KAAK,CAAC,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAC/C,IAAI,MAAM;oBAAE,MAAK;YACnB,CAAC;;;;;;;;;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;;OASG;IACH,oCAAS,GAAT,UAAU,YAAoB,EAAE,aAAqB;;;YACnD,KAAoB,IAAA,KAAA,SAAA,IAAI,CAAC,gBAAgB,CAAA,gBAAA,4BAAE,CAAC;gBAAvC,IAAM,KAAK,WAAA;gBACd,IAAI,KAAK,CAAC,SAAS,IAAI,YAAY,EAAE,CAAC;oBACpC,OAAO,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAA;gBACzD,CAAC;YACH,CAAC;;;;;;;;;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;OAMG;IACH,sCAAW,GAAX,UAAY,SAAiB;QAC3B,IAAI,GAAG,GAAG,CAAC,CAAC,CAAA;QACZ,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAC,KAAK,EAAE,KAAK;YACtC,GAAG,GAAG,KAAK,CAAA;YACX,OAAO,KAAK,CAAC,SAAS,IAAI,SAAS,CAAA;QACrC,CAAC,CAAC,CAAA;QACF,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACb,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YACpC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAnMD,2CAA2C;IACpC,2CAA0B,GAAG,MAAM,CAAA;IAC1C,iDAAiD;IAC1C,0CAAyB,GAAG,MAAM,CAAA;IAiM3C,uBAAC;CAAA,AArMD,IAqMC;SArMY,gBAAgB"}

package/lib/editor/global/eventBus.d.ts

@@ -1,34 +1,102 @@
 import { AcDbConversionStage, AcDbConversionStageStatus } from '@mlightcad/data-model';
 import { type Emitter } from 'mitt';
 /**
- * Message type
+ * Message severity type for user notifications.
+ *
+ * Used to categorize messages shown to users with appropriate visual styling.
  */
 export type AcEdMessageType = 'success' | 'warning' | 'info' | 'error';
+/**
+ * Type definition for all events that can be emitted through the global event bus.
+ *
+ * This type maps event names to their corresponding payload types, providing
+ * type safety for event emission and listening throughout the application.
+ *
+ * ## Event Categories
+ * - **File Operations**: `open-file`, `open-file-progress`, `failed-to-open-file`
+ * - **Font Management**: `font-not-loaded`, `failed-to-get-avaiable-fonts`, `font-not-found`
+ * - **User Messages**: `message`
+ */
 export type AcEdEvents = {
+    /** Emitted to request opening a file dialog */
     'open-file': {};
+    /** Emitted during file opening to report progress */
     'open-file-progress': {
+        /** Progress percentage (0-100) */
         percentage: number;
+        /** Current conversion stage */
         stage: AcDbConversionStage;
+        /** Status of the current stage */
         stageStatus: AcDbConversionStageStatus;
     };
+    /** Emitted to display a message to the user */
     message: {
+        /** The message text to display */
         message: string;
+        /** The severity/type of the message */
         type: AcEdMessageType;
     };
+    /** Emitted when a font fails to load */
     'font-not-loaded': {
+        /** Name of the font that failed to load */
         fontName: string;
+        /** URL where the font was attempted to be loaded from */
         url: string;
     };
+    /** Emitted when the available fonts list cannot be retrieved */
     'failed-to-get-avaiable-fonts': {
+        /** URL where the fonts list was attempted to be retrieved from */
         url: string;
     };
+    /** Emitted when a file fails to open */
     'failed-to-open-file': {
+        /** Name/path of the file that failed to open */
         fileName: string;
     };
+    /** Emitted when a required font is not found */
     'font-not-found': {
+        /** Name of the missing font */
         fontName: string;
+        /** Number of entities that require this font */
         count: number;
     };
 };
+/**
+ * Global event bus for application-wide communication.
+ *
+ * This event bus enables decoupled communication between different parts of the
+ * CAD viewer application. Components can emit events to notify about state changes
+ * or request actions, while other components can listen for these events to respond
+ * appropriately.
+ *
+ * The event bus is particularly useful for:
+ * - File operation status updates
+ * - Error and warning notifications
+ * - Font loading status
+ * - Cross-component communication
+ *
+ * @example
+ * ```typescript
+ * import { eventBus } from './eventBus';
+ *
+ * // Listen for file opening events
+ * eventBus.on('open-file', () => {
+ *   console.log('File open requested');
+ * });
+ *
+ * // Emit a progress update
+ * eventBus.emit('open-file-progress', {
+ *   percentage: 50,
+ *   stage: AcDbConversionStage.Parsing,
+ *   stageStatus: AcDbConversionStageStatus.InProgress
+ * });
+ *
+ * // Display a message to the user
+ * eventBus.emit('message', {
+ *   message: 'File opened successfully',
+ *   type: 'success'
+ * });
+ * ```
+ */
 export declare const eventBus: Emitter<AcEdEvents>;
 //# sourceMappingURL=eventBus.d.ts.map

package/lib/editor/global/eventBus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventBus.d.ts","sourceRoot":"","sources":["../../../src/editor/global/eventBus.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EAC1B,MAAM,uBAAuB,CAAA;AAC9B,OAAa,EAAE,KAAK,OAAO,EAAE,MAAM,MAAM,CAAA;AAEzC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAA;AAEtE,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,EAAE,CAAA;IACf,oBAAoB,EAAE;QACpB,UAAU,EAAE,MAAM,CAAA;QAClB,KAAK,EAAE,mBAAmB,CAAA;QAC1B,WAAW,EAAE,yBAAyB,CAAA;KACvC,CAAA;IACD,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,eAAe,CAAA;KAAE,CAAA;IACnD,iBAAiB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;IACpD,8BAA8B,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/C,qBAAqB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;IAC3C,gBAAgB,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CACtD,CAAA;AAED,eAAO,MAAM,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAsB,CAAA"}
+{"version":3,"file":"eventBus.d.ts","sourceRoot":"","sources":["../../../src/editor/global/eventBus.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EAC1B,MAAM,uBAAuB,CAAA;AAC9B,OAAa,EAAE,KAAK,OAAO,EAAE,MAAM,MAAM,CAAA;AAEzC;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAA;AAEtE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,+CAA+C;IAC/C,WAAW,EAAE,EAAE,CAAA;IACf,qDAAqD;IACrD,oBAAoB,EAAE;QACpB,kCAAkC;QAClC,UAAU,EAAE,MAAM,CAAA;QAClB,+BAA+B;QAC/B,KAAK,EAAE,mBAAmB,CAAA;QAC1B,kCAAkC;QAClC,WAAW,EAAE,yBAAyB,CAAA;KACvC,CAAA;IACD,+CAA+C;IAC/C,OAAO,EAAE;QACP,kCAAkC;QAClC,OAAO,EAAE,MAAM,CAAA;QACf,uCAAuC;QACvC,IAAI,EAAE,eAAe,CAAA;KACtB,CAAA;IACD,wCAAwC;IACxC,iBAAiB,EAAE;QACjB,2CAA2C;QAC3C,QAAQ,EAAE,MAAM,CAAA;QAChB,yDAAyD;QACzD,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,gEAAgE;IAChE,8BAA8B,EAAE;QAC9B,kEAAkE;QAClE,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,wCAAwC;IACxC,qBAAqB,EAAE;QACrB,gDAAgD;QAChD,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,gDAAgD;IAChD,gBAAgB,EAAE;QAChB,+BAA+B;QAC/B,QAAQ,EAAE,MAAM,CAAA;QAChB,gDAAgD;QAChD,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAsB,CAAA"}

package/lib/editor/global/eventBus.js

@@ -1,3 +1,40 @@
 import mitt from 'mitt';
+/**
+ * Global event bus for application-wide communication.
+ *
+ * This event bus enables decoupled communication between different parts of the
+ * CAD viewer application. Components can emit events to notify about state changes
+ * or request actions, while other components can listen for these events to respond
+ * appropriately.
+ *
+ * The event bus is particularly useful for:
+ * - File operation status updates
+ * - Error and warning notifications
+ * - Font loading status
+ * - Cross-component communication
+ *
+ * @example
+ * ```typescript
+ * import { eventBus } from './eventBus';
+ *
+ * // Listen for file opening events
+ * eventBus.on('open-file', () => {
+ *   console.log('File open requested');
+ * });
+ *
+ * // Emit a progress update
+ * eventBus.emit('open-file-progress', {
+ *   percentage: 50,
+ *   stage: AcDbConversionStage.Parsing,
+ *   stageStatus: AcDbConversionStageStatus.InProgress
+ * });
+ *
+ * // Display a message to the user
+ * eventBus.emit('message', {
+ *   message: 'File opened successfully',
+ *   type: 'success'
+ * });
+ * ```
+ */
 export var eventBus = mitt();
 //# sourceMappingURL=eventBus.js.map

package/lib/editor/global/eventBus.js.map

@@ -1 +1 @@
-{"version":3,"file":"eventBus.js","sourceRoot":"","sources":["../../../src/editor/global/eventBus.ts"],"names":[],"mappings":"AAIA,OAAO,IAAsB,MAAM,MAAM,CAAA;AAqBzC,MAAM,CAAC,IAAM,QAAQ,GAAwB,IAAI,EAAc,CAAA"}
+{"version":3,"file":"eventBus.js","sourceRoot":"","sources":["../../../src/editor/global/eventBus.ts"],"names":[],"mappings":"AAIA,OAAO,IAAsB,MAAM,MAAM,CAAA;AAiEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,CAAC,IAAM,QAAQ,GAAwB,IAAI,EAAc,CAAA"}