@lightdash/cli 2.228.1 → 2.229.0

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

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

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

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

package/dist/handlers/exportChartImage.test.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = require("../config");
-const apiClient_1 = require("./dbt/apiClient");
-const exportChartImage_1 = require("./exportChartImage");
-vi.mock('../config', () => ({ getConfig: vi.fn() }));
-vi.mock('./dbt/apiClient', () => ({ lightdashApi: vi.fn() }));
-vi.mock('../globalState', () => ({
-    default: {
-        setVerbose: vi.fn(),
-        startSpinner: vi.fn(() => ({ warn: vi.fn() })),
-    },
-}));
-describe('exportChartImageHandler', () => {
-    beforeEach(() => {
-        vi.mocked(apiClient_1.lightdashApi).mockResolvedValue(undefined);
-    });
-    afterEach(() => {
-        vi.clearAllMocks();
-    });
-    it('scopes a slug to the selected project', async () => {
-        vi.mocked(config_1.getConfig).mockResolvedValue({
-            context: {
-                project: '22222222-2222-4222-8222-222222222222',
-            },
-        });
-        await (0, exportChartImage_1.exportChartImageHandler)('shared-slug', { output: 'chart.png' });
-        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
-            method: 'POST',
-            url: '/api/v1/saved/shared-slug/export?projectUuid=22222222-2222-4222-8222-222222222222',
-            body: undefined,
-        });
-    });
-    it('does not scope UUID exports to the selected project', async () => {
-        vi.mocked(config_1.getConfig).mockResolvedValue({
-            context: {
-                project: '22222222-2222-4222-8222-222222222222',
-            },
-        });
-        await (0, exportChartImage_1.exportChartImageHandler)('11111111-1111-4111-8111-111111111111', {
-            output: 'chart.png',
-        });
-        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
-            method: 'POST',
-            url: '/api/v1/saved/11111111-1111-4111-8111-111111111111/export',
-            body: undefined,
-        });
-        expect(config_1.getConfig).not.toHaveBeenCalled();
-    });
-    it('rejects a slug without project context', async () => {
-        vi.mocked(config_1.getConfig).mockResolvedValue({});
-        await expect((0, exportChartImage_1.exportChartImageHandler)('shared-slug', { output: 'chart.png' })).rejects.toThrow('A project is required when exporting by slug');
-        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
-    });
-});

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

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

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

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

package/dist/handlers/homepagesAsCode.test.js

@@ -1,72 +0,0 @@
-"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/handlers/lint.test.d.ts

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

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

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

package/dist/handlers/lint.test.js

@@ -1,221 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const fs_1 = require("fs");
-const os = tslib_1.__importStar(require("os"));
-const path = tslib_1.__importStar(require("path"));
-const lint_1 = require("./lint");
-vi.mock('../analytics/analytics', () => ({
-    categorizeError: vi.fn(),
-    LightdashAnalytics: {
-        track: vi.fn().mockResolvedValue(undefined),
-    },
-}));
-describe('lintHandler', () => {
-    let tempDir;
-    let output;
-    beforeEach(async () => {
-        tempDir = await fs_1.promises.mkdtemp(path.join(os.tmpdir(), 'lightdash-lint-'));
-        output = [];
-        vi.spyOn(console, 'log').mockImplementation((...args) => {
-            output.push(args.map(String).join(' '));
-        });
-        vi.spyOn(process, 'exit').mockImplementation(() => {
-            throw new Error('process.exit');
-        });
-    });
-    afterEach(async () => {
-        vi.restoreAllMocks();
-        await fs_1.promises.rm(tempDir, { recursive: true, force: true });
-    });
-    const expectLintFailure = async () => {
-        await expect((0, lint_1.lintHandler)({ path: tempDir, format: 'json' })).rejects.toThrow('process.exit');
-        expect(process.exit).toHaveBeenCalledWith(2);
-        return output.join('\n');
-    };
-    test('fails for a dashboard upload file missing its required version', async () => {
-        const dashboardsDir = path.join(tempDir, 'dashboards');
-        await fs_1.promises.mkdir(dashboardsDir);
-        await fs_1.promises.writeFile(path.join(dashboardsDir, 'missing-version.yml'), [
-            'name: Missing version',
-            'slug: missing-version',
-            'spaceSlug: shared',
-            'tiles: []',
-            'tabs: []',
-        ].join('\n'));
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('missing-version.yml');
-        expect(lintOutput).toContain("Missing required property 'version'");
-    });
-    test('fails for a chart missing its required version alongside a valid sibling', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        const dashboardsDir = path.join(tempDir, 'dashboards');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.mkdir(dashboardsDir);
-        await fs_1.promises.writeFile(path.join(chartsDir, 'missing-version.yml'), [
-            'name: Missing version',
-            'slug: missing-version',
-            'spaceSlug: shared',
-            'tableName: orders',
-            'metricQuery:',
-            '  exploreName: orders',
-            '  dimensions: []',
-            '  metrics: []',
-            '  filters: {}',
-            '  sorts: []',
-            '  limit: 500',
-            '  tableCalculations: []',
-            '  additionalMetrics: []',
-            '  customDimensions: []',
-            'chartConfig:',
-            '  type: table',
-            '  config: {}',
-        ].join('\n'));
-        await fs_1.promises.writeFile(path.join(dashboardsDir, 'valid.yml'), [
-            'name: Valid dashboard',
-            'slug: valid-dashboard',
-            'spaceSlug: shared',
-            'tiles: []',
-            'tabs: []',
-            'version: 1',
-        ].join('\n'));
-        await expect((0, lint_1.lintHandler)({ path: tempDir, format: 'cli' })).rejects.toThrow('process.exit');
-        expect(process.exit).toHaveBeenCalledWith(2);
-        const lintOutput = output.join('\n');
-        expect(lintOutput).toContain('missing-version.yml');
-        expect(lintOutput).toContain("Missing required property 'version'");
-        expect(lintOutput).toContain('2 Lightdash Code files');
-        expect(lintOutput).toContain('1 valid');
-        expect(lintOutput).toContain('1 invalid');
-    });
-    test('fails when a chart upload file cannot be parsed', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.writeFile(path.join(chartsDir, 'invalid-yaml.yml'), ['name: Invalid YAML', 'slug: invalid-yaml', 'sql: ]'].join('\n'));
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('invalid-yaml.yml');
-        expect(lintOutput).toContain('chart/parse');
-        expect(lintOutput).toContain('"startLine": 3');
-    });
-    test('reports empty chart upload files as invalid', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.writeFile(path.join(chartsDir, 'empty.yml'), '');
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('empty.yml');
-        expect(lintOutput).toContain('chart/type');
-    });
-    test('validates loose chart files by contentType', async () => {
-        await fs_1.promises.writeFile(path.join(tempDir, 'loose-chart.yml'), [
-            'contentType: chart',
-            'name: Missing version',
-            'metricQuery: {}',
-        ].join('\n'));
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('loose-chart.yml');
-        expect(lintOutput).toContain("Missing required property 'version'");
-    });
-    test('validates SQL chart content as a dashboard when placed in dashboards', async () => {
-        const dashboardsDir = path.join(tempDir, 'dashboards');
-        await fs_1.promises.mkdir(dashboardsDir);
-        await fs_1.promises.writeFile(path.join(dashboardsDir, 'sql-chart.yml'), [
-            'contentType: sql_chart',
-            'name: Misplaced SQL chart',
-            'sql: SELECT 1',
-        ].join('\n'));
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('sql-chart.yml');
-        expect(lintOutput).toContain("Missing required property 'version'");
-    });
-    test('accepts structurally recognized SQL charts selected for upload', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.writeFile(path.join(tempDir, 'sql-chart.yml'), [
-            'contentType: sql_chart',
-            'name: Loose SQL chart',
-            'sql: SELECT 1',
-        ].join('\n'));
-        await fs_1.promises.writeFile(path.join(chartsDir, 'sql-chart.yml'), ['name: Folder SQL chart', 'sql: SELECT 1'].join('\n'));
-        await (0, lint_1.lintHandler)({ path: tempDir, format: 'cli' });
-        expect(process.exit).not.toHaveBeenCalled();
-        expect(output.join('\n')).toContain('All Lightdash Code files are valid!');
-    });
-    test('ignores loose YAML files upload would not select', async () => {
-        await fs_1.promises.writeFile(path.join(tempDir, 'unrelated.yml'), ['version: 1', 'metricQuery: {}', 'name: Not uploadable'].join('\n'));
-        await (0, lint_1.lintHandler)({ path: tempDir, format: 'cli' });
-        expect(process.exit).not.toHaveBeenCalled();
-        expect(output.join('\n')).toContain('No Lightdash Code files found.');
-    });
-    test('accepts merge keys that upload resolves with js-yaml', async () => {
-        const dashboardsDir = path.join(tempDir, 'dashboards');
-        await fs_1.promises.mkdir(dashboardsDir);
-        await fs_1.promises.writeFile(path.join(dashboardsDir, 'merged-tabs.yml'), [
-            'contentType: dashboard',
-            'name: Merged tabs',
-            'slug: merged-tabs',
-            'spaceSlug: shared',
-            'version: 1',
-            'tiles: []',
-            'tabs:',
-            '  - &tab',
-            '    name: Overview',
-            '    order: 0',
-            '  - <<: *tab',
-            '    name: Details',
-            '    order: 1',
-        ].join('\n'));
-        await (0, lint_1.lintHandler)({ path: tempDir, format: 'cli' });
-        expect(process.exit).not.toHaveBeenCalled();
-        expect(output.join('\n')).toContain('All Lightdash Code files are valid!');
-    });
-    test('reports parse errors for loose content files and models', async () => {
-        const modelsDir = path.join(tempDir, 'models');
-        await fs_1.promises.mkdir(modelsDir);
-        await fs_1.promises.writeFile(path.join(tempDir, 'loose-chart.yml'), [
-            'contentType: chart',
-            'name: Broken chart',
-            'bad: [unterminated',
-        ].join('\n'));
-        await fs_1.promises.writeFile(path.join(modelsDir, 'broken-model.yml'), ['type: model', 'name: Broken model', 'bad: [unterminated'].join('\n'));
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('loose-chart.yml');
-        expect(lintOutput).toContain('chart/parse');
-        expect(lintOutput).toContain('broken-model.yml');
-        expect(lintOutput).toContain('model/parse');
-    });
-    test('reports .yaml content files as unsupported', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.writeFile(path.join(chartsDir, 'unsupported.yaml'), 'name: Unsupported extension');
-        const lintOutput = await expectLintFailure();
-        expect(lintOutput).toContain('unsupported.yaml');
-        expect(lintOutput).toContain('chart/extension');
-        expect(lintOutput).toContain("Content files must use the '.yml' extension");
-    });
-    test('defaults strict content discovery to the upload root', async () => {
-        const thirdPartyChartsDir = path.join(tempDir, 'vendor', 'charts');
-        await fs_1.promises.mkdir(thirdPartyChartsDir, { recursive: true });
-        await fs_1.promises.writeFile(path.join(thirdPartyChartsDir, 'unrelated.yml'), 'name: Not Lightdash content');
-        vi.spyOn(process, 'cwd').mockReturnValue(tempDir);
-        await (0, lint_1.lintHandler)({ format: 'cli' });
-        expect(process.exit).not.toHaveBeenCalled();
-        expect(output.join('\n')).toContain('No Lightdash Code files found.');
-    });
-    test('discovers content when run from inside the download root', async () => {
-        const chartsDir = path.join(tempDir, 'charts');
-        await fs_1.promises.mkdir(chartsDir);
-        await fs_1.promises.writeFile(path.join(chartsDir, 'missing-version.yml'), 'name: Missing version');
-        vi.spyOn(process, 'cwd').mockReturnValue(tempDir);
-        await expect((0, lint_1.lintHandler)({ format: 'cli' })).rejects.toThrow('process.exit');
-        expect(output.join('\n')).toContain('missing-version.yml');
-        expect(output.join('\n')).toContain("Missing required property 'version'");
-    });
-    test('shows the filename when linting a single file', async () => {
-        const dashboardsDir = path.join(tempDir, 'dashboards');
-        await fs_1.promises.mkdir(dashboardsDir);
-        const dashboardPath = path.join(dashboardsDir, 'single-file.yml');
-        await fs_1.promises.writeFile(dashboardPath, 'name: Missing version');
-        await expect((0, lint_1.lintHandler)({ path: dashboardPath, format: 'cli' })).rejects.toThrow('process.exit');
-        expect(output.join('\n')).toContain('✗ single-file.yml');
-    });
-});

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

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

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

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

