@splunk/visualizations-shared 28.9.0 → 28.10.0

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.
package/themeUtils.js CHANGED
@@ -30,10 +30,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
30
30
  ));
31
31
  var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
32
32
 
33
- // src/themeUtils.js
33
+ // src/themeUtils.ts
34
34
  var themeUtils_exports = {};
35
35
  __export(themeUtils_exports, {
36
- getChartingThemeKey: () => getChartingThemeKey
36
+ getChartingThemeKey: () => getChartingThemeKey,
37
+ isSplunk1cdTheme: () => isSplunk1cdTheme
37
38
  });
38
39
  module.exports = __toCommonJS(themeUtils_exports);
39
40
 
@@ -46,16 +47,25 @@ var defaultImport = __toESM(require("lodash/get"));
46
47
  __reExport(get_exports, require("lodash/get"));
47
48
  var get_default = "default" in defaultImport ? defaultImport.default : defaultImport;
48
49
 
50
+ // esm-externals:@splunk/themes
51
+ var themes_exports = {};
52
+ __export(themes_exports, {
53
+ default: () => themes_default
54
+ });
55
+ var defaultImport2 = __toESM(require("@splunk/themes"));
56
+ __reExport(themes_exports, require("@splunk/themes"));
57
+ var themes_default = "default" in defaultImport2 ? defaultImport2.default : defaultImport2;
58
+
49
59
  // esm-externals:@splunk/themes/getSettingsFromThemedProps
50
60
  var getSettingsFromThemedProps_exports = {};
51
61
  __export(getSettingsFromThemedProps_exports, {
52
62
  default: () => getSettingsFromThemedProps_default
53
63
  });
54
- var defaultImport2 = __toESM(require("@splunk/themes/getSettingsFromThemedProps"));
64
+ var defaultImport3 = __toESM(require("@splunk/themes/getSettingsFromThemedProps"));
55
65
  __reExport(getSettingsFromThemedProps_exports, require("@splunk/themes/getSettingsFromThemedProps"));
56
- var getSettingsFromThemedProps_default = "default" in defaultImport2 ? defaultImport2.default : defaultImport2;
66
+ var getSettingsFromThemedProps_default = "default" in defaultImport3 ? defaultImport3.default : defaultImport3;
57
67
 
