@deepnote/database-integrations 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [2025] [Deepnote Inc]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -60,7 +60,7 @@ This package provides TypeScript types and utilities for working with Deepnote S
 ### Environment variables and configuration
 
 - utilities
-  - `getIntegrationListEnv(integrations: Array<DatabaseIntegrationConfig>, params: { projectRootDirectory: string, snowflakePartnerIdentifier?: string })` – Creates a list of environment variables to be set when executing a notebook that uses the integrations, the variables are in a format consumed by the Deepnote Toolkit
+  - `getEnvironmentVariablesForIntegrations(integrations: Array<DatabaseIntegrationConfig>, params: { projectRootDirectory: string, snowflakePartnerIdentifier?: string })` – Creates a list of environment variables to be set when executing a notebook that uses the integrations, the variables are in a format consumed by the Deepnote Toolkit
     - arguments:
       - `integrations` – list of active integrations
       - `params.projectRootDirectory` – project root directory, used to construct paths to CA certificates
@@ -71,7 +71,7 @@ This package provides TypeScript types and utilities for working with Deepnote S
           - `*INTEGRATION_NAME*_*METADATA_KEY*` - for each metadata field of the integration
           - `SQL_*INTEGRATION_ID*` - SQL Alchemy config for each SQL integration
       - `errors: Array<Error>` – List of errors that occurred when generating the environment variables. These are not thrown to allow partial functionality, even when some integrations are misconfigured.
-  - `getSqlAlchemyInput(sqlIntegration: SqlIntegrationConfig, params: { projectRootDirectory: string, snowflakePartnerIdentifier?: string })` – Creates a SQL Alchemy config for a SQL integration, used to connect to the database from SQL blocks. This is used internally within `getIntegrationListEnv()`.
+  - `getSqlAlchemyInput(sqlIntegration: SqlIntegrationConfig, params: { projectRootDirectory: string, snowflakePartnerIdentifier?: string })` – Creates a SQL Alchemy config for a SQL integration, used to connect to the database from SQL blocks. This is used internally within `getEnvironmentVariablesForIntegrations()`.
     - arguments:
       - `sqlIntegration` – SQL integration configuration
       - `params.projectRootDirectory` – project root directory, used to construct paths to CA certificates
