@mlightcad/cad-simple-viewer 1.5.6 → 1.5.7

package/README.md

@@ -28,6 +28,7 @@ Use `cad-simple-viewer` if you need **core CAD logic only** (document management
 - `src/app/` – Document/context management, settings
 - `src/command/` – Command implementations (open, zoom, select, etc.)
 - `src/editor/` – Command stack, input handling, global functions
+- `src/service/` – Layer/entity services and UI layer store
 - `src/view/` – Layout and scene management
 - `src/util/` – Utilities
 
@@ -54,15 +55,79 @@ This capability makes `cad-simple-viewer` suitable for applications that need to
 
 In [cad-simple-viewer-example](https://github.com/mlight-lee/cad-simple-viewer-example) it demonstrates how to create one drawing with [**realdwg-web API**](https://mlight-lee.github.io/realdwg-web/).
 
+## Layer services
+
+Layer table mutations are centralized in `AcApLayerService`. UI integrations should use `AcApDocument.layerStore`, which observes that document's layer table and delegates mutations to its layer service.
+
+### Turning layers on/off from UI vs CLI
+
+`AcApLayerService.setLayerOn` accepts `{ switchCurrentLayer?: boolean }`:
+
+- **CLI commands** leave the default `false`. Batch helpers skip the current layer instead.
+- **UI callers** (`AcApLayerStore`, Vue `useLayers`) pass `true` so hiding or freezing the active layer moves `CLAYER` to another visible layer first.
+
+### LAYISO `LockAndFade` mode
+
+The `LockAndFade` isolation keyword matches AutoCAD naming but the viewer **locks** non-isolated layers only. It does not apply a visual fade; users are notified when selecting this mode in the `LAYISO` command.
+
+## Web Worker deployment
+
+The viewer loads three worker scripts for DXF parsing, DWG parsing, and MTEXT rendering. Host applications must deploy these files and point to them via `webworkerFileUrls` in `AcApDocManager.createInstance()`.
+
+Before calling `openDocument()`, verify that the workers are reachable. Use the built-in readiness API rather than downloading worker bodies with a plain GET request (the LibreDWG worker alone is ~12 MB):
+
+```typescript
+const workerUrls = {
+  dxfParser: './workers/dxf-parser-worker.js',
+  dwgParser: './workers/libredwg-parser-worker.js',
+  mtextRender: './workers/mtext-renderer-worker.js'
+}
+
+// Option 1: check before creating the manager
+const ready = await AcApDocManager.checkWebworkerReadiness(workerUrls)
+if (!ready) {
+  throw new Error('CAD worker scripts are missing or blocked')
+}
+
+const manager = AcApDocManager.createInstance({ webworkerFileUrls: workerUrls })
+
+// Option 2: check on an existing manager instance
+if (!(await manager.areWorkersReady())) {
+  throw new Error('CAD worker scripts are missing or blocked')
+}
+```
+
+`areWorkersReady()` and `checkWebworkerReadiness()` use HEAD requests internally. Successful URL probes are cached for the current page lifecycle; failures are not cached at the probe layer, so a transient network error can succeed on a later `areWorkersReady()` call. After each check, `manager.workersReady` is `true` or `false` (`null` only before the first check).
+
+You can also enable automatic checks during initialization:
+
+```typescript
+AcApDocManager.createInstance({
+  webworkerFileUrls: workerUrls,
+  checkWorkersOnInit: true
+})
+
+manager.events.workersReady.addEventListener(({ ready }) => {
+  if (!ready) console.error('CAD workers are not reachable')
+})
+```
+
 ## Available Exports
 
 ### Core Classes
 
 - `AcApContext` - Main application context
 - `AcApDocManager` - Document management
-- `AcApDocument` - Individual document handling
+- `AcApDocument` - Individual document handling (includes `layerService` and `layerStore`)
 - `AcApSettingManager` - Settings management
 
+### Services
+
+- `AcApLayerService` - Layer table mutations with undo
+- `AcApLayerStore` - Cached layer rows and UI-friendly mutations (via `AcApDocument.layerStore`)
+- `AcApEntityService` - Entity selection, transform, and edit helpers
+- `acapRunServiceEdit` - Undo-wrapped edits outside command transactions
+
 ### Commands
 
 - `AcApOpenCmd` - Open file command