@skyvexsoftware/stratos-sdk 0.13.1 → 0.14.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, 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";

package/dist/types/context.d.ts

@@ -201,6 +201,32 @@ export type PluginToastInput = {
 };
 /** Fixed shell-bundled sound catalogue. No plugin-supplied audio. */
 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 +346,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/package.json

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