@lightdash/common 0.1460.1 → 0.1462.0

package/dist/authorization/organizationMemberAbility.js

@@ -70,6 +70,9 @@ const applyOrganizationMemberStaticAbilities = {
         can('view', 'MetricsTree', {
             organizationUuid: member.organizationUuid,
         });
+        can('view', 'SpotlightTableConfig', {
+            organizationUuid: member.organizationUuid,
+        });
     },
     interactive_viewer(member, { can }) {
         applyOrganizationMemberStaticAbilities.viewer(member, { can });
@@ -225,6 +228,9 @@ const applyOrganizationMemberStaticAbilities = {
             organizationUuid: member.organizationUuid,
             type: projects_1.ProjectType.PREVIEW,
         });
+        can('manage', 'SpotlightTableConfig', {
+            organizationUuid: member.organizationUuid,
+        });
     },
     admin(member, { can }) {
         applyOrganizationMemberStaticAbilities.developer(member, { can });

package/dist/authorization/projectMemberAbility.js

@@ -54,6 +54,9 @@ exports.projectMemberAbilities = {
         can('view', 'MetricsTree', {
             projectUuid: member.projectUuid,
         });
+        can('view', 'SpotlightTableConfig', {
+            projectUuid: member.projectUuid,
+        });
     },
     interactive_viewer(member, { can }) {
         exports.projectMemberAbilities.viewer(member, { can });
@@ -205,6 +208,9 @@ exports.projectMemberAbilities = {
             upstreamProjectUuid: member.projectUuid,
             type: projects_1.ProjectType.PREVIEW,
         });
+        can('manage', 'SpotlightTableConfig', {
+            projectUuid: member.projectUuid,
+        });
     },
     admin(member, { can }) {
         exports.projectMemberAbilities.developer(member, { can });

package/dist/authorization/types.d.ts

@@ -8,7 +8,7 @@ interface Project {
 interface Organization {
     organizationUuid: string;
 }
-type Subject = Project | Organization | OrganizationMemberProfile | 'Project' | 'Organization' | 'OrganizationMemberProfile' | 'Dashboard' | 'Space' | 'SavedChart' | 'InviteLink' | 'Job' | 'SqlRunner' | 'Analytics' | 'Explore' | 'UnderlyingData' | 'ExportCsv' | 'CsvJobResult' | 'PinnedItems' | 'Validation' | 'Group' | 'ChangeCsvResults' | 'ScheduledDeliveries' | 'DashboardComments' | 'CustomSql' | 'CompileProject' | 'SemanticViewer' | 'VirtualView' | 'Tags' | 'PersonalAccessToken' | 'MetricsTree' | 'all';
+type Subject = Project | Organization | OrganizationMemberProfile | 'Project' | 'Organization' | 'OrganizationMemberProfile' | 'Dashboard' | 'Space' | 'SavedChart' | 'InviteLink' | 'Job' | 'SqlRunner' | 'Analytics' | 'Explore' | 'UnderlyingData' | 'ExportCsv' | 'CsvJobResult' | 'PinnedItems' | 'Validation' | 'Group' | 'ChangeCsvResults' | 'ScheduledDeliveries' | 'DashboardComments' | 'CustomSql' | 'CompileProject' | 'SemanticViewer' | 'VirtualView' | 'Tags' | 'PersonalAccessToken' | 'MetricsTree' | 'SpotlightTableConfig' | 'all';
 type PossibleAbilities = [
     AbilityAction,
     Subject | ForcedSubject<Exclude<Subject, 'all'>>

package/dist/compiler/translator.js

@@ -4,6 +4,7 @@ exports.getSchemaStructureFromDbtModels = exports.attachTypesToModels = exports.
 const tslib_1 = require("tslib");
 const dbt_1 = require("../types/dbt");
 const errors_1 = require("../types/errors");
+const explore_1 = require("../types/explore");
 const field_1 = require("../types/field");
 const filterGrammar_1 = require("../types/filterGrammar");
 const table_1 = require("../types/table");
@@ -401,9 +402,12 @@ const convertExplores = async (models, loadSources, adapterType, metrics, wareho
                 groupLabel: meta.group_label,
                 errors: [
                     {
-                        type: e.name,
-                        message: e.message ||
-                            `Could not convert dbt model: "${model.name}" in to a Lightdash explore`,
+                        type: e instanceof errors_1.ParseError
+                            ? explore_1.InlineErrorType.METADATA_PARSE_ERROR
+                            : explore_1.InlineErrorType.NO_DIMENSIONS_FOUND,
+                        message: e instanceof Error
+                            ? e.message
+                            : `Could not convert dbt model: "${model.name}" in to a Lightdash explore`,
                     },
                 ],
             };
@@ -444,7 +448,17 @@ const convertExplores = async (models, loadSources, adapterType, metrics, wareho
                 name: model.name,
                 label: meta.label || (0, field_1.friendlyName)(model.name),
                 groupLabel: meta.group_label,
-                errors: [{ type: e.name, message: e.message }],
+                errors: [
+                    {
+                        // TODO improve parsing of error type
+                        type: e instanceof errors_1.ParseError
+                            ? explore_1.InlineErrorType.METADATA_PARSE_ERROR
+                            : explore_1.InlineErrorType.NO_DIMENSIONS_FOUND,
+                        message: e instanceof Error
+                            ? e.message
+                            : `Could not convert dbt model: "${model.name}" is not a valid model`,
+                    },
+                ],
             };
         }
     });

