@lightdash/cli 0.1444.1 → 0.1445.0

package/dist/handlers/download.d.ts

@@ -3,7 +3,8 @@ export type DownloadHandlerOptions = {
     charts: string[];
     dashboards: string[];
     force: boolean;
+    path?: string;
 };
-export declare const downloadContent: (ids: string[], type: 'charts' | 'dashboards', projectId: string) => Promise<[number, string[]]>;
+export declare const downloadContent: (ids: string[], type: 'charts' | 'dashboards', projectId: string, customPath?: 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

@@ -13,7 +13,14 @@ 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 DOWNLOAD_FOLDER = 'lightdash';
+const getDownloadFolder = (customPath) => {
+    if (customPath) {
+        return path.isAbsolute(customPath)
+            ? customPath
+            : path.join(process.cwd(), customPath);
+    }
+    return path.join(process.cwd(), 'lightdash');
+};
 /*
     This function is used to parse the content filters.
     It can be slugs, uuids or urls
@@ -28,8 +35,8 @@ const parseContentFilters = (items) => {
     });
     return `?${new URLSearchParams(parsedItems.map((item) => ['ids', item])).toString()}`;
 };
-const dumpIntoFiles = async (folder, items) => {
-    const outputDir = path.join(process.cwd(), DOWNLOAD_FOLDER, folder);
+const dumpIntoFiles = async (folder, items, customPath) => {
+    const outputDir = path.join(getDownloadFolder(customPath), folder);
     globalState_1.default.debug(`Writing ${items.length} ${folder} into ${outputDir}`);
     // Make directory
     const created = await fs_1.promises.mkdir(outputDir, { recursive: true });
@@ -43,8 +50,8 @@ const dumpIntoFiles = async (folder, items) => {
         await fs_1.promises.writeFile(itemPath, chartYml);
     }
 };
-const readCodeFiles = async (folder) => {
-    const inputDir = path.join(process.cwd(), DOWNLOAD_FOLDER, folder);
+const readCodeFiles = async (folder, customPath) => {
+    const inputDir = path.join(getDownloadFolder(customPath), folder);
     console.info(`Reading ${folder} from ${inputDir}`);
     const items = [];
     try {
@@ -88,7 +95,7 @@ const readCodeFiles = async (folder) => {
     return items;
 };
 const downloadContent = async (ids, // slug, uuid or url
-type, projectId) => {
+type, projectId, customPath) => {
     const spinner = globalState_1.default.getActiveSpinner();
     const contentFilters = parseContentFilters(ids);
     let contentAsCode;
@@ -109,7 +116,7 @@ type, projectId) => {
             console.warn(styles.warning(`\nNo chart with id "${missingId}"`));
         });
         if ('dashboards' in contentAsCode) {
-            await dumpIntoFiles('dashboards', contentAsCode.dashboards);
+            await dumpIntoFiles('dashboards', contentAsCode.dashboards, customPath);
             // Extract chart slugs from dashboards
             chartSlugs = contentAsCode.dashboards.reduce((acc, dashboard) => {
                 const slugs = dashboard.tiles.map((chart) => 'chartSlug' in chart.properties
@@ -122,7 +129,7 @@ type, projectId) => {
             }, chartSlugs);
         }
         else {
-            await dumpIntoFiles('charts', contentAsCode.charts);
+            await dumpIntoFiles('charts', contentAsCode.charts, customPath);
         }
         offset = contentAsCode.offset;
     } while (contentAsCode.offset < contentAsCode.total);
@@ -162,7 +169,7 @@ const downloadHandler = async (options) => {
         }
         else {
             const spinner = globalState_1.default.startSpinner(`Downloading charts`);
-            [chartTotal] = await (0, exports.downloadContent)(options.charts, 'charts', projectId);
+            [chartTotal] = await (0, exports.downloadContent)(options.charts, 'charts', projectId, options.path);
             spinner.succeed(`Downloaded ${chartTotal} charts`);
         }
         // Download dashboards
@@ -172,13 +179,13 @@ const downloadHandler = async (options) => {
         else {
             const spinner = globalState_1.default.startSpinner(`Downloading dashboards`);
             let chartSlugs = [];
-            [dashboardTotal, chartSlugs] = await (0, exports.downloadContent)(options.dashboards, 'dashboards', projectId);
+            [dashboardTotal, chartSlugs] = await (0, exports.downloadContent)(options.dashboards, 'dashboards', projectId, options.path);
             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);
+                const [totalCharts] = await (0, exports.downloadContent)(chartSlugs, 'charts', projectId, options.path);
                 spinner.succeed(`Downloaded ${totalCharts} charts linked to dashboards`);
             }
         }
@@ -207,7 +214,6 @@ const downloadHandler = async (options) => {
             },
         });
     }
-    // TODO delete files if chart don't exist ?*/
 };
 exports.downloadHandler = downloadHandler;
 const getPromoteAction = (action) => {
@@ -255,9 +261,9 @@ const logUploadChanges = (changes) => {
  *
  * @param slugs if slugs are provided, we only force upsert the charts/dashboards that match the slugs, if slugs are empty, we upload files that were locally updated
  */
-const upsertResources = async (type, projectId, changes, force, slugs) => {
+const upsertResources = async (type, projectId, changes, force, slugs, customPath) => {
     const config = await (0, config_1.getConfig)();
-    const items = await readCodeFiles(type);
+    const items = await readCodeFiles(type, customPath);
     console.info(`Found ${items.length} ${type} files`);
     const hasFilter = slugs.length > 0;
     const filteredItems = hasFilter
@@ -342,7 +348,7 @@ const uploadHandler = async (options) => {
             console.info(styles.warning(`No charts filters provided, skipping`));
         }
         else {
-            const { changes: chartChanges, total } = await upsertResources('charts', projectId, changes, options.force, options.charts);
+            const { changes: chartChanges, total } = await upsertResources('charts', projectId, changes, options.force, options.charts, options.path);
             changes = chartChanges;
             chartTotal = total;
         }
@@ -350,7 +356,7 @@ const uploadHandler = async (options) => {
             console.info(styles.warning(`No dashboard filters provided, skipping`));
         }
         else {
-            const { changes: dashboardChanges, total } = await upsertResources('dashboards', projectId, changes, options.force, options.dashboards);
+            const { changes: dashboardChanges, total } = await upsertResources('dashboards', projectId, changes, options.force, options.dashboards, options.path);
             changes = dashboardChanges;
             dashboardTotal = total;
         }

package/dist/index.js

@@ -198,6 +198,7 @@ commander_1.program
     .option('--verbose', undefined, false)
     .option('-c, --charts <charts...>', 'specify chart slugs, uuids, or urls to download', [])
     .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs, uuids or urls to download', [])
+    .option('-p, --path <path>', 'specify a custom path to download charts and dashboards', undefined)
     .action(download_1.downloadHandler);
 commander_1.program
     .command('upload')
@@ -206,6 +207,7 @@ commander_1.program
     .option('-c, --charts <charts...>', 'specify chart slugs to force upload', [])
     .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs to force upload', [])
     .option('--force', 'Force upload even if local files have not changed, use this when you want to upload files to a new project', false)
+    .option('-p, --path <path>', 'specify a custom path to upload charts and dashboards from', undefined)
     .action(download_1.uploadHandler);
 commander_1.program
     .command('deploy')

package/package.json

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