@@ -140,7 +140,7 @@ if (validationResult.error) {
 ### Example: Getting environment variables for configured integrations
 
 ```ts
-import { getIntegrationListEnv } from "@deepnote/database-integrations";
+import { getEnvironmentVariablesForIntegrations } from "@deepnote/database-integrations";
 
 const integrations = [
   {
@@ -156,7 +156,7 @@ const integrations = [
   },
 ];
 
-const { envVars } = getIntegrationListEnv(integrations, {
+const { envVars } = getEnvironmentVariablesForIntegrations(integrations, {
   projectRootDirectory: "/path/to/project",
 });
 

package/dist/index.cjs

@@ -67,27 +67,21 @@ function isFederatedAuthMetadata(metadata) {
 function getSnowflakeSqlAlchemyInput(metadata, params) {
 	if (isFederatedAuthMetadata(metadata)) return null;
 	const { username, accountName, database, authMethod } = metadata;
-	if (authMethod === SnowflakeAuthMethods.ServiceAccountKeyPair) {
-		const url$1 = (0, build_url_ts.default)(`snowflake://${encodeURIComponent(username)}@${encodeURIComponent(accountName)}`, {
-			path: database,
-			queryParams: {
-				...createBaseQueryParams(metadata, params.snowflakePartnerIdentifier),
-				authenticator: "snowflake_jwt"
-			}
-		});
-		if (!url$1) throw new Error("getSnowflakeEnvVar URL must be defined");
-		return createSqlAlchemyInputFromUrl(url$1, {
-			privateKey: metadata.privateKey,
-			password: metadata.privateKeyPassphrase,
-			username: metadata.username
-		});
-	}
-	const url = (0, build_url_ts.default)(`snowflake://${encodeURIComponent(username)}:${encodeURIComponent(metadata.password)}@${encodeURIComponent(accountName)}`, {
+	if (authMethod === SnowflakeAuthMethods.ServiceAccountKeyPair) return createSqlAlchemyInputFromUrl((0, build_url_ts.default)(`snowflake://${encodeURIComponent(username)}@${encodeURIComponent(accountName)}`, {
 		path: database,
-		queryParams: { ...createBaseQueryParams(metadata, params.snowflakePartnerIdentifier) }
+		queryParams: {
+			...createBaseQueryParams(metadata, params.snowflakePartnerIdentifier),
+			authenticator: "snowflake_jwt"
+		}
+	}), {
+		privateKey: metadata.privateKey,
+		password: metadata.privateKeyPassphrase,
+		username: metadata.username
 	});
-	if (!url) throw new Error("getSnowflakeEnvVar URL must be defined");
-	return createSqlAlchemyInputFromUrl(url);
+	return createSqlAlchemyInputFromUrl((0, build_url_ts.default)(`snowflake://${encodeURIComponent(username)}:${encodeURIComponent(metadata.password)}@${encodeURIComponent(accountName)}`, {
+		path: database,
+		queryParams: { ...createBaseQueryParams(metadata, params.snowflakePartnerIdentifier) }
+	}));
 }
 function createBaseQueryParams(metadata, snowflakePartnerIdentifier) {
 	return {
@@ -100,8 +94,8 @@ function createSqlAlchemyInputFromUrl(url, keyPair) {
 	return {
 		url,
 		params: keyPair ? {
-			snowflake_private_key: Buffer.from(keyPair.privateKey).toString("base64"),
-			snowflake_private_key_passphrase: keyPair.password || void 0
+			snowflake_private_key: btoa(keyPair.privateKey),
+			...keyPair.password ? { snowflake_private_key_passphrase: keyPair.password } : {}
 		} : {},
 		param_style: "pyformat"
 	};
@@ -109,10 +103,10 @@ function createSqlAlchemyInputFromUrl(url, keyPair) {
 
 //#endregion
 //#region src/database-integration-env-vars.ts
-function getIntegrationListEnv(sqlIntegrations, params) {
+function getEnvironmentVariablesForIntegrations(integrations, params) {
 	const envVars = [];
 	const errors = [];
-	sqlIntegrations.forEach((integration) => {
+	integrations.forEach((integration) => {
 		const namePrefix = convertToEnvironmentVariableName(integration.name);
 		const envVarsForThisIntegration = Object.entries(integration.metadata).map(([key, rawValue]) => {
 			const name = `${namePrefix}_${key.toUpperCase()}`;
@@ -139,11 +133,6 @@ function getIntegrationListEnv(sqlIntegrations, params) {
 		errors
 	};
 }
-const duckDbEnvVar = {
-	url: `deepnote+duckdb:///:memory:`,
-	params: {},
-	param_style: "qmark"
-};
 function addSslOptionsToMongoConnectionString(projectRoot, connectionString, integrationId, metadata) {
 	const [base, paramString] = connectionString.split("?");
 	const params = new URLSearchParams(paramString);
@@ -162,7 +151,7 @@ function getEnvVarForSqlCells(integration, params) {
 	const sqlAlchemyInput = getSqlAlchemyInput(integration, params);
 	if (!sqlAlchemyInput) return null;
 	return {
-		name: convertToEnvironmentVariableName(getSqlEnvVarName(integration.id)),
+		name: getSqlEnvVarName(integration.id),
 		value: JSON.stringify({
 			integration_id: integration.id,
 			...sqlAlchemyInput
@@ -193,7 +182,11 @@ function getSqlAlchemyInput(integration, params) {
 		case "mindsdb":
 		case "mysql": return getMySqlSqlAlchemyInput(integration.id, params.projectRootDirectory, integration.metadata);
 		case "materialize": return getMaterializePostgresSqlAlchemyInput(integration.id, params.projectRootDirectory, integration.metadata);
-		case "pandas-dataframe": return { ...duckDbEnvVar };
+		case "pandas-dataframe": return {
+			url: `deepnote+duckdb:///:memory:`,
+			params: {},
+			param_style: "qmark"
+		};
 		case "redshift": return getRedshiftSqlAlchemyInput(integration.id, params.projectRootDirectory, integration.metadata);
 		case "snowflake": return getSnowflakeSqlAlchemyInput(integration.metadata, { snowflakePartnerIdentifier: params.snowflakePartnerIdentifier });
 		case "spanner": return getSpannerSqlAlchemyInput(integration.metadata);
@@ -212,7 +205,7 @@ const getDatabricksSqlAlchemyInput = ({ httpPath, host, token, port, schema, cat
 		} },
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -220,7 +213,7 @@ const getDatabricksSqlAlchemyInput = ({ httpPath, host, token, port, schema, cat
 	};
 };
 const getDremioSqlAlchemyInput = ({ port, host, token, schema, sshEnabled, sshHost, sshPort, sshUser }) => {
-	const url = new URL(`dremio+flight://${host}:${port}${schema ? "/" + schema : ""}`);
+	const url = new URL(`dremio+flight://${host}:${port}${schema ? `/${schema}` : ""}`);
 	url.searchParams.set("UseEncryption", "true");
 	url.searchParams.set("Token", token);
 	return {
@@ -228,7 +221,7 @@ const getDremioSqlAlchemyInput = ({ port, host, token, schema, sshEnabled, sshHo
 		params: {},
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -242,7 +235,7 @@ const getSQLServerVar = ({ user, password, host, port, database, sshEnabled, ssh
 		params: {},
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -268,7 +261,7 @@ const getPostgresSqlAlchemyInput = (integrationId, projectRootDirectory, { user,
 		} },
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -296,7 +289,7 @@ const getRedshiftSqlAlchemyInput = (integrationId, projectRootDirectory, metadat
 		} },
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(metadata.sshEnabled),
+			enabled: metadata.sshEnabled == null ? void 0 : String(metadata.sshEnabled),
 			host: metadata.sshHost,
 			port: metadata.sshPort,
 			user: metadata.sshUser
@@ -328,7 +321,7 @@ const getMaterializePostgresSqlAlchemyInput = (integrationId, projectRootDirecto
 		} },
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -381,7 +374,7 @@ const getClickHouseSqlAlchemyInput = (integrationId, projectRootDirectory, { use
 		params: {},
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -447,7 +440,7 @@ const getMySqlSqlAlchemyInput = (integrationId, projectRootDirectory, { user, pa
 		params: { connect_args: { ssl } },
 		param_style: "pyformat",
 		ssh_options: {
-			enabled: String(sshEnabled),
+			enabled: sshEnabled == null ? void 0 : String(sshEnabled),
 			host: sshHost,
 			port: sshPort,
 			user: sshUser
@@ -455,13 +448,13 @@ const getMySqlSqlAlchemyInput = (integrationId, projectRootDirectory, { user, pa
 	};
 };
 function getCACertificatePath({ projectRoot, integrationId, caCertificateName }) {
-	return `${projectRoot ?? ""}/.deepnote/${integrationId}/${caCertificateName}`;
+	return `${projectRoot}/.deepnote/${integrationId}/${caCertificateName}`;
 }
 function convertToEnvironmentVariableName(str) {
 	return (/^\d/.test(str) ? `_${str}` : str).toUpperCase().replace(/[^\w]/g, "_");
 }
 function getSqlEnvVarName(integrationId) {
-	return `SQL_${integrationId}`;
+	return convertToEnvironmentVariableName(`SQL_${integrationId}`);
 }
 function assertNever(value) {
 	throw new Error(`Unexpected value: ${value}`);
@@ -727,7 +720,7 @@ exports.SpannerServiceAccountParseError = SpannerServiceAccountParseError;
 exports.databaseIntegrationTypes = databaseIntegrationTypes;
 exports.databaseIntegrationTypesWithSslSupport = databaseIntegrationTypesWithSslSupport;
 exports.databaseMetadataSchemasByType = databaseMetadataSchemasByType;
-exports.getIntegrationListEnv = getIntegrationListEnv;
+exports.getEnvironmentVariablesForIntegrations = getEnvironmentVariablesForIntegrations;
 exports.getSqlAlchemyInput = getSqlAlchemyInput;
 exports.isFederatedAuthMetadata = isFederatedAuthMetadata;
 exports.isFederatedAuthMethod = isFederatedAuthMethod;