@lightdash/cli 0.2234.3 → 0.2235.0

package/dist/handlers/download.d.ts

@@ -11,7 +11,9 @@ export type DownloadHandlerOptions = {
     includeCharts: boolean;
     nested: boolean;
 };
-export declare const downloadContent: (ids: string[], type: "charts" | "dashboards", projectId: string, projectName: string, customPath?: string, languageMap?: boolean, nested?: boolean) => Promise<[number, string[]]>;
+type DownloadContentType = 'charts' | 'dashboards' | 'sqlCharts';
+export declare const downloadContent: (ids: string[], type: DownloadContentType, projectId: string, projectName: string, customPath?: string, languageMap?: boolean, nested?: boolean) => Promise<[number, string[]]>;
 export declare const downloadHandler: (options: DownloadHandlerOptions) => Promise<void>;
 export declare const uploadHandler: (options: DownloadHandlerOptions) => Promise<void>;
+export {};
 //# sourceMappingURL=download.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/handlers/download.ts"],"names":[],"mappings":"AA2BA,MAAM,MAAM,sBAAsB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC;AA2NF,eAAO,MAAM,eAAe,QACnB,MAAM,EAAE,QACP,QAAQ,GAAG,YAAY,aAClB,MAAM,eACJ,MAAM,eACN,MAAM,gBACN,OAAO,WACZ,OAAO,KAChB,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CA4F5B,CAAC;AAEF,eAAO,MAAM,eAAe,YACf,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAqJd,CAAC;AA6MF,eAAO,MAAM,aAAa,YACb,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAuHd,CAAC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/handlers/download.ts"],"names":[],"mappings":"AA6BA,MAAM,MAAM,sBAAsB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,OAAO,CAAC;CACnB,CAAC;AA2PF,KAAK,mBAAmB,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;AAkDjE,eAAO,MAAM,eAAe,QACnB,MAAM,EAAE,QACP,mBAAmB,aACd,MAAM,eACJ,MAAM,eACN,MAAM,gBACN,OAAO,WACZ,OAAO,KAChB,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CA2G5B,CAAC;AAEF,eAAO,MAAM,eAAe,YACf,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAkLd,CAAC;AAyNF,eAAO,MAAM,aAAa,YACb,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAuHd,CAAC"}

package/dist/handlers/download.js

@@ -51,8 +51,24 @@ const createDirForContent = async (projectName, spaceSlug, folder, customPath, f
     await fs_1.promises.mkdir(outputDir, { recursive: true });
     return outputDir;
 };
