@grafana/plugin-ui 0.14.1-dsconfig.b962e11 → 0.14.1-dsconfig.ced809d

package/dist/cjs/index.d.cts

@@ -1,4 +1,4 @@
-import React, { ComponentProps, PureComponent, ReactElement, ReactNode, FunctionComponent, HTMLProps } from 'react';
+import React, { ComponentProps, PureComponent, ReactElement, ReactNode, Component, ErrorInfo, FunctionComponent, HTMLProps } from 'react';
 import { Input, Segment as Segment$1, monacoTypes, Monaco, ButtonProps, Field, PopoverContent, Switch, SelectCommonProps, InlineLabel } from '@grafana/ui';
 import { DataSourceInstanceSettings, SelectableValue, DataSourceJsonData, VariableSuggestion, TimeRange, DataFrame, MetricFindValue, ThemeSpacingTokens, ScopedVars, VariableModel, DataFrameView, QueryEditorProps as QueryEditorProps$1, DataSourceSettings, RegistryItem, DataSourceApi, Registry, DataQuery as DataQuery$1, PanelData } from '@grafana/data';
 import { DataSourceSrv, DataSourceWithBackend, TemplateSrv } from '@grafana/runtime';
@@ -1173,7 +1173,7 @@ type SemanticType = 'url' | 'password' | 'token' | 'hostname' | 'duration' | 'da
 type FieldKind = 'storage' | 'virtual';
 type Lifecycle = 'stable' | 'deprecated' | 'experimental';
 type TargetLocation = 'root' | 'jsonData' | 'secureJsonData';
-type UIComponent = 'input' | 'textarea' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'switch' | 'code' | 'keyvalue' | 'list';
+type UIComponent = 'input' | 'textarea' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'switch' | 'code' | 'keyvalue' | 'list' | 'fileUpload';
 type UIWidth = 'full' | 'half';
 /**
  * UI configuration
@@ -1191,6 +1191,26 @@ interface FieldUI {
      * Example: "promql", "logql", "traceql", "sql", "json"
      */
     language?: string;
+    /**
+     * Layout row index for item fields inside object arrays.
+     * Fields with the same row number are rendered horizontally.
+     * Fields without a row number use auto-layout:
+     * - ≤3 fields: all on one row
+     * - >3 fields: each on its own row
+     */
+    row?: number;
+    /**
+     * Accepted file types for fileUpload component.
+     * Uses HTML accept attribute format with leading dot.
+     * Example: [".json"]
+     */
+    accept?: string[];
+    /**
+     * Maps keys in an uploaded JSON file to target field IDs.
+     * Used by fileUpload to distribute parsed values to other form fields.
+     * Example: { "private_key": "secureJsonData.privateKey", "client_email": "jsonData.clientEmail" }
+     */
+    fileMapping?: Record<string, string>;
 }
 type FieldValidationRule = PatternValidationRule | RangeValidationRule | LengthValidationRule | ItemCountValidationRule | AllowedValuesValidationRule | CustomValidationRule;
 interface BaseValidationRule {
@@ -1251,6 +1271,21 @@ interface FieldOverride {
     tooltip?: string;
     validations?: FieldValidationRule[];
     options?: FieldOption[];
+    /**
+     * When present on an `isItemField` field, the value is routed to
+     * `secureJsonData` under the resolved key instead of being stored
+     * inline in the parent array.
+     *
+     * The template string supports placeholders:
+     * - `{index}`  — 0-based array position
+     * - `{index1}` — 1-based array position
+     * - `{item.KEY}` — value of sibling item field `KEY`
+     *
+     * Examples:
+     * - `"secureHttpHeaders.{item.name}"` (ClickHouse)
+     * - `"httpHeaderValue{index1}"` (Grafana core headers)
+     */
+    secureKey?: string;
 }
 /**
  * Declares that when a field's value matches a condition,
@@ -1347,6 +1382,18 @@ interface FieldRelationship {
      */
     targetPluginType?: string;
 }
+type SecureFieldState = {
+    type: 'unset';
+} | {
+    type: 'configured';
+} | {
+    type: 'updated';
+    value: string;
+};
+interface FormState {
+    values: Record<string, unknown>;
+    secure: Record<string, SecureFieldState>;
+}
 
 type DatasourceConfigWizardProps = {
     schema: DatasourceConfigSchema;
@@ -1368,6 +1415,43 @@ type DatasourceConfigWizardProps = {
 };
 declare function DatasourceConfigWizard(props: DatasourceConfigWizardProps): React.JSX.Element;
 
+/** Lightweight error boundary scoped to datasource config widgets — won't crash the host UI. */
+declare class DatasourceErrorBoundary extends Component<{
+    children: ReactNode;
+    dsName?: string;
+}, {
+    error: Error | null;
+}> {
+    state: {
+        error: Error | null;
+    };
+    static getDerivedStateFromError(error: Error): {
+        error: Error;
+    };
+    componentDidCatch(error: Error, info: ErrorInfo): void;
+    render(): string | number | boolean | Iterable<React.ReactNode> | React.JSX.Element | null | undefined;
+}
+
+type HealthState = 'pending' | 'checking' | 'done';
+interface DatasourceHealth {
+    state: HealthState;
+    status?: string;
+    message?: string;
+}
+/**
+ * Health check hook — on-demand only.
+ * Call `checkUids(uids)` to trigger checks for specific UIDs.
+ * Call `retry(uid)` to force re-check a single UID.
+ * UIDs that have already been checked (or are in-flight) are automatically skipped.
+ */
+declare function useHealthChecks(): {
+    healthMap: Record<string, DatasourceHealth>;
+    checkUids: (uids: string[]) => void;
+    retry: (uid: string) => void;
+};
+
+declare function resolvePluginName(pluginType: string): string;
+
 interface CustomHeader {
     id: string;
     name: string;
@@ -1625,13 +1709,39 @@ declare function resolveRequiredFieldsGroup(schema: DatasourceConfigSchema): {
  */
 declare function formKey(field: ConfigField): string;
 /**
- * Parse a simple CEL-like dependsOn expression: "fieldId == 'value'" or "fieldId == true".
- * Returns { field, value } or null if unparseable.
+ * Resolve a possibly-dotted key against watchedValues from react-hook-form.
+ * RHF's `watch()` returns nested objects for dotted Controller names
+ * (e.g. "logs.otelEnabled" → { logs: { otelEnabled: true } }),
+ * so a flat `obj["logs.otelEnabled"]` lookup misses.
+ *
+ * For dotted keys we must try the nested path **first**: react-hook-form's
+ * Controller `onChange` writes nested objects via its internal `set()`, but
+ * `reset()` may have created a flat dotted key with the same name.  After user
+ * interaction the nested value is authoritative; the stale flat key must not
+ * shadow it.  This mirrors RHF's own `get()` semantics (nested-first, flat
+ * fallback).
+ */
+declare function getWatchedValue(watchedValues: Record<string, unknown>, key: string): unknown;
+/**
+ * Parse a simple CEL-like dependsOn expression: "fieldId == 'value'" or "fieldId != 'value'".
+ * Only single comparisons are supported — no &&, ||, or parentheses.
+ * Field IDs may contain dots and underscores (e.g. "jsonData.oauth2.oauth2_type").
+ * Values may be single-quoted, double-quoted, or unquoted literals (true/false/numbers).
+ * Returns { field, value, negate } or null if unparseable.
  */
 declare function parseDependsOn(expr: string): {
     field: string;
     value: string;
+    negate: boolean;
 } | null;
+/**
+ * Evaluate a parsed dependsOn condition against a value.
+ * Handles both == and != operators.
+ */
+declare function evaluateDependsOn(parsed: {
+    value: string;
+    negate: boolean;
+}, currentValue: unknown): boolean;
 /**
  * Resolve the first matching override for a field given current form values.
  * Override `when` uses the same "fieldId == 'value'" syntax as dependsOn.
@@ -1678,6 +1788,24 @@ type DatasourceConfigPayload = {
 type FormValues = Record<string, unknown>;
 
 declare const SECURE_FIELD_CONFIGURED = "__CONFIGURED__";
+/**
+ * Resolve a secureKey template string by replacing placeholders.
+ *
+ * Supported placeholders:
+ * - `{index}`  — 0-based array position
+ * - `{index1}` — 1-based array position
+ * - `{item.KEY}` — value of sibling field `KEY` in the same item object
+ */
+declare function resolveSecureKeyTemplate(template: string, item: Record<string, unknown>, index: number): string;
+/**
+ * For a given item object at a given index, find the first active secureKey
+ * override across all item fields. Returns the resolved secureJsonData key
+ * and the item field key whose value should be routed, or null if none active.
+ */
+declare function findActiveSecureOverride(itemFields: ConfigField[], item: Record<string, unknown>, index: number): {
+    fieldKey: string;
+    resolvedKey: string;
+} | null;
 type FetchExistingResult = {
     values: FormValues;
     readOnly: boolean;
@@ -1746,4 +1874,6 @@ declare function toProvisioningYaml(schema: DatasourceConfigSchema, values?: Rec
  */
 declare function datasourceToProvisioningYaml(ds: Record<string, unknown>, schema: DatasourceConfigSchema | null): string;
 
-export { AccessoryButton, AdvancedHttpSettings, type Aggregate, Auth, AuthMethod, type Props$c as AuthProps, BINARY_OPERATIONS_KEY, CatalogSelector, type ColumnDefinition, CompletionItemInsertTextRule, CompletionItemKind, CompletionItemPriority, ConfigDescriptionLink, ConfigSection, ConfigSubSection, ConnectionSettings, CustomHeadersSettings, type DB, DataLink, type DataLinkConfig, DataLinks, DataSourceDescription, DataSourcePicker, DatasetSelector, type DatasourceConfigPayload, DatasourceConfigWizard, type DatasourceConfigWizardProps, type DatasourceResponse, DatePicker, type DatePickerProps, DatePickerWithInput, type DatePickerWithInputProps, DebounceInput, type DebounceInputProps, EditorField, EditorFieldGroup, EditorHeader, EditorList, EditorMode, EditorRow, EditorRows, EditorStack, EditorSwitch, type FetchExistingResult, FlexItem, type FormValues, GroupByRow, type IndexedPairItem, InlineSelect, InputGroup, LabelFilters, type LanguageCompletionProvider, type LanguageDefinition, LinkedToken, MacroType, type MetaDefinition, type NameValue, OperationExplainedBox, OperationList, OperationListExplained, OperationsEditorRow, OperatorType, type PositionContext, type Props$s as Props, type ProvisioningYamlOptions, QUERY_FORMAT_OPTIONS, QueryBuilderHints, type QueryBuilderLabelFilter, type QueryBuilderOperation, type QueryBuilderOperationDefinition, type QueryBuilderOperationParamDef, type QueryBuilderOperationParamEditorProps, type QueryBuilderOperationParamValue, QueryEditorMode, QueryEditorModeToggle, type QueryEditorProps, QueryEditorRow, QueryFormat, QueryHeaderSwitch, QueryModellerBase, QueryOptionGroup, type QueryRowFilter, type QueryStats, type QueryWithDefaults, type RAQBFieldTypes, RawQuery, type ResourceSelectorProps, type ResponseParser, RunQueryButton, SECURE_FIELD_CONFIGURED, type SQLConnectionLimits, SQLEditor, SQLEditorMode, SQLEditorTestUtils, type SQLExpression, type SQLFilters, type SQLMonarchLanguage, type SQLOptions, type SQLQuery, type SQLSelectableValue, type SchemaDefinition, SecureSocksProxyToggle, Segment, type SegmentProps, Space, SqlDatasource, SqlQueryEditor, type SqlQueryForInterpolation, type SqlQueryModel, type State$1 as State, type StatementPlacementProvider, StatementPosition, SuggestionKind, type SuggestionKindProvider, TLSSettings, type Props$f as TLSSettingsProps, type TableDefinition, type TableFieldSchema, type TableIdentifier, type TableSchema, TableSelector, type TestQueryModel, TokenType, type ValidationResults, type VisualQuery, type VisualQueryBinary, type VisualQueryModeller, buildDatasourceConfigPayload, computeVirtualFieldValues, convertLegacyAuthProps, datasourceToProvisioningYaml, evaluateComputedRead, expandIndexedPair, fetchExistingValues, flattenIndexedPair, formKey, formatDate, generateLLMHint, generateTroubleshootingFields, getStandardSQLCompletionProvider, language as grafanaStandardSQLLanguage, conf as grafanaStandardSQLLanguageConf, parseDependsOn, resolveActiveOverride, resolveGroups, resolveRequiredFieldsGroup, submitDatasourceConfig, toOption, toProvisioningYaml };
+declare function getConfigSchema(pluginType: string): DatasourceConfigSchema | null;
+
+export { AccessoryButton, AdvancedHttpSettings, type Aggregate, type AllowedValuesValidationRule, Auth, AuthMethod, type Props$c as AuthProps, BINARY_OPERATIONS_KEY, type BaseValidationRule, CatalogSelector, type ColumnDefinition, CompletionItemInsertTextRule, CompletionItemKind, CompletionItemPriority, type ComputedMapping, ConfigDescriptionLink, type ConfigField, type ConfigGroup, ConfigSection, ConfigSubSection, ConnectionSettings, CustomHeadersSettings, type CustomValidationRule, type DB, DataLink, type DataLinkConfig, DataLinks, DataSourceDescription, DataSourcePicker, DatasetSelector, type DatasourceConfigPayload, type DatasourceConfigSchema, DatasourceConfigWizard, type DatasourceConfigWizardProps, DatasourceErrorBoundary, type DatasourceHealth, type DatasourceResponse, DatePicker, type DatePickerProps, DatePickerWithInput, type DatePickerWithInputProps, DebounceInput, type DebounceInputProps, type DirectMapping, EditorField, EditorFieldGroup, EditorHeader, EditorList, EditorMode, EditorRow, EditorRows, EditorStack, EditorSwitch, type Expression, type FetchExistingResult, type FieldEffect, type FieldItemSchema, type FieldKind, type FieldOption, type FieldOverride, type FieldRelationship, type FieldUI, type FieldValidationRule, FlexItem, type FormState, type FormValues, GroupByRow, type HealthState, type IndexedPairItem, type IndexedPairMapping, InlineSelect, InputGroup, type ItemCountValidationRule, LabelFilters, type LanguageCompletionProvider, type LanguageDefinition, type LengthValidationRule, type Lifecycle, LinkedToken, MacroType, type MappingField, type MetaDefinition, type NameValue, OperationExplainedBox, OperationList, OperationListExplained, OperationsEditorRow, OperatorType, type PatternValidationRule, type PositionContext, type Props$s as Props, type ProvisioningYamlOptions, QUERY_FORMAT_OPTIONS, QueryBuilderHints, type QueryBuilderLabelFilter, type QueryBuilderOperation, type QueryBuilderOperationDefinition, type QueryBuilderOperationParamDef, type QueryBuilderOperationParamEditorProps, type QueryBuilderOperationParamValue, QueryEditorMode, QueryEditorModeToggle, type QueryEditorProps, QueryEditorRow, QueryFormat, QueryHeaderSwitch, QueryModellerBase, QueryOptionGroup, type QueryRowFilter, type QueryStats, type QueryWithDefaults, type RAQBFieldTypes, type RangeValidationRule, RawQuery, type RelationshipType, type ResourceSelectorProps, type ResponseParser, RunQueryButton, SECURE_FIELD_CONFIGURED, type SQLConnectionLimits, SQLEditor, SQLEditorMode, SQLEditorTestUtils, type SQLExpression, type SQLFilters, type SQLMonarchLanguage, type SQLOptions, type SQLQuery, type SQLSelectableValue, type SchemaDefinition, type SecureFieldState, SecureSocksProxyToggle, Segment, type SegmentProps, type SemanticType, Space, SqlDatasource, SqlQueryEditor, type SqlQueryForInterpolation, type SqlQueryModel, type State$1 as State, type StatementPlacementProvider, StatementPosition, type StorageMapping, SuggestionKind, type SuggestionKindProvider, TLSSettings, type Props$f as TLSSettingsProps, type TableDefinition, type TableFieldSchema, type TableIdentifier, type TableSchema, TableSelector, type TargetLocation, type TestQueryModel, TokenType, type UIComponent, type UIWidth, type ValidationResults, type ValueType, type VisualQuery, type VisualQueryBinary, type VisualQueryModeller, buildDatasourceConfigPayload, computeVirtualFieldValues, convertLegacyAuthProps, datasourceToProvisioningYaml, evaluateComputedRead, evaluateDependsOn, expandIndexedPair, fetchExistingValues, findActiveSecureOverride, flattenIndexedPair, formKey, formatDate, generateLLMHint, generateTroubleshootingFields, getConfigSchema, getStandardSQLCompletionProvider, getWatchedValue, language as grafanaStandardSQLLanguage, conf as grafanaStandardSQLLanguageConf, parseDependsOn, resolveActiveOverride, resolveGroups, resolvePluginName, resolveRequiredFieldsGroup, resolveSecureKeyTemplate, submitDatasourceConfig, toOption, toProvisioningYaml, useHealthChecks };