@skyvexsoftware/stratos-sdk 0.13.1 → 0.15.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export type { PluginAuthor, PluginManifest } from "./types/manifest";
-export type { PluginAirline, PluginAirlineAccessor, PluginAuthAccessor, PluginVaApiClient, PluginConfigStore, PluginContext, PluginDatabaseAccessor, PluginIPCRegistrar, PluginLogger, PluginServerRegistrar, PluginFlightAccessor, PluginFlightLogWriter, PluginFlightLogInput, PluginFlightLogPatch, PluginStartGuard, PluginStartContext, PluginStartDecision, PluginNotifier, PluginToastInput, PluginAlertSound, PluginDialogApi, PluginPromptApi, PluginDialogAlertInput, PluginDialogConfirmInput, PluginPromptTextInput, PluginPromptNumberInput, PluginPromptSelectInput, } from "./types/context";
+export type { PluginAirline, PluginAirlineAccessor, PluginAuthAccessor, PluginVaApiClient, PluginConfigStore, PluginContext, PluginDatabaseAccessor, PluginIPCRegistrar, PluginLogger, PluginServerRegistrar, PluginFlightAccessor, PluginFlightLogWriter, PluginFlightLogInput, PluginFlightLogPatch, PluginStartGuard, PluginStartContext, PluginStartDecision, PluginNotifier, PluginToastInput, BuiltInSound, PluginAlertSound, PluginDialogApi, PluginPromptApi, PluginDialogAlertInput, PluginDialogConfirmInput, PluginPromptTextInput, PluginPromptNumberInput, PluginPromptSelectInput, PluginIndicatorType, PluginIndicatorInput, PluginSelfApi, } from "./types/context";
 export type { PluginNavigationHelper, PluginPilotUser, PluginToastAPI, PluginUIContext, } from "./types/context-ui";
 export type { PluginSettingType, PluginSettingOption, PluginSettingDefinition, PluginAvailableSettings, BooleanSettingDef, TextSettingDef, LongtextSettingDef, NumberSettingDef, RangeSettingDef, ListSettingDef, RadioSettingDef, DateSettingDef, JsonSettingDef, } from "./types/settings";
 export type { PluginBackgroundModule, PluginRouteComponent, PluginUIModule, } from "./types/module";
@@ -34,7 +34,7 @@ export { useShellNavigation } from "./hooks/useShellNavigation";
 export { useShellToast } from "./hooks/useShellToast";
 export { useSocket, useSimulatorData, useProtocolUrl, useNotifications, useSystemMetrics, } from "./hooks/useSimulatorData";
 export { SOCKET_EVENTS } from "./shared-types/socket-events";
-export type { AutoStartConfirmPayload, ConnectionState, LogEntryPayload, NotificationPayload, ProtocolUrlPayload, SimulatorDataPayload, SimulatorStatusPayload, SocketEventName, SystemMetricsPayload, } from "./shared-types/socket-events";
+export type { AutoStartConfirmPayload, ConnectionState, LogEntryPayload, NotificationPayload, ProtocolUrlPayload, SimulatorDataPayload, SimulatorStatusPayload, SocketEventName, SoundPayload, SystemMetricsPayload, } from "./shared-types/socket-events";
 export type { PluginDialogKind, PluginDialogSelectOption, PluginDialogSpec, PluginDialogResult, PluginDialogClosePayload, } from "./shared-types/plugin-dialogs";
 export { AlertDialog, AlertDialogPortal, AlertDialogOverlay, AlertDialogTrigger, AlertDialogContent, AlertDialogHeader, AlertDialogFooter, AlertDialogTitle, AlertDialogDescription, AlertDialogAction, AlertDialogCancel, Badge, badgeVariants, Button, buttonVariants, Card, CardAction, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Combobox, Dialog, DialogClose, DialogContent, DialogDescription, DialogFooter, DialogHeader, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, Input, Label, Popover, PopoverAnchor, PopoverContent, PopoverTrigger, RadioGroup, RadioGroupItem, Select, SelectContent, SelectGroup, SelectItem, SelectLabel, SelectScrollDownButton, SelectScrollUpButton, SelectSeparator, SelectTrigger, SelectValue, Separator, Slider, Switch, Tabs, TabsContent, TabsList, TabsTrigger, Textarea, Tooltip, TooltipContent, TooltipProvider, TooltipTrigger, } from "./ui";
 export type { BadgeProps, ButtonProps, ComboboxOption, ComboboxProps, } from "./ui";