+/**
+ * Get file extension for content-as-code files.
+ * SQL charts use '.sql.yml' extension to avoid filename conflicts with regular charts
+ * that may have the same slug, since both chart types share the same output directory.
+ */
+const getFileExtension = (contentType) => {
+    switch (contentType) {
+        case 'sqlChart':
+            return '.sql.yml';
+        case 'chart':
+        case 'dashboard':
+        default:
+            return '.yml';
+    }
+};
 const writeContent = async (contentAsCode, outputDir, languageMap) => {
-    const itemPath = path.join(outputDir, `${contentAsCode.content.slug}.yml`);
+    const extension = getFileExtension(contentAsCode.type);
+    const itemPath = path.join(outputDir, `${contentAsCode.content.slug}${extension}`);
     const chartYml = yaml.dump(contentAsCode.content, {
         quotingType: '"',
     });
@@ -115,86 +131,135 @@ const groupBySpace = (items) => {
     const itemsWithIndex = items.map((item, index) => ({ item, index }));
     return (0, groupBy_1.default)(itemsWithIndex, (entry) => entry.item.spaceSlug);
 };
-const writeSpaceContent = async ({ projectName, spaceSlug, folder, contentInSpace, contentAsCode, customPath, languageMap, folderScheme, }) => {
+const writeSpaceContent = async ({ projectName, spaceSlug, folder, contentType, contentInSpace, contentAsCode, customPath, languageMap, folderScheme, }) => {
     const outputDir = await createDirForContent(projectName, spaceSlug, folder, customPath, folderScheme);
-    const contentType = folder === 'charts' ? 'chart' : 'dashboard';
     for (const { item, index } of contentInSpace) {
+        const translationMap = 'languageMap' in contentAsCode
+            ? contentAsCode.languageMap?.[index]
+            : undefined;
         await writeContent({
             type: contentType,
             content: item,
-            translationMap: contentAsCode.languageMap?.[index],
+            translationMap,
         }, outputDir, languageMap);
     }
 };
-const downloadContent = async (ids, // slug, uuid or url
-type, projectId, projectName, customPath, languageMap = false, nested = false) => {
+const getContentTypeConfig = (type, projectId) => {
+    switch (type) {
+        case 'charts':
+            return {
+                endpoint: `/api/v1/projects/${projectId}/charts/code`,
+                displayName: 'charts',
+                supportsLanguageMap: true,
+            };
+        case 'dashboards':
+            return {
+                endpoint: `/api/v1/projects/${projectId}/dashboards/code`,
+                displayName: 'dashboards',
+                supportsLanguageMap: true,
+            };
+        case 'sqlCharts':
+            return {
+                endpoint: `/api/v1/projects/${projectId}/sqlCharts/code`,
+                displayName: 'SQL charts',
+                supportsLanguageMap: false,
+            };
+        default:
+            return (0, common_1.assertUnreachable)(type, `Unknown content type: ${type}`);
+    }
+};
+const extractChartSlugsFromDashboards = (dashboards) => dashboards.reduce((acc, dashboard) => {
+    const slugs = dashboard.tiles
+        .map((tile) => 'chartSlug' in tile.properties
+        ? tile.properties.chartSlug
+        : undefined)
+        .filter((slug) => slug !== undefined);
+    return [...acc, ...slugs];
+}, []);
+const downloadContent = async (ids, type, projectId, projectName, customPath, languageMap = false, nested = false) => {
     const spinner = globalState_1.default.getActiveSpinner();
     const contentFilters = parseContentFilters(ids);
-    // Convert boolean flag to FolderScheme type
     const folderScheme = nested ? 'nested' : 'flat';
-    let contentAsCode;
+    const config = getContentTypeConfig(type, projectId);
     let offset = 0;
+    let total = 0;
     let chartSlugs = [];
     do {
-        globalState_1.default.debug(`Downloading ${type} with offset "${offset}" and filters "${contentFilters}"`);
-        const commonParams = `offset=${offset}&languageMap=${languageMap}`;
+        globalState_1.default.debug(`Downloading ${config.displayName} with offset "${offset}" and filters "${contentFilters}"`);
+        const commonParams = config.supportsLanguageMap
+            ? `offset=${offset}&languageMap=${languageMap}`
+            : `offset=${offset}`;
         const queryParams = contentFilters
             ? `${contentFilters}&${commonParams}`
             : `?${commonParams}`;
-        contentAsCode = await (0, apiClient_1.lightdashApi)({
+        const results = await (0, apiClient_1.lightdashApi)({
             method: 'GET',
-            url: `/api/v1/projects/${projectId}/${type}/code${queryParams}`,
+            url: `${config.endpoint}${queryParams}`,
             body: undefined,
         });
-        spinner?.start(`Downloaded ${contentAsCode.offset} of ${contentAsCode.total} ${type}`);
-        contentAsCode.missingIds.forEach((missingId) => {
-            console.warn(styles.warning(`\nNo ${type} with id "${missingId}"`));
+        spinner?.start(`Downloaded ${results.offset} of ${results.total} ${config.displayName}`);
+        // For the same chart slug, we run the code for saved charts and sql chart
+        // so we are going to get more false positives here, so we keep it on the debug log
+        results.missingIds.forEach((missingId) => {
+            globalState_1.default.debug(`\nNo ${config.displayName} with id "${missingId}"`);
         });
-        if ('dashboards' in contentAsCode) {
-            // Group dashboards by spaceSlug
-            const dashboardsBySpace = groupBySpace(contentAsCode.dashboards);
-            // Create directory and write content for each space
+        // Write content based on type
+        if ('sqlCharts' in results) {
+            const sqlChartsBySpace = groupBySpace(results.sqlCharts);
+            for (const [spaceSlug, sqlChartsInSpace] of Object.entries(sqlChartsBySpace)) {
+                await writeSpaceContent({
+                    projectName,
+                    spaceSlug,
+                    folder: 'charts',
+                    contentType: 'sqlChart',
+                    contentInSpace: sqlChartsInSpace,
+                    contentAsCode: results,
+                    customPath,
+                    languageMap,
+                    folderScheme,
+                });
+            }
+        }
+        else if ('dashboards' in results) {
+            const dashboardsBySpace = groupBySpace(results.dashboards);
             for (const [spaceSlug, dashboardsInSpace] of Object.entries(dashboardsBySpace)) {
                 await writeSpaceContent({
                     projectName,
                     spaceSlug,
                     folder: 'dashboards',
+                    contentType: 'dashboard',
                     contentInSpace: dashboardsInSpace,
-                    contentAsCode,
+                    contentAsCode: results,
                     customPath,
                     languageMap,
                     folderScheme,
                 });
             }
-            // 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 = [
+                ...chartSlugs,
+                ...extractChartSlugsFromDashboards(results.dashboards),
+            ];
         }
         else {
-            const chartsBySpace = groupBySpace(contentAsCode.charts);
+            const chartsBySpace = groupBySpace(results.charts);
             for (const [spaceSlug, chartsInSpace] of Object.entries(chartsBySpace)) {
                 await writeSpaceContent({
                     projectName,
                     spaceSlug,
                     folder: 'charts',
+                    contentType: 'chart',
                     contentInSpace: chartsInSpace,
-                    contentAsCode,
+                    contentAsCode: results,
                     customPath,
                     languageMap,
                     folderScheme,
                 });
             }
         }
-        offset = contentAsCode.offset;
-    } while (contentAsCode.offset < contentAsCode.total);
-    return [contentAsCode.total, [...new Set(chartSlugs)]];
+        offset = results.offset;
+        total = results.total;
+    } while (offset < total);
+    return [total, [...new Set(chartSlugs)]];
 };
 exports.downloadContent = downloadContent;
 const downloadHandler = async (options) => {
@@ -243,13 +308,18 @@ const downloadHandler = async (options) => {
         // If any filter is provided, we skip those items without filters
         // eg: if a --charts filter is provided, we skip dashboards if no --dashboards filter is provided
         const hasFilters = options.charts.length > 0 || options.dashboards.length > 0;
-        // Download charts
+        // Download regular charts
         if (hasFilters && options.charts.length === 0) {
             console.info(styles.warning(`No charts filters provided, skipping`));
         }
         else {
-            [chartTotal] = await (0, exports.downloadContent)(options.charts, 'charts', projectId, projectName, options.path, options.languageMap, options.nested);
-            spinner.succeed(`Downloaded ${chartTotal} charts`);
+            const [regularChartTotal] = await (0, exports.downloadContent)(options.charts, 'charts', projectId, projectName, options.path, options.languageMap, options.nested);
+            spinner.succeed(`Downloaded ${regularChartTotal} charts`);
+            // Download SQL charts
+            spinner.start(`Downloading SQL charts`);
+            const [sqlChartTotal] = await (0, exports.downloadContent)(options.charts, 'sqlCharts', projectId, projectName, options.path, options.languageMap, options.nested);
+            spinner.succeed(`Downloaded ${sqlChartTotal} SQL charts`);
+            chartTotal = regularChartTotal + sqlChartTotal;
         }
         // Download dashboards
         if (hasFilters && options.dashboards.length === 0) {
@@ -259,12 +329,14 @@ const downloadHandler = async (options) => {
             let chartSlugs = [];
             [dashboardTotal, chartSlugs] = await (0, exports.downloadContent)(options.dashboards, 'dashboards', projectId, projectName, options.path, options.languageMap, options.nested);
             spinner.succeed(`Downloaded ${dashboardTotal} dashboards`);
-            // If any filter is provided, we download all charts for these dashboard
+            // If any filter is provided, we download all charts linked to these dashboards
             // We don't need to do this if we download everything (no filters)
             if (hasFilters && chartSlugs.length > 0) {
                 spinner.start(`Downloading ${chartSlugs.length} charts linked to dashboards`);
-                const [totalCharts] = await (0, exports.downloadContent)(chartSlugs, 'charts', projectId, projectName, options.path, options.languageMap, options.nested);
-                spinner.succeed(`Downloaded ${totalCharts} charts linked to dashboards`);
+                // Download both regular charts and SQL charts linked to dashboards
+                const [regularCharts] = await (0, exports.downloadContent)(chartSlugs, 'charts', projectId, projectName, options.path, options.languageMap, options.nested);
+                const [sqlCharts] = await (0, exports.downloadContent)(chartSlugs, 'sqlCharts', projectId, projectName, options.path, options.languageMap, options.nested);
+                spinner.succeed(`Downloaded ${regularCharts + sqlCharts} charts linked to dashboards`);
             }
         }
         const end = Date.now();
@@ -335,6 +407,8 @@ const logUploadChanges = (changes) => {
         console.info(`Total ${key}: ${value} `);
     });
 };
+// SQL charts have 'sql' field instead of 'tableName'/'metricQuery'
+const isSqlChart = (item) => 'sql' in item && !('tableName' in item);
 /**
  *
  * @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
@@ -368,9 +442,14 @@ const upsertResources = async (type, projectId, changes, force, slugs, customPat
                 continue;
             }
             globalState_1.default.debug(`Upserting ${type} ${item.slug}`);
+            // SQL charts use a different endpoint
+            const isSqlChartItem = type === 'charts' && isSqlChart(item);
+            const endpoint = isSqlChartItem
+                ? `/api/v1/projects/${projectId}/sqlCharts/${item.slug}/code`
+                : `/api/v1/projects/${projectId}/${type}/${item.slug}/code`;
             const upsertData = await (0, apiClient_1.lightdashApi)({
                 method: 'POST',
-                url: `/api/v1/projects/${projectId}/${type}/${item.slug}/code`,
+                url: endpoint,
                 body: JSON.stringify({
                     ...item,
                     skipSpaceCreate,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.2234.3",
+  "version": "0.2235.0",
   "license": "MIT",
   "bin": {
     "lightdash": "dist/index.js"
@@ -34,8 +34,8 @@
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
     "yaml": "^2.7.0",
-    "@lightdash/common": "0.2234.3",
-    "@lightdash/warehouses": "0.2234.3"
+    "@lightdash/common": "0.2235.0",
+    "@lightdash/warehouses": "0.2235.0"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {