fluxplugin 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) fluxplugin contributors
+
+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,50 @@
+# fluxplugin
+
+Plugin architecture for **Electron + React + TypeScript**. Build an app that others can extend — pages, menus,
+commands, UI slots, IPC, hooks, permissions, hot reload — and manage plugins with a CLI. One package, like `react`.
+
+```bash
+npm create fluxplugin@latest my-app      # or: npx fluxplugin init my-app
+cd my-app && npm install
+npm run dev:web        # browser mode, no Electron needed
+npm run dev            # Electron, plugins hot-reload
+npm run plugin:new orders -- -t backend   # scaffold a plugin in ./plugins
+npm run build && npm start
+```
+
+## Package map (one install: `npm i fluxplugin`)
+| import | runs in | contents |
+|---|---|---|
+| `fluxplugin` | main + renderer | `definePlugin`, `defineIPC`, `s` schemas, `PluginManager`, registries, types |
+| `fluxplugin/main` | Electron main | `MainFramework`, discovery, signatures, installer/registries, `attachElectron`, `serveWeb` |
+| `fluxplugin/preload` | preload | `exposeFluxBridge` (sandbox-safe) |
+| `fluxplugin/react` | renderer | `PluginProvider`, `PluginSlot`, `PluginRoutes`, hooks, `StyleHost`, `CommandPalette` |
+| `fluxplugin/manager-ui` | renderer | ready-made Plugin Manager screen |
+| `fluxplugin/cli` | node | programmatic CLI (`run`, `buildHost`, scaffolds) |
+
+CLI (`npx fluxplugin`): `init`, `dev [--web]`, `build`, `start`, `plugin new`, `validate`, `package [--sign-key]`,
+`install`, `uninstall`, `enable`, `disable`, `list`, `keygen`, `tailwind`.
+
+## A plugin in 20 lines
+```ts
+// src/main.ts                                   // src/renderer.tsx
+import { definePlugin, defineIPC, s } from "fluxplugin";  import { definePlugin } from "fluxplugin";
+export default definePlugin({                      import { usePluginIPC } from "fluxplugin/react";
+  ipc: [defineIPC({ name: "orders.count",          const Page = () => { const { data, call } = usePluginIPC("orders.count");
+    output: s.object({ n: s.number() }),             return <button onClick={() => call()}>{data?.n ?? "load"}</button>; };
+    handler: () => ({ n: 3 }) })],                 export default definePlugin({ routes: [{ path: "/orders", component: Page,
+  preload: { orders: { count: "orders.count" } },    meta: { title: "Orders", menu: { label: "Orders" } } }] });
+});
+```
+More: [ARCHITECTURE](docs/ARCHITECTURE.md) · [SECURITY](docs/SECURITY.md) · [PLUGIN-AUTHORS](docs/PLUGIN-AUTHORS.md) · [RELEASE](docs/RELEASE.md)
+
+## Status — read this
+* **Verified:** 121 automated tests; typecheck strict; the packed tarball installed into a *freshly generated app*
+  (`init` → `npm install` → typecheck → `build` → run in browser mode); a Playwright E2E against that app with
+  3 plugins (menus, slots, extension points, hooks, validated IPC, push events, live enable/disable, palette, manager UI);
+  `plugin new` + `build` hot-loads into a running app.
+* **Not verified:** a real Electron binary (unavailable in the build sandbox). `main.ts`/`preload.ts` templates and
+  `attachElectron` follow the Electron API and are tested against fakes — expect small adjustments on first `npm run dev`.
+* **Not published:** the package is not on npm. Run the steps in `docs/RELEASE.md`; check the name is free first.
+* **Security:** plugin `main` code is not sandboxed (permissions are an API contract). Read `docs/SECURITY.md`.
+* **Not done:** per-plugin process isolation, hosted marketplace (only the `PluginRegistry` abstraction + local/HTTP), Tailwind wiring in the starter.