package/dist/index.d.ts

@@ -45,6 +45,7 @@ import { type ApiPromotionChangesResponse } from './types/promotion';
 import { type ApiSemanticLayerClientInfo, type ApiSemanticViewerChartCreate, type ApiSemanticViewerChartGet, type ApiSemanticViewerChartUpdate } from './types/semanticLayer';
 import { type ApiCreateSqlChart, type ApiCreateVirtualView, type ApiGithubDbtWritePreview, type ApiSqlChart, type ApiSqlRunnerJobStatusResponse, type ApiUpdateSqlChart } from './types/sqlRunner';
 import { type ApiWarehouseTableFields } from './types/warehouse';
+import { type ApiGetSpotlightTableConfig } from './types/api/spotlight';
 export * from './authorization/index';
 export * from './authorization/types';
 export * from './compiler/exploreCompiler';
@@ -63,6 +64,7 @@ export * from './types/api/share';
 export * from './types/api/sort';
 export * from './types/api/success';
 export * from './types/api/uuid';
+export * from './types/api/spotlight';
 export * from './types/catalog';
 export * from './types/coder';
 export * from './types/comments';
@@ -149,6 +151,7 @@ export * from './visualizations/PieChartDataModel';
 export * from './visualizations/TableDataModel';
 export * from './visualizations/types';
 export * from './visualizations/types/IResultsRunner';
+export * from './types/spotlightTableConfig';
 export declare const validateEmail: (email: string) => boolean;
 export declare const getEmailSchema: () => z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 export declare const getPasswordSchema: () => z.ZodString;
@@ -382,7 +385,7 @@ export type ApiAiGetDashboardSummaryResponse = {
     status: 'ok';
     results: DashboardSummary;
 };
-type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiDashboardAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'];
+type ApiResults = ApiQueryResults | ApiSqlQueryResults | ApiCompiledQueryResults | ApiExploresResults | ApiExploreResults | ApiStatusResults | ApiRefreshResults | ApiHealthResults | Organization | LightdashUser | LoginOptions | SavedChart | SavedChart[] | Space[] | InviteLink | OrganizationProject[] | Project | WarehouseCredentials | OrganizationMemberProfile[] | ProjectCatalog | TablesConfiguration | Dashboard | DashboardBasicDetails[] | OnboardingStatus | Dashboard[] | DeleteOpenIdentity | ApiFlashResults | Record<OpenIdIdentitySummary['issuerType'], OpenIdIdentitySummary[]> | FilterableField[] | DashboardAvailableFilters | ProjectSavedChartStatus | null | Array<unknown> | ApiJobStartedResults | ApiCreateUserTokenResults | CreatePersonalAccessToken | PersonalAccessToken | ProjectMemberProfile[] | ProjectGroupAccess | SearchResults | Space | ShareUrl | SlackSettings | ApiSlackChannelsResponse['results'] | UserActivity | SchedulerAndTargets | SchedulerAndTargets[] | FieldValueSearchResult | ApiDownloadCsv | AllowedEmailDomains | UpdateAllowedEmailDomains | UserAllowedOrganization[] | EmailStatusExpiring | ApiScheduledDownloadCsv | PinnedItems | ViewStatistics | SchedulerWithLogs | ValidationResponse[] | ChartHistory | ChartVersion | Array<GitRepo> | PullRequestCreated | GitIntegrationConfiguration | UserWarehouseCredentials | ApiJobStatusResponse['results'] | ApiJobScheduledResponse['results'] | ApiSshKeyPairResponse['results'] | MostPopularAndRecentlyUpdated | ApiCalculateTotalResponse['results'] | Record<string, DbtExposure> | ApiCreateComment['results'] | ApiGetComments['results'] | ApiDeleteComment | ApiSuccessEmpty | ApiCreateProjectResults | ApiAiDashboardSummaryResponse['results'] | ApiAiGetDashboardSummaryResponse['results'] | ApiCatalogMetadataResults | ApiCatalogAnalyticsResults | ApiPromotionChangesResponse['results'] | ApiWarehouseTableFields['results'] | ApiTogglePinnedItem['results'] | ApiOrganizationMemberProfiles['results'] | ApiSqlChart['results'] | ApiCreateSqlChart['results'] | ApiUpdateSqlChart['results'] | ApiContentResponse['results'] | ApiChartContentResponse['results'] | ApiSqlRunnerJobStatusResponse['results'] | ApiSemanticLayerClientInfo['results'] | ApiSemanticViewerChartCreate['results'] | ApiSemanticViewerChartGet['results'] | ApiSemanticViewerChartUpdate['results'] | ApiCreateVirtualView['results'] | ApiGithubDbtWritePreview['results'] | ApiMetricsCatalog['results'] | ApiMetricsExplorerQueryResults['results'] | ApiGroupListResponse['results'] | ApiCreateTagResponse['results'] | ApiChartAsCodeListResponse['results'] | ApiDashboardAsCodeListResponse['results'] | ApiChartAsCodeUpsertResponse['results'] | ApiGetMetricsTree['results'] | ApiMetricsExplorerTotalResults['results'] | ApiGetSpotlightTableConfig['results'];
 export type ApiResponse<T extends ApiResults = ApiResults> = {
     status: 'ok';
     results: T;

package/dist/index.js

@@ -32,6 +32,7 @@ tslib_1.__exportStar(require("./types/api/share"), exports);
 tslib_1.__exportStar(require("./types/api/sort"), exports);
 tslib_1.__exportStar(require("./types/api/success"), exports);
 tslib_1.__exportStar(require("./types/api/uuid"), exports);
+tslib_1.__exportStar(require("./types/api/spotlight"), exports);
 tslib_1.__exportStar(require("./types/catalog"), exports);
 tslib_1.__exportStar(require("./types/coder"), exports);
 tslib_1.__exportStar(require("./types/comments"), exports);
@@ -119,6 +120,7 @@ tslib_1.__exportStar(require("./visualizations/PieChartDataModel"), exports);
 tslib_1.__exportStar(require("./visualizations/TableDataModel"), exports);
 tslib_1.__exportStar(require("./visualizations/types"), exports);
 tslib_1.__exportStar(require("./visualizations/types/IResultsRunner"), exports);
+tslib_1.__exportStar(require("./types/spotlightTableConfig"), exports);
 const validateEmail = (email) => {
     if (/\s/.test(email)) {
         return false;

package/dist/types/api/spotlight.d.ts

@@ -0,0 +1,5 @@
+import type { SpotlightTableConfig } from '../spotlightTableConfig';
+export type ApiGetSpotlightTableConfig = {
+    status: 'ok';
+    results: Pick<SpotlightTableConfig, 'columnConfig'>;
+};

package/dist/types/api/spotlight.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/errors.d.ts

@@ -123,4 +123,5 @@ export declare class UnexpectedGoogleSheetsError extends LightdashError {
         [key: string]: any;
     });
 }
+export declare const getErrorMessage: (e: unknown) => string;
 export {};

package/dist/types/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnexpectedGoogleSheetsError = exports.SlackInstallationNotFoundError = exports.KnexPaginationError = exports.NotEnoughResults = exports.MissingConfigError = exports.AlreadyExistsError = exports.AlreadyProcessingError = exports.SmptError = exports.WarehouseQueryError = exports.WarehouseConnectionError = exports.InvalidUser = exports.NotFoundError = exports.DbtError = exports.FieldReferenceError = exports.CompileError = exports.ParseError = exports.UnexpectedDatabaseError = exports.UnexpectedGitError = exports.UnexpectedServerError = exports.MissingWarehouseCredentialsError = exports.MissingCatalogEntryError = exports.NonCompiledModelError = exports.ParameterError = exports.ExpiredError = exports.NotExistsError = exports.AuthorizationError = exports.DeactivatedAccountError = exports.ForbiddenError = exports.LightdashError = void 0;
+exports.getErrorMessage = exports.UnexpectedGoogleSheetsError = exports.SlackInstallationNotFoundError = exports.KnexPaginationError = exports.NotEnoughResults = exports.MissingConfigError = exports.AlreadyExistsError = exports.AlreadyProcessingError = exports.SmptError = exports.WarehouseQueryError = exports.WarehouseConnectionError = exports.InvalidUser = exports.NotFoundError = exports.DbtError = exports.FieldReferenceError = exports.CompileError = exports.ParseError = exports.UnexpectedDatabaseError = exports.UnexpectedGitError = exports.UnexpectedServerError = exports.MissingWarehouseCredentialsError = exports.MissingCatalogEntryError = exports.NonCompiledModelError = exports.ParameterError = exports.ExpiredError = exports.NotExistsError = exports.AuthorizationError = exports.DeactivatedAccountError = exports.ForbiddenError = exports.LightdashError = void 0;
 class LightdashError extends Error {
     constructor({ message, name, statusCode, data }) {
         super(message);
@@ -319,3 +319,5 @@ class UnexpectedGoogleSheetsError extends LightdashError {
     }
 }
 exports.UnexpectedGoogleSheetsError = UnexpectedGoogleSheetsError;
+const getErrorMessage = (e) => e instanceof Error ? e.message : `Unknown ${typeof e} error`;
+exports.getErrorMessage = getErrorMessage;

package/dist/types/spotlightTableConfig.d.ts

@@ -0,0 +1,18 @@
+export declare enum SpotlightTableColumns {
+    METRIC = "label",
+    TABLE = "tableLabel",
+    DESCRIPTION = "description",
+    CATEGORIES = "categories",
+    CHART_USAGE = "chartUsage"
+}
+type ColumnConfig = Array<{
+    column: SpotlightTableColumns;
+    isVisible: boolean;
+}>;
+export type SpotlightTableConfig = {
+    spotlightTableConfigUuid: string;
+    projectUuid: string;
+    columnConfig: ColumnConfig;
+};
+export declare const DEFAULT_SPOTLIGHT_TABLE_COLUMN_CONFIG: ColumnConfig;
+export {};

package/dist/types/spotlightTableConfig.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SPOTLIGHT_TABLE_COLUMN_CONFIG = exports.SpotlightTableColumns = void 0;
+var SpotlightTableColumns;
+(function (SpotlightTableColumns) {
+    // These must match the keys of CatalogField type
+    SpotlightTableColumns["METRIC"] = "label";
+    SpotlightTableColumns["TABLE"] = "tableLabel";
+    SpotlightTableColumns["DESCRIPTION"] = "description";
+    SpotlightTableColumns["CATEGORIES"] = "categories";
+    SpotlightTableColumns["CHART_USAGE"] = "chartUsage";
+})(SpotlightTableColumns = exports.SpotlightTableColumns || (exports.SpotlightTableColumns = {}));
+exports.DEFAULT_SPOTLIGHT_TABLE_COLUMN_CONFIG = [
+    { column: SpotlightTableColumns.METRIC, isVisible: true },
+    { column: SpotlightTableColumns.TABLE, isVisible: false },
+    { column: SpotlightTableColumns.DESCRIPTION, isVisible: true },
+    { column: SpotlightTableColumns.CATEGORIES, isVisible: true },
+    { column: SpotlightTableColumns.CHART_USAGE, isVisible: true },
+];

package/dist/visualizations/CartesianChartDataModel.d.ts

@@ -3,7 +3,7 @@ import { type Organization } from '../types/organization';
 import { type RawResultRow } from '../types/results';
 import { ChartKind, type CartesianSeriesType } from '../types/savedCharts';
 import { type SemanticLayerQuery } from '../types/semanticLayer';
-import { VizIndexType, type PivotChartData, type PivotChartLayout, type VizCartesianChartConfig, type VizCartesianChartOptions } from './types';
+import { type AxisSide, VizIndexType, type PivotChartData, type PivotChartLayout, type VizCartesianChartConfig, type VizCartesianChartOptions } from './types';
 import { type IResultsRunner } from './types/IResultsRunner';
 type CartesianChartKind = Extract<ChartKind, ChartKind.LINE | ChartKind.VERTICAL_BAR>;
 export declare class CartesianChartDataModel {
@@ -71,7 +71,7 @@ export type CartesianChartDisplay = {
             color?: string;
             type?: CartesianSeriesType.LINE | CartesianSeriesType.BAR;
             valueLabelPosition?: ValueLabelPositionOptions;
-            whichYAxis?: number;
+            whichYAxis?: AxisSide;
         };
     };
     legend?: {

package/dist/visualizations/CartesianChartDataModel.js

@@ -302,8 +302,12 @@ class CartesianChartDataModel {
         const leftYAxisSeriesReferences = [];
         const rightYAxisSeriesReferences = [];
         const series = transformedData.valuesColumns.map((seriesColumn, index) => {
-            const seriesDisplay = Object.values(display?.series || {}).find((s) => s.yAxisIndex === index);
             const seriesColumnId = seriesColumn.pivotColumnName;
+            // NOTE: seriesColumnId is the post pivoted column name and we now store the display based on that.
+            // If there is no display object for the seriesColumnId, we also referenceField for compatibility with
+            // the old display object that stored display info by the field, not the ID.
+            const seriesDisplay = display?.series?.[seriesColumnId] ??
+                display?.series?.[seriesColumn.referenceField];
             const seriesColor = seriesDisplay?.color;
             const seriesValueLabelPosition = seriesDisplay?.valueLabelPosition;
             const seriesType = seriesDisplay?.type ?? defaultSeriesType;

package/dist/visualizations/types/index.d.ts

@@ -24,6 +24,10 @@ export declare enum VizIndexType {
     TIME = "time",
     CATEGORY = "category"
 }
+export declare enum AxisSide {
+    LEFT = 0,
+    RIGHT = 1
+}
 export declare function getColumnAxisType(column: VizColumn): VizIndexType;
 export type VizIndexLayoutOptions = {
     axisType: VizIndexType;

package/dist/visualizations/types/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isVizTableConfig = exports.isVizPieChartConfig = exports.isVizCartesianChartConfig = exports.isVizLineChartConfig = exports.isVizBarChartConfig = exports.isPivotChartLayout = exports.getColumnAxisType = exports.VizIndexType = exports.VIZ_DEFAULT_AGGREGATION = exports.vizAggregationOptions = exports.SortByDirection = exports.VizAggregationOptions = void 0;
+exports.isVizTableConfig = exports.isVizPieChartConfig = exports.isVizCartesianChartConfig = exports.isVizLineChartConfig = exports.isVizBarChartConfig = exports.isPivotChartLayout = exports.getColumnAxisType = exports.AxisSide = exports.VizIndexType = exports.VIZ_DEFAULT_AGGREGATION = exports.vizAggregationOptions = exports.SortByDirection = exports.VizAggregationOptions = void 0;
 const field_1 = require("../../types/field");
 const savedCharts_1 = require("../../types/savedCharts");
 var VizAggregationOptions;
@@ -31,6 +31,11 @@ var VizIndexType;
     VizIndexType["TIME"] = "time";
     VizIndexType["CATEGORY"] = "category";
 })(VizIndexType = exports.VizIndexType || (exports.VizIndexType = {}));
+var AxisSide;
+(function (AxisSide) {
+    AxisSide[AxisSide["LEFT"] = 0] = "LEFT";
+    AxisSide[AxisSide["RIGHT"] = 1] = "RIGHT";
+})(AxisSide = exports.AxisSide || (exports.AxisSide = {}));
 function getColumnAxisType(column) {
     switch (column.type) {
         case field_1.DimensionType.DATE:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/common",
-  "version": "0.1460.1",
+  "version": "0.1462.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [