@lightdash/cli 0.1464.3 → 0.1466.0

package/LICENSE

@@ -1,6 +1,10 @@
-MIT License
+Copyright (c) 2021-present Telescope Technology Limited (trading as “Lightdash”)
 
-Copyright (c) 2021 Telescope Technologies Inc.
+Portions of this software are licensed as follows:
+
+* All content that resides under the "packages/backend/src/ee" directory of this repository, if that directory exists, is licensed under the license defined in "packages/backend/src/ee/LICENSE".
+* All third party components incorporated into the Lightdash Software are licensed under the original license provided by the owner of the applicable component.
+* Content outside of the above mentioned directories or restrictions above is available under the "MIT" license as defined below.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/handlers/dbt/apiClient.d.ts

@@ -17,14 +17,17 @@ export declare const lightdashApi: <T extends string | boolean | unknown[] | imp
     selectedTabs?: string[] | undefined;
 } & {
     targets: (import("@lightdash/common").SchedulerSlackTarget | import("@lightdash/common").SchedulerEmailTarget)[];
-}) | import("@lightdash/common").SchedulerAndTargets[] | import("@lightdash/common").FieldValueSearchResult<unknown> | import("@lightdash/common").ApiDownloadCsv | import("@lightdash/common").AllowedEmailDomains | import("@lightdash/common").UpdateAllowedEmailDomains | import("@lightdash/common").UserAllowedOrganization[] | import("@lightdash/common").EmailStatusExpiring | import("@lightdash/common").ApiScheduledDownloadCsv | import("@lightdash/common").PinnedItems | import("@lightdash/common").ViewStatistics | import("@lightdash/common").SchedulerWithLogs | import("@lightdash/common").ValidationResponse[] | import("@lightdash/common").ChartHistory | import("@lightdash/common").ChartVersion | import("@lightdash/common").GitRepo[] | import("@lightdash/common").PullRequestCreated | import("@lightdash/common").GitIntegrationConfiguration | import("@lightdash/common").UserWarehouseCredentials | {
+}) | import("@lightdash/common").SchedulerAndTargets[] | import("@lightdash/common").FieldValueSearchResult<unknown> | import("@lightdash/common").ApiDownloadCsv | import("@lightdash/common").AllowedEmailDomains | import("@lightdash/common").UpdateAllowedEmailDomains | import("@lightdash/common").UserAllowedOrganization[] | import("@lightdash/common").EmailStatusExpiring | import("@lightdash/common").ApiScheduledDownloadCsv | import("@lightdash/common").PinnedItems | import("@lightdash/common").ViewStatistics | import("@lightdash/common").SchedulerWithLogs | import("@lightdash/common").ValidationResponse[] | import("@lightdash/common").ChartHistory | import("@lightdash/common").ChartVersion | import("@lightdash/common").EmbedUrl | import("@lightdash/common").DecodedEmbed | import("@lightdash/common").GitRepo[] | import("@lightdash/common").PullRequestCreated | import("@lightdash/common").GitIntegrationConfiguration | import("@lightdash/common").UserWarehouseCredentials | {
     status: import("@lightdash/common").SchedulerJobStatus;
     details: Record<string, any> | null;
 } | {
     jobId: string;
 } | Pick<import("@lightdash/common").SshKeyPair, "publicKey"> | import("@lightdash/common").MostPopularAndRecentlyUpdated | Record<string, number> | Record<string, import("@lightdash/common").DbtExposure> | {
     [dashboardTileUuid: string]: import("@lightdash/common").Comment[];
-} | import("@lightdash/common").ApiResolveComment | import("@lightdash/common").ApiSuccessEmpty | import("@lightdash/common").ApiCreateProjectResults | import("@lightdash/common").DashboardSummary | import("@lightdash/common").CatalogMetadata | import("@lightdash/common").CatalogAnalytics | import("@lightdash/common").PromotionChanges | import("@lightdash/common").WarehouseTableSchema | import("@lightdash/common").TogglePinnedItemInfo | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").OrganizationMemberProfile[]> | import("@lightdash/common").SqlChart | {
+} | import("@lightdash/common").ApiResolveComment | import("@lightdash/common").ApiSuccessEmpty | import("@lightdash/common").ApiCreateProjectResults | import("@lightdash/common").DashboardSummary | import("@lightdash/common").CatalogMetadata | import("@lightdash/common").CatalogAnalytics | import("@lightdash/common").AiConversation[] | import("@lightdash/common").AiConversationMessage[] | {
+    prompt: import("@lightdash/common").AiWebAppPrompt;
+    rows: Record<string, any>[] | undefined;
+} | import("@lightdash/common").PromotionChanges | import("@lightdash/common").WarehouseTableSchema | import("@lightdash/common").TogglePinnedItemInfo | import("@lightdash/common").KnexPaginatedData<import("@lightdash/common").OrganizationMemberProfile[]> | import("@lightdash/common").SqlChart | {
     savedSqlUuid: string;
     slug: string;
 } | {

package/dist/handlers/deploy.js

@@ -11,11 +11,24 @@ const analytics_1 = require("../analytics/analytics");
 const config_1 = require("../config");
 const context_1 = require("../dbt/context");
 const globalState_1 = tslib_1.__importDefault(require("../globalState"));
+const lightdash_config_1 = require("../lightdash-config");
 const styles = tslib_1.__importStar(require("../styles"));
 const compile_1 = require("./compile");
 const createProject_1 = require("./createProject");
 const apiClient_1 = require("./dbt/apiClient");
 const getDbtVersion_1 = require("./dbt/getDbtVersion");
+const replaceProjectYamlTags = async (projectUuid, lightdashProjectConfig) => {
+    const yamlTags = Object.entries(lightdashProjectConfig.spotlight?.categories ?? {}).map(([yamlReference, category]) => ({
+        yamlReference,
+        name: category.label,
+        color: category.color ?? 'gray',
+    }));
+    await (0, apiClient_1.lightdashApi)({
+        method: 'PUT',
+        url: `/api/v1/projects/${projectUuid}/tags/yaml`,
+        body: JSON.stringify(yamlTags),
+    });
+};
 const deploy = async (explores, options) => {
     if (explores.length === 0) {
         globalState_1.default.log(styles.warning('No explores found'));
@@ -31,6 +44,8 @@ const deploy = async (explores, options) => {
             process.exit(1);
         }
     }
+    const lightdashProjectConfig = await (0, lightdash_config_1.loadLightdashProjectConfig)(path_1.default.join(options.projectDir, 'lightdash.config.yml'));
+    await replaceProjectYamlTags(options.projectUuid, lightdashProjectConfig);
     await (0, apiClient_1.lightdashApi)({
         method: 'PUT',
         url: `/api/v1/projects/${options.projectUuid}/explores`,

package/dist/lightdash-config/index.d.ts

@@ -0,0 +1,2 @@
+import { LightdashProjectConfig } from '@lightdash/common';
+export declare const loadLightdashProjectConfig: (configPath: string) => Promise<LightdashProjectConfig>;

package/dist/lightdash-config/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadLightdashProjectConfig = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@lightdash/common");
+const better_ajv_errors_1 = tslib_1.__importDefault(require("better-ajv-errors"));
+const fs_1 = require("fs");
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const ajv_1 = require("../ajv");
+const loadLightdashProjectConfig = async (configPath) => {
+    try {
+        const configFile = yaml.load(await fs_1.promises.readFile(configPath, 'utf8'));
+        const validate = ajv_1.ajv.compile(common_1.lightdashProjectConfigSchema);
+        if (!validate(configFile)) {
+            const errors = (0, better_ajv_errors_1.default)(common_1.lightdashProjectConfigSchema, configFile, validate.errors || [], { indent: 2 });
+            throw new common_1.ParseError(`Invalid lightdash.config.yml at ${configPath}\n${errors}`);
+        }
+        return configFile;
+    }
+    catch (e) {
+        if (e instanceof Error && 'code' in e && e.code === 'ENOENT') {
+            // Return default config if file doesn't exist
+            return {
+                spotlight: common_1.DEFAULT_SPOTLIGHT_CONFIG,
+            };
+        }
+        throw e;
+    }
+};
+exports.loadLightdashProjectConfig = loadLightdashProjectConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.1464.3",
+  "version": "0.1466.0",
   "license": "MIT",
   "bin": {
     "lightdash": "dist/index.js"
@@ -30,8 +30,8 @@
     "parse-node-version": "^2.0.0",
     "unique-names-generator": "^4.7.1",
     "uuid": "^11.0.3",
-    "@lightdash/common": "0.1464.3",
-    "@lightdash/warehouses": "0.1464.3"
+    "@lightdash/common": "0.1466.0",
+    "@lightdash/warehouses": "0.1466.0"
   },
   "description": "Lightdash CLI tool",
   "devDependencies": {