@superblocksteam/shared 0.9431.0 → 0.9433.0

package/src/plugins/templates/databricks.ts

@@ -13,17 +13,20 @@ import { makeDropdownItem } from './shared/db';
 
 export const DatabricksPluginVersions = {
   V1: '0.0.1',
-  V2: '0.0.2'
+  V2: '0.0.2',
+  V3: '0.0.3'
 };
 
 enum ConnectionType {
   PERSONAL_ACCESS_TOKEN = '1',
-  MACHINE_TO_MACHINE = '2'
+  MACHINE_TO_MACHINE = '2',
+  OAUTH_TOKEN_FEDERATION = '3'
 }
 
 const CONNECTION_METHODS_AND_DISPLAY_NAMES_V2 = {
   [ConnectionType.PERSONAL_ACCESS_TOKEN]: 'Personal access token',
-  [ConnectionType.MACHINE_TO_MACHINE]: 'Machine-to-machine'
+  [ConnectionType.MACHINE_TO_MACHINE]: 'Machine-to-machine',
+  [ConnectionType.OAUTH_TOKEN_FEDERATION]: 'OAuth token federation'
 };
 
 const BASE_HOST = {
@@ -73,6 +76,50 @@ const BASE_DEFAULT_SCHEMA = {
   placeholder: 'default'
 };
 
+const BASE_SUBJECT_TOKEN_SOURCE = {
+  label: 'Subject token source',
+  name: 'authConfig.subjectTokenSource',
+  componentType: FormComponentType.DROPDOWN,
+  initialValue: 'SUBJECT_TOKEN_SOURCE_LOGIN_IDENTITY_PROVIDER',
+  rules: [{ required: true, message: 'Subject token source is required' }],
+  options: [
+    makeDropdownItem('SUBJECT_TOKEN_SOURCE_LOGIN_IDENTITY_PROVIDER', 'Login Identity Provider'),
+    makeDropdownItem('SUBJECT_TOKEN_SOURCE_STATIC_TOKEN', 'Static Token')
+  ]
+};
+
+const BASE_TOKEN_URL = {
+  label: 'Token URL',
+  name: 'authConfig.tokenUrl',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: 'https://your-token-endpoint.com/oauth/token',
+  rules: [{ required: true, message: 'Token URL is required' }]
+};
+
+const BASE_CLIENT_ID = {
+  label: 'Service Principal UUID',
+  name: 'authConfig.clientId',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: 'optional-service-principal-uuid',
+  rules: [{ required: false }]
+};
+
+const BASE_STATIC_TOKEN = {
+  label: 'Static Token',
+  name: 'authConfig.subjectTokenSourceStaticToken',
+  componentType: FormComponentType.INPUT_TEXT,
+  dataType: InputDataType.PASSWORD, // Hidden input for security
+  rules: [{ required: true, message: 'Static token is required when using static token source' }]
+};
+
+const BASE_SCOPE = {
+  label: 'Scope',
+  name: 'authConfig.scope',
+  componentType: FormComponentType.INPUT_TEXT,
+  initialValue: 'all-apis',
+  rules: [{ required: true }]
+};
+
 export const DatabricksPlugin: Plugin = {
   id: 'databricks',
   name: 'Databricks',
@@ -98,6 +145,48 @@ export const DatabricksPlugin: Plugin = {
             placeholder: 'ProdDB',
             rules: [{ required: true, message: 'Display name is required' }]
           },
+          {
+            label: 'Auth Type Field',
+            name: 'authTypeField',
+            hidden: true,
+            componentType: FormComponentType.INPUT_TEXT,
+            startVersion: DatabricksPluginVersions.V3,
+            initialValue: 'oauthType',
+            rules: [{ required: false }],
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          },
+          {
+            label: 'OAuth Type',
+            name: 'oauthType',
+            hidden: true,
+            componentType: FormComponentType.INPUT_TEXT,
+            startVersion: DatabricksPluginVersions.V3,
+            initialValue: 'oauth-token-exchange',
+            rules: [{ required: false }],
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          },
+          {
+            label: 'Subject Token Type',
+            name: 'authConfig.subjectTokenType',
+            hidden: true,
+            componentType: FormComponentType.INPUT_TEXT,
+            startVersion: DatabricksPluginVersions.V3,
+            initialValue: 'urn:ietf:params:oauth:token-type:jwt',
+            rules: [{ required: false }],
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          },
           // HOST
           {
             ...BASE_HOST,
@@ -109,7 +198,11 @@ export const DatabricksPlugin: Plugin = {
             startVersion: DatabricksPluginVersions.V2,
             display: {
               show: {
-                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+                'connection.connectionType': [
+                  ConnectionType.PERSONAL_ACCESS_TOKEN,
+                  ConnectionType.MACHINE_TO_MACHINE,
+                  ConnectionType.OAUTH_TOKEN_FEDERATION
+                ]
               }
             }
           } as FormItem,
@@ -124,7 +217,11 @@ export const DatabricksPlugin: Plugin = {
             startVersion: DatabricksPluginVersions.V2,
             display: {
               show: {
-                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+                'connection.connectionType': [
+                  ConnectionType.PERSONAL_ACCESS_TOKEN,
+                  ConnectionType.MACHINE_TO_MACHINE,
+                  ConnectionType.OAUTH_TOKEN_FEDERATION
+                ]
               }
             }
           } as FormItem,
@@ -139,7 +236,11 @@ export const DatabricksPlugin: Plugin = {
             startVersion: DatabricksPluginVersions.V2,
             display: {
               show: {
-                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+                'connection.connectionType': [
+                  ConnectionType.PERSONAL_ACCESS_TOKEN,
+                  ConnectionType.MACHINE_TO_MACHINE,
+                  ConnectionType.OAUTH_TOKEN_FEDERATION
+                ]
               }
             }
           } as FormItem,
@@ -154,7 +255,11 @@ export const DatabricksPlugin: Plugin = {
             startVersion: DatabricksPluginVersions.V2,
             display: {
               show: {
-                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+                'connection.connectionType': [
+                  ConnectionType.PERSONAL_ACCESS_TOKEN,
+                  ConnectionType.MACHINE_TO_MACHINE,
+                  ConnectionType.OAUTH_TOKEN_FEDERATION
+                ]
               }
             }
           } as FormItem,
@@ -169,7 +274,11 @@ export const DatabricksPlugin: Plugin = {
             startVersion: DatabricksPluginVersions.V2,
             display: {
               show: {
-                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+                'connection.connectionType': [
+                  ConnectionType.PERSONAL_ACCESS_TOKEN,
+                  ConnectionType.MACHINE_TO_MACHINE,
+                  ConnectionType.OAUTH_TOKEN_FEDERATION
+                ]
               }
             }
           } as FormItem,
@@ -177,6 +286,18 @@ export const DatabricksPlugin: Plugin = {
             label: 'Connection method',
             name: 'connection.connectionType',
             startVersion: DatabricksPluginVersions.V2,
+            endVersion: DatabricksPluginVersions.V2,
+            componentType: FormComponentType.DROPDOWN,
+            initialValue: ConnectionType.PERSONAL_ACCESS_TOKEN,
+            rules: [{ required: true }],
+            options: Object.entries(CONNECTION_METHODS_AND_DISPLAY_NAMES_V2).map(([value, displayName]) =>
+              makeDropdownItem(value, displayName)
+            )
+          },
+          {
+            label: 'Connection method',
+            name: 'connection.connectionType',
+            startVersion: DatabricksPluginVersions.V3,
             componentType: FormComponentType.DROPDOWN,
             initialValue: ConnectionType.PERSONAL_ACCESS_TOKEN,
             rules: [{ required: true }],
@@ -225,6 +346,56 @@ export const DatabricksPlugin: Plugin = {
                 'connection.connectionType': [ConnectionType.MACHINE_TO_MACHINE]
               }
             }
+          } as FormItem,
+
+          {
+            ...BASE_SUBJECT_TOKEN_SOURCE,
+            startVersion: DatabricksPluginVersions.V3,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          } as FormItem,
+          {
+            ...BASE_STATIC_TOKEN,
+            startVersion: DatabricksPluginVersions.V3,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION],
+                'authConfig.subjectTokenSource': ['SUBJECT_TOKEN_SOURCE_STATIC_TOKEN']
+              }
+            }
+          } as FormItem,
+          {
+            ...BASE_TOKEN_URL,
+            startVersion: DatabricksPluginVersions.V3,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          } as FormItem,
+          {
+            ...BASE_CLIENT_ID,
+            startVersion: DatabricksPluginVersions.V3,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
+          } as FormItem,
+          {
+            ...BASE_SCOPE,
+            startVersion: DatabricksPluginVersions.V3,
+            // NOTE: @joeyagreco - `all-apis` is the only scope that databricks allows, so we just hardcode and hide to prevent users from changing and having connection issues
+            hidden: true,
+            initialValue: 'all-apis',
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.OAUTH_TOKEN_FEDERATION]
+              }
+            }
           } as FormItem
         ]
       }