package/dist/shared-types/index.d.ts

@@ -8,6 +8,6 @@ export { ADDITIONAL_FIELD_PHASES, toPhaseKey } from "./additional-fields";
 export type { AdditionalFieldsConfig, FieldDelivery, } from "./additional-fields";
 export type { FlightPlan, FlightStatus, CurrentFlight, FlightComment, PreflightCheck, PreflightCheckResult, StartFlightOptions, FlightManagerPayload, StartFlightResult, RecoverableFlight, } from "./flight-manager";
 export { SOCKET_EVENTS } from "./socket-events";
-export type { ConnectionState, LogEntryPayload, NotificationPayload, ProtocolUrlPayload, SimulatorDataPayload, SimulatorStatusPayload, SocketEventName, SystemMetricsPayload, } from "./socket-events";
+export type { ConnectionState, LogEntryPayload, NotificationPayload, ProtocolUrlPayload, SimulatorDataPayload, SimulatorStatusPayload, SocketEventName, SoundPayload, SystemMetricsPayload, } from "./socket-events";
 export type { PluginDialogKind, PluginDialogSelectOption, PluginDialogSpec, PluginDialogResult, PluginDialogClosePayload, } from "./plugin-dialogs";
 //# sourceMappingURL=index.d.ts.map

package/dist/shared-types/socket-events.d.ts

