@i-scope/debugger 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/LICENSE +21 -0
  3. package/README.md +111 -0
  4. package/package.json +47 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,15 @@
1
+ # Changelog — @i-scope/debugger
2
+
3
+ All notable changes to this package will be documented here. The format
4
+ is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and
5
+ this project adheres to [Semantic Versioning](https://semver.org/).
6
+
7
+ ## [0.1.0] — 2026-05-19
8
+
9
+ ### Added
10
+
11
+ - Initial public release. Meta-package umbrella for the iScope Debugger SDK.
12
+ - Direct dependencies: `@i-scope/mcp-server@^0.4.0`, `@i-scope/dap-adapter@^0.2.0`.
13
+ - Transitively brings in `iscope-bridge-client`, `iscope-bridge` (Win32 binary),
14
+ `source-map-bridge`, `vlst-parser`, `com-protocol-types`.
15
+ - No runtime code of its own; install convenience only.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 iScope
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,111 @@
1
+ # @i-scope/debugger
2
+
3
+ [![npm version](https://img.shields.io/npm/v/%40i-scope%2Fdebugger.svg?label=npm)](https://www.npmjs.com/package/@i-scope/debugger)
4
+ [![npm downloads](https://img.shields.io/npm/dm/%40i-scope%2Fdebugger.svg)](https://www.npmjs.com/package/@i-scope/debugger)
5
+ [![License: MIT](https://img.shields.io/npm/l/%40i-scope%2Fdebugger.svg)](./LICENSE)
6
+ [![Node](https://img.shields.io/node/v/%40i-scope%2Fdebugger.svg)](#)
7
+
8
+ Official single-install entry point for the **iScope Debugger SDK** —
9
+ the open-source toolkit for debugging Oscilloscope.exe `.ajs` (JScript
10
+ ES3) scripts. This is a pure **meta-package**: it ships no runtime
11
+ code, just a curated set of `dependencies` that transitively pull in
12
+ every piece of the SDK (DAP adapter, MCP server, Win32 native helper,
13
+ source-map / VLST / COM-protocol leaves).
14
+
15
+ ## Quick install
16
+
17
+ ```bash
18
+ npm install @i-scope/debugger
19
+ ```
20
+
21
+ That's it. After install you can import from any of the underlying
22
+ packages — `@i-scope/mcp-server`, `@i-scope/dap-adapter`,
23
+ `@i-scope/iscope-bridge-client`, etc. — without listing them
24
+ individually in your own `package.json`.
25
+
26
+ ## Who should install this
27
+
28
+ | Persona | Recommended install | Entry point |
29
+ |---------|---------------------|-------------|
30
+ | AI agent through MCP | `@i-scope/debugger` (full set) | `import ... from '@i-scope/mcp-server'`; or wire `.cursor/mcp.json` |
31
+ | DAP host integration (WebStorm, Neovim DAP, custom IDE) | `@i-scope/debugger` (full set) | `import { AjsDebugSession } from '@i-scope/dap-adapter'` |
32
+ | CLI / custom Node tooling | `@i-scope/debugger` (full set) OR point-pick `@i-scope/iscope-bridge-client` standalone | `import { IScopeBridge } from '@i-scope/iscope-bridge-client'` |
33
+ | VS Code / Cursor end-user | **Do NOT install this.** Install the `.vsix` extension from Marketplace — it bundles everything. | F5 in `.ajs` / `.ts` files |
34
+
35
+ Note that `@i-scope/debugger` (this package, published on **npmjs.com**)
36
+ and the unscoped `iscope-debugger` (the VS Code / Cursor extension
37
+ published on the **Visual Studio Marketplace** and OpenVSX) are two
38
+ different artefacts living on two different registries with two
39
+ different audiences — there is no name collision. End-users install
40
+ the extension; SDK consumers install this meta-package.
41
+
42
+ ## What's inside
43
+
44
+ Installing `@i-scope/debugger` transitively brings in the full SDK
45
+ (2 direct deps + 5 transitive):
46
+
47
+ - [`@i-scope/mcp-server`](https://www.npmjs.com/package/@i-scope/mcp-server) *(direct dep)* — MCP server exposing 21 debugger tools to AI agents (16 debug + 4 UI modal + 1 system preflight).
48
+ - [`@i-scope/dap-adapter`](https://www.npmjs.com/package/@i-scope/dap-adapter) *(direct dep)* — DAP server (`AjsDebugSession`) for IDE integrations; ships both a stand-alone stdio server (`npx iscope-debug-server`) and an embeddable class.
49
+ - [`@i-scope/iscope-bridge-client`](https://www.npmjs.com/package/@i-scope/iscope-bridge-client) *(transitive)* — Node JSON-RPC client to the native helper; exports `IScopeBridge`, `resolveHelperPath`, OSC_NOT_FOUND detector, VLST helpers.
50
+ - [`@i-scope/iscope-bridge`](https://www.npmjs.com/package/@i-scope/iscope-bridge) *(transitive)* — Win32 native helper `iScopeBridge.exe` (JSON-RPC stdio → COM bridge to Oscilloscope.exe). Binary-only tarball.
51
+ - [`@i-scope/source-map-bridge`](https://www.npmjs.com/package/@i-scope/source-map-bridge) *(transitive)* — bidirectional TS ↔ AJS source-map manager (inline / sidecar / implicit, webpack:// URLs).
52
+ - [`@i-scope/vlst-parser`](https://www.npmjs.com/package/@i-scope/vlst-parser) *(transitive)* — pure-TypeScript parser for Oscilloscope VLST blobs (the wire format for locals / Watch).
53
+ - [`@i-scope/com-protocol-types`](https://www.npmjs.com/package/@i-scope/com-protocol-types) *(transitive)* — COM constants mirror (DISPID, GSTID, RTID, STEPACT, BRKREASON) — TS dzeркало of `Constants.h`.
54
+
55
+ `@i-scope/dap-adapter` is listed as a direct dep (in addition to being
56
+ transitive through `@i-scope/mcp-server`) so the DAP-only persona gets
57
+ a clean top-level `npm update @i-scope/dap-adapter`.
58
+
59
+ ## Prerequisites
60
+
61
+ This SDK targets **Windows only** (the `iScopeBridge.exe` helper is
62
+ Win32 native, and `Oscilloscope.exe` is a Windows COM server). Before
63
+ the debugger can attach to a running Oscilloscope you need:
64
+
65
+ - Windows 10 / 11.
66
+ - [Oscilloscope.exe](https://gitlab.com/i-scope/Debugger) installed
67
+ and running with a `.mwf` waveform loaded.
68
+ - Machine Debug Manager (MDM) registered — i.e. `pdm.dll` present
69
+ under `HKCR\CLSID\{0BB89CE8-...}`. Install via "Windows Script
70
+ Debugger" or via the legacy `script56.exe` package.
71
+ - Node.js ≥ 20 in your host process.
72
+
73
+ See the [root README](https://gitlab.com/i-scope/Debugger/-/blob/main/README.md)
74
+ of the monorepo for the full Prerequisites section, including
75
+ preflight diagnostics (`debug_preflight_check` / `system_preflight_check`
76
+ MCP tools) that verify the above and return a structured verdict.
77
+
78
+ ## Quick start — MCP integration (most common path)
79
+
80
+ After `npm install @i-scope/debugger`, point your MCP client (Cursor,
81
+ Claude Code, …) at the bundled server. Example `.cursor/mcp.json`:
82
+
83
+ ```json
84
+ {
85
+ "mcpServers": {
86
+ "iscope-debugger": {
87
+ "command": "npx",
88
+ "args": ["-y", "@i-scope/mcp-server"]
89
+ }
90
+ }
91
+ }
92
+ ```
93
+
94
+ The AI agent now has access to all 21 MCP tools — `debug_launch`,
95
+ `debug_set_breakpoints`, `debug_step_into`, `debug_variables`,
96
+ `debug_snapshot`, `debug_resolve_source`, `ui_modal_list`,
97
+ `system_preflight_check`, … See
98
+ [`@i-scope/mcp-server` README](https://www.npmjs.com/package/@i-scope/mcp-server)
99
+ for the full tool reference.
100
+
101
+ ## Documentation
102
+
103
+ - Monorepo: <https://gitlab.com/i-scope/Debugger>
104
+ - [Root README](https://gitlab.com/i-scope/Debugger/-/blob/main/README.md) — Prerequisites + project layout.
105
+ - [`AGENTS.md`](https://gitlab.com/i-scope/Debugger/-/blob/main/AGENTS.md) — AI session orientation guide.
106
+ - [`info/Plan.md`](https://gitlab.com/i-scope/Debugger/-/blob/main/info/Plan.md) — overall architecture and project plan.
107
+ - [`info/Naming-Taxonomy.md`](https://gitlab.com/i-scope/Debugger/-/blob/main/info/Naming-Taxonomy.md) — npm scope taxonomy across iScope products (why this package is named `@i-scope/debugger` rather than `iscope-sdk` or `@iscope/*`).
108
+
109
+ ## License
110
+
111
+ MIT — see [`LICENSE`](./LICENSE).
package/package.json ADDED
@@ -0,0 +1,47 @@
1
+ {
2
+ "name": "@i-scope/debugger",
3
+ "version": "0.2.0",
4
+ "license": "MIT",
5
+ "description": "iScope Debugger — meta-package. Single-install entry point for the full debugger SDK: DAP adapter for IDE integrations, MCP server for AI agents, Win32 native helper bridge, source-map / VLST / COM-protocol building blocks. Pure dependency umbrella; no runtime code of its own.",
6
+ "keywords": [
7
+ "iscope-debugger",
8
+ "iscope",
9
+ "i-scope",
10
+ "debugger",
11
+ "ajs",
12
+ "jscript",
13
+ "oscilloscope",
14
+ "autoscope",
15
+ "dap",
16
+ "mcp",
17
+ "sdk",
18
+ "meta-package"
19
+ ],
20
+ "homepage": "https://gitlab.com/i-scope/Debugger",
21
+ "repository": {
22
+ "type": "git",
23
+ "url": "https://gitlab.com/i-scope/Debugger.git",
24
+ "directory": "packages/debugger"
25
+ },
26
+ "bugs": {
27
+ "url": "https://gitlab.com/i-scope/Debugger/-/issues"
28
+ },
29
+ "files": [
30
+ "README.md",
31
+ "CHANGELOG.md",
32
+ "LICENSE"
33
+ ],
34
+ "engines": {
35
+ "node": ">=20"
36
+ },
37
+ "os": [
38
+ "win32"
39
+ ],
40
+ "publishConfig": {
41
+ "access": "public"
42
+ },
43
+ "dependencies": {
44
+ "@i-scope/mcp-server": "^0.4.2",
45
+ "@i-scope/dap-adapter": "^0.2.2"
46
+ }
47
+ }