@databricks/appkit-ui 0.36.0 → 0.38.0

package/dist/schemas/template-plugins.schema.json

@@ -1,113 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://databricks.github.io/appkit/schemas/template-plugins.schema.json",
-  "title": "AppKit Template Plugins Manifest",
-  "description": "Aggregated plugin manifest for AppKit templates. Read by Databricks CLI during init to discover available plugins and their resource requirements.",
-  "type": "object",
-  "required": ["version", "plugins"],
-  "properties": {
-    "$schema": {
-      "type": "string",
-      "description": "Reference to the JSON Schema for validation"
-    },
-    "version": {
-      "type": "string",
-      "enum": ["1.0", "1.1"],
-      "description": "Schema version for the template plugins manifest"
-    },
-    "plugins": {
-      "type": "object",
-      "description": "Map of plugin name to plugin manifest with package source",
-      "additionalProperties": {
-        "$ref": "#/$defs/templatePlugin"
-      }
-    }
-  },
-  "additionalProperties": false,
-  "$defs": {
-    "templatePlugin": {
-      "type": "object",
-      "required": [
-        "name",
-        "displayName",
-        "description",
-        "package",
-        "resources"
-      ],
-      "description": "Plugin manifest with package source information",
-      "properties": {
-        "name": {
-          "type": "string",
-          "pattern": "^[a-z][a-z0-9-]*$",
-          "description": "Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.",
-          "examples": ["analytics", "server", "my-custom-plugin"]
-        },
-        "displayName": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Human-readable display name for UI and CLI",
-          "examples": ["Analytics Plugin", "Server Plugin"]
-        },
-        "description": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Brief description of what the plugin does",
-          "examples": ["SQL query execution against Databricks SQL Warehouses"]
-        },
-        "package": {
-          "type": "string",
-          "minLength": 1,
-          "description": "NPM package name that provides this plugin",
-          "examples": ["@databricks/appkit", "@my-org/custom-plugin"]
-        },
-        "requiredByTemplate": {
-          "type": "boolean",
-          "default": false,
-          "description": "When true, this plugin is required by the template and cannot be deselected during CLI init. The user will only be prompted to configure its resources. When absent or false, the plugin is optional and the user can choose whether to include it."
-        },
-        "onSetupMessage": {
-          "type": "string",
-          "description": "Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning)."
-        },
-        "stability": {
-          "type": "string",
-          "enum": ["beta", "ga"],
-          "default": "ga",
-          "description": "Plugin stability level. Beta is heading to GA; APIs may change between minor releases. GA (general availability) follows semver."
-        },
-        "resources": {
-          "type": "object",
-          "required": ["required", "optional"],
-          "description": "Databricks resource requirements for this plugin",
-          "properties": {
-            "required": {
-              "type": "array",
-              "description": "Resources that must be available for the plugin to function",
-              "items": {
-                "$ref": "#/$defs/resourceRequirement"
-              }
-            },
-            "optional": {
-              "type": "array",
-              "description": "Resources that enhance functionality but are not mandatory",
-              "items": {
-                "$ref": "#/$defs/resourceRequirement"
-              }
-            }
-          },
-          "additionalProperties": false
-        }
-      },
-      "additionalProperties": false
-    },
-    "resourceType": {
-      "$ref": "plugin-manifest.schema.json#/$defs/resourceType"
-    },
-    "resourceFieldEntry": {
-      "$ref": "plugin-manifest.schema.json#/$defs/resourceFieldEntry"
-    },
-    "resourceRequirement": {
-      "$ref": "plugin-manifest.schema.json#/$defs/resourceRequirement"
-    }
-  }
-}

package/docs/api/appkit/Interface.ResourceFieldEntry.md

@@ -1,82 +0,0 @@
-# Interface: ResourceFieldEntry
-
-Defines a single field for a resource. Each field has its own environment variable and optional description. Single-value types use one key (e.g. id); multi-value types (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).
-
-This interface was referenced by `PluginManifest`'s JSON-Schema via the `definition` "resourceFieldEntry".
-
-## Properties[​](#properties "Direct link to Properties")
-
-### bundleIgnore?[​](#bundleignore "Direct link to bundleIgnore?")
-
-```ts
-optional bundleIgnore: boolean;
-
-```
-
-When true, this field is excluded from Databricks bundle configuration (databricks.yml) generation.
-
-***
-
-### description?[​](#description "Direct link to description?")
-
-```ts
-optional description: string;
-
-```
-
-Human-readable description for this field
-
-***
-
-### env?[​](#env "Direct link to env?")
-
-```ts
-optional env: string;
-
-```
-
-Environment variable name for this field
-
-***
-
-### examples?[​](#examples "Direct link to examples?")
-
-```ts
-optional examples: string[];
-
-```
-
-Example values showing the expected format for this field
-
-***
-
-### localOnly?[​](#localonly "Direct link to localOnly?")
-
-```ts
-optional localOnly: boolean;
-
-```
-
-When true, this field is only generated for local .env files. The Databricks Apps platform auto-injects it at deploy time.
-
-***
-
-### resolve?[​](#resolve "Direct link to resolve?")
-
-```ts
-optional resolve: string;
-
-```
-
-Named resolver prefixed by resource type (e.g., 'postgres<!-- -->:host<!-- -->'). The CLI resolves this value during the init prompt flow.
-
-***
-
-### value?[​](#value "Direct link to value?")
-
-```ts
-optional value: string;
-
-```
-
-Static value for this field. Used when no prompted or resolved value exists.