genesys-spark 4.5.0 → 4.6.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.
package/README.md CHANGED
@@ -29,13 +29,26 @@ import { registerSparkComponents } from 'genesys-spark';
29
29
  await registerSparkComponents();
30
30
  ```
31
31
 
32
+ ### Loading the chart components
33
+
34
+ When initializing your app/page, call `registerSparkChartComponents`, which will inject
35
+ the script and style tags into your page that define the chart related Spark custom elements:
36
+
37
+ ```js
38
+ import { registerSparkChartComponents } from 'genesys-spark';
39
+
40
+ // It's not _required_ to await component loading, but it can help prevent a flash
41
+ // of unstyled content.
42
+ await registerSparkChartComponents();
43
+ ```
44
+
32
45
  ### Font Loading
33
46
 
34
- While `registerSparkComponents()` will add the required webfonts to your page if
35
- they are not already present, it is recommended that you link stylesheets to load
36
- the Urbanist and Noto Sans fonts in your document prior to starting your app. This
37
- will improve loading performance and prevent a jarring font transition when the
38
- required fonts load.
47
+ While `registerSparkComponents()` and `registerSparkChartComponents()` will add
48
+ the required web fonts to your page if they are not already present, it is recommended
49
+ that you link stylesheets to load the Urbanist and Noto Sans fonts in your document
50
+ prior to starting your app. This will improve loading performance and prevent a
51
+ jarring font transition when the required fonts load.
39
52
 
40
53
  ## Asset loading details
41
54
 
package/dist/index.js CHANGED
@@ -15,12 +15,18 @@ var NON_STANDARD_DOMAINS = [
15
15
  * Returns the origin that web component assets should be loaded from.
16
16
  * Will use the domain of the current window if it matches a Genesys domain.
17
17
  */
18
+ function getComponentAssetsOrigin() {
19
+ return getAssetsOrigin();
20
+ }
21
+ function getChartComponentAssetsOrigin() {
22
+ return getAssetsOrigin();
23
+ }
18
24
  function getAssetsOrigin() {
19
25
  var matchedDomain = getRegionDomain();
20
26
  return "https://app.".concat(matchedDomain || DEFAULT_DOMAIN);
21
27
  }
22
28
  function getFontOrigin() {
23
- return getAssetsOrigin();
29
+ return getComponentAssetsOrigin();
24
30
  }
25
31
  function getRegionDomain() {
26
32
  var pageHost = window.location.hostname;
@@ -241,17 +247,19 @@ var intl = /*#__PURE__*/Object.freeze({
241
247
  relativeTimeFormat: relativeTimeFormat
242
248
  });
243
249
 
244
- var ASSET_PREFIX = '/spark-components/build-assets/4.5.0-34/genesys-webcomponents/';
245
- var SCRIPT_PATH = 'genesys-webcomponents.esm.js';
246
- var STYLE_PATH = 'genesys-webcomponents.css';
247
- var assetsOrigin = getAssetsOrigin();
248
- var SCRIPT_SRC = "".concat(assetsOrigin).concat(ASSET_PREFIX).concat(SCRIPT_PATH);
249
- var STYLE_HREF = "".concat(assetsOrigin).concat(ASSET_PREFIX).concat(STYLE_PATH);
250
- var fontOrigin = getFontOrigin();
251
- var FONTS = {
252
- Urbanist: "".concat(fontOrigin, "/webfonts/urbanist.css"),
253
- 'Noto Sans': "".concat(fontOrigin, "/webfonts/noto-sans.css")
254
- };
250
+ var COMPONENT_ASSET_PREFIX = '/spark-components/build-assets/4.6.1-72/genesys-webcomponents/';
251
+ var CHART_COMPONENT_ASSET_PREFIX = '/spark-components/build-assets/4.6.1-72/genesys-chart-webcomponents/';
252
+ /**
253
+ * TODO
254
+ */
255
+ function loadSparkFonts() {
256
+ var fontOrigin = getFontOrigin();
257
+ var FONTS = {
258
+ Urbanist: "".concat(fontOrigin, "/webfonts/urbanist.css"),
259
+ 'Noto Sans': "".concat(fontOrigin, "/webfonts/noto-sans.css")
260
+ };
261
+ return checkAndLoadFonts(FONTS);
262
+ }
255
263
  /**
256
264
  * Loads the spark web components, as well as required CSS and fonts from a
257
265
  * shared CDN. Performance can be optimized by pre-loading fonts in static HTML.
@@ -262,11 +270,31 @@ var FONTS = {
262
270
  * unexpected failures.
263
271
  */
264
272
  function registerSparkComponents() {
273
+ var SCRIPT_PATH = 'genesys-webcomponents.esm.js';
274
+ var STYLE_PATH = 'genesys-webcomponents.css';
275
+ var assetsOrigin = getComponentAssetsOrigin();
276
+ var SCRIPT_SRC = "".concat(assetsOrigin).concat(COMPONENT_ASSET_PREFIX).concat(SCRIPT_PATH);
277
+ var STYLE_HREF = "".concat(assetsOrigin).concat(COMPONENT_ASSET_PREFIX).concat(STYLE_PATH);
278
+ return Promise.all([
279
+ checkAndLoadScript(SCRIPT_SRC),
280
+ checkAndLoadStyle(STYLE_HREF),
281
+ loadSparkFonts()
282
+ ]).then();
283
+ }
284
+ /**
285
+ * TODO
286
+ */
287
+ function registerSparkChartComponents() {
288
+ var SCRIPT_PATH = 'genesys-chart-webcomponents.esm.js';
289
+ var STYLE_PATH = 'genesys-chart-webcomponents.css';
290
+ var assetsOrigin = getChartComponentAssetsOrigin();
291
+ var SCRIPT_SRC = "".concat(assetsOrigin).concat(CHART_COMPONENT_ASSET_PREFIX).concat(SCRIPT_PATH);
292
+ var STYLE_HREF = "".concat(assetsOrigin).concat(CHART_COMPONENT_ASSET_PREFIX).concat(STYLE_PATH);
265
293
  return Promise.all([
266
294
  checkAndLoadScript(SCRIPT_SRC),
267
295
  checkAndLoadStyle(STYLE_HREF),
268
- checkAndLoadFonts(FONTS)
296
+ loadSparkFonts()
269
297
  ]).then();
270
298
  }
271
299
 
272
- export { intl as Intl, registerSparkComponents };
300
+ export { intl as Intl, loadSparkFonts, registerSparkChartComponents, registerSparkComponents };
@@ -5,5 +5,7 @@ declare global {
5
5
  * Returns the origin that web component assets should be loaded from.
6
6
  * Will use the domain of the current window if it matches a Genesys domain.
7
7
  */
8
+ export declare function getComponentAssetsOrigin(): string;
9
+ export declare function getChartComponentAssetsOrigin(): string;
8
10
  export declare function getAssetsOrigin(): string;
9
11
  export declare function getFontOrigin(): string;
@@ -1,3 +1,7 @@
1
+ /**
2
+ * TODO
3
+ */
4
+ export declare function loadSparkFonts(): Promise<void>;
1
5
  /**
2
6
  * Loads the spark web components, as well as required CSS and fonts from a
3
7
  * shared CDN. Performance can be optimized by pre-loading fonts in static HTML.
@@ -8,4 +12,8 @@
8
12
  * unexpected failures.
9
13
  */
10
14
  export declare function registerSparkComponents(): Promise<void>;
15
+ /**
16
+ * TODO
17
+ */
18
+ export declare function registerSparkChartComponents(): Promise<void>;
11
19
  export * as Intl from './intl';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "genesys-spark",
3
- "version": "4.5.0",
3
+ "version": "4.6.1",
4
4
  "description": "",
5
5
  "license": "ISC",
6
6
  "author": "",