@databricks/appkit 0.37.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/dist/shared/src/schemas/plugin-manifest.generated.d.ts

@@ -1,182 +0,0 @@
-//#region ../shared/src/schemas/plugin-manifest.generated.d.ts
-/**
- * Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().
- *
- * This interface was referenced by `PluginManifest`'s JSON-Schema
- * via the `definition` "resourceRequirement".
- */
-type ResourceRequirement = {
-  type: ResourceType;
-  /**
-   * Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
-   */
-  alias: string;
-  /**
-   * Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
-   */
-  resourceKey: string;
-  /**
-   * Human-readable description of why this resource is needed
-   */
-  description: string;
-  /**
-   * Required permission level. Validated per resource type by the allOf/if-then rules below.
-   */
-  permission: string;
-  /**
-   * Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance_name, database_name or scope, key).
-   */
-  fields?: {
-    [k: string]: ResourceFieldEntry;
-  };
-};
-/**
- * Type of Databricks resource
- *
- * This interface was referenced by `PluginManifest`'s JSON-Schema
- * via the `definition` "resourceType".
- */
-type ResourceType = "secret" | "job" | "sql_warehouse" | "serving_endpoint" | "volume" | "vector_search_index" | "uc_function" | "uc_connection" | "database" | "postgres" | "genie_space" | "experiment" | "app";
-/**
- * Schema for Databricks AppKit plugin manifest files. Defines plugin metadata, resource requirements, and configuration options.
- */
-interface PluginManifest {
-  /**
-   * Reference to the JSON Schema for validation
-   */
-  $schema?: string;
-  /**
-   * Plugin identifier. Must be lowercase, start with a letter, and contain only letters, numbers, and hyphens.
-   */
-  name: string;
-  /**
-   * Human-readable display name for UI and CLI
-   */
-  displayName: string;
-  /**
-   * Brief description of what the plugin does
-   */
-  description: string;
-  /**
-   * Databricks resource requirements for this plugin
-   */
-  resources: {
-    /**
-     * Resources that must be available for the plugin to function
-     */
-    required: ResourceRequirement[];
-    /**
-     * Resources that enhance functionality but are not mandatory
-     */
-    optional: ResourceRequirement[];
-  };
-  /**
-   * Configuration schema for the plugin
-   */
-  config?: {
-    schema?: ConfigSchema;
-  };
-  /**
-   * Author name or organization
-   */
-  author?: string;
-  /**
-   * Plugin version (semver format)
-   */
-  version?: string;
-  /**
-   * URL to the plugin's source repository
-   */
-  repository?: string;
-  /**
-   * Keywords for plugin discovery
-   */
-  keywords?: string[];
-  /**
-   * SPDX license identifier
-   */
-  license?: string;
-  /**
-   * Message displayed to the user after project initialization. Use this to inform about manual setup steps (e.g. environment variables, resource provisioning).
-   */
-  onSetupMessage?: string;
-  /**
-   * When true, this plugin is excluded from the template plugins manifest (appkit.plugins.json) during sync.
-   */
-  hidden?: boolean;
-  /**
-   * Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly.
-   */
-  stability?: "beta" | "ga";
-}
-/**
- * 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".
- */
-interface ResourceFieldEntry {
-  /**
-   * Environment variable name for this field
-   */
-  env?: string;
-  /**
-   * Human-readable description for this field
-   */
-  description?: string;
-  /**
-   * When true, this field is excluded from Databricks bundle configuration (databricks.yml) generation.
-   */
-  bundleIgnore?: boolean;
-  /**
-   * Example values showing the expected format for this field
-   */
-  examples?: string[];
-  /**
-   * When true, this field is only generated for local .env files. The Databricks Apps platform auto-injects it at deploy time.
-   */
-  localOnly?: boolean;
-  /**
-   * Static value for this field. Used when no prompted or resolved value exists.
-   */
-  value?: string;
-  /**
-   * Named resolver prefixed by resource type (e.g., 'postgres:host'). The CLI resolves this value during the init prompt flow.
-   */
-  resolve?: string;
-}
-/**
- * This interface was referenced by `PluginManifest`'s JSON-Schema
- * via the `definition` "configSchema".
- */
-interface ConfigSchema {
-  type: "object" | "array" | "string" | "number" | "boolean";
-  properties?: {
-    [k: string]: ConfigSchemaProperty;
-  };
-  items?: ConfigSchema;
-  required?: string[];
-  additionalProperties?: boolean;
-}
-/**
- * This interface was referenced by `PluginManifest`'s JSON-Schema
- * via the `definition` "configSchemaProperty".
- */
-interface ConfigSchemaProperty {
-  type: "object" | "array" | "string" | "number" | "boolean" | "integer";
-  description?: string;
-  default?: unknown;
-  enum?: unknown[];
-  properties?: {
-    [k: string]: ConfigSchemaProperty;
-  };
-  items?: ConfigSchemaProperty;
-  minimum?: number;
-  maximum?: number;
-  minLength?: number;
-  maxLength?: number;
-  required?: string[];
-}
-//#endregion
-export { PluginManifest, ResourceFieldEntry, ResourceRequirement };
-//# sourceMappingURL=plugin-manifest.generated.d.ts.map

package/dist/shared/src/schemas/plugin-manifest.generated.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin-manifest.generated.d.ts","names":[],"sources":["../../../../../shared/src/schemas/plugin-manifest.generated.ts"],"mappings":";;AAQA;;;;;KAAY,mBAAA;EACV,IAAA,EAAM,YAAA;EAQN;;;EAJA,KAAA;EAiBG;;;EAbH,WAAA;EAsBU;;;EAlBV,WAAA;EAkBsB;AAiHxB;;EA/HE,UAAA;EAuJY;;;EAnJZ,MAAA;IAAA,CACG,CAAA,WAAY,kBAAA;EAAA;AAAA;;;;;;;KASL,YAAA;;;;UAiHK,cAAA;;;;EAIf,OAAA;;;;EAIA,IAAA;;;;EAIA,WAAA;;;;EAIA,WAAA;;;;EAIA,SAAA;;;;IAIE,QAAA,EAAU,mBAAA;;;;IAIV,QAAA,EAAU,mBAAA;EAAA;;;;EAKZ,MAAA;IACE,MAAA,GAAS,YAAA;EAAA;;;;EAKX,MAAA;;;;EAIA,OAAA;;;;EAIA,UAAA;;;;EAIA,QAAA;;;;EAIA,OAAA;;;;EAIA,cAAA;;;;EAIA,MAAA;;;;EAIA,SAAA;AAAA;;;;;;;UAQe,kBAAA;;;;EAIf,GAAA;;;;EAIA,WAAA;;;;EAIA,YAAA;;;;EAIA,QAAA;;;;EAIA,SAAA;;;;EAIA,KAAA;;;;EAIA,OAAA;AAAA;;;;;UAMe,YAAA;EACf,IAAA;EACA,UAAA;IAAA,CACG,CAAA,WAAY,oBAAA;EAAA;EAEf,KAAA,GAAQ,YAAA;EACR,QAAA;EACA,oBAAA;AAAA;;;;;UAMe,oBAAA;EACf,IAAA;EACA,WAAA;EACA,OAAA;EACA,IAAA;EACA,UAAA;IAAA,CACG,CAAA,WAAY,oBAAA;EAAA;EAEf,KAAA,GAAQ,oBAAA;EACR,OAAA;EACA,OAAA;EACA,SAAA;EACA,SAAA;EACA,QAAA;AAAA"}

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.