@lightdash/common 3.269.0 → 3.269.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,4 +30,37 @@ export declare const expandSelectedTabs: (selectedTabs: string[] | null, tiles:
30
30
  * @throws ParameterError if none of the selected tabs exist in the dashboard
31
31
  */
32
32
  export declare const validateSelectedTabs: (selectedTabs: string[] | null, dashboardTiles: DashboardTile[]) => void;
33
+ export type DashboardLimits = {
34
+ maxTilesPerTab: number;
35
+ maxTabsPerDashboard: number;
36
+ };
37
+ type LimitedDashboard = {
38
+ tiles: {
39
+ tabUuid?: string | null;
40
+ }[];
41
+ tabs: {
42
+ uuid: string;
43
+ name: string;
44
+ order: number;
45
+ }[];
46
+ };
47
+ /**
48
+ * Tiles of every type count. Tiles without a tab, or with a tab that doesn't
49
+ * exist (saving drops it), render on the first tab.
50
+ */
51
+ export declare const getDashboardTileCountsByTab: ({ tiles, tabs, }: LimitedDashboard) => Map<string | null, number>;
52
+ export type DashboardLimitViolation = {
53
+ type: 'tabs';
54
+ count: number;
55
+ limit: number;
56
+ } | {
57
+ type: 'tiles';
58
+ tabUuid: string | null;
59
+ tabName: string | null;
60
+ count: number;
61
+ limit: number;
62
+ };
63
+ export declare const getDashboardLimitViolations: (dashboard: LimitedDashboard, { maxTilesPerTab, maxTabsPerDashboard }: DashboardLimits) => DashboardLimitViolation[];
64
+ export declare const assertDashboardWithinLimits: (dashboard: LimitedDashboard, limits: DashboardLimits) => void;
65
+ export {};
33
66
  //# sourceMappingURL=dashboard.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../../src/utils/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAI5E,eAAO,MAAM,yCAAyC,eACtC,eAAe,KAC5B,kBAYF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,SACvB;IAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,gBACnB,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,KACvC,OACsE,CAAC;AAE1E;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,iBACb,MAAM,EAAE,GAAG,IAAI,SACtB;IAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EAAE,KACrC,CAAC,MAAM,GAAG,IAAI,CAAC,EACyD,CAAC;AAE5E;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,iBACf,MAAM,EAAE,GAAG,IAAI,kBACb,aAAa,EAAE,KAChC,IAiBF,CAAC"}
1
+ {"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../../src/utils/dashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAI5E,eAAO,MAAM,yCAAyC,eACtC,eAAe,KAC5B,kBAYF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,SACvB;IAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,gBACnB,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,KACvC,OACsE,CAAC;AAE1E;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,iBACb,MAAM,EAAE,GAAG,IAAI,SACtB;IAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,EAAE,KACrC,CAAC,MAAM,GAAG,IAAI,CAAC,EACyD,CAAC;AAE5E;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,iBACf,MAAM,EAAE,GAAG,IAAI,kBACb,aAAa,EAAE,KAChC,IAiBF,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,KAAK,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EAAE,CAAC;IACrC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACzD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,qBAGrC,gBAAgB,KAAG,GAAG,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,CAU9C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC7B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC9C;IACI,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAER,eAAO,MAAM,2BAA2B,cACzB,gBAAgB,2CACc,eAAe,KACzD,uBAAuB,EAyBzB,CAAC;AAEF,eAAO,MAAM,2BAA2B,cACzB,gBAAgB,UACnB,eAAe,KACxB,IAaF,CAAC"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.validateSelectedTabs = exports.expandSelectedTabs = exports.isTileInSelectedTabs = exports.convertChartSourceTypeToDashboardTileType = void 0;
3
+ exports.assertDashboardWithinLimits = exports.getDashboardLimitViolations = exports.getDashboardTileCountsByTab = exports.validateSelectedTabs = exports.expandSelectedTabs = exports.isTileInSelectedTabs = exports.convertChartSourceTypeToDashboardTileType = void 0;
4
4
  const tslib_1 = require("tslib");
5
5
  const content_1 = require("../types/content");
6
6
  const dashboard_1 = require("../types/dashboard");
@@ -57,4 +57,54 @@ const validateSelectedTabs = (selectedTabs, dashboardTiles) => {
57
57
  }
58
58
  };
59
59
  exports.validateSelectedTabs = validateSelectedTabs;
60
+ /**
61
+ * Tiles of every type count. Tiles without a tab, or with a tab that doesn't
62
+ * exist (saving drops it), render on the first tab.
63
+ */
64
+ const getDashboardTileCountsByTab = ({ tiles, tabs, }) => {
65
+ const firstTab = [...tabs].sort((a, b) => a.order - b.order)[0];
66
+ const tabUuids = new Set(tabs.map((tab) => tab.uuid));
67
+ return tiles.reduce((counts, tile) => {
68
+ const tabUuid = tile.tabUuid && tabUuids.has(tile.tabUuid)
69
+ ? tile.tabUuid
70
+ : (firstTab?.uuid ?? null);
71
+ return counts.set(tabUuid, (counts.get(tabUuid) ?? 0) + 1);
72
+ }, new Map());
73
+ };
74
+ exports.getDashboardTileCountsByTab = getDashboardTileCountsByTab;
75
+ const getDashboardLimitViolations = (dashboard, { maxTilesPerTab, maxTabsPerDashboard }) => {
76
+ const tabViolations = dashboard.tabs.length > maxTabsPerDashboard
77
+ ? [
78
+ {
79
+ type: 'tabs',
80
+ count: dashboard.tabs.length,
81
+ limit: maxTabsPerDashboard,
82
+ },
83
+ ]
84
+ : [];
85
+ const tileViolations = [...(0, exports.getDashboardTileCountsByTab)(dashboard).entries()]
86
+ .filter(([, count]) => count > maxTilesPerTab)
87
+ .map(([tabUuid, count]) => ({
88
+ type: 'tiles',
89
+ tabUuid,
90
+ tabName: dashboard.tabs.find((tab) => tab.uuid === tabUuid)?.name ??
91
+ null,
92
+ count,
93
+ limit: maxTilesPerTab,
94
+ }));
95
+ return [...tabViolations, ...tileViolations];
96
+ };
97
+ exports.getDashboardLimitViolations = getDashboardLimitViolations;
98
+ const assertDashboardWithinLimits = (dashboard, limits) => {
99
+ const [violation] = (0, exports.getDashboardLimitViolations)(dashboard, limits);
100
+ if (!violation)
101
+ return;
102
+ if (violation.type === 'tabs') {
103
+ throw new errors_1.ParameterError(`Dashboard has ${violation.count} tabs, which is over the limit of ${violation.limit} tabs per dashboard`);
104
+ }
105
+ throw new errors_1.ParameterError(violation.tabName
106
+ ? `Tab "${violation.tabName}" has ${violation.count} tiles, which is over the limit of ${violation.limit} tiles per tab`
107
+ : `Dashboard has ${violation.count} tiles, which is over the limit of ${violation.limit} tiles per tab`);
108
+ };
109
+ exports.assertDashboardWithinLimits = assertDashboardWithinLimits;
60
110
  //# sourceMappingURL=dashboard.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../../../src/utils/dashboard.ts"],"names":[],"mappings":";;;;AAAA,8CAAmD;AACnD,kDAA4E;AAC5E,4CAAiD;AACjD,oFAAoD;AAE7C,MAAM,yCAAyC,GAAG,CACrD,UAA2B,EACT,EAAE;IACpB,QAAQ,UAAU,EAAE,CAAC;QACjB,KAAK,yBAAe,CAAC,WAAW;YAC5B,OAAO,8BAAkB,CAAC,WAAW,CAAC;QAC1C,KAAK,yBAAe,CAAC,GAAG;YACpB,OAAO,8BAAkB,CAAC,SAAS,CAAC;QACxC;YACI,OAAO,IAAA,2BAAiB,EACpB,UAAU,EACV,wBAAwB,UAAU,EAAE,CACvC,CAAC;IACV,CAAC;AACL,CAAC,CAAC;AAdW,QAAA,yCAAyC,GAAzC,yCAAyC,CAcpD;AAEF;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAChC,IAAiC,EACjC,YAAsC,EAC/B,EAAE,CACT,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAJ7D,QAAA,oBAAoB,GAApB,oBAAoB,CAIyC;AAE1E;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAC9B,YAA6B,EAC7B,KAAoC,EACnB,EAAE,CACnB,YAAY,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;AAJ/D,QAAA,kBAAkB,GAAlB,kBAAkB,CAI6C;AAE5E;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAChC,YAA6B,EAC7B,cAA+B,EAC3B,EAAE;IACN,iGAAiG;IACjG,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,cAAc;aAC/B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;aAC3B,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACjD,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC;QAEvE,MAAM,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CACtD,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAClC,CAAC;QACF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,uBAAc,CACpB,kDAAkD,CACrD,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,oBAAoB,GAApB,oBAAoB,CAoB/B"}
1
+ {"version":3,"file":"dashboard.js","sourceRoot":"","sources":["../../../src/utils/dashboard.ts"],"names":[],"mappings":";;;;AAAA,8CAAmD;AACnD,kDAA4E;AAC5E,4CAAiD;AACjD,oFAAoD;AAE7C,MAAM,yCAAyC,GAAG,CACrD,UAA2B,EACT,EAAE;IACpB,QAAQ,UAAU,EAAE,CAAC;QACjB,KAAK,yBAAe,CAAC,WAAW;YAC5B,OAAO,8BAAkB,CAAC,WAAW,CAAC;QAC1C,KAAK,yBAAe,CAAC,GAAG;YACpB,OAAO,8BAAkB,CAAC,SAAS,CAAC;QACxC;YACI,OAAO,IAAA,2BAAiB,EACpB,UAAU,EACV,wBAAwB,UAAU,EAAE,CACvC,CAAC;IACV,CAAC;AACL,CAAC,CAAC;AAdW,QAAA,yCAAyC,GAAzC,yCAAyC,CAcpD;AAEF;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAChC,IAAiC,EACjC,YAAsC,EAC/B,EAAE,CACT,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAJ7D,QAAA,oBAAoB,GAApB,oBAAoB,CAIyC;AAE1E;;;;;;GAMG;AACI,MAAM,kBAAkB,GAAG,CAC9B,YAA6B,EAC7B,KAAoC,EACnB,EAAE,CACnB,YAAY,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;AAJ/D,QAAA,kBAAkB,GAAlB,kBAAkB,CAI6C;AAE5E;;;;;;GAMG;AACI,MAAM,oBAAoB,GAAG,CAChC,YAA6B,EAC7B,cAA+B,EAC3B,EAAE;IACN,iGAAiG;IACjG,IAAI,YAAY,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,cAAc;aAC/B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;aAC3B,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;aACjD,MAAM,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC;QAEvE,MAAM,iBAAiB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CACtD,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,CAClC,CAAC;QACF,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,uBAAc,CACpB,kDAAkD,CACrD,CAAC;QACN,CAAC;IACL,CAAC;AACL,CAAC,CAAC;AApBW,QAAA,oBAAoB,GAApB,oBAAoB,CAoB/B;AAYF;;;GAGG;AACI,MAAM,2BAA2B,GAAG,CAAC,EACxC,KAAK,EACL,IAAI,GACW,EAA8B,EAAE;IAC/C,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IACtD,OAAO,KAAK,CAAC,MAAM,CAA6B,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QAC7D,MAAM,OAAO,GACT,IAAI,CAAC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YACtC,CAAC,CAAC,IAAI,CAAC,OAAO;YACd,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC;QACnC,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC;AAbW,QAAA,2BAA2B,GAA3B,2BAA2B,CAatC;AAYK,MAAM,2BAA2B,GAAG,CACvC,SAA2B,EAC3B,EAAE,cAAc,EAAE,mBAAmB,EAAmB,EAC/B,EAAE;IAC3B,MAAM,aAAa,GACf,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,mBAAmB;QACvC,CAAC,CAAC;YACI;gBACI,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM;gBAC5B,KAAK,EAAE,mBAAmB;aAC7B;SACJ;QACH,CAAC,CAAC,EAAE,CAAC;IACb,MAAM,cAAc,GAAG,CAAC,GAAG,IAAA,QAAA,2BAA2B,EAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;SACvE,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,cAAc,CAAC;SAC7C,GAAG,CACA,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,EAA2B,EAAE,CAAC,CAAC;QAC5C,IAAI,EAAE,OAAO;QACb,OAAO;QACP,OAAO,EACH,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,IAAI;YACxD,IAAI;QACR,KAAK;QACL,KAAK,EAAE,cAAc;KACxB,CAAC,CACL,CAAC;IACN,OAAO,CAAC,GAAG,aAAa,EAAE,GAAG,cAAc,CAAC,CAAC;AACjD,CAAC,CAAC;AA5BW,QAAA,2BAA2B,GAA3B,2BAA2B,CA4BtC;AAEK,MAAM,2BAA2B,GAAG,CACvC,SAA2B,EAC3B,MAAuB,EACnB,EAAE;IACN,MAAM,CAAC,SAAS,CAAC,GAAG,IAAA,QAAA,2BAA2B,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACnE,IAAI,CAAC,SAAS;QAAE,OAAO;IACvB,IAAI,SAAS,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC5B,MAAM,IAAI,uBAAc,CACpB,iBAAiB,SAAS,CAAC,KAAK,qCAAqC,SAAS,CAAC,KAAK,qBAAqB,CAC5G,CAAC;IACN,CAAC;IACD,MAAM,IAAI,uBAAc,CACpB,SAAS,CAAC,OAAO;QACb,CAAC,CAAC,QAAQ,SAAS,CAAC,OAAO,SAAS,SAAS,CAAC,KAAK,sCAAsC,SAAS,CAAC,KAAK,gBAAgB;QACxH,CAAC,CAAC,iBAAiB,SAAS,CAAC,KAAK,sCAAsC,SAAS,CAAC,KAAK,gBAAgB,CAC9G,CAAC;AACN,CAAC,CAAC;AAhBW,QAAA,2BAA2B,GAA3B,2BAA2B,CAgBtC"}