@lightdash/cli 0.1425.3 → 0.1425.5

package/dist/handlers/download.d.ts

@@ -4,5 +4,6 @@ export type DownloadHandlerOptions = {
     dashboards: string[];
     force: boolean;
 };
+export declare const downloadContent: (ids: string[], type: 'charts' | 'dashboards', projectId: string) => Promise<[number, string[]]>;
 export declare const downloadHandler: (options: DownloadHandlerOptions) => Promise<void>;
 export declare const uploadHandler: (options: DownloadHandlerOptions) => Promise<void>;

package/dist/handlers/download.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uploadHandler = exports.downloadHandler = void 0;
+exports.uploadHandler = exports.downloadHandler = exports.downloadContent = void 0;
 const tslib_1 = require("tslib");
 /* eslint-disable no-await-in-loop */
 /* eslint-disable no-param-reassign */
@@ -34,7 +34,7 @@ const dumpIntoFiles = async (folder, items) => {
     // Make directory
     const created = await fs_1.promises.mkdir(outputDir, { recursive: true });
     if (created)
-        console.info(`Created new folder: ${outputDir} `);
+        console.info(`\nCreated new folder: ${outputDir} `);
     for (const item of items) {
         const itemPath = path.join(outputDir, `${item.slug}.yml`);
         const chartYml = yaml.dump(item, {
@@ -87,6 +87,48 @@ const readCodeFiles = async (folder) => {
     }
     return items;
 };
+const downloadContent = async (ids, // slug, uuid or url
+type, projectId) => {
+    const spinner = globalState_1.default.getActiveSpinner();
+    const contentFilters = parseContentFilters(ids);
+    let contentAsCode;
+    let offset = 0;
+    let chartSlugs = [];
+    do {
+        globalState_1.default.debug(`Downloading ${type} with offset "${offset}" and filters "${contentFilters}"`);
+        const queryParams = contentFilters
+            ? `${contentFilters}&offset=${offset}`
+            : `?offset=${offset}`;
+        contentAsCode = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v1/projects/${projectId}/${type}/code${queryParams}`,
+            body: undefined,
+        });
+        spinner?.start(`Downloaded ${contentAsCode.offset} of ${contentAsCode.total} ${type}`);
+        contentAsCode.missingIds.forEach((missingId) => {
+            console.warn(styles.warning(`\nNo chart with id "${missingId}"`));
+        });
+        if ('dashboards' in contentAsCode) {
+            await dumpIntoFiles('dashboards', contentAsCode.dashboards);
+            // Extract chart slugs from dashboards
+            chartSlugs = contentAsCode.dashboards.reduce((acc, dashboard) => {
+                const slugs = dashboard.tiles.map((chart) => 'chartSlug' in chart.properties
+                    ? chart.properties.chartSlug
+                    : undefined);
+                return [
+                    ...acc,
+                    ...slugs.filter((slug) => slug !== undefined),
+                ];
+            }, chartSlugs);
+        }
+        else {
+            await dumpIntoFiles('charts', contentAsCode.charts);
+        }
+        offset = contentAsCode.offset;
+    } while (contentAsCode.offset < contentAsCode.total);
+    return [contentAsCode.total, [...new Set(chartSlugs)]];
+};
+exports.downloadContent = downloadContent;
 const downloadHandler = async (options) => {
     globalState_1.default.setVerbose(options.verbose);
     await (0, apiClient_1.checkLightdashVersion)();
@@ -120,28 +162,8 @@ const downloadHandler = async (options) => {
         }
         else {
             const spinner = globalState_1.default.startSpinner(`Downloading charts`);
-            const chartFilters = parseContentFilters(options.charts);
-            let chartsAsCode;
-            let offset = 0;
-            do {
-                globalState_1.default.debug(`Downloading charts with offset "${offset}" and filters "${chartFilters}"`);
-                const queryParams = chartFilters
-                    ? `${chartFilters}&offset=${offset}`
-                    : `?offset=${offset}`;
-                chartsAsCode = await (0, apiClient_1.lightdashApi)({
-                    method: 'GET',
-                    url: `/api/v1/projects/${projectId}/charts/code${queryParams}`,
-                    body: undefined,
-                });
-                spinner.start(`Downloaded ${chartsAsCode.offset} of ${chartsAsCode.total} charts`);
-                chartsAsCode.missingIds.forEach((missingId) => {
-                    console.warn(styles.warning(`\nNo chart with id "${missingId}"`));
-                });
-                await dumpIntoFiles('charts', chartsAsCode.charts);
-                offset = chartsAsCode.offset;
-            } while (chartsAsCode.offset < chartsAsCode.total);
-            chartTotal = chartsAsCode.total;
-            spinner.succeed(`Downloaded ${chartsAsCode.total} charts`);
+            [chartTotal] = await (0, exports.downloadContent)(options.charts, 'charts', projectId);
+            spinner.succeed(`Downloaded ${chartTotal} charts`);
         }
         // Download dashboards
         if (hasFilters && options.dashboards.length === 0) {
@@ -149,28 +171,16 @@ const downloadHandler = async (options) => {
         }
         else {
             const spinner = globalState_1.default.startSpinner(`Downloading dashboards`);
-            const dashboardFilters = parseContentFilters(options.dashboards);
-            let offset = 0;
-            let dashboardsAsCode;
-            do {
-                globalState_1.default.debug(`Downloading dashboards with offset "${offset}" and filters "${dashboardFilters}"`);
-                const queryParams = dashboardFilters
-                    ? `${dashboardFilters}&offset=${offset}`
-                    : `?offset=${offset}`;
-                dashboardsAsCode = await (0, apiClient_1.lightdashApi)({
-                    method: 'GET',
-                    url: `/api/v1/projects/${projectId}/dashboards/code${queryParams}`,
-                    body: undefined,
-                });
-                dashboardsAsCode.missingIds.forEach((missingId) => {
-                    console.warn(styles.warning(`\nNo dashboard with id "${missingId}"`));
-                });
-                spinner?.start(`Downloaded ${dashboardsAsCode.offset} of ${dashboardsAsCode.total} dashboards`);
-                await dumpIntoFiles('dashboards', dashboardsAsCode.dashboards);
-                offset = dashboardsAsCode.offset;
-            } while (dashboardsAsCode.offset < dashboardsAsCode.total);
-            dashboardTotal = dashboardsAsCode.total;
-            spinner.succeed(`Downloaded ${dashboardsAsCode.total} dashboards`);
+            let chartSlugs = [];
+            [dashboardTotal, chartSlugs] = await (0, exports.downloadContent)(options.dashboards, 'dashboards', projectId);
+            spinner.succeed(`Downloaded ${dashboardTotal} dashboards`);
+            // If any filter is provided, we download all charts for these dashboard
+            // We don't need to do this if we download everything (no filters)
+            if (hasFilters) {
+                spinner.start(`Downloading ${chartSlugs.length} charts linked to dashboards`);
+                const [totalCharts] = await (0, exports.downloadContent)(chartSlugs, 'charts', projectId);
+                spinner.succeed(`Downloaded ${totalCharts} charts linked to dashboards`);
+            }
         }
         const end = Date.now();
         await analytics_1.LightdashAnalytics.track({

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lightdash/cli",
-    "version": "0.1425.3",
+    "version": "0.1425.5",
     "license": "MIT",
     "bin": {
         "lightdash": "dist/index.js"
@@ -11,8 +11,8 @@
     ],
     "dependencies": {
         "@actions/core": "^1.11.1",
-        "@lightdash/common": "^0.1425.3",
-        "@lightdash/warehouses": "^0.1425.3",
+        "@lightdash/common": "^0.1425.5",
+        "@lightdash/warehouses": "^0.1425.5",
         "@types/columnify": "^1.5.1",
         "ajv": "^8.11.0",
         "ajv-formats": "^2.1.1",