package/dist/handlers/login.test.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const login_1 = require("./login");
-describe('isApiKeyEnvVarShadowing', () => {
-    it('is false when LIGHTDASH_API_KEY is not set', () => {
-        expect((0, login_1.isApiKeyEnvVarShadowing)(undefined, {})).toBe(false);
-        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_from_login', {})).toBe(false);
-    });
-    it('is true when an interactive login saves a token the env var will shadow', () => {
-        expect((0, login_1.isApiKeyEnvVarShadowing)(undefined, {
-            LIGHTDASH_API_KEY: 'ldpat_stale_env',
-        })).toBe(true);
-    });
-    it('is false for `lightdash login --token $LIGHTDASH_API_KEY`', () => {
-        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_ci', {
-            LIGHTDASH_API_KEY: 'ldpat_ci',
-        })).toBe(false);
-    });
-    it('is true when --token is a different token to the env var', () => {
-        expect((0, login_1.isApiKeyEnvVarShadowing)('ldpat_explicit', {
-            LIGHTDASH_API_KEY: 'ldpat_stale_env',
-        })).toBe(true);
-    });
-});

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

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

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

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

package/dist/handlers/metadataFile.test.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const fs_1 = require("fs");
-const os = tslib_1.__importStar(require("os"));
-const path = tslib_1.__importStar(require("path"));
-const metadataFile_1 = require("./metadataFile");
-describe('writeMetadataFile', () => {
-    let tmpDir;
-    beforeEach(async () => {
-        tmpDir = await fs_1.promises.mkdtemp(path.join(os.tmpdir(), 'ld-metadata-'));
-    });
-    afterEach(async () => {
-        await fs_1.promises.rm(tmpDir, { recursive: true, force: true });
-    });
-    it('creates the output root when it does not exist yet', async () => {
-        const baseDir = path.join(tmpDir, 'brand-new-dir');
-        await (0, metadataFile_1.writeMetadataFile)(baseDir, {
-            version: 1,
-            charts: {},
-            dashboards: {},
-        });
-        const written = JSON.parse(await fs_1.promises.readFile(path.join(baseDir, metadataFile_1.METADATA_FILENAME), 'utf-8'));
-        expect(written).toEqual({ version: 1, charts: {}, dashboards: {} });
-    });
-    it('merges with existing metadata', async () => {
-        await (0, metadataFile_1.writeMetadataFile)(tmpDir, {
-            version: 1,
-            charts: { 'chart-a': '2026-01-01T00:00:00Z' },
-            dashboards: {},
-        });
-        await (0, metadataFile_1.writeMetadataFile)(tmpDir, {
-            version: 1,
-            charts: { 'chart-b': '2026-02-02T00:00:00Z' },
-            dashboards: { 'dash-a': '2026-02-02T00:00:00Z' },
-        });
-        expect(await (0, metadataFile_1.readMetadataFile)(tmpDir)).toEqual({
-            version: 1,
-            charts: {
-                'chart-a': '2026-01-01T00:00:00Z',
-                'chart-b': '2026-02-02T00:00:00Z',
-            },
-            dashboards: { 'dash-a': '2026-02-02T00:00:00Z' },
-        });
-    });
-});

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

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

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

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

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

