@superblocksteam/shared 0.9108.0

package/src/plugins/templates/couchbase.ts

@@ -0,0 +1,190 @@
+import { DB_SQL_INITIAL_TEXT, EditorLanguage, FormComponentType, InputDataType, Plugin, PluginResponseType, PluginType } from '../../types';
+import { sshTunnelSections } from './shared';
+
+export const CouchbasePluginVersions = {
+  V1: '0.0.1'
+};
+
+type DisplayInfo = { displayName: string; description: string };
+const COUCHBASE_ACTIONS_AND_DISPLAY_NAMES: Record<string, DisplayInfo> = {
+  runSql: { displayName: 'Query', description: 'Execute a raw query' },
+  insert: { displayName: 'Insert item', description: 'Insert an item with the specified key and value' },
+  get: { displayName: 'Get item', description: 'Get an item with the specified key' },
+  remove: { displayName: 'Remove item', description: 'Remove an item with the specified key' }
+};
+
+const makeDropdownItem = (value: string, displayName?: string, subText?: string) => {
+  return {
+    key: value,
+    value: value,
+    displayName: displayName ?? value,
+    subText: subText ?? ''
+  };
+};
+
+export const CouchbasePlugin: Plugin = {
+  id: 'couchbase',
+  name: 'Couchbase',
+  moduleName: 'CouchbasePlugin',
+  modulePath: 'plugins/couchbase/CouchbasePlugin',
+  iconLocation: 'https://superblocks.s3-us-west-2.amazonaws.com/img/integrations/couchbase.png',
+  docsUrl: 'https://docs.superblocks.com/integrations/integrations-library/couchbase',
+  type: PluginType.API,
+  responseType: PluginResponseType.JSON,
+  hasRawRequest: true,
+  hasMetadata: true,
+  datasourceTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Display name',
+            name: 'name',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'ProdDB',
+            rules: [{ required: true, message: 'Display name is required' }]
+          },
+          {
+            label: 'URI',
+            name: 'connection.url',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: `couchbase[s]://my-host-name:11210,my-host-name:8091?[network=external]&[operation_timeout=10.0]`,
+            tooltip: {
+              markdownText: '[Read the docs](https://docs.couchbase.com/nodejs-sdk/current/howtos/managing-connections.html)'
+            },
+            rules: [{ required: true, message: 'URI is required' }]
+          },
+          {
+            label: 'Username',
+            name: 'connection.user',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'user',
+            tooltip: {
+              markdownText: 'Cluster access credentials name'
+            },
+            rules: [{ required: true, message: 'Username is required' }]
+          },
+          {
+            label: 'Password',
+            name: 'connection.password',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            dataType: InputDataType.PASSWORD,
+            placeholder: 'password',
+            tooltip: {
+              markdownText: 'Cluster access credentials password'
+            },
+            rules: [{ required: true, message: 'Password is required' }]
+          },
+          ...sshTunnelSections({
+            startVersion: CouchbasePluginVersions.V1,
+            isProto: true
+          })
+        ]
+      }
+    ]
+  },
+  actionTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Action',
+            name: 'couchbaseAction.case',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.DROPDOWN,
+            initialValue: 'runSql',
+            rules: [{ required: true }],
+            options: Object.entries(COUCHBASE_ACTIONS_AND_DISPLAY_NAMES).map(([value, displayInfo]) =>
+              makeDropdownItem(value, displayInfo.displayName, displayInfo.description)
+            )
+          },
+          {
+            label: 'Bucket',
+            name: 'bucketName',
+            placeholder: 'my_bucket',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            display: {
+              show: {
+                'couchbaseAction.case': ['insert', 'get', 'remove']
+              }
+            },
+            rules: [{ required: true, message: 'Bucket is required' }]
+          },
+          {
+            label: 'Scope',
+            name: 'couchbaseAction.value.identifier.scope',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.DYNAMIC_INPUT_TEXT,
+            initialValue: '',
+            placeholder: 'scope',
+            display: {
+              show: {
+                'couchbaseAction.case': ['insert', 'get', 'remove']
+              }
+            }
+          },
+          {
+            label: 'Collection',
+            name: 'couchbaseAction.value.identifier.collection',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.DYNAMIC_INPUT_TEXT,
+            initialValue: '',
+            placeholder: 'collection',
+            display: {
+              show: {
+                'couchbaseAction.case': ['insert', 'get', 'remove']
+              }
+            }
+          },
+          {
+            label: '', // Query
+            name: 'couchbaseAction.value.sqlBody',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.SQL,
+            initialValue: DB_SQL_INITIAL_TEXT,
+            display: {
+              show: {
+                'couchbaseAction.case': ['runSql']
+              }
+            }
+          },
+          {
+            label: 'Key',
+            name: 'couchbaseAction.value.key',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.DYNAMIC_INPUT_TEXT,
+            initialValue: '',
+            placeholder: 'key',
+            display: {
+              show: {
+                'couchbaseAction.case': ['insert', 'get', 'remove']
+              }
+            }
+          },
+          {
+            label: 'Document',
+            name: 'couchbaseAction.value.value',
+            startVersion: CouchbasePluginVersions.V1,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.JSON,
+            initialValue: '',
+            placeholder: '',
+            display: {
+              show: {
+                'couchbaseAction.case': ['insert']
+              }
+            }
+          }
+        ]
+      }
+    ]
+  }
+};

