@grafana/plugin-ui 0.14.1-dsconfig.f952c80 → 0.15.0

package/dist/cjs/schemas.d.cts

@@ -1,448 +0,0 @@
-interface DatasourceConfigSchema {
-    /**
-     * Schema version (required)
-     * Used for compatibility and migrations
-     *
-     * Example: "v2"
-     */
-    schemaVersion: string;
-    /**
-     * Unique datasource plugin identifier
-     * Example: "prometheus"
-     */
-    pluginType: string;
-    /**
-     * Human-readable name
-     */
-    pluginName: string;
-    /**
-     * Optional documentation URL
-     */
-    docURL?: string;
-    /**
-     * Source of truth for configuration
-     */
-    fields: ConfigField[];
-    /**
-     * Optional UI grouping
-     */
-    groups?: ConfigGroup[];
-    /**
-     * Relationships between fields
-     */
-    relationships?: FieldRelationship[];
-}
-interface ConfigField {
-    /**
-     * Globally unique identifier
-     * Recommended format: dot-separated path
-     * Example: "auth.method", "httpHeaders.item.key"
-     */
-    id: string;
-    /**
-     * Local key used in storage or object
-     */
-    key: string;
-    /**
-     * UI metadata
-     */
-    label?: string;
-    description?: string;
-    docURL?: string;
-    /**
-     * Core type of the field
-     */
-    valueType: ValueType;
-    /**
-     * Semantic meaning (optional)
-     */
-    semanticType?: SemanticType;
-    /**
-     * Storage location (required for storage fields)
-     */
-    target?: TargetLocation;
-    /**
-     * Dotted path prefix within the target for nested objects.
-     * Example: for jsonData.tracesToLogs.datasourceUid,
-     * target="jsonData", section="tracesToLogs", key="datasourceUid".
-     */
-    section?: string;
-    /**
-     * Field kind.
-     * @default "storage"
-     */
-    kind?: FieldKind;
-    /**
-     * True if field belongs to array item schema
-     */
-    isItemField?: boolean;
-    /**
-     * Lifecycle state
-     */
-    lifecycle?: Lifecycle;
-    /**
-     * UI rendering hints
-     */
-    ui?: FieldUI;
-    /**
-     * Validations rules
-     */
-    validations?: FieldValidationRule[];
-    /**
-     * Visibility condition (CEL expression)
-     */
-    dependsOn?: Expression;
-    /**
-     * Always required
-     */
-    required?: boolean;
-    /**
-     * Conditionally required
-     */
-    requiredWhen?: Expression;
-    /**
-     * Disabled condition
-     */
-    disabledWhen?: Expression;
-    /**
-     * Dynamic overrides
-     */
-    overrides?: FieldOverride[];
-    /**
-     * Declarative multi-field write side-effects.
-     * When this field's value matches a condition, the listed target
-     * fields are set to specified values. Typically used on virtual
-     * selector fields (e.g. auth method dropdown).
-     */
-    effects?: FieldEffect[];
-    /**
-     * Item schema for array elements or map values.
-     * Required if valueType === "array" or "map".
-     */
-    item?: FieldItemSchema;
-    /**
-     * Legacy indexed fields (deprecated)
-     */
-    repeatable?: boolean;
-    pattern?: string;
-    /**
-     * Storage mapping
-     */
-    storage?: StorageMapping;
-    /**
-     * Metadata
-     */
-    tags?: string[];
-    examples?: unknown[];
-    defaultValue?: unknown;
-}
-interface FieldItemSchema {
-    /**
-     * Type of array items or map values.
-     * For arrays, describes each element.
-     * For maps, describes each value (keys are always strings).
-     */
-    valueType: ValueType;
-    /**
-     * Sub-fields for object items. Optional even when valueType = "object"
-     * (omitting allows an unconstrained object).
-     */
-    fields?: ConfigField[];
-}
-/**
- * CEL expression string
- */
-type Expression = string;
-type ValueType = 'string' | 'number' | 'boolean' | 'array' | 'object' | 'map' | 'any';
-type SemanticType = 'url' | 'password' | 'token' | 'hostname' | 'duration' | 'datasourceUid' | 'query';
-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' | 'fileUpload';
-type UIWidth = 'full' | 'half';
-/**
- * UI configuration
- */
-interface FieldUI {
-    component: UIComponent;
-    multiline?: boolean;
-    rows?: number;
-    options?: FieldOption[];
-    allowCustom?: boolean;
-    width?: UIWidth;
-    placeholder?: string;
-    /**
-     * Language hint for code editor components.
-     * 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 {
-    /**
-     * Optional stable ID for the validation rule.
-     * Useful for docs, localization, and test snapshots.
-     */
-    id?: string;
-    /**
-     * Human-readable validation error message.
-     */
-    message?: string;
-}
-interface PatternValidationRule extends BaseValidationRule {
-    type: 'pattern';
-    pattern: string;
-}
-interface RangeValidationRule extends BaseValidationRule {
-    type: 'range';
-    min?: number;
-    max?: number;
-}
-interface LengthValidationRule extends BaseValidationRule {
-    type: 'length';
-    min?: number;
-    max?: number;
-}
-interface ItemCountValidationRule extends BaseValidationRule {
-    type: 'itemCount';
-    min?: number;
-    max?: number;
-}
-interface AllowedValuesValidationRule extends BaseValidationRule {
-    type: 'allowedValues';
-    values: unknown[];
-}
-interface CustomValidationRule extends BaseValidationRule {
-    type: 'custom';
-    /**
-     * CEL expression.
-     *
-     * Should evaluate to true when the field value is valid.
-     */
-    expression: Expression;
-}
-interface FieldOverride {
-    /**
-     * CEL condition
-     */
-    when: Expression;
-    defaultValue?: unknown;
-    /**
-     * When true, the field is disabled/read-only while this override is active.
-     */
-    readOnly?: boolean;
-    description?: string;
-    placeholder?: string;
-    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,
- * listed target fields should be set to specified values.
- *
- * Use "value" in the `when` expression to refer to the field's value.
- */
-interface FieldEffect {
-    /**
-     * CEL expression. Example: "value == 'basic-auth'"
-     */
-    when: Expression;
-    /**
-     * Maps field IDs to the values they should be set to.
-     * Must contain at least one entry.
-     */
-    set: Record<string, unknown> & {
-        [k: string]: unknown;
-    };
-}
-type StorageMapping = DirectMapping | IndexedPairMapping | ComputedMapping;
-/**
- * Direct mapping
- */
-interface DirectMapping {
-    type: 'direct';
-}
-/**
- * Indexed pair mapping (headers)
- */
-interface IndexedPairMapping {
-    type: 'indexedPair';
-    key: MappingField;
-    value: MappingField;
-    startIndex?: number;
-}
-/**
- * Computed mapping (virtual fields).
- * At least one of `read` or `write` must be provided.
- */
-type ComputedMapping = {
-    type: 'computed';
-    read: Expression;
-    write?: Expression;
-} | {
-    type: 'computed';
-    read?: Expression;
-    write: Expression;
-};
-/**
- * Mapping field
- */
-interface MappingField {
-    target: TargetLocation;
-    pattern: string;
-}
-interface FieldOption {
-    label: string;
-    /**
-     * Must match parent field valueType.
-     * Must not be null.
-     */
-    value: NonNullable<unknown>;
-    /**
-     * Optional human-readable description of the option.
-     */
-    description?: string;
-}
-interface ConfigGroup {
-    id: string;
-    title: string;
-    description?: string;
-    order?: number;
-    /**
-     * When true, the group is optional and can be collapsed/hidden by default.
-     */
-    optional?: boolean;
-    /**
-     * References field IDs (not keys)
-     */
-    fieldRefs: string[];
-}
-type RelationshipType = 'pair' | 'group' | 'datasourceReference';
-interface FieldRelationship {
-    type: RelationshipType;
-    /**
-     * References field IDs
-     */
-    fields: string[];
-    description?: string;
-    /**
-     * Constrains the datasource UID to a specific plugin type.
-     * Only applicable when type is "datasourceReference".
-     */
-    targetPluginType?: string;
-}
-type SecureFieldState = {
-    type: 'unset';
-} | {
-    type: 'configured';
-} | {
-    type: 'updated';
-    value: string;
-};
-interface FormState {
-    values: Record<string, unknown>;
-    secure: Record<string, SecureFieldState>;
-}
-
-declare function getConfigSchema(pluginType: string): DatasourceConfigSchema | null;
-
-/**
- * Generate LLM hints for select fields (used when creating datasources).
- */
-declare function generateLLMHint(schema: DatasourceConfigSchema): string;
-/**
- * Generate comprehensive structured field data for troubleshooting context.
- * Returns an array of field descriptors the LLM can use to render rich tables.
- */
-declare function generateTroubleshootingFields(schema: DatasourceConfigSchema): Array<{
-    label: string;
-    key: string;
-    target: string;
-    type: string;
-    required: boolean;
-    description?: string;
-    defaultValue?: unknown;
-    options?: string[];
-    section?: string;
-    dependsOn?: string;
-}>;
-
-type YamlRenderOptions = {
-    jsonDataKeys?: string[];
-    secureKeys?: string[];
-};
-type ProvisioningYamlOptions = {
-    /** Include comments with field descriptions. Default: true for template, false for export. */
-    comments?: boolean;
-    /** Name override (used in template mode). */
-    name?: string;
-};
-/**
- * Generate a Grafana provisioning YAML from a dsconfig schema.
- * In template mode (no values), emits all fields with defaults and comments.
- * When values are provided, emits actual values — used for existing datasource export.
- */
-declare function toProvisioningYaml(schema: DatasourceConfigSchema, values?: Record<string, unknown>, options?: ProvisioningYamlOptions): string;
-/**
- * Generate provisioning YAML from an existing Grafana datasource API response.
- * If a dsconfig schema is available, uses it for field ordering and comments.
- * If not, generates basic YAML from the raw API response.
- */
-declare function datasourceToProvisioningYaml(ds: Record<string, unknown>, schema: DatasourceConfigSchema | null): string;
-declare const configToYaml: (ds: Record<string, unknown>, options?: YamlRenderOptions) => string;
-declare const formatYamlDiff: (existing: Record<string, unknown>, body: Record<string, unknown>) => string;
-
-type UseDatasourceSchemaResult = {
-    schema: DatasourceConfigSchema | null;
-    loading: boolean;
-    error: string | null;
-};
-declare function useDatasourceSchema(pluginType: string): UseDatasourceSchemaResult;
-declare function fetchConfigSchema(pluginType: string): DatasourceConfigSchema | null;
-
-declare const ROOT_CONFIG_FIELDS: readonly ["name", "type", "id", "uid", "access", "url", "basicAuth", "basicAuthUser", "user", "isDefault", "database", "withCredentials"];
-type DatasourceConfig = Record<any, any>;
-declare const buildCreateDatasourcePayload: (input: DatasourceConfig) => DatasourceConfig;
-declare const buildCloneDatasourcePayload: (source: DatasourceConfig, name: string) => DatasourceConfig;
-declare const buildUpdateDatasourcePayload: (existing: DatasourceConfig, input: DatasourceConfig) => {
-    body: DatasourceConfig;
-    hasChanges: boolean;
-};
-
-export { type AllowedValuesValidationRule, type BaseValidationRule, type ComputedMapping, type ConfigField, type ConfigGroup, type CustomValidationRule, type DatasourceConfigSchema, type DirectMapping, type Expression, type FieldEffect, type FieldItemSchema, type FieldKind, type FieldOption, type FieldOverride, type FieldRelationship, type FieldUI, type FieldValidationRule, type FormState, type IndexedPairMapping, type ItemCountValidationRule, type LengthValidationRule, type Lifecycle, type MappingField, type PatternValidationRule, type ProvisioningYamlOptions, ROOT_CONFIG_FIELDS, type RangeValidationRule, type RelationshipType, type SecureFieldState, type SemanticType, type StorageMapping, type TargetLocation, type UIComponent, type UIWidth, type ValueType, buildCloneDatasourcePayload, buildCreateDatasourcePayload, buildUpdateDatasourcePayload, configToYaml, datasourceToProvisioningYaml, fetchConfigSchema, formatYamlDiff, generateLLMHint, generateTroubleshootingFields, getConfigSchema, toProvisioningYaml, useDatasourceSchema };