@deepnote/database-integrations 1.4.1 → 1.4.3

package/dist/index.cjs

@@ -323,12 +323,12 @@ const commonIntegrationConfig = zod.default.object({
 const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("alloydb"),
-		metadata: databaseMetadataSchemasByType["alloydb"],
+		metadata: databaseMetadataSchemasByType.alloydb,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("athena"),
-		metadata: databaseMetadataSchemasByType["athena"],
+		metadata: databaseMetadataSchemasByType.athena,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
@@ -338,42 +338,42 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("clickhouse"),
-		metadata: databaseMetadataSchemasByType["clickhouse"],
+		metadata: databaseMetadataSchemasByType.clickhouse,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("databricks"),
-		metadata: databaseMetadataSchemasByType["databricks"],
+		metadata: databaseMetadataSchemasByType.databricks,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("dremio"),
-		metadata: databaseMetadataSchemasByType["dremio"],
+		metadata: databaseMetadataSchemasByType.dremio,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("mariadb"),
-		metadata: databaseMetadataSchemasByType["mariadb"],
+		metadata: databaseMetadataSchemasByType.mariadb,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("materialize"),
-		metadata: databaseMetadataSchemasByType["materialize"],
+		metadata: databaseMetadataSchemasByType.materialize,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("mindsdb"),
-		metadata: databaseMetadataSchemasByType["mindsdb"],
+		metadata: databaseMetadataSchemasByType.mindsdb,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("mongodb"),
-		metadata: databaseMetadataSchemasByType["mongodb"],
+		metadata: databaseMetadataSchemasByType.mongodb,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("mysql"),
-		metadata: databaseMetadataSchemasByType["mysql"],
+		metadata: databaseMetadataSchemasByType.mysql,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
@@ -383,12 +383,12 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("pgsql"),
-		metadata: databaseMetadataSchemasByType["pgsql"],
+		metadata: databaseMetadataSchemasByType.pgsql,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("redshift"),
-		metadata: databaseMetadataSchemasByType["redshift"],
+		metadata: databaseMetadataSchemasByType.redshift,
 		federated_auth_method: zod.default.enum([
 			"username-and-password",
 			"iam-role",
@@ -397,7 +397,7 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("snowflake"),
-		metadata: databaseMetadataSchemasByType["snowflake"],
+		metadata: databaseMetadataSchemasByType.snowflake,
 		federated_auth_method: zod.default.enum([
 			"okta",
 			"snowflake",
@@ -409,7 +409,7 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("spanner"),
-		metadata: databaseMetadataSchemasByType["spanner"],
+		metadata: databaseMetadataSchemasByType.spanner,
 		federated_auth_method: zod.default.null().optional()
 	}),
 	commonIntegrationConfig.extend({
@@ -419,7 +419,7 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 	}),
 	commonIntegrationConfig.extend({
 		type: zod.default.literal("trino"),
-		metadata: databaseMetadataSchemasByType["trino"],
+		metadata: databaseMetadataSchemasByType.trino,
 		federated_auth_method: zod.default.enum(["trino-oauth", "password"]).optional().nullable()
 	})
 ]);
@@ -725,6 +725,7 @@ const getTrinoEnvVars = (integrationId, metadata, projectRootDirectory) => {
 	return {
 		url: `trino://${encodeURIComponent(metadata.user)}:${encodeURIComponent(metadata.password)}@${metadata.host}:${metadata.port}/${encodeURIComponent(metadata.database)}`,
 		params: { connect_args: {
+			client_tags: ["deepnote/toolkit"],
 			...metadata.sslEnabled ? { http_scheme: "https" } : {},
 			...metadata.caCertificateName ? { verify: getCACertificatePath({
 				projectRoot: projectRootDirectory,
@@ -897,6 +898,63 @@ function isDatabaseIntegrationTypeWithSslSupport(type) {
 	return databaseIntegrationTypesWithSslSupport.includes(type);
 }
 
+//#endregion
+//#region src/secret-field-paths.ts
+/**
+* All secret fields for each integration type.
+* This includes all possible secret fields regardless of auth method.
+*
+* Note: For integrations with multiple auth methods (e.g., snowflake, bigquery),
+* this includes all secret fields from all auth variants.
+*/
+const SECRET_PATHS = {
+	alloydb: ["password", "caCertificateText"],
+	mariadb: ["password", "caCertificateText"],
+	materialize: ["password", "caCertificateText"],
+	mindsdb: ["password", "caCertificateText"],
+	mysql: ["password", "caCertificateText"],
+	pgsql: ["password", "caCertificateText"],
+	"sql-server": ["password"],
+	clickhouse: ["password", "caCertificateText"],
+	databricks: ["token"],
+	dremio: ["token"],
+	athena: ["secret_access_key"],
+	spanner: ["service_account"],
+	mongodb: [
+		"password",
+		"connection_string",
+		"rawConnectionString",
+		"caCertificateText"
+	],
+	"pandas-dataframe": [],
+	"big-query": ["service_account", "clientSecret"],
+	snowflake: [
+		"password",
+		"clientSecret",
+		"privateKey",
+		"privateKeyPassphrase"
+	],
+	redshift: ["password", "caCertificateText"],
+	trino: [
+		"password",
+		"clientSecret",
+		"caCertificateText"
+	]
+};
+/**
+* Get the list of secret field paths for a given integration type.
+*
+* @param type - The integration type (e.g., 'pgsql', 'snowflake')
+* @returns Array of field names that contain secrets
+*
+* @example
+* getSecretFieldPaths('pgsql') // => ['password', 'caCertificateText']
+* getSecretFieldPaths('snowflake') // => ['password', 'clientSecret', 'privateKey', 'privateKeyPassphrase']
+*/
+function getSecretFieldPaths(type) {
+	return SECRET_PATHS[type] ?? [];
+}
+
 //#endregion
 exports.AwsAuthMethods = AwsAuthMethods;
 exports.BigQueryAuthMethods = BigQueryAuthMethods;
@@ -911,6 +969,7 @@ exports.databaseIntegrationTypesWithSslSupport = databaseIntegrationTypesWithSsl
 exports.databaseMetadataSchemasByType = databaseMetadataSchemasByType;
 exports.federatedAuthMethods = federatedAuthMethods;
 exports.getEnvironmentVariablesForIntegrations = getEnvironmentVariablesForIntegrations;
+exports.getSecretFieldPaths = getSecretFieldPaths;
 exports.getSnowflakeFederatedAuthSqlAlchemyInput = getSnowflakeFederatedAuthSqlAlchemyInput;
 exports.getSqlAlchemyInput = getSqlAlchemyInput;
 exports.isDatabaseIntegrationType = isDatabaseIntegrationType;