@deepnote/database-integrations 1.5.0 → 1.7.0

package/dist/index.js

@@ -1,7 +1,6 @@
 import z, { z as z$1 } from "zod";
 import { isMap, isSeq, parseDocument } from "yaml";
 import { parseYaml } from "@deepnote/blocks";
-
 //#region src/sql-integration-auth-methods.ts
 const AwsAuthMethods = {
 	AccessKeys: "access-keys",
@@ -42,7 +41,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 = z$1.object({
@@ -270,8 +268,6 @@ const pgsqlMetadataSchema = commonDatabaseSchema.extend({
 	caCertificateName: z$1.string().optional(),
 	caCertificateText: z$1.string().optional()
 });
-const materializeMetadataSchema = pgsqlMetadataSchema.extend({ cluster: z$1.string() });
-const sqlServerMetadataSchema = commonDatabaseSchema.extend({ port: z$1.string() });
 const databaseMetadataSchemasByType = {
 	"alloydb": alloydbMetadataSchema,
 	"athena": athenaMetadataSchema,
@@ -281,7 +277,7 @@ const databaseMetadataSchemasByType = {
 	"databricks": databricksMetadataSchema,
 	"dremio": dremioMetadataSchema,
 	"mariadb": mariadbMetadataSchema,
-	"materialize": materializeMetadataSchema,
+	"materialize": pgsqlMetadataSchema.extend({ cluster: z$1.string() }),
 	"mindsdb": mindsdbMetadataSchema,
 	"mongodb": mongodbMetadataSchema,
 	"mysql": mysqlMetadataSchema,
@@ -290,10 +286,9 @@ const databaseMetadataSchemasByType = {
 	"redshift": redshiftMetadataSchema,
 	"snowflake": snowflakeMetadataSchema,
 	"spanner": spannerMetadataSchema,
-	"sql-server": sqlServerMetadataSchema,
+	"sql-server": commonDatabaseSchema.extend({ port: z$1.string() }),
 	"trino": trinoMetadataSchema
 };
-
 //#endregion
 //#region src/database-integration-config.ts
 const commonIntegrationConfig = z.object({
@@ -408,7 +403,6 @@ const databaseIntegrationConfigSchema = z.discriminatedUnion("type", [
 		federated_auth_method: z.enum(["trino-oauth", "password"]).optional().nullable()
 	})
 ]);
-
 //#endregion
 //#region src/snowflake-integration-env-vars.ts
 /**
@@ -474,7 +468,6 @@ function createSqlAlchemyInputFromUrl(url, keyPair) {
 		param_style: "pyformat"
 	};
 }
-
 //#endregion
 //#region src/database-integration-env-vars.ts
 function getEnvironmentVariablesForIntegrations(integrations, params) {
@@ -839,7 +832,6 @@ function getSqlEnvVarName(integrationId) {
 function assertNever(value) {
 	throw new Error(`Unexpected value: ${value}`);
 }
-
 //#endregion
 //#region src/database-integration-types.ts
 const sqlIntegrationTypes = [
@@ -884,7 +876,6 @@ function isSqlIntegrationType(type) {
 function isDatabaseIntegrationTypeWithSslSupport(type) {
 	return databaseIntegrationTypesWithSslSupport.includes(type);
 }
-
 //#endregion
 //#region src/loading/api-error.ts
 /**
@@ -898,18 +889,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:";
@@ -918,7 +922,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 {
@@ -981,7 +985,6 @@ function resolveEnvVarRefsFromMap(obj, vars, currentPath) {
 	}
 	return obj;
 }
-
 //#endregion
 //#region src/loading/fetch-integrations.ts
 /**
@@ -992,15 +995,19 @@ const apiIntegrationSchema = z$1.object({
 	name: z$1.string(),
 	type: z$1.string(),
 	metadata: z$1.unknown(),
-	is_public: z$1.boolean(),
-	created_at: z$1.string(),
-	updated_at: z$1.string(),
-	federated_auth_method: z$1.string().nullable()
+	is_public: z$1.boolean().nullish(),
+	created_at: z$1.string().nullish(),
+	updated_at: z$1.string().nullish(),
+	federated_auth_method: z$1.string().nullish()
 }).passthrough();
 /**
 * Schema for the full API response.
 */
 const apiResponseSchema = z$1.object({ integrations: z$1.array(apiIntegrationSchema) }).passthrough();
+const REQUEST_TIMEOUT_MS = 3e4;
+function trimTrailingSlash(url) {
+	return url.replace(/\/+$/, "");
+}
 /**
 * Fetch integrations from the Deepnote API.
 *
@@ -1008,21 +1015,25 @@ const apiResponseSchema = z$1.object({ integrations: z$1.array(apiIntegrationSch
 *
 * @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.");
@@ -1034,21 +1045,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 parseDocument(content, {
+	const doc = 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
@@ -1057,7 +1085,6 @@ function parseIntegrationsDocument(content) {
 function serializeIntegrationsDocument(doc) {
 	return doc.toString({ lineWidth: 0 });
 }
-
 //#endregion
 //#region src/loading/integrations-file-schema.ts
 /**
@@ -1078,7 +1105,6 @@ function serializeIntegrationsDocument(doc) {
 */
 const baseIntegrationsFileSchema = z$1.object({ integrations: z$1.array(z$1.record(z$1.unknown())).optional().default([]) });
 const integrationsFileSchema = z$1.object({ integrations: z$1.array(databaseIntegrationConfigSchema) });
-
 //#endregion
 //#region src/secret-field-paths.ts
 /**
@@ -1114,7 +1140,8 @@ const SECRET_PATHS = {
 		"password",
 		"clientSecret",
 		"privateKey",
-		"privateKeyPassphrase"
+		"privateKeyPassphrase",
+		"dbtServiceToken"
 	],
 	redshift: ["password", "caCertificateText"],
 	trino: [
@@ -1131,12 +1158,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
 /**
@@ -1206,7 +1232,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);
@@ -1229,7 +1255,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({
@@ -1356,7 +1382,6 @@ function mergeApiIntegrationsIntoDocument(doc, apiIntegrations) {
 		skipped
 	};
 }
-
 //#endregion
 //#region src/loading/merge-into-yaml.ts
 /**
@@ -1370,6 +1395,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();
@@ -1382,7 +1415,6 @@ function mergeApiIntegrationsIntoYaml(existingContent, apiIntegrations) {
 		skipped
 	};
 }
-
 //#endregion
 //#region src/loading/parse-integrations.ts
 /**
@@ -1471,6 +1503,5 @@ function parseIntegrations({ yaml, env = {} }) {
 		issues
 	};
 }
-
 //#endregion
-export { ApiError, AwsAuthMethods, BUILTIN_INTEGRATIONS, BigQueryAuthMethods, BigQueryServiceAccountParseError, DEFAULT_API_URL, DEFAULT_ENV_FILE, DEFAULT_INTEGRATIONS_FILE, DatabaseAuthMethods, ENV_VAR_REF_PREFIX, EnvVarResolutionError, InvalidIntegrationError, InvalidIntegrationsTypeError, JSON_SCHEMA_URL, SCHEMA_COMMENT, SnowflakeAuthMethods, SpannerServiceAccountParseError, TrinoAuthMethods, addIntegrationToSeq, apiIntegrationSchema, apiResponseSchema, baseIntegrationsFileSchema, convertApiIntegrations, createEnvVarRef, createNewDocument, databaseIntegrationConfigSchema, databaseIntegrationTypes, databaseIntegrationTypesWithSslSupport, databaseMetadataSchemasByType, extractEnvVarName, federatedAuthMethods, fetchIntegrations, generateEnvVarName, getEnvironmentVariablesForIntegrations, getOrCreateIntegrationMetadata, getOrCreateIntegrationsFromDocument, getSecretFieldPaths, getSnowflakeFederatedAuthSqlAlchemyInput, getSqlAlchemyInput, getSqlEnvVarName, integrationsFileSchema, isDatabaseIntegrationType, isDatabaseIntegrationTypeWithSslSupport, isEnvVarRef, isFederatedAuthMetadata, isFederatedAuthMethod, isSqlIntegrationType, mergeApiIntegrationsIntoDocument, mergeApiIntegrationsIntoYaml, mergeProcessedIntegrations, parseEnvVarRef, parseIntegrations, parseIntegrationsDocument, resolveEnvVarRefsFromMap, serializeIntegrationsDocument, sqlIntegrationTypes, updateIntegrationInDocument, updateIntegrationMetadataMap };
+export { ApiError, AwsAuthMethods, BUILTIN_INTEGRATIONS, BigQueryAuthMethods, BigQueryServiceAccountParseError, DEFAULT_API_URL, DEFAULT_ENV_FILE, DEFAULT_INTEGRATIONS_FILE, DatabaseAuthMethods, ENV_VAR_REF_PREFIX, EnvVarResolutionError, IntegrationsYamlParseError, InvalidIntegrationError, InvalidIntegrationsTypeError, JSON_SCHEMA_URL, SCHEMA_COMMENT, SnowflakeAuthMethods, SpannerServiceAccountParseError, TrinoAuthMethods, addIntegrationToSeq, apiIntegrationSchema, apiResponseSchema, baseIntegrationsFileSchema, convertApiIntegrations, createEnvVarRef, createNewDocument, databaseIntegrationConfigSchema, databaseIntegrationTypes, databaseIntegrationTypesWithSslSupport, databaseMetadataSchemasByType, extractEnvVarName, federatedAuthMethods, fetchIntegrations, generateEnvVarName, getEnvironmentVariablesForIntegrations, getOrCreateIntegrationMetadata, getOrCreateIntegrationsFromDocument, getSecretFieldPaths, getSnowflakeFederatedAuthSqlAlchemyInput, getSqlAlchemyInput, getSqlEnvVarName, integrationsFileSchema, isBuiltinIntegration, isDatabaseIntegrationType, isDatabaseIntegrationTypeWithSslSupport, isEnvVarRef, isFederatedAuthMetadata, isFederatedAuthMethod, isSqlIntegrationType, mergeApiIntegrationsIntoDocument, mergeApiIntegrationsIntoYaml, mergeProcessedIntegrations, parseEnvVarRef, parseIntegrations, parseIntegrationsDocument, resolveEnvVarRefsFromMap, serializeIntegrationsDocument, sqlIntegrationTypes, updateIntegrationInDocument, updateIntegrationMetadataMap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepnote/database-integrations",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Deepnote database integration definitions",
   "keywords": [],
   "repository": {
@@ -27,17 +27,17 @@
     "package.json"
   ],
   "dependencies": {
-    "yaml": "^2.8.3",
+    "yaml": "^2.9.0",
     "zod": "3.25.76",
-    "@deepnote/blocks": "4.6.0"
+    "@deepnote/blocks": "4.8.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
-    "build": "tsdown --format esm --format cjs --dts",
+    "build": "tsdown --format esm --format cjs --dts --no-fixed-extension",
     "test": "vitest",
-    "watch": "tsdown --watch --format esm --format cjs --dts"
+    "watch": "tsdown --watch --format esm --format cjs --dts --no-fixed-extension"
   }
 }