package/src/plugins/templates/databricks.ts

@@ -0,0 +1,265 @@
+import {
+  DB_SQL_INITIAL_TEXT,
+  EditorLanguage,
+  FormComponentType,
+  InputDataType,
+  Plugin,
+  PluginResponseType,
+  PluginType,
+  FormItem
+} from '../../types';
+import { PARAMETERIZED_SQL_DESCRIPTION } from './constants';
+import { makeDropdownItem } from './shared/db';
+
+export const DatabricksPluginVersions = {
+  V1: '0.0.1',
+  V2: '0.0.2'
+};
+
+enum ConnectionType {
+  PERSONAL_ACCESS_TOKEN = '1',
+  MACHINE_TO_MACHINE = '2'
+}
+
+const CONNECTION_METHODS_AND_DISPLAY_NAMES_V2 = {
+  [ConnectionType.PERSONAL_ACCESS_TOKEN]: 'Personal access token',
+  [ConnectionType.MACHINE_TO_MACHINE]: 'Machine-to-machine'
+};
+
+const BASE_HOST = {
+  label: 'Host',
+  name: 'connection.hostUrl',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: 'warehouse-staging.cloud.databricks.com',
+  rules: [{ required: true, message: 'Host is required' }]
+};
+
+const BASE_PORT = {
+  label: 'Port',
+  name: 'connection.port',
+  componentType: FormComponentType.INPUT_TEXT,
+  dataType: InputDataType.NUMBER,
+  initialValue: 443,
+  rules: [{ required: true, message: 'Port is required' }]
+};
+
+const BASE_PATH = {
+  label: 'Path',
+  name: 'connection.path',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: '/sql/1.0/warehouses/warehouse',
+  rules: [{ required: true, message: 'Path is required' }]
+};
+
+const BASE_ACCESS_TOKEN = {
+  label: 'Access token',
+  name: 'connection.token',
+  componentType: FormComponentType.INPUT_TEXT,
+  dataType: InputDataType.PASSWORD,
+  rules: [{ required: true, message: 'Access token is required' }]
+};
+
+const BASE_DEFAULT_CATALOG = {
+  label: 'Default catalog',
+  name: 'connection.defaultCatalog',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: 'hive_datastore'
+};
+
+const BASE_DEFAULT_SCHEMA = {
+  label: 'Default schema',
+  name: 'connection.defaultSchema',
+  componentType: FormComponentType.INPUT_TEXT,
+  placeholder: 'default'
+};
+
+export const DatabricksPlugin: Plugin = {
+  id: 'databricks',
+  name: 'Databricks',
+  moduleName: 'DatabricksPlugin',
+  modulePath: 'plugins/databricks/DatabricksPlugin',
+  iconLocation: 'https://superblocks.s3-us-west-2.amazonaws.com/img/integrations/databricks.png',
+  docsUrl: 'https://docs.superblocks.com/integrations/integrations-library/databricks',
+  type: PluginType.DB,
+  responseType: PluginResponseType.TABLE,
+  hasRawRequest: true,
+  hasMetadata: true,
+  rawRequestName: 'Executed SQL',
+  datasourceTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Display name',
+            name: 'name',
+            startVersion: DatabricksPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            placeholder: 'ProdDB',
+            rules: [{ required: true, message: 'Display name is required' }]
+          },
+          // HOST
+          {
+            ...BASE_HOST,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_HOST,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          // PORT
+          {
+            ...BASE_PORT,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_PORT,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          // PATH
+          {
+            ...BASE_PATH,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_PATH,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          // DEFAULT CATALOG
+          {
+            ...BASE_DEFAULT_CATALOG,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_DEFAULT_CATALOG,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          // DEFAULT SCHEMA
+          {
+            ...BASE_DEFAULT_SCHEMA,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_DEFAULT_SCHEMA,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN, ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          {
+            label: 'Connection method',
+            name: 'connection.connectionType',
+            startVersion: 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)
+            )
+          },
+          // ACCESS TOKEN
+          {
+            ...BASE_ACCESS_TOKEN,
+            startVersion: DatabricksPluginVersions.V1,
+            endVersion: DatabricksPluginVersions.V1
+          } as FormItem,
+          {
+            ...BASE_ACCESS_TOKEN,
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.PERSONAL_ACCESS_TOKEN]
+              }
+            }
+          } as FormItem,
+          // OAUTH CLIENT ID
+          {
+            label: 'OAuth client ID',
+            name: 'connection.oauthClientId',
+            componentType: FormComponentType.INPUT_TEXT,
+            rules: [{ required: true, message: 'OAuth client ID is required' }],
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem,
+          // OAUTH CLIENT SECRET
+          {
+            label: 'OAuth client secret',
+            name: 'connection.oauthClientSecret',
+            componentType: FormComponentType.INPUT_TEXT,
+            dataType: InputDataType.PASSWORD,
+            rules: [{ required: true, message: 'OAuth client secret is required' }],
+            startVersion: DatabricksPluginVersions.V2,
+            display: {
+              show: {
+                'connection.connectionType': [ConnectionType.MACHINE_TO_MACHINE]
+              }
+            }
+          } as FormItem
+        ]
+      }
+    ]
+  },
+  actionTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: '', // Query
+            name: 'runSql.sqlBody',
+            startVersion: DatabricksPluginVersions.V1,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.SQL,
+            initialValue: DB_SQL_INITIAL_TEXT
+          }
+        ]
+      },
+      {
+        name: 'advanced:main',
+        items: [
+          {
+            label: 'Use parameterized SQL',
+            name: 'runSql.useParameterized',
+            startVersion: DatabricksPluginVersions.V1,
+            componentType: FormComponentType.SWITCH,
+            initialValue: true,
+            tooltip: {
+              markdownText: PARAMETERIZED_SQL_DESCRIPTION
+            }
+          }
+        ]
+      }
+    ]
+  }
+};

package/src/plugins/templates/datadog.ts

@@ -0,0 +1,14 @@
+import { ExtendedIntegrationPluginId, Plugin } from '../../types';
+import { getNativeOpenApiPlugin } from './shared';
+
+export const DatadogPlugin: Plugin = getNativeOpenApiPlugin({
+  name: 'Datadog',
+  id: ExtendedIntegrationPluginId.DATADOG,
+  authMethods: {
+    apiKeyForm: [
+      { label: 'API key', header: 'DD-API-KEY', key: 'api-key' },
+      { label: 'Application key', header: 'DD-APPLICATION-KEY', key: 'app-key' }
+    ]
+  },
+  serverURL: 'https://api.datadoghq.com'
+});

package/src/plugins/templates/dropbox.ts

@@ -0,0 +1,20 @@
+import { ExtendedIntegrationPluginId, Plugin } from '../../types';
+import { PUBLIC_INTEGRATIONS_CDN_URL, getNativeOpenApiPlugin } from './shared';
+
+export const DropboxPlugin: Plugin = getNativeOpenApiPlugin({
+  name: 'Dropbox',
+  id: ExtendedIntegrationPluginId.DROPBOX,
+  authMethods: {
+    oauth2BringYourOwn: {
+      authorizationUrl: 'https://www.dropbox.com/oauth2/authorize',
+      tokenUrl: 'https://www.dropbox.com/oauth2/token',
+      revokeTokenUrl: 'https://api.dropboxapi.com/2/auth/token/revoke',
+      iconUrl: `${PUBLIC_INTEGRATIONS_CDN_URL}/img/dropbox.png`,
+      authorizationExtraParams: {
+        stateConfigExclude: ['datasource-auth-state'],
+        responseType: 'code'
+      }
+    }
+  },
+  serverURL: 'https://content.dropboxapi.com'
+});

