@snaptrude/plugin-client 0.0.8 → 0.0.9

package/AGENTS.md

@@ -0,0 +1,92 @@
+# Plugin Client — Agent Guide
+
+This package implements the plugin-core API for the **worker side** (plugin runtime).
+Plugins import `snaptrude` from this package to interact with the Snaptrude host.
+
+## Relationship to plugin-core
+
+> Source of truth: [`packages/plugin-core/AGENTS.md`](../plugin-core/AGENTS.md)
+
+This package **extends** every abstract class defined in `@snaptrude/plugin-core`.
+When plugin-core changes, this package must be updated to match.
+
+## What this package contains
+
+- `src/api/` — Concrete implementations of all plugin-core abstract APIs
+- `src/host-api.ts` — Comlink RPC wrapper (`HostApi.call()`) for host API calls
+- `src/plugin-worker.ts` — `PluginWorker` base class (lifecycle, UI messaging, Comlink exposure)
+- `src/index.ts` — Exports the `snaptrude` singleton (`ClientPluginApi` instance)
+
+## Quick commands
+
+```bash
+pnpm check-types   # typecheck (no emit)
+pnpm build          # tsup build (ESM + CJS)
+pnpm dev            # tsup watch mode
+```
+
+## Implementation patterns
+
+### Pure math/geometry (sync, local)
+
+Methods on `core.math.*` and `core.geom.*` are implemented directly — they inherit
+the base class implementation or override with equivalent logic. No RPC involved.
+
+```typescript
+// Example: ClientVec3Api inherits PluginVec3Api directly
+export class ClientVec3Api extends PluginVec3Api {}
+```
+
+### Host API calls (async, RPC)
+
+Methods on `entity.*`, `tools.*`, and `units.*` marshal calls to the host via Comlink:
+
+```typescript
+public async createRectangular(args: PluginSpaceCreateRectangularArgs) {
+  const hostApi = getHostApi()
+  return hostApi.call({
+    method: "entity.space.createRectangular",
+    args,
+  })
+}
+```
+
+The `method` string must match the dot-separated path from `PluginApiMethod` (auto-inferred
+from the class hierarchy in `plugin-core/src/host-utils.ts`).
+
+## When to update this package
+
+- **plugin-core adds a new abstract method**: Add the concrete implementation here
+- **plugin-core removes a method**: Remove the implementation here
+- **plugin-core changes a signature**: Update the method signature + call args here
+- **plugin-core adds a new API module**: Create a matching file under `src/api/`, wire
+  into the parent barrel (`index.ts`), and add to `ClientPluginApi`
+
+After making changes, always run `pnpm check-types` to verify everything compiles.
+
+## File mapping (plugin-core -> plugin-client)
+
+| plugin-core                           | plugin-client                              |
+| ------------------------------------- | ------------------------------------------ |
+| `src/api/core/math/vec3.ts`           | `src/api/core/math/vec3.ts`                |
+| `src/api/core/math/quat.ts`           | `src/api/core/math/quat.ts`                |
+| `src/api/core/geom/line.ts`           | `src/api/core/geom/line.ts`                |
+| `src/api/core/geom/arc.ts`            | `src/api/core/geom/arc.ts`                 |
+| `src/api/core/geom/curve.ts`          | `src/api/core/geom/curve.ts`               |
+| `src/api/core/geom/profile.ts`        | `src/api/core/geom/profile.ts`             |
+| `src/api/entity/space.ts`             | `src/api/entity/space.ts`                  |
+| `src/api/entity/story.ts`             | `src/api/entity/story.ts`                  |
+| `src/api/entity/referenceLine.ts`     | `src/api/entity/referenceLine.ts`          |
+| `src/api/entity/department.ts`        | `src/api/entity/department.ts`             |
+| `src/api/tools/selection.ts`          | `src/api/tools/selection.ts`               |
+| `src/api/tools/transform.ts`          | `src/api/tools/transform.ts`               |
+| `src/api/units/index.ts`              | `src/api/units/index.ts`                   |
+| `src/api/index.ts` (`PluginApi`)      | `src/api/index.ts` (`ClientPluginApi`)     |
+
+## Downstream consumers
+
+Changes to this package's **public exports** affect:
+- Internal plugins under `plugins/`
+- Example plugins under `examples/`
+
+If you change or remove an export, search these directories for usage.

package/CLAUDE.md

@@ -0,0 +1,11 @@
+# CLAUDE.md
+
+> **All coding standards, checks, and guidance live in [`AGENTS.md`](AGENTS.md).**
+> `CLAUDE.md` is a pointer only — add all new rules, patterns, and instructions to `AGENTS.md`.
+
+See [AGENTS.md](AGENTS.md) for:
+
+- Implementation patterns (sync math vs async RPC)
+- File mapping from plugin-core to plugin-client
+- When and how to update this package in response to plugin-core changes
+- Downstream consumer notes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snaptrude/plugin-client",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -18,7 +18,7 @@
   },
   "dependencies": {
     "comlink": "^4.4.2",
-    "@snaptrude/plugin-core": "0.0.8"
+    "@snaptrude/plugin-core": "0.0.9"
   },
   "devDependencies": {
     "tsup": "^8.5.1",