@lightdash/cli 2.204.0 → 2.205.0

package/dist/handlers/slugUpdate.d.ts

@@ -1,9 +1,10 @@
-import { type ContentSlugRenameRequest } from '@lightdash/common';
+import { ContentType, type ContentSlugRenameRequest } from '@lightdash/common';
 type SlugUpdateOptions = {
     verbose: boolean;
     project?: string;
     path?: string;
     dryRun: boolean;
+    type: ContentType.CHART | ContentType.DASHBOARD;
     from: string;
     to: string;
 };
@@ -18,7 +19,8 @@ type LocalSlugUpdatePlan = {
     }>;
     metadata: {
         root: string;
-        charts: Record<string, string>;
+        resourceType: ContentType.CHART | ContentType.DASHBOARD;
+        slugs: Record<string, string>;
     } | undefined;
     referencesUpdated: number;
 };
@@ -26,11 +28,11 @@ export type LocalSlugUpdateFileChange = {
     source: string;
     target?: string;
 };
-export declare const planLocalChartSlugUpdate: (customPath: string | undefined, from: string, to: string) => Promise<LocalSlugUpdatePlan>;
+export declare const planLocalSlugUpdate: (customPath: string | undefined, from: string, to: string, resourceType?: ContentType.CHART | ContentType.DASHBOARD) => Promise<LocalSlugUpdatePlan>;
 export declare const getLocalSlugUpdateFileChanges: (plan: LocalSlugUpdatePlan, customPath: string | undefined) => LocalSlugUpdateFileChange[];
-export declare const applyLocalChartSlugUpdate: (plan: LocalSlugUpdatePlan) => Promise<() => Promise<void>>;
+export declare const applyLocalSlugUpdate: (plan: LocalSlugUpdatePlan) => Promise<() => Promise<void>>;
 export declare const requestSlugUpdate: (projectUuid: string, request: ContentSlugRenameRequest) => Promise<void>;
-export declare const executeChartSlugUpdate: (projectUuid: string, customPath: string | undefined, from: string, to: string) => Promise<LocalSlugUpdatePlan>;
+export declare const executeSlugUpdate: (projectUuid: string, customPath: string | undefined, from: string, to: string, resourceType?: ContentType.CHART | ContentType.DASHBOARD) => Promise<LocalSlugUpdatePlan>;
 export declare const slugUpdateHandler: (options: SlugUpdateOptions) => Promise<void>;
 export {};
 //# sourceMappingURL=slugUpdate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"slugUpdate.d.ts","sourceRoot":"","sources":["../../src/handlers/slugUpdate.ts"],"names":[],"mappings":"AAAA,OAAO,EAMH,KAAK,wBAAwB,EAChC,MAAM,mBAAmB,CAAC;AAY3B,KAAK,iBAAiB,GAAG;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACvB,WAAW,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC1D,SAAS,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrD,QAAQ,EACF;QACI,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,GACD,SAAS,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAIF,MAAM,MAAM,yBAAyB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAwDF,eAAO,MAAM,wBAAwB,eACrB,MAAM,GAAG,SAAS,QACxB,MAAM,MACR,MAAM,KACX,OAAO,CAAC,mBAAmB,CAyL7B,CAAC;AAEF,eAAO,MAAM,6BAA6B,SAChC,mBAAmB,cACb,MAAM,GAAG,SAAS,KAC/B,yBAAyB,EAuB3B,CAAC;AAuDF,eAAO,MAAM,yBAAyB,SAC5B,mBAAmB,KAC1B,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAkD7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,gBACb,MAAM,WACV,wBAAwB,KAClC,OAAO,CAAC,IAAI,CAmBd,CAAC;AAEF,eAAO,MAAM,sBAAsB,gBAClB,MAAM,cACP,MAAM,GAAG,SAAS,QACxB,MAAM,MACR,MAAM,KACX,OAAO,CAAC,mBAAmB,CAkB7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,YACjB,iBAAiB,KAC3B,OAAO,CAAC,IAAI,CAsDd,CAAC"}
+{"version":3,"file":"slugUpdate.d.ts","sourceRoot":"","sources":["../../src/handlers/slugUpdate.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,WAAW,EAIX,KAAK,wBAAwB,EAChC,MAAM,mBAAmB,CAAC;AAY3B,KAAK,iBAAiB,GAAG;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACvB,WAAW,EAAE,KAAK,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC1D,SAAS,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrD,QAAQ,EACF;QACI,IAAI,EAAE,MAAM,CAAC;QACb,YAAY,EAAE,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC;QACxD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACjC,GACD,SAAS,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAIF,MAAM,MAAM,yBAAyB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAwDF,eAAO,MAAM,mBAAmB,eAChB,MAAM,GAAG,SAAS,QACxB,MAAM,MACR,MAAM,iBACI,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,KACxD,OAAO,CAAC,mBAAmB,CAyM7B,CAAC;AAEF,eAAO,MAAM,6BAA6B,SAChC,mBAAmB,cACb,MAAM,GAAG,SAAS,KAC/B,yBAAyB,EAuB3B,CAAC;AAuDF,eAAO,MAAM,oBAAoB,SACvB,mBAAmB,KAC1B,OAAO,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAuD7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,gBACb,MAAM,WACV,wBAAwB,KAClC,OAAO,CAAC,IAAI,CAmBd,CAAC;AAEF,eAAO,MAAM,iBAAiB,gBACb,MAAM,cACP,MAAM,GAAG,SAAS,QACxB,MAAM,MACR,MAAM,iBACI,WAAW,CAAC,KAAK,GAAG,WAAW,CAAC,SAAS,KACxD,OAAO,CAAC,mBAAmB,CAuB7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,YACjB,iBAAiB,KAC3B,OAAO,CAAC,IAAI,CAwDd,CAAC"}

package/dist/handlers/slugUpdate.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.slugUpdateHandler = exports.executeChartSlugUpdate = exports.requestSlugUpdate = exports.applyLocalChartSlugUpdate = exports.getLocalSlugUpdateFileChanges = exports.planLocalChartSlugUpdate = void 0;
+exports.slugUpdateHandler = exports.executeSlugUpdate = exports.requestSlugUpdate = exports.applyLocalSlugUpdate = exports.getLocalSlugUpdateFileChanges = exports.planLocalSlugUpdate = void 0;
 const tslib_1 = require("tslib");
 const common_1 = require("@lightdash/common");
 const fs_1 = require("fs");
@@ -56,11 +56,12 @@ const assertMovesAreSafe = async (moves) => {
         }
     }
 };