@@ -1,179 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const common_1 = require("@lightdash/common");
-const fs_1 = require("fs");
-const yaml = tslib_1.__importStar(require("js-yaml"));
-const os = tslib_1.__importStar(require("os"));
-const path = tslib_1.__importStar(require("path"));
-const vitest_1 = require("vitest");
-const apiClient_1 = require("../dbt/apiClient");
-const customRoles_1 = require("./customRoles");
-const index_1 = require("./index");
-vitest_1.vi.mock('../dbt/apiClient', async (importOriginal) => ({
-    ...(await importOriginal()),
-    lightdashApi: vitest_1.vi.fn(),
-}));
-describe('custom roles as code', () => {
-    let tmpDir;
-    const writeCustomRole = async (filename, role) => {
-        const folder = (0, customRoles_1.getCustomRolesFolder)(tmpDir);
-        await fs_1.promises.mkdir(folder, { recursive: true });
-        await fs_1.promises.writeFile(path.join(folder, filename), yaml.dump(role, { sortKeys: true }));
-    };
-    const customRole = (name, overrides = {}) => ({
-        version: 1,
-        name,
-        description: null,
-        level: 'project',
-        scopes: ['view:Dashboard'],
-        ...overrides,
-    });
-    beforeEach(async () => {
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockReset();
-        tmpDir = await fs_1.promises.mkdtemp(path.join(os.tmpdir(), 'custom-roles-test-'));
-    });
-    afterEach(async () => {
-        vitest_1.vi.restoreAllMocks();
-        await fs_1.promises.rm(tmpDir, { recursive: true, force: true });
-    });
-    it('uses the standard organization content folder by default', () => {
-        expect((0, index_1.getOrganizationContentFolder)()).toBe(path.join(process.cwd(), 'lightdash'));
-        expect((0, index_1.getOrganizationContentFolder)(tmpDir)).toBe(tmpDir);
-        expect((0, customRoles_1.getCustomRolesFolder)(tmpDir)).toBe(path.join(tmpDir, 'custom-roles'));
-    });
-    it('downloads portable custom role YAML from the code endpoint', async () => {
-        const folder = (0, customRoles_1.getCustomRolesFolder)(tmpDir);
-        await fs_1.promises.mkdir(folder, { recursive: true });
-        await fs_1.promises.writeFile(path.join(folder, 'stale.yml'), 'stale: true');
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValueOnce({
-            customRoles: [
-                customRole('Custom Role Name', {
-                    description: 'A useful role',
-                    level: 'organization',
-                    scopes: ['manage:Space', 'view:Dashboard'],
-                }),
-            ],
-        });
-        const total = await (0, customRoles_1.downloadCustomRoles)('organization-uuid', tmpDir);
-        expect(total).toBe(1);
-        expect(apiClient_1.lightdashApi).toHaveBeenCalledWith({
-            method: 'GET',
-            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({
-            version: 1,
-            name: 'Custom Role Name',
-            description: 'A useful role',
-            level: 'organization',
-            scopes: ['manage:Space', 'view:Dashboard'],
-        });
-        expect((await fs_1.promises.readdir(folder)).sort()).toStrictEqual([
-            'custom-role-name.yml',
-            'stale.yml',
-        ]);
-    });
-    it('uses stable hashes for normalized filename collisions', async () => {
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockResolvedValueOnce({
-            customRoles: [customRole('Data Admin'), customRole('Data--Admin')],
-        });
-        await (0, customRoles_1.downloadCustomRoles)('organization-uuid', tmpDir);
-        const filenames = (await fs_1.promises.readdir((0, customRoles_1.getCustomRolesFolder)(tmpDir))).sort();
-        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'));
-        await writeCustomRole('c.yml', customRole('Role C'));
-        vitest_1.vi.mocked(apiClient_1.lightdashApi)
-            .mockResolvedValueOnce({ action: common_1.PromotionAction.CREATE })
-            .mockResolvedValueOnce({ action: common_1.PromotionAction.UPDATE })
-            .mockResolvedValueOnce({
-            action: common_1.PromotionAction.NO_CHANGES,
-        });
-        const summary = await (0, customRoles_1.uploadCustomRoles)('organization-uuid', tmpDir);
-        expect(summary).toStrictEqual({
-            created: 1,
-            updated: 1,
-            unchanged: 1,
-            failed: 0,
-            failures: [],
-        });
-        expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(1, {
-            method: 'POST',
-            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'));
-    });
-    it('is a no-op when the custom roles folder is missing or empty', async () => {
-        await expect((0, customRoles_1.uploadCustomRoles)('organization-uuid', tmpDir)).resolves.toStrictEqual({
-            created: 0,
-            updated: 0,
-            unchanged: 0,
-            failed: 0,
-            failures: [],
-        });
-        await fs_1.promises.mkdir((0, customRoles_1.getCustomRolesFolder)(tmpDir), { recursive: true });
-        await expect((0, customRoles_1.uploadCustomRoles)('organization-uuid', tmpDir)).resolves.toStrictEqual({
-            created: 0,
-            updated: 0,
-            unchanged: 0,
-            failed: 0,
-            failures: [],
-        });
-        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
-    });
-    it('rejects duplicate names before calling the API', async () => {
-        await writeCustomRole('one.yml', customRole('Duplicate role'));
-        await writeCustomRole('two.yml', customRole('Duplicate role'));
-        await expect((0, customRoles_1.readCustomRoleFiles)(tmpDir)).rejects.toThrow('Duplicate custom role name "Duplicate role"');
-        expect(apiClient_1.lightdashApi).not.toHaveBeenCalled();
-    });
-    it('continues after the backend rejects one role', async () => {
-        await writeCustomRole('a-invalid.yml', customRole('Invalid role', { scopes: ['delete:VirtualViewsss'] }));
-        await writeCustomRole('b-valid.yml', customRole('Valid role'));
-        vitest_1.vi.mocked(apiClient_1.lightdashApi)
-            .mockRejectedValueOnce(new Error('Unknown custom role scopes: delete:VirtualViewsss'))
-            .mockResolvedValueOnce({ action: common_1.PromotionAction.UPDATE });
-        const summary = await (0, customRoles_1.uploadCustomRoles)('organization-uuid', tmpDir);
-        expect(summary).toMatchObject({
-            created: 0,
-            updated: 1,
-            unchanged: 0,
-            failed: 1,
-        });
-        expect(summary.failures[0].message).toContain('Unknown custom role scopes: delete:VirtualViewsss');
-        expect(apiClient_1.lightdashApi).toHaveBeenCalledTimes(2);
-    });
-    it('skips custom roles when the target has no Enterprise license', async () => {
-        await writeCustomRole('role.yml', customRole('Enterprise role'));
-        vitest_1.vi.mocked(apiClient_1.lightdashApi).mockRejectedValueOnce(new common_1.LightdashError({
-            message: 'Custom roles require a Lightdash Enterprise license',
-            name: 'ForbiddenError',
-            statusCode: 403,
-            data: {},
-        }));
-        const summary = await (0, customRoles_1.uploadCustomRoles)('organization-uuid', tmpDir);
-        expect(summary).toMatchObject({
-            created: 0,
-            updated: 0,
-            unchanged: 0,
-            skipped: 1,
-            failed: 0,
-            failures: [],
-        });
-    });
-});

package/dist/handlers/organizationContent/groups.test.d.ts

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

package/dist/handlers/organizationContent/groups.test.d.ts.map

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