@skyvexsoftware/stratos-sdk 0.1.9 → 0.1.11

package/README.md

@@ -42,7 +42,7 @@ my-plugin/
 │   │   ├── index.tsx     # UI entry (default export: React component)
 │   │   └── global.css    # Tailwind CSS
 │   └── background/       # Optional: main process module
-│       └── index.ts      # Exports onStart(ctx) and onStop()
+│       └── index.ts      # export default createPlugin({...})
 └── assets/
     ├── icon-light.svg    # Sidebar icon (dark theme)
     └── icon-dark.svg     # Sidebar icon (light theme)
@@ -77,7 +77,7 @@ The `vite` option accepts any Vite config to merge in (plugins, resolve, css, et
 
 ## Plugin Manifest
 
-`plugin.json` defines your plugin's metadata:
+`plugin.json` defines your plugin's metadata. Background modules don't need manifest configuration — the shell discovers them automatically if `background/index.js` exists in the built output.
 
 ```json
 {
@@ -87,7 +87,7 @@ The `vite` option accepts any Vite config to merge in (plugins, resolve, css, et
   "name": "My Plugin",
   "version": "0.1.0",
   "description": "A Stratos plugin",
-  "author": { "id": "my-org", "name": "My Organization" },
+  "author": { "id": "my-org", "name": "My Organisation" },
   "icon_light": "icon-light.svg",
   "icon_dark": "icon-dark.svg"
 }
@@ -110,7 +110,7 @@ function MyComponent() {
     pluginId,
     auth,        // { isAuthenticated, token, user }
     airline,     // { id, name, icao, logo_light, logo_dark }
-    config,      // { get(key, defaultValue) }
+    config,      // { get(key, defaultValue?) } — airline-scoped settings
     navigation,  // { navigateTo, navigateToPlugin, navigateToShell }
     toast,       // { success, error, info, warning }
     logger,      // { info, warn, error, debug }
@@ -120,84 +120,90 @@ function MyComponent() {
 
 Individual hooks are also available:
 
-| Hook                   | Returns              | Description                    |
-| ---------------------- | -------------------- | ------------------------------ |
-| `usePluginContext()`   | Full PluginUIContext | All services combined          |
-| `useShellAuth()`       | Auth state           | Authentication state and token |
-| `useShellConfig()`     | Config store         | Scoped configuration access    |
-| `useShellNavigation()` | Navigation helpers   | Route navigation utilities     |
-| `useShellToast()`      | Toast API            | Toast/notification functions   |
-| `usePluginLogger()`    | Logger               | Scoped renderer-side logger    |
+| Hook                   | Description                                    |
+| ---------------------- | ---------------------------------------------- |
+| `usePluginContext()`   | All shell services combined                    |
+| `useSimData()`         | Real-time simulator data (RAF-throttled)       |
+| `useFlightPhase()`     | Current flight phase with selector support     |
+| `useFlightEvents()`    | Flight event log with comment mutations        |
+| `useFlightManager()`   | Low-level flight lifecycle control             |
+| `useTrackingSession()` | High-level tracking state with derived fields  |
+| `useLandingAnalysis()` | Landing rate, bounces, and settled analysis    |
+| `useShellAuth()`       | Authentication state and token                 |
+| `useShellConfig()`     | Scoped configuration access                    |
+| `useShellNavigation()` | Route navigation utilities                     |
+| `useShellToast()`      | Toast/notification functions                   |
+| `usePluginLogger()`    | Scoped renderer-side logger                    |
 
 ### Background Module
 
-Optional main-process code with access to IPC, Express routes, SQLite, and more:
+Optional main-process code with access to IPC, Express routes, SQLite, and more. Must use the `createPlugin` helper (imported from the `/helpers` subpath) with a default export:
 
 ```ts
-import { createPlugin } from "@skyvexsoftware/stratos-sdk";
+import { createPlugin } from "@skyvexsoftware/stratos-sdk/helpers";
 
 export default createPlugin({
   async onStart(ctx) {
-    // ctx.logger  — scoped logger
-    // ctx.config  — per-plugin config store
-    // ctx.ipc     — IPC handler registration
-    // ctx.auth    — read-only auth token access
-    // ctx.server  — Express router registration
+    // ctx.logger   — scoped logger
+    // ctx.config   — per-plugin config store (async)
+    // ctx.ipc      — IPC handler registration
+    // ctx.auth     — read-only auth token access (async)
+    // ctx.server   — Express router registration
     // ctx.database — SQLite database access
     ctx.logger.info("MyPlugin", "Started");
   },
-  async onStop() {
-    // cleanup
+  async onStop(ctx) {
+    ctx.logger.info("MyPlugin", "Stopped");
   },
 });
 ```
 
-### Routing
+Named exports are not supported — the shell requires the `createPlugin` default export pattern for type safety and validation.
 
-For multi-page plugins, use `PluginRouter`:
-
-```tsx
-import { PluginRouter } from "@skyvexsoftware/stratos-sdk";
+### UI Components
 
-const routes = [
-  { path: "home", component: HomePage },
-  { path: "settings", component: SettingsPage },
-  { path: "detail/:id", component: DetailPage },
-];
+Pre-styled shadcn/ui components that match the Stratos design system:
 
-export default function Plugin() {
-  return <PluginRouter routes={routes} defaultPath="home" />;
-}
+```tsx
+import { Button, Card, CardContent, Input, Dialog } from "@skyvexsoftware/stratos-sdk";
 ```
 
-For single-page plugins, just export the component directly.
+Available: Button, Card, Dialog, Input, Label, Select, Badge, Separator, Tabs, Tooltip, AlertDialog, RadioGroup, Slider, Switch, Textarea.
 
-### UI Components
+### Icons
 
-Pre-styled shadcn/ui components that match the Stratos design system:
+The full [Lucide](https://lucide.dev) icon set is available via `STRATOS_ICONS`:
 
 ```tsx
-import { Button, Card, CardContent, Input, Dialog } from "@skyvexsoftware/stratos-sdk";
+import { STRATOS_ICONS, STRATOS_ICON_NAMES } from "@skyvexsoftware/stratos-sdk";
+
+const Icon = STRATOS_ICONS["Helicopter"];
 ```
 
-Available: Button, Card, Dialog, Input, Label, Select, Badge, Separator, Tabs, Tooltip, AlertDialog, RadioGroup, Slider, Switch, Textarea.
+Or import icons directly from `lucide-react` in your plugin.
 
 ### Types
 
 ```ts
-import { FlightPhase, SimulatorType } from "@skyvexsoftware/stratos-sdk";
+import { FlightPhase, EventCategory } from "@skyvexsoftware/stratos-sdk";
 import type { FlightData, PluginManifest, PluginContext } from "@skyvexsoftware/stratos-sdk";
 ```
 
 ### Utilities
 
 ```ts
-import { cn } from "@skyvexsoftware/stratos-sdk";
-
 // Tailwind class merging
+import { cn } from "@skyvexsoftware/stratos-sdk";
 cn("bg-red-500", isActive && "text-white", className);
+
+// Unit conversion helpers
+import { weightFromLbs, formatAltitude } from "@skyvexsoftware/stratos-sdk/helpers";
 ```
 
-## License
+## Documentation
+
+Full documentation is available at [docs.skyvexsoftware.com](https://docs.skyvexsoftware.com).
+
+## Licence
 
 MIT

package/dist/helpers/createPlugin.d.ts

@@ -6,7 +6,7 @@ import type { PluginBackgroundModule } from "../types/module";
  *
  * @example
  * ```ts
- * import { createPlugin } from "@skyvexsoftware/stratos-sdk";
+ * import { createPlugin } from "@skyvexsoftware/stratos-sdk/helpers";
  *
  * export default createPlugin({
  *   async onStart(ctx) {

package/dist/helpers/createPlugin.js

@@ -5,7 +5,7 @@
  *
  * @example
  * ```ts
- * import { createPlugin } from "@skyvexsoftware/stratos-sdk";
+ * import { createPlugin } from "@skyvexsoftware/stratos-sdk/helpers";
  *
  * export default createPlugin({
  *   async onStart(ctx) {

package/dist/vite/plugin-config.js

@@ -21,11 +21,7 @@ import { UI_EXTERNALS } from "./externals.js";
 import { serveExternals } from "./serve-externals.js";
 import { stratosDevServer } from "./stratos-dev-server.js";
 /** Modules external in background builds (available in Electron main process) */
-const BG_EXTERNALS = [
-    "electron",
-    "@skyvexsoftware/stratos-sdk",
-    "socket.io-client",
-];
+const BG_EXTERNALS = ["electron", "socket.io-client"];
 /** Node.js built-in modules to externalize in background builds */
 const NODE_BUILTINS = [
     "assert",
@@ -238,11 +234,18 @@ function createBackgroundConfig(pluginDir, entry) {
                 fileName: () => "index.js",
             },
             rollupOptions: {
-                external: [
-                    ...BG_EXTERNALS,
-                    ...NODE_BUILTINS,
-                    ...NODE_BUILTINS.map((b) => `node:${b}`),
-                ],
+                external: (id) => {
+                    // Bundle the SDK helpers subpath (createPlugin) into the output
+                    if (id === "@skyvexsoftware/stratos-sdk/helpers")
+                        return false;
+                    if (id === "@skyvexsoftware/stratos-sdk")
+                        return true;
+                    if (BG_EXTERNALS.some((ext) => id === ext || id.startsWith(`${ext}/`)))
+                        return true;
+                    if (NODE_BUILTINS.some((b) => id === b || id === `node:${b}`))
+                        return true;
+                    return false;
+                },
             },
             sourcemap: !isProduction,
             minify: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyvexsoftware/stratos-sdk",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Plugin SDK for Stratos — types, hooks, and UI components",
   "author": {
     "name": "Skyvex Software",
@@ -72,11 +72,11 @@
     "@radix-ui/react-tabs": "^1.1.0",
     "@radix-ui/react-tooltip": "^1.1.0",
     "@tanstack/react-query": "^5.0.0",
+    "@vitejs/plugin-react": "^5.0.0",
     "class-variance-authority": "^0.7.0",
     "lucide-react": ">=0.300.0",
     "react": "^19.0.0",
     "socket.io-client": "^4.0.0",
-    "@vitejs/plugin-react": "^5.0.0",
     "vite": "^7.0.0"
   },
   "dependencies": {
@@ -96,9 +96,9 @@
     "@radix-ui/react-tabs": "^1.1.8",
     "@radix-ui/react-tooltip": "^1.1.12",
     "@types/react": "^19.1.2",
-    "class-variance-authority": "^0.7.1",
-    "lucide-react": "^0.503.0",
     "@vitejs/plugin-react": "^5.1.4",
+    "class-variance-authority": "^0.7.1",
+    "lucide-react": "^0.577.0",
     "socket.io-client": "^4.8.3",
     "typescript": "^5.8.3",
     "vite": "^7.3.1"