-const planLocalChartSlugUpdate = async (customPath, from, to) => {
+const planLocalSlugUpdate = async (customPath, from, to, resourceType = common_1.ContentType.CHART) => {
     const root = (0, contentAsCodePaths_1.getDownloadFolder)(customPath);
     const fileUpdates = [];
     const fileMoves = [];
     let referencesUpdated = 0;
+    const languageMapKey = resourceType === common_1.ContentType.CHART ? 'chart' : 'dashboard';
     if (!from || from.length > 255) {
         throw new common_1.ParameterError('The source slug must contain between 1 and 255 characters');
     }
@@ -88,7 +89,10 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
         const parsed = document.toJS();
         const isChart = parsed.contentType === common_1.ContentType.CHART ||
             parsed.metricQuery !== undefined;
-        if (isChart && parsed.slug === from) {
+        const isDashboard = parsed.contentType === common_1.ContentType.DASHBOARD ||
+            (parsed.contentType === undefined && Array.isArray(parsed.tiles));
+        const isTargetContent = resourceType === common_1.ContentType.CHART ? isChart : isDashboard;
+        if (isTargetContent && parsed.slug === from) {
             document.set('slug', to);
             referencesUpdated += 1;
             changed = true;
@@ -112,16 +116,21 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
                                 .join('; ')}`);
                         }
                         const languageMapEntry = languageMapDocument.getIn([
-                            'chart',
+                            languageMapKey,
                             from,
                         ]);
                         if (languageMapEntry !== undefined) {
-                            if (languageMapDocument.getIn(['chart', to]) !==
-                                undefined) {
-                                throw new common_1.ParameterError(`Cannot update language map because chart slug "${to}" already exists in "${sourceLanguageMap}"`);
+                            if (languageMapDocument.getIn([
+                                languageMapKey,
+                                to,
+                            ]) !== undefined) {
+                                throw new common_1.ParameterError(`Cannot update language map because ${resourceType} slug "${to}" already exists in "${sourceLanguageMap}"`);
                             }
-                            languageMapDocument.setIn(['chart', to], languageMapEntry);
-                            languageMapDocument.deleteIn(['chart', from]);
+                            languageMapDocument.setIn([languageMapKey, to], languageMapEntry);
+                            languageMapDocument.deleteIn([
+                                languageMapKey,
+                                from,
+                            ]);
                             fileUpdates.push({
                                 filePath: sourceLanguageMap,
                                 content: languageMapDocument.toString(),
@@ -141,7 +150,7 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
                 }
             }
         }
-        if (Array.isArray(parsed.tiles)) {
+        if (resourceType === common_1.ContentType.CHART && Array.isArray(parsed.tiles)) {
             for (const [index, tile] of parsed.tiles.entries()) {
                 if (tile.type === 'saved_chart' &&
                     tile.properties?.chartSlug === from) {
@@ -151,7 +160,7 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
                 }
             }
         }
-        if (parsed.resource?.type === common_1.ContentType.CHART &&
+        if (parsed.resource?.type === resourceType &&
             parsed.resource.slug === from) {
             document.setIn(['resource', 'slug'], to);
             referencesUpdated += 1;
@@ -163,14 +172,17 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
     }
     const metadata = await (0, metadataFile_1.readMetadataFile)(root);
     let updatedMetadata;
-    if (from in metadata.charts) {
-        if (to !== from && to in metadata.charts) {
-            throw new common_1.ParameterError(`Cannot update local metadata because chart slug "${to}" already exists`);
+    const metadataSlugs = resourceType === common_1.ContentType.CHART
+        ? metadata.charts
+        : metadata.dashboards;
+    if (from in metadataSlugs) {
+        if (to !== from && to in metadataSlugs) {
+            throw new common_1.ParameterError(`Cannot update local metadata because ${resourceType} slug "${to}" already exists`);
         }
-        const charts = { ...metadata.charts };
-        charts[to] = charts[from];
-        delete charts[from];
-        updatedMetadata = { root, charts };
+        const slugs = { ...metadataSlugs };
+        slugs[to] = slugs[from];
+        delete slugs[from];
+        updatedMetadata = { root, resourceType, slugs };
     }
     await assertMovesAreSafe(fileMoves);
     return {
@@ -180,7 +192,7 @@ const planLocalChartSlugUpdate = async (customPath, from, to) => {
         referencesUpdated,
     };
 };
-exports.planLocalChartSlugUpdate = planLocalChartSlugUpdate;
+exports.planLocalSlugUpdate = planLocalSlugUpdate;
 const getLocalSlugUpdateFileChanges = (plan, customPath) => {
     const root = (0, contentAsCodePaths_1.getDownloadFolder)(customPath);
     const movedSources = new Set(plan.fileMoves.map(({ source }) => source));
@@ -235,7 +247,7 @@ const restoreFiles = async (snapshots) => {
         ? fs_1.promises.rm(filePath, { force: true })
         : fs_1.promises.writeFile(filePath, content)));
 };
-const applyLocalChartSlugUpdate = async (plan) => {
+const applyLocalSlugUpdate = async (plan) => {
     const metadataPath = plan.metadata
         ? path.join(plan.metadata.root, metadataFile_1.METADATA_FILENAME)
         : undefined;
@@ -260,7 +272,12 @@ const applyLocalChartSlugUpdate = async (plan) => {
         }
         if (plan.metadata && metadataPath) {
             const existing = await (0, metadataFile_1.readMetadataFile)(plan.metadata.root);
-            await fs_1.promises.writeFile(metadataPath, JSON.stringify({ ...existing, charts: plan.metadata.charts }, null, 2));
+            await fs_1.promises.writeFile(metadataPath, JSON.stringify({
+                ...existing,
+                [plan.metadata.resourceType === common_1.ContentType.CHART
+                    ? 'charts'
+                    : 'dashboards']: plan.metadata.slugs,
+            }, null, 2));
         }
     }
     catch (error) {
@@ -270,7 +287,7 @@ const applyLocalChartSlugUpdate = async (plan) => {
     }
     return () => restoreFiles(snapshots);
 };
-exports.applyLocalChartSlugUpdate = applyLocalChartSlugUpdate;
+exports.applyLocalSlugUpdate = applyLocalSlugUpdate;
 const requestSlugUpdate = async (projectUuid, request) => {
     try {
         await (0, apiClient_1.lightdashApi)({
@@ -289,22 +306,22 @@ const requestSlugUpdate = async (projectUuid, request) => {
     }
 };
 exports.requestSlugUpdate = requestSlugUpdate;
-const executeChartSlugUpdate = async (projectUuid, customPath, from, to) => {
-    const localPlan = await (0, exports.planLocalChartSlugUpdate)(customPath, from, to);
+const executeSlugUpdate = async (projectUuid, customPath, from, to, resourceType = common_1.ContentType.CHART) => {
+    const localPlan = await (0, exports.planLocalSlugUpdate)(customPath, from, to, resourceType);
     await (0, exports.requestSlugUpdate)(projectUuid, {
-        resourceType: common_1.ContentType.CHART,
+        resourceType,
         from,
         to,
     });
     try {
-        await (0, exports.applyLocalChartSlugUpdate)(localPlan);
+        await (0, exports.applyLocalSlugUpdate)(localPlan);
     }
     catch (error) {
-        throw new Error('The chart slug was renamed in Lightdash, but the local files could not be updated. Fix the local file error and rerun the same command; the rename is idempotent.', { cause: error });
+        throw new Error(`The ${resourceType} slug was renamed in Lightdash, but the local files could not be updated. Fix the local file error and rerun the same command; the rename is idempotent.`, { cause: error });
     }
     return localPlan;
 };
-exports.executeChartSlugUpdate = executeChartSlugUpdate;
+exports.executeSlugUpdate = executeSlugUpdate;
 const slugUpdateHandler = async (options) => {
     globalState_1.default.setVerbose(options.verbose);
     await (0, apiClient_1.checkLightdashVersion)();
@@ -317,17 +334,17 @@ const slugUpdateHandler = async (options) => {
         throw new common_1.ParameterError('No project selected. Run lightdash config set-project');
     }
     (0, selectProject_1.logSelectedProject)(selection, config, options.dryRun
-        ? 'Previewing chart slug update in'
-        : 'Updating chart slug in');
+        ? `Previewing ${options.type} slug update in`
+        : `Updating ${options.type} slug in`);
     if (options.dryRun) {
-        const localPlan = await (0, exports.planLocalChartSlugUpdate)(options.path, options.from, options.to);
-        console.info(styles.success(`Would update chart slug "${options.from}" -> "${options.to}".`));
+        const localPlan = await (0, exports.planLocalSlugUpdate)(options.path, options.from, options.to, options.type);
+        console.info(styles.success(`Would update ${options.type} slug "${options.from}" -> "${options.to}".`));
         logLocalSlugUpdateFileChanges(localPlan, options.path, true);
         console.info(styles.secondary('No changes were made.'));
         return;
     }
-    const localPlan = await (0, exports.executeChartSlugUpdate)(selection.projectUuid, options.path, options.from, options.to);
-    console.info(styles.success(`Updated chart slug "${options.from}" -> "${options.to}".`));
+    const localPlan = await (0, exports.executeSlugUpdate)(selection.projectUuid, options.path, options.from, options.to, options.type);
+    console.info(styles.success(`Updated ${options.type} slug "${options.from}" -> "${options.to}".`));
     logLocalSlugUpdateFileChanges(localPlan, options.path, false);
 };
 exports.slugUpdateHandler = slugUpdateHandler;

package/dist/handlers/slugUpdate.test.js

@@ -22,6 +22,63 @@ const createTemporaryContent = async () => {
         .splice(0)
         .map((directory) => fs_1.promises.rm(directory, { recursive: true, force: true })));
 });
+(0, vitest_1.describe)('local dashboard slug updates', () => {
+    (0, vitest_1.test)('updates only dashboard identity, language maps, deliveries, and dashboard metadata', async () => {
+        const root = await createTemporaryContent();
+        const dashboardFile = path.join(root, 'dashboards', 'old-overview.yml');
+        const mapFile = path.join(root, 'dashboards', 'old-overview.language.map.yml');
+        const chartFile = path.join(root, 'charts', 'old-overview.yml');
+        const chartSource = 'contentType: chart\nslug: old-overview\nmetricQuery: {}\n';
+        const alertFile = path.join(root, 'alerts', 'delivery.yml');
+        await Promise.all([
+            fs_1.promises.writeFile(dashboardFile, 'contentType: dashboard\nslug: old-overview\ntiles:\n  - type: saved_chart\n    properties:\n      chartSlug: old-overview\n'),
+            fs_1.promises.writeFile(mapFile, 'dashboard:\n  old-overview:\n    name: Overview\n'),
+            fs_1.promises.writeFile(chartFile, chartSource),
+            fs_1.promises.writeFile(alertFile, 'resource:\n  type: dashboard\n  slug: old-overview\n'),
+            fs_1.promises.writeFile(path.join(root, '.lightdash-metadata.json'), JSON.stringify({
+                version: 1,
+                charts: { 'old-overview': 'chart-timestamp' },
+                dashboards: { 'old-overview': 'dashboard-timestamp' },
+            })),
+        ]);
+        const plan = await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'old-overview', 'overview', common_1.ContentType.DASHBOARD);
+        (0, vitest_1.expect)(await fs_1.promises.readFile(dashboardFile, 'utf8')).toContain('slug: old-overview');
+        await (0, slugUpdate_1.applyLocalSlugUpdate)(plan);
+        const dashboard = (0, yaml_1.parse)(await fs_1.promises.readFile(path.join(root, 'dashboards', 'overview.yml'), 'utf8'));
+        (0, vitest_1.expect)(dashboard.slug).toBe('overview');
+        (0, vitest_1.expect)(dashboard.tiles[0].properties.chartSlug).toBe('old-overview');
+        (0, vitest_1.expect)((0, yaml_1.parse)(await fs_1.promises.readFile(path.join(root, 'dashboards', 'overview.language.map.yml'), 'utf8'))).toEqual({
+            dashboard: { overview: { name: 'Overview' } },
+        });
+        (0, vitest_1.expect)((0, yaml_1.parse)(await fs_1.promises.readFile(alertFile, 'utf8')).resource.slug).toBe('overview');
+        (0, vitest_1.expect)(await fs_1.promises.readFile(chartFile, 'utf8')).toBe(chartSource);
+        (0, vitest_1.expect)(JSON.parse(await fs_1.promises.readFile(path.join(root, '.lightdash-metadata.json'), 'utf8'))).toEqual({
+            version: 1,
+            charts: { 'old-overview': 'chart-timestamp' },
+            dashboards: { overview: 'dashboard-timestamp' },
+        });
+        const replay = await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'old-overview', 'overview', common_1.ContentType.DASHBOARD);
+        (0, vitest_1.expect)((0, slugUpdate_1.getLocalSlugUpdateFileChanges)(replay, root)).toEqual([]);
+    });
+    (0, vitest_1.test)('sends the dashboard type before changing local files', async () => {
+        const root = await createTemporaryContent();
+        const dashboardFile = path.join(root, 'dashboards', 'old-overview.yml');
+        const source = 'slug: old-overview\ntiles: []\n';
+        await fs_1.promises.writeFile(dashboardFile, source);
+        const api = vitest_1.vi
+            .spyOn(apiClient, 'lightdashApi')
+            .mockImplementation(async () => {
+            (0, vitest_1.expect)(await fs_1.promises.readFile(dashboardFile, 'utf8')).toBe(source);
+            return undefined;
+        });
+        await (0, slugUpdate_1.executeSlugUpdate)('project-uuid', root, 'old-overview', 'overview', common_1.ContentType.DASHBOARD);
+        (0, vitest_1.expect)(JSON.parse(api.mock.calls[0][0].body)).toEqual({
+            resourceType: common_1.ContentType.DASHBOARD,
+            from: 'old-overview',
+            to: 'overview',
+        });
+    });
+});
 (0, vitest_1.describe)('local chart slug updates', () => {
     (0, vitest_1.test)('updates chart files, language maps, references, filenames, and metadata', async () => {
         const root = await createTemporaryContent();
@@ -55,7 +112,7 @@ const createTemporaryContent = async () => {
                 dashboards: { overview: 'dashboard-timestamp' },
             })),
         ]);
-        const plan = await (0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', 'orders');
+        const plan = await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', 'orders');
         (0, vitest_1.expect)(plan.referencesUpdated).toBe(4);
         (0, vitest_1.expect)(plan.fileMoves).toHaveLength(2);
         (0, vitest_1.expect)((0, slugUpdate_1.getLocalSlugUpdateFileChanges)(plan, root)).toEqual([
@@ -71,7 +128,7 @@ const createTemporaryContent = async () => {
             },
             { source: path.join('dashboards', 'overview.yml') },
         ]);
-        await (0, slugUpdate_1.applyLocalChartSlugUpdate)(plan);
+        await (0, slugUpdate_1.applyLocalSlugUpdate)(plan);
         await (0, vitest_1.expect)(fs_1.promises.access(chartFile)).rejects.toThrow();
         await (0, vitest_1.expect)(fs_1.promises.access(languageMapFile)).rejects.toThrow();
         const renamedChart = (0, yaml_1.parse)(await fs_1.promises.readFile(path.join(root, 'charts', 'orders.yml'), 'utf8'));
@@ -98,8 +155,8 @@ const createTemporaryContent = async () => {
     (0, vitest_1.test)('is idempotent after local files have already been updated', async () => {
         const root = await createTemporaryContent();
         await fs_1.promises.writeFile(path.join(root, 'charts', 'copy-of-orders.yml'), 'contentType: chart\nslug: copy-of-orders\nname: Orders\nmetricQuery: {}\n');
-        await (0, slugUpdate_1.applyLocalChartSlugUpdate)(await (0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', 'orders'));
-        const secondPlan = await (0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', 'orders');
+        await (0, slugUpdate_1.applyLocalSlugUpdate)(await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', 'orders'));
+        const secondPlan = await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', 'orders');
         (0, vitest_1.expect)(secondPlan).toEqual({
             fileUpdates: [],
             fileMoves: [],
@@ -113,7 +170,7 @@ const createTemporaryContent = async () => {
         const source = 'contentType: chart\nslug: copy-of-orders\nname: Orders\nmetricQuery: {}\n';
         await fs_1.promises.writeFile(chartFile, source);
         const api = vitest_1.vi.spyOn(apiClient, 'lightdashApi');
-        const plan = await (0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', 'orders');
+        const plan = await (0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', 'orders');
         (0, vitest_1.expect)((0, slugUpdate_1.getLocalSlugUpdateFileChanges)(plan, root)).toEqual([
             {
                 source: path.join('charts', 'copy-of-orders.yml'),
@@ -131,7 +188,7 @@ const createTemporaryContent = async () => {
             fs_1.promises.writeFile(sourceFile, 'contentType: chart\nslug: copy-of-orders\nname: Orders\nmetricQuery: {}\n'),
             fs_1.promises.writeFile(path.join(root, 'charts', 'orders.yml'), 'contentType: chart\nslug: another-chart\nname: Another\nmetricQuery: {}\n'),
         ]);
-        await (0, vitest_1.expect)((0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', 'orders')).rejects.toThrow('already exists');
+        await (0, vitest_1.expect)((0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', 'orders')).rejects.toThrow('already exists');
         (0, vitest_1.expect)(await fs_1.promises.readFile(sourceFile, 'utf8')).toContain('slug: copy-of-orders');
     });
     (0, vitest_1.test)('rejects malformed target slugs before constructing file paths', async () => {
@@ -139,7 +196,7 @@ const createTemporaryContent = async () => {
         const chartFile = path.join(root, 'charts', 'copy-of-orders.yml');
         const source = 'contentType: chart\nslug: copy-of-orders\nname: Orders\nmetricQuery: {}\n';
         await fs_1.promises.writeFile(chartFile, source);
-        await (0, vitest_1.expect)((0, slugUpdate_1.planLocalChartSlugUpdate)(root, 'copy-of-orders', '../../orders')).rejects.toThrow('target slug must contain');
+        await (0, vitest_1.expect)((0, slugUpdate_1.planLocalSlugUpdate)(root, 'copy-of-orders', '../../orders')).rejects.toThrow('target slug must contain');
         (0, vitest_1.expect)(await fs_1.promises.readFile(chartFile, 'utf8')).toBe(source);
     });
     (0, vitest_1.test)('does not change local files when the server rejects the rename', async () => {
@@ -153,7 +210,7 @@ const createTemporaryContent = async () => {
             statusCode: 409,
             data: {},
         }));
-        await (0, vitest_1.expect)((0, slugUpdate_1.executeChartSlugUpdate)('project-uuid', root, 'copy-of-orders', 'orders')).rejects.toThrow('Slug already in use');
+        await (0, vitest_1.expect)((0, slugUpdate_1.executeSlugUpdate)('project-uuid', root, 'copy-of-orders', 'orders')).rejects.toThrow('Slug already in use');
         (0, vitest_1.expect)(await fs_1.promises.readFile(chartFile, 'utf8')).toBe(source);
         await (0, vitest_1.expect)(fs_1.promises.access(path.join(root, 'charts', 'orders.yml'))).rejects.toThrow();
         (0, vitest_1.expect)((await fs_1.promises.readdir(path.join(root, 'charts'))).some((file) => file.includes('.slug-update-'))).toBe(false);
@@ -167,7 +224,7 @@ const createTemporaryContent = async () => {
             await (0, vitest_1.expect)(fs_1.promises.access(path.join(root, 'charts', 'orders.yml'))).rejects.toThrow();
             return undefined;
         });
-        await (0, slugUpdate_1.executeChartSlugUpdate)('project-uuid', root, 'copy-of-orders', 'orders');
+        await (0, slugUpdate_1.executeSlugUpdate)('project-uuid', root, 'copy-of-orders', 'orders');
         await (0, vitest_1.expect)(fs_1.promises.access(chartFile)).rejects.toThrow();
         (0, vitest_1.expect)(await fs_1.promises.readFile(path.join(root, 'charts', 'orders.yml'), 'utf8')).toContain('slug: orders');
     });

package/dist/index.js

@@ -608,11 +608,14 @@ commander_1.program
     .action(renameHandler_1.renameHandler);
 commander_1.program
     .command('slug-update')
-    .description('Rename a chart slug and update its local references')
+    .description('Rename a chart or dashboard slug and update its local references')
+    .addOption(new commander_1.Option('--type <resource-type>', 'content type to rename')
+    .choices(['chart', 'dashboard'])
+    .default('chart'))
     .option('--verbose', 'show verbose output', false)
     .option('--project <project uuid or slug>', 'specify a project by UUID or slug', parseProjectArgument, undefined)
     .option('-p, --path <path>', 'specify the local content-as-code path to update', undefined)
-    .option('--dry-run', 'preview the chart rename and local file changes without making changes', false)
+    .option('--dry-run', 'preview the rename and local file changes without making changes', false)
     .requiredOption('--from <slug>', 'current content slug')
     .requiredOption('--to <slug>', 'new content slug')
     .action(slugUpdate_1.slugUpdateHandler);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "2.204.0",
+  "version": "2.205.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -22,8 +22,8 @@
     "@actions/core": "1.11.1",
     "@aws-sdk/credential-providers": "3.995.0",
     "@casl/ability": "6.8.0",
-    "@lightdash/common": "2.204.0",
-    "@lightdash/warehouses": "2.204.0",
+    "@lightdash/common": "2.205.0",
+    "@lightdash/warehouses": "2.205.0",
     "@sidvind/better-ajv-errors": "7.0.0",
     "@types/columnify": "1.5.1",
     "ajv": "8.18.0",