@mlightcad/cad-simple-viewer 1.0.0 → 1.0.2

package/lib/command/AcApZoomToBoxCmd.d.ts

@@ -1,11 +1,68 @@
 import { AcApContext } from '../app';
 import { AcEdCommand } from '../command';
 import { AcEdBaseView, AcEdJig } from '../editor';
+/**
+ * Jig for handling zoom-to-box selection interaction.
+ *
+ * This jig handles the user interaction for selecting a rectangular
+ * area to zoom to. It extends {@link AcEdJig} to provide interactive
+ * selection capabilities.
+ *
+ * The jig allows users to:
+ * - Select a rectangular area on the drawing
+ * - Zoom the view to fit the selected area
+ * - Provide visual feedback during selection
+ *
+ * @example
+ * ```typescript
+ * const jig = new AcApZoomToBoxJig(view);
+ * await jig.drag(); // User selects area to zoom to
+ * ```
+ */
 export declare class AcApZoomToBoxJig extends AcEdJig<boolean> {
+    /**
+     * Creates a new zoom-to-box jig.
+     *
+     * @param view - The view that will be zoomed
+     */
     constructor(view: AcEdBaseView);
+    /**
+     * Handles the selection sampling and zooming operation.
+     *
+     * This method gets the user's selection box and applies
+     * the zoom operation to fit that area in the view.
+     *
+     * @returns Promise that resolves when the zoom operation completes
+     */
     sampler(): Promise<void>;
 }
+/**
+ * Command for zooming to a user-selected rectangular area.
+ *
+ * This command initiates an interactive zoom-to-box operation where:
+ * - User selects a rectangular area by dragging
+ * - The view zooms to fit the selected area
+ * - The zoom level is adjusted to show the entire selected region
+ *
+ * This provides precise navigation control, allowing users to quickly
+ * focus on specific areas of large drawings.
+ *
+ * @example
+ * ```typescript
+ * const zoomToBoxCmd = new AcApZoomToBoxCmd();
+ * await zoomToBoxCmd.execute(context); // User selects area to zoom to
+ * ```
+ */
 export declare class AcApZoomToBoxCmd extends AcEdCommand {
+    /**
+     * Executes the zoom-to-box command.
+     *
+     * Creates a jig for interactive area selection and initiates
+     * the drag operation for the user to select the zoom area.
+     *
+     * @param context - The application context containing the view
+     * @returns Promise that resolves when the zoom operation completes
+     */
     execute(context: AcApContext): Promise<void>;
 }
 //# sourceMappingURL=AcApZoomToBoxCmd.d.ts.map

