@stina/extension-api 1.16.0 → 1.18.0

package/dist/{types.tools-CK0As7KV.d.cts → types.tools-D_srSS_m.d.cts}

@@ -162,14 +162,14 @@ interface ExtensionPanelDefinition {
 interface HeaderProps extends ExtensionComponentData {
     component: 'Header';
     level: number;
-    title: string;
-    description?: string | string[];
+    title: LocalizedString;
+    description?: LocalizedString | LocalizedString[];
     icon?: HugeIconName;
 }
 /** The extension API properties for the Label component. */
 interface LabelProps extends ExtensionComponentData {
     component: 'Label';
-    text: string;
+    text: LocalizedString;
 }
 /**
  * The extension API properties for the Clock component.
@@ -186,40 +186,40 @@ interface ClockProps extends ExtensionComponentData {
 /** The extension API properties for the paragraph component. */
 interface ParagraphProps extends ExtensionComponentData {
     component: 'Paragraph';
-    text: string;
+    text: LocalizedString;
 }
 /** The extension API properties for the Button component. */
 interface ButtonProps extends ExtensionComponentData {
     component: 'Button';
-    text: string;
+    text: LocalizedString;
     /** Visual style. Defaults to "normal". */
     type?: 'normal' | 'primary' | 'danger' | 'accent';
     /** Optional tooltip shown on hover. */
-    title?: string;
+    title?: LocalizedString;
     disabled?: boolean;
     onClickAction: ExtensionActionRef;
 }
 /** The extension API properties for the TextInput component. */
 interface TextInputProps extends ExtensionComponentData {
     component: 'TextInput';
-    label: string;
-    placeholder?: string;
+    label: LocalizedString;
+    placeholder?: LocalizedString;
     value?: string;
     onChangeAction?: ExtensionActionRef;
 }
 /** The extension API properties for the PasswordInput component. */
 interface PasswordInputProps extends ExtensionComponentData {
     component: 'PasswordInput';
-    label: string;
-    placeholder?: string;
+    label: LocalizedString;
+    placeholder?: LocalizedString;
     value?: string;
     onChangeAction?: ExtensionActionRef;
 }
 /** The extension API properties for the NumberInput component. */
 interface NumberInputProps extends ExtensionComponentData {
     component: 'NumberInput';
-    label: string;
-    placeholder?: string;
+    label: LocalizedString;
+    placeholder?: LocalizedString;
     value?: string | number;
     /** Optional minimum value. */
     min?: number;
@@ -232,8 +232,8 @@ interface NumberInputProps extends ExtensionComponentData {
 /** The extension API properties for the TextArea component. */
 interface TextAreaProps extends ExtensionComponentData {
     component: 'TextArea';
-    label: string;
-    placeholder?: string;
+    label: LocalizedString;
+    placeholder?: LocalizedString;
     value?: string;
     /** Number of visible text rows. Defaults to 4. */
     rows?: number;
@@ -242,16 +242,16 @@ interface TextAreaProps extends ExtensionComponentData {
 /** The extension API properties for the DateTimeInput component. */
 interface DateTimeInputProps extends ExtensionComponentData {
     component: 'DateTimeInput';
-    label: string;
+    label: LocalizedString;
     value?: string;
     onChangeAction?: ExtensionActionRef;
 }
 /** The extension API properties for the Select component. */
 interface SelectProps extends ExtensionComponentData {
     component: 'Select';
-    label: string;
+    label: LocalizedString;
     options: Array<{
-        label: string;
+        label: LocalizedString;
         value: string;
     }>;
     selectedValue?: string;
@@ -260,7 +260,7 @@ interface SelectProps extends ExtensionComponentData {
 /** The extension API properties for the IconPicker component. */
 interface IconPickerProps extends ExtensionComponentData {
     component: 'IconPicker';
-    label?: string;
+    label?: LocalizedString;
     value?: string;
     onChangeAction?: ExtensionActionRef;
 }
@@ -291,7 +291,7 @@ interface DividerProps extends ExtensionComponentData {
 interface IconProps extends ExtensionComponentData {
     component: 'Icon';
     name: HugeIconName;
-    title?: string;
+    title?: LocalizedString;
 }
 /** Button type for IconButton. */
 type IconButtonType = 'normal' | 'primary' | 'danger' | 'accent';
@@ -299,7 +299,7 @@ type IconButtonType = 'normal' | 'primary' | 'danger' | 'accent';
 interface IconButtonProps extends ExtensionComponentData {
     component: 'IconButton';
     icon: HugeIconName;
-    tooltip: string;
+    tooltip: LocalizedString;
     active?: boolean;
     disabled?: boolean;
     type?: IconButtonType;
@@ -308,15 +308,15 @@ interface IconButtonProps extends ExtensionComponentData {
 /** Action button definition for Panel component. */
 interface PanelAction {
     icon: HugeIconName;
-    tooltip: string;
+    tooltip: LocalizedString;
     action: ExtensionActionRef;
     type?: IconButtonType;
 }
 /** The extension API properties for the Panel component. */
 interface PanelProps extends ExtensionComponentData {
     component: 'Panel';
-    title: string;
-    description?: string | string[];
+    title: LocalizedString;
+    description?: LocalizedString | LocalizedString[];
     icon?: HugeIconName;
     actions?: PanelAction[];
     content?: ExtensionComponentData;
@@ -324,8 +324,8 @@ interface PanelProps extends ExtensionComponentData {
 /** The extension API properties for the Toggle component. */
 interface ToggleProps extends ExtensionComponentData {
     component: 'Toggle';
-    label?: string;
-    description?: string;
+    label?: LocalizedString;
+    description?: LocalizedString;
     checked?: boolean;
     disabled?: boolean;
     onChangeAction?: ExtensionActionRef;
@@ -334,9 +334,9 @@ interface ToggleProps extends ExtensionComponentData {
 interface CollapsibleProps extends ExtensionComponentData {
     component: 'Collapsible';
     /** Title displayed in the header. */
-    title: string;
+    title: LocalizedString;
     /** Optional description rendered under the title. */
-    description?: string | string[];
+    description?: LocalizedString | LocalizedString[];
     /** Optional icon shown to the left of the title. */
     icon?: HugeIconName;
     /** Whether the section is expanded by default. */
@@ -350,7 +350,7 @@ type PillVariant = 'default' | 'primary' | 'success' | 'warning' | 'danger' | 'a
 interface PillProps extends ExtensionComponentData {
     component: 'Pill';
     /** Text to display in the pill. */
-    text: string;
+    text: LocalizedString;
     /** Optional icon shown to the left of the text. */
     icon?: HugeIconName;
     /** Color variant. Defaults to 'default'. */
@@ -360,7 +360,7 @@ interface PillProps extends ExtensionComponentData {
 interface CheckboxProps extends ExtensionComponentData {
     component: 'Checkbox';
     /** Label text displayed next to the checkbox. */
-    label: string;
+    label: LocalizedString;
     /** Whether the checkbox is checked. */
     checked?: boolean;
     /** Whether the checkbox is disabled. */
@@ -374,7 +374,7 @@ interface CheckboxProps extends ExtensionComponentData {
 interface MarkdownProps extends ExtensionComponentData {
     component: 'Markdown';
     /** Markdown content to render. */
-    content: string;
+    content: LocalizedString;
 }
 /** The extension API properties for the TextPreview component. */
 interface TextPreviewProps extends ExtensionComponentData {
@@ -388,7 +388,7 @@ interface TextPreviewProps extends ExtensionComponentData {
 interface ModalProps extends ExtensionComponentData {
     component: 'Modal';
     /** Title displayed in the modal header. */
-    title: string;
+    title: LocalizedString;
     /** Whether the modal is open. */
     open?: boolean;
     /** Optional max width for the modal (e.g., '600px', '80%'). Defaults to '600px'. */
@@ -426,7 +426,7 @@ type FrameVariant = 'border' | 'solid';
 interface FrameProps extends ExtensionComponentData {
     component: 'Frame';
     /** Optional title displayed in the header. Can be a plain string or extension components. */
-    title?: string | ExtensionComponentChildren;
+    title?: LocalizedString | ExtensionComponentChildren;
     /** Whether the content can be toggled (collapsed/expanded) by clicking the title. Requires title to be set. */
     collapsible?: boolean;
     /** Whether the frame content is expanded by default. Only used when collapsible is true. Defaults to true. */
@@ -513,7 +513,7 @@ interface WeatherForecastStep {
 interface WeatherForecastProps extends ExtensionComponentData {
     component: 'WeatherForecast';
     /** Heading above the row, e.g. "Kommande timmar". */
-    title?: string;
+    title?: LocalizedString;
     /** Icon shown to the left of the title. */
     icon?: HugeIconName;
     /** Written after every temperature. Defaults to `°`. */
@@ -551,7 +551,7 @@ interface ChartProps extends ExtensionComponentData {
     /** One per point, along the horizontal axis. */
     labels?: string[];
     /** Heading above the plot. With a single series this is what names it, so no legend is drawn. */
-    title?: string;
+    title?: LocalizedString;
     /** Icon shown to the left of the title. */
     icon?: HugeIconName;
     /** Written after every value, e.g. `°`, ` mm`, ` kr`. */
@@ -576,12 +576,12 @@ type StatTrend = 'up' | 'down' | 'flat';
 interface StatTileProps extends ExtensionComponentData {
     component: 'StatTile';
     /** What the number is, e.g. "Förbrukning i går". */
-    label: string;
+    label: LocalizedString;
     value: string | number;
     /** Written after the value in smaller type, e.g. `kWh`. */
     unit?: string;
     /** One quiet line under the number. */
-    caption?: string;
+    caption?: LocalizedString;
     icon?: HugeIconName;
     /** `flat` draws no arrow. */
     trend?: StatTrend;
@@ -619,7 +619,7 @@ type ProgressColor = 'accent' | 'success' | 'warning' | 'danger' | 'info' | 'neu
 interface ProgressBarProps extends ExtensionComponentData {
     component: 'ProgressBar';
     /** What is being measured, e.g. "Stressnivå". Shown beside the reading. */
-    label: string;
+    label: LocalizedString;
     value: number;
     /** Bottom of the range. Defaults to 0. */
     min?: number;
@@ -634,7 +634,7 @@ interface ProgressBarProps extends ExtensionComponentData {
     /** The readout in words, when the bare number does not say it. Replaces value and unit. */
     valueLabel?: string;
     /** One quiet line under the reading. */
-    caption?: string;
+    caption?: LocalizedString;
     icon?: HugeIconName;
 }
 /** One row of a KeyValueList. */
@@ -690,7 +690,7 @@ interface TimelineEntry {
 interface TimelineProps extends ExtensionComponentData {
     component: 'Timeline';
     /** Heading above the rail, e.g. "I dag". */
-    title?: string;
+    title?: LocalizedString;
     /** Icon shown to the left of the title. */
     icon?: HugeIconName;
     entries: TimelineEntry[];
@@ -713,7 +713,7 @@ type NoteVariant = 'default' | 'accent' | 'success' | 'warning' | 'danger';
  */
 interface NoteProps extends ExtensionComponentData {
     component: 'Note';
-    title?: string;
+    title?: LocalizedString;
     /** Icon shown to the left of the title. */
     icon?: HugeIconName;
     /** Trailing badge next to the title: a source, a category, a time. */
@@ -812,7 +812,7 @@ interface AgendaDay {
 interface AgendaProps extends ExtensionComponentData {
     component: 'Agenda';
     /** Heading above the days. */
-    title?: string;
+    title?: LocalizedString;
     /** Icon shown to the left of the title. */
     icon?: HugeIconName;
     days: AgendaDay[];
@@ -894,6 +894,29 @@ interface AccountContribution {
     /** Why the extension needs them, shown next to the scopes in the settings. */
     reason?: LocalizedString;
 }
+/**
+ * What a settings view is about, which decides where Stina shows it.
+ *
+ * An extension never picks a place in the settings menu: the menu belongs to Stina and
+ * changes between versions. It says what the view is *about*, and Stina puts each topic
+ * where it belongs, the way `accounts`, `providers` and `statusCards` already work.
+ *
+ * - `accounts`: connects Stina to an account or a service (a mailbox, a calendar feed).
+ *   Shown with the other connected accounts.
+ * - `notifications`: when and how the extension may get in touch. Shown with Stina's own
+ *   notification settings.
+ * - `personal`: facts about the user the extension relies on (a home town for the
+ *   weather). Shown with the profile.
+ * - `tracking`: things Stina keeps track of for the user that are worth looking through
+ *   now and then (people, projects, reminders). Gets its own row in the register.
+ *
+ * A view without a topic, or with one this version of Stina does not know, is shown on
+ * the extension's own page. That is always a working place, only a less fitting one, so
+ * a topic added later never breaks an older Stina.
+ */
+type ExtensionSettingsTopic = 'accounts' | 'notifications' | 'personal' | 'tracking';
+/** Every topic this version of the API knows, in no particular order. */
+declare const EXTENSION_SETTINGS_TOPICS: readonly ExtensionSettingsTopic[];
 /**
  * Tool settings view definition (UI schema)
  */
@@ -901,9 +924,11 @@ interface ToolSettingsViewDefinition {
     /** Unique view ID within the extension */
     id: string;
     /** Display title */
-    title: string;
+    title: LocalizedString;
     /** Help text */
-    description?: string;
+    description?: LocalizedString;
+    /** What the view is about, and so where Stina shows it. See {@link ExtensionSettingsTopic}. */
+    topic?: ExtensionSettingsTopic;
     /** View configuration */
     view: ToolSettingsView;
 }
@@ -959,7 +984,7 @@ interface ToolSettingsListGroupBy {
     /** Explicit ordering of group values. Groups not listed appear afterwards, sorted alphabetically. */
     order?: string[];
     /** Human-friendly labels per group value (rendered as section headers). Falls back to the raw value if missing. */
-    labels?: Record<string, string>;
+    labels?: Record<string, LocalizedString>;
 }
 /**
  * Mapping from tool list data to UI fields
@@ -1008,7 +1033,7 @@ interface PanelDefinition {
     /** Unique panel ID within the extension */
     id: string;
     /** Display title */
-    title: string;
+    title: LocalizedString;
     /** Icon name (from huge-icons) */
     icon?: string;
     /** Panel view schema */
@@ -1029,7 +1054,7 @@ interface StatusCardDefinition {
     /** Unique card ID within the extension */
     id: string;
     /** What it is called where the user picks it */
-    title: string;
+    title: LocalizedString;
     /** Icon name (from huge-icons) */
     icon?: string;
     /**
@@ -2665,4 +2690,4 @@ interface ActionResult {
     error?: string;
 }
 
-export { type ConnectedAccountsAPI as $, type ActionResult as A, type ProvidersAPI as B, type ChatMessage as C, type Disposable as D, type ExtensionContributions as E, type ToolsAPI as F, type GetModelsOptions as G, type HugeIconName as H, type ActionsAPI as I, type EventsAPI as J, type SchedulerAPI as K, type LocalizedString as L, type ModelInfo as M, type NetworkAPI as N, type SchedulerJobRequest as O, type PanelDefinition as P, type SchedulerSchedule as Q, type UserProfile as R, type SchedulerFirePayload as S, type ToolResult as T, type UserAPI as U, type VoiceSessionOptions as V, type ChatAPI as W, type ChatInstructionMessage as X, type ConversationPresentation as Y, type AttachmentsAPI as Z, type AttachmentContent as _, type ChatOptions as a, type MarkdownProps as a$, type ConnectedAccount as a0, type AccountAccessToken as a1, type LogAPI as a2, type BackgroundWorkersAPI as a3, type BackgroundTaskConfig as a4, type BackgroundTaskCallback as a5, type BackgroundTaskContext as a6, type BackgroundTaskHealth as a7, type BackgroundRestartPolicy as a8, type Query as a9, type ClockProps as aA, type ParagraphProps as aB, type ButtonProps as aC, type TextInputProps as aD, type PasswordInputProps as aE, type NumberInputProps as aF, type TextAreaProps as aG, type DateTimeInputProps as aH, type SelectProps as aI, type IconPickerProps as aJ, type VerticalStackProps as aK, type HorizontalStackProps as aL, type GridProps as aM, type DividerProps as aN, type IconProps as aO, type IconButtonType as aP, type IconButtonProps as aQ, type PanelAction as aR, type PanelProps as aS, type ToggleProps as aT, type CollapsibleProps as aU, type FrameVariant as aV, type FrameProps as aW, type ListProps as aX, type PillVariant as aY, type PillProps as aZ, type CheckboxProps as a_, type QueryOptions as aa, type StorageAPI as ab, type SecretsAPI as ac, type StorageCollectionConfig as ad, type StorageContributions as ae, type AIProvider as af, type ModelCapabilities as ag, type ChatImage as ah, type ChatFile as ai, type ToolCall as aj, type VoiceTransportRequest as ak, type Tool as al, type ToolAttachment as am, type Action as an, type ExtensionModule as ao, type AllowedCSSProperty as ap, type ExtensionComponentStyle as aq, type ExtensionComponentData as ar, type ExtensionComponentIterator as as, type ExtensionComponentChildren as at, type ExtensionActionCall as au, type ExtensionActionRef as av, type ExtensionDataSource as aw, type ExtensionPanelDefinition as ax, type HeaderProps as ay, type LabelProps as az, type StreamEvent as b, type TextPreviewProps as b0, type ModalProps as b1, type ConditionalGroupProps as b2, type WeatherCondition as b3, type WeatherWind as b4, type WeatherNowProps as b5, type WeatherForecastStep as b6, type WeatherForecastProps as b7, type ChartKind as b8, type ChartSeries as b9, type ChartProps as ba, type StatTrend as bb, type StatTileProps as bc, type ProgressShape as bd, type ProgressColor as be, type ProgressBarProps as bf, type KeyValueRow as bg, type KeyValueListProps as bh, type TimelineVariant as bi, type TimelineEntry as bj, type TimelineProps as bk, type NoteVariant as bl, type NoteProps as bm, type CalendarEventStatus as bn, type CalendarEventProps as bo, type AgendaEvent as bp, type AgendaDay as bq, type AgendaProps as br, type ExecutionContext as bs, type VoiceSessionDescriptor as c, type ToolSettingsViewDefinition as d, type ToolSettingsView as e, type ToolSettingsListView as f, type ToolSettingsListMapping as g, type ToolSettingsComponentView as h, type ToolSettingsActionDataSource as i, type StatusCardDefinition as j, type PanelView as k, type PanelComponentView as l, type PanelActionDataSource as m, type PanelUnknownView as n, type ProviderDefinition as o, type ProviderConfigView as p, type PromptContribution as q, resolveLocalizedString as r, type PromptSection as s, type ToolDefinition as t, type ToolConfirmationConfig as u, type CommandDefinition as v, type AccountProvider as w, type AccountContribution as x, type ExtensionContext as y, type SettingsAPI as z };
+export { type AttachmentsAPI as $, type ActionResult as A, type ExtensionContext as B, type ChatMessage as C, type Disposable as D, type ExtensionContributions as E, type SettingsAPI as F, type GetModelsOptions as G, type HugeIconName as H, type ProvidersAPI as I, type ToolsAPI as J, type ActionsAPI as K, type LocalizedString as L, type ModelInfo as M, type NetworkAPI as N, type EventsAPI as O, type PanelDefinition as P, type SchedulerAPI as Q, type SchedulerJobRequest as R, type SchedulerFirePayload as S, type ToolResult as T, type SchedulerSchedule as U, type VoiceSessionOptions as V, type UserAPI as W, type UserProfile as X, type ChatAPI as Y, type ChatInstructionMessage as Z, type ConversationPresentation as _, type ChatOptions as a, type PillProps as a$, type AttachmentContent as a0, type ConnectedAccountsAPI as a1, type ConnectedAccount as a2, type AccountAccessToken as a3, type LogAPI as a4, type BackgroundWorkersAPI as a5, type BackgroundTaskConfig as a6, type BackgroundTaskCallback as a7, type BackgroundTaskContext as a8, type BackgroundTaskHealth as a9, type HeaderProps as aA, type LabelProps as aB, type ClockProps as aC, type ParagraphProps as aD, type ButtonProps as aE, type TextInputProps as aF, type PasswordInputProps as aG, type NumberInputProps as aH, type TextAreaProps as aI, type DateTimeInputProps as aJ, type SelectProps as aK, type IconPickerProps as aL, type VerticalStackProps as aM, type HorizontalStackProps as aN, type GridProps as aO, type DividerProps as aP, type IconProps as aQ, type IconButtonType as aR, type IconButtonProps as aS, type PanelAction as aT, type PanelProps as aU, type ToggleProps as aV, type CollapsibleProps as aW, type FrameVariant as aX, type FrameProps as aY, type ListProps as aZ, type PillVariant as a_, type BackgroundRestartPolicy as aa, type Query as ab, type QueryOptions as ac, type StorageAPI as ad, type SecretsAPI as ae, type StorageCollectionConfig as af, type StorageContributions as ag, type AIProvider as ah, type ModelCapabilities as ai, type ChatImage as aj, type ChatFile as ak, type ToolCall as al, type VoiceTransportRequest as am, type Tool as an, type ToolAttachment as ao, type Action as ap, type ExtensionModule as aq, type AllowedCSSProperty as ar, type ExtensionComponentStyle as as, type ExtensionComponentData as at, type ExtensionComponentIterator as au, type ExtensionComponentChildren as av, type ExtensionActionCall as aw, type ExtensionActionRef as ax, type ExtensionDataSource as ay, type ExtensionPanelDefinition as az, type StreamEvent as b, type CheckboxProps as b0, type MarkdownProps as b1, type TextPreviewProps as b2, type ModalProps as b3, type ConditionalGroupProps as b4, type WeatherCondition as b5, type WeatherWind as b6, type WeatherNowProps as b7, type WeatherForecastStep as b8, type WeatherForecastProps as b9, type ChartKind as ba, type ChartSeries as bb, type ChartProps as bc, type StatTrend as bd, type StatTileProps as be, type ProgressShape as bf, type ProgressColor as bg, type ProgressBarProps as bh, type KeyValueRow as bi, type KeyValueListProps as bj, type TimelineVariant as bk, type TimelineEntry as bl, type TimelineProps as bm, type NoteVariant as bn, type NoteProps as bo, type CalendarEventStatus as bp, type CalendarEventProps as bq, type AgendaEvent as br, type AgendaDay as bs, type AgendaProps as bt, type ExecutionContext as bu, type VoiceSessionDescriptor as c, EXTENSION_SETTINGS_TOPICS as d, type ToolSettingsViewDefinition as e, type ExtensionSettingsTopic as f, type ToolSettingsView as g, type ToolSettingsListView as h, type ToolSettingsListMapping as i, type ToolSettingsComponentView as j, type ToolSettingsActionDataSource as k, type StatusCardDefinition as l, type PanelView as m, type PanelComponentView as n, type PanelActionDataSource as o, type PanelUnknownView as p, type ProviderDefinition as q, resolveLocalizedString as r, type ProviderConfigView as s, type PromptContribution as t, type PromptSection as u, type ToolDefinition as v, type ToolConfirmationConfig as w, type CommandDefinition as x, type AccountProvider as y, type AccountContribution as z };