@atomic.io/action-cards-web-sdk-cdn-icons 25.4.0 → 26.1.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.
Files changed (6) hide show
  1. package/README.md +16 -13
  2. package/package.json +2 -2
  3. package/public/LICENSES.txt +1 -1
  4. package/public/iframe-manager.js +3 -3
  5. package/public/sdk.d.ts +2 -0
  6. package/public/sdk.js +3 -3
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  [![codecov](https://codecov.io/github/atomic-app/action-cards-web-sdk/branch/master/graph/badge.svg?token=BNXNRL8ASJ)](https://codecov.io/github/atomic-app/action-cards-web-sdk)
2
2
 
3
- # Web SDK - Current (25.4.0)
3
+ # Web SDK - Current (26.1.0)
4
4
 
5
5
  ## Introduction
6
6
 
7
7
  The Atomic Web SDK allows you to integrate an Atomic stream container into your web app or site, presenting cards from a stream to your customers.
8
8
 
9
- The current stable release is **25.4.0**.
9
+ The current stable release is **26.1.0**.
10
10
 
11
11
  ### Browser support
12
12
 
@@ -18,10 +18,10 @@ We currently do not have a boilerplate app for the Web SDK. [Contact us](mailto:
18
18
 
19
19
  ## Installation
20
20
 
21
- The current version of the Atomic Web SDK is `25.4.0`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js`.
21
+ The current version of the Atomic Web SDK is `26.1.0`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js`.
22
22
 
23
23
  The Web SDK also offers a bundle variant which does not include the font used for icons in action cards. Instead this font is fetched via CDN as required, allowing the size of your initial bundle loaded by the browser to be smaller. Both variations function identically in all other respects.
24
- This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.4.0/sdk-cdn-icons.js`.
24
+ This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/26.1.0/sdk-cdn-icons.js`.
25
25
 
26
26
  To integrate it, add the script for your chosen variant as a source to your web page:
27
27
 
@@ -29,7 +29,7 @@ To integrate it, add the script for your chosen variant as a source to your web
29
29
  <html>
30
30
  ...
31
31
  <body>
32
- <script src="https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js"></script>
32
+ <script src="https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js"></script>
33
33
  </body>
34
34
  </html>
35
35
  ```
@@ -265,6 +265,7 @@ You can customize the following strings used by the Web SDK, using the `customSt
265
265
  - The message displayed when the user has never received any cards before (`awaitingFirstCard`);
266
266
  - The message displayed when the user has seen at least one card in the container before, but has no cards to complete (`allCardsCompleted`);
267
267
  - The title to display for the card snooze functionality in the card overflow menu, and at the top of the card snooze screen (`cardSnoozeTitle`).
268
+ - The title to display for the card dismiss functionality in the card overflow menu (`cardDismissTitle`).
268
269
  - The text displayed next to the option to indicate that a card was useful (`votingUsefulTitle`);
269
270
  - The text displayed next to the option to indicate that a card was not useful (`votingNotUsefulTitle`);
270
271
  - The title displayed at the top of the screen presented when a user indicates that a card was not useful (`votingFeedbackTitle`).
@@ -283,6 +284,7 @@ If you don't provide these custom strings, the SDK defaults will be used:
283
284
  - `awaitingFirstCard`: "Cards will appear here when there's something to action."
284
285
  - `allCardsCompleted`: "All cards completed"
285
286
  - `cardSnoozeTitle`: "Remind me"
287
+ - `cardDismissTitle`: "Dismiss"
286
288
  - `votingUsefulTitle`: "This is useful"
287
289
  - `votingNotUsefulTitle`: "This isn't useful"
288
290
  - `votingFeedbackTitle`: "Send feedback"
@@ -305,6 +307,7 @@ AtomicSDK.launch({
305
307
  awaitingFirstCard: 'Cards will appear here soon',
306
308
  allCardsCompleted: 'All cards completed',
307
309
  cardSnoozeTitle: 'Snooze',
310
+ cardDismissTitle: 'Dismiss card',
308
311
  votingUsefulTitle: 'Positive feedback',
309
312
  votingNotUsefulTitle: 'Negative feedback',
310
313
  votingFeedbackTitle: 'Tell us more',
@@ -395,7 +398,7 @@ The code sample below shows how to use the `AtomicSDK.launch(config)` method, to
395
398
  ...
396
399
  <body>
397
400
  <!-- Installation -->
398
- <script src="https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js"></script>
401
+ <script src="https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js"></script>
399
402
 
400
403
  <script>
401
404
  AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -470,7 +473,7 @@ The iframe generated by the `singleCard` method can be styled just like any othe
470
473
  ...
471
474
  <body>
472
475
  <!--Installation-->
473
- <script src="https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js"></script>
476
+ <script src="https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js"></script>
474
477
 
475
478
  <script>
476
479
  AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -503,7 +506,7 @@ The iframe generated by the `embed` method can be styled just like any other DOM
503
506
  ...
504
507
  <body>
505
508
  <!--Installation-->
506
- <script src="https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js"></script>
509
+ <script src="https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js"></script>
507
510
 
508
511
  <script>
509
512
  AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -582,7 +585,7 @@ The following illustrates initializing a modal stream container with example con
582
585
  ...
583
586
  <body>
584
587
  <!--Installation-->
585
- <script src="https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js"></script>
588
+ <script src="https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js"></script>
586
589
 
587
590
  <script>
588
591
  AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -1994,10 +1997,10 @@ To use the SDK with your Cordova or Capacitor app:
1994
1997
 
1995
1998
  1. Download the Atomic SDK from our CDN, and bundle it with your application. There are two files you need to download:
1996
1999
 
1997
- - `https://downloads.atomic.io/web-sdk/release/25.4.0/iframe-manager.js`
1998
- - `https://downloads.atomic.io/web-sdk/release/25.4.0/sdk.js`
2000
+ - `https://downloads.atomic.io/web-sdk/release/26.1.0/iframe-manager.js`
2001
+ - `https://downloads.atomic.io/web-sdk/release/26.1.0/sdk.js`
1999
2002
 
2000
- _Where `25.4.0` is the version number of the SDK you wish to use._
2003
+ _Where `26.1.0` is the version number of the SDK you wish to use._
2001
2004
 
2002
2005
  2. **(Cordova only)**: Modify the `Content-Security-Policy` meta tag in your Cordova app to allow the following URLs, after the `default-src` directive:
2003
2006
 
@@ -2096,7 +2099,7 @@ AtomicSDK.setTokenUserIdAttribute('my_custom_id')
2096
2099
 
2097
2100
  ## Third-party dependencies
2098
2101
 
2099
- The Atomic Web SDK (as at the current release `25.4.0`) uses the following third-party dependencies:
2102
+ The Atomic Web SDK (as at the current release `26.1.0`) uses the following third-party dependencies:
2100
2103
 
2101
2104
  - Font Awesome Free `5.13.1`
2102
2105
  - snarkdown `1.2.1`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atomic.io/action-cards-web-sdk-cdn-icons",
3
- "version": "25.4.0",
3
+ "version": "26.1.0",
4
4
  "description": "The Atomic Web SDK",
5
5
  "main": "public/sdk.js",
6
6
  "typings": "public/sdk.d.ts",
@@ -16,7 +16,7 @@
16
16
  "start:server": "webpack serve --env outputPath='samples/basic'",
17
17
  "start:server:preview": "webpack serve --config webpack.preview.config.js",
18
18
  "typescript-check": "tsc -p tsconfig.json",
19
- "prettier-check": "prettier -c \"src/**/*.{ts,tsx,json,js}\"",
19
+ "prettier-check": "prettier -c \"src/**/*.{ts,tsx,json,js}\" --write",
20
20
  "emit-types": "tsc -p tsconfig.json --declaration --noEmit false --emitDeclarationOnly --outDir './dist'",
21
21
  "prebundle-types": "npm run emit-types",
22
22
  "bundle-types": "api-extractor run --typescript-compiler-folder './node_modules/typescript/lib/'"
package/public/LICENSES.txt CHANGED
@@ -1,4 +1,4 @@
1
- The Atomic Web SDK (25.4.0) uses the following open sources libraries:
1
+ The Atomic Web SDK (26.1.0) uses the following open sources libraries:
2
2
 
3
3
  -----------------------
4
4