@lightdash/cli 0.3405.1 → 0.3406.1

package/dist/handlers/contentAsCode/resource.test.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const os_1 = tslib_1.__importDefault(require("os"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const vitest_1 = require("vitest");
+const projectResources_1 = require("./projectResources");
+const resource_1 = require("./resource");
+const temporaryDirectories = [];
+(0, vitest_1.afterEach)(async () => {
+    await Promise.all(temporaryDirectories.splice(0).map((directory) => fs_1.promises.rm(directory, {
+        recursive: true,
+        force: true,
+    })));
+});
+(0, vitest_1.describe)('content-as-code resource files', () => {
+    (0, vitest_1.it)('ignores other scheduled content types in a shared legacy folder', async () => {
+        const basePath = await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'lightdash-content-as-code-'));
+        temporaryDirectories.push(basePath);
+        const alertFolder = path_1.default.join(basePath, 'alerts', 'charts', 'orders');
+        await fs_1.promises.mkdir(alertFolder, { recursive: true });
+        await Promise.all([
+            fs_1.promises.writeFile(path_1.default.join(alertFolder, 'alert.yml'), 'contentType: alert\nversion: 1\nslug: revenue-alert\nname: Revenue alert\n'),
+            fs_1.promises.writeFile(path_1.default.join(alertFolder, 'delivery.yml'), 'contentType: scheduled_delivery\nversion: 1\nslug: revenue-delivery\nname: Revenue delivery\n'),
+            fs_1.promises.writeFile(path_1.default.join(alertFolder, 'invalid-alert.yml'), 'contentType: alert\nslug: invalid-alert\nname: Invalid alert\n'),
+        ]);
+        const result = await (0, resource_1.readCodeResourceFiles)({
+            definition: projectResources_1.ALERT_CODE_RESOURCE,
+            basePath,
+        });
+        (0, vitest_1.expect)(result.files.map(({ document }) => document.slug)).toEqual([
+            'revenue-alert',
+        ]);
+        (0, vitest_1.expect)(result.failures).toHaveLength(1);
+        (0, vitest_1.expect)(result.failures[0].message).toContain('invalid-alert.yml');
+        (0, vitest_1.expect)(result.failures[0].message).toContain('expected version 1');
+    });
+});

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

@@ -1 +1 @@
-{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/handlers/download.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,WAAW,EAuBX,WAAW,EAGX,eAAe,EAef,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AA4D3B,OAAO,EAmBH,KAAK,aAAa,EACrB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,sBAAsB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,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;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,OAAO,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AA8FF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AA6XF,KAAK,mBAAmB,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;AAkDjE,eAAO,MAAM,eAAe,GACxB,KAAK,MAAM,EAAE,EACb,MAAM,mBAAmB,EACzB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,cAAa,OAAe,EAC5B,SAAQ,OAAe,EACvB,aAAY,OAAe,EAC3B,mBAAkB,OAAe,EACjC,aAAY,OAAe,KAC5B,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,CAuI5D,CAAC;AA4gBF,eAAO,MAAM,eAAe,GACxB,SAAS,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAglBd,CAAC;AAgaF,eAAO,MAAM,aAAa,GACtB,SAAS,sBAAsB,KAChC,OAAO,CAAC,IAAI,CA6pBd,CAAC;AAEF,eAAO,MAAM,WAAW;;;;6CAlsBJ,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC,EAAE;oCAruCpD,MAAM,KACpB,OAAO,CAAC,WAAW,EAAE,CAAC;;;sCAzzBd,WAAW,oBACA,OAAO,KAC1B,WAAW;;+EA9FX,IAAI,CACH,sBAAsB,EACtB,YAAY,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,CACzD,KAAG,OAAO;;;oCAmvBI,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,aACH,OAAO,eACL,MAAM,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;;CA6kEjC,CAAC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/handlers/download.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,WAAW,EAuBX,WAAW,EAGX,eAAe,EAef,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAyE3B,OAAO,EAmBH,KAAK,aAAa,EACrB,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,sBAAsB,GAAG;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,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;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,OAAO,CAAC;IACpB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB,EAAE,OAAO,CAAC;IACjC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AA8FF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AA6XF,KAAK,mBAAmB,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;AAkDjE,eAAO,MAAM,eAAe,GACxB,KAAK,MAAM,EAAE,EACb,MAAM,mBAAmB,EACzB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,cAAa,OAAe,EAC5B,SAAQ,OAAe,EACvB,aAAY,OAAe,EAC3B,mBAAkB,OAAe,EACjC,aAAY,OAAe,KAC5B,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,WAAW,EAAE,CAAC,CAuI5D,CAAC;AAycF,eAAO,MAAM,eAAe,GACxB,SAAS,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAglBd,CAAC;AAgaF,eAAO,MAAM,aAAa,GACtB,SAAS,sBAAsB,KAChC,OAAO,CAAC,IAAI,CA6pBd,CAAC;AAEF,eAAO,MAAM,WAAW;;;;6CAlsBJ,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC,EAAE;oCA/rCpD,MAAM,KACpB,OAAO,CAAC,WAAW,EAAE,CAAC;;;sCA5xBd,WAAW,oBACA,OAAO,KAC1B,WAAW;;+EA9FX,IAAI,CACH,sBAAsB,EACtB,YAAY,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,CACzD,KAAG,OAAO;;;oCAqtBI,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,aACH,OAAO,eACL,MAAM,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;;;CAwiEjC,CAAC"}

package/dist/handlers/download.js

@@ -19,6 +19,8 @@ const styles = tslib_1.__importStar(require("../styles"));
 const appCodeFiles_1 = require("./apps/appCodeFiles");
 const appsDownload_1 = require("./apps/appsDownload");
 const scaffolding_1 = require("./apps/scaffolding");
+const projectResources_1 = require("./contentAsCode/projectResources");
+const resource_1 = require("./contentAsCode/resource");
 const contentAsCodePaths_1 = require("./contentAsCodePaths");
 const apiClient_1 = require("./dbt/apiClient");
 const metadataFile_1 = require("./metadataFile");
@@ -288,19 +290,19 @@ const getContentTypeConfig = (type, projectId) => {
     switch (type) {
         case 'charts':
             return {
-                endpoint: `/api/v1/projects/${projectId}/charts/code`,
+                endpoint: `/api/v1/projects/${projectId}/code/charts`,
                 displayName: 'charts',
                 supportsLanguageMap: true,
             };
         case 'dashboards':
             return {
-                endpoint: `/api/v1/projects/${projectId}/dashboards/code`,
+                endpoint: `/api/v1/projects/${projectId}/code/dashboards`,
                 displayName: 'dashboards',
                 supportsLanguageMap: true,
             };
         case 'sqlCharts':
             return {
-                endpoint: `/api/v1/projects/${projectId}/sqlCharts/code`,
+                endpoint: `/api/v1/projects/${projectId}/code/sqlCharts`,
                 displayName: 'SQL charts',
                 supportsLanguageMap: false,
             };
@@ -421,55 +423,32 @@ const downloadContent = async (ids, type, projectId, projectName, customPath, la
     return [total, [...new Set(chartSlugs)], allMetadataEntries, allSpaces];
 };
 exports.downloadContent = downloadContent;
-const getScheduledDeliveriesFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), 'scheduled-deliveries');
-const getAiAgentsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), 'ai-agents');
-const getAlertsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), 'alerts');
-const getGoogleSheetsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), 'google-sheets');
-const getVirtualViewsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), 'virtual-views');
+const getScheduledDeliveriesFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), projectResources_1.SCHEDULED_DELIVERY_CODE_RESOURCE.folderName);
+const getAlertsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), projectResources_1.ALERT_CODE_RESOURCE.folderName);
+const getGoogleSheetsFolder = (customPath) => path.join((0, contentAsCodePaths_1.getDownloadFolder)(customPath), projectResources_1.GOOGLE_SHEETS_CODE_RESOURCE.folderName);
 const downloadVirtualViews = async (projectId, slugs, customPath) => {
-    const folder = getVirtualViewsFolder(customPath);
-    await fs_1.promises.mkdir(folder, { recursive: true });
     const query = new URLSearchParams(slugs.map((slug) => ['slugs', slug])).toString();
     const results = await (0, apiClient_1.lightdashApi)({
         method: 'GET',
-        url: `/api/v1/projects/${projectId}/virtualViews/code${query ? `?${query}` : ''}`,
+        url: `/api/v1/projects/${projectId}/code/virtualViews${query ? `?${query}` : ''}`,
         body: undefined,
     });
-    for (const virtualView of results.virtualViews) {
-        await fs_1.promises.writeFile(path.join(folder, `${encodeURIComponent(virtualView.slug)}.yml`), yaml.dump(virtualView, { quotingType: '"', sortKeys: true }));
-    }
+    await (0, resource_1.writeCodeResourceDocuments)({
+        definition: projectResources_1.VIRTUAL_VIEW_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+        documents: results.virtualViews,
+    });
     results.skipped.forEach(({ slug, reason }) => globalState_1.default.log(styles.warning(`Skipped virtual view "${slug}": ${reason}`)));
     results.missingSlugs.forEach((slug) => globalState_1.default.log(styles.warning(`Virtual view "${slug}" was not found`)));
     return results.virtualViews.length;
 };
 const readVirtualViewFiles = async (customPath) => {
-    const folder = getVirtualViewsFolder(customPath);
-    try {
-        const entries = await fs_1.promises.readdir(folder, { withFileTypes: true });
-        const virtualViews = [];
-        for (const entry of entries) {
-            if (entry.isFile() &&
-                (entry.name.endsWith('.yml') || entry.name.endsWith('.yaml'))) {
-                const parsed = yaml.load(await fs_1.promises.readFile(path.join(folder, entry.name), 'utf-8'));
-                if (parsed.contentType !== common_1.ContentAsCodeType.VIRTUAL_VIEW) {
-                    throw new common_1.ParameterError(`Invalid virtual view contentType in ${entry.name}`);
-                }
-                virtualViews.push(parsed);
-            }
-        }
-        const duplicates = Object.entries((0, groupBy_1.default)(virtualViews, 'slug'))
-            .filter(([, items]) => items.length > 1)
-            .map(([slug]) => slug);
-        if (duplicates.length > 0) {
-            throw new common_1.ParameterError(`Duplicate virtual view slugs: ${duplicates.join(', ')}`);
-        }
-        return virtualViews;
-    }
-    catch (error) {
-        if (error.code === 'ENOENT')
-            return [];
-        throw error;
-    }
+    const result = await (0, resource_1.readCodeResourceFiles)({
+        definition: projectResources_1.VIRTUAL_VIEW_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+    });
+    (0, resource_1.assertCodeResourceFilesValid)(result);
+    return result.files.map(({ document }) => document);
 };
 const upsertVirtualViews = async (projectId, slugs, changes, force, canUpload, customPath) => {
     const virtualViews = await readVirtualViewFiles(customPath);
@@ -497,7 +476,7 @@ const upsertVirtualViews = async (projectId, slugs, changes, force, canUpload, c
             }
             const result = await (0, apiClient_1.lightdashApi)({
                 method: 'POST',
-                url: `/api/v1/projects/${projectId}/virtualViews/${encodeURIComponent(virtualView.slug)}/code?force=${force}`,
+                url: `/api/v1/projects/${projectId}/code/virtualViews/${encodeURIComponent(virtualView.slug)}?force=${force}`,
                 body: JSON.stringify(virtualView),
             });
             const action = `virtual views ${getPromoteAction(result.action)}`;
@@ -516,6 +495,7 @@ const getScheduledContentConfig = (contentType, customPath) => {
         case common_1.ContentAsCodeType.ALERT:
             return {
                 folder: getAlertsFolder(customPath),
+                definition: projectResources_1.ALERT_CODE_RESOURCE,
                 route: 'alerts',
                 singular: 'alert',
                 plural: 'alerts',
@@ -523,6 +503,7 @@ const getScheduledContentConfig = (contentType, customPath) => {
         case common_1.ContentAsCodeType.GOOGLE_SHEETS_SYNC:
             return {
                 folder: getGoogleSheetsFolder(customPath),
+                definition: projectResources_1.GOOGLE_SHEETS_CODE_RESOURCE,
                 route: 'googleSheets',
                 singular: 'Google Sheets sync',
                 plural: 'Google Sheets syncs',
@@ -530,6 +511,7 @@ const getScheduledContentConfig = (contentType, customPath) => {
         case common_1.ContentAsCodeType.SCHEDULED_DELIVERY:
             return {
                 folder: getScheduledDeliveriesFolder(customPath),
+                definition: projectResources_1.SCHEDULED_DELIVERY_CODE_RESOURCE,
                 route: 'scheduledDeliveries',
                 singular: 'scheduled delivery',
                 plural: 'scheduled deliveries',
@@ -539,12 +521,11 @@ const getScheduledContentConfig = (contentType, customPath) => {
     }
 };
 const downloadAiAgents = async (projectId, ids, customPath) => {
-    const outputDir = getAiAgentsFolder(customPath);
-    await fs_1.promises.mkdir(outputDir, { recursive: true });
     const idQuery = ids.map((id) => ['ids', id]);
     let offset = 0;
     let total = 0;
     let downloaded = 0;
+    const agents = [];
     do {
         const query = new URLSearchParams([
             ...idQuery,
@@ -552,54 +533,29 @@ const downloadAiAgents = async (projectId, ids, customPath) => {
         ]).toString();
         const results = await (0, apiClient_1.lightdashApi)({
             method: 'GET',
-            url: `/api/v1/projects/${projectId}/aiAgents/code?${query}`,
+            url: `/api/v1/projects/${projectId}/code/aiAgents?${query}`,
             body: undefined,
         });
-        for (const agent of results.agents) {
-            const { updatedAt, downloadedAt, ...agentConfig } = agent;
-            // eslint-disable-next-line no-await-in-loop
-            await fs_1.promises.writeFile(path.join(outputDir, `${agent.slug}.yml`), yaml.dump(agentConfig, { quotingType: '"', sortKeys: true }));
-        }
+        agents.push(...results.agents);
         results.missingIds.forEach((id) => globalState_1.default.debug(`No AI agent with id "${id}"`));
         downloaded += results.agents.length;
         offset = results.offset;
         total = results.total;
     } while (offset < total);
+    await (0, resource_1.writeCodeResourceDocuments)({
+        definition: projectResources_1.AI_AGENT_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+        documents: agents,
+    });
     return downloaded;
 };
 const readAiAgentFiles = async (customPath) => {
-    const folder = getAiAgentsFolder(customPath);
-    try {
-        const entries = await fs_1.promises.readdir(folder, {
-            recursive: true,
-            withFileTypes: true,
-        });
-        const agents = [];
-        for (const entry of entries) {
-            if (entry.isFile() &&
-                (entry.name.endsWith('.yml') || entry.name.endsWith('.yaml'))) {
-                const filePath = path.join(entry.parentPath, entry.name);
-                // eslint-disable-next-line no-await-in-loop
-                const parsed = yaml.load(await fs_1.promises.readFile(filePath, 'utf-8'));
-                if (typeof parsed !== 'object' ||
-                    parsed === null ||
-                    Array.isArray(parsed)) {
-                    throw new common_1.ParameterError(`Invalid AI agent file "${filePath}": expected a YAML object`);
-                }
-                if (!('contentType' in parsed) ||
-                    parsed.contentType !== common_1.ContentAsCodeType.AI_AGENT) {
-                    throw new common_1.ParameterError(`Invalid contentType in AI agent file "${filePath}": expected "${common_1.ContentAsCodeType.AI_AGENT}"`);
-                }
-                agents.push(parsed);
-            }
-        }
-        return agents;
-    }
-    catch (error) {
-        if (error.code === 'ENOENT')
-            return [];
-        throw error;
-    }
+    const result = await (0, resource_1.readCodeResourceFiles)({
+        definition: projectResources_1.AI_AGENT_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+    });
+    (0, resource_1.assertCodeResourceFilesValid)(result);
+    return result.files.map(({ document }) => document);
 };
 class AiAgentAsCodeUploadError extends Error {
     originalError;
@@ -624,7 +580,7 @@ const upsertAiAgents = async (projectId, slugs, changes, force, customPath) => {
     globalState_1.default.log(`Found ${filteredAgents.length} AI agent files`);
     const results = await (0, apiClient_1.lightdashApi)({
         method: 'POST',
-        url: `/api/v1/projects/${projectId}/aiAgents/code?force=${force}`,
+        url: `/api/v1/projects/${projectId}/code/aiAgents?force=${force}`,
         body: JSON.stringify({ agents: filteredAgents }),
     });
     const counts = {
@@ -644,7 +600,7 @@ const downloadScheduledContent = async (projectId, slugs, contentType, customPat
     const query = new URLSearchParams(slugs.map((slug) => ['slugs', slug])).toString();
     const results = await (0, apiClient_1.lightdashApi)({
         method: 'GET',
-        url: `/api/v1/projects/${projectId}/${config.route}/code${query ? `?${query}` : ''}`,
+        url: `/api/v1/projects/${projectId}/code/${config.route}${query ? `?${query}` : ''}`,
         body: undefined,
     });
     let scheduledContent;
@@ -666,29 +622,23 @@ const downloadScheduledContent = async (projectId, slugs, contentType, customPat
     return scheduledContent.length;
 };
 const readScheduledContentFiles = async (contentType, customPath) => {
-    const config = getScheduledContentConfig(contentType, customPath);
-    try {
-        const entries = await fs_1.promises.readdir(config.folder, {
-            recursive: true,
-            withFileTypes: true,
+    const read = async (definition) => {
+        const result = await (0, resource_1.readCodeResourceFiles)({
+            definition,
+            basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
         });
-        const scheduledContent = [];
-        for (const entry of entries) {
-            if (entry.isFile() &&
-                (entry.name.endsWith('.yml') || entry.name.endsWith('.yaml'))) {
-                const filePath = path.join(entry.parentPath, entry.name);
-                const parsed = yaml.load(await fs_1.promises.readFile(filePath, 'utf-8'));
-                if (parsed.contentType === contentType) {
-                    scheduledContent.push(parsed);
-                }
-            }
-        }
-        return scheduledContent;
-    }
-    catch (error) {
-        if (error.code === 'ENOENT')
-            return [];
-        throw error;
+        (0, resource_1.assertCodeResourceFilesValid)(result);
+        return result.files.map(({ document }) => document);
+    };
+    switch (contentType) {
+        case common_1.ContentAsCodeType.ALERT:
+            return read(projectResources_1.ALERT_CODE_RESOURCE);
+        case common_1.ContentAsCodeType.GOOGLE_SHEETS_SYNC:
+            return read(projectResources_1.GOOGLE_SHEETS_CODE_RESOURCE);
+        case common_1.ContentAsCodeType.SCHEDULED_DELIVERY:
+            return read(projectResources_1.SCHEDULED_DELIVERY_CODE_RESOURCE);
+        default:
+            return (0, common_1.assertUnreachable)(contentType, 'Unknown scheduled content type');
     }
 };
 const upsertScheduledContent = async (projectId, slugs, changes, force, contentType, canUpload, customPath) => {
@@ -709,7 +659,7 @@ const upsertScheduledContent = async (projectId, slugs, changes, force, contentT
         try {
             const result = await (0, apiClient_1.lightdashApi)({
                 method: 'POST',
-                url: `/api/v1/projects/${projectId}/${config.route}/${item.slug}/code?force=${force}`,
+                url: `/api/v1/projects/${projectId}/code/${config.route}/${item.slug}?force=${force}`,
                 body: JSON.stringify(item),
             });
             const action = getPromoteAction(result.action);
@@ -1160,8 +1110,8 @@ const upsertSingleItem = async (item, type, projectId, changes, force, config, s
         // 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`;
+            ? `/api/v1/projects/${projectId}/code/sqlCharts/${item.slug}`
+            : `/api/v1/projects/${projectId}/code/${type}/${item.slug}`;
         const upsertData = await (0, apiClient_1.lightdashApi)({
             method: 'POST',
             url: endpoint,

package/dist/handlers/organizationContent/customRoles.d.ts

@@ -1,6 +1,6 @@
-export type CustomRoleUploadFailure = {
-    message: string;
-};
+import { type CustomRoleAsCode } from '@lightdash/common';
+import { type CodeFileFailure, type CodeResourceDefinition } from '../contentAsCode/resource';
+export type CustomRoleUploadFailure = CodeFileFailure;
 export type CustomRoleUploadSummary = {
     created: number;
     updated: number;
@@ -8,6 +8,7 @@ export type CustomRoleUploadSummary = {
     failed: number;
     failures: CustomRoleUploadFailure[];
 };
+export declare const CUSTOM_ROLE_CODE_RESOURCE: CodeResourceDefinition<CustomRoleAsCode>;
 export declare const getCustomRolesFolder: (organizationContentPath: string) => string;
 export declare const formatCustomRoleUploadSummary: (summary: CustomRoleUploadSummary) => string;
 export declare const readCustomRoleFiles: (organizationContentPath: string) => Promise<unknown[]>;

package/dist/handlers/organizationContent/customRoles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customRoles.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/customRoles.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,uBAAuB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,uBAAuB,EAAE,CAAC;CACvC,CAAC;AAgBF,eAAO,MAAM,oBAAoB,GAAI,yBAAyB,MAAM,KAAG,MACjB,CAAC;AAEvD,eAAO,MAAM,6BAA6B,GACtC,SAAS,uBAAuB,KACjC,MACmH,CAAC;AAkFvH,eAAO,MAAM,mBAAmB,GAC5B,yBAAyB,MAAM,KAChC,OAAO,CAAC,OAAO,EAAE,CAUnB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC1B,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,uBAAuB,CA6CjC,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC5B,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,MAAM,CAiChB,CAAC"}
+{"version":3,"file":"customRoles.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/customRoles.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,gBAAgB,EACxB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAKH,KAAK,eAAe,EACpB,KAAK,sBAAsB,EAC9B,MAAM,2BAA2B,CAAC;AAGnC,MAAM,MAAM,uBAAuB,GAAG,eAAe,CAAC;AAEtD,MAAM,MAAM,uBAAuB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,uBAAuB,EAAE,CAAC;CACvC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,sBAAsB,CAAC,gBAAgB,CAkB1E,CAAC;AAEN,eAAO,MAAM,oBAAoB,GAAI,yBAAyB,MAAM,KAAG,MACK,CAAC;AAE7E,eAAO,MAAM,6BAA6B,GACtC,SAAS,uBAAuB,KACjC,MACmH,CAAC;AAEvH,eAAO,MAAM,mBAAmB,GAC5B,yBAAyB,MAAM,KAChC,OAAO,CAAC,OAAO,EAAE,CAOnB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAC1B,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,uBAAuB,CAc5B,CAAC;AAEP,eAAO,MAAM,mBAAmB,GAC5B,kBAAkB,MAAM,EACxB,yBAAyB,MAAM,KAChC,OAAO,CAAC,MAAM,CAcX,CAAC"}

package/dist/handlers/organizationContent/customRoles.js

@@ -1,151 +1,65 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadCustomRoles = exports.uploadCustomRoles = exports.readCustomRoleFiles = exports.formatCustomRoleUploadSummary = exports.getCustomRolesFolder = void 0;
+exports.downloadCustomRoles = exports.uploadCustomRoles = exports.readCustomRoleFiles = exports.formatCustomRoleUploadSummary = exports.getCustomRolesFolder = exports.CUSTOM_ROLE_CODE_RESOURCE = 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 groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const path = tslib_1.__importStar(require("path"));
+const resource_1 = require("../contentAsCode/resource");
 const apiClient_1 = require("../dbt/apiClient");
-const fileNames_1 = require("./fileNames");
-const getCustomRolesFolder = (organizationContentPath) => path.join(organizationContentPath, 'custom-roles');
+exports.CUSTOM_ROLE_CODE_RESOURCE = {
+    kind: 'custom_role',
+    displayLabel: 'custom role',
+    identityLabel: 'name',
+    scope: 'organization',
+    folderName: 'custom-roles',
+    acceptedExtensions: ['.yml'],
+    fileName: {
+        strategy: 'normalizedDisplayName',
+        fallbackPrefix: 'role',
+        extension: '.yml',
+    },
+    dependencies: [],
+    identity: ({ name }) => name,
+    displayName: ({ name }) => name,
+    parse: common_1.parseCustomRoleAsCode,
+    sort: (left, right) => left.name.localeCompare(right.name),
+};
+const getCustomRolesFolder = (organizationContentPath) => path.join(organizationContentPath, exports.CUSTOM_ROLE_CODE_RESOURCE.folderName);
 exports.getCustomRolesFolder = getCustomRolesFolder;
 const formatCustomRoleUploadSummary = (summary) => `${summary.created} created, ${summary.updated} updated, ${summary.unchanged} unchanged, ${summary.failed} failed`;
 exports.formatCustomRoleUploadSummary = formatCustomRoleUploadSummary;
-const getCustomRoleName = (role) => {
-    if (typeof role !== 'object' || role === null || Array.isArray(role)) {
-        return undefined;
-    }
-    return typeof role.name === 'string'
-        ? role.name
-        : undefined;
-};
-const readCustomRoleFileResults = async (organizationContentPath) => {
-    const folder = (0, exports.getCustomRolesFolder)(organizationContentPath);
-    let entries;
-    try {
-        entries = await fs_1.promises.readdir(folder, { withFileTypes: true });
-    }
-    catch (error) {
-        if (error.code === 'ENOENT') {
-            return { roleFiles: [], failures: [] };
-        }
-        throw error;
-    }
-    const files = entries
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
-        .sort((left, right) => left.name.localeCompare(right.name));
-    const results = await Promise.all(files.map(async (file) => {
-        const filePath = path.join(folder, file.name);
-        try {
-            return {
-                kind: 'role',
-                roleFile: {
-                    filePath,
-                    role: yaml.load(await fs_1.promises.readFile(filePath, 'utf8')),
-                },
-            };
-        }
-        catch (error) {
-            return {
-                kind: 'failure',
-                failure: {
-                    message: `Unable to parse custom role file "${filePath}": ${(0, common_1.getErrorMessage)(error)}`,
-                },
-            };
-        }
-    }));
-    const parsedRoleFiles = results.flatMap((result) => result.kind === 'role' ? [result.roleFile] : []);
-    const failures = results.flatMap((result) => result.kind === 'failure' ? [result.failure] : []);
-    const namedRoleFiles = parsedRoleFiles.flatMap((roleFile) => {
-        const name = getCustomRoleName(roleFile.role);
-        return name === undefined ? [] : [{ name, roleFile }];
-    });
-    const roleFilesByName = (0, groupBy_1.default)(namedRoleFiles, ({ name }) => name);
-    const duplicateNames = new Set(Object.entries(roleFilesByName)
-        .filter(([, roleFiles]) => roleFiles.length > 1)
-        .map(([name]) => name));
-    for (const duplicateName of [...duplicateNames].sort()) {
-        for (const { roleFile } of roleFilesByName[duplicateName]) {
-            failures.push({
-                message: `Duplicate custom role name "${duplicateName}" in "${roleFile.filePath}"`,
-            });
-        }
-    }
-    return {
-        roleFiles: parsedRoleFiles.filter(({ role }) => !duplicateNames.has(getCustomRoleName(role) ?? '')),
-        failures,
-    };
-};
 const readCustomRoleFiles = async (organizationContentPath) => {
-    const { roleFiles, failures } = await readCustomRoleFileResults(organizationContentPath);
-    if (failures.length > 0) {
-        throw new common_1.ParameterError(failures.map(({ message }) => message).join('\n'));
-    }
-    return roleFiles.map(({ role }) => role);
+    const result = await (0, resource_1.readCodeResourceFiles)({
+        definition: exports.CUSTOM_ROLE_CODE_RESOURCE,
+        basePath: organizationContentPath,
+    });
+    (0, resource_1.assertCodeResourceFilesValid)(result);
+    return result.files.map(({ document }) => document);
 };
 exports.readCustomRoleFiles = readCustomRoleFiles;
-const uploadCustomRoles = async (organizationUuid, organizationContentPath) => {
-    const { roleFiles, failures } = await readCustomRoleFileResults(organizationContentPath);
-    const summary = {
-        created: 0,
-        updated: 0,
-        unchanged: 0,
-        failed: 0,
-        failures,
-    };
-    for (const { filePath, role } of roleFiles) {
-        try {
-            const result = await (0, apiClient_1.lightdashApi)({
-                method: 'POST',
-                url: `/api/v2/orgs/${organizationUuid}/roles/code`,
-                body: JSON.stringify(role),
-            });
-            switch (result.action) {
-                case common_1.PromotionAction.CREATE:
-                    summary.created += 1;
-                    break;
-                case common_1.PromotionAction.UPDATE:
-                    summary.updated += 1;
-                    break;
-                case common_1.PromotionAction.NO_CHANGES:
-                    summary.unchanged += 1;
-                    break;
-                default:
-                    throw new common_1.ParameterError(`Unsupported custom role promotion action: ${result.action}`);
-            }
-        }
-        catch (error) {
-            summary.failures.push({
-                message: `Invalid custom role file "${filePath}": ${(0, common_1.getErrorMessage)(error)}`,
-            });
-        }
-    }
-    summary.failed = summary.failures.length;
-    return summary;
-};
+const uploadCustomRoles = async (organizationUuid, organizationContentPath) => (0, resource_1.uploadCodeResource)({
+    definition: exports.CUSTOM_ROLE_CODE_RESOURCE,
+    basePath: organizationContentPath,
+    upsert: async (role) => {
+        const result = await (0, apiClient_1.lightdashApi)({
+            method: 'POST',
+            url: `/api/v2/orgs/${organizationUuid}/code/roles`,
+            body: JSON.stringify(role),
+        });
+        return result.action;
+    },
+});
 exports.uploadCustomRoles = uploadCustomRoles;
-const downloadCustomRoles = async (organizationUuid, organizationContentPath) => {
-    const { customRoles } = await (0, apiClient_1.lightdashApi)({
-        method: 'GET',
-        url: `/api/v2/orgs/${organizationUuid}/roles/code`,
-        body: undefined,
-    });
-    const folder = (0, exports.getCustomRolesFolder)(organizationContentPath);
-    await fs_1.promises.mkdir(folder, { recursive: true });
-    const existingFiles = await fs_1.promises.readdir(folder, { withFileTypes: true });
-    await Promise.all(existingFiles
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
-        .map((entry) => fs_1.promises.unlink(path.join(folder, entry.name))));
-    const filenames = (0, fileNames_1.getOrganizationContentFileNames)({
-        values: customRoles.map(({ name }) => name),
-        fallbackPrefix: 'role',
-    });
-    await Promise.all(customRoles.map(async (role, index) => {
-        await fs_1.promises.writeFile(path.join(folder, filenames[index]), yaml.dump(role, { quotingType: '"', sortKeys: true }));
-    }));
-    return customRoles.length;
-};
+const downloadCustomRoles = async (organizationUuid, organizationContentPath) => (0, resource_1.downloadCodeResource)({
+    definition: exports.CUSTOM_ROLE_CODE_RESOURCE,
+    basePath: organizationContentPath,
+    list: async () => {
+        const { customRoles } = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v2/orgs/${organizationUuid}/code/roles`,
+            body: undefined,
+        });
+        return customRoles;
+    },
+});
 exports.downloadCustomRoles = downloadCustomRoles;

package/dist/handlers/organizationContent/customRoles.test.js

@@ -59,7 +59,7 @@ describe('custom roles as code', () => {
         expect(total).toBe(1);
         expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
             method: 'GET',
-            url: '/api/v2/orgs/organization-uuid/roles/code',
+            url: '/api/v2/orgs/organization-uuid/code/roles',
             body: undefined,
         });
         expect(yaml.load(await fs_1.promises.readFile(path.join(tmpDir, 'custom-roles', 'custom-role-name.yml'), 'utf8'))).toStrictEqual({
@@ -71,6 +71,7 @@ describe('custom roles as code', () => {
         });
         expect((await fs_1.promises.readdir(folder)).sort()).toStrictEqual([
             'custom-role-name.yml',
+            'stale.yml',
         ]);
     });
     it('uses stable hashes for normalized filename collisions', async () => {
@@ -82,6 +83,16 @@ describe('custom roles as code', () => {
         expect(filenames).toHaveLength(2);
         expect(filenames.every((filename) => /^data-admin-[a-f0-9]{8}\.yml$/.test(filename))).toBe(true);
     });
+    it('reuses an existing filename owned by the same identity', async () => {
+        await writeCustomRole('hand-authored-name.yml', customRole('Data Admin'));
+        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValueOnce({
+            customRoles: [customRole('Data Admin')],
+        });
+        await (0, customRoles_1.downloadCustomRoles)('organization-uuid', tmpDir);
+        expect(await fs_1.promises.readdir((0, customRoles_1.getCustomRolesFolder)(tmpDir))).toStrictEqual([
+            'hand-authored-name.yml',
+        ]);
+    });
     it('counts backend create, update, and no-op actions', async () => {
         await writeCustomRole('a.yml', customRole('Role A'));
         await writeCustomRole('b.yml', customRole('Role B'));
@@ -102,7 +113,7 @@ describe('custom roles as code', () => {
         });
         expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(1, {
             method: 'POST',
-            url: '/api/v2/orgs/organization-uuid/roles/code',
+            url: '/api/v2/orgs/organization-uuid/code/roles',
             body: expect.any(String),
         });
         expect(JSON.parse(vitest_1.vi.mocked(apiClient_1.lightdashApi).mock.calls[0][0].body)).toStrictEqual(customRole('Role A'));

package/dist/handlers/organizationContent/fileNames.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fileNames.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/fileNames.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,+BAA+B,GAAI,6BAG7C;IACC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B,KAAG,MAAM,EAsBT,CAAC"}
+{"version":3,"file":"fileNames.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/fileNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,+BAA+B,GAAI,6BAG7C;IACC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CAC1B,KAAG,MAAM,EAOJ,CAAC"}