Skip to content

feat: add the official Node plugin SDK and runner - #7

Draft
MAJ224 wants to merge 2 commits into
developfrom
feature/node-plugin-sdk
Draft

MAJ224 wants to merge 2 commits into
developfrom
feature/node-plugin-sdk

Conversation

@MAJ224

@MAJ224 MAJ224 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • add typed protocol 1.1 contracts and PluginServer to @focusrgb/plugin-sdk
  • ship focusrgb-node-runner at dist/focusrgb-node-runner.js for the Windows host
  • support concurrent requests, cancellation, standard JSON-RPC errors, protocol-only stdout, automatic SDK identity and signed 64-bit IDs
  • add a TypeScript example and template, both exercised by language-neutral conformance
  • pin schema/type drift and conformance to FocusRGB spec-v1.1.0
  • add path-filtered Node 22 CI and a package-only sdk-node-v* dry run with no npm credentials or publication

Verification

  • clean npm ci; 0 vulnerabilities
  • Node SDK tests: 11/11 passed
  • node-example conformance: passed
  • node-template conformance: passed
  • npm package dry run includes dist/focusrgb-node-runner.js
  • .NET Release build: 0 warnings/errors
  • .NET tests against spec-v1.0.0: 30/30 passed
  • .NET package, consumer, template and conformance verifier: passed

Remaining action

  • The @FocusRGB npm organization is still pending. This PR never publishes and requires no npm token.

Closes the Node SDK checklist item in #3.

Assisted-by: OpenAI Codex

Assisted-by: OpenAI Codex
Assisted-by: OpenAI Codex
@MAJ224

MAJ224 commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Claude review requested for current head ac9d419.

All required checks are green: branch-policy, existing .NET build, and the new Node 22 job. Local verification is recorded in the PR body; the package contains dist/focusrgb-node-runner.js exactly where the Windows host resolves it.

Assisted-by: OpenAI Codex

@MAJ224

MAJ224 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor Author

Decided 2026-10-21: Node and Python SDKs are deferred until after SignalRGB independence (FocusRGB#55) under #8. This PR is parked as a draft; leave its branch intact and rebase it when #8 starts. Do not merge from the current review state.

Assisted-by: OpenAI Codex

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant