@databricks/appkit 0.5.3 → 0.6.0

package/dist/registry/types.d.ts

@@ -0,0 +1,181 @@
+import { JSONSchema7 } from "json-schema";
+
+//#region src/registry/types.d.ts
+
+/**
+ * Resource Registry Type System
+ *
+ * This module defines the type system for the AppKit Resource Registry,
+ * which enables plugins to declare their Databricks resource requirements
+ * in a machine-readable format.
+ *
+ * Resource types are exposed as first-class citizens with their specific
+ * permissions, making it simple for users to declare dependencies.
+ * Internal tooling handles conversion to Databricks app.yaml format.
+ */
+/**
+ * Supported resource types that plugins can depend on.
+ * Each type has its own set of valid permissions.
+ */
+declare enum ResourceType {
+  /** Secret scope for secure credential storage */
+  SECRET = "secret",
+  /** Databricks Job for scheduled or triggered workflows */
+  JOB = "job",
+  /** Databricks SQL Warehouse for query execution */
+  SQL_WAREHOUSE = "sql_warehouse",
+  /** Model serving endpoint for ML inference */
+  SERVING_ENDPOINT = "serving_endpoint",
+  /** Unity Catalog Volume for file storage */
+  VOLUME = "volume",
+  /** Vector Search Index for similarity search */
+  VECTOR_SEARCH_INDEX = "vector_search_index",
+  /** Unity Catalog Function */
+  UC_FUNCTION = "uc_function",
+  /** Unity Catalog Connection for external data sources */
+  UC_CONNECTION = "uc_connection",
+  /** Database (Lakebase) for persistent storage */
+  DATABASE = "database",
+  /** Genie Space for AI assistant */
+  GENIE_SPACE = "genie_space",
+  /** MLflow Experiment for ML tracking */
+  EXPERIMENT = "experiment",
+  /** Databricks App dependency */
+  APP = "app",
+}
+/** Permissions for SECRET resources */
+type SecretPermission = "MANAGE" | "READ" | "WRITE";
+/** Permissions for JOB resources */
+type JobPermission = "CAN_MANAGE" | "CAN_MANAGE_RUN" | "CAN_VIEW";
+/** Permissions for SQL_WAREHOUSE resources */
+type SqlWarehousePermission = "CAN_MANAGE" | "CAN_USE";
+/** Permissions for SERVING_ENDPOINT resources */
+type ServingEndpointPermission = "CAN_MANAGE" | "CAN_QUERY" | "CAN_VIEW";
+/** Permissions for VOLUME resources */
+type VolumePermission = "READ_VOLUME" | "WRITE_VOLUME";
+/** Permissions for VECTOR_SEARCH_INDEX resources */
+type VectorSearchIndexPermission = "SELECT";
+/** Permissions for UC_FUNCTION resources */
+type UcFunctionPermission = "EXECUTE";
+/** Permissions for UC_CONNECTION resources */
+type UcConnectionPermission = "USE_CONNECTION";
+/** Permissions for DATABASE resources */
+type DatabasePermission = "CAN_CONNECT_AND_CREATE";
+/** Permissions for GENIE_SPACE resources */
+type GenieSpacePermission = "CAN_EDIT" | "CAN_VIEW" | "CAN_RUN" | "CAN_MANAGE";
+/** Permissions for EXPERIMENT resources */
+type ExperimentPermission = "CAN_READ" | "CAN_EDIT" | "CAN_MANAGE";
+/** Permissions for APP resources */
+type AppPermission = "CAN_USE";
+/**
+ * Union of all possible permission levels across all resource types.
+ */
+type ResourcePermission = SecretPermission | JobPermission | SqlWarehousePermission | ServingEndpointPermission | VolumePermission | VectorSearchIndexPermission | UcFunctionPermission | UcConnectionPermission | DatabasePermission | GenieSpacePermission | ExperimentPermission | AppPermission;
+/**
+ * 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).
+ */
+interface ResourceFieldEntry {
+  /** Environment variable name for this field */
+  env: string;
+  /** Human-readable description for this field */
+  description?: string;
+}
+/**
+ * Declares a resource requirement for a plugin.
+ * Can be defined statically in a manifest or dynamically via getResourceRequirements().
+ */
+interface ResourceRequirement {
+  /** Type of Databricks resource required */
+  type: ResourceType;
+  /** Unique alias for this resource within the plugin (e.g., 'warehouse', 'secrets'). Used for UI/display. */
+  alias: string;
+  /** Stable key for machine use (env naming, composite keys, app.yaml). Required. */
+  resourceKey: string;
+  /** Human-readable description of why this resource is needed */
+  description: string;
+  /** Required permission level for the resource */
+  permission: ResourcePermission;
+  /**
+   * Map of field name to env and optional description.
+   * Single-value types use one key (e.g. id); multi-value (database, secret) use multiple keys.
+   */
+  fields: Record<string, ResourceFieldEntry>;
+  /** Whether this resource is required (true) or optional (false) */
+  required: boolean;
+}
+/**
+ * Internal representation of a resource in the registry.
+ * Extends ResourceRequirement with resolution state and plugin ownership.
+ */
+interface ResourceEntry extends ResourceRequirement {
+  /** Plugin(s) that require this resource (comma-separated if multiple) */
+  plugin: string;
+  /** Whether the resource has been resolved (all field env vars set) */
+  resolved: boolean;
+  /** Resolved value per field name. Populated by validate() when all field env vars are set. */
+  values?: Record<string, string>;
+  /**
+   * Per-plugin permission tracking.
+   * Maps plugin name to the permission it originally requested.
+   * Populated when multiple plugins share the same resource.
+   */
+  permissionSources?: Record<string, ResourcePermission>;
+}
+/**
+ * Result of validating all registered resources against the environment.
+ */
+interface ValidationResult {
+  /** Whether all required resources are available */
+  valid: boolean;
+  /** List of missing required resources */
+  missing: ResourceEntry[];
+  /** Complete list of all registered resources (required and optional) */
+  all: ResourceEntry[];
+}
+/**
+ * Configuration schema definition for plugin config.
+ * Re-exported from the standard JSON Schema Draft 7 types.
+ *
+ * @see {@link https://json-schema.org/draft-07/json-schema-release-notes | JSON Schema Draft 7}
+ */
+type ConfigSchema = JSONSchema7;
+/**
+ * Plugin manifest that declares metadata and resource requirements.
+ * Attached to plugin classes as a static property.
+ */
+interface PluginManifest {
+  /** Plugin identifier (matches plugin.name) */
+  name: string;
+  /** Human-readable display name for UI/CLI */
+  displayName: string;
+  /** Brief description of what the plugin does */
+  description: string;
+  /**
+   * Resource requirements declaration
+   */
+  resources: {
+    /** Resources that must be available for the plugin to function */
+    required: Omit<ResourceRequirement, "required">[];
+    /** Resources that enhance functionality but are not mandatory */
+    optional: Omit<ResourceRequirement, "required">[];
+  };
+  /**
+   * Configuration schema for the plugin.
+   * Defines the shape and validation rules for plugin config.
+   */
+  config?: {
+    schema: ConfigSchema;
+  };
+  /**
+   * Optional metadata for community plugins
+   */
+  author?: string;
+  version?: string;
+  repository?: string;
+  keywords?: string[];
+  license?: string;
+}
+//#endregion
+export { ConfigSchema, PluginManifest, ResourceEntry, ResourceFieldEntry, ResourcePermission, ResourceRequirement, ResourceType, ValidationResult };
+//# sourceMappingURL=types.d.ts.map

package/dist/registry/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/registry/types.ts"],"sourcesContent":[],"mappings":";;;;;;;AAgBA;AA2CA;AAGA;AAGA;AAGA;AAGA;AAGA;AAGA;AAGA;AAGA;AAGA;AAOA;AAGY,aAhFA,YAAA;EAqFA;EAAkB,MAAA,GAAA,QAAA;;KAE1B,GAAA,KAAA;;eAEA,GAAA,eAAA;;kBAEA,GAAA,kBAAA;;QAEA,GAAA,QAAA;;qBAEA,GAAA,qBAAA;;aAEA,GAAA,aAAA;EAAa;EAmCA,aAAA,GAAA,eAAkB;EAWlB;EAAmB,QAAA,GAAA,UAAA;;aActB,GAAA,aAAA;;YAMJ,GAAA,YAAA;EAAM;EAUC,GAAA,GAAA,KAAA;;;AAeoB,KAjJzB,gBAAA,GAiJyB,QAAA,GAAA,MAAA,GAAA,OAAA;;AAfE,KA/H3B,aAAA,GA+H2B,YAAA,GAAA,gBAAA,GAAA,UAAA;;AAqBtB,KAjJL,sBAAA,GAiJqB,YAAA,GAAA,SAAA;;AAKtB,KAnJC,yBAAA,GAmJD,YAAA,GAAA,WAAA,GAAA,UAAA;;AAGS,KAnJR,gBAAA,GAmJQ,aAAA,GAAA,cAAA;AAWpB;AAMiB,KAjKL,2BAAA,GAiKmB,QAAA;;AAeZ,KA7KP,oBAAA,GA6KO,SAAA;;AAGA,KA7KP,sBAAA,GA6KO,gBAAA;;AAQP,KAlLA,kBAAA,GAkLA,wBAAA;;KA/KA,oBAAA;;KAOA,oBAAA;;KAGA,aAAA;;;;KAKA,kBAAA,GACR,mBACA,gBACA,yBACA,4BACA,mBACA,8BACA,uBACA,yBACA,qBACA,uBACA,uBACA;;;;;UAmCa,kBAAA;;;;;;;;;;UAWA,mBAAA;;QAET;;;;;;;;cAYM;;;;;UAMJ,eAAe;;;;;;;;UAUR,aAAA,SAAsB;;;;;;WAQ5B;;;;;;sBAOW,eAAe;;;;;UAMpB,gBAAA;;;;WAKN;;OAGJ;;;;;;;;KAWK,YAAA,GAAe;;;;;UAMV,cAAA;;;;;;;;;;;;cAeH,KAAK;;cAGL,KAAK;;;;;;;YAQP"}

package/dist/registry/types.js

@@ -0,0 +1,89 @@
+//#region src/registry/types.ts
+/**
+* Resource Registry Type System
+*
+* This module defines the type system for the AppKit Resource Registry,
+* which enables plugins to declare their Databricks resource requirements
+* in a machine-readable format.
+*
+* Resource types are exposed as first-class citizens with their specific
+* permissions, making it simple for users to declare dependencies.
+* Internal tooling handles conversion to Databricks app.yaml format.
+*/
+/**
+* Supported resource types that plugins can depend on.
+* Each type has its own set of valid permissions.
+*/
+let ResourceType = /* @__PURE__ */ function(ResourceType) {
+	/** Secret scope for secure credential storage */
+	ResourceType["SECRET"] = "secret";
+	/** Databricks Job for scheduled or triggered workflows */
+	ResourceType["JOB"] = "job";
+	/** Databricks SQL Warehouse for query execution */
+	ResourceType["SQL_WAREHOUSE"] = "sql_warehouse";
+	/** Model serving endpoint for ML inference */
+	ResourceType["SERVING_ENDPOINT"] = "serving_endpoint";
+	/** Unity Catalog Volume for file storage */
+	ResourceType["VOLUME"] = "volume";
+	/** Vector Search Index for similarity search */
+	ResourceType["VECTOR_SEARCH_INDEX"] = "vector_search_index";
+	/** Unity Catalog Function */
+	ResourceType["UC_FUNCTION"] = "uc_function";
+	/** Unity Catalog Connection for external data sources */
+	ResourceType["UC_CONNECTION"] = "uc_connection";
+	/** Database (Lakebase) for persistent storage */
+	ResourceType["DATABASE"] = "database";
+	/** Genie Space for AI assistant */
+	ResourceType["GENIE_SPACE"] = "genie_space";
+	/** MLflow Experiment for ML tracking */
+	ResourceType["EXPERIMENT"] = "experiment";
+	/** Databricks App dependency */
+	ResourceType["APP"] = "app";
+	return ResourceType;
+}({});
+/**
+* Permission hierarchy per resource type (weakest to strongest).
+* Used to compare permissions when merging; higher index = more permissive.
+* Unknown permissions are treated as less than any known permission.
+*/
+const PERMISSION_HIERARCHY_BY_TYPE = {
+	[ResourceType.SECRET]: [
+		"READ",
+		"WRITE",
+		"MANAGE"
+	],
+	[ResourceType.JOB]: [
+		"CAN_VIEW",
+		"CAN_MANAGE_RUN",
+		"CAN_MANAGE"
+	],
+	[ResourceType.SQL_WAREHOUSE]: ["CAN_USE", "CAN_MANAGE"],
+	[ResourceType.SERVING_ENDPOINT]: [
+		"CAN_VIEW",
+		"CAN_QUERY",
+		"CAN_MANAGE"
+	],
+	[ResourceType.VOLUME]: ["READ_VOLUME", "WRITE_VOLUME"],
+	[ResourceType.VECTOR_SEARCH_INDEX]: ["SELECT"],
+	[ResourceType.UC_FUNCTION]: ["EXECUTE"],
+	[ResourceType.UC_CONNECTION]: ["USE_CONNECTION"],
+	[ResourceType.DATABASE]: ["CAN_CONNECT_AND_CREATE"],
+	[ResourceType.GENIE_SPACE]: [
+		"CAN_VIEW",
+		"CAN_RUN",
+		"CAN_EDIT",
+		"CAN_MANAGE"
+	],
+	[ResourceType.EXPERIMENT]: [
+		"CAN_READ",
+		"CAN_EDIT",
+		"CAN_MANAGE"
+	],
+	[ResourceType.APP]: ["CAN_USE"]
+};
+/** Set of valid permissions per type (for validation). */
+const PERMISSIONS_BY_TYPE = PERMISSION_HIERARCHY_BY_TYPE;
+
+//#endregion
+export { PERMISSIONS_BY_TYPE, PERMISSION_HIERARCHY_BY_TYPE, ResourceType };
+//# sourceMappingURL=types.js.map

package/dist/registry/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../src/registry/types.ts"],"sourcesContent":["/**\n * Resource Registry Type System\n *\n * This module defines the type system for the AppKit Resource Registry,\n * which enables plugins to declare their Databricks resource requirements\n * in a machine-readable format.\n *\n * Resource types are exposed as first-class citizens with their specific\n * permissions, making it simple for users to declare dependencies.\n * Internal tooling handles conversion to Databricks app.yaml format.\n */\n\n/**\n * Supported resource types that plugins can depend on.\n * Each type has its own set of valid permissions.\n */\nexport enum ResourceType {\n  /** Secret scope for secure credential storage */\n  SECRET = \"secret\",\n\n  /** Databricks Job for scheduled or triggered workflows */\n  JOB = \"job\",\n\n  /** Databricks SQL Warehouse for query execution */\n  SQL_WAREHOUSE = \"sql_warehouse\",\n\n  /** Model serving endpoint for ML inference */\n  SERVING_ENDPOINT = \"serving_endpoint\",\n\n  /** Unity Catalog Volume for file storage */\n  VOLUME = \"volume\",\n\n  /** Vector Search Index for similarity search */\n  VECTOR_SEARCH_INDEX = \"vector_search_index\",\n\n  /** Unity Catalog Function */\n  UC_FUNCTION = \"uc_function\",\n\n  /** Unity Catalog Connection for external data sources */\n  UC_CONNECTION = \"uc_connection\",\n\n  /** Database (Lakebase) for persistent storage */\n  DATABASE = \"database\",\n\n  /** Genie Space for AI assistant */\n  GENIE_SPACE = \"genie_space\",\n\n  /** MLflow Experiment for ML tracking */\n  EXPERIMENT = \"experiment\",\n\n  /** Databricks App dependency */\n  APP = \"app\",\n}\n\n// ============================================================================\n// Permissions per resource type\n// ============================================================================\n\n/** Permissions for SECRET resources */\nexport type SecretPermission = \"MANAGE\" | \"READ\" | \"WRITE\";\n\n/** Permissions for JOB resources */\nexport type JobPermission = \"CAN_MANAGE\" | \"CAN_MANAGE_RUN\" | \"CAN_VIEW\";\n\n/** Permissions for SQL_WAREHOUSE resources */\nexport type SqlWarehousePermission = \"CAN_MANAGE\" | \"CAN_USE\";\n\n/** Permissions for SERVING_ENDPOINT resources */\nexport type ServingEndpointPermission = \"CAN_MANAGE\" | \"CAN_QUERY\" | \"CAN_VIEW\";\n\n/** Permissions for VOLUME resources */\nexport type VolumePermission = \"READ_VOLUME\" | \"WRITE_VOLUME\";\n\n/** Permissions for VECTOR_SEARCH_INDEX resources */\nexport type VectorSearchIndexPermission = \"SELECT\";\n\n/** Permissions for UC_FUNCTION resources */\nexport type UcFunctionPermission = \"EXECUTE\";\n\n/** Permissions for UC_CONNECTION resources */\nexport type UcConnectionPermission = \"USE_CONNECTION\";\n\n/** Permissions for DATABASE resources */\nexport type DatabasePermission = \"CAN_CONNECT_AND_CREATE\";\n\n/** Permissions for GENIE_SPACE resources */\nexport type GenieSpacePermission =\n  | \"CAN_EDIT\"\n  | \"CAN_VIEW\"\n  | \"CAN_RUN\"\n  | \"CAN_MANAGE\";\n\n/** Permissions for EXPERIMENT resources */\nexport type ExperimentPermission = \"CAN_READ\" | \"CAN_EDIT\" | \"CAN_MANAGE\";\n\n/** Permissions for APP resources */\nexport type AppPermission = \"CAN_USE\";\n\n/**\n * Union of all possible permission levels across all resource types.\n */\nexport type ResourcePermission =\n  | SecretPermission\n  | JobPermission\n  | SqlWarehousePermission\n  | ServingEndpointPermission\n  | VolumePermission\n  | VectorSearchIndexPermission\n  | UcFunctionPermission\n  | UcConnectionPermission\n  | DatabasePermission\n  | GenieSpacePermission\n  | ExperimentPermission\n  | AppPermission;\n\n/**\n * Permission hierarchy per resource type (weakest to strongest).\n * Used to compare permissions when merging; higher index = more permissive.\n * Unknown permissions are treated as less than any known permission.\n */\nexport const PERMISSION_HIERARCHY_BY_TYPE: Record<\n  ResourceType,\n  readonly ResourcePermission[]\n> = {\n  [ResourceType.SECRET]: [\"READ\", \"WRITE\", \"MANAGE\"],\n  [ResourceType.JOB]: [\"CAN_VIEW\", \"CAN_MANAGE_RUN\", \"CAN_MANAGE\"],\n  [ResourceType.SQL_WAREHOUSE]: [\"CAN_USE\", \"CAN_MANAGE\"],\n  [ResourceType.SERVING_ENDPOINT]: [\"CAN_VIEW\", \"CAN_QUERY\", \"CAN_MANAGE\"],\n  [ResourceType.VOLUME]: [\"READ_VOLUME\", \"WRITE_VOLUME\"],\n  [ResourceType.VECTOR_SEARCH_INDEX]: [\"SELECT\"],\n  [ResourceType.UC_FUNCTION]: [\"EXECUTE\"],\n  [ResourceType.UC_CONNECTION]: [\"USE_CONNECTION\"],\n  [ResourceType.DATABASE]: [\"CAN_CONNECT_AND_CREATE\"],\n  [ResourceType.GENIE_SPACE]: [\"CAN_VIEW\", \"CAN_RUN\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n  [ResourceType.EXPERIMENT]: [\"CAN_READ\", \"CAN_EDIT\", \"CAN_MANAGE\"],\n  [ResourceType.APP]: [\"CAN_USE\"],\n} as const;\n\n/** Set of valid permissions per type (for validation). */\nexport const PERMISSIONS_BY_TYPE: Record<\n  ResourceType,\n  readonly ResourcePermission[]\n> = PERMISSION_HIERARCHY_BY_TYPE;\n\n/**\n * Defines a single field for a resource. Each field has its own environment variable and optional description.\n * 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).\n */\nexport interface ResourceFieldEntry {\n  /** Environment variable name for this field */\n  env: string;\n  /** Human-readable description for this field */\n  description?: string;\n}\n\n/**\n * Declares a resource requirement for a plugin.\n * Can be defined statically in a manifest or dynamically via getResourceRequirements().\n */\nexport interface ResourceRequirement {\n  /** Type of Databricks resource required */\n  type: ResourceType;\n\n  /** Unique alias for this resource within the plugin (e.g., 'warehouse', 'secrets'). Used for UI/display. */\n  alias: string;\n\n  /** Stable key for machine use (env naming, composite keys, app.yaml). Required. */\n  resourceKey: string;\n\n  /** Human-readable description of why this resource is needed */\n  description: string;\n\n  /** Required permission level for the resource */\n  permission: ResourcePermission;\n\n  /**\n   * Map of field name to env and optional description.\n   * Single-value types use one key (e.g. id); multi-value (database, secret) use multiple keys.\n   */\n  fields: Record<string, ResourceFieldEntry>;\n\n  /** Whether this resource is required (true) or optional (false) */\n  required: boolean;\n}\n\n/**\n * Internal representation of a resource in the registry.\n * Extends ResourceRequirement with resolution state and plugin ownership.\n */\nexport interface ResourceEntry extends ResourceRequirement {\n  /** Plugin(s) that require this resource (comma-separated if multiple) */\n  plugin: string;\n\n  /** Whether the resource has been resolved (all field env vars set) */\n  resolved: boolean;\n\n  /** Resolved value per field name. Populated by validate() when all field env vars are set. */\n  values?: Record<string, string>;\n\n  /**\n   * Per-plugin permission tracking.\n   * Maps plugin name to the permission it originally requested.\n   * Populated when multiple plugins share the same resource.\n   */\n  permissionSources?: Record<string, ResourcePermission>;\n}\n\n/**\n * Result of validating all registered resources against the environment.\n */\nexport interface ValidationResult {\n  /** Whether all required resources are available */\n  valid: boolean;\n\n  /** List of missing required resources */\n  missing: ResourceEntry[];\n\n  /** Complete list of all registered resources (required and optional) */\n  all: ResourceEntry[];\n}\n\nimport type { JSONSchema7 } from \"json-schema\";\n\n/**\n * Configuration schema definition for plugin config.\n * Re-exported from the standard JSON Schema Draft 7 types.\n *\n * @see {@link https://json-schema.org/draft-07/json-schema-release-notes | JSON Schema Draft 7}\n */\nexport type ConfigSchema = JSONSchema7;\n\n/**\n * Plugin manifest that declares metadata and resource requirements.\n * Attached to plugin classes as a static property.\n */\nexport interface PluginManifest {\n  /** Plugin identifier (matches plugin.name) */\n  name: string;\n\n  /** Human-readable display name for UI/CLI */\n  displayName: string;\n\n  /** Brief description of what the plugin does */\n  description: string;\n\n  /**\n   * Resource requirements declaration\n   */\n  resources: {\n    /** Resources that must be available for the plugin to function */\n    required: Omit<ResourceRequirement, \"required\">[];\n\n    /** Resources that enhance functionality but are not mandatory */\n    optional: Omit<ResourceRequirement, \"required\">[];\n  };\n\n  /**\n   * Configuration schema for the plugin.\n   * Defines the shape and validation rules for plugin config.\n   */\n  config?: {\n    schema: ConfigSchema;\n  };\n\n  /**\n   * Optional metadata for community plugins\n   */\n  author?: string;\n  version?: string;\n  repository?: string;\n  keywords?: string[];\n  license?: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAgBA,IAAY,sDAAL;;AAEL;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;AAGA;;;;;;;;AAqEF,MAAa,+BAGT;EACD,aAAa,SAAS;EAAC;EAAQ;EAAS;EAAS;EACjD,aAAa,MAAM;EAAC;EAAY;EAAkB;EAAa;EAC/D,aAAa,gBAAgB,CAAC,WAAW,aAAa;EACtD,aAAa,mBAAmB;EAAC;EAAY;EAAa;EAAa;EACvE,aAAa,SAAS,CAAC,eAAe,eAAe;EACrD,aAAa,sBAAsB,CAAC,SAAS;EAC7C,aAAa,cAAc,CAAC,UAAU;EACtC,aAAa,gBAAgB,CAAC,iBAAiB;EAC/C,aAAa,WAAW,CAAC,yBAAyB;EAClD,aAAa,cAAc;EAAC;EAAY;EAAW;EAAY;EAAa;EAC5E,aAAa,aAAa;EAAC;EAAY;EAAY;EAAa;EAChE,aAAa,MAAM,CAAC,UAAU;CAChC;;AAGD,MAAa,sBAGT"}

