@lightdash/cli 1.154.0 → 1.154.2

package/dist/handlers/login.d.ts

@@ -10,6 +10,14 @@ type LoginOptions = {
     interactive?: boolean;
     verbose: boolean;
 };
+/**
+ * `LIGHTDASH_API_KEY` takes precedence over the token saved by `lightdash login`,
+ * so a login that saves a different token has no effect until the variable is
+ * unset. We warn rather than refuse, because `lightdash login --token
+ * $LIGHTDASH_API_KEY` is a documented CI pattern — there both tokens are the
+ * same and nothing is shadowed.
+ */
+export declare const isApiKeyEnvVarShadowing: (token: string | undefined, env?: NodeJS.ProcessEnv) => boolean;
 export declare const login: (urlInput: string | undefined, options: LoginOptions) => Promise<void>;
 export {};
 //# sourceMappingURL=login.d.ts.map

package/dist/handlers/login.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../src/handlers/login.ts"],"names":[],"mappings":"AAkBA,KAAK,YAAY,GAAG;IAChB,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AA4JF,eAAO,MAAM,KAAK,aACJ,MAAM,GAAG,SAAS,WACnB,YAAY,kBA2JxB,CAAC"}
+{"version":3,"file":"login.d.ts","sourceRoot":"","sources":["../../src/handlers/login.ts"],"names":[],"mappings":"AAkBA,KAAK,YAAY,GAAG;IAChB,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CACpB,CAAC;AA8CF;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,UACzB,MAAM,GAAG,SAAS,QACpB,MAAM,CAAC,UAAU,KACvB,OAAqE,CAAC;AA2HzE,eAAO,MAAM,KAAK,aACJ,MAAM,GAAG,SAAS,WACnB,YAAY,kBAoKxB,CAAC"}

package/dist/handlers/login.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.login = void 0;
+exports.login = exports.isApiKeyEnvVarShadowing = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
@@ -54,6 +54,18 @@ const getLoginMethod = (options) => {
         return 'password';
     return 'oauth';
 };
+/**
+ * `LIGHTDASH_API_KEY` takes precedence over the token saved by `lightdash login`,
+ * so a login that saves a different token has no effect until the variable is
+ * unset. We warn rather than refuse, because `lightdash login --token
+ * $LIGHTDASH_API_KEY` is a documented CI pattern — there both tokens are the
+ * same and nothing is shadowed.
+ */
+const isApiKeyEnvVarShadowing = (token, env = process.env) => !!env.LIGHTDASH_API_KEY && env.LIGHTDASH_API_KEY !== token;
+exports.isApiKeyEnvVarShadowing = isApiKeyEnvVarShadowing;
+const apiKeyEnvVarWarning = (when) => styles.warning(when === 'before-login'
+    ? `\n⚠️  LIGHTDASH_API_KEY is set and takes precedence over the token saved by \`lightdash login\` (${config_1.configFilePath}).\n   Every command will keep using LIGHTDASH_API_KEY until you unset it:\n\n     ${styles.bold('unset LIGHTDASH_API_KEY')}\n`
+    : `  ⚠️  LIGHTDASH_API_KEY is still set and takes precedence — run ${styles.bold('unset LIGHTDASH_API_KEY')} for this login to take effect.\n`);
 const loginWithToken = async (url, token) => {
     const userInfoUrl = new url_1.URL(`/api/v1/user`, url).href;
     const response = await (0, node_fetch_1.default)(userInfoUrl, {
@@ -161,6 +173,9 @@ const login = async (urlInput, options) => {
         const cloudServer = url.replace('lightdash.com', 'lightdash.cloud');
         console.error(`\n${styles.title('Warning')}: Login URL ${styles.secondary(url)} does not match a valid cloud server, perhaps you meant ${styles.secondary(cloudServer)} ?\n`);
     }
+    if ((0, exports.isApiKeyEnvVarShadowing)(options.token)) {
+        console.error(apiKeyEnvVarWarning('before-login'));
+    }
     const email = options.email || process.env.LIGHTDASH_CLI_EMAIL;
     const password = process.env.LIGHTDASH_CLI_PASSWORD;
     let loginResult;
@@ -213,6 +228,9 @@ const login = async (urlInput, options) => {
     globalState_1.default.debug(`> Saved config on: ${config_1.configFilePath}`);
     await (0, config_1.setDefaultUser)(userUuid, organizationUuid);
     console.error(`\n  ✅️ Login successful\n`);
+    if ((0, exports.isApiKeyEnvVarShadowing)(token)) {
+        console.error(apiKeyEnvVarWarning('after-login'));
+    }
     try {
         if (options.project) {
             await (0, setProject_1.setProjectCommand)(undefined, options.project);
@@ -231,7 +249,8 @@ const login = async (urlInput, options) => {
             }
         }
     }
-    catch {
+    catch (e) {
+        globalState_1.default.debug(`> Failed to select project: ${(0, common_1.getErrorMessage)(e)}`);
         console.error('Unable to select projects, try with: ');
         console.error(`\n  ${styles.bold(`⚡️ lightdash config set-project`)}\n`);
     }

package/dist/handlers/login.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=login.test.d.ts.map

package/dist/handlers/login.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"login.test.d.ts","sourceRoot":"","sources":["../../src/handlers/login.test.ts"],"names":[],"mappings":""}

package/dist/handlers/login.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const login_1 = require("./login");
+describe('isApiKeyEnvVarShadowing', () => {
+    it('is false when LIGHTDASH_API_KEY is not set', () => {
+        expect((0, login_1.isApiKeyEnvVarShadowing)(undefined, {})).toBe(false);
+        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_from_login', {})).toBe(false);
+    });
+    it('is true when an interactive login saves a token the env var will shadow', () => {
+        expect((0, login_1.isApiKeyEnvVarShadowing)(undefined, {
+            LIGHTDASH_API_KEY: 'ldpat_stale_env',
+        })).toBe(true);
+    });
+    it('is false for `lightdash login --token $LIGHTDASH_API_KEY`', () => {
+        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_ci', {
+            LIGHTDASH_API_KEY: 'ldpat_ci',
+        })).toBe(false);
+    });
+    it('is true when --token is a different token to the env var', () => {
+        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_explicit', {
+            LIGHTDASH_API_KEY: 'ldpat_stale_env',
+        })).toBe(true);
+    });
+});

package/dist/index.js

@@ -756,7 +756,9 @@ const errorHandler = (err) => {
         console.error(`\n💡 Contact your Lightdash administrator to request project creation access or if you believe this is incorrect.\n`);
     }
     else if (err.name === 'AuthorizationError') {
-        console.error(`Looks like you did not authenticate or the personal access token expired.\n\n👀 See https://docs.lightdash.com/guides/cli/cli-authentication for help and examples`);
+        console.error(`Looks like you did not authenticate or the personal access token expired.${process.env.LIGHTDASH_API_KEY
+            ? `\n\nLIGHTDASH_API_KEY is set, and it takes precedence over the token saved by \`lightdash login\`. If you expected your saved login to be used, run ${styles.bold('unset LIGHTDASH_API_KEY')}.`
+            : ''}\n\n👀 See https://docs.lightdash.com/guides/cli/cli-authentication for help and examples`);
     }
     else if (!(err instanceof common_1.LightdashError)) {
         console.error(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "1.154.0",
+  "version": "1.154.2",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -42,8 +42,8 @@
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/common": "1.154.0",
-    "@lightdash/warehouses": "1.154.0"
+    "@lightdash/common": "1.154.2",
+    "@lightdash/warehouses": "1.154.2"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",