package/lib/command/AcApZoomToBoxCmd.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcApZoomToBoxCmd.d.ts","sourceRoot":"","sources":["../../src/command/AcApZoomToBoxCmd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEjD,qBAAa,gBAAiB,SAAQ,OAAO,CAAC,OAAO,CAAC;gBACxC,IAAI,EAAE,YAAY;IAIxB,OAAO;CAKd;AAED,qBAAa,gBAAiB,SAAQ,WAAW;IACzC,OAAO,CAAC,OAAO,EAAE,WAAW;CAInC"}
+{"version":3,"file":"AcApZoomToBoxCmd.d.ts","sourceRoot":"","sources":["../../src/command/AcApZoomToBoxCmd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,gBAAiB,SAAQ,OAAO,CAAC,OAAO,CAAC;IACpD;;;;OAIG;gBACS,IAAI,EAAE,YAAY;IAI9B;;;;;;;OAOG;IACG,OAAO;CAKd;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACG,OAAO,CAAC,OAAO,EAAE,WAAW;CAInC"}

package/lib/command/AcApZoomToBoxCmd.js

@@ -52,11 +52,42 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 import { AcApDocManager } from '../app';
 import { AcEdCommand } from '../command';
 import { AcEdJig } from '../editor';
+/**
+ * Jig for handling zoom-to-box selection interaction.
+ *
+ * This jig handles the user interaction for selecting a rectangular
+ * area to zoom to. It extends {@link AcEdJig} to provide interactive
+ * selection capabilities.
+ *
+ * The jig allows users to:
+ * - Select a rectangular area on the drawing
+ * - Zoom the view to fit the selected area
+ * - Provide visual feedback during selection
+ *
+ * @example
+ * ```typescript
+ * const jig = new AcApZoomToBoxJig(view);
+ * await jig.drag(); // User selects area to zoom to
+ * ```
+ */
 var AcApZoomToBoxJig = /** @class */ (function (_super) {
     __extends(AcApZoomToBoxJig, _super);
+    /**
+     * Creates a new zoom-to-box jig.
+     *
+     * @param view - The view that will be zoomed
+     */
     function AcApZoomToBoxJig(view) {
         return _super.call(this, view) || this;
     }
+    /**
+     * Handles the selection sampling and zooming operation.
+     *
+     * This method gets the user's selection box and applies
+     * the zoom operation to fit that area in the view.
+     *
+     * @returns Promise that resolves when the zoom operation completes
+     */
     AcApZoomToBoxJig.prototype.sampler = function () {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
@@ -75,11 +106,37 @@ var AcApZoomToBoxJig = /** @class */ (function (_super) {
     return AcApZoomToBoxJig;
 }(AcEdJig));
 export { AcApZoomToBoxJig };
+/**
+ * Command for zooming to a user-selected rectangular area.
+ *
+ * This command initiates an interactive zoom-to-box operation where:
+ * - User selects a rectangular area by dragging
+ * - The view zooms to fit the selected area
+ * - The zoom level is adjusted to show the entire selected region
+ *
+ * This provides precise navigation control, allowing users to quickly
+ * focus on specific areas of large drawings.
+ *
+ * @example
+ * ```typescript
+ * const zoomToBoxCmd = new AcApZoomToBoxCmd();
+ * await zoomToBoxCmd.execute(context); // User selects area to zoom to
+ * ```
+ */
 var AcApZoomToBoxCmd = /** @class */ (function (_super) {
     __extends(AcApZoomToBoxCmd, _super);
     function AcApZoomToBoxCmd() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Executes the zoom-to-box command.
+     *
+     * Creates a jig for interactive area selection and initiates
+     * the drag operation for the user to select the zoom area.
+     *
+     * @param context - The application context containing the view
+     * @returns Promise that resolves when the zoom operation completes
+     */
     AcApZoomToBoxCmd.prototype.execute = function (context) {
         return __awaiter(this, void 0, void 0, function () {
             var jig;

package/lib/command/AcApZoomToBoxCmd.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcApZoomToBoxCmd.js","sourceRoot":"","sources":["../../src/command/AcApZoomToBoxCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAgB,OAAO,EAAE,MAAM,WAAW,CAAA;AAEjD;IAAsC,oCAAgB;IACpD,0BAAY,IAAkB;QAC5B,OAAA,MAAK,YAAC,IAAI,CAAC,SAAA;IACb,CAAC;IAEK,kCAAO,GAAb;;;;;4BACE,qBAAM,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,UAAA,GAAG;4BAC1D,OAAO,KAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;wBACjC,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAA;;;;;KACH;IACH,uBAAC;AAAD,CAAC,AAVD,CAAsC,OAAO,GAU5C;;AAED;IAAsC,oCAAW;IAAjD;;IAKA,CAAC;IAJO,kCAAO,GAAb,UAAc,OAAoB;;;;;;wBAC1B,GAAG,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;wBAC9C,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAAhB,SAAgB,CAAA;;;;;KACjB;IACH,uBAAC;AAAD,CAAC,AALD,CAAsC,WAAW,GAKhD"}
+{"version":3,"file":"AcApZoomToBoxCmd.js","sourceRoot":"","sources":["../../src/command/AcApZoomToBoxCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAgB,OAAO,EAAE,MAAM,WAAW,CAAA;AAEjD;;;;;;;;;;;;;;;;;GAiBG;AACH;IAAsC,oCAAgB;IACpD;;;;OAIG;IACH,0BAAY,IAAkB;QAC5B,OAAA,MAAK,YAAC,IAAI,CAAC,SAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACG,kCAAO,GAAb;;;;;4BACE,qBAAM,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,UAAA,GAAG;4BAC1D,OAAO,KAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;wBACjC,CAAC,CAAC,EAAA;;wBAFF,SAEE,CAAA;;;;;KACH;IACH,uBAAC;AAAD,CAAC,AAvBD,CAAsC,OAAO,GAuB5C;;AAED;;;;;;;;;;;;;;;;GAgBG;AACH;IAAsC,oCAAW;IAAjD;;IAcA,CAAC;IAbC;;;;;;;;OAQG;IACG,kCAAO,GAAb,UAAc,OAAoB;;;;;;wBAC1B,GAAG,GAAG,IAAI,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;wBAC9C,qBAAM,GAAG,CAAC,IAAI,EAAE,EAAA;;wBAAhB,SAAgB,CAAA;;;;;KACjB;IACH,uBAAC;AAAD,CAAC,AAdD,CAAsC,WAAW,GAchD"}

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

@@ -1,41 +1,150 @@
 import { AcCmEventManager } from '@mlightcad/data-model';
 import { AcApContext } from '../../app';
 /**
- * Interface to define arguments of one command event.
+ * Event arguments for command lifecycle events.
+ *
+ * Contains the command instance that triggered the event.
  */
 export interface AcEdCommandEventArgs {
+    /** The command instance involved in the event */
     command: AcEdCommand;
 }
 /**
- * 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);
+ * ```
  */
 export declare abstract class AcEdCommand {
+    /** The global (untranslated) name of the command */
     private _globalName;
+    /** The local (translated) name of the command */
     private _localName;
+    /**
+     * Creates a new command instance.
+     *
+     * Initializes the command with empty names. Subclasses should set
+     * appropriate global and local names in their constructors.
+     */
     constructor();
+    /** Events fired during command execution lifecycle */
     readonly events: {
+        /** Fired just before the command starts executing */
         commandWillStart: AcCmEventManager<AcEdCommandEventArgs>;
+        /** Fired after the command finishes executing */
         commandEnded: AcCmEventManager<AcEdCommandEventArgs>;
     };
     /**
-     * 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 globalName(): string;
+    /**
+     * Sets the global (untranslated) name of the command.
+     *
+     * @param value - The global command name (e.g., 'LINE', 'CIRCLE', 'ZOOM')
+     */
     set globalName(value: string);
     /**
-     * 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 localName(): string;
+    /**
+     * Sets the local (translated) name of the command.
+     *
+     * @param value - The localized command name (e.g., 'Draw Line', 'Zoom In')
+     */
     set localName(value: string);
     /**
-     * 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);
+     * ```
      */
     tirgger(context: AcApContext): void;
     /**
-     * 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);
+     * }
+     * ```
      */
     execute(_context: AcApContext): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcEdCommand.d.ts","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,WAAW,CAAA;CACrB;AAED;;GAEG;AACH,8BAAsB,WAAW;IAC/B,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAQ;;IAO1B,SAAgB,MAAM;;;MAGrB;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;OAEG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW;IAM5B;;;OAGG;IACH,OAAO,CAAC,QAAQ,EAAE,WAAW;CAG9B"}
+{"version":3,"file":"AcEdCommand.d.ts","sourceRoot":"","sources":["../../../src/editor/command/AcEdCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,iDAAiD;IACjD,OAAO,EAAE,WAAW,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,8BAAsB,WAAW;IAC/B,oDAAoD;IACpD,OAAO,CAAC,WAAW,CAAQ;IAC3B,iDAAiD;IACjD,OAAO,CAAC,UAAU,CAAQ;IAE1B;;;;;OAKG;;IAMH,sDAAsD;IACtD,SAAgB,MAAM;QACpB,qDAAqD;;QAErD,iDAAiD;;MAElD;IAED;;;;;;;OAOG;IACH,IAAI,UAAU,IASQ,MAAM,CAP3B;IAED;;;;OAIG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;OAOG;IACH,IAAI,SAAS,IASQ,MAAM,CAP1B;IAED;;;;OAIG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW;IAM5B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CAAC,QAAQ,EAAE,WAAW;CAG9B"}

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"}