package/dist/shared/src/plugin.d.ts

@@ -1,11 +1,11 @@
 import express from "express";
+import { JSONSchema7 } from "json-schema";
 
 //#region ../shared/src/plugin.d.ts
 /** Base plugin interface. */
 interface BasePlugin {
   name: string;
   abortActiveOperations?(): void;
-  validateEnv(): void;
   setup(): Promise<void>;
   injectRoutes(router: express.Router): void;
   getEndpoints(): PluginEndpointMap;
@@ -24,10 +24,75 @@ type TelemetryOptions = boolean | {
   logs?: boolean;
 };
 type PluginPhase = "core" | "normal" | "deferred";
+/**
+ * Plugin constructor with required manifest declaration.
+ * All plugins must declare a manifest with their metadata and resource requirements.
+ */
 type PluginConstructor<C = BasePluginConfig, I extends BasePlugin = BasePlugin> = (new (config: C) => I) & {
   DEFAULT_CONFIG?: Record<string, unknown>;
   phase?: PluginPhase;
+  /**
+   * Static manifest declaring plugin metadata and resource requirements.
+   * Required for all plugins.
+   */
+  manifest: PluginManifest;
+  /**
+   * Optional runtime resource requirements based on config.
+   * Use this when resource requirements depend on plugin configuration.
+   */
+  getResourceRequirements?(config: C): ResourceRequirement[];
 };
+/**
+ * Manifest declaration for plugins (imported from registry types).
+ * Re-exported here to avoid circular dependencies.
+ */
+interface PluginManifest {
+  name: string;
+  displayName: string;
+  description: string;
+  resources: {
+    required: Omit<ResourceRequirement, "required">[];
+    optional: Omit<ResourceRequirement, "required">[];
+  };
+  config?: {
+    schema: JSONSchema7;
+  };
+  author?: string;
+  version?: string;
+  repository?: string;
+  keywords?: string[];
+  license?: string;
+}
+/**
+ * Defines a single field for a resource.
+ * Each field maps to 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).
+ */
+interface ResourceFieldEntry {
+  /** Environment variable name for this field */
+  env: string;
+  /** Human-readable description for this field */
+  description?: string;
+}
+/**
+ * Resource requirement declaration (imported from registry types).
+ * Re-exported here to avoid circular dependencies.
+ */
+interface ResourceRequirement {
+  type: string;
+  alias: string;
+  /** Stable key for machine use (env naming, composite keys, app.yaml). */
+  resourceKey: string;
+  description: string;
+  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 keys.
+   */
+  fields: Record<string, ResourceFieldEntry>;
+  required: boolean;
+}
 /**
  * Extracts the exports type from a plugin.
  * This is the return type of the plugin's exports() method.

package/dist/shared/src/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","names":[],"sources":["../../../../shared/src/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAGiB,UAAA;EAAA,IAAA,EAAA,MAAA;EAAU,qBAAA,GAAA,EAAA,IAAA;aAOhB,EAAA,EAAA,IAAA;OAEY,EAAA,EAFZ,OAEoB,CAAA,IAAA,CAAA;cAEb,CAAA,MAAA,EAFK,OAAA,CAAQ,MAEb,CAAA,EAAA,IAAA;EAAiB,YAAA,EAAA,EAAjB,iBAAiB;EAMlB,OAAA,GAAA,EAAA,OAAgB;AAajC;AAaA;AAEY,UA5BK,gBAAA,CA4BY;EAAA,IAAA,CAAA,EAAA,MAAA;MACvB,CAAA,EAAA,MAAA;MACM,EAAA,MAAA,CAAA,EAAA,OAAA;WAAa,CAAA,EApBX,gBAoBW;;AAGpB,KApBO,gBAAA,GAoBP,OAAA,GAAA;QACc,CAAA,EAAA,OAAA;SACT,CAAA,EAAA,OAAA;EAAW,IAAA,CAAA,EAAA,OAAA;AAoCrB,CAAA;AAC2C,KA9C/B,WAAA,GA8C+B,MAAA,GAAA,QAAA,GAAA,UAAA;AAAM,KA5CrC,iBA4CqC,CAAA,IA3C3C,gBA2C2C,EAAA,UA1CrC,UA0CqC,GA1CxB,UA0CwB,CAAA,GAAA,CAAA,KAAA,MAAA,EAxCvC,CAwCuC,EAAA,GAvC5C,CAuC4C,CAAA,GAAA;EAMrC,cAAU,CAAA,EA5CH,MA4CG,CAAA,MAAA,EAAA,OAAA,CAAA;EAAA,KAAA,CAAA,EA3CZ,WA2CY;;;;;AAuBtB;;AACW,KA/BC,aA+BD,CAAA,UA/ByB,UA+BzB,CAAA,GA9BT,CA8BS,CAAA,SAAA,CAAA,UAAA,GAAA,GAAA,KAAA,EAAA,IA9B4B,CA8B5B,GA9BgC,MA8BhC,CAAA,MAAA,EAAA,KAAA,CAAA;;;;;AACI,KAzBH,UAyBG,CAAA,GAAA,CAAA,GAzBe,GAyBf,GAAA;EAGH;AACZ;AACA;AAEA;AAEA;EAAuB,MAAA,EAAA,CAAA,GAAA,EA5BP,WA4BO,EAAA,GA5BS,GA4BT;;;;;;AASvB;KA7BY,6BACS,WAAW,iDAExB,aAAa,YAAY,WAC7B,cAAc,aAAa;KAInB;UAAgC;UAAW;QAAS;;KACpD,6CACD,MACN,WAAW,GAAG,GAAG;;KAGV,UAAA,GAAa,OAAA,CAAQ;KACrB,YAAA,GAAe,OAAA,CAAQ;KACvB,WAAA,GAAc,OAAA,CAAQ;KAEtB,UAAA;KAEA,WAAA;;;UAGF;;iBAEO,kBAAkB,iBAAiB;;;KAIxC,iBAAA,GAAoB"}
+{"version":3,"file":"plugin.d.ts","names":[],"sources":["../../../../shared/src/plugin.ts"],"sourcesContent":[],"mappings":";;;;;UAIiB,UAAA;EAAA,IAAA,EAAA,MAAA;EAAU,qBAAA,GAAA,EAAA,IAAA;OAKhB,EAAA,EAAA,OAAA,CAAA,IAAA,CAAA;cAEoB,CAAA,MAAA,EAAR,OAAA,CAAQ,MAAA,CAAA,EAAA,IAAA;cAEb,EAAA,EAAA,iBAAA;EAAiB,OAAA,GAAA,EAAA,OAAA;AAMnC;AAaA;AAaY,UA1BK,gBAAA,CA0BM;EAMX,IAAA,CAAA,EAAA,MAAA;EAAiB,IAAA,CAAA,EAAA,MAAA;MACvB,EAAA,MAAA,CAAA,EAAA,OAAA;WACM,CAAA,EAxBE,gBAwBF;;AAEF,KAvBE,gBAAA,GAuBF,OAAA,GAAA;QACL,CAAA,EAAA,OAAA;SACc,CAAA,EAAA,OAAA;MACT,CAAA,EAAA,OAAA;;AAiBqB,KA9BnB,WAAA,GA8BmB,MAAA,GAAA,QAAA,GAAA,UAAA;;;;;AASnB,KAjCA,iBAiCA,CAAA,IAhCN,gBAgCM,EAAA,UA/BA,UA+BA,GA/Ba,UA+Bb,CAAA,GAAA,CAAA,KAAA,MAAA,EA7BF,CA6BE,EAAA,GA5BP,CA4BO,CAAA,GAAA;EAAW,cAAA,CAAA,EA3BJ,MA2BI,CAAA,MAAA,EAAA,OAAA,CAAA;EAeN,KAAA,CAAA,EAzCP,WAyCO;EAWA;;;;EAWD,QAAA,EA1DJ,cA0DI;EAqCJ;;;;yBAC2B,EAAA,MAAA,EA3FJ,CA2FI,CAAA,EA3FA,mBA2FA,EAAA;;;AAMvC;;;AAMgB,UAhGC,cAAA,CAgGD;MAAgB,EAAA,MAAA;EAAG,WAAA,EAAA,MAAA;EAQvB,WAAA,EAAS,MAAA;EAAA,SAAA,EAAA;IACW,QAAA,EApGlB,IAoGkB,CApGb,mBAoGa,EAAA,UAAA,CAAA,EAAA;IAAX,QAAA,EAnGP,IAmGO,CAnGF,mBAmGE,EAAA,UAAA,CAAA,EAAA;;QAEA,CAAA,EAAA;IACU,MAAA,EAnGnB,WAmGmB;;QAA3B,CAAA,EAAA,MAAA;SAD6B,CAAA,EAAA,MAAA;EAAU,UAAA,CAAA,EAAA,MAAA;EAK/B,QAAA,CAAA,EAAA,MAAU,EAAA;EAAA,OAAA,CAAA,EAAA,MAAA;;;;;AACtB;;;AAEgB,UA3FC,kBAAA,CA2FD;;KAAM,EAAA,MAAA;;EAAP,WAAA,CAAA,EAAA,MAAA;AAGf;AACA;AACA;AAEA;AAEA;AAAuB,UAzFN,mBAAA,CAyFM;MAGb,EAAA,MAAA;OAEO,EAAA,MAAA;;aAAmC,EAAA,MAAA;EAAO,WAAA,EAAA,MAAA;EAI/C,UAAA,EAAA,MAAA;;;;;UAvFF,eAAe;;;;;;;;KAqCb,wBAAwB,cAClC,uCAAqC,IAAI;;;;;KAM/B,kBAAkB;;;;;;gBAMd,gBAAgB;;;;;;;KAQpB,6BACS,WAAW,iDAExB,aAAa,YAAY,WAC7B,cAAc,aAAa;KAInB;UAAgC;UAAW;QAAS;;KACpD,6CACD,MACN,WAAW,GAAG,GAAG;;KAGV,UAAA,GAAa,OAAA,CAAQ;KACrB,YAAA,GAAe,OAAA,CAAQ;KACvB,WAAA,GAAc,OAAA,CAAQ;KAEtB,UAAA;KAEA,WAAA;;;UAGF;;iBAEO,kBAAkB,iBAAiB;;;KAIxC,iBAAA,GAAoB"}

package/dist/type-generator/query-registry.js

@@ -98,10 +98,13 @@ async function generateQueriesFromDescribe(queryFolder, warehouseId, options = {
 				warehouse_id: warehouseId
 			});
 			if (result.status.state === "FAILED") {
+				const sqlError = result.status.error?.message || "Query execution failed";
 				spinner.stop(`✗ ${queryName} - failed`);
+				spinner.printDetail(`SQL Error: ${sqlError}`);
+				spinner.printDetail(`Query: ${cleanedSql.slice(0, 200)}`);
 				failedQueries.push({
 					name: queryName,
-					error: "Query execution failed"
+					error: sqlError
 				});
 				continue;
 			}

package/dist/type-generator/query-registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-registry.js","names":[],"sources":["../../src/type-generator/query-registry.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport { WorkspaceClient } from \"@databricks/sdk-experimental\";\nimport { createLogger } from \"../logging/logger\";\nimport { CACHE_VERSION, hashSQL, loadCache, saveCache } from \"./cache\";\nimport { Spinner } from \"./spinner\";\nimport {\n  type DatabricksStatementExecutionResponse,\n  type QuerySchema,\n  sqlTypeToHelper,\n  sqlTypeToMarker,\n} from \"./types\";\n\nconst logger = createLogger(\"type-generator:query-registry\");\n\n/**\n * Extract parameters from a SQL query\n * @param sql - the SQL query to extract parameters from\n * @returns an array of parameter names\n */\nexport function extractParameters(sql: string): string[] {\n  const matches = sql.matchAll(/:([a-zA-Z_]\\w*)/g);\n  const params = new Set<string>();\n  for (const match of matches) {\n    params.add(match[1]);\n  }\n  return Array.from(params);\n}\n\n// parameters that are injected by the server\nexport const SERVER_INJECTED_PARAMS = [\"workspaceId\"];\n\nexport function convertToQueryType(\n  result: DatabricksStatementExecutionResponse,\n  sql: string,\n  queryName: string,\n): string {\n  const dataRows = result.result?.data_array || [];\n  const columns = dataRows.map((row) => ({\n    name: row[0] || \"\",\n    type_name: row[1]?.toUpperCase() || \"STRING\",\n    comment: row[2] || undefined,\n  }));\n\n  const params = extractParameters(sql).filter(\n    (p) => !SERVER_INJECTED_PARAMS.includes(p),\n  );\n\n  const paramTypes = extractParameterTypes(sql);\n\n  // generate parameters types with JSDoc hints\n  const paramsType =\n    params.length > 0\n      ? `{\\n      ${params\n          .map((p) => {\n            const sqlType = paramTypes[p];\n            // if no type annotation, use SQLTypeMarker (union type)\n            const markerType = sqlType\n              ? sqlTypeToMarker[sqlType]\n              : \"SQLTypeMarker\";\n            const helper = sqlType ? sqlTypeToHelper[sqlType] : \"sql.*()\";\n            return `/** ${sqlType || \"any\"} - use ${helper} */\\n      ${p}: ${markerType}`;\n          })\n          .join(\";\\n      \")};\\n    }`\n      : \"Record<string, never>\";\n\n  // generate result fields with JSDoc\n  const resultFields = columns.map((column) => {\n    const normalizedType = normalizeTypeName(column.type_name);\n    const mappedType = typeMap[normalizedType] || \"unknown\";\n    // validate column name is a valid identifier\n    const name = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(column.name)\n      ? column.name\n      : `\"${column.name}\"`;\n\n    // generate comment for column\n    const comment = column.comment\n      ? `/** ${column.comment} */\\n      `\n      : `/** @sqlType ${column.type_name} */\\n      `;\n\n    return `${comment}${name}: ${mappedType}`;\n  });\n\n  return `{\n    name: \"${queryName}\";\n    parameters: ${paramsType};\n    result: Array<{\n      ${resultFields.join(\";\\n      \")};\n    }>;\n  }`;\n}\n\nexport function extractParameterTypes(sql: string): Record<string, string> {\n  const paramTypes: Record<string, string> = {};\n  const regex =\n    /--\\s*@param\\s+(\\w+)\\s+(STRING|NUMERIC|BOOLEAN|DATE|TIMESTAMP|BINARY)/gi;\n  const matches = sql.matchAll(regex);\n  for (const match of matches) {\n    const [, paramName, paramType] = match;\n    paramTypes[paramName] = paramType.toUpperCase();\n  }\n\n  return paramTypes;\n}\n\n/**\n * Generate query schemas from a folder of SQL files\n * It uses DESCRIBE QUERY to get the schema without executing the query\n * @param queryFolder - the folder containing the SQL files\n * @param warehouseId - the warehouse id to use for schema analysis\n * @param options - options for the query generation\n * @param options.noCache - if true, skip the cache and regenerate all types\n * @returns an array of query schemas\n */\nexport async function generateQueriesFromDescribe(\n  queryFolder: string,\n  warehouseId: string,\n  options: { noCache?: boolean } = {},\n): Promise<QuerySchema[]> {\n  const { noCache = false } = options;\n\n  // read all query files in the folder\n  const queryFiles = fs\n    .readdirSync(queryFolder)\n    .filter((file) => file.endsWith(\".sql\"));\n\n  logger.debug(\"Found %d SQL queries\", queryFiles.length);\n\n  // load cache\n  const cache = noCache ? { version: CACHE_VERSION, queries: {} } : loadCache();\n\n  const client = new WorkspaceClient({});\n  const querySchemas: QuerySchema[] = [];\n  const failedQueries: { name: string; error: string }[] = [];\n  const spinner = new Spinner();\n\n  // process each query file\n  for (let i = 0; i < queryFiles.length; i++) {\n    const file = queryFiles[i];\n    const rawName = path.basename(file, \".sql\");\n    const queryName = normalizeQueryName(rawName);\n\n    // read query file content\n    const sql = fs.readFileSync(path.join(queryFolder, file), \"utf8\");\n    const sqlHash = hashSQL(sql);\n\n    // check cache\n    const cached = cache.queries[queryName];\n    if (cached && cached.hash === sqlHash) {\n      querySchemas.push({ name: queryName, type: cached.type });\n      spinner.start(`Processing ${queryName} (${i + 1}/${queryFiles.length})`);\n      spinner.stop(`✓ ${queryName} (cached)`);\n      continue;\n    }\n\n    spinner.start(`Processing ${queryName} (${i + 1}/${queryFiles.length})`);\n\n    const sqlWithDefaults = sql.replace(/:([a-zA-Z_]\\w*)/g, \"''\");\n\n    // strip trailing semicolon for DESCRIBE QUERY\n    const cleanedSql = sqlWithDefaults.trim().replace(/;\\s*$/, \"\");\n\n    // execute DESCRIBE QUERY to get schema without running the actual query\n    try {\n      const result = (await client.statementExecution.executeStatement({\n        statement: `DESCRIBE QUERY ${cleanedSql}`,\n        warehouse_id: warehouseId,\n      })) as DatabricksStatementExecutionResponse;\n\n      if (result.status.state === \"FAILED\") {\n        spinner.stop(`✗ ${queryName} - failed`);\n        failedQueries.push({\n          name: queryName,\n          error: \"Query execution failed\",\n        });\n        continue;\n      }\n\n      // convert result to query schema\n      const type = convertToQueryType(result, sql, queryName);\n      querySchemas.push({ name: queryName, type });\n\n      // update cache\n      cache.queries[queryName] = { hash: sqlHash, type };\n\n      spinner.stop(`✓ ${queryName}`);\n    } catch (error) {\n      const errorMessage =\n        error instanceof Error ? error.message : \"Unknown error\";\n      spinner.stop(`✗ ${queryName} - ${errorMessage}`);\n      failedQueries.push({ name: queryName, error: errorMessage });\n    }\n  }\n\n  // save cache\n  saveCache(cache);\n\n  // log warning if there are failed queries\n  if (failedQueries.length > 0) {\n    logger.debug(\"Warning: %d queries failed\", failedQueries.length);\n  }\n\n  return querySchemas;\n}\n\n/**\n * Normalize query name by removing the .obo extension\n * @param queryName - the query name to normalize\n * @returns the normalized query name\n */\nexport function normalizeQueryName(fileName: string): string {\n  return fileName.replace(/\\.obo$/, \"\");\n}\n\n/**\n * Normalize SQL type name by removing parameters/generics\n * Examples:\n *   DECIMAL(38,6) -> DECIMAL\n *   ARRAY<STRING> -> ARRAY\n *   MAP<STRING,INT> -> MAP\n *   STRUCT<name:STRING> -> STRUCT\n *   INTERVAL DAY TO SECOND -> INTERVAL\n *   GEOGRAPHY(4326) -> GEOGRAPHY\n */\nexport function normalizeTypeName(typeName: string): string {\n  return typeName\n    .replace(/\\(.*\\)$/, \"\") // remove (p, s) eg: DECIMAL(38,6) -> DECIMAL\n    .replace(/<.*>$/, \"\") // remove <T> eg: ARRAY<STRING> -> ARRAY\n    .split(\" \")[0]; // take first word eg: INTERVAL DAY TO SECOND -> INTERVAL\n}\n\n/** Type Map for Databricks data types to JavaScript types */\nconst typeMap: Record<string, string> = {\n  // string types\n  STRING: \"string\",\n  BINARY: \"string\",\n  // boolean\n  BOOLEAN: \"boolean\",\n  // numeric types\n  TINYINT: \"number\",\n  SMALLINT: \"number\",\n  INT: \"number\",\n  BIGINT: \"number\",\n  FLOAT: \"number\",\n  DOUBLE: \"number\",\n  DECIMAL: \"number\",\n  // date/time types\n  DATE: \"string\",\n  TIMESTAMP: \"string\",\n  TIMESTAMP_NTZ: \"string\",\n  INTERVAL: \"string\",\n  // complex types\n  ARRAY: \"unknown[]\",\n  MAP: \"Record<string, unknown>\",\n  STRUCT: \"Record<string, unknown>\",\n  OBJECT: \"Record<string, unknown>\",\n  VARIANT: \"unknown\",\n  // spatial types\n  GEOGRAPHY: \"unknown\",\n  GEOMETRY: \"unknown\",\n  // null type\n  VOID: \"null\",\n};\n"],"mappings":";;;;;;;;;AAaA,MAAM,SAAS,aAAa,gCAAgC;;;;;;AAO5D,SAAgB,kBAAkB,KAAuB;CACvD,MAAM,UAAU,IAAI,SAAS,mBAAmB;CAChD,MAAM,yBAAS,IAAI,KAAa;AAChC,MAAK,MAAM,SAAS,QAClB,QAAO,IAAI,MAAM,GAAG;AAEtB,QAAO,MAAM,KAAK,OAAO;;AAI3B,MAAa,yBAAyB,CAAC,cAAc;AAErD,SAAgB,mBACd,QACA,KACA,WACQ;CAER,MAAM,WADW,OAAO,QAAQ,cAAc,EAAE,EACvB,KAAK,SAAS;EACrC,MAAM,IAAI,MAAM;EAChB,WAAW,IAAI,IAAI,aAAa,IAAI;EACpC,SAAS,IAAI,MAAM;EACpB,EAAE;CAEH,MAAM,SAAS,kBAAkB,IAAI,CAAC,QACnC,MAAM,CAAC,uBAAuB,SAAS,EAAE,CAC3C;CAED,MAAM,aAAa,sBAAsB,IAAI;AAmC7C,QAAO;aACI,UAAU;kBAhCnB,OAAO,SAAS,IACZ,YAAY,OACT,KAAK,MAAM;EACV,MAAM,UAAU,WAAW;EAE3B,MAAM,aAAa,UACf,gBAAgB,WAChB;EACJ,MAAM,SAAS,UAAU,gBAAgB,WAAW;AACpD,SAAO,OAAO,WAAW,MAAM,SAAS,OAAO,aAAa,EAAE,IAAI;GAClE,CACD,KAAK,YAAY,CAAC,YACrB,wBAqBqB;;QAlBN,QAAQ,KAAK,WAAW;EAE3C,MAAM,aAAa,QADI,kBAAkB,OAAO,UAAU,KACZ;EAE9C,MAAM,OAAO,6BAA6B,KAAK,OAAO,KAAK,GACvD,OAAO,OACP,IAAI,OAAO,KAAK;AAOpB,SAAO,GAJS,OAAO,UACnB,OAAO,OAAO,QAAQ,eACtB,gBAAgB,OAAO,UAAU,eAEjB,KAAK,IAAI;GAC7B,CAMiB,KAAK,YAAY,CAAC;;;;AAKvC,SAAgB,sBAAsB,KAAqC;CACzE,MAAM,aAAqC,EAAE;CAG7C,MAAM,UAAU,IAAI,SADlB,yEACiC;AACnC,MAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,GAAG,WAAW,aAAa;AACjC,aAAW,aAAa,UAAU,aAAa;;AAGjD,QAAO;;;;;;;;;;;AAYT,eAAsB,4BACpB,aACA,aACA,UAAiC,EAAE,EACX;CACxB,MAAM,EAAE,UAAU,UAAU;CAG5B,MAAM,aAAa,GAChB,YAAY,YAAY,CACxB,QAAQ,SAAS,KAAK,SAAS,OAAO,CAAC;AAE1C,QAAO,MAAM,wBAAwB,WAAW,OAAO;CAGvD,MAAM,QAAQ,UAAU;EAAE,SAAS;EAAe,SAAS,EAAE;EAAE,GAAG,WAAW;CAE7E,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;CACtC,MAAM,eAA8B,EAAE;CACtC,MAAM,gBAAmD,EAAE;CAC3D,MAAM,UAAU,IAAI,SAAS;AAG7B,MAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,OAAO,WAAW;EAExB,MAAM,YAAY,mBADF,KAAK,SAAS,MAAM,OAAO,CACE;EAG7C,MAAM,MAAM,GAAG,aAAa,KAAK,KAAK,aAAa,KAAK,EAAE,OAAO;EACjE,MAAM,UAAU,QAAQ,IAAI;EAG5B,MAAM,SAAS,MAAM,QAAQ;AAC7B,MAAI,UAAU,OAAO,SAAS,SAAS;AACrC,gBAAa,KAAK;IAAE,MAAM;IAAW,MAAM,OAAO;IAAM,CAAC;AACzD,WAAQ,MAAM,cAAc,UAAU,IAAI,IAAI,EAAE,GAAG,WAAW,OAAO,GAAG;AACxE,WAAQ,KAAK,KAAK,UAAU,WAAW;AACvC;;AAGF,UAAQ,MAAM,cAAc,UAAU,IAAI,IAAI,EAAE,GAAG,WAAW,OAAO,GAAG;EAKxE,MAAM,aAHkB,IAAI,QAAQ,oBAAoB,KAAK,CAG1B,MAAM,CAAC,QAAQ,SAAS,GAAG;AAG9D,MAAI;GACF,MAAM,SAAU,MAAM,OAAO,mBAAmB,iBAAiB;IAC/D,WAAW,kBAAkB;IAC7B,cAAc;IACf,CAAC;AAEF,OAAI,OAAO,OAAO,UAAU,UAAU;AACpC,YAAQ,KAAK,KAAK,UAAU,WAAW;AACvC,kBAAc,KAAK;KACjB,MAAM;KACN,OAAO;KACR,CAAC;AACF;;GAIF,MAAM,OAAO,mBAAmB,QAAQ,KAAK,UAAU;AACvD,gBAAa,KAAK;IAAE,MAAM;IAAW;IAAM,CAAC;AAG5C,SAAM,QAAQ,aAAa;IAAE,MAAM;IAAS;IAAM;AAElD,WAAQ,KAAK,KAAK,YAAY;WACvB,OAAO;GACd,MAAM,eACJ,iBAAiB,QAAQ,MAAM,UAAU;AAC3C,WAAQ,KAAK,KAAK,UAAU,KAAK,eAAe;AAChD,iBAAc,KAAK;IAAE,MAAM;IAAW,OAAO;IAAc,CAAC;;;AAKhE,WAAU,MAAM;AAGhB,KAAI,cAAc,SAAS,EACzB,QAAO,MAAM,8BAA8B,cAAc,OAAO;AAGlE,QAAO;;;;;;;AAQT,SAAgB,mBAAmB,UAA0B;AAC3D,QAAO,SAAS,QAAQ,UAAU,GAAG;;;;;;;;;;;;AAavC,SAAgB,kBAAkB,UAA0B;AAC1D,QAAO,SACJ,QAAQ,WAAW,GAAG,CACtB,QAAQ,SAAS,GAAG,CACpB,MAAM,IAAI,CAAC;;;AAIhB,MAAM,UAAkC;CAEtC,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,UAAU;CACV,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CACf,UAAU;CAEV,OAAO;CACP,KAAK;CACL,QAAQ;CACR,QAAQ;CACR,SAAS;CAET,WAAW;CACX,UAAU;CAEV,MAAM;CACP"}
+{"version":3,"file":"query-registry.js","names":[],"sources":["../../src/type-generator/query-registry.ts"],"sourcesContent":["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport { WorkspaceClient } from \"@databricks/sdk-experimental\";\nimport { createLogger } from \"../logging/logger\";\nimport { CACHE_VERSION, hashSQL, loadCache, saveCache } from \"./cache\";\nimport { Spinner } from \"./spinner\";\nimport {\n  type DatabricksStatementExecutionResponse,\n  type QuerySchema,\n  sqlTypeToHelper,\n  sqlTypeToMarker,\n} from \"./types\";\n\nconst logger = createLogger(\"type-generator:query-registry\");\n\n/**\n * Extract parameters from a SQL query\n * @param sql - the SQL query to extract parameters from\n * @returns an array of parameter names\n */\nexport function extractParameters(sql: string): string[] {\n  const matches = sql.matchAll(/:([a-zA-Z_]\\w*)/g);\n  const params = new Set<string>();\n  for (const match of matches) {\n    params.add(match[1]);\n  }\n  return Array.from(params);\n}\n\n// parameters that are injected by the server\nexport const SERVER_INJECTED_PARAMS = [\"workspaceId\"];\n\nexport function convertToQueryType(\n  result: DatabricksStatementExecutionResponse,\n  sql: string,\n  queryName: string,\n): string {\n  const dataRows = result.result?.data_array || [];\n  const columns = dataRows.map((row) => ({\n    name: row[0] || \"\",\n    type_name: row[1]?.toUpperCase() || \"STRING\",\n    comment: row[2] || undefined,\n  }));\n\n  const params = extractParameters(sql).filter(\n    (p) => !SERVER_INJECTED_PARAMS.includes(p),\n  );\n\n  const paramTypes = extractParameterTypes(sql);\n\n  // generate parameters types with JSDoc hints\n  const paramsType =\n    params.length > 0\n      ? `{\\n      ${params\n          .map((p) => {\n            const sqlType = paramTypes[p];\n            // if no type annotation, use SQLTypeMarker (union type)\n            const markerType = sqlType\n              ? sqlTypeToMarker[sqlType]\n              : \"SQLTypeMarker\";\n            const helper = sqlType ? sqlTypeToHelper[sqlType] : \"sql.*()\";\n            return `/** ${sqlType || \"any\"} - use ${helper} */\\n      ${p}: ${markerType}`;\n          })\n          .join(\";\\n      \")};\\n    }`\n      : \"Record<string, never>\";\n\n  // generate result fields with JSDoc\n  const resultFields = columns.map((column) => {\n    const normalizedType = normalizeTypeName(column.type_name);\n    const mappedType = typeMap[normalizedType] || \"unknown\";\n    // validate column name is a valid identifier\n    const name = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(column.name)\n      ? column.name\n      : `\"${column.name}\"`;\n\n    // generate comment for column\n    const comment = column.comment\n      ? `/** ${column.comment} */\\n      `\n      : `/** @sqlType ${column.type_name} */\\n      `;\n\n    return `${comment}${name}: ${mappedType}`;\n  });\n\n  return `{\n    name: \"${queryName}\";\n    parameters: ${paramsType};\n    result: Array<{\n      ${resultFields.join(\";\\n      \")};\n    }>;\n  }`;\n}\n\nexport function extractParameterTypes(sql: string): Record<string, string> {\n  const paramTypes: Record<string, string> = {};\n  const regex =\n    /--\\s*@param\\s+(\\w+)\\s+(STRING|NUMERIC|BOOLEAN|DATE|TIMESTAMP|BINARY)/gi;\n  const matches = sql.matchAll(regex);\n  for (const match of matches) {\n    const [, paramName, paramType] = match;\n    paramTypes[paramName] = paramType.toUpperCase();\n  }\n\n  return paramTypes;\n}\n\n/**\n * Generate query schemas from a folder of SQL files\n * It uses DESCRIBE QUERY to get the schema without executing the query\n * @param queryFolder - the folder containing the SQL files\n * @param warehouseId - the warehouse id to use for schema analysis\n * @param options - options for the query generation\n * @param options.noCache - if true, skip the cache and regenerate all types\n * @returns an array of query schemas\n */\nexport async function generateQueriesFromDescribe(\n  queryFolder: string,\n  warehouseId: string,\n  options: { noCache?: boolean } = {},\n): Promise<QuerySchema[]> {\n  const { noCache = false } = options;\n\n  // read all query files in the folder\n  const queryFiles = fs\n    .readdirSync(queryFolder)\n    .filter((file) => file.endsWith(\".sql\"));\n\n  logger.debug(\"Found %d SQL queries\", queryFiles.length);\n\n  // load cache\n  const cache = noCache ? { version: CACHE_VERSION, queries: {} } : loadCache();\n\n  const client = new WorkspaceClient({});\n  const querySchemas: QuerySchema[] = [];\n  const failedQueries: { name: string; error: string }[] = [];\n  const spinner = new Spinner();\n\n  // process each query file\n  for (let i = 0; i < queryFiles.length; i++) {\n    const file = queryFiles[i];\n    const rawName = path.basename(file, \".sql\");\n    const queryName = normalizeQueryName(rawName);\n\n    // read query file content\n    const sql = fs.readFileSync(path.join(queryFolder, file), \"utf8\");\n    const sqlHash = hashSQL(sql);\n\n    // check cache\n    const cached = cache.queries[queryName];\n    if (cached && cached.hash === sqlHash) {\n      querySchemas.push({ name: queryName, type: cached.type });\n      spinner.start(`Processing ${queryName} (${i + 1}/${queryFiles.length})`);\n      spinner.stop(`✓ ${queryName} (cached)`);\n      continue;\n    }\n\n    spinner.start(`Processing ${queryName} (${i + 1}/${queryFiles.length})`);\n\n    const sqlWithDefaults = sql.replace(/:([a-zA-Z_]\\w*)/g, \"''\");\n\n    // strip trailing semicolon for DESCRIBE QUERY\n    const cleanedSql = sqlWithDefaults.trim().replace(/;\\s*$/, \"\");\n\n    // execute DESCRIBE QUERY to get schema without running the actual query\n    try {\n      const result = (await client.statementExecution.executeStatement({\n        statement: `DESCRIBE QUERY ${cleanedSql}`,\n        warehouse_id: warehouseId,\n      })) as DatabricksStatementExecutionResponse;\n\n      if (result.status.state === \"FAILED\") {\n        const sqlError =\n          result.status.error?.message || \"Query execution failed\";\n        spinner.stop(`✗ ${queryName} - failed`);\n        spinner.printDetail(`SQL Error: ${sqlError}`);\n        spinner.printDetail(`Query: ${cleanedSql.slice(0, 200)}`);\n        failedQueries.push({\n          name: queryName,\n          error: sqlError,\n        });\n        continue;\n      }\n\n      // convert result to query schema\n      const type = convertToQueryType(result, sql, queryName);\n      querySchemas.push({ name: queryName, type });\n\n      // update cache\n      cache.queries[queryName] = { hash: sqlHash, type };\n\n      spinner.stop(`✓ ${queryName}`);\n    } catch (error) {\n      const errorMessage =\n        error instanceof Error ? error.message : \"Unknown error\";\n      spinner.stop(`✗ ${queryName} - ${errorMessage}`);\n      failedQueries.push({ name: queryName, error: errorMessage });\n    }\n  }\n\n  // save cache\n  saveCache(cache);\n\n  // log warning if there are failed queries\n  if (failedQueries.length > 0) {\n    logger.debug(\"Warning: %d queries failed\", failedQueries.length);\n  }\n\n  return querySchemas;\n}\n\n/**\n * Normalize query name by removing the .obo extension\n * @param queryName - the query name to normalize\n * @returns the normalized query name\n */\nexport function normalizeQueryName(fileName: string): string {\n  return fileName.replace(/\\.obo$/, \"\");\n}\n\n/**\n * Normalize SQL type name by removing parameters/generics\n * Examples:\n *   DECIMAL(38,6) -> DECIMAL\n *   ARRAY<STRING> -> ARRAY\n *   MAP<STRING,INT> -> MAP\n *   STRUCT<name:STRING> -> STRUCT\n *   INTERVAL DAY TO SECOND -> INTERVAL\n *   GEOGRAPHY(4326) -> GEOGRAPHY\n */\nexport function normalizeTypeName(typeName: string): string {\n  return typeName\n    .replace(/\\(.*\\)$/, \"\") // remove (p, s) eg: DECIMAL(38,6) -> DECIMAL\n    .replace(/<.*>$/, \"\") // remove <T> eg: ARRAY<STRING> -> ARRAY\n    .split(\" \")[0]; // take first word eg: INTERVAL DAY TO SECOND -> INTERVAL\n}\n\n/** Type Map for Databricks data types to JavaScript types */\nconst typeMap: Record<string, string> = {\n  // string types\n  STRING: \"string\",\n  BINARY: \"string\",\n  // boolean\n  BOOLEAN: \"boolean\",\n  // numeric types\n  TINYINT: \"number\",\n  SMALLINT: \"number\",\n  INT: \"number\",\n  BIGINT: \"number\",\n  FLOAT: \"number\",\n  DOUBLE: \"number\",\n  DECIMAL: \"number\",\n  // date/time types\n  DATE: \"string\",\n  TIMESTAMP: \"string\",\n  TIMESTAMP_NTZ: \"string\",\n  INTERVAL: \"string\",\n  // complex types\n  ARRAY: \"unknown[]\",\n  MAP: \"Record<string, unknown>\",\n  STRUCT: \"Record<string, unknown>\",\n  OBJECT: \"Record<string, unknown>\",\n  VARIANT: \"unknown\",\n  // spatial types\n  GEOGRAPHY: \"unknown\",\n  GEOMETRY: \"unknown\",\n  // null type\n  VOID: \"null\",\n};\n"],"mappings":";;;;;;;;;AAaA,MAAM,SAAS,aAAa,gCAAgC;;;;;;AAO5D,SAAgB,kBAAkB,KAAuB;CACvD,MAAM,UAAU,IAAI,SAAS,mBAAmB;CAChD,MAAM,yBAAS,IAAI,KAAa;AAChC,MAAK,MAAM,SAAS,QAClB,QAAO,IAAI,MAAM,GAAG;AAEtB,QAAO,MAAM,KAAK,OAAO;;AAI3B,MAAa,yBAAyB,CAAC,cAAc;AAErD,SAAgB,mBACd,QACA,KACA,WACQ;CAER,MAAM,WADW,OAAO,QAAQ,cAAc,EAAE,EACvB,KAAK,SAAS;EACrC,MAAM,IAAI,MAAM;EAChB,WAAW,IAAI,IAAI,aAAa,IAAI;EACpC,SAAS,IAAI,MAAM;EACpB,EAAE;CAEH,MAAM,SAAS,kBAAkB,IAAI,CAAC,QACnC,MAAM,CAAC,uBAAuB,SAAS,EAAE,CAC3C;CAED,MAAM,aAAa,sBAAsB,IAAI;AAmC7C,QAAO;aACI,UAAU;kBAhCnB,OAAO,SAAS,IACZ,YAAY,OACT,KAAK,MAAM;EACV,MAAM,UAAU,WAAW;EAE3B,MAAM,aAAa,UACf,gBAAgB,WAChB;EACJ,MAAM,SAAS,UAAU,gBAAgB,WAAW;AACpD,SAAO,OAAO,WAAW,MAAM,SAAS,OAAO,aAAa,EAAE,IAAI;GAClE,CACD,KAAK,YAAY,CAAC,YACrB,wBAqBqB;;QAlBN,QAAQ,KAAK,WAAW;EAE3C,MAAM,aAAa,QADI,kBAAkB,OAAO,UAAU,KACZ;EAE9C,MAAM,OAAO,6BAA6B,KAAK,OAAO,KAAK,GACvD,OAAO,OACP,IAAI,OAAO,KAAK;AAOpB,SAAO,GAJS,OAAO,UACnB,OAAO,OAAO,QAAQ,eACtB,gBAAgB,OAAO,UAAU,eAEjB,KAAK,IAAI;GAC7B,CAMiB,KAAK,YAAY,CAAC;;;;AAKvC,SAAgB,sBAAsB,KAAqC;CACzE,MAAM,aAAqC,EAAE;CAG7C,MAAM,UAAU,IAAI,SADlB,yEACiC;AACnC,MAAK,MAAM,SAAS,SAAS;EAC3B,MAAM,GAAG,WAAW,aAAa;AACjC,aAAW,aAAa,UAAU,aAAa;;AAGjD,QAAO;;;;;;;;;;;AAYT,eAAsB,4BACpB,aACA,aACA,UAAiC,EAAE,EACX;CACxB,MAAM,EAAE,UAAU,UAAU;CAG5B,MAAM,aAAa,GAChB,YAAY,YAAY,CACxB,QAAQ,SAAS,KAAK,SAAS,OAAO,CAAC;AAE1C,QAAO,MAAM,wBAAwB,WAAW,OAAO;CAGvD,MAAM,QAAQ,UAAU;EAAE,SAAS;EAAe,SAAS,EAAE;EAAE,GAAG,WAAW;CAE7E,MAAM,SAAS,IAAI,gBAAgB,EAAE,CAAC;CACtC,MAAM,eAA8B,EAAE;CACtC,MAAM,gBAAmD,EAAE;CAC3D,MAAM,UAAU,IAAI,SAAS;AAG7B,MAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK;EAC1C,MAAM,OAAO,WAAW;EAExB,MAAM,YAAY,mBADF,KAAK,SAAS,MAAM,OAAO,CACE;EAG7C,MAAM,MAAM,GAAG,aAAa,KAAK,KAAK,aAAa,KAAK,EAAE,OAAO;EACjE,MAAM,UAAU,QAAQ,IAAI;EAG5B,MAAM,SAAS,MAAM,QAAQ;AAC7B,MAAI,UAAU,OAAO,SAAS,SAAS;AACrC,gBAAa,KAAK;IAAE,MAAM;IAAW,MAAM,OAAO;IAAM,CAAC;AACzD,WAAQ,MAAM,cAAc,UAAU,IAAI,IAAI,EAAE,GAAG,WAAW,OAAO,GAAG;AACxE,WAAQ,KAAK,KAAK,UAAU,WAAW;AACvC;;AAGF,UAAQ,MAAM,cAAc,UAAU,IAAI,IAAI,EAAE,GAAG,WAAW,OAAO,GAAG;EAKxE,MAAM,aAHkB,IAAI,QAAQ,oBAAoB,KAAK,CAG1B,MAAM,CAAC,QAAQ,SAAS,GAAG;AAG9D,MAAI;GACF,MAAM,SAAU,MAAM,OAAO,mBAAmB,iBAAiB;IAC/D,WAAW,kBAAkB;IAC7B,cAAc;IACf,CAAC;AAEF,OAAI,OAAO,OAAO,UAAU,UAAU;IACpC,MAAM,WACJ,OAAO,OAAO,OAAO,WAAW;AAClC,YAAQ,KAAK,KAAK,UAAU,WAAW;AACvC,YAAQ,YAAY,cAAc,WAAW;AAC7C,YAAQ,YAAY,UAAU,WAAW,MAAM,GAAG,IAAI,GAAG;AACzD,kBAAc,KAAK;KACjB,MAAM;KACN,OAAO;KACR,CAAC;AACF;;GAIF,MAAM,OAAO,mBAAmB,QAAQ,KAAK,UAAU;AACvD,gBAAa,KAAK;IAAE,MAAM;IAAW;IAAM,CAAC;AAG5C,SAAM,QAAQ,aAAa;IAAE,MAAM;IAAS;IAAM;AAElD,WAAQ,KAAK,KAAK,YAAY;WACvB,OAAO;GACd,MAAM,eACJ,iBAAiB,QAAQ,MAAM,UAAU;AAC3C,WAAQ,KAAK,KAAK,UAAU,KAAK,eAAe;AAChD,iBAAc,KAAK;IAAE,MAAM;IAAW,OAAO;IAAc,CAAC;;;AAKhE,WAAU,MAAM;AAGhB,KAAI,cAAc,SAAS,EACzB,QAAO,MAAM,8BAA8B,cAAc,OAAO;AAGlE,QAAO;;;;;;;AAQT,SAAgB,mBAAmB,UAA0B;AAC3D,QAAO,SAAS,QAAQ,UAAU,GAAG;;;;;;;;;;;;AAavC,SAAgB,kBAAkB,UAA0B;AAC1D,QAAO,SACJ,QAAQ,WAAW,GAAG,CACtB,QAAQ,SAAS,GAAG,CACpB,MAAM,IAAI,CAAC;;;AAIhB,MAAM,UAAkC;CAEtC,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,UAAU;CACV,KAAK;CACL,QAAQ;CACR,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CACf,UAAU;CAEV,OAAO;CACP,KAAK;CACL,QAAQ;CACR,QAAQ;CACR,SAAS;CAET,WAAW;CACX,UAAU;CAEV,MAAM;CACP"}

package/dist/type-generator/spinner.js

@@ -28,6 +28,9 @@ var Spinner = class {
 		}
 		process.stdout.write(`\x1b[2K\r  ${finalText || this.text}\n`);
 	}
+	printDetail(text) {
+		process.stdout.write(`\x1b[2m    ${text}\x1b[0m\n`);
+	}
 };
 
 //#endregion

package/dist/type-generator/spinner.js.map

@@ -1 +1 @@
-{"version":3,"file":"spinner.js","names":[],"sources":["../../src/type-generator/spinner.ts"],"sourcesContent":["/**\n * Simple loading spinner for CLI\n */\nexport class Spinner {\n  private frames = [\"   \", \".  \", \".. \", \"...\"];\n  private current = 0;\n  private interval: NodeJS.Timeout | null = null;\n  private text = \"\";\n\n  start(text: string) {\n    this.text = text;\n    this.current = 0;\n    process.stdout.write(`  ${this.text}${this.frames[0]}`);\n    this.interval = setInterval(() => {\n      this.current = (this.current + 1) % this.frames.length;\n      process.stdout.write(`\\r  ${this.text}${this.frames[this.current]}`);\n    }, 300);\n  }\n\n  stop(finalText?: string) {\n    if (this.interval) {\n      clearInterval(this.interval);\n      this.interval = null;\n    }\n    // clear the line and write the final text\n    process.stdout.write(`\\x1b[2K\\r  ${finalText || this.text}\\n`);\n  }\n}\n"],"mappings":";;;;AAGA,IAAa,UAAb,MAAqB;CACnB,AAAQ,SAAS;EAAC;EAAO;EAAO;EAAO;EAAM;CAC7C,AAAQ,UAAU;CAClB,AAAQ,WAAkC;CAC1C,AAAQ,OAAO;CAEf,MAAM,MAAc;AAClB,OAAK,OAAO;AACZ,OAAK,UAAU;AACf,UAAQ,OAAO,MAAM,KAAK,KAAK,OAAO,KAAK,OAAO,KAAK;AACvD,OAAK,WAAW,kBAAkB;AAChC,QAAK,WAAW,KAAK,UAAU,KAAK,KAAK,OAAO;AAChD,WAAQ,OAAO,MAAM,OAAO,KAAK,OAAO,KAAK,OAAO,KAAK,WAAW;KACnE,IAAI;;CAGT,KAAK,WAAoB;AACvB,MAAI,KAAK,UAAU;AACjB,iBAAc,KAAK,SAAS;AAC5B,QAAK,WAAW;;AAGlB,UAAQ,OAAO,MAAM,cAAc,aAAa,KAAK,KAAK,IAAI"}
+{"version":3,"file":"spinner.js","names":[],"sources":["../../src/type-generator/spinner.ts"],"sourcesContent":["/**\n * Simple loading spinner for CLI\n */\nexport class Spinner {\n  private frames = [\"   \", \".  \", \".. \", \"...\"];\n  private current = 0;\n  private interval: NodeJS.Timeout | null = null;\n  private text = \"\";\n\n  start(text: string) {\n    this.text = text;\n    this.current = 0;\n    process.stdout.write(`  ${this.text}${this.frames[0]}`);\n    this.interval = setInterval(() => {\n      this.current = (this.current + 1) % this.frames.length;\n      process.stdout.write(`\\r  ${this.text}${this.frames[this.current]}`);\n    }, 300);\n  }\n\n  stop(finalText?: string) {\n    if (this.interval) {\n      clearInterval(this.interval);\n      this.interval = null;\n    }\n    // clear the line and write the final text\n    process.stdout.write(`\\x1b[2K\\r  ${finalText || this.text}\\n`);\n  }\n\n  printDetail(text: string) {\n    process.stdout.write(`\\x1b[2m    ${text}\\x1b[0m\\n`);\n  }\n}\n"],"mappings":";;;;AAGA,IAAa,UAAb,MAAqB;CACnB,AAAQ,SAAS;EAAC;EAAO;EAAO;EAAO;EAAM;CAC7C,AAAQ,UAAU;CAClB,AAAQ,WAAkC;CAC1C,AAAQ,OAAO;CAEf,MAAM,MAAc;AAClB,OAAK,OAAO;AACZ,OAAK,UAAU;AACf,UAAQ,OAAO,MAAM,KAAK,KAAK,OAAO,KAAK,OAAO,KAAK;AACvD,OAAK,WAAW,kBAAkB;AAChC,QAAK,WAAW,KAAK,UAAU,KAAK,KAAK,OAAO;AAChD,WAAQ,OAAO,MAAM,OAAO,KAAK,OAAO,KAAK,OAAO,KAAK,WAAW;KACnE,IAAI;;CAGT,KAAK,WAAoB;AACvB,MAAI,KAAK,UAAU;AACjB,iBAAc,KAAK,SAAS;AAC5B,QAAK,WAAW;;AAGlB,UAAQ,OAAO,MAAM,cAAc,aAAa,KAAK,KAAK,IAAI;;CAGhE,YAAY,MAAc;AACxB,UAAQ,OAAO,MAAM,cAAc,KAAK,WAAW"}

