@lightdash/cli 2.13.2 → 2.14.0

package/dist/index.js

@@ -39,6 +39,7 @@ const sql_1 = require("./handlers/sql");
 const upgradeCheck_1 = require("./handlers/upgradeCheck");
 const validate_2 = require("./handlers/validate");
 const warehouseCatalog_1 = require("./handlers/warehouseCatalog");
+const refsArgument_1 = require("./refsArgument");
 const styles = tslib_1.__importStar(require("./styles"));
 // Trigger CLI tests
 // Suppress AWS SDK V2 warning, imported by snowflake SDK
@@ -360,15 +361,15 @@ const downloadCommand = commander_1.program
     .command('download')
     .description('Downloads project or organization content as code')
     .option('--verbose', undefined, false)
-    .option('-c, --charts <charts...>', 'specify chart slugs, uuids, or urls to download', [])
-    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs, uuids or urls to download', [])
-    .option('--agents <slugs...>', 'specify AI agent slugs to download', [])
+    .option('-c, --charts <charts...>', 'specify chart slugs, uuids, or urls to download', refsArgument_1.parseRefsArgument, [])
+    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs, uuids or urls to download', refsArgument_1.parseRefsArgument, [])
+    .option('--agents <slugs...>', 'specify AI agent slugs to download', refsArgument_1.parseRefsArgument, [])
     .option('--include-agents', "include all of the project's AI agents (enterprise)", false)
-    .option('--alerts <slugs...>', 'specify alert slugs to download', [])
-    .option('--virtual-views <slugs...>', 'specify virtual view slugs to download', [])
-    .option('--google-sheets <slugs...>', 'specify Google Sheets sync slugs to download', [])
-    .option('--scheduled-deliveries <slugs...>', 'specify scheduled delivery slugs to download', [])
-    .option('--external-connections <slugs...>', 'specify external connection slugs to download (enterprise)', [])
+    .option('--alerts <slugs...>', 'specify alert slugs to download', refsArgument_1.parseRefsArgument, [])
+    .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('--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)
     .option('-p, --path <path>', 'specify a custom path to download content', undefined)
@@ -385,11 +386,11 @@ const downloadCommand = commander_1.program
     .option('--include-scheduled-deliveries', 'include all scheduled deliveries in the download', false)
     .option('--include-all', 'include all optional content in the download', false)
     .option('--strip-pivot-series', 'strip per-value pivot series config from chart YAML for portable downloads', false)
-    .option('--apps <appReferences...>', 'Download only the specified data apps, by slug, app URL, or UUID (enterprise). Works for apps not added to a space.')
+    .option('--apps <appReferences...>', 'Download only the specified data apps, by slug, app URL, or UUID (enterprise). Works for apps not added to a space.', refsArgument_1.parseRefsArgument)
     .option('--include-apps', "Include all of the project's data apps (enterprise), capped at --apps-limit (default: 50)", false)
     .option('--apps-limit <number>', 'Maximum number of data apps downloaded by --include-apps or --include-all (default: 50)', undefined)
     .option('--apps-only', "Download only data apps (implies --skip-charts --skip-dashboards --skip-spaces). Bare --apps-only downloads all the project's apps; pass --apps <appReferences...> to select.", false)
-    .option('--chart-types <chartTypeReferences...>', 'Download only the specified custom chart types, by slug, URL, or UUID (enterprise).')
+    .option('--chart-types <chartTypeReferences...>', 'Download only the specified custom chart types, by slug, URL, or UUID (enterprise).', refsArgument_1.parseRefsArgument)
     .option('--include-chart-types', "Include all of the project's custom chart types (enterprise), capped at --chart-types-limit (default: 50)", false)
     .option('--chart-types-limit <number>', 'Maximum number of custom chart types downloaded by --include-chart-types or --include-all (default: 50)', undefined)
     .option('--chart-types-only', "Download only custom chart types (implies --skip-charts --skip-dashboards --skip-spaces). Bare --chart-types-only downloads all the project's chart types; pass --chart-types <chartTypeReferences...> to select.", false)
@@ -399,14 +400,14 @@ const uploadCommand = commander_1.program
     .command('upload')
     .description('Uploads project or organization content as code')
     .option('--verbose', undefined, false)
-    .option('-c, --charts <charts...>', 'specify chart slugs to force upload', [])
-    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs to force upload', [])
-    .option('--agents <slugs...>', 'specify AI agent slugs to upload', [])
-    .option('--alerts <slugs...>', 'specify alert slugs to upload', [])
-    .option('--virtual-views <slugs...>', 'specify virtual view slugs to upload', [])
-    .option('--google-sheets <slugs...>', 'specify Google Sheets sync slugs to upload', [])
-    .option('--scheduled-deliveries <slugs...>', 'specify scheduled delivery slugs to upload', [])
-    .option('--external-connections <slugs...>', 'specify external connection slugs to upload (enterprise)', [])
+    .option('-c, --charts <charts...>', 'specify chart slugs to force upload', refsArgument_1.parseRefsArgument, [])
+    .option('-d, --dashboards <dashboards...>', 'specify dashboard slugs to force upload', refsArgument_1.parseRefsArgument, [])
+    .option('--agents <slugs...>', 'specify AI agent slugs to upload', refsArgument_1.parseRefsArgument, [])
+    .option('--alerts <slugs...>', 'specify alert slugs to upload', refsArgument_1.parseRefsArgument, [])
+    .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('--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)
     .option('--project <project uuid>', 'specify a project UUID to upload', parseProjectArgument, undefined)
@@ -426,10 +427,10 @@ const uploadCommand = commander_1.program
     .option('--include-virtual-views', 'Include the virtual views used by the charts and dashboards being uploaded', false)
     .option('--validate', 'Validate charts and dashboards after upload', false)
     .option('--gzip', 'Enable gzip compression for request bodies', false)
-    .option('--apps <appReferences...>', 'Upload only the specified data apps, by slug (the app folder name), app URL, or UUID (enterprise). URL and UUID refs are resolved against the target project.')
+    .option('--apps <appReferences...>', 'Upload only the specified data apps, by slug (the app folder name), app URL, or UUID (enterprise). URL and UUID refs are resolved against the target project.', refsArgument_1.parseRefsArgument)
     .option('--include-apps', 'Upload all app folders on disk (enterprise).', false)
     .option('--apps-only', 'Upload only data apps, skipping charts, dashboards, and space reconciliation. Bare --apps-only uploads every app folder; pass --apps <appReferences...> to select.', false)
-    .option('--chart-types <chartTypeReferences...>', 'Upload only the specified custom chart types, by slug (the chart type folder name), URL, or UUID (enterprise). URL and UUID refs are resolved against the target project.')
+    .option('--chart-types <chartTypeReferences...>', 'Upload only the specified custom chart types, by slug (the chart type folder name), URL, or UUID (enterprise). URL and UUID refs are resolved against the target project.', refsArgument_1.parseRefsArgument)
     .option('--include-chart-types', 'Upload all chart type folders on disk (enterprise).', false)
     .option('--chart-types-only', 'Upload only custom chart types, skipping charts, dashboards, and space reconciliation. Bare --chart-types-only uploads every chart type folder; pass --chart-types <chartTypeReferences...> to select.', false)
     .option('--allow-custom-dependencies', 'Approve uploading apps that declare custom dependencies without prompting. Required for non-interactive runs of such uploads.', false)
@@ -464,7 +465,7 @@ appsProgram
     .action(preview_1.appsPreviewHandler);
 appsProgram
     .command('validate [paths...]')
-    .description('Validate data app source, manifests, dependencies, and semantic-layer references locally.')
+    .description('Validate data app and custom chart type source, manifests, dependencies, and semantic-layer references locally.')
     .option('--live', 'Validate against fresh explores from each app project instead of its downloaded semantic-layer snapshot.', false)
     .option('--build', 'Run the same Vite production build as Lightdash Cloud.', false)
     .addOption(new commander_1.Option('--format <format>', 'Output format: human or json')
@@ -811,6 +812,8 @@ const successHandler = () => {
         process.exit(0);
     }
     console.error(`Done 🕶`);
-    process.exit(0);
+    // Handlers report partial failures (e.g. some uploads failed) via
+    // process.exitCode; an unconditional exit(0) would wipe it.
+    process.exit(process.exitCode ?? 0);
 };
 commander_1.program.parseAsync().then(successHandler).catch(errorHandler);

package/dist/refsArgument.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Coercion for variadic reference options (--charts, --chart-types, --apps, ...).
+ * Commander's required-value parsing consumes the next argv token even when it
+ * is another option (e.g. `--chart-types --force` reads "--force" as a ref),
+ * so reject option-like values with a clear missing-value error.
+ */
+export declare function parseRefsArgument(value: string, previous?: string[]): string[];
+//# sourceMappingURL=refsArgument.d.ts.map

package/dist/refsArgument.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refsArgument.d.ts","sourceRoot":"","sources":["../src/refsArgument.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC7B,KAAK,EAAE,MAAM,EACb,QAAQ,GAAE,MAAM,EAAO,GACxB,MAAM,EAAE,CAOV"}

package/dist/refsArgument.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRefsArgument = parseRefsArgument;
+const commander_1 = require("commander");
+/**
+ * Coercion for variadic reference options (--charts, --chart-types, --apps, ...).
+ * Commander's required-value parsing consumes the next argv token even when it
+ * is another option (e.g. `--chart-types --force` reads "--force" as a ref),
+ * so reject option-like values with a clear missing-value error.
+ */
+function parseRefsArgument(value, previous = []) {
+    if (value.startsWith('-')) {
+        throw new commander_1.InvalidArgumentError('Expected a reference value but got another option. Pass one or more references after this flag, or use the matching --include-* flag to select all.');
+    }
+    return [...previous, value];
+}

package/dist/refsArgument.test.d.ts

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

package/dist/refsArgument.test.d.ts.map

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

package/dist/refsArgument.test.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const refsArgument_1 = require("./refsArgument");
+const buildCommand = () => {
+    const command = new commander_1.Command('upload')
+        .exitOverride()
+        .configureOutput({ writeErr: () => { } })
+        .option('--force', 'force upload', false)
+        .option('-c, --charts <charts...>', 'chart refs', refsArgument_1.parseRefsArgument, [])
+        .option('--chart-types <chartTypeReferences...>', 'chart type refs', refsArgument_1.parseRefsArgument);
+    return command;
+};
+describe('parseRefsArgument', () => {
+    it('rejects a bare flag followed by another option', () => {
+        const command = buildCommand();
+        expect(() => command.parse(['--chart-types', '--force'], { from: 'user' })).toThrow(/argument '--force' is invalid/);
+    });
+    it('does not consume the following boolean flag as a value', () => {
+        const command = buildCommand();
+        command.parse(['--chart-types', 'one', 'two', '--force'], {
+            from: 'user',
+        });
+        expect(command.opts().chartTypes).toEqual(['one', 'two']);
+        expect(command.opts().force).toBe(true);
+    });
+    it('rejects option-like values on options with array defaults', () => {
+        const command = buildCommand();
+        expect(() => command.parse(['--charts', '--force'], { from: 'user' })).toThrow(/argument '--force' is invalid/);
+    });
+    it('accumulates values onto the default array', () => {
+        const command = buildCommand();
+        command.parse(['-c', 'a', '-c', 'b'], { from: 'user' });
+        expect(command.opts().charts).toEqual(['a', 'b']);
+    });
+    it('leaves unset options at their defaults', () => {
+        const command = buildCommand();
+        command.parse([], { from: 'user' });
+        expect(command.opts().charts).toEqual([]);
+        expect(command.opts().chartTypes).toBeUndefined();
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "2.13.2",
+  "version": "2.14.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -45,8 +45,8 @@
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/warehouses": "2.13.2",
-    "@lightdash/common": "2.13.2"
+    "@lightdash/warehouses": "2.14.0",
+    "@lightdash/common": "2.14.0"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",