diff --git a/src/positron-dts/positron.d.ts b/src/positron-dts/positron.d.ts index c9c0065a5c5..030d9c4229a 100644 --- a/src/positron-dts/positron.d.ts +++ b/src/positron-dts/positron.d.ts @@ -1101,50 +1101,89 @@ declare module 'positron' { pasteText(text: string): void; } + /** + * ConnectionsInput interface defines the structure for connection inputs. + */ export interface ConnectionsInput { - // The unique identifier for the input. + /** + * The unique identifier for the input. + */ id: string; - // A human-readable label for the input. + /** + * A human-readable label for the input. + */ label: string; - // The type of the input. + /** + * The type of the input. + */ type: 'string' | 'number' | 'option'; - // Options, if the input type is an option. + /** + * Options, if the input type is an option. + */ options?: { 'identifier': string; 'title': string }[]; - // The default value for the input. + /** + * The default value for the input. + */ value?: string; } + /** + * ConnectionsDriverMetadata interface defines the structure for connection driver metadata. + */ export interface ConnectionsDriverMetadata { - // The language identifier for the driver. - // Drivers are grouped by language, not by runtime. + /** + * The language identifier for the driver. + * Drivers are grouped by language, not by runtime. + */ languageId: string; - // A human-readable name for the driver. + /** + * A human-readable name for the driver. + */ name: string; - // The base64-encoded SVG icon for the driver. + /** + * The base64-encoded SVG icon for the driver. + */ base64EncodedIconSvg?: string; - // The inputs required to create a connection. - // For instance, a connection might require a username - // and password. + /** + * The inputs required to create a connection. + * For instance, a connection might require a username + * and password. + */ inputs: Array; } export interface ConnectionsDriver { - // The unique identifier for the driver. + /** + * The unique identifier for the driver. + */ driverId: string; - // The metadata for the driver. + /** + * The metadata for the driver. + */ metadata: ConnectionsDriverMetadata; - // Generates the connection code based on the inputs. + /** + * Generates the connection code based on the inputs. + */ generateCode?: (inputs: Array) => string; - // Connect session + + /** + * Connect session. + */ connect?: (code: string) => Promise; - // Checks if the dependencies for the driver are installed - // and functioning. + + /** + * Checks if the dependencies for the driver are installed + * and functioning. + */ checkDependencies?: () => Promise; - // Installs the dependencies for the driver. - // For instance, R packages would install the required - // R packages, and or other dependencies. + + /** + * Installs the dependencies for the driver. + * For instance, R packages would install the required + * R packages, and or other dependencies. + */ installDependencies?: () => Promise; }