@@ -60,7 +60,7 @@ export declare const SOCKET_EVENTS: {
     readonly SYSTEM_METRICS: "system:metrics";
     /** Toast / notification push. Payload: NotificationPayload */
     readonly NOTIFICATION: "notification";
-    /** Play a sound in the renderer. Payload: { name: string } */
+    /** Play a sound in the renderer. Payload: SoundPayload */
     readonly SOUND: "sound";
     /** Flight lifecycle state change. Payload: FlightManagerPayload */
     readonly FLIGHT_MANAGER: "flight:manager";
@@ -138,6 +138,18 @@ export type NotificationPayload = {
     /** Stable ID for deduplication — toasts with the same ID replace each other. */
     id?: string;
 };
+/**
+ * Payload for `sound` events.
+ *
+ * Either a built-in shell sound (by `name`) or a plugin-bundled sound asset
+ * (`pluginId` + plugin-root-relative `path`, served via /api/plugin-files).
+ */
+export type SoundPayload = {
+    name: string;
+} | {
+    pluginId: string;
+    path: string;
+};
 /**
  * Payload for `system:metrics` events.
  *

package/dist/shared-types/socket-events.js

@@ -34,7 +34,7 @@ export const SOCKET_EVENTS = {
     // Notification events
     /** Toast / notification push. Payload: NotificationPayload */
     NOTIFICATION: "notification",
-    /** Play a sound in the renderer. Payload: { name: string } */
+    /** Play a sound in the renderer. Payload: SoundPayload */
     SOUND: "sound",
     // Flight manager events
     /** Flight lifecycle state change. Payload: FlightManagerPayload */

package/dist/types/context.d.ts

@@ -188,7 +188,20 @@ export type PluginStartGuard = (ctx: PluginStartContext) => PluginStartDecision
 export type PluginNotifier = {
     /** Show a toast in the renderer. */
     toast(n: PluginToastInput): Promise<void>;
-    /** Play a shell-bundled sound by name (no plugin-supplied audio). */
+    /** Play a built-in shell sound by name. */
+    playSound(name: BuiltInSound): Promise<void>;
+    /**
+     * Play a sound file bundled inside this plugin. `assetPath` is relative to
+     * the plugin root (e.g. "assets/DepGateAlert.wav"). Anything under the
+     * plugin's `assets/` directory is shipped with the plugin automatically.
+     * Obeys the user's notification-sound setting. Allowed file types: wav, mp3,
+     * ogg, m4a, aac.
+     */
+    playCustomSound(assetPath: string): Promise<void>;
+    /**
+     * @deprecated Use {@link PluginNotifier.playSound}. Retained for back-compat;
+     * legacy names (`alert`/`warning`/`chime`) now map onto a real bundled file.
+     */
     sound(name: PluginAlertSound): Promise<void>;
 };
 /** Input for `ctx.notify.toast`. */
@@ -199,8 +212,36 @@ export type PluginToastInput = {
     durationMs?: number;
     id?: string;
 };
-/** Fixed shell-bundled sound catalogue. No plugin-supplied audio. */
+/** Built-in shell sound catalogue. Semantic names mapped to bundled files by the shell. */
+export type BuiltInSound = "attention" | "error" | "success";
+/** @deprecated Use {@link BuiltInSound} with `playSound`. */
 export type PluginAlertSound = "alert" | "warning" | "error" | "success" | "chime";
+/** Visual style of a plugin's sidebar indicator. */
+export type PluginIndicatorType = "notification" | "warning";
+/** Input for `ctx.plugin.setIndicator`. */
+export type PluginIndicatorInput = {
+    /** A passive dot ("notification") or an amber warning triangle ("warning"). */
+    type: PluginIndicatorType;
+    /** Optional hover text shown on the indicator. When omitted, the indicator has no tooltip. */
+    tooltip?: string;
+    /**
+     * When true, the indicator clears automatically the first time the user
+     * opens this plugin. Defaults to false — it otherwise persists until
+     * `clearIndicator()` or a shell restart.
+     */
+    dismissOnOpen?: boolean;
+};
+/**
+ * A plugin's control over its own presence in the shell. Backs `ctx.plugin`.
+ * Today: the sidebar indicator. The `error` style is reserved for the system
+ * (a crashed plugin) and always takes precedence over a plugin-set indicator.
+ */
+export type PluginSelfApi = {
+    /** Set (or replace) this plugin's sidebar indicator. */
+    setIndicator(indicator: PluginIndicatorInput): Promise<void>;
+    /** Remove this plugin's sidebar indicator, if any. */
+    clearIndicator(): Promise<void>;
+};
 /** Input for `ctx.dialog.alert`. */
 export type PluginDialogAlertInput = {
     title: string;
@@ -320,5 +361,7 @@ export type PluginContext = {
     dialog: PluginDialogApi;
     /** Blocking, awaited input prompts (text/number/select). */
     prompt: PluginPromptApi;
+    /** Control this plugin's own shell presence (e.g. the sidebar indicator). */
+    plugin: PluginSelfApi;
 };
 //# sourceMappingURL=context.d.ts.map

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 export type { PluginAuthor, PluginManifest } from "./manifest";
-export type { PluginAirline, PluginAirlineAccessor, PluginAuthAccessor, PluginConfigStore, PluginContext, PluginDatabaseAccessor, PluginIPCRegistrar, PluginLogger, PluginServerRegistrar, PluginFlightAccessor, PluginFlightLogWriter, PluginFlightLogInput, PluginFlightLogPatch, PluginStartGuard, PluginStartContext, PluginStartDecision, PluginNotifier, PluginToastInput, PluginAlertSound, } from "./context";
+export type { PluginAirline, PluginAirlineAccessor, PluginAuthAccessor, PluginConfigStore, PluginContext, PluginDatabaseAccessor, PluginIPCRegistrar, PluginLogger, PluginServerRegistrar, PluginFlightAccessor, PluginFlightLogWriter, PluginFlightLogInput, PluginFlightLogPatch, PluginStartGuard, PluginStartContext, PluginStartDecision, PluginNotifier, PluginToastInput, BuiltInSound, PluginAlertSound, } from "./context";
 export type { PluginNavigationHelper, PluginToastAPI, PluginUIContext, } from "./context-ui";
 export type { PluginBackgroundModule, PluginRouteComponent, PluginUIModule, } from "./module";
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyvexsoftware/stratos-sdk",
-  "version": "0.13.1",
+  "version": "0.15.0",
   "description": "Plugin SDK for Stratos — types, hooks, and UI components",
   "author": {
     "name": "Skyvex Software Pty Ltd",