@mlightcad/cad-simple-viewer 1.0.0 → 1.0.1

package/lib/command/AcApSelectCmd.js

@@ -15,11 +15,37 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { AcEdCommand } from '../command';
 import { AcEdCorsorType, AcEdViewMode } from '../editor';
+/**
+ * Command for enabling selection mode in the CAD viewer.
+ *
+ * This command switches the view to selection mode, allowing users to
+ * select CAD entities by clicking on them. When executed, it:
+ * - Sets the view mode to SELECTION
+ * - Changes the cursor to a crosshair for precise selection
+ *
+ * In selection mode, users can click on entities to select them,
+ * which will add them to the selection set and typically show
+ * grip points for manipulation.
+ *
+ * @example
+ * ```typescript
+ * const selectCmd = new AcApSelectCmd();
+ * selectCmd.execute(context); // Enables selection mode
+ * ```
+ */
 var AcApSelectCmd = /** @class */ (function (_super) {
     __extends(AcApSelectCmd, _super);
     function AcApSelectCmd() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Executes the select command.
+     *
+     * Sets the view to selection mode and updates the cursor appearance
+     * to indicate that entity selection is active.
+     *
+     * @param context - The application context containing the view
+     */
     AcApSelectCmd.prototype.execute = function (context) {
         context.view.mode = AcEdViewMode.SELECTION;
         context.view.setCursor(AcEdCorsorType.Crosshair);

package/lib/command/AcApSelectCmd.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcApSelectCmd.js","sourceRoot":"","sources":["../../src/command/AcApSelectCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExD;IAAmC,iCAAW;IAA9C;;IAKA,CAAC;IAJC,+BAAO,GAAP,UAAQ,OAAoB;QAC1B,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,SAAS,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;IAClD,CAAC;IACH,oBAAC;AAAD,CAAC,AALD,CAAmC,WAAW,GAK7C"}
+{"version":3,"file":"AcApSelectCmd.js","sourceRoot":"","sources":["../../src/command/AcApSelectCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH;IAAmC,iCAAW;IAA9C;;IAaA,CAAC;IAZC;;;;;;;OAOG;IACH,+BAAO,GAAP,UAAQ,OAAoB;QAC1B,OAAO,CAAC,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,SAAS,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;IAClD,CAAC;IACH,oBAAC;AAAD,CAAC,AAbD,CAAmC,WAAW,GAa7C"}

package/lib/command/AcApSvgConvertor.d.ts

@@ -1,5 +1,53 @@
+/**
+ * Utility class for converting CAD drawings to SVG format.
+ *
+ * This class provides functionality to export the current CAD drawing
+ * to SVG format and download it as a file. It iterates through all
+ * entities in the model space and renders them using the SVG renderer.
+ *
+ * The conversion process:
+ * 1. Gets all entities from the current document's model space
+ * 2. Uses the SVG renderer to convert each entity to SVG markup
+ * 3. Exports the complete SVG content
+ * 4. Creates a downloadable file for the user
+ *
+ * @example
+ * ```typescript
+ * const converter = new AcApSvgConvertor();
+ *
+ * // Convert and download current drawing as SVG
+ * converter.convert();
+ * ```
+ */
 export declare class AcApSvgConvertor {
+    /**
+     * Converts the current CAD drawing to SVG format and initiates download.
+     *
+     * This method:
+     * - Retrieves all entities from the current document's model space
+     * - Renders each entity using the SVG renderer
+     * - Exports the complete SVG markup
+     * - Automatically downloads the SVG file as 'example.svg'
+     *
+     * @example
+     * ```typescript
+     * const converter = new AcApSvgConvertor();
+     * converter.convert(); // Downloads the drawing as SVG
+     * ```
+     */
     convert(): void;
+    /**
+     * Creates a downloadable SVG file and triggers the download.
+     *
+     * This method:
+     * - Creates a Blob from the SVG content with proper MIME type
+     * - Generates a temporary download URL
+     * - Creates and triggers a download link
+     * - Cleans up the temporary elements
+     *
+     * @param svgContent - The SVG markup content to download
+     * @private
+     */
     private createFileAndDownloadIt;
 }
 //# sourceMappingURL=AcApSvgConvertor.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AcApSvgConvertor.d.ts","sourceRoot":"","sources":["../../src/command/AcApSvgConvertor.ts"],"names":[],"mappings":"AAIA,qBAAa,gBAAgB;IAC3B,OAAO;IAUP,OAAO,CAAC,uBAAuB;CAoBhC"}
+{"version":3,"file":"AcApSvgConvertor.d.ts","sourceRoot":"","sources":["../../src/command/AcApSvgConvertor.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAgB;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO;IAUP;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,uBAAuB;CAoBhC"}

package/lib/command/AcApSvgConvertor.js

@@ -11,9 +11,45 @@ var __values = (this && this.__values) || function(o) {
 };
 import { AcSvgRenderer } from '@mlightcad/svg-renderer';
 import { AcApDocManager } from '../app';
+/**
+ * Utility class for converting CAD drawings to SVG format.
+ *
+ * This class provides functionality to export the current CAD drawing
+ * to SVG format and download it as a file. It iterates through all
+ * entities in the model space and renders them using the SVG renderer.
+ *
+ * The conversion process:
+ * 1. Gets all entities from the current document's model space
+ * 2. Uses the SVG renderer to convert each entity to SVG markup
+ * 3. Exports the complete SVG content
+ * 4. Creates a downloadable file for the user
+ *
+ * @example
+ * ```typescript
+ * const converter = new AcApSvgConvertor();
+ *
+ * // Convert and download current drawing as SVG
+ * converter.convert();
+ * ```
+ */
 var AcApSvgConvertor = /** @class */ (function () {
     function AcApSvgConvertor() {
     }
+    /**
+     * Converts the current CAD drawing to SVG format and initiates download.
+     *
+     * This method:
+     * - Retrieves all entities from the current document's model space
+     * - Renders each entity using the SVG renderer
+     * - Exports the complete SVG markup
+     * - Automatically downloads the SVG file as 'example.svg'
+     *
+     * @example
+     * ```typescript
+     * const converter = new AcApSvgConvertor();
+     * converter.convert(); // Downloads the drawing as SVG
+     * ```
+     */
     AcApSvgConvertor.prototype.convert = function () {
         var e_1, _a;
         var entities = AcApDocManager.instance.curDocument.database.tables.blockTable.modelSpace.newIterator();
@@ -33,6 +69,18 @@ var AcApSvgConvertor = /** @class */ (function () {
         }
         this.createFileAndDownloadIt(renderer.export());
     };
+    /**
+     * Creates a downloadable SVG file and triggers the download.
+     *
+     * This method:
+     * - Creates a Blob from the SVG content with proper MIME type
+     * - Generates a temporary download URL
+     * - Creates and triggers a download link
+     * - Cleans up the temporary elements
+     *
+     * @param svgContent - The SVG markup content to download
+     * @private
+     */
     AcApSvgConvertor.prototype.createFileAndDownloadIt = function (svgContent) {
         // Convert the SVG content into a Blob
         var svgBlob = new Blob([svgContent], {

package/lib/command/AcApSvgConvertor.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcApSvgConvertor.js","sourceRoot":"","sources":["../../src/command/AcApSvgConvertor.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAEvC;IAAA;IA+BA,CAAC;IA9BC,kCAAO,GAAP;;QACE,IAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA;QACzF,IAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAA;;YACpC,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;gBAA3B,IAAM,MAAM,qBAAA;gBACf,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvB,CAAC;;;;;;;;;QACD,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IACjD,CAAC;IAEO,kDAAuB,GAA/B,UAAgC,UAAkB;QAChD,sCAAsC;QACtC,IAAM,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE;YACrC,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAA;QAEF,4BAA4B;QAC5B,IAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAExC,kDAAkD;QAClD,IAAM,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAChD,YAAY,CAAC,IAAI,GAAG,GAAG,CAAA;QACvB,YAAY,CAAC,QAAQ,GAAG,aAAa,CAAA;QAErC,mFAAmF;QACnF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAA;QAEvC,uBAAuB;QACvB,YAAY,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IACH,uBAAC;AAAD,CAAC,AA/BD,IA+BC"}
+{"version":3,"file":"AcApSvgConvertor.js","sourceRoot":"","sources":["../../src/command/AcApSvgConvertor.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAEvD,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IAAA;IA0DA,CAAC;IAzDC;;;;;;;;;;;;;;OAcG;IACH,kCAAO,GAAP;;QACE,IAAM,QAAQ,GACZ,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA;QACzF,IAAM,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAA;;YACpC,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;gBAA3B,IAAM,MAAM,qBAAA;gBACf,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACvB,CAAC;;;;;;;;;QACD,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;;;;;;OAWG;IACK,kDAAuB,GAA/B,UAAgC,UAAkB;QAChD,sCAAsC;QACtC,IAAM,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE;YACrC,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAA;QAEF,4BAA4B;QAC5B,IAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QAExC,kDAAkD;QAClD,IAAM,YAAY,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAChD,YAAY,CAAC,IAAI,GAAG,GAAG,CAAA;QACvB,YAAY,CAAC,QAAQ,GAAG,aAAa,CAAA;QAErC,mFAAmF;QACnF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAA;QAEvC,uBAAuB;QACvB,YAAY,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IACH,uBAAC;AAAD,CAAC,AA1DD,IA0DC"}

package/lib/command/AcApZoomCmd.d.ts

@@ -1,6 +1,35 @@
 import { AcApContext } from '../app';
 import { AcEdCommand } from '../command';
+/**
+ * Command to zoom the view to fit all visible entities.
+ *
+ * This command adjusts the view's zoom level and position to show all
+ * visible entities in the current drawing within the viewport. It's
+ * equivalent to the "Zoom Extents" or "Fit to Window" functionality
+ * found in most CAD applications.
+ *
+ * The command calculates the bounding box of all visible entities and
+ * adjusts the camera to show them all with appropriate padding.
+ *
+ * @example
+ * ```typescript
+ * const zoomCommand = new AcApZoomCmd();
+ * zoomCommand.globalName = 'ZOOM';
+ * zoomCommand.localName = 'Zoom to Fit';
+ *
+ * // Execute the command to fit all entities in view
+ * zoomCommand.trigger(docManager.context);
+ * ```
+ */
 export declare class AcApZoomCmd extends AcEdCommand {
+    /**
+     * Executes the zoom to fit command.
+     *
+     * Calls the view's `zoomToFit()` method to adjust the camera position
+     * and zoom level to display all visible entities within the viewport.
+     *
+     * @param context - The current application context containing the view to zoom
+     */
     execute(context: AcApContext): void;
 }
 //# sourceMappingURL=AcApZoomCmd.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AcApZoomCmd.d.ts","sourceRoot":"","sources":["../../src/command/AcApZoomCmd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,qBAAa,WAAY,SAAQ,WAAW;IAC1C,OAAO,CAAC,OAAO,EAAE,WAAW;CAG7B"}
+{"version":3,"file":"AcApZoomCmd.d.ts","sourceRoot":"","sources":["../../src/command/AcApZoomCmd.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW;CAG7B"}

package/lib/command/AcApZoomCmd.js

@@ -14,11 +14,40 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import { AcEdCommand } from '../command';
+/**
+ * Command to zoom the view to fit all visible entities.
+ *
+ * This command adjusts the view's zoom level and position to show all
+ * visible entities in the current drawing within the viewport. It's
+ * equivalent to the "Zoom Extents" or "Fit to Window" functionality
+ * found in most CAD applications.
+ *
+ * The command calculates the bounding box of all visible entities and
+ * adjusts the camera to show them all with appropriate padding.
+ *
+ * @example
+ * ```typescript
+ * const zoomCommand = new AcApZoomCmd();
+ * zoomCommand.globalName = 'ZOOM';
+ * zoomCommand.localName = 'Zoom to Fit';
+ *
+ * // Execute the command to fit all entities in view
+ * zoomCommand.trigger(docManager.context);
+ * ```
+ */
 var AcApZoomCmd = /** @class */ (function (_super) {
     __extends(AcApZoomCmd, _super);
     function AcApZoomCmd() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Executes the zoom to fit command.
+     *
+     * Calls the view's `zoomToFit()` method to adjust the camera position
+     * and zoom level to display all visible entities within the viewport.
+     *
+     * @param context - The current application context containing the view to zoom
+     */
     AcApZoomCmd.prototype.execute = function (context) {
         context.view.zoomToFit();
     };

package/lib/command/AcApZoomCmd.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcApZoomCmd.js","sourceRoot":"","sources":["../../src/command/AcApZoomCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC;IAAiC,+BAAW;IAA5C;;IAIA,CAAC;IAHC,6BAAO,GAAP,UAAQ,OAAoB;QAC1B,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;IAC1B,CAAC;IACH,kBAAC;AAAD,CAAC,AAJD,CAAiC,WAAW,GAI3C"}
+{"version":3,"file":"AcApZoomCmd.js","sourceRoot":"","sources":["../../src/command/AcApZoomCmd.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IAAiC,+BAAW;IAA5C;;IAYA,CAAC;IAXC;;;;;;;OAOG;IACH,6BAAO,GAAP,UAAQ,OAAoB;QAC1B,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;IAC1B,CAAC;IACH,kBAAC;AAAD,CAAC,AAZD,CAAiC,WAAW,GAY3C"}

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