package/dist/type-generator/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/type-generator/types.ts"],"sourcesContent":["/**\n * Databricks statement execution response interface for DESCRIBE QUERY\n * @property statement_id - the id of the statement\n * @property status - the status of the statement\n * @property result - the result containing column schema as rows [col_name, data_type, comment]\n */\nexport interface DatabricksStatementExecutionResponse {\n  statement_id: string;\n  status: { state: string };\n  result?: {\n    data_array?: (string | null)[][];\n  };\n}\n\n/**\n * Map of SQL types to their corresponding marker types\n * Used to convert SQL types to their corresponding marker types\n */\nexport const sqlTypeToMarker: Record<string, string> = {\n  // string\n  STRING: \"SQLStringMarker\",\n  BINARY: \"SQLBinaryMarker\",\n  // boolean\n  BOOLEAN: \"SQLBooleanMarker\",\n  // numeric\n  NUMERIC: \"SQLNumberMarker\",\n  INT: \"SQLNumberMarker\",\n  BIGINT: \"SQLNumberMarker\",\n  TINYINT: \"SQLNumberMarker\",\n  SMALLINT: \"SQLNumberMarker\",\n  FLOAT: \"SQLNumberMarker\",\n  DOUBLE: \"SQLNumberMarker\",\n  DECIMAL: \"SQLNumberMarker\",\n  // date/time\n  DATE: \"SQLDateMarker\",\n  TIMESTAMP: \"SQLTimestampMarker\",\n  TIMESTAMP_NTZ: \"SQLTimestampMarker\",\n};\n\n/**\n * Map of SQL types to their corresponding helper function names\n * Used to generate JSDoc hints for parameters\n */\nexport const sqlTypeToHelper: Record<string, string> = {\n  // string\n  STRING: \"sql.string()\",\n  BINARY: \"sql.binary()\",\n  // boolean\n  BOOLEAN: \"sql.boolean()\",\n  // numeric\n  NUMERIC: \"sql.number()\",\n  INT: \"sql.number()\",\n  BIGINT: \"sql.number()\",\n  TINYINT: \"sql.number()\",\n  SMALLINT: \"sql.number()\",\n  FLOAT: \"sql.number()\",\n  DOUBLE: \"sql.number()\",\n  DECIMAL: \"sql.number()\",\n  // date/time\n  DATE: \"sql.date()\",\n  TIMESTAMP: \"sql.timestamp()\",\n  TIMESTAMP_NTZ: \"sql.timestamp()\",\n};\n\n/**\n * Query schema interface\n * @property name - the name of the query\n * @property type - the type of the query (string, number, boolean, object, array, etc.)\n */\nexport interface QuerySchema {\n  name: string;\n  type: string;\n}\n"],"mappings":";;;;;AAkBA,MAAa,kBAA0C;CAErD,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,KAAK;CACL,QAAQ;CACR,SAAS;CACT,UAAU;CACV,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CAChB;;;;;AAMD,MAAa,kBAA0C;CAErD,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,KAAK;CACL,QAAQ;CACR,SAAS;CACT,UAAU;CACV,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CAChB"}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/type-generator/types.ts"],"sourcesContent":["/**\n * Databricks statement execution response interface for DESCRIBE QUERY\n * @property statement_id - the id of the statement\n * @property status - the status of the statement\n * @property result - the result containing column schema as rows [col_name, data_type, comment]\n */\nexport interface DatabricksStatementExecutionResponse {\n  statement_id: string;\n  status: {\n    state: string;\n    error?: { error_code?: string; message?: string };\n  };\n  result?: {\n    data_array?: (string | null)[][];\n  };\n}\n\n/**\n * Map of SQL types to their corresponding marker types\n * Used to convert SQL types to their corresponding marker types\n */\nexport const sqlTypeToMarker: Record<string, string> = {\n  // string\n  STRING: \"SQLStringMarker\",\n  BINARY: \"SQLBinaryMarker\",\n  // boolean\n  BOOLEAN: \"SQLBooleanMarker\",\n  // numeric\n  NUMERIC: \"SQLNumberMarker\",\n  INT: \"SQLNumberMarker\",\n  BIGINT: \"SQLNumberMarker\",\n  TINYINT: \"SQLNumberMarker\",\n  SMALLINT: \"SQLNumberMarker\",\n  FLOAT: \"SQLNumberMarker\",\n  DOUBLE: \"SQLNumberMarker\",\n  DECIMAL: \"SQLNumberMarker\",\n  // date/time\n  DATE: \"SQLDateMarker\",\n  TIMESTAMP: \"SQLTimestampMarker\",\n  TIMESTAMP_NTZ: \"SQLTimestampMarker\",\n};\n\n/**\n * Map of SQL types to their corresponding helper function names\n * Used to generate JSDoc hints for parameters\n */\nexport const sqlTypeToHelper: Record<string, string> = {\n  // string\n  STRING: \"sql.string()\",\n  BINARY: \"sql.binary()\",\n  // boolean\n  BOOLEAN: \"sql.boolean()\",\n  // numeric\n  NUMERIC: \"sql.number()\",\n  INT: \"sql.number()\",\n  BIGINT: \"sql.number()\",\n  TINYINT: \"sql.number()\",\n  SMALLINT: \"sql.number()\",\n  FLOAT: \"sql.number()\",\n  DOUBLE: \"sql.number()\",\n  DECIMAL: \"sql.number()\",\n  // date/time\n  DATE: \"sql.date()\",\n  TIMESTAMP: \"sql.timestamp()\",\n  TIMESTAMP_NTZ: \"sql.timestamp()\",\n};\n\n/**\n * Query schema interface\n * @property name - the name of the query\n * @property type - the type of the query (string, number, boolean, object, array, etc.)\n */\nexport interface QuerySchema {\n  name: string;\n  type: string;\n}\n"],"mappings":";;;;;AAqBA,MAAa,kBAA0C;CAErD,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,KAAK;CACL,QAAQ;CACR,SAAS;CACT,UAAU;CACV,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CAChB;;;;;AAMD,MAAa,kBAA0C;CAErD,QAAQ;CACR,QAAQ;CAER,SAAS;CAET,SAAS;CACT,KAAK;CACL,QAAQ;CACR,SAAS;CACT,UAAU;CACV,OAAO;CACP,QAAQ;CACR,SAAS;CAET,MAAM;CACN,WAAW;CACX,eAAe;CAChB"}