package/src/types/datasource/auth.ts

@@ -261,6 +261,7 @@ type PublicOAuthTokenExchangeConfig = {
   scope?: string;
   subjectTokenSource?: string;
   subjectTokenSourceStaticToken?: string;
+  subjectTokenType?: string;
   clientId?: string;
 };
 

package/src/types/datasource/index.ts

@@ -432,7 +432,11 @@ export type CouchbaseDatasourceConfiguration = Pick<
   'name' | 'connection' | 'tunnel' | 'dynamicWorkflowConfiguration'
 >;
 
-export type DatabricksDatasourceConfiguration = Pick<DatabricksPlugin.Plugin, 'name' | 'connection' | 'dynamicWorkflowConfiguration'>;
+export type DatabricksDatasourceConfiguration = Pick<DatabricksPlugin.Plugin, 'name' | 'connection' | 'dynamicWorkflowConfiguration'> &
+  AuthenticatedDatasourceConfig & {
+    authTypeField?: string;
+    oauthType?: IntegrationAuthType.OAUTH2_TOKEN_EXCHANGE;
+  };
 
 export type OracleDbDatasourceConfiguration = Pick<OracleDbPlugin.Plugin, 'name' | 'connection' | 'dynamicWorkflowConfiguration'> & {
   connectionType?: 'fields' | 'url';