@sparkerp/plugin-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ERP Platform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# @sparkerp/plugin-sdk
+
+The ERP Developer Platform CLI (`erp`) + MCP server (`erp-mcp-server`) for
+authoring plugins against a deployed ERP — **with zero access to the
+platform monorepo**. Platform source is secret to third-party developers;
+this package ships an offline authoring snapshot (`bundle/` — JSON Schemas,
+the frozen engine capability catalog, curated examples, tenant-public docs,
+the core block catalog, and self-contained page/block validators) so most
+commands work before you ever `erp login`.
+
+## Install
+
+```bash
+npm install -g @sparkerp/plugin-sdk
+```
+
+## Quickstart
+
+```bash
+erp --version
+erp schema pull page            # offline — reads the bundled snapshot
+erp login                       # OAuth 2.0 device authorization grant (RFC 8628)
+erp env sync                    # pulls the latest schemas/docs/blocks/live entity+theme
+                                 # names from your logged-in env's GET /api/v1/dev/bundle
+                                 # into ~/.erp/cache/<envKey>/ — overlays the bundled snapshot
+erp mcp install                 # wires .mcp.json in the current dir to this install's
+                                 # erp-mcp-server (Claude Code / any MCP client)
+erp docs serve                  # local offline dev-preview of the full doc set
+```
+
+For CI, set `ERP_TOKEN=<access token>` instead of `erp login` — every
+networked command honors it.
+
+Full task-by-task docs: see this package's bundled `bundle/docs/` (browse
+them with `erp docs serve`), or the source Diátaxis tree at
+`developer-docs/quickstart/` in the platform repo (`developer-docs/README.md`
+is the entry point; `docs.json` is the nav manifest).
+
+## How the two SDK modes work
+
+- **monorepo** — running from inside the platform repo checkout (or
+  `ERP_SDK_MODE=monorepo`): reads live from the repo's own schema/doc/example
+  sources, byte-identical to a platform developer's own tooling.
+- **packaged** — this npm install, anywhere else (or `ERP_SDK_MODE=packaged`):
+  reads only from `bundle/` (shipped in this package) overlaid by
+  `~/.erp/cache/<envKey>/` (populated by `erp env sync` from your logged-in
+  environment's live `/api/v1/dev/bundle`). No Java, no repo file, ever, on
+  the client. See `bundle/docs/concepts/sdk-modes.md`.
+
+## Rebuilding this package (maintainers, inside the monorepo)
+
+```bash
+node build.mjs     # refreshes erp-cli/, erp-mcp-server/, bundle/ from ../../tools/*
+                    # (run `erp bundle build` upstream first for a fresh bundle)
+npm version patch   # or minor/major
+npm pack            # or npm publish, once a registry is set up
+```
+
+See `low-code-docs/REMOTE-SDK-BATCH-C-D-STATUS.md` in the platform repo for
+the portability proof and what's deferred (real registry publish, hosted
+website deploy).