@deepnote/database-integrations 1.5.0 → 1.7.0

package/dist/index.cjs

@@ -1,4 +1,5 @@
-//#region rolldown:runtime
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -15,19 +16,15 @@ var __copyProps = (to, from, except, desc) => {
 	}
 	return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
 	value: mod,
 	enumerable: true
 }) : target, mod));
-
 //#endregion
 let zod = require("zod");
-zod = __toESM(zod);
+zod = __toESM(zod, 1);
 let yaml = require("yaml");
-yaml = __toESM(yaml);
-let __deepnote_blocks = require("@deepnote/blocks");
-__deepnote_blocks = __toESM(__deepnote_blocks);
-
+let _deepnote_blocks = require("@deepnote/blocks");
 //#region src/sql-integration-auth-methods.ts
 const AwsAuthMethods = {
 	AccessKeys: "access-keys",
@@ -68,7 +65,6 @@ function isFederatedAuthMethod(authMethod) {
 function isFederatedAuthMetadata(metadata) {
 	return metadata.authMethod !== void 0 && isFederatedAuthMethod(metadata.authMethod);
 }
-
 //#endregion
 //#region src/database-integration-metadata-schemas.ts
 const athenaMetadataSchema = zod.z.object({
@@ -296,8 +292,6 @@ const pgsqlMetadataSchema = commonDatabaseSchema.extend({
 	caCertificateName: zod.z.string().optional(),
 	caCertificateText: zod.z.string().optional()
 });
-const materializeMetadataSchema = pgsqlMetadataSchema.extend({ cluster: zod.z.string() });
-const sqlServerMetadataSchema = commonDatabaseSchema.extend({ port: zod.z.string() });
 const databaseMetadataSchemasByType = {
 	"alloydb": alloydbMetadataSchema,
 	"athena": athenaMetadataSchema,
@@ -307,7 +301,7 @@ const databaseMetadataSchemasByType = {
 	"databricks": databricksMetadataSchema,
 	"dremio": dremioMetadataSchema,
 	"mariadb": mariadbMetadataSchema,
-	"materialize": materializeMetadataSchema,
+	"materialize": pgsqlMetadataSchema.extend({ cluster: zod.z.string() }),
 	"mindsdb": mindsdbMetadataSchema,
 	"mongodb": mongodbMetadataSchema,
 	"mysql": mysqlMetadataSchema,
@@ -316,10 +310,9 @@ const databaseMetadataSchemasByType = {
 	"redshift": redshiftMetadataSchema,
 	"snowflake": snowflakeMetadataSchema,
 	"spanner": spannerMetadataSchema,
-	"sql-server": sqlServerMetadataSchema,
+	"sql-server": commonDatabaseSchema.extend({ port: zod.z.string() }),
 	"trino": trinoMetadataSchema
 };
-
 //#endregion
 //#region src/database-integration-config.ts
 const commonIntegrationConfig = zod.default.object({
@@ -434,7 +427,6 @@ const databaseIntegrationConfigSchema = zod.default.discriminatedUnion("type", [
 		federated_auth_method: zod.default.enum(["trino-oauth", "password"]).optional().nullable()
 	})
 ]);
-
 //#endregion
 //#region src/snowflake-integration-env-vars.ts
 /**
@@ -500,7 +492,6 @@ function createSqlAlchemyInputFromUrl(url, keyPair) {
 		param_style: "pyformat"
 	};
 }
-
 //#endregion
 //#region src/database-integration-env-vars.ts
 function getEnvironmentVariablesForIntegrations(integrations, params) {
@@ -865,7 +856,6 @@ function getSqlEnvVarName(integrationId) {
 function assertNever(value) {
 	throw new Error(`Unexpected value: ${value}`);
 }
-
 //#endregion
 //#region src/database-integration-types.ts
 const sqlIntegrationTypes = [
@@ -910,7 +900,6 @@ function isSqlIntegrationType(type) {
 function isDatabaseIntegrationTypeWithSslSupport(type) {
 	return databaseIntegrationTypesWithSslSupport.includes(type);
 }
-
 //#endregion
 //#region src/loading/api-error.ts
 /**
@@ -924,18 +913,31 @@ var ApiError = class extends Error {
 		this.statusCode = statusCode;
 	}
 };
-
 //#endregion
 //#region src/loading/constants.ts
-/** Built-in integrations that don't require external configuration. */
-const BUILTIN_INTEGRATIONS = new Set(["deepnote-dataframe-sql", "pandas-dataframe"]);
+/** Built-in integrations that don't require external configuration. Keys are canonical lowercase IDs. */
+const BUILTIN_INTEGRATIONS = /* @__PURE__ */ new Set(["deepnote-dataframe-sql", "pandas-dataframe"]);
+/**
+* Return whether the given integration ID refers to a built-in integration.
+*
+* The comparison is case-insensitive: built-in IDs are stored as canonical
+* lowercase strings in {@link BUILTIN_INTEGRATIONS}, and SQL block metadata may
+* reference them in any casing (e.g. `Pandas-DataFrame`). This mirrors the
+* case-insensitive env-var derivation in `getSqlEnvVarName`, so a built-in is
+* recognized regardless of how a notebook cased its `sql_integration_id`.
+*
+* @param integrationId - The integration ID from SQL block metadata.
+* @returns `true` when the ID matches a built-in integration regardless of casing.
+*/
+function isBuiltinIntegration(integrationId) {
+	return BUILTIN_INTEGRATIONS.has(integrationId.toLowerCase());
+}
 /** Default `.env` file name for storing integration secrets. */
 const DEFAULT_ENV_FILE = ".env";
 /** Default integrations file name. */
 const DEFAULT_INTEGRATIONS_FILE = ".deepnote.env.yaml";
 /** Default Deepnote API base URL. */
 const DEFAULT_API_URL = "https://api.deepnote.com";
-
 //#endregion
 //#region src/loading/env-var-refs.ts
 const ENV_VAR_REF_PREFIX = "env:";
@@ -944,7 +946,7 @@ function generateEnvVarName(integrationId, fieldPath) {
 }
 function parseEnvVarRef(value) {
 	if (typeof value !== "string") return null;
-	if (!value.startsWith(ENV_VAR_REF_PREFIX)) return null;
+	if (!value.startsWith("env:")) return null;
 	const varName = value.slice(4);
 	if (!varName) return null;
 	return {
@@ -1007,7 +1009,6 @@ function resolveEnvVarRefsFromMap(obj, vars, currentPath) {
 	}
 	return obj;
 }
-
 //#endregion
 //#region src/loading/fetch-integrations.ts
 /**
@@ -1018,15 +1019,19 @@ const apiIntegrationSchema = zod.z.object({
 	name: zod.z.string(),
 	type: zod.z.string(),
 	metadata: zod.z.unknown(),
-	is_public: zod.z.boolean(),
-	created_at: zod.z.string(),
-	updated_at: zod.z.string(),
-	federated_auth_method: zod.z.string().nullable()
+	is_public: zod.z.boolean().nullish(),
+	created_at: zod.z.string().nullish(),
+	updated_at: zod.z.string().nullish(),
+	federated_auth_method: zod.z.string().nullish()
 }).passthrough();
 /**
 * Schema for the full API response.
 */
 const apiResponseSchema = zod.z.object({ integrations: zod.z.array(apiIntegrationSchema) }).passthrough();
+const REQUEST_TIMEOUT_MS = 3e4;
+function trimTrailingSlash(url) {
+	return url.replace(/\/+$/, "");
+}
 /**
 * Fetch integrations from the Deepnote API.
 *
@@ -1034,21 +1039,25 @@ const apiResponseSchema = zod.z.object({ integrations: zod.z.array(apiIntegratio
 *
 * @param baseUrl - The base URL of the Deepnote API
 * @param token - The authentication token
-* @param integrationIds - Optional list of integration IDs to fetch. When provided, only these integrations are returned.
+* @param integrationIds - Optional list of integration UUIDs to fetch. When provided, only these integrations are returned.
 * @returns Array of integrations from the API
 * @throws ApiError if the request fails
 */
 async function fetchIntegrations(baseUrl, token, integrationIds) {
-	const endpoint = new URL(`${baseUrl}/v2/integrations`);
+	const endpoint = new URL(`${trimTrailingSlash(baseUrl)}/v2/integrations`);
 	endpoint.searchParams.set("includeMetadata", "true");
-	if (integrationIds && integrationIds.length > 0) endpoint.searchParams.set("integrationIds", integrationIds.join(","));
+	if (integrationIds && integrationIds.length > 0) {
+		const normalizedIntegrationIds = new Set(integrationIds.map((id) => id.toLowerCase()));
+		endpoint.searchParams.set("integrationIds", Array.from(normalizedIntegrationIds).join(","));
+	}
 	const url = endpoint.toString();
 	const response = await fetch(url, {
 		method: "GET",
 		headers: {
 			Authorization: `Bearer ${token}`,
 			"Content-Type": "application/json"
-		}
+		},
+		signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS)
 	});
 	if (!response.ok) {
 		if (response.status === 401) throw new ApiError(401, "Authentication failed. Please check your API token.");
@@ -1060,21 +1069,38 @@ async function fetchIntegrations(baseUrl, token, integrationIds) {
 	if (!parseResult.success) throw new Error(`Invalid API response: ${parseResult.error.message}`);
 	return parseResult.data.integrations;
 }
-
 //#endregion
 //#region src/loading/integrations-document.ts
 /**
+* Error thrown when integrations YAML content cannot be parsed.
+*/
+var IntegrationsYamlParseError = class extends Error {
+	/** The underlying parse errors reported by the `yaml` library. */
+	errors;
+	constructor(errors) {
+		super(`Failed to parse integrations YAML: ${errors[0]?.message ?? "unknown parse error"}`);
+		this.name = "IntegrationsYamlParseError";
+		this.errors = errors;
+	}
+};
+/**
 * Parse integrations YAML content into a mutable `yaml` Document that preserves
 * comments and formatting. Returns `null` for empty content.
 *
 * This is the content-accepting counterpart of the Node-only `readIntegrationsDocument`.
+*
+* @throws {IntegrationsYamlParseError} If the content is not valid YAML. Malformed
+* content is rejected here rather than at serialization time, where `yaml` would
+* otherwise fail with an opaque "Document with errors cannot be stringified".
 */
 function parseIntegrationsDocument(content) {
 	if (!content.trim()) return null;
-	return (0, yaml.parseDocument)(content, {
+	const doc = (0, yaml.parseDocument)(content, {
 		strict: true,
 		version: "1.2"
 	});
+	if (doc.errors.length > 0) throw new IntegrationsYamlParseError(doc.errors);
+	return doc;
 }
 /**
 * Serialize an integrations Document back to YAML text, preserving comments and
@@ -1083,7 +1109,6 @@ function parseIntegrationsDocument(content) {
 function serializeIntegrationsDocument(doc) {
 	return doc.toString({ lineWidth: 0 });
 }
-
 //#endregion
 //#region src/loading/integrations-file-schema.ts
 /**
@@ -1104,7 +1129,6 @@ function serializeIntegrationsDocument(doc) {
 */
 const baseIntegrationsFileSchema = zod.z.object({ integrations: zod.z.array(zod.z.record(zod.z.unknown())).optional().default([]) });
 const integrationsFileSchema = zod.z.object({ integrations: zod.z.array(databaseIntegrationConfigSchema) });
-
 //#endregion
 //#region src/secret-field-paths.ts
 /**
@@ -1140,7 +1164,8 @@ const SECRET_PATHS = {
 		"password",
 		"clientSecret",
 		"privateKey",
-		"privateKeyPassphrase"
+		"privateKeyPassphrase",
+		"dbtServiceToken"
 	],
 	redshift: ["password", "caCertificateText"],
 	trino: [
@@ -1157,12 +1182,11 @@ const SECRET_PATHS = {
 *
 * @example
 * getSecretFieldPaths('pgsql') // => ['password', 'caCertificateText']
-* getSecretFieldPaths('snowflake') // => ['password', 'clientSecret', 'privateKey', 'privateKeyPassphrase']
+* getSecretFieldPaths('snowflake') // => ['password', 'clientSecret', 'privateKey', 'privateKeyPassphrase', 'dbtServiceToken']
 */
 function getSecretFieldPaths(type) {
 	return SECRET_PATHS[type] ?? [];
 }
-
 //#endregion
 //#region src/loading/merge-integrations.ts
 /**
@@ -1232,7 +1256,7 @@ function updateIntegrationMetadataMap({ metadataMap, integrationId, integrationM
 * @returns Record of extracted secrets (envVarName -> secretValue)
 */
 function updateIntegrationInDocument(doc, integrationMap, integration) {
-	const { id, name, type, metadata, federated_auth_method,...rest } = integration;
+	const { id, name, type, metadata, federated_auth_method, ...rest } = integration;
 	integrationMap.set("id", id);
 	integrationMap.set("name", name);
 	integrationMap.set("type", type);
@@ -1255,7 +1279,7 @@ function updateIntegrationInDocument(doc, integrationMap, integration) {
 */
 function addIntegrationToSeq(doc, integrationsSeq, integration) {
 	const secretPaths = getSecretFieldPaths(integration.type);
-	const { metadata,...restIntegration } = integration;
+	const { metadata, ...restIntegration } = integration;
 	const integrationMap = doc.createNode(restIntegration);
 	const metadataMap = doc.createNode({});
 	const secrets = updateIntegrationMetadataMap({
@@ -1382,7 +1406,6 @@ function mergeApiIntegrationsIntoDocument(doc, apiIntegrations) {
 		skipped
 	};
 }
-
 //#endregion
 //#region src/loading/merge-into-yaml.ts
 /**
@@ -1396,6 +1419,14 @@ function mergeApiIntegrationsIntoDocument(doc, apiIntegrations) {
 *
 * @param existingContent - Current YAML content, or `null` if the file doesn't exist yet
 * @param apiIntegrations - Integrations fetched from the API
+*
+* @throws {IntegrationsYamlParseError} If `existingContent` is not valid YAML (for
+* example, unresolved git merge conflict markers). Callers that want to rebuild the
+* file from scratch instead of surfacing the error can catch it and re-run with
+* `mergeApiIntegrationsIntoYaml(null, apiIntegrations)` — note this discards the
+* existing content, including any local-only integrations and comments.
+* @throws {InvalidIntegrationsTypeError} If the existing `integrations` property is
+* present but is not a list.
 */
 function mergeApiIntegrationsIntoYaml(existingContent, apiIntegrations) {
 	const doc = (existingContent != null ? parseIntegrationsDocument(existingContent) : null) ?? createNewDocument();
@@ -1408,7 +1439,6 @@ function mergeApiIntegrationsIntoYaml(existingContent, apiIntegrations) {
 		skipped
 	};
 }
-
 //#endregion
 //#region src/loading/parse-integrations.ts
 /**
@@ -1432,12 +1462,12 @@ function formatZodIssues(issues, pathPrefix) {
 *
 * @returns Object containing valid integrations and any validation issues
 */
-function parseIntegrations({ yaml: yaml$1, env = {} }) {
+function parseIntegrations({ yaml, env = {} }) {
 	const emptyIntegrations = [];
 	const issues = [];
 	let parsed;
 	try {
-		parsed = (0, __deepnote_blocks.parseYaml)(yaml$1);
+		parsed = (0, _deepnote_blocks.parseYaml)(yaml);
 	} catch (error) {
 		const message = error instanceof Error ? error.message : String(error);
 		issues.push({
@@ -1497,7 +1527,6 @@ function parseIntegrations({ yaml: yaml$1, env = {} }) {
 		issues
 	};
 }
-
 //#endregion
 exports.ApiError = ApiError;
 exports.AwsAuthMethods = AwsAuthMethods;
@@ -1510,6 +1539,7 @@ exports.DEFAULT_INTEGRATIONS_FILE = DEFAULT_INTEGRATIONS_FILE;
 exports.DatabaseAuthMethods = DatabaseAuthMethods;
 exports.ENV_VAR_REF_PREFIX = ENV_VAR_REF_PREFIX;
 exports.EnvVarResolutionError = EnvVarResolutionError;
+exports.IntegrationsYamlParseError = IntegrationsYamlParseError;
 exports.InvalidIntegrationError = InvalidIntegrationError;
 exports.InvalidIntegrationsTypeError = InvalidIntegrationsTypeError;
 exports.JSON_SCHEMA_URL = JSON_SCHEMA_URL;
@@ -1540,6 +1570,7 @@ exports.getSnowflakeFederatedAuthSqlAlchemyInput = getSnowflakeFederatedAuthSqlA
 exports.getSqlAlchemyInput = getSqlAlchemyInput;
 exports.getSqlEnvVarName = getSqlEnvVarName;
 exports.integrationsFileSchema = integrationsFileSchema;
+exports.isBuiltinIntegration = isBuiltinIntegration;
 exports.isDatabaseIntegrationType = isDatabaseIntegrationType;
 exports.isDatabaseIntegrationTypeWithSslSupport = isDatabaseIntegrationTypeWithSslSupport;
 exports.isEnvVarRef = isEnvVarRef;
@@ -1556,4 +1587,4 @@ exports.resolveEnvVarRefsFromMap = resolveEnvVarRefsFromMap;
 exports.serializeIntegrationsDocument = serializeIntegrationsDocument;
 exports.sqlIntegrationTypes = sqlIntegrationTypes;
 exports.updateIntegrationInDocument = updateIntegrationInDocument;
-exports.updateIntegrationMetadataMap = updateIntegrationMetadataMap;
+exports.updateIntegrationMetadataMap = updateIntegrationMetadataMap;