@skyvexsoftware/stratos-sdk 0.1.1 → 0.1.3

package/README.md

@@ -4,18 +4,20 @@ The Stratos Plugin SDK provides typed access to shell APIs, shared UI components
 
 ## Installation
 
-**External plugin developers (npm):**
-
 ```bash
-npm install @skyvexsoftware/stratos-sdk
+pnpm add @skyvexsoftware/stratos-sdk
 ```
 
-**Within the Stratos monorepo (workspace):**
+## Getting Started
+
+Scaffold a new plugin project:
 
 ```bash
-pnpm add @skyvexsoftware/stratos-sdk --workspace
+pnpx create-stratos-plugin
 ```
 
+Or manually create a project with `plugin.json`, `vite.config.ts`, and `src/ui/index.tsx`. See the [plugin developer guide](https://skyvexsoftware.com/docs/plugins) for details.
+
 ## Available APIs
 
 ### Plugin Contract Types
@@ -32,6 +34,22 @@ import type {
 } from "@skyvexsoftware/stratos-sdk";
 ```
 
+### Vite Plugin Config
+
+The SDK provides a shared Vite configuration for building plugins:
+
+```ts
+import { createPluginConfig } from "@skyvexsoftware/stratos-sdk/vite";
+
+export default createPluginConfig({
+  pluginDir: import.meta.dirname,
+  ui: { entry: "src/ui/index.tsx" },
+  background: { entry: "src/background/index.ts" }, // optional
+});
+```
+
+This handles UI bundling with externals, background module builds, asset copying, dev server auto-connect, and HMR.
+
 ### Helper Functions
 
 #### `createPlugin(module)`
@@ -109,14 +127,14 @@ function DetailPage() {
 
 Access shell services from plugin components. All hooks must be used within a `PluginShellProvider` (provided by the shell at runtime).
 
-| Hook                 | Returns              | Description                    |
-| -------------------- | -------------------- | ------------------------------ |
-| `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    |
-| `usePluginContext()` | Full PluginUIContext | All of the above combined      |
+| Hook                   | Returns              | Description                    |
+| ---------------------- | -------------------- | ------------------------------ |
+| `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    |
+| `usePluginContext()`   | Full PluginUIContext | All of the above combined      |
 
 ```tsx
 import { useShellAuth, useShellToast } from "@skyvexsoftware/stratos-sdk";
@@ -174,7 +192,7 @@ cn("bg-red-500", conditional && "text-white", className);
 
 ## Peer Dependencies
 
-The SDK expects these to be provided by the shell at runtime:
+The SDK expects these to be provided by the Stratos shell at runtime:
 
 - `react` ^19.0.0
 - `@radix-ui/react-*` (dialog, label, select, separator, slot, tabs, tooltip)
@@ -183,19 +201,6 @@ The SDK expects these to be provided by the shell at runtime:
 - `lucide-react` >=0.300.0
 - `socket.io-client` ^4.0.0
 
-## Publishing
-
-The SDK is published to npm as `@skyvexsoftware/stratos-sdk` directly from the monorepo.
-
-```bash
-pnpm build:sdk                                        # compile TypeScript to dist/
-pnpm --filter @skyvexsoftware/stratos-sdk publish      # publish to npm
-```
+## License
 
-The published package contains only the `dist/` folder (compiled JS + declaration files). Locally in the monorepo, pnpm's `workspace:*` protocol resolves to the source files via TypeScript project references.
-
-To inspect what would be published without actually publishing:
-
-```bash
-pnpm --filter @skyvexsoftware/stratos-sdk pack
-```
+MIT

package/dist/vite/plugin-config.d.ts

@@ -16,7 +16,7 @@
  *   });
  */
 import type { Plugin, UserConfig } from "vite";
-import { UI_EXTERNALS } from "./externals";
+import { UI_EXTERNALS } from "./externals.js";
 /** Modules external in background builds (available in Electron main process) */
 declare const BG_EXTERNALS: string[];
 /**

package/dist/vite/plugin-config.js

@@ -18,9 +18,9 @@
 import * as fs from "fs";
 import * as path from "path";
 import react from "@vitejs/plugin-react";
-import { UI_EXTERNALS } from "./externals";
-import { serveExternals } from "./serve-externals";
-import { stratosDevServer } from "./stratos-dev-server";
+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",

package/dist/vite/serve-externals.js

@@ -1,4 +1,4 @@
-import { UI_EXTERNALS } from "./externals";
+import { UI_EXTERNALS } from "./externals.js";
 const EXTERNAL_PACKAGES = [
     ...UI_EXTERNALS,
     "react/jsx-runtime",

package/package.json

@@ -1,12 +1,21 @@
 {
   "name": "@skyvexsoftware/stratos-sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Plugin SDK for Stratos — types, hooks, and UI components",
   "author": {
     "name": "Skyvex Software",
     "email": "jordan@skyvexsoftware.com"
   },
   "license": "MIT",
+  "homepage": "https://skyvexsoftware.com",
+  "keywords": [
+    "stratos",
+    "plugin",
+    "sdk",
+    "flight-sim",
+    "acars",
+    "simconnect"
+  ],
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",