npm - @atomic.io/action-cards-web-sdk-cdn-icons - Versions diffs - 25.1.0 → 25.2.0 - Mend

@atomic.io/action-cards-web-sdk-cdn-icons 25.1.0 → 25.2.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

package/README.md CHANGED Viewed

@@ -1,12 +1,12 @@
 [![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)
-# Web SDK - Current (25.1.0)
+# Web SDK - Current (25.2.0)
 ## Introduction
 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.
-The current stable release is **25.1.0**.
+The current stable release is **25.2.0**.
 ### Browser support
@@ -18,10 +18,10 @@ We currently do not have a boilerplate app for the Web SDK. [Contact us](mailto:
 ## Installation
-The current version of the Atomic Web SDK is `25.1.0`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js`.
+The current version of the Atomic Web SDK is `25.2.0`, and is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js`.
 As of version `24.2.1` 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.
-This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.1.0/sdk-cdn-icons.js`.
+This variant is hosted on our CDN at `https://downloads.atomic.io/web-sdk/release/25.2.0/sdk-cdn-icons.js`.
 To integrate it, add the script for your chosen variant as a source to your web page:
@@ -29,7 +29,7 @@ To integrate it, add the script for your chosen variant as a source to your web
 <html>
   ...
   <body>
-    <script src="https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js"></script>
+    <script src="https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js"></script>
   </body>
 </html>
 ```
@@ -93,21 +93,6 @@ AtomicSDK.setSessionDelegate(() => {
 }, retryInterval)
 ```
-#### JWT custom user ID field {#jwt-custom-user-id-field}
-_(introduced in 25.1.0)_
-To use a custom field in your JWT for the user ID used by the Atomic Platform you must first configure this field in the [Atomic Workbench](/sdks/auth-SDK#custom-user-id-field) for the relevant SDK API Key.
-Once you have the API Key configuration in place, you need to call the `setTokenUserIdAttribute` method, supplying the field name:
-```javascript
-AtomicSDK.setTokenUserIdAttribute('custom_id_property')
-```
-**info:**
-This method must be called **before** initialization of the SDK
 ### Login convenience method
 To be ready to display a stream container you need to have [initialised](https://documentation.atomic.io/sdks/web#displaying-a-stream-container) the SDK & set the [Session Delegate](https://documentation.atomic.io/sdks/web#authenticating-requests-with-a-jwt). You can use the convenience method `login` to accomplish this in one call. This method has the following parameters:
@@ -281,6 +266,7 @@ You can customize the following strings used by the Web SDK, using the `customSt
 - The text displayed next to the option to indicate that a card was useful (`votingUsefulTitle`);
 - The text displayed next to the option to indicate that a card was not useful (`votingNotUsefulTitle`);
 - The title displayed at the top of the screen presented when a user indicates that a card was not useful (`votingFeedbackTitle`).
+- The validation message shown to the user when they attempt to enter text feedback on a card exceeding the character limit (`votingFeedbackValidationMessage`).
 - The error message shown when the user does not have an internet connection (`noInternetConnectionMessage`).
 - The error message shown when the theme or card list cannot be loaded due to an API error (`dataLoadFailedMessage`).
 - The title of the button allowing the user to retry the failed request for the card list or theme (`tryAgainTitle`).
@@ -298,6 +284,7 @@ If you don't provide these custom strings, the SDK defaults will be used:
 - `votingUsefulTitle`: "This is useful"
 - `votingNotUsefulTitle`: "This isn't useful"
 - `votingFeedbackTitle`: "Send feedback"
+- `votingFeedbackValidationMessage`: "Feedback is limited to 280 characters."
 - `noInternetConnectionMessage`: "No internet connection"
 - `dataLoadFailedMessage`: "Couldn't load data"
 - `tryAgainTitle`: "Try again"
@@ -319,6 +306,7 @@ AtomicSDK.launch({
         votingUsefulTitle: 'Positive feedback',
         votingNotUsefulTitle: 'Negative feedback',
         votingFeedbackTitle: 'Tell us more',
+        votingFeedbackValidationMessage: 'Feedback message is too long',
         noInternetConnectionMessage: 'No internet connection available',
         dataLoadFailedMessage: 'Failed to load cards',
         tryAgainTitle: 'Please try again',
@@ -405,7 +393,7 @@ The code sample below shows how to use the `AtomicSDK.launch(config)` method, to
   ...
   <body>
     <!-- Installation -->
-    <script src="https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js"></script>
+    <script src="https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js"></script>
     <script>
       AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -480,7 +468,7 @@ The iframe generated by the `singleCard` method can be styled just like any othe
   ...
   <body>
     <!--Installation-->
-    <script src="https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js"></script>
+    <script src="https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js"></script>
     <script>
       AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -513,7 +501,7 @@ The iframe generated by the `embed` method can be styled just like any other DOM
   ...
   <body>
     <!--Installation-->
-    <script src="https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js"></script>
+    <script src="https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js"></script>
     <script>
       AtomicSDK.initialise('<apiHost>', '<apiKey>', '<environmentId>')
@@ -1019,6 +1007,16 @@ If an expiry date is set on the card, you cannot select dates beyond this expiry
 The Atomic SDKs support card voting, which allows you to gauge user sentiment towards the cards you send. When integrating the SDKs, you can choose to enable options for customers to indicate whether a card was useful to the user or not, accessible when they tap on the overflow button in the top right of a card.
+As of SDK version `25.2.0` SDK configuration of card voting has been deprecated, instead card voting should be configured from the workbench on a per card basis from the "Menu actions" options in the [Card elements menu](/guide/cards/creating#card-elements-menu-left).
+Configuration of card voting from within the workbench provides further customization options, allowing you to specify whether or not text feedback is enabled for vote up or vote down actions.
+Whether enabled in the workbench, or in the SDK configuration, the default wording of card voting options can be configured. See the [custom strings](#custom-strings) section of this guide if you want to change the default wording.
+### Configuring card voting within the SDK
+The following describes how card voting appears when configured via the SDK feature configuration:
 If the user indicates that the card was useful, a corresponding analytics event is sent for that card (`card-voted-up`).
 If they indicate that the card was not useful, they are presented with a secondary screen where they can choose to provide further feedback. The available reasons for why a card wasn’t useful are:
@@ -1029,9 +1027,7 @@ If they indicate that the card was not useful, they are presented with a seconda
 If they select "Something else", a free-form input is presented, where the user can provide additional feedback. The free form input is limited to 280 characters. After tapping "Submit", an analytics event containing this feedback is sent (`card-voted-down`).
-See the [custom strings](https://documentation.atomic.io/sdks/web#custom-strings) section of this guide if you want to change the default wording.
-Card voting is disabled by default. You can enable positive card voting ("This is useful"), negative card voting ("This isn’t useful"), or both:
+You can enable positive card voting ("This is useful"), negative card voting ("This isn’t useful"), or both:
 ```js
 AtomicSDK.launch({
@@ -1346,8 +1342,9 @@ You will also need to update this token every time the logged-in user changes in
 To deregister the device for Atomic notifications for your app, such as when a user completely logs out of your app, call `deregisterDeviceForNotifications` on `AtomicSDK`.
-**caution:**
+:::caution
 Calling `AtomicSDK.logout()` will automatically invoke this method.
+:::
 If the deregistration fails, the promise will be rejected, returning a description of the failure that occurred.
@@ -1848,10 +1845,10 @@ To use the SDK with your Cordova or Capacitor app:
 1. Download the Atomic SDK from our CDN, and bundle it with your application. There are two files you need to download:
-- `https://downloads.atomic.io/web-sdk/release/25.1.0/iframe-manager.js`
-- `https://downloads.atomic.io/web-sdk/release/25.1.0/sdk.js`
+- `https://downloads.atomic.io/web-sdk/release/25.2.0/iframe-manager.js`
+- `https://downloads.atomic.io/web-sdk/release/25.2.0/sdk.js`
-  _Where `25.1.0` is the version number of the SDK you wish to use._
+  _Where `25.2.0` is the version number of the SDK you wish to use._
 2. **(Cordova only)**: Modify the `Content-Security-Policy` meta tag in your Cordova app to allow the following URLs, after the `default-src` directive:
@@ -1936,21 +1933,9 @@ The following example sets the client app version to `Version 2.3.1`.
 AtomicSDK.setClientAppVersion('Version 2.3.1')
 ```
-### Setting a custom user Id attribute
-The SDK provides a method `AtomicSDK.setTokenUserIdAttribute` for determining a custom user Id attribute in your JWT if you are not using the standard `sub` attribute. This attribute must also be configured in the Atomic Workbench against the relevant SDK API key.
-The attribute name has a maximum length of 128 characters and must be a string.
-The following example sets the attribute to `my_custom_id`.
-```js
-AtomicSDK.setTokenUserIdAttribute('my_custom_id')
-```
 ## Third-party dependencies
-The Atomic Web SDK (as at the current release `25.1.0`) uses the following third-party dependencies:
+The Atomic Web SDK (as at the current release `25.2.0`) uses the following third-party dependencies:
 - Font Awesome Free `5.13.1`
 - snarkdown `1.2.1`

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@atomic.io/action-cards-web-sdk-cdn-icons",
-  "version": "25.1.0",
+  "version": "25.2.0",
   "description": "The Atomic Web SDK",
   "main": "public/sdk.js",
   "typings": "public/sdk.d.ts",

package/public/LICENSES.txt CHANGED Viewed

@@ -1,4 +1,4 @@
-The Atomic Web SDK (25.1.0) uses the following open sources libraries:
+The Atomic Web SDK (25.2.0) uses the following open sources libraries:
 -----------------------
@@ -90,19 +90,19 @@ MIT License
 Copyright (c) <year> <copyright holders>
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-associated documentation files (the "Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
 following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial
+The above copyright notice and this permission notice shall be included in all copies or substantial
 portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
-EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -145,19 +145,19 @@ MIT License
 Copyright (c) <year> <copyright holders>
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-associated documentation files (the "Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
 following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial
+The above copyright notice and this permission notice shall be included in all copies or substantial
 portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
-LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
-EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 USE OR OTHER DEALINGS IN THE SOFTWARE.