package/src/plugins/templates/dynamodb.ts

@@ -0,0 +1,184 @@
+import {
+  AgentType,
+  DropdownOption,
+  EditorLanguage,
+  FormComponentType,
+  InputDataType,
+  Plugin,
+  PluginResponseType,
+  PluginType
+} from '../../types';
+import { camelCaseToDisplay } from '../../utils';
+import { getAWSAuthSection } from './shared';
+
+export const DynamoDBActions = [
+  'getItem',
+  'updateItem',
+  'putItem',
+  'deleteItem',
+  'query',
+  'scan',
+  'executeStatement',
+  'executeTransaction',
+  'listTagsOfResource',
+  'tagResource',
+  'listTables',
+  'describeTable',
+  'createTable',
+  'updateTable',
+  'deleteTable',
+  'batchWriteItem'
+  // "batchExecuteStatement",
+  // "batchGetItem",
+  // "createBackup",
+  // "createGlobalTable",
+  // "deleteBackup",
+  // "describeBackup",
+  // "describeContinuousBackups",
+  // "describeContributorInsights",
+  // "describeEndpoints",
+  // "describeExport",
+  // "describeGlobalTable",
+  // "describeGlobalTableSettings",
+  // "describeKinesisStreamingDestination",
+  // "describeLimits",
+  // "describeTableReplicaAutoScaling",
+  // "describeTimeToLive",
+  // "disableKinesisStreamingDestination",
+  // "enableKinesisStreamingDestination",
+  // "exportTableToPointInTime",
+  // "listBackups",
+  // "listContributorInsights",
+  // "listExports",
+  // "listGlobalTables",
+  // "restoreTableFromBackup",
+  // "restoreTableToPointInTime",
+  // "transactGetItems",
+  // "transactWriteItems",
+  // "untagResource",
+  // "updateContinuousBackups",
+  // "updateContributorInsights",
+  // "updateGlobalTable",
+  // "updateGlobalTableSettings",
+  // "updateTableReplicaAutoScaling",
+  // "updateTimeToLive",
+  // "waitFor",
+];
+
+function getDynamoDBActionDropdownOptions(): DropdownOption[] {
+  return DynamoDBActions.map((method: string): DropdownOption => {
+    const displayName = camelCaseToDisplay(method);
+
+    return {
+      key: method,
+      value: method,
+      displayName: displayName
+    };
+  });
+}
+
+export const DynamoDBPluginVersions = {
+  V1: '0.0.1',
+  V4: '0.0.4',
+  V5: '0.0.5'
+};
+
+export const DynamoDBPlugin: Plugin = {
+  id: 'dynamodb',
+  name: 'Amazon DynamoDB',
+  moduleName: 'DynamoDBPlugin',
+  modulePath: 'plugins/dynamodb/DynamoDBPlugin',
+  iconLocation: 'https://superblocks.s3-us-west-2.amazonaws.com/img/integrations/dynamodb.png',
+  docsUrl: 'https://docs.superblocks.com/integrations/integrations-library/aws-dynamodb',
+  type: PluginType.DB,
+  responseType: PluginResponseType.JSON,
+  hasRawRequest: true,
+  hasMetadata: true,
+  rawRequestName: 'Executed query',
+  datasourceTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Display name',
+            name: 'name',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            rules: [{ required: true, message: 'Display name is required' }]
+          },
+          {
+            label: 'Region',
+            name: 'authentication.custom.region.value',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            agentType: AgentType.MULTITENANT
+          },
+          {
+            label: 'Access key ID',
+            name: 'authentication.custom.accessKeyID.value',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            agentType: AgentType.MULTITENANT
+          },
+          {
+            label: 'Secret key',
+            name: 'authentication.custom.secretKey.value',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.INPUT_TEXT,
+            dataType: InputDataType.PASSWORD,
+            agentType: AgentType.MULTITENANT
+          },
+          {
+            label: 'IAM role ARN (optional)',
+            name: 'authentication.custom.iamRoleArn.value',
+            startVersion: DynamoDBPluginVersions.V5,
+            componentType: FormComponentType.INPUT_TEXT,
+            agentType: AgentType.MULTITENANT,
+            rules: [{ required: false }]
+          }
+        ]
+      },
+      getAWSAuthSection({ startVersion: DynamoDBPluginVersions.V4, startVersionForRoleAssumption: DynamoDBPluginVersions.V5 })
+    ]
+  },
+  actionTemplate: {
+    sections: [
+      {
+        name: 'main',
+        items: [
+          {
+            label: 'Action',
+            name: 'action',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.DROPDOWN,
+            initialValue: DynamoDBActions.length > 0 && DynamoDBActions[0],
+            options: getDynamoDBActionDropdownOptions()
+          },
+          {
+            label: 'Params',
+            name: 'body',
+            startVersion: DynamoDBPluginVersions.V1,
+            componentType: FormComponentType.CODE_EDITOR,
+            language: EditorLanguage.JSON,
+            placeholder: `{
+  "TableName": "ExampleTable",
+  "Key": {
+      "PK": "user#abc",
+      "SK": "account#0123456789"
+  },
+  "ConditionExpression": "#balance > :amount",
+  "ExpressionAttributeNames": {
+      "#balance": "balance"
+  },
+  "ExpressionAttributeValues": {
+      ":amount": { "N": "123" },
+      ":zero": { "N": "0" },
+  }
+}`
+          }
+        ]
+      }
+    ]
+  }
+};

package/src/plugins/templates/elasticsearch.ts

@@ -0,0 +1,17 @@
+import { ExtendedIntegrationPluginId, Plugin, SUPERBLOCKS_OPENAPI_TENANT_KEYWORD } from '../../types';
+import { PUBLIC_INTEGRATIONS_CDN_URL, getNativeOpenApiPlugin } from './shared';
+
+export const ElasticSearchPlugin: Plugin = getNativeOpenApiPlugin({
+  name: 'Elasticsearch',
+  id: ExtendedIntegrationPluginId.ELASTICSEARCH,
+  authMethods: {
+    basic: true
+  },
+  openApiSpecURL: `${PUBLIC_INTEGRATIONS_CDN_URL}/openapi/elasticsearch.yaml`,
+  logoURL: `${PUBLIC_INTEGRATIONS_CDN_URL}/img/elasticsearch.png`,
+  serverURL: `${SUPERBLOCKS_OPENAPI_TENANT_KEYWORD}`,
+  tenantInput: {
+    label: 'Elasticsearch host',
+    placeholder: 'https://6997e2f921fe5a0eb92af014d4c6fa47.us-central1.gcp.cloud.es.io'
+  }
+});