@lightdash/cli 0.1385.1 → 0.1386.0

package/dist/handlers/dbt/apiClient.d.ts

@@ -49,6 +49,9 @@ export declare const lightdashApi: <T extends string | boolean | unknown[] | imp
     owner: string;
 } | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").ApiMetricsCatalogResults> | import("@lightdash/common").MetricsExplorerQueryResults | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").Group[] | import("@lightdash/common").GroupWithMembers[]> | {
     tagUuid: string;
+} | import("@lightdash/common").ChartAsCode[] | {
+    chart: import("@lightdash/common").ChartAsCode;
+    created: boolean;
 } | null | undefined>({ method, url, body, }: LightdashApiProps) => Promise<T>;
 export declare const checkLightdashVersion: () => Promise<void>;
 export {};

package/dist/handlers/download.d.ts

@@ -0,0 +1,5 @@
+export type DownloadHandlerOptions = {
+    verbose: boolean;
+};
+export declare const downloadHandler: (options: DownloadHandlerOptions) => Promise<void>;
+export declare const uploadHandler: (options: DownloadHandlerOptions) => Promise<void>;

package/dist/handlers/download.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadHandler = exports.downloadHandler = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable no-await-in-loop */
+const common_1 = require("@lightdash/common");
+const fs_1 = require("fs");
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const path = tslib_1.__importStar(require("path"));
+const config_1 = require("../config");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const apiClient_1 = require("./dbt/apiClient");
+const DOWNLOAD_FOLDER = 'lightdash';
+const downloadHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const config = await (0, config_1.getConfig)();
+    if (!config.context?.apiKey || !config.context.serverUrl) {
+        throw new common_1.AuthorizationError(`Not logged in. Run 'lightdash login --help'`);
+    }
+    const projectId = config.context.project;
+    if (!projectId) {
+        throw new Error('No project selected. Run lightdash config set-project');
+    }
+    const chartsAsCode = await (0, apiClient_1.lightdashApi)({
+        method: 'GET',
+        url: `/api/v1/projects/${projectId}/charts/code`,
+        body: undefined,
+    });
+    console.info(`Downloading ${chartsAsCode.length} charts`);
+    const outputDir = path.join(process.cwd(), DOWNLOAD_FOLDER);
+    console.info(`Creating new path for files on ${outputDir} `);
+    try {
+        await fs_1.promises.mkdir(outputDir, { recursive: true });
+    }
+    catch (error) {
+        // Directory already exists
+    }
+    for (const chart of chartsAsCode) {
+        const chartPath = path.join(outputDir, `${chart.slug}.yml`);
+        globalState_1.default.debug(`> Writing chart to ${chartPath}`);
+        const chartYml = yaml.dump(chart, {
+            quotingType: '"',
+        });
+        await fs_1.promises.writeFile(chartPath, chartYml);
+    }
+    // TODO delete files if chart don't exist ?*/
+};
+exports.downloadHandler = downloadHandler;
+const uploadHandler = async (options) => {
+    globalState_1.default.setVerbose(options.verbose);
+    await (0, apiClient_1.checkLightdashVersion)();
+    const config = await (0, config_1.getConfig)();
+    if (!config.context?.apiKey || !config.context.serverUrl) {
+        throw new common_1.AuthorizationError(`Not logged in. Run 'lightdash login --help'`);
+    }
+    const projectId = config.context.project;
+    if (!projectId) {
+        throw new Error('No project selected. Run lightdash config set-project');
+    }
+    const inputDir = path.join(process.cwd(), DOWNLOAD_FOLDER);
+    console.info(`Reading charts from ${inputDir}`);
+    const charts = [];
+    try {
+        // Read all files from the lightdash directory
+        const files = await fs_1.promises.readdir(inputDir);
+        const jsonFiles = files.filter((file) => file.endsWith('.yml'));
+        // Load each JSON file
+        for (const file of jsonFiles) {
+            const filePath = path.join(inputDir, file);
+            const fileContent = await fs_1.promises.readFile(filePath, 'utf-8');
+            const chart = yaml.load(fileContent);
+            charts.push(chart);
+        }
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            throw new Error(`Directory ${inputDir} not found. Run download command first.`);
+        }
+        throw error;
+    }
+    console.info(`Found ${charts.length} chart files`);
+    let created = 0;
+    let updated = 0;
+    try {
+        for (const chart of charts) {
+            globalState_1.default.debug(`Upserting chart ${chart.slug}`);
+            const chartData = await (0, apiClient_1.lightdashApi)({
+                method: 'POST',
+                url: `/api/v1/projects/${projectId}/charts/${chart.slug}/code`,
+                body: JSON.stringify(chart),
+            });
+            if (chartData.created) {
+                created += 1;
+                globalState_1.default.debug(`Created chart: ${chart.name}`);
+            }
+            else {
+                updated += 1;
+                globalState_1.default.debug(`Updated chart: ${chart.name}`);
+            }
+        }
+    }
+    catch (error) {
+        console.error('Error upserting chart', error);
+    }
+    console.info(`Total charts created: ${created} `);
+    console.info(`Total charts updated: ${updated} `);
+};
+exports.uploadHandler = uploadHandler;

package/dist/index.js

@@ -9,6 +9,7 @@ const compile_1 = require("./handlers/compile");
 const refresh_1 = require("./handlers/dbt/refresh");
 const run_1 = require("./handlers/dbt/run");
 const deploy_1 = require("./handlers/deploy");
+const download_1 = require("./handlers/download");
 const generate_1 = require("./handlers/generate");
 const generateExposures_1 = require("./handlers/generateExposures");
 const login_1 = require("./handlers/login");
@@ -189,6 +190,16 @@ commander_1.program
     .option('--name [preview name]', '[required] Name for the preview project to be deleted')
     .option('--verbose', undefined, false)
     .action(preview_1.stopPreviewHandler);
+commander_1.program
+    .command('download')
+    .description('Downloads charts and dashboards as code')
+    .option('--verbose', undefined, false)
+    .action(download_1.downloadHandler);
+commander_1.program
+    .command('upload')
+    .description('Uploads charts and dashboards as code')
+    .option('--verbose', undefined, false)
+    .action(download_1.uploadHandler);
 commander_1.program
     .command('deploy')
     .description('Compiles and deploys a Lightdash project')

package/package.json

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