@lightdash/cli 2.215.3 → 2.217.0

package/dist/handlers/contentAsCode/projectResources.d.ts

@@ -1,5 +1,6 @@
-import { type AgentAsCode, type AlertAsCode, type ExternalConnectionAsCode, type GoogleSheetsSyncAsCode, type ScheduledDeliveryAsCode, type VirtualViewAsCode } from '@lightdash/common';
+import { type AgentAsCode, type AlertAsCode, type ExternalConnectionAsCode, type GoogleSheetsSyncAsCode, type HomepageAsCode, type ScheduledDeliveryAsCode, type VirtualViewAsCode } from '@lightdash/common';
 import type { CodeResourceDefinition } from './resource';
+export declare const HOMEPAGE_CODE_RESOURCE: CodeResourceDefinition<HomepageAsCode>;
 export declare const VIRTUAL_VIEW_CODE_RESOURCE: CodeResourceDefinition<VirtualViewAsCode>;
 export declare const AI_AGENT_CODE_RESOURCE: CodeResourceDefinition<AgentAsCode>;
 export declare const EXTERNAL_CONNECTION_CODE_RESOURCE: CodeResourceDefinition<ExternalConnectionAsCode>;

package/dist/handlers/contentAsCode/projectResources.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"projectResources.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/projectResources.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAAC,iBAAiB,CAwB5E,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,WAAW,CAyBtE,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,sBAAsB,CAAC,wBAAwB,CAwB1F,CAAC;AA4CN,eAAO,MAAM,gCAAgC,iDAKvC,CAAC;AAEP,eAAO,MAAM,mBAAmB,qCAI9B,CAAC;AAEH,eAAO,MAAM,2BAA2B,gDAKlC,CAAC"}
+{"version":3,"file":"projectResources.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/projectResources.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,sBAAsB,EAC3B,KAAK,cAAc,EACnB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEzD,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,cAAc,CAiBzE,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,sBAAsB,CAAC,iBAAiB,CAwB5E,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,sBAAsB,CAAC,WAAW,CAyBtE,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,sBAAsB,CAAC,wBAAwB,CAwB1F,CAAC;AA4CN,eAAO,MAAM,gCAAgC,iDAKvC,CAAC;AAEP,eAAO,MAAM,mBAAmB,qCAI9B,CAAC;AAEH,eAAO,MAAM,2BAA2B,gDAKlC,CAAC"}

package/dist/handlers/contentAsCode/projectResources.js

@@ -1,7 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GOOGLE_SHEETS_CODE_RESOURCE = exports.ALERT_CODE_RESOURCE = exports.SCHEDULED_DELIVERY_CODE_RESOURCE = exports.EXTERNAL_CONNECTION_CODE_RESOURCE = exports.AI_AGENT_CODE_RESOURCE = exports.VIRTUAL_VIEW_CODE_RESOURCE = void 0;
+exports.GOOGLE_SHEETS_CODE_RESOURCE = exports.ALERT_CODE_RESOURCE = exports.SCHEDULED_DELIVERY_CODE_RESOURCE = exports.EXTERNAL_CONNECTION_CODE_RESOURCE = exports.AI_AGENT_CODE_RESOURCE = exports.VIRTUAL_VIEW_CODE_RESOURCE = exports.HOMEPAGE_CODE_RESOURCE = void 0;
 const common_1 = require("@lightdash/common");
+exports.HOMEPAGE_CODE_RESOURCE = {
+    kind: common_1.ContentAsCodeType.HOMEPAGE,
+    displayLabel: 'homepage',
+    identityLabel: 'name',
+    scope: 'project',
+    folderName: 'homepages',
+    acceptedExtensions: ['.yml', '.yaml'],
+    fileName: {
+        strategy: 'uriEncodedIdentity',
+        fallbackPrefix: 'homepage',
+        extension: '.yml',
+    },
+    dependencies: ['space', 'chart', 'dashboard'],
+    identity: ({ name }) => name,
+    displayName: ({ name }) => name,
+    parse: common_1.parseHomepageAsCode,
+    sort: (a, b) => a.name.localeCompare(b.name),
+};
 exports.VIRTUAL_VIEW_CODE_RESOURCE = {
     kind: common_1.ContentAsCodeType.VIRTUAL_VIEW,
     displayLabel: 'virtual view',

package/dist/handlers/contentAsCode/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAc3B,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;CACtD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,SAAS,wBAAwB,EAMtE,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,SAAS,wBAAwB,EAwBrE,CAAC;AAEF,eAAO,MAAM,iCAAiC,cAC/B,SAAS,wBAAwB,EAAE,KAC/C,IAeF,CAAC"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAe3B,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;CACtD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,SAAS,wBAAwB,EAMtE,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,SAAS,wBAAwB,EAyBrE,CAAC;AAEF,eAAO,MAAM,iCAAiC,cAC/B,SAAS,wBAAwB,EAAE,KAC/C,IAeF,CAAC"}

package/dist/handlers/contentAsCode/registry.js

