@lightdash/cli 1.3.0 → 1.4.1

package/dist/handlers/exportChartImage.d.ts

@@ -1,5 +1,6 @@
 type ExportChartImageOptions = {
     output: string;
+    project?: string;
     verbose?: boolean;
 };
 export declare const exportChartImageHandler: (chartUuidOrSlug: string, options: ExportChartImageOptions) => Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"exportChartImage.d.ts","sourceRoot":"","sources":["../../src/handlers/exportChartImage.ts"],"names":[],"mappings":"AAMA,KAAK,uBAAuB,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAChC,iBAAiB,MAAM,EACvB,SAAS,uBAAuB,KACjC,OAAO,CAAC,IAAI,CAkCd,CAAC"}
+{"version":3,"file":"exportChartImage.d.ts","sourceRoot":"","sources":["../../src/handlers/exportChartImage.ts"],"names":[],"mappings":"AAQA,KAAK,uBAAuB,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAChC,iBAAiB,MAAM,EACvB,SAAS,uBAAuB,KACjC,OAAO,CAAC,IAAI,CA+Cd,CAAC"}

package/dist/handlers/exportChartImage.js

@@ -4,15 +4,26 @@ exports.exportChartImageHandler = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
+const uuid_1 = require("uuid");
+const config_1 = require("../config");
 const globalState_1 = tslib_1.__importDefault(require("../globalState"));
 const styles = tslib_1.__importStar(require("../styles"));
 const apiClient_1 = require("./dbt/apiClient");
 const exportChartImageHandler = async (chartUuidOrSlug, options) => {
     globalState_1.default.setVerbose(options.verbose ?? false);
     const spinner = globalState_1.default.startSpinner(`Exporting chart image for '${chartUuidOrSlug}'...`);
+    const isChartUuid = (0, uuid_1.validate)(chartUuidOrSlug);
+    const projectUuid = options.project ??
+        (!isChartUuid ? (await (0, config_1.getConfig)()).context?.project : undefined);
+    if (!projectUuid && !isChartUuid) {
+        throw new Error('A project is required when exporting by slug. Pass --project <uuid> or select a project first.');
+    }
+    const projectQuery = projectUuid
+        ? `?projectUuid=${encodeURIComponent(projectUuid)}`
+        : '';
     const imageUrl = await (0, apiClient_1.lightdashApi)({
         method: 'POST',
-        url: `/api/v1/saved/${chartUuidOrSlug}/export`,
+        url: `/api/v1/saved/${chartUuidOrSlug}/export${projectQuery}`,
         body: undefined,
     });
     if (!imageUrl) {

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

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

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

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

package/dist/handlers/exportChartImage.test.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("../config");
+const apiClient_1 = require("./dbt/apiClient");
+const exportChartImage_1 = require("./exportChartImage");
+vi.mock('../config', () => ({ getConfig: vi.fn() }));
+vi.mock('./dbt/apiClient', () => ({ lightdashApi: vi.fn() }));
+vi.mock('../globalState', () => ({
+    default: {
+        setVerbose: vi.fn(),
+        startSpinner: vi.fn(() => ({ warn: vi.fn() })),
+    },
+}));
+describe('exportChartImageHandler', () => {
+    beforeEach(() => {
+        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue(undefined);
+    });
+    afterEach(() => {
+        vi.clearAllMocks();
+    });
+    it('scopes a slug to the selected project', async () => {
+        vi.mocked(config_1.getConfig).mockResolvedValue({
+            context: {
+                project: '22222222-2222-4222-8222-222222222222',
+            },
+        });
+        await (0, exportChartImage_1.exportChartImageHandler)('shared-slug', { output: 'chart.png' });
+        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
+            method: 'POST',
+            url: '/api/v1/saved/shared-slug/export?projectUuid=22222222-2222-4222-8222-222222222222',
+            body: undefined,
+        });
+    });
+    it('does not scope UUID exports to the selected project', async () => {
+        vi.mocked(config_1.getConfig).mockResolvedValue({
+            context: {
+                project: '22222222-2222-4222-8222-222222222222',
+            },
+        });
+        await (0, exportChartImage_1.exportChartImageHandler)('11111111-1111-4111-8111-111111111111', {
+            output: 'chart.png',
+        });
+        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
+            method: 'POST',
+            url: '/api/v1/saved/11111111-1111-4111-8111-111111111111/export',
+            body: undefined,
+        });
+        expect(config_1.getConfig).not.toHaveBeenCalled();
+    });
+    it('rejects a slug without project context', async () => {
+        vi.mocked(config_1.getConfig).mockResolvedValue({});
+        await expect((0, exportChartImage_1.exportChartImageHandler)('shared-slug', { output: 'chart.png' })).rejects.toThrow('A project is required when exporting by slug');
+        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
+    });
+});

package/dist/index.js

@@ -643,8 +643,9 @@ commander_1.program
 commander_1.program
     .command('export-chart-image')
     .description('Export a deployed chart as a PNG image. The chart must already exist on the server.')
-    .argument('<chart>', 'Chart slug')
+    .argument('<chart>', 'Chart UUID or slug')
     .requiredOption('-o, --output <file>', 'Output file path for the PNG image')
+    .option('--project <uuid>', 'Lightdash project UUID (defaults to the currently selected project)')
     .option('--verbose', 'Show detailed output', false)
     .action(exportChartImage_1.exportChartImageHandler);
 commander_1.program

package/package.json

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