58
- // src/themeUtils.js
68
+ // src/themeUtils.ts
59
69
  var chartingThemes = {
60
70
  light: {
61
71
  enterprise: "default",
@@ -66,11 +76,36 @@ var chartingThemes = {
66
76
  prisma: "prismaDark"
67
77
  }
68
78
  };
69
- var getChartingThemeKey = (theme) => {
70
- if (!theme) {
79
+ var isSplunk1cdTheme = (theme, appearance) => {
80
+ var _a;
81
+ if ((appearance == null ? void 0 : appearance.style) === "gradient") {
82
+ return true;
83
+ }
84
+ if ((appearance == null ? void 0 : appearance.style) === "flat") {
85
+ return false;
86
+ }
87
+ const visualizationTheme = theme;
88
+ if (visualizationTheme == null ? void 0 : visualizationTheme.visualizationThemeFamily) {
89
+ return visualizationTheme.visualizationThemeFamily === "splunk-1cd";
90
+ }
91
+ if ((visualizationTheme == null ? void 0 : visualizationTheme.name) === "splunk1cdLight" || (visualizationTheme == null ? void 0 : visualizationTheme.name) === "splunk1cdDark") {
92
+ return true;
93
+ }
94
+ const customizer = (_a = visualizationTheme == null ? void 0 : visualizationTheme.splunkThemeV1) == null ? void 0 : _a.customizer;
95
+ return customizer === themes_exports.unstable_splunk1cdThemeCustomizer || (customizer == null ? void 0 : customizer.name) === themes_exports.unstable_splunk1cdThemeCustomizer.name;
96
+ };
97
+ var getChartingThemeKey = (theme, appearance) => {
98
+ var _a;
99
+ if (!theme && (appearance == null ? void 0 : appearance.style) !== "gradient") {
71
100
  return "prismaDark";
72
101
  }
73
- const { colorScheme, family } = getSettingsFromThemedProps_default({ theme });
102
+ const { colorScheme, family } = getSettingsFromThemedProps_default({
103
+ theme
104
+ });
105
+ if (isSplunk1cdTheme(theme, appearance)) {
106
+ const visualizationColorScheme = (_a = theme == null ? void 0 : theme.visualizationColorScheme) != null ? _a : colorScheme;
107
+ return visualizationColorScheme === "dark" ? "splunk1cdDark" : "splunk1cdLight";
108
+ }
74
109
  return get_default(chartingThemes, [colorScheme, family], "prismaDark");
75
110
  };
76
111
  //# sourceMappingURL=themeUtils.js.map
package/themeUtils.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["src/themeUtils.js", "esm-externals:lodash/get", "esm-externals:@splunk/themes/getSettingsFromThemedProps"],
4
- "sourcesContent": ["import get from 'lodash/get';\nimport getSettingsFromThemedProps from '@splunk/themes/getSettingsFromThemedProps';\n\nconst chartingThemes = {\n light: {\n enterprise: 'default',\n prisma: 'default',\n },\n dark: {\n enterprise: 'dark',\n prisma: 'prismaDark',\n },\n};\n\n/*\n * convert theme name for splunk-charting based visualization\n * @params {Object} theme\n * @return {String} 'prismaDark', 'dark' or 'default'\n */\nexport const getChartingThemeKey = theme => {\n if (!theme) {\n return 'prismaDark';\n }\n\n const { colorScheme, family } = getSettingsFromThemedProps({ theme });\n return get(chartingThemes, [colorScheme, family], 'prismaDark');\n};\n", "\nimport * as defaultImport from \"lodash/get\";\nexport * from \"lodash/get\";\nexport default ('default' in defaultImport ? defaultImport.default : defaultImport);\n", "\nimport * as defaultImport from \"@splunk/themes/getSettingsFromThemedProps\";\nexport * from \"@splunk/themes/getSettingsFromThemedProps\";\nexport default ('default' in defaultImport ? defaultImport.default : defaultImport);\n"],
5
- "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AACA,oBAA+B;AAC/B,wBAAc;AACd,IAAO,cAAS,aAAa,gBAA8B,wBAAU;;;ACHrE;AAAA;AAAA;AAAA;AACA,IAAAA,iBAA+B;AAC/B,+CAAc;AACd,IAAO,qCAAS,aAAaA,iBAA8B,yBAAUA;;;AFArE,IAAM,iBAAiB;AAAA,EACnB,OAAO;AAAA,IACH,YAAY;AAAA,IACZ,QAAQ;AAAA,EACZ;AAAA,EACA,MAAM;AAAA,IACF,YAAY;AAAA,IACZ,QAAQ;AAAA,EACZ;AACJ;AAOO,IAAM,sBAAsB,WAAS;AACxC,MAAI,CAAC,OAAO;AACR,WAAO;AAAA,EACX;AAEA,QAAM,EAAE,aAAa,OAAO,IAAI,mCAA2B,EAAE,MAAM,CAAC;AACpE,SAAO,YAAI,gBAAgB,CAAC,aAAa,MAAM,GAAG,YAAY;AAClE;",
6
- "names": ["defaultImport"]
3
+ "sources": ["src/themeUtils.ts", "esm-externals:lodash/get", "esm-externals:@splunk/themes", "esm-externals:@splunk/themes/getSettingsFromThemedProps"],
4
+ "sourcesContent": ["import get from 'lodash/get';\nimport {\n unstable_splunk1cdThemeCustomizer as splunk1cdThemeCustomizer,\n type AnyTheme,\n type OptionalThemedProps,\n} from '@splunk/themes';\nimport getSettingsFromThemedProps from '@splunk/themes/getSettingsFromThemedProps';\n\n/**\n * Appearance options for the visualization. For supported visualizations, set style to 'gradient' to use the updated gradient style.\n */\nexport type VizAppearance = {\n style?: 'flat' | 'gradient';\n};\n\ntype VisualizationTheme = {\n name?: string;\n visualizationThemeFamily?: string;\n visualizationColorScheme?: string;\n splunkThemeV1?: {\n family?: 'enterprise' | 'prisma';\n colorScheme?: 'light' | 'dark';\n density?: 'comfortable' | 'compact';\n customizer?: unknown;\n };\n};\ntype ThemeInput = VisualizationTheme | AnyTheme;\n\nconst chartingThemes = {\n light: {\n enterprise: 'default',\n prisma: 'default',\n },\n dark: {\n enterprise: 'dark',\n prisma: 'prismaDark',\n },\n};\n\n/** Return whether a visualization should use Splunk 1CD-specific rendering. */\nexport const isSplunk1cdTheme = (theme?: ThemeInput, appearance?: VizAppearance): boolean => {\n if (appearance?.style === 'gradient') {\n return true;\n }\n if (appearance?.style === 'flat') {\n return false;\n }\n\n const visualizationTheme = theme as VisualizationTheme | undefined;\n if (visualizationTheme?.visualizationThemeFamily) {\n return visualizationTheme.visualizationThemeFamily === 'splunk-1cd';\n }\n\n // The canvas package normalizes theme input to one of these stable keys.\n // Recognize that shape here so theme-mode detection has one implementation.\n if (visualizationTheme?.name === 'splunk1cdLight' || visualizationTheme?.name === 'splunk1cdDark') {\n return true;\n }\n\n const customizer = visualizationTheme?.splunkThemeV1?.customizer as { name?: string } | undefined;\n\n // Older integrations expose only the customizer, which can arrive from\n // another module instance.\n return customizer === splunk1cdThemeCustomizer || customizer?.name === splunk1cdThemeCustomizer.name;\n};\n\n/** Resolve the splunk-charting theme name for the current theme and appearance. */\nexport const getChartingThemeKey = (theme?: ThemeInput, appearance?: VizAppearance): string => {\n if (!theme && appearance?.style !== 'gradient') {\n return 'prismaDark';\n }\n\n const { colorScheme, family } = getSettingsFromThemedProps({\n theme: theme as unknown as OptionalThemedProps['theme'],\n });\n if (isSplunk1cdTheme(theme, appearance)) {\n const visualizationColorScheme =\n (theme as VisualizationTheme | undefined)?.visualizationColorScheme ?? colorScheme;\n return visualizationColorScheme === 'dark' ? 'splunk1cdDark' : 'splunk1cdLight';\n }\n\n return get(chartingThemes, [colorScheme, family], 'prismaDark');\n};\n", "\nimport * as defaultImport from \"lodash/get\";\nexport * from \"lodash/get\";\nexport default ('default' in defaultImport ? defaultImport.default : defaultImport);\n", "\nimport * as defaultImport from \"@splunk/themes\";\nexport * from \"@splunk/themes\";\nexport default ('default' in defaultImport ? defaultImport.default : defaultImport);\n", "\nimport * as defaultImport from \"@splunk/themes/getSettingsFromThemedProps\";\nexport * from \"@splunk/themes/getSettingsFromThemedProps\";\nexport default ('default' in defaultImport ? defaultImport.default : defaultImport);\n"],
5
+ "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA;AAAA;AAAA;AAAA;AACA,oBAA+B;AAC/B,wBAAc;AACd,IAAO,cAAS,aAAa,gBAA8B,wBAAU;;;ACHrE;AAAA;AAAA;AAAA;AACA,IAAAA,iBAA+B;AAC/B,2BAAc;AACd,IAAO,iBAAS,aAAaA,iBAA8B,yBAAUA;;;ACHrE;AAAA;AAAA;AAAA;AACA,IAAAC,iBAA+B;AAC/B,+CAAc;AACd,IAAO,qCAAS,aAAaA,iBAA8B,yBAAUA;;;AHyBrE,IAAM,iBAAiB;AAAA,EACnB,OAAO;AAAA,IACH,YAAY;AAAA,IACZ,QAAQ;AAAA,EACZ;AAAA,EACA,MAAM;AAAA,IACF,YAAY;AAAA,IACZ,QAAQ;AAAA,EACZ;AACJ;AAGO,IAAM,mBAAmB,CAAC,OAAoB,eAAwC;AAxC7F;AAyCI,OAAI,yCAAY,WAAU,YAAY;AAClC,WAAO;AAAA,EACX;AACA,OAAI,yCAAY,WAAU,QAAQ;AAC9B,WAAO;AAAA,EACX;AAEA,QAAM,qBAAqB;AAC3B,MAAI,yDAAoB,0BAA0B;AAC9C,WAAO,mBAAmB,6BAA6B;AAAA,EAC3D;AAIA,OAAI,yDAAoB,UAAS,qBAAoB,yDAAoB,UAAS,iBAAiB;AAC/F,WAAO;AAAA,EACX;AAEA,QAAM,cAAa,8DAAoB,kBAApB,mBAAmC;AAItD,SAAO,eAAe,eAAAC,sCAA4B,yCAAY,UAAS,eAAAA,kCAAyB;AACpG;AAGO,IAAM,sBAAsB,CAAC,OAAoB,eAAuC;AAnE/F;AAoEI,MAAI,CAAC,UAAS,yCAAY,WAAU,YAAY;AAC5C,WAAO;AAAA,EACX;AAEA,QAAM,EAAE,aAAa,OAAO,IAAI,mCAA2B;AAAA,IACvD;AAAA,EACJ,CAAC;AACD,MAAI,iBAAiB,OAAO,UAAU,GAAG;AACrC,UAAM,4BACD,oCAA0C,6BAA1C,YAAsE;AAC3E,WAAO,6BAA6B,SAAS,kBAAkB;AAAA,EACnE;AAEA,SAAO,YAAI,gBAAgB,CAAC,aAAa,MAAM,GAAG,YAAY;AAClE;",
6
+ "names": ["defaultImport", "defaultImport", "splunk1cdThemeCustomizer"]
7
7
  }