@@ -37,6 +37,7 @@ exports.PROJECT_CODE_RESOURCES = [
     projectResources_1.ALERT_CODE_RESOURCE,
     projectResources_1.GOOGLE_SHEETS_CODE_RESOURCE,
     projectResources_1.EXTERNAL_CONNECTION_CODE_RESOURCE,
+    projectResources_1.HOMEPAGE_CODE_RESOURCE,
 ];
 const assertCodeResourceDependencyOrder = (resources) => {
     const completed = new Set();

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

@@ -32,6 +32,38 @@ const agent = (slug) => ({
     })));
 });
 (0, vitest_1.describe)('content-as-code resource files', () => {
+    (0, vitest_1.it)('round trips exact homepage names safely and rejects duplicate local identities', async () => {
+        const basePath = await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'lightdash-homepage-code-'));
+        temporaryDirectories.push(basePath);
+        const document = {
+            contentType: common_1.ContentAsCodeType.HOMEPAGE,
+            version: 1,
+            name: '../Home / 100%',
+            config: { version: 1, rows: [] },
+            publication: null,
+        };
+        await (0, resource_1.writeCodeResourceDocuments)({
+            definition: projectResources_1.HOMEPAGE_CODE_RESOURCE,
+            basePath,
+            documents: [document],
+            pruneOtherDocuments: true,
+        });
+        const fileNames = await fs_1.promises.readdir(path_1.default.join(basePath, 'homepages'));
+        (0, vitest_1.expect)(fileNames).toHaveLength(1);
+        (0, vitest_1.expect)(fileNames[0]).not.toContain('/');
+        const result = await (0, resource_1.readCodeResourceFiles)({
+            definition: projectResources_1.HOMEPAGE_CODE_RESOURCE,
+            basePath,
+        });
+        (0, vitest_1.expect)(result.files[0].document).toEqual(document);
+        await fs_1.promises.copyFile(path_1.default.join(basePath, 'homepages', fileNames[0]), path_1.default.join(basePath, 'homepages', 'duplicate.yaml'));
+        const duplicates = await (0, resource_1.readCodeResourceFiles)({
+            definition: projectResources_1.HOMEPAGE_CODE_RESOURCE,
+            basePath,
+        });
+        (0, vitest_1.expect)(duplicates.files).toEqual([]);
+        (0, vitest_1.expect)(duplicates.failures[0].message).toContain('Duplicate');
+    });
     (0, vitest_1.it)('preserves other documents when writing a filtered download', async () => {
         const basePath = await fs_1.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'lightdash-content-as-code-'));
         temporaryDirectories.push(basePath);

package/dist/handlers/download.d.ts

@@ -10,6 +10,10 @@ export type DownloadHandlerOptions = {
     googleSheets: string[];
     scheduledDeliveries: string[];
     virtualViews: string[];
+    homepages?: string[];
+    includeHomepages?: boolean;
+    skipHomepages?: boolean;
+    publish?: boolean;
     externalConnections: string[];
     apps?: string[];
     chartTypes?: string[];
@@ -57,7 +61,7 @@ export type DownloadHandlerOptions = {
     sendInvites?: boolean;
 };
 declare const shouldDownloadAiAgents: ({ includeAll, includeAgents, agents, appsOnly, }: Pick<DownloadHandlerOptions, 'includeAll' | 'includeAgents' | 'agents' | 'appsOnly'>) => boolean;
-declare const hasContentFilters: ({ spacesOnly, charts, dashboards, agents, alerts, googleSheets, scheduledDeliveries, virtualViews, externalConnections, apps, chartTypes, }: Pick<DownloadHandlerOptions, 'spacesOnly' | 'charts' | 'dashboards' | 'agents' | 'alerts' | 'googleSheets' | 'scheduledDeliveries' | 'virtualViews' | 'externalConnections' | 'apps' | 'chartTypes'>) => boolean;
+declare const hasContentFilters: ({ spacesOnly, charts, dashboards, agents, alerts, googleSheets, scheduledDeliveries, virtualViews, externalConnections, homepages, apps, chartTypes, }: Pick<DownloadHandlerOptions, 'spacesOnly' | 'charts' | 'dashboards' | 'agents' | 'alerts' | 'googleSheets' | 'scheduledDeliveries' | 'virtualViews' | 'externalConnections' | 'homepages' | 'apps' | 'chartTypes'>) => boolean;
 declare const parseContentFilters: (items: string[]) => string;
 type MetadataEntry = {
     slug: string;

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,EA0BX,WAAW,EAIX,eAAe,EAGf,wBAAwB,EAoBxB,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAiB3B,OAAO,EAIH,KAAK,0BAA0B,EAClC,MAAM,iCAAiC,CAAC;AAoEzC,OAAO,EACH,sBAAsB,EAGtB,cAAc,EACd,qBAAqB,EAKrB,cAAc,EACd,cAAc,EACd,8BAA8B,EAC9B,yBAAyB,EACzB,YAAY,EACZ,qBAAqB,EACrB,eAAe,EAElB,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,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,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,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,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,uBAAuB,EAAE,OAAO,CAAC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,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;AAIF,QAAA,MAAM,sBAAsB,qDAKzB,IAAI,CACH,sBAAsB,EACtB,YAAY,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,CACzD,KAAG,OAEoE,CAAC;AAEzE,QAAA,MAAM,iBAAiB,gJAYpB,IAAI,CACH,sBAAsB,EACpB,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,cAAc,GACd,qBAAqB,GACrB,cAAc,GACd,qBAAqB,GACrB,MAAM,GACN,YAAY,CACjB,KAAG,OAauC,CAAC;AAO5C,QAAA,MAAM,mBAAmB,UAAW,MAAM,EAAE,KAAG,MAa9C,CAAC;AA4DF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,QAAA,MAAM,wBAAwB,UACnB,WAAW,oBACA,OAAO,KAC1B,WAUY,CAAC;AA6YhB,KAAK,mBAAmB,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;AAkDjE,QAAA,MAAM,6BAA6B,eACnB,eAAe,EAAE,KAC9B,MAAM,EAWR,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,8BAA8B,WAAY,WAAW,EAAE,KAAG,MAAM,EAUrE,CAAC;AAIF,QAAA,MAAM,sBAAsB,WAAY,WAAW,EAAE,KAAG,MAAM,EAM7D,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAC;IAGnB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,EAAE,aAAa,EAAE,CAAC;IACjC,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,eAAe,QACnB,MAAM,EAAE,QACP,mBAAmB,aACd,MAAM,eACJ,MAAM,eACN,MAAM,gBACN,OAAO,WACZ,OAAO,eACH,OAAO,qBACD,OAAO,eACb,OAAO,eACN,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KACtC,OAAO,CAAC,qBAAqB,CA6J/B,CAAC;AAsDF,QAAA,MAAM,8BAA8B,UAAW,OAAO,KAAG,OACmB,CAAC;AAE7E;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B,cACjB,MAAM,cACL,MAAM,EAAE,eACP,MAAM,KACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAoCvB,CAAC;AAaF,QAAA,MAAM,kBAAkB,cACT,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,aACH,OAAO,eACL,MAAM,mBACH,MAAM,EAAE,KACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmEhC,CAAC;AAEF,eAAO,MAAM,iCAAiC,SAAU,MAAM,KAAG,MAGzC,CAAC;AASzB;;;;;;GAMG;AACH,QAAA,MAAM,qCAAqC,UAAW,OAAO,KAAG,OAElB,CAAC;AAE/C,QAAA,MAAM,0BAA0B,UAAW,OAAO,KAAG,OAEP,CAAC;AA8E/C,QAAA,MAAM,2BAA2B,gBAChB,MAAM,KACpB,OAAO,CAAC,wBAAwB,EAAE,CAOpC,CAAC;AAEF,QAAA,MAAM,yBAAyB,cAChB,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,CA8EhC,CAAC;AAgDF,QAAA,MAAM,gBAAgB,cACP,MAAM,OACZ,MAAM,EAAE,YACH,OAAO,eACJ,MAAM,KACpB,OAAO,CAAC,MAAM,CAqDhB,CAAC;AAEF,QAAA,MAAM,gBAAgB,gBACL,MAAM,KACpB,OAAO,CAAC,WAAW,EAAE,CAOvB,CAAC;AAcF,QAAA,MAAM,cAAc,cACL,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,eACD,MAAM,aACT,OAAO,KAClB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAoDhC,CAAC;AAgLF,eAAO,MAAM,eAAe,YACf,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAglCd,CAAC;AA8BF,QAAA,MAAM,gBAAgB,WACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACvB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B,MAIM,CAAC;AAEV,QAAA,MAAM,sBAAsB,WAChB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACvB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,0BAA0B,CAAA;CAoBxD,CAAC;AAwMF;;;GAGG;AACH,QAAA,MAAM,eAAe,GAAU,CAAC,SAAS,WAAW,GAAG,eAAe,QAC5D,QAAQ,GAAG,YAAY,aAClB,MAAM,WACR,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,SACP,MAAM,EAAE,aACJ,OAAO,eACL,MAAM,oBACD,OAAO,sBACL,OAAO,aAChB,OAAO,gBACL,MAAM,eACP,CAAC,CAAC,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,eACjC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,cACvB,WAAW,CAAC,MAAM,CAAC,KAChC,OAAO,CAAC;IACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB,CA+LA,CAAC;AA8DF,QAAA,MAAM,2BAA2B,gEAK9B;IACC,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,EAAE,eAAe,EAAE,CAAC;IAClC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC5B,KAAG,MAAM,EAWT,CAAC;AAEF,QAAA,MAAM,sBAAsB,mBACR,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,KAClE,OAAO,CAAC,MAAM,EAAE,CAId,CAAC;AAEN,QAAA,MAAM,oBAAoB,mBACN,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,KAClE,OAAO,CAAC,MAAM,EAAE,CAId,CAAC;AAIN,QAAA,MAAM,0BAA0B,eAChB,OAAO,kBACH,MAAM,EAAE,KACzB,OAAoD,CAAC;AAExD,QAAA,MAAM,yBAAyB,gBACd,MAAM,KACpB,OAAO,CAAC,IAAI,CA6Bd,CAAC;AAoCF,eAAO,MAAM,aAAa,YACb,sBAAsB,KAChC,OAAO,CAAC,IAAI,CA+pCd,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCvB,CAAC"}
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../src/handlers/download.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,WAAW,EA0BX,WAAW,EAIX,eAAe,EAGf,wBAAwB,EAoBxB,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAiB3B,OAAO,EAIH,KAAK,0BAA0B,EAClC,MAAM,iCAAiC,CAAC;AAqEzC,OAAO,EACH,sBAAsB,EAGtB,cAAc,EACd,qBAAqB,EAKrB,cAAc,EACd,cAAc,EACd,8BAA8B,EAC9B,yBAAyB,EACzB,YAAY,EACZ,qBAAqB,EACrB,eAAe,EAElB,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,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,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,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,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,uBAAuB,EAAE,OAAO,CAAC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,0BAA0B,EAAE,OAAO,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,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;AAIF,QAAA,MAAM,sBAAsB,qDAKzB,IAAI,CACH,sBAAsB,EACtB,YAAY,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,CACzD,KAAG,OAEoE,CAAC;AAEzE,QAAA,MAAM,iBAAiB,2JAapB,IAAI,CACH,sBAAsB,EACpB,YAAY,GACZ,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,cAAc,GACd,qBAAqB,GACrB,cAAc,GACd,qBAAqB,GACrB,WAAW,GACX,MAAM,GACN,YAAY,CACjB,KAAG,OAcuC,CAAC;AAO5C,QAAA,MAAM,mBAAmB,UAAW,MAAM,EAAE,KAAG,MAa9C,CAAC;AA4DF,KAAK,aAAa,GAAG;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,YAAY,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,QAAA,MAAM,wBAAwB,UACnB,WAAW,oBACA,OAAO,KAC1B,WAUY,CAAC;AA6YhB,KAAK,mBAAmB,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC;AAkDjE,QAAA,MAAM,6BAA6B,eACnB,eAAe,EAAE,KAC9B,MAAM,EAWR,CAAC;AAEF;;;GAGG;AACH,QAAA,MAAM,8BAA8B,WAAY,WAAW,EAAE,KAAG,MAAM,EAUrE,CAAC;AAIF,QAAA,MAAM,sBAAsB,WAAY,WAAW,EAAE,KAAG,MAAM,EAM7D,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAC;IAGnB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,EAAE,aAAa,EAAE,CAAC;IACjC,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,eAAe,QACnB,MAAM,EAAE,QACP,mBAAmB,aACd,MAAM,eACJ,MAAM,eACN,MAAM,gBACN,OAAO,WACZ,OAAO,eACH,OAAO,qBACD,OAAO,eACb,OAAO,eACN,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KACtC,OAAO,CAAC,qBAAqB,CA6J/B,CAAC;AAsDF,QAAA,MAAM,8BAA8B,UAAW,OAAO,KAAG,OACmB,CAAC;AAE7E;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B,cACjB,MAAM,cACL,MAAM,EAAE,eACP,MAAM,KACpB,OAAO,CAAC,MAAM,GAAG,IAAI,CAoCvB,CAAC;AAaF,QAAA,MAAM,kBAAkB,cACT,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,aACH,OAAO,eACL,MAAM,mBACH,MAAM,EAAE,KACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmEhC,CAAC;AAEF,eAAO,MAAM,iCAAiC,SAAU,MAAM,KAAG,MAGzC,CAAC;AASzB;;;;;;GAMG;AACH,QAAA,MAAM,qCAAqC,UAAW,OAAO,KAAG,OAElB,CAAC;AAE/C,QAAA,MAAM,0BAA0B,UAAW,OAAO,KAAG,OAEP,CAAC;AA8E/C,QAAA,MAAM,2BAA2B,gBAChB,MAAM,KACpB,OAAO,CAAC,wBAAwB,EAAE,CAOpC,CAAC;AAEF,QAAA,MAAM,yBAAyB,cAChB,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,CA8EhC,CAAC;AAgDF,QAAA,MAAM,gBAAgB,cACP,MAAM,OACZ,MAAM,EAAE,YACH,OAAO,eACJ,MAAM,KACpB,OAAO,CAAC,MAAM,CAqDhB,CAAC;AAEF,QAAA,MAAM,gBAAgB,gBACL,MAAM,KACpB,OAAO,CAAC,WAAW,EAAE,CAOvB,CAAC;AAcF,QAAA,MAAM,cAAc,cACL,MAAM,SACV,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,eACD,MAAM,aACT,OAAO,KAClB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAoDhC,CAAC;AAgLF,eAAO,MAAM,eAAe,YACf,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAumCd,CAAC;AA8BF,QAAA,MAAM,gBAAgB,WACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACvB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B,MAIM,CAAC;AAEV,QAAA,MAAM,sBAAsB,WAChB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACvB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC9B;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,0BAA0B,CAAA;CAoBxD,CAAC;AAwMF;;;GAGG;AACH,QAAA,MAAM,eAAe,GAAU,CAAC,SAAS,WAAW,GAAG,eAAe,QAC5D,QAAQ,GAAG,YAAY,aAClB,MAAM,WACR,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SACxB,OAAO,SACP,MAAM,EAAE,aACJ,OAAO,eACL,MAAM,oBACD,OAAO,sBACL,OAAO,aAChB,OAAO,gBACL,MAAM,eACP,CAAC,CAAC,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,eACjC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,cACvB,WAAW,CAAC,MAAM,CAAC,KAChC,OAAO,CAAC;IACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,EAAE,CAAC;CACzB,CA+LA,CAAC;AA8DF,QAAA,MAAM,2BAA2B,gEAK9B;IACC,UAAU,EAAE,WAAW,EAAE,CAAC;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,EAAE,eAAe,EAAE,CAAC;IAClC,cAAc,EAAE,MAAM,EAAE,CAAC;CAC5B,KAAG,MAAM,EAWT,CAAC;AAEF,QAAA,MAAM,sBAAsB,mBACR,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,KAClE,OAAO,CAAC,MAAM,EAAE,CAId,CAAC;AAEN,QAAA,MAAM,oBAAoB,mBACN,MAAM,EAAE,eACX,MAAM,oBACF,CAAC,eAAe,GAAG;IAAE,aAAa,EAAE,OAAO,CAAA;CAAE,CAAC,EAAE,KAClE,OAAO,CAAC,MAAM,EAAE,CAId,CAAC;AAIN,QAAA,MAAM,0BAA0B,eAChB,OAAO,kBACH,MAAM,EAAE,KACzB,OAAoD,CAAC;AAExD,QAAA,MAAM,yBAAyB,gBACd,MAAM,KACpB,OAAO,CAAC,IAAI,CA6Bd,CAAC;AAoCF,eAAO,MAAM,aAAa,YACb,sBAAsB,KAChC,OAAO,CAAC,IAAI,CAyrCd,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCvB,CAAC"}

package/dist/handlers/download.js

@@ -28,13 +28,14 @@ const projectResources_1 = require("./contentAsCode/projectResources");
 const resource_1 = require("./contentAsCode/resource");
 const contentAsCodePaths_1 = require("./contentAsCodePaths");
 const apiClient_1 = require("./dbt/apiClient");
+const homepagesAsCode_1 = require("./homepagesAsCode");
 const metadataFile_1 = require("./metadataFile");
 const organizationContent_1 = require("./organizationContent");
 const selectProject_1 = require("./selectProject");
 const spacesAsCode_1 = require("./spacesAsCode");
 const shouldDownloadAiAgents = ({ includeAll, includeAgents, agents, appsOnly, }) => appsOnly !== true &&
     (includeAll === true || includeAgents === true || agents.length > 0);
-const hasContentFilters = ({ spacesOnly, charts, dashboards, agents, alerts, googleSheets, scheduledDeliveries, virtualViews, externalConnections, apps, chartTypes, }) => !spacesOnly &&
+const hasContentFilters = ({ spacesOnly, charts, dashboards, agents, alerts, googleSheets, scheduledDeliveries, virtualViews, externalConnections, homepages, apps, chartTypes, }) => !spacesOnly &&
     [
         charts,
         dashboards,
@@ -44,6 +45,7 @@ const hasContentFilters = ({ spacesOnly, charts, dashboards, agents, alerts, goo
         scheduledDeliveries,
         virtualViews,
         externalConnections,
+        homepages ?? [],
         apps ?? [],
         chartTypes ?? [],
     ].some((filters) => filters.length > 0);
@@ -1154,6 +1156,20 @@ const downloadHandler = async (options) => {
         // chart types step.
         let downloadedChartVizRefs = [];
         const explicitChartTypeRefs = new Set((Array.isArray(options.chartTypes) ? options.chartTypes : []).map(appsDownload_1.getDataAppReference));
+        if (!options.appsOnly &&
+            !options.chartTypesOnly &&
+            !options.spacesOnly &&
+            (options.includeHomepages ||
+                options.homepages?.length ||
+                includeAllOptionalContent)) {
+            await output.runItem({
+                label: 'Homepages',
+                action: () => (0, homepagesAsCode_1.downloadHomepages)(projectId, options.homepages ?? [], options.path, includeAllOptionalContent &&
+                    !options.includeHomepages &&
+                    !options.homepages?.length),
+                detail: (count) => `${count} downloaded`,
+            });
+        }
         if (shouldDownloadSpaces) {
             output.startItem('Spaces');
             try {
@@ -2806,6 +2822,21 @@ const uploadHandler = async (options) => {
                 });
             }
         }
+        if (!options.skipHomepages &&
+            !options.appsOnly &&
+            !options.chartTypesOnly &&
+            (!hasFilters || options.homepages?.length)) {
+            changes = await runUploadChangesPhase({
+                output,
+                label: 'Homepages',
+                changes,
+                action: () => {
+                    if (hasUploadFailures(changes))
+                        throw new common_1.ParameterError('Homepage upload blocked because prerequisite content uploads failed');
+                    return (0, homepagesAsCode_1.uploadHomepages)(projectId, options.homepages ?? [], changes, options.publish === true, contentPathOption);
+                },
+            });
+        }
         const end = Date.now();
         await analytics_1.LightdashAnalytics.track({
             event: 'upload.completed',

package/dist/handlers/download.test.js

@@ -130,6 +130,9 @@ const makeContentFilterOptions = (overrides = {}) => ({
     ...overrides,
 });
 describe('hasContentFilters', () => {
+    it('treats explicit homepage names as a filtered download and upload', () => {
+        expect(hasContentFilters(makeContentFilterOptions({ homepages: ['Team homepage'] }))).toBe(true);
+    });
     it('treats explicit apps as a filtered download and upload', () => {
         expect(hasContentFilters(makeContentFilterOptions({ apps: ['app-reference'] }))).toBe(true);
     });
@@ -1026,7 +1029,8 @@ describe('downloadHandler failures', () => {
                     missingSlugs: [],
                 };
             }
-            if (url.includes('/code/aiAgents')) {
+            if (url.includes('/code/aiAgents') ||
+                url.includes('/code/homepages')) {
                 throw unavailableError;
             }
             if (url.includes('/code/alerts')) {

package/dist/handlers/homepagesAsCode.d.ts

@@ -0,0 +1,3 @@
+export declare const downloadHomepages: (projectUuid: string, names: string[], customPath?: string, implicit?: boolean) => Promise<number>;
+export declare const uploadHomepages: (projectUuid: string, names: string[], changes: Record<string, number>, publish: boolean, customPath?: string) => Promise<Record<string, number>>;
+//# sourceMappingURL=homepagesAsCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"homepagesAsCode.d.ts","sourceRoot":"","sources":["../../src/handlers/homepagesAsCode.ts"],"names":[],"mappings":"AAoBA,eAAO,MAAM,iBAAiB,gBACb,MAAM,SACZ,MAAM,EAAE,eACF,MAAM,aACT,OAAO,KAClB,OAAO,CAAC,MAAM,CAqChB,CAAC;AAEF,eAAO,MAAM,eAAe,gBACX,MAAM,SACZ,MAAM,EAAE,WACN,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,WACtB,OAAO,eACH,MAAM,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA8ChC,CAAC"}

package/dist/handlers/homepagesAsCode.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadHomepages = exports.downloadHomepages = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable no-await-in-loop */
+const common_1 = require("@lightdash/common");
+const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const styles = tslib_1.__importStar(require("../styles"));
+const projectResources_1 = require("./contentAsCode/projectResources");
+const resource_1 = require("./contentAsCode/resource");
+const contentAsCodePaths_1 = require("./contentAsCodePaths");
+const apiClient_1 = require("./dbt/apiClient");
+const downloadHomepages = async (projectUuid, names, customPath, implicit = false) => {
+    const query = new URLSearchParams(names.map((name) => ['names', name]));
+    let result;
+    try {
+        result = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v1/projects/${projectUuid}/code/homepages?${query}`,
+            body: undefined,
+        });
+    }
+    catch (error) {
+        if (implicit &&
+            error instanceof common_1.LightdashError &&
+            [403, 404, 422].includes(error.statusCode)) {
+            globalState_1.default.log(styles.warning('Skipping homepages: the homepage builder and homepage management permission are required.'));
+            return 0;
+        }
+        throw error;
+    }
+    if (result.missingNames.length)
+        throw new common_1.ParameterError(`Homepages not found or unpublished: ${result.missingNames.join(', ')}`);
+    await (0, resource_1.writeCodeResourceDocuments)({
+        definition: projectResources_1.HOMEPAGE_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+        documents: result.homepages,
+        pruneOtherDocuments: names.length === 0,
+    });
+    return result.homepages.length;
+};
+exports.downloadHomepages = downloadHomepages;
+const uploadHomepages = async (projectUuid, names, changes, publish, customPath) => {
+    const uploadChanges = { ...changes };
+    const files = await (0, resource_1.readCodeResourceFiles)({
+        definition: projectResources_1.HOMEPAGE_CODE_RESOURCE,
+        basePath: (0, contentAsCodePaths_1.getDownloadFolder)(customPath),
+    });
+    (0, resource_1.assertCodeResourceFilesValid)(files);
+    const documents = files.files
+        .map((file) => file.document)
+        .filter((document) => names.length === 0 || names.includes(document.name));
+    const missing = names.filter((name) => !documents.some((document) => document.name === name));
+    if (missing.length)
+        throw new common_1.ParameterError(`Homepages not found locally: ${missing.join(', ')}`);
+    for (const document of documents) {
+        try {
+            const result = await (0, apiClient_1.lightdashApi)({
+                method: 'POST',
+                url: `/api/v1/projects/${projectUuid}/code/homepages/${encodeURIComponent(document.name)}?publish=${publish}`,
+                body: JSON.stringify(document),
+            });
+            const actionLabels = {
+                [common_1.PromotionAction.CREATE]: 'created',
+                [common_1.PromotionAction.UPDATE]: 'updated',
+                [common_1.PromotionAction.NO_CHANGES]: 'unchanged',
+            };
+            const key = `homepages ${actionLabels[result.action]}`;
+            uploadChanges[key] = (uploadChanges[key] ?? 0) + 1;
+        }
+        catch (error) {
+            uploadChanges['homepages with errors'] =
+                (uploadChanges['homepages with errors'] ?? 0) + 1;
+            globalState_1.default.log(styles.error(`Error uploading homepage "${document.name}": ${(0, common_1.getErrorMessage)(error)}`));
+        }
+    }
+    return uploadChanges;
+};
+exports.uploadHomepages = uploadHomepages;

package/dist/handlers/homepagesAsCode.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=homepagesAsCode.test.d.ts.map

package/dist/handlers/homepagesAsCode.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"homepagesAsCode.test.d.ts","sourceRoot":"","sources":["../../src/handlers/homepagesAsCode.test.ts"],"names":[],"mappings":""}

package/dist/handlers/homepagesAsCode.test.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@lightdash/common");
+const vitest_1 = require("vitest");
+const resource_1 = require("./contentAsCode/resource");
+const apiClient_1 = require("./dbt/apiClient");
+const homepagesAsCode_1 = require("./homepagesAsCode");
+vitest_1.vi.mock('./dbt/apiClient', () => ({ lightdashApi: vitest_1.vi.fn() }));
+vitest_1.vi.mock('./contentAsCode/resource', () => ({
+    readCodeResourceFiles: vitest_1.vi.fn(),
+    writeCodeResourceDocuments: vitest_1.vi.fn(),
+    assertCodeResourceFilesValid: vitest_1.vi.fn(),
+}));
+vitest_1.vi.mock('../globalState', () => ({ default: { log: vitest_1.vi.fn() } }));
+const document = {
+    contentType: common_1.ContentAsCodeType.HOMEPAGE,
+    version: 1,
+    name: 'Home / Team',
+    config: { version: 1, rows: [] },
+    publication: null,
+};
+(0, vitest_1.describe)('homepage CLI download/upload', () => {
+    (0, vitest_1.beforeEach)(() => vitest_1.vi.clearAllMocks());
+    (0, vitest_1.it)('requests exact names and preserves other files during a filtered download', async () => {
+        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValue({
+            homepages: [document],
+            missingNames: [],
+        });
+        await (0, homepagesAsCode_1.downloadHomepages)('project', [document.name], '/tmp/homepage-code');
+        (0, vitest_1.expect)(apiClient_1.lightdashApi).toHaveBeenCalledWith(vitest_1.expect.objectContaining({
+            url: '/api/v1/projects/project/code/homepages?names=Home+%2F+Team',
+        }));
+        (0, vitest_1.expect)(resource_1.writeCodeResourceDocuments).toHaveBeenCalledWith(vitest_1.expect.objectContaining({
+            documents: [document],
+            pruneOtherDocuments: false,
+        }));
+    });
+    (0, vitest_1.it)('skips unavailable homepages only for implicit include-all downloads', async () => {
+        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockRejectedValue(new common_1.ForbiddenError());
+        await (0, vitest_1.expect)((0, homepagesAsCode_1.downloadHomepages)('project', [], undefined, true)).resolves.toBe(0);
+        await (0, vitest_1.expect)((0, homepagesAsCode_1.downloadHomepages)('project', [], undefined, false)).rejects.toThrow();
+        (0, vitest_1.expect)(resource_1.writeCodeResourceDocuments).not.toHaveBeenCalled();
+    });
+    (0, vitest_1.it)('passes the publication option explicitly and reports unchanged uploads', async () => {
+        vitest_1.vi.mocked(resource_1.readCodeResourceFiles).mockResolvedValue({
+            files: [{ filePath: 'home.yml', document }],
+            failures: [],
+        });
+        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValue({
+            action: common_1.PromotionAction.NO_CHANGES,
+        });
+        await (0, vitest_1.expect)((0, homepagesAsCode_1.uploadHomepages)('project', [], {}, false)).resolves.toEqual({ 'homepages unchanged': 1 });
+        (0, vitest_1.expect)(apiClient_1.lightdashApi).toHaveBeenLastCalledWith(vitest_1.expect.objectContaining({
+            method: 'POST',
+            url: '/api/v1/projects/project/code/homepages/Home%20%2F%20Team?publish=false',
+        }));
+        await (0, homepagesAsCode_1.uploadHomepages)('project', [], {}, true);
+        (0, vitest_1.expect)(apiClient_1.lightdashApi).toHaveBeenLastCalledWith(vitest_1.expect.objectContaining({
+            url: '/api/v1/projects/project/code/homepages/Home%20%2F%20Team?publish=true',
+        }));
+    });
+    (0, vitest_1.it)('fails missing selections and records API failures for a nonzero CLI exit', async () => {
+        vitest_1.vi.mocked(resource_1.readCodeResourceFiles).mockResolvedValue({
+            files: [{ filePath: 'home.yml', document }],
+            failures: [],
+        });
+        await (0, vitest_1.expect)((0, homepagesAsCode_1.uploadHomepages)('project', ['Missing'], {}, false)).rejects.toThrow('not found locally');
+        (0, vitest_1.expect)(apiClient_1.lightdashApi).not.toHaveBeenCalled();
+        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockRejectedValue(new Error('Missing reference'));
+        await (0, vitest_1.expect)((0, homepagesAsCode_1.uploadHomepages)('project', [], {}, false)).resolves.toEqual({ 'homepages with errors': 1 });
+    });
+});

package/dist/index.js

@@ -368,6 +368,8 @@ const downloadCommand = commander_1.program
     .option('--virtual-views <slugs...>', 'specify virtual view slugs to download', refsArgument_1.parseRefsArgument, [])
     .option('--google-sheets <slugs...>', 'specify Google Sheets sync slugs to download', refsArgument_1.parseRefsArgument, [])
     .option('--scheduled-deliveries <slugs...>', 'specify scheduled delivery slugs to download', refsArgument_1.parseRefsArgument, [])
+    .option('--homepages <names...>', 'specify exact homepage names to download', [])
+    .option('--include-homepages', 'include all published homepages (enterprise)', false)
     .option('--external-connections <slugs...>', 'specify external connection slugs to download (enterprise)', refsArgument_1.parseRefsArgument, [])
     .option('--include-external-connections', "include all of the project's data-app external connections (enterprise)", false)
     .option('-l, --language-map', 'generate a language maps for the downloaded charts and dashboards', false)
@@ -406,6 +408,9 @@ const uploadCommand = commander_1.program
     .option('--virtual-views <slugs...>', 'specify virtual view slugs to upload', refsArgument_1.parseRefsArgument, [])
     .option('--google-sheets <slugs...>', 'specify Google Sheets sync slugs to upload', refsArgument_1.parseRefsArgument, [])
     .option('--scheduled-deliveries <slugs...>', 'specify scheduled delivery slugs to upload', refsArgument_1.parseRefsArgument, [])
+    .option('--homepages <names...>', 'specify exact homepage names to upload', [])
+    .option('--skip-homepages', 'skip uploading homepages', false)
+    .option('--publish', 'publish uploaded homepages and apply their audience assignments', false)
     .option('--external-connections <slugs...>', 'specify external connection slugs to upload (enterprise)', refsArgument_1.parseRefsArgument, [])
     .option('--force', 'Force upload unchanged files and allow destructive virtual-view column changes', false)
     .option('-p, --path <path>', 'specify a custom path to upload content from', undefined)

package/dist/vendor/template/.claude/skills/reusable-visualization/SKILL.md

@@ -176,9 +176,10 @@ action menu. This is part of the component contract, not an optional nicety —
 item shows; you always write the wiring, and it costs nothing visually when disabled.
 
 When `underlyingData.enabled` is true, viewers get the standard Lightdash action on
-chart marks: click a data point → small action menu → "View underlying data" → a dialog
-listing the raw rows behind that point, with a Download button. When it is false (host
-too old, viewer lacks permission, embed), render no menu item — never a disabled one.
+chart marks: click a data point → small action menu → "View underlying data" → the
+standard Lightdash dialog listing the raw rows behind that point, with its Download
+button. When it is false (host too old, viewer lacks permission, embed), render no menu
+item — never a disabled one.
 
 Provenance is the contract: **every interactive datum keeps a reference to its
 untransformed source row.** When mapping `rows` into chart data, carry the row:
@@ -195,33 +196,17 @@ Only attach the action where one mark maps to exactly ONE source row and ONE met
 field. A mark that aggregates several rows (a binned bucket, a "top N + other" slice)
 gets no underlying-data item.
 
-On click, fetch and render in a dialog themed like the rest of the viz:
+On click, send the intent and render nothing else. Lightdash opens the dialog outside
+the viz and owns its table, loading, error, sorting, and download controls:
 
 ```tsx
-const result = await underlyingData.get({ row: datum.sourceRow, metric: 'value' });
-// result.rows / result.columns / result.format — render as a table
-// Download button:
-// await underlyingData.download({ row: datum.sourceRow, metric: 'value', fileType: 'csv' });
+underlyingData.open({ row: datum.sourceRow, metric: 'value' }).catch(() => {});
 ```
 
 `metric` is the declared field NAME from your `fields` (the same key you read from
-`fieldMapping`), not a query field id. Show `get()`/`download()` rejection messages in
-the dialog — they are written for viewers.
-
-Keep the dialog table dense — underlying data is often wide and long. Compact cell
-padding (the table is for scanning, not presenting). If the header is sticky: pin it
-flush at `top: 0` with an opaque background, and put NO padding on the scroll
-container itself — pad the cells, not the scroller. A sticky header pins to the
-container's content edge, so any container padding becomes a strip that rows
-visibly scroll through above the header.
-
-The table must scroll BOTH ways: `overflow: auto` on ONE wrapper directly around the
-`<table>`, and every element between that wrapper and the dialog body a plain block
-that can shrink (`min-width: 0`; no `display: table`, no `w-max`/`width:
-max-content`). A wrapper that sizes to the table's intrinsic width makes the
-overflow container's horizontal scroll dead — the table looks clipped and viewers
-cannot reach the right-hand columns. Verify by scrolling right in the rendered
-dialog with more columns than fit.
+`fieldMapping`), not a query field id. The custom chart type owns only its data-point
+action menu. It never renders an underlying-data dialog, table, loading state, error
+state, or download control inside the iframe.
 
 ### Drill into a data point
 

package/dist/vendor/template/.claude/skills/sdk-features/SKILL.md

@@ -28,6 +28,7 @@ Users describe features by what they see in the Lightdash editor. Translate:
 | runs inside a dashboard tile | `viz-context` | required — see below |
 | reusable chart/table with pivoted results | `viz-pivoted-results` | required — see below |
 | "view underlying data", raw rows behind a point (viz only) | `viz-underlying-data` | app code opt-in |
+| Lightdash-owned "View underlying data" dialog (viz only) | `viz-host-underlying-data` | app code opt-in |
 | light/dark mode, "matches my Lightdash theme" | `follow-host-theme` | CSS tokens — see below |
 
 ## Automatic (zero wiring — active on any current-SDK bundle)
@@ -119,11 +120,11 @@ order, `sortBy` describes result ordering, `totalColumnCount` exposes truncation
   every tab's queries execute during capture while only the active tab stays
   visible — never mount all tabs unconditionally (interactive loads must stay
   lazy).
-- `viz-underlying-data` (vizs only): keep the untransformed `sourceRow` on each
-  interactive datum, gate a data-point action menu on
-  `useVizContext().underlyingData.enabled`, render
-  `underlyingData.get({ row, metric })` in a themed dialog, and wire its
-  Download button to `underlyingData.download`. Full contract in the
+- `viz-underlying-data` and `viz-host-underlying-data` (vizs only): keep the
+  untransformed `sourceRow` on each interactive datum, gate a data-point action menu on
+  `useVizContext().underlyingData.enabled`, and call
+  `underlyingData.open({ row, metric })`. Lightdash renders the dialog and
+  owns its table, loading, error, and download controls. Full contract in the
   `reusable-visualization` skill.
 
 ## After a template upgrade
@@ -132,3 +133,7 @@ An upgrade rebuilds the app on the current SDK, which turns on the automatic
 capabilities but does NOT add wiring — that is a deliberate rail. When you
 offer newly available features, offer wiring-required ones too (their registry
 entries carry a `wiring` note); implement only when the user asks.
+
+Existing published visualization bundles are not rewritten by this registry.
+Bundles built before `viz-host-underlying-data` keep their iframe-owned
+`get`/`download` dialog until the user explicitly upgrades that feature.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "2.215.3",
+  "version": "2.217.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.215.3",
-    "@lightdash/warehouses": "2.215.3",
+    "@lightdash/common": "2.217.0",
+    "@lightdash/warehouses": "2.217.0",
     "@sidvind/better-ajv-errors": "7.0.0",
     "@types/columnify": "1.5.1",
     "ajv": "8.18.0",