@grafana/plugin-ui 0.14.0-dev.1 → 0.14.1-dsconfig.4bdebf6

package/dist/esm/index.js

@@ -37,6 +37,10 @@ export { convertLegacyAuthProps } from './components/ConfigEditor/Auth/utils.js'
 export { TLSSettings } from './components/ConfigEditor/Auth/tls/TLSSettings.js';
 export { ConnectionSettings } from './components/ConfigEditor/Connection/ConnectionSettings.js';
 export { AdvancedHttpSettings } from './components/ConfigEditor/AdvancedSettings/AdvancedHttpSettings.js';
+export { DatasourceConfigWizard } from './components/ConfigEditor/DatasourceConfigWizard/DatasourceConfigWizard.js';
+export { DatasourceErrorBoundary } from './components/ConfigEditor/DatasourceConfigWizard/DatasourceErrorBoundary.js';
+export { useHealthChecks } from './components/ConfigEditor/DatasourceConfigWizard/useHealthChecks.js';
+export { resolvePluginName } from './components/ConfigEditor/DatasourceConfigWizard/resolvePluginName.js';
 export { CustomHeadersSettings } from './components/CustomHeadersSettings/CustomHeadersSettings.js';
 export { QueryModellerBase } from './components/VisualQueryBuilder/QueryModellerBase.js';
 export { LabelFilters } from './components/VisualQueryBuilder/components/LabelFilters.js';
@@ -55,6 +59,12 @@ export { SQLEditorTestUtils } from './components/SQLEditor/test-utils/index.js';
 export { LinkedToken } from './components/SQLEditor/utils/LinkedToken.js';
 export { language as grafanaStandardSQLLanguage, conf as grafanaStandardSQLLanguageConf } from './components/SQLEditor/standardSql/language.js';
 export { getStandardSQLCompletionProvider } from './components/SQLEditor/standardSql/standardSQLCompletionItemProvider.js';
-export { CompletionItemInsertTextRule, CompletionItemKind, CompletionItemPriority, MacroType, OperatorType, SQLEditorMode, StatementPosition, SuggestionKind, TokenType } from './components/SQLEditor/types.js';
+export { CompletionItemInsertTextRule, CompletionItemKind, CompletionItemPriority, MacroType, OperatorType, SQLEditorMode, StatementPosition, SuggestionKind } from './components/SQLEditor/types.js';
 export { SqlDatasource } from './datasource/SqlDatasource.js';
+export { computeVirtualFieldValues, evaluateComputedRead, formKey, parseDependsOn, resolveActiveOverride, resolveGroups, resolveRequiredFieldsGroup } from './datasource/schema/config.js';
+export { SECURE_FIELD_CONFIGURED, buildDatasourceConfigPayload, expandIndexedPair, fetchExistingValues, flattenIndexedPair, submitDatasourceConfig } from './datasource/schema/datasource.js';
+export { generateLLMHint, generateTroubleshootingFields } from './datasource/schema/llmHints.js';
+export { datasourceToProvisioningYaml, toProvisioningYaml } from './datasource/schema/provisioningYaml.js';
+export { getConfigSchema } from './datasource/schema/schemaRegistry.js';
+export { TokenType } from './components/SQLEditor/utils/tokenType.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/schemas.d.ts

@@ -0,0 +1,338 @@
+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';
+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;
+}
+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[];
+}
+/**
+ * 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;
+}
+
+declare function getConfigSchema(pluginType: string): DatasourceConfigSchema | null;
+
+export { type DatasourceConfigSchema, getConfigSchema };

package/dist/esm/schemas.js

@@ -0,0 +1,2 @@
+export { getConfigSchema } from './datasource/schema/schemaRegistry.js';
+//# sourceMappingURL=schemas.js.map

package/dist/esm/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-ui",
-  "version": "0.14.0-dev.1",
+  "version": "0.14.1-dsconfig.4bdebf6",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/grafana/plugin-ui.git"
@@ -14,6 +14,9 @@
     "*": {
       "test": [
         "dist/cjs/test-utils.d.cts"
+      ],
+      "schemas": [
+        "dist/cjs/schemas.d.cts"
       ]
     }
   },
@@ -38,6 +41,16 @@
         "types": "./dist/cjs/test-utils.d.cts",
         "default": "./dist/cjs/test-utils.cjs"
       }
+    },
+    "./schemas": {
+      "import": {
+        "types": "./dist/esm/schemas.d.ts",
+        "default": "./dist/esm/schemas.js"
+      },
+      "require": {
+        "types": "./dist/cjs/schemas.d.cts",
+        "default": "./dist/cjs/schemas.cjs"
+      }
     }
   },
   "sideEffects": false,
@@ -50,7 +63,7 @@
     "spellcheck": "cspell -c cspell.config.json \"**/*.{ts,tsx,js,md,mdx,yml,yaml,json,scss,css}\"",
     "storybook": "storybook dev",
     "storybook:build": "storybook build",
-    "lint": "eslint --cache --ignore-path ./.eslintignore --ext .js,.jsx,.ts,.tsx .",
+    "lint": "eslint --cache --ignore-path ./.gitignore --ext .js,.jsx,.ts,.tsx .",
     "lint:fix": "yarn run lint --fix",
     "typecheck": "tsc",
     "verify-types": "attw --pack .",
@@ -62,13 +75,15 @@
     "@react-awesome-query-builder/ui": "^6.6.4",
     "@types/prismjs": "^1.26.4",
     "chance": "^1.1.7",
-    "lodash": "^4.17.23",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.18.1",
     "prismjs": "^1.30.0",
     "react-calendar": "^4.8.0",
+    "react-hook-form": "^7.52.0",
     "react-popper-tooltip": "^4.4.2",
     "react-use": "^17.3.1",
     "react-virtualized-auto-sizer": "^1.0.6",
-    "sql-formatter-plus": "^1.3.6",
+    "sql-formatter": "^15.7.0",
     "uuid": "^11.0.0"
   },
   "devDependencies": {
@@ -77,9 +92,10 @@
     "@grafana/e2e-selectors": "^10.4.0",
     "@grafana/eslint-config": "^8.0.0",
     "@grafana/runtime": "^10.4.0",
-    "@grafana/tsconfig": "^1.3.0-rc1",
+    "@grafana/tsconfig": "^2.0.0",
     "@grafana/ui": "^10.4.0",
-    "@rollup/plugin-commonjs": "^28.0.2",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@storybook/addon-docs": "10.2.5",
     "@storybook/addon-links": "10.2.5",
@@ -112,6 +128,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
+    "lefthook": "^1.7.18",
     "mockdate": "^3.0.2",
     "prettier": "^3.3.3",
     "publint": "^0.3.12",
@@ -128,10 +145,10 @@
     "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "@grafana/data": ">=10.4.0",
-    "@grafana/e2e-selectors": ">=10.4.0",
-    "@grafana/runtime": ">=10.4.0",
-    "@grafana/ui": ">=10.4.0",
+    "@grafana/data": ">=10.4.0-0",
+    "@grafana/e2e-selectors": ">=10.4.0-0",
+    "@grafana/runtime": ">=10.4.0-0",
+    "@grafana/ui": ">=10.4.0-0",
     "@testing-library/jest-dom": ">=5.16.5",
     "@testing-library/react": ">=15.0.2",
     "@testing-library/user-event": ">=14.5.2",
@@ -141,5 +158,21 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "resolutions": {
+    "prismjs": "^1.30.0",
+    "uplot": "^1.6.31",
+    "glob": "10.5.0",
+    "tar": "^7.5.7",
+    "@babel/helpers": "^7.26.10",
+    "brace-expansion": "^2.0.2",
+    "diff": "^4.0.4",
+    "js-yaml": "^4.1.1",
+    "immutable": "^4.3.8",
+    "minimatch@^3.0.0": "^3.1.3",
+    "lodash": "^4.18.1",
+    "dompurify": "^3.3.2",
+    "@tootallnate/once": "^3.0.1"
+  },
+  "packageManager": "